Helper methods for Pidgin parsers.
Get Started
$ dotnet add package War3Net.CodeAnalysisReadme
War3Net.CodeAnalysis
About
War3Net.CodeAnalysis is a library providing helper methods and extension methods for Pidgin parsers, along with utility classes for code generation. It simplifies the creation of complex recursive parsers for domain-specific languages and provides tools for generating properly formatted source code output. It is part of the War3Net modding library.
Key features
- Parse separated lists (e.g., comma-separated arguments) while preserving separator tokens
- Parse if/elseif/else/endif block structures with trivia preservation
- Parse block constructs with open/close tokens (e.g., loops, function bodies)
- Generate indented source code output with automatic indentation management
- Immutable data structures for representing parsed syntax lists
How to Use
Parse a comma-separated list
using Pidgin;
using War3Net.CodeAnalysis;
// Define your item and separator parsers
Parser<char, Expression> expressionParser = /* your expression parser */;
Parser<char, char> commaParser = Parser.Char(',');
// Create a separated list parser
Parser<char, SeparatedSyntaxList<Expression, char>> argumentListParser =
expressionParser.SeparatedList(commaParser);
// Parse input
var result = argumentListParser.Parse("a, b, c");
SeparatedSyntaxList<Expression, char> arguments = result.Value;
// Access items and separators
foreach (var item in arguments.Items)
{
// Process each expression
}
Parse block structures with UntilWithLeading
using Pidgin;
using War3Net.CodeAnalysis;
// Parse items between open and close tokens (e.g., loop/endloop)
Parser<char, LoopStatement> loopParser = statementParser.UntilWithLeading(
triviaParser, // Parser for leading whitespace/comments
loopKeywordParser, // Open token parser
endLoopKeywordParser, // Close token parser
(trivia, stmt) => stmt.WithLeadingTrivia(trivia),
(loopToken, statements, trivia, endLoopToken) =>
new LoopStatement(loopToken, statements, trivia, endLoopToken));
Build a separated syntax list manually
using War3Net.CodeAnalysis;
// Create a builder with the first item
var builder = SeparatedSyntaxList<string, char>.CreateBuilder("first");
// Add more items with separators
builder.Add(',', "second");
builder.Add(',', "third");
// Build the immutable list
SeparatedSyntaxList<string, char> list = builder.ToSeparatedSyntaxList();