The net.mfiano.lisp.parsley Reference Manual

Table of Contents

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

The net.mfiano.lisp.parsley Reference Manual

This is the net.mfiano.lisp.parsley Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 11:55:37 2020 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

(ql:quickload :net.mfiano.lisp.parsley)

License

Copyright © 2017-2020 Michael Fiano mail@mfiano.net.

Licensed under the MIT License.


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 net.mfiano.lisp.parsley

Author

Michael Fiano <mail@mfiano.net>

Home Page

https://mfiano.net/projects/parsley

Source Control

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

Bug Tracker

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

License

MIT

Description

A toolset for parsing binary data formats.

Dependencies
Source

net.mfiano.lisp.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 net.mfiano.lisp.parsley.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/parsley-20200610-git/net.mfiano.lisp.parsley.asd

Systems

net.mfiano.lisp.parsley (system)


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

3.1.2 net.mfiano.lisp.parsley/package.lisp

Parent

net.mfiano.lisp.parsley (system)

Location

package.lisp

Packages

net.mfiano.lisp.parsley


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

3.1.3 net.mfiano.lisp.parsley/buffer.lisp

Dependency

package.lisp (file)

Parent

net.mfiano.lisp.parsley (system)

Location

buffer.lisp

Exported Definitions
Internal Definitions

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

3.1.4 net.mfiano.lisp.parsley/common.lisp

Dependency

buffer.lisp (file)

Parent

net.mfiano.lisp.parsley (system)

Location

common.lisp

Exported Definitions

split-string (function)

Internal Definitions

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

3.1.5 net.mfiano.lisp.parsley/processors.lisp

Dependency

common.lisp (file)

Parent

net.mfiano.lisp.parsley (system)

Location

processors.lisp

Exported Definitions

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

3.1.6 net.mfiano.lisp.parsley/readers.lisp

Dependency

processors.lisp (file)

Parent

net.mfiano.lisp.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 net.mfiano.lisp.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

net.mfiano.lisp.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

net.mfiano.lisp.parsley

Source

buffer.lisp (file)


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

5.1.3 Functions

Function: buffer-bits ()
Package

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

Function: buffer-bytes ()
Package

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

Function: buffer-position ()
Package

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

Function: buffer-sequence ()
Package

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

Function: buffer-stream ()
Package

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

Function: octets= OCTET-VECTOR OCTET-LIST
Package

net.mfiano.lisp.parsley

Source

readers.lisp (file)

Function: read-bits COUNT &key PROCESSOR
Package

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

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

net.mfiano.lisp.parsley

Source

readers.lisp (file)

Function: split-string STRING DELIMITER
Package

net.mfiano.lisp.parsley

Source

common.lisp (file)

Function: uncompress-bzip2 OCTET-VECTOR
Package

net.mfiano.lisp.parsley

Source

processors.lisp (file)

Function: uncompress-deflate OCTET-VECTOR
Package

net.mfiano.lisp.parsley

Source

processors.lisp (file)

Function: uncompress-gzip OCTET-VECTOR
Package

net.mfiano.lisp.parsley

Source

processors.lisp (file)

Function: uncompress-zlib OCTET-VECTOR
Package

net.mfiano.lisp.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

net.mfiano.lisp.parsley

Source

buffer.lisp (file)

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

net.mfiano.lisp.parsley

Source

common.lisp (file)

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

net.mfiano.lisp.parsley

Source

common.lisp (file)


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

5.2.2 Classes

Class: buffer ()
Package

net.mfiano.lisp.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   N  
Index Entry  Section

F
File, Lisp, net.mfiano.lisp.parsley.asd: The net․mfiano․lisp․parsley․asd file
File, Lisp, net.mfiano.lisp.parsley/buffer.lisp: The net․mfiano․lisp․parsley/buffer․lisp file
File, Lisp, net.mfiano.lisp.parsley/common.lisp: The net․mfiano․lisp․parsley/common․lisp file
File, Lisp, net.mfiano.lisp.parsley/package.lisp: The net․mfiano․lisp․parsley/package․lisp file
File, Lisp, net.mfiano.lisp.parsley/processors.lisp: The net․mfiano․lisp․parsley/processors․lisp file
File, Lisp, net.mfiano.lisp.parsley/readers.lisp: The net․mfiano․lisp․parsley/readers․lisp file

L
Lisp File, net.mfiano.lisp.parsley.asd: The net․mfiano․lisp․parsley․asd file
Lisp File, net.mfiano.lisp.parsley/buffer.lisp: The net․mfiano․lisp․parsley/buffer․lisp file
Lisp File, net.mfiano.lisp.parsley/common.lisp: The net․mfiano․lisp․parsley/common․lisp file
Lisp File, net.mfiano.lisp.parsley/package.lisp: The net․mfiano․lisp․parsley/package․lisp file
Lisp File, net.mfiano.lisp.parsley/processors.lisp: The net․mfiano․lisp․parsley/processors․lisp file
Lisp File, net.mfiano.lisp.parsley/readers.lisp: The net․mfiano․lisp․parsley/readers․lisp file

N
net.mfiano.lisp.parsley.asd: The net․mfiano․lisp․parsley․asd file
net.mfiano.lisp.parsley/buffer.lisp: The net․mfiano․lisp․parsley/buffer․lisp file
net.mfiano.lisp.parsley/common.lisp: The net․mfiano․lisp․parsley/common․lisp file
net.mfiano.lisp.parsley/package.lisp: The net․mfiano․lisp․parsley/package․lisp file
net.mfiano.lisp.parsley/processors.lisp: The net․mfiano․lisp․parsley/processors․lisp file
net.mfiano.lisp.parsley/readers.lisp: The net․mfiano․lisp․parsley/readers․lisp file

Jump to:   F   L   N  

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:   %   *  
S  
Index Entry  Section

%
%bits: Internal classes
%bytes: Internal classes
%sequence: Internal classes
%stream: Internal classes

*
*buffer*: Exported special variables

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

Jump to:   %   *  
S  

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

A.4 Data types

Jump to:   B   C   N   P   S  
Index Entry  Section

B
buffer: Internal classes

C
Class, buffer: Internal classes

N
net.mfiano.lisp.parsley: The net․mfiano․lisp․parsley system
net.mfiano.lisp.parsley: The net․mfiano․lisp․parsley package

P
Package, net.mfiano.lisp.parsley: The net․mfiano․lisp․parsley package

S
System, net.mfiano.lisp.parsley: The net․mfiano․lisp․parsley system

Jump to:   B   C   N   P   S