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

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 Mon Feb 26 17:34:33 2024 GMT+0.

Next: Systems, Previous: The place-modifiers Reference Manual, Up: The place-modifiers Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The place-modifiers Reference Manual [Contents][Index]

2 Systems

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

place-modifiers

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

2.1 `place-modifiers`

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

Author

Jean-Philippe Paradis <hexstream@gmail.com>

License

Public Domain

Version

2.1

Dependencies

map-bind (system).
cartesian-product-switch (system).

Source

place-modifiers.asd.

Child Components

package.lisp (file).
info.lisp (file).
main.lisp (file).
definitions.lisp (file).

Next: Packages, Previous: Systems, Up: The place-modifiers Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: place-modifiers/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `place-modifiers/place-modifiers.asd`

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

Next: place-modifiers/info.lisp, Previous: place-modifiers/place-modifiers.asd, Up: Lisp [Contents][Index]

3.1.2 `place-modifiers/package.lisp`

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

Next: place-modifiers/main.lisp, Previous: place-modifiers/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `place-modifiers/info.lisp`

Dependency

package.lisp (file).

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

Public Interface

*spot-index-format* (special variable).
convert-spot-indexes (function).
define (macro).
ensure (function).
inconceivable-place-p (generic reader).
info (class).
initialize-instance (method).
locate (function).
map-infos (function).
names (generic reader).
print-object (method).
spot-index (generic function).
spot-indexes (generic function).
standard-info (class).

Internals

%plurality-aware-map (function).
*infos* (special variable).

Next: place-modifiers/definitions.lisp, Previous: place-modifiers/info.lisp, Up: Lisp [Contents][Index]

3.1.4 `place-modifiers/main.lisp`

Dependency

info.lisp (file).

Source

place-modifiers.asd.

Parent Component

place-modifiers (system).

Public Interface

modify (macro).
parse-operator (function).

Internals

%actual-spot-index (function).
%analyze (function).
%augment-template (function).
%augmented-template-caller (function).
%expand (function).
%finish (function).
%split (function).
%split-at-index (function).
%walk-conservatively-non-top-level (function).
%walk-speculatively-non-top-level (function).
nop (function).

Previous: place-modifiers/main.lisp, Up: Lisp [Contents][Index]

3.1.5 `place-modifiers/definitions.lisp`

Dependency: main.lisp (file).
Source: place-modifiers.asd.
Parent Component: place-modifiers (system).

Next: Definitions, Previous: Files, Up: The place-modifiers Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

place-modifiers

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

4.1 `place-modifiers`

Source

package.lisp.

Nickname

place-modifier

Use List

common-lisp.

Public Interface

*spot-index-format* (special variable).
convert-spot-indexes (function).
define (macro).
ensure (function).
inconceivable-place-p (generic reader).
info (class).
locate (function).
map-infos (function).
modify (macro).
names (generic reader).
parse-operator (function).
spot-index (generic function).
spot-indexes (generic function).
standard-info (class).

Internals

%actual-spot-index (function).
%analyze (function).
%augment-template (function).
%augmented-template-caller (function).
%expand (function).
%finish (function).
%plurality-aware-map (function).
%split (function).
%split-at-index (function).
%walk-conservatively-non-top-level (function).
%walk-speculatively-non-top-level (function).
*infos* (special variable).
nop (function).

Next: Indexes, Previous: Packages, Up: The place-modifiers Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Special variables
Macros
Ordinary functions
Generic functions
Standalone methods
Classes

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Special variables

Special Variable: *spot-index-format* ¶

Package: place-modifiers.
Source: info.lisp.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

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.

Next: Generic functions, Previous: Macros, Up: Public Interface [Contents][Index]

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.

Next: Standalone methods, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

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

Next: Classes, Previous: Generic functions, Up: Public Interface [Contents][Index]

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.

Previous: Standalone methods, Up: Public Interface [Contents][Index]

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

inconceivable-place-p.
initialize-instance.
names.
print-object.
spot-index.
spot-indexes.

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

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *infos* ¶

Package: place-modifiers.
Source: info.lisp.

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

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.

Previous: Definitions, Up: The place-modifiers Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

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

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	% * S

	Index Entry	Section

%
	`%inconceivable-place-p`:	Public classes
	`%names`:	Public classes
	`%spot-indexes`:	Public classes

*
	`infos`:	Private special variables
	`spot-index-format`:	Public special variables

S
	`Slot, %inconceivable-place-p`:	Public classes
	`Slot, %names`:	Public classes
	`Slot, %spot-indexes`:	Public classes
	`Special Variable, infos`:	Private special variables
	`Special Variable, spot-index-format`:	Public special variables

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

A.4 Data types

Jump to:	C D F I M P S

	Index Entry	Section

C
	`Class, info`:	Public classes
	`Class, standard-info`:	Public classes

D
	`definitions.lisp`:	The place-modifiers/definitions․lisp file

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

I
	`info`:	Public classes
	`info.lisp`:	The place-modifiers/info․lisp file

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

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

S
	`standard-info`:	Public classes
	`System, place-modifiers`:	The place-modifiers system

The place-modifiers Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 place-modifiers

3 Files

3.1 Lisp

3.1.1 place-modifiers/place-modifiers.asd

3.1.2 place-modifiers/package.lisp

3.1.3 place-modifiers/info.lisp

3.1.4 place-modifiers/main.lisp

3.1.5 place-modifiers/definitions.lisp

4 Packages

4.1 place-modifiers

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Ordinary functions

5.1.4 Generic functions

5.1.5 Standalone methods

5.1.6 Classes

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `place-modifiers`

3.1.1 `place-modifiers/place-modifiers.asd`

3.1.2 `place-modifiers/package.lisp`

3.1.3 `place-modifiers/info.lisp`

3.1.4 `place-modifiers/main.lisp`

3.1.5 `place-modifiers/definitions.lisp`

4.1 `place-modifiers`