The binary-parser Reference Manual

This is the binary-parser Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Tue Nov 15 04:17:44 2022 GMT+0.

1 Introduction

binary-parser

A toolset for parsing binary data formats.

Overview

Currently, this just defines some common readers for primitive binary data types. This project is of alpha status, and its API or scope may change drastically at any time.

Install

(ql:quickload :binary-parser)

License

Licensed under the MIT License.

2 Systems

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

binary-parser

2.1 `binary-parser`

A toolset for parsing binary data formats.

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://github.com/mfiano/binary-parser

License

MIT

Dependencies

babel (system).
bitio (system).
chipz (system).
fast-io (system).

Source

binary-parser.asd.

Child Components

package.lisp (file).
buffer.lisp (file).
common.lisp (file).
processors.lisp (file).
readers.lisp (file).

3 Files

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

Lisp

3.1.1 `binary-parser/binary-parser.asd`

Source: binary-parser.asd.
Parent Component: binary-parser (system).
ASDF Systems: binary-parser.

3.1.2 `binary-parser/package.lisp`

Source: binary-parser.asd.
Parent Component: binary-parser (system).
Packages: binary-parser.

3.1.3 `binary-parser/buffer.lisp`

Dependency

package.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

*buffer* (special variable).
buffer-bits (function).
buffer-bytes (function).
buffer-position (function).
buffer-sequence (function).
buffer-stream (function).
with-buffer-read (macro).

Internals

%bitio-read-sequence (function).
buffer (class).

3.1.4 `binary-parser/common.lisp`

Dependency

buffer.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

split-string (function).

Internals

%string-length (function).
%uncompress-octets (function).

3.1.5 `binary-parser/processors.lisp`

Dependency

common.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

uncompress-bzip2 (function).
uncompress-deflate (function).
uncompress-gzip (function).
uncompress-zlib (function).

3.1.6 `binary-parser/readers.lisp`

Dependency

processors.lisp (file).

Source

binary-parser.asd.

Parent Component

binary-parser (system).

Public Interface

octets= (function).
read-bits (function).
read-bytes (function).
read-int-be (function).
read-int-le (function).
read-string (function).
read-uint-be (function).
read-uint-le (function).

4 Packages

Packages are listed by definition order.

binary-parser

4.1 `binary-parser`

Source

package.lisp.

Use List

common-lisp.

Public Interface

*buffer* (special variable).
buffer-bits (function).
buffer-bytes (function).
buffer-position (function).
buffer-sequence (function).
buffer-stream (function).
octets= (function).
read-bits (function).
read-bytes (function).
read-int-be (function).
read-int-le (function).
read-string (function).
read-uint-be (function).
read-uint-le (function).
split-string (function).
uncompress-bzip2 (function).
uncompress-deflate (function).
uncompress-gzip (function).
uncompress-zlib (function).
with-buffer-read (macro).

Internals

%bitio-read-sequence (function).
%string-length (function).
%uncompress-octets (function).
buffer (class).

5 Definitions

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

Public Interface
Internals

5.1 Public Interface

Special variables
Macros
Ordinary functions

5.1.1 Special variables

Special Variable: *buffer* ¶

Package: binary-parser.
Source: buffer.lisp.

5.1.2 Macros

Macro: with-buffer-read ((&key sequence stream) &body body) ¶

Package: binary-parser.
Source: buffer.lisp.

5.1.3 Ordinary functions

Function: buffer-bits () ¶

Package: binary-parser.
Source: buffer.lisp.

Function: buffer-bytes () ¶

Package: binary-parser.
Source: buffer.lisp.

Function: buffer-position () ¶

Package: binary-parser.
Source: buffer.lisp.

Function: buffer-sequence () ¶

Package: binary-parser.
Source: buffer.lisp.

Function: buffer-stream () ¶

Package: binary-parser.
Source: buffer.lisp.

