The parsley Reference Manual

This is the parsley Reference Manual, version 0.1.0, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:22:51 2018 GMT+0.

1 Introduction

parsley

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 :parsley)

License

Licensed under the MIT License.

2 Systems

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

2.1 `parsley`

Maintainer

Michael Fiano <mail@michaelfiano.com>

Author

Michael Fiano <mail@michaelfiano.com>

Home Page

https://www.michaelfiano.com/projects/parsley

Source Control

(:git "https://github.com/mfiano/parsley.git")

Bug Tracker

https://github.com/mfiano/parsley/issues

License

MIT

Description

A toolset for parsing binary data formats.

Long Description

# parsley

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

“‘lisp
(ql:quickload :parsley)
“‘

## License

Licensed under the MIT License.

Version

0.1.0

Dependencies

fast-io
bitio
chipz
babel

Source

parsley.asd (file)

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.

3.1 Lisp

3.1.1 `parsley.asd`

Location: /home/quickref/quicklisp/dists/quicklisp/software/parsley-20180430-git/parsley.asd
Systems: parsley (system)

3.1.2 `parsley/package.lisp`

Parent: parsley (system)
Location: package.lisp
Packages: parsley

3.1.3 `parsley/buffer.lisp`

Dependency

package.lisp (file)

Parent

parsley (system)

Location

buffer.lisp

Exported Definitions

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

Internal Definitions

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

3.1.4 `parsley/common.lisp`

Dependency

buffer.lisp (file)

Parent

parsley (system)

Location

common.lisp

Exported Definitions

split-string (function)

Internal Definitions

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

3.1.5 `parsley/processors.lisp`

Dependency

common.lisp (file)

Parent

parsley (system)

Location

processors.lisp

Exported Definitions

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

3.1.6 `parsley/readers.lisp`

Dependency

processors.lisp (file)

Parent

parsley (system)

Location

readers.lisp

Exported Definitions

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.

4.1 `parsley`

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

*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)

Internal Definitions

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

5.1 Exported definitions

5.1.1 Special variables

Special Variable: *buffer*

Package: parsley
Source: buffer.lisp (file)

5.1.2 Macros

Macro: with-buffer-read (&key SEQUENCE STREAM) &body BODY

Package: parsley
Source: buffer.lisp (file)

5.1.3 Functions

Function: buffer-bits ()

Package: parsley
Source: buffer.lisp (file)

Function: buffer-bytes ()

Package: parsley
Source: buffer.lisp (file)

Function: buffer-position ()

Package: parsley
Source: buffer.lisp (file)

Function: buffer-sequence ()

Package: parsley
Source: buffer.lisp (file)

Function: buffer-stream ()

Package: parsley
Source: buffer.lisp (file)

Function: octets= OCTET-VECTOR OCTET-LIST

Package: parsley
Source: readers.lisp (file)

Function: read-bits COUNT &key PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: read-bytes COUNT &key BITS-PER-BYTE PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: read-int-be BYTE-COUNT &key BITS-PER-BYTE PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: read-int-le BYTE-COUNT &key BITS-PER-BYTE PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: read-string &key BYTES ENCODING PROCESSOR NULL-TERMINATED-P

Package: parsley
Source: readers.lisp (file)

Function: read-uint-be BYTE-COUNT &key BITS-PER-BYTE PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: read-uint-le BYTE-COUNT &key BITS-PER-BYTE PROCESSOR

Package: parsley
Source: readers.lisp (file)

Function: split-string STRING DELIMITER

Package: parsley
Source: common.lisp (file)

Function: uncompress-bzip2 OCTET-VECTOR

Package: parsley
Source: processors.lisp (file)

Function: uncompress-deflate OCTET-VECTOR

Package: parsley
Source: processors.lisp (file)

Function: uncompress-gzip OCTET-VECTOR

Package: parsley
Source: processors.lisp (file)

Function: uncompress-zlib OCTET-VECTOR

Package: parsley
Source: processors.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: %bitio-read-sequence SEQUENCE BUFFER &key START END

Package: parsley
Source: buffer.lisp (file)

Function: %string-length BYTES NULL-TERMINATED-P

Package: parsley
Source: common.lisp (file)

Function: %uncompress-octets OCTET-VECTOR COMPRESSION-SCHEME

Package: parsley
Source: common.lisp (file)

5.2.2 Classes

Class: buffer ()

Package

parsley

Source

buffer.lisp (file)

Direct superclasses

standard-object (class)

Direct slots

Slot: bytes

Initargs: :bytes

Slot: bits

Initargs: :bits

Slot: sequence

Initargs: :sequence

Slot: stream

Initargs: :stream

Appendix A Indexes

