The trivial-yenc Reference Manual

Table of Contents

The trivial-yenc Reference Manual

This is the trivial-yenc Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:42:49 2018 GMT+0.

1 Introduction

trivial-yenc

Common lisp tools for decoding yenc files. It uses split-sequence.

(ql:quickload :trivial-yenc)

(trivial-yenc:decode-part instream directory) => part number or nil

• instream is a binary input stream (:element-type '(unsigned-byte 8))

• directory is a path prefix for the output file

See examples test1 and test2.

test1 opens a yenc file (two roads), decodes and displays the poem from the file.

test2 decodes a multi-part binary, joystick.jpg.

(defun test2 ()
  "decode multipart messages to create joystick.jpg"
  (with-open-file (in  (asdf:system-relative-pathname 'trivial-yenc "test/yenc2/00000020.ntx" )
		       :element-type '(unsigned-byte 8))
    (decode-part in (asdf:system-relative-pathname 'trivial-yenc "test/yenc2/")))
  (with-open-file (in  (asdf:system-relative-pathname 'trivial-yenc "test/yenc2/00000021.ntx" )
		       :element-type '(unsigned-byte 8))
   (decode-part in (asdf:system-relative-pathname 'trivial-yenc "test/yenc2/")))   )

decode-part skips message headers, parses =ybegin line. If it's a multipart, it parses the next =ypart line. With enough information, it yydecodes the data that follows and writes it to a file in the directory specified. (test2) reads yenc files, but in real life you can stream the data right from the newsserver...

See:

• http://www.yenc.org

Todo:

• general cleanup
• handle crc
• check part size
• return mutivalue status, part, ofparts, filename, etc...

2 Systems

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

2.1 trivial-yenc

Author

Stacksmith <fpgasm@apple2.x10.mx>

License

MIT

Description

Decode yenc file to a binary file

Dependency

split-sequence

Source

trivial-yenc.asd (file)

Components

• package.lisp (file)
• trivial-yenc.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 trivial-yenc.asd

Location

trivial-yenc.asd

Systems

trivial-yenc (system)

3.1.2 trivial-yenc/package.lisp

Parent

trivial-yenc (system)

Location

package.lisp

Packages

trivial-yenc

3.1.3 trivial-yenc/trivial-yenc.lisp

Dependency

package.lisp (file)

Parent

trivial-yenc (system)

Location

trivial-yenc.lisp

Exported Definitions

• decode-part (function)
• test1 (function)
• test2 (function)

Internal Definitions

• =yend (special variable)
• bytes-to-string (function)
• bytes-to-vec (function)
• decode-data (function)
• decode-line (function)
• decode-lines (function)
• header-prim (function)
• header-ybegin (function)
• header-ybegin- (function)
• header-ypart (function)
• header-ypart- (function)
• param-to-pair (function)
• read-bytes (function)

4 Packages

Packages are listed by definition order.

4.1 trivial-yenc

Source

package.lisp (file)

Use List

• split-sequence
• common-lisp

Exported Definitions

• decode-part (function)
• test1 (function)
• test2 (function)

Internal Definitions

• =yend (special variable)
• bytes-to-string (function)
• bytes-to-vec (function)
• decode-data (function)
• decode-line (function)
• decode-lines (function)
• header-prim (function)
• header-ybegin (function)
• header-ybegin- (function)
• header-ypart (function)
• header-ypart- (function)
• param-to-pair (function)
• read-bytes (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: decode-part IN PATH

decode stream in and write file in path directory. Return part number or nil

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: test1 ()

decode two-roads.yenc into two-roads.out; load the output file and print to screen.

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: test2 ()

decode a multi-part binary from two files.

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: =yend

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

5.2.2 Functions

Function: bytes-to-string LINE

convert vector of bytes to a string

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: bytes-to-vec LINE

convert vector of bytes to a string

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: decode-data VEC OUT

decode bytes in vec into out stream

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: decode-line IN OUT

decode a line of encoded data from in and output to out

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: decode-lines IN OUT

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: header-prim STR START END

parse a simple header consisting of pure name=value pairs

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: header-ybegin IN

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: header-ybegin- STR

read a parameter line starting with =ybegin; return an alist.

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: header-ypart IN

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: header-ypart- STR

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: param-to-pair PARAM

convert string x=y to (x . y), converting y to a number if possible

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Function: read-bytes IN

Package

trivial-yenc

Source

trivial-yenc.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types