The place-modifiers Reference Manual

This is the place-modifiers Reference Manual, version 2.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 06:17:36 2023 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 place-modifiers

Essentially gives access to hundreds of modify-macros through one single macro: MODIFY.

Author

Jean-Philippe Paradis <>

License

Public Domain

Version

2.1

Dependencies
  • map-bind (system).
  • cartesian-product-switch (system).
Source

place-modifiers.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 place-modifiers/place-modifiers.asd

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

ASDF Systems

place-modifiers.


3.1.2 place-modifiers/package.lisp

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

Packages

place-modifiers.


3.1.3 place-modifiers/info.lisp

Dependency

package.lisp (file).

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

Public Interface
Internals

3.1.4 place-modifiers/main.lisp

Dependency

info.lisp (file).

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

Public Interface
Internals

3.1.5 place-modifiers/definitions.lisp

Dependency

main.lisp (file).

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).


4 Packages

Packages are listed by definition order.


4.1 place-modifiers

Source

package.lisp.

Nickname

place-modifier

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *spot-index-format*
Package

place-modifiers.

Source

info.lisp.


5.1.2 Macros

Macro: define ((&key spot-index-format) &body definitions)
Package

place-modifiers.

Source

info.lisp.

Macro: modify (&rest place-modification-expressions)
Package

place-modifiers.

Source

main.lisp.


5.1.3 Ordinary functions

Function: convert-spot-indexes (spot-indexes source-format destination-format &key plurality-format)
Package

place-modifiers.

Source

info.lisp.

Function: ensure (names inconceivable-place-p &key spot-indexes spot-index-format)
Package

place-modifiers.

Source

info.lisp.

Function: locate (name &key errorp)
Package

place-modifiers.

Source

info.lisp.

Function: map-infos (function)
Package

place-modifiers.

Source

info.lisp.

Function: parse-operator (name/variant &key errorp)
Package

place-modifiers.

Source

main.lisp.


5.1.4 Generic functions

Generic Reader: inconceivable-place-p (object)
Package

place-modifiers.

Source

info.lisp.

Methods
Reader Method: inconceivable-place-p ((standard-info standard-info))

automatically generated reader method

Target Slot

%inconceivable-place-p.

Generic Reader: names (object)
Package

place-modifiers.

Source

info.lisp.

Methods
Reader Method: names ((standard-info standard-info))

automatically generated reader method

Target Slot

%names.

Generic Function: spot-index (info variant)
Package

place-modifiers.

Source

info.lisp.

Methods
Method: spot-index ((info standard-info) variant)
Generic Function: spot-indexes (object &key format plurality-format)
Package

place-modifiers.

Source

info.lisp.

Methods
Method: spot-indexes ((info standard-info) &key format plurality-format)

5.1.5 Standalone methods

Method: initialize-instance :around ((info standard-info) &key names inconceivable-place-p spot-indexes spot-index-format)
Source

info.lisp.

Method: print-object ((info standard-info) stream)
Source

info.lisp.


5.1.6 Classes

Class: info
Package

place-modifiers.

Source

info.lisp.

Direct subclasses

standard-info.

Class: standard-info
Package

place-modifiers.

Source

info.lisp.

Direct superclasses

info.

Direct methods
Direct slots
Slot: %names
Type

list

Initargs

:names

Readers

names.

Writers

This slot is read-only.

Slot: %inconceivable-place-p
Type

boolean

Initargs

:inconceivable-place-p

Readers

inconceivable-place-p.

Writers

This slot is read-only.

Slot: %spot-indexes
Type

list

Initargs

:spot-indexes


5.2 Internals


5.2.1 Special variables

Special Variable: *infos*
Package

place-modifiers.

Source

info.lisp.


5.2.2 Ordinary functions

Function: %actual-spot-index (args-count spot-index name)
Package

place-modifiers.

Source

main.lisp.

Function: %analyze (pme-or-place &key on-pme on-place on-ambiguous on-place-marker)
Package

place-modifiers.

Source

main.lisp.

Function: %augment-template (base-template operator before-spot after-spot)
Package

place-modifiers.

Source

main.lisp.

Function: %augmented-template-caller (function template)
Package

place-modifiers.

Source

main.lisp.

Function: %expand (place-modification-expression env)
Package

place-modifiers.

Source

main.lisp.

Function: %finish (template place env oldp)
Package

place-modifiers.

Source

main.lisp.

Function: %plurality-aware-map (function list-or-atom destination-plurality-format &key forcep)
Package

place-modifiers.

Source

info.lisp.

Function: %split (pm-info variant args place-modification-expression)
Package

place-modifiers.

Source

main.lisp.

Function: %split-at-index (sequence index)
Package

place-modifiers.

Source

main.lisp.

Function: %walk-conservatively-non-top-level (pme-or-place)
Package

place-modifiers.

Source

main.lisp.

Function: %walk-speculatively-non-top-level (pme-or-place template)
Package

place-modifiers.

Source

main.lisp.

Function: nop (&rest args)
Package

place-modifiers.

Source

main.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
C   D   E   F   G   I   L   M   N   P   S  
Index Entry  Section

%
%actual-spot-index: Private ordinary functions
%analyze: Private ordinary functions
%augment-template: Private ordinary functions
%augmented-template-caller: Private ordinary functions
%expand: Private ordinary functions
%finish: Private ordinary functions
%plurality-aware-map: Private ordinary functions
%split: Private ordinary functions
%split-at-index: Private ordinary functions
%walk-conservatively-non-top-level: Private ordinary functions
%walk-speculatively-non-top-level: Private ordinary functions

C
convert-spot-indexes: Public ordinary functions

D
define: Public macros

E
ensure: Public ordinary functions

F
Function, %actual-spot-index: Private ordinary functions
Function, %analyze: Private ordinary functions
Function, %augment-template: Private ordinary functions
Function, %augmented-template-caller: Private ordinary functions
Function, %expand: Private ordinary functions
Function, %finish: Private ordinary functions
Function, %plurality-aware-map: Private ordinary functions
Function, %split: Private ordinary functions
Function, %split-at-index: Private ordinary functions
Function, %walk-conservatively-non-top-level: Private ordinary functions
Function, %walk-speculatively-non-top-level: Private ordinary functions
Function, convert-spot-indexes: Public ordinary functions
Function, ensure: Public ordinary functions
Function, locate: Public ordinary functions
Function, map-infos: Public ordinary functions
Function, nop: Private ordinary functions
Function, parse-operator: Public ordinary functions

G
Generic Function, inconceivable-place-p: Public generic functions
Generic Function, names: Public generic functions
Generic Function, spot-index: Public generic functions
Generic Function, spot-indexes: Public generic functions

I
inconceivable-place-p: Public generic functions
inconceivable-place-p: Public generic functions
initialize-instance: Public standalone methods

L
locate: Public ordinary functions

M
Macro, define: Public macros
Macro, modify: Public macros
map-infos: Public ordinary functions
Method, inconceivable-place-p: Public generic functions
Method, initialize-instance: Public standalone methods
Method, names: Public generic functions
Method, print-object: Public standalone methods
Method, spot-index: Public generic functions
Method, spot-indexes: Public generic functions
modify: Public macros

N
names: Public generic functions
names: Public generic functions
nop: Private ordinary functions

P
parse-operator: Public ordinary functions
print-object: Public standalone methods

S
spot-index: Public generic functions
spot-index: Public generic functions
spot-indexes: Public generic functions
spot-indexes: Public generic functions