A.1 Concepts

Jump to:	F L P

	Index Entry	Section

F
	File, Lisp, `parsley.asd`:	The parsley<dot>asd file
	File, Lisp, `parsley/buffer.lisp`:	The parsley/buffer<dot>lisp file
	File, Lisp, `parsley/common.lisp`:	The parsley/common<dot>lisp file
	File, Lisp, `parsley/package.lisp`:	The parsley/package<dot>lisp file
	File, Lisp, `parsley/processors.lisp`:	The parsley/processors<dot>lisp file
	File, Lisp, `parsley/readers.lisp`:	The parsley/readers<dot>lisp file

L
	Lisp File, `parsley.asd`:	The parsley<dot>asd file
	Lisp File, `parsley/buffer.lisp`:	The parsley/buffer<dot>lisp file
	Lisp File, `parsley/common.lisp`:	The parsley/common<dot>lisp file
	Lisp File, `parsley/package.lisp`:	The parsley/package<dot>lisp file
	Lisp File, `parsley/processors.lisp`:	The parsley/processors<dot>lisp file
	Lisp File, `parsley/readers.lisp`:	The parsley/readers<dot>lisp file

P
	`parsley.asd`:	The parsley<dot>asd file
	`parsley/buffer.lisp`:	The parsley/buffer<dot>lisp file
	`parsley/common.lisp`:	The parsley/common<dot>lisp file
	`parsley/package.lisp`:	The parsley/package<dot>lisp file
	`parsley/processors.lisp`:	The parsley/processors<dot>lisp file
	`parsley/readers.lisp`:	The parsley/readers<dot>lisp file

Jump to:	F L P

A.2 Functions

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

	Index Entry	Section

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

B
	`buffer-bits`:	Exported functions
	`buffer-bytes`:	Exported functions
	`buffer-position`:	Exported functions
	`buffer-sequence`:	Exported functions
	`buffer-stream`:	Exported functions

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

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

O
	`octets=`:	Exported functions

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

S
	`split-string`:	Exported functions

U
	`uncompress-bzip2`:	Exported functions
	`uncompress-deflate`:	Exported functions
	`uncompress-gzip`:	Exported functions
	`uncompress-zlib`:	Exported functions

W
	`with-buffer-read`:	Exported macros

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

A.3 Variables

Jump to:	* B S

	Index Entry	Section

*
	`buffer`:	Exported special variables

B
	`bits`:	Internal classes
	`bytes`:	Internal classes

S
	`sequence`:	Internal classes
	`Slot, bits`:	Internal classes
	`Slot, bytes`:	Internal classes
	`Slot, sequence`:	Internal classes
	`Slot, stream`:	Internal classes
	`Special Variable, buffer`:	Exported special variables
	`stream`:	Internal classes

Jump to:	* B S

A.4 Data types

Jump to:	B C P S

	Index Entry	Section

B
	`buffer`:	Internal classes

C
	`Class, buffer`:	Internal classes

P
	`Package, parsley`:	The parsley package
	`parsley`:	The parsley system
	`parsley`:	The parsley package

S
	`System, parsley`:	The parsley system

Jump to:	B C P S

• Introduction:		What parsley is all about
• Systems:		The systems documentation
• Files:		The files documentation
• Packages:		The packages documentation
• Definitions:		The symbols documentation
• Indexes:		Concepts, functions, variables and data types

• The parsley.asd file:
• The parsley/package.lisp file:
• The parsley/buffer.lisp file:
• The parsley/common.lisp file:
• The parsley/processors.lisp file:
• The parsley/readers.lisp file:

• Concept index:
• Function index:
• Variable index:
• Data type index:

• Exported special variables:
• Exported macros:
• Exported functions:

The parsley Reference Manual

Table of Contents

The parsley Reference Manual

1 Introduction

parsley

Overview

Install

License

2 Systems

2.1 parsley

3 Files

3.1 Lisp

3.1.1 parsley.asd

3.1.2 parsley/package.lisp

3.1.3 parsley/buffer.lisp

3.1.4 parsley/common.lisp

3.1.5 parsley/processors.lisp

3.1.6 parsley/readers.lisp

4 Packages

4.1 parsley

5 Definitions

5.1 Exported definitions

5.1.1 Special variables

5.1.2 Macros

5.1.3 Functions

5.2 Internal definitions

5.2.1 Functions

5.2.2 Classes

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `parsley`

3.1.1 `parsley.asd`

3.1.2 `parsley/package.lisp`

3.1.3 `parsley/buffer.lisp`

3.1.4 `parsley/common.lisp`

3.1.5 `parsley/processors.lisp`

3.1.6 `parsley/readers.lisp`

4.1 `parsley`