The ixf Reference Manual

Child 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.

Lisp

3.1.1 `ixf/ixf.asd`

Source: ixf.asd.
Parent Component: ixf (system).
ASDF Systems: ixf.

3.1.2 `ixf/package.lisp`

Source: ixf.asd.
Parent Component: ixf (system).
Packages: ixf.

3.1.3 `ixf/records.lisp`

Dependency

package.lisp (file).

Source

Parent Component

ixf (system).

Public Interface

read-next-record (function).

Internals

*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 (reader).
(setf field-name) (writer).
field-size (reader).
(setf field-size) (writer).
field-type (reader).
(setf field-type) (writer).
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

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

Source

Parent Component

ixf (system).

Public Interface

+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).

Internals

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

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

Source

Parent Component

ixf (system).

Internals

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

3.1.6 `ixf/structs.lisp`

Dependencies

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

Source

Parent Component

ixf (system).

Public Interface

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

Internals

copy-ixf-column (function).
copy-ixf-file (function).
copy-ixf-header (function).
copy-ixf-table (function).
get-code-page (function).
ixf-column-code-page (reader).
(setf ixf-column-code-page) (writer).
ixf-column-d-id (reader).
(setf ixf-column-d-id) (writer).
ixf-column-encoding (reader).
(setf ixf-column-encoding) (writer).
ixf-column-length (reader).
(setf ixf-column-length) (writer).
ixf-column-p (function).
ixf-column-pos (reader).
(setf ixf-column-pos) (writer).
ixf-file-data-position (reader).
(setf ixf-file-data-position) (writer).
ixf-file-stream (reader).
(setf ixf-file-stream) (writer).
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

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

Source

Parent Component

ixf (system).

Public Interface

read-next-row (method).

Internals

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

3.1.8 `ixf/ixf.lisp`

Dependencies

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

Source

Parent Component

ixf (system).

Public Interface

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.

ixf

4.1 `ixf`

Source

package.lisp.

Use List

common-lisp.

Public Interface

+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 (reader).
(setf ixf-column-default) (writer).
ixf-column-desc (reader).
(setf ixf-column-desc) (writer).
ixf-column-has-default (reader).
(setf ixf-column-has-default) (writer).
ixf-column-name (reader).
(setf ixf-column-name) (writer).
ixf-column-nullable (reader).
(setf ixf-column-nullable) (writer).
ixf-column-pkey-pos (reader).
(setf ixf-column-pkey-pos) (writer).
ixf-column-type (reader).
(setf ixf-column-type) (writer).
ixf-file (structure).
ixf-file-header (reader).
(setf ixf-file-header) (writer).
ixf-file-p (function).
ixf-file-table (reader).
(setf ixf-file-table) (writer).
ixf-header (structure).
ixf-header-code-page (reader).
(setf ixf-header-code-page) (writer).
ixf-header-count (reader).
(setf ixf-header-count) (writer).
ixf-header-date (reader).
(setf ixf-header-date) (writer).
ixf-header-encoding (reader).
(setf ixf-header-encoding) (writer).
ixf-header-time (reader).
(setf ixf-header-time) (writer).
ixf-table (structure).
ixf-table-columns (reader).
(setf ixf-table-columns) (writer).
ixf-table-creator (reader).
(setf ixf-table-creator) (writer).
ixf-table-desc (reader).
(setf ixf-table-desc) (writer).
ixf-table-name (reader).
(setf ixf-table-name) (writer).
ixf-table-ncol (reader).
(setf ixf-table-ncol) (writer).
ixf-table-pkey-name (reader).
(setf ixf-table-pkey-name) (writer).
ixf-table-source (reader).
(setf ixf-table-source) (writer).
make-ixf-file (function).
map-data (function).
read-data (generic function).
read-headers (generic function).
read-ixf-file (function).
read-next-record (function).
read-next-row (generic function).
with-ixf-file (macro).
with-ixf-stream (macro).

Internals

