|0.4.0||Oct 24, 2022|
|0.3.0||Oct 21, 2022|
#45 in Text editors
56 downloads per month
Used in 3 crates
Table of Contents
The grammar is fairly complete. It parses:
There are a few known issues.
This grammar aims to support the following use-cases:
- Editor integration
- Code navigation (e.g., jump-to-definition, show references)
- Syntax highlighting
- Static analysis
It does not currently aim to support round-trip printing (i.e., code formatting and refactoring).
On the C Pre-Processor
This parser has limited support for parsing C pre-processor
which may be helpful for analysis tasks. To avoid over-complicating the grammar,
it does not handle directives in the middle of top-level entities (e.g., in
between two conjuncts of a rule). You can configure your preprocessor to not
emit such tokens (
The grammar doesn't mirror the structure of the Soufflé C++ parser implementation nor the grammar as presented in the Soufflé documentation. It instead tries to map nonterminals to more abstract categories, i.e., categories that match the way we think about the language. For instance, the Soufflé C++ parser doesn't have a nonterminal for constants, whereas this parser does. As another example, the Soufflé documentation has this specification for type declarations:
type_decl ::= '.type' IDENT ("<:" type_name | "=" ( type_name ( "|" type_name )* | record_list | adt_branch ( "|" adt_branch )* ))
This grammar instead has something more like
type_decl ::= subtype | type_synonym | type_union | record | adt
so that the parse tree encodes a bit more "semantic" information. The hope is that these choices make it easier to write tree-sitter queries.
For the same reason, the grammar doesn't specify keywords and operators like
:- as their own nonterminals, but rather inlines
them into the grammar.
This script downloads the Soufflé, ddisasm, cclyzer++, and other repos and attempts to parse their Datalog files.