The anaphoric-variants Reference Manual

Table of Contents

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

The anaphoric-variants Reference Manual

This is the anaphoric-variants Reference Manual, version 1.0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 10:44:56 2018 GMT+0.


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

1 Introduction

Project's home: http://www.hexstreamsoft.com/projects/anaphoric-variants/


anaphoric-variants gives access to anaphoric variants of operators
through one macro: ANAPHORIC. The user explicitly provides a variable
name, preserving sanity, in contrast to the traditional use of an evil
implicit variable (\"IT\"). Some operators can bind additional handy
variables when explicitly requested.


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 anaphoric-variants

Author

Jean-Philippe Paradis <hexstream@gmail.com>

License

Public Domain

Description

Gives access to anaphoric variants of operators through one macro: ANAPHORIC. The user explicitly provides a variable name, preserving sanity, in contrast to the traditional use of an evil implicit variable ("IT"). Some operators can bind additional handy variables when explicitly requested.

Version

1.0.1

Dependency

map-bind

Source

anaphoric-variants.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 anaphoric-variants.asd

Location

anaphoric-variants.asd

Systems

anaphoric-variants (system)


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

3.1.2 anaphoric-variants/package.lisp

Parent

anaphoric-variants (system)

Location

package.lisp

Packages

anaphoric-variants


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

3.1.3 anaphoric-variants/info.lisp

Dependency

package.lisp (file)

Parent

anaphoric-variants (system)

Location

info.lisp

Exported Definitions
Internal Definitions

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

3.1.4 anaphoric-variants/definitions.lisp

Dependency

info.lisp (file)

Parent

anaphoric-variants (system)

Location

definitions.lisp

Internal Definitions

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

3.1.5 anaphoric-variants/main.lisp

Dependency

definitions.lisp (file)

Parent

anaphoric-variants (system)

Location

main.lisp

Exported Definitions

anaphoric (macro)


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

4 Packages

Packages are listed by definition order.


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

4.1 anaphoric-variants

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


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

5.1.1 Macros

Macro: anaphoric OPTIONS &body FORM
Package

anaphoric-variants

Source

main.lisp (file)

Macro: define NAME OPTIONS-LAMBDA-LIST FORM-LAMBDA-LIST &body BODY
Package

anaphoric-variants

Source

info.lisp (file)


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

5.1.2 Functions

Function: ensure NAME FORM-LAMBDA-LIST OPTIONS-LAMBDA-LIST EXPANDER &rest KEYS &key CLASS &allow-other-keys
Package

anaphoric-variants

Source

info.lisp (file)

Function: expand OPTIONS FORM &optional ENV
Package

anaphoric-variants

Source

info.lisp (file)

Function: locate NAME &key ERRORP
Package

anaphoric-variants

Source

info.lisp (file)


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

5.1.3 Generic functions

Generic Function: atom-options-transformer OBJECT
Package

anaphoric-variants

Methods
Method: atom-options-transformer (STANDARD-INFO standard-info)

automatically generated reader method

Source

info.lisp (file)

Generic Function: expander OBJECT
Package

anaphoric-variants

Source

info.lisp (file)

Methods
Method: expander (STANDARD-INFO standard-info)

automatically generated reader method

Generic Function: form-lambda-list OBJECT
Package

anaphoric-variants

Source

info.lisp (file)

Methods
Method: form-lambda-list (STANDARD-INFO standard-info)

automatically generated reader method

Generic Function: name OBJECT
Package

anaphoric-variants

Source

info.lisp (file)

Methods
Method: name (STANDARD-INFO standard-info)

automatically generated reader method

Generic Function: options-lambda-list OBJECT
Package

anaphoric-variants

Source

info.lisp (file)

Methods
Method: options-lambda-list (STANDARD-INFO standard-info)

automatically generated reader method


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

5.1.4 Classes

Class: info ()
Package

anaphoric-variants

Source

info.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-info (class)

Class: standard-info ()
Package

anaphoric-variants

Source

info.lisp (file)

Direct superclasses

info (class)

Direct methods
Direct slots
Slot: %name
Type

symbol

Initargs

:name

Readers

name (generic function)

Slot: %options-lambda-list
Type

list

Initargs

:options-lambda-list

Readers

options-lambda-list (generic function)

Slot: %form-lambda-list
Type

list

Initargs

:form-lambda-list

Readers

form-lambda-list (generic function)

Slot: %expander
Type

(or function symbol)

Initargs

:expander

Readers

expander (generic function)

Slot: %atom-options-transformer
Type

(or function symbol)

Initargs

:atom-options-transformer

Initform

(function list)

Readers

atom-options-transformer (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *infos*
Package

anaphoric-variants

Source

info.lisp (file)


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

5.2.2 Functions

Function: %caselike OPERATOR KEY-VAR TEST-VAR LISTIFY-KEYS-P INDEX-VAR KEYFORM CASES
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: %check-expected-operator ACTUAL EXPECTED
Package

anaphoric-variants

Source

info.lisp (file)

Function: %extract-&environment MACRO-LAMBDA-LIST
Package

anaphoric-variants

Source

info.lisp (file)

Function: %listify LIST-OR-ATOM
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: (setf %locate) NEW NAME &key ERRORP
Package

anaphoric-variants

Source

info.lisp (file)

Function: %make-expander NAME OPTIONS-LAMBDA-LIST FORM-LAMBDA-LIST BODY
Package

anaphoric-variants

Source

info.lisp (file)

Function: %maybe-binding MAYBE-VAR FORM TEMPLATE
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: %maybe-index-wrapper INDEX-VAR
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: %maybe-wrapper WRAPP TEMPLATE
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: %recursively OPERATOR VAR FORMS
Package

anaphoric-variants

Source

definitions.lisp (file)

Function: %remove-keys KEYS PLIST
Package

anaphoric-variants

Source

info.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L  
Index Entry  Section

A
anaphoric-variants.asd: The anaphoric-variants<dot>asd file
anaphoric-variants/definitions.lisp: The anaphoric-variants/definitions<dot>lisp file
anaphoric-variants/info.lisp: The anaphoric-variants/info<dot>lisp file
anaphoric-variants/main.lisp: The anaphoric-variants/main<dot>lisp file
anaphoric-variants/package.lisp: The anaphoric-variants/package<dot>lisp file

F
File, Lisp, anaphoric-variants.asd: The anaphoric-variants<dot>asd file
File, Lisp, anaphoric-variants/definitions.lisp: The anaphoric-variants/definitions<dot>lisp file
File, Lisp, anaphoric-variants/info.lisp: The anaphoric-variants/info<dot>lisp file
File, Lisp, anaphoric-variants/main.lisp: The anaphoric-variants/main<dot>lisp file
File, Lisp, anaphoric-variants/package.lisp: The anaphoric-variants/package<dot>lisp file

L
Lisp File, anaphoric-variants.asd: The anaphoric-variants<dot>asd file
Lisp File, anaphoric-variants/definitions.lisp: The anaphoric-variants/definitions<dot>lisp file
Lisp File, anaphoric-variants/info.lisp: The anaphoric-variants/info<dot>lisp file
Lisp File, anaphoric-variants/main.lisp: The anaphoric-variants/main<dot>lisp file
Lisp File, anaphoric-variants/package.lisp: The anaphoric-variants/package<dot>lisp file

Jump to:   A   F   L  

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

A.2 Functions

Jump to:   %   (  
A   D   E   F   G   L   M   N   O  
Index Entry  Section

%
%caselike: Internal functions
%check-expected-operator: Internal functions
%extract-&environment: Internal functions
%listify: Internal functions
%make-expander: Internal functions
%maybe-binding: Internal functions
%maybe-index-wrapper: Internal functions
%maybe-wrapper: Internal functions
%recursively: Internal functions
%remove-keys: Internal functions

(
(setf %locate): Internal functions

A
anaphoric: Exported macros
atom-options-transformer: Exported generic functions
atom-options-transformer: Exported generic functions

D
define: Exported macros

E
ensure: Exported functions
expand: Exported functions
expander: Exported generic functions
expander: Exported generic functions

F
form-lambda-list: Exported generic functions
form-lambda-list: Exported generic functions
Function, %caselike: Internal functions
Function, %check-expected-operator: Internal functions
Function, %extract-&environment: Internal functions
Function, %listify: Internal functions
Function, %make-expander: Internal functions
Function, %maybe-binding: Internal functions
Function, %maybe-index-wrapper: Internal functions
Function, %maybe-wrapper: Internal functions
Function, %recursively: Internal functions
Function, %remove-keys: Internal functions
Function, (setf %locate): Internal functions
Function, ensure: Exported functions
Function, expand: Exported functions
Function, locate: Exported functions

G
Generic Function, atom-options-transformer: Exported generic functions
Generic Function, expander: Exported generic functions
Generic Function, form-lambda-list: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, options-lambda-list: Exported generic functions

L
locate: Exported functions

M
Macro, anaphoric: Exported macros
Macro, define: Exported macros
Method, atom-options-transformer: Exported generic functions
Method, expander: Exported generic functions
Method, form-lambda-list: Exported generic functions
Method, name: Exported generic functions
Method, options-lambda-list: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions

O
options-lambda-list: Exported generic functions
options-lambda-list: Exported generic functions

Jump to:   %   (  
A   D   E   F   G   L   M   N   O  

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

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%atom-options-transformer: Exported classes
%expander: Exported classes
%form-lambda-list: Exported classes
%name: Exported classes
%options-lambda-list: Exported classes

*
*infos*: Internal special variables

S
Slot, %atom-options-transformer: Exported classes
Slot, %expander: Exported classes
Slot, %form-lambda-list: Exported classes
Slot, %name: Exported classes
Slot, %options-lambda-list: Exported classes
Special Variable, *infos*: Internal special variables

Jump to:   %   *  
S  

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

A.4 Data types

Jump to:   A   C   I   P   S  
Index Entry  Section

A
anaphoric-variants: The anaphoric-variants system
anaphoric-variants: The anaphoric-variants package

C
Class, info: Exported classes
Class, standard-info: Exported classes

I
info: Exported classes

P
Package, anaphoric-variants: The anaphoric-variants package

S
standard-info: Exported classes
System, anaphoric-variants: The anaphoric-variants system

Jump to:   A   C   I   P   S