Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the cl-locatives Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 03:56:08 2022 GMT+0.
Next: Systems, Previous: The cl-locatives Reference Manual, Up: The cl-locatives Reference Manual [Contents][Index]
CL-LOCATIVES
============
By Robert Smith
Locatives are the Lisp equivalent of pointers, minus the
arithmetic. In Lisp terms, they make the concept of "places"
first-class.
The main API consists of the macro LOCATIVE-FOR, which takes as an
argument a place, as you would give to SETF; and the function
DEREFERENCE, which extracts the value of that place, and (SETF
DEREFERENCE), which sets the value of that place.
The following example pretty much sums up the API:
(let* ((x (make-array 5 :initial-element 0))
(l (locative-for (aref x 2))))
(setf (dereference l) 5)
(list l
x
(dereference l)))
gives
(# #(0 0 5 0 0) 5)
as a result. We also have LOCATIVEP, and you can funcall the
LOCATIVE-WRITER of a locative if you need to deal with multiple values
(a rare case).
This code can be very useful for porting over C code which uses
pointers and by-reference values a lot.
Next: Files, Previous: Introduction, Up: The cl-locatives Reference Manual [Contents][Index]
The main system appears first, followed by any subsystem dependency.
Implementation of locatives, pointer-like objects in Lisp.
Robert Smith <quad@symbo1ics.com>
BSD 3-clause (See LICENSE)
Next: Packages, Previous: Systems, Up: The cl-locatives Reference Manual [Contents][Index]
Files are sorted by type and then listed depth-first from the systems components trees.
Next: cl-locatives/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]
cl-locatives (system).
Next: cl-locatives/cl-locatives.lisp, Previous: cl-locatives/cl-locatives.asd, Up: Lisp [Contents][Index]
cl-locatives (system).
Previous: cl-locatives/package.lisp, Up: Lisp [Contents][Index]
package.lisp (file).
cl-locatives (system).
Next: Definitions, Previous: Files, Up: The cl-locatives Reference Manual [Contents][Index]
Packages are listed by definition order.
A package for creating and manipulating locatives.
loc
common-lisp.
Next: Indexes, Previous: Packages, Up: The cl-locatives Reference Manual [Contents][Index]
Definitions are sorted by export status, category, package, and then by lexicographic order.
Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]
Next: Setf expanders, Previous: Public Interface, Up: Public Interface [Contents][Index]
Return a locative for the place PLACE.
PLACE should be a form that can be passed as the first argument to SETF.
Next: Ordinary functions, Previous: Macros, Up: Public Interface [Contents][Index]
dereference (function).
Next: Standalone methods, Previous: Setf expanders, Up: Public Interface [Contents][Index]
Return a value that a locative LOCATIVE "points" to.
Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]
Previous: Standalone methods, Up: Public Interface [Contents][Index]
A pointer-like data structure to allow, among other things, "reference passing" programming style.
structure-object.
function
(error "must provide reader function.")
This slot is read-only.
function
(error "must provide writer function.")
This slot is read-only.
Previous: Public Interface, Up: Definitions [Contents][Index]
Previous: Definitions, Up: The cl-locatives Reference Manual [Contents][Index]
| Jump to: | %
(
D F L M P S |
|---|
| Jump to: | %
(
D F L M P S |
|---|
Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]
| Jump to: | R S W |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| R | |||
reader: | Public structures | ||
| | |||
| S | |||
Slot, reader: | Public structures | ||
Slot, writer: | Public structures | ||
| | |||
| W | |||
writer: | Public structures | ||
| | |||
| Jump to: | R S W |
|---|
| Jump to: | C F L P S |
|---|
| Jump to: | C F L P S |
|---|