Define 'meta-string', 'meta-keyword'

Regular 'string' and 'keyword' may not agree with the meta styling, so we need separate class names. The idea of using CSS cascade, like `.meta .keyword` is too error-prone, as the style author may simply not look at a language with these combinations while creating a style.
highlightjs · Nov 17, 2015 · f7f38f7 · f7f38f7
1 parent 5901226
commit f7f38f7
Show file tree

Hide file tree

Showing 14 changed files with 31 additions and 23 deletions.
diff --git a/docs/css-classes-reference.rst b/docs/css-classes-reference.rst
@@ -49,6 +49,10 @@ Stylable classes
 | meta                     | flags, modifiers, annotations, processing         |
 |                          | instructions, preprocessor directive, etc         |
 +--------------------------+---------------------------------------------------+
+| meta-keyword             | keyword or built-in within meta construct         |
++--------------------------+---------------------------------------------------+
+| meta-string              | string within meta construct                      |
++--------------------------+---------------------------------------------------+
 | **Tags, attributes, configs**                                                |
 +--------------------------+---------------------------------------------------+
 | section                  | heading of a section in a config file, heading in |

diff --git a/src/languages/actionscript.js b/src/languages/actionscript.js
@@ -47,7 +47,8 @@ function(hljs) {
       },
       {
         className: 'meta',
-        beginKeywords: 'import include', end: ';'
+        beginKeywords: 'import include', end: ';',
+        keywords: {'meta-keyword': 'import include'}
       },
       {
         className: 'function',

diff --git a/src/languages/autoit.js b/src/languages/autoit.js
@@ -1644,7 +1644,7 @@ function(hljs) {
             className: 'meta',
             begin: '#',
             end: '$',
-            keywords: 'include include-once NoTrayIcon OnAutoItStartRegister RequireAdmin pragma ' +
+            keywords: {'meta-keyword': 'include include-once NoTrayIcon OnAutoItStartRegister RequireAdmin pragma ' +
                 'Au3Stripper_Ignore_Funcs Au3Stripper_Ignore_Variables ' +
                 'Au3Stripper_Off Au3Stripper_On Au3Stripper_Parameters ' +
                 'AutoIt3Wrapper_Add_Constants AutoIt3Wrapper_Au3Check_Parameters ' +
@@ -1674,16 +1674,17 @@ function(hljs) {
                 'AutoIt3Wrapper_UPX_Parameters AutoIt3Wrapper_UseUPX ' +
                 'AutoIt3Wrapper_UseX64 AutoIt3Wrapper_Version ' +
                 'AutoIt3Wrapper_Versioning AutoIt3Wrapper_Versioning_Parameters ' +
-                'Tidy_Off Tidy_On Tidy_Parameters EndRegion Region',
+                'Tidy_Off Tidy_On Tidy_Parameters EndRegion Region'},
             contains: [{
                     begin: /\\\n/,
                     relevance: 0
                 }, {
                     beginKeywords: 'include',
+                    keywords: {'meta-keyword': 'include'},
                     end: '$',
                     contains: [
                         STRING, {
-                            className: 'string',
+                            className: 'meta-string',
                             variants: [{
                                 begin: '<',
                                 end: '>'

diff --git a/src/languages/cpp.js b/src/languages/cpp.js
@@ -38,18 +38,19 @@ function(hljs) {
   var PREPROCESSOR =       {
     className: 'meta',
     begin: '#', end: '$',
-    keywords: 'if else elif endif define undef warning error line ' +
-              'pragma ifdef ifndef',
+    keywords: {'meta-keyword': 'if else elif endif define undef warning error line ' +
+                  'pragma ifdef ifndef'},
     contains: [
       {
         begin: /\\\n/, relevance: 0
       },
       {
         beginKeywords: 'include', end: '$',
+        keywords: {'meta-keyword': 'include'},
         contains: [
-          STRINGS,
+          hljs.inherit(STRINGS, {className: 'meta-string'}),
           {
-            className: 'string',
+            className: 'meta-string',
             begin: '<', end: '>',
             illegal: '\\n',
           }

diff --git a/src/languages/cs.js b/src/languages/cs.js
@@ -51,7 +51,7 @@ function(hljs) {
       {
         className: 'meta',
         begin: '#', end: '$',
-        keywords: 'if else elif endif define undef warning error line region endregion pragma checksum'
+        keywords: {'meta-keyword': 'if else elif endif define undef warning error line region endregion pragma checksum'}
       },
       {
         className: 'string',

diff --git a/src/languages/haxe.js b/src/languages/haxe.js
@@ -34,7 +34,7 @@ function(hljs) {
       {
         className: 'meta',
         begin: '#', end: '$',
-        keywords: 'if else elseif end error'
+        keywords: {'meta-keyword': 'if else elseif end error'}
       },
       {
         className: 'function',

diff --git a/src/languages/makefile.js b/src/languages/makefile.js
@@ -35,7 +35,7 @@ function(hljs) {
       {
         className: 'meta',
         begin: /^\.PHONY:/, end: /$/,
-        keywords: '.PHONY', lexemes: /[\.\w]+/
+        keywords: {'meta-keyword': '.PHONY'}, lexemes: /[\.\w]+/
       },
       {
         begin: /^\t+/, end: /$/,

diff --git a/src/languages/monkey.js b/src/languages/monkey.js
@@ -62,7 +62,7 @@ function(hljs) {
       {
         className: 'meta',
         begin: '\\s*#', end: '$',
-        keywords: 'if else elseif endif end then'
+        keywords: {'meta-keyword': 'if else elseif endif end then'}
       },
       {
         className: 'meta',

diff --git a/src/languages/objectivec.js b/src/languages/objectivec.js
@@ -59,7 +59,7 @@ function(hljs) {
         end: '$',
         contains: [
           {
-            className: 'string',
+            className: 'meta-string',
             variants: [
               { begin: '\"', end: '\"' },
               { begin: '<', end: '>' }

diff --git a/src/languages/openscad.js b/src/languages/openscad.js
@@ -22,7 +22,7 @@ function(hljs) {
 	STRING = hljs.inherit(hljs.QUOTE_STRING_MODE,{illegal: null}),
 	PREPRO = {
 		className: 'meta',
-		keywords: 'include use',
+		keywords: {'meta-keyword': 'include use'},
 		begin: 'include|use <',
 		end: '>'
 	},

diff --git a/src/languages/sqf.js b/src/languages/sqf.js
diff --git a/src/languages/vbnet.js b/src/languages/vbnet.js
@@ -53,7 +53,7 @@ function(hljs) {
       {
         className: 'meta',
         begin: '#', end: '$',
-        keywords: 'if else elseif end region externalsource'
+        keywords: {'meta-keyword': 'if else elseif end region externalsource'}
       }
     ]
   };

diff --git a/src/styles/default.css b/src/styles/default.css
@@ -17,6 +17,7 @@ Original highlight.js style (c) Ivan Sagalaev <maniac@softwaremaniacs.org>
 }
 
 .hljs-keyword,
+.hljs-meta-keyword,
 .hljs-doctag,
 .hljs-name {
   font-weight: bold;
@@ -52,8 +53,7 @@ Original highlight.js style (c) Ivan Sagalaev <maniac@softwaremaniacs.org>
 .hljs-section,
 .hljs-selector-tag,
 .hljs-selector-id,
-.hljs-selector-class,
-.hljs-builtin-name {
+.hljs-selector-class {
   color: #880000;
   font-weight: bold;
 }

diff --git a/test/markup/cpp/function-preprocessor.expect.txt b/test/markup/cpp/function-preprocessor.expect.txt
@@ -1,6 +1,6 @@
-<span class="hljs-meta">#<span class="hljs-keyword">ifdef</span> DEBUG</span>
+<span class="hljs-meta">#<span class="hljs-meta-keyword">ifdef</span> DEBUG</span>
 <span class="hljs-function">TYPE1 <span class="hljs-title">foo</span><span class="hljs-params">(<span class="hljs-keyword">void</span>)</span>
-<span class="hljs-meta">#<span class="hljs-keyword">else</span></span>
+<span class="hljs-meta">#<span class="hljs-meta-keyword">else</span></span>
 <span class="hljs-keyword">int</span> <span class="hljs-title">foo</span><span class="hljs-params">(<span class="hljs-keyword">void</span>)</span>
-<span class="hljs-meta">#<span class="hljs-keyword">endif</span></span>
+<span class="hljs-meta">#<span class="hljs-meta-keyword">endif</span></span>
 </span>{ }