• README

• Top Level Namespace
• CLTK
  • ASTNode
  • CFG
    • GrammarError
    • Item
    • Production
    • ProductionBufferType
    • ProductionCallbackType
  • Lexer
    • BlockReturn
    • Environment
    • Exceptions
      • LexingError
  • Lexers
    • Calculator
    • EBNF
  • Parser
    • Action
    • Actions
      • Accept
      • GoTo
      • Reduce
      • Shift
    • CLAUSE
    • CrystalizeVisitor
    • Environment
    • Exceptions
      • BadToken
      • HandledError
      • InternalParserException
      • NotInLanguage
      • ParserConstructionException
      • UselessParserException
    • Explain
    • LIST_PROD
    • Opts
    • ParserConcern
    • ParseStack
      • OutputStackVisitor
        • ProcsType
    • ProdProc
    • StackType
    • StandaloneParser
    • State
  • Parsers
    • InfixCalc
    • PostfixCalc
    • PrefixCalc
  • Scanner
    • Environment
    • LexerCompatibility
    • ProcType
    • StreamPosition
    • Token
  • StreamPosition
  • Token
  • TokenValue
  • Type
• NamedTuple
• Object
• StringScanner

cltk

This is a port of the Ruby Language Toolkit to the Crystal Programming Language.

CLTK (like RLTK) is: a collection of classes and methods designed to help programmers create languages in an easy to use and straightforward manner. This toolkit provides the following features:

• 2 Lexer generators based on PCRE Regexps from crystals STD Lib and a second faster one based on the crystal-dfa DFA automaton implementation
• Parser generator
• AST node baseclass
• Class for representing context free grammars

In addition, CLTK includes several ready-made lexers and parsers. As well as a serialization mechanism that renders a finalized parser back into crystal syntax to compile it without having to be finalized again at startup (see exp_lang_repl for a usage example).

To see what works have a look at the specs or run them with:

The Implementation has been strongly altered but the API is compatible to RLTK. The LLVM Bindings has not been ported. Instead crystals own LLVM Bindings were used in examples/kazoo/chapter 8/kcontractor.cr

Usage

To use the toolkit in your project add this to your application's shard.yml:

dependencies:
  cltk:
    github: ziprandom/cltk

Examples

See the example languages (and their specs):

• interpreted language EXP_LANG (examples/exp_lang)
• kazoo (examples/kazoo/chapter 8) with LLVM IR generation
• brainfuck (examples/brainfuck)
• json_parser (examples/json_parser) example of a linter / xml converter

Documentation

can be found in the docs directory

Contributing

1. Fork it ( https://github.com/ziprandom/cltk/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Contributors

• ziprandom - creator of the port, maintainer