Skip to content

Commit

Permalink
Added EBNF language (#1756)
Browse files Browse the repository at this point in the history
This adds the EBNF language.
  • Loading branch information
RunDevelopment authored Feb 28, 2019
1 parent 1df96c5 commit 13e1c97
Show file tree
Hide file tree
Showing 14 changed files with 208 additions and 3 deletions.
2 changes: 1 addition & 1 deletion components.js

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions components.json
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,10 @@
"alias": "dockerfile",
"owner": "JustinBeckwith"
},
"ebnf": {
"title": "Extended Backus–Naur form",
"owner": "RunDevelopment"
},
"eiffel": {
"title": "Eiffel",
"owner": "Conaclos"
Expand Down
22 changes: 22 additions & 0 deletions components/prism-ebnf.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
Prism.languages.ebnf = {
'comment': /\(\*[\s\S]*?\*\)/,
'string': {
pattern: /"[^"\r\n]*"|'[^'\r\n]*'/,
greedy: true
},
'special': {
pattern: /\?[^?\r\n]*\?/,
greedy: true,
alias: 'class-name'
},

'definition': {
pattern: /^(\s*)[a-z]\w*(?:[ \t]+[a-z]\w*)*(?=\s*=)/im,
lookbehind: true,
alias: ['rule', 'keyword']
},
'rule': /[a-z]\w*(?:[ \t]+[a-z]\w*)*/i,

'punctuation': /\([:/]|[:/]\)|[.,;()[\]{}]/,
'operator': /[-=|*/!]/
};
1 change: 1 addition & 0 deletions components/prism-ebnf.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

63 changes: 63 additions & 0 deletions examples/prism-ebnf.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
<h2>Full example</h2>
<pre><code>SYNTAX = SYNTAX RULE, { SYNTAX RULE } ;
SYNTAX RULE
= META IDENTIFIER, '=', DEFINITIONS LIST, ' ;' ;
DEFINITIONS LIST
= SINGLE DEFINITION,
{ '|', SINGLE DEFINITION } ;
SINGLE DEFINITION = TERM, { ',', TERM } ;
TERM = FACTOR, [ '-', EXCEPTION ] ;
EXCEPTION = FACTOR ;
FACTOR = [ INTEGER, '*' ], PRIMARY ;
PRIMARY
= OPTIONAL SEQUENCE | REPEATED SEQUENCE
| SPECIAL SEQUENCE | GROUPED SEQUENCE
| META IDENTIFIER | TERMINAL | EMPTY ;
EMPTY = ;
OPTIONAL SEQUENCE = '[', DEFINITIONS LIST, ']' ;
REPEATED SEQUENCE = '{', DEFINITIONS LIST, '}' ;
GROUPED SEQUENCE = '(', DEFINITIONS LIST, ')' ;
TERMINAL
= "'", CHARACTER - "'",
{ CHARACTER - "'" }, "'"
| '"', CHARACTER - '"',
{ CHARACTER - '"' }, '"' ;
META IDENTIFIER = LETTER, { LETTER | DIGIT } ;
INTEGER = DIGIT, { DIGIT } ;
SPECIAL SEQUENCE = '?', { CHARACTER - '?' }, '?' ;
COMMENT = '(*', { COMMENT SYMBOL }, '*)' ;
COMMENT SYMBOL
= COMMENT | TERMINAL | SPECIAL SEQUENCE
| CHARACTER ;</code></pre>

<h2>Full example with alternative syntax</h2>
<pre><code>SYNTAX = SYNTAX RULE, (: SYNTAX RULE :).
SYNTAX RULE
= META IDENTIFIER, '=', DEFINITIONS LIST, '.'. (* '.' instead of ';' *)
DEFINITIONS LIST
= SINGLE DEFINITION,
(: '/', SINGLE DEFINITION :).
SINGLE DEFINITION = TERM, (: ',', TERM :).
TERM = FACTOR, (/ '-', EXCEPTION /).
EXCEPTION = FACTOR.
FACTOR = (/ INTEGER, '*' /), PRIMARY.
PRIMARY
= OPTIONAL SEQUENCE / REPEATED SEQUENCE (* / is the same as | *)
/ SPECIAL SEQUENCE / GROUPED SEQUENCE
/ META IDENTIFIER / TERMINAL / EMPTY.
EMPTY = .
OPTIONAL SEQUENCE = '(/', DEFINITIONS LIST, '/)'.
REPEATED SEQUENCE = '(:', DEFINITIONS LIST, ':)'.
GROUPED SEQUENCE = '(', DEFINITIONS LIST, ')'.
TERMINAL
= "'", CHARACTER - "'",
(: CHARACTER - "'" :), "'"
/ '"', CHARACTER - '"',
(: CHARACTER - '"' :), '"'.
META IDENTIFIER = LETTER, (: LETTER / DIGIT :).
INTEGER = DIGIT, (: DIGIT :).
SPECIAL SEQUENCE = '?', (: CHARACTER - '?' :), '?'.
COMMENT = '(*', (: COMMENT SYMBOL :), '*)'.
COMMENT SYMBOL
= COMMENT / TERMINAL / SPECIAL SEQUENCE
/ CHARACTER.</code></pre>
2 changes: 1 addition & 1 deletion plugins/show-language/prism-show-language.js
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ if (!Prism.plugins.toolbar) {
}

