The cl-qprint Reference Manual

Table of Contents

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

The cl-qprint Reference Manual

This is the cl-qprint Reference Manual, version 0.9.9, generated automatically by Declt version 2.3 "Robert April" on Tue Jan 09 13:57:29 2018 GMT+0.


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

1 Introduction

cl-qprint

Description:

cl-qprint implements the quoted-printable encoding as described in RFC 2045. It was originally written by Robert Marlow but is not maintained anymore. This version contains major bug fixes and is actively maintained.

Documentation:


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 cl-qprint

Maintainer

Max Rottenkolber <max@mr.gy>

Author

Robert Marlow <rob@bobturf.org>

Description

Encode and decode quoted-printable encoded strings.

Version

0.9.9

Dependency

flexi-streams

Source

cl-qprint.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 cl-qprint.asd

Location

cl-qprint.asd

Systems

cl-qprint (system)

Packages

cl-qprint-system


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

3.1.2 cl-qprint/base.lisp

Parent

cl-qprint (system)

Location

base.lisp

Packages

cl-qprint

Exported Definitions
Internal Definitions

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

3.1.3 cl-qprint/test.lisp

Dependency

base.lisp (file)

Parent

cl-qprint (system)

Location

test.lisp

Packages

cl-qprint-test

Exported Definitions

