/src Overview

From da389927ddf9240bbba10b819eb782e80a5d6bf7 Mon Sep 17 00:00:00 2001 From: Jed Barber Date: Tue, 19 Jan 2021 02:25:44 +1100 Subject: Basic HTML documentation added --- doc/src_overview.html | 74 +++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 74 insertions(+) create mode 100644 doc/src_overview.html (limited to 'doc/src_overview.html') 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 @@ + + + + + + + /src Overview - Packrat Docs + + + + + + +

+ + Return to Contents + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

packrat.adb packrat.ads	The main Packrat package.
packrat-errors.adb packrat-errors.ads packrat-errors-parts.adb	Error handling functionality. Use this if you need to handle Lexer_Error or + Parser_Error exception messages.
packrat-lexers.adb packrat-lexers.ads	Scanner functions, lexer components and combinators.
packrat-no_lex.ads	Convenience package to allow use of parser combinators and related functionality without + having to with and instantiate a long list of packages.
packrat-parse_graphs.adb packrat-parse_graphs.ads	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.
packrat-parsers.adb packrat-parsers.ads	Parser functions and combinators. More flexible and extensive than Packrat.Lexers.
packrat-standard.ads	Convenience package to allow use of both lexer and parser combinators as well as related + functionality without having to with and instantiate a long list of packages.
packrat-tokens.adb packrat-tokens.ads	Handles the individual tokens that lexers give as output and that form the nodes + of a parse graph.
packrat-traits.adb packrat-traits.ads	Convenience package to collect the various other things necessary to instantiate + a lot of the other packages.
packrat-utilities.adb packrat-utilities.ads	Convenience predicates for use with Satisfy combinators and the like when + lexing or parsing standard strings.

+ + + + + -- cgit