trcombine 0.20.26

There is a newer version of this package available.
See the version list below for details.
dotnet tool install --global trcombine --version 0.20.26                
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 trcombine --version 0.20.26                
This package contains a .NET tool you can call from the shell/command line.
#tool dotnet:?package=trcombine&version=0.20.26                
nuke :add-package trcombine --version 0.20.26                

trcombine

Summary

Combine a split Antlr4 grammar

Description

Combine two grammars into one. One grammar must be a lexer grammar, the other a parser grammar, order is irrelevant. The output is parse tree data.

Usage

trcombine <grammar1> <grammar2>

Details

trcombine combines grammars that are known as "split grammars" (separate Antlr4 lexer and parser grammars) into one grammar, known as a "combined grammar". This refactoring is useful if a simplified grammar grammar is wanted, and if possible if the split grammar does not use the "superClass" option in one or the other grammars. The opposite refactoring is implemented by trsplit.

The split refactoring performs several operations:

  • Combine the two files together, parser grammar first, then lexer grammar.
  • Remove the grammarDecl for the lexer rules, and change the grammarDecl for the parser rules to be a combined grammar declaration. Rename the name of the parser grammar to not have "Parser" at the tail of the name.
  • Remove the optionsSpec for the lexer section.
  • Remove any occurrence of "tokenVocab" from the optionsSpec of the parser section.
  • If the optionsSpec is empty, it is removed.

The order of the two grammars is ignored: the parser rules always will appear before the lexer rules.

Lexer modes will require manual fix-up.

Example

Consider the following grammar that is split.

Input to command

Lexer grammar in ExpressionLexer.g4:

lexer grammar ExpressionLexer;
VARIABLE : VALID_ID_START VALID_ID_CHAR* ;
fragment VALID_ID_START : ('a' .. 'z') | ('A' .. 'Z') | '_' ;
fragment VALID_ID_CHAR : VALID_ID_START | ('0' .. '9') ;
INT : ('0' .. '9')+ ;
MUL : '*' ;
DIV : '/' ;
ADD : '+' ;
SUB : '-' ;
LP : '(' ;
RP : ')' ;
WS : [ \r\n\t] + -> skip ;

Parser grammar in ExpressionParser.g4:

parser grammar ExpressionParser;
e : e ('*' | '/') e
 | e ('+' | '-') e
 | '(' e ')'
 | ('-' | '+')* a
 ;
a : number | variable ;
number : INT ;
variable : VARIABLE ;

Command

trcombine ExpressionLexer.g4 ExpressionParser.g4 | trprint > Expression.g4

Combined grammar in Expression.g4:

grammar Expression;
e : e ('*' | '/') e
 | e ('+' | '-') e
 | '(' e ')'
 | ('-' | '+')* a
 ;
a : number | variable ;
number : INT ;
variable : VARIABLE ;
VARIABLE : VALID_ID_START VALID_ID_CHAR* ;
fragment VALID_ID_START : ('a' .. 'z') | ('A' .. 'Z') | '_' ;
fragment VALID_ID_CHAR : VALID_ID_START | ('0' .. '9') ;
INT : ('0' .. '9')+ ;
MUL : '*' ;
DIV : '/' ;
ADD : '+' ;
SUB : '-' ;
LP : '(' ;
RP : ')' ;
WS : [ \r\n\t] + -> skip ;

The original grammars are left unchanged.

Current version

0.20.26 Updates to trparse. NB: not all Trash tools supported yet.

