Syntax diagram: Difference between revisions

Revision as of 09:10, 27 January 2009

Latest revision as of 20:58, 30 May 2025

(115 intermediate revisions by 80 users not shown)

Line 1:

{{Short description|Visual description of context-free grammar}}

'''Syntax diagrams''' (or '''railroad diagrams''') are a way to represent a [[context-free grammar]]. They represent a graphical alternative to [[Backus-NaurBackus–Naur Formform]] or, [[EBNF]], [[Augmented Backus–Naur form]], and other text-based grammars as [[metalanguages]]. Early books using syntax diagrams include the "Pascal User Manual" written by [[Niklaus Wirth ]]<ref name="Wirth1974">[http://wwwe-collection.standardpascallibrary.orgethz.ch/The_Programming_Language_Pascal_1973eserv/eth:3059/eth-3059-01.pdf Niklaus Wirth: ''The Programming Language Pascal.'' (July 1973)]</ref> (diagrams start at page 47) and the Burroughs [[CANDE]] manual Manual.<ref name="burroughs71">[http://bitsavers.org/pdf/burroughs/B6500_6700/5000318_B6700_CANDE_Oct72.pdf Burroughs B6700/B7700 ''Command AND Edit (CANDE) Language: Information Manual'']</ref>. In the compilation field, textual representations like BNF or its variants are usually preferred. BNF is welltext-based, understoodand used by compiler writers and compilers,parser butgenerators. isRailroad notdiagrams wellare understoodvisual, byand mostmay users of languages. Railroad diagrams arebe more readily understood by mostlaypeople, people.sometimes Someincorporated ofinto thegraphic popularitydesign. ofThe canonical source defining the [[JSON]] [[data exchange|data interchange]] format isprovides dueyet toanother itsexample representationof ina popular modern usage of railroadthese diagrams.

== Principle ==

The representation of a grammar is made of a set of syntax diagrams. Each diagram defines a non-terminal"nonterminal" stage in a process. There is a main diagram which defines the language in the following way: to belong to the language, a word must describe a path in the main diagram.

Each diagram has an entry point and an end point. The diagram describes possible paths between these two points by going through other nonterminals and terminals. TerminalsHistorically, areterminals have been represented by round boxes whileand nonterminals are represented by squarerectangular boxes but there is no official standard.

== Example ==

We use arithmetic expressions as an example., Firstin wevarious providegrammar a simplified BNF grammar:formats.

<source lang="bnf">

BNF:

<sourcesyntaxhighlight lang="bnf">

<expression> ::= <term> | <term> "+" <expression>

<term> ::= <factor> | <factor> "*" <term>

Line 17 ⟶ 20:

<constant> ::= <digit> | <digit> <constant>

<digit> ::= "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"

</source>

</syntaxhighlight>

This grammar can also be expressed in [[EBNF]]:

<source lang="bnf">

EBNF:

expression = term , {"+" term};

<syntaxhighlight lang="ebnf">

term = factor , {"*" factor};

expression = term , [ "+" , expression ];

term = factor , {[ "*" factor}, term ];

factor = constant | variable | "(" , expression , ")";

variable = "x" | "y" | "z";

constant = digit , { digit };

digit = "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9";

</source>

</syntaxhighlight>

One possible set of syntax diagrams for this grammar is:

[[Image:Syntax Diagrams.png]]

ABNF:

<syntaxhighlight lang="abnf" highlight="6">

expression = term , {["+" term};expression]

term = factor ["*" term]

factor = constant / variable / "(" expression ")"

variable = "x" / "y" / "z"

constant = 1*digit

DIGIT = "0" / "1" / "2" / "3" / "4" / "5" / "6" / "7" / "8" / "9"

</syntaxhighlight>

ABNF also supports ranges, e.g. {{code|2=abnf|1=DIGIT = %x30-39}}, but it is not used here for consistency with the other examples.

[[Red (programming language)]] Parse Dialect:

<syntaxhighlight lang="Red" highlight="7">

Red [Title: "Parse Dialect"]

expression: [term opt ["+" expression]]

term: [factor opt ["*" term]]

factor: [constant | variable | "(" expression ")"]

variable: ["x" | "y" | "z"]

constant: [some digit]

digit: ["0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9"]

</syntaxhighlight>

This format also supports ranges, e.g. {{code|2=red|digit: charset [#"0" - #"9"]}}, but it is not used here for consistency with the other examples.

One possible syntax diagram for the example grammars is below. While the syntax for the text-based grammars differs, the syntax diagram for all of them can be the same because it is a [[metalanguage]].

[[Image:Syntax-diagram-example.png|"Railroad" syntax diagram]]

==See also==

* [[Recursive transition network]]

* [[Extended Backus-NaurBackus–Naur form]] (EBNF)

==References==

{{reflist}}

Note: the first link is sometimes blocked by the server outside of its ___domain, but it is available on [https://web.archive.org/web/20180909121538/https://www.research-collection.ethz.ch/bitstream/handle/20.500.11850/68910/eth-3059-01.pdf archive.org]. The file was also mirrored at [http://www.standardpascal.org/The_Programming_Language_Pascal_1973.pdf standardpascal.org].

==External links==

* {{en}} [httphttps://www.json.org/ JSON website including syntax diagrams]

* {{en}} [http://dotnet.jku.at/applications/Visualizer/ Generator from EBNF]

* {{en}} [http://www-cgi.uni-regensburg.de/~brf09510/syntax.html Automatic generator of syntax diagrams]

* {{en}} [http://www.informatik.uni-freiburg.de/~thiemann/haskell/ebnf2ps/ From EBNF to a postscript file with the diagrams]

* {{en}} [http://www-cgi.uni-regensburg.de/~brf09510/syntax/lazyebnf.ebnf.html Syntax diagrams of BNF]

* {{en}} [httphttps://wiki.karmin.ch/ebnf/index EBNF Parser & Renderer]

* {{en}} [http://dotnet.jku.at/applications/Visualizer/ Generator from EBNF]

* [https://www.sqlite.org/docsrc/finfo?name=art/syntax/bubble-generator.tcl SQLite syntax diagram generator for SQL]

* {{en}} [http://www.informatik.uni-freiburg.de/~thiemann/haskell/ebnf2ps/ From EBNF to a postscript file with the diagrams]

* [https://www.bottlecaps.de/rr Online Railroad Diagram Generator]

* {{en}} [http://wiki.karmin.ch/ebnf/ EBNF Parser & Renderer]

* [https://www.yorku.ca/jmason/asdgram.htm Augmented Syntax Diagram (ASD) grammars]

* [http://www.asd-networks.com (ASD) '''Augmented''' Syntax Diagram Application Demo Site ]

{{Formal languages and grammars}}

* [https://github.com/gbrault/railroad-diagrams/blob/gh-pages/live/doc/readme.md/ SRFB Syntax Diagram representation by Function Basis + svg generation]

[[Category:Formal languages]]

[[Category:Diagrams]]

{{formalmethods-stub}}

[[de:Syntaxdiagramm]]

[[fr:Diagramme syntaxique]]