- C 99.3%
- Ruby 0.5%
- C++ 0.1%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
- This change removes the `BUNDLE_PATH` constant due to the fact that it is hard-coded at gem build time. This can cause issues if you compile a project including this gem on a build server and run it on another server. - In place of a specific `BUNDLE_PATH`, we utilize `NULL`. The Linux and MacOS man pages give slightly different accounts of the behavior of passing `NULL` to `dlopen`. MacOS says the behavior is the same as `RTLD_DEFAULT`, whereas Linux only says that it returns a handle for the main program. Whether the symbols are being found in the default library search order (RTLD_DEFAULT) or in the main program, this appears to work on both MacOS and Linux. |
||
| bin | ||
| ext/tree-sitter | ||
| lib | ||
| script | ||
| test | ||
| .gitignore | ||
| .gitmodules | ||
| .rubocop.yml | ||
| .travis.yml | ||
| Gemfile | ||
| LICENSE.txt | ||
| Rakefile | ||
| README.md | ||
| tree-sitter.gemspec | ||
TreeSitter
This gem wraps around tree-sitter.
Installation
Add this line to your application's Gemfile:
gem 'tree-sitter'
And then execute:
$ bundle
Or install it yourself as:
$ gem install tree-sitter
Usage
Tree-sitter performs two different operations: compiling grammars and parsing text with those grammars.
This gem is only concerned with parsing a blob of text, given the appropriate grammars. Compiling grammars from JSON is trivial and can just be kept as an executable generated from C.
Running the parser
The libruntime static library needs to make use of the C code generated by the libcompile executable. Once you've got those, you'll need to provide an absolute path to the directory containing the C files that the library can incorporate. For example:
# if you've installed this gem
$ TREE_SITTER_PARSER_DIR=/somewhere/code bundle install
# if you're using this gem locally
$ TREE_SITTER_PARSER_DIR=/somewhere/code bundle exec rake compile
This directory is appended with the glob suffix **/*.{c,cc}, so it can contain as many nested parser files as necessary.
Then, you can start making use of the parser:
# first argument is the string to parse
# second argument is a set of options; currently, only one is available, `language:`,
# which identifies the text's language
document = TreeSitter::Document.new('a + b * 5', language: 'tree_sitter_arithmetic')
# you can change any of these values whenever you want, just remember to call `parse`
# provide the function name
document.input_string = '12 * 12'
document.language = "tree_sitter_python"
document.parse
Development
After checking out the repo, run script/bootstrap to install dependencies. Then, run script/test to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.