Antlr4Ast 2.0.0

.NET 6.0
dotnet add package Antlr4Ast --version 2.0.0
NuGet\Install-Package Antlr4Ast -Version 2.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Antlr4Ast" Version="2.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Antlr4Ast --version 2.0.0
#r "nuget: Antlr4Ast, 2.0.0"
#r directive can be used in F# Interactive, C# scripting and .NET Interactive. Copy this into the interactive tool or source code of the script to reference the package.
// Install Antlr4Ast as a Cake Addin
#addin nuget:?package=Antlr4Ast&version=2.0.0

// Install Antlr4Ast as a Cake Tool
#tool nuget:?package=Antlr4Ast&version=2.0.0

Antlr4Ast Build Status Coverage Status NuGet

<img align="right" width="160px" height="160px" src="img/antlr4ast.png">

Antlr4Ast is a .NET library that provides a parser and abstract syntax tree (AST) for ANTLR4/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 .NET6+

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:

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:

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.

License

This software is released under the BSD-Clause 2 license.

Author

Alexandre Mutel aka xoofx.

Product Versions
.NET net6.0 net6.0-android net6.0-ios net6.0-maccatalyst net6.0-macos net6.0-tvos net6.0-windows net7.0 net7.0-android net7.0-ios net7.0-maccatalyst net7.0-macos net7.0-tvos net7.0-windows
Compatible target framework(s)
Additional computed target framework(s)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.0.0 226 10/11/2022
1.0.0 197 10/9/2022