SynCodeIntel plugin

SynCodeIntel

Intro
How to install
How to use
How to specify search paths
Config file
About

Intro

Intelligent auto-completion plugin for SynWrite editor, for several lexers: Python (note: for Python lexer better use another plugin SynJedi), PHP, Perl, Ruby, JavaScript, Tcl, SCSS, LESS.
Based on CodeIntel2 library from ActiveState (it's also used in Komodo Edit).

How to install

Latest SynWrite supports plugins auto-installing. Just open "SynCodeIntel.rar" file in SynWrite, you'll see plugin installation prompt. Confirm it, then wait until "unrar" window finishes its work.

Note: if you have renamed one of supported lexers, correct also lexer name in "SynPlugins.ini" file, using command "Options -- Advanced -- Edit file SynPlugins.ini".

How to use

Notes

Plugin runs server window, it's minimized, you can close it at any time, after work in editor is finished. Server starts slowly (4-5 sec or more) but works fast.
Plugin creates big database, you can delete its folder: %userprofile%\.codeintel.
If plugin fails, you should see message in SynWrite statusbar, e.g. "[SynCodeIntel] Cannot parse position". This msg in statusbar is visible only for 1.5 sec.

1) Auto-completion

Open for ex Python script, place caret after "objname." (where objname is some object instance), and press Ctrl+Space (default auto-completion shortcut). You should see message in SynWrite statusbar "Trying auto-complete: .........", then you should see, after server reply, auto-completion list for your objname.

For PHP lexer you should place caret after "objname->", PHP uses "->" instead of a dot.

2) Function hints

You can place caret after "objname.funcname(" and press Ctrl+Shift+Space (default func-hint shortcut), after server reply, you'll see function hint, above caret, for function "objname.funcname".

3) Find symbol definition

Right-click any identifier (class name, function name, variable, etc), to call editor context menu, and choose menu item "Find ID" (if menu item is disabled, you didn't configure "SynPlugins.ini" section [FindID]). If id declaration can be found by CodeIntel library, you'll see "Found" message in statusbar, and caret placed on line-start of id declaration (CodeIntel doesn't return column position).

Also you can use Ctrl+Alt+click, instead of context menu.

How to specify search paths

You can specify additional folders, for your custom libraries (for any of these languages: PHP/Python/Perl/Ruby/JavaScript), using one or both of methods:

list folders in SynWrite options dialog, "Path Environment" tab;
list folders in current SynWrite project's properties dialog (if you have different folders for each project).

Notes:

If you have changed search folders, server window must be closed, to apply this setting to server.
SynWrite feature "append '*' to search folder to search in all subfolders" isn't supported here.

Config file

You may create file "SynCodeIntel.ini" in the plugin folder and write there few options in section [ini]:

datadir: Specifies folder where plugin finds its folder "server".
hints (bool, 0 or 1): Enables to show function hints.
server_port: Specifies TCP port for server process. Default is 11112.
server_hide (bool): Enables to hide server window (otherwise window is minimized).

About

License for SynCodeIntel is Mozilla Public License 1.1.