The place-utils Reference Manual

Table of Contents

The place-utils Reference Manual

This is the place-utils Reference Manual, version 0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:49:01 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.

2.1 place-utils

Author

Jean-Philippe Paradis <hexstream@gmail.com>

License

Public Domain

Description

Provides a few utilities relating to setfable places.

Version

0.2

Source

place-utils.asd (file)

Components

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

3 Files

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

3.1 Lisp

3.1.1 place-utils.asd

Location

place-utils.asd

Systems

place-utils (system)

3.1.2 place-utils/package.lisp

Parent

place-utils (system)

Location

package.lisp

Packages

place-utils

3.1.3 place-utils/main.lisp

Dependency

package.lisp (file)

Parent

place-utils (system)

Location

main.lisp

Exported Definitions

• 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)

Internal Definitions

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

4 Packages

Packages are listed by definition order.

4.1 place-utils

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• 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)

Internal Definitions

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

5 Definitions

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

5.1 Exported definitions

5.1.1 Macros

Macro: bulkf UPDATE-FUNCTION &rest MODE-MARKERS-AND-ITEMS

Package

place-utils

Source

main.lisp (file)

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 (file)

Macro: oldf PLACE

Setf Expander: (setf oldf) PLACE

Package

place-utils

Source

main.lisp (file)

Macro: readf PLACE

Setf Expander: (setf readf) PLACE

Package

place-utils

Source

main.lisp (file)

Macro: setf-expanderlet BINDINGS &body BODY

Package

place-utils

Source

main.lisp (file)

Macro: tracef PLACE

Setf Expander: (setf tracef) PLACE

Package

place-utils

Source

main.lisp (file)

Macro: updatef &rest ARGS

Package

place-utils

Source

main.lisp (file)

Macro: with-resolved-places BINDINGS &body BODY

Package

place-utils

Source

main.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *really-expand*

Package

place-utils

Source

main.lisp (file)

5.2.2 Macros

Macro: %readf PLACE

Setf Expander: (setf %readf) PLACE

Package

place-utils

Source

main.lisp (file)

Macro: with-hash-table (ACCESSOR HASH) &body BODY

Package

place-utils

Source

main.lisp (file)

5.2.3 Functions

Function: %default-on-replace OLD NEW

Package

place-utils

Source

main.lisp (file)

Function: reader-from-setf-expansion VARS VALUES STORES WRITER READER

Package

place-utils

Source

main.lisp (file)

Function: setf-expanderlet-values VARS VALUES STORES WRITER READER

Package

place-utils

Source

main.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types