Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the alexandria+ Reference Manual, version 1.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 03:15:19 2022 GMT+0.
| • Introduction | What alexandria+ is all about | |
| • Systems | The systems documentation | |
| • Files | The files documentation | |
| • Packages | The packages documentation | |
| • Definitions | The symbols documentation | |
| • Indexes | Concepts, functions, variables and data types |
We generally follow two of the three guiding principles of Alexandria:
Utilities, not extensions: Alexandria will not contain conceptual extensions to Common Lisp, instead limiting itself to tools and utilities that fit well within the framework of standard ANSI Common Lisp. Test-frameworks, system definitions, logging facilities, serialization layers, etc. are all outside the scope of Alexandria as a library, though well within the scope of Alexandria as a project.
Conservative: Alexandria limits itself to what project members consider conservative utilities. Alexandria does not and will not include anaphoric constructs, loop-like binding macros, etc.
~~Portable: Alexandria limits itself to portable parts of Common Lisp. Even apparently conservative and useful functions remain outside the scope of Alexandria if they cannot be implemented portably. Portability is here defined as portable within a conforming implementation: implementation bugs are not considered portability issues.~~
Manpower does not permit testing on all Lisp implementations, so we target Genera, SBCL and CCL.
An additional guiding principal is that we only add functionality that is not already available in UIOP, OSICAT or alexandria, but required for multiple projects that we work on.
Other utilities libraries include:
To get a local copy up and running follow these steps:
An ANSI Common Lisp implementation. Developed and tested with SBCL, Genera and CCL.
To make the system accessible to ASDF (a build facility, similar to make in the C world), clone the repository in a directory it knows about. By default the common-lisp directory in your home directory is known. Create this if it doesn't already exist and then:
cd ~/common-lisp/ &&
git clone https://github.com/Symbolics/alexandria-plus.git
(asdf:clear-source-registry)
(asdf:load-system :alexandria+)
The alexandria+ source code is organised the same as the alexandria source. For example the alist and plist utilities are in lists.lisp in both alexandria and alexandria+. It is intended to be used alongside alexandria, e.g. (:use :alexandria :alexandria+)
For more examples, please refer to the Documentation.
See the open issues for a list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated. Please see CONTRIBUTING.md for details on the code of conduct, and the process for submitting pull requests.
Distributed under the MS-PL License. See LICENSE for more information.
Project Link: https://github.com/Symbolics/alexandria-plus
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The alexandria+ system |
Steven Nunez <steve@symbolics.tech>
MS-PL
A conservative set of extensions to Alexandria utilities.
Utilities not in Alexandria, UIOP or OSICAT.
1.1
alexandria
alexandria+.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files |
| • The alexandria+.asd file | ||
| • The alexandria+/pkgdcl.lisp file | ||
| • The alexandria+/lists.lisp file | ||
| • The alexandria+/types.lisp file |
Next: The alexandria+/pkgdcl․lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
alexandria+.asd
alexandria+ (system)
Next: The alexandria+/lists․lisp file, Previous: The alexandria+․asd file, Up: Lisp files [Contents][Index]
alexandria+ (system)
pkgdcl.lisp
Next: The alexandria+/types․lisp file, Previous: The alexandria+/pkgdcl․lisp file, Up: Lisp files [Contents][Index]
alexandria+ (system)
lists.lisp
*assoc-test* (special variable)
Previous: The alexandria+/lists․lisp file, Up: Lisp files [Contents][Index]
alexandria+ (system)
types.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The alexandria+ package |
pkgdcl.lisp (file)
common-lisp
*assoc-test* (special variable)
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions | ||
| • Internal definitions |
Next: Internal definitions, Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported macros | ||
| • Exported functions | ||
| • Exported types |
Next: Exported functions, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Gives SYMBOL an INDICATOR property of VALUE.
After this is done (CL:GET symbol indicator) returns VALUE
lists.lisp (file)
Next: Exported types, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Returns a list of the keys in ALIST.
lists.lisp (file)
Returns a list of the values in ALIST.
lists.lisp (file)
Returns T if VALUE is an ALIST.
lists.lisp (file)
Return the value associated with ITEM in ALIST.
lists.lisp (file)
Returns VALUE if it is a properly formed PLIST, NIL otherwise.
lists.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
Type designator for ALIST. Implemented as a SATISFIES type, hence not recommended for performance intensive use. Main usefullness as a type designator of the expected type in a TYPE-ERROR.
lists.lisp (file)
A number between 0 and 100
types.lisp (file)
Type designator for PLIST. Implemented as a SATISFIES type, hence not recommended for performance intensive use. Main usefullness as a type designator of the expected type in a TYPE-ERROR.
lists.lisp (file)
A number between 0 and 1
types.lisp (file)
Previous: Exported definitions, Up: Definitions [Contents][Index]
| • Internal special variables |
Previous: Internal definitions, Up: Internal definitions [Contents][Index]
Global equality test for assoc
lists.lisp (file)
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: | A F L |
|---|
| Jump to: | A F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | A C D F M P |
|---|
| Jump to: | A C D F M P |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*assoc-test*: | Internal special variables | ||
| | |||
| S | |||
Special Variable, *assoc-test*: | Internal special variables | ||
| | |||
| Jump to: | *
S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | A P S T |
|---|
| Jump to: | A P S T |
|---|