The pvars Reference Manual

This is the pvars Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:36:10 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 pvars

Author

Florian Margaine <>

License

MIT

Dependencies
  • cl-store (system).
  • global-vars (system).
Source

pvars.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 pvars/pvars.asd

Source

pvars.asd.

Parent Component

pvars (system).

ASDF Systems

pvars.


3.1.2 pvars/package.lisp

Source

pvars.asd.

Parent Component

pvars (system).

Packages

pvars.


3.1.3 pvars/pvars.lisp

Source

pvars.asd.

Parent Component

pvars (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 pvars

Source

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 Macros

Macro: define-persistent-global-parameter (name path val &optional doc)
Package

pvars.

Source

pvars.lisp.

Macro: define-persistent-global-parameter* (name path val &optional doc)
Package

pvars.

Source

pvars.lisp.

Macro: define-persistent-global-var (name path val &optional doc)
Package

pvars.

Source

pvars.lisp.

Macro: define-persistent-global-var* (name path val &optional doc)
Package

pvars.

Source

pvars.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *pvars*
Package

pvars.

Source

pvars.lisp.


5.2.2 Ordinary functions

Function: access (pvar)
Package

pvars.

Source

pvars.lisp.

Function: (setf access) (pvar)
Package

pvars.

Source

pvars.lisp.

Function: defp (type name path val doc)
Package

pvars.

Source

pvars.lisp.


5.2.3 Generic functions

Generic Reader: default (object)
Package

pvars.

Methods
Reader Method: default ((pvar pvar))

automatically generated reader method

Source

pvars.lisp.

Target Slot

default.

Generic Reader: last-access-write-p (object)
Generic Writer: (setf last-access-write-p) (object)
Package

pvars.

Methods
Reader Method: last-access-write-p ((pvar pvar))
Writer Method: (setf last-access-write-p) ((pvar pvar))

Used to be able to speed up reads.

Source

pvars.lisp.

Target Slot

last-access-write-p.

Generic Reader: last-value (object)
Package

pvars.

Methods
Reader Method: last-value ((pvar pvar))

automatically generated reader method

Source

pvars.lisp.

Target Slot

last-value.

Generic Writer: (setf last-value) (object)
Package

pvars.

Methods
Writer Method: (setf last-value) ((pvar pvar))

automatically generated writer method

Source

pvars.lisp.

Target Slot

last-value.

Generic Reader: path (object)
Package

pvars.

Methods
Reader Method: path ((pvar pvar))

automatically generated reader method

Source

pvars.lisp.

Target Slot

path.

Generic Reader: written-p (object)
Generic Writer: (setf written-p) (object)
Package

pvars.

Methods
Reader Method: written-p ((pvar pvar))
Writer Method: (setf written-p) ((pvar pvar))

Used to know if we should return the default value.

Source

pvars.lisp.

Target Slot

written-p.


5.2.4 Classes

Class: pvar
Package

pvars.

Source

pvars.lisp.

Direct methods
Direct slots
Slot: path
Type

pathname

Initargs

:path

Readers

path.

Writers

This slot is read-only.

Slot: default
Initargs

:default

Readers

default.

Writers

This slot is read-only.

Slot: written-p

Used to know if we should return the default value.

Readers

written-p.

Writers

(setf written-p).

Slot: last-access-write-p

Used to be able to speed up reads.

Readers

last-access-write-p.

Writers

(setf last-access-write-p).

Slot: last-value
Readers

last-value.

Writers

(setf last-value).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   D   F   G   L   M   P   W  
Index Entry  Section

(
(setf access): Private ordinary functions
(setf last-access-write-p): Private generic functions
(setf last-access-write-p): Private generic functions
(setf last-value): Private generic functions
(setf last-value): Private generic functions
(setf written-p): Private generic functions
(setf written-p): Private generic functions

A
access: Private ordinary functions

D
default: Private generic functions
default: Private generic functions
define-persistent-global-parameter: Public macros
define-persistent-global-parameter*: Public macros
define-persistent-global-var: Public macros
define-persistent-global-var*: Public macros
defp: Private ordinary functions

F
Function, (setf access): Private ordinary functions
Function, access: Private ordinary functions
Function, defp: Private ordinary functions

G
Generic Function, (setf last-access-write-p): Private generic functions
Generic Function, (setf last-value): Private generic functions
Generic Function, (setf written-p): Private generic functions
Generic Function, default: Private generic functions
Generic Function, last-access-write-p: Private generic functions
Generic Function, last-value: Private generic functions
Generic Function, path: Private generic functions
Generic Function, written-p: Private generic functions

L
last-access-write-p: Private generic functions
last-access-write-p: Private generic functions
last-value: Private generic functions
last-value: Private generic functions

M
Macro, define-persistent-global-parameter: Public macros
Macro, define-persistent-global-parameter*: Public macros
Macro, define-persistent-global-var: Public macros
Macro, define-persistent-global-var*: Public macros
Method, (setf last-access-write-p): Private generic functions
Method, (setf last-value): Private generic functions
Method, (setf written-p): Private generic functions
Method, default: Private generic functions
Method, last-access-write-p: Private generic functions
Method, last-value: Private generic functions
Method, path: Private generic functions
Method, written-p: Private generic functions

P
path: Private generic functions
path: Private generic functions

W
written-p: Private generic functions
written-p: Private generic functions