beginWithKeyword replaced by a simpler beginKeywords.

highlightjs · Dec 13, 2013 · 6c7fdea · 6c7fdea
1 parent a3c2db5
commit 6c7fdea
Show file tree

Hide file tree

Showing 29 changed files with 66 additions and 103 deletions.
diff --git a/docs/reference.rst b/docs/reference.rst
@@ -78,10 +78,10 @@ Sometimes a mode can end not by itself but implicitly with its containing (paren
 This is achieved with :ref:`endsWithParent <endsWithParent>` attribute.
 
 
-beginWithKeyword
+beginKeywords
 ^^^^^^^^^^^^^^^^
 
-**type**: boolean
+**type**: string
 
 Used instead of ``begin`` for modes starting with keywords to avoid needless repetition:
 
@@ -97,9 +97,11 @@ Used instead of ``begin`` for modes starting with keywords to avoid needless rep
 ::
 
   {
-    beginWithKeyword: true, keywords: 'extends implements'
+    beginKeywords: 'extends implements'
   }
 
+Unlike the ``[[#keywords]]`` attribute, this one allows only a simple list of space separated keywords. If you do need additional features of ``keywords`` or you just need more keywords for this mode you may include ``keywords`` along with ``beginKeywords``.
+
 
 .. _endsWithParent:
 

diff --git a/src/highlight.js b/src/highlight.js
@@ -166,7 +166,7 @@ function() {
         return;
       mode.compiled = true;
 
-      var keywords = []; // used later with beginWithKeyword but filled as a side-effect of keywords compilation
+      mode.keywords = mode.keywords || mode.beginKeywords;
       if (mode.keywords) {
         var compiled_keywords = {};
 
@@ -177,7 +177,6 @@ function() {
           str.split(' ').forEach(function(kw) {
             var pair = kw.split('|');
             compiled_keywords[pair[0]] = [className, pair[1] ? Number(pair[1]) : 1];
-            keywords.push(pair[0]);
           });
         }
 
@@ -193,9 +192,10 @@ function() {
         }
         mode.keywords = compiled_keywords;
       }
+
       if (parent) {
-        if (mode.beginWithKeyword) {
-          mode.begin = '\\b(' + keywords.join('|') + ')\\b(?!\\.)\\s*';
+        if (mode.beginKeywords) {
+          mode.begin = '\\b(' + mode.beginKeywords.split(/\s+/).join('|') + ')\\b(?!\\.)\\s*';
         }
         mode.beginRe = langRe(mode.begin ? mode.begin : '\\B|\\b');
         if (!mode.end && !mode.endsWithParent)

diff --git a/src/languages/actionscript.js b/src/languages/actionscript.js
@@ -31,31 +31,26 @@ function(hljs) {
       hljs.C_NUMBER_MODE,
       {
         className: 'package',
-        beginWithKeyword: true, end: '{',
-        keywords: 'package',
+        beginKeywords: 'package', end: '{',
         contains: [TITLE_MODE]
       },
       {
         className: 'class',
-        beginWithKeyword: true, end: '{',
-        keywords: 'class interface',
+        beginKeywords: 'class interface', end: '{',
         contains: [
           {
-            beginWithKeyword: true,
-            keywords: 'extends implements'
+            beginKeywords: 'extends implements'
           },
           TITLE_MODE
         ]
       },
       {
         className: 'preprocessor',
-        beginWithKeyword: true, end: ';',
-        keywords: 'import include'
+        beginKeywords: 'import include', end: ';'
       },
       {
         className: 'function',
-        beginWithKeyword: true, end: '[{;]',
-        keywords: 'function',
+        beginKeywords: 'function', end: '[{;]',
         illegal: '\\S',
         contains: [
           TITLE_MODE,

diff --git a/src/languages/applescript.js b/src/languages/applescript.js
@@ -93,8 +93,7 @@ function(hljs) {
       },
       {
         className: 'function_start',
-        beginWithKeyword: true,
-        keywords: 'on',
+        beginKeywords: 'on',
         illegal: '[${=;\\n]',
         contains: [TITLE, PARAMS]
       }

diff --git a/src/languages/autohotkey.js b/src/languages/autohotkey.js
@@ -21,8 +21,7 @@ function(hljs) {
     },
     {
       className: 'built_in',
-      beginWithKeyword: true,
-      keywords: 'ComSpec Clipboard ClipboardAll ErrorLevel'
+      beginKeywords: 'ComSpec Clipboard ClipboardAll ErrorLevel'
     }
   ];
 

diff --git a/src/languages/axapta.js b/src/languages/axapta.js
@@ -23,14 +23,12 @@ function(hljs) {
       },
       {
         className: 'class',
-        beginWithKeyword: true, end: '{',
+        beginKeywords: 'class interface', end: '{',
         illegal: ':',
-        keywords: 'class interface',
         contains: [
           {
             className: 'inheritance',
-            beginWithKeyword: true,
-            keywords: 'extends implements',
+            beginKeywords: 'extends implements',
             relevance: 10
           },
           {

diff --git a/src/languages/coffeescript.js b/src/languages/coffeescript.js
@@ -112,12 +112,12 @@ function(hljs) {
       },
       {
         className: 'class',
-        beginWithKeyword: true, keywords: 'class',
+        beginKeywords: 'class',
         end: '$',
         illegal: /[:="\[\]]/,
         contains: [
           {
-            beginWithKeyword: true, keywords: 'extends',
+            beginKeywords: 'extends',
             endsWithParent: true,
             illegal: /[:="\[\]]/,
             contains: [TITLE]

diff --git a/src/languages/cs.js b/src/languages/cs.js
@@ -51,26 +51,22 @@ function(hljs) {
       hljs.QUOTE_STRING_MODE,
       hljs.C_NUMBER_MODE,
       {
-        beginWithKeyword: true, end: '{',
-        keywords: 'class namespace',
+        beginKeywords: 'class namespace', end: '{',
         contains: [
           TITLE
         ]
       },
       {
-        beginWithKeyword: true, keywords: 'protected public private internal',
-        starts: {
-          end: '{|;',
-          keywords: KEYWORDS,
-          contains: [
-            {
-              begin: hljs.IDENT_RE + '\\s*\\(', returnBegin: true,
-              contains: [
-                TITLE
-              ]
-            }
-          ]
-        }
+        beginKeywords: 'protected public private internal', end: '{|;',
+        keywords: KEYWORDS,
+        contains: [
+          {
+            begin: hljs.IDENT_RE + '\\s*\\(', returnBegin: true,
+            contains: [
+              TITLE
+            ]
+          }
+        ]
       }
     ]
   };

diff --git a/src/languages/delphi.js b/src/languages/delphi.js
@@ -34,7 +34,7 @@ function(hljs) {
   };
   var FUNCTION = {
     className: 'function',
-    beginWithKeyword: true, end: /[:;]/,
+    beginKeywords: 'function constructor destructor procedure', end: /[:;]/,
     keywords: 'function constructor|10 destructor|10 procedure|10',
     contains: [
       {

diff --git a/src/languages/fsharp.js b/src/languages/fsharp.js
@@ -30,8 +30,7 @@ function(hljs) {
       },
       {
         className: 'class',
-        beginWithKeyword: true, end: '\\(|=|$',
-        keywords: 'type',
+        beginKeywords: 'type', end: '\\(|=|$',
         contains: [
           {
             className: 'title',

diff --git a/src/languages/haskell.js b/src/languages/haskell.js
@@ -90,14 +90,12 @@ function(hljs) {
       },
       {
         className: 'default',
-        beginWithKeyword: true, end: '$',
-        keywords: 'default',
+        beginKeywords: 'default', end: '$',
         contains: [CONSTRUCTOR, LIST, COMMENT]
       },
       {
         className: 'infix',
-        beginWithKeyword: true, end: '$',
-        keywords: 'infix infixl infixr',
+        beginKeywords: 'infix infixl infixr', end: '$',
         contains: [hljs.C_NUMBER_MODE, COMMENT]
       },
       {

diff --git a/src/languages/java.js b/src/languages/java.js
@@ -25,14 +25,12 @@ function(hljs) {
       hljs.QUOTE_STRING_MODE,
       {
         className: 'class',
-        beginWithKeyword: true, end: '{',
-        keywords: 'class interface',
+        beginKeywords: 'class interface', end: '{',
         excludeEnd: true,
         illegal: ':',
         contains: [
           {
-            beginWithKeyword: true,
-            keywords: 'extends implements',
+            beginKeywords: 'extends implements',
             relevance: 10
           },
           {

diff --git a/src/languages/javascript.js b/src/languages/javascript.js
@@ -47,8 +47,7 @@ function(hljs) {
       },
       {
         className: 'function',
-        beginWithKeyword: true, end: /{/,
-        keywords: 'function',
+        beginKeywords: 'function', end: /\{/,
         contains: [
           {
             className: 'title', begin: /[A-Za-z$_][0-9A-Za-z$_]*/

diff --git a/src/languages/lasso.js b/src/languages/lasso.js
@@ -109,7 +109,7 @@ function(hljs) {
     },
     {
       className: 'class',
-      beginWithKeyword: true, keywords: 'define',
+      beginKeywords: 'define',
       returnEnd: true, end: '\\(|=>',
       contains: [
         {

diff --git a/src/languages/livecodeserver.js b/src/languages/livecodeserver.js
@@ -119,8 +119,7 @@ function(hljs) {
 	  },
 	  {
 	 	className: 'function',
-	    beginWithKeyword: true, end: '$',
-	    keywords: 'function',
+	    beginKeywords: 'function', end: '$',
 	    contains: [
 		  VARIABLE,
 		  {
@@ -131,8 +130,7 @@ function(hljs) {
 	  },
 	  {
 	 	className: 'function',
-	    beginWithKeyword: true, end: '$',
-	    keywords: 'end',
+	    beginKeywords: 'end', end: '$',
 	    contains: [
 		  {
 		  	className: 'title',
@@ -142,8 +140,7 @@ function(hljs) {
 	  },
 	  {
 	 	className: 'command',
-	    beginWithKeyword: true, end: '$',
-	    keywords: 'command on',
+	    beginKeywords: 'command on', end: '$',
 	    contains: [
 		  VARIABLE,
 		  {
@@ -154,8 +151,7 @@ function(hljs) {
 	  },
 	  {
 	 	className: 'command',
-	    beginWithKeyword: true, end: '$',
-	    keywords: 'end',
+	    beginKeywords: 'end', end: '$',
 	    contains: [
 		  {
 		  	className: 'title',

diff --git a/src/languages/lua.js b/src/languages/lua.js
@@ -37,8 +37,7 @@ function(hljs) {
     contains: COMMENTS.concat([
       {
         className: 'function',
-        beginWithKeyword: true, end: '\\)',
-        keywords: 'function',
+        beginKeywords: 'function', end: '\\)',
         contains: [
           {
             className: 'title',

diff --git a/src/languages/matlab.js b/src/languages/matlab.js
@@ -40,8 +40,7 @@ function(hljs) {
     contains: [
       {
         className: 'function',
-        beginWithKeyword: true, end: '$',
-        keywords: 'function',
+        beginKeywords: 'function', end: '$',
         contains: [
           {
               className: 'title',

diff --git a/src/languages/ocaml.js b/src/languages/ocaml.js
@@ -30,8 +30,7 @@ function(hljs) {
       },
       {
         className: 'class',
-        beginWithKeyword: true, end: '\\(|=|$',
-        keywords: 'type',
+        beginKeywords: 'type', end: '\\(|=|$',
         contains: [
           {
             className: 'title',

diff --git a/src/languages/oxygene.js b/src/languages/oxygene.js
@@ -33,7 +33,7 @@ function(hljs) {
   };
   var FUNCTION = {
     className: 'function',
-    beginWithKeyword: true, end: '[:;]',
+    beginKeywords: 'function constructor destructor procedure method', end: '[:;]',
     keywords: 'function constructor|10 destructor|10 procedure|10 method|10',
     contains: [
       {

diff --git a/src/languages/perl.js b/src/languages/perl.js
@@ -136,8 +136,7 @@ function(hljs) {
     },
     {
       className: 'sub',
-      beginWithKeyword: true, end: '(\\s*\\(.*?\\))?[;{]',
-      keywords: 'sub',
+      beginKeywords: 'sub', end: '(\\s*\\(.*?\\))?[;{]',
       relevance: 5
     },
     {

diff --git a/src/languages/php.js b/src/languages/php.js
@@ -69,8 +69,7 @@ function(hljs) {
       VARIABLE,
       {
         className: 'function',
-        beginWithKeyword: true, end: /[;{]/,
-        keywords: 'function',
+        beginKeywords: 'function', end: /[;{]/,
         illegal: '\\$|\\[|%',
         contains: [
           TITLE,
@@ -89,13 +88,11 @@ function(hljs) {
       },
       {
         className: 'class',
-        beginWithKeyword: true, end: '{',
-        keywords: 'class',
+        beginKeywords: 'class', end: '{',
         illegal: '[:\\(\\$]',
         contains: [
           {
-            beginWithKeyword: true, endsWithParent: true,
-            keywords: 'extends',
+            beginKeywords: 'extends', endsWithParent: true,
             contains: [TITLE]
           },
           TITLE

diff --git a/src/languages/python.js b/src/languages/python.js
@@ -55,7 +55,7 @@ function(hljs) {
     contains: ['self', PROMPT, NUMBER, STRING]
   };
   var FUNC_CLASS_PROTO = {
-    beginWithKeyword: true, end: /:/,
+    end: /:/,
     illegal: /[${=;\n]/,
     contains: [TITLE, PARAMS]
   };
@@ -75,8 +75,8 @@ function(hljs) {
       NUMBER,
       STRING,
       hljs.HASH_COMMENT_MODE,
-      hljs.inherit(FUNC_CLASS_PROTO, {className: 'function', keywords: 'def', relevance: 10}),
-      hljs.inherit(FUNC_CLASS_PROTO, {className: 'class', keywords: 'class'}),
+      hljs.inherit(FUNC_CLASS_PROTO, {className: 'function', beginKeywords: 'def', relevance: 10}),
+      hljs.inherit(FUNC_CLASS_PROTO, {className: 'class', beginKeywords: 'class'}),
       {
         className: 'decorator',
         begin: /@/, end: /$/