syn Users Manual Users Manual for syn Version 2.1 September 23, 2003 Stefan Ascher Abstract This is the Document which describes syn. If you don’t know how to figure out some stuff you should consult this paper. syn is an Open Source Text- and Programming Editor with Syntaxhighlight for many Languages, and some IDE Features, like starting a program (e.g. Compiler) and capture the output, support for Projects etc. syn is written in Delphi (Version 5, Updatepack 1) for maximum performance, stability and filesize, hence it doesn’t require any bulky VC++/VB Runtime or MFC libraries! I tried to keep this program as general as possible, to make it useable for many purposes, but the primary intendentation is the usage in conjunction with Compilers and Interpreters. This is the reason that there is much to configure, and it appears complicated at the beginning. It could also be a good startingpoint for your own IDE written with Delphi, because the Editor part is already done. The documentation consits of three files, syn.pdf this document, qaa.pdf some questions and answeres and scriptref.pdf the Script reference. References in the Document will appear as blue Link, Links to Internet Sites are coloured red. To jump to the target from a Link click on it. The References show the number from the section, figure or table. CONTENTS I Contents 1 Introduction 1 2 Copyright 2 2.1 Trademarks ................................. 2 3 License 3 3.1 Ataglance ................................. 3 3.2 Manual.................................... 3 4 Installation 4 4.1 Install .................................... 4 4.2 Uninstall................................... 4 4.3 Update.................................... 4 4.4 Repair .................................... 5 5 Getting Started 6 5.1 Profiles.................................... 6 5.1.1 Configure Profiles . 8 5.1.2 Run Profile Directive . 9 5.1.3 Output Expression . 10 5.1.4 Examples.............................. 11 5.1.5 Using Environment Variables . 14 5.1.6 Interacting with the Console . 15 5.2 Variables................................... 15 5.2.1 Run................................. 15 5.2.2 InsertString ............................ 17 5.3 Using syn as Console Window . 17 5.4 DelphiFormfiles .............................. 21 CONTENTS II 5.5 Tools..................................... 21 5.5.1 Launch a Program . 21 5.5.2 Execute an Editcommand . 22 5.5.3 InsertaString ........................... 22 5.6 Projects . 22 5.7 Monitor for external changes . 24 5.8 LimittooneInstance............................ 24 5.9 Generating PDF Files . 25 5.10 The Custom Highlighter . 25 5.10.1 Fileformat ............................. 25 5.11 Autocomplete ................................ 27 5.11.1 Example for Object Pascal . 28 5.11.2 PopupList ............................. 29 5.12 Editcommands................................ 30 5.12.1 Uncategorized Commands . 30 5.12.2 Fomat................................ 31 5.12.3 ChangeCase............................ 32 5.12.4 Block ................................ 32 5.12.5 Advanced.............................. 33 5.13 Searchcommands .............................. 34 5.13.1 Find................................. 34 5.13.2 Find next/previous Word . 34 5.13.3 Incremental Search . 35 5.13.4 FindinFiles ............................ 35 5.13.5 Replace............................... 37 5.13.6 Goto................................ 37 5.13.7 Goto previous/next Output Item . 38 5.13.8 Gotolastchange ......................... 38 CONTENTS III 5.13.9 ShowCaret............................. 38 5.14 UsingCtags ................................. 38 5.15 Calling a Helpfile depending on the Syntax Sheme . 40 5.16 FTP ..................................... 40 5.17 FileExplorer ................................ 42 5.18 BookmarkFiles ............................... 44 6 Menus 45 6.1 FileMenu .................................. 45 6.2 EditMenu.................................. 46 6.3 SearchMenu................................. 46 6.4 View Menu . 46 6.5 Project Menu . 47 6.6 RunMenu.................................. 47 6.7 ScriptMenu................................. 47 6.8 ToolsMenu ................................. 48 6.9 WindowMenu................................ 48 6.10 Help Menu . 49 6.11 EditorPopupMenu............................. 49 6.12 Window Bar Popup Menu . 49 6.13 Workspace Popup Menu . 49 6.14 File Explorer Popup Menu . 51 6.15 Output Window Popup Menu . 51 6.16 Marker Popup Menu . 52 7 Toolbars 54 7.1 MainToolbar ................................ 54 7.2 Project Toolbar . 54 7.3 RunToolbar................................. 54 CONTENTS IV 7.4 EditToolbar................................. 54 7.5 ScriptToolbar................................ 54 7.6 ToolsToolbar ................................ 55 7.7 WindowToolbar .............................. 55 7.8 FileExplorer ................................ 55 7.9 Worspace .................................. 55 7.10 OutputWindow............................... 55 7.11 WindowBar................................. 58 7.12 StatusBar.................................. 58 8 Program Options 60 8.1 General ................................... 61 8.2 View..................................... 62 8.3 Print..................................... 63 8.4 Associations . 63 8.5 Run ..................................... 64 8.6 Scripts.................................... 65 8.7 Tools..................................... 66 8.8 FTP ..................................... 66 8.9 Editor General . 67 8.10 Syntaxhighlight . 68 8.11 Highlighter.................................. 68 8.11.1 Highlight .............................. 68 8.11.2 Autocomplete ........................... 68 8.11.3 Profiles ............................... 70 8.11.4 Help................................. 70 8.11.5 Ctags................................ 70 8.12 Autocorrect . 71 8.13 Spell Checker . 71 CONTENTS V 8.14 Editoroptions ................................ 72 8.15 Gutter .................................... 73 8.16 Shortcuts .................................. 73 9 Page Setup 74 9.1 Margins ................................... 74 9.2 Header/Footer . 74 10 Customize 76 10.1 Toolbars ................................... 76 10.2 Keyboard .................................. 77 10.3 Mouse .................................... 77 10.4 Options ................................... 78 11 Projectoptions 80 11.1 General ................................... 80 11.2 Files ..................................... 80 11.3 Profiles.................................... 81 11.4 Tools..................................... 81 12 Other Windows 82 12.1 ParametersDialog.............................. 82 12.2 NewDialog ................................. 83 12.3 WelcomeDialog............................... 83 12.4 ConfigureTools ............................... 83 12.4.1 Launch Program . 86 12.4.2 InsertString ............................ 87 12.4.3 Execute Editcommand . 87 12.4.4 DOSCommand .......................... 87 12.5 SaveDialog ................................. 87 CONTENTS VI 12.6 Confirm Replace Dialog . 88 12.7 MarkerDialog................................ 88 12.8 File Properties Dialog . 89 12.9 FileVersions................................. 90 12.10 WindowsDialog............................... 90 12.11 Print Preview Window . 91 12.12 KeyboardMap ............................... 91 13 Default Keyboard Map 93 13.1 File...................................... 93 13.2 Edit ..................................... 94 13.3 Search .................................... 95 13.4 View..................................... 96 13.5 Project . 96 13.6 Run ..................................... 96 13.7 Script .................................... 96 13.8 Tools..................................... 97 13.9 Window ................................... 97 13.10 Help ..................................... 97 14 Commandline Switches 98 15 Messages 100 16 Regular Expressions 102 16.1 Someexamples ............................... 102 16.2 Detailed explanation . 102 17 Escape Sequences 105 CONTENTS VII 18 SynTray 106 18.1 Menu..................................... 106 18.2 Commandline Switches . 107 19 asgrep 108 19.1 License.................................... 108 19.2 Introduction................................. 108 19.3 Commandline Switches . 108 19.4 Using a configurationfile . 109 19.5 Results.................................... 111 19.6 ReplaceText................................. 111 19.7 Credits.................................... 111 20 synclp 112 20.1 License.................................... 112 20.2 Introduction................................. 112 20.3 Commandline Switches . 112 21 Requirements 114 22 Known Problems 115 23 Features 116 23.1 Available Highlighters . 117 24 What’s planned 120 A Statistics 121 A.1 Forsyn.exe ................................. 121 A.1.1 Project Lines . 121 A.1.2 LibraryLines............................ 121 CONTENTS VIII A.1.3 TotalLines............................. 121 A.1.4 Routines .............................. 121 A.1.5 Variables .............................. 121 A.1.6 Constants.............................. 121 A.1.7 Classes . 121 A.1.8 Interfaces . 122 A.1.9 Records............................... 122 B syn Developers 123 C Credits and Contributors 124 D Contact 126 E Mozilla Public License Version 1.1 127 E.1 Definitions. ................................. 127 E.2 Source Code License. 128 E.3 Distribution Obligations. 130 E.4 Inability to Comply Due to Statute or Regulation. 132 E.5 Application of this License. 132 E.6 Versions of the License. 133 E.7