Merge lp:~mefrio-g/scratch/bug-139057 into lp:~elementary-apps/scratch/scratch

[Mario Guerriero]

Fix bug #139057

Make adding support for new languages easier. You just need to add the .lang file in the data/language-specs if you want to add support for a new language.

[lp:~mefrio-g/scratch/bug-139057]

1594. By Mario Guerriero on 2015-11-21

using personal language-specs folder

[Gero.Bare (gero-bare)]

Ok this seems to work fine, but it's missing something important.
A license.

The first time I saw it, I missed it, but there's no license.
The license needs to be free software (or equivalent that allow redistribution, modify, etc).

Contact the creator, we don't need a permission, that wont work we need a free license (or equivalent, MIT, apache, lgpl, gpl3, BSD).

The lang spec, needs to have the copyright notice, and if the license is not gpl 2, it should be packed with scratch... that part goes beyond my knowledge so you will need to ask ric*tz, or c*dy, or daniel.

Also I didn't know you only need it to copy the lang spec file to /home/<user>/.local/share/gtksourceview-3.0/language-specs

Which defeat most of the purpose of this. I don't know, we might need to discuss this part further.

review: Needs Fixing

[Gero.Bare (gero-bare)]

Ok, I don't think this is a good Idea.

I discussed this, the proper action is to add the file to GtkSourceView, and not here.

The license issue remains, so if you want to add it to Gtksourceview you have 2 path.
Contact the people of GtkSourceview, or convince some one that is responsible to pack Gtksourceview for elementary to be added there.

Ideally this should be fixed upstream.

I need to disapprove this.

review: Disapprove

[Mario Guerriero (mefrio-g)]

Thanks for the review. I posted a patch for the upstream project.

https://bugzilla.gnome.org/show_bug.cgi?id=741626

Unmerged revisions

1594. By Mario Guerriero on 2015-11-21

using personal language-specs folder

1593. By Mario Guerriero on 2015-11-20

fixed #1390577

=== modified file 'CMakeLists.txt'
--- CMakeLists.txt	2015-09-01 09:34:28 +0000
+++ CMakeLists.txt	2015-11-21 15:15:56 +0000
@@ -6,6 +6,7 @@
 enable_testing ()
 include (GNUInstallDirs)
 set (DATADIR "${CMAKE_INSTALL_FULL_DATAROOTDIR}/scratch")
+set (LANGUAGE_SPECS_DIR "${DATADIR}/language-specs")
 set (SCRIPTDIR "${CMAKE_INSTALL_FULL_DATAROOTDIR}/scratch/scripts")
 set (PKGDATADIR "${DATADIR}/scratch")
 set (GETTEXT_PACKAGE "scratch-text-editor")
@@ -101,3 +102,4 @@
 
 # Data
 install (FILES ${CMAKE_CURRENT_SOURCE_DIR}/data/scratch-text-editor.desktop DESTINATION ${CMAKE_INSTALL_FULL_DATAROOTDIR}/applications)
+install (DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}/data/language-specs DESTINATION ${DATADIR})

