The place-utils Reference Manual

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

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.

Table of Contents


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.


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

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

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp   [Contents][Index]

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
Internals

4 Packages

Packages are listed by definition order.


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

4.1 place-utils

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


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

5.1 Public Interface


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


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

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.


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

5.2.3 Setf expanders

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

place-utils.

Source

main.lisp.


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

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


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

A.1 Concepts


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

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  

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

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