The cl-naive-deprecation Reference Manual

This is the cl-naive-deprecation Reference Manual, version 2023.8.23, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:11:34 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-naive-deprecation

Author

Phil Marneweck

License

MIT

Version

2023.8.23

Source

cl-naive-deprecation.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 cl-naive-deprecation/cl-naive-deprecation.asd

Source

cl-naive-deprecation.asd.

Parent Component

cl-naive-deprecation (system).

ASDF Systems

cl-naive-deprecation.


3.1.2 cl-naive-deprecation/src/package.lisp

Source

cl-naive-deprecation.asd.

Parent Component

cl-naive-deprecation (system).

Packages

cl-naive-deprecation.


3.1.3 cl-naive-deprecation/src/deprecation.lisp

Dependency

src/package.lisp (file).

Source

cl-naive-deprecation.asd.

Parent Component

cl-naive-deprecation (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-naive-deprecation

Source

src/package.lisp.

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: *deprecation-warnings*

If true, warnings are issued when deprecated operators are used.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.


5.1.2 Macros

Macro: declare-deprecated-operators (&rest operator-names)
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Macro: declare-deprecation (deprecation-clause &rest other-deprecation-clauses)
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.


5.1.3 Ordinary functions

Function: clear-deprecations ()

Clear the list of deprecated operators and the locations where they were used.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Function: deprecated-operators ()

Return a list of the names of all the deprecated operators.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Function: report-deprecations (&key stream include-unused)

Prints on the stream a list of all the deprecated operators that were used and the files they’re used in.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.


5.1.4 Generic functions

Generic Reader: deprecation-warning-operator-kind (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: deprecation-warning-operator-kind ((condition deprecation-warning))
Source

src/deprecation.lisp.

Target Slot

operator-kind.

Generic Reader: deprecation-warning-operator-name (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: deprecation-warning-operator-name ((condition deprecation-warning))
Source

src/deprecation.lisp.

Target Slot

operator-name.

Generic Reader: deprecation-warning-source-file (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: deprecation-warning-source-file ((condition deprecation-warning))
Source

src/deprecation.lisp.

Target Slot

source-file.

Generic Reader: deprecation-warning-source-form (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: deprecation-warning-source-form ((condition deprecation-warning))
Source

src/deprecation.lisp.

Target Slot

source-form.

Generic Reader: replaced-warning-replacement-description (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: replaced-warning-replacement-description ((condition replaced-warning))
Source

src/deprecation.lisp.

Target Slot

replacement-description.

Generic Reader: replaced-warning-replacement-name (condition)
Package

cl-naive-deprecation.

Methods
Reader Method: replaced-warning-replacement-name ((condition replaced-warning))
Source

src/deprecation.lisp.

Target Slot

replacement-name.


5.1.5 Conditions

Condition: deprecation-warning
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Direct superclasses

warning.

Direct subclasses
Direct methods
Direct slots
Slot: operator-name
Initargs

:operator-name

Readers

deprecation-warning-operator-name.

Writers

This slot is read-only.

Slot: operator-kind
Initform

(quote (quote cl-naive-deprecation::operator))

Initargs

:operator-kind

Readers

deprecation-warning-operator-kind.

Writers

This slot is read-only.

Slot: source-file
Initform

(quote nil)

Initargs

:source-file

Readers

deprecation-warning-source-file.

Writers

This slot is read-only.

Slot: source-form
Initform

(quote nil)

Initargs

:source-form

Readers

deprecation-warning-source-form.

Writers

This slot is read-only.

Condition: removed-warning
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Direct superclasses

deprecation-warning.

Condition: replaced-warning
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Direct superclasses

deprecation-warning.

Direct methods
Direct slots
Slot: replacement-name
Initargs

:replacement-name

Readers

replaced-warning-replacement-name.

Writers

This slot is read-only.

Slot: replacement-description
Initargs

:replacement-description

Readers

replaced-warning-replacement-description.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Special variables

Special Variable: *deprecation-locations*

A hash table mapping deprecated operator names to lists of locations where they were used. Note: we may deprecate (setf foo) operators too.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.


5.2.2 Ordinary functions

Function: generate-deprecated-operator (kind name)
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Function: generate-removed-operator (kind name)
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Function: generate-replaced-by-operator (kind name lambda-list-p lambda-list replacement-clause)
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Function: syntax-keyword (symbol &optional expected)

Intern the name of the symbol in the source package.
If expected (a list of symbols) is given, then check that symbol has the same name as one of the symbols in expected, and return the symbol from expected.

Package

cl-naive-deprecation.

Source

src/deprecation.lisp.


5.2.3 Conditions

Condition: simple-program-error
Package

cl-naive-deprecation.

Source

src/deprecation.lisp.

Direct superclasses
  • program-error.
  • simple-error.

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   C   D   F   G   M   R   S  
Index Entry  Section

C
clear-deprecations: Public ordinary functions

D
declare-deprecated-operators: Public macros
declare-deprecation: Public macros
deprecated-operators: Public ordinary functions
deprecation-warning-operator-kind: Public generic functions
deprecation-warning-operator-kind: Public generic functions
deprecation-warning-operator-name: Public generic functions
deprecation-warning-operator-name: Public generic functions
deprecation-warning-source-file: Public generic functions
deprecation-warning-source-file: Public generic functions
deprecation-warning-source-form: Public generic functions
deprecation-warning-source-form: Public generic functions

F
Function, clear-deprecations: Public ordinary functions
Function, deprecated-operators: Public ordinary functions
Function, generate-deprecated-operator: Private ordinary functions
Function, generate-removed-operator: Private ordinary functions
Function, generate-replaced-by-operator: Private ordinary functions
Function, report-deprecations: Public ordinary functions
Function, syntax-keyword: Private ordinary functions

G
generate-deprecated-operator: Private ordinary functions
generate-removed-operator: Private ordinary functions
generate-replaced-by-operator: Private ordinary functions
Generic Function, deprecation-warning-operator-kind: Public generic functions
Generic Function, deprecation-warning-operator-name: Public generic functions
Generic Function, deprecation-warning-source-file: Public generic functions
Generic Function, deprecation-warning-source-form: Public generic functions
Generic Function, replaced-warning-replacement-description: Public generic functions
Generic Function, replaced-warning-replacement-name: Public generic functions

M
Macro, declare-deprecated-operators: Public macros
Macro, declare-deprecation: Public macros
Method, deprecation-warning-operator-kind: Public generic functions
Method, deprecation-warning-operator-name: Public generic functions
Method, deprecation-warning-source-file: Public generic functions
Method, deprecation-warning-source-form: Public generic functions
Method, replaced-warning-replacement-description: Public generic functions
Method, replaced-warning-replacement-name: Public generic functions

R
replaced-warning-replacement-description: Public generic functions
replaced-warning-replacement-description: Public generic functions
replaced-warning-replacement-name: Public generic functions
replaced-warning-replacement-name: Public generic functions
report-deprecations: Public ordinary functions

S
syntax-keyword: Private ordinary functions