// The languages map is built automatically with gulp
var Languages = /*languages_placeholder[*/{"html":"HTML","xml":"XML","svg":"SVG","mathml":"MathML","css":"CSS","clike":"C-like","js":"JavaScript","abap":"ABAP","abnf":"Augmented Backus–Naur form","apacheconf":"Apache Configuration","apl":"APL","arff":"ARFF","asciidoc":"AsciiDoc","adoc":"AsciiDoc","asm6502":"6502 Assembly","aspnet":"ASP.NET (C#)","autohotkey":"AutoHotkey","autoit":"AutoIt","shell":"Bash","basic":"BASIC","bnf":"Backus–Naur form","rbfn":"Routing Backus–Naur form","csharp":"C#","dotnet":"C#","cpp":"C++","cil":"CIL","csp":"Content-Security-Policy","css-extras":"CSS Extras","django":"Django/Jinja2","jinja2":"Django/Jinja2","dockerfile":"Docker","erb":"ERB","fsharp":"F#","gcode":"G-code","gedcom":"GEDCOM","glsl":"GLSL","gml":"GameMaker Language","gamemakerlanguage":"GameMaker Language","graphql":"GraphQL","hcl":"HCL","http":"HTTP","hpkp":"HTTP Public-Key-Pins","hsts":"HTTP Strict-Transport-Security","ichigojam":"IchigoJam","inform7":"Inform 7","javastacktrace":"Java stack trace","json":"JSON","jsonp":"JSONP","latex":"LaTeX","emacs":"Lisp","elisp":"Lisp","emacs-lisp":"Lisp","lolcode":"LOLCODE","markup-templating":"Markup templating","matlab":"MATLAB","mel":"MEL","n1ql":"N1QL","n4js":"N4JS","n4jsd":"N4JS","nand2tetris-hdl":"Nand To Tetris HDL","nasm":"NASM","nginx":"nginx","nsis":"NSIS","objectivec":"Objective-C","ocaml":"OCaml","opencl":"OpenCL","parigp":"PARI/GP","objectpascal":"Object Pascal","php":"PHP","php-extras":"PHP Extras","plsql":"PL/SQL","powershell":"PowerShell","properties":".properties","protobuf":"Protocol Buffers","q":"Q (kdb+ database)","jsx":"React JSX","tsx":"React TSX","renpy":"Ren'py","rest":"reST (reStructuredText)","sas":"SAS","sass":"Sass (Sass)","scss":"Sass (Scss)","sql":"SQL","soy":"Soy (Closure Template)","tap":"TAP","toml":"TOML","tt2":"Template Toolkit 2","ts":"TypeScript","vbnet":"VB.Net","vhdl":"VHDL","vim":"vim","visual-basic":"Visual Basic","vb":"Visual Basic","wasm":"WebAssembly","wiki":"Wiki markup","xeoracube":"XeoraCube","xojo":"Xojo (REALbasic)","xquery":"XQuery","yaml":"YAML"}/*]*/;
var Languages = /*languages_placeholder[*/{"html":"HTML","xml":"XML","svg":"SVG","mathml":"MathML","css":"CSS","clike":"C-like","js":"JavaScript","abap":"ABAP","abnf":"Augmented Backus–Naur form","apacheconf":"Apache Configuration","apl":"APL","arff":"ARFF","asciidoc":"AsciiDoc","adoc":"AsciiDoc","asm6502":"6502 Assembly","aspnet":"ASP.NET (C#)","autohotkey":"AutoHotkey","autoit":"AutoIt","shell":"Bash","basic":"BASIC","bnf":"Backus–Naur form","rbfn":"Routing Backus–Naur form","csharp":"C#","dotnet":"C#","cpp":"C++","cil":"CIL","csp":"Content-Security-Policy","css-extras":"CSS Extras","django":"Django/Jinja2","jinja2":"Django/Jinja2","dockerfile":"Docker","ebnf":"Extended Backus–Naur form","erb":"ERB","fsharp":"F#","gcode":"G-code","gedcom":"GEDCOM","glsl":"GLSL","gml":"GameMaker Language","gamemakerlanguage":"GameMaker Language","graphql":"GraphQL","hcl":"HCL","http":"HTTP","hpkp":"HTTP Public-Key-Pins","hsts":"HTTP Strict-Transport-Security","ichigojam":"IchigoJam","inform7":"Inform 7","javastacktrace":"Java stack trace","json":"JSON","jsonp":"JSONP","latex":"LaTeX","emacs":"Lisp","elisp":"Lisp","emacs-lisp":"Lisp","lolcode":"LOLCODE","markup-templating":"Markup templating","matlab":"MATLAB","mel":"MEL","n1ql":"N1QL","n4js":"N4JS","n4jsd":"N4JS","nand2tetris-hdl":"Nand To Tetris HDL","nasm":"NASM","nginx":"nginx","nsis":"NSIS","objectivec":"Objective-C","ocaml":"OCaml","opencl":"OpenCL","parigp":"PARI/GP","objectpascal":"Object Pascal","php":"PHP","php-extras":"PHP Extras","plsql":"PL/SQL","powershell":"PowerShell","properties":".properties","protobuf":"Protocol Buffers","q":"Q (kdb+ database)","jsx":"React JSX","tsx":"React TSX","renpy":"Ren'py","rest":"reST (reStructuredText)","sas":"SAS","sass":"Sass (Sass)","scss":"Sass (Scss)","sql":"SQL","soy":"Soy (Closure Template)","tap":"TAP","toml":"TOML","tt2":"Template Toolkit 2","ts":"TypeScript","vbnet":"VB.Net","vhdl":"VHDL","vim":"vim","visual-basic":"Visual Basic","vb":"Visual Basic","wasm":"WebAssembly","wiki":"Wiki markup","xeoracube":"XeoraCube","xojo":"Xojo (REALbasic)","xquery":"XQuery","yaml":"YAML"}/*]*/;

