This is the multival-plist Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 19:02:25 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
multival-plist
Property List stores multiple values per one key.
Eitarow Fukamachi
LLGPL
# 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
cl-annot
(system).
cl-syntax-annot
(system).
trivial-types
(system).
alexandria
(system).
src
(module).
Modules are listed depth-first from the system components tree.
multival-plist/src
multival-plist
(system).
multival-plist.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
multival-plist/multival-plist.asd
multival-plist
(system).
multival-plist/src/multival-plist.lisp
src
(module).
getf-all
(function).
(setf getf-all)
(function).
remf-all
(macro).
Packages are listed by definition order.
multival-plist
common-lisp
.
getf-all
(function).
(setf getf-all)
(function).
remf-all
(macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Removes a key and associated values for the given ‘key’.
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.
Changes the stored value(s) of the given ‘key’. This removes or adds pairs as necessary to store the new list.
Jump to: | (
F G M R |
---|
Jump to: | (
F G M R |
---|
Jump to: | F M P S |
---|
Jump to: | F M P S |
---|