trgen 0.23.1

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher.
There is a newer version of this package available.
See the version list below for details. 
dotnet tool install --global trgen --version 0.23.1
This package contains a .NET tool you can call from the shell/command line. 
dotnet new tool-manifest # if you are setting up this repo
dotnet tool install --local trgen --version 0.23.1
This package contains a .NET tool you can call from the shell/command line. 
#tool dotnet:?package=trgen&version=0.23.1                

                    
                

            
nuke :add-package trgen --version 0.23.1

trgen

Summary

Generate an Antlr4 parser for a given target language

Description

Generate a parser application using the Antlr tool and application templates. The generated parser is placed in the directory <current-directory>/Generated-<target>/. If there is a desc.xml file in the current directory, trgen will read it for information on testing the grammar. If there is no desc.xml file, the start rule must be provided. If the current directory is empty, trgen will create a parser for the Arithmetic.g4 grammar.

Usage

trgen <options>*

Examples

trgen

Specification of desc.xml

The desc.xml is an XML file that specifies how to generate a driver and test a grammar. The desc.xml is similar to the Antlr Maven Tester pom.xml file, but with a few extension. trgen analyzes the grammar to determine how to test the grammar; this analysis simplifies the information needed in the desc.xml that would be required in the pom.xml.

A typical desc.xml simply specifies all targets to test.

<?xml version="1.0" encoding="UTF-8" ?>
<desc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../_scripts/desc.xsd">
   <targets>Antlr4cs;Antlr4ng;Cpp;CSharp;Dart;Go;Java;JavaScript;PHP;Python3;TypeScript</targets>
</desc>

trgen will read all .g4's contained in the directory with the desc.xml file. It computes a dependency graph of the grammars used via tokenVocab options, and import statements. The tool will then perform a topological sort, determine the first "top-level" parser or combined grammar, and use that grammar for testing. The start rule for the driver for testing will be determined by looking for the first EOF-terminated rule. With these two analyses, the desc.xml eliminates the need to specify information that is required in the pom.xml, and helps to greatly simplify and eliminate bugs created when adding new grammars.

Current version

0.23.1 Added tritext back, added -m option for markup of fonts. Add heat map to trperf. Rewrite grammar analysis in trgen.

License

The MIT License

Copyright (c) 2024 Ken Domino

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

