Created a new page documenting available editor modes for GF

Also adding editing modes for Gedit and Geany contributed by John J. Camilleri.

6 files changed, 351 insertions, 0 deletions

diff --git a/doc/gf-editor-modes.t2t b/doc/gf-editor-modes.t2t
new file mode 100644
index 000000000..a511d9b19
--- /dev/null
+++ b/doc/gf-editor-modes.t2t
@@ -0,0 +1,64 @@
+Editor modes for GF
+
+
+%!style:../css/style.css
+%!options(html): --toc
+%!postproc(html): <H1> <H1><a href="../"><IMG src="../doc/Logos/gf0.png"></a>
+
+We collect GF modes for various editors on this page. Contributions are
+welcome!
+
+==Emacs==
+
+[gf.el ../src/tools/gf.el] by Johan Bockgård provides syntax highlighting and
+automatic indentation and lets you run the GF Shell in an emacs buffer.
+See installation instructions inside.
+
+
+==Gedit==
+
+[John J. Camilleri http://johnjcamilleri.com/]
+provided the following syntax highlighting mode for
+[Gedit http://www.gedit.org/] (the default text editor in Ubuntu).
+
+Copy the file below to
+``~/.local/share/gtksourceview-2.0/language-specs/gf.lang`` (under Ubuntu).
+
+- [gf.lang ../src/tools/gf.lang]
+
+
+Some helpful notes/links:
+
+- The code is based heavily on the ``haskell.lang`` file which I found in
+  ``/usr/share/gtksourceview-2.0/language-specs/haskell.lang``.
+- Ruslan Osmanov recommends 
+  [registering your file extension as its own MIME type http://osmanov-dev-notes.blogspot.com/2011/04/how-to-add-new-highlight-mode-in-gedit.html]
+  (see also [here https://help.ubuntu.com/community/AddingMimeTypes]),
+  however on my system the ``.gf`` extension was already registered
+  as a generic font (``application/x-tex-gf``) and I didn't want to risk
+  messing any of that up.
+- This is a quick 5-minute job and might require some tweaking.
+  [The GtkSourceView language definition tutorial http://developer.gnome.org/gtksourceview/stable/lang-tutorial.html]
+  is the place to start looking.
+- Contributions are welcome!
+
+
+==Geany==
+
+[John J. Camilleri http://johnjcamilleri.com/] provided the following
+[custom filetype http://www.geany.org/manual/dev/index.html#custom-filetypes]
+config files for syntax highlighting in [Geany http://www.geany.org/].
+
+Copy one of the files below to ``/usr/share/geany/filetypes.GF.conf``
+(under Ubuntu). You will need to manually create the file.
+
+- [light-filetypes.GF.conf ../src/tools/light-filetypes.GF.conf]
+- [dark-filetypes.GF.conf ../src/tools/dark-filetypes.GF.conf]
+
+
+You will also need to edit the ``filetype_extensions.conf`` file and add the
+following line somewhere:
+
+```
+GF=*.gf
+```
diff --git a/doc/index.html b/doc/index.html
index 1accf3fe6..3d2cda8dc 100644
--- a/doc/index.html
+++ b/doc/index.html
@@ -52,6 +52,11 @@
   Describes the commands available in the interactive GF shell. Also
   summarizes how to run GF as a batch compiler.
 
+  <li>
+  <a href="gf-editor-modes.html">Editor modes for GF</a>.
+  Editor modes for GF provides syntax highligting, automatic indentation and
+  other features that makes editing GF grammar files easier.
+  
 </ul>
 
 
diff --git a/index.html b/index.html
index 4ec66fb69..1036e9e1a 100644
--- a/index.html
+++ b/index.html
@@ -33,6 +33,7 @@ December 2010
 | <A HREF="doc/gf-bibliography.html">Publications</A>
 | <A HREF="doc/gf-reference.html">QuickRefCard</A>
 | <A HREF="doc/gf-shell-reference.html">GF Shell Reference</A>
+| <a href="doc/gf-editor-modes.html">GF Editor Modes</a>
 | <A HREF="doc/gf-lrec-2010.pdf">LibTutorial</A>
 | <A HREF="http://www.molto-project.eu">MOLTO</A>
 | <A HREF="http://school.grammaticalframework.org">SummerSchool</A>
diff --git a/src/tools/dark-filetypes.GF.conf b/src/tools/dark-filetypes.GF.conf
new file mode 100644
index 000000000..f1ffae48b
--- /dev/null
+++ b/src/tools/dark-filetypes.GF.conf
@@ -0,0 +1,37 @@
+# This file written by John J. Camilleri, June 2011
+# Geany documentation ref: http://www.geany.org/manual/dev/index.html#custom-filetypes
+
+[styling]
+# foreground;background;bold;italic
+default=0xffffff;0x1E1E1E;false;false
+commentline=0x747474;0x1E1E1E;false;false
+commentblock=0x747474;0x1E1E1E;false;false
+commentblock2=0x747474;0x1E1E1E;false;false
+commentblock3=0x747474;0x1E1E1E;false;false
+number=0x7ECDFF;0x1E1E1E;false;false
+keyword=0xFFCA4A;0x1E1E1E;true;false
+import=0x8C2421;0x1E1E1E;false;false
+string=0xA18651;0x1E1E1E;false;false
+character=0xA18651;0x1E1E1E;false;false
+class=0xB2A886;0x1E1E1E;True;false
+operator=0x98BAC5;0x1E1E1E;true;false
+identifier=0xffffff;0x1E1E1E;false;false
+capital=0x7BB25A;0x1E1E1E;false;false
+module=0xAD7DAD;0x1E1E1E;false;false
+data=0x5ABEFF;0x1E1E1E;false;false
+
+[keywords]
+keywords=PType Str Strs Type abstract case cat concrete data def flags fun in incomplete instance interface let lin lincat lindef of open oper param pre printname resource strs table transfer variants where with
+
+[settings]
+extension=gf
+
+comment_single=--
+comment_open={-
+comment_close=-}
+comment_use_indent=true
+
+#tag_parser=GF
+lexer_filetype=Haskell
+
+[build_settings]
diff --git a/src/tools/gf.lang b/src/tools/gf.lang
new file mode 100644
index 000000000..6ddd37fb8
--- /dev/null
+++ b/src/tools/gf.lang
@@ -0,0 +1,211 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!--
+
+ Author: John J. Camilleri
+ Copyright (C) 2011, John J. Camilleri
+ Based on haskell.lang by Duncan Coutts <duncan@haskell.org> and Anders Carlsson <andersca@gnome.org>
+
+ This library is free software; you can redistribute it and/or
+ modify it under the terms of the GNU Library General Public
+ License as published by the Free Software Foundation; either
+ version 2 of the License, or (at your option) any later version.
+
+ This library is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ Library General Public License for more details.
+
+ You should have received a copy of the GNU Library General Public
+ License along with this library; if not, write to the
+ Free Software Foundation, Inc., 59 Temple Place - Suite 330,
+ Boston, MA 02111-1307, USA.
+
+-->
+<language id="gf" _name="Grammatical Framework" version="2.0" _section="Sources">
+  <metadata>
+    <property name="mimetypes">text/x-gf;text/plain</property>
+    <property name="globs">*.gf</property>
+  </metadata>
+
+  <styles>
+    <style id="preprocessor" _name="Preprocessor" map-to="def:preprocessor"/>
+    <style id="comment"      _name="Comment"      map-to="def:comment"/>
+    <style id="variable"     _name="Variable"                         />
+    <style id="symbol"       _name="Symbol"                           />
+    <style id="keyword"      _name="Keyword"      map-to="def:keyword"/>
+    <style id="type"         _name="Data Type"    map-to="def:type"/>
+    <style id="string"       _name="String"       map-to="def:string"/>
+    <style id="character"    _name="Character"    map-to="def:character"/>
+    <style id="char-escape"  _name="Escaped Character" map-to="def:special-char"/>
+    <style id="decimal"      _name="Decimal"      map-to="def:decimal"/>
+  </styles>
+
+  <definitions>
+
+    <define-regex id="symbolchar">[!#$%&amp;*+./&gt;=&lt;?@:\\^|~-]</define-regex>
+
+    <context id="line-comment" style-ref="comment" end-at-line-end="true" class="comment" class-disabled="no-spell-check">
+      <start>(?&lt;!\%{symbolchar})--+(?!\%{symbolchar})</start>
+      <include>
+        <context ref="def:in-comment"/>
+        <context ref="haddock:line-paragraph"/>
+        <context ref="haddock:directive"/>
+      </include>
+    </context>
+
+    <context id="block-comment" style-ref="comment" class="comment" class-disabled="no-spell-check">
+      <start>\{-</start>
+      <end>-\}</end>
+      <include>
+        <context ref="def:in-comment"/>
+        <context ref="haddock:block-paragraph"/>
+        <context ref="haddock:directive"/>
+        <context ref="block-comment"/>
+      </include>
+    </context>
+
+    <context id="pragma" style-ref="preprocessor">
+      <start>\{-#</start>
+      <end>#-\}</end>
+    </context>
+
+    <context id="variable" style-ref="variable">
+      <match>\b[a-z_][0-9a-zA-Z_'#]*</match>
+    </context>
+
+    <context id="type-or-constructor" style-ref="type">
+      <match>\b[A-Z][0-9a-zA-Z._'#]*</match>
+    </context>
+
+    <!-- Must not extend parent context, or we end up matching
+         "\end{code}" as part of the Haskell context, but when in
+         literate haskell mode it should be terminating a code block. -->
+    <context id="symbol" style-ref="symbol" extend-parent="false">
+      <match>\%{symbolchar}+</match>
+    </context>
+
+    <context id="keysymbol" style-ref="keyword">
+      <prefix>(?&lt;!\%{symbolchar})</prefix>
+      <suffix>(?!\%{symbolchar})</suffix>
+      <keyword>\.\.</keyword>
+      <keyword>::</keyword>
+      <keyword>=</keyword>
+      <keyword>\|</keyword>
+      <keyword>\</keyword>
+      <keyword>-&gt;</keyword>
+      <keyword>&lt;-</keyword>
+      <keyword>@</keyword>
+      <keyword>~</keyword>
+      <keyword>=&gt;</keyword>
+    </context>
+
+    <define-regex id="escaped-character" extended="true">
+        \\(                   # leading backslash
+        [abfnrtv\\"\'&amp;] | # escaped character
+         [0-9]+ |             # decimal digits
+        o[0-7]+ |             # 'o' followed by octal digits
+        x[0-9A-Fa-f]+ |       # 'x' followed by hex digits
+        \^[A-Z@\[\\\]^_] |    # control character codes
+        NUL | SOH | STX | ETX | EOT | ENQ | ACK |
+        BEL | BS | HT | LF | VT | FF | CR | SO |
+        SI | DLE | DC1 | DC2 | DC3 | DC4 | NAK |
+        SYN | ETB | CAN | EM | SUB | ESC | FS | GS |
+        RS | US | SP | DEL    # control char names
+        )
+    </define-regex>
+
+    <context id="string" style-ref="string" end-at-line-end="true" class="string" class-disabled="no-spell-check">
+      <start>"</start>
+      <end>"</end>
+      <include>
+        <context ref="def:line-continue"/>
+        <context style-ref="char-escape">
+          <match>\%{escaped-character}</match>
+        </context>
+      </include>
+    </context>
+
+    <context id="char" style-ref="character" end-at-line-end="true">
+      <start>'</start>
+      <end>'</end>
+      <include>
+        <context style-ref="char-escape" once-only="true">
+          <match>\%{escaped-character}</match>
+        </context>
+        <context once-only="true" extend-parent="false">
+          <match>.</match>
+        </context>
+        <context style-ref="def:error" extend-parent="false">
+          <match>.</match>
+        </context>
+      </include>
+    </context>
+
+    <context id="decimal" style-ref="decimal">
+      <match>[0-9]+</match>
+    </context>
+
+    <context id="keyword" style-ref="keyword">
+		<keyword>PType</keyword>
+		<keyword>Str</keyword>
+		<keyword>Strs</keyword>
+		<keyword>Type</keyword>
+		<keyword>abstract</keyword>
+		<keyword>case</keyword>
+		<keyword>cat</keyword>
+		<keyword>concrete</keyword>
+		<keyword>data</keyword>
+		<keyword>def</keyword>
+		<keyword>flags</keyword>
+		<keyword>fun</keyword>
+		<keyword>in</keyword>
+		<keyword>incomplete</keyword>
+		<keyword>instance</keyword>
+		<keyword>interface</keyword>
+		<keyword>let</keyword>
+		<keyword>lin</keyword>
+		<keyword>lincat</keyword>
+		<keyword>lindef</keyword>
+		<keyword>of</keyword>
+		<keyword>open</keyword>
+		<keyword>oper</keyword>
+		<keyword>param</keyword>
+		<keyword>pre</keyword>
+		<keyword>printname</keyword>
+		<keyword>resource</keyword>
+		<keyword>strs</keyword>
+		<keyword>table</keyword>
+		<keyword>transfer</keyword>
+		<keyword>variants</keyword>
+		<keyword>where</keyword>
+		<keyword>with</keyword>
+    </context>
+
+    <context id="body">
+      <include>
+        <context ref="line-comment"/>
+        <context ref="pragma"/>
+        <context ref="block-comment"/>
+        <context ref="keyword"/>
+        <context ref="variable"/>
+        <context ref="type-or-constructor"/>
+        <context ref="keysymbol"/>
+        <context ref="symbol"/>
+        <context ref="string"/>
+        <context ref="char"/>
+        <context ref="decimal"/>
+      </include>
+    </context>
+
+    <context id="gf" class="no-spell-check">
+      <include>
+        <context ref="def:shebang"/>
+        <context ref="c:if0-comment"/>
+        <context ref="c:include"/>
+        <context ref="c:preprocessor"/>
+        <context ref="body"/>
+      </include>
+    </context>
+
+  </definitions>
+</language>
\ No newline at end of file
diff --git a/src/tools/light-filetypes.GF.conf b/src/tools/light-filetypes.GF.conf
new file mode 100644
index 000000000..d2f0904c4
--- /dev/null
+++ b/src/tools/light-filetypes.GF.conf
@@ -0,0 +1,33 @@
+# This file written by John J. Camilleri, June 2011
+# Geany documentation ref: http://www.geany.org/manual/dev/index.html#custom-filetypes
+[styling]
+default=0x000000;0xffffff;false;false
+commentline=0x808080;0xffffff;false;false
+commentblock=0x808080;0xffffff;false;false
+commentblock2=0x808080;0xffffff;false;false
+commentblock3=0x808080;0xffffff;false;false
+number=0x007f00;0xffffff;false;false
+keyword=0x00007f;0xffffff;true;false
+import=0x991111;0xffffff;false;false
+string=0xff901e;0xffffff;false;false
+character=0x7f007f;0xffffff;false;false
+class=0x0000d0;0xffffff;false;false
+operator=0x301010;0xffffff;false;false
+identifier=0x000000;0xffffff;false;false
+instance=0x000000;0xffffff;false;false
+capital=0x635b00;0xffffff;false;false
+module=0x007f7f;0xffffff;false;false
+data=0x000000;0xffffff;false;false
+
+[keywords]
+keywords=PType Str Strs Type abstract case cat concrete data def flags fun in incomplete instance interface let lin lincat lindef of open oper param pre printname resource strs table transfer variants where with
+
+[settings]
+extension=gf
+
+comment_single=--
+comment_open={-
+comment_close=-}
+comment_use_indent=true
+
+lexer_filetype=Haskell