The parsley Reference Manual

Table of Contents

The parsley Reference Manual

This is the parsley Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Apr 28 12:39:18 2020 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

Copyright © 2017-2018 Michael Fiano.

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.

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

A.2 Functions

A.3 Variables

A.4 Data types