Version Downloads Last updated
0.23.11 629 12/18/2024
0.23.10 89 12/12/2024
0.23.9 101 11/29/2024
0.23.8 143 11/1/2024
0.23.7 4,176 10/9/2024
0.23.6 968 9/21/2024
0.23.5 133 9/15/2024
0.23.4 141 9/7/2024
0.23.3 1,153 8/15/2024
0.23.2 202 6/28/2024
0.23.1 129 6/22/2024
0.23.0 7,622 4/25/2024
0.22.0 5,311 2/26/2024
0.21.16 20,647 11/16/2023
0.21.15 372 11/16/2023
0.21.14 195 11/15/2023
0.21.13 144 11/14/2023
0.21.12 252 10/27/2023
0.21.11 347 10/24/2023
0.21.9 10,681 9/27/2023
0.21.8 375 9/26/2023
0.21.7 379 9/26/2023
0.21.6 241 9/20/2023
0.21.5 240 9/18/2023
0.21.4 215 9/17/2023
0.21.3 279 9/14/2023
0.21.2 248 9/4/2023
0.21.1 376 8/15/2023
0.21.0 20,509 6/25/2023
0.20.27 5,251 6/15/2023
0.20.26 2,134 6/5/2023
0.20.25 529 6/3/2023
0.20.24 204 6/1/2023
0.20.23 2,471 5/31/2023
0.20.22 481 5/21/2023
0.20.21 214 5/15/2023
0.20.20 238 5/11/2023
0.20.19 9,424 5/8/2023
0.20.18 226 5/8/2023
0.20.17 2,920 5/4/2023
0.20.16 289 5/1/2023
0.20.15 1,388 4/27/2023
0.20.14 298 4/21/2023
0.20.13 347 4/13/2023
0.20.12 10,162 3/17/2023
0.20.11 2,440 3/15/2023
0.20.10 403 3/15/2023
0.20.9 435 3/14/2023
0.20.8 366 3/14/2023
0.20.7 368 3/13/2023
0.20.6 2,647 3/11/2023
0.20.5 381 3/11/2023
0.20.4 416 3/9/2023
0.20.3 678 3/8/2023
0.20.2 415 3/7/2023
0.20.1 485 3/7/2023
0.20.0 9,691 2/22/2023
0.19.3 405 2/19/2023
0.19.2 4,816 2/2/2023
0.19.1 423 1/28/2023
0.19.0 5,008 1/15/2023
0.19.0-alpha7 446 1/15/2023
0.19.0-alpha6 333 1/14/2023
0.19.0-alpha5 387 1/12/2023
0.19.0-alpha4 347 1/11/2023
0.19.0-alpha3 501 1/5/2023
0.19.0-alpha2 356 1/4/2023
0.19.0-alpha1 413 1/4/2023
0.18.1 502 11/11/2022
0.18.0 521 11/7/2022
0.17.0 742 9/11/2022
0.16.5 555 7/29/2022
0.16.4 571 6/13/2022
0.16.3 36,592 5/7/2022
0.16.2 614 5/6/2022
0.16.1 1,294 5/5/2022
0.16.0 5,123 4/13/2022
0.15.1 577 4/4/2022
0.15.0 622 3/20/2022
0.14.3 606 2/27/2022
0.14.2 566 2/18/2022
0.14.1 11,847 1/26/2022
0.14.0 599 1/26/2022
0.13.8 743 1/14/2022
0.13.7 603 1/13/2022
0.13.6 589 1/13/2022
0.13.5 641 1/12/2022
0.13.4 668 1/11/2022
0.13.3 668 1/10/2022
0.13.2 3,564 12/24/2021
0.13.1 400 12/24/2021
0.13.0 482 12/23/2021
0.12.0 378 12/6/2021
0.11.5 421 10/17/2021
0.11.4 390 10/17/2021
0.11.3 382 9/28/2021
0.11.2 441 9/26/2021
0.11.1 424 9/25/2021
0.11.0 434 9/24/2021
0.10.0 446 9/9/2021
0.8.9 510 8/13/2021
0.8.8 421 8/5/2021
0.8.7 428 7/20/2021
0.8.6 445 7/13/2021
0.8.5 597 7/6/2021
0.8.4 682 6/24/2021
0.8.3 720 6/13/2021
0.8.2 432 6/8/2021
0.8.1 418 6/2/2021
0.8.0 438 5/27/2021
0.7.0 17,358 5/10/2021
0.6.5 501 5/7/2021
0.6.4 494 5/7/2021
0.6.3 461 5/4/2021
0.6.2 440 5/4/2021
0.6.1 420 5/4/2021
0.6.0 431 5/3/2021
0.5.5 425 4/22/2021
0.5.3 2,455 4/16/2021
0.5.2 441 4/15/2021
0.5.1 377 4/15/2021
0.5.0 423 4/14/2021

# trgen
## Summary
Generate an Antlr4 parser for a given target language
## Description
Generate a parser application using the Antlr tool and application templates.
The generated parser is placed in the directory <current-directory>/Generated-<target>/.
If there is a `desc.xml` file in the current directory, `trgen` will read
it for information on testing the grammar. If there is no `desc.xml` file,
the start rule must be provided. If the current directory is empty, `trgen` will
create a parser for the Arithmetic.g4 grammar.
## Usage
trgen <options>*
## Examples
trgen
## Specification of desc.xml
The desc.xml is an XML file that specifies how to generate a driver and test
a grammar. The desc.xml is similar to the Antlr Maven Tester pom.xml file,
but with a few extension. trgen analyzes the grammar to determine how to test
the grammar; this analysis simplifies the information needed in the desc.xml
that would be required in the pom.xml.
A typical desc.xml simply specifies all targets to test.
```
<?xml version="1.0" encoding="UTF-8" ?>
<desc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../_scripts/desc.xsd">
<targets>Antlr4cs;Antlr4ng;Cpp;CSharp;Dart;Go;Java;JavaScript;PHP;Python3;TypeScript</targets>
</desc>
```
trgen will read all .g4's contained in the directory with the desc.xml file.
It computes a dependency graph of the grammars used via `tokenVocab` options,
and `import` statements. The tool will then perform a topological sort, determine
the first "top-level" parser or combined grammar, and use that grammar for testing.
The start rule for the driver for testing will be determined by looking for the
first EOF-terminated rule. With these two analyses, the desc.xml eliminates the
need to specify information that is required in the pom.xml, and helps to greatly
simplify and eliminate bugs created when adding new grammars.
## Current version
0.23.1 Added tritext back, added -m option for markup of fonts. Add heat map to trperf. Rewrite grammar analysis in trgen.
## License
The MIT License
Copyright (c) 2024 Ken Domino
Permission is hereby granted, free of charge,
to any person obtaining a copy of this software and
associated documentation files (the "Software"), to
deal in the Software without restriction, including
without limitation the rights to use, copy, modify,
merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom
the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice
shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR
ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.