The parsley Reference Manual

Table of Contents

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

The parsley Reference Manual

This is the parsley Reference Manual, version 0.1.0, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 15:28:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

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

This system is not yet available to be installed automatically with Quicklisp. To manually install using Quicklisp, clone this repository into your local-projects directory and issue the following in your REPL:

(ql:quickload :parsley)

License

Copyright © 2017 Michael Fiano michael.fiano@gmail.com.

Licensed under the MIT License.

A copy of the license is available here.


Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

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


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

2.1 parsley

Maintainer

Michael Fiano <michael.fiano@gmail.com>

Author

Michael Fiano <michael.fiano@gmail.com>

Home Page

https://github.com/mfiano/parsley

Source Control

(:git "git@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

This system is not yet available to be installed automatically with Quicklisp. To manually install using Quicklisp, clone this repository into your local-projects directory and issue the following in your REPL:

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

## License

Copyright © 2017 Michael Fiano <michael.fiano@gmail.com>.

Licensed under the MIT License.

A copy of the license is available [here](LICENSE).

Version

0.1.0

Dependencies
Source

parsley.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

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


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

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 parsley.asd

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/parsley-20171023-git/parsley.asd

Systems

parsley (system)


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 parsley/package.lisp

Parent

parsley (system)

Location

package.lisp

Packages

parsley


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 parsley/buffer.lisp

Dependency

package.lisp (file)

Parent

parsley (system)

Location

buffer.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.4 parsley/common.lisp

Dependency

buffer.lisp (file)

Parent

parsley (system)

Location

common.lisp

Exported Definitions

split-string (function)

Internal Definitions

Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.5 parsley/processors.lisp

Dependency

common.lisp (file)

Parent

parsley (system)

Location

processors.lisp

Exported Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.6 parsley/readers.lisp

Dependency

processors.lisp (file)

Parent

parsley (system)

Location

readers.lisp

Exported Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


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

4.1 parsley

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

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


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Special variables

Special Variable: *buffer*
Package

parsley

Source

buffer.lisp (file)


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Macros

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

parsley

Source

buffer.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

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)


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

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

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)


Previous: , Up: Internal definitions   [Contents][Index]

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


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

Appendix A Indexes


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

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  

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

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  

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

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  

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

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