The ixf Reference Manual

Table of Contents

The ixf Reference Manual

This is the ixf Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:18:19 2020 GMT+0.

1 Introduction

Tools to handle IBM PC version of IXF file format

See http://www-01.ibm.com/support/knowledgecenter/SSEPGG_10.5.0/com.ibm.db2.luw.admin.dm.doc/doc/r0004667.html.

2 Systems

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

2.1 ixf

Author

Dimitri Fontaine <dim@tapoueh.org>

License

WTFPL

Description

Tools to handle IBM PC version of IXF file format

Version

0.1.0

Dependencies

• split-sequence
• md5
• alexandria
• babel
• local-time
• cl-ppcre
• ieee-floats

Source

ixf.asd (file)

Components

• package.lisp (file)
• records.lisp (file)
• types.lisp (file)
• encodings.lisp (file)
• structs.lisp (file)
• data.lisp (file)
• ixf.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 ixf.asd

Location

ixf.asd

Systems

ixf (system)

3.1.2 ixf/package.lisp

Parent

ixf (system)

Location

package.lisp

Packages

ixf

3.1.3 ixf/records.lisp

Dependencies

• package.lisp (file)
• package.lisp (file)

Parent

ixf (system)

Location

records.lisp

Exported Definitions

read-next-record (function)

Internal Definitions

• *ixf-application* (special variable)
• *ixf-column* (special variable)
• *ixf-data* (special variable)
• *ixf-header* (special variable)
• *ixf-table* (special variable)
• *record-types* (special variable)
• check-record (function)
• collect-records (function)
• column-record-p (function)
• copy-ixf-field (function)
• data-record-p (function)
• field-name (function)
• (setf field-name) (function)
• field-size (function)
• (setf field-size) (function)
• field-type (function)
• (setf field-type) (function)
• get-record-property (function)
• header-record-p (function)
• ixf-field (structure)
• ixf-field-p (function)
• make-field (function)
• read-ascii-string (function)
• read-binary-data (function)
• read-character (function)
• read-field (function)
• read-integer (function)
• read-record (function)
• table-record-p (function)
• validate-file (function)

3.1.4 ixf/types.lisp

Dependencies

• records.lisp (file)
• package.lisp (file)

Parent

ixf (system)

Location

types.lisp

Exported Definitions

• +bigint+ (constant)
• +blob+ (constant)
• +blob-file+ (constant)
• +blob-location-spec+ (constant)
• +char+ (constant)
• +clob+ (constant)
• +clob-file+ (constant)
• +date+ (constant)
• +dbblob-location-spec+ (constant)
• +dbclob+ (constant)
• +dbclob-file+ (constant)
• +dbclob-location-spec+ (constant)
• +decfloat+ (constant)
• +decimal+ (constant)
• +float+ (constant)
• +graphic+ (constant)
• +integer+ (constant)
• +longvarchar+ (constant)
• +longvargraphic+ (constant)
• +smallint+ (constant)
• +time+ (constant)
• +timestamp+ (constant)
• +varchar+ (constant)
• +vargraphic+ (constant)

Internal Definitions

• parse-ixf-bigint (function)
• parse-ixf-date (function)
• parse-ixf-decimal (function)
• parse-ixf-float (function)
• parse-ixf-integer (function)
• parse-ixf-lls (function)
• parse-ixf-null (function)
• parse-ixf-smallint (function)
• parse-ixf-string (function)
• parse-ixf-time (function)
• parse-ixf-timestamp (function)
• parse-ixf-unsigned-bigint (function)
• parse-ixf-unsigned-integer (function)
• unsigned-to-signed (function)

3.1.5 ixf/encodings.lisp

Dependencies

• types.lisp (file)
• package.lisp (file)

Parent

ixf (system)

Location

encodings.lisp

Internal Definitions

• *ixf-encodings-mapping* (special variable)
• babel-encoding-for-code-page (function)

3.1.6 ixf/structs.lisp

