Skip to content
This repository
Browse code

Merge branch 'gh-pages' of github.com:joshua-choi/fnparse

  • Loading branch information...
commit 54d08fc798a55b90dbf7902833932a0dd87ee381 2 parents 803c4f6 + 59bf36d
Joshua Choi authored
419 api-index.html
... ... @@ -0,0 +1,419 @@
  1 +<html>
  2 + <head>
  3 + <title>fnparse - Index</title>
  4 + <link href="static/favicon.png" rel="icon" />
  5 + <link href="static/favicon.png" rel="shortcut icon" />
  6 + <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
  7 + <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
  8 + <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
  9 + <!-- TODO: are we using these (from clojure.org)? If so, add the files -->
  10 + <script src="file/view/code_highlighter.js" type="text/javascript"></script>
  11 + <script src="file/view/clojure.js" type="text/javascript"></script>
  12 + <style>.menuWrapper{height: 36px;}</style>
  13 + <!--[if lte IE 6]>
  14 + <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
  15 + <![endif]-->
  16 + </head>
  17 +<!--
  18 +This document was auto-generated from the source by the clojure autodoc system.
  19 +To report errors or ask questions about the overall documentation structure, formatting,
  20 +etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
  21 +For errors in the documentation of a particular namespace, contact the author of that
  22 +namespace.
  23 +-->
  24 + <body>
  25 + <div id="AllContentContainer">
  26 + <div id="Header">
  27 + <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
  28 + <h1><a title="page header title" id="page-header" href="index.html">fnparse</a></h1>
  29 + </div>
  30 + <div id="leftcolumn"><div style="text-align: center;"></div>
  31 +<div class="menu">
  32 + <div class="WikiCustomNav WikiElement wiki">
  33 + <a class="wiki_link" href="index.html">Overview</a><br />
  34 + <a class="wiki_link" href="api-index.html">API Index</a><br />
  35 + <a class="wiki_link" href="#">Namespaces:</a>
  36 + <ul id="left-sidebar-list">
  37 + <li><a href="edu.arizona.fnparse.cat-api.html" class="wiki_link">edu.arizona.fnparse.cat</a></li><li><a href="edu.arizona.fnparse.clojure-api.html" class="wiki_link">edu.arizona.fnparse.clojure</a></li><li><a href="edu.arizona.fnparse.core-api.html" class="wiki_link">edu.arizona.fnparse.core</a></li><li><a href="edu.arizona.fnparse.hound-api.html" class="wiki_link">edu.arizona.fnparse.hound</a></li><li><a href="edu.arizona.fnparse.json-api.html" class="wiki_link">edu.arizona.fnparse.json</a></li><li><a href="edu.arizona.fnparse.math-api.html" class="wiki_link">edu.arizona.fnparse.math</a></li>
  38 + </ul>
  39 + </div>
  40 +</div>
  41 +</div>
  42 + <div id="rightcolumn">
  43 + <div id="Content">
  44 + <div class="contentBox"><div class="innerContentBox">
  45 + <div id="content_view" class="wiki wikiPage">
  46 + <div id="right-sidebar"></div>
  47 + <div id="content-tag"><h1 id="overview">Index of Public Functions and Variables in <span class="project-name-span">fnparse</span></h1>
  48 +This page has an alphabetical index of all the documented functions and variables
  49 +in <span class="project-name-span">fnparse</span>.
  50 +
  51 +<!-- TODO: enable this functionality on github?
  52 +
  53 +In a narrow browser window, you may want to collapse the sidebar (use the \"<<\" link)
  54 +to get more screen space for the index.
  55 +-->
  56 +
  57 +<div class="shortcuts">
  58 +Shortcuts:<br />
  59 +<a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a>
  60 + <a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#H">H</a>
  61 + <a href="#I">I</a> <a href="#J">J</a> <a href="#K">K</a> <a href="#L">L</a>
  62 + <a href="#M">M</a>
  63 +<br />
  64 +<a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#Q">Q</a>
  65 + <a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a>
  66 + <a href="#V">V</a> <a href="#W">W</a> <a href="#X">X</a> <a href="#Y">Y</a>
  67 + <a href="#Z">Z</a>
  68 +<br />
  69 +<a href="#Other">Other</a>
  70 +<br />
  71 +</div>
  72 +
  73 +<div id="index-body">
  74 + <h2 id="A"><span id="section-head">A</span></h2>
  75 + <pre>
  76 +<span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;addition-level&gt;">&lt;addition-level&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  77 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;anything&gt;">&lt;anything&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat The generic terminal rule that matches any on...
  78 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;anything&gt;">&lt;anything&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound The generic terminal rule that matches any ...
  79 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;array-content&gt;">&lt;array-content&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a sequence of JSON values separated...
  80 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;array-end&gt;">&lt;array-end&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  81 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;array-start&gt;">&lt;array-start&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  82 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;array&gt;">&lt;array&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a JSON array. Optionally padded on ...
  83 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;ascii-alphanumeric&gt;">&lt;ascii-alphanumeric&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single alphanumeric ASCII l...
  84 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;ascii-alphanumeric&gt;">&lt;ascii-alphanumeric&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single alphanumeric ASCII...
  85 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;ascii-control&gt;">&lt;ascii-control&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single ASCII control charac...
  86 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;ascii-control&gt;">&lt;ascii-control&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single ASCII control char...
  87 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;ascii-digit&gt;">&lt;ascii-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single ASCII numeric digit....
  88 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;ascii-digit&gt;">&lt;ascii-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single ASCII numeric digi...
  89 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;ascii-letter&gt;">&lt;ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single uppercase or lowerca...
  90 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;ascii-letter&gt;">&lt;ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single uppercase or lower...
  91 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/add-warning">add-warning</a><span id="line-content"> function edu.arizona.fnparse.cat A rule that adds a new warning with the given...
  92 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/add-warning">add-warning</a><span id="line-content"> function edu.arizona.fnparse.hound A rule that adds a new warning with the giv...
  93 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/alter-context">alter-context</a><span id="line-content"> function edu.arizona.fnparse.hound A rule that alters the current context. Ru...
  94 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/alter-location">alter-location</a><span id="line-content"> function edu.arizona.fnparse.cat A rule that alters the current location. Rul...
  95 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/alter-location">alter-location</a><span id="line-content"> function edu.arizona.fnparse.hound A rule that alters the current location. R...
  96 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/annotate-error">annotate-error</a><span id="line-content"> function edu.arizona.fnparse.cat Creates an error-annotating rule. Whenever th...
  97 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/annotate-error">annotate-error</a><span id="line-content"> function edu.arizona.fnparse.hound Creates an error-annotating rule. Whenever ...
  98 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/antilit">antilit</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule of an antiliteral. A shortcut ...
  99 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/antilit">antilit</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule of an antiliteral. A shortcu...
  100 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/antiset-term">antiset-term</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a terminal rule with an antiset. A sh...
  101 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/antiset-term">antiset-term</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a terminal rule with an antiset. A ...
  102 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/antiterm">antiterm</a><span id="line-content"> function edu.arizona.fnparse.cat Exactly like term, only uses the complement o...
  103 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/antiterm">antiterm</a><span id="line-content"> function edu.arizona.fnparse.hound Exactly like term, only uses the complement...
  104 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/antivalidate">antivalidate</a><span id="line-content"> function edu.arizona.fnparse.cat Exactly like the `validate` function, except ...
  105 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/antivalidate">antivalidate</a><span id="line-content"> function edu.arizona.fnparse.hound Exactly like the `validate` function, excep...
  106 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/AParseAnswer">AParseAnswer</a><span id="line-content"> var edu.arizona.fnparse.core The protocol of FnParse Answers: what FnPars...
  107 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/apply">apply</a><span id="line-content"> function edu.arizona.fnparse.core Applies the given rule to the given state..
  108 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/AState">AState</a><span id="line-content"> var edu.arizona.fnparse.core The protocol of FnParse states, which must b...
  109 +</span></span></pre>
  110 +</div><div id="index-body">
  111 + <h2 id="B"><span id="section-head">B</span></h2>
  112 + <pre>
  113 +</pre>
  114 +</div><div id="index-body">
  115 + <h2 id="C"><span id="section-head">C</span></h2>
  116 + <pre>
  117 +<span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;comment-char&gt;">&lt;comment-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a character inside a line commen...
  118 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;comment-indicator&gt;">&lt;comment-indicator&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure There are two line comment indicators, `;...
  119 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;comment&gt;">&lt;comment&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a line comment..
  120 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;control-char&gt;">&lt;control-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes an ASCII control character, which i...
  121 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/case-insensitive-lit">case-insensitive-lit</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a case-insensitive rule using Java's ...
  122 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/case-insensitive-lit">case-insensitive-lit</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a case-insensitive rule using Java'...
  123 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/cat">cat</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a concatenated rule out of many given...
  124 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/cat">cat</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a concatenated rule out of many giv...
  125 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/chook">chook</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule with a constant semantic hook....
  126 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/chook">chook</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule with a constant semantic hoo...
  127 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/circumfix">circumfix</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a circumfixed rule. Use when you want...
  128 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/circumfix">circumfix</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a circumfixed rule. Use when you wa...
  129 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/combine">combine</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule combining the given `rule` int...
  130 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/combine">combine</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule combining the given `rule` i...
  131 +</span></span></pre>
  132 +</div><div id="index-body">
  133 + <h2 id="D"><span id="section-head">D</span></h2>
  134 + <pre>
  135 +<span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;decimal-digit&gt;">&lt;decimal-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single core-10 digit charac...
  136 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;decimal-digit&gt;">&lt;decimal-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single core-10 digit char...
  137 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;derefed&gt;">&lt;derefed&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  138 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;discarded&gt;">&lt;discarded&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a discarded form (prefixed by `#...
  139 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;document&gt;">&lt;document&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a general JSON document, optionally...
  140 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/defmaker">defmaker</a><span id="line-content"> macro edu.arizona.fnparse.cat Creates a rule-making function. Use this inst...
  141 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/defmaker">defmaker</a><span id="line-content"> macro edu.arizona.fnparse.hound Creates a rule-making function. Use this in...
  142 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/defmaker-">defmaker-</a><span id="line-content"> macro edu.arizona.fnparse.cat Like `defmaker`, but also makes the var priva...
  143 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/defmaker-">defmaker-</a><span id="line-content"> macro edu.arizona.fnparse.hound Like `defmaker`, but also makes the var pri...
  144 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/defmaker-macro">defmaker-macro</a><span id="line-content"> macro edu.arizona.fnparse.cat Like `defmaker`, but makes a macro rule-maker...
  145 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/defmaker-macro">defmaker-macro</a><span id="line-content"> macro edu.arizona.fnparse.hound Like `defmaker`, but makes a macro rule-mak...
  146 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/defrule">defrule</a><span id="line-content"> macro edu.arizona.fnparse.cat Defines a rule var. You really should use thi...
  147 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/defrule">defrule</a><span id="line-content"> macro edu.arizona.fnparse.hound Defines a rule var. You really should use t...
  148 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/defrule-">defrule-</a><span id="line-content"> macro edu.arizona.fnparse.cat Like `defrule`, but also makes the var privat...
  149 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/defrule-">defrule-</a><span id="line-content"> macro edu.arizona.fnparse.hound Like `defrule`, but also makes the var priv...
  150 +</span></span></pre>
  151 +</div><div id="index-body">
  152 + <h2 id="E"><span id="section-head">E</span></h2>
  153 + <pre>
  154 +<span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;emptiness&gt;">&lt;emptiness&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat The general emptiness rule. (Actually just `(...
  155 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;emptiness&gt;">&lt;emptiness&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound The general emptiness rule. (Actually just ...
  156 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;end-of-input&gt;">&lt;end-of-input&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat The standard end-of-input rule. Rule Summary...
  157 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;end-of-input&gt;">&lt;end-of-input&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound The standard end-of-input rule. Rule Summa...
  158 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;escape-char-start&gt;">&lt;escape-char-start&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  159 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;escaped-str-char&gt;">&lt;escaped-str-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes an escaped character in a string: a...
  160 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/effects">effects</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a side-effect rule. Applies the given...
  161 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/effects">effects</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a side-effect rule. Applies the giv...
  162 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/except">except</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a subtracted rule. Matches using the ...
  163 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/except">except</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a subtracted rule. Matches using th...
  164 +</span></span></pre>
  165 +</div><div id="index-body">
  166 + <h2 id="F"><span id="section-head">F</span></h2>
  167 + <pre>
  168 +<span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/*format-remainder-limit*">*format-remainder-limit*</a><span id="line-content"> var edu.arizona.fnparse.core The limit at which `format-remainder`will cu...
  169 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;false&gt;">&lt;false&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  170 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;fetch-context&gt;">&lt;fetch-context&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule that fetches the current context. R...
  171 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;fetch-location&gt;">&lt;fetch-location&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule that fetches the current state's locat...
  172 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;fetch-location&gt;">&lt;fetch-location&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule that fetches the current state's loc...
  173 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;fetch-warnings&gt;">&lt;fetch-warnings&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule that fetches the current state's warni...
  174 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;fetch-warnings&gt;">&lt;fetch-warnings&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule that fetches the current state's war...
  175 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;form-end&gt;">&lt;form-end&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Peeks and checks for a separator or the e...
  176 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;form-series&gt;">&lt;form-series&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  177 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/factor=">factor=</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a non-greedy repetition rule. Conca...
  178 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/failure?">failure?</a><span id="line-content"> function edu.arizona.fnparse.core Is the given result a Failure?.
  179 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/fetch-referred-namespace">fetch-referred-namespace</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  180 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/find">find</a><span id="line-content"> function edu.arizona.fnparse.cat Finds all occurrences of a rule in a sequence...
  181 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/find">find</a><span id="line-content"> function edu.arizona.fnparse.core Finds all occurrences of a rule in a sequenc...
  182 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/find">find</a><span id="line-content"> function edu.arizona.fnparse.hound Finds all occurrences of a rule in a sequen...
  183 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/for">for</a><span id="line-content"> macro edu.arizona.fnparse.cat Creates a rule comprehension, very much like ...
  184 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/for">for</a><span id="line-content"> macro edu.arizona.fnparse.hound Creates a rule comprehension, very much lik...
  185 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/format-parse-error">format-parse-error</a><span id="line-content"> function edu.arizona.fnparse.core Returns a formatted string from the given er...
  186 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/format-parse-error">format-parse-error</a><span id="line-content"> function edu.arizona.fnparse.hound Returns a formatted string from the given e...
  187 +</span></span></pre>
  188 +</div><div id="index-body">
  189 + <h2 id="G"><span id="section-head">G</span></h2>
  190 + <pre>
  191 +</pre>
  192 +</div><div id="index-body">
  193 + <h2 id="H"><span id="section-head">H</span></h2>
  194 + <pre>
  195 +<span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;hexadecimal-digit&gt;">&lt;hexadecimal-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single core-16 digit charac...
  196 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;hexadecimal-digit&gt;">&lt;hexadecimal-digit&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single core-16 digit char...
  197 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/hook">hook</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule with a semantic hook. A shortc...
  198 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/hook">hook</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule with a semantic hook. A shor...
  199 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/hooked-rep">hooked-rep</a><span id="line-content"> function edu.arizona.fnparse.hound A `reduce`-like version of `rep`. See `rep`...
  200 +</span></span></pre>
  201 +</div><div id="index-body">
  202 + <h2 id="I"><span id="section-head">I</span></h2>
  203 + <pre>
  204 +<span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;inc-column&gt;">&lt;inc-column&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A literal rule that also increments the col...
  205 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;inc-line&gt;">&lt;inc-line&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A literal rule that also increments the lin...
  206 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;indicator&gt;">&lt;indicator&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a Clojure indicator character..
  207 +</span></span></pre>
  208 +</div><div id="index-body">
  209 + <h2 id="J"><span id="section-head">J</span></h2>
  210 + <pre>
  211 +</pre>
  212 +</div><div id="index-body">
  213 + <h2 id="K"><span id="section-head">K</span></h2>
  214 + <pre>
  215 +</pre>
  216 +</div><div id="index-body">
  217 + <h2 id="L"><span id="section-head">L</span></h2>
  218 + <pre>
  219 +<span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;lowercase-ascii-letter&gt;">&lt;lowercase-ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single lowercase ASCII lett...
  220 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;lowercase-ascii-letter&gt;">&lt;lowercase-ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single lowercase ASCII le...
  221 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/label">label</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a labelled rule. Labels the given ru...
  222 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/label">label</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a labelled rule. Labels the given ...
  223 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/lex">lex</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a lexical rule. You use this whenev...
  224 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/lit">lit</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule of a literal. A shortcut for `...
  225 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/lit">lit</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule of a literal. A shortcut for...
  226 +</span></span></pre>
  227 +</div><div id="index-body">
  228 + <h2 id="M"><span id="section-head">M</span></h2>
  229 + <pre>
  230 +<span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;multiplication-level&gt;">&lt;multiplication-level&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  231 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/make-state">make-state</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a state with the given parameters..
  232 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/mapcat">mapcat</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule that is the result of applying...
  233 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/mapcat">mapcat</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule that is the result of applyi...
  234 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/mapsum">mapsum</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule that is the result of applying...
  235 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/mapsum">mapsum</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule that is the result of applyi...
  236 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/match">match</a><span id="line-content"> function edu.arizona.fnparse.cat The general matching function of FnParse. Att...
  237 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/match">match</a><span id="line-content"> function edu.arizona.fnparse.core The general matching function of FnParse. At...
  238 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/match">match</a><span id="line-content"> function edu.arizona.fnparse.hound The general matching function of FnParse. A...
  239 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/matches-seq">matches-seq</a><span id="line-content"> function edu.arizona.fnparse.cat Finds all *consecutive* occurrences of a rule...
  240 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/matches-seq">matches-seq</a><span id="line-content"> function edu.arizona.fnparse.core Finds all *consecutive* occurrences of a rul...
  241 +</span></span></pre>
  242 +</div><div id="index-body">
  243 + <h2 id="N"><span id="section-head">N</span></h2>
  244 + <pre>
  245 +<span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;name-separator&gt;">&lt;name-separator&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  246 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;non-alphanumeric-symbol-char&gt;">&lt;non-alphanumeric-symbol-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a non-alphanumeric character all...
  247 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;normal-str-char&gt;">&lt;normal-str-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes normal, non-espaced string characte...
  248 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;normal-ws-char&gt;">&lt;normal-ws-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a normal whitespace character su...
  249 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;nothing&gt;">&lt;nothing&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat The general failing rule. Use `with-error` o...
  250 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;nothing&gt;">&lt;nothing&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound The general failing rule. Use `with-error`...
  251 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;ns-separator&gt;">&lt;ns-separator&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a forward slash: the separator o...
  252 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;null&gt;">&lt;null&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  253 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;number&gt;">&lt;number&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  254 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/not-followed">not-followed</a><span id="line-content"> function edu.arizona.fnparse.cat See also `except`..
  255 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/not-followed">not-followed</a><span id="line-content"> function edu.arizona.fnparse.hound See also `except`..
  256 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/nothing-descriptors">nothing-descriptors</a><span id="line-content"> var edu.arizona.fnparse.hound The error descriptors that `&lt;nothing&gt;` uses...
  257 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/ns-qualified-keyword-empty-end">ns-qualified-keyword-empty-end</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  258 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/ns-qualified-keyword-end-with-slash">ns-qualified-keyword-end-with-slash</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  259 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/ns-resolved-keyword-end">ns-resolved-keyword-end</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  260 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/number-tail">number-tail</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  261 +</span></span></pre>
  262 +</div><div id="index-body">
  263 + <h2 id="O"><span id="section-head">O</span></h2>
  264 + <pre>
  265 +<span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;object-content&gt;">&lt;object-content&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a sequence of object entries separa...
  266 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;object-end&gt;">&lt;object-end&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  267 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;object-entry&gt;">&lt;object-entry&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a string-value pair with a colon. T...
  268 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;object-start&gt;">&lt;object-start&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  269 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;object&gt;">&lt;object&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a JSON object. Optionally padded on...
  270 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/opt">opt</a><span id="line-content"> function edu.arizona.fnparse.cat Creates an optional rule. It is equivalent to...
  271 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/opt">opt</a><span id="line-content"> function edu.arizona.fnparse.hound Creates an optional rule. It is equivalent ...
  272 +</span></span></pre>
  273 +</div><div id="index-body">
  274 + <h2 id="P"><span id="section-head">P</span></h2>
  275 + <pre>
  276 +<span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;parenthesized&gt;">&lt;parenthesized&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  277 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/padded-lit">padded-lit</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  278 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/parser-m">parser-m</a><span id="line-content"> var edu.arizona.fnparse.cat The monad that FnParse Cat uses..
  279 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/parser-m">parser-m</a><span id="line-content"> var edu.arizona.fnparse.hound The monad that FnParse Hound uses..
  280 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/peek">peek</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a lookahead rule. Checks if the given...
  281 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/peek">peek</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a lookahead rule. Checks if the giv...
  282 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/phrase">phrase</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a phrase rule, which succeeds only wh...
  283 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/phrase">phrase</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a phrase rule, which succeeds only ...
  284 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/prefix">prefix</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a prefixed rule. Use when you want to...
  285 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/prefix">prefix</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a prefixed rule. Use when you want ...
  286 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/prod">prod</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a rule that always returns the given ...
  287 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/prod">prod</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a rule that always returns the give...
  288 +</span></span></pre>
  289 +</div><div id="index-body">
  290 + <h2 id="Q"><span id="section-head">Q</span></h2>
  291 + <pre>
  292 +<span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;quoted&gt;">&lt;quoted&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  293 +</span></span></pre>
  294 +</div><div id="index-body">
  295 + <h2 id="R"><span id="section-head">R</span></h2>
  296 + <pre>
  297 +<span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/radix-coefficient-tail">radix-coefficient-tail</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  298 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/radix-digit">radix-digit</a><span id="line-content"> function edu.arizona.fnparse.cat Returns a rule that accepts one digit charact...
  299 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/radix-digit">radix-digit</a><span id="line-content"> function edu.arizona.fnparse.hound Returns a rule that accepts one digit chara...
  300 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/radix-label">radix-label</a><span id="line-content"> function edu.arizona.fnparse.cat The function used by radix-digit to smartly c...
  301 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/radix-label">radix-label</a><span id="line-content"> function edu.arizona.fnparse.hound The function used by radix-digit to smartly...
  302 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/radix-natural-number">radix-natural-number</a><span id="line-content"> function edu.arizona.fnparse.clojure No description available..
  303 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/read-string">read-string</a><span id="line-content"> function edu.arizona.fnparse.clojure Reads one object from the given string. A...
  304 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/rep">rep</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a one-or-more greedy repetition rul...
  305 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/rep*">rep*</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a zero-or-more greedy repetition ru...
  306 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/rule?">rule?</a><span id="line-content"> function edu.arizona.fnparse.cat Tests if the given object is a Hound Rule, or...
  307 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/rule?">rule?</a><span id="line-content"> function edu.arizona.fnparse.hound Tests if the given object is a Hound Rule, ...
  308 +</span></span></pre>
  309 +</div><div id="index-body">
  310 + <h2 id="S"><span id="section-head">S</span></h2>
  311 + <pre>
  312 +<span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;separator&gt;">&lt;separator&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes a separator of Clojure forms: wh...
  313 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;str-char&gt;">&lt;str-char&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a general string character. Rule S...
  314 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;str-content&gt;">&lt;str-content&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a sequence of string characters. R...
  315 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;str-delimiter&gt;">&lt;str-delimiter&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  316 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;str&gt;">&lt;str&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a JSON string. Rule Summary ======...
  317 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;symbol-content&gt;">&lt;symbol-content&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  318 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;syntax-quoted&gt;">&lt;syntax-quoted&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  319 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/separated-rep">separated-rep</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a greedy repetition rule with a sep...
  320 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/separated-rep*">separated-rep*</a><span id="line-content"> function edu.arizona.fnparse.hound Like `separated-rep`, but also calls `opt` ...
  321 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/set-term">set-term</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a terminal rule with a set. A shortcu...
  322 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/set-term">set-term</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a terminal rule with a set. A short...
  323 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/state?">state?</a><span id="line-content"> function edu.arizona.fnparse.cat Tests if the given object is a Hound State..
  324 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/state?">state?</a><span id="line-content"> function edu.arizona.fnparse.hound Tests if the given object is a Hound State..
  325 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/substitute">substitute</a><span id="line-content"> function edu.arizona.fnparse.cat Substitutes all occurences of a rule in a seq...
  326 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/substitute">substitute</a><span id="line-content"> function edu.arizona.fnparse.core Substitutes all occurences of a rule in a se...
  327 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/substitute">substitute</a><span id="line-content"> function edu.arizona.fnparse.hound Substitutes all occurences of a rule in a s...
  328 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/substitute-1">substitute-1</a><span id="line-content"> function edu.arizona.fnparse.cat Substitutes the first occurence of a rule in ...
  329 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/substitute-1">substitute-1</a><span id="line-content"> function edu.arizona.fnparse.core Substitutes the first occurence of a rule in...
  330 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/substitute-1">substitute-1</a><span id="line-content"> function edu.arizona.fnparse.hound Substitutes the first occurence of a rule i...
  331 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.core-api.html#edu.arizona.fnparse.core/success?">success?</a><span id="line-content"> function edu.arizona.fnparse.core Is the given result is a Success?.
  332 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/suffix">suffix</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a suffixed rule. Use when you want to...
  333 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/suffix">suffix</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a suffixed rule. Use when you want ...
  334 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/suffix-peek">suffix-peek</a><span id="line-content"> function edu.arizona.fnparse.cat No description available..
  335 +</span></span></pre>
  336 +</div><div id="index-body">
  337 + <h2 id="T"><span id="section-head">T</span></h2>
  338 + <pre>
  339 +<span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;true&gt;">&lt;true&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  340 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/template-sum">template-sum</a><span id="line-content"> macro edu.arizona.fnparse.cat Creates a summed rule using a template. Acts ...
  341 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/template-sum">template-sum</a><span id="line-content"> macro edu.arizona.fnparse.hound Creates a summed rule using a template. Act...
  342 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/term">term</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a terminal rule. The new rule either...
  343 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/term">term</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a terminal rule. The new rule eith...
  344 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/term*">term*</a><span id="line-content"> function edu.arizona.fnparse.cat Exactly like `term`, only its product is the ...
  345 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/term*">term*</a><span id="line-content"> function edu.arizona.fnparse.hound Exactly like `term`, only its product is th...
  346 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/term-">term-</a><span id="line-content"> function edu.arizona.fnparse.cat All terminal Cat rules, including `term` and ...
  347 +</span></span></pre>
  348 +</div><div id="index-body">
  349 + <h2 id="U"><span id="section-head">U</span></h2>
  350 + <pre>
  351 +<span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;unicode-sequence&gt;">&lt;unicode-sequence&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a lowercase 'u' followed by hexadec...
  352 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;unquote-spliced&gt;">&lt;unquote-spliced&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  353 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;unquoted&gt;">&lt;unquoted&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  354 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/&lt;uppercase-ascii-letter&gt;">&lt;uppercase-ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.cat A rule matching a single uppercase ASCII lett...
  355 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/&lt;uppercase-ascii-letter&gt;">&lt;uppercase-ascii-letter&gt;</a><span id="line-content"> var edu.arizona.fnparse.hound A rule matching a single uppercase ASCII le...
  356 +</span></span></pre>
  357 +</div><div id="index-body">
  358 + <h2 id="V"><span id="section-head">V</span></h2>
  359 + <pre>
  360 +<span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;value-separator&gt;">&lt;value-separator&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Padded on the front with optional whitespace...
  361 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;value&gt;">&lt;value&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes a general JSON value, optionally pa...
  362 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;var-inner&gt;">&lt;var-inner&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  363 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/validate">validate</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a validating rule. A convenience fun...
  364 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/validate">validate</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a validating rule. A convenience f...
  365 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/vcat">vcat</a><span id="line-content"> function edu.arizona.fnparse.cat Exactly like cat, only applies `vec` to its p...
  366 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/vcat">vcat</a><span id="line-content"> function edu.arizona.fnparse.hound Exactly like cat, only applies `vec` to its...
  367 +</span></span></pre>
  368 +</div><div id="index-body">
  369 + <h2 id="W"><span id="section-head">W</span></h2>
  370 + <pre>
  371 +<span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;with-meta-inner&gt;">&lt;with-meta-inner&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure No description available..
  372 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;ws&gt;">&lt;ws&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure The general whitespace rule: spaces, line...
  373 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/&lt;ws&gt;">&lt;ws&gt;</a><span id="line-content"> var edu.arizona.fnparse.math No description available..
  374 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.clojure-api.html#edu.arizona.fnparse.clojure/&lt;ws?&gt;">&lt;ws?&gt;</a><span id="line-content"> var edu.arizona.fnparse.clojure Consumes optional whitespace..
  375 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.json-api.html#edu.arizona.fnparse.json/&lt;ws?&gt;">&lt;ws?&gt;</a><span id="line-content"> var edu.arizona.fnparse.json Consumes optional, ignored JSON whitespace..
  376 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/when">when</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a maybe-failing rule— an either succe...
  377 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/when">when</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a maybe-failing rule— an either suc...
  378 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/with-error">with-error</a><span id="line-content"> function edu.arizona.fnparse.cat Creates an always-failing rule with the given...
  379 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/with-error">with-error</a><span id="line-content"> function edu.arizona.fnparse.hound Creates an always-failing rule with the giv...
  380 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.math-api.html#edu.arizona.fnparse.math/ws-suffix">ws-suffix</a><span id="line-content"> function edu.arizona.fnparse.math No description available..
  381 +</span></span></pre>
  382 +</div><div id="index-body">
  383 + <h2 id="X"><span id="section-head">X</span></h2>
  384 + <pre>
  385 +</pre>
  386 +</div><div id="index-body">
  387 + <h2 id="Y"><span id="section-head">Y</span></h2>
  388 + <pre>
  389 +</pre>
  390 +</div><div id="index-body">
  391 + <h2 id="Z"><span id="section-head">Z</span></h2>
  392 + <pre>
  393 +</pre>
  394 +</div><div id="index-body">
  395 + <h2 id="Other"><span id="section-head">Other</span></h2>
  396 + <pre>
  397 +<span id="section-content"> <a href="edu.arizona.fnparse.cat-api.html#edu.arizona.fnparse.cat/+">+</a><span id="line-content"> function edu.arizona.fnparse.cat Creates a summed rule. Adds the given sub-ru...
  398 +</span></span><span id="section-content"> <a href="edu.arizona.fnparse.hound-api.html#edu.arizona.fnparse.hound/+">+</a><span id="line-content"> function edu.arizona.fnparse.hound Creates a summed rule. Adds the given sub-...
  399 +</span></span></pre>
  400 +</div>
  401 +<style type="text/css">
  402 + #AllContentContainer {min-width: 96em;}
  403 +</style>
  404 +</div>
  405 + </div>
  406 + </div>
  407 + </div>
  408 + </div>
  409 + <div id="foot">
  410 + <div style="text-align: center;" id="copyright">No copyright info </div>
  411 + </div>
  412 + </div>
  413 + <div id="DesignedBy">Logo &amp; site design by <a title="Visit Tom Hickey's website." href="http://www.tomhickey.com">Tom Hickey</a>.<br />
  414 + Clojure auto-documentation system by Tom Faulhaber.</div>
  415 + </div>
  416 + <!-- /AllContentContainer -->
  417 + </body>
  418 +
  419 +</html>
3,732 edu.arizona.fnparse-api.html
3,732 additions, 0 deletions not shown
1,339 edu.arizona.fnparse.cat-api.html
... ... @@ -0,0 +1,1339 @@
  1 +<html>
  2 + <head>
  3 + <title>edu.arizona.fnparse.cat API reference (fnparse)</title>
  4 + <link href="static/favicon.png" rel="icon" />
  5 + <link href="static/favicon.png" rel="shortcut icon" />
  6 + <link media="all" type="text/css" href="static/clojure.css" rel="stylesheet" />
  7 + <link media="all" type="text/css" href="static/wiki.css" rel="stylesheet" />
  8 + <link media="all" type="text/css" href="static/internal.css" rel="stylesheet" />
  9 + <!-- TODO: are we using these (from clojure.org)? If so, add the files -->
  10 + <script src="file/view/code_highlighter.js" type="text/javascript"></script>
  11 + <script src="file/view/clojure.js" type="text/javascript"></script>
  12 + <style>.menuWrapper{height: 36px;}</style>
  13 + <!--[if lte IE 6]>
  14 + <link rel="stylesheet" href="http://www.wikispaces.com/_/2009051601/s/internal_ie.css" type="text/css" />
  15 + <![endif]-->
  16 + </head>
  17 +<!--
  18 +This document was auto-generated from the source by the clojure autodoc system.
  19 +To report errors or ask questions about the overall documentation structure, formatting,
  20 +etc., contact Tom Faulhaber (google mail name: tomfaulhaber).
  21 +For errors in the documentation of a particular namespace, contact the author of that
  22 +namespace.
  23 +-->
  24 + <body>
  25 + <div id="AllContentContainer">
  26 + <div id="Header">
  27 + <a id="Logo" href="index.html"><img alt="Clojure" height="100" width="100" src="static/clojure-icon.gif" /></a>
  28 + <h1><a title="page header title" id="page-header" href="index.html">fnparse</a></h1>
  29 + </div>
  30 + <div id="leftcolumn"><div style="text-align: center;"></div>
  31 +<div class="menu">
  32 + <div class="WikiCustomNav WikiElement wiki">
  33 + <a class="wiki_link" href="index.html">Overview</a><br />
  34 + <a class="wiki_link" href="api-index.html">API Index</a><br />
  35 + <a class="wiki_link" href="#">Namespaces:</a>
  36 + <ul id="left-sidebar-list">
  37 + <li><a href="edu.arizona.fnparse.cat-api.html" class="wiki_link">edu.arizona.fnparse.cat</a></li><li><a href="edu.arizona.fnparse.clojure-api.html" class="wiki_link">edu.arizona.fnparse.clojure</a></li><li><a href="edu.arizona.fnparse.core-api.html" class="wiki_link">edu.arizona.fnparse.core</a></li><li><a href="edu.arizona.fnparse.hound-api.html" class="wiki_link">edu.arizona.fnparse.hound</a></li><li><a href="edu.arizona.fnparse.json-api.html" class="wiki_link">edu.arizona.fnparse.json</a></li><li><a href="edu.arizona.fnparse.math-api.html" class="wiki_link">edu.arizona.fnparse.math</a></li>
  38 + </ul>
  39 + </div>
  40 +</div>
  41 +</div>
  42 + <div id="rightcolumn">
  43 + <div id="Content">
  44 + <div class="contentBox"><div class="innerContentBox">
  45 + <div id="content_view" class="wiki wikiPage">
  46 + <div id="right-sidebar"><div id="toc">
  47 + <h1 class="nopad">Table of Contents</h1>
  48 + <div style="margin-left: 1em;" class="toc-section">
  49 + <a href="#toc0">Overview</a>
  50 + <div style="margin-left: 1em;" class="toc-entry">
  51 + <a href="#edu.arizona.fnparse.cat/+">+</a>
  52 + </div><div style="margin-left: 1em;" class="toc-entry">
  53 + <a href="#edu.arizona.fnparse.cat/&lt;anything&gt;">&lt;anything&gt;</a>
  54 + </div><div style="margin-left: 1em;" class="toc-entry">
  55 + <a href="#edu.arizona.fnparse.cat/&lt;ascii-alphanumeric&gt;">&lt;ascii-alphanumeric&gt;</a>
  56 + </div><div style="margin-left: 1em;" class="toc-entry">
  57 + <a href="#edu.arizona.fnparse.cat/&lt;ascii-control&gt;">&lt;ascii-control&gt;</a>
  58 + </div><div style="margin-left: 1em;" class="toc-entry">
  59 + <a href="#edu.arizona.fnparse.cat/&lt;ascii-digit&gt;">&lt;ascii-digit&gt;</a>
  60 + </div><div style="margin-left: 1em;" class="toc-entry">
  61 + <a href="#edu.arizona.fnparse.cat/&lt;ascii-letter&gt;">&lt;ascii-letter&gt;</a>
  62 + </div><div style="margin-left: 1em;" class="toc-entry">
  63 + <a href="#edu.arizona.fnparse.cat/&lt;decimal-digit&gt;">&lt;decimal-digit&gt;</a>
  64 + </div><div style="margin-left: 1em;" class="toc-entry">
  65 + <a href="#edu.arizona.fnparse.cat/&lt;emptiness&gt;">&lt;emptiness&gt;</a>
  66 + </div><div style="margin-left: 1em;" class="toc-entry">
  67 + <a href="#edu.arizona.fnparse.cat/&lt;end-of-input&gt;">&lt;end-of-input&gt;</a>
  68 + </div><div style="margin-left: 1em;" class="toc-entry">
  69 + <a href="#edu.arizona.fnparse.cat/&lt;fetch-location&gt;">&lt;fetch-location&gt;</a>
  70 + </div><div style="margin-left: 1em;" class="toc-entry">
  71 + <a href="#edu.arizona.fnparse.cat/&lt;fetch-warnings&gt;">&lt;fetch-warnings&gt;</a>
  72 + </div><div style="margin-left: 1em;" class="toc-entry">
  73 + <a href="#edu.arizona.fnparse.cat/&lt;hexadecimal-digit&gt;">&lt;hexadecimal-digit&gt;</a>
  74 + </div><div style="margin-left: 1em;" class="toc-entry">
  75 + <a href="#edu.arizona.fnparse.cat/&lt;lowercase-ascii-letter&gt;">&lt;lowercase-ascii-letter&gt;</a>
  76 + </div><div style="margin-left: 1em;" class="toc-entry">
  77 + <a href="#edu.arizona.fnparse.cat/&lt;nothing&gt;">&lt;nothing&gt;</a>
  78 + </div><div style="margin-left: 1em;" class="toc-entry">
  79 + <a href="#edu.arizona.fnparse.cat/&lt;uppercase-ascii-letter&gt;">&lt;uppercase-ascii-letter&gt;</a>
  80 + </div><div style="margin-left: 1em;" class="toc-entry">
  81 + <a href="#edu.arizona.fnparse.cat/add-warning">add-warning</a>
  82 + </div><div style="margin-left: 1em;" class="toc-entry">
  83 + <a href="#edu.arizona.fnparse.cat/alter-location">alter-location</a>
  84 + </div><div style="margin-left: 1em;" class="toc-entry">
  85 + <a href="#edu.arizona.fnparse.cat/annotate-error">annotate-error</a>
  86 + </div><div style="margin-left: 1em;" class="toc-entry">
  87 + <a href="#edu.arizona.fnparse.cat/antilit">antilit</a>
  88 + </div><div style="margin-left: 1em;" class="toc-entry">
  89 + <a href="#edu.arizona.fnparse.cat/antiset-term">antiset-term</a>
  90 + </div><div style="margin-left: 1em;" class="toc-entry">
  91 + <a href="#edu.arizona.fnparse.cat/antiterm">antiterm</a>
  92 + </div><div style="margin-left: 1em;" class="toc-entry">
  93 + <a href="#edu.arizona.fnparse.cat/antivalidate">antivalidate</a>
  94 + </div><div style="margin-left: 1em;" class="toc-entry">
  95 + <a href="#edu.arizona.fnparse.cat/case-insensitive-lit">case-insensitive-lit</a>
  96 + </div><div style="margin-left: 1em;" class="toc-entry">
  97 + <a href="#edu.arizona.fnparse.cat/cat">cat</a>
  98 + </div><div style="margin-left: 1em;" class="toc-entry">
  99 + <a href="#edu.arizona.fnparse.cat/chook">chook</a>
  100 + </div><div style="margin-left: 1em;" class="toc-entry">
  101 + <a href="#edu.arizona.fnparse.cat/circumfix">circumfix</a>
  102 + </div><div style="margin-left: 1em;" class="toc-entry">
  103 + <a href="#edu.arizona.fnparse.cat/combine">combine</a>
  104 + </div><div style="margin-left: 1em;" class="toc-entry">
  105 + <a href="#edu.arizona.fnparse.cat/defmaker">defmaker</a>
  106 + </div><div style="margin-left: 1em;" class="toc-entry">
  107 + <a href="#edu.arizona.fnparse.cat/defmaker-">defmaker-</a>
  108 + </div><div style="margin-left: 1em;" class="toc-entry">
  109 + <a href="#edu.arizona.fnparse.cat/defmaker-macro">defmaker-macro</a>
  110 + </div><div style="margin-left: 1em;" class="toc-entry">
  111 + <a href="#edu.arizona.fnparse.cat/defrule">defrule</a>
  112 + </div><div style="margin-left: 1em;" class="toc-entry">
  113 + <a href="#edu.arizona.fnparse.cat/defrule-">defrule-</a>
  114 + </div><div style="margin-left: 1em;" class="toc-entry">
  115 + <a href="#edu.arizona.fnparse.cat/effects">effects</a>
  116 + </div><div style="margin-left: 1em;" class="toc-entry">
  117 + <a href="#edu.arizona.fnparse.cat/except">except</a>
  118 + </div><div style="margin-left: 1em;" class="toc-entry">
  119 + <a href="#edu.arizona.fnparse.cat/find">find</a>
  120 + </div><div style="margin-left: 1em;" class="toc-entry">
  121 + <a href="#edu.arizona.fnparse.cat/for">for</a>
  122 + </div><div style="margin-left: 1em;" class="toc-entry">
  123 + <a href="#edu.arizona.fnparse.cat/hook">hook</a>
  124 + </div><div style="margin-left: 1em;" class="toc-entry">
  125 + <a href="#edu.arizona.fnparse.cat/label">label</a>
  126 + </div><div style="margin-left: 1em;" class="toc-entry">
  127 + <a href="#edu.arizona.fnparse.cat/lit">lit</a>
  128 + </div><div style="margin-left: 1em;" class="toc-entry">
  129 + <a href="#edu.arizona.fnparse.cat/mapcat">mapcat</a>
  130 + </div><div style="margin-left: 1em;" class="toc-entry">
  131 + <a href="#edu.arizona.fnparse.cat/mapsum">mapsum</a>
  132 + </div><div style="margin-left: 1em;" class="toc-entry">
  133 + <a href="#edu.arizona.fnparse.cat/match">match</a>
  134 + </div><div style="margin-left: 1em;" class="toc-entry">
  135 + <a href="#edu.arizona.fnparse.cat/matches-seq">matches-seq</a>
  136 + </div><div style="margin-left: 1em;" class="toc-entry">
  137 + <a href="#edu.arizona.fnparse.cat/not-followed">not-followed</a>
  138 + </div><div style="margin-left: 1em;" class="toc-entry">
  139 + <a href="#edu.arizona.fnparse.cat/opt">opt</a>
  140 + </div><div style="margin-left: 1em;" class="toc-entry">
  141 + <a href="#edu.arizona.fnparse.cat/parser-m">parser-m</a>
  142 + </div><div style="margin-left: 1em;" class="toc-entry">
  143 + <a href="#edu.arizona.fnparse.cat/peek">peek</a>
  144 + </div><div style="margin-left: 1em;" class="toc-entry">
  145 + <a href="#edu.arizona.fnparse.cat/phrase">phrase</a>
  146 + </div><div style="margin-left: 1em;" class="toc-entry">
  147 + <a href="#edu.arizona.fnparse.cat/prefix">prefix</a>
  148 + </div><div style="margin-left: 1em;" class="toc-entry">
  149 + <a href="#edu.arizona.fnparse.cat/prod">prod</a>
  150 + </div><div style="margin-left: 1em;" class="toc-entry">
  151 + <a href="#edu.arizona.fnparse.cat/radix-digit">radix-digit</a>
  152 + </div><div style="margin-left: 1em;" class="toc-entry">
  153 + <a href="#edu.arizona.fnparse.cat/radix-label">radix-label</a>
  154 + </div><div style="margin-left: 1em;" class="toc-entry">
  155 + <a href="#edu.arizona.fnparse.cat/rule?">rule?</a>
  156 + </div><div style="margin-left: 1em;" class="toc-entry">
  157 + <a href="#edu.arizona.fnparse.cat/set-term">set-term</a>
  158 + </div><div style="margin-left: 1em;" class="toc-entry">
  159 + <a href="#edu.arizona.fnparse.cat/state?">state?</a>
  160 + </div><div style="margin-left: 1em;" class="toc-entry">
  161 + <a href="#edu.arizona.fnparse.cat/substitute">substitute</a>
  162 + </div><div style="margin-left: 1em;" class="toc-entry">
  163 + <a href="#edu.arizona.fnparse.cat/substitute-1">substitute-1</a>
  164 + </div><div style="margin-left: 1em;" class="toc-entry">
  165 + <a href="#edu.arizona.fnparse.cat/suffix">suffix</a>
  166 + </div><div style="margin-left: 1em;" class="toc-entry">
  167 + <a href="#edu.arizona.fnparse.cat/suffix-peek">suffix-peek</a>
  168 + </div><div style="margin-left: 1em;" class="toc-entry">
  169 + <a href="#edu.arizona.fnparse.cat/template-sum">template-sum</a>
  170 + </div><div style="margin-left: 1em;" class="toc-entry">
  171 + <a href="#edu.arizona.fnparse.cat/term">term</a>
  172 + </div><div style="margin-left: 1em;" class="toc-entry">
  173 + <a href="#edu.arizona.fnparse.cat/term*">term*</a>
  174 + </div><div style="margin-left: 1em;" class="toc-entry">
  175 + <a href="#edu.arizona.fnparse.cat/term-">term-</a>
  176 + </div><div style="margin-left: 1em;" class="toc-entry">
  177 + <a href="#edu.arizona.fnparse.cat/validate">validate</a>
  178 + </div><div style="margin-left: 1em;" class="toc-entry">
  179 + <a href="#edu.arizona.fnparse.cat/vcat">vcat</a>
  180 + </div><div style="margin-left: 1em;" class="toc-entry">
  181 + <a href="#edu.arizona.fnparse.cat/when">when</a>
  182 + </div><div style="margin-left: 1em;" class="toc-entry">
  183 + <a href="#edu.arizona.fnparse.cat/with-error">with-error</a>
  184 + </div>
  185 + <br />
  186 + </div>
  187 +</div>
  188 +</div>
  189 + <div id="content-tag"><h1 id="overview">API for <span id="namespace-name">edu.arizona.fnparse.cat</span></h1>
  190 +by <span id="author">Unknown</span><br />
  191 +<br />Usage:
  192 +<pre>
  193 +(ns your-namespace
  194 + (:require <span id="long-name">edu.arizona.fnparse.cat</span>))
  195 +</pre><pre>
  196 +</pre><h2>Overview</h2>
  197 +<pre id="namespace-docstr"></pre>
  198 +<br />
  199 +<h2>Public Variables and Functions</h2>
  200 +<div id="var-entry">
  201 + <br />
  202 + <hr />
  203 + <h2 id="edu.arizona.fnparse.cat/+">+</h2>
  204 + <span id="var-type">function</span><br />
  205 + <pre id="var-usage">Usage: (+)
  206 + (+ &lt;first&gt;)
  207 + (+ &lt;first&gt; &lt;second&gt; &amp; rest-rules)
  208 +</pre>
  209 + <pre id="var-docstr">Creates a summed rule.
  210 +
  211 +Adds the given sub-rules together, forming a new rule.
  212 +The order of the sub-rules matters.
  213 +
  214 +This is the FnParse *Cat* version of +. Unlike
  215 +FnParse Hound's `+` rule-maker, Cat's *does* backtrack.
  216 +
  217 +This means that it searches for the *first successful*
  218 +match from its sub-rules, regardless of whether they
  219 +consume tokens or not.
  220 +
  221 +Otherwise, if every sub-rule failed, then a failure
  222 +is returned with the proper error descriptors.
  223 +
  224 +This is the plus monadic operator of the `parser-m` monad.
  225 +
  226 +Rule Summary
  227 +============
  228 +* Consumes: Whatever the succeeding sub-rule consumes.
  229 +* Description: FnParse Hound rule-maker
  230 +* Error: An intelligent combination of the errors
  231 + from all the failed sub-rules.
  232 +* Product: The product of the succeeding sub-rule.</pre>
  233 +
  234 +</div><div id="var-entry">
  235 + <br />
  236 + <hr />
  237 + <h2 id="edu.arizona.fnparse.cat/&lt;anything&gt;">&lt;anything&gt;</h2>
  238 + <span id="var-type">var</span><br />
  239 + <pre id="var-usage"></pre>
  240 + <pre id="var-docstr">The generic terminal rule that matches any one token.
  241 +
  242 +Rule Summary
  243 +============
  244 +* Consumes: One token, any type.
  245 +* Description: FnParse Hound rule
  246 +* Error: "Expected anything."
  247 +* Product: The token it consumes.
  248 +* Success: If there are any tokens left, i.e.
  249 + not at the end of input.</pre>
  250 +
  251 +</div><div id="var-entry">
  252 + <br />
  253 + <hr />
  254 + <h2 id="edu.arizona.fnparse.cat/&lt;ascii-alphanumeric&gt;">&lt;ascii-alphanumeric&gt;</h2>
  255 + <span id="var-type">var</span><br />
  256 + <pre id="var-usage"></pre>
  257 + <pre id="var-docstr">A rule matching a single alphanumeric ASCII letter.
  258 +
  259 +Rule Summary
  260 +============
  261 +* Consumes: One character.
  262 +* Description: FnParse Hound rule
  263 +* Product: The matching character itself.</pre>
  264 +
  265 +</div><div id="var-entry">
  266 + <br />
  267 + <hr />
  268 + <h2 id="edu.arizona.fnparse.cat/&lt;ascii-control&gt;">&lt;ascii-control&gt;</h2>
  269 + <span id="var-type">var</span><br />
  270 + <pre id="var-usage"></pre>
  271 + <pre id="var-docstr">A rule matching a single ASCII control character,
  272 +i.e. a character within Unicode points 0000 and 001F.
  273 +
  274 +Rule Summary
  275 +============
  276 +* Consumes: One character.
  277 +* Description: FnParse Hound rule
  278 +* Product: The matching character itself.</pre>
  279 +
  280 +</div><div id="var-entry">
  281 + <br />
  282 + <hr />
  283 + <h2 id="edu.arizona.fnparse.cat/&lt;ascii-digit&gt;">&lt;ascii-digit&gt;</h2>
  284 + <span id="var-type">var</span><br />
  285 + <pre id="var-usage"></pre>
  286 + <pre id="var-docstr">A rule matching a single ASCII numeric digit. You may
  287 +want to use instead `decimal-digit`, which automatically
  288 +converts digits to Integer objects.
  289 +
  290 +Rule Summary
  291 +============
  292 +* Consumes: One character.
  293 +* Description: FnParse Hound rule
  294 +* Product: The matching character itself.</pre>
  295 +
  296 +</div><div id="var-entry">
  297 + <br />
  298 + <hr />
  299 + <h2 id="edu.arizona.fnparse.cat/&lt;ascii-letter&gt;">&lt;ascii-letter&gt;</h2>
  300 + <span id="var-type">var</span><br />
  301 + <pre id="var-usage"></pre>
  302 + <pre id="var-docstr">A rule matching a single uppercase or lowercase ASCII letter.
  303 +
  304 +Rule Summary
  305 +============
  306 +* Consumes: One character.
  307 +* Description: FnParse Hound rule
  308 +* Product: The matching character itself.</pre>
  309 +
  310 +</div><div id="var-entry">
  311 + <br />
  312 + <hr />
  313 + <h2 id="edu.arizona.fnparse.cat/&lt;decimal-digit&gt;">&lt;decimal-digit&gt;</h2>
  314 + <span id="var-type">var</span><br />
  315 + <pre id="var-usage"></pre>
  316 + <pre id="var-docstr">A rule matching a single core-10 digit
  317 +character token (i.e. \0 through \9).
  318 +
  319 +Rule Summary
  320 +============
  321 +* Consumes: One character.
  322 +* Description: FnParse Hound rule
  323 +* Product: The matching digit's corresponding Integer object, 0 through 9.</pre>
  324 +
  325 +</div><div id="var-entry">
  326 + <br />
  327 + <hr />
  328 + <h2 id="edu.arizona.fnparse.cat/&lt;emptiness&gt;">&lt;emptiness&gt;</h2>
  329 + <span id="var-type">var</span><br />
  330 + <pre id="var-usage"></pre>
  331 + <pre id="var-docstr">The general emptiness rule. (Actually just `(prod nil)`).
  332 +
  333 +Rule Summary
  334 +============
  335 +* Consumes: No tokens.
  336 +* Description: FnParse Hound rule
  337 +* Product: `nil`.
  338 +* Success: Always.</pre>
  339 +
  340 +</div><div id="var-entry">
  341 + <br />
  342 + <hr />
  343 + <h2 id="edu.arizona.fnparse.cat/&lt;end-of-input&gt;">&lt;end-of-input&gt;</h2>
  344 + <span id="var-type">var</span><br />
  345 + <pre id="var-usage"></pre>
  346 + <pre id="var-docstr">The standard end-of-input rule.
  347 +
  348 +Rule Summary
  349 +============
  350 +* Consumes: No tokens.
  351 +* Description: FnParse Hound rule
  352 +* Product: `true`.
  353 +* Success: If there are no tokens left.</pre>
  354 +
  355 +</div><div id="var-entry">
  356 + <br />
  357 + <hr />
  358 + <h2 id="edu.arizona.fnparse.cat/&lt;fetch-location&gt;">&lt;fetch-location&gt;</h2>
  359 + <span id="var-type">var</span><br />
  360 + <pre id="var-usage"></pre>
  361 + <pre id="var-docstr">A rule that fetches the current state's location.
  362 +
  363 +Rule Summary
  364 +============
  365 +* Consumes: Zero tokens.
  366 +* Description: FnParse Hound rule
  367 +* Product: The current location.</pre>
  368 +
  369 +</div><div id="var-entry">
  370 + <br />
  371 + <hr />
  372 + <h2 id="edu.arizona.fnparse.cat/&lt;fetch-warnings&gt;">&lt;fetch-warnings&gt;</h2>
  373 + <span id="var-type">var</span><br />
  374 + <pre id="var-usage"></pre>
  375 + <pre id="var-docstr">A rule that fetches the current state's warnings.
  376 +
  377 +Rule Summary
  378 +============
  379 +* Consumes: Zero tokens.
  380 +* Description: FnParse Hound rule
  381 +* Product: The current warnings.</pre>
  382 +
  383 +</div><div id="var-entry">
  384 + <br />
  385 + <hr />
  386 + <h2 id="edu.arizona.fnparse.cat/&lt;hexadecimal-digit&gt;">&lt;hexadecimal-digit&gt;</h2>
  387 + <span id="var-type">var</span><br />
  388 + <pre id="var-usage"></pre>
  389 + <pre id="var-docstr">A rule matching a single core-16 digit
  390 +character token (i.e. \0 through \F).
  391 +
  392 +Rule Summary
  393 +============
  394 +* Consumes: One character.
  395 +* Description: FnParse Hound rule
  396 +* Product: The matching digit's corresponding Integer object, 0 through 15.</pre>
  397 +
  398 +</div><div id="var-entry">
  399 + <br />
  400 + <hr />
  401 + <h2 id="edu.arizona.fnparse.cat/&lt;lowercase-ascii-letter&gt;">&lt;lowercase-ascii-letter&gt;</h2>
  402 + <span id="var-type">var</span><br />
  403 + <pre id="var-usage"></pre>
  404 + <pre id="var-docstr">A rule matching a single lowercase ASCII letter.
  405 +
  406 +Rule Summary
  407 +============
  408 +* Consumes: One character.
  409 +* Description: FnParse Hound rule
  410 +* Product: The matching character itself.</pre>
  411 +
  412 +</div><div id="var-entry">
  413 + <br />
  414 + <hr />
  415 + <h2 id="edu.arizona.fnparse.cat/&lt;nothing&gt;">&lt;nothing&gt;</h2>
  416 + <span id="var-type">var</span><br />
  417 + <pre id="var-usage"></pre>
  418 + <pre id="var-docstr">The general failing rule.
  419 +
  420 +Use `with-error` or `when` in preference to `&lt;nothing&gt;`,
  421 +because the first two rule-makers can attach meaningful
  422 +error messages.
  423 +
  424 +Is the zero monadic value of the `parser-m` monad.
  425 +
  426 +Rule Summary
  427 +============
  428 +* Description: FnParse Hound rule
  429 +* Error: `"Expected: absolutely nothing"`.
  430 +* Success: Never.</pre>
  431 +
  432 +</div><div id="var-entry">
  433 + <br />
  434 + <hr />
  435 + <h2 id="edu.arizona.fnparse.cat/&lt;uppercase-ascii-letter&gt;">&lt;uppercase-ascii-letter&gt;</h2>
  436 + <span id="var-type">var</span><br />
  437 + <pre id="var-usage"></pre>
  438 + <pre id="var-docstr">A rule matching a single uppercase ASCII letter.
  439 +
  440 +Rule Summary
  441 +============
  442 +* Consumes: One character.
  443 +* Description: FnParse Hound rule
  444 +* Product: The matching character itself.</pre>
  445 +
  446 +</div><div id="var-entry">
  447 + <br />
  448 + <hr />
  449 + <h2 id="edu.arizona.fnparse.cat/add-warning">add-warning</h2>
  450 + <span id="var-type">function</span><br />
  451 + <pre id="var-usage">Usage: (add-warning message)
  452 +</pre>
  453 + <pre id="var-docstr">A rule that adds a new warning with the given message.
  454 +
  455 +Rule Summary
  456 +============
  457 +* Consumes: Zero tokens.
  458 +* Description: FnParse Hound rule-maker
  459 +* Product: `nil`.</pre>
  460 +
  461 +</div><div id="var-entry">
  462 + <br />
  463 + <hr />
  464 + <h2 id="edu.arizona.fnparse.cat/alter-location">alter-location</h2>
  465 + <span id="var-type">function</span><br />
  466 + <pre id="var-usage">Usage: (alter-location f &amp; args)
  467 +</pre>
  468 + <pre id="var-docstr">A rule that alters the current location.
  469 +
  470 +Rule Summary
  471 +============
  472 +* Consumes: Zero tokens.
  473 +* Description: FnParse Hound rule-maker
  474 +* Product: The new location.</pre>
  475 +
  476 +</div><div id="var-entry">
  477 + <br />
  478 + <hr />
  479 + <h2 id="edu.arizona.fnparse.cat/annotate-error">annotate-error</h2>
  480 + <span id="var-type">function</span><br />
  481 + <pre id="var-usage">Usage: (annotate-error message-fn rule)
  482 +</pre>
  483 + <pre id="var-docstr">Creates an error-annotating rule. Whenever
  484 +the given `rule` fails, the error is passed
  485 +into the `message-fn` function. This can be
  486 +useful to add a message with more info to an
  487 +error when certain conditions are met.
  488 +
  489 +`message-fn` must return a string when given
  490 +the original `ParseError`, which will be added
  491 +to the `ParseError`, or `nil` for no message.
  492 +(`ParseError`s are maps of type
  493 +`:edu.arizona.fnparse.c/ParseError`.
  494 +See its documentation for more information.)</pre>
  495 +
  496 +</div><div id="var-entry">
  497 + <br />
  498 + <hr />
  499 + <h2 id="edu.arizona.fnparse.cat/antilit">antilit</h2>
  500 + <span id="var-type">function</span><br />
  501 + <pre id="var-usage">Usage: (antilit token)
  502 +</pre>
  503 + <pre id="var-docstr">Creates a rule of an antiliteral.
  504 +A shortcut for `term`.
  505 +It automatically adds an appropriate label.
  506 +
  507 +Rule Summary
  508 +============
  509 +* Consumes: One token, any type (so long as it doesn't equal `token`).
  510 +* Description: FnParse Hound rule-maker
  511 +* Error: When `(antilit \a) fails, its error
  512 + says, "Expected anything except 'a'."
  513 +* Product: The consumed token.</pre>
  514 +
  515 +</div><div id="var-entry">
  516 + <br />
  517 + <hr />
  518 + <h2 id="edu.arizona.fnparse.cat/antiset-term">antiset-term</h2>
  519 + <span id="var-type">function</span><br />
  520 + <pre id="var-usage">Usage: (antiset-term l tokens)
  521 +</pre>
  522 + <pre id="var-docstr">Creates a terminal rule with an antiset.
  523 +A shortcut for `(antiterm l (set tokens))`.</pre>
  524 +
  525 +</div><div id="var-entry">
  526 + <br />
  527 + <hr />
  528 + <h2 id="edu.arizona.fnparse.cat/antiterm">antiterm</h2>
  529 + <span id="var-type">function</span><br />
  530 + <pre id="var-usage">Usage: (antiterm l pred)
  531 +</pre>
  532 + <pre id="var-docstr">Exactly like term, only uses the complement of the
  533 +given predicate instead.</pre>
  534 +
  535 +</div><div id="var-entry">
  536 + <br />
  537 + <hr />
  538 + <h2 id="edu.arizona.fnparse.cat/antivalidate">antivalidate</h2>
  539 + <span id="var-type">function</span><br />
  540 + <pre id="var-usage">Usage: (antivalidate pred message rule)
  541 +</pre>
  542 + <pre id="var-docstr">Exactly like the `validate` function, except that
  543 +it uses the complement of `pred` instead.</pre>
  544 +
  545 +</div><div id="var-entry">
  546 + <br />
  547 + <hr />
  548 + <h2 id="edu.arizona.fnparse.cat/case-insensitive-lit">case-insensitive-lit</h2>
  549 + <span id="var-type">function</span><br />
  550 + <pre id="var-usage">Usage: (case-insensitive-lit token)
  551 +</pre>
  552 + <pre id="var-docstr">Creates a case-insensitive rule using Java's
  553 +`Character/toLowerCase` and `Character/toUpperCase`
  554 +methods. Only works with `Character`-type tokens.
  555 +
  556 +Rule Summary
  557 +============
  558 +* Consumes: One character.
  559 +* Description: FnParse Hound rule-maker
  560 +* Success: If there is a next token and it's equal to either
  561 + the upper or lowercase of the given `token`.</pre>
  562 +
  563 +</div><div id="var-entry">
  564 + <br />
  565 + <hr />
  566 + <h2 id="edu.arizona.fnparse.cat/cat">cat</h2>
  567 + <span id="var-type">function</span><br />
  568 + <pre id="var-usage">Usage: (cat &amp; rules)
  569 +</pre>
  570 + <pre id="var-docstr">Creates a concatenated rule out of many given `rules`.
  571 +
  572 +Rule Summary
  573 +============
  574 +* Consumes: All tokens that the `rules` sequentially consume.
  575 +* Description: FnParse Hound rule-maker
  576 +* Error: The error of whatever sub-rule failed.
  577 +* Product: The sequence (not lazy) of all the `rules`'s respective products.</pre>
  578 +
  579 +</div><div id="var-entry">
  580 + <br />
  581 + <hr />
  582 + <h2 id="edu.arizona.fnparse.cat/chook">chook</h2>
  583 + <span id="var-type">function</span><br />
  584 + <pre id="var-usage">Usage: (chook product rule)
  585 +</pre>
  586 + <pre id="var-docstr">Creates a rule with a constant semantic hook.
  587 +A shortcut for the `for` macro. The name
  588 +stands for 'constant-hook'. It's exactly like
  589 +`hook`, only the product is a constant; its
  590 +product is always the given `product` object.</pre>
  591 +
  592 +</div><div id="var-entry">
  593 + <br />
  594 + <hr />
  595 + <h2 id="edu.arizona.fnparse.cat/circumfix">circumfix</h2>
  596 + <span id="var-type">function</span><br />
  597 + <pre id="var-usage">Usage: (circumfix prefix-rule body-rule suffix-rule)
  598 +</pre>
  599 + <pre id="var-docstr">Creates a circumfixed rule. Use when you want to
  600 +concatenate three rules, but you don't care about
  601 +the first and third rules' products.
  602 +Its product is always the body-rule's product.
  603 +A shortcut for `(prefix prefix-rule (suffix body-rule suffix-rule))`.</pre>
  604 +
  605 +</div><div id="var-entry">
  606 + <br />
  607 + <hr />
  608 + <h2 id="edu.arizona.fnparse.cat/combine">combine</h2>
  609 + <span id="var-type">function</span><br />
  610 + <pre id="var-usage">Usage: (combine rule product-fn)
  611 +</pre>
  612 + <pre id="var-docstr">Creates a rule combining the given `rule` into the
  613 +`product-fn`.
  614 +
  615 +*Use `cat` or `for`* instead of this function.
  616 +You *shouldn't have to use this function*
  617 +at all, unless you're doing something special.
  618 +
  619 +The product-fn must return a rule when given the
  620 +product of the first rule. `combine` is the bind
  621 +monadic function of the parser monad.
  622 +
  623 +Below, the rule returned by `(product-fn
  624 +state-after-first-rule)` will be referred to as
  625 +`second-rule`.
  626 +
  627 +Rule Summary
  628 +============
  629 +* Consumes: All tokens that `rule` and then `(product-fn
  630 + state-after-first-rule)` consume.
  631 +* Description: FnParse Hound rule-maker
  632 +* Product: The product of `(product-fn state-after-first-rule)`.</pre>
  633 +
  634 +</div><div id="var-entry">
  635 + <br />
  636 + <hr />
  637 + <h2 id="edu.arizona.fnparse.cat/defmaker">defmaker</h2>
  638 + <span id="var-type">macro</span><br />
  639 + <pre id="var-usage">Usage: (defmaker fn-name &amp; forms)
  640 +</pre>
  641 + <pre id="var-docstr">Creates a rule-making function. Use this instead of
  642 +`clojure.core/defn` whenever you make a rule-making
  643 +function. (It does other stuff like memoization and
  644 +and stuff.) Also see `defmaker-` and `defmaker-macro`.
  645 +
  646 +Arguments
  647 +=========
  648 +`defmaker` requires exactly the same arguments as
  649 +`clojure.core/defn`. Particularly important is being
  650 +able to give metadata easily.
  651 +
  652 +Metadata options
  653 +================
  654 +`defmaker` accepts all special metadata options that
  655 +`defrule` does; see `defrule` for more information.
  656 +There is also a `:no-memoize?` option
  657 +that does something special, detailed below.
  658 +
  659 +Memoization
  660 +===========
  661 +`defmaker` rule-makers *memoize by default*. This means
  662 +that they save the arguments they receive and their
  663 +corresponding results in a cache, and search the cache
  664 +every time they are called for equal arguments. See
  665 +`clojure.k/memoize` for more information.
  666 +