The cobstor Reference Manual

Table of Contents

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

The cobstor Reference Manual

This is the cobstor Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 03:44:51 2018 GMT+0.


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

1 Systems

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


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

1.1 cobstor

Maintainer

Walter C. Pelissero <walter@pelissero.de>

Author

Walter C. Pelissero <walter@pelissero.de>

License

LGPL

Description

Cobol Storage library

Long Description

This is a package that provides access to Cobol data files from within Common Lisp. Its design is of the proxy/agent type, where the lisp program communicates through a proxy library to a cobol program (the agent) which ultimately accesses the data storage. An generator is included which automates the extraction of the necessary meta-data from Cobol source files.

Dependencies
Source

cobstor.asd (file)

Component

src (module)


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

2 Modules

Modules are listed depth-first from the system components tree.


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

2.1 cobstor/src

Parent

cobstor (system)

Location

src/

Components

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

2.2 cobstor/src/proxy

Parent

src (module)

Location

src/proxy/

Components

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

2.3 cobstor/src/gen

Dependency

proxy (module)

Parent

src (module)

Location

src/gen/

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 cobstor.asd

Location

cobstor.asd

Systems

cobstor (system)

Packages

cobstor-system

Exported Definitions

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

3.1.2 cobstor/src/proxy/package.lisp

Parent

proxy (module)

Location

src/proxy/package.lisp

Packages

cobstor


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

3.1.3 cobstor/src/proxy/field.lisp

Dependency

package.lisp (file)

Parent

proxy (module)

Location

src/proxy/field.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cobstor/src/proxy/record.lisp

Dependencies
Parent

proxy (module)

Location

src/proxy/record.lisp

Exported Definitions
Internal Definitions

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

3.1.5 cobstor/src/proxy/file.lisp

Dependencies
Parent

proxy (module)

Location

src/proxy/file.lisp

Exported Definitions
Internal Definitions

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

3.1.6 cobstor/src/gen/ss.lisp

Parent

gen (module)

Location

src/gen/ss.lisp

Packages

stateful-streams

Exported Definitions
Internal Definitions

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

3.1.7 cobstor/src/gen/package.lisp

Dependency

ss.lisp (file)

Parent

gen (module)

Location

src/gen/package.lisp

Packages

cobstor-generator


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

3.1.8 cobstor/src/gen/lexer.lisp

Dependencies
Parent

gen (module)

Location

src/gen/lexer.lisp

Exported Definitions

get-position (method)

Internal Definitions

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

3.1.9 cobstor/src/gen/grammar.lisp

Dependency

package.lisp (file)

Parent

gen (module)

Location

src/gen/grammar.lisp

Internal Definitions

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

3.1.10 cobstor/src/gen/agent.lisp

Dependencies
Parent

gen (module)

Location

src/gen/agent.lisp

Exported Definitions

make-cobol-agent (function)

Internal Definitions

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

3.1.11 cobstor/src/gen/stub.lisp

Dependency

package.lisp (file)

Parent

gen (module)

Location

src/gen/stub.lisp

Exported Definitions

make-cobol-proxy-stub (function)

Internal Definitions

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

3.1.12 cobstor/src/gen/parser.lisp

Dependencies
Parent

gen (module)

Location

src/gen/parser.lisp

Exported Definitions
Internal Definitions

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

3.1.13 cobstor/src/gen/generator.lisp

Dependencies
Parent

gen (module)

Location

src/gen/generator.lisp

Exported Definitions

