diff options
| author | Jed Barber <jjbarber@y7mail.com> | 2021-01-19 02:25:44 +1100 |
|---|---|---|
| committer | Jed Barber <jjbarber@y7mail.com> | 2021-01-19 02:25:44 +1100 |
| commit | da389927ddf9240bbba10b819eb782e80a5d6bf7 (patch) | |
| tree | 88b167b892de8c419151ca9a02c16f8d4ed96bec /doc/src_overview.html | |
| parent | 901c7e61278f16dc5c08cbebf74c2a816cd4b4b6 (diff) | |
Basic HTML documentation added
Diffstat (limited to 'doc/src_overview.html')
| -rw-r--r-- | doc/src_overview.html | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/src_overview.html b/doc/src_overview.html new file mode 100644 index 0000000..a0f4341 --- /dev/null +++ b/doc/src_overview.html @@ -0,0 +1,74 @@ + +<!DOCTYPE html> + +<html lang="en"> + <head> + <meta charset="utf-8"> + <title>/src Overview - Packrat Docs</title> + <link href="default.css" rel="stylesheet"> + </head> + + <body> + + + <h2>/src Overview</h2> + + <a href="index.html">Return to Contents</a> + + + <table> + <tr> + <td>packrat.adb<br>packrat.ads</td> + <td>The main Packrat package.</td> + </tr> + <tr> + <td>packrat-errors.adb<br>packrat-errors.ads<br>packrat-errors-parts.adb</td> + <td>Error handling functionality. Use this if you need to handle <em>Lexer_Error</em> or + <em>Parser_Error</em> exception messages.</td> + </tr> + <tr> + <td>packrat-lexers.adb<br>packrat-lexers.ads</td> + <td>Scanner functions, lexer components and combinators.</td> + </tr> + <tr> + <td>packrat-no_lex.ads</td> + <td>Convenience package to allow use of parser combinators and related functionality without + having to <em>with</em> and instantiate a long list of packages.</td> + </tr> + <tr> + <td>packrat-parse_graphs.adb<br>packrat-parse_graphs.ads</td> + <td>The data structure that parse results end up in. Externally it gives the appearance + of a directed acyclic graph with several root nodes. Internally a lot of deduplication is + done by labeling the nodes with starting points and the edges with finishing points then + keeping track of what edges are valid to go down given the current position.</td> + </tr> + <tr> + <td>packrat-parsers.adb<br>packrat-parsers.ads</td> + <td>Parser functions and combinators. More flexible and extensive than <em>Packrat.Lexers</em>.</td> + </tr> + <tr> + <td>packrat-standard.ads</td> + <td>Convenience package to allow use of both lexer and parser combinators as well as related + functionality without having to <em>with</em> and instantiate a long list of packages.</td> + </tr> + <tr> + <td>packrat-tokens.adb<br>packrat-tokens.ads</td> + <td>Handles the individual tokens that lexers give as output and that form the nodes + of a parse graph.</td> + </tr> + <tr> + <td>packrat-traits.adb<br>packrat-traits.ads</td> + <td>Convenience package to collect the various other things necessary to instantiate + a lot of the other packages.</td> + </tr> + <tr> + <td>packrat-utilities.adb<br>packrat-utilities.ads</td> + <td>Convenience predicates for use with <em>Satisfy</em> combinators and the like when + lexing or parsing standard strings.</td> + </tr> + </table> + + + </body> +</html> + |