hg.stevelosh.com > docs.stevelosh.com

<!DOCTYPE html>
<html>
    <head>
        <meta charset="utf-8"/>
        <title> API Reference / Bones</title>
        <link rel="stylesheet" href="../_dmedia/tango.css"/>
        <link rel="stylesheet/less" type="text/css" href="../_dmedia/style.less"/>
        <script src="../_dmedia/less.js" type="text/javascript">
        </script>
    </head>
    <body class="content">
        <div class="wrap">
            <header><h1><a href="..">Bones</a></h1></header>
                <div class="markdown">
<h1 id="api-reference"><a href="">API Reference</a></h1><p>The following is a list of all user-facing parts of Bones.</p>
<p>If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.</p>
<p>Anything not listed here is subject to change at any time with no warning, so
don't touch it.</p>
<div class="toc">
<ul>
<li><a href="#package-bonespaip">Package BONES.PAIP</a><ul>
<li><a href="#check-occurs-variable">*CHECK-OCCURS* (variable)</a></li>
<li><a href="#clear-db-function">CLEAR-DB (function)</a></li>
<li><a href="#fact-macro">FACT (macro)</a></li>
<li><a href="#fail-variable">FAIL (variable)</a></li>
<li><a href="#no-bindings-variable">NO-BINDINGS (variable)</a></li>
<li><a href="#query-macro">QUERY (macro)</a></li>
<li><a href="#query-all-macro">QUERY-ALL (macro)</a></li>
<li><a href="#query-one-macro">QUERY-ONE (macro)</a></li>
<li><a href="#return-all-macro">RETURN-ALL (macro)</a></li>
<li><a href="#return-one-macro">RETURN-ONE (macro)</a></li>
<li><a href="#rule-macro">RULE (macro)</a></li>
<li><a href="#unify-function">UNIFY (function)</a></li>
</ul>
</li>
</ul></div>
<h2 id="package-bonespaip">Package <code>BONES.PAIP</code></h2>
<p>Test?</p>
<h3 id="check-occurs-variable"><code>*CHECK-OCCURS*</code> (variable)</h3>
<p>Whether to perform an occurs check.</p>
<h3 id="clear-db-function"><code>CLEAR-DB</code> (function)</h3>
<div class="codehilite"><pre>(CLEAR-DB)
</pre></div>


<h3 id="fact-macro"><code>FACT</code> (macro)</h3>
<div class="codehilite"><pre>(FACT &amp;REST BODY)
</pre></div>


<h3 id="fail-variable"><code>FAIL</code> (variable)</h3>
<p>Failure to unify</p>
<h3 id="no-bindings-variable"><code>NO-BINDINGS</code> (variable)</h3>
<p>A succesful unification, with no bindings.</p>
<h3 id="query-macro"><code>QUERY</code> (macro)</h3>
<div class="codehilite"><pre>(QUERY &amp;REST GOALS)
</pre></div>


<p>Perform the query interactively.</p>
<h3 id="query-all-macro"><code>QUERY-ALL</code> (macro)</h3>
<div class="codehilite"><pre>(QUERY-ALL &amp;REST GOALS)
</pre></div>


<p>Perform the query and automatically show all results.</p>
<h3 id="query-one-macro"><code>QUERY-ONE</code> (macro)</h3>
<div class="codehilite"><pre>(QUERY-ONE &amp;REST GOALS)
</pre></div>


<p>Perform the query and just show the first result.</p>
<h3 id="return-all-macro"><code>RETURN-ALL</code> (macro)</h3>
<div class="codehilite"><pre>(RETURN-ALL &amp;REST GOALS)
</pre></div>


<h3 id="return-one-macro"><code>RETURN-ONE</code> (macro)</h3>
<div class="codehilite"><pre>(RETURN-ONE &amp;REST GOALS)
</pre></div>


<h3 id="rule-macro"><code>RULE</code> (macro)</h3>
<div class="codehilite"><pre>(RULE &amp;REST CLAUSE)
</pre></div>


<h3 id="unify-function"><code>UNIFY</code> (function)</h3>
<div class="codehilite"><pre>(UNIFY X Y &amp;OPTIONAL (BINDINGS NO-BINDINGS))
</pre></div>


<p>Unify the two terms and return bindings necessary to do so (or FAIL).</p>
                </div>
            <footer><p><i>Made with Lisp and love by <a href="http://stevelosh.com/">Steve Losh</a> in Reykjavík, Iceland.</i></p>
<script>
  (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
  (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
  m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
  })(window,document,'script','//www.google-analytics.com/analytics.js','ga');

  ga('create', 'UA-15328874-3', 'auto');
  ga('send', 'pageview');

</script></footer>
        </div>
    </body>
</html>
author	Steve Losh <steve@stevelosh.com>
date	Mon, 28 Mar 2016 17:59:40 +0000
parents	73c9b8445871
children	(none)