Ace modes for all compatible markups (#1420)

* Add support for gollum tags

lib/gollum/public/gollum/javascript/editor/modes.js.erb

@@ -1,16 +1,17 @@
 /*  modes.js
 
-    Add highlighting rules for gollum-specific block level syntax to ACE.
+    Add highlighting rules for gollum-specific syntax to ACE.
     We first have to extends the Highlighters for each supported syntax,
     so that later, we can extend the relevant ACE Mode to use the custom Highlighter.
-    We do this for all and only those languages which ACE supports, i.e.,
-    for which it has a specific Highlighter and Mode. So we do not extend e.g. Creole,
-    for which there is no ACE Mode (we use the 'text mode' instead).
     At the moment there are two gollum-wide block level syntaxes which need to be added:
 
     * GitHub style code blocks: ``` ... ```
     * UML blocks: @startuml ... @enduml
 
+    In addition, there are universal gollum tags:
+
+    [[link]]]
+
     The regexes defined for these below should be equivalent to the regexes used by
     gollum-lib to extract these blocks.
 
@@ -19,6 +20,12 @@
       * Dynamically generating modes: https://stackoverflow.com/questions/22166784/dynamically-update-syntax-highlighting-mode-rules-for-the-ace-editor
 */
 
+// For Gollum link tags
+var GollumTagStart = {
+  token: "support.function",
+  regex: "\\[\\[.*\\]\\]",
+  next: 'start'
+};
 
 <%
 uml_rule_name = 'UMLBlock'
@@ -99,8 +106,10 @@ var MarkdownCodeStart = {
 default_rules = {
   :path => '',
   :rule_name => '',
-  :start_rules => ['GollumCodeStart', 'UMLStart'],
+  :start_rules => ['GollumTagStart', 'UMLStart', 'GollumCodeStart'],
-  :block_rules => {codeblock_rule_id => codeblock_rule_name, uml_rule_id => uml_rule_name}
+  :block_rules => { codeblock_rule_id => codeblock_rule_name, 
+                    uml_rule_id => uml_rule_name,
+                  }
 }
 
 rst_rules = default_rules.dup
@@ -108,6 +117,7 @@ rst_rules[:path] = 'ace/mode/rst_highlight_rules'
 rst_rules[:rule_name] = 'RSTHighlightRules'
 
 asciidoc_rules = default_rules.dup
+asciidoc_rules[:start_rules] = ['UMLStart', 'GollumCodeStart'] # Gollum tags are disabled for asciidoc
 asciidoc_rules[:path] = 'ace/mode/asciidoc_highlight_rules'
 asciidoc_rules[:rule_name] = 'AsciidocHighlightRules'
 
@@ -115,16 +125,27 @@ textile_rules = default_rules.dup
 textile_rules[:path] = 'ace/mode/textile_highlight_rules'
 textile_rules[:rule_name] = 'TextileHighlightRules'
 
+rdoc_rules = default_rules.dup
+rdoc_rules[:path] = 'ace/mode/rdoc_highlight_rules'
+rdoc_rules[:rule_name] = 'RDocHighlightRules'
+
+# Create set of extended rules for markups that don't have their own Ace mode, based on the default 'text' highligter.
+text_rules = default_rules.dup
+text_rules[:path] = 'ace/mode/text_highlight_rules'
+text_rules[:rule_name] = 'TextHighlightRules'
+
 markdown_rules = default_rules.dup
 markdown_rules[:path] = 'ace/mode/markdown_highlight_rules'
 markdown_rules[:rule_name] = 'MarkdownHighlightRules'
-markdown_rules[:start_rules] = ['GollumCodeStart', 'UMLStart', 'MarkdownCodeStart'] # Markdown pages should also support fenced code blocks
+markdown_rules[:start_rules] = ['GollumTagStart', 'UMLStart', 'GollumCodeStart', 'MarkdownCodeStart'] # Markdown pages should also support fenced code blocks
 
 
 {
   'GollumRstHighlightRules'      => rst_rules,
   'GollumAsciidocHighlightRules' => asciidoc_rules,
   'GollumTextileHighlightRules'  => textile_rules,
+  'GollumTextHighlightRules'     => text_rules,
+  'GollumRdocHighlightRules'     => rdoc_rules,
   'GollumMarkdownHighlightRules' => markdown_rules 
 }.each do |name, highlighter|
 %>
@@ -161,26 +182,59 @@ ace.define("<%= name %>", [], function(require, exports, module) {
 
 (function($) {
   var AceMode = {
-    asciidoc: 'GollumAsciidocHighlightRules',
+    asciidoc: {
-    creole: 'text',
+      mode: 'asciidoc',
-    markdown: 'GollumMarkdownHighlightRules',
+      highlighter: 'GollumAsciidocHighlightRules'
-    mediawiki: 'text',
+    },
-    bib: 'latex',
+    creole: {
-    org: 'text',
+      mode: 'text',
-    rst: 'GollumRstHighlightRules',
+      highlighter: 'GollumTextHighlightRules'
-    txt: 'text',
+    },
-    pod: 'text',
+    markdown: {
-    rdoc: 'rdoc',
+      mode: 'markdown',
-    textile: 'GollumTextileHighlightRules'
+      highlighter: 'GollumMarkdownHighlightRules'
+    },
+    mediawiki: {
+      mode: 'text',
+      highlighter: 'GollumTextHighlightRules'
+    },
+    bib: {
+      mode: 'latex'
+    },
+    org: {
+      mode: 'text',
+      highlighter: 'GollumTextHighlightRules'
+    },
+    rst: {
+      mode: 'rst',
+      highlighter: 'GollumRstHighlightRules'
+    },
+    txt: {
+      mode: 'text'
+    },
+    pod: {
+      mode: 'text',
+      highlighter: 'GollumTextHighlightRules'
+    },
+    rdoc: {
+      mode: 'rdoc',
+      highlighter: 'GollumRdocHighlightRules'
+    },
+    textile: {
+      mode: 'textile',
+      highlighter: 'GollumTextileHighlightRules'
+    }
   };
 
   $.getEditorMode = function ( mode ) {
-    var ace_mode = '';
+    var lang = null;
-    if (ace_mode = AceMode[mode]) {
+    if (lang = AceMode[mode]) {
-      if (ace_mode.startsWith('Gollum')){ // We have extended highlighters
+      var ace_mode = lang['mode'];
-        var baseMode = ace.require("ace/mode/" + mode).Mode;
+      var gollum_rules = lang['highlighter'];
+      if (gollum_rules){ // We have extended highlighters
+        var baseMode = ace.require("ace/mode/" + ace_mode).Mode;
         var dynamicMode = new baseMode();
-        dynamicMode.HighlightRules = ace.require(ace_mode).GollumHighlightRules;
+        dynamicMode.HighlightRules = ace.require(gollum_rules).GollumHighlightRules;
         return dynamicMode;      
       } else {
         return "ace/mode/" + ace_mode;