kgt

BNF wrangling and railroad diagrams

Github stars Tracking Chart

KGT: Kate's Grammar Tool

Do you want to convert various kinds of BNF to other kinds of BNF? No?
Well imagine if you did! This would be the tool for you.

Input: Various BNF-like syntaxes
Output: Various BNF-like syntaxes, AST dumps, and Railroad Syntax Diagrams

Compilation phases:

phases.svg

  • Bold indicates the input BNF dialects with the most features
  • ✨ indicates presentational formats (these are the good ones!)
  • 🧪 indicates debugging formats.
    You don't want these unless you're looking at kgt's internals.
  • Other formats provide various subsets of features

Gallery:

Getting started:

See the /examples directory for grammars in various
BNF dialects. These have been collated from various sources and
are of various quality. BNF dialects tend to be poorly specified,
and these examples are an attempt to keep a corpus of known-good
examples for each dialect. kgt can't parse them all yet.

kgt reads from stdin in dialect -l ... and writes to stdout
in format -e ...:

; kgt -l bnf -e rrutf8 < examples.expr.bnf
expr:
    │├──╮── term ── "+" ── expr ──╭──┤│
        │                         │
        ╰───────── term ──────────╯

term:
    │├──╮── factor ── "*" ── term ──╭──┤│
        │                           │
        ╰───────── factor ──────────╯

factor:
    │├──╮── "(" ── expr ── ")" ──╭──┤│
        │                        │
        ╰──────── const ─────────╯

const:
    │├── integer ──┤│

and the same grammar output as SVG instead:

; kgt -l bnf -e svg < examples/expr.bnf > /tmp/expr.svg

expr.svg

Clone with submodules (contains required .mk files):

; git clone --recursive https://github.com/katef/kgt.git

To build and install:

; pmake -r install

You can override a few things:

; CC=clang PREFIX=$HOME pmake -r install

Building depends on:

  • Any BSD make. This includes OpenBSD, FreeBSD and NetBSD make(1)
    and sjg's portable bmake (also packaged as pmake).

  • A C compiler. Any should do, but GCC and clang are best supported.

  • ar, ld, and a bunch of other stuff you probably already have.

Ideas, comments or bugs: kate@elide.org

Main metrics

Overview
Name With Ownerkatef/kgt
Primary LanguageC
Program languageMakefile (Language Count: 4)
Platform
License:BSD 2-Clause "Simplified" License
所有者活动
Created At2017-02-01 05:13:03
Pushed At2025-04-11 03:13:56
Last Commit At2020-05-19 21:36:00
Release Count0
用户参与
Stargazers Count607
Watchers Count19
Fork Count31
Commits Count505
Has Issues Enabled
Issues Count38
Issue Open Count19
Pull Requests Count31
Pull Requests Open Count0
Pull Requests Close Count3
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private