*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 (reader).
(setf field-name) (writer).
field-size (reader).
(setf field-size) (writer).
field-type (reader).
(setf field-type) (writer).
get-code-page (function).
get-record-property (function).
header-record-p (function).
ixf-column-code-page (reader).
(setf ixf-column-code-page) (writer).
ixf-column-d-id (reader).
(setf ixf-column-d-id) (writer).
ixf-column-encoding (reader).
(setf ixf-column-encoding) (writer).
ixf-column-length (reader).
(setf ixf-column-length) (writer).
ixf-column-p (function).
ixf-column-pos (reader).
(setf ixf-column-pos) (writer).
ixf-field (structure).
ixf-field-p (function).
ixf-file-data-position (reader).
(setf ixf-file-data-position) (writer).
ixf-file-stream (reader).
(setf ixf-file-stream) (writer).
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).
parse-column-definition (generic function).
parse-encoding (function).
parse-header (generic function).
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).
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.

Public Interface
Internals

5.1 Public Interface

Constants
Macros
Ordinary functions
Generic functions
Structures

5.1.1 Constants

Constant: +bigint+ ¶

Package: ixf.
Source: types.lisp.

Constant: +blob+ ¶

Package: ixf.
Source: types.lisp.

Constant: +blob-file+ ¶

Package: ixf.
Source: types.lisp.

Constant: +blob-location-spec+ ¶

Package: ixf.
Source: types.lisp.

Constant: +char+ ¶

Package: ixf.
Source: types.lisp.

Constant: +clob+ ¶

Package: ixf.
Source: types.lisp.

Constant: +clob-file+ ¶

Package: ixf.
Source: types.lisp.

Constant: +date+ ¶

Package: ixf.
Source: types.lisp.

Constant: +dbblob-location-spec+ ¶

Package: ixf.
Source: types.lisp.

Constant: +dbclob+ ¶

Package: ixf.
Source: types.lisp.

Constant: +dbclob-file+ ¶

Package: ixf.
Source: types.lisp.

Constant: +dbclob-location-spec+ ¶

Package: ixf.
Source: types.lisp.

Constant: +decfloat+ ¶

Package: ixf.
Source: types.lisp.

Constant: +decimal+ ¶

Package: ixf.
Source: types.lisp.

Constant: +float+ ¶

Package: ixf.
Source: types.lisp.

Constant: +graphic+ ¶

Package: ixf.
Source: types.lisp.

Constant: +integer+ ¶

Package: ixf.
Source: types.lisp.

Constant: +longvarchar+ ¶

Package: ixf.
Source: types.lisp.

Constant: +longvargraphic+ ¶

Package: ixf.
Source: types.lisp.

Constant: +smallint+ ¶

Package: ixf.
Source: types.lisp.

Constant: +time+ ¶

Package: ixf.
Source: types.lisp.

Constant: +timestamp+ ¶

Package: ixf.
Source: types.lisp.

Constant: +varchar+ ¶

Package: ixf.
Source: types.lisp.

Constant: +vargraphic+ ¶

Package: ixf.
Source: types.lisp.

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.

Macro: with-ixf-stream ((var stream) &body body) ¶

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

Package: ixf.
Source: ixf.lisp.

5.1.3 Ordinary functions

Reader: ixf-column-default (instance) ¶

Writer: (setf ixf-column-default) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: default.

Reader: ixf-column-desc (instance) ¶

Writer: (setf ixf-column-desc) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: desc.

Reader: ixf-column-has-default (instance) ¶

Writer: (setf ixf-column-has-default) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: has-default.

Reader: ixf-column-name (instance) ¶

Writer: (setf ixf-column-name) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: name.

Reader: ixf-column-nullable (instance) ¶

Writer: (setf ixf-column-nullable) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: nullable.

Reader: ixf-column-pkey-pos (instance) ¶

Writer: (setf ixf-column-pkey-pos) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: pkey-pos.

Reader: ixf-column-type (instance) ¶

Writer: (setf ixf-column-type) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: type.

Reader: ixf-file-header (instance) ¶

Writer: (setf ixf-file-header) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: header.

Function: ixf-file-p (object) ¶

Package: ixf.
Source: structs.lisp.

Reader: ixf-file-table (instance) ¶

Writer: (setf ixf-file-table) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: table.

Reader: ixf-header-code-page (instance) ¶

Writer: (setf ixf-header-code-page) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: code-page.

Reader: ixf-header-count (instance) ¶

Writer: (setf ixf-header-count) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: count.

Reader: ixf-header-date (instance) ¶

Writer: (setf ixf-header-date) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: date.

Reader: ixf-header-encoding (instance) ¶

