.LISP File Format – Functions and variables

Evaluation, compilation and control

• Evaluation: eval, funcall, apply, identity, constantly, complement, values, values-list, function-lambda-expression, functionp, compiled-function-p, fboundp, fdefinition, fmakunbound, symbol-function, macro-function, compiler-macro-function, special-operator-p, macroexpand, macroexpand-1, constantp, proclaim.
• Compilation and loading: compile, compile-file, compile-file-pathname, load, disassemble, provide, require, make-load-form, make-load-form-saving-slots.
• Mapping and sequence of control: mapcar, mapc, maplist, mapl, mapcan, mapcon, map, map-into, maphash, not, eq, eql, equal, equalp.
• Evaluation environment: apropos, apropos-list, describe, describe-object, inspect, documentation, room, ed, dribble, sleep, get-internal-real-time, get-internal-run-time, get-universal-time, get-decoded-time, decode-universal-time, encode-universal-time, lisp-implementation-type, lisp-implementation-version, machine-instance, machine-type, machine-version, software-type, software-version, short-site-name, long-site-name, user-homedir-pathname.

Numbers

• Arithmetic: + - * / 1+ 1- abs signum max min mod rem floor ceiling truncate round ffloor fceiling ftruncate fround gcd lcm isqrt sqrt expt exp log numerator denominator rational rationalize.
• Comparison and tests: = /= < > <= >= zerop plusp minusp evenp oddp numberp integerp rationalp realp floatp complexp.
• Trigonometry: sin cos tan asin acos atan sinh cosh tanh asinh acosh atanh cis conjugate phase realpart imagpart complex.
• Floats: float decode-float integer-decode-float scale-float float-radix float-sign float-digits float-precision.
• Bits and bytes: ash logand logior logxor lognot logeqv lognand lognor logandc1 logandc2 logorc1 logorc2 logbitp logcount logtest integer-length boole (with the constants boole-and …) byte byte-size byte-position ldb ldb-test dpb mask-field deposit-field.
• Random: random, make-random-state, random-state-p, with *random-state*. Parsing: parse-integer.

Characters and strings

• Characters: char-code code-char char-int char-name name-char char-upcase char-downcase digit-char digit-char-p characterp alpha-char-p alphanumericp graphic-char-p standard-char-p upper-case-p lower-case-p both-case-p and the comparisons char= char/= char< char> char<= char>= char-equal char-not-equal char-lessp char-greaterp char-not-lessp char-not-greaterp.
• Strings: string make-string char schar stringp simple-string-p string= string/= string< string> string<= string>= string-equal string-not-equal string-lessp string-greaterp string-not-lessp string-not-greaterp string-upcase string-downcase string-capitalize nstring-upcase nstring-downcase nstring-capitalize string-trim string-left-trim string-right-trim. The rest of the string work (search, subseq, concatenate, replace, position) is by sequence functions.
• String streams: make-string-input-stream, make-string-output-stream, get-output-stream-string, with-output-to-string, with-input-from-string, read-from-string, write-to-string, prin1-to-string, princ-to-string.

Conses and lists

• Cells: cons car cdr rplaca rplacd consp atom listp null and the combinations caar to cddddr (28 functions); first to tenth rest nth nthcdr last butlast nbutlast ldiff tailp endp list list* make-list list-length append nconc revappend nreconc copy-list copy-alist copy-tree.
• Trees: subst subst-if subst-if-not nsubst nsubst-if nsubst-if-not sublis nsublis tree-equal.
• Association lists: assoc assoc-if assoc-if-not rassoc rassoc-if rassoc-if-not acons pairlis. Property lists: get getf get-properties remprop symbol-plist.
• Sets (lists as sets): member member-if member-if-not adjoin union nunion intersection nintersection set-difference nset-difference set-exclusive-or nset-exclusive-or subsetp.

Sequences

A sequence is a list or a vector. These work on both, with the keyword parameters :key (a function applied to each element before the test), :test and :test-not (the comparison, default eql), :start and :end (a range), :from-end (right to left) and :count.

• length elt subseq copy-seq fill replace reverse nreverse concatenate make-sequence coerce map reduce merge sort stable-sort search mismatch.
• Finding: find find-if find-if-not position position-if position-if-not count count-if count-if-not every some notany notevery.
• Changing: remove remove-if remove-if-not delete delete-if delete-if-not remove-duplicates delete-duplicates substitute substitute-if substitute-if-not nsubstitute nsubstitute-if nsubstitute-if-not. The ones with an n or delete may destroy their argument; use their result, not the original.

