# HG changeset patch # User Steve Losh # Date 1471732335 0 # Node ID 6a8c03807d0664ef7478d0b195859feba0388e8f # Parent 15f1ecfc6d245743b19d8cb7e47854e1aaee6817 temperance: Update site. diff -r 15f1ecfc6d24 -r 6a8c03807d06 temperance/reference/index.html --- a/temperance/reference/index.html Sat Aug 20 22:31:01 2016 +0000 +++ b/temperance/reference/index.html Sat Aug 20 22:32:15 2016 +0000 @@ -12,86 +12,182 @@

Temperance

-

API Reference

The following is a list of all user-facing parts of Bones.

+

API Reference

The following is a list of all user-facing parts of Temperance.

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.

-

Package BONES.PAIP

-

Test?

-

*CHECK-OCCURS* (variable)

-

Whether to perform an occurs check.

-

CLEAR-DB (function)

-
(CLEAR-DB)
+
Package TEMPERANCE.WAM

+
FACT (macro)

+
(FACT FACT)
+

+
+
+
FACTS (macro)

+
(FACTS
+  &BODY
+  FACTS)
+

+
+
+
FINALIZE-LOGIC-FRAME (function)

+
(FINALIZE-LOGIC-FRAME)
 

 
 
-
FACT (macro)

-
(FACT &REST BODY)
+
INVOKE-FACT (function)

+
(INVOKE-FACT FACT)
+

+
+
+
INVOKE-FACTS (function)

+
(INVOKE-FACTS &REST FACTS)
+

+
+
+
INVOKE-PROVE (function)

+
(INVOKE-PROVE &REST TERMS438)
+

+
+
+
INVOKE-QUERY (function)

+
(INVOKE-QUERY &REST TERMS262)
+

+
+
+
INVOKE-QUERY-ALL (function)

+
(INVOKE-QUERY-ALL &REST TERMS296)
 

 
 
-
FAIL (variable)

-
Failure to unify

-
NO-BINDINGS (variable)

-
A succesful unification, with no bindings.

-
QUERY (macro)

-
(QUERY &REST GOALS)
+
INVOKE-QUERY-DO (function)

+
(INVOKE-QUERY-DO FUNCTION &REST TERMS366)
+

+
+
+
INVOKE-QUERY-FIND (function)

+
(INVOKE-QUERY-FIND PREDICATE &REST TERMS402)
+

+
+
+
INVOKE-QUERY-MAP (function)

+
(INVOKE-QUERY-MAP FUNCTION &REST TERMS330)
 

 
 
-
Perform the query interactively.

-
QUERY-ALL (macro)

-
(QUERY-ALL &REST GOALS)
+
INVOKE-RULE (function)

+
(INVOKE-RULE HEAD &REST BODY)
+

+
+
+
MAKE-DATABASE (function)

+
(MAKE-DATABASE)
+

+
+
+
POP-LOGIC-FRAME (function)

+
(POP-LOGIC-FRAME)
+

+
+
+
PROVE (macro)

+
(PROVE &REST TERMS)
 

 
 
-
Perform the query and automatically show all results.

-
QUERY-ONE (macro)

-
(QUERY-ONE &REST GOALS)
+
PUSH-LOGIC-FRAME (function)

+
(PUSH-LOGIC-FRAME)
+

+
+
+
PUSH-LOGIC-FRAME-WITH (macro)

+
(PUSH-LOGIC-FRAME-WITH
+  &BODY
+  BODY)
+

+
+
+
QUERY (macro)

+
(QUERY &REST TERMS)
 

 
 
-
Perform the query and just show the first result.

-
RETURN-ALL (macro)

-
(RETURN-ALL &REST GOALS)
+
QUERY-ALL (macro)

+
(QUERY-ALL &REST TERMS)
+

+
+
+
QUERY-DO (macro)

+
(QUERY-DO FUNCTION &REST TERMS)
 

 
 
-
RETURN-ONE (macro)

-
(RETURN-ONE &REST GOALS)
+
QUERY-FIND (macro)

+
(QUERY-FIND PREDICATE &REST TERMS)
+

+
+
+
QUERY-MAP (macro)

+
(QUERY-MAP FUNCTION &REST TERMS)
+

+
+
+
RESET-DATABASE (function)

+
(RESET-DATABASE)
 

 
 
 
RULE (macro)

-
(RULE &REST CLAUSE)
+
(RULE HEAD
+  &BODY
+  BODY)
 

 
 
-
UNIFY (function)

-
(UNIFY X Y &OPTIONAL (BINDINGS NO-BINDINGS))
+
WITH-DATABASE (macro)

+
(WITH-DATABASE DATABASE
+  &BODY
+  BODY)
 

 
 
-
Unify the two terms and return bindings necessary to do so (or FAIL).

+
WITH-FRESH-DATABASE (macro)

+
(WITH-FRESH-DATABASE
+  &BODY
+  BODY)
+