The multival-plist Reference Manual

Table of Contents

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

The multival-plist Reference Manual

This is the multival-plist Reference Manual, version 0.1, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:20:48 2018 GMT+0.


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

1 Introduction

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

Copyright

Copyright (c) 2012 Eitarow Fukamachi (e.arrows@gmail.com)

License

Licensed under the LLGPL License.


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 multival-plist

Author

Eitarow Fukamachi

License

LLGPL

Description

Property List stores multiple values per one key.

Long Description

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

Version

0.1

Dependencies
Source

multival-plist.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 multival-plist/src

Parent

multival-plist (system)

Location

src/

Component

multival-plist.lisp (file)


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

4 Files

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


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

4.1 Lisp


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

4.1.1 multival-plist.asd

Location

multival-plist.asd

Systems

multival-plist (system)

Packages

multival-plist-asd


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

4.1.2 multival-plist/src/multival-plist.lisp

Parent

src (module)

Location

src/multival-plist.lisp

Packages

multival-plist

Exported Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 multival-plist-asd

Source

multival-plist.asd

Use List

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

5.2 multival-plist

Source

multival-plist.lisp (file)

Use List

common-lisp

Exported Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Macros

Macro: remf-all PLIST KEY

Removes a key and associated values for the given ‘key’.

Package

multival-plist

Source

multival-plist.lisp (file)


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

6.1.2 Functions

Function: getf-all PLIST KEY &optional DEFAULT

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.

Package

multival-plist

Source

multival-plist.lisp (file)

Writer

(setf getf-all) (function)

Function: (setf getf-all) VAL PLIST KEY &optional DEFAULT

Changes the stored value(s) of the given ‘key’. This removes or adds pairs as necessary to store the new list.

Package

multival-plist

Source

multival-plist.lisp (file)

Reader

getf-all (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, multival-plist.asd: The multival-plist<dot>asd file
File, Lisp, multival-plist/src/multival-plist.lisp: The multival-plist/src/multival-plist<dot>lisp file

L
Lisp File, multival-plist.asd: The multival-plist<dot>asd file
Lisp File, multival-plist/src/multival-plist.lisp: The multival-plist/src/multival-plist<dot>lisp file

M
Module, multival-plist/src: The multival-plist/src module
multival-plist.asd: The multival-plist<dot>asd file
multival-plist/src: The multival-plist/src module
multival-plist/src/multival-plist.lisp: The multival-plist/src/multival-plist<dot>lisp file

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   (  
F   G   M   R  
Index Entry  Section

(
(setf getf-all): Exported functions

F
Function, (setf getf-all): Exported functions
Function, getf-all: Exported functions

G
getf-all: Exported functions

M
Macro, remf-all: Exported macros

R
remf-all: Exported macros

Jump to:   (  
F   G   M   R  

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

A.3 Variables


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

A.4 Data types

Jump to:   M   P   S  
Index Entry  Section

M
multival-plist: The multival-plist system
multival-plist: The multival-plist package
multival-plist-asd: The multival-plist-asd package

P
Package, multival-plist: The multival-plist package
Package, multival-plist-asd: The multival-plist-asd package

S
System, multival-plist: The multival-plist system

Jump to:   M   P   S