docs/03-reference.markdown @ ba96e98a1d54
Add precompilation of static queries at compile time
Imagine a function like this:
(defun legal-moves ()
(query (legal ?who ?move)))
The argument to `query` there is constant, so we can compile it into WAM
bytecode once, when the Lisp function around it is compiled. Then running the
query doesn't need to touch the Bones compiler -- it can just load the bytecode
from an array and first up the VM loop.
This saves a lot of time (and consing) compared to compiling the same query over
and over at runtime.
| author |
Steve Losh <steve@stevelosh.com> |
| date |
Sun, 17 Jul 2016 16:49:06 +0000 |
| parents |
dfba7d90a8a5 |
| children |
66c01894e34c |
# API Reference
The following is a list of all user-facing parts of Bones.
If there are backwards-incompatible changes to anything listed here, they will
be noted in the changelog and the author will feel bad.
Anything not listed here is subject to change at any time with no warning, so
don't touch it.
[TOC]
## Package `BONES.PAIP`
Test?
### `*CHECK-OCCURS*` (variable)
Whether to perform an occurs check.
### `CLEAR-DB` (function)
(CLEAR-DB)
### `FACT` (macro)
(FACT &REST BODY)
### `FAIL` (variable)
Failure to unify
### `NO-BINDINGS` (variable)
A succesful unification, with no bindings.
### `QUERY` (macro)
(QUERY &REST GOALS)
Perform the query interactively.
### `QUERY-ALL` (macro)
(QUERY-ALL &REST GOALS)
Perform the query and automatically show all results.
### `QUERY-ONE` (macro)
(QUERY-ONE &REST GOALS)
Perform the query and just show the first result.
### `RETURN-ALL` (macro)
(RETURN-ALL &REST GOALS)
### `RETURN-ONE` (macro)
(RETURN-ONE &REST GOALS)
### `RULE` (macro)
(RULE &REST CLAUSE)
### `UNIFY` (function)
(UNIFY X Y &OPTIONAL (BINDINGS NO-BINDINGS))
Unify the two terms and return bindings necessary to do so (or FAIL).