The db3 Reference Manual

This is the db3 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:08:16 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 db3

DB3 file reader

Author

Xach

License

WTFPL

Source

db3.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 db3/db3.asd

Source

db3.asd.

Parent Component

db3 (system).

ASDF Systems

db3.


3.1.2 db3/package.lisp

Source

db3.asd.

Parent Component

db3 (system).

Packages

db3.


3.1.3 db3/db3.lisp

Dependency

package.lisp (file).

Source

db3.asd.

Parent Component

db3 (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 db3

Source

package.lisp.

Use List

common-lisp.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *external-format*

External format of the DBF file Character data

Package

db3.

Source

db3.lisp.


5.1.2 Ordinary functions

Function: dump-db3 (input output)
Package

db3.

Source

db3.lisp.

Function: sample-db3 (input ostream &key sample-size)
Package

db3.

Source

db3.lisp.

Function: write-record (record stream)
Package

db3.

Source

db3.lisp.


5.1.3 Generic functions

Generic Function: close-memo (db3)
Package

db3.

Methods
Method: close-memo ((db3 db3))
Source

db3.lisp.

Generic Function: load-header (db3 stream)
Package

db3.

Methods
Method: load-header ((db3 db3) stream)
Source

db3.lisp.

Generic Function: load-record (db3 stream)
Package

db3.

Methods
Method: load-record ((db3 db3) stream)
Source

db3.lisp.

Generic Reader: record-count (object)
Package

db3.

Methods
Reader Method: record-count ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

record-count.

Generic Writer: (setf record-count) (object)
Package

db3.

Methods
Writer Method: (setf record-count) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

record-count.


5.1.4 Classes

Class: db3
Package

db3.

Source

db3.lisp.

Direct methods
Direct slots
Slot: filename
Initargs

:filename

Readers

filename.

Writers

(setf filename).

Slot: memo
Readers

memo.

Writers

(setf memo).

Slot: version-number
Readers

version-number.

Writers

(setf version-number).

Slot: last-update
Readers

last-update.

Writers

(setf last-update).

Slot: record-count
Readers

record-count.

Writers

(setf record-count).

Slot: header-length
Readers

header-length.

Writers

(setf header-length).

Slot: record-length
Readers

record-length.

Writers

(setf record-length).

Slot: encoding
Readers

encoding.

Writers

(setf encoding).

Slot: fields
Readers

fields.

Writers

(setf fields).


5.2 Internals


5.2.1 Special variables

Special Variable: *code-page-list*
Package

db3.

Source

db3.lisp.


5.2.2 Ordinary functions

Function: ascii->string (array)
Package

db3.

Source

db3.lisp.

Function: asciiz->string (array)
Package

db3.

Source

db3.lisp.

Function: bytes->bigint (data)
Package

db3.

Source

db3.lisp.

Function: bytes->integer (data)
Package

db3.

Source

db3.lisp.

Function: inspect-db3 (input ostream &key sample-size)
Package

db3.

Source

db3.lisp.

Function: language-driver-to-encoding (language-driver)
Package

db3.

Source

db3.lisp.

Function: load-field-descriptor (stream)
Package

db3.

Source

db3.lisp.

Function: read-uint16 (stream)
Package

db3.

Source

db3.lisp.

Function: read-uint32 (stream)
Package

db3.

Source

db3.lisp.

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

db3.

Source

db3.lisp.


5.2.3 Generic functions

Generic Reader: block-data (object)
Package

db3.

Methods
Reader Method: block-data ((db3-memo-block db3-memo-block))

automatically generated reader method

Source

db3.lisp.

Target Slot

data.

Generic Writer: (setf block-data) (object)
Package

db3.

Methods
Writer Method: (setf block-data) ((db3-memo-block db3-memo-block))

automatically generated writer method

Source

db3.lisp.

Target Slot

data.

Generic Reader: block-size (object)
Package

db3.

Methods
Reader Method: block-size ((db3-memo-block db3-memo-block))

automatically generated reader method

Source

db3.lisp.

Target Slot

size.

Reader Method: block-size ((db3-memo db3-memo))

automatically generated reader method

Source

db3.lisp.

Target Slot

block-size.

Generic Writer: (setf block-size) (object)
Package

db3.

Methods
Writer Method: (setf block-size) ((db3-memo-block db3-memo-block))

automatically generated writer method

Source

db3.lisp.

Target Slot

size.

Writer Method: (setf block-size) ((db3-memo db3-memo))

automatically generated writer method

Source

db3.lisp.

Target Slot

block-size.

Generic Reader: block-type (object)
Package

db3.

Methods
Reader Method: block-type ((db3-memo-block db3-memo-block))

automatically generated reader method

Source

db3.lisp.

Target Slot

type.

Generic Writer: (setf block-type) (object)
Package

db3.

Methods
Writer Method: (setf block-type) ((db3-memo-block db3-memo-block))

automatically generated writer method

Source

db3.lisp.

Target Slot

type.

Generic Function: convert-field (db3 type data)
Package

db3.

Methods
Method: convert-field (db3 (type (eql #\m)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\c)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\f)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\y)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\+)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\i)) data)
Source

db3.lisp.

Method: convert-field (db3 (type (eql #\0)) data)
Source

db3.lisp.

Method: convert-field (db3 type data)
Source

db3.lisp.

Generic Reader: data-address (object)
Package

db3.

Methods
Reader Method: data-address ((db3-field db3-field))

automatically generated reader method

Source

db3.lisp.

Target Slot

data-address.

Generic Writer: (setf data-address) (object)
Package

db3.

Methods
Writer Method: (setf data-address) ((db3-field db3-field))

automatically generated writer method

Source

db3.lisp.

Target Slot

data-address.

Generic Reader: db3-memo-stream (object)
Package

db3.

Methods
Reader Method: db3-memo-stream ((db3-memo db3-memo))

automatically generated reader method

Source

db3.lisp.

Target Slot

stream.

Generic Writer: (setf db3-memo-stream) (object)
Package

db3.

Methods
Writer Method: (setf db3-memo-stream) ((db3-memo db3-memo))

automatically generated writer method

Source

db3.lisp.

Target Slot

stream.

Generic Reader: encoding (object)
Package

db3.

Methods
Reader Method: encoding ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

encoding.

Generic Writer: (setf encoding) (object)
Package

db3.

Methods
Writer Method: (setf encoding) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

encoding.

Generic Function: field-count (object)
Package

db3.

Methods
Method: field-count ((db3 db3))
Source

db3.lisp.

Reader Method: field-count ((db3-field db3-field))

automatically generated reader method

Source

db3.lisp.

Target Slot

field-count.

Generic Writer: (setf field-count) (object)
Package

db3.

Methods
Writer Method: (setf field-count) ((db3-field db3-field))

automatically generated writer method

Source

db3.lisp.

Target Slot

field-count.

Generic Reader: field-length (object)
Package

db3.

Methods
Reader Method: field-length ((db3-field db3-field))

automatically generated reader method

Source

db3.lisp.

Target Slot

field-length.

Generic Writer: (setf field-length) (object)
Package

db3.

Methods
Writer Method: (setf field-length) ((db3-field db3-field))

automatically generated writer method

Source

db3.lisp.

Target Slot

field-length.

Generic Reader: field-name (object)
Package

db3.

Methods
Reader Method: field-name ((db3-field db3-field))

automatically generated reader method

Source

db3.lisp.

Target Slot

name.

Generic Writer: (setf field-name) (object)
Package

db3.

Methods
Writer Method: (setf field-name) ((db3-field db3-field))

automatically generated writer method

Source

db3.lisp.

Target Slot

name.

Generic Reader: field-type (object)
Package

db3.

Methods
Reader Method: field-type ((db3-field db3-field))

automatically generated reader method

Source

db3.lisp.

Target Slot

type.

Generic Writer: (setf field-type) (object)
Package

db3.

Methods
Writer Method: (setf field-type) ((db3-field db3-field))

automatically generated writer method

Source

db3.lisp.

Target Slot

type.

Generic Reader: fields (object)
Package

db3.

Methods
Reader Method: fields ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

fields.

Generic Writer: (setf fields) (object)
Package

db3.

Methods
Writer Method: (setf fields) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

fields.

Generic Reader: filename (object)
Package

db3.

Methods
Reader Method: filename ((db3-memo db3-memo))

automatically generated reader method

Source

db3.lisp.

Target Slot

filename.

Reader Method: filename ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

filename.

Generic Writer: (setf filename) (object)
Package

db3.

Methods
Writer Method: (setf filename) ((db3-memo db3-memo))

automatically generated writer method

Source

db3.lisp.

Target Slot

filename.

Writer Method: (setf filename) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

filename.

Generic Reader: header-length (object)
Package

db3.

Methods
Reader Method: header-length ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

header-length.

Generic Writer: (setf header-length) (object)
Package

db3.

Methods
Writer Method: (setf header-length) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

header-length.

Generic Reader: last-update (object)
Package

db3.

Methods
Reader Method: last-update ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

last-update.

Generic Writer: (setf last-update) (object)
Package

db3.

Methods
Writer Method: (setf last-update) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

last-update.

Generic Function: load-field (db3 field stream)
Package

db3.

Methods
Method: load-field ((db3 db3) (field db3-field) stream)
Source

db3.lisp.

Generic Function: load-memo-header (db3)
Package

db3.

Methods
Method: load-memo-header ((db3 db3))
Source

db3.lisp.

Generic Function: load-memo-record (db3 data)
Package

db3.

Methods
Method: load-memo-record ((db3 db3) data)
Source

db3.lisp.

Generic Reader: memo (object)
Package

db3.

Methods
Reader Method: memo ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

memo.

Generic Writer: (setf memo) (object)
Package

db3.

Methods
Writer Method: (setf memo) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

memo.

Generic Reader: next-block (object)
Package

db3.

Methods
Reader Method: next-block ((db3-memo db3-memo))

automatically generated reader method

Source

db3.lisp.

Target Slot

next-block.

Generic Writer: (setf next-block) (object)
Package

db3.

Methods
Writer Method: (setf next-block) ((db3-memo db3-memo))

automatically generated writer method

Source

db3.lisp.

Target Slot

next-block.

Generic Reader: record-length (object)
Package

db3.

Methods
Reader Method: record-length ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

record-length.

Generic Writer: (setf record-length) (object)
Package

db3.

Methods
Writer Method: (setf record-length) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

record-length.

Generic Reader: version-number (object)
Package

db3.

Methods
Reader Method: version-number ((db3 db3))

automatically generated reader method

Source

db3.lisp.

Target Slot

version-number.

Generic Writer: (setf version-number) (object)
Package

db3.

Methods
Writer Method: (setf version-number) ((db3 db3))

automatically generated writer method

Source

db3.lisp.

Target Slot

version-number.


5.2.4 Classes

Class: db3-field
Package

db3.

Source

db3.lisp.

Direct methods
Direct slots
Slot: name
Readers

field-name.

Writers

(setf field-name).

Slot: type
Package

common-lisp.

Readers

field-type.

Writers

(setf field-type).

Slot: data-address
Readers

data-address.

Writers

(setf data-address).

Slot: field-length
Readers

field-length.

Writers

(setf field-length).

Slot: field-count
Readers

field-count.

Writers

(setf field-count).

Class: db3-memo
Package

db3.

Source

db3.lisp.

Direct methods
Direct slots
Slot: filename
Initargs

:filename

Readers

filename.

Writers

(setf filename).

Slot: stream
Package

common-lisp.

Readers

db3-memo-stream.

Writers

(setf db3-memo-stream).

Slot: next-block
Readers

next-block.

Writers

(setf next-block).

Slot: block-size
Readers

block-size.

Writers

(setf block-size).

Class: db3-memo-block
Package

db3.

Source

db3.lisp.

Direct methods
Direct slots
Slot: type
Package

common-lisp.

Readers

block-type.

Writers

(setf block-type).

Slot: size
Readers

block-size.

Writers

(setf block-size).

Slot: data
Initargs

:data

Readers

block-data.

Writers

(setf block-data).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   H   I   L   M   N   R   S   U   V   W  
Index Entry  Section

(
(setf block-data): Private generic functions
(setf block-data): Private generic functions
(setf block-size): Private generic functions
(setf block-size): Private generic functions
(setf block-size): Private generic functions
(setf block-type): Private generic functions
(setf block-type): Private generic functions
(setf data-address): Private generic functions
(setf data-address): Private generic functions
(setf db3-memo-stream): Private generic functions
(setf db3-memo-stream): Private generic functions
(setf encoding): Private generic functions
(setf encoding): Private generic functions
(setf field-count): Private generic functions
(setf field-count): Private generic functions
(setf field-length): Private generic functions
(setf field-length): Private generic functions
(setf field-name): Private generic functions
(setf field-name): Private generic functions
(setf field-type): Private generic functions
(setf field-type): Private generic functions
(setf fields): Private generic functions
(setf fields): Private generic functions
(setf filename): Private generic functions
(setf filename): Private generic functions
(setf filename): Private generic functions
(setf header-length): Private generic functions
(setf header-length): Private generic functions
(setf last-update): Private generic functions
(setf last-update): Private generic functions
(setf memo): Private generic functions
(setf memo): Private generic functions
(setf next-block): Private generic functions
(setf next-block): Private generic functions
(setf record-count): Public generic functions
(setf record-count): Public generic functions
(setf record-length): Private generic functions
(setf record-length): Private generic functions
(setf version-number): Private generic functions
(setf version-number): Private generic functions

A
ascii->string: Private ordinary functions
asciiz->string: Private ordinary functions

B
block-data: Private generic functions
block-data: Private generic functions
block-size: Private generic functions
block-size: Private generic functions
block-size: Private generic functions
block-type: Private generic functions
block-type: Private generic functions
bytes->bigint: Private ordinary functions
bytes->integer: Private ordinary functions

C
close-memo: Public generic functions
close-memo: Public generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions
convert-field: Private generic functions

D
data-address: Private generic functions
data-address: Private generic functions
db3-memo-stream: Private generic functions
db3-memo-stream: Private generic functions
dump-db3: Public ordinary functions

E
encoding: Private generic functions
encoding: Private generic functions

F
field-count: Private generic functions
field-count: Private generic functions
field-count: Private generic functions
field-length: Private generic functions
field-length: Private generic functions
field-name: Private generic functions
field-name: Private generic functions
field-type: Private generic functions
field-type: Private generic functions
fields: Private generic functions
fields: Private generic functions
filename: Private generic functions
filename: Private generic functions
filename: Private generic functions
Function, ascii->string: Private ordinary functions
Function, asciiz->string: Private ordinary functions
Function, bytes->bigint: Private ordinary functions
Function, bytes->integer: Private ordinary functions
Function, dump-db3: Public ordinary functions
Function, inspect-db3: Private ordinary functions
Function, language-driver-to-encoding: Private ordinary functions
Function, load-field-descriptor: Private ordinary functions
Function, read-uint16: Private ordinary functions
Function, read-uint32: Private ordinary functions
Function, sample-db3: Public ordinary functions
Function, unsigned-to-signed: Private ordinary functions
Function, write-record: Public ordinary functions

G
Generic Function, (setf block-data): Private generic functions
Generic Function, (setf block-size): Private generic functions
Generic Function, (setf block-type): Private generic functions
Generic Function, (setf data-address): Private generic functions
Generic Function, (setf db3-memo-stream): Private generic functions
Generic Function, (setf encoding): Private generic functions
Generic Function, (setf field-count): Private generic functions
Generic Function, (setf field-length): Private generic functions
Generic Function, (setf field-name): Private generic functions
Generic Function, (setf field-type): Private generic functions
Generic Function, (setf fields): Private generic functions
Generic Function, (setf filename): Private generic functions
Generic Function, (setf header-length): Private generic functions
Generic Function, (setf last-update): Private generic functions
Generic Function, (setf memo): Private generic functions
Generic Function, (setf next-block): Private generic functions
Generic Function, (setf record-count): Public generic functions
Generic Function, (setf record-length): Private generic functions
Generic Function, (setf version-number): Private generic functions
Generic Function, block-data: Private generic functions
Generic Function, block-size: Private generic functions
Generic Function, block-type: Private generic functions
Generic Function, close-memo: Public generic functions
Generic Function, convert-field: Private generic functions
Generic Function, data-address: Private generic functions
Generic Function, db3-memo-stream: Private generic functions
Generic Function, encoding: Private generic functions
Generic Function, field-count: Private generic functions
Generic Function, field-length: Private generic functions
Generic Function, field-name: Private generic functions
Generic Function, field-type: Private generic functions
Generic Function, fields: Private generic functions
Generic Function, filename: Private generic functions
Generic Function, header-length: Private generic functions
Generic Function, last-update: Private generic functions
Generic Function, load-field: Private generic functions
Generic Function, load-header: Public generic functions
Generic Function, load-memo-header: Private generic functions
Generic Function, load-memo-record: Private generic functions
Generic Function, load-record: Public generic functions
Generic Function, memo: Private generic functions
Generic Function, next-block: Private generic functions
Generic Function, record-count: Public generic functions
Generic Function, record-length: Private generic functions
Generic Function, version-number: Private generic functions

H
header-length: Private generic functions
header-length: Private generic functions

I
inspect-db3: Private ordinary functions

L
language-driver-to-encoding: Private ordinary functions
last-update: Private generic functions
last-update: Private generic functions
load-field: Private generic functions
load-field: Private generic functions
load-field-descriptor: Private ordinary functions
load-header: Public generic functions
load-header: Public generic functions
load-memo-header: Private generic functions
load-memo-header: Private generic functions
load-memo-record: Private generic functions
load-memo-record: Private generic functions
load-record: Public generic functions
load-record: Public generic functions

M
memo: Private generic functions
memo: Private generic functions
Method, (setf block-data): Private generic functions
Method, (setf block-size): Private generic functions
Method, (setf block-size): Private generic functions
Method, (setf block-type): Private generic functions
Method, (setf data-address): Private generic functions
Method, (setf db3-memo-stream): Private generic functions
Method, (setf encoding): Private generic functions
Method, (setf field-count): Private generic functions
Method, (setf field-length): Private generic functions
Method, (setf field-name): Private generic functions
Method, (setf field-type): Private generic functions
Method, (setf fields): Private generic functions
Method, (setf filename): Private generic functions
Method, (setf filename): Private generic functions
Method, (setf header-length): Private generic functions
Method, (setf last-update): Private generic functions
Method, (setf memo): Private generic functions
Method, (setf next-block): Private generic functions
Method, (setf record-count): Public generic functions
Method, (setf record-length): Private generic functions
Method, (setf version-number): Private generic functions
Method, block-data: Private generic functions
Method, block-size: Private generic functions
Method, block-size: Private generic functions
Method, block-type: Private generic functions
Method, close-memo: Public generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, convert-field: Private generic functions
Method, data-address: Private generic functions
Method, db3-memo-stream: Private generic functions
Method, encoding: Private generic functions
Method, field-count: Private generic functions
Method, field-count: Private generic functions
Method, field-length: Private generic functions
Method, field-name: Private generic functions
Method, field-type: Private generic functions
Method, fields: Private generic functions
Method, filename: Private generic functions
Method, filename: Private generic functions
Method, header-length: Private generic functions
Method, last-update: Private generic functions
Method, load-field: Private generic functions
Method, load-header: Public generic functions
Method, load-memo-header: Private generic functions
Method, load-memo-record: Private generic functions
Method, load-record: Public generic functions
Method, memo: Private generic functions
Method, next-block: Private generic functions
Method, record-count: Public generic functions
Method, record-length: Private generic functions
Method, version-number: Private generic functions

N
next-block: Private generic functions
next-block: Private generic functions

R
read-uint16: Private ordinary functions
read-uint32: Private ordinary functions
record-count: Public generic functions
record-count: Public generic functions
record-length: Private generic functions
record-length: Private generic functions

S
sample-db3: Public ordinary functions

U
unsigned-to-signed: Private ordinary functions

V
version-number: Private generic functions
version-number: Private generic functions

W
write-record: Public ordinary functions


A.3 Variables

Jump to:   *  
B   D   E   F   H   L   M   N   R   S   T   V  
Index Entry  Section

*
*code-page-list*: Private special variables
*external-format*: Public special variables

B
block-size: Private classes

D
data: Private classes
data-address: Private classes

E
encoding: Public classes

F
field-count: Private classes
field-length: Private classes
fields: Public classes
filename: Public classes
filename: Private classes

H
header-length: Public classes

L
last-update: Public classes

M
memo: Public classes

N
name: Private classes
next-block: Private classes

R
record-count: Public classes
record-length: Public classes

S
size: Private classes
Slot, block-size: Private classes
Slot, data: Private classes
Slot, data-address: Private classes
Slot, encoding: Public classes
Slot, field-count: Private classes
Slot, field-length: Private classes
Slot, fields: Public classes
Slot, filename: Public classes
Slot, filename: Private classes
Slot, header-length: Public classes
Slot, last-update: Public classes
Slot, memo: Public classes
Slot, name: Private classes
Slot, next-block: Private classes
Slot, record-count: Public classes
Slot, record-length: Public classes
Slot, size: Private classes
Slot, stream: Private classes
Slot, type: Private classes
Slot, type: Private classes
Slot, version-number: Public classes
Special Variable, *code-page-list*: Private special variables
Special Variable, *external-format*: Public special variables
stream: Private classes

T
type: Private classes
type: Private classes

V
version-number: Public classes