Function: octets= (octet-vector octet-list) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-bits (count &key processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-bytes (count &key bits-per-byte processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-int-be (byte-count &key bits-per-byte processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-int-le (byte-count &key bits-per-byte processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-string (&key bytes encoding processor null-terminated-p) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-uint-be (byte-count &key bits-per-byte processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: read-uint-le (byte-count &key bits-per-byte processor) ¶

Package: binary-parser.
Source: readers.lisp.

Function: split-string (string delimiter) ¶

Package: binary-parser.
Source: common.lisp.

Function: uncompress-bzip2 (octet-vector) ¶

Package: binary-parser.
Source: processors.lisp.

Function: uncompress-deflate (octet-vector) ¶

Package: binary-parser.
Source: processors.lisp.

Function: uncompress-gzip (octet-vector) ¶

Package: binary-parser.
Source: processors.lisp.

Function: uncompress-zlib (octet-vector) ¶

Package: binary-parser.
Source: processors.lisp.

5.2 Internals

Ordinary functions
Classes

5.2.1 Ordinary functions

Function: %bitio-read-sequence (sequence buffer &key start end) ¶

Package: binary-parser.
Source: buffer.lisp.

Function: %string-length (bytes null-terminated-p) ¶

Package: binary-parser.
Source: common.lisp.

Function: %uncompress-octets (octet-vector compression-scheme) ¶

Package: binary-parser.
Source: common.lisp.

5.2.2 Classes

Class: buffer ¶

Package

binary-parser.

Source

buffer.lisp.

Direct slots

Slot: %bytes ¶

Initargs: :bytes

Slot: %bits ¶

Initargs: :bits

Slot: %sequence ¶

Initargs: :sequence

Slot: %stream ¶

Initargs: :stream

Appendix A Indexes

Concepts
Functions
Variables
Data types

A.1 Concepts

A.2 Functions

Jump to:	% B F M O R S U W

	Index Entry	Section

%
	`%bitio-read-sequence`:	Private ordinary functions
	`%string-length`:	Private ordinary functions
	`%uncompress-octets`:	Private ordinary functions

B
	`buffer-bits`:	Public ordinary functions
	`buffer-bytes`:	Public ordinary functions
	`buffer-position`:	Public ordinary functions
	`buffer-sequence`:	Public ordinary functions
	`buffer-stream`:	Public ordinary functions

F
	`Function, %bitio-read-sequence`:	Private ordinary functions
	`Function, %string-length`:	Private ordinary functions
	`Function, %uncompress-octets`:	Private ordinary functions
	`Function, buffer-bits`:	Public ordinary functions
	`Function, buffer-bytes`:	Public ordinary functions
	`Function, buffer-position`:	Public ordinary functions
	`Function, buffer-sequence`:	Public ordinary functions
	`Function, buffer-stream`:	Public ordinary functions
	`Function, octets=`:	Public ordinary functions
	`Function, read-bits`:	Public ordinary functions
	`Function, read-bytes`:	Public ordinary functions
	`Function, read-int-be`:	Public ordinary functions
	`Function, read-int-le`:	Public ordinary functions
	`Function, read-string`:	Public ordinary functions
	`Function, read-uint-be`:	Public ordinary functions
	`Function, read-uint-le`:	Public ordinary functions
	`Function, split-string`:	Public ordinary functions
	`Function, uncompress-bzip2`:	Public ordinary functions
	`Function, uncompress-deflate`:	Public ordinary functions
	`Function, uncompress-gzip`:	Public ordinary functions
	`Function, uncompress-zlib`:	Public ordinary functions

M
	`Macro, with-buffer-read`:	Public macros

O
	`octets=`:	Public ordinary functions

R
	`read-bits`:	Public ordinary functions
	`read-bytes`:	Public ordinary functions
	`read-int-be`:	Public ordinary functions
	`read-int-le`:	Public ordinary functions
	`read-string`:	Public ordinary functions
	`read-uint-be`:	Public ordinary functions
	`read-uint-le`:	Public ordinary functions

S
	`split-string`:	Public ordinary functions

U
	`uncompress-bzip2`:	Public ordinary functions
	`uncompress-deflate`:	Public ordinary functions
	`uncompress-gzip`:	Public ordinary functions
	`uncompress-zlib`:	Public ordinary functions

W
	`with-buffer-read`:	Public macros

Jump to:	% B F M O R S U W

A.3 Variables

Jump to:	% * S

	Index Entry	Section

%
	`%bits`:	Private classes
	`%bytes`:	Private classes
	`%sequence`:	Private classes
	`%stream`:	Private classes

*
	`buffer`:	Public special variables

S
	`Slot, %bits`:	Private classes
	`Slot, %bytes`:	Private classes
	`Slot, %sequence`:	Private classes
	`Slot, %stream`:	Private classes
	`Special Variable, buffer`:	Public special variables

Jump to:	% * S

A.4 Data types

Jump to:	B C F P R S

	Index Entry	Section

B
	`binary-parser`:	The binary-parser system
	`binary-parser`:	The binary-parser package
	`binary-parser.asd`:	The binary-parser/binary-parser․asd file
	`buffer`:	Private classes
	`buffer.lisp`:	The binary-parser/buffer․lisp file

C
	`Class, buffer`:	Private classes
	`common.lisp`:	The binary-parser/common․lisp file

F
	`File, binary-parser.asd`:	The binary-parser/binary-parser․asd file
	`File, buffer.lisp`:	The binary-parser/buffer․lisp file
	`File, common.lisp`:	The binary-parser/common․lisp file
	`File, package.lisp`:	The binary-parser/package․lisp file
	`File, processors.lisp`:	The binary-parser/processors․lisp file
	`File, readers.lisp`:	The binary-parser/readers․lisp file

P
	`Package, binary-parser`:	The binary-parser package
	`package.lisp`:	The binary-parser/package․lisp file
	`processors.lisp`:	The binary-parser/processors․lisp file

R
	`readers.lisp`:	The binary-parser/readers․lisp file

S
	`System, binary-parser`:	The binary-parser system

Jump to:	B C F P R S

The binary-parser Reference Manual

The binary-parser Reference Manual

Table of Contents

1 Introduction

binary-parser

Overview

Install

License

2 Systems

2.1 binary-parser

3 Files

3.1 Lisp

3.1.1 binary-parser/binary-parser.asd

3.1.2 binary-parser/package.lisp

3.1.3 binary-parser/buffer.lisp

3.1.4 binary-parser/common.lisp

3.1.5 binary-parser/processors.lisp

3.1.6 binary-parser/readers.lisp

4 Packages

4.1 binary-parser

5 Definitions

5.1 Public Interface

5.1.1 Special variables

5.1.2 Macros

5.1.3 Ordinary functions

5.2 Internals

5.2.1 Ordinary functions

5.2.2 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `binary-parser`

3.1.1 `binary-parser/binary-parser.asd`

3.1.2 `binary-parser/package.lisp`

3.1.3 `binary-parser/buffer.lisp`

3.1.4 `binary-parser/common.lisp`

3.1.5 `binary-parser/processors.lisp`

3.1.6 `binary-parser/readers.lisp`

4.1 `binary-parser`