Revision 1 of 2, by DomingoGP on 1-23-2022. The page as it is now.

Editor Macros PascalScript

General

The PascalScript macro functionality is available in Lazarus 1.1 and later. To use the feature you have to install the package EditorMacroScript, which includes the Pascal Script package. Pascal Script is provided by REM Objects. A minimum package is provided with the Lazarus 1.1 distribution.

Availability

This functionality is only available on selected platforms/architectures:

Windows
- 32/64bit Intel/AMD
Linux
- 32/64bit Intel/AMD
Mac
- 32(/maybe 64)bit Intel/AMD
- 32bit PPC

Simple actions

All simple Keyboard actions are represented as follows:

ecLeft;
Move Caret one to the left (in the editor that invoked the macro)

ecChar('a');
Inserts an 'a'

See the unit SynEditKeyCmds in package SynEdit, and IDECommands in IDEIntf for a full list. Or use the Recorder to get the names of actions.

Functions

pascal

    Function MessageDlg( const Msg: string; DlgType: TMsgDlgType; Buttons: TMsgDlgButtons; HelpCtx: Longint ): Integer;
    Function MessageDlgPos( const Msg: string; DlgType: TMsgDlgType; Buttons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer): Integer;
    Function MessageDlgPosHelp( const Msg: string; DlgType: TMsgDlgType; Buttons: TMsgDlgButtons; HelpCtx: Longint; X, Y: Integer; const HelpFileName: string): Integer;
    Procedure ShowMessage( const Msg: string );
    Procedure ShowMessagePos( const Msg: string; X, Y  Integer );
    Function InputBox( const ACaption, APrompt, ADefault: string): string;
    Function InputQuery( const ACaption, APrompt: string; var Value: string): Boolean;

Objects provided

Scripts can refer to the invoking SynEdit via the identifier "Caller".

Caller: TSynEdit

The following methods and properties are available:

Caret

pascal

    property CaretX: Integer;
    property CaretY: Integer;
    property CaretXY: TPoint;
    property LogicalCaretXY: TPoint;
    property LogicalCaretX: Integer;
    procedure MoveCaretIgnoreEOL(const NewCaret: TPoint);
    procedure MoveLogicalCaretIgnoreEOL(const NewLogCaret: TPoint);

Selection

pascal

    property BlockBegin: TPoint;
    property BlockEnd: TPoint;
    property SelAvail: Boolean; // read only
    property SelText: string;
    property SelectionMode: TSynSelectionMode;
    procedure ClearSelection;
    procedure SelectAll;
    procedure SelectToBrace;
    procedure SelectWord;
    procedure SelectLine(WithLeadSpaces: Boolean);
    procedure SelectParagraph;

Search/Replace

pascal

    function SearchReplace(const ASearch, AReplace: string; AOptions: TSynSearchOptions): integer;
    function SearchReplaceEx(const ASearch, AReplace: string; AOptions: TSynSearchOptions; AStart: TPoint): integer;

    TSynSearchOptions = set of
    ( ssoMatchCase, ssoWholeWord,
      ssoBackwards,
      ssoEntireScope, ssoSelectedOnly,  // Default is From Caret to End-of-text (or begin-of-text if backward) 
      ssoReplace, ssoReplaceAll,        // Otherwise the function does a search only
      ssoPrompt,                        // Show the prompt before replacing
      ssoSearchInReplacement,           // continue search-replace in replacement (with ssoReplaceAll) // replace recursive
      ssoRegExpr, ssoRegExprMultiLine,
      ssoFindContinue                   // Assume the current selection is the last match, and start search behind selection
                                        // (before if ssoBackward) // Default is to start at caret (Only SearchReplace / SearchReplaceEx has start/end param)
    );

Returns the number of replacements done. When Searching, returns 1 if found, 0 if not found. If found the match will be selected (use BlockBegin/End).

pascal

  if Caller.SearchReplace('FindMe', ' ', []) > 0 then begin
    // Selection is set to the first occurrence of FindMe (searched from position of caret)
  end;

Text

pascal

    property Lines[Index: Integer]: string; // read only
    property LinesCount: integer; // read only   (new for Lazarus 2.2)
    property LineAtCaret: string;  // read only
    procedure InsertTextAtCaret(aText: String; aCaretMode : TSynCaretAdjustMode);
    property TextBetweenPoints[aStartPoint, aEndPoint: TPoint]: String              // Logical Points
    procedure SetTextBetweenPoints(aStartPoint, aEndPoint: TPoint;
                                   const AValue: String;
                                   aFlags: TSynEditTextFlags = [];
                                   aCaretMode: TSynCaretAdjustMode;
                                   aMarksMode: TSynMarksAdjustMode;
                                   aSelectionMode: TSynSelectionMode
                                  );

Clipboard

pascal

    procedure CopyToClipboard;
    procedure CutToClipboard;
    procedure PasteFromClipboard;
    property CanPaste: Boolean     // read only

Logical / Physical

