SynEdit is a syntax highlighting edit/memo control with support for many languages/syntaxes.
The SynEdit contained in Lazarus was forked from SynEdit 1.0.3, and was adapted and extended quite a lot. Changes are listed below.
Lazarus package contains a source editor component named TSynEdit, several syntax highlighters and other components used for source editing.
Licensed under the same terms as the original SynEdit (MPL or GPL).
Original vs Lazarus version
Lazarus version is maintained mostly by Martin Friebe. Martin wrote at forum, what has been added to Lazarus version since fork appeared:
Big things added to the Lazarus version:
- configurable gutter / gutter-parts
- shared text between several editors
- utf-8 support
- sync-editing plugin
- basic RTL/LTR support
- mouse config via MouseActions
- rewrite of various highlight/markup modules
Codebases of Delphi/Lazarus versions were independently refactored. There is very few overlap left.
SynEdit 2.0 port
An alternative port of the 2.0.x version of the original SynEdit exists. It's not actively maintained, last commit (now is Jun 2014) was at 2011.
SynEdit in the IDE
The SynEdit in Lazarus is a built-in package, because the IDE uses it itself. Therefore the package can not be removed from the installation list. To remove the entries from the component palette, the SynEditDsgn package can be removed from installation.
- There are several standard highlighters (see tab "SynEdit" at component pallette)
- There are scriptable highlighters exist, which can adapt to many other file formats:
- SynAnySyn (standart, on component pallette by default)
- SynPositionHighlighter (standart, not on component pallette)
- SynUniHighlighter (standart, not on component pallette)
- SynFacilSyn (Github)
- More 3rd-party highlighters exist: SynCacheSyn, SynGeneralSyn, SynRCSyn, SynRubySyn, SynSDDSyn, SynSMLSyn, SynSTSyn, SynTclTkSyn, SynUnrealSyn, SynURISyn, SynVBScriptSyn, SynVrml97Syn, see here.
- You can write new highlighter, see info at SynEdit_Highlighter.
There are 3 completion plug-ins for SynEdit:
- Offers a list of words in a drop-down via a shortcut key combination (default: Ctrl-Space).
- Used in the IDE for identifier completion.
- Included in examples.
- Available on the component palette (since 0.9.3x).
Example code to invoke the completion pop up programmatically (i.e. without pressing the keyboard shortcut):
YourSynEdit.CommandProcessor(YourSynCompletion.ExecCommandID, '', nil)
- Replaces the current token with a piece of text. Not interactive. No drop-down.
- Included in examples.
- Available on the component palette.
- Basic template module. No drop-down.
- Used by IDE for code-templates. IDE contains additional code extending the feature (drop-down and syncro macros are added by IDE).
- Not included in examples.
Todo: Differences between 2nd and 3rd need to be documented. Maybe they can be merged.
Logical/Physical caret position
SynEdit offers position of the caret (text blinking cursor) in 2 different forms:
- Physical X/Y: Corresponds to visual (canvas) position,
- Logical X/Y: Corresponds to byte offset of the text.
Both are 1-based. Currently Y coordinates are always the same. This may change in future.
- The Physical coordinate
- is the position in the display grid (ignoring any scrolling). That is:
- the letter "a" and "â" take both ONE cell on the grid, increasing physical x by 1. Even though in utf8 encoding "a" takes one byte, and "â" takes several bytes.
- however the tab char (#9), besides being just one byte and one char, can take several cells in the grid, increasing the physical x by more than one. There are also some chars in Chinese and eastern languages, that take 2 grid positions (google full-width vs half-width char)
- The Logical coordinate
- is the byte offset in the string holding the line.
- the letter "a" has 1 byte and increases by 1
- the letter "â" has 2 (or 3) bytes, and increases by that
- tab has 1 byte and increases by that.
Neither of the 2 give the position in UTF8 chars/code-points (e.g. for Utf8Copy or Utf8Length).
The physical X is always counted from the left of the text, even if this is scrolled out. To get the grid-x of the currently scrolled control do:
- grid-X-in-visible-part-of-synedit := PhysicalX - SynEdit.LeftChar + 1
- grid-y-in-visible-part-of-synedit := SynEdit.RowToScreenRow(PhysicalY); // includes folding
- use ScreenRowToRow for reverse
Change text from code
Text can be accessed via SynEdit.Lines. This is a TStrings based property offering read/write access to each line. It is 0 based.
SynEdit.Lines := 'Text'; // first line
SynEdit.Lines can be used to set the initial version of the text (e.g. loaded from file). Note that SynEdit.Lines.Add/SynEdit.Lines.Append does not support line breaks inside the added strings. You should add lines one by one.
To modify the content of a SynEdit, and allow the user to undo the action use the following methods:
procedure InsertTextAtCaret(aText: String; aCaretMode: TSynCaretAdjustMode = scamEnd); property TextBetweenPoints[aStartPoint, aEndPoint: TPoint]: String // Logical Points read GetTextBetweenPoints write SetTextBetweenPointsSimple; property TextBetweenPointsEx[aStartPoint, aEndPoint: TPoint; CaretMode: TSynCaretAdjustMode]: String write SetTextBetweenPointsEx; procedure SetTextBetweenPoints(aStartPoint, aEndPoint: TPoint; const AValue: String; aFlags: TSynEditTextFlags = ; aCaretMode: TSynCaretAdjustMode = scamIgnore; aMarksMode: TSynMarksAdjustMode = smaMoveUp; aSelectionMode: TSynSelectionMode = smNormal );
// Insert text at caret SynEdit.InsertTextAtCaret('Text'); // Replace text from (x=2,y=10) to (x=4,y=20) with Str SynEdit.TextBetweenPoints[Point(2,10), Point(4,20)] := Str;
// Delete/replace single char at caret pos var p1, p2: TPoint; begin p1 := SynEdit.LogicalCaretXY; p2 := p1; // Calculate the byte pos of the next char p2.x := p2.x + UTF8CharacterLength(@SynEdit.LineText[p2.x]); // p1 points to the first byte of char to be replaced // p2 points to the first byte of the char after the last replaceable char // Replace with "Text" (or use empty string to delete) SynEdit.TextBetweenPoints[p1, p2] := 'Text';
Fold/Unfold from code
- This is still under construction.
- This only works if current highlighter supports folding (details at SynEdit_Highlighter).
- Also note that some highlighters support several independent fold-trees. E.g. in Pascal you have folding on keywords (begin, end, class, procedure, etc) which is the primary fold, and folding on $ifdef or $region which is secondary.
- Folding of current selection is also different from folding on keywords.
Methods for folding:
Folds at the given Line. If there are more than one, folds the inner most (right most). Note: This does not work with selection, nor with Folds that hide entirely / Need testing for 2ndary folds.
3) TSynEdit.FoldAll / TSynEdit.UnfoldAll
Discussions on the forum, which contain info about SynEdit:
- Search/replace; caret; position logical/physical
- Diff between SynEdit/SynMemo
- Mouse actions; disable paste on middle click
- TSynEditMarkup info
Example applications can be found in the folder "lazarus/examples/synedit".
Adding hotkeys for Cut/Copy/Paste/etc
Hotkeys can be implemented by using SynEdit commands.
uses SynEdit, SynEditKeyCmds; procedure TForm1.SynEdit1KeyDown(Sender: TObject; var Key: Word; Shift: TShiftState); begin if (Shift = [ssCtrl]) then begin case Key of VK_C: SynEdit1.CommandProcessor(TSynEditorCommand(ecCopy), ' ', nil); VK_V: SynEdit1.CommandProcessor(TSynEditorCommand(ecPaste), ' ', nil); VK_X: SynEdit1.CommandProcessor(TSynEditorCommand(ecCut), ' ', nil); end; end; end;
Further development, discussions
- RTL (right-to-left): started by Mazen (partly implemented on Windows)
- SynEdit only uses UTF8; an ASCII/ANSI version no longer exists. A font is pre-selected depending on the system. The user can choose another font, but must then take care to choose a monospaced ont.
- automatic monospace font selection: At the moment SynEdit starts with a font 'courier'. December 2012/BigChimp: but Courier *is* monospace!!?!? But it would be better, if SynEdit would start with a monospace font (meaning: every character has the same width). At the moment the LCL TFont does not provide such a property. At the moment the user has to choose the right font.
- automatic UTF-8 font selection: Same as above monospace, but also with an UTF-8 font, so that for example umlaute are shown correctly. At the moment the user has to choose the right font.
- Dead keys. Most keyboards support typing two or more keys to create one special character (like accented or umlaut characters). (This is handled by LCL widgedset)
- Redesign of the SynEdit component. The primary goal is more reliable display and navigation in the text. A more modular approach also allows for better integration of extensions, and for specialized controls, for use outside of Lazarus.