Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xoofx/antlr4ast
Antlr4Ast is a .NET library that provides a parser and abstract syntax tree (AST) for ANTLR4/g4 files.
https://github.com/xoofx/antlr4ast
abstract-syntax-tree antlr antlr4 ast csharp dotnet parser
Last synced: 7 days ago
JSON representation
Antlr4Ast is a .NET library that provides a parser and abstract syntax tree (AST) for ANTLR4/g4 files.
- Host: GitHub
- URL: https://github.com/xoofx/antlr4ast
- Owner: xoofx
- License: bsd-2-clause
- Created: 2022-10-08T13:16:22.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-17T14:04:08.000Z (8 months ago)
- Last Synced: 2024-05-01T14:08:04.627Z (7 months ago)
- Topics: abstract-syntax-tree, antlr, antlr4, ast, csharp, dotnet, parser
- Language: C#
- Homepage:
- Size: 957 KB
- Stars: 50
- Watchers: 3
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Funding: .github/FUNDING.yml
- License: license.txt
Awesome Lists containing this project
README
# Antlr4Ast [](https://github.com/xoofx/Antlr4Ast/actions/workflows/ci.yml) [](https://coveralls.io/github/xoofx/Antlr4Ast?branch=main) [](https://www.nuget.org/packages/Antlr4Ast/)
Antlr4Ast is a .NET library that provides a parser and abstract syntax tree (AST) for [ANTLR4](https://www.antlr.org/)/g4 files.
> This can be useful if you are looking for building code generation tools from ANTLR4/g4 files.
## Features
- Allow to **parse** and **merge** ANTLR4/g4 files to a simple AST.
- Should support almost all grammar features of ANTLR4/g4 except actions.
- Provides **precise source location** for most of the AST elements.
- Provides **access to comments** attached to syntax nodes.
- Provides **visitor** and **transform**.
- Library with nullable annotations.
- Compatible with `netstandard2.0`
> Limitations
>
> As this library is mainly for codegen scenarios, it does not preserve whitespaces or the position of some comments within elements.
> There is no plan to support high fidelity roundtrip ANTLR4 parser.
## Usage
The entry point for parsing an ANTLR4/g4 grammar is to use the `Grammar.Parse` methods:
```c#
var input = @"grammar MyGrammar;
// Parser rules starting here!
expr_a_plus_b
: TOKEN_A '+' TOKEN_B
;
// Lexer rules starting here!
TOKEN_A: 'a';
TOKEN_B: 'b';
";
// Parse the grammar
var grammar = Grammar.Parse(input);
// Print the grammar
Console.WriteLine(
grammar.ToString(
new AntlrFormattingOptions() {
MultiLineWithComments = true
}
)
);
```
will print the following:
```antlr
grammar MyGrammar;
// Parser rules starting here!
expr_a_plus_b
: TOKEN_A '+' TOKEN_B
;
// Lexer rules starting here!
TOKEN_A
: 'a'
;
TOKEN_B
: 'b'
;
```
### Documentation
You will find more details about how to use Antlr4Ast in this [user guide](https://github.com/xoofx/Antlr4Ast/blob/main/doc/readme.md).
## License
This software is released under the [BSD-Clause 2 license](https://opensource.org/licenses/BSD-2-Clause).
## Author
Alexandre Mutel aka [xoofx](https://xoofx.github.io).