Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ziprandom/cltk
A crystal port of the Ruby Language Toolkit
https://github.com/ziprandom/cltk
Last synced: about 2 months ago
JSON representation
A crystal port of the Ruby Language Toolkit
- Host: GitHub
- URL: https://github.com/ziprandom/cltk
- Owner: ziprandom
- License: other
- Created: 2016-03-30T20:15:10.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2023-04-02T12:56:23.000Z (over 1 year ago)
- Last Synced: 2024-06-21T18:09:02.965Z (3 months ago)
- Language: Crystal
- Homepage: https://ziprandom.github.io/cltk
- Size: 2.31 MB
- Stars: 73
- Watchers: 6
- Forks: 8
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-crystal - cltk - A crystal port of the Ruby Language Toolkit (Implementations/Compilers)
- awesome-crystal - cltk - A crystal port of the Ruby Language Toolkit (Implementations/Compilers)
- awesome-crystal - cltk - A crystal port of the Ruby Language Toolkit (Implementations/Compilers)
README
# cltk [](https://travis-ci.org/ziprandom/cltk)
This is a port of the [Ruby Language Toolkit](https://github.com/chriswailes/RLTK) to the [Crystal Programming Language](http://crystal-lang.org/).
**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](https://ziprandom.github.io/cltk/CLTK/Lexer.html) and a [second faster one](https://ziprandom.github.io/cltk/CLTK/Scanner.html) based on the [crystal-dfa](https://github.com/ziprandom/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](https://github.com/ziprandom/cltk/blob/master/src/cltk/parser/crystalize.cr#L24) that renders a finalized parser back into crystal syntax to compile it without having to be finalized again at startup (see [exp_lang_repl](examples/exp_lang/exp_lang_repl.cr) for a usage example).
To see what works have a look at the specs or run them with:
```crystal
$ crystal spec
```
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`](https://github.com/ziprandom/cltk/blob/master/examples/kazoo/chapter_8/kcontractor.cr)
## Usage
To use the toolkit in your project add this to your application's `shard.yml`:
```yaml
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](https://ziprandom.github.io/cltk/) 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](https://github.com/ziprandom) - creator of the port, maintainer