Writer: (setf ixf-header-encoding) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: encoding.

Reader: ixf-header-time (instance) ¶

Writer: (setf ixf-header-time) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: time.

Reader: ixf-table-columns (instance) ¶

Writer: (setf ixf-table-columns) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: columns.

Reader: ixf-table-creator (instance) ¶

Writer: (setf ixf-table-creator) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: creator.

Reader: ixf-table-desc (instance) ¶

Writer: (setf ixf-table-desc) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: desc.

Reader: ixf-table-name (instance) ¶

Writer: (setf ixf-table-name) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: name.

Reader: ixf-table-ncol (instance) ¶

Writer: (setf ixf-table-ncol) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: ncol.

Reader: ixf-table-pkey-name (instance) ¶

Writer: (setf ixf-table-pkey-name) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: pkey-name.

Reader: ixf-table-source (instance) ¶

Writer: (setf ixf-table-source) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: source.

Function: make-ixf-file (&key stream header table data-position) ¶

Package: ixf.
Source: structs.lisp.

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.

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.

Function: read-next-record (stream) ¶

Discover next record length and type, then read it.

Package: ixf.
Source: records.lisp.

5.1.4 Generic functions

Generic Function: read-data (ixf) ¶

Package

Methods

Method: read-data ((ixf ixf-file)) ¶

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

Source: ixf.lisp.

Generic Function: read-headers (ixf) ¶

Package

Methods

Method: read-headers ((ixf ixf-file)) ¶

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

Source: structs.lisp.

Generic Function: read-next-row (ixf first-record) ¶

Package

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.

5.1.5 Structures

Structure: ixf-column ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

maybe-read-record.
parse-column-definition.

Direct slots

Slot: name ¶

Readers: ixf-column-name.
Writers: (setf ixf-column-name).

Slot: nullable ¶

Readers: ixf-column-nullable.
Writers: (setf ixf-column-nullable).

Slot: has-default ¶

Readers: ixf-column-has-default.
Writers: (setf ixf-column-has-default).

Slot: default ¶

Readers: ixf-column-default.
Writers: (setf ixf-column-default).

Slot: pkey-pos ¶

Readers: ixf-column-pkey-pos.
Writers: (setf ixf-column-pkey-pos).

Slot: type ¶

Package: common-lisp.
Readers: ixf-column-type.
Writers: (setf ixf-column-type).

Slot: code-page ¶

Readers: ixf-column-code-page.
Writers: (setf ixf-column-code-page).

Slot: encoding ¶

Readers: ixf-column-encoding.
Writers: (setf ixf-column-encoding).

Slot: length ¶

Package: common-lisp.
Readers: ixf-column-length.
Writers: (setf ixf-column-length).

Slot: d-id ¶

Readers: ixf-column-d-id.
Writers: (setf ixf-column-d-id).

Slot: pos ¶

Readers: ixf-column-pos.
Writers: (setf ixf-column-pos).

Slot: desc ¶

Readers: ixf-column-desc.
Writers: (setf ixf-column-desc).

Structure: ixf-file ¶

Package

Source

Direct superclasses

structure-object.

Direct methods

maybe-read-record.
parse-header.
parse-table-definition.
read-data.
read-headers.
read-next-row.

Direct slots

Slot: stream ¶

Package: common-lisp.
Readers: ixf-file-stream.
Writers: (setf ixf-file-stream).

Slot: header ¶

Readers: ixf-file-header.
Writers: (setf ixf-file-header).

Slot: table ¶

Readers: ixf-file-table.
Writers: (setf ixf-file-table).

Slot: data-position ¶

Readers: ixf-file-data-position.
Writers: (setf ixf-file-data-position).

Structure: ixf-header ¶

Package

Source

parse-column-definition.

Direct superclasses

structure-object.

Direct methods

Direct slots

Slot: date ¶

Readers: ixf-header-date.
Writers: (setf ixf-header-date).

Slot: time ¶

Package: common-lisp.
Readers: ixf-header-time.
Writers: (setf ixf-header-time).

Slot: count ¶

Package: common-lisp.
Readers: ixf-header-count.
Writers: (setf ixf-header-count).

Slot: code-page ¶

Readers: ixf-header-code-page.
Writers: (setf ixf-header-code-page).

Slot: encoding ¶

