Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The cl-locatives Reference Manual

This is the cl-locatives Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:11:24 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The cl-locatives Reference Manual, Up: The cl-locatives Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cl-locatives Reference Manual [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.

cl-locatives

Previous: Systems, Up: Systems [Contents][Index]

2.1 `cl-locatives`

Implementation of locatives, pointer-like objects in Lisp.

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause (See LICENSE)

Source

cl-locatives.asd.

Child Components

package.lisp (file).
cl-locatives.lisp (file).

Next: Packages, Previous: Systems, Up: The cl-locatives Reference Manual [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

cl-locatives/cl-locatives.asd
cl-locatives/package.lisp
cl-locatives/cl-locatives.lisp

Next: cl-locatives/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cl-locatives/cl-locatives.asd`

Source: cl-locatives.asd.
Parent Component: cl-locatives (system).
ASDF Systems: cl-locatives.

Next: cl-locatives/cl-locatives.lisp, Previous: cl-locatives/cl-locatives.asd, Up: Lisp [Contents][Index]

3.1.2 `cl-locatives/package.lisp`

Source: cl-locatives.asd.
Parent Component: cl-locatives (system).
Packages: cl-locatives.

Previous: cl-locatives/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `cl-locatives/cl-locatives.lisp`

Dependency

package.lisp (file).

Source

cl-locatives.asd.

Parent Component

cl-locatives (system).

Public Interface

(setf dereference) (setf expander).
dereference (function).
locative (structure).
locative-for (macro).
locative-writer (reader).
locativep (function).
print-object (method).

Internals

%make-locative (function).
locative-reader (reader).

Next: Definitions, Previous: Files, Up: The cl-locatives Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cl-locatives

Previous: Packages, Up: Packages [Contents][Index]

4.1 `cl-locatives`

A package for creating and manipulating locatives.

Source

package.lisp.

Nickname

loc

Use List

common-lisp.

Public Interface

(setf dereference) (setf expander).
dereference (function).
locative (structure).
locative-for (macro).
locative-writer (reader).
locativep (function).

Internals

%make-locative (function).
locative-reader (reader).

Next: Indexes, Previous: Packages, Up: The cl-locatives Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Macros
Setf expanders
Ordinary functions
Standalone methods
Structures

Next: Setf expanders, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: locative-for (place) ¶

Return a locative for the place PLACE.

PLACE should be a form that can be passed as the first argument to SETF.

Package: cl-locatives.
Source: cl-locatives.lisp.

Next: Ordinary functions, Previous: Macros, Up: Public Interface [Contents][Index]

5.1.2 Setf expanders

Setf Expander: (setf dereference) (locative) ¶

Package: cl-locatives.
Source: cl-locatives.lisp.
Reader: dereference (function).

Next: Standalone methods, Previous: Setf expanders, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: dereference (locative) ¶

Return a value that a locative LOCATIVE "points" to.

Package: cl-locatives.
Source: cl-locatives.lisp.
Setf expander for this function: (setf dereference).

Reader: locative-writer (instance) ¶

Package: cl-locatives.
Source: cl-locatives.lisp.
Target Slot: writer.

Function: locativep (object) ¶

Package: cl-locatives.
Source: cl-locatives.lisp.

Next: Structures, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

5.1.4 Standalone methods

Method: print-object ((object locative) stream) ¶

Source: cl-locatives.lisp.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

5.1.5 Structures

Structure: locative ¶

A pointer-like data structure to allow, among other things, "reference passing" programming style.

Package

cl-locatives.

Source

cl-locatives.lisp.

Direct superclasses

structure-object.

Direct methods

print-object.

Direct slots

Slot: reader ¶

Type: function
Initform: (error "must provide reader function.")
Readers: locative-reader.
Writers: This slot is read-only.

Slot: writer ¶

Type: function
Initform: (error "must provide writer function.")
Readers: locative-writer.
Writers: This slot is read-only.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Ordinary functions

Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Ordinary functions

Function: %make-locative (&key reader writer) ¶

Package: cl-locatives.
Source: cl-locatives.lisp.

Reader: locative-reader (instance) ¶

Package: cl-locatives.
Source: cl-locatives.lisp.
Target Slot: reader.

Previous: Definitions, Up: The cl-locatives Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% ( D F L M P S

	Index Entry		Section

%
	`%make-locative`:		Private ordinary functions

(
	`(setf dereference)`:		Public setf expanders

D
	`dereference`:		Public ordinary functions

F
	`Function, %make-locative`:		Private ordinary functions
	`Function, dereference`:		Public ordinary functions
	`Function, locative-reader`:		Private ordinary functions
	`Function, locative-writer`:		Public ordinary functions
	`Function, locativep`:		Public ordinary functions

L
	`locative-for`:		Public macros
	`locative-reader`:		Private ordinary functions
	`locative-writer`:		Public ordinary functions
	`locativep`:		Public ordinary functions

M
	`Macro, locative-for`:		Public macros
	`Method, print-object`:		Public standalone methods

P
	`print-object`:		Public standalone methods

S
	`Setf Expander, (setf dereference)`:		Public setf expanders

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F L P S

	Index Entry		Section

C
	`cl-locatives`:		The cl-locatives system
	`cl-locatives`:		The cl-locatives package
	`cl-locatives.asd`:		The cl-locatives/cl-locatives․asd file
	`cl-locatives.lisp`:		The cl-locatives/cl-locatives․lisp file

F
	`File, cl-locatives.asd`:		The cl-locatives/cl-locatives․asd file
	`File, cl-locatives.lisp`:		The cl-locatives/cl-locatives․lisp file
	`File, package.lisp`:		The cl-locatives/package․lisp file

L
	`locative`:		Public structures

P
	`Package, cl-locatives`:		The cl-locatives package
	`package.lisp`:		The cl-locatives/package․lisp file

S
	`Structure, locative`:		Public structures
	`System, cl-locatives`:		The cl-locatives system