=== added directory 'data/language-specs'
=== added file 'data/language-specs/mustache.lang'
--- data/language-specs/mustache.lang	1970-01-01 00:00:00 +0000
+++ data/language-specs/mustache.lang	2015-11-21 15:15:56 +0000
@@ -0,0 +1,109 @@
+<?xml version="1.0" encoding="UTF-8"?> <!--
+
+  ╔══════════════════════════════════════════════════════════╗
+  ║ Author: denim2x <https://github.com/denim2x>             ║ 
+  ╟──────────────────────────────────────────────────────────╢  
+  ║ This file provides syntax highlighting for the Mustache  ║ 
+  ║ language within editors based on GtkSourceView; based on ║  
+  ║ asp.lang <https://goo.gl/1lrGu6>.                        ║ 
+  ╚══════════════════════════════════════════════════════════╝
+
+-->
+<language id="mustache" _name="Mustache" version="2.0" _section="Markup"> 
+  <metadata>
+    <property name="mimetypes">text/x-handlebars-template;text/html</property>
+    <property name="globs">*.handlebars;*.hbs;*.hgn;*.hjs;*.mu;*.mustache;*.stache</property>
+    <property name="block-comment-start">{{!</property>
+    <property name="block-comment-end">}}</property>
+  </metadata>
+
+  <styles>
+    <style id="comment"   _name="Comment"   map-to="def:comment"      />
+    <style id="delimiter" _name="Delimiter" map-to="def:type"         />
+    <style id="key"       _name="Key"       map-to="def:identifier"   />
+    <style id="operator"  _name="Operator"  map-to="def:operator"     />
+    <style id="partial"   _name="Partial"   map-to="def:preprocessor" />
+    <style id="section"   _name="Section"   map-to="def:statement"    />
+    <style id="tag"       _name="Tag"       map-to="def:keyword"      />
+    <style id="variable"  _name="Variable"  map-to="def:function"     />
+    <style id="unescaped" _name="Unescaped" map-to="def:constant"     />
+  </styles>
+
+  <definitions>
+    <context id="comment" style-ref="comment">
+      <start>\{\{\!</start>
+      <end>\}\}</end>
+      <include>
+        <context ref="def:in-comment"/>
+      </include>
+    </context>
+
+    <context id="delimiter" style-ref="delimiter">
+      <start>\{\{=</start>
+      <end>=\}\}</end>
+      <include>
+        <context ref="def:string"/>
+      </include>
+    </context>
+
+    <context id="key" style-ref="key">
+      <match>[a-zA-Z_][a-zA-Z0-9_]*</match>
+    </context>
+
+    <context id="partial" style-ref="partial">
+      <start>\{\{&gt;</start>
+      <end>\}\}</end>
+      <include>
+        <context ref="key"/>
+      </include>
+    </context>
+
+    <context id="section" style-ref="section">
+      <start>\{\{([#^/])</start>
+      <end>(\?)?\}\}</end>
+      <include>
+        <context sub-pattern="0" where="start" style-ref="operator"/>
+        <context sub-pattern="0" where="end" style-ref="operator"/>
+        <context ref="key"/>
+      </include>
+    </context>
+
+    <context id="unescaped" style-ref="unescaped">
+      <start>\{\{\{</start>
+      <end>\}\}\}</end>
+      <include>
+        <context ref="key"/>
+      </include>
+    </context>
+
+    <context id="unescaped-amp" style-ref="unescaped">
+      <start>\{\{&amp;</start>
+      <end>\}\}</end>
+      <include>
+        <context ref="key"/>
+      </include>
+    </context>
+
+    <context id="variable" style-ref="variable">
+      <start>\{\{</start>
+      <end>\}\}</end>
+      <include>
+        <context ref="key"/>
+      </include>
+    </context>
+
+    <context id="mustache" class="no-spell-check">
+      <include>
+        <context ref="comment"       />
+        <context ref="delimiter"     />
+        <context ref="partial"       />
+        <context ref="section"       />
+        <context ref="unescaped"     />
+        <context ref="unescaped-amp" />
+        <context ref="variable"      />
+        <context ref="html:html"     />
+      </include>
+    </context>
+
+  </definitions>
+</language>
\ No newline at end of file

=== modified file 'src/Services/Document.vala'
--- src/Services/Document.vala	2015-09-16 01:11:55 +0000
+++ src/Services/Document.vala	2015-11-21 15:15:56 +0000
@@ -90,6 +90,16 @@
             this.main_actions = actions;
             this.file = file;
 
+            // Change directories list where gtksourceview looks for language files
+            Gtk.SourceLanguageManager manager = Gtk.SourceLanguageManager.get_default ();
+            string[] search_path = manager.get_search_path ();
+            string[] custom_search_path = new string[search_path.length + 1];
+            int i;
+            for (i = 0; i < search_path.length; i++)
+                custom_search_path[i] = search_path[i];
+            custom_search_path[i] = Constants.LANGUAGE_SPECS_DIR;
+            manager.set_search_path (custom_search_path);
+
             open.begin ();
         }
 

=== modified file 'src/config.vala.cmake'
--- src/config.vala.cmake	2014-11-12 11:20:08 +0000
+++ src/config.vala.cmake	2015-11-21 15:15:56 +0000
@@ -8,6 +8,7 @@
    public const string VERSION_INFO = "@VERSION_INFO@";
    public const string PLUGINDIR = "@PLUGINDIR@";
    public const string INSTALL_PREFIX = "@CMAKE_INSTALL_PREFIX@";
+   public const string LANGUAGE_SPECS_DIR = "@LANGUAGE_SPECS_DIR@";
 
    /* Translatable launcher (.desktop) strings to be added to   */
    /* template (.pot) file. These strings should reflect any    */