Readers: ixf-header-encoding.
Writers: (setf ixf-header-encoding).

Structure: ixf-table ¶

Package

Source

Direct superclasses

structure-object.

Direct slots

Slot: name ¶

Readers: ixf-table-name.
Writers: (setf ixf-table-name).

Slot: creator ¶

Readers: ixf-table-creator.
Writers: (setf ixf-table-creator).

Slot: source ¶

Readers: ixf-table-source.
Writers: (setf ixf-table-source).

Slot: ncol ¶

Readers: ixf-table-ncol.
Writers: (setf ixf-table-ncol).

Slot: columns ¶

Readers: ixf-table-columns.
Writers: (setf ixf-table-columns).

Slot: pkey-name ¶

Readers: ixf-table-pkey-name.
Writers: (setf ixf-table-pkey-name).

Slot: desc ¶

Readers: ixf-table-desc.
Writers: (setf ixf-table-desc).

5.2 Internals

Special variables
Ordinary functions
Generic functions
Structures

5.2.1 Special variables

Special Variable: *ixf-application* ¶

Definition of the IXF Application record.

Package: ixf.
Source: records.lisp.

Special Variable: *ixf-column* ¶

Package: ixf.
Source: records.lisp.

Special Variable: *ixf-data* ¶

Definition of the IXF Data record.

Package: ixf.
Source: records.lisp.

Special Variable: *ixf-encodings-mapping* ¶

A alist of mapping from IBM CCSID to babel encodings.

Package: ixf.
Source: encodings.lisp.

Special Variable: *ixf-header* ¶

Definition of the IXF Header record.

Package: ixf.
Source: records.lisp.

Special Variable: *ixf-table* ¶

Definition of the IXF Table record.

Package: ixf.
Source: records.lisp.

Special Variable: *record-types* ¶

All expected record types.

Package: ixf.
Source: records.lisp.

5.2.2 Ordinary functions

Function: babel-encoding-for-code-page (code-page) ¶

Return a babel encoding for given CODE-PAGE.

Package: ixf.
Source: encodings.lisp.

Function: check-record (record) ¶

Given a record, do some basic validity checking.

Package: ixf.
Source: records.lisp.

Function: collect-records (filename) ¶

Validate that we can read FILENAME as an IXF file.

Package: ixf.
Source: records.lisp.

Function: column-record-p (record) ¶

Package: ixf.
Source: records.lisp.

Function: copy-ixf-column (instance) ¶

Package: ixf.
Source: structs.lisp.

Function: copy-ixf-field (instance) ¶

Package: ixf.
Source: records.lisp.

Function: copy-ixf-file (instance) ¶

Package: ixf.
Source: structs.lisp.

Function: copy-ixf-header (instance) ¶

Package: ixf.
Source: structs.lisp.

Function: copy-ixf-table (instance) ¶

Package: ixf.
Source: structs.lisp.

Function: data-record-p (record) ¶

Package: ixf.
Source: records.lisp.

Reader: field-name (instance) ¶

Writer: (setf field-name) (instance) ¶

Package: ixf.
Source: records.lisp.
Target Slot: name.

Reader: field-size (instance) ¶

Writer: (setf field-size) (instance) ¶

Package: ixf.
Source: records.lisp.
Target Slot: size.

Reader: field-type (instance) ¶

Writer: (setf field-type) (instance) ¶

Package: ixf.
Source: records.lisp.
Target Slot: type.

Function: get-code-page (code-page) ¶

Return CODE-PAGE or NIL if it’s 00000

Package: ixf.
Source: structs.lisp.

Function: get-record-property (property record) ¶

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

Package: ixf.
Source: records.lisp.

Function: header-record-p (record) ¶

Package: ixf.
Source: records.lisp.

Reader: ixf-column-code-page (instance) ¶

Writer: (setf ixf-column-code-page) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: code-page.

Reader: ixf-column-d-id (instance) ¶

Writer: (setf ixf-column-d-id) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: d-id.

Reader: ixf-column-encoding (instance) ¶

Writer: (setf ixf-column-encoding) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: encoding.

Reader: ixf-column-length (instance) ¶

Writer: (setf ixf-column-length) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: length.

Function: ixf-column-p (object) ¶

Package: ixf.
Source: structs.lisp.

Reader: ixf-column-pos (instance) ¶

