The its Reference Manual

Table of Contents

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

The its Reference Manual

This is the its Reference Manual, version 1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Apr 08 14:19:20 2019 GMT+0.


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

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/its/


ITS provides convenient access to multiple values of an object
in a concise, explicit and efficient way.


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 its

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Public Domain

Description

Provides convenient access to multiple values of an object in a concise, explicit and efficient way.

Version

1.0

Dependency

definitions-systems

Source

its.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 its.asd

Location

its.asd

Systems

its (system)


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

3.1.2 its/package.lisp

Parent

its (system)

Location

package.lisp

Packages

its


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

3.1.3 its/defsys.lisp

Dependency

package.lisp (file)

Parent

its (system)

Location

defsys.lisp

Exported Definitions
Internal Definitions

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

3.1.4 its/definitions.lisp

Dependency

defsys.lisp (file)

Parent

its (system)

Location

definitions.lisp

Internal Definitions

%slot-value-like-expand (function)


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

4 Packages

Packages are listed by definition order.


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

4.1 its

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: its SPECIFICATION &body OBJECT
Setf Expander: (setf its) SPECIFICATION &body OBJECT
Package

its

Source

defsys.lisp (file)

Macro: their SPECIFICATION &body OBJECTS
Setf Expander: (setf their) SPECIFICATION &body OBJECTS
Package

its

Source

defsys.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: *kind-definitions*
Package

its

Source

defsys.lisp (file)


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

5.2.2 Macros

Macro: multiple-value-values &body BODY
Setf Expander: (setf multiple-value-values) &body PLACES
Package

its

Source

defsys.lisp (file)


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

5.2.3 Functions

Function: %combine-templates TEMPLATES VALUES-COUNTS
Package

its

Source

defsys.lisp (file)

Function: %ensure KIND NAME LAMBDA-LIST EXPANDER
Package

its

Source

defsys.lisp (file)

Function: %ensure-kind NAME
Package

its

Source

defsys.lisp (file)

Function: %expand-args EXPANDER ARGS
Package

its

Source

defsys.lisp (file)

Function: %extract-object-var-substitutions OBJECT-VAR VARS VALS
Package

its

Source

defsys.lisp (file)

Function: %generate-templates FUNCTION ARGS
Package

its

Source

defsys.lisp (file)

Function: %make-object-vars COUNT
Package

its

Source

defsys.lisp (file)

Function: %slot-value-like-expand OPERATOR SLOT-NAME FURTHER-SLOT-NAMES
Package

its

Source

definitions.lisp (file)


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

5.2.4 Generic functions

Generic Function: expand-specification EXPANDER SPECIFICATION
Package

its

Source

defsys.lisp (file)

Methods
Method: expand-specification (ACCESS-SPECIFIER access-specifier-definition) (SPECIFICATION cons)
Method: expand-specification (ACCESS-SPECIFIER access-specifier-definition) (SPECIFICATION symbol)
Method: expand-specification (KIND standard-kind-definition) (SPECIFICATION cons)
Method: expand-specification (KIND standard-kind-definition) (SPECIFICATION symbol)
Method: expand-specification (ROOT kind-definitions) (SPECIFICATION cons)
Method: expand-specification (ROOT kind-definitions) (SPECIFICATION symbol)
Generic Function: expander OBJECT
Package

its

Source

defsys.lisp (file)

Methods
Method: expander (ACCESS-SPECIFIER-DEFINITION access-specifier-definition)

automatically generated reader method

Generic Function: lambda-list OBJECT
Package

its

Source

defsys.lisp (file)

Methods
Method: lambda-list (ACCESS-SPECIFIER-DEFINITION access-specifier-definition)

automatically generated reader method


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

5.2.5 Classes

Class: access-specifier-definition ()
Package

its

Source

defsys.lisp (file)

Direct superclasses

name-mixin (class)

Direct methods
Direct slots
Slot: %lambda-list
Initargs

:lambda-list

Readers

lambda-list (generic function)

Slot: %expander
Initargs

:expander

