The place-utils Reference Manual

Table of Contents

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

The place-utils Reference Manual

This is the place-utils Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:24:04 2018 GMT+0.


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

1 Introduction

Project's home: http://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.


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

2 Systems

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


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

2.1 place-utils

Author

Jean-Philippe Paradis <hexstream@gmail.com>

Description

Provides a few utilities relating to setfable places.

Version

0.1

Source

place-utils.asd (file)

Components

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

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 files   [Contents][Index]

3.1.1 place-utils.asd

Location

place-utils.asd

Systems

place-utils (system)

Packages

place-utils.system


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

3.1.2 place-utils/package.lisp

Parent

place-utils (system)

Location

package.lisp

Packages

place-utils


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

3.1.3 place-utils/main.lisp

Dependency

package.lisp (file)

Parent

place-utils (system)

Location

main.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 place-utils.system

Source

place-utils.asd

Use List

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

4.2 place-utils

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: applyf FUNCTION PLACE &rest OTHER-ARGS
Package

place-utils

Source

main.lisp (file)

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: funcallf FUNCTION PLACE &rest OTHER-ARGS
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: setfnew PLACE NEW &rest KEY-ARGS &key KEY TEST ON-REPLACE
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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *really-expand*
Package

place-utils

Source

main.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: %readf PLACE
Setf Expander: (setf %readf) PLACE
Package

place-utils

Source

main.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

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)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   P  
Index Entry  Section

F
File, Lisp, place-utils.asd: The place-utils<dot>asd file
File, Lisp, place-utils/main.lisp: The place-utils/main<dot>lisp file
File, Lisp, place-utils/package.lisp: The place-utils/package<dot>lisp file

L
Lisp File, place-utils.asd: The place-utils<dot>asd file
Lisp File, place-utils/main.lisp: The place-utils/main<dot>lisp file
Lisp File, place-utils/package.lisp: The place-utils/package<dot>lisp file

P
place-utils.asd: The place-utils<dot>asd file
place-utils/main.lisp: The place-utils/main<dot>lisp file
place-utils/package.lisp: The place-utils/package<dot>lisp file

Jump to:   F   L   P  

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

A.2 Functions

Jump to:   %   (  
A   B   C   F   M   O   R   S   T   U   W  
Index Entry  Section

%
%default-on-replace: Internal functions
%readf: Internal macros

(
(setf %readf): Internal macros
(setf cachef): Exported macros
(setf oldf): Exported macros
(setf readf): Exported macros
(setf tracef): Exported macros

A
applyf: Exported macros

B
bulkf: Exported macros

C
cachef: Exported macros

F
funcallf: Exported macros
Function, %default-on-replace: Internal functions
Function, reader-from-setf-expansion: Internal functions
Function, setf-expanderlet-values: Internal functions

M
Macro, %readf: Internal macros
Macro, applyf: Exported macros
Macro, bulkf: Exported macros
Macro, cachef: Exported macros
Macro, funcallf: Exported macros
Macro, oldf: Exported macros
Macro, readf: Exported macros
Macro, setf-expanderlet: Exported macros
Macro, setfnew: Exported macros
Macro, tracef: Exported macros
Macro, updatef: Exported macros
Macro, with-resolved-places: Exported macros

O
oldf: Exported macros

R
reader-from-setf-expansion: Internal functions
readf: Exported macros

S
Setf Expander, (setf %readf): Internal macros
Setf Expander, (setf cachef): Exported macros
Setf Expander, (setf oldf): Exported macros
Setf Expander, (setf readf): Exported macros
Setf Expander, (setf tracef): Exported macros
setf-expanderlet: Exported macros
setf-expanderlet-values: Internal functions
setfnew: Exported macros

T
tracef: Exported macros

U
updatef: Exported macros

W
with-resolved-places: Exported macros

Jump to:   %   (  
A   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*: Internal special variables

S
Special Variable, *really-expand*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   S  
Index Entry  Section

P
Package, place-utils: The place-utils package
Package, place-utils.system: The place-utils<dot>system package
place-utils: The place-utils system
place-utils: The place-utils package
place-utils.system: The place-utils<dot>system package

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

Jump to:   P   S