Prism.plugins.toolbar.registerButton('show-language', function(env) {
var pre = env.element.parentNode;
Expand Down
2 changes: 1 addition & 1 deletion plugins/show-language/prism-show-language.min.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 11 additions & 0 deletions tests/languages/ebnf/comment_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
(* comment *)

----------------------------------------------------

[
["comment", "(* comment *)"]
]

----------------------------------------------------

Checks for comments.
14 changes: 14 additions & 0 deletions tests/languages/ebnf/definition_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
foo bar = 'a' ;

----------------------------------------------------

[
["definition", "foo bar"],
["operator", "="],
["string", "'a'"],
["punctuation", ";"]
]

----------------------------------------------------

Checks for rules.
19 changes: 19 additions & 0 deletions tests/languages/ebnf/operator_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
| / !
*
-
=

----------------------------------------------------

[
["operator", "|"],
["operator", "/"],
["operator", "!"],
["operator", "*"],
["operator", "-"],
["operator", "="]
]

----------------------------------------------------

Checks for operators.
31 changes: 31 additions & 0 deletions tests/languages/ebnf/punctuation_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
; .
,
()
[] (//)
{} (::)

----------------------------------------------------

[
["punctuation", ";"],
["punctuation", "."],

["punctuation", ","],

["punctuation", "("],
["punctuation", ")"],

["punctuation", "["],
["punctuation", "]"],
["punctuation", "(/"],
["punctuation", "/)"],

["punctuation", "{"],
["punctuation", "}"],
["punctuation", "(:"],
["punctuation", ":)"]
]

----------------------------------------------------

Checks for punctuation.
12 changes: 12 additions & 0 deletions tests/languages/ebnf/rule_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
foo bar;

----------------------------------------------------

[
["rule", "foo bar"],
["punctuation", ";"]
]

----------------------------------------------------

Checks for rules.
11 changes: 11 additions & 0 deletions tests/languages/ebnf/special_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
? special characters ?

----------------------------------------------------

[
["special", "? special characters ?"]
]

----------------------------------------------------

Checks for special sequences.
17 changes: 17 additions & 0 deletions tests/languages/ebnf/string_feature.test
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
""
''
"foo's"
'"bar;'

----------------------------------------------------

[
["string", "\"\""],
["string", "''"],
["string", "\"foo's\""],
["string", "'\"bar;'"]
]

----------------------------------------------------

Checks for strings.

0 comments on commit 13e1c97

Please sign in to comment.