Product Compatible and additional computed target framework versions.
.NET net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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.8 113 11/1/2024
0.23.7 2,555 10/9/2024
0.23.6 726 9/21/2024
0.23.5 102 9/15/2024
0.23.4 101 9/7/2024
0.23.3 115 8/15/2024
0.23.2 121 6/28/2024
0.23.1 108 6/22/2024
0.23.0 184 4/25/2024
0.22.0 177 2/26/2024
0.21.16 270 11/16/2023
0.21.15 173 11/16/2023
0.21.14 180 11/15/2023
0.21.13 186 11/14/2023
0.21.12 277 10/27/2023
0.21.11 274 10/24/2023
0.21.9 284 9/27/2023
0.21.8 299 9/26/2023
0.21.7 230 9/26/2023
0.21.6 219 9/20/2023
0.21.5 202 9/18/2023
0.21.4 165 9/17/2023
0.21.3 199 9/14/2023
0.21.2 237 9/4/2023
0.21.1 314 8/15/2023
0.21.0 247 6/25/2023
0.20.27 222 6/15/2023
0.20.26 225 6/5/2023
0.20.25 211 6/3/2023
0.20.24 216 6/1/2023
0.20.23 170 5/31/2023
0.20.22 216 5/21/2023
0.20.21 226 5/15/2023
0.20.20 191 5/11/2023
0.20.19 193 5/8/2023
0.20.18 173 5/8/2023
0.20.17 210 5/4/2023
0.20.16 222 5/1/2023
0.20.15 207 4/27/2023
0.20.14 246 4/21/2023
0.20.13 269 4/13/2023
0.20.12 328 3/17/2023
0.20.11 292 3/15/2023
0.20.10 297 3/15/2023
0.20.9 297 3/14/2023
0.20.8 278 3/14/2023
0.20.7 269 3/13/2023
0.20.6 300 3/11/2023
0.20.5 325 3/11/2023
0.20.4 272 3/9/2023
0.20.3 279 3/8/2023
0.20.2 315 3/7/2023
0.20.1 289 3/7/2023
0.18.1 575 11/11/2022
0.18.0 458 11/7/2022
0.17.0 542 9/11/2022
0.16.5 545 7/29/2022
0.16.4 546 6/13/2022
0.16.3 635 5/7/2022
0.16.2 581 5/6/2022
0.16.1 571 5/5/2022
0.16.0 611 4/13/2022
0.15.1 597 4/4/2022
0.15.0 573 3/20/2022
0.14.3 590 2/27/2022
0.14.2 582 2/18/2022
0.14.1 614 1/26/2022
0.14.0 566 1/26/2022
0.13.8 586 1/14/2022
0.13.7 611 1/13/2022
0.13.6 574 1/13/2022
0.13.5 603 1/12/2022
0.13.4 590 1/11/2022
0.13.3 580 1/10/2022
0.13.2 398 12/24/2021
0.13.1 419 12/24/2021
0.13.0 426 12/23/2021
0.12.0 447 12/6/2021
0.11.5 512 10/17/2021
0.11.4 481 10/17/2021
0.11.3 471 9/28/2021
0.11.2 445 9/26/2021
0.11.1 460 9/25/2021
0.11.0 500 9/24/2021
0.10.0 530 9/9/2021
0.8.9 438 8/13/2021
0.8.8 432 8/5/2021
0.8.7 435 7/20/2021
0.8.6 467 7/13/2021
0.8.5 437 7/6/2021
0.8.4 420 6/24/2021
0.8.3 515 6/13/2021
0.8.2 442 6/8/2021
0.8.1 458 6/2/2021

# trcombine
## Summary
Combine a split Antlr4 grammar
## Description
Combine two grammars into one.
One grammar must be a lexer grammar, the other a parser grammar,
order is irrelevant. The output is parse tree data.
## Usage
trcombine <grammar1> <grammar2>
## Details
`trcombine` combines grammars that are known as "split grammars"
(separate Antlr4 lexer and parser grammars)
into one grammar, known as a "combined grammar". This refactoring is
useful if a simplified grammar grammar is wanted, and if possible if
the split grammar does not use the "superClass" option in one or the other
grammars. The opposite refactoring is implemented by
[trsplit](https://github.com/kaby76/Domemtech.Trash/tree/main/trsplit).
The split refactoring performs several operations:
* Combine the two files together, parser grammar first, then lexer grammar.
* Remove the `grammarDecl` for the lexer rules, and change the `grammarDecl`
for the parser rules to be a combined grammar declaration. Rename the name
of the parser grammar to not have "Parser" at the tail of the name.
* Remove the `optionsSpec` for the lexer section.
* Remove any occurrence of "tokenVocab" from the `optionsSpec` of the parser section.
* If the `optionsSpec` is empty, it is removed.
The order of the two grammars is ignored: the parser rules always will appear
before the lexer rules.
Lexer modes will require manual fix-up.
## Example
Consider the following grammar that is split.
_Input to command_
Lexer grammar in ExpressionLexer.g4:
lexer grammar ExpressionLexer;
VARIABLE : VALID_ID_START VALID_ID_CHAR* ;
fragment VALID_ID_START : ('a' .. 'z') | ('A' .. 'Z') | '_' ;
fragment VALID_ID_CHAR : VALID_ID_START | ('0' .. '9') ;
INT : ('0' .. '9')+ ;
MUL : '*' ;
DIV : '/' ;
ADD : '+' ;
SUB : '-' ;
LP : '(' ;
RP : ')' ;
WS : [ \r\n\t] + -> skip ;
Parser grammar in ExpressionParser.g4:
parser grammar ExpressionParser;
e : e ('*' | '/') e
| e ('+' | '-') e
| '(' e ')'
| ('-' | '+')* a
;
a : number | variable ;
number : INT ;
variable : VARIABLE ;
_Command_
trcombine ExpressionLexer.g4 ExpressionParser.g4 | trprint > Expression.g4
Combined grammar in Expression.g4:
grammar Expression;
e : e ('*' | '/') e
| e ('+' | '-') e
| '(' e ')'
| ('-' | '+')* a
;
a : number | variable ;
number : INT ;
variable : VARIABLE ;
VARIABLE : VALID_ID_START VALID_ID_CHAR* ;
fragment VALID_ID_START : ('a' .. 'z') | ('A' .. 'Z') | '_' ;
fragment VALID_ID_CHAR : VALID_ID_START | ('0' .. '9') ;
INT : ('0' .. '9')+ ;
MUL : '*' ;
DIV : '/' ;
ADD : '+' ;
SUB : '-' ;
LP : '(' ;
RP : ')' ;
WS : [ \r\n\t] + -> skip ;
The original grammars are left unchanged.
## Current version
0.20.26 Updates to trparse. NB: not all Trash tools supported yet.