The tiff4cl Reference Manual

Table of Contents

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

The tiff4cl Reference Manual

This is the tiff4cl Reference Manual, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:40:01 2018 GMT+0.


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

1 Systems

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


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

1.1 tiff4cl

Maintainer

Walter C. Pelissero <walter@pelissero.de>

Author

Walter C. Pelissero <walter@pelissero.de>

License

LGPL

Description

TIFF access primitives

Long Description

A TIFF file parser that reads the tags leaving the actual image data alone.

Dependency

ie3fp

Source

tiff4cl.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 tiff4cl.asd

Location

tiff4cl.asd

Systems

tiff4cl (system)

Packages

tiff4cl-system


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

2.1.2 tiff4cl/package.lisp

Parent

tiff4cl (system)

Location

package.lisp

Packages

tiff4cl


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

2.1.3 tiff4cl/util.lisp

Dependency

package.lisp (file)

Parent

tiff4cl (system)

Location

util.lisp

Internal Definitions

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

2.1.4 tiff4cl/tiff.lisp

Dependency

util.lisp (file)

Parent

tiff4cl (system)

Location

tiff.lisp

Exported Definitions
Internal Definitions

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

3 Packages

Packages are listed by definition order.


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

3.1 tiff4cl-system

Source

tiff4cl.asd

Use List

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

3.2 tiff4cl

Source

package.lisp (file)

Nickname

tiff

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Functions

Function: map-tiff-tags FUNCTION IFDS
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-tiff FILE &key START END
Package

tiff4cl

Source

tiff.lisp (file)

Function: print-tiff-tags IFDS &optional STREAM
Package

tiff4cl

Source

tiff.lisp (file)

Function: tiff-extract-tags IFDS TAG-IDS
Package

tiff4cl

Source

tiff.lisp (file)


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

4.1.2 Generic functions

Generic Function: ifd-tags OBJECT
Package

tiff4cl

Methods
Method: ifd-tags (TIFF-IFD tiff-ifd)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: tag-id OBJECT
Package

tiff4cl

Methods
Method: tag-id (TIFF-TAG tiff-tag)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: tag-type OBJECT
Package

tiff4cl

Methods
Method: tag-type (TIFF-TAG tiff-tag)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: tag-value OBJECT
Package

tiff4cl

Methods
Method: tag-value (TIFF-TAG tiff-tag)

automatically generated reader method

Source

tiff.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Special variables

Special Variable: *tag-ids*
Package

tiff4cl

Source

tiff.lisp (file)

Special Variable: +big-endian-signature+
Package

tiff4cl

Source

tiff.lisp (file)

Special Variable: +little-endian-signature+
Package

tiff4cl

Source

tiff.lisp (file)

Special Variable: +tag-types+

List of supported tag types. Every type is a triplet consisting of: a numeric id, a keyword id, and a length in bytes.

Package

tiff4cl

Source

tiff.lisp (file)

Special Variable: +tiff-version+

What was the question?

Package

tiff4cl

Source

tiff.lisp (file)


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

4.2.2 Macros

Macro: defconst NAME VALUE &rest ETC
Package

tiff4cl

Source

tiff.lisp (file)

Macro: make-read-sequence NAME BUFFER
Package

tiff4cl

Source

util.lisp (file)


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

4.2.3 Functions

Function: decode-integer-be SEQUENCE &key START END

Decode a big-endian sequence of bytes as an integer and return it.

Package

tiff4cl

Source

util.lisp (file)

Function: decode-integer-le SEQUENCE &key START END

Decode a big-endian sequence of bytes as an integer and return it.

Package

tiff4cl

Source

util.lisp (file)

Function: fetch-tag-data FILE ADDRESS LENGTH
Package

tiff4cl

Source

tiff.lisp (file)

Function: get-tag-value FILE TYPE COUNT DATA
Package

tiff4cl

Source

tiff.lisp (file)

Function: interpret-tag-value FILE ID VALUE
Package

tiff4cl

Source

tiff.lisp (file)

Function: map-ifd-tags FUNCTION IFD
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-endianness STREAM
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-file-format-version TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-ifd TIFF &optional POSITION
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-tag TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: parse-tiff-stream STREAM &optional END
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-16bit-be STREAM
Package

tiff4cl

Source

util.lisp (file)