Dependencies

• encodings.lisp (file)
• package.lisp (file)
• records.lisp (file)
• types.lisp (file)
• encodings.lisp (file)

Parent

ixf (system)

Location

structs.lisp

Exported Definitions

• ixf-column (structure)
• ixf-column-default (function)
• (setf ixf-column-default) (function)
• ixf-column-desc (function)
• (setf ixf-column-desc) (function)
• ixf-column-has-default (function)
• (setf ixf-column-has-default) (function)
• ixf-column-name (function)
• (setf ixf-column-name) (function)
• ixf-column-nullable (function)
• (setf ixf-column-nullable) (function)
• ixf-column-pkey-pos (function)
• (setf ixf-column-pkey-pos) (function)
• ixf-column-type (function)
• (setf ixf-column-type) (function)
• ixf-file (structure)
• ixf-file-header (function)
• (setf ixf-file-header) (function)
• ixf-file-p (function)
• ixf-file-table (function)
• (setf ixf-file-table) (function)
• ixf-header (structure)
• ixf-header-code-page (function)
• (setf ixf-header-code-page) (function)
• ixf-header-count (function)
• (setf ixf-header-count) (function)
• ixf-header-date (function)
• (setf ixf-header-date) (function)
• ixf-header-encoding (function)
• (setf ixf-header-encoding) (function)
• ixf-header-time (function)
• (setf ixf-header-time) (function)
• ixf-table (structure)
• ixf-table-columns (function)
• (setf ixf-table-columns) (function)
• ixf-table-creator (function)
• (setf ixf-table-creator) (function)
• ixf-table-desc (function)
• (setf ixf-table-desc) (function)
• ixf-table-name (function)
• (setf ixf-table-name) (function)
• ixf-table-ncol (function)
• (setf ixf-table-ncol) (function)
• ixf-table-pkey-name (function)
• (setf ixf-table-pkey-name) (function)
• ixf-table-source (function)
• (setf ixf-table-source) (function)
• make-ixf-file (function)
• read-headers (method)

Internal Definitions

• copy-ixf-column (function)
• copy-ixf-file (function)
• copy-ixf-header (function)
• copy-ixf-table (function)
• get-code-page (function)
• ixf-column-code-page (function)
• (setf ixf-column-code-page) (function)
• ixf-column-d-id (function)
• (setf ixf-column-d-id) (function)
• ixf-column-encoding (function)
• (setf ixf-column-encoding) (function)
• ixf-column-length (function)
• (setf ixf-column-length) (function)
• ixf-column-p (function)
• ixf-column-pos (function)
• (setf ixf-column-pos) (function)
• ixf-file-data-position (function)
• (setf ixf-file-data-position) (function)
• ixf-file-stream (function)
• (setf ixf-file-stream) (function)
• ixf-header-p (function)
• ixf-table-p (function)
• make-ixf-column (function)
• make-ixf-header (function)
• make-ixf-table (function)
• parse-column-definition (method)
• parse-encoding (function)
• parse-header (method)
• parse-table-definition (method)

3.1.7 ixf/data.lisp

Dependencies

• structs.lisp (file)
• package.lisp (file)
• structs.lisp (file)
• records.lisp (file)
• types.lisp (file)

Parent

ixf (system)

Location

data.lisp

Exported Definitions

read-next-row (method)

Internal Definitions

• maybe-read-record (method)
• parse-ixf-data (function)

3.1.8 ixf/ixf.lisp

Dependencies

• data.lisp (file)
• package.lisp (file)
• records.lisp (file)
• types.lisp (file)
• structs.lisp (file)
• data.lisp (file)

Parent

ixf (system)

Location

ixf.lisp

Exported Definitions

• map-data (function)
• read-data (method)
• read-ixf-file (function)
• with-ixf-file (macro)
• with-ixf-stream (macro)

4 Packages

Packages are listed by definition order.