Arrays and hash tables

• Arrays: make-array adjust-array aref svref row-major-aref array-dimension array-dimensions array-rank array-total-size array-element-type array-displacement array-in-bounds-p array-row-major-index array-has-fill-pointer-p adjustable-array-p fill-pointer vector vector-push vector-push-extend vector-pop arrayp vectorp simple-vector-p upgraded-array-element-type; bit arrays: bit sbit bit-and bit-ior bit-xor bit-eqv bit-nand bit-nor bit-andc1 bit-andc2 bit-orc1 bit-orc2 bit-not bit-vector-p simple-bit-vector-p.
• Hash tables: make-hash-table (:test eq, eql, equal or equalp, :size, :rehash-size, :rehash-threshold) gethash (a place) remhash clrhash maphash hash-table-count hash-table-p hash-table-test hash-table-size hash-table-rehash-size hash-table-rehash-threshold sxhash and the macro with-hash-table-iterator.

Symbols, packages and structures

The symbol and package functions are on Symbols and packages. The symbol accessors are symbol-name, symbol-package, symbol-value, symbol-function, symbol-plist, boundp, makunbound, set, symbolp, keywordp. Structures (defstruct) define their own functions; the standard ones are copy-structure and the printer hook print-object. Readers of class and slot structure: see CLOS.

Files, pathnames and streams

• Pathnames: pathname make-pathname parse-namestring merge-pathnames namestring file-namestring directory-namestring host-namestring enough-namestring pathname-host pathname-device pathname-directory pathname-name pathname-type pathname-version pathname-match-p wild-pathname-p translate-pathname logical-pathname translate-logical-pathname logical-pathname-translations load-logical-pathname-translations pathnamep.
• Files: open close probe-file truename directory delete-file rename-file ensure-directories-exist file-author file-write-date file-length file-position file-string-length and the macro with-open-file.
• Streams: make-broadcast-stream make-concatenated-stream make-echo-stream make-synonym-stream make-two-way-stream and their accessors, streamp input-stream-p output-stream-p interactive-stream-p open-stream-p stream-element-type stream-external-format finish-output force-output clear-input clear-output listen.
• Reading characters and bytes: read-char read-char-no-hang unread-char peek-char read-line read-byte read-sequence; writing: write-char write-string write-line write-byte write-sequence terpri fresh-line y-or-n-p yes-or-no-p.

The printer and the reader

• Printer: write prin1 princ print pprint write-to-string prin1-to-string princ-to-string format print-object pprint-newline pprint-indent pprint-tab pprint-fill pprint-linear pprint-tabular pprint-dispatch set-pprint-dispatch copy-pprint-dispatch print-not-readable-object; the control variables are below.
• Reader: read read-preserving-whitespace read-delimited-list read-from-string readtable-case readtablep copy-readtable get-macro-character set-macro-character make-dispatch-macro-character get-dispatch-macro-character set-dispatch-macro-character set-syntax-from-char.

Special variables

The standard defines these special variables, most of them written with earmuffs (all coloured as variables by the viewer):

• Reader: *read-base* *read-default-float-format* *read-eval* *read-suppress* *readtable* *package* *features* *modules* *gensym-counter* *random-state*.
• Printer: *print-array* *print-base* *print-case* *print-circle* *print-escape* *print-gensym* *print-length* *print-level* *print-lines* *print-miser-width* *print-pprint-dispatch* *print-pretty* *print-radix* *print-readably* *print-right-margin*.
• Streams: *standard-input* *standard-output* *error-output* *terminal-io* *query-io* *debug-io* *trace-output*.
• Loading and compiling: *load-pathname* *load-truename* *load-print* *load-verbose* *compile-file-pathname* *compile-file-truename* *compile-print* *compile-verbose* *default-pathname-defaults*.
• Evaluation and debugging: *macroexpand-hook* *break-on-signals* *debugger-hook*.
• The REPL variables * ** *** (the last three values), + ++ +++ (the last three forms), / // /// (the last three lists of values) and - (the form being evaluated).

Constants

t, nil, pi (a long-float), the limits listed on Types and declarations, lambda-list-keywords and boole-1 to boole-xor (16 constants for boole).