The ia-hash-table Reference Manual

Table of Contents

The ia-hash-table Reference Manual

This is the ia-hash-table Reference Manual, version 0.2.1, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:00:45 2018 GMT+0.

1 Introduction

IA-HASH-TABLE

Examples

CL-USER> (defvar ht (ia-hash-table:make-ia-hash-table))
HT
CL-USER> (setf (gethash "qwe" ht) 1)
1
CL-USER> (gethash :qwe ht)
1
T

(enable-ia-syntax)

(defparameter response (alist-ia-hash-table '(("name" . "John Smith")
                                              ("age" . 34)
                                              ("city" . "New York")
                                              ("account" . (("checking" . 36223)
                                                            ("saving" . 468300))))))

>> #Iresponse.name
"John Smith"

>> #Iresponse.account.saving
468300

>> #Iresponse.address
NIL

>> #Iresponse.address.state
The value NIL is not of type HASH-TABLE.

>> #Iresponse.address?.state
NIL

;; or even
(defparameter nil-response nil)

>> #Inil-response?.account.saving
NIL

2 Systems

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

2.1 ia-hash-table

Author

Ilya Khaprov <ilya.kharpov@publitechs.com>

License

MIT

Description

Main purpose is to be able to use strings as real keys but do gethash with symbols and vice versa.
Can be useful for things like http headers parsing (no more intern leaks), json apis with/without https://github.com/AccelerationNet/access. Only tested on SBCL. Expected to work on Allegro, CCL and LW.
Also provides nil safe dot syntax

Version

0.2.1

Dependencies

• alexandria
• split-sequence

Source

ia-hash-table.asd (file)

Component

src (module)

3 Modules

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

3.1 ia-hash-table/src

Parent

ia-hash-table (system)

Location

src/

Components

• package.lisp (file)
• ia-hash-table.lisp (file)
• reader.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 ia-hash-table.asd

Location

ia-hash-table.asd

Systems

ia-hash-table (system)

4.1.2 ia-hash-table/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

ia-hash-table

4.1.3 ia-hash-table/src/ia-hash-table.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/ia-hash-table.lisp

Exported Definitions

• alist-ia-hash-table (function)
• make-ia-hash-table (function)
• plist-ia-hash-table (function)
• string-equalp (function)
• string-sxhash (function)

Internal Definitions

• alist (type)
• deep-alist-ia-hash-table (function)
• list-is-alist (function)

4.1.4 ia-hash-table/src/reader.lisp

Dependency

ia-hash-table.lisp (file)

Parent

src (module)

Location

src/reader.lisp

Exported Definitions

• disable-ia-syntax (macro)
• enable-ia-syntax (macro)

Internal Definitions

• %disable-ia-syntax (function)
• %enable-ia-syntax (function)
• *previous-readtables* (special variable)
• gen-get-deep-hash (function)
• gen-get-deep-hash-nullables (function)
• gen-get-deep-hash-w/o-nullables (function)
• have-nullable-p (function)
• ia-syntax-reader (function)
• parse-key (function)
• process-?. (function)
• process-elt-key (function)
• safe-aref (function)

5 Packages

Packages are listed by definition order.

5.1 ia-hash-table

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• alist-ia-hash-table (function)
• disable-ia-syntax (macro)
• enable-ia-syntax (macro)
• make-ia-hash-table (function)
• plist-ia-hash-table (function)
• string-equalp (function)
• string-sxhash (function)

Internal Definitions

• %disable-ia-syntax (function)
• %enable-ia-syntax (function)
• *previous-readtables* (special variable)
• alist (type)
• deep-alist-ia-hash-table (function)
• gen-get-deep-hash (function)
• gen-get-deep-hash-nullables (function)
• gen-get-deep-hash-w/o-nullables (function)
• have-nullable-p (function)
• ia-syntax-reader (function)
• list-is-alist (function)
• parse-key (function)
• process-?. (function)
• process-elt-key (function)
• safe-aref (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Macros

Macro: disable-ia-syntax ()

Package

ia-hash-table

Source

reader.lisp (file)

Macro: enable-ia-syntax ()

Package

ia-hash-table

Source

reader.lisp (file)

6.1.2 Functions

Function: alist-ia-hash-table ALIST &rest HASH-TABLE-INITARGS

Adopted version of alexandria:alist-hash-table

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: make-ia-hash-table &rest OPTIONS

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: plist-ia-hash-table PLIST &rest HASH-TABLE-INITARGS

Adopted version of alexandria:plist-hash-table

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: string-equalp F1 F2

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: string-sxhash F

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *previous-readtables*

A stack which holds the previous readtables that have been pushed here by ENABLE-IA-SYNTAX.

Package

ia-hash-table

Source

reader.lisp (file)

6.2.2 Functions

Function: %disable-ia-syntax ()

Internal function used to restore previous readtable.

Package

ia-hash-table

Source

reader.lisp (file)

Function: %enable-ia-syntax ()

Package

ia-hash-table

Source

reader.lisp (file)

Function: deep-alist-ia-hash-table VALUE HASH-TABLE-INITARGS

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: gen-get-deep-hash HT KEYS

Package

ia-hash-table

Source

reader.lisp (file)

Function: gen-get-deep-hash-nullables HT KEYS

Package

ia-hash-table

Source

reader.lisp (file)

Function: gen-get-deep-hash-w/o-nullables HT KEYS

Package

ia-hash-table

Source

reader.lisp (file)

Function: have-nullable-p KEYS

Package

ia-hash-table

Source

reader.lisp (file)

Function: ia-syntax-reader STREAM CHAR ARG

Package

ia-hash-table

Source

reader.lisp (file)

Function: list-is-alist LIST

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Function: parse-key KEY

Package

ia-hash-table

Source

reader.lisp (file)

Function: process-?. KEYS

Package

ia-hash-table

Source

reader.lisp (file)

Function: process-elt-key KEY

Package

ia-hash-table

Source

reader.lisp (file)

Function: safe-aref VECTOR INDEX

Package

ia-hash-table

Source

reader.lisp (file)

6.2.3 Types

Type: alist ()

Package

ia-hash-table

Source

ia-hash-table.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types