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 Sat Dec 03 21:09:25 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


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] | core-reader |
| —— | ————- | ———– |
| Orient | Line/S-Exp | Character |

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


3 Files

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


3.1 Lisp


3.1.1 core-reader/core-reader.asd

Source

core-reader.asd.

Parent Component

core-reader (system).

ASDF Systems

core-reader.


3.1.2 core-reader/core-reader.lisp

Source

core-reader.asd.

Parent Component

core-reader (system).

Packages

core-reader.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 core-reader

Source

core-reader.lisp.

Use List

common-lisp.

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


5.1.2 Compiler macros

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

core-reader.

Source

core-reader.lisp.


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.


5.2 Internals


5.2.1 Ordinary functions

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

core-reader.

Source

core-reader.lisp.


5.2.2 Types

Type: function-designator ()
Package

core-reader.

Source

core-reader.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables