This is the ixf Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Sep 15 04:07:06 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
ixf
Tools to handle IBM PC version of IXF file format
Dimitri Fontaine <dim@tapoueh.org>
WTFPL
0.1.0
split-sequence
(system).
md5
(system).
alexandria
(system).
babel
(system).
local-time
(system).
cl-ppcre
(system).
ieee-floats
(system).
package.lisp
(file).
records.lisp
(file).
types.lisp
(file).
encodings.lisp
(file).
structs.lisp
(file).
data.lisp
(file).
ixf.lisp
(file).
Files are sorted by type and then listed depth-first from the systems components trees.
ixf/ixf.asd
ixf/package.lisp
ixf/records.lisp
ixf/types.lisp
ixf/encodings.lisp
ixf/structs.lisp
ixf/data.lisp
ixf/ixf.lisp
ixf/records.lisp
package.lisp
(file).
ixf
(system).
read-next-record
(function).
*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).
ixf/types.lisp
package.lisp
(file).
records.lisp
(file).
ixf
(system).
+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).
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).
ixf/encodings.lisp
package.lisp
(file).
types.lisp
(file).
ixf
(system).
*ixf-encodings-mapping*
(special variable).
babel-encoding-for-code-page
(function).
ixf/structs.lisp
package.lisp
(file).
records.lisp
(file).
types.lisp
(file).
encodings.lisp
(file).
ixf
(system).
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).
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).
ixf/data.lisp
package.lisp
(file).
structs.lisp
(file).
records.lisp
(file).
types.lisp
(file).
ixf
(system).
read-next-row
(method).
maybe-read-record
(method).
parse-ixf-data
(function).
ixf/ixf.lisp
package.lisp
(file).
records.lisp
(file).
types.lisp
(file).
structs.lisp
(file).
data.lisp
(file).
ixf
(system).
map-data
(function).
read-data
(method).
read-ixf-file
(function).
with-ixf-file
(macro).
with-ixf-stream
(macro).
Packages are listed by definition order.
ixf
common-lisp
.
+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).
*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).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Executes BODY with VAR an IXF-FILE instance made from FILENAME stream contents.
Executes BODY with VAR an IXF-FILE instance made from STREAM.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
Call map-fn on each row of data read from STREAM given IXF definition.
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.
Discover next record length and type, then read it.
ixf
.
ixf
.
structure-object
.
common-lisp
.
common-lisp
.
A alist of mapping from IBM CCSID to babel encodings.
ixf
.
Return a babel encoding for given CODE-PAGE.
ixf
.
Given a record, do some basic validity checking.
ixf
.
Validate that we can read FILENAME as an IXF file.
ixf
.
Return the property value for PROPERTY (a symbol) as found in RECORD.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
ixf
.
Read the encoding from the RECORD with properties such as :IXFHSBCP and :IXFHDBCP, or :IXFCSBCP and :IXFCDBCP
ixf
.
Read data at given POSITION in DATA, with given LENGTH and DATA-TYPE.
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.
ixf
.
Parse a FLOATING POINT machine IBM format.
ixf
.
Parse a LOB Location Specifier.
ixf
.
Read a NULL indicator and returns t when the value is NULL.
ixf
.
Read an encoded string in data from pos to length.
ixf
.
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.
ixf
.
Read an unsigned 8-byte integer.
ixf
.
Read an unsigned 4-byte integer.
ixf
.
Read an ascii string of SIZE characters from STREAM.
ixf
.
Read a bunch of SIZE bytes in STREAM.
ixf
.
Read a single character from the binary STREAM.
ixf
.
Read the next bytes of STREAM according to field definition.
ixf
.
Read a character encoded integer of SIZE from binary STREAM.
ixf
.
Read the next bytes of STREAM according to record definition
ixf
.
Validate that we can read FILENAME as an IXF file.
ixf
.
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
ixf
.
ixf-column
) (header ixf-header
) record) ¶Parse a Column definition from its record.
Jump to: | (
B C D F G H I M P R T U V W |
---|
Jump to: | (
B C D F G H I M P R T U V W |
---|
Jump to: | *
+
C D E H L N P S T |
---|
Jump to: | *
+
C D E H L N P S T |
---|
Jump to: | D E F I P R S T |
---|
Jump to: | D E F I P R S T |
---|