Next: Introduction, Previous: (dir), Up: (dir) [Contents][Index]

The safe-read Reference Manual

This is the safe-read Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:49:52 2024 GMT+0.

Table of Contents

Next: Systems, Previous: The safe-read Reference Manual, Up: The safe-read Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The safe-read Reference Manual [Contents][Index]

2 Systems

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

safe-read

Previous: Systems, Up: Systems [Contents][Index]

2.1 `safe-read`

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

Author

Michał "phoe" Herda <phoe@disroot.org>

License

BSD 2-clause

Dependencies

local-time (system).
trivial-garbage (system).

Source

safe-read.asd.

Child Components

package.lisp (file).
safe-read.lisp (file).

Next: Packages, Previous: Systems, Up: The safe-read Reference Manual [Contents][Index]

3 Files

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

Lisp

Previous: Files, Up: Files [Contents][Index]

3.1 Lisp

safe-read/safe-read.asd
safe-read/package.lisp
safe-read/safe-read.lisp

Next: safe-read/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `safe-read/safe-read.asd`

Source: safe-read.asd.
Parent Component: safe-read (system).
ASDF Systems: safe-read.

Next: safe-read/safe-read.lisp, Previous: safe-read/safe-read.asd, Up: Lisp [Contents][Index]

3.1.2 `safe-read/package.lisp`

Source: safe-read.asd.
Parent Component: safe-read (system).
Packages: safe-read.

Previous: safe-read/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `safe-read/safe-read.lisp`

Dependency

package.lisp (file).

Source

safe-read.asd.

Parent Component

safe-read (system).

Public Interface

*max-input-size* (special variable).
*stream-buffers* (special variable).
buffer-of (function).
(setf buffer-of) (function).
safe-read (function).
with-temp-package (macro).

Internals

%max-safe-char% (special variable).
%safe-readtable% (special variable).
condition-key (function).
incomplete-input (condition).
input-size-exceeded (condition).
malformed-input (condition).
read-limited-line (function).
safe-read-buffer (function).
safe-read-handler-case (macro).
safe-read-no-buffer (function).
trim-leading-whitespace (function).
whitespace-p (function).

Next: Definitions, Previous: Files, Up: The safe-read Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

safe-read

Previous: Packages, Up: Packages [Contents][Index]

4.1 `safe-read`

Source

package.lisp.

Use List

common-lisp.
trivial-garbage.

Public Interface

*max-input-size* (special variable).
*stream-buffers* (special variable).
buffer-of (function).
(setf buffer-of) (function).
safe-read (function).
with-temp-package (macro).

Internals

%max-safe-char% (special variable).
%safe-readtable% (special variable).
condition-key (function).
incomplete-input (condition).
input-size-exceeded (condition).
malformed-input (condition).
read-limited-line (function).
safe-read-buffer (function).
safe-read-handler-case (macro).
safe-read-no-buffer (function).
trim-leading-whitespace (function).
whitespace-p (function).

Next: Indexes, Previous: Packages, Up: The safe-read Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

Next: Internals, Previous: Definitions, Up: Definitions [Contents][Index]

5.1 Public Interface

Special variables
Macros
Ordinary functions

Next: Macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

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.

Next: Ordinary functions, Previous: Special variables, Up: Public Interface [Contents][Index]

5.1.2 Macros

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

Package: safe-read.
Source: safe-read.lisp.

Previous: Macros, Up: Public Interface [Contents][Index]

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.

Previous: Public Interface, Up: Definitions [Contents][Index]

5.2 Internals

Special variables
Macros
Ordinary functions
Conditions

Next: Macros, Previous: Internals, Up: Internals [Contents][Index]

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.

Next: Ordinary functions, Previous: Special variables, Up: Internals [Contents][Index]

5.2.2 Macros

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

Package: safe-read.
Source: safe-read.lisp.

Next: Conditions, Previous: Macros, Up: Internals [Contents][Index]

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.

Previous: Ordinary functions, Up: Internals [Contents][Index]

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.

Previous: Definitions, Up: The safe-read Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

Next: Functions, Previous: Indexes, Up: Indexes [Contents][Index]

A.1 Concepts

Next: Variables, Previous: Concepts, Up: Indexes [Contents][Index]

A.2 Functions

Jump to:	( B C F M R S T W

	Index Entry		Section

(
	`(setf buffer-of)`:		Public ordinary functions

B
	`buffer-of`:		Public ordinary functions

C
	`condition-key`:		Private ordinary functions

F
	`Function, (setf buffer-of)`:		Public ordinary functions
	`Function, buffer-of`:		Public ordinary functions
	`Function, condition-key`:		Private ordinary functions
	`Function, read-limited-line`:		Private ordinary functions
	`Function, safe-read`:		Public ordinary functions
	`Function, safe-read-buffer`:		Private ordinary functions
	`Function, safe-read-no-buffer`:		Private ordinary functions
	`Function, trim-leading-whitespace`:		Private ordinary functions
	`Function, whitespace-p`:		Private ordinary functions

M
	`Macro, safe-read-handler-case`:		Private macros
	`Macro, with-temp-package`:		Public macros

R
	`read-limited-line`:		Private ordinary functions

S
	`safe-read`:		Public ordinary functions
	`safe-read-buffer`:		Private ordinary functions
	`safe-read-handler-case`:		Private macros
	`safe-read-no-buffer`:		Private ordinary functions

T
	`trim-leading-whitespace`:		Private ordinary functions

W
	`whitespace-p`:		Private ordinary functions
	`with-temp-package`:		Public macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

Jump to:	% * S

	Index Entry		Section

%
	`%max-safe-char%`:		Private special variables
	`%safe-readtable%`:		Private special variables

*
	`max-input-size`:		Public special variables
	`stream-buffers`:		Public special variables

S
	`Special Variable, %max-safe-char%`:		Private special variables
	`Special Variable, %safe-readtable%`:		Private special variables
	`Special Variable, max-input-size`:		Public special variables
	`Special Variable, stream-buffers`:		Public special variables

Previous: Variables, Up: Indexes [Contents][Index]

A.4 Data types

Jump to:	C F I M P S

	Index Entry		Section

C
	`Condition, incomplete-input`:		Private conditions
	`Condition, input-size-exceeded`:		Private conditions
	`Condition, malformed-input`:		Private conditions

F
	`File, package.lisp`:		The safe-read/package․lisp file
	`File, safe-read.asd`:		The safe-read/safe-read․asd file
	`File, safe-read.lisp`:		The safe-read/safe-read․lisp file

I
	`incomplete-input`:		Private conditions
	`input-size-exceeded`:		Private conditions

M
	`malformed-input`:		Private conditions

P
	`Package, safe-read`:		The safe-read package
	`package.lisp`:		The safe-read/package․lisp file

S
	`safe-read`:		The safe-read system
	`safe-read`:		The safe-read package
	`safe-read.asd`:		The safe-read/safe-read․asd file
	`safe-read.lisp`:		The safe-read/safe-read․lisp file
	`System, safe-read`:		The safe-read system