Function: read-16bit-le STREAM
Package

tiff4cl

Source

util.lisp (file)

Function: read-32bit-be STREAM
Package

tiff4cl

Source

util.lisp (file)

Function: read-32bit-le STREAM
Package

tiff4cl

Source

util.lisp (file)

Function: read-bytes STREAM LENGTH &key EOF-ERRORP EOF-VALUE
Package

tiff4cl

Source

util.lisp (file)

Function: read-ifd-pointer TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-ifd-tags-number TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-tag-data TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-tag-id TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-tag-type TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: read-tag-values-count TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Function: tag-id->symbol N
Package

tiff4cl

Source

tiff.lisp (file)

Function: tag-type->symbol N
Package

tiff4cl

Source

tiff.lisp (file)

Function: tag-type-size TYPE
Package

tiff4cl

Source

tiff.lisp (file)

Function: tiff-position TIFF &optional POSITION
Package

tiff4cl

Source

tiff.lisp (file)


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

4.2.4 Generic functions

Generic Function: decode-integer TIFF BUFFER &key START END
Package

tiff4cl

Source

tiff.lisp (file)

Methods
Method: decode-integer (TIFF tiff-big-endian-stream) BUFFER &key START END
Method: decode-integer (TIFF tiff-little-endian-stream) BUFFER &key START END
Generic Function: ifd-next OBJECT
Package

tiff4cl

Methods
Method: ifd-next (TIFF-IFD tiff-ifd)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: read-16bit TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Methods
Method: read-16bit (TIFF tiff-big-endian-stream)
Method: read-16bit (TIFF tiff-little-endian-stream)
Generic Function: read-32bit TIFF
Package

tiff4cl

Source

tiff.lisp (file)

Methods
Method: read-32bit (TIFF tiff-big-endian-stream)
Method: read-32bit (TIFF tiff-little-endian-stream)
Generic Function: tiff-end OBJECT
Package

tiff4cl

Methods
Method: tiff-end (TIFF-STREAM tiff-stream)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: tiff-error-pointer CONDITION
Package

tiff4cl

Methods
Method: tiff-error-pointer (CONDITION invalid-pointer)
Source

tiff.lisp (file)

Generic Function: tiff-error-version CONDITION
Package

tiff4cl

Methods
Method: tiff-error-version (CONDITION wrong-version)
Source

tiff.lisp (file)

Generic Function: tiff-start OBJECT
Package

tiff4cl

Methods
Method: tiff-start (TIFF-STREAM tiff-stream)

automatically generated reader method

Source

tiff.lisp (file)

Generic Function: tiff-stream OBJECT
Package

tiff4cl

Methods
Method: tiff-stream (TIFF-STREAM tiff-stream)

automatically generated reader method

Source

tiff.lisp (file)


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

4.2.5 Conditions

Condition: invalid-pointer ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

tiff-error (condition)

Direct methods

tiff-error-pointer (method)

Direct slots
Slot: pointer
Initargs

:pointer

Readers

tiff-error-pointer (generic function)

Condition: not-a-tiff ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

tiff-error (condition)

Condition: tiff-error ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

error (condition)

Direct subclasses
Condition: wrong-version ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

tiff-error (condition)

Direct methods

tiff-error-version (method)

Direct slots
Slot: version
Initargs

:version

Readers

tiff-error-version (generic function)


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

4.2.6 Classes

Class: tiff-big-endian-stream ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

tiff-stream (class)

Direct methods
Class: tiff-ifd ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: tags
Type

list

Initargs

:tags

Readers

ifd-tags (generic function)

Slot: next
Initargs

:next

Readers

ifd-next (generic function)

Class: tiff-little-endian-stream ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

tiff-stream (class)

Direct methods
Class: tiff-stream ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: stream
Initargs

:stream

Readers

tiff-stream (generic function)

Slot: start
Type

integer

Initargs

:start

Initform

0

Readers

tiff-start (generic function)

Slot: end
Type

(or integer null)

Initargs

:end

Readers

tiff-end (generic function)

Class: tiff-tag ()
Package

tiff4cl

Source

tiff.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: id
Initargs

:id

Readers

tag-id (generic function)

Slot: type
Initargs

:type

Readers

tag-type (generic function)

Slot: value
Initargs

:value

Readers

