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

The core-reader Reference Manual

This is the core-reader Reference Manual, version 1.2.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Nov 06 13:02:13 2023 GMT+0.

Next: Systems, Previous: The core-reader Reference Manual, Up: The core-reader Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The core-reader Reference Manual [Contents][Index]

2 Systems

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

core-reader

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

2.1 `core-reader`

Utilities for stream oriented reader.

Author

SATO Shinichi

Source Control

(GIT git@github.com:hyotang666/core-reader)

Bug Tracker

https://github.com/hyotang666/core-reader/issues

License

MIT

Long Description

# CORE-READER 0.1.1
## What is this?
Utilities for stream oriented reader.

## Alternatives and differences.

[uiop/stream]: https://gitlab.common-lisp.net/asdf/asdf/-/blob/master/uiop/stream.lisp

## Usage
See spec file.
## From developer

### Product’s goal

### License
MIT
### Tested with
* SBCL/2.2.5
* CCL/1.12.1
* CLISP/2.49
* ECL/21.2.1
* Allegro/10.1
* CMUCL/21D
* ABCL/1.9.0

## Installation

Version

1.2.6

Dependency

uiop (system).

Source

core-reader.asd.

Child Component

core-reader.lisp (file).

Next: Packages, Previous: Systems, Up: The core-reader 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]

Next: core-reader/core-reader.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `core-reader/core-reader.asd`

Source: core-reader.asd.
Parent Component: core-reader (system).
ASDF Systems: core-reader.

Previous: core-reader/core-reader.asd, Up: Lisp [Contents][Index]

3.1.2 `core-reader/core-reader.lisp`

Source

core-reader.asd.

Parent Component

core-reader (system).

Packages

core-reader.

Public Interface

char-pred (compiler macro).
char-pred (function).
delimiter (function).
do-stream (macro).
do-stream-till (macro).
do-stream-till-suffix (macro).
read-delimited-string (function).
read-string-till (function).
string-concat (function).

Internals

call-with-do-stream-till-suffix (function).
function-designator (type).

Next: Definitions, Previous: Files, Up: The core-reader Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

core-reader

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

4.1 `core-reader`

Source

core-reader.lisp.

Use List

common-lisp.

Public Interface

char-pred (compiler macro).
char-pred (function).
delimiter (function).
do-stream (macro).
do-stream-till (macro).
do-stream-till-suffix (macro).
read-delimited-string (function).
read-string-till (function).
string-concat (function).

Internals

call-with-do-stream-till-suffix (function).
function-designator (type).

Next: Indexes, Previous: Packages, Up: The core-reader 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

Macros
Compiler macros
Ordinary functions

Next: Compiler macros, Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: do-stream ((var &optional stream eof-error-p eof-value) &body body) ¶

Package: core-reader.
Source: core-reader.lisp.

Macro: do-stream-till ((var pred &optional stream consume include) &body body) ¶

Package: core-reader.
Source: core-reader.lisp.

Macro: do-stream-till-suffix ((var suffix &key stream include) &body body) ¶

Package: core-reader.
Source: core-reader.lisp.

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

5.1.2 Compiler macros

Compiler Macro: char-pred (char &optional check) ¶

Package: core-reader.
Source: core-reader.lisp.

Previous: Compiler macros, Up: Public Interface [Contents][Index]

5.1.3 Ordinary functions

Function: char-pred (char &optional check) ¶

Package: core-reader.
Source: core-reader.lisp.

Function: delimiter (delimiters) ¶

Package: core-reader.
Source: core-reader.lisp.

Function: read-delimited-string (end-char &optional *standard-input* start-char) ¶

Package: core-reader.
Source: core-reader.lisp.

Function: read-string-till (pred &optional *standard-input* eof-error-p eof-value consume include) ¶

Package: core-reader.
Source: core-reader.lisp.

Function: string-concat (list) ¶

Package: core-reader.
Source: core-reader.lisp.

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

5.2 Internals

Ordinary functions
Types

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

5.2.1 Ordinary functions

Function: call-with-do-stream-till-suffix (suffix input thunk &key include) ¶

Package: core-reader.
Source: core-reader.lisp.

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

5.2.2 Types

Type: function-designator () ¶

Package: core-reader.
Source: core-reader.lisp.

Previous: Definitions, Up: The core-reader 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:	C D F M R S

	Index Entry	Section

C
	`call-with-do-stream-till-suffix`:	Private ordinary functions
	`char-pred`:	Public compiler macros
	`char-pred`:	Public ordinary functions
	`Compiler Macro, char-pred`:	Public compiler macros

D
	`delimiter`:	Public ordinary functions
	`do-stream`:	Public macros
	`do-stream-till`:	Public macros
	`do-stream-till-suffix`:	Public macros

F
	`Function, call-with-do-stream-till-suffix`:	Private ordinary functions
	`Function, char-pred`:	Public ordinary functions
	`Function, delimiter`:	Public ordinary functions
	`Function, read-delimited-string`:	Public ordinary functions
	`Function, read-string-till`:	Public ordinary functions
	`Function, string-concat`:	Public ordinary functions

M
	`Macro, do-stream`:	Public macros
	`Macro, do-stream-till`:	Public macros
	`Macro, do-stream-till-suffix`:	Public macros

R
	`read-delimited-string`:	Public ordinary functions
	`read-string-till`:	Public ordinary functions

S
	`string-concat`:	Public ordinary functions

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

A.3 Variables

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

A.4 Data types

Jump to:	C F P S T

	Index Entry	Section

C
	`core-reader`:	The core-reader system
	`core-reader`:	The core-reader package
	`core-reader.asd`:	The core-reader/core-reader․asd file
	`core-reader.lisp`:	The core-reader/core-reader․lisp file

F
	`File, core-reader.asd`:	The core-reader/core-reader․asd file
	`File, core-reader.lisp`:	The core-reader/core-reader․lisp file
	`function-designator`:	Private types

P
	`Package, core-reader`:	The core-reader package

S
	`System, core-reader`:	The core-reader system

T
	`Type, function-designator`:	Private types

The core-reader Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 core-reader

3 Files

3.1 Lisp

3.1.1 core-reader/core-reader.asd

3.1.2 core-reader/core-reader.lisp

4 Packages

4.1 core-reader

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.1.2 Compiler macros

5.1.3 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Types

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `core-reader`

3.1.1 `core-reader/core-reader.asd`

3.1.2 `core-reader/core-reader.lisp`

4.1 `core-reader`