4.1 ixf

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• +bigint+ (constant)
• +blob+ (constant)
• +blob-file+ (constant)
• +blob-location-spec+ (constant)
• +char+ (constant)
• +clob+ (constant)
• +clob-file+ (constant)
• +date+ (constant)
• +dbblob-location-spec+ (constant)
• +dbclob+ (constant)
• +dbclob-file+ (constant)
• +dbclob-location-spec+ (constant)
• +decfloat+ (constant)
• +decimal+ (constant)
• +float+ (constant)
• +graphic+ (constant)
• +integer+ (constant)
• +longvarchar+ (constant)
• +longvargraphic+ (constant)
• +smallint+ (constant)
• +time+ (constant)
• +timestamp+ (constant)
• +varchar+ (constant)
• +vargraphic+ (constant)
• ixf-column (structure)
• ixf-column-default (function)
• (setf ixf-column-default) (function)
• ixf-column-desc (function)
• (setf ixf-column-desc) (function)
• ixf-column-has-default (function)
• (setf ixf-column-has-default) (function)
• ixf-column-name (function)
• (setf ixf-column-name) (function)
• ixf-column-nullable (function)
• (setf ixf-column-nullable) (function)
• ixf-column-pkey-pos (function)
• (setf ixf-column-pkey-pos) (function)
• ixf-column-type (function)
• (setf ixf-column-type) (function)
• ixf-file (structure)
• ixf-file-header (function)
• (setf ixf-file-header) (function)
• ixf-file-p (function)
• ixf-file-table (function)
• (setf ixf-file-table) (function)
• ixf-header (structure)
• ixf-header-code-page (function)
• (setf ixf-header-code-page) (function)
• ixf-header-count (function)
• (setf ixf-header-count) (function)
• ixf-header-date (function)
• (setf ixf-header-date) (function)
• ixf-header-encoding (function)
• (setf ixf-header-encoding) (function)
• ixf-header-time (function)
• (setf ixf-header-time) (function)
• ixf-table (structure)
• ixf-table-columns (function)
• (setf ixf-table-columns) (function)
• ixf-table-creator (function)
• (setf ixf-table-creator) (function)
• ixf-table-desc (function)
• (setf ixf-table-desc) (function)
• ixf-table-name (function)
• (setf ixf-table-name) (function)
• ixf-table-ncol (function)
• (setf ixf-table-ncol) (function)
• ixf-table-pkey-name (function)
• (setf ixf-table-pkey-name) (function)
• ixf-table-source (function)
• (setf ixf-table-source) (function)
• make-ixf-file (function)
• map-data (function)
• read-data (generic function)
• read-data (method)
• read-headers (generic function)
• read-headers (method)
• read-ixf-file (function)
• read-next-record (function)
• read-next-row (generic function)
• read-next-row (method)
• with-ixf-file (macro)
• with-ixf-stream (macro)

Internal Definitions

