The string-case Reference Manual

Table of Contents

The string-case Reference Manual

This is the string-case Reference Manual, version 0.0.2, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:53:29 2021 GMT+0.

1 Systems

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

1.1 string-case

Author

Paul Khuong

License

3-clause BSD

Description

string-case is a macro that generates specialised decision trees to dispatch on string equality

Version

0.0.2

Source

string-case.asd (file)

Component

string-case.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 string-case.asd

Location

string-case.asd

Systems

string-case (system)

2.1.2 string-case/string-case.lisp

Parent

string-case (system)

Location

string-case.lisp

Packages

string-case

Exported Definitions

string-case (macro)

Internal Definitions

• *input-string* (special variable)
• *no-match-form* (special variable)
• all-equal (function)
• emit-common-checks (function)
• emit-string-case (function)
• find-best-split (function)
• hash-table->list (function)
• iota (function)
• make-search-tree (function)
• numeric-char= (function)
• split (function)
• split-at (function)

3 Packages

Packages are listed by definition order.

3.1 string-case

Source

string-case.lisp (file)

Use List

• sb-vm
• sb-c
• common-lisp

Exported Definitions

string-case (macro)

Internal Definitions

• *input-string* (special variable)
• *no-match-form* (special variable)
• all-equal (function)
• emit-common-checks (function)
• emit-string-case (function)
• find-best-split (function)
• hash-table->list (function)
• iota (function)
• make-search-tree (function)
• numeric-char= (function)
• split (function)
• split-at (function)

4 Definitions

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

4.1 Exported definitions

4.1.1 Macros

Macro: string-case (STRING &key DEFAULT) &body CASES

(string-case (string &key default) case*)
case ::= string form*
| t form*
Where t is the default case.

Package

string-case

Source

string-case.lisp (file)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *input-string*

Symbol of the variable holding the input string

Package

string-case

Source

string-case.lisp (file)

Special Variable: *no-match-form*

Form to insert when no match is found.

Package

string-case

Source

string-case.lisp (file)

4.2.2 Functions

Function: all-equal LIST &key KEY TEST

Package

string-case

Source

string-case.lisp (file)

Function: emit-common-checks STRINGS TO-CHECK

Package

string-case

Source

string-case.lisp (file)

Function: emit-string-case CASES INPUT-VAR NO-MATCH

Package

string-case

Source

string-case.lisp (file)

Function: find-best-split STRINGS TO-CHECK

Iterate over all the indices left to check to find which index (and which character) to test for equality with, keeping the ones which result in the most balanced split.

Package

string-case

Source

string-case.lisp (file)

Function: hash-table->list TABLE &key KEEP-KEYS KEEP-VALUES

Saves the keys and/or values in table to a list. As with hash table iterating functions, there is no implicit ordering.

Package

string-case

Source

string-case.lisp (file)

Function: iota N

Package

string-case

Source

string-case.lisp (file)

Function: make-search-tree STRINGS BODIES TO-CHECK

Package

string-case

Source

string-case.lisp (file)

Function: numeric-char= X Y

Package

string-case

Source

string-case.lisp (file)

Function: split LIST &key TEST KEY

Splits input list into sublists of elements
whose elements are all such that (key element)
are all test.
It’s assumed that test and key form an equality class. (This is similar to groupBy)

Package

string-case

Source

string-case.lisp (file)

Function: split-at LIST N

Split list in k lists of n elements (or less for the last list)

Package

string-case

Source

string-case.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types