mirror of
https://github.com/radareorg/radare2.git
synced 2024-12-12 07:26:42 +00:00
7df28e1fb2
* Import export in CSV and R2 formats * Export in JSON, ascii-art, columns, r2, .. * For example: aaa;aflt>$a;,.$a,/size/sum |
||
|---|---|---|
| .. | ||
| corpus | ||
| src | ||
| .gitignore | ||
| binding.gyp | ||
| grammar.js | ||
| index.js | ||
| package-lock.json | ||
| package.json | ||
| README.md | ||
radare2-shell-parser
This is the parser for radare2 shell language. See https://tree-sitter.github.io/tree-sitter/creating-parsers for more info on how to create a parser with tree-sitter.
Sources
- grammar.js: defines the basic grammar
- src/scanner.c: external scanner used to scan some tokens that cannot be parsed with the regular js grammar, as that includes only the context-free part of the language.
- src/parser.c: this file is auto-generated by tree-sitter based on grammar.js
- corpus/*: list of test files used to ensure the grammar works well
How to update grammar
When you update something in grammar.js or src/scanner.c you have to re-generate the parser. The process works as follows:
- Do changes as needed to grammar.js and/or src/scanner.c
- Install npm dependencies with:
cd shlr/radare2-shell-parser ; npm install - Make sure tree-sitter is in PATH:
export PATH=$PATH:./node_modules/.bin - Re-generate the parser files:
tree-sitter generate - Check tests still pass:
tree-sitter test. Usetree-sitter parse ./example-fileif you want to see the syntax tree of a custom input provided in./example-file - Commit auto-generated files and modified grammar.js and src/scanner.c into git.