Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The shared-preferences Reference Manual

This is the shared-preferences Reference Manual, version 1.1.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:52:22 2024 GMT+0.

Next: Systems, Previous: The shared-preferences Reference Manual, Up: The shared-preferences Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The shared-preferences Reference Manual [Contents][Index]

2 Systems

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

shared-preferences

Previous: Systems, Up: Systems [Contents][Index]

2.1 `shared-preferences`

Notably allows flexible specification of package-local preferences.

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Unlicense

Version

1.1.1

Dependencies

trivial-garbage (system).
inheriting-readers (system).

Source

shared-preferences.asd.

Child Components

package.lisp (file).
core.lisp (file).
standard.lisp (file).

Next: Packages, Previous: Systems, Up: The shared-preferences Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

shared-preferences/shared-preferences.asd
shared-preferences/package.lisp
shared-preferences/core.lisp
shared-preferences/standard.lisp

Next: shared-preferences/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `shared-preferences/shared-preferences.asd`

Source: shared-preferences.asd.
Parent Component: shared-preferences (system).
ASDF Systems: shared-preferences.

Next: shared-preferences/core.lisp, Previous: shared-preferences/shared-preferences.asd, Up: Lisp [Contents][Index]

3.1.2 `shared-preferences/package.lisp`

Source: shared-preferences.asd.
Parent Component: shared-preferences (system).
Packages: shared-prefs.

Next: shared-preferences/standard.lisp, Previous: shared-preferences/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `shared-preferences/core.lisp`

Dependency

package.lisp (file).

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

Public Interface

preferences (function).
preferences (class).
preferences-1 (generic function).
(setf preferences-1) (generic function).
preferences-mixin (class).
preferencesp (generic function).
scope (class).
scopep (generic function).

Internals

*scope-to-preferences* (special variable).

Previous: shared-preferences/core.lisp, Up: Lisp [Contents][Index]

3.1.4 `shared-preferences/standard.lisp`

Dependency

core.lisp (file).

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

Public Interface

define-defaults (macro).
define-setting (macro).
define-settings (macro).
preferences-class (class).
standard-preferences (class).

Internals

%check-setting-exists (function).

Next: Definitions, Previous: Files, Up: The shared-preferences Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

shared-prefs

Previous: Packages, Up: Packages [Contents][Index]

4.1 `shared-prefs`

Source

package.lisp.

Nickname

shared-preferences

Use List

common-lisp.

Public Interface

define-defaults (macro).
define-setting (macro).
define-settings (macro).
preferences (function).
preferences (class).
preferences-1 (generic function).
(setf preferences-1) (generic function).
preferences-class (class).
preferences-mixin (class).
preferencesp (generic function).
scope (class).
scopep (generic function).
standard-preferences (class).

Internals

%check-setting-exists (function).
*scope-to-preferences* (special variable).

