The safe-read Reference Manual

This is the safe-read Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:49:36 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 safe-read

A variant of READ secure against internbombing, excessive input and macro characters.

Author

Michał "phoe" Herda <>

License

BSD 2-clause

Dependencies
  • local-time (system).
  • trivial-garbage (system).
Source

safe-read.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 safe-read/safe-read.asd

Source

safe-read.asd.

Parent Component

safe-read (system).

ASDF Systems

safe-read.


3.1.2 safe-read/package.lisp

Source

safe-read.asd.

Parent Component

safe-read (system).

Packages

safe-read.


3.1.3 safe-read/safe-read.lisp

Dependency

package.lisp (file).

Source

safe-read.asd.

Parent Component

safe-read (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 safe-read

Source

package.lisp.

Use List
  • common-lisp.
  • trivial-garbage.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *max-input-size*
Package

safe-read.

Source

safe-read.lisp.

Special Variable: *stream-buffers*
Package

safe-read.

Source

safe-read.lisp.


5.1.2 Macros

Macro: with-temp-package (&body body)
Package

safe-read.

Source

safe-read.lisp.


5.1.3 Ordinary functions

Function: buffer-of (stream)
Package

safe-read.

Source

safe-read.lisp.

Function: (setf buffer-of) (stream)
Package

safe-read.

Source

safe-read.lisp.

Function: safe-read (&optional stream use-list)
Package

safe-read.

Source

safe-read.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: %max-safe-char%
Package

safe-read.

Source

safe-read.lisp.

Special Variable: %safe-readtable%
Package

safe-read.

Source

safe-read.lisp.


5.2.2 Macros

Macro: safe-read-handler-case (&body body)
Package

safe-read.

Source

safe-read.lisp.


5.2.3 Ordinary functions

Function: condition-key (condition)
Package

safe-read.

Source

safe-read.lisp.

Function: read-limited-line (&optional stream buffer-length)
Package

safe-read.

Source

safe-read.lisp.

Function: safe-read-buffer (stream &optional use-list)
Package

safe-read.

Source

safe-read.lisp.

Function: safe-read-no-buffer (stream &optional use-list)
Package

safe-read.

Source

safe-read.lisp.

Function: trim-leading-whitespace (string)
Package

safe-read.

Source

safe-read.lisp.

Function: whitespace-p (char)
Package

safe-read.

Source

safe-read.lisp.


5.2.4 Conditions

Condition: incomplete-input
Package

safe-read.

Source

safe-read.lisp.

Direct superclasses

condition.

Condition: input-size-exceeded
Package

safe-read.

Source

safe-read.lisp.

Direct superclasses

error.

Condition: malformed-input
Package

safe-read.

Source

safe-read.lisp.

Direct superclasses

error.


Appendix A Indexes


A.1 Concepts