The instance-tracking Reference Manual

This is the instance-tracking Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 21:44:44 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 instance-tracking

Defines a class that tracks its instances

Maintainer

plkrueger

Author

plkrueger

License

MIT

Dependency

bordeaux-threads (system).

Source

instance-tracking.asd.

Child Component

instance-tracking.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 instance-tracking/instance-tracking.asd

Source

instance-tracking.asd.

Parent Component

instance-tracking (system).

ASDF Systems

instance-tracking.


3.1.2 instance-tracking/instance-tracking.lisp

Source

instance-tracking.asd.

Parent Component

instance-tracking (system).

Packages

pk-inst-track.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pk-inst-track

Source

instance-tracking.lisp.

Use List
  • common-lisp.
  • sb-mop.
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: instance-tracking-classes ()
Package

pk-inst-track.

Source

instance-tracking.lisp.


5.1.2 Generic functions

Generic Function: instances-of (class)
Package

pk-inst-track.

Methods
Method: instances-of ((x null))
Source

instance-tracking.lisp.

Method: instances-of (something-else)
Source

instance-tracking.lisp.

Method: instances-of ((class string))
Source

instance-tracking.lisp.

Method: instances-of ((class symbol))
Source

instance-tracking.lisp.

Method: instances-of ((obj inst-track))
Source

instance-tracking.lisp.

Method: instances-of ((class instance-tracking))
Source

instance-tracking.lisp.

Generic Function: untrack-all-instances (class)
Package

pk-inst-track.

Methods
Method: untrack-all-instances ((class instance-tracking))
Source

instance-tracking.lisp.

Generic Function: untrack-instance (self)
Package

pk-inst-track.

Methods
Method: untrack-instance ((self inst-track))
Source

instance-tracking.lisp.


5.1.3 Standalone methods

Method: initialize-instance :after ((class instance-tracking) &key &allow-other-keys)
Source

instance-tracking.lisp.

Method: initialize-instance :after ((self inst-track) &key &allow-other-keys)
Source

instance-tracking.lisp.

Method: validate-superclass ((class instance-tracking) (superclass standard-class))
Package

sb-mop.

Source

instance-tracking.lisp.


5.1.4 Classes

Class: instance-tracking
Package

pk-inst-track.

Source

instance-tracking.lisp.

Direct superclasses

standard-class.

Direct methods
Direct slots
Slot: class-instances
Allocation

:class

Readers

class-instances.

Writers

(setf class-instances).


5.2 Internals


5.2.1 Special variables

Special Variable: it-lock
Package

pk-inst-track.

Source

instance-tracking.lisp.


5.2.2 Generic functions

Generic Reader: class-instances (object)
Package

pk-inst-track.

Methods
Reader Method: class-instances ((instance-tracking instance-tracking))

automatically generated reader method

Source

instance-tracking.lisp.

Target Slot

class-instances.

Generic Writer: (setf class-instances) (object)
Package

pk-inst-track.

Methods
Writer Method: (setf class-instances) ((instance-tracking instance-tracking))

automatically generated writer method

Source

instance-tracking.lisp.

Target Slot

class-instances.


5.2.3 Classes

Class: inst-track
Package

pk-inst-track.

Source

instance-tracking.lisp.

Direct methods

Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   F   G   I   M   U   V  
Index Entry  Section

(
(setf class-instances): Private generic functions
(setf class-instances): Private generic functions

C
class-instances: Private generic functions
class-instances: Private generic functions

F
Function, instance-tracking-classes: Public ordinary functions

G
Generic Function, (setf class-instances): Private generic functions
Generic Function, class-instances: Private generic functions
Generic Function, instances-of: Public generic functions
Generic Function, untrack-all-instances: Public generic functions
Generic Function, untrack-instance: Public generic functions

I
initialize-instance: Public standalone methods
initialize-instance: Public standalone methods
instance-tracking-classes: Public ordinary functions
instances-of: Public generic functions
instances-of: Public generic functions
instances-of: Public generic functions
instances-of: Public generic functions
instances-of: Public generic functions
instances-of: Public generic functions
instances-of: Public generic functions

M
Method, (setf class-instances): Private generic functions
Method, class-instances: Private generic functions
Method, initialize-instance: Public standalone methods
Method, initialize-instance: Public standalone methods
Method, instances-of: Public generic functions
Method, instances-of: Public generic functions
Method, instances-of: Public generic functions
Method, instances-of: Public generic functions
Method, instances-of: Public generic functions
Method, instances-of: Public generic functions
Method, untrack-all-instances: Public generic functions
Method, untrack-instance: Public generic functions
Method, validate-superclass: Public standalone methods

U
untrack-all-instances: Public generic functions
untrack-all-instances: Public generic functions
untrack-instance: Public generic functions
untrack-instance: Public generic functions

V
validate-superclass: Public standalone methods


A.3 Variables