The place-utils Reference Manual

This is the place-utils Reference Manual, version 0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Sep 15 05:52:19 2022 GMT+0.

1 Introduction

Project's home: https://www.hexstreamsoft.com/projects/place-utils/


Place-utils is a Common Lisp library that provides a few utilities
relating to setfable places.


Place-utils has no dependencies.

Load it with ASDF: (asdf:operate 'asdf:load-op '#:place-utils).
(Make sure ASDF can find place-utils.asd beforehand.)


This library is in the public domain.
See the UNLICENSE file for details.

2 Systems

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

place-utils

2.1 `place-utils`

Provides a few utilities relating to setfable places.

Author

Jean-Philippe Paradis <hexstream@gmail.com>

License

Public Domain

Version

0.2

Source

place-utils.asd.

Child Components

package.lisp (file).
main.lisp (file).

3 Files

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

Lisp

3.1.1 `place-utils/place-utils.asd`

Source: place-utils.asd.
Parent Component: place-utils (system).
ASDF Systems: place-utils.

3.1.2 `place-utils/package.lisp`

Source: place-utils.asd.
Parent Component: place-utils (system).
Packages: place-utils.

3.1.3 `place-utils/main.lisp`

Dependency

package.lisp (file).

Source

place-utils.asd.

Parent Component

place-utils (system).

Public Interface

bulkf (macro).
cachef (macro).
(setf cachef) (setf expander).
oldf (macro).
(setf oldf) (setf expander).
readf (macro).
(setf readf) (setf expander).
setf-expanderlet (macro).
tracef (macro).
(setf tracef) (setf expander).
updatef (macro).
with-resolved-places (macro).

Internals

%default-on-replace (function).
%readf (macro).
(setf %readf) (setf expander).
*really-expand* (special variable).
reader-from-setf-expansion (function).
(setf setf-expanderlet-helper) (setf expander).
setf-expanderlet-values (function).
with-hash-table (macro).

4 Packages

Packages are listed by definition order.

place-utils

4.1 `place-utils`

Source

package.lisp.

Use List

common-lisp.

Public Interface

bulkf (macro).
cachef (macro).
(setf cachef) (setf expander).
oldf (macro).
(setf oldf) (setf expander).
readf (macro).
(setf readf) (setf expander).
setf-expanderlet (macro).
tracef (macro).
(setf tracef) (setf expander).
updatef (macro).
with-resolved-places (macro).

Internals

%default-on-replace (function).
%readf (macro).
(setf %readf) (setf expander).
*really-expand* (special variable).
reader-from-setf-expansion (function).
(setf setf-expanderlet-helper) (setf expander).
setf-expanderlet-values (function).
with-hash-table (macro).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Macros

5.1.1 Macros

Macro: bulkf (update-function &rest mode-markers-and-items) ¶

Package: place-utils.
Source: main.lisp.

Macro: cachef (cachedp-place cache-place init-form &key test new-cachedp init-form-evaluates-to) ¶

Setf Expander: (setf cachef) (cachedp-place cache-place init-form &rest key-args &key test init-form-evaluates-to new-cachedp) ¶

Package: place-utils.
Source: main.lisp.

Macro: oldf (place) ¶

Setf Expander: (setf oldf) (place) ¶

Package: place-utils.
Source: main.lisp.

Macro: readf (place) ¶

Setf Expander: (setf readf) (place) ¶

Package: place-utils.
Source: main.lisp.

Macro: setf-expanderlet (bindings &body body) ¶

Package: place-utils.
Source: main.lisp.

Macro: tracef (place) ¶

Setf Expander: (setf tracef) (place) ¶

Package: place-utils.
Source: main.lisp.

Macro: updatef (&rest args) ¶

Package: place-utils.
Source: main.lisp.

Macro: with-resolved-places (bindings &body body) ¶

Package: place-utils.
Source: main.lisp.

5.2 Internals

Special variables
Macros
Setf expanders
Ordinary functions

5.2.1 Special variables

Special Variable: *really-expand* ¶

Package: place-utils.
Source: main.lisp.

5.2.2 Macros

Macro: %readf (place) ¶

Setf Expander: (setf %readf) (place) ¶

Package: place-utils.
Source: main.lisp.

Macro: with-hash-table ((accessor hash) &body body) ¶

Package: place-utils.
Source: main.lisp.

5.2.3 Setf expanders

Setf Expander: (setf setf-expanderlet-helper) (vars values stores writer reader) ¶

Package: place-utils.
Source: main.lisp.

5.2.4 Ordinary functions

Function: %default-on-replace (old new) ¶

Package: place-utils.
Source: main.lisp.

Function: reader-from-setf-expansion (vars values stores writer reader) ¶

Package: place-utils.
Source: main.lisp.

Function: setf-expanderlet-values (vars values stores writer reader) ¶

Package: place-utils.
Source: main.lisp.

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	% ( B C F M O R S T U W

	Index Entry	Section

%
	`%default-on-replace`:	Private ordinary functions
	`%readf`:	Private macros

(
	`(setf %readf)`:	Private macros
	`(setf cachef)`:	Public macros
	`(setf oldf)`:	Public macros
	`(setf readf)`:	Public macros
	`(setf setf-expanderlet-helper)`:	Private setf expanders
	`(setf tracef)`:	Public macros

B
	`bulkf`:	Public macros

C
	`cachef`:	Public macros

F
	`Function, %default-on-replace`:	Private ordinary functions
	`Function, reader-from-setf-expansion`:	Private ordinary functions
	`Function, setf-expanderlet-values`:	Private ordinary functions

M
	`Macro, %readf`:	Private macros
	`Macro, bulkf`:	Public macros
	`Macro, cachef`:	Public macros
	`Macro, oldf`:	Public macros
	`Macro, readf`:	Public macros
	`Macro, setf-expanderlet`:	Public macros
	`Macro, tracef`:	Public macros
	`Macro, updatef`:	Public macros
	`Macro, with-hash-table`:	Private macros
	`Macro, with-resolved-places`:	Public macros

O
	`oldf`:	Public macros

R
	`reader-from-setf-expansion`:	Private ordinary functions
	`readf`:	Public macros

S
	`Setf Expander, (setf %readf)`:	Private macros
	`Setf Expander, (setf cachef)`:	Public macros
	`Setf Expander, (setf oldf)`:	Public macros
	`Setf Expander, (setf readf)`:	Public macros
	`Setf Expander, (setf setf-expanderlet-helper)`:	Private setf expanders
	`Setf Expander, (setf tracef)`:	Public macros
	`setf-expanderlet`:	Public macros
	`setf-expanderlet-values`:	Private ordinary functions

T
	`tracef`:	Public macros

U
	`updatef`:	Public macros

W
	`with-hash-table`:	Private macros
	`with-resolved-places`:	Public macros

Jump to:	% ( B C F M O R S T U W

A.3 Variables

Jump to:	* S

	Index Entry	Section

*
	`really-expand`:	Private special variables

S
	`Special Variable, really-expand`:	Private special variables

Jump to:	* S

A.4 Data types

Jump to:	F M P S

	Index Entry	Section

F
	`File, main.lisp`:	The place-utils/main․lisp file
	`File, package.lisp`:	The place-utils/package․lisp file
	`File, place-utils.asd`:	The place-utils/place-utils․asd file

M
	`main.lisp`:	The place-utils/main․lisp file

P
	`Package, place-utils`:	The place-utils package
	`package.lisp`:	The place-utils/package․lisp file
	`place-utils`:	The place-utils system
	`place-utils`:	The place-utils package
	`place-utils.asd`:	The place-utils/place-utils․asd file

S
	`System, place-utils`:	The place-utils system

Jump to:	F M P S

The place-utils Reference Manual

The place-utils Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 place-utils

3 Files

3.1 Lisp

3.1.1 place-utils/place-utils.asd

3.1.2 place-utils/package.lisp

3.1.3 place-utils/main.lisp

4 Packages

4.1 place-utils

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.2 Internals

5.2.1 Special variables

5.2.2 Macros

5.2.3 Setf expanders

5.2.4 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `place-utils`

3.1.1 `place-utils/place-utils.asd`

3.1.2 `place-utils/package.lisp`

3.1.3 `place-utils/main.lisp`

4.1 `place-utils`