Writer: (setf ixf-column-pos) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: pos.

Function: ixf-field-p (object) ¶

Package: ixf.
Source: records.lisp.

Reader: ixf-file-data-position (instance) ¶

Writer: (setf ixf-file-data-position) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: data-position.

Reader: ixf-file-stream (instance) ¶

Writer: (setf ixf-file-stream) (instance) ¶

Package: ixf.
Source: structs.lisp.
Target Slot: stream.

Function: ixf-header-p (object) ¶

Package: ixf.
Source: structs.lisp.

Function: ixf-table-p (object) ¶

Package: ixf.
Source: structs.lisp.

Function: make-field (name size type) ¶

Package: ixf.
Source: records.lisp.

Function: make-ixf-column (&key name nullable has-default default pkey-pos type code-page encoding length d-id pos desc) ¶

Package: ixf.
Source: structs.lisp.

Function: make-ixf-header (&key date time count code-page encoding) ¶

Package: ixf.
Source: structs.lisp.

Function: make-ixf-table (&key name creator source ncol columns pkey-name desc) ¶

Package: ixf.
Source: structs.lisp.

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.

Function: parse-ixf-bigint (data pos) ¶

Read a signed 8-byte integer.

Package: ixf.
Source: types.lisp.

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.

Function: parse-ixf-date (data pos) ¶

Read an IXF date ascii string.

Package: ixf.
Source: types.lisp.

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.

Function: parse-ixf-float (data pos length) ¶

Parse a FLOATING POINT machine IBM format.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-integer (data pos) ¶

Read a signed 4-byte integer.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-lls (data pos &key relative-to element-type external-format) ¶

Parse a LOB Location Specifier.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-null (data pos) ¶

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

Package: ixf.
Source: types.lisp.

Function: parse-ixf-smallint (data pos) ¶

Read a 2-byte integer.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-string (data pos length) ¶

Read an encoded string in data from pos to length.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-time (data pos) ¶

Read an IXF time ascii string.

Package: ixf.
Source: types.lisp.

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.

Function: parse-ixf-unsigned-bigint (data pos) ¶

Read an unsigned 8-byte integer.

Package: ixf.
Source: types.lisp.

Function: parse-ixf-unsigned-integer (data pos) ¶

Read an unsigned 4-byte integer.

Package: ixf.
Source: types.lisp.

Function: read-ascii-string (stream size) ¶

Read an ascii string of SIZE characters from STREAM.

Package: ixf.
Source: records.lisp.

Function: read-binary-data (stream size) ¶

Read a bunch of SIZE bytes in STREAM.

Package: ixf.
Source: records.lisp.

Function: read-character (stream) ¶

Read a single character from the binary STREAM.

Package: ixf.
Source: records.lisp.

Function: read-field (stream field start length) ¶

Read the next bytes of STREAM according to field definition.

Package: ixf.
Source: records.lisp.

Function: read-integer (stream size) ¶

Read a character encoded integer of SIZE from binary STREAM.

Package: ixf.
Source: records.lisp.

Function: read-record (stream record-definition start length) ¶

Read the next bytes of STREAM according to record definition

Package: ixf.
Source: records.lisp.

Function: table-record-p (record) ¶

Package: ixf.
Source: records.lisp.

Function: unsigned-to-signed (byte n) ¶

Package: ixf.
Source: types.lisp.

Function: validate-file (filename) ¶

Validate that we can read FILENAME as an IXF file.

Package: ixf.
Source: records.lisp.

5.2.3 Generic functions

Generic Function: maybe-read-record (ixf col d-id) ¶

Package

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.

Generic Function: parse-column-definition (col header record) ¶

Package

Methods

Method: parse-column-definition ((col ixf-column) (header ixf-header) record) ¶

Parse a Column definition from its record.

Source: structs.lisp.

Generic Function: parse-header (ixf record) ¶

Package

Methods

Method: parse-header ((ixf ixf-file) record) ¶

Given a record alist, parse its definition into IXF.

Source: structs.lisp.

Generic Function: parse-table-definition (ixf record) ¶

Package

Methods

Method: parse-table-definition ((ixf ixf-file) record) ¶

Parse a Table definition from its record.

Source: structs.lisp.

5.2.4 Structures

Structure: ixf-field ¶

Package