jdb/jlp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
aac5915df7
jlp/doc/grammar.rst

58 lines
1.1 KiB
ReStructuredText
Raw Normal View History

Experimenting with a different AST structure and ideas. Ideas: * For literate output, format like Docco, tables like Doc | Code -----------|------------ | docblock | codeblock | | docblock | codeblock | | docblock | codeblock | * For javadoc output, maybe create a running 'pure source' object containing just the code lines. Then run an sup-parser for the language the code is written in and build a seperate AST for the code. This code AST then gets tagged onto the overall AST and is used in the generation phase for code comprehension. Would still need a way to map doc blocks to code blocks. I could probably use line numbers. In that case I would need to map the original source line from the commented input to the 'pure source' while processing the 'pure source' and store the original line number in the code AST. That would give me a reliable way to lookup the closest code structure to a doc block. * The code AST would need to made of generic pieces if I want to have language-agnostic generator code. What may be better is to allow the language parser to create it's code AST however is wants and just have some pluggable bit of the generator for each language. Would increase generator code complexity though.
2011-08-31 17:09:25 +00:00
SourceFile ->
(Block / DocBlock / CodeBlock)+
Started grammar definition.
2011-08-23 21:26:02 +00:00
Experimenting with a different AST structure and ideas. Ideas: * For literate output, format like Docco, tables like Doc | Code -----------|------------ | docblock | codeblock | | docblock | codeblock | | docblock | codeblock | * For javadoc output, maybe create a running 'pure source' object containing just the code lines. Then run an sup-parser for the language the code is written in and build a seperate AST for the code. This code AST then gets tagged onto the overall AST and is used in the generation phase for code comprehension. Would still need a way to map doc blocks to code blocks. I could probably use line numbers. In that case I would need to map the original source line from the commented input to the 'pure source' while processing the 'pure source' and store the original line number in the code AST. That would give me a reliable way to lookup the closest code structure to a doc block. * The code AST would need to made of generic pieces if I want to have language-agnostic generator code. What may be better is to allow the language parser to create it's code AST however is wants and just have some pluggable bit of the generator for each language. Would increase generator code complexity though.
2011-08-31 17:09:25 +00:00
Block ->
DocBlock CodeBlock
Started grammar definition.
2011-08-23 21:26:02 +00:00
Experimenting with a different AST structure and ideas. Ideas: * For literate output, format like Docco, tables like Doc | Code -----------|------------ | docblock | codeblock | | docblock | codeblock | | docblock | codeblock | * For javadoc output, maybe create a running 'pure source' object containing just the code lines. Then run an sup-parser for the language the code is written in and build a seperate AST for the code. This code AST then gets tagged onto the overall AST and is used in the generation phase for code comprehension. Would still need a way to map doc blocks to code blocks. I could probably use line numbers. In that case I would need to map the original source line from the commented input to the 'pure source' while processing the 'pure source' and store the original line number in the code AST. That would give me a reliable way to lookup the closest code structure to a doc block. * The code AST would need to made of generic pieces if I want to have language-agnostic generator code. What may be better is to allow the language parser to create it's code AST however is wants and just have some pluggable bit of the generator for each language. Would increase generator code complexity though.
2011-08-31 17:09:25 +00:00
DocBlock ->
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
(SDocBlock / MDocBlock)
Implmented actions to build AST. * Rewrote grammar slightly. * Added parboiled parse section to JLPMain. * Added code to build the AST while parsing. * Created ASTNode classes.
2011-08-26 20:40:56 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
SDocBlock ->
(SDirective / SDocText)+
Finished basic grammar outline.
2011-08-25 12:13:39 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
MDocBlock ->
MDOC_START (!MDOC_END / MDirective / MDocText)* MDOC_END
Worked on documentation, parser. * Added planning documentation regrding the process. * Updated grammer. * Refactored the test code a bit. * Added sample input file from vbs-suite * Refactored the AST node structure created by the parser.
2011-08-29 14:44:05 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
CodeBlock ->
(RemainingCodeLine)+
More work on grammar, starting parboiled implementation.
2011-08-25 12:47:01 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
SDirective ->
SDocLineStart AT (SLongDirective / SShortDirective)
Finished basic grammar outline.
2011-08-25 12:13:39 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
MDirective ->
MDocLineStart? AT (MLongDirective / MShortDirective)
Implmented actions to build AST. * Rewrote grammar slightly. * Added parboiled parse section to JLPMain. * Added code to build the AST while parsing. * Created ASTNode classes.
2011-08-26 20:40:56 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
SLongDirective ->
("api" / "example") RemainingSDocLine SDocText?
MLongDirective ->
("api" / "example") RemainingMDocLine MDocText?
SShortDirective ->
("author" / "org" / "copyright") RemainingSDocLine
MShortDirective ->
("author" / "org" / "copyright") RemainingMDocLine
SDocText ->
(SDocLineStart !AT RemainingSDocLine)+
MDocText ->
(MDocLineStart? !AT RemainingMDocLine)+
SDocLineStart ->
SPACE* SDOC_START SPACE?
MDocLineStart ->
SPACE* !MDOC_END MDOC_LINE_START SPACE?
RemainingSDocLine ->
((!EOL)* EOL) / ((!EOL)+ EOI)
RemainingMDocLine ->
((!(EOL / MDOC_END))* EOL) / ((!MDOC_END)+)
Implmented actions to build AST. * Rewrote grammar slightly. * Added parboiled parse section to JLPMain. * Added code to build the AST while parsing. * Created ASTNode classes.
2011-08-26 20:40:56 +00:00
Support for multi=line comments, detects file type. * Added support for multi-line comments to the JLPPegParser grammar implementation. * Added a Java sample file. * Updated test script to add convenience functions for the java test file and for using a TracingParseRunner for parse runs. * Added an option, `--css-file`, to allow the caller to specify their own css file. * Added basic logic to the Processor class to detect source file types and build a parser and a generator for that source type. Support currently exists for the following languages: C (.c, .h), C++ (.cpp, .c++, .hpp, .h++), Erlang (.erl), Groovy (.groovy), Java (.java), JavaScript (.js).
2011-12-26 04:07:48 +00:00
RemainingCodeLine ->
((!(EOL / MDOC_START / SDocLineStart))* EOL) /
(!(MDOC_START / SDocLineStart))+
Reference in New Issue Copy Permalink