The def-properties Reference Manual

This is the def-properties Reference Manual, version 0.0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:53:16 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 def-properties

Common Lisp definitions instropection library

Author

Mariano Montone <>

License

MIT

Long Description

Common Lisp definitions instropection library.

NOTE: This contains some code taken from DOCBROWSER library: https://github.com/lokedhs/docbrowser.

Version

0.0.1

Dependencies
  • alexandria (system).
  • swank (system).
  • closer-mop (system).
Source

def-properties.asd.

Child Component

def-properties.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 def-properties/def-properties.asd

Source

def-properties.asd.

Parent Component

def-properties (system).

ASDF Systems

def-properties.


3.1.2 def-properties/def-properties.lisp

Source

def-properties.asd.

Parent Component

def-properties (system).

Packages

def-properties.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 def-properties

Collects properties about Lisp definitions, in a portable way

Source

def-properties.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 Ordinary functions

Function: asdf-system-packages (system)
Package

def-properties.

Source

def-properties.lisp.

Function: class-properties (class-name &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: function-properties (symbol &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: generic-function-properties (symbol &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: list-lambda-list-args (lambda-list)

Takes a LAMBDA-LIST and returns the list of all the argument names.

Package

def-properties.

Source

def-properties.lisp.

Function: macro-properties (symbol &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: package-properties (package &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: parse-docstring (docstring bound-args &key case-sensitive ignore package)

Parse a docstring.
BOUND-ARGS: when parsing a function/macro/generic function docstring, BOUND-ARGS contains the names of the arguments. That means the function arguments are detected by the parser. CASE-SENSITIVE: when case-sensitive is T, bound arguments are only parsed when in uppercase.
IGNORE: an optional predicate. When ignore is given and invoking it returns T, the current word is not parsed as special symbol.
PACKAGE: the package to use to read the docstring symbols.

Package

def-properties.

Source

def-properties.lisp.

Function: special-operator-properties (symbol &optional shallow)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-class-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-function-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-generic-function-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-kind-p (symbol kind)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-kinds (symbol)

Return the kinds of the SYMBOL.

Package

def-properties.

Source

def-properties.lisp.

Function: symbol-macro-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-properties (symbol &optional shallow type)

Collects properties about a symbol.
If TYPE is specified, then SYMBOL is treated as the given TYPE (variable, function, package, etc). If SHALLOW is T, then only fundamental properties are collected.
Returns a list of alists of properties, one alist for each type of definition that SYMBOL is bound to.

Package

def-properties.

Source

def-properties.lisp.

Function: symbol-structure-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-type-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-variable-p (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: type-properties (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: variable-properties (symbol &optional shallow)
Package

def-properties.

Source

def-properties.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *package-source-locations*

A cache of packages source locations

Package

def-properties.

Source

def-properties.lisp.


5.2.2 Macros

Macro: aand (arg1 &rest args)
Package

def-properties.

Source

def-properties.lisp.


5.2.3 Ordinary functions

Function: %annotate-function-properties (fn-properties classes)

Append :ACCESSORP tag if the function is present as an accessor function.

Package

def-properties.

Source

def-properties.lisp.

Function: %ensure-external (symbol)
Package

def-properties.

Source

def-properties.lisp.

Function: accessor-properties (class slot)
Package

def-properties.

Source

def-properties.lisp.

Function: aget (alist key)
Package

def-properties.

Source

def-properties.lisp.

Function: assoc-cdr (key data &key error-p)

Return (CDR (ASSOC KEY DATA)). If ERROR-P is non-NIL, signal an error if KEY is not available is DATA.

Package

def-properties.

Source

def-properties.lisp.

Function: assoc-name (v)
Package

def-properties.

Source

def-properties.lisp.

Function: concat-rich-text (text)
Package

def-properties.

Source

def-properties.lisp.

Function: find-superclasses (class)
Package

def-properties.

Source

def-properties.lisp.

Function: format-argument-to-string (arg)
Package

def-properties.

Source

def-properties.lisp.

Function: load-slots (class)
Package

def-properties.

Source

def-properties.lisp.

Function: location-pathname (location)
Package

def-properties.

Source

def-properties.lisp.

Function: macro-source-location (name)
Package

def-properties.

Source

def-properties.lisp.

Function: nice-princ-to-string (obj)
Package

def-properties.

Source

def-properties.lisp.

Function: package-source-location (package)
Package

def-properties.

Source

def-properties.lisp.

Function: prin1-to-string-with-package (obj package)
Package

def-properties.

Source

def-properties.lisp.

Function: quoted-symbol-name (string)
Package

def-properties.

Source

def-properties.lisp.

Function: quoted-symbol-p (string)
Package

def-properties.

Source

def-properties.lisp.

Function: specialisation-properties (class-name &key include-internal)
Package

def-properties.

Source

def-properties.lisp.

Function: specialise->symbol (spec)
Package

def-properties.

Source

def-properties.lisp.

Function: split-string-with-delimiter (string delimiter &key keep-delimiters)
Package

def-properties.

Source

def-properties.lisp.

Function: symbol-external-p (symbol &optional package)

Return non-NIL if SYMBOL is external in PACKAGE. SYMBOL may be either a symbol, or a SETF form, in which case the check will be performed on the CADR of the list.

Package

def-properties.

Source

def-properties.lisp.

Function: variable-source-location (name)
Package

def-properties.

Source

def-properties.lisp.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %  
A   C   F   G   L   M   N   P   Q   S   T   V  
Index Entry  Section

%
%annotate-function-properties: Private ordinary functions
%ensure-external: Private ordinary functions

A
aand: Private macros
accessor-properties: Private ordinary functions
aget: Private ordinary functions
asdf-system-packages: Public ordinary functions
assoc-cdr: Private ordinary functions
assoc-name: Private ordinary functions

C
class-properties: Public ordinary functions
concat-rich-text: Private ordinary functions

F
find-superclasses: Private ordinary functions
format-argument-to-string: Private ordinary functions
Function, %annotate-function-properties: Private ordinary functions
Function, %ensure-external: Private ordinary functions
Function, accessor-properties: Private ordinary functions
Function, aget: Private ordinary functions
Function, asdf-system-packages: Public ordinary functions
Function, assoc-cdr: Private ordinary functions
Function, assoc-name: Private ordinary functions
Function, class-properties: Public ordinary functions
Function, concat-rich-text: Private ordinary functions
Function, find-superclasses: Private ordinary functions
Function, format-argument-to-string: Private ordinary functions
Function, function-properties: Public ordinary functions
Function, generic-function-properties: Public ordinary functions
Function, list-lambda-list-args: Public ordinary functions
Function, load-slots: Private ordinary functions
Function, location-pathname: Private ordinary functions
Function, macro-properties: Public ordinary functions
Function, macro-source-location: Private ordinary functions
Function, nice-princ-to-string: Private ordinary functions
Function, package-properties: Public ordinary functions
Function, package-source-location: Private ordinary functions
Function, parse-docstring: Public ordinary functions
Function, prin1-to-string-with-package: Private ordinary functions
Function, quoted-symbol-name: Private ordinary functions
Function, quoted-symbol-p: Private ordinary functions
Function, special-operator-properties: Public ordinary functions
Function, specialisation-properties: Private ordinary functions
Function, specialise->symbol: Private ordinary functions
Function, split-string-with-delimiter: Private ordinary functions
Function, symbol-class-p: Public ordinary functions
Function, symbol-external-p: Private ordinary functions
Function, symbol-function-p: Public ordinary functions
Function, symbol-generic-function-p: Public ordinary functions
Function, symbol-kind-p: Public ordinary functions
Function, symbol-kinds: Public ordinary functions
Function, symbol-macro-p: Public ordinary functions
Function, symbol-properties: Public ordinary functions
Function, symbol-structure-p: Public ordinary functions
Function, symbol-type-p: Public ordinary functions
Function, symbol-variable-p: Public ordinary functions
Function, type-properties: Public ordinary functions
Function, variable-properties: Public ordinary functions
Function, variable-source-location: Private ordinary functions
function-properties: Public ordinary functions

G
generic-function-properties: Public ordinary functions

L
list-lambda-list-args: Public ordinary functions
load-slots: Private ordinary functions
location-pathname: Private ordinary functions

M
Macro, aand: Private macros
macro-properties: Public ordinary functions
macro-source-location: Private ordinary functions

N
nice-princ-to-string: Private ordinary functions

P
package-properties: Public ordinary functions
package-source-location: Private ordinary functions
parse-docstring: Public ordinary functions
prin1-to-string-with-package: Private ordinary functions

Q
quoted-symbol-name: Private ordinary functions
quoted-symbol-p: Private ordinary functions

S
special-operator-properties: Public ordinary functions
specialisation-properties: Private ordinary functions
specialise->symbol: Private ordinary functions
split-string-with-delimiter: Private ordinary functions
symbol-class-p: Public ordinary functions
symbol-external-p: Private ordinary functions
symbol-function-p: Public ordinary functions
symbol-generic-function-p: Public ordinary functions
symbol-kind-p: Public ordinary functions
symbol-kinds: Public ordinary functions
symbol-macro-p: Public ordinary functions
symbol-properties: Public ordinary functions
symbol-structure-p: Public ordinary functions
symbol-type-p: Public ordinary functions
symbol-variable-p: Public ordinary functions

T
type-properties: Public ordinary functions

V
variable-properties: Public ordinary functions
variable-source-location: Private ordinary functions


A.3 Variables