Readers

expander (generic function)

Class: kind-definition ()
Package

its

Source

defsys.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-kind-definition (class)

Class: kind-definitions ()
Package

its

Source

defsys.lisp (file)

Direct superclasses

standard-system (class)

Direct methods
Class: standard-kind-definition ()
Package

its

Source

defsys.lisp (file)

Direct superclasses
Direct methods

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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L  
Index Entry  Section

F
File, Lisp, its.asd: The its<dot>asd file
File, Lisp, its/definitions.lisp: The its/definitions<dot>lisp file
File, Lisp, its/defsys.lisp: The its/defsys<dot>lisp file
File, Lisp, its/package.lisp: The its/package<dot>lisp file

I
its.asd: The its<dot>asd file
its/definitions.lisp: The its/definitions<dot>lisp file
its/defsys.lisp: The its/defsys<dot>lisp file
its/package.lisp: The its/package<dot>lisp file

L
Lisp File, its.asd: The its<dot>asd file
Lisp File, its/definitions.lisp: The its/definitions<dot>lisp file
Lisp File, its/defsys.lisp: The its/defsys<dot>lisp file
Lisp File, its/package.lisp: The its/package<dot>lisp file

Jump to:   F   I   L  

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

A.2 Functions

Jump to:   %   (  
E   F   G   I   L   M   S   T  
Index Entry  Section

%
%combine-templates: Internal functions
%ensure: Internal functions
%ensure-kind: Internal functions
%expand-args: Internal functions
%extract-object-var-substitutions: Internal functions
%generate-templates: Internal functions
%make-object-vars: Internal functions
%slot-value-like-expand: Internal functions

(
(setf its): Exported macros
(setf multiple-value-values): Internal macros
(setf their): Exported macros

E
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expand-specification: Internal generic functions
expander: Internal generic functions
expander: Internal generic functions

F
Function, %combine-templates: Internal functions
Function, %ensure: Internal functions
Function, %ensure-kind: Internal functions
Function, %expand-args: Internal functions
Function, %extract-object-var-substitutions: Internal functions
Function, %generate-templates: Internal functions
Function, %make-object-vars: Internal functions
Function, %slot-value-like-expand: Internal functions

G
Generic Function, expand-specification: Internal generic functions
Generic Function, expander: Internal generic functions
Generic Function, lambda-list: Internal generic functions

I
its: Exported macros

L
lambda-list: Internal generic functions
lambda-list: Internal generic functions

M
Macro, its: Exported macros
Macro, multiple-value-values: Internal macros
Macro, their: Exported macros
Method, expand-specification: Internal generic functions
Method, expand-specification: Internal generic functions
Method, expand-specification: Internal generic functions
Method, expand-specification: Internal generic functions
Method, expand-specification: Internal generic functions
Method, expand-specification: Internal generic functions
Method, expander: Internal generic functions
Method, lambda-list: Internal generic functions
multiple-value-values: Internal macros

S
Setf Expander, (setf its): Exported macros
Setf Expander, (setf multiple-value-values): Internal macros
Setf Expander, (setf their): Exported macros

T
their: Exported macros

Jump to:   %   (  
E   F   G   I   L   M   S   T  

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

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%expander: Internal classes
%lambda-list: Internal classes

*
*kind-definitions*: Internal special variables

S
Slot, %expander: Internal classes
Slot, %lambda-list: Internal classes
Special Variable, *kind-definitions*: Internal special variables

Jump to:   %   *  
S  

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

A.4 Data types

Jump to:   A   C   I   K   P   S  
Index Entry  Section

A
access-specifier-definition: Internal classes

C
Class, access-specifier-definition: Internal classes
Class, kind-definition: Internal classes
Class, kind-definitions: Internal classes
Class, standard-kind-definition: Internal classes

I
its: The its system
its: The its package

K
kind-definition: Internal classes
kind-definitions: Internal classes

P
Package, its: The its package

S
standard-kind-definition: Internal classes
System, its: The its system

Jump to:   A   C   I   K   P   S