Creating a custom lexer for Code::Blocks editor - Revision history

MortenMacFly: /* Tips */

2017-02-19T19:02:50Z

Tips

Alpha: Added link to GtkSourceView.

2012-09-26T03:30:30Z

Added link to GtkSourceView.

Alpha: Added link.

2012-01-17T22:45:11Z

Added link.

Alpha: Added "See also".

2011-09-29T22:00:18Z

Added "See also".

Danselmi: /* Adding support for a lexer not supported in Scintilla */

2009-12-03T18:46:14Z

Adding support for a lexer not supported in Scintilla

Jazzboy: /* Keywords */

2007-09-21T23:09:28Z

Keywords

Dmoore at 13:53, 1 June 2007

2007-06-01T13:53:17Z

Dmoore at 17:49, 31 May 2007

2007-05-31T17:49:57Z

Dmoore at 17:48, 31 May 2007

2007-05-31T17:48:05Z

Dmoore at 17:46, 31 May 2007

2007-05-31T17:46:04Z

@@ Line 139: / Line 139: @@
 ==Tips==
-When writting a lexer, this can be useful:
+When writing a lexer, this can be useful:
 * .properties files of SciTE (the official Scintilla-based text editor) [http://scintilla.sourceforge.net/SciTE.html]
 * .lang files of GtkSourceView (used Gedit) [http://git.gnome.org/browse/gtksourceview/tree/data/language-specs]

@@ Line 141: / Line 141: @@
 When writting a lexer, this can be useful:
 * .properties files of SciTE (the official Scintilla-based text editor) [http://scintilla.sourceforge.net/SciTE.html]
+* .lang files of GtkSourceView (used Gedit) [http://git.gnome.org/browse/gtksourceview/tree/data/language-specs]
 ==Adding support for code-folding==

@@ Line 28: / Line 28: @@
 * '''filemasks''' is a comma separated list of the extensions that this lexer should be used for. This is case-insensitive.
-* '''index''' corresponds with the <tt>wxSCI_LEX_*</tt> constants, found in <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>. In this example, if you look in <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>, you'll see that ''index 3'' matches <tt>wxSCI_LEX_CPP</tt>. That is the ''lexer id'' for C/C++ syntax highlighting.
+* '''index''' corresponds with the <tt>wxSCI_LEX_*</tt> constants, found in [http://svn.berlios.de/wsvn/codeblocks/trunk/src/sdk/wxscintilla/include/wx/wxscintilla.h <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>]. In this example, if you look in <tt>sdk/wxscintilla/include/wx/wxscintilla.h</tt>, you'll see that ''index 3'' matches <tt>wxSCI_LEX_CPP</tt>. That is the ''lexer id'' for C/C++ syntax highlighting.
 If we were building a lexer configuration for let's say, XML (random choice) we would look up the constant <tt>wxSCI_LEX_XML</tt> which is defined to be number ''5''. So ''index=5''. Simple.

← Older revision		Revision as of 22:00, 29 September 2011
Line 160:		Line 160:

	* And finishing, be sure to send all to the [http://developer.berlios.de/patch/?func=addpatch&group_id=5358 Code::Blocks tracker] (Category: Lexer), and announce it at the [/index.php?board=7.0 Forum] and the [[Announcement for plugins/patches\|Wiki announcement for plugins/patches]].		* And finishing, be sure to send all to the [http://developer.berlios.de/patch/?func=addpatch&group_id=5358 Code::Blocks tracker] (Category: Lexer), and announce it at the [/index.php?board=7.0 Forum] and the [[Announcement for plugins/patches\|Wiki announcement for plugins/patches]].
		+
		+	==See also==
		+	* [[Languages supported by Code::Blocks lexers]]

@@ Line 153: / Line 153: @@
 '''Note: support for a lexer not supported in Scintilla is out of scope of Code::Blocks. It must be done right in the Scintilla code.'''
-Here are some instructions: http://scintilla.sourceforge.net/Lexer.txt
+Here are some instructions: http://scintilla.sourceforge.net/Lexer.txt. To be able to use your newly created lexer in C::B, adjust the validity check of "lexer" in EditorColourSet::AddHighlightLanguage().
 * After you've written the Scintilla lexer, submit the files to the [http://sourceforge.net/tracker/?group_id=2439 Scintilla tracker], following their own [http://scintilla.sourceforge.net/SciCoding.html coding style].

@@ Line 95: / Line 95: @@
          </Keywords>
-If the language you're defining a lexer configuration for, has keywords they should be added in the <tt><Keywords></tt> tag.
+If you are defining a lexer configuration for a language that has keywords they should be added in the <tt><Keywords></tt> tag.
 In the scintilla version used by Code::Blocks, you can setup up to 9 keyword sets (the "index" attribute). What each set does and which sets are used by a lexer, is defined by the lexer itself.

@@ Line 1: / Line 1: @@
 [[Category:Developer Documentation]]
-Code::Blocks can provide syntax highlighting for any of the languages supported by Scintilla
+Code::Blocks can provide syntax highlighting for any of the languages supported by Scintilla http://www.scintilla.org (the Rich Editing API used by C::B to provide syntax highlighting, code folding etc). Each language that C::B provides highlighting for has a C::B specific xml file found under <tt>sdk/resources/lexers</tt> that specifies styles and keywords of the language (they're simple XML files with names of the form <tt>lexer_*.xml</tt>). Adding a new language that is supported by Scintilla is as simple as adding an xml file for that language. At a minimum, the xml file must list the available set of styles for the lexical elements of a language and provide for keywords (the file will also specify a file containing sample code for editing and previewing lexer styles in Code::Blocks). Actual styles and keywords for each language can be edited by users within Code::Blocks under Settings->Editors->Syntax Highlighting allowing them view the results in a preview window (for the preview to display you will need to provide this sample code in a separate file also located in <tt>sdk/resources/lexers</tt>). User customized styles and keywords are kept in the users <tt>default.conf</tt> file (i.e. the xml file is never changed within codeblocks) allowing users to easily revert to the xml file.
 To illustrate how you might construct a new lexer xml file let's look at the pre-installed CPP lexer, whose styles and keywords are stored in <tt>lexer_cpp.xml</tt>.