The com.google.base Reference Manual

Table of Contents

The com.google.base Reference Manual

This is the com.google.base Reference Manual, version 1.4, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 13:09:37 2020 GMT+0.

1 Introduction

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

2 Systems

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

2.1 com.google.base

Author

Robert Brown <robert.brown@gmail.com>

License

New BSD license. See the copyright messages in individual files.

Description

Universally useful Lisp code.

Long Description

Code that should be useful for any Lisp application.

Version

1.4

Source

com.google.base.asd (file)

Components

• package.lisp (file)
• optimize.lisp (file)
• syntax.lisp (file)
• error.lisp (file)
• type.lisp (file)
• octet.lisp (file)
• sequence.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 com.google.base.asd

Location

com.google.base.asd

Systems

com.google.base (system)

3.1.2 com.google.base/package.lisp

Parent

com.google.base (system)

Location

package.lisp

Packages

com.google.base

3.1.3 com.google.base/optimize.lisp

Dependency

package.lisp (file)

Parent

com.google.base (system)

Location

optimize.lisp

Exported Definitions

• *optimize-default* (special variable)
• *optimize-fast-unsafe* (special variable)

3.1.4 com.google.base/syntax.lisp

Dependencies

• package.lisp (file)
• optimize.lisp (file)

Parent

com.google.base (system)

Location

syntax.lisp

Exported Definitions

• defconst (macro)
• define-print-object (macro)

3.1.5 com.google.base/error.lisp

Dependencies

• package.lisp (file)
• optimize.lisp (file)

Parent

com.google.base (system)

Location

error.lisp

Exported Definitions

missing-argument (function)

3.1.6 com.google.base/type.lisp

Dependencies

• package.lisp (file)
• optimize.lisp (file)
• syntax.lisp (file)

Parent

com.google.base (system)

Location

type.lisp

Exported Definitions

• +maximum-vector-index+ (constant)
• int16 (type)
• int32 (type)
• int64 (type)
• int8 (type)
• uint16 (type)
• uint32 (type)
• uint64 (type)
• uint8 (type)
• vector-index (type)

3.1.7 com.google.base/octet.lisp

Dependencies

• package.lisp (file)
• optimize.lisp (file)
• type.lisp (file)

Parent

com.google.base (system)

Location

octet.lisp

Exported Definitions

• make-octet-vector (function)
• octet (type)
• octet-vector (function)
• octet-vector (type)
• string-to-utf8-octets (function)
• utf8-octets-to-string (function)

3.1.8 com.google.base/sequence.lisp

Dependencies

• package.lisp (file)
• optimize.lisp (file)

Parent

com.google.base (system)

Location

sequence.lisp

Exported Definitions

• prefixp (function)
• suffixp (function)

4 Packages

Packages are listed by definition order.

4.1 com.google.base

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.

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• *optimize-default* (special variable)
• *optimize-fast-unsafe* (special variable)
• +maximum-vector-index+ (constant)
• defconst (macro)
• define-print-object (macro)
• int16 (type)
• int32 (type)
• int64 (type)
• int8 (type)
• make-octet-vector (function)
• missing-argument (function)
• octet (type)
• octet-vector (function)
• octet-vector (type)
• prefixp (function)
• string-to-utf8-octets (function)
• suffixp (function)
• uint16 (type)
• uint32 (type)
• uint64 (type)
• uint8 (type)
• utf8-octets-to-string (function)
• vector-index (type)

5 Definitions

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

5.1 Exported definitions

5.1.1 Constants

Constant: +maximum-vector-index+

Largest valid vector index.

Package

com.google.base

Source

type.lisp (file)

5.1.2 Special variables

Special Variable: *optimize-default*

Compiler optimization settings that emphasize debugging over speed. Most code should use these settings.

Package

com.google.base

Source

optimize.lisp (file)

Special Variable: *optimize-fast-unsafe*

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.

Package

com.google.base

Source

optimize.lisp (file)

5.1.3 Macros

Macro: defconst NAME VALUE &optional DOCUMENTATION

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.

Package

com.google.base

Source

syntax.lisp (file)

Macro: define-print-object CLASS-NAME ACCESSOR-INFO

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)))))

Package

com.google.base

Source

syntax.lisp (file)

5.1.4 Functions

Function: make-octet-vector OCTET-COUNT &key INITIAL-CONTENTS

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.

Package

com.google.base

Source

octet.lisp (file)

Function: missing-argument ()

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.

Package

com.google.base

Source

error.lisp (file)

Function: octet-vector &rest OCTETS

Package

com.google.base

Source

octet.lisp (file)

Function: prefixp PREFIX SEQUENCE &key TEST

Does PREFIX match a prefix of SEQUENCE?

Package

com.google.base

Source

sequence.lisp (file)

Function: string-to-utf8-octets STRING &key START END

Convert STRING into an OCTET-VECTOR by UTF-8 encoding each character.

Package

com.google.base

Source

octet.lisp (file)

Function: suffixp SUFFIX SEQUENCE &key TEST

Does SUFFIX match a suffix of SEQUENCE?

Package

com.google.base

Source

sequence.lisp (file)

Function: utf8-octets-to-string OCTETS &key START END

Convert OCTETS, a vector of UTF-8 encoded octets, into a string.

Package

com.google.base

Source

octet.lisp (file)

5.1.5 Types

Type: int16 ()

A signed 16-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: int32 ()

A signed 32-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: int64 ()

A signed 64-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: int8 ()

A signed 8-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: octet ()

Package

com.google.base

Source

octet.lisp (file)

Type: octet-vector &optional LENGTH

Package

com.google.base

Source

octet.lisp (file)

Type: uint16 ()

An unsigned 16-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: uint32 ()

An unsigned 32-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: uint64 ()

An unsigned 64-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: uint8 ()

An unsigned 8-bit integer.

Package

com.google.base

Source

type.lisp (file)

Type: vector-index ()

Integer that can be used as a subscript for accessing an array or vector element.

Package

com.google.base

Source

type.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types