The trucler Reference Manual

Source

Methods

Reader Method: compiler-macro ((compiler-macro-mixin compiler-macro-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %compiler-macro.

Generic Function: compiler-macro-function (name environment) ¶

Package: trucler.
Source: macro-functions.lisp.

Generic Reader: debug (object) ¶

Package

Methods

Reader Method: debug ((debug-mixin debug-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %debug.

Generic Reader: declarations (object) ¶

Package

Methods

Reader Method: declarations ((declarations-mixin declarations-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %declarations.

Generic Reader: deprecated (object) ¶

Package

Methods

Reader Method: deprecated ((deprecated-mixin deprecated-mixin)) ¶

automatically generated reader method

Source: query-classes.lisp.
Target Slot: %deprecated.

Generic Function: describe-block (client environment name) ¶

Return an instance of the class BLOCK-DESCRIPTION describing the role of NAME in ENVIRONMENT when NAME was found in a position to name a block, typically in a RETURN-FROM special form.
If no relevant information about NAME exists in ENVIRONMENT, then return NIL.

Package

Source

Methods

Method: describe-block ((client client) (env lexenv) (name symbol)) ¶

Source: describe-block.lisp.

Method: describe-block ((client client) (env null) (name symbol)) ¶

Source: describe-block.lisp.

Generic Function: describe-declarations (client environment) ¶

Return an instance of the class DECLARATIONS-DESCRIPTION describing the list of user-defined declaration identifiers in ENVIRONMENT.

Package

Source

Methods

Method: describe-declarations ((client client) (env lexenv)) ¶

Source: describe-declarations.lisp.

Method: describe-declarations ((client client) (env null)) ¶

Source: describe-declarations.lisp.

Generic Function: describe-function (client environment name) ¶

Return an instance of the class FUNCTION-DESCRIPTION describing the role of NAME in ENVIRONMENT
when NAME was found in a function position.
This function can also be used to obtain information about a function name that is not a symbol.
If no relevant information about NAME exists
in ENVIRONMENT, then return NIL.

Package

Source

Methods

Method: describe-function ((client client) (env lexenv) name) ¶

Source: describe-function.lisp.

Method: describe-function ((client client) (env null) name) ¶

Source: describe-function.lisp.

Generic Function: describe-optimize (client environment) ¶

Return an instance of the class OPTIMIZE-DESCRIPTION describing the values of all OPTIMIZE qualities in ENVIRONMENT.

Package

Source

Methods

Method: describe-optimize ((client client) (env lexenv)) ¶

Source: describe-optimize.lisp.

Method: describe-optimize ((client client) (env null)) ¶

Source: describe-optimize.lisp.

Generic Function: describe-tag (client environment tag) ¶

Return an instance of the class TAG-DESCRIPTION describing the role of TAG in ENVIRONMENT when TAG was found in a position to name a TAGBODY tag, i.e. as an argument to GO.
TAG must be a symbol or an integer.
If no relevant information about NAME exists in ENVIRONMENT, then return NIL.

Package

Source

Methods

Method: describe-tag ((client client) (env lexenv) tag) ¶

Source: describe-tag.lisp.

Method: describe-tag ((client client) (env null) tag) ¶

Source: describe-tag.lisp.

Generic Function: describe-variable (client environment name) ¶

Return an instance of the class VARIABLE-DESCRIPTION describing the role of NAME in ENVIRONMENT
when NAME was found in a variable position.
If no relevant information about NAME exists
in ENVIRONMENT, then return NIL.

Package

Source

Methods

Method: describe-variable ((client client) (env lexenv) (name symbol)) ¶

Source: describe-variable.lisp.

Method: describe-variable ((client client) (env null) (name symbol)) ¶

Source: describe-variable.lisp.

Generic Reader: description (condition) ¶

Package

Methods

Reader Method: description ((condition invalid-description)) ¶

Source: conditions.lisp.
Target Slot: %description.

Generic Reader: dynamic-extent (description) ¶

Return the dynamic-extent property of DESCRIPTION, typically given as the value of the :DYNAMIC-EXTENT initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class DYNAMIC-EXTENT-MIXIN.

The return value is a generalized Boolean.

Package

Source

Methods

Reader Method: dynamic-extent ((dynamic-extent-mixin dynamic-extent-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %dynamic-extent.

Generic Reader: expander (description) ¶

Return the expander property of DESCRIPTION, typically given as the value of the :EXPANDER initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class EXPANDER-MIXIN.

The return value is either a macro function, which is a function with two parameters, namely a FORM and an ENVIRONMENT, or NIL if there is no expander associated with the function description.

Package

Source

Methods

Reader Method: expander ((expander-mixin expander-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %expander.

Generic Reader: expansion (description) ¶

Return the expansion property of DESCRIPTION, typically given as the expansion of the :EXPANSION initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class EXPANSION-MIXIN.

The return value is a a form that is defined to be the expansion of a symbol macro described by DESCRIPTION.

Package

Source

Methods

Reader Method: expansion ((expansion-mixin expansion-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %expansion.

Generic Function: finalize-environment-builder (client environment-builder) ¶

Package: trucler.
Source: environment-builder.lisp.

Generic Function: global-environment (client environment) ¶

Package

Source

Methods

Method: global-environment ((client client) (env lexenv)) ¶

Source: global-environment.lisp.

Method: global-environment ((client client) (env null)) ¶

Source: methods.lisp.

Generic Function: global-environment-p (client environment) ¶

Package

Source

Methods

Method: global-environment-p ((client client) (env lexenv)) ¶

Source: global-environment-p.lisp.

Method: global-environment-p ((client client) (env null)) ¶

Source: methods.lisp.

Generic Reader: identity (description) ¶

Return the identity of DESCRIPTION, typically given as the value of the :IDENTITY initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class IDENTITY-MIXIN.

Package

Source

Methods

Reader Method: identity ((identity-mixin identity-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %identity.

Generic Reader: ignore (description) ¶

Return the ignore property of DESCRIPTION, typically given as the value of the :IGNORE initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class IGNORE-MIXIN.

There are three possible values here, namely
NIL, IGNORE and IGNORABLE. NIL means that there is
neither an IGNORE nor a IGNORABLE declaration in scope. IGNORE means that there is an IGNORE declaration in scope, and IGNORABLE means that there is a IGNORABLE declaration
in scope

Package

Source

Methods

Reader Method: ignore ((ignore-mixin ignore-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %ignore.

Generic Reader: inline (description) ¶

Return the inline property of DESCRIPTION, typically given as the value of the :INLINE initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class INLINE-MIXIN.

There are three possible values here, namely
NIL, INLINE and NOTINLINE. NIL means that there is
neither an INLINE nor a NOTINLINE declaration in scope. INLINE means that there is an INLINE declaration in scope, and NOTINLINE means that there is a NOTINLINE declaration
in scope.

Package

Source

Methods

Reader Method: inline ((inline-mixin inline-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %inline.

Generic Reader: inline-data (object) ¶

Package

Methods

Reader Method: inline-data ((inline-data-mixin inline-data-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %inline-data.

Generic Function: lexical-variable-description-class (client) ¶

Package

Source

Methods

Method: lexical-variable-description-class (client) ¶

Generic Function: local-function-description-class (client) ¶

Package

Source

Methods

Method: local-function-description-class (client) ¶

Generic Function: local-macro-description-class (client) ¶

Package

Source

Methods

Method: local-macro-description-class (client) ¶

Generic Function: local-special-variable-description-class (client) ¶

Package

Source

Methods

Method: local-special-variable-description-class (client) ¶

Generic Function: local-symbol-macro-description-class (client) ¶

Package

Source

Methods

Method: local-symbol-macro-description-class (client) ¶

Generic Function: macro-function (name environment) ¶

Package: trucler.
Source: macro-functions.lisp.

Generic Function: make-environment-builder (client environment) ¶

Package: trucler.
Source: environment-builder.lisp.

Generic Function: merge-compilation-speed (client description value) ¶

Package

Source

Methods

Method: merge-compilation-speed (client (description compilation-speed-mixin) value) ¶

Source: merge-methods.lisp.

Method: merge-compilation-speed (client description value) ¶

Source: merge-methods.lisp.

Generic Function: merge-debug (client description value) ¶

Package

Source

Methods

Method: merge-debug (client (description debug-mixin) value) ¶

Source: merge-methods.lisp.

Method: merge-debug (client description value) ¶

Source: merge-methods.lisp.

Generic Function: merge-dynamic-extent (client description) ¶

Package

Source

Methods

Method: merge-dynamic-extent (client (description dynamic-extent-mixin)) ¶

Source: merge-methods.lisp.

Method: merge-dynamic-extent (client description) ¶

Source: merge-methods.lisp.

Generic Function: merge-ignore (client description ignore) ¶

Package

Source

Methods

Method: merge-ignore (client (description ignore-mixin) ignore) ¶

Source: merge-methods.lisp.

Method: merge-ignore (client description ignore) ¶

Source: merge-methods.lisp.

Generic Function: merge-inline (client description inline) ¶

Package

Source

Methods

Method: merge-inline (client (description inline-mixin) inline) ¶

Source: merge-methods.lisp.

Method: merge-inline (client description inline) ¶

Source: merge-methods.lisp.

Generic Function: merge-inline-data (client description inline-data) ¶

Package

Source

Methods

Method: merge-inline-data (client (description inline-data-mixin) inline-data) ¶

Source: merge-methods.lisp.

Method: merge-inline-data (client description inline-data) ¶

Source: merge-methods.lisp.

Generic Function: merge-safety (client description value) ¶

Package

Source

Methods

Method: merge-safety (client (description safety-mixin) value) ¶

Source: merge-methods.lisp.

Method: merge-safety (client description value) ¶

Source: merge-methods.lisp.

Generic Function: merge-space (client description value) ¶

Package

Source

Methods

Method: merge-space (client (description space-mixin) value) ¶

Source: merge-methods.lisp.

Method: merge-space (client description value) ¶

Source: merge-methods.lisp.

Generic Function: merge-speed (client description value) ¶

Package

Source

Methods

Method: merge-speed (client (description speed-mixin) value) ¶

Source: merge-methods.lisp.

Method: merge-speed (client description value) ¶

Source: merge-methods.lisp.

Generic Function: merge-type (client description type) ¶

Package

Source

Methods

Method: merge-type (client (description type-mixin) type) ¶

Source: merge-methods.lisp.

Method: merge-type (client description type) ¶

Source: merge-methods.lisp.

Generic Reader: name (description) ¶

Return the name of DESCRIPTION, typically given as the value of the :NAME initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class NAME-MIXIN.

The name returned by this function might be different from the name given to the query function that returned DESCRIPTION, as a result of errors and restarts. Therefore, client code should always use the return value of this function for further processing.

Package

Source

Methods

Reader Method: name ((condition undefined-function-referred-to-by-inline-declaration)) ¶

Source: conditions.lisp.
Target Slot: %name.

Reader Method: name ((name-mixin name-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %name.

Generic Reader: origin (condition) ¶

Package

Methods

Reader Method: origin ((condition undefined-function-referred-to-by-inline-declaration)) ¶

Source: conditions.lisp.
Target Slot: %origin.

Generic Function: restrict-for-macrolet-expander (client environment) ¶

Package: trucler.
Source: augmentation-functions.lisp.

Generic Reader: safety (object) ¶

Package

Methods

Reader Method: safety ((safety-mixin safety-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %safety.

Generic Reader: space (object) ¶

Package

Methods

Reader Method: space ((space-mixin space-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %space.

Generic Reader: speed (object) ¶

Package

Methods

Reader Method: speed ((speed-mixin speed-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %speed.

Generic Function: symbol-macro-expansion (name environment) ¶

Package: trucler.
Source: macro-functions.lisp.

Generic Function: tag-description-class (client) ¶

Package

Source

Methods

Method: tag-description-class (client) ¶

Generic Reader: type (description) ¶

Return the type of DESCRIPTION, typically given as the value of the :TYPE initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class TYPE-MIXIN.

The return value is a type descriptor.

Package

Source

Methods

Reader Method: type ((type-mixin type-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %type.

Generic Reader: value (description) ¶

Return the value property of DESCRIPTION, typically given as the value of the :VALUE initialization argument when DESCRIPTION was created. DESCRIPTION must be a subclass of the class VALUE-MIXIN.

The return value is a the value of a constant variable described by DESCRIPTION.

Package

Source

Methods

Reader Method: value ((value-mixin value-mixin)) ¶

automatically generated reader method

Source: query-mixin-classes.lisp.
Target Slot: %value.

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

6.1.4 Standalone methods

Method: report-condition ((condition invalid-description-for-merging-compilation-speed-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-speed-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-type-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-debug-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-space-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-ignore-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-inline-data) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition undefined-function-referred-to-by-inline-declaration) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-safety-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-inline-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

Method: report-condition ((condition invalid-description-for-merging-dynamic-extent-information) stream (language english)) ¶

Package: acclimation.
Source: condition-reporters-english.lisp.

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

6.1.5 Conditions

Condition: invalid-description-for-merging-compilation-speed-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-debug-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-ignore-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-inline-data ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-inline-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-safety-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-space-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-speed-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: invalid-description-for-merging-type-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Condition: undefined-function-referred-to-by-inline-declaration ¶

Package

Source

conditions.lisp.

Direct superclasses

condition.
program-error.

Direct methods

name.
origin.
report-condition.

Direct slots

Slot: %name ¶

Initargs: :name
Readers: name.
Writers: This slot is read-only.

Slot: %origin ¶

Initargs: :origin
Readers: origin.
Writers: This slot is read-only.

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

6.1.6 Classes

Class: authentic-function-description ¶

This abstract class is a subclass of the classes FUNCTION-DESCRIPTION and TYPE-MIXIN.

Package

Source

Direct superclasses

dynamic-extent-mixin.
function-description.
ignore-mixin.
inline-data-mixin.
inline-mixin.
type-mixin.

Direct subclasses

global-function-description.
local-function-description.

Class: authentic-variable-description ¶

This abstract class is a subclass of the classes VARIABLE-DESCRIPTION, TYPE-MIXIN, and DYNAMIC-EXTENT-MIXIN.

Package

Source

Direct superclasses

dynamic-extent-mixin.
type-mixin.
variable-description.

Direct subclasses

global-variable-description.
lexical-variable-description.
special-variable-description.

Class: block-description ¶

Package

Source

Direct superclasses

description.
identity-mixin.
name-mixin.

Direct subclasses

block-description.

Class: client ¶

Package

trucler-native.

Source

client.lisp.

Direct methods

describe-block.
describe-block.
describe-declarations.
describe-declarations.
describe-function.
describe-function.
describe-optimize.
describe-optimize.
describe-tag.
describe-tag.
describe-variable.
describe-variable.
global-environment.
global-environment.
global-environment-p.
global-environment-p.

Class: compilation-speed-mixin ¶

This mixin class supplies a single initarg and a single reader.
It can be used as a superclass of query classes that correspond
to some entity that can have compilation-speed information, in particular the class optimize-description.

The initarg :COMPILATION-SPEED is supported by this class. The value of this initarg is an integer between 0 and 3.

The reader COMPILATION-SPEED can be used to access the compilation-speed information of the entity.

Package

Source

Direct subclasses

Direct methods

cloning-information.
compilation-speed.
merge-compilation-speed.

Direct slots

Slot: %compilation-speed ¶

Initform: (error "initarg ~s must be given." :compilation-speed)
Initargs: :compilation-speed
Readers: compilation-speed.
Writers: This slot is read-only.

Class: compiler-macro-mixin ¶

Package

Source

Direct subclasses

global-function-description.
global-macro-description.

Direct methods

cloning-information.
compiler-macro.

Direct slots

Slot: %compiler-macro ¶

Initargs: :compiler-macro
Readers: compiler-macro.
Writers: This slot is read-only.

Class: constant-variable-description ¶

This instantiable class represents information about constant variables. An instance of this class is returned by a call to variable-description when it turns out that the symbol passed as an argument refers to a constant variable.

This class is a subclass of the classes VARIABLE-DESCRIPTION and VALUE-MIXIN.

Package

Source

constant-variable-description.

Direct superclasses

value-mixin.
variable-description.

Direct subclasses

Class: debug-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have debug information, in particular the class optimize-description.

The initarg :DEBUG is supported by this class. The value of this initarg is an integer between 0 and 3.

The reader DEBUG can be used to access the debug information of the entity.

Package

Source

Direct subclasses

Direct methods

cloning-information.
debug.
merge-debug.

Direct slots

Slot: %debug ¶

Initform: (error "initarg ~s must be given." :debug)
Initargs: :debug
Readers: debug.
Writers: This slot is read-only.

Class: declarations-description ¶

Package

Source

declarations-description.

Direct superclasses

declarations-mixin.
description.

Direct subclasses

Class: description ¶

Package

Source

Direct subclasses

block-description.
declarations-description.
function-description.
optimize-description.
tag-description.
variable-description.

Class: dynamic-extent-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can be declared DYNAMIC-EXTENT.

The initarg :DYNAMIC-EXTENT is supported by this class. The value of this initarg is a generalized Boolean.

The reader DYNAMIC-EXTENT can be used to access the dynamic-extent information of the entity.

Package

Source

Direct subclasses

authentic-function-description.
authentic-variable-description.

Direct methods

cloning-information.
dynamic-extent.
merge-dynamic-extent.

Direct slots

Slot: %dynamic-extent ¶

Initargs: :dynamic-extent
Readers: dynamic-extent.
Writers: This slot is read-only.

Class: expander-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have an expander function, in particular macros.

The initarg :EXPANDER is supported by this class. The value of this initarg is a function of two arguments, a form and. an environment.

The reader EXPANDER can be used to access the expander information of the entity.

Package

Source

Direct subclasses

macro-description.

Direct methods

cloning-information.
expander.

Direct slots

Slot: %expander ¶

Initform: (error "initarg ~s must be given." :expander)
Initargs: :expander
Readers: expander.
Writers: This slot is read-only.

Class: expansion-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have an expansion, in particular symbol macros.

The initarg :EXPANSION is supported by this class. The value of this initarg is a form.

The reader EXPANSION can be used to access the expansion information of the entity.

Package

Source

symbol-macro-description.

Direct subclasses

Direct methods

cloning-information.
expansion.

Direct slots

Slot: %expansion ¶

Initform: (error "initarg ~s must be given." :expansion)
Initargs: :expansion
Readers: expansion.
Writers: This slot is read-only.

Class: function-description ¶

This abstract class is the superclass of every query class returned by a call to the generic function DESCRIBE-FUNCTION. It is a subclass of the class NAME-MIXIN.

Package

Source

Direct superclasses

description.
name-mixin.

Direct subclasses

authentic-function-description.
macro-description.
special-operator-description.

Class: generic-function-description ¶

This instantiable class represents information about generic functions. An instance of this class is returned by a call to function-description when it turns out that the name passed
as an argument refers to a generic function.

This class is a subclass of the class GLOBAL-FUNCTION-DESCRIPTION.

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: global-function-description.
Direct subclasses: generic-function-description.

Class: global-function-description ¶

This instantiable class represents information about global functions. An instance of this class is returned by a call to function-description when it turns out that the name passed
as an argument refers to a global function.

This class is a subclass of the classes AUTHENTIC-FUNCTION-DESCRIPTION and COMPILER-MACRO-MIXIN.

Package

Source

Direct superclasses

authentic-function-description.
compiler-macro-mixin.

Direct subclasses

generic-function-description.
global-function-description.

Class: global-macro-description ¶

This instantiable class represents information about global macros. An instance of this class is returned by a call to function-description when it turns out that the name passed as an argument refers to a global macro.

This class is a subclass of the classes MACRO-DESCRIPTION, INLINE-MIXIN, and COMPILER-MACRO-MIXIN.

Package

Source

global-macro-description.

Direct superclasses

compiler-macro-mixin.
inline-mixin.
macro-description.

Direct subclasses

Class: global-special-variable-description ¶

This instantiable class represents information about special variables. An instance of this class is returned by a call to variable-description when it turns out that the symbol passed as an argument refers to a global special variable.

This class is a subclass of the class SPECIAL-VARIABLE-DESCRIPTION.

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: special-variable-description.
Direct subclasses: global-special-variable-description.

Class: global-symbol-macro-description ¶

This instantiable class represents information about global symbol macros. An instance of this class is returned by a call to variable-description when it turns out that the symbol passed as an argument refers to a global symbol macro.

This class is a subclass of the class SYMBOL-MACRO-DESCRIPTION.

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: symbol-macro-description.
Direct subclasses: global-symbol-macro-description.

Class: identity-mixin ¶

Package

Source

Direct subclasses

block-description.
lexical-variable-description.
local-function-description.
tag-description.

Direct methods

cloning-information.
identity.

Direct slots

Slot: %identity ¶

Initform: (error "initarg ~s must be given." :identity)
Initargs: :identity
Readers: identity.
Writers: This slot is read-only.

Class: ignore-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can be declared IGNORE or IGNORABLE.

The initarg :IGNORE is supported by this class. The value of this initarg is one of the symbols IGNORE, IGNORABLE, and NIL from the COMMON-LISP package

The reader IGNORE can be used to access the ignore information of the entity.

Package

Source

Direct subclasses

authentic-function-description.
local-macro-description.
variable-description.

Direct methods

cloning-information.
ignore.
merge-ignore.

Direct slots

Slot: %ignore ¶

Initargs: :ignore
Readers: ignore.
Writers: This slot is read-only.

Class: inline-data-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can be declared INLINE or NOTINLINE, and that may contain additional data for inlining.

The initarg :INLINE-DATA is supported by this class. The value of this initarg can be any datum supplied by client code. The default value if this intarg is not supplied is NIL.

The reader INLINE-DATA can be used to access the inline information of the entity.

Package

Source

authentic-function-description.

Direct subclasses

Direct methods

cloning-information.
inline-data.
merge-inline-data.

Direct slots

Slot: %inline-data ¶

Initargs: :inline-data
Readers: inline-data.
Writers: This slot is read-only.

Class: inline-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can be declared INLINE or NOTINLINE.

The initarg :INLINE is supported by this class. The value of this initarg is one of the symbols INLINE and NOTINLINE from the COMMON-LISP package

The reader INLINE can be used to access the inline information of the entity.

Package

Source

Direct subclasses

authentic-function-description.
global-macro-description.

Direct methods

cloning-information.
inline.
merge-inline.

Direct slots

Slot: %inline ¶

Type: (member nil inline notinline)
Initargs: :inline
Readers: inline.
Writers: This slot is read-only.

Class: lexical-variable-description ¶

This instantiable class represents information about lexical variables. An instance of this class is returned by a call to variable-description when it turns out that the symbol passed
as an argument refers to a lexical variable.

This class is a subclass of the classes AUTHENTIC-VARIABLE-DESCRIPTION and IDENTITY-MIXIN.

Package

Source

lexical-variable-description.

Direct superclasses

authentic-variable-description.
identity-mixin.

Direct subclasses

Class: local-function-description ¶

This instantiable class represents information about local functions introduced by FLET or LABELS. An instance of this class is returned by a call to function-description when it turns out that the name passed as an argument refers to a local function.

This class is a subclass of the classes AUTHENTIC-FUNCTION-DESCRIPTION, IDENTITY-MIXIN, IGNORE-MIXIN, and DYNAMIC-EXTENT-MIXIN.

Package

Source

local-function-description.

Direct superclasses

authentic-function-description.
identity-mixin.

Direct subclasses

Class: local-macro-description ¶

This instantiable class represents information about local macros introduced by MACROLET. An instance of this class
is returned by a call to function-description when it turns out that the name passed as an argument refers to a local macro.

This class is a subclass of the classes MACRO-DESCRIPTION and IGNORE-MIXIN.

Package

Source

local-macro-description.

Direct superclasses

ignore-mixin.
macro-description.

Direct subclasses

Class: local-special-variable-description ¶

This class is a subclass of the class SPECIAL-VARIABLE-DESCRIPTION.

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: special-variable-description.
Direct subclasses: local-special-variable-description.

Class: local-symbol-macro-description ¶

This instantiable class represents information about local symbol macros. An instance of this class is returned by a call to variable-description when it turns out that the symbol passed as an argument refers to a local symbol macro.

This class is a subclass of the class SYMBOL-MACRO-DESCRIPTION.

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: symbol-macro-description.
Direct subclasses: local-symbol-macro-description.

Class: macro-description ¶

This abstract class is a subclass of the classes FUNCTION-DESCRIPTION and EXPANDER-MIXIN.

Package

Source

Direct superclasses

expander-mixin.
function-description.

Direct subclasses

global-macro-description.
local-macro-description.

Class: name-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some named entity, such as a function or a class.
The initarg :NAME is supported by this class. The nature of this argument depends on the entity being named. For a variable, it is a symbol. For a function, it is a symbol or a list (SETF symbol). For a tag, it is a symbol or an integer.

The reader NAME can be used to access the name of the entity.

Package

Source

Direct subclasses

block-description.
function-description.
tag-description.
variable-description.

Direct methods

cloning-information.
name.

Direct slots

Slot: %name ¶

Initform: (error "initarg ~s must be given." :name)
Initargs: :name
Readers: name.
Writers: This slot is read-only.

Class: optimize-description ¶

Package

Source

Direct superclasses

compilation-speed-mixin.
debug-mixin.
description.
safety-mixin.
space-mixin.
speed-mixin.

Direct subclasses

Class: safety-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have safety information, in particular the class optimize-description.

The initarg :SAFETY is supported by this class. The value of this initarg is an integer between 0 and 3.

The reader SAFETY can be used to access the safety information of the entity.

Package

Source

Direct subclasses

Direct methods

cloning-information.
merge-safety.
safety.

Direct slots

Slot: %safety ¶

Initform: (error "initarg ~s must be given." :safety)
Initargs: :safety
Readers: safety.
Writers: This slot is read-only.

Class: space-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have space information, in particular the class optimize-description.

The initarg :SPACE is supported by this class. The value of this initarg is an integer between 0 and 3.

The reader SPACE can be used to access the space information of the entity.

Package

Source

Direct subclasses

Direct methods

cloning-information.
merge-space.
space.

Direct slots

Slot: %space ¶

Initform: (error "initarg ~s must be given." :space)
Initargs: :space
Readers: space.
Writers: This slot is read-only.

Class: special-operator-description ¶

Package: trucler.
Source: query-classes.lisp.
Direct superclasses: function-description.
Direct subclasses: special-operator-description.

Class: special-variable-description ¶

This abstract class is a superclass of the classes LOCAL-SPECIAL-VARIABLE-DESCRIPTION and GLOBAL-SPECIAL-VARIABLE-DESCRIPTION.

Package

Source

authentic-variable-description.

Direct superclasses

Direct subclasses

global-special-variable-description.
local-special-variable-description.

Class: speed-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have speed information, in particular the class optimize-description.

The initarg :SPEED is supported by this class. The value of this initarg is an integer between 0 and 3.

The reader SPEED can be used to access the speed information of the entity.

Package

Source

Direct subclasses

Direct methods

cloning-information.
merge-speed.
speed.

Direct slots

Slot: %speed ¶

Initform: (error "initarg ~s must be given." :speed)
Initargs: :speed
Readers: speed.
Writers: This slot is read-only.

Class: symbol-macro-description ¶

This abstract class is a subclass of the classes VARIABLE-DESCRIPTION, TYPE-MIXIN, and EXPANSION-MIXIN.

Package

Source

Direct superclasses

expansion-mixin.
type-mixin.
variable-description.

Direct subclasses

global-symbol-macro-description.
local-symbol-macro-description.

Class: tag-description ¶

Package

Source

Direct superclasses

description.
identity-mixin.
name-mixin.

Direct subclasses

tag-description.

Class: type-mixin ¶

This mixin class supplies a single initarg and a single reader. It can be used as a superclass of query classes that correspond to some entity that can have a type associated with it, such as a variable or a function.

The initarg :TYPE is supported by this class. The value of this initarg is a type descriptor. If this initarg is not given, it defaults to T.

The reader TYPE can be used to access the type of the entity.

Package

Source

Direct subclasses

authentic-function-description.
authentic-variable-description.
symbol-macro-description.

Direct methods

cloning-information.
merge-type.
type.

Direct slots

Slot: %type ¶

Initform: t
Initargs: :type
Readers: type.
Writers: This slot is read-only.

Class: value-mixin ¶

Package

Source

constant-variable-description.

Direct subclasses

Direct methods

cloning-information.
value.

Direct slots

Slot: %value ¶

Initform: (error "initarg ~s must be given." :value)
Initargs: :value
Readers: value.
Writers: This slot is read-only.

Class: variable-description ¶

This abstract class is the superclass of every query class returned by a call to the generic function DESCRIBE-VARIABLE. It is a subclass of the classes NAME-MIXIN and IGNORE-MIXIN.

Package

Source

Direct superclasses

description.
ignore-mixin.
name-mixin.

Direct subclasses

authentic-variable-description.
constant-variable-description.
symbol-macro-description.

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

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

6.2.1 Special variables

Special Variable: *null-lexical-environment* ¶

Package: trucler-native-sbcl.
Source: utilities.lisp.

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

6.2.2 Ordinary functions

Function: fun-type (var env) ¶

Package: trucler-native-sbcl.
Source: utilities.lisp.

Function: leaf-dynamic-extent (leaf env) ¶

Package: trucler-native-sbcl.
Source: utilities.lisp.

Function: leaf-type (leaf env default) ¶

Package: trucler-native-sbcl.
Source: utilities.lisp.

Function: var-type (var env) ¶

Package: trucler-native-sbcl.
Source: utilities.lisp.

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

6.2.3 Conditions

Condition: invalid-description ¶

Package

Source

conditions.lisp.

Direct superclasses

condition.
program-error.

Direct subclasses

invalid-description-for-merging-compilation-speed-information.
invalid-description-for-merging-debug-information.
invalid-description-for-merging-dynamic-extent-information.
invalid-description-for-merging-ignore-information.
invalid-description-for-merging-inline-data.
invalid-description-for-merging-inline-information.
invalid-description-for-merging-safety-information.
invalid-description-for-merging-space-information.
invalid-description-for-merging-speed-information.
invalid-description-for-merging-type-information.

Direct methods

description.

Direct slots

Slot: %description ¶

Initargs: :description
Readers: description.
Writers: This slot is read-only.

Condition: invalid-description-for-merging-dynamic-extent-information ¶

Package: trucler.
Source: conditions.lisp.
Direct superclasses: invalid-description.
Direct methods: report-condition.

Previous: Conditions, Up: Internals [Contents][Index]

6.2.4 Classes

Class: always-bound-mixin ¶

Package

Source

Direct subclasses

constant-variable-description.
global-special-variable-description.
global-symbol-macro-description.
global-variable-description.
lexical-variable-description.
local-special-variable-description.
local-symbol-macro-description.

Direct methods

always-bound.

Direct slots

Slot: %always-bound ¶

Type: boolean
Initargs: :always-bound
Readers: always-bound.
Writers: This slot is read-only.

Class: block-description ¶

Package: trucler-native-sbcl.
Source: query-classes.lisp.
Direct superclasses: block-description.

Class: constant-variable-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
constant-variable-description.
deprecated-mixin.

Class: declarations-description ¶

Package: trucler-native-sbcl.
Source: query-classes.lisp.
Direct superclasses: declarations-description.

Class: declarations-mixin ¶

This mixin class supplies a single initarg and a single reader.
It can be used as a superclass of query classes that correspond
to some entity that can have declaration identifier information, in particular the class declarations-description.

The initarg :DECLARATIONS is supported by this class. The value
of this initarg is a list of declaration identifiers (symbols).

The reader DECLARATIONS can be used to access the declarations
information of the entity.

Package

Source

declarations-description.

Direct subclasses

Direct methods

cloning-information.
declarations.

Direct slots

Slot: %declarations ¶

Initform: (error "initarg ~s must be given." :declarations)
Initargs: :declarations
Readers: declarations.
Writers: This slot is read-only.

Class: deprecated-mixin ¶

Package

Source

Direct subclasses

constant-variable-description.
generic-function-description.
global-function-description.
global-macro-description.
global-special-variable-description.
global-symbol-macro-description.
global-variable-description.
lexical-variable-description.
local-function-description.
local-macro-description.
local-special-variable-description.
local-symbol-macro-description.
special-operator-description.

Direct methods

deprecated.

Direct slots

Slot: %deprecated ¶

Initform: (quote nil)
Initargs: :deprecated
Readers: deprecated.
Writers: This slot is read-only.

Class: generic-function-description ¶

Package

Source

Direct superclasses

deprecated-mixin.
generic-function-description.

Class: global-function-description ¶

Package

Source

Direct superclasses

deprecated-mixin.
global-function-description.

Class: global-macro-description ¶

Package

Source

Direct superclasses

deprecated-mixin.
global-macro-description.

Class: global-special-variable-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
deprecated-mixin.
global-special-variable-description.

Class: global-symbol-macro-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
deprecated-mixin.
global-symbol-macro-description.

Class: global-variable-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
authentic-variable-description.
deprecated-mixin.

Class: lexical-variable-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
deprecated-mixin.
lexical-variable-description.

Class: local-function-description ¶

Package

Source

Direct superclasses

deprecated-mixin.
local-function-description.

Class: local-macro-description ¶

Package

Source

Direct superclasses

deprecated-mixin.
local-macro-description.

Class: local-special-variable-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
deprecated-mixin.
local-special-variable-description.

Class: local-symbol-macro-description ¶

Package

Source

Direct superclasses

always-bound-mixin.
deprecated-mixin.
local-symbol-macro-description.

Class: optimize-description ¶

Package: trucler-native-sbcl.
Source: query-classes.lisp.
Direct superclasses: optimize-description.

Class: special-operator-description ¶

Package

Source