docs/03-reference.markdown @ b36cb61805d4

THE CONCATENING

This patch does something I've been dreading since I started: it concatenates
the registers, stack, and heap into one single big-ass array called the store.
This is how the original WAM was laid out (actually the original WAM has
EVERYTHING in one giant block of memory, but let's not get carried away here).

I was hoping I wouldn't have to do this, because the code reads a lot nicer when
these things are separate, but after reading ahead in the book I think I'm
pretty sure it had to be done.

The upside here is that now dereferencing things can be done without caring
where they live -- it's all just pointers into this giant array.  For example:
a register could refer to a stack cell, or a heap cell could point at a stack
cell.  The downside is that the stack is no longer adjustable (and things are
a bit less safe).
author Steve Losh <steve@stevelosh.com>
date Sun, 08 May 2016 21:25:08 +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).