Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]
This is the com.google.base Reference Manual, version 1.4, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 11:37:43 2018 GMT+0.
| • Introduction: | What com.google.base 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 |
Universally useful Lisp code that lives in package com.google.base.
The intent is that the base package only contains code that's highly likely to
be useful in every Lisp application. Currently it contains:
a nicer version of DEFCONSTANT
a macro for generating simple PRINT-OBJECT methods
a MISSING-ARGUMENT function for use in DEFCLASS forms
functions for manipulating utf-8 strings stored as vectors of 8-bit octets
common compiler optimization settings
functions for extracting the prefix or suffix of a sequence
Lisp type definitions for common C integer types
Next: Files, Previous: Introduction, Up: Top [Contents][Index]
The main system appears first, followed by any subsystem dependency.
| • The com.google.base system: |
Robert Brown
New BSD license. See the copyright messages in individual files.
Universally useful Lisp code.
Code that should be useful for any Lisp application.
1.4
com.google.base.asd (file)
Files are sorted by type and then listed depth-first from the systems components trees.
| • Lisp files: |
Next: The com<dot>google<dot>base/package<dot>lisp file, Previous: Lisp files, Up: Lisp files [Contents][Index]
com.google.base.asd
com.google.base (system)
Next: The com<dot>google<dot>base/optimize<dot>lisp file, Previous: The com<dot>google<dot>base<dot>asd file, Up: Lisp files [Contents][Index]
com.google.base (system)
package.lisp
Next: The com<dot>google<dot>base/syntax<dot>lisp file, Previous: The com<dot>google<dot>base/package<dot>lisp file, Up: Lisp files [Contents][Index]
package.lisp (file)
com.google.base (system)
optimize.lisp
Next: The com<dot>google<dot>base/error<dot>lisp file, Previous: The com<dot>google<dot>base/optimize<dot>lisp file, Up: Lisp files [Contents][Index]
com.google.base (system)
syntax.lisp
Next: The com<dot>google<dot>base/type<dot>lisp file, Previous: The com<dot>google<dot>base/syntax<dot>lisp file, Up: Lisp files [Contents][Index]
com.google.base (system)
error.lisp
missing-argument (function)
Next: The com<dot>google<dot>base/octet<dot>lisp file, Previous: The com<dot>google<dot>base/error<dot>lisp file, Up: Lisp files [Contents][Index]
com.google.base (system)
type.lisp
Next: The com<dot>google<dot>base/sequence<dot>lisp file, Previous: The com<dot>google<dot>base/type<dot>lisp file, Up: Lisp files [Contents][Index]
com.google.base (system)
octet.lisp
Previous: The com<dot>google<dot>base/octet<dot>lisp file, Up: Lisp files [Contents][Index]
com.google.base (system)
sequence.lisp
Next: Definitions, Previous: Files, Up: Top [Contents][Index]
Packages are listed by definition order.
| • The com.google.base package: |
Basic code used by all applications. The code in BASE should be universally
useful, since most packages will import BASE symbols by including
(:USE #:COM.GOOGLE.BASE) in their DEFPACKAGE form.
package.lisp (file)
common-lisp
Definitions are sorted by export status, category, package, and then by lexicographic order.
| • Exported definitions: |
Previous: Definitions, Up: Definitions [Contents][Index]
| • Exported constants: | ||
| • Exported special variables: | ||
| • Exported macros: | ||
| • Exported functions: | ||
| • Exported types: |
Next: Exported special variables, Previous: Exported definitions, Up: Exported definitions [Contents][Index]
Largest valid vector index.
type.lisp (file)
Next: Exported macros, Previous: Exported constants, Up: Exported definitions [Contents][Index]
Compiler optimization settings that emphasize debugging over speed. Most code should use these settings.
optimize.lisp (file)
Compiler optimization settings that emphasize speed at the expense of debugging and run-time safety. Only low-level performance sensitive code that has been extensively tested should use these settings.
optimize.lisp (file)
Next: Exported functions, Previous: Exported special variables, Up: Exported definitions [Contents][Index]
Identical to CL:DEFCONSTANT except that the global constant variable NAME is bound to VALUE at compile time so it can be used in #. reader forms. Additionally, if the DEFCONST form is evaluated a second time, the constant is not rebound if the new value is EQUALP to the old. CL:DEFCONSTANT requires that the two values be EQL to avoid undefined behavior.
syntax.lisp (file)
Generates a CL:PRINT-OBJECT generic function for class CLASS-NAME using
ACCESSOR-INFO, a list containing elements of the form
(accessor initarg [format-string]).
If a format-string is not provided for a slot, then the generated PRINT-OBJECT
function outputs nothing for that slot when *PRINT-READABLY* is false.
Given a POINT class with slots X, Y, and HIDDEN. The following
DEFINE-PRINT-OBJECT form:
(define-print-object point
((x :x "x is ~D")
(y :y "y is ~D")
(hidden :hidden)))
expands to a PRINT-OBJECT function similar to:
(defmethod print-object ((point point) stream)
(if *print-readably*
(progn (write-string "#." stream)
(write ‘(make-instance ’point
:x ,(x point)
:y ,(y point)
:hidden ,(hidden point))
:stream stream))
(print-unreadable-object (point stream :type t :identity t)
(format stream "x is ~D y is ~D" (x point) (y point)))))
syntax.lisp (file)
Next: Exported types, Previous: Exported macros, Up: Exported definitions [Contents][Index]
Create an OCTET-VECTOR containing OCTET-COUNT octets. If INITIAL-CONTENTS is not supplied, each element of the vector is initialized to zero. Otherwise, the vector is initialized to the contents of list INITIAL-CONTENTS.
octet.lisp (file)
Signal an error indicating that an &OPTIONAL or &KEY argument is missing. Use (MISSING-ARGUMENT) as the default value of required &KEY function arguments and as the initform in DEFCLASS and DEFSTRUCT slot definition forms when the slot’s initform must always be supplied to MAKE-INSTANCE.
error.lisp (file)
octet.lisp (file)
Does PREFIX match a prefix of SEQUENCE?
sequence.lisp (file)
Convert STRING into an OCTET-VECTOR by UTF-8 encoding each character.
octet.lisp (file)
Does SUFFIX match a suffix of SEQUENCE?
sequence.lisp (file)
Convert OCTETS, a vector of UTF-8 encoded octets, into a string.
octet.lisp (file)
Previous: Exported functions, Up: Exported definitions [Contents][Index]
A signed 16-bit integer.
type.lisp (file)
A signed 32-bit integer.
type.lisp (file)
A signed 64-bit integer.
type.lisp (file)
A signed 8-bit integer.
type.lisp (file)
octet.lisp (file)
octet.lisp (file)
An unsigned 16-bit integer.
type.lisp (file)
An unsigned 32-bit integer.
type.lisp (file)
An unsigned 64-bit integer.
type.lisp (file)
An unsigned 8-bit integer.
type.lisp (file)
Integer that can be used as a subscript for accessing an array or vector element.
type.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: | C F L |
|---|
| Jump to: | C F L |
|---|
Next: Variable index, Previous: Concept index, Up: Indexes [Contents][Index]
| Jump to: | D F M O P S U |
|---|
| Jump to: | D F M O P S U |
|---|
Next: Data type index, Previous: Function index, Up: Indexes [Contents][Index]
| Jump to: | *
+
C S |
|---|
| Jump to: | *
+
C S |
|---|
Previous: Variable index, Up: Indexes [Contents][Index]
| Jump to: | C I O P S T U V |
|---|
| Jump to: | C I O P S T U V |
|---|