generate-cobstor-interface (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cobstor-system

Source

cobstor.asd

Use List
Exported Definitions

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

4.2 cobstor

Source

package.lisp (file)

Use List
Used By List

cobstor-generator

Exported Definitions
Internal Definitions

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

4.3 stateful-streams

Source

ss.lisp (file)

Use List
Used By List

cobstor-generator

Exported Definitions
Internal Definitions

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

4.4 cobstor-generator

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *agent-base-port*

Portnumber at which the Cobol agent serves connections.

Package

cobstor

Source

file.lisp (file)

Special Variable: *agents-library-name*

Pathname of the Cobol library containing all the agents. If NIL cobstor will run the single agents using the COMPILED-AGENT-FILE-PATHNAME function.

Package

cobstor

Source

file.lisp (file)

Special Variable: *base-directory*
Package

cobstor-system

Source

cobstor.asd

Special Variable: *binary-field-class*

Class to use to represent binary fields. The Cobol manual says: By default, a BINARY data item is identical to a COMP-4 data item. The compile-time option "-D5" treats BINARY data items as COMP-5 items instead.

Package

cobstor

Source

field.lisp (file)

Special Variable: *binary-field-size-convention*

The storage convention for binary fields. Normally this is :ACU but it can also be :ACU1, :ACU-TIGHT or :MF.

Package

cobstor

Source

field.lisp (file)

Special Variable: *cobol-files*

List of files declared with DECLARE-COBOL-DATA-FILE.

Package

cobstor

Source

file.lisp (file)

Special Variable: *comp-field-class*

Class to use to represent comp fields. The Cobol manual says: In VAX/COBOL compatibility mode, a COMP data item is the same as COMP-4 and is treated as binary data. In RM/COBOL compatibility lmode, COMP is the same as COMP-2. You can use compile-time options to change the default behavior.

Package

cobstor

Source

field.lisp (file)

Special Variable: *compilation-epoch*
Package

cobstor-system

Source

cobstor.asd

Special Variable: *default-endianness*

What kind of CPU should be emulated when handling fields which depend on the endianness of the architecture. Allowed values are :BIG-ENDIAN (like Motorola CPUs) and :LITTLE-ENDIAN (like Intel CPUs).

Package

cobstor

Source

field.lisp (file)

Special Variable: *default-sign-position*

Position of a separate sign in numeric fields if not explicitly specified. It can be :LEADING or :TRAILING.

Package

cobstor

Source

field.lisp (file)

Special Variable: *field-accessors*

Type of accessor that is created for record fields. It can be either :METHOD, to create CLOS methods, or :FUNCTION, to create normal Lisp functions. If you don’t expect name clashes :FUNCTION is the best choice, as it avoids the CLOS overhead.

Package

cobstor

Source

record.lisp (file)

Special Variable: *keep-agent-connections*

If true agent connections are not severed upon exit of WITH-CBL-FILE.

Package

cobstor

Source

file.lisp (file)

Special Variable: *numeric-field-sign-convention*

Notation used by numerical fields in presence of a sign. This can be :ACU :MF :VAX :IBM :NCR.

Package

cobstor

Source

field.lisp (file)

Special Variable: *packed-decimal-field-class*

Class to use to represent packed decimal fields. The Cobol manual says: Data items described as PACKED-DECIMAL are identical to COMP-3. You can cause unsigned PACKED-DECIMAL to be treated as COMP-6 by using a compile-time option.

Package

cobstor

Source

field.lisp (file)

Special Variable: *runcbl-pathname*

Pathname to the runcbl executable (or wrapper). Although a relative pathname would be resolved by the Unix shell search path, it’s a bad idea to rely on that.

Package

cobstor

Source

file.lisp (file)

Special Variable: *setter-prefix*

Prefix to be prepended to function names of field setters. This should be a symbol, possibly ending in hyphen.

Package

cobstor

Source

record.lisp (file)

Special Variable: *treat-blank-as-zero*

If true blanks in numeric fields with storage type ‘display’ are treated as zeros.

Package

cobstor

Source

field.lisp (file)


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

5.1.2 Macros

Macro: declare-cobol-data-file NAME RECORD KEYS

Add a data file to the *AGENT-TABLE*.

Package

cobstor

Source

file.lisp (file)

Macro: define-cobol-record (NAME &key ALTERNATES DOCUMENTATION) &rest DECLARATIONS
Package

cobstor

Source

record.lisp (file)

Macro: loop-cbl-file-query (FILE RECORD STARTS &key COMPARE-OP KEY MULTI-RECORD PATHNAME FIELDS) &body BODY

Execute BODY within a start and next loop on FILE. Overwrite RECORD at each iteration with the next record in FILE. COMPARE-OP and KEY are the same as for CBL-START. STARTS is a list where each element is a two elements list: the first is the RECORD accessor for a key field and the second is its start value. If MULTI-RECORD is true allocate a new record at each iteration. If RECORD is within parenthesis, don’t allocate a new record and use one in the lexical context. If FIELDS is not null bind local macrolets to access RECORD’s fields. If FIELDS is a list bind only those listed.

Package

cobstor

Source

file.lisp (file)

Macro: with-cbl-file (HANDLE FILE &key PATHNAME DIRECTION) &body BODY
Package

cobstor

Source

file.lisp (file)

Macro: with-record RECORD CLASS &body FORMS

Locally create macrolets to access all RECORD’s fields. RECORD is assumed to be of type CLASS.

Package

cobstor

Source

record.lisp (file)

Macro: with-record-accessors ACCESSORS RECORD &body FORMS

Execute FORMS while locally creating macrolets to access RECORD’s ACCESSORS.

Package

cobstor

Source

record.lisp (file)

Macro: with-records RECORDS &body FORMS

Locally create macrolets to access all fields in RECORDS. RECORDS is an alist of variable names and record classes. Each variable is assumed to be of the respective type and macrolet accessors are generated. See also WITH-RECORD-ACCESSORS.

Package

cobstor

Source

record.lisp (file)


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

5.1.3 Functions

Function: already-exists-p STATUS
Package

cobstor

Source

file.lisp (file)

Function: cbl-connect NAME

Connect to remote agent for file of type NAME.

Package

cobstor

Source

file.lisp (file)

Function: cbl-ensure-connection FILE-NAME

Return a handle of a connection to a Cobol agent. If *KEEP-AGENT-CONNECTIONS* is true the handle may already exist in the cache, in this case no new connection is created.

Package

cobstor

Source

file.lisp (file)

Function: cbl-file-metadata FILE-NAME

Find a data file in *DATA-FILES-TABLE*.

Package

cobstor

Source

file.lisp (file)

Function: cbl-map-fields PROC FIELDS &key LEAVES-ONLY-P NAMED-ONLY-P

Apply PROC to FIELDS. If LEAVES-ONLY-P is true, don’t apply PROC to fields that contain subfields.

Package

cobstor

Source

record.lisp (file)

Function: cbl-open FILE &key DIRECTION

Open a remote cobol file of type NAME. The DIRECTION can be :INPUT, :OUTPUT or :INPUT-OUTPUT.

Package

cobstor

Source

file.lisp (file)

Function: cbl-record-fields RECORD

Return the tree of fields of Cobol record RECORD, which is a symbol.

Package

cobstor

Source

record.lisp (file)

Function: cbl-release-connection FILE &key ABORT

Dispose of a connection that is no longer necessary. If *KEEP-AGENT-CONNECTIONS* is true at least a connection to a each file is kept in cache so that the next time we require to access the same file, the burden of starting a new agent is avoided.

Package

cobstor

Source

file.lisp (file)

Function: cbl-unlock FILE

Unlock all records of FILE.

Package

cobstor

Source

file.lisp (file)

Function: clear-agents-pool &optional ABORT

Severe all the existing connections to Cobol agents and remove the entries from the *agent-handles-by-name* and *agent-handles-by-port* hash tables.

Package

cobstor

Source

file.lisp (file)

Function: copy-record RECORD
Package

cobstor

Source

record.lisp (file)

Function: eof-p STATUS
Package

cobstor

Source

file.lisp (file)

Function: file-error-p STATUS
Package

cobstor

Source

file.lisp (file)

Function: generate-cobstor-interface FILES-LIST &key PACKAGE COMPILE FORCE

Generate all the proxy stubs and agent in FILES-LIST. If PACKAGE is specified the generated Lisp code will be part of it. If COMPILE is true (the default) the generated code is compiled as well. If FORCE is true the generation takes place even if the module looks to be up to date.

Package

cobstor-generator

Source

generator.lisp (file)

Function: load-all-proxies ()
Package

cobstor

Source

file.lisp (file)

Function: load-proxy NAME
Package

cobstor

Source

file.lisp (file)

Function: make-cobol-agent DATA-FILE-NAME RECORDS KEYS OUTPUT-PROGRAM-PATHNAME

Generate the agent programs for the remote access to the Cobol field.

Package

cobstor-generator

Source

agent.lisp (file)

Function: make-cobol-proxy-stub OUTPUT-FILE RECORDS KEYS &key PACKAGE RECORD-NAME

Compile a Cobol record declaration from records into a
Lisp record declaration written into OUTPUT-FILE. If PACKAGE is specified the Lisp code will be populated in that package. If RECORD-NAME is not specified, the output record name will be the name of the first INPUT-FILE with "-RECORD" appended to it.

Package

cobstor-generator

Source

stub.lisp (file)

Function: next-key RECORD &optional KEY

Return the key of the record following RECORD in the file.

Package

cobstor

Source

file.lisp (file)

Function: next-record RECORD &optional KEY

Fetch the record that follows RECORD in the file.

Package

cobstor

Source

file.lisp (file)

Function: not-found-p STATUS
Package

cobstor

Source

file.lisp (file)

Function: open FILENAME &rest OPTIONS &key STATEFUL &allow-other-keys
Package

stateful-streams

Source

ss.lisp (file)

Function: previous-key RECORD &optional KEY

Return the key of the record preceding RECORD in the file.

Package

cobstor

Source

file.lisp (file)

Function: previous-record RECORD &optional KEY

Fetch the record that precedes RECORD in the file.

Package

cobstor

Source

file.lisp (file)

Function: read-field-declarations PATHNAME

Return the list of field declarations layed in a hyerarchical form, found in Cobol file at PATHNAME.

Package

cobstor-generator

Source

parser.lisp (file)

Function: record-key RECORD &optional KEY

Return the value of the key of RECORD. KEY, if specified is a symbol. If KEY is not specified, return the default key.

Package

cobstor

Source

file.lisp (file)


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

5.1.4 Generic functions

Generic Function: beginning-of-line-p OBJECT
Package

stateful-streams

Methods
Method: beginning-of-line-p (STATEFUL-STREAM stateful-stream)

True if stream is currently at the beginning of a line.

Source

ss.lisp (file)

Generic Function: cbl-close FILE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-close (FILE cbl-file)

Close a Cobol file that has been opened with CBL-OPEN. This does _not_ close the connection to the Cobol agent.

Generic Function: cbl-delete FILE RECORD &key INEXISTENT-ERRORP INEXISTENT-VALUE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-delete (FILE cbl-file) RECORD &key INEXISTENT-ERRORP INEXISTENT-VALUE

Delete RECORD from FILE.

Generic Function: cbl-delete-file FILE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-delete-file (FILE cbl-file)

Delete FILE and return NIL. Signal an error if operation didn’t succeed.

Generic Function: cbl-disconnect FILE &key ABORT
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-disconnect (FILE cbl-file) &key ABORT

Opposite of CBL-CONNECT.

Generic Function: cbl-error-status CONDITION
Package

cobstor

Methods
Method: cbl-error-status (CONDITION cbl-file-cobol-error)
Source

file.lisp (file)

Generic Function: cbl-exit FILE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-exit (FILE cbl-file)

Stop the agent and don’t wait for an answer that wouldn’t come.

Generic Function: cbl-next FILE &optional RECORD
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-next (FILE cbl-file) &optional RECORD

Return next record from FILE or NIL if there are no more. FILE must be first started with CBL-FILE-START.

Generic Function: cbl-previous FILE &optional RECORD
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-previous (FILE cbl-file) &optional RECORD

Return previous record from FILE or NIL if at the beginning of the file. FILE must be first started with CBL-FILE-START.

Generic Function: cbl-read FILE RECORD &key KEY NOT-FOUND-ERRORP NOT-FOUND-VALUE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-read (FILE cbl-file) (RECORD cbl-record) &key KEY NOT-FOUND-ERRORP NOT-FOUND-VALUE

Read record RECORD. Use KEY as the index in the file. If record is found without errors the RECORD is returned. If record is missing and NOT-FOUND-ERRORP is true, signal an error condition; NOT-FOUND-ERRORP is false return NOT-FOUND-VALUE. On any other error signal an error condition.

Generic Function: cbl-record-file RECORD
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-record-file (RECORD cbl-record)
Method: cbl-record-file (RECORD-NAME symbol)
Generic Function: cbl-rewrite FILE RECORD &key IF-NOT-FOUND
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-rewrite (FILE cbl-file) (RECORD cbl-record) &key IF-NOT-FOUND

Write RECORD to FILE. Raise an error condition if record is not already present and IF-NOT-FOUND is :ERROR. Insert a new record if IF-NOT-FOUND is :INSERT.

Generic Function: cbl-start FILE RECORD &key COMPARE-OP KEY NOT-FOUND-ERRORP
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-start (FILE cbl-file) (RECORD cbl-record) &key COMPARE-OP KEY NOT-FOUND-ERRORP

Start a sequential READ (see CBL-NEXT) of FILE using RECORD as initial position. The key is compared according to COMPARE-OP, which can take the following values:

:NOT-LESS (or :GREATER-OR-EQUAL)
:LESS
:GREATER
:NOT-GREATER (or :LESS-OR-EQUAL)

The semantics are identical to the familiar Cobol START statement. Return true if the initial record was found. If no initial record was found and NOT-FOUND-ERRORP is not true return false. Otherwise signal an error.

Generic Function: cbl-write FILE RECORD &key IF-EXISTS
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-write (FILE cbl-file) (RECORD cbl-record) &key IF-EXISTS

Write RECORD to FILE. Raise an error condition if the record is already present and IF-EXISTS is :ERROR. Override any existing record if IF-EXISTS is :REPLACE.

Generic Function: column OBJECT
Package

stateful-streams

Methods
Method: column (STATEFUL-STREAM stateful-stream)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: field-alternates OBJECT
Generic Function: (setf field-alternates) NEW-VALUE OBJECT
Package

cobstor-generator

Methods
Method: field-alternates (FIELD-DECLARATION field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Method: (setf field-alternates) NEW-VALUE (FIELD-DECLARATION field-declaration)

automatically generated writer method

Source

parser.lisp (file)

Generic Function: field-decimals OBJECT
Package

cobstor-generator

Methods
Method: field-decimals (LEAF-FIELD-DECLARATION leaf-field-declaration)

The number of decimals places in a numeric field. These are included in length.

Source

parser.lisp (file)

Generic Function: field-length OBJECT
Package

cobstor-generator

Methods
Method: field-length (LEAF-FIELD-DECLARATION leaf-field-declaration)

The size in charcater positions the field occupies. This is not its size in bytes.

Source

parser.lisp (file)

Generic Function: field-level OBJECT
Package

cobstor-generator

Methods
Method: field-level (FIELD-DECLARATION field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: field-name OBJECT
Generic Function: (setf field-name) NEW-VALUE OBJECT
Package

cobstor-generator

Methods
Method: field-name (FIELD-DECLARATION field-declaration)
Method: (setf field-name) NEW-VALUE (FIELD-DECLARATION field-declaration)

Name of the field or NIL if it’s a filler.

Source

parser.lisp (file)

Generic Function: field-picture OBJECT
Package

cobstor-generator

Methods
Method: field-picture (LEAF-FIELD-DECLARATION leaf-field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: field-redefines OBJECT
Package

cobstor-generator

Methods
Method: field-redefines (FIELD-DECLARATION field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: field-sign-position OBJECT
Package

cobstor-generator

Methods
Method: field-sign-position (LEAF-FIELD-DECLARATION leaf-field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: field-sign-separated OBJECT
Package

cobstor-generator

Methods
Method: field-sign-separated (LEAF-FIELD-DECLARATION leaf-field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: field-signed OBJECT
Package

cobstor-generator

Methods
Method: field-signed (LEAF-FIELD-DECLARATION leaf-field-declaration)

True if field is a signed numeric field.

Source

parser.lisp (file)

Generic Function: field-size OBJECT
Package

cobstor-generator

Methods
Method: field-size (FIELD-DECLARATION field-declaration)

The size of the field in bytes. This is not multiplied by times (below).

Source

parser.lisp (file)

Generic Function: field-subfields OBJECT
Generic Function: (setf field-subfields) NEW-VALUE OBJECT
Package

cobstor-generator

Methods
Method: field-subfields (CONTAINER-FIELD-DECLARATION container-field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Method: (setf field-subfields) NEW-VALUE (CONTAINER-FIELD-DECLARATION container-field-declaration)

automatically generated writer method

Source

parser.lisp (file)

Generic Function: field-times OBJECT
Package

cobstor-generator

Methods
Method: field-times (FIELD-DECLARATION field-declaration)

Cardinality of this field.

Source

parser.lisp (file)

Generic Function: field-type OBJECT
Package

cobstor-generator

Methods
Method: field-type (LEAF-FIELD-DECLARATION leaf-field-declaration)

automatically generated reader method

Source

parser.lisp (file)

Generic Function: get-position STREAM

Return current position of stream. The position may be an object of the class STREAM-OFFSET.

Package

stateful-streams

Source

ss.lisp (file)

Methods
Method: get-position (STREAM parser-stream)
Source

lexer.lisp (file)

Method: get-position (STREAM stateful-stream)
Generic Function: line OBJECT
Package

stateful-streams

Methods
Method: line (STATEFUL-STREAM stateful-stream)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: off-column OBJECT
Package

stateful-streams

Methods
Method: off-column (STREAM-OFFSET stream-offset)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: off-line OBJECT
Package

stateful-streams

Methods
Method: off-line (STREAM-OFFSET stream-offset)

automatically generated reader method

Source

ss.lisp (file)

Generic Function: real-stream OBJECT
Package

stateful-streams

Methods
Method: real-stream (STATEFUL-STREAM stateful-stream)

The stream this stateful stream encapsulates.

Source

ss.lisp (file)

Generic Function: record-size OBJECT
Package

cobstor

Methods
Method: record-size (RECORD string)

Return the size of RECORD, which is a string.

Source

record.lisp (file)

Method: record-size (RECORD symbol)

Return the size of RECORD, which is a symbol.

Source

record.lisp (file)

Method: record-size (CBL-RECORD cbl-record)

automatically generated reader method

Source

record.lisp (file)

Generic Function: record-storage OBJECT
Package

cobstor

Methods
Method: record-storage (CBL-RECORD cbl-record)

automatically generated reader method

Source

record.lisp (file)

Generic Function: write-record RECORD STREAM

Write the storage of RECORD to STREAM.

Package

cobstor

Source

record.lisp (file)

Methods
Method: write-record (RECORD cbl-record) STREAM

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

5.1.5 Conditions

Condition: cbl-file-condition ()

Base abstract class for all the conditions related to the use of a CBL-FILE.

Package

cobstor

Source

file.lisp (file)

Direct superclasses

cbl-condition (condition)

Direct subclasses
Condition: cbl-file-error ()
Package

cobstor

Source

file.lisp (file)

Direct superclasses

cbl-file-condition (condition)

Direct slots
Slot: description
Initargs

:description

Condition: cbl-protocol-error ()
Package

cobstor

Source

file.lisp (file)

Direct superclasses

cbl-file-condition (condition)

Direct slots
Slot: description
Initargs

:description


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

5.1.6 Structures

Structure: cbl-file-status ()
Package

cobstor

Source

file.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: major
Readers

cbl-file-status-major (function)

Writers

(setf cbl-file-status-major) (function)

Slot: minor
Readers

cbl-file-status-minor (function)

Writers

(setf cbl-file-status-minor) (function)

Slot: extended
Readers

cbl-file-status-extended (function)

Writers

(setf cbl-file-status-extended) (function)


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

5.1.7 Classes

Class: cbl-file ()
Package

cobstor

Source

file.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name

Name of the file and the Cobol agent.

Type

symbol

Initargs

:name

Readers

cbl-file-name (generic function)

Slot: record-type

The class of this file’s records.

Type

(or class symbol)

Initargs

:record-type

Readers

cbl-file-record-type (generic function)

Slot: keys

List of file keys this file supports.

Type

list

Initargs

:keys

Readers

cbl-file-keys (generic function)

Slot: process
Initargs

:process

Slot: port-number

The port number this Cobol agent answers connections.

Initargs

:port

Readers

cbl-file-port (generic function)

Slot: socket

The socket connected to the Cobol agent.

Initargs

:socket

Readers

cbl-file-socket (generic function)

Class: cbl-record ()

Base class for cobol records. Subclasses must specify an initform for the SIZE slot so that the default INITIALIZE-INSTANCE method will instantiate the storage automatically.

Package

cobstor

Source

record.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: size
Type

fixnum

Readers

record-size (generic function)

Slot: storage
Type

cobstor::field-storage

Initargs

:storage

Readers

record-storage (generic function)

Class: container-field-declaration ()

Class for container objects; those made up of subfields.

Package

cobstor-generator

Source

parser.lisp (file)

Direct superclasses

field-declaration (class)

Direct methods
Direct slots
Slot: subfields
Type

list

Initargs

:subfields

Initform

(quote nil)

Readers

field-subfields (generic function)

Writers

(setf field-subfields) (generic function)

Class: field-declaration ()

Abstract base class for field declarations. This is not the kind of objects instantiated at run-time in the proxy library.

Package

cobstor-generator

Source

parser.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: level
Type

integer

Initargs

:level

Readers

field-level (generic function)

Slot: name

Name of the field or NIL if it’s a filler.

Type

(or string null)

Initargs

:name

Readers

field-name (generic function)

Writers

(setf field-name) (generic function)

Slot: size

The size of the field in bytes. This is not multiplied by times (below).

Readers

field-size (generic function)

Slot: redefines
Type

(or string null)

Initargs

:redefines

Readers

field-redefines (generic function)

Slot: alternates
Type

list

Initargs

:alternates

Initform

(quote nil)

Readers

field-alternates (generic function)

Writers

(setf field-alternates) (generic function)

Slot: times

Cardinality of this field.

Type

(or integer null)

Initargs

:times

Readers

field-times (generic function)

Class: leaf-field-declaration ()

Class for Cobol simple field declarations; those without subfields.

Package

cobstor-generator

Source

parser.lisp (file)

Direct superclasses

field-declaration (class)

Direct methods
Direct slots
Slot: type
Type

symbol

Initargs

:type

Readers

field-type (generic function)

Slot: length

The size in charcater positions the field occupies. This is not its size in bytes.

Type

integer

Initargs

:length

Readers

field-length (generic function)

Slot: picture
Type

string

Initargs

:picture

Readers

field-picture (generic function)

Slot: signed

True if field is a signed numeric field.

Type

boolean

Initargs

:signed

Readers

field-signed (generic function)

Slot: sign-position
Type

(or keyword null)

Initargs

:sign-position

Readers

field-sign-position (generic function)

Slot: sign-separated
Type

boolean

Initargs

:sign-separated

Readers

field-sign-separated (generic function)

Slot: decimals

The number of decimals places in a numeric field. These are included in length.

Type

(or integer null)

Initargs

:decimals

Readers

field-decimals (generic function)

Class: stateful-stream ()
Package

stateful-streams

Source

ss.lisp (file)

Direct superclasses

fundamental-character-input-stream (class)

Direct subclasses

parser-stream (class)

Direct methods
Direct slots
Slot: column
Type

integer

Initform

0

Readers

column (generic function)

Slot: line
Type

integer

Initform

0

Readers

line (generic function)

Slot: real-stream

The stream this stateful stream encapsulates.

Type

stream

Initargs

:stream

Readers

real-stream (generic function)

Slot: bol

True if stream is currently at the beginning of a line.

Type

boolean

Initform

t

Readers

beginning-of-line-p (generic function)

Class: stream-offset ()

Class for objects representing offset position within a stateful stream. These are the kind of objects returned by GET-POSITION method on a stateful stream.

Package

stateful-streams

Source

ss.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

parser-offset (class)

Direct methods
Direct slots
Slot: line
Initargs

:line

Readers

off-line (generic function)

Slot: column
Initargs

:column

Readers

off-column (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *agent-compiled-type*

Pathname type of the compiled files of the Cobol agent.

Package

cobstor

Source

file.lisp (file)

Special Variable: *agent-handles-by-name*

The active connections to Cobol agents keyed by name.

Package

cobstor

Source

file.lisp (file)

Special Variable: *agent-handles-by-port*

The active connections to Cobol agents keyed by socket port.

Package

cobstor

Source

file.lisp (file)

Special Variable: *agent-source-type*

Pathname type of the source files of the Cobol agent.

Package

cobstor

Source

file.lisp (file)

Special Variable: *binary-alias*

Class to use to represent binary fields. The Cobol manual says: By default, a BINARY data item is identical to a COMP-4 data item. The compile-time option "-D5" treats BINARY data items as COMP-5 items instead.

Package

cobstor

Source

record.lisp (file)

Special Variable: *comp-alias*

Class to use to represent comp fields. The Cobol manual says: In VAX/COBOL compatibility mode, a COMP data item is the same as COMP-4 and is treated as binary data. In RM/COBOL compatibility lmode, COMP is the same as COMP-2. You can use compile-time options to change the default behavior.

Package

cobstor

Source

record.lisp (file)

Special Variable: *debug*

If set to T, this library will produce more output.

Package

cobstor

Source

file.lisp (file)

Special Variable: *default-term*

Default value for TERM envvar in case it’s not set already. This is required by runcbl which requires it despite the -b (batch) flag.

Package

cobstor

Source

file.lisp (file)

Special Variable: *packed-decimal-alias*

Class to use to represent packed decimal fields. The Cobol manual says: Data items described as PACKED-DECIMAL are identical to COMP-3. You can cause unsigned PACKED-DECIMAL to be treated as COMP-6 by using a compile-time option.

Package

cobstor

Source

record.lisp (file)

Special Variable: +whitespace-bytes+

List of whitespace characters as unsigned bytes.

Package

cobstor

Source

field.lisp (file)

Special Variable: +word-component-table+
Package

cobstor-generator

Source

lexer.lisp (file)

Special Variable: +word-start-table+
Package

cobstor-generator

Source

lexer.lisp (file)

Special Variable: define-grammar
Package

cobstor-generator

Source

grammar.lisp (file)


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

5.2.2 Macros

Macro: defaccmkr TYPE ARGS &body FORMS
Package

cobstor

Source

record.lisp (file)

Macro: defsizer TYPE ARGS &body FORMS
Package

cobstor

Source

record.lisp (file)

Macro: with-indexes (OFFSET CARDINALITIES) &body FORMS
Package

cobstor

Source

record.lisp (file)

Macro: with-open-stateful-stream (STREAM PATHNAME &rest OPEN-OPTIONS) &body BODY
Package

stateful-streams

Source

ss.lisp (file)

Macro: with-parser-stream (VAR PATHNAME-OR-STREAM GRAMMAR) &body BODY
Package

cobstor-generator

Source

lexer.lisp (file)


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

5.2.3 Functions

Function: add-field-sizes FIELDS

Add the :SIZE property to FIELDS, which is a list of fields as expected by DEFINE-COBOL-RECORD. Return a modified list of fields.

Package

cobstor

Source

record.lisp (file)

Function: add-running-agent FILE
Package

cobstor

Source

file.lisp (file)

Function: agent-file-pathname NAME

Return the absolute pathname of the Cobol agent source file named NAME.

Package

cobstor

Source

file.lisp (file)

Function: buffer N

Make an (UNSIGNED-BYTE 8) vector of length N.

Package

cobstor

Source

file.lisp (file)

Function: byte-vector->integer SEQUENCE
Package

cobstor

Source

file.lisp (file)

Function: case-string STRING

Up/down-case STRING according to the value of *PRINT-CASE*.

Package

cobstor-generator

Source

stub.lisp (file)

Function: cbl-file-status-extended INSTANCE
Function: (setf cbl-file-status-extended) VALUE INSTANCE
Package

cobstor

Source

file.lisp (file)

Function: cbl-file-status-major INSTANCE
Function: (setf cbl-file-status-major) VALUE INSTANCE
Package

cobstor

Source

file.lisp (file)

Function: cbl-file-status-minor INSTANCE
Function: (setf cbl-file-status-minor) VALUE INSTANCE
Package

cobstor

Source

file.lisp (file)

Function: cbl-file-status-p OBJECT
Package

cobstor

Source

file.lisp (file)

Function: cbl-record-field-names RECORD

Return the list of field names of Cobol record RECORD, which is a symbol. Return a list of symbols.

Package

cobstor

Source

record.lisp (file)

Function: collect-names FIELDS
Package

cobstor

Source

record.lisp (file)

Function: compile-cobol-agent PATHNAME
Package

cobstor-generator

Source

agent.lisp (file)

Function: compile-proxy-stub PATHNAME

Compile a proxy stub. Thi is at the moment just a wrapper for compile-file.

Package

cobstor-generator

Source

stub.lisp (file)

Function: compiled-agent-file-pathname NAME

Return the absolute pathname of the compiled Cobol agent program named NAME.

Package

cobstor

Source

file.lisp (file)

Function: copy-cbl-file-status INSTANCE
Package

cobstor

Source

file.lisp (file)

Function: copy-file-pathname NAME

Given a copy file NAME (possibly a pathname) return an absolute pathname. The defaults are relative to COBSTOR-DYNAMIC logial pathname host.

Package

cobstor-generator

Source

generator.lisp (file)

Function: data-file-pathname NAME

Return the absolute pathname of the Cobol data file named NAME.

Package

cobstor

Source

file.lisp (file)

Function: decode-file-status STATUS

Read the file status from STREAM and return a CBL-FILE-STATUS object.

Package

cobstor

Source

file.lisp (file)

Function: delete-running-agent FILE
Package

cobstor

Source

file.lisp (file)

Function: ensure-term-envvar ()
Package

cobstor

Source

file.lisp (file)

Function: expand-picture PICTURE

Return a new picture string where all repeated characters in a PICTURE have been expanded. Pictures of the form "9(5)" are expanded to "99999".

Package

cobstor-generator

Source

parser.lisp (file)

Function: field-name-as-cobol DECL
Package

cobstor-generator

Source

parser.lisp (file)

Function: field-type->accessor-maker TYPE
Package

cobstor

Source

record.lisp (file)

Function: field-type->sizer TYPE
Package

cobstor

Source

record.lisp (file)

Function: field-type-string FIELD
Package

cobstor-generator

Source

agent.lisp (file)

Function: find-running-agent NAME
Package

cobstor

Source

file.lisp (file)

Function: find-running-agent-by-port PORT-NUMBER
Package

cobstor

Source

file.lisp (file)

Function: free-port-p PORT

Check whether port is currently free to be used by a local server.

Package

cobstor

Source

file.lisp (file)

Function: get-area-field-value STORAGE OFFSET LENGTH
Package

cobstor

Source

field.lisp (file)

Function: get-comp1-field-value STORAGE OFFSET
Package

cobstor

Source

field.lisp (file)

Function: get-comp2-field-value STORAGE OFFSET SIZE SIGNED DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-comp3-field-value STORAGE OFFSET SIZE SIGNED DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-comp6-field-value STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-field-value-comp4/5-be STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-field-value-comp4/5-le STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-numeric-field-value STORAGE OFFSET SIZE SIGNED SIGN-SEPARATED-P SIGN-POSITION DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: get-running-agent NAME

If it exists, return a running agent for NAME file. In doing so, remove it from the names hash table so the subsequent calls to this function won’t find the same agent.

Package

cobstor

Source

file.lisp (file)

Function: get-string-field-value STORAGE OFFSET LENGTH
Package

cobstor

Source

field.lisp (file)

Function: initial-handshake HANDLE

Do some sanity checks on the cbl-file HANDLE, just in case the agent doesn’t correspond to the proxy stub.

Package

cobstor

Source

file.lisp (file)

Function: integer->byte-vector INTEGER LENGTH
Package

cobstor

Source

file.lisp (file)

Function: keys-declaration KEYS &optional PREFIX

Return a string for the Cobol keys declaration of KEYS. Optionally add PREFIX to each key name. This declaration is normally part of a SELECT Cobol statement.

Package

cobstor-generator

Source

agent.lisp (file)

Function: longest-record-size RECORDS
Package

cobstor-generator

Source

agent.lisp (file)

Function: make-agent-and-proxy-stub NAME KEYS INPUT-FILES PACKAGE COMPILE FORCE
Package

cobstor-generator

Source

generator.lisp (file)

Function: make-cbl-binary-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-binary-area-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp1-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp2-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp3-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp4-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp5-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH SIGNED DECIMALS ENDIANNESS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-comp6-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-file-status &key (MAJOR MAJOR) (MINOR MINOR) (EXTENDED EXTENDED)
Package

cobstor

Source

file.lisp (file)

Function: make-cbl-numeric-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH SIGNED DECIMALS SIGN-SEPARATED SIGN-POSITION
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-packed-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: make-cbl-string-accessor SLOT-NAME CLASS OFFSET SIZE CARDINALITIES &key LENGTH
Package

cobstor

Source

record.lisp (file)

Function: make-field-declaration FIELD

Get a parsed field and return a FIELD-DECLARATION object. Guess from the picture string (property :PICTURE) of FIELD the missing parameters such as the type, length, decimals, and so on and so forth. The input FIELD is a list of at least two elements:

(LEVEL NAME . PROPERTIES)

where NAME can be NIL for fillers.

Package

cobstor-generator

Source

parser.lisp (file)

Function: make-parser-stream PATHNAME-OR-STREAM GRAMMAR
Package

cobstor-generator

Source

lexer.lisp (file)

Function: make-presence-table CHARS
Package

cobstor-generator

Source

lexer.lisp (file)

Function: new-token-position STREAM
Package

cobstor-generator

Source

lexer.lisp (file)

Function: next-agent-port &optional BASE
Package

cobstor

Source

file.lisp (file)

Function: no-current-record-p STATUS
Package

cobstor

Source

file.lisp (file)

Function: open-pipe FMT &rest ARGS

Return a process object from which the command output/input will be read/written.

Package

cobstor

Source

file.lisp (file)

Function: open-stateful-stream PATHNAME &rest OPEN-OPTIONS
Package

stateful-streams

Source

ss.lisp (file)

Function: parse-file SOURCE-PATHNAME

Parse a Cobol file containing a data record description (and only that) and return a list of its fields.

Package

cobstor-generator

Source

parser.lisp (file)

Function: parse-picture PICTURE

Interprete the meaning of a Cobol picture returning useful facts like: the type, the total length of the field, the decimals and the presence of the sign.

Package

cobstor-generator

Source

parser.lisp (file)

Function: populate-grammar ()
Package

cobstor-generator

Source

grammar.lisp (file)

Function: pprint-cobol-field STREAM DEFINITION

Pretty print on *STANDARD-OUTPUT* a cobol field as Lisp code.

Package

cobstor-generator

Source

stub.lisp (file)

Function: pprint-cobol-subfields STREAM SUBFIELDS
Package

cobstor-generator

Source

stub.lisp (file)

Function: pprint-define-cobol-record STREAM NAME FIELDS &key ALTERNATES

Pretty print on *STANDARD-OUTPUT* a Cobol record definition in Lisp language. FIELDS are composing the record.

Package

cobstor-generator

Source

stub.lisp (file)

Function: pprint-plist STREAM PROPERTIES
Package

cobstor-generator

Source

stub.lisp (file)

Function: print-cbl-file-cobol-error-condition CONDITION STREAM
Package

cobstor

Source

file.lisp (file)

Function: print-cbl-file-error-condition CONDITION STREAM
Package

cobstor

Source

file.lisp (file)

Function: print-cbl-protocol-error-condition CONDITION STREAM
Package

cobstor

Source

file.lisp (file)

Function: proxy-stub-file-pathname NAME
Package

cobstor-generator

Source

stub.lisp (file)

Function: query-record-length FILE
Package

cobstor

Source

file.lisp (file)

Function: rdseq SEQ STREAM
Package

cobstor

Source

file.lisp (file)

Function: read-integer STREAM FIRST-DIGIT
Package

cobstor-generator

Source

lexer.lisp (file)

Function: read-number STREAM FIRST-DIGIT
Package

cobstor-generator

Source

lexer.lisp (file)

Function: read-picture STREAM
Package

cobstor-generator

Source

lexer.lisp (file)

Function: read-string STREAM
Package

cobstor-generator

Source

lexer.lisp (file)

Function: read-word STREAM FIRST-CHARS
Package

cobstor-generator

Source

lexer.lisp (file)

Function: receive-answer FILE &optional RECORD
Package

cobstor

Source

file.lisp (file)

Function: receive-message FILE

Receive a message from agent. Anything coming from the agent is preceded by a two bytes length of the following byte sequence.

Package

cobstor

Source

file.lisp (file)

Function: receive-name HANDLE
Package

cobstor

Source

file.lisp (file)

Function: receive-ok FILE &optional RECORD
Package

cobstor

Source

file.lisp (file)

Function: receive-sequence STREAM LENGTH
Package

cobstor

Source

file.lisp (file)

Function: receive-string-message FILE
Package

cobstor

Source

file.lisp (file)

Function: release-running-agent FILE

Opposite of GET-RUNNING-AGENT. Return FILE to the names hash table so that FIND-RUNNING-AGENT will find it.

Package

cobstor

Source

file.lisp (file)

Function: run-async-program FMT &rest ARGS

Run a shell program asynchronously (in background).

Package

cobstor

Source

file.lisp (file)

Function: send-command FILE COMMAND &optional RECORD KEY
Package

cobstor

Source

file.lisp (file)

Function: send-message FILE SEQUENCE

Send a message to agent.

Package

cobstor

Source

file.lisp (file)

Function: set-area-field-value VALUE STORAGE OFFSET LENGTH
Package

cobstor

Source

field.lisp (file)

Function: set-comp1-field-value VALUE STORAGE OFFSET
Package

cobstor

Source

field.lisp (file)

Function: set-comp2-field-value VALUE STORAGE OFFSET SIZE SIGNED DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-comp3-field-value VALUE STORAGE OFFSET SIZE SIGNED DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-comp6-field-value VALUE STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-field-value-comp4/5-be VALUE STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-field-value-comp4/5-le VALUE STORAGE OFFSET SIZE DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-numeric-field-value VALUE STORAGE OFFSET SIZE SIGNED SIGN-SEPARATED-P SIGN-POSITION DECIMALS
Package

cobstor

Source

field.lisp (file)

Function: set-string-field-value VALUE STORAGE OFFSET LENGTH
Package

cobstor

Source

field.lisp (file)

Function: sexp->field-declaration SEXP

Create FIELD-DECLARATION object from a sexp of the form found in a DEFINE-COBOL-RECORD macro. See FIELD-DECLARATION->SEXP for further details.

Package

cobstor-generator

Source

parser.lisp (file)

Function: signed-negative-digit-coding-table ()
Package

cobstor

Source

field.lisp (file)

Function: signed-positive-digit-coding-table ()
Package

cobstor

Source

field.lisp (file)

Function: simple-command FILE COMMAND
Package

cobstor

Source

file.lisp (file)

Function: size-of-cbl-binary &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-binary-area &key LENGTH
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp1 ()
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp2 &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp3 &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp4 &key LENGTH SIGNED DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp5 &key LENGTH SIGNED DECIMALS ENDIANNESS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-comp6 &key LENGTH DECIMALS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-numeric &key LENGTH SIGNED DECIMALS SIGN-SEPARATED SIGN-POSITION
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-packed &rest ARGS
Package

cobstor

Source

record.lisp (file)

Function: size-of-cbl-string &key LENGTH
Package

cobstor

Source

record.lisp (file)

Function: size-of-comp4/5 DIGITS SIGNED

Return the size of the storage accupied by COMP-4 Cobol field with DIGITS and SIGN. This is according to the AcuCobol documentation that considers at most 31 digits.

Package

cobstor

Source

field.lisp (file)

Function: skip-to-eol STREAM
Package

cobstor-generator

Source

lexer.lisp (file)

Function: skip-whitespace STREAM
Package

cobstor-generator

Source

lexer.lisp (file)

Function: spc STREAM
Package

cobstor-generator

Source

stub.lisp (file)

Function: structure-records PARSED-FIELDS

Structure a list of fields into a list of trees according to the level number which appears in front of each cbfield. If in FIELDS there is only one record (just one level 01) the returned list will contain just one tree. The PARSED-FIELDS list is made up of elements of the kind:

(LEVEL NAME TYPE . PROPERTIES-LIST)

TYPE can be NIL if field is a composite field (with subfields).

Package

cobstor-generator

Source

parser.lisp (file)

Function: try-connect-to-agent PORT
Package

cobstor

Source

file.lisp (file)

Function: unsigned-digit-coding-table ()
Package

cobstor

Source

field.lisp (file)

Function: word-component-p C
Package

cobstor-generator

Source

lexer.lisp (file)

Function: word-start-p C
Package

cobstor-generator

Source

lexer.lisp (file)

Function: write-data-division STREAM RECORDS
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-environment-division STREAM KEYS
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-file-section STREAM RECORDS
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-identification-division STREAM FILE-NAME PROGRAM
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-procedure-division STREAM DATA-FILE-NAME KEYS

Write a standard procedure division body to STREAM. All the agents have this code in common.

Package

cobstor-generator

Source

agent.lisp (file)

Function: write-read-paragraph STREAM KEYS
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-start-paragraphs STREAM KEYS
Package

cobstor-generator

Source

agent.lisp (file)

Function: write-working-storage-section STREAM

Write a constant working-storage section to STREAM.

Package

cobstor-generator

Source

agent.lisp (file)

Function: wrseq SEQ STREAM

Like write-sequence but considers the element type of the stream.

Package

cobstor

Source

file.lisp (file)


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

5.2.4 Generic functions

Generic Function: cbl-file-input FILE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-file-input (FILE cbl-file)
Generic Function: cbl-file-keys OBJECT
Package

cobstor

Methods
Method: cbl-file-keys (CBL-FILE cbl-file)

List of file keys this file supports.

Source

file.lisp (file)

Generic Function: cbl-file-name OBJECT
Package

cobstor

Methods
Method: cbl-file-name (CBL-FILE cbl-file)

Name of the file and the Cobol agent.

Source

file.lisp (file)

Generic Function: cbl-file-output FILE
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-file-output (FILE cbl-file)
Generic Function: cbl-file-port OBJECT
Package

cobstor

Methods
Method: cbl-file-port (CBL-FILE cbl-file)

The port number this Cobol agent answers connections.

Source

file.lisp (file)

Generic Function: cbl-file-record-type OBJECT
Package

cobstor

Methods
Method: cbl-file-record-type (CBL-FILE cbl-file)

The class of this file’s records.

Source

file.lisp (file)

Generic Function: cbl-file-socket OBJECT
Package

cobstor

Methods
Method: cbl-file-socket (CBL-FILE cbl-file)

The socket connected to the Cobol agent.

Source

file.lisp (file)

Generic Function: cbl-set-pathname FILE PATHNAME
Package

cobstor

Source

file.lisp (file)

Methods
Method: cbl-set-pathname (FILE cbl-file) (PATHNAME pathname)
Generic Function: compute-field-size FIELD

Return the size in bytes occupied by the binary encoding of field. This doesn’t take in count repetitions as for TIMES.

Package

cobstor-generator

Source

parser.lisp (file)

Methods
Method: compute-field-size (FIELD leaf-field-declaration)
Method: compute-field-size (FIELD container-field-declaration)
Generic Function: field-declaration->sexp FIELD-DECLARATION

Return a sexp of a FIELD-DECLARATION object suitable to be used in a DEFINE-COBOL-RECORD macro. The sexp has the form:

(name ToS . properties)

where ToS is a storage type in the case leaf fields, and it’s a list of subfields (same sexp format) in case of container fields.

Package

cobstor-generator

Source

parser.lisp (file)

Methods
Method: field-declaration->sexp (DECL container-field-declaration)
Method: field-declaration->sexp (DECL leaf-field-declaration)
Generic Function: field-names FIELD-DECLARATION

Return a list of all field names at all level of nesting.

Package

cobstor-generator

Source

stub.lisp (file)

Methods
Method: field-names (FIELD container-field-declaration)
Method: field-names (FIELD field-declaration)
Generic Function: off-file OBJECT
Package

cobstor-generator

Methods
Method: off-file (PARSER-OFFSET parser-offset)

automatically generated reader method

Source

lexer.lisp (file)

Generic Function: off-token OBJECT
Package

cobstor-generator

Methods
Method: off-token (PARSER-OFFSET parser-offset)

automatically generated reader method

Source

lexer.lisp (file)

Generic Function: token OBJECT
Package

cobstor-generator

Methods
Method: token (PARSER-STREAM parser-stream)

automatically generated reader method

Source

lexer.lisp (file)

Generic Function: write-field-declaration-as-cobol FIELD-DECLARATION STREAM

Write to STREAM a FIELD-DECLARATION in Cobol syntax.

Package

cobstor-generator

Source

agent.lisp (file)

Methods
Method: write-field-declaration-as-cobol (FIELD container-field-declaration) STREAM
Method: write-field-declaration-as-cobol (FIELD leaf-field-declaration) STREAM
Method: write-field-declaration-as-cobol (FIELD field-declaration) STREAM

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

5.2.5 Conditions

Condition: cbl-condition ()

Base abstract class for all the conditions of the cobstor package.

Package

cobstor

Source

field.lisp (file)

Direct superclasses

error (condition)

Direct subclasses

cbl-file-condition (condition)

Condition: cbl-file-cobol-error ()
Package

cobstor

Source

file.lisp (file)

Direct superclasses

cbl-file-condition (condition)

Direct methods

cbl-error-status (method)

Direct slots
Slot: status
Initargs

:status

Initform

(quote nil)

Readers

cbl-error-status (generic function)


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

5.2.6 Classes

Class: parser-offset ()

Type of objects returned by GET-POSITION applied to PARSER-STREAMs.

Package

cobstor-generator

Source

lexer.lisp (file)

Direct superclasses

stream-offset (class)

Direct methods
Direct slots
Slot: file
Type

(or string pathname)

Initargs

:file

Readers

off-file (generic function)

Slot: token
Type

integer

Initargs

:token

Readers

off-token (generic function)

Class: parser-stream ()

Type of stream used by cobstor parser.

Package

cobstor-generator

Source

lexer.lisp (file)

Direct superclasses

stateful-stream (class)

Direct methods
Direct slots
Slot: grammar
Type

naive-parser-generator:grammar

Initargs

:grammar

Readers

grammar (generic function)

Slot: token
Type

integer

Initform

0

Readers

token (generic function)


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

5.2.7 Types

Type: field-storage &optional SIZE
Package

cobstor

Source

field.lisp (file)

Type: ubyte ()
Package

cobstor

Source

field.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
cobstor.asd: The cobstor<dot>asd file
cobstor/src: The cobstor/src module
cobstor/src/gen: The cobstor/src/gen module
cobstor/src/gen/agent.lisp: The cobstor/src/gen/agent<dot>lisp file
cobstor/src/gen/generator.lisp: The cobstor/src/gen/generator<dot>lisp file
cobstor/src/gen/grammar.lisp: The cobstor/src/gen/grammar<dot>lisp file
cobstor/src/gen/lexer.lisp: The cobstor/src/gen/lexer<dot>lisp file
cobstor/src/gen/package.lisp: The cobstor/src/gen/package<dot>lisp file
cobstor/src/gen/parser.lisp: The cobstor/src/gen/parser<dot>lisp file
cobstor/src/gen/ss.lisp: The cobstor/src/gen/ss<dot>lisp file
cobstor/src/gen/stub.lisp: The cobstor/src/gen/stub<dot>lisp file
cobstor/src/proxy: The cobstor/src/proxy module
cobstor/src/proxy/field.lisp: The cobstor/src/proxy/field<dot>lisp file
cobstor/src/proxy/file.lisp: The cobstor/src/proxy/file<dot>lisp file
cobstor/src/proxy/package.lisp: The cobstor/src/proxy/package<dot>lisp file
cobstor/src/proxy/record.lisp: The cobstor/src/proxy/record<dot>lisp file

F
File, Lisp, cobstor.asd: The cobstor<dot>asd file
File, Lisp, cobstor/src/gen/agent.lisp: The cobstor/src/gen/agent<dot>lisp file
File, Lisp, cobstor/src/gen/generator.lisp: The cobstor/src/gen/generator<dot>lisp file
File, Lisp, cobstor/src/gen/grammar.lisp: The cobstor/src/gen/grammar<dot>lisp file
File, Lisp, cobstor/src/gen/lexer.lisp: The cobstor/src/gen/lexer<dot>lisp file
File, Lisp, cobstor/src/gen/package.lisp: The cobstor/src/gen/package<dot>lisp file
File, Lisp, cobstor/src/gen/parser.lisp: The cobstor/src/gen/parser<dot>lisp file
File, Lisp, cobstor/src/gen/ss.lisp: The cobstor/src/gen/ss<dot>lisp file
File, Lisp, cobstor/src/gen/stub.lisp: The cobstor/src/gen/stub<dot>lisp file
File, Lisp, cobstor/src/proxy/field.lisp: The cobstor/src/proxy/field<dot>lisp file
File, Lisp, cobstor/src/proxy/file.lisp: The cobstor/src/proxy/file<dot>lisp file
File, Lisp, cobstor/src/proxy/package.lisp: The cobstor/src/proxy/package<dot>lisp file
File, Lisp, cobstor/src/proxy/record.lisp: The cobstor/src/proxy/record<dot>lisp file

L
Lisp File, cobstor.asd: The cobstor<dot>asd file
Lisp File, cobstor/src/gen/agent.lisp: The cobstor/src/gen/agent<dot>lisp file
Lisp File, cobstor/src/gen/generator.lisp: The cobstor/src/gen/generator<dot>lisp file
Lisp File, cobstor/src/gen/grammar.lisp: The cobstor/src/gen/grammar<dot>lisp file
Lisp File, cobstor/src/gen/lexer.lisp: The cobstor/src/gen/lexer<dot>lisp file
Lisp File, cobstor/src/gen/package.lisp: The cobstor/src/gen/package<dot>lisp file
Lisp File, cobstor/src/gen/parser.lisp: The cobstor/src/gen/parser<dot>lisp file
Lisp File, cobstor/src/gen/ss.lisp: The cobstor/src/gen/ss<dot>lisp file
Lisp File, cobstor/src/gen/stub.lisp: The cobstor/src/gen/stub<dot>lisp file
Lisp File, cobstor/src/proxy/field.lisp: The cobstor/src/proxy/field<dot>lisp file
Lisp File, cobstor/src/proxy/file.lisp: The cobstor/src/proxy/file<dot>lisp file
Lisp File, cobstor/src/proxy/package.lisp: The cobstor/src/proxy/package<dot>lisp file
Lisp File, cobstor/src/proxy/record.lisp: The cobstor/src/proxy/record<dot>lisp file

M
Module, cobstor/src: The cobstor/src module
Module, cobstor/src/gen: The cobstor/src/gen module
Module, cobstor/src/proxy: The cobstor/src/proxy module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   (  
A   B   C   D   E   F   G   I   K   L   M   N   O   P   Q   R   S   T   U   W  
Index Entry  Section

(
(setf cbl-file-status-extended): Internal functions
(setf cbl-file-status-major): Internal functions
(setf cbl-file-status-minor): Internal functions
(setf field-alternates): Exported generic functions
(setf field-alternates): Exported generic functions
(setf field-name): Exported generic functions
(setf field-name): Exported generic functions
(setf field-subfields): Exported generic functions
(setf field-subfields): Exported generic functions

A
add-field-sizes: Internal functions
add-running-agent: Internal functions
agent-file-pathname: Internal functions
already-exists-p: Exported functions

B
beginning-of-line-p: Exported generic functions
beginning-of-line-p: Exported generic functions
buffer: Internal functions
byte-vector->integer: Internal functions

C
case-string: Internal functions
cbl-close: Exported generic functions
cbl-close: Exported generic functions
cbl-connect: Exported functions
cbl-delete: Exported generic functions
cbl-delete: Exported generic functions
cbl-delete-file: Exported generic functions
cbl-delete-file: Exported generic functions
cbl-disconnect: Exported generic functions
cbl-disconnect: Exported generic functions
cbl-ensure-connection: Exported functions
cbl-error-status: Exported generic functions
cbl-error-status: Exported generic functions
cbl-exit: Exported generic functions
cbl-exit: Exported generic functions
cbl-file-input: Internal generic functions
cbl-file-input: Internal generic functions
cbl-file-keys: Internal generic functions
cbl-file-keys: Internal generic functions
cbl-file-metadata: Exported functions
cbl-file-name: Internal generic functions
cbl-file-name: Internal generic functions
cbl-file-output: Internal generic functions
cbl-file-output: Internal generic functions
cbl-file-port: Internal generic functions
cbl-file-port: Internal generic functions
cbl-file-record-type: Internal generic functions
cbl-file-record-type: Internal generic functions
cbl-file-socket: Internal generic functions
cbl-file-socket: Internal generic functions
cbl-file-status-extended: Internal functions
cbl-file-status-major: Internal functions
cbl-file-status-minor: Internal functions
cbl-file-status-p: Internal functions
cbl-map-fields: Exported functions
cbl-next: Exported generic functions
cbl-next: Exported generic functions
cbl-open: Exported functions
cbl-previous: Exported generic functions
cbl-previous: Exported generic functions
cbl-read: Exported generic functions
cbl-read: Exported generic functions
cbl-record-field-names: Internal functions
cbl-record-fields: Exported functions
cbl-record-file: Exported generic functions
cbl-record-file: Exported generic functions
cbl-record-file: Exported generic functions
cbl-release-connection: Exported functions
cbl-rewrite: Exported generic functions
cbl-rewrite: Exported generic functions
cbl-set-pathname: Internal generic functions
cbl-set-pathname: Internal generic functions
cbl-start: Exported generic functions
cbl-start: Exported generic functions
cbl-unlock: Exported functions
cbl-write: Exported generic functions
cbl-write: Exported generic functions
clear-agents-pool: Exported functions
collect-names: Internal functions
column: Exported generic functions
column: Exported generic functions
compile-cobol-agent: Internal functions
compile-proxy-stub: Internal functions
compiled-agent-file-pathname: Internal functions
compute-field-size: Internal generic functions
compute-field-size: Internal generic functions
compute-field-size: Internal generic functions
copy-cbl-file-status: Internal functions
copy-file-pathname: Internal functions
copy-record: Exported functions

D
data-file-pathname: Internal functions
declare-cobol-data-file: Exported macros
decode-file-status: Internal functions
defaccmkr: Internal macros
define-cobol-record: Exported macros
defsizer: Internal macros
delete-running-agent: Internal functions

E
ensure-term-envvar: Internal functions
eof-p: Exported functions
expand-picture: Internal functions

F
field-alternates: Exported generic functions
field-alternates: Exported generic functions
field-decimals: Exported generic functions
field-decimals: Exported generic functions
field-declaration->sexp: Internal generic functions
field-declaration->sexp: Internal generic functions
field-declaration->sexp: Internal generic functions
field-length: Exported generic functions
field-length: Exported generic functions
field-level: Exported generic functions
field-level: Exported generic functions
field-name: Exported generic functions
field-name: Exported generic functions
field-name-as-cobol: Internal functions
field-names: Internal generic functions
field-names: Internal generic functions
field-names: Internal generic functions
field-picture: Exported generic functions
field-picture: Exported generic functions
field-redefines: Exported generic functions
field-redefines: Exported generic functions
field-sign-position: Exported generic functions
field-sign-position: Exported generic functions
field-sign-separated: Exported generic functions
field-sign-separated: Exported generic functions
field-signed: Exported generic functions
field-signed: Exported generic functions
field-size: Exported generic functions
field-size: Exported generic functions
field-subfields: Exported generic functions
field-subfields: Exported generic functions
field-times: Exported generic functions
field-times: Exported generic functions
field-type: Exported generic functions
field-type: Exported generic functions
field-type->accessor-maker: Internal functions
field-type->sizer: Internal functions
field-type-string: Internal functions
file-error-p: Exported functions
find-running-agent: Internal functions
find-running-agent-by-port: Internal functions
free-port-p: Internal functions
Function, (setf cbl-file-status-extended): Internal functions
Function, (setf cbl-file-status-major): Internal functions
Function, (setf cbl-file-status-minor): Internal functions
Function, add-field-sizes: Internal functions
Function, add-running-agent: Internal functions
Function, agent-file-pathname: Internal functions
Function, already-exists-p: Exported functions
Function, buffer: Internal functions
Function, byte-vector->integer: Internal functions
Function, case-string: Internal functions
Function, cbl-connect: Exported functions
Function, cbl-ensure-connection: Exported functions
Function, cbl-file-metadata: Exported functions
Function, cbl-file-status-extended: Internal functions
Function, cbl-file-status-major: Internal functions
Function, cbl-file-status-minor: Internal functions
Function, cbl-file-status-p: Internal functions
Function, cbl-map-fields: Exported functions
Function, cbl-open: Exported functions
Function, cbl-record-field-names: Internal functions
Function, cbl-record-fields: Exported functions
Function, cbl-release-connection: Exported functions
Function, cbl-unlock: Exported functions
Function, clear-agents-pool: Exported functions
Function, collect-names: Internal functions
Function, compile-cobol-agent: Internal functions
Function, compile-proxy-stub: Internal functions
Function, compiled-agent-file-pathname: Internal functions
Function, copy-cbl-file-status: Internal functions
Function, copy-file-pathname: Internal functions
Function, copy-record: Exported functions
Function, data-file-pathname: Internal functions
Function, decode-file-status: Internal functions
Function, delete-running-agent: Internal functions
Function, ensure-term-envvar: Internal functions
Function, eof-p: Exported functions
Function, expand-picture: Internal functions
Function, field-name-as-cobol: Internal functions
Function, field-type->accessor-maker: Internal functions
Function, field-type->sizer: Internal functions
Function, field-type-string: Internal functions
Function, file-error-p: Exported functions
Function, find-running-agent: Internal functions
Function, find-running-agent-by-port: Internal functions
Function, free-port-p: Internal functions
Function, generate-cobstor-interface: Exported functions
Function, get-area-field-value: Internal functions
Function, get-comp1-field-value: Internal functions
Function, get-comp2-field-value: Internal functions
Function, get-comp3-field-value: Internal functions
Function, get-comp6-field-value: Internal functions
Function, get-field-value-comp4/5-be: Internal functions
Function, get-field-value-comp4/5-le: Internal functions
Function, get-numeric-field-value: Internal functions
Function, get-running-agent: Internal functions
Function, get-string-field-value: Internal functions
Function, initial-handshake: Internal functions
Function, integer->byte-vector: Internal functions
Function, keys-declaration: Internal functions
Function, load-all-proxies: Exported functions
Function, load-proxy: Exported functions
Function, longest-record-size: Internal functions
Function, make-agent-and-proxy-stub: Internal functions
Function, make-cbl-binary-accessor: Internal functions
Function, make-cbl-binary-area-accessor: Internal functions
Function, make-cbl-comp-accessor: Internal functions
Function, make-cbl-comp1-accessor: Internal functions
Function, make-cbl-comp2-accessor: Internal functions
Function, make-cbl-comp3-accessor: Internal functions
Function, make-cbl-comp4-accessor: Internal functions
Function, make-cbl-comp5-accessor: Internal functions
Function, make-cbl-comp6-accessor: Internal functions
Function, make-cbl-file-status: Internal functions
Function, make-cbl-numeric-accessor: Internal functions
Function, make-cbl-packed-accessor: Internal functions
Function, make-cbl-string-accessor: Internal functions
Function, make-cobol-agent: Exported functions
Function, make-cobol-proxy-stub: Exported functions
Function, make-field-declaration: Internal functions
Function, make-parser-stream: Internal functions
Function, make-presence-table: Internal functions
Function, new-token-position: Internal functions
Function, next-agent-port: Internal functions
Function, next-key: Exported functions
Function, next-record: Exported functions
Function, no-current-record-p: Internal functions
Function, not-found-p: Exported functions
Function, open: Exported functions
Function, open-pipe: Internal functions
Function, open-stateful-stream: Internal functions
Function, parse-file: Internal functions
Function, parse-picture: Internal functions
Function, populate-grammar: Internal functions
Function, pprint-cobol-field: Internal functions
Function, pprint-cobol-subfields: Internal functions
Function, pprint-define-cobol-record: Internal functions
Function, pprint-plist: Internal functions
Function, previous-key: Exported functions
Function, previous-record: Exported functions
Function, print-cbl-file-cobol-error-condition: Internal functions
Function, print-cbl-file-error-condition: Internal functions
Function, print-cbl-protocol-error-condition: Internal functions
Function, proxy-stub-file-pathname: Internal functions
Function, query-record-length: Internal functions
Function, rdseq: Internal functions
Function, read-field-declarations: Exported functions
Function, read-integer: Internal functions
Function, read-number: Internal functions
Function, read-picture: Internal functions
Function, read-string: Internal functions
Function, read-word: Internal functions
Function, receive-answer: Internal functions
Function, receive-message: Internal functions
Function, receive-name: Internal functions
Function, receive-ok: Internal functions
Function, receive-sequence: Internal functions
Function, receive-string-message: Internal functions
Function, record-key: Exported functions
Function, release-running-agent: Internal functions
Function, run-async-program: Internal functions
Function, send-command: Internal functions
Function, send-message: Internal functions
Function, set-area-field-value: Internal functions
Function, set-comp1-field-value: Internal functions
Function, set-comp2-field-value: Internal functions
Function, set-comp3-field-value: Internal functions
Function, set-comp6-field-value: Internal functions
Function, set-field-value-comp4/5-be: Internal functions
Function, set-field-value-comp4/5-le: Internal functions
Function, set-numeric-field-value: Internal functions
Function, set-string-field-value: Internal functions
Function, sexp->field-declaration: Internal functions
Function, signed-negative-digit-coding-table: Internal functions
Function, signed-positive-digit-coding-table: Internal functions
Function, simple-command: Internal functions
Function, size-of-cbl-binary: Internal functions
Function, size-of-cbl-binary-area: Internal functions
Function, size-of-cbl-comp: Internal functions
Function, size-of-cbl-comp1: Internal functions
Function, size-of-cbl-comp2: Internal functions
Function, size-of-cbl-comp3: Internal functions
Function, size-of-cbl-comp4: Internal functions
Function, size-of-cbl-comp5: Internal functions
Function, size-of-cbl-comp6: Internal functions
Function, size-of-cbl-numeric: Internal functions
Function, size-of-cbl-packed: Internal functions
Function, size-of-cbl-string: Internal functions
Function, size-of-comp4/5: Internal functions
Function, skip-to-eol: Internal functions
Function, skip-whitespace: Internal functions
Function, spc: Internal functions
Function, structure-records: Internal functions
Function, try-connect-to-agent: Internal functions
Function, unsigned-digit-coding-table: Internal functions
Function, word-component-p: Internal functions
Function, word-start-p: Internal functions
Function, write-data-division: Internal functions
Function, write-environment-division: Internal functions
Function, write-file-section: Internal functions
Function, write-identification-division: Internal functions
Function, write-procedure-division: Internal functions
Function, write-read-paragraph: Internal functions
Function, write-start-paragraphs: Internal functions
Function, write-working-storage-section: Internal functions
Function, wrseq: Internal functions

G
generate-cobstor-interface: Exported functions
Generic Function, (setf field-alternates): Exported generic functions
Generic Function, (setf field-name): Exported generic functions
Generic Function, (setf field-subfields): Exported generic functions
Generic Function, beginning-of-line-p: Exported generic functions
Generic Function, cbl-close: Exported generic functions
Generic Function, cbl-delete: Exported generic functions
Generic Function, cbl-delete-file: Exported generic functions
Generic Function, cbl-disconnect: Exported generic functions
Generic Function, cbl-error-status: Exported generic functions
Generic Function, cbl-exit: Exported generic functions
Generic Function, cbl-file-input: Internal generic functions
Generic Function, cbl-file-keys: Internal generic functions
Generic Function, cbl-file-name: Internal generic functions
Generic Function, cbl-file-output: Internal generic functions
Generic Function, cbl-file-port: Internal generic functions
Generic Function, cbl-file-record-type: Internal generic functions
Generic Function, cbl-file-socket: Internal generic functions
Generic Function, cbl-next: Exported generic functions
Generic Function, cbl-previous: Exported generic functions
Generic Function, cbl-read: Exported generic functions
Generic Function, cbl-record-file: Exported generic functions
Generic Function, cbl-rewrite: Exported generic functions
Generic Function, cbl-set-pathname: Internal generic functions
Generic Function, cbl-start: Exported generic functions
Generic Function, cbl-write: Exported generic functions
Generic Function, column: Exported generic functions
Generic Function, compute-field-size: Internal generic functions
Generic Function, field-alternates: Exported generic functions
Generic Function, field-decimals: Exported generic functions
Generic Function, field-declaration->sexp: Internal generic functions
Generic Function, field-length: Exported generic functions
Generic Function, field-level: Exported generic functions
Generic Function, field-name: Exported generic functions
Generic Function, field-names: Internal generic functions
Generic Function, field-picture: Exported generic functions
Generic Function, field-redefines: Exported generic functions
Generic Function, field-sign-position: Exported generic functions
Generic Function, field-sign-separated: Exported generic functions
Generic Function, field-signed: Exported generic functions
Generic Function, field-size: Exported generic functions
Generic Function, field-subfields: Exported generic functions
Generic Function, field-times: Exported generic functions
Generic Function, field-type: Exported generic functions
Generic Function, get-position: Exported generic functions
Generic Function, line: Exported generic functions
Generic Function, off-column: Exported generic functions
Generic Function, off-file: Internal generic functions
Generic Function, off-line: Exported generic functions
Generic Function, off-token: Internal generic functions
Generic Function, real-stream: Exported generic functions
Generic Function, record-size: Exported generic functions
Generic Function, record-storage: Exported generic functions
Generic Function, token: Internal generic functions
Generic Function, write-field-declaration-as-cobol: Internal generic functions
Generic Function, write-record: Exported generic functions
get-area-field-value: Internal functions
get-comp1-field-value: Internal functions
get-comp2-field-value: Internal functions
get-comp3-field-value: Internal functions
get-comp6-field-value: Internal functions
get-field-value-comp4/5-be: Internal functions
get-field-value-comp4/5-le: Internal functions
get-numeric-field-value: Internal functions
get-position: Exported generic functions
get-position: Exported generic functions
get-position: Exported generic functions
get-running-agent: Internal functions
get-string-field-value: Internal functions

I
initial-handshake: Internal functions
integer->byte-vector: Internal functions

K
keys-declaration: Internal functions

L
line: Exported generic functions
line: Exported generic functions
load-all-proxies: Exported functions
load-proxy: Exported functions
longest-record-size: Internal functions
loop-cbl-file-query: Exported macros

M
Macro, declare-cobol-data-file: Exported macros
Macro, defaccmkr: Internal macros
Macro, define-cobol-record: Exported macros
Macro, defsizer: Internal macros
Macro, loop-cbl-file-query: Exported macros
Macro, with-cbl-file: Exported macros
Macro, with-indexes: Internal macros
Macro, with-open-stateful-stream: Internal macros
Macro, with-parser-stream: Internal macros
Macro, with-record: Exported macros
Macro, with-record-accessors: Exported macros
Macro, with-records: Exported macros
make-agent-and-proxy-stub: Internal functions
make-cbl-binary-accessor: Internal functions
make-cbl-binary-area-accessor: Internal functions
make-cbl-comp-accessor: Internal functions
make-cbl-comp1-accessor: Internal functions
make-cbl-comp2-accessor: Internal functions
make-cbl-comp3-accessor: Internal functions
make-cbl-comp4-accessor: Internal functions
make-cbl-comp5-accessor: Internal functions
make-cbl-comp6-accessor: Internal functions
make-cbl-file-status: Internal functions
make-cbl-numeric-accessor: Internal functions
make-cbl-packed-accessor: Internal functions
make-cbl-string-accessor: Internal functions
make-cobol-agent: Exported functions
make-cobol-proxy-stub: Exported functions
make-field-declaration: Internal functions
make-parser-stream: Internal functions
make-presence-table: Internal functions
Method, (setf field-alternates): Exported generic functions
Method, (setf field-name): Exported generic functions
Method, (setf field-subfields): Exported generic functions
Method, beginning-of-line-p: Exported generic functions
Method, cbl-close: Exported generic functions
Method, cbl-delete: Exported generic functions
Method, cbl-delete-file: Exported generic functions
Method, cbl-disconnect: Exported generic functions
Method, cbl-error-status: Exported generic functions
Method, cbl-exit: Exported generic functions
Method, cbl-file-input: Internal generic functions
Method, cbl-file-keys: Internal generic functions
Method, cbl-file-name: Internal generic functions
Method, cbl-file-output: Internal generic functions
Method, cbl-file-port: Internal generic functions
Method, cbl-file-record-type: Internal generic functions
Method, cbl-file-socket: Internal generic functions
Method, cbl-next: Exported generic functions
Method, cbl-previous: Exported generic functions
Method, cbl-read: Exported generic functions
Method, cbl-record-file: Exported generic functions
Method, cbl-record-file: Exported generic functions
Method, cbl-rewrite: Exported generic functions
Method, cbl-set-pathname: Internal generic functions
Method, cbl-start: Exported generic functions
Method, cbl-write: Exported generic functions
Method, column: Exported generic functions
Method, compute-field-size: Internal generic functions
Method, compute-field-size: Internal generic functions
Method, field-alternates: Exported generic functions
Method, field-decimals: Exported generic functions
Method, field-declaration->sexp: Internal generic functions
Method, field-declaration->sexp: Internal generic functions
Method, field-length: Exported generic functions
Method, field-level: Exported generic functions
Method, field-name: Exported generic functions
Method, field-names: Internal generic functions
Method, field-names: Internal generic functions
Method, field-picture: Exported generic functions
Method, field-redefines: Exported generic functions
Method, field-sign-position: Exported generic functions
Method, field-sign-separated: Exported generic functions
Method, field-signed: Exported generic functions
Method, field-size: Exported generic functions
Method, field-subfields: Exported generic functions
Method, field-times: Exported generic functions
Method, field-type: Exported generic functions
Method, get-position: Exported generic functions
Method, get-position: Exported generic functions
Method, line: Exported generic functions
Method, off-column: Exported generic functions
Method, off-file: Internal generic functions
Method, off-line: Exported generic functions
Method, off-token: Internal generic functions
Method, real-stream: Exported generic functions
Method, record-size: Exported generic functions
Method, record-size: Exported generic functions
Method, record-size: Exported generic functions
Method, record-storage: Exported generic functions
Method, token: Internal generic functions
Method, write-field-declaration-as-cobol: Internal generic functions
Method, write-field-declaration-as-cobol: Internal generic functions
Method, write-field-declaration-as-cobol: Internal generic functions
Method, write-record: Exported generic functions

N
new-token-position: Internal functions
next-agent-port: Internal functions
next-key: Exported functions
next-record: Exported functions
no-current-record-p: Internal functions
not-found-p: Exported functions

O
off-column: Exported generic functions
off-column: Exported generic functions
off-file: Internal generic functions
off-file: Internal generic functions
off-line: Exported generic functions
off-line: Exported generic functions
off-token: Internal generic functions
off-token: Internal generic functions
open: Exported functions
open-pipe: Internal functions
open-stateful-stream: Internal functions

P
parse-file: Internal functions
parse-picture: Internal functions
populate-grammar: Internal functions
pprint-cobol-field: Internal functions
pprint-cobol-subfields: Internal functions
pprint-define-cobol-record: Internal functions
pprint-plist: Internal functions
previous-key: Exported functions
previous-record: Exported functions
print-cbl-file-cobol-error-condition: Internal functions
print-cbl-file-error-condition: Internal functions
print-cbl-protocol-error-condition: Internal functions
proxy-stub-file-pathname: Internal functions

Q
query-record-length: Internal functions

R
rdseq: Internal functions
read-field-declarations: Exported functions
read-integer: Internal functions
read-number: Internal functions
read-picture: Internal functions
read-string: Internal functions
read-word: Internal functions
real-stream: Exported generic functions
real-stream: Exported generic functions
receive-answer: Internal functions
receive-message: Internal functions
receive-name: Internal functions
receive-ok: Internal functions
receive-sequence: Internal functions
receive-string-message: Internal functions
record-key: Exported functions
record-size: Exported generic functions
record-size: Exported generic functions
record-size: Exported generic functions
record-size: Exported generic functions
record-storage: Exported generic functions
record-storage: Exported generic functions
release-running-agent: Internal functions
run-async-program: Internal functions

S
send-command: Internal functions
send-message: Internal functions
set-area-field-value: Internal functions
set-comp1-field-value: Internal functions
set-comp2-field-value: Internal functions
set-comp3-field-value: Internal functions
set-comp6-field-value: Internal functions
set-field-value-comp4/5-be: Internal functions
set-field-value-comp4/5-le: Internal functions
set-numeric-field-value: Internal functions
set-string-field-value: Internal functions
sexp->field-declaration: Internal functions
signed-negative-digit-coding-table: Internal functions
signed-positive-digit-coding-table: Internal functions
simple-command: Internal functions
size-of-cbl-binary: Internal functions
size-of-cbl-binary-area: Internal functions
size-of-cbl-comp: Internal functions
size-of-cbl-comp1: Internal functions
size-of-cbl-comp2: Internal functions
size-of-cbl-comp3: Internal functions
size-of-cbl-comp4: Internal functions
size-of-cbl-comp5: Internal functions
size-of-cbl-comp6: Internal functions
size-of-cbl-numeric: Internal functions
size-of-cbl-packed: Internal functions
size-of-cbl-string: Internal functions
size-of-comp4/5: Internal functions
skip-to-eol: Internal functions
skip-whitespace: Internal functions
spc: Internal functions
structure-records: Internal functions

T
token: Internal generic functions
token: Internal generic functions
try-connect-to-agent: Internal functions

U
unsigned-digit-coding-table: Internal functions

W
with-cbl-file: Exported macros
with-indexes: Internal macros
with-open-stateful-stream: Internal macros
with-parser-stream: Internal macros
with-record: Exported macros
with-record-accessors: Exported macros
with-records: Exported macros
word-component-p: Internal functions
word-start-p: Internal functions
write-data-division: Internal functions
write-environment-division: Internal functions
write-field-declaration-as-cobol: Internal generic functions
write-field-declaration-as-cobol: Internal generic functions
write-field-declaration-as-cobol: Internal generic functions
write-field-declaration-as-cobol: Internal generic functions
write-file-section: Internal functions
write-identification-division: Internal functions
write-procedure-division: Internal functions
write-read-paragraph: Internal functions
write-record: Exported generic functions
write-record: Exported generic functions
write-start-paragraphs: Internal functions
write-working-storage-section: Internal functions
wrseq: Internal functions

Jump to:   (  
A   B   C   D   E   F   G   I   K   L   M   N   O   P   Q   R   S   T   U   W  

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

A.3 Variables

Jump to:   *   +  
A   B   C   D   E   F   G   K   L   M   N   P   R   S   T  
Index Entry  Section

*
*agent-base-port*: Exported special variables
*agent-compiled-type*: Internal special variables
*agent-handles-by-name*: Internal special variables
*agent-handles-by-port*: Internal special variables
*agent-source-type*: Internal special variables
*agents-library-name*: Exported special variables
*base-directory*: Exported special variables
*binary-alias*: Internal special variables
*binary-field-class*: Exported special variables
*binary-field-size-convention*: Exported special variables
*cobol-files*: Exported special variables
*comp-alias*: Internal special variables
*comp-field-class*: Exported special variables
*compilation-epoch*: Exported special variables
*debug*: Internal special variables
*default-endianness*: Exported special variables
*default-sign-position*: Exported special variables
*default-term*: Internal special variables
*field-accessors*: Exported special variables
*keep-agent-connections*: Exported special variables
*numeric-field-sign-convention*: Exported special variables
*packed-decimal-alias*: Internal special variables
*packed-decimal-field-class*: Exported special variables
*runcbl-pathname*: Exported special variables
*setter-prefix*: Exported special variables
*treat-blank-as-zero*: Exported special variables

+
+whitespace-bytes+: Internal special variables
+word-component-table+: Internal special variables
+word-start-table+: Internal special variables

A
alternates: Exported classes

B
bol: Exported classes

C
column: Exported classes
column: Exported classes

D
decimals: Exported classes
define-grammar: Internal special variables
description: Exported conditions
description: Exported conditions

E
extended: Exported structures

F
file: Internal classes

G
grammar: Internal classes

K
keys: Exported classes

L
length: Exported classes
level: Exported classes
line: Exported classes
line: Exported classes

M
major: Exported structures
minor: Exported structures

N
name: Exported classes
name: Exported classes

P
picture: Exported classes
port-number: Exported classes
process: Exported classes

R
real-stream: Exported classes
record-type: Exported classes
redefines: Exported classes

S
sign-position: Exported classes
sign-separated: Exported classes
signed: Exported classes
size: Exported classes
size: Exported classes
Slot, alternates: Exported classes
Slot, bol: Exported classes
Slot, column: Exported classes
Slot, column: Exported classes
Slot, decimals: Exported classes
Slot, description: Exported conditions
Slot, description: Exported conditions
Slot, extended: Exported structures
Slot, file: Internal classes
Slot, grammar: Internal classes
Slot, keys: Exported classes
Slot, length: Exported classes
Slot, level: Exported classes
Slot, line: Exported classes
Slot, line: Exported classes
Slot, major: Exported structures
Slot, minor: Exported structures
Slot, name: Exported classes
Slot, name: Exported classes
Slot, picture: Exported classes
Slot, port-number: Exported classes
Slot, process: Exported classes
Slot, real-stream: Exported classes
Slot, record-type: Exported classes
Slot, redefines: Exported classes
Slot, sign-position: Exported classes
Slot, sign-separated: Exported classes
Slot, signed: Exported classes
Slot, size: Exported classes
Slot, size: Exported classes
Slot, socket: Exported classes
Slot, status: Internal conditions
Slot, storage: Exported classes
Slot, subfields: Exported classes
Slot, times: Exported classes
Slot, token: Internal classes
Slot, token: Internal classes
Slot, type: Exported classes
socket: Exported classes
Special Variable, *agent-base-port*: Exported special variables
Special Variable, *agent-compiled-type*: Internal special variables
Special Variable, *agent-handles-by-name*: Internal special variables
Special Variable, *agent-handles-by-port*: Internal special variables
Special Variable, *agent-source-type*: Internal special variables
Special Variable, *agents-library-name*: Exported special variables
Special Variable, *base-directory*: Exported special variables
Special Variable, *binary-alias*: Internal special variables
Special Variable, *binary-field-class*: Exported special variables
Special Variable, *binary-field-size-convention*: Exported special variables
Special Variable, *cobol-files*: Exported special variables
Special Variable, *comp-alias*: Internal special variables
Special Variable, *comp-field-class*: Exported special variables
Special Variable, *compilation-epoch*: Exported special variables
Special Variable, *debug*: Internal special variables
Special Variable, *default-endianness*: Exported special variables
Special Variable, *default-sign-position*: Exported special variables
Special Variable, *default-term*: Internal special variables
Special Variable, *field-accessors*: Exported special variables
Special Variable, *keep-agent-connections*: Exported special variables
Special Variable, *numeric-field-sign-convention*: Exported special variables
Special Variable, *packed-decimal-alias*: Internal special variables
Special Variable, *packed-decimal-field-class*: Exported special variables
Special Variable, *runcbl-pathname*: Exported special variables
Special Variable, *setter-prefix*: Exported special variables
Special Variable, *treat-blank-as-zero*: Exported special variables
Special Variable, +whitespace-bytes+: Internal special variables
Special Variable, +word-component-table+: Internal special variables
Special Variable, +word-start-table+: Internal special variables
Special Variable, define-grammar: Internal special variables
status: Internal conditions
storage: Exported classes
subfields: Exported classes

T
times: Exported classes
token: Internal classes
token: Internal classes
type: Exported classes

Jump to:   *   +  
A   B   C   D   E   F   G   K   L   M   N   P   R   S   T  

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

A.4 Data types

Jump to:   C   F   L   P   S   T   U  
Index Entry  Section

C
cbl-condition: Internal conditions
cbl-file: Exported classes
cbl-file-cobol-error: Internal conditions
cbl-file-condition: Exported conditions
cbl-file-error: Exported conditions
cbl-file-status: Exported structures
cbl-protocol-error: Exported conditions
cbl-record: Exported classes
Class, cbl-file: Exported classes
Class, cbl-record: Exported classes
Class, container-field-declaration: Exported classes
Class, field-declaration: Exported classes
Class, leaf-field-declaration: Exported classes
Class, parser-offset: Internal classes
Class, parser-stream: Internal classes
Class, stateful-stream: Exported classes
Class, stream-offset: Exported classes
cobstor: The cobstor system
cobstor: The cobstor package
cobstor-generator: The cobstor-generator package
cobstor-system: The cobstor-system package
Condition, cbl-condition: Internal conditions
Condition, cbl-file-cobol-error: Internal conditions
Condition, cbl-file-condition: Exported conditions
Condition, cbl-file-error: Exported conditions
Condition, cbl-protocol-error: Exported conditions
container-field-declaration: Exported classes

F
field-declaration: Exported classes
field-storage: Internal types

L
leaf-field-declaration: Exported classes

P
Package, cobstor: The cobstor package
Package, cobstor-generator: The cobstor-generator package
Package, cobstor-system: The cobstor-system package
Package, stateful-streams: The stateful-streams package
parser-offset: Internal classes
parser-stream: Internal classes

S
stateful-stream: Exported classes
stateful-streams: The stateful-streams package
stream-offset: Exported classes
Structure, cbl-file-status: Exported structures
System, cobstor: The cobstor system

T
Type, field-storage: Internal types
Type, ubyte: Internal types

U
ubyte: Internal types

Jump to:   C   F   L   P   S   T   U