tag-value (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, tiff4cl.asd: The tiff4cl<dot>asd file
File, Lisp, tiff4cl/package.lisp: The tiff4cl/package<dot>lisp file
File, Lisp, tiff4cl/tiff.lisp: The tiff4cl/tiff<dot>lisp file
File, Lisp, tiff4cl/util.lisp: The tiff4cl/util<dot>lisp file

L
Lisp File, tiff4cl.asd: The tiff4cl<dot>asd file
Lisp File, tiff4cl/package.lisp: The tiff4cl/package<dot>lisp file
Lisp File, tiff4cl/tiff.lisp: The tiff4cl/tiff<dot>lisp file
Lisp File, tiff4cl/util.lisp: The tiff4cl/util<dot>lisp file

T
tiff4cl.asd: The tiff4cl<dot>asd file
tiff4cl/package.lisp: The tiff4cl/package<dot>lisp file
tiff4cl/tiff.lisp: The tiff4cl/tiff<dot>lisp file
tiff4cl/util.lisp: The tiff4cl/util<dot>lisp file

Jump to:   F   L   T  

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

A.2 Functions

Jump to:   D   F   G   I   M   P   R   T  
Index Entry  Section

D
decode-integer: Internal generic functions
decode-integer: Internal generic functions
decode-integer: Internal generic functions
decode-integer-be: Internal functions
decode-integer-le: Internal functions
defconst: Internal macros

F
fetch-tag-data: Internal functions
Function, decode-integer-be: Internal functions
Function, decode-integer-le: Internal functions
Function, fetch-tag-data: Internal functions
Function, get-tag-value: Internal functions
Function, interpret-tag-value: Internal functions
Function, map-ifd-tags: Internal functions
Function, map-tiff-tags: Exported functions
Function, parse-endianness: Internal functions
Function, parse-file-format-version: Internal functions
Function, parse-ifd: Internal functions
Function, parse-tag: Internal functions
Function, parse-tiff: Exported functions
Function, parse-tiff-stream: Internal functions
Function, print-tiff-tags: Exported functions
Function, read-16bit-be: Internal functions
Function, read-16bit-le: Internal functions
Function, read-32bit-be: Internal functions
Function, read-32bit-le: Internal functions
Function, read-bytes: Internal functions
Function, read-ifd-pointer: Internal functions
Function, read-ifd-tags-number: Internal functions
Function, read-tag-data: Internal functions
Function, read-tag-id: Internal functions
Function, read-tag-type: Internal functions
Function, read-tag-values-count: Internal functions
Function, tag-id->symbol: Internal functions
Function, tag-type->symbol: Internal functions
Function, tag-type-size: Internal functions
Function, tiff-extract-tags: Exported functions
Function, tiff-position: Internal functions

G
Generic Function, decode-integer: Internal generic functions
Generic Function, ifd-next: Internal generic functions
Generic Function, ifd-tags: Exported generic functions
Generic Function, read-16bit: Internal generic functions
Generic Function, read-32bit: Internal generic functions
Generic Function, tag-id: Exported generic functions
Generic Function, tag-type: Exported generic functions
Generic Function, tag-value: Exported generic functions
Generic Function, tiff-end: Internal generic functions
Generic Function, tiff-error-pointer: Internal generic functions
Generic Function, tiff-error-version: Internal generic functions
Generic Function, tiff-start: Internal generic functions
Generic Function, tiff-stream: Internal generic functions
get-tag-value: Internal functions

I
ifd-next: Internal generic functions
ifd-next: Internal generic functions
ifd-tags: Exported generic functions
ifd-tags: Exported generic functions
interpret-tag-value: Internal functions

M
Macro, defconst: Internal macros
Macro, make-read-sequence: Internal macros
make-read-sequence: Internal macros
map-ifd-tags: Internal functions
map-tiff-tags: Exported functions
Method, decode-integer: Internal generic functions
Method, decode-integer: Internal generic functions
Method, ifd-next: Internal generic functions
Method, ifd-tags: Exported generic functions
Method, read-16bit: Internal generic functions
Method, read-16bit: Internal generic functions
Method, read-32bit: Internal generic functions
Method, read-32bit: Internal generic functions
Method, tag-id: Exported generic functions
Method, tag-type: Exported generic functions
Method, tag-value: Exported generic functions
Method, tiff-end: Internal generic functions
Method, tiff-error-pointer: Internal generic functions
Method, tiff-error-version: Internal generic functions
Method, tiff-start: Internal generic functions
Method, tiff-stream: Internal generic functions

P
parse-endianness: Internal functions
parse-file-format-version: Internal functions
parse-ifd: Internal functions
parse-tag: Internal functions
parse-tiff: Exported functions
parse-tiff-stream: Internal functions
print-tiff-tags: Exported functions

R
read-16bit: Internal generic functions
read-16bit: Internal generic functions
read-16bit: Internal generic functions
read-16bit-be: Internal functions
read-16bit-le: Internal functions
read-32bit: Internal generic functions
read-32bit: Internal generic functions
read-32bit: Internal generic functions
read-32bit-be: Internal functions
read-32bit-le: Internal functions
read-bytes: Internal functions
read-ifd-pointer: Internal functions
read-ifd-tags-number: Internal functions
read-tag-data: Internal functions
read-tag-id: Internal functions
read-tag-type: Internal functions
read-tag-values-count: Internal functions

T
tag-id: Exported generic functions
tag-id: Exported generic functions
tag-id->symbol: Internal functions
tag-type: Exported generic functions
tag-type: Exported generic functions
tag-type->symbol: Internal functions
tag-type-size: Internal functions
tag-value: Exported generic functions
tag-value: Exported generic functions
tiff-end: Internal generic functions
tiff-end: Internal generic functions
tiff-error-pointer: Internal generic functions
tiff-error-pointer: Internal generic functions
tiff-error-version: Internal generic functions
tiff-error-version: Internal generic functions
tiff-extract-tags: Exported functions
tiff-position: Internal functions
tiff-start: Internal generic functions
tiff-start: Internal generic functions
tiff-stream: Internal generic functions
tiff-stream: Internal generic functions

Jump to:   D   F   G   I   M   P   R   T  

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

A.3 Variables

Jump to:   *   +  
E   I   N   P   S   T   V  
Index Entry  Section

*
*tag-ids*: Internal special variables

+
+big-endian-signature+: Internal special variables
+little-endian-signature+: Internal special variables
+tag-types+: Internal special variables
+tiff-version+: Internal special variables

E
end: Internal classes

I
id: Internal classes

N
next: Internal classes

P
pointer: Internal conditions

S
Slot, end: Internal classes
Slot, id: Internal classes
Slot, next: Internal classes
Slot, pointer: Internal conditions
Slot, start: Internal classes
Slot, stream: Internal classes
Slot, tags: Internal classes
Slot, type: Internal classes
Slot, value: Internal classes
Slot, version: Internal conditions
Special Variable, *tag-ids*: Internal special variables
Special Variable, +big-endian-signature+: Internal special variables
Special Variable, +little-endian-signature+: Internal special variables
Special Variable, +tag-types+: Internal special variables
Special Variable, +tiff-version+: Internal special variables
start: Internal classes
stream: Internal classes

T
tags: Internal classes
type: Internal classes

V
value: Internal classes
version: Internal conditions

Jump to:   *   +  
E   I   N   P   S   T   V  

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

A.4 Data types

Jump to:   C   I   N   P   S   T   W  
Index Entry  Section

C
Class, tiff-big-endian-stream: Internal classes
Class, tiff-ifd: Internal classes
Class, tiff-little-endian-stream: Internal classes
Class, tiff-stream: Internal classes
Class, tiff-tag: Internal classes
Condition, invalid-pointer: Internal conditions
Condition, not-a-tiff: Internal conditions
Condition, tiff-error: Internal conditions
Condition, wrong-version: Internal conditions

I
invalid-pointer: Internal conditions

N
not-a-tiff: Internal conditions

P
Package, tiff4cl: The tiff4cl package
Package, tiff4cl-system: The tiff4cl-system package

S
System, tiff4cl: The tiff4cl system

T
tiff-big-endian-stream: Internal classes
tiff-error: Internal conditions
tiff-ifd: Internal classes
tiff-little-endian-stream: Internal classes
tiff-stream: Internal classes
tiff-tag: Internal classes
tiff4cl: The tiff4cl system
tiff4cl: The tiff4cl package
tiff4cl-system: The tiff4cl-system package

W
wrong-version: Internal conditions

Jump to:   C   I   N   P   S   T   W