test-cl-qprint (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-qprint-system

Source

cl-qprint.asd

Use List

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

4.2 cl-qprint

Encode and decode quoted-printable encoded strings as defined by [RFC 2045](http://tools.ietf.org/html/rfc2045).

Source

base.lisp (file)

Nicknames
Use List
Used By List

cl-qprint-test

Exported Definitions
Internal Definitions

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

4.3 cl-qprint-test

Test routines for CL-QPRINT.

Source

test.lisp (file)

Use List
Exported Definitions

test-cl-qprint (function)

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 Functions

Function: decode INPUT &key ERROR-P

*Arguments and Values:*

_input_—a _string_ or a _character stream_.

_error-p_—a _generalized boolean_. The default is false.

*Description*:

{decode} reads from _quoted-printable_ encoded _input_ and returns a decoded _vector_ with {(unsigned-byte 8)} as its _element type_.

*Exceptional Situations:*

If _error-p_ is _true_, an error of _type_ {decode-error} signaled when _input_ is malformed.

Package

cl-qprint

Source

base.lisp (file)

Function: encode INPUT &key COLUMNS

*Arguments and Values:*

_input_—a _vector_ or a _stream_ with element type {(unsigned-byte 8)}.

_columns_—a positive _integer_.

*Description*:

{encode} reads from _input_ and returns a _quoted-printable_ encoded _string_. _Columns_ denotes the maximum line length of _string_.

Package

cl-qprint

Source

base.lisp (file)

Function: test-cl-qprint ()

Test integritiy of CL-QPRINT by asserting the following to be true:

{(EQUALP (DECODE (ENCODE input)) input)}

for {input} being randomized data.

Package

cl-qprint-test

Source

test.lisp (file)


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

5.1.2 Conditions

Condition: decode-error ()

The _type_ {decode-error} consists of error conditions related to malformed encodings.

Package

cl-qprint

Source

base.lisp (file)

Direct superclasses

error (condition)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *ascii-!*

ASCII code for exclamation mark character.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *ascii-=*

ASCII code for equal sign character.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *ascii-whitespace*

List of ASCII codes of whitespace characters.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *ascii-~*

ASCII code for tilde character.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *encoded-crlf*

CRLF string.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *soft-line-break*

Soft line break.

Package

cl-qprint

Source

base.lisp (file)

Special Variable: *test-iterations*

Number of random strings tested.

Package

cl-qprint-test

Source

test.lisp (file)

Special Variable: *value-range*

Range of values in random vectors.

Package

cl-qprint-test

Source

test.lisp (file)


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

5.2.2 Functions

Function: byte-encoding BYTE

Produce quoted-printable encoding string for BYTE.

Package

cl-qprint

Source

base.lisp (file)

Function: char-code-ascii CHAR

Return ASCII code for CHAR.

Package

cl-qprint

Source

base.lisp (file)

Function: code-char-ascii CODE

Return ASCII character for CODE.

Package

cl-qprint

Source

base.lisp (file)

Function: decode-byte CHAR2 CHAR3

Decode byte encoded by CHAR2 and CHAR2.

Package

cl-qprint

Source

base.lisp (file)

Function: decode-quoted CHAR2 CHAR3 &key ERROR-P

Decode quoted CHAR2 and CHAR3, signal DECODE-ERROR when ERROR-P is non NIL and sequence is invalid.

Package

cl-qprint

Source

base.lisp (file)

Function: encode-byte BYTE

Encode BYTE for quoted-printable encoding and return string.

Package

cl-qprint

Source

base.lisp (file)

Function: encode-byte-p BYTE

Predicate to check wether BYTE has to be encoded in quoted-printable encoding.

Package

cl-qprint

Source

base.lisp (file)

Function: plain-char-code CHAR &key ERROR-P

Return ASCII code for unencoded CHAR if possible otherwise return NIL or signal DECODE-ERROR depending on ERROR-P.

Package

cl-qprint

Source

base.lisp (file)

Function: random-vector LENGTH

Return a random vector of LENGTH.

Package

cl-qprint-test

Source

test.lisp (file)

Function: upper-case-hex-p CHAR

Predicate to check if CHAR is a upper case hexadecimal digit.

Package

cl-qprint

Source

base.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-qprint.asd: The cl-qprint<dot>asd file
cl-qprint/base.lisp: The cl-qprint/base<dot>lisp file
cl-qprint/test.lisp: The cl-qprint/test<dot>lisp file

F
File, Lisp, cl-qprint.asd: The cl-qprint<dot>asd file
File, Lisp, cl-qprint/base.lisp: The cl-qprint/base<dot>lisp file
File, Lisp, cl-qprint/test.lisp: The cl-qprint/test<dot>lisp file

L
Lisp File, cl-qprint.asd: The cl-qprint<dot>asd file
Lisp File, cl-qprint/base.lisp: The cl-qprint/base<dot>lisp file
Lisp File, cl-qprint/test.lisp: The cl-qprint/test<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   B   C   D   E   F   P   R   T   U  
Index Entry  Section

B
byte-encoding: Internal functions

C
char-code-ascii: Internal functions
code-char-ascii: Internal functions

D
decode: Exported functions
decode-byte: Internal functions
decode-quoted: Internal functions

E
encode: Exported functions
encode-byte: Internal functions
encode-byte-p: Internal functions

F
Function, byte-encoding: Internal functions
Function, char-code-ascii: Internal functions
Function, code-char-ascii: Internal functions
Function, decode: Exported functions
Function, decode-byte: Internal functions
Function, decode-quoted: Internal functions
Function, encode: Exported functions
Function, encode-byte: Internal functions
Function, encode-byte-p: Internal functions
Function, plain-char-code: Internal functions
Function, random-vector: Internal functions
Function, test-cl-qprint: Exported functions
Function, upper-case-hex-p: Internal functions

P
plain-char-code: Internal functions

R
random-vector: Internal functions

T
test-cl-qprint: Exported functions

U
upper-case-hex-p: Internal functions

Jump to:   B   C   D   E   F   P   R   T   U  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*ascii-!*: Internal special variables
*ascii-=*: Internal special variables
*ascii-whitespace*: Internal special variables
*ascii-~*: Internal special variables
*encoded-crlf*: Internal special variables
*soft-line-break*: Internal special variables
*test-iterations*: Internal special variables
*value-range*: Internal special variables

S
Special Variable, *ascii-!*: Internal special variables
Special Variable, *ascii-=*: Internal special variables
Special Variable, *ascii-whitespace*: Internal special variables
Special Variable, *ascii-~*: Internal special variables
Special Variable, *encoded-crlf*: Internal special variables
Special Variable, *soft-line-break*: Internal special variables
Special Variable, *test-iterations*: Internal special variables
Special Variable, *value-range*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   D   P   S  
Index Entry  Section

C
cl-qprint: The cl-qprint system
cl-qprint: The cl-qprint package
cl-qprint-system: The cl-qprint-system package
cl-qprint-test: The cl-qprint-test package
Condition, decode-error: Exported conditions

D
decode-error: Exported conditions

P
Package, cl-qprint: The cl-qprint package
Package, cl-qprint-system: The cl-qprint-system package
Package, cl-qprint-test: The cl-qprint-test package

S
System, cl-qprint: The cl-qprint system

Jump to:   C   D   P   S