Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the multival-plist Reference Manual, version 0.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:19:01 2018 GMT+0.
| • Introduction: | What multival-plist is all about | |
| • Systems: | The systems documentation | |
| • Modules: | The modules documentation | |
| • Files: | The files documentation | |
| • Packages: | The packages documentation | |
| • Definitions: | The symbols documentation | |
| • Indexes: | Concepts, functions, variables and data types |
(defparameter *plist* '(:foo 1 :bar 2 :foo 3))
(getf *plist* :foo)
;=> 1
(getf-all *plist* :foo)
;=> (1 3)
(remf-all *plist* :foo)
;=> T
(getf-all *plist* :foo :undef)
;=> :UNDEF
Multival-Plist provides utilities to handle Property Lists that may contain multiple values per key.
*plist*
;=> (:FOO 1 :BAR 2 :FOO 3)
(getf *plist* :foo)
;=> 1
(getf-all *plist* :foo)
;=> (1 3)
This is a version of getf enabled to manage multiple keys. If the plist has two or more pairs that they have given key as a key, returns the values of each pairs as one list.
(setf (getf-all *plist* :foo) '("Hello" "World"))
;; *plist* = '(:foo "Hello" :bar 2 :foo "World")
;; same as (setf (getf-all *plist* :foo) '(3000))
(setf (getf-all *plist* :foo) 3000)
;; *plist* = '(:foo 3000 :bar 2)
Changes the stored value(s) of the given key. This removes or adds pairs as necessary to store the new list.
(remf-all *plist* :foo)
Removes a key and associated values for the given key.
Copyright (c) 2012 Eitarow Fukamachi (e.arrows@gmail.com)
Licensed under the LLGPL License.
Next: Modules, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The multival-plist system: |
Eitarow Fukamachi
LLGPL
Property List stores multiple values per one key.
# Multival-Plist - Property List stores multiple values per one key.
## Usage
(defparameter *plist* ’(:foo 1 :bar 2 :foo 3))
(getf *plist* :foo)
;=> 1
(getf-all *plist* :foo)
;=> (1 3)
(remf-all *plist* :foo)
;=> T
(getf-all *plist* :foo :undef)
;=> :UNDEF
## Description
Multival-Plist provides utilities to handle Property Lists that may contain multiple values per key.
## API Reference
### [Function] getf-all (plist key &optional default)
*plist*
;=> (:FOO 1 :BAR 2 :FOO 3)
(getf *plist* :foo)
;=> 1
(getf-all *plist* :foo)
;=> (1 3)
This is a version of ‘getf‘ enabled to manage multiple keys. If the ‘plist‘ has two or more pairs that they have given ‘key‘ as a key, returns the values of each pairs as one list.
### [Function] \(setf getf-all\) (val plist key &optional default)
(setf (getf-all *plist* :foo) ’("Hello" "World"))
;; *plist* = ’(:foo "Hello" :bar 2 :foo "World")
;; same as (setf (getf-all *plist* :foo) ’(3000))
(setf (getf-all *plist* :foo) 3000)
;; *plist* = ’(:foo 3000 :bar 2)
Changes the stored value(s) of the given ‘key‘. This removes or adds pairs as necessary to store the new list.
### [Macro] remf-all (plist key)
(remf-all *plist* :foo)
Removes a key and associated values for the given ‘key‘.
## Author
* Eitarow Fukamachi (e.arrows@gmail.com)
## Copyright
Copyright (c) 2012 Eitarow Fukamachi (e.arrows@gmail.com)
# License
Licensed under the LLGPL License.
0.1
multival-plist.asd (file)
src (module)
Modules are listed depth-first from the system components tree.
| • The multival-plist/src module: |
multival-plist (system)
src/
multival-plist.lisp (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
| • The multival-plist.asd file: | ||
| • The multival-plist/src/multival-plist.lisp file: |
Next: The multival-plist/src/multival-plist<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
multival-plist.asd
multival-plist (system)
Previous: The multival-plist<dot>asd file, Up: Lisp files [Contents][Index]
src (module)
src/multival-plist.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The multival-plist-asd package: | ||
| • The multival-plist package: |
Next: The multival-plist package, Previous: Packages, Up: Packages [Contents][Index]
multival-plist.asd
Previous: The multival-plist-asd package, Up: Packages [Contents][Index]
multival-plist.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: |
Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros: | ||
| • Exported functions: |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Removes a key and associated values for the given ‘key’.
multival-plist.lisp (file)
Previous: Exported macros, Up: Exported definitions [Contents][Index]
This is a version of ‘getf’ enabled to manage multiple keys. If the ‘plist’ has two or more pairs that they have given ‘key’ as a key, returns the values of each pairs as one list.
multival-plist.lisp (file)
(setf getf-all) (function)
Changes the stored value(s) of the given ‘key’. This removes or adds pairs as necessary to store the new list.
multival-plist.lisp (file)
getf-all (function)
Previous: Definitions, Up: Top [Contents][Index]
| • Concept index: | ||
| • Function index: | ||
| • Variable index: | ||
| • Data type index: |
Next: Function index, Previous: Indexes, Up: Indexes [Contents][Index]
| Jump to: | F L M |
|---|
| Jump to: | F L M |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | (
F G M R |
|---|
| Jump to: | (
F G M R |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | M P S |
|---|
| Jump to: | M P S |
|---|