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 Wed May 15 06:52:31 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 shared-preferences

Notably allows flexible specification of package-local preferences.

Author

Jean-Philippe Paradis <>

License

Unlicense

Version

1.1.1

Dependencies
  • trivial-garbage (system).
  • inheriting-readers (system).
Source

shared-preferences.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 shared-preferences/shared-preferences.asd

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

ASDF Systems

shared-preferences.


3.1.2 shared-preferences/package.lisp

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

Packages

shared-prefs.


3.1.3 shared-preferences/core.lisp

Dependency

package.lisp (file).

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

Public Interface
Internals

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


3.1.4 shared-preferences/standard.lisp

Dependency

core.lisp (file).

Source

shared-preferences.asd.

Parent Component

shared-preferences (system).

Public Interface
Internals

%check-setting-exists (function).


4 Packages

Packages are listed by definition order.


4.1 shared-prefs

Source

package.lisp.

Nickname

shared-preferences

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-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.


5.1.2 Ordinary functions

Function: preferences (scope)
Package

shared-prefs.

Source

core.lisp.


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)

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
InitargValue
:inheritt
Class: preferences-mixin
Package

shared-prefs.

Source

core.lisp.

Direct superclasses

scope.

Direct methods
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

5.2 Internals


5.2.1 Special variables

Special Variable: *scope-to-preferences*
Package

shared-prefs.

Source

core.lisp.


5.2.2 Ordinary functions

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

shared-prefs.

Source

standard.lisp.


Appendix A Indexes


A.1 Concepts


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