• *ixf-application* (special variable)
• *ixf-column* (special variable)
• *ixf-data* (special variable)
• *ixf-encodings-mapping* (special variable)
• *ixf-header* (special variable)
• *ixf-table* (special variable)
• *record-types* (special variable)
• babel-encoding-for-code-page (function)
• check-record (function)
• collect-records (function)
• column-record-p (function)
• copy-ixf-column (function)
• copy-ixf-field (function)
• copy-ixf-file (function)
• copy-ixf-header (function)
• copy-ixf-table (function)
• data-record-p (function)
• field-name (function)
• (setf field-name) (function)
• field-size (function)
• (setf field-size) (function)
• field-type (function)
• (setf field-type) (function)
• get-code-page (function)
• get-record-property (function)
• header-record-p (function)
• ixf-column-code-page (function)
• (setf ixf-column-code-page) (function)
• ixf-column-d-id (function)
• (setf ixf-column-d-id) (function)
• ixf-column-encoding (function)
• (setf ixf-column-encoding) (function)
• ixf-column-length (function)
• (setf ixf-column-length) (function)
• ixf-column-p (function)
• ixf-column-pos (function)
• (setf ixf-column-pos) (function)
• ixf-field (structure)
• ixf-field-p (function)
• ixf-file-data-position (function)
• (setf ixf-file-data-position) (function)
• ixf-file-stream (function)
• (setf ixf-file-stream) (function)
• ixf-header-p (function)
• ixf-table-p (function)
• make-field (function)
• make-ixf-column (function)
• make-ixf-header (function)
• make-ixf-table (function)
• maybe-read-record (generic function)
• maybe-read-record (method)
• parse-column-definition (generic function)
• parse-column-definition (method)
• parse-encoding (function)
• parse-header (generic function)
• parse-header (method)
• parse-ixf-bigint (function)
• parse-ixf-data (function)
• parse-ixf-date (function)
• parse-ixf-decimal (function)
• parse-ixf-float (function)
• parse-ixf-integer (function)
• parse-ixf-lls (function)
• parse-ixf-null (function)
• parse-ixf-smallint (function)
• parse-ixf-string (function)
• parse-ixf-time (function)
• parse-ixf-timestamp (function)
• parse-ixf-unsigned-bigint (function)
• parse-ixf-unsigned-integer (function)
• parse-table-definition (generic function)
• parse-table-definition (method)
• read-ascii-string (function)
• read-binary-data (function)
• read-character (function)
• read-field (function)
• read-integer (function)
• read-record (function)
• table-record-p (function)
• unsigned-to-signed (function)
• validate-file (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Constants

Constant: +bigint+

Package

ixf

Source

types.lisp (file)

Constant: +blob+

Package

ixf

Source

types.lisp (file)

Constant: +blob-file+

Package

ixf

Source

types.lisp (file)

Constant: +blob-location-spec+

Package

ixf

Source

types.lisp (file)

Constant: +char+

Package

ixf

Source

types.lisp (file)

Constant: +clob+

Package

ixf

Source

types.lisp (file)

Constant: +clob-file+

Package

ixf

Source

types.lisp (file)

Constant: +date+

Package

ixf

Source

types.lisp (file)

Constant: +dbblob-location-spec+

Package

ixf

Source

types.lisp (file)

Constant: +dbclob+

Package

ixf

Source

types.lisp (file)

Constant: +dbclob-file+

Package

ixf

Source

types.lisp (file)

Constant: +dbclob-location-spec+

Package

ixf

Source

types.lisp (file)

Constant: +decfloat+

Package

ixf

Source

types.lisp (file)

Constant: +decimal+

Package

ixf

Source

types.lisp (file)

Constant: +float+

Package

ixf

Source

types.lisp (file)

Constant: +graphic+

Package

ixf

Source

types.lisp (file)

Constant: +integer+

Package

ixf

Source

types.lisp (file)

Constant: +longvarchar+

Package

ixf

Source

types.lisp (file)

Constant: +longvargraphic+

Package

ixf

Source

types.lisp (file)

Constant: +smallint+

Package

ixf

Source

types.lisp (file)

Constant: +time+

Package

ixf

Source

types.lisp (file)

Constant: +timestamp+

Package

ixf

Source

types.lisp (file)

Constant: +varchar+

Package

ixf

Source

types.lisp (file)

Constant: +vargraphic+

Package

ixf

Source

types.lisp (file)

5.1.2 Macros

Macro: with-ixf-file (VAR FILENAME) &body BODY

Executes BODY with VAR an IXF-FILE instance made from FILENAME stream contents.

Package

ixf

Source

ixf.lisp (file)

Macro: with-ixf-stream (VAR STREAM) &body BODY

Executes BODY with VAR an IXF-FILE instance made from STREAM.

Package

ixf

Source

ixf.lisp (file)

5.1.3 Functions

Function: ixf-column-default INSTANCE

Function: (setf ixf-column-default) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-desc INSTANCE

Function: (setf ixf-column-desc) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-has-default INSTANCE

Function: (setf ixf-column-has-default) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-name INSTANCE

Function: (setf ixf-column-name) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-nullable INSTANCE

Function: (setf ixf-column-nullable) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-pkey-pos INSTANCE

Function: (setf ixf-column-pkey-pos) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-type INSTANCE

Function: (setf ixf-column-type) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-file-header INSTANCE

Function: (setf ixf-file-header) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-file-p OBJECT

Package

ixf

Source

structs.lisp (file)

Function: ixf-file-table INSTANCE

Function: (setf ixf-file-table) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-code-page INSTANCE

Function: (setf ixf-header-code-page) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-count INSTANCE

Function: (setf ixf-header-count) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-date INSTANCE

Function: (setf ixf-header-date) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-encoding INSTANCE

Function: (setf ixf-header-encoding) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-time INSTANCE

Function: (setf ixf-header-time) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-columns INSTANCE

Function: (setf ixf-table-columns) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-creator INSTANCE

Function: (setf ixf-table-creator) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-desc INSTANCE

Function: (setf ixf-table-desc) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-name INSTANCE

Function: (setf ixf-table-name) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-ncol INSTANCE

Function: (setf ixf-table-ncol) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-pkey-name INSTANCE

Function: (setf ixf-table-pkey-name) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-source INSTANCE

Function: (setf ixf-table-source) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: make-ixf-file &key (STREAM STREAM) (HEADER HEADER) (TABLE TABLE) (DATA-POSITION DATA-POSITION)

Package

ixf

Source

structs.lisp (file)

Function: map-data IXF MAP-FN

Call map-fn on each row of data read from STREAM given IXF definition.

Package

ixf

Source

ixf.lisp (file)

Function: read-ixf-file FILENAME

Read FILENAME as an IXF file and return the IXF definition (table name, columns names and types, etc) and all its content as a list of vectors, each vector being a table’s row, as mutliple values.

Package

ixf

Source

ixf.lisp (file)

Function: read-next-record STREAM

Discover next record length and type, then read it.

Package

ixf

Source

records.lisp (file)

5.1.4 Generic functions

Generic Function: read-data IXF

Package

ixf

Methods

Method: read-data (IXF ixf-file)

Return the data read from IXF as a list of vectors of values.

Source

ixf.lisp (file)

Generic Function: read-headers IXF

Package

ixf

Methods

Method: read-headers (IXF ixf-file)

Return an IXF-FILE data structure filled with information read from FILENAME.

Source

structs.lisp (file)

Generic Function: read-next-row IXF FIRST-RECORD

Package

ixf

Methods

Method: read-next-row (IXF ixf-file) FIRST-RECORD

Read next IXF row: each row in the table is represented by one or more records, so keep reading D records as we need them.

Source

data.lisp (file)

5.1.5 Structures

Structure: ixf-column ()

Package

ixf

Source

structs.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• maybe-read-record (method)
• parse-column-definition (method)

Direct slots

Slot: name

Readers

ixf-column-name (function)

Writers

(setf ixf-column-name) (function)

Slot: nullable

Readers

ixf-column-nullable (function)

Writers

(setf ixf-column-nullable) (function)

Slot: has-default

Readers

ixf-column-has-default (function)

Writers

(setf ixf-column-has-default) (function)

Slot: default

Readers

ixf-column-default (function)

Writers

(setf ixf-column-default) (function)

Slot: pkey-pos

Readers

ixf-column-pkey-pos (function)

Writers

(setf ixf-column-pkey-pos) (function)

Slot: type

Readers

ixf-column-type (function)

Writers

(setf ixf-column-type) (function)

Slot: code-page

Readers

ixf-column-code-page (function)

Writers

(setf ixf-column-code-page) (function)

Slot: encoding

Readers

ixf-column-encoding (function)

Writers

(setf ixf-column-encoding) (function)

Slot: length

Readers

ixf-column-length (function)

Writers

(setf ixf-column-length) (function)

Slot: d-id

Readers

ixf-column-d-id (function)

Writers

(setf ixf-column-d-id) (function)

Slot: pos

Readers

ixf-column-pos (function)

Writers

(setf ixf-column-pos) (function)

Slot: desc

Readers

ixf-column-desc (function)

Writers

(setf ixf-column-desc) (function)

Structure: ixf-file ()

Package

ixf

Source

structs.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

• read-data (method)
• read-next-row (method)
• maybe-read-record (method)
• read-headers (method)
• parse-table-definition (method)
• parse-header (method)

Direct slots

Slot: stream

Readers

ixf-file-stream (function)

Writers

(setf ixf-file-stream) (function)

Slot: header

Readers

ixf-file-header (function)

Writers

(setf ixf-file-header) (function)

Slot: table

Readers

ixf-file-table (function)

Writers

(setf ixf-file-table) (function)

Slot: data-position

Readers

ixf-file-data-position (function)

Writers

(setf ixf-file-data-position) (function)

Structure: ixf-header ()

Package

ixf

Source

structs.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

parse-column-definition (method)

Direct slots

Slot: date

Readers

ixf-header-date (function)

Writers

(setf ixf-header-date) (function)

Slot: time

Readers

ixf-header-time (function)

Writers

(setf ixf-header-time) (function)

Slot: count

Readers

ixf-header-count (function)

Writers

(setf ixf-header-count) (function)

Slot: code-page

Readers

ixf-header-code-page (function)

Writers

(setf ixf-header-code-page) (function)

Slot: encoding

Readers

ixf-header-encoding (function)

Writers

(setf ixf-header-encoding) (function)

Structure: ixf-table ()

Package

ixf

Source

structs.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

ixf-table-name (function)

Writers

(setf ixf-table-name) (function)

Slot: creator

Readers

ixf-table-creator (function)

Writers

(setf ixf-table-creator) (function)

Slot: source

Readers

ixf-table-source (function)

Writers

(setf ixf-table-source) (function)

Slot: ncol

Readers

ixf-table-ncol (function)

Writers

(setf ixf-table-ncol) (function)

Slot: columns

Readers

ixf-table-columns (function)

Writers

(setf ixf-table-columns) (function)

Slot: pkey-name

Readers

ixf-table-pkey-name (function)

Writers

(setf ixf-table-pkey-name) (function)

Slot: desc

Readers

ixf-table-desc (function)

Writers

(setf ixf-table-desc) (function)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *ixf-application*

Definition of the IXF Application record.

Package

ixf

Source

records.lisp (file)

Special Variable: *ixf-column*

Package

ixf

Source

records.lisp (file)

Special Variable: *ixf-data*

Definition of the IXF Data record.

Package

ixf

Source

records.lisp (file)

Special Variable: *ixf-encodings-mapping*

A alist of mapping from IBM CCSID to babel encodings.

Package

ixf

Source

encodings.lisp (file)

Special Variable: *ixf-header*

Definition of the IXF Header record.

Package

ixf

Source

records.lisp (file)

Special Variable: *ixf-table*

Definition of the IXF Table record.

Package

ixf

Source

records.lisp (file)

Special Variable: *record-types*

All expected record types.

Package

ixf

Source

records.lisp (file)

5.2.2 Functions

Function: babel-encoding-for-code-page CODE-PAGE

Return a babel encoding for given CODE-PAGE.

Package

ixf

Source

encodings.lisp (file)

Function: check-record RECORD

Given a record, do some basic validity checking.

Package

ixf

Source

records.lisp (file)

Function: collect-records FILENAME

Validate that we can read FILENAME as an IXF file.

Package

ixf

Source

records.lisp (file)

Function: column-record-p RECORD

Package

ixf

Source

records.lisp (file)

Function: copy-ixf-column INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: copy-ixf-field INSTANCE

Package

ixf

Source

records.lisp (file)

Function: copy-ixf-file INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: copy-ixf-header INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: copy-ixf-table INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: data-record-p RECORD

Package

ixf

Source

records.lisp (file)

Function: field-name INSTANCE

Function: (setf field-name) VALUE INSTANCE

Package

ixf

Source

records.lisp (file)

Function: field-size INSTANCE

Function: (setf field-size) VALUE INSTANCE

Package

ixf

Source

records.lisp (file)

Function: field-type INSTANCE

Function: (setf field-type) VALUE INSTANCE

Package

ixf

Source

records.lisp (file)

Function: get-code-page CODE-PAGE

Return CODE-PAGE or NIL if it’s 00000

Package

ixf

Source

structs.lisp (file)

Function: get-record-property PROPERTY RECORD

Return the property value for PROPERTY (a symbol) as found in RECORD.

Package

ixf

Source

records.lisp (file)

Function: header-record-p RECORD

Package

ixf

Source

records.lisp (file)

Function: ixf-column-code-page INSTANCE

Function: (setf ixf-column-code-page) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-d-id INSTANCE

Function: (setf ixf-column-d-id) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-encoding INSTANCE

Function: (setf ixf-column-encoding) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-length INSTANCE

Function: (setf ixf-column-length) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-p OBJECT

Package

ixf

Source

structs.lisp (file)

Function: ixf-column-pos INSTANCE

Function: (setf ixf-column-pos) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-field-p OBJECT

Package

ixf

Source

records.lisp (file)

Function: ixf-file-data-position INSTANCE

Function: (setf ixf-file-data-position) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-file-stream INSTANCE

Function: (setf ixf-file-stream) VALUE INSTANCE

Package

ixf

Source

structs.lisp (file)

Function: ixf-header-p OBJECT

Package

ixf

Source

structs.lisp (file)

Function: ixf-table-p OBJECT

Package

ixf

Source

structs.lisp (file)

Function: make-field NAME SIZE TYPE

Package

ixf

Source

records.lisp (file)

Function: make-ixf-column &key (NAME NAME) (NULLABLE NULLABLE) (HAS-DEFAULT HAS-DEFAULT) (DEFAULT DEFAULT) (PKEY-POS PKEY-POS) (TYPE TYPE) (CODE-PAGE CODE-PAGE) (ENCODING ENCODING) (LENGTH LENGTH) (D-ID D-ID) (POS POS) (DESC DESC)

Package

ixf

Source

structs.lisp (file)

Function: make-ixf-header &key (DATE DATE) (TIME TIME) (COUNT COUNT) (CODE-PAGE CODE-PAGE) (ENCODING ENCODING)

Package

ixf

Source

structs.lisp (file)

Function: make-ixf-table &key (NAME NAME) (CREATOR CREATOR) (SOURCE SOURCE) (NCOL NCOL) (COLUMNS COLUMNS) (PKEY-NAME PKEY-NAME) (DESC DESC)

Package

ixf

Source

structs.lisp (file)

Function: parse-encoding RECORD SINGLE-CP-PROPERTY DOUBLE-CP-PROPERTY &key STRICT

Read the encoding from the RECORD with properties such as :IXFHSBCP and :IXFHDBCP, or :IXFCSBCP and :IXFCDBCP

Package

ixf

Source

structs.lisp (file)

Function: parse-ixf-bigint DATA POS

Read a signed 8-byte integer.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-data IXF COLUMN DATA

Read data at given POSITION in DATA, with given LENGTH and DATA-TYPE.

Package

ixf

Source

data.lisp (file)

Function: parse-ixf-date DATA POS

Read an IXF date ascii string.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-decimal DATA POS PRECISION SCALE

Read a DECIMAL BCD IBM format.

The right documentation to be able to make sense of the data seems to be found at http://www.simotime.com/datapk01.htm, at least it allows progress to be made.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-float DATA POS LENGTH

Parse a FLOATING POINT machine IBM format.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-integer DATA POS

Read a signed 4-byte integer.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-lls DATA POS &key RELATIVE-TO ELEMENT-TYPE EXTERNAL-FORMAT

Parse a LOB Location Specifier.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-null DATA POS

Read a NULL indicator and returns t when the value is NULL.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-smallint DATA POS

Read a 2-byte integer.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-string DATA POS LENGTH

Read an encoded string in data from pos to length.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-time DATA POS

Read an IXF time ascii string.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-timestamp DATA POS LENGTH

Read an IXF timestamp string.

From the docs:

Each time stamp is a character string of the form yyyy-mm-dd-hh.mm.ss.nnnnnn (year month day hour minutes seconds fractional seconds).

Starting with Version 9.7, the timestamp precision is contained in the IXFCLENG field of the column descriptor record, and cannot exceed 12. before Version 9.7, IXFCLENG is not used, and should contain blanks.

Valid characters within TIMESTAMP are invariant in all PC ASCII code pages; therefore, IXFCSBCP and IXFCDBCP are not significant, and should be zero.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-unsigned-bigint DATA POS

Read an unsigned 8-byte integer.

Package

ixf

Source

types.lisp (file)

Function: parse-ixf-unsigned-integer DATA POS

Read an unsigned 4-byte integer.

Package

ixf

Source

types.lisp (file)

Function: read-ascii-string STREAM SIZE

Read an ascii string of SIZE characters from STREAM.

Package

ixf

Source

records.lisp (file)

Function: read-binary-data STREAM SIZE

Read a bunch of SIZE bytes in STREAM.

Package

ixf

Source

records.lisp (file)

Function: read-character STREAM

Read a single character from the binary STREAM.

Package

ixf

Source

records.lisp (file)

Function: read-field STREAM FIELD START LENGTH

Read the next bytes of STREAM according to field definition.

Package

ixf

Source

records.lisp (file)

Function: read-integer STREAM SIZE

Read a character encoded integer of SIZE from binary STREAM.

Package

ixf

Source

records.lisp (file)

Function: read-record STREAM RECORD-DEFINITION START LENGTH

Read the next bytes of STREAM according to record definition

Package

ixf

Source

records.lisp (file)

Function: table-record-p RECORD

Package

ixf

Source

records.lisp (file)

Function: unsigned-to-signed BYTE N

Package

ixf

Source

types.lisp (file)

Function: validate-file FILENAME

Validate that we can read FILENAME as an IXF file.

Package

ixf

Source

records.lisp (file)

5.2.3 Generic functions

Generic Function: maybe-read-record IXF COL D-ID

Package

ixf

Methods

Method: maybe-read-record (IXF ixf-file) (COL ixf-column) D-ID

Compare current D-ID value with expected (ixf-column-d-id col) and read another record when they don’t match

Source

data.lisp (file)

Generic Function: parse-column-definition COL HEADER RECORD

Package

ixf

Methods

Method: parse-column-definition (COL ixf-column) (HEADER ixf-header) RECORD

Parse a Column definition from its record.

Source

structs.lisp (file)

Generic Function: parse-header IXF RECORD

Package

ixf

Methods

Method: parse-header (IXF ixf-file) RECORD

Given a record alist, parse its definition into IXF.

Source

structs.lisp (file)

Generic Function: parse-table-definition IXF RECORD

Package

ixf

Methods

Method: parse-table-definition (IXF ixf-file) RECORD

Parse a Table definition from its record.

Source

structs.lisp (file)

5.2.4 Structures

Structure: ixf-field ()

Package

ixf

Source

records.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: name

Readers

field-name (function)

Writers

(setf field-name) (function)

Slot: size

Readers

field-size (function)

Writers

(setf field-size) (function)

Slot: type

Readers

field-type (function)

Writers

(setf field-type) (function)

Appendix A Indexes

A.1 Concepts

A.2 Functions