https://github.com/BNFC/bnfc
BNF Converter
https://github.com/BNFC/bnfc
abstract-syntax-tree bnf bnf-converter bnfc grammar-specification lexer-generator parser-generator pretty-print
Last synced: 2 months ago
JSON representation
BNF Converter
- Host: GitHub
- URL: https://github.com/BNFC/bnfc
- Owner: BNFC
- Created: 2012-11-20T18:33:10.000Z (almost 13 years ago)
- Default Branch: master
- Last Pushed: 2025-03-15T20:23:40.000Z (7 months ago)
- Last Synced: 2025-06-27T02:51:03.420Z (3 months ago)
- Topics: abstract-syntax-tree, bnf, bnf-converter, bnfc, grammar-specification, lexer-generator, parser-generator, pretty-print
- Language: TeX
- Homepage: http://bnfc.digitalgrammars.com/
- Size: 7.62 MB
- Stars: 602
- Watchers: 19
- Forks: 169
- Open Issues: 92
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
[](http://hackage.haskell.org/package/BNFC)
[](https://stackage.org/nightly/package/BNFC)
[](https://www.stackage.org/package/BNFC)
[](https://github.com/BNFC/bnfc/actions)
[](http://bnfc.readthedocs.io/en/latest/?badge=latest)
The BNF Converter
=================
What is the BNF Converter?
--------------------------
The BNF Converter (bnfc) is a compiler construction tool generating a compiler
front-end from a Labelled BNF (LBNF) grammar. It is currently able to generate Haskell,
Agda, C, C++, Java, and OCaml, as well as XML representations.
Given a LBNF grammar the tool produces:
- an abstract syntax implementation
- a case skeleton for the abstract syntax in the same language
- an Alex, Ocamllex, JLex, or Flex lexer generator file
- a Happy, Ocamlyacc, Menhir, ANTLR, CUP, or Bison parser generator file
- a pretty-printer as a Haskell/Agda/C/C++/Java/Ocaml module
- a Latex file containing a readable specification of the language
*More information*: http://bnfc.digitalgrammars.com/
Installation
------------
Some binaries are available at https://github.com/BNFC/bnfc/releases.
Installation from the Haskell sources is possible via `stack` or `cabal`.
### Installation via stack (recommended)
You need a running installation of
[stack](https://docs.haskellstack.org/en/stable/install_and_upgrade/).
To install and run the latest version of
[bnfc from stackage](https://www.stackage.org/package/BNFC),
enter at the command line:
```
stack install BNFC
bnfc --help
```
BNFC versions in major Stackage LTS snapshots:
| GHC | LTS | BNFC |
|--------|-------|---------|
| 8.8.4 | 16.31 | 2.8.4 |
| 8.10.7 | 18.28 | 2.9.4 |
| 9.0.2 | 19.33 | 2.9.4 |
| 9.2.8 | 20.26 | 2.9.4.1 |
| 9.4.8 | 21.25 | 2.9.5 |
### Installation via cabal
You need a running installation of a recent version of
[GHC](https://www.haskell.org/ghc/) and
[Cabal](https://www.haskell.org/cabal/), most easily available via the
[GHCup](https://www.haskell.org/ghcup/). To install
[bnfc from hackage](https://hackage.haskell.org/package/BNFC),
enter at the command line:
```
cabal install BNFC
bnfc --help
```
### Installing the development version
To install the
[development version of bnfc](https://github.com/BNFC/bnfc)
with the latest bugfixes (and regressions ;-)):
```
git clone https://github.com/BNFC/bnfc.git
cd bnfc/source
```
and then either
```
cabal install
```
or
```
stack install --stack-yaml stack-9.4.yaml
```
(replace `9.4` with your GHC major version, and if you want to build with
your installed GHC then add flag `--system-ghc`).
Mini tutorial
-------------
- Build a first parser in 5 min (Haskell backend):
1. In a fresh directory, prepare a grammar file `Sum.cf` with the following content:
```
EInt. Exp ::= Integer;
EPlus. Exp ::= Exp "+" Integer;
```
2. Build a parser (in Haskell) with bnfc:
```
bnfc -d -m Sum.cf && make
```
The `make` step needs the Haskell compiler [GHC](https://www.haskell.org/ghc/), the lexer
generator [alex](https://www.haskell.org/alex/) and the parser generator [happy](https://www.haskell.org/happy/) (all included in the GHC installation).
3. Inspect the generated files in directory `Sum`.
4. Test the parser.
```
echo "1 + 2 + 3" | Sum/Test
```
- Try the C-family backends. (The prerequisites, GNU C(++) compiler
(`gcc` / `g++`), lexer generator `flex` and parser generator `bison`,
are usually present):
```
bnfc --c -m -o sum-c Sum.cf && make -C sum-c && echo "1 + 2 + 3" | sum-c/TestSum
bnfc --cpp -m -o sum-cpp Sum.cf && make -C sum-cpp && echo "1 + 2 + 3" | sum-cpp/TestSum
```
- Try the other backends:
| Option | Backend |
| --- | --- |
| `--java` | Requires Java, [JLex](https://www.cs.princeton.edu/~appel/modern/java/JLex/) or [JFlex](https://jflex.de/), and [CUP](http://www2.cs.tum.edu/projects/cup/).|
| `--java-antlr` | Requires [ANTLR](https://www.antlr.org/).|
| `--ocaml` | Requires [OCaml](https://ocaml.org/), `ocamllex` and `ocamlyacc`.|
| `--ocaml-menhir` | Uses [menhir](http://gallium.inria.fr/~fpottier/menhir/) instead of `ocamlyacc`.|
| `--agda` | Produces [Agda](https://agda-lang.org) bindings to the parser generated for Haskell.|
| `--pygments` | Produces a lexer definition for the Python highlighting suite [Pygments](https://pygments.org/).|
Documentation
-------------
https://bnfc.readthedocs.org/en/latest/
Support
-------
You can discuss with us issues around bnfc on our mailing list bnfc-dev@googlegroups.com.
For current limitations of bnfc, or to report a new bug, please consult our [issue tracker](https://github.com/BNFC/bnfc/issues).
Contribute
----------
- Issue Tracker: https://github.com/BNFC/bnfc/issues
- Source Code: https://github.com/BNFC/bnfc
- Haskell coding style guide: https://github.com/andreasabel/haskell-style-guide/
- Some pull request etiquette:
* Document, document, document! (See style guide)
* Include test cases that cover your feature.
* Include changelog entry.
* More etiquette: E.g. https://gist.github.com/mikepea/863f63d6e37281e329f8
License
-------
The project is licensed under the [BSD 3-clause license](https://raw.githubusercontent.com/BNFC/bnfc/master/source/LICENSE).
BNFC versions until 2.8.4 released under the
[GNU General Public License](https://www.gnu.org/licenses/gpl-2.0.html).
Example uses of the BNF Converter
---------------------------------
In research:
- NASA's [OGMA](https://github.com/nasa/ogma) tool uses LBNF for its grammars, e.g. for a [subset of C 99](https://github.com/nasa/ogma/blob/49e78e4d6fa7558d09d36a284648087df48714e4/ogma-language-c/grammar/C.cf).
In teaching:
- Course [Programming Language Technology](http://www.cse.chalmers.se/edu/course/DAT151/) at Chalmers / Gothenburg University.