Skip to content

Commit d45a693

Browse files
committed
Merge pull request OpenBEL#4 from abargnesi/update_antlr_readme
updated ANTLR README; usage in OpenBEL Framework
2 parents af7f822 + f7b27ae commit d45a693

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

version_1.0/ANTLR/README.adoc

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@ https://github.com/OpenBEL/openbel-framework[framework].
1010
BELScript.g
1111
^^^^^^^^^^^
1212

13-
_Not used_
13+
Parse grammar that emits an ANTLR Abstract Syntax Tree. Syntax warnings and errors are caught in this step.
14+
15+
Used by OpenBEL Framework 2.0 / 3.0. See https://github.com/OpenBEL/openbel-framework/blob/experimental/org.openbel.framework.common/src/main/java/org/openbel/framework/common/bel/parser/BELParser.java[BELParser.java].
1416

1517
BELScriptWalker.g
1618
^^^^^^^^^^^^^^^^^
1719

18-
Grammar used by the legacy Java BEL Framework.
20+
Walks the AST and transforms into BEL Java Objects (org.openbel.framework.common.model package).
21+
22+
Used by OpenBEL Framework 2.0 / 3.0. See https://github.com/OpenBEL/openbel-framework/blob/experimental/org.openbel.framework.common/src/main/java/org/openbel/framework/common/bel/parser/BELParser.java[BELParser.java].
1923

2024
BELScriptWalker_v1.g
2125
^^^^^^^^^^^^^^^^^^^^
@@ -40,5 +44,6 @@ _Not used_
4044
BELStatement.g
4145
^^^^^^^^^^^^^^
4246

43-
_Not used_
47+
Parses a BEL Statement into a BELStatement Java Object (org.openbel.framework.common.model.BELStatement).
4448

49+
Used by OpenBEL Framework 2.0 / 3.0. See https://github.com/OpenBEL/openbel-framework/blob/experimental/org.openbel.framework.common/src/main/java/org/openbel/framework/common/bel/parser/BELParser.java[BELParser.java].

0 commit comments

Comments
 (0)