pascal

    function LogicalToPhysicalPos(const p: TPoint): TPoint;
    function LogicalToPhysicalCol(const Line: String; Index, LogicalPos
                              : integer): integer;
    function PhysicalToLogicalPos(const p: TPoint): TPoint;
    function PhysicalToLogicalCol(const Line: string;
                                  Index, PhysicalPos: integer): integer;
    function PhysicalLineLength(Line: String; Index: integer): integer;

ClipBoard: TClipBoard

pascal

    property AsText: String;

Available Macros / Downloads

<table> <caption>Editor macros</caption> <tbody> <tr> <td>Description</td> <td>Link</td> </tr> <tr> <td>Column Align Source code A macro that aligns selected code to a specific token. It looks for a specific token in each selected line, and aligns each occurrence of it. Select the 3 lines. If the selection starts right before the ":" then the ":" will be detected. A prompt will ask you to confirm the ":". Then all ":" will be aligned. (If you use a word for alignment, please note, that it will be matched regardless of word boundaries) You can vertically align things like := or // or ( <table> <tbody> <tr> <td><div class="sourceCode" id="cb1"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a> foo := 1; <a href="#cb1-2" aria-hidden="true" tabindex="-1"></a> something := 2; <a href="#cb1-3" aria-hidden="true" tabindex="-1"></a> x := -3;</code></pre></div></td> <td><div class="sourceCode" id="cb2"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a> foo := 1; <a href="#cb2-2" aria-hidden="true" tabindex="-1"></a> something := 2; <a href="#cb2-3" aria-hidden="true" tabindex="-1"></a> x := -3;</code></pre></div></td> </tr> </tbody> </table></td> <td>Editor Macro Column Align Source</td> </tr> <tr> <td>Count array elements A macro to count the boundaries in an array constant. <table> <tbody> <tr> <td><div class="sourceCode" id="cb3"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a> const foo: array [0..] of integer = ( <a href="#cb3-2" aria-hidden="true" tabindex="-1"></a> 1, 2, 3, <a href="#cb3-3" aria-hidden="true" tabindex="-1"></a> 4 <a href="#cb3-4" aria-hidden="true" tabindex="-1"></a> );</code></pre></div></td> <td><div class="sourceCode" id="cb4"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a> const foo: array [0..3] of integer = ( <a href="#cb4-2" aria-hidden="true" tabindex="-1"></a> 1, 2, 3, <a href="#cb4-3" aria-hidden="true" tabindex="-1"></a> 4 <a href="#cb4-4" aria-hidden="true" tabindex="-1"></a> );</code></pre></div></td> </tr> </tbody> </table></td> <td>See <a href="http://forum.lazarus.freepascal.org/index.php/topic,27186.msg167883.html#msg167883">http://forum.lazarus.freepascal.org/index.php/topic,27186.msg167883.html#msg167883</a> for counting array elements.</td> </tr> <tr> <td>Add PasDoc for function declaration Comments a procedure/function in <a href="https://github.com/pasdoc/pasdoc/wiki">PasDoc</a> format Example: Executing the macro with the caret in the line of function declaration will insert the comment before. <table> <tbody> <tr> <td><div class="sourceCode" id="cb5"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a>function AddRadioButton(const aCaption: string; aChecked: boolean = False): TCheckBox;</code></pre></div></td> <td><div class="sourceCode" id="cb6"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a>{ Description <a href="#cb6-2" aria-hidden="true" tabindex="-1"></a> @param(aCaption description ) <a href="#cb6-3" aria-hidden="true" tabindex="-1"></a> @param(aChecked description ) <a href="#cb6-4" aria-hidden="true" tabindex="-1"></a> @returns( description ) <a href="#cb6-5" aria-hidden="true" tabindex="-1"></a> @raises( none ) <a href="#cb6-6" aria-hidden="true" tabindex="-1"></a>} <a href="#cb6-7" aria-hidden="true" tabindex="-1"></a>function AddRadioButton(const aCaption: string; aChecked: boolean = False): TRadioButton;</code></pre></div></td> </tr> </tbody> </table> <a href="https://github.com/DomingoGP/LazarusMacroPasDoc">https://github.com/DomingoGP/LazarusMacroPasDoc</a></td> <td><a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroPasDocLazarus.txt">MacroPasDocLazarus.txt</a></td> </tr> <tr> <td>Sort selected lines There are two macros, one with the normal alphabetical order and another that orders by type <table> <tbody> <tr> <td><div class="sourceCode" id="cb7"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a> c:integer; <a href="#cb7-2" aria-hidden="true" tabindex="-1"></a> b:integer; <a href="#cb7-3" aria-hidden="true" tabindex="-1"></a> d:boolean; <a href="#cb7-4" aria-hidden="true" tabindex="-1"></a> a:boolean;</code></pre></div></td> <td><div class="sourceCode" id="cb8"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a> //normal sorting <a href="#cb8-2" aria-hidden="true" tabindex="-1"></a> a:boolean; <a href="#cb8-3" aria-hidden="true" tabindex="-1"></a> b:integer; <a href="#cb8-4" aria-hidden="true" tabindex="-1"></a> c:integer; <a href="#cb8-5" aria-hidden="true" tabindex="-1"></a> d:boolean;</code></pre></div></td> <td><div class="sourceCode" id="cb9"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a> //sorting by type <a href="#cb9-2" aria-hidden="true" tabindex="-1"></a> d:boolean; <a href="#cb9-3" aria-hidden="true" tabindex="-1"></a> a:boolean; <a href="#cb9-4" aria-hidden="true" tabindex="-1"></a> c:integer; <a href="#cb9-5" aria-hidden="true" tabindex="-1"></a> b:integer; </code></pre></div></td> </tr> </tbody> </table></td> <td><a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroSortLinesLazarus.txt">MacroSortLinesLazarus.txt</a> <a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroSortByTypeLazarus.txt">MacroSortByTypeLazarus.txt</a></td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td>Column Align by procedure/function name the selected lines <table> <tbody> <tr> <td><div class="sourceCode" id="cb10"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a> constructor Create; <a href="#cb10-2" aria-hidden="true" tabindex="-1"></a> destructor Destroy; override; <a href="#cb10-3" aria-hidden="true" tabindex="-1"></a> function Load(const aFileName:TFileName):boolean; <a href="#cb10-4" aria-hidden="true" tabindex="-1"></a> procedure Save(const aFileName:TFileName); <a href="#cb10-5" aria-hidden="true" tabindex="-1"></a> function Size:integer; </code></pre></div></td> <td><div class="sourceCode" id="cb11"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a> constructor Create; <a href="#cb11-2" aria-hidden="true" tabindex="-1"></a> destructor Destroy; override <a href="#cb11-3" aria-hidden="true" tabindex="-1"></a> function Load(const aFileName:TFileName):boolean; <a href="#cb11-4" aria-hidden="true" tabindex="-1"></a> procedure Save(const aFileName:TFileName); <a href="#cb11-5" aria-hidden="true" tabindex="-1"></a> function Size:integer;</code></pre></div></td> </tr> </tbody> </table></td> <td><a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroAlignFunctionProcedureNamesLazarus.txt">MacroAlignFunctionProcedureNamesLazarus.txt</a></td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td>Sort selected function/procedures declarations by Name, keeps the comments before the function/procedure <table> <tbody> <tr> <td><div class="sourceCode" id="cb12"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb12-1" aria-hidden="true" tabindex="-1"></a> destructor Destroy; override; <a href="#cb12-2" aria-hidden="true" tabindex="-1"></a> constructor Create; <a href="#cb12-3" aria-hidden="true" tabindex="-1"></a> procedure Save(const aFileName:TFileName); <a href="#cb12-4" aria-hidden="true" tabindex="-1"></a> { Load the aFileName } <a href="#cb12-5" aria-hidden="true" tabindex="-1"></a> function Load(const aFileName:TFileName):boolean; <a href="#cb12-6" aria-hidden="true" tabindex="-1"></a> function Size:integer; </code></pre></div></td> <td><div class="sourceCode" id="cb13"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb13-1" aria-hidden="true" tabindex="-1"></a> constructor Create; <a href="#cb13-2" aria-hidden="true" tabindex="-1"></a> destructor Destroy; override; <a href="#cb13-3" aria-hidden="true" tabindex="-1"></a> { Load the aFileName } <a href="#cb13-4" aria-hidden="true" tabindex="-1"></a> function Load(const aFileName:TFileName):boolean; <a href="#cb13-5" aria-hidden="true" tabindex="-1"></a> procedure Save(const aFileName:TFileName); <a href="#cb13-6" aria-hidden="true" tabindex="-1"></a> function Size:integer; </code></pre></div></td> </tr> </tbody> </table></td> <td><a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroSortFuncProcLazarus.txt">MacroSortFuncProcLazarus.txt</a></td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td></td> <td></td> </tr> <tr> <td>Sort selected units in the uses clause <table> <tbody> <tr> <td><div class="sourceCode" id="cb14"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb14-1" aria-hidden="true" tabindex="-1"></a> uses <a href="#cb14-2" aria-hidden="true" tabindex="-1"></a> Classes, SysUtils, Forms, Controls, Graphics, Dialogs; </code></pre></div></td> <td><div class="sourceCode" id="cb15"><pre class="sourceCode pascal"><code class="sourceCode pascal"><a href="#cb15-1" aria-hidden="true" tabindex="-1"></a> uses <a href="#cb15-2" aria-hidden="true" tabindex="-1"></a> Classes, Controls, Dialogs, Forms, Graphics, SysUtils;</code></pre></div></td> </tr> </tbody> </table></td> <td><a href="https://github.com/DomingoGP/LazarusMacroPasDoc/blob/master/MacroSortUsesLazarus.txt">MacroSortUsesLazarus.txt</a></td> </tr> <tr> <td></td> <td></td> </tr> </tbody> </table>

Editor Macros PascalScript

General

Availability

Simple actions

Functions

Objects provided

Caller: TSynEdit

ClipBoard: TClipBoard

Available Macros / Downloads

See also