<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Quickstart Guide - Packrat Docs</title>
<link href="default.css" rel="stylesheet">
</head>
<body>
<h2>Quickstart Guide</h2>
<a href="index.html">Return to Contents</a>
<h4>Lexing and Parsing</h4>
<p>The package that you will need is <em>Packrat.Standard</em>. If you are parsing
ordinary strings then <em>Packrat.Utilities</em> may also be useful.<br>
<br>
Define enumeration types for all the lexer token labels and parse graph node labels
you need, then use them to instantiate <em>Packrat.Standard</em>.<br>
<br>
Instantiate subprograms from the nested <em>Lexers</em> package to create your lexer,
and subprograms from the nested <em>Parsers</em> package to create your parser.<br>
<br>
Take special care when using any redirects from <em>Parsers</em>. They are used to
allow for self-referential instantiation of parser combinators and must be set properly
before using any parsers built with them. Otherwise an exception will be raised.<br>
<br>
Feed your input through the lexer, then the results of that through the parser to
obtain a parse graph.<br>
<br>
Use subprograms from the nested <em>Parse_Graphs</em> package to inspect and manipulate
the resulting graph.
</p>
<h4>Parsing Only</h4>
<p>The package that you will need is <em>Packrat.No_Lex</em>. If you are parsing
ordinary strings then <em>Packrat.Utilities</em> may also be useful.<br>
<br>
Define an enumeration type for all the parse graph node labels you need, then use it
to instantiate <em>Packrat.No_Lex</em>.<br>
<br>
Instantiate subprograms from the nested <em>Parsers</em> package to create your parser.<br>
<br>
Take special care when using any redirects. They are used to allow for self-referential
instantiation of parser combinators and must be set properly before using any parsers
built with them. Otherwise an exception will be raised.<br>
<br>
Feed your input through the parser to obtain a parse graph.<br>
<br>
Use subprograms from the nested <em>Parse_Graphs</em> package to inspect and manipulate
the resulting graph.
</p>
</body>
</html>