@@ -8,26 +8,62 @@ These tools are meant to supplement the need to continually build java classes t
88
99### Grun.exe
1010
11- A breakdown of option statuses follows
12- - --tokens [ ** Full Suport** ]
13- - --gui [ ** Partial Support** ]
14- - --diagnostics [ ** Full Support** ]
15- - --trace [ ** Full Support** ]
16- - --encoding [ ** Full Support** ]
17- - --SLL [ ** Full Support** ]
18- - --ps [ ** Not Supported Yet** ]
19- - --tree [ ** Full Support** ]
11+ Grun.exe is meant to be a mostly faithful port of existing functionality provided by the standard
12+ grun batch file that in turn invokes the ANTLR test rig. All but one of the same options are
13+ supported. The option flags are slightly different in format due to the command line option
14+ parser that is being used. The parameters and option flags are detailed below
15+
16+ ** Grun.exe \< Grammar Name> \< Rule Name> [ \< Input Filename>] [ options] **
17+
18+ Grammar Name (pos. 0)
19+ : Required. ANTLR grammar to load
20+
21+ Rule Name (pos. 1)
22+ : Required. ANTLR grammar rule to use
23+
24+ Input Filename (pos. 2)
25+ : File name to parse
26+
27+ | Option Name | Description |
28+ | --- | --- |
29+ | --tokens | Display list of grammar tokens. |
30+ | --tree | Display a Lisp-style parse tree.|
31+ | --trace | Trace grammar parsing. |
32+ | --gui | Opens GrunWin.exe gui tool. |
33+ | --SLL | Parse using SLL prediction mode.|
34+ | --diagnostics | Parse with diagnostics. |
35+ | --encoding | Encoding type to use. |
36+ | --help | Display this help screen. |
37+ | --version | Display version information. |
2038
2139The gui flag simply opens the GrunWin tool (which can also be executed stand-alone).
2240
2341### GrunWin.exe
24- GrunWin is more than just a graphical parse tree viewer. It also displays a tab with
25- the grid view of tokens and a robust editor window. As code is changed in the editor,
26- GrunWin continues to re-parse for tokens and rebuild the graphical parse tree. I eventually
27- plan to add syntax highlighting to the editor window as well as a list of parser errors in
28- a grid view.
29- By default it will attempt to intelligently figure out some colors for different tokens.
30- However, it will also support dynamic loading of helper classes to give it concrete highlighting guides.
31- I have not worked out the interface for this guide yet, but it can be included in the grammar assembly
32- or any other assembly in the same folder as the grammar assembly.
33- GrunWin will also look for syntax guides in a special folder within the location of the GrunWin executable as well.
42+ GrunWin is a replacement for the gui parse tree viewer that the standard test rig displays.
43+ GrunWin Features
44+ - Can be run as a stand-alone application
45+ - Features a robust code editor window to use for grammar testing.
46+ - Features a graphical parse tree viewer.
47+ - Features a parser message window that displays parser errors.
48+ - Features a token viewer that displays detailed information about lexer tokens.
49+
50+ The parse tree graph, token display and parser error messages all update in real-time
51+ as you enter text into the code editor. You can load a new grammar at any while GrunWin
52+ is running. GrunWin also supports a handful of optional command line parameters.
53+
54+ ** GrunWin.exe [ options] **
55+
56+ | Option Name | Description |
57+ | --- | --- |
58+ | --grammar | Attempts to load the specified grammar. |
59+ | --rule | Attempts to load the specified rule name. |
60+ | --trace | Trace grammar parsing. |
61+ | --SLL | Parse using SLL prediction mode.|
62+ | --diagnostics | Parse with diagnostics. |
63+ | --encoding | Encoding type to use. |
64+
65+ ![ alt text] ( https://github.com/wiredwiz/Grun.Net/tree/master/Images/GrunWinExample.gif )
66+
67+ I eventually plan to add syntax highlighting to the editor window. The tool will attempt
68+ to build a color pallet heuristically, but an ISyntaxGuide can be implemented to help
69+ GrunWin highlight the text more to your liking.
0 commit comments