Next: Indexes, Previous: Packages, Up: The shared-preferences Reference Manual [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

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

5.1.1 Macros

Macro: define-defaults (&body setting-defaults) ¶

Package: shared-prefs.
Source: standard.lisp.

Macro: define-setting (name &optional default-value) ¶

Package: shared-prefs.
Source: standard.lisp.

Macro: define-settings (preferences-class-name direct-superclasses settings &rest options) ¶

Package: shared-prefs.
Source: standard.lisp.

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

5.1.2 Ordinary functions

Function: preferences (scope) ¶

Package: shared-prefs.
Source: core.lisp.

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

5.1.3 Generic functions

Generic Function: preferences-1 (scope) ¶

Package

shared-prefs.

Source

core.lisp.

Methods

Reader Method: preferences-1 ((preferences-mixin preferences-mixin)) ¶

automatically generated reader method

Target Slot: %preferences.

Method: preferences-1 :around (scope) ¶

Method: preferences-1 (scope) ¶

Generic Function: (setf preferences-1) (scope) ¶

Package

shared-prefs.

Source

core.lisp.

Methods

Writer Method: (setf preferences-1) ((preferences-mixin preferences-mixin)) ¶

automatically generated writer method

Target Slot: %preferences.

Method: (setf preferences-1) :around (scope) ¶

Method: (setf preferences-1) (scope) ¶

Generic Function: preferencesp (object) ¶

Package

shared-prefs.

Source

core.lisp.

Methods

Method: preferencesp (object) ¶

Method: preferencesp ((default null)) ¶

Method: preferencesp ((preferences preferences)) ¶

Generic Function: scopep (object) ¶

Package

shared-prefs.

Source

core.lisp.

Methods

Method: scopep :around (object) ¶

Method: scopep ((scope scope)) ¶

Method: scopep ((package package)) ¶

Method: scopep (object) ¶

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

5.1.4 Classes

Class: preferences ¶

Package: shared-prefs.
Source: core.lisp.
Direct subclasses: standard-preferences.
Direct methods: preferencesp.

Class: preferences-class ¶

Package

shared-prefs.

Source

standard.lisp.

Direct superclasses

standard-class.

Direct Default Initargs

Initarg	Value
`:inherit`	`t`

Class: preferences-mixin ¶

Package

shared-prefs.

Source

core.lisp.

Direct superclasses

scope.

Direct methods

(setf preferences-1).
preferences-1.

Direct slots

Slot: %preferences ¶

Initargs: :preferences
Readers: preferences-1.
Writers: (setf preferences-1).

Class: scope ¶

Package: shared-prefs.
Source: core.lisp.
Direct subclasses: preferences-mixin.
Direct methods: scopep.

Class: standard-preferences ¶

Package

shared-prefs.

Source

standard.lisp.

Direct superclasses

parent-mixin.
preferences.

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

5.2 Internals

Special variables
Ordinary functions

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

5.2.1 Special variables

Special Variable: *scope-to-preferences* ¶

Package: shared-prefs.
Source: core.lisp.

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

5.2.2 Ordinary functions

Function: %check-setting-exists (setting-name) ¶

Package: shared-prefs.
Source: standard.lisp.

Previous: Definitions, Up: The shared-preferences Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	% ( D F G M P S

	Index Entry	Section

%
	`%check-setting-exists`:	Private ordinary functions

(
	`(setf preferences-1)`:	Public generic functions
	`(setf preferences-1)`:	Public generic functions
	`(setf preferences-1)`:	Public generic functions
	`(setf preferences-1)`:	Public generic functions

D
	`define-defaults`:	Public macros
	`define-setting`:	Public macros
	`define-settings`:	Public macros

F
	`Function, %check-setting-exists`:	Private ordinary functions
	`Function, preferences`:	Public ordinary functions

G
	`Generic Function, (setf preferences-1)`:	Public generic functions
	`Generic Function, preferences-1`:	Public generic functions
	`Generic Function, preferencesp`:	Public generic functions
	`Generic Function, scopep`:	Public generic functions

M
	`Macro, define-defaults`:	Public macros
	`Macro, define-setting`:	Public macros
	`Macro, define-settings`:	Public macros
	`Method, (setf preferences-1)`:	Public generic functions
	`Method, (setf preferences-1)`:	Public generic functions
	`Method, (setf preferences-1)`:	Public generic functions
	`Method, preferences-1`:	Public generic functions
	`Method, preferences-1`:	Public generic functions
	`Method, preferences-1`:	Public generic functions
	`Method, preferencesp`:	Public generic functions
	`Method, preferencesp`:	Public generic functions
	`Method, preferencesp`:	Public generic functions
	`Method, scopep`:	Public generic functions
	`Method, scopep`:	Public generic functions
	`Method, scopep`:	Public generic functions
	`Method, scopep`:	Public generic functions

P
	`preferences`:	Public ordinary functions
	`preferences-1`:	Public generic functions
	`preferences-1`:	Public generic functions
	`preferences-1`:	Public generic functions
	`preferences-1`:	Public generic functions
	`preferencesp`:	Public generic functions
	`preferencesp`:	Public generic functions
	`preferencesp`:	Public generic functions
	`preferencesp`:	Public generic functions

S
	`scopep`:	Public generic functions
	`scopep`:	Public generic functions
	`scopep`:	Public generic functions
	`scopep`:	Public generic functions
	`scopep`:	Public generic functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	% * S

	Index Entry	Section

%
	`%preferences`:	Public classes

*
	`scope-to-preferences`:	Private special variables

S
	`Slot, %preferences`:	Public classes
	`Special Variable, scope-to-preferences`:	Private special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F P S

	Index Entry	Section

C
	`Class, preferences`:	Public classes
	`Class, preferences-class`:	Public classes
	`Class, preferences-mixin`:	Public classes
	`Class, scope`:	Public classes
	`Class, standard-preferences`:	Public classes
	`core.lisp`:	The shared-preferences/core․lisp file

F
	`File, core.lisp`:	The shared-preferences/core․lisp file
	`File, package.lisp`:	The shared-preferences/package․lisp file
	`File, shared-preferences.asd`:	The shared-preferences/shared-preferences․asd file
	`File, standard.lisp`:	The shared-preferences/standard․lisp file

P
	`Package, shared-prefs`:	The shared-prefs package
	`package.lisp`:	The shared-preferences/package․lisp file
	`preferences`:	Public classes
	`preferences-class`:	Public classes
	`preferences-mixin`:	Public classes

S
	`scope`:	Public classes
	`shared-preferences`:	The shared-preferences system
	`shared-preferences.asd`:	The shared-preferences/shared-preferences․asd file
	`shared-prefs`:	The shared-prefs package
	`standard-preferences`:	Public classes
	`standard.lisp`:	The shared-preferences/standard․lisp file
	`System, shared-preferences`:	The shared-preferences system

The shared-preferences Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 shared-preferences

3 Files

3.1 Lisp

3.1.1 shared-preferences/shared-preferences.asd

3.1.2 shared-preferences/package.lisp

3.1.3 shared-preferences/core.lisp

3.1.4 shared-preferences/standard.lisp

4 Packages

4.1 shared-prefs

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Ordinary functions

5.1.3 Generic functions

5.1.4 Classes

5.2 Internals

5.2.1 Special variables

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `shared-preferences`

3.1.1 `shared-preferences/shared-preferences.asd`

3.1.2 `shared-preferences/package.lisp`

3.1.3 `shared-preferences/core.lisp`

3.1.4 `shared-preferences/standard.lisp`

4.1 `shared-prefs`