The shared-preferences Reference Manual

Table of Contents

Next: , Previous: , 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 3.0 "Montgomery Scott" on Mon Apr 19 17:45:30 2021 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/shared-preferences/


shared-preferences notably allows flexible specification of package-local preferences.


This library is in the Public Domain.
See the UNLICENSE file for details.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 shared-preferences

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Unlicense

Description

Notably allows flexible specification of package-local preferences.

Version

1.1.1

Dependencies
Source

shared-preferences.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 shared-preferences.asd

Location

shared-preferences.asd

Systems

shared-preferences (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 shared-preferences/package.lisp

Parent

shared-preferences (system)

Location

package.lisp

Packages

shared-prefs


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 shared-preferences/core.lisp

Dependency

package.lisp (file)

Parent

shared-preferences (system)

Location

core.lisp

Exported Definitions
Internal Definitions

*scope-to-preferences* (special variable)


Previous: , Up: Lisp files   [Contents][Index]

3.1.4 shared-preferences/standard.lisp

Dependency

core.lisp (file)

Parent

shared-preferences (system)

Location

standard.lisp

Exported Definitions
Internal Definitions

%check-setting-exists (function)


Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 shared-prefs

Source

package.lisp (file)

Nickname

shared-preferences

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


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

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: define-defaults &body SETTING-DEFAULTS
Package

shared-prefs

Source

standard.lisp (file)

Macro: define-setting NAME &optional DEFAULT-VALUE
Package

shared-prefs

Source

standard.lisp (file)

Macro: define-settings PREFERENCES-CLASS-NAME DIRECT-SUPERCLASSES SETTINGS &rest OPTIONS
Package

shared-prefs

Source

standard.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: preferences SCOPE
Package

shared-prefs

Source

core.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.3 Generic functions

Generic Function: preferences-1 SCOPE
Generic Function: (setf preferences-1) PREFERENCES SCOPE
Package

shared-prefs

Source

core.lisp (file)

Methods
Method: preferences-1 (PREFERENCES-MIXIN preferences-mixin)

automatically generated reader method

Method: (setf preferences-1) NEW-VALUE (PREFERENCES-MIXIN preferences-mixin)

automatically generated writer method

Method: preferences-1 SCOPE around
Method: (setf preferences-1) PREFERENCES SCOPE around
Method: preferences-1 SCOPE
Method: (setf preferences-1) PREFERENCES SCOPE
Generic Function: preferencesp OBJECT
Package

shared-prefs

Source

core.lisp (file)

Methods
Method: preferencesp OBJECT
Method: preferencesp (DEFAULT null)
Method: preferencesp (PREFERENCES preferences)
Generic Function: scopep OBJECT
Package

shared-prefs

Source

core.lisp (file)

Methods
Method: scopep OBJECT around
Method: scopep (SCOPE scope)
Method: scopep (PACKAGE package)
Method: scopep OBJECT

Previous: , Up: Exported definitions   [Contents][Index]

5.1.4 Classes

Class: preferences ()
Package

shared-prefs

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-preferences (class)

Direct methods

preferencesp (method)

Class: preferences-class ()
Package

shared-prefs

Source

standard.lisp (file)

Direct superclasses

standard-class (class)

Direct Default Initargs
InitargValue
:inheritt
Class: preferences-mixin ()
Package

shared-prefs

Source

core.lisp (file)

Direct superclasses

scope (class)

Direct methods
Direct slots
Slot: %preferences
Initargs

:preferences

Readers

preferences-1 (generic function)

Writers

(setf preferences-1) (generic function)

Class: scope ()
Package

shared-prefs

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

preferences-mixin (class)

Direct methods

scopep (method)

Class: standard-preferences ()
Package

shared-prefs

Source

standard.lisp (file)

Direct superclasses

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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *scope-to-preferences*
Package

shared-prefs

Source

core.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Functions

Function: %check-setting-exists SETTING-NAME
Package

shared-prefs

Source

standard.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   S  
Index Entry  Section

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

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

S
shared-preferences.asd: The shared-preferences․asd file
shared-preferences/core.lisp: The shared-preferences/core․lisp file
shared-preferences/package.lisp: The shared-preferences/package․lisp file
shared-preferences/standard.lisp: The shared-preferences/standard․lisp file

Jump to:   F   L   S  

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

A.2 Functions

Jump to:   %   (  
D   F   G   M   P   S  
Index Entry  Section

%
%check-setting-exists: Internal functions

(
(setf preferences-1): Exported generic functions
(setf preferences-1): Exported generic functions
(setf preferences-1): Exported generic functions
(setf preferences-1): Exported generic functions

D
define-defaults: Exported macros
define-setting: Exported macros
define-settings: Exported macros

F
Function, %check-setting-exists: Internal functions
Function, preferences: Exported functions

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

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

P
preferences: Exported functions
preferences-1: Exported generic functions
preferences-1: Exported generic functions
preferences-1: Exported generic functions
preferences-1: Exported generic functions
preferencesp: Exported generic functions
preferencesp: Exported generic functions
preferencesp: Exported generic functions
preferencesp: Exported generic functions

S
scopep: Exported generic functions
scopep: Exported generic functions
scopep: Exported generic functions
scopep: Exported generic functions
scopep: Exported generic functions

Jump to:   %   (  
D   F   G   M   P   S  

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

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%preferences: Exported classes

*
*scope-to-preferences*: Internal special variables

S
Slot, %preferences: Exported classes
Special Variable, *scope-to-preferences*: Internal special variables

Jump to:   %   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
Class, preferences: Exported classes
Class, preferences-class: Exported classes
Class, preferences-mixin: Exported classes
Class, scope: Exported classes
Class, standard-preferences: Exported classes

P
Package, shared-prefs: The shared-prefs package
preferences: Exported classes
preferences-class: Exported classes
preferences-mixin: Exported classes

S
scope: Exported classes
shared-preferences: The shared-preferences system
shared-prefs: The shared-prefs package
standard-preferences: Exported classes
System, shared-preferences: The shared-preferences system

Jump to:   C   P   S