https://github.com/seagreen/state-of-haskell-bnf

https://github.com/seagreen/state-of-haskell-bnf

Last synced: 10 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/seagreen/state-of-haskell-bnf
• Owner: seagreen
• Created: 2017-03-10T05:28:45.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2017-03-18T22:20:52.000Z (almost 8 years ago)
• Last Synced: 2024-10-25T13:40:10.565Z (about 2 months ago)
• Size: 20.5 KB
• Stars: 9
• Watchers: 5
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# BNF In Haskell

[Backus-Naur form](https://en.wikipedia.org/wiki/Backus%E2%80%93Naur_form) is technique for describing context-free grammars.

The difference in clarity between specifications using BNF and ones using informal English is enormous. The following [EBNF](https://en.wikipedia.org/wiki/Extended_Backus%E2%80%93Naur_form) is unlikely to translate to brief English:

```

number ::= "-"? (positiveInteger fraction? | "0" fraction)

         | "0"

```

And even if it was short it wouldn't let you generate this for free (using [GrammKit](https://github.com/dundalek/GrammKit)):

![Number](./example.png)

I think Haskell would be a natural fit for this kind of work, and so did a survey of the ecosystem to see what's been built so far. If no Haskell solution is available I list the best non-Haskell one.

Here are my goals:

#### 1. Validation executable

Simply make sure a BNF file is valid.

ABNF: None yet. Perhaps a wrapper around [parseABNF](https://github.com/Xandaros/abnf/blob/master/src/Text/ABNF/ABNF/Parser.hs#L40) should be built.

EBNF: None yet. Ebnf2ps could do this, but it would also try to generate diagrams.

#### 2. Haskell representation

A clean, general Haskell data type that can be used by other libraries.

ABNF: [`[Rule]`](https://github.com/Xandaros/abnf/blob/master/src/Text/ABNF/ABNF/Types.hs#L23)

EBNF: None yet.

#### 3. Railroad diagram generator

ABNF: None yet.

EBNF: [GrammKit](https://github.com/dundalek/GrammKit) is great for generating SVGs if you just need an executable (it's not Haskell). Ebnf2ps generates PostScript files.

## Existing Packages

### abnf

[Hackage](http://hackage.haskell.org/package/abnf) / [Source](https://github.com/Xandaros/abnf)

Supported: ABNF

Summary: "Parse ABNF and generate parsers for the specified document"

### Ebnf2ps

[Hackage](http://hackage.haskell.org/package/Ebnf2ps) / [Source](https://github.com/FranklinChen/Ebnf2ps)

Supported: EBNF

Summary: "Generate PostScript diagrams from an EBNF grammar"

### BNFC

[Hackage](http://hackage.haskell.org/package/BNFC) / [Source](https://github.com/BNFC/bnfc)

Supported: Labelled BNF

Summary: "Given a Labelled BNF grammar the tool produces: an abstract syntax as a HaskellC++C module or Java directory, a case skeleton for the abstract syntax in the same language, an Alex, JLex, or Flex lexer generator file, a Happy, CUP, or Bison parser generator file, a pretty-printer as a HaskellJavaC++/C module, a Latex file containing a readable specification of the language."

### BNFC-meta

[Hackage](http://hackage.haskell.org/package/BNFC-meta)

Supported: Labelled BNF

Summary: Embed LBNF within Haskell using Template Haskell

### ebnf-bff

[Hackage](http://hackage.haskell.org/package/ebnf-bff) / [Source](https://github.com/Lokidottir/ebnf-bff)

Supported: EBNF

Summary: "A library & program that builds parsers from ISO EBNF using Parsec"