The verrazano Reference Manual

Child Component

src (module).

3 Modules

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

verrazano/src
verrazano/src/frontend
verrazano/src/cffi-backend

3.1 `verrazano/src`

Source

Parent Component

verrazano (system).

Child Components

flexml.lisp (file).
generate-example-bindings.lisp (file).
packages.lisp (file).
frontend (module).
cffi-backend (module).

3.2 `verrazano/src/frontend`

Dependencies

packages.lisp (file).
flexml.lisp (file).

Source

Parent Component

src (module).

Child Components

api.lisp (file).
utility.lisp (file).
parser.lisp (file).
analyses.lisp (file).
backend.lisp (file).
filters-and-transformers.lisp (file).
driver.lisp (file).

3.3 `verrazano/src/cffi-backend`

Dependency

frontend (module).

Source

Parent Component

src (module).

Child Components

cffi.lisp (file).
writers.lisp (file).

4 Files

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

Lisp
Static

4.1 Lisp

verrazano/verrazano.asd
verrazano/src/flexml.lisp
verrazano/src/packages.lisp
verrazano/src/frontend/api.lisp
verrazano/src/frontend/utility.lisp
verrazano/src/frontend/parser.lisp
verrazano/src/frontend/analyses.lisp
verrazano/src/frontend/backend.lisp
verrazano/src/frontend/filters-and-transformers.lisp
verrazano/src/frontend/driver.lisp
verrazano/src/cffi-backend/cffi.lisp
verrazano/src/cffi-backend/writers.lisp

4.1.1 `verrazano/verrazano.asd`

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

4.1.2 `verrazano/src/flexml.lisp`

Source

Parent Component

src (module).

Packages

flexml.
xml.

Public Interface

attributes-of (reader method).
(setf attributes-of) (writer method).
characters (method).
children-of (reader method).
(setf children-of) (writer method).
class-for-node-name (generic function).
class-name-for-node-name (generic function).
cross-referenced-node (type).
cross-referenced-nodes (type).
end-document (method).
end-element (method).
find-node-by-id (generic function).
first-child-with-local-name (function).
first-child-with-type (function).
flexml-builder (class).
flexml-node (class).
local-name-of (reader method).
(setf local-name-of) (writer method).
make-flexml-builder (function).
parent-of (reader method).
(setf parent-of) (writer method).
register-flexml-namespace (function).
root-of (reader method).
(setf root-of) (writer method).
slot-missing (method).
start-element (method).
string-content-of (function).

Internals

*xml-namespace->lisp-package* (special variable).
+xml-namespace-uri+ (special variable).
cross-referencing-slots-of (reader method).
(setf cross-referencing-slots-of) (writer method).
default-package-of (reader method).
(setf default-package-of) (writer method).
element-stack-of (reader method).
(setf element-stack-of) (writer method).
find-lisp-package-for-xml-namespace (function).
find-slot (function).
id->node-of (reader method).
(setf id->node-of) (writer method).
id-of (reader method).
(setf id-of) (writer method).
include-default-values-p (reader method).
(setf include-default-values-p) (writer method).
missing-cross-reference (function).

4.1.3 `verrazano/src/packages.lisp`

Source

Parent Component

src (module).

Packages

gccxml.
verrazano-user.
verrazano.

4.1.4 `verrazano/src/frontend/api.lisp`

Source

Parent Component

frontend (module).

Internals

*backend* (special variable).
*parser* (special variable).
*unique-name-counter* (special variable).
make-backend (generic function).
process-gccxml-node (generic function).

4.1.5 `verrazano/src/frontend/utility.lisp`

Dependency

api.lisp (file).

Source

Parent Component

frontend (module).

Internals

aif (macro).
aprog1 (macro).
awhen (macro).
bits-to-bytes (function).
do-arguments-of-function (macro).
do-fields-of-composite-type (macro).
execute-shell-command (function).
generate-unique-name (function).
if-bind (macro).
prog1-bind (macro).
system-relative-pathname (function).
unquote-string (function).
when-bind (macro).

4.1.6 `verrazano/src/frontend/parser.lisp`

Dependency

utility.lisp (file).

Source

Parent Component

frontend (module).

Public Interface

argument (class).
arguments-of (reader method).
(setf arguments-of) (writer method).
arraytype (class).
base (class).
bits-of (reader method).
(setf bits-of) (writer method).
body-of (reader method).
body-of (method).
(setf body-of) (writer method).
characters (method).
class (class).
const? (reader method).
(setf const?) (writer method).
constructor (class).
context-of (reader method).
(setf context-of) (writer method).
converter (class).
cvqualifiedtype (class).
definition (class).
destructor (class).
ellipsis (class).
end-document (method).
end-element (method).
enumeration (class).
enumvalue (class).
extern? (reader method).
(setf extern?) (writer method).
externable-node (class).
field (class).
file (class).
file-of (reader method).
(setf file-of) (writer method).
function (class).
functiontype (class).
fundamentaltype (class).
gcc_xml (class).
incomplete? (reader method).
incomplete? (reader method).
(setf incomplete?) (writer method).
(setf incomplete?) (writer method).
line-of (reader method).
(setf line-of) (writer method).
macro (class).
mangled-of (reader method).
(setf mangled-of) (writer method).
members-of (reader method).
(setf members-of) (writer method).
method (class).
name-of (reader method).
name-of (reader method).
(setf name-of) (writer method).
(setf name-of) (writer method).
namespace (class).
node (class).
node-with-members (class).
node-with-name (class).
node-with-type (class).
offset-of (reader method).
(setf offset-of) (writer method).
offsettype (class).
operatorfunction (class).
operatormethod (class).
pointertype (class).
print-object (method).
raw-body-of (reader method).
(setf raw-body-of) (writer method).
referencetype (class).
returns-of (reader method).
(setf returns-of) (writer method).
start-element (method).
struct (class).
type-of (reader method).
(setf type-of) (writer method).
typedef (class).
union (class).
variable (class).

Internals

%map-gccxml-nodes/breadth-first (function).
%map-gccxml-nodes/depth-first (function).
c-literal-to-lisp-literal (function).
find-node-by-name (generic function).
gccxml-parser (class).
id->file-node-of (reader method).
(setf id->file-node-of) (writer method).
input-files-of (reader method).
(setf input-files-of) (writer method).
macro-name->macro-node-of (reader method).
(setf macro-name->macro-node-of) (writer method).
make-gccxml-parser (function).
map-gccxml-nodes (function).
map-gccxml-nodes/breadth-first (function).
map-gccxml-nodes/depth-first (function).
parse-gccxml-output (function).
parse-macro-definitions (function).
root-namespace-of (generic function).
type->name->node-of (reader method).
(setf type->name->node-of) (writer method).

4.1.7 `verrazano/src/frontend/analyses.lisp`

Dependency

parser.lisp (file).

Source

Parent Component

frontend (module).

Public Interface

artificial? (function).

Internals

anonymous? (function).
the-void-type? (function).

4.1.8 `verrazano/src/frontend/backend.lisp`

Dependency

analyses.lisp (file).

Source

Parent Component

frontend (module).

Internals

already-processed-of (reader method).
(setf already-processed-of) (writer method).
backend (class).
currently-being-processed-of (reader method).
(setf currently-being-processed-of) (writer method).
definitions-to-output-of (reader method).
(setf definitions-to-output-of) (writer method).
export-filter-of (reader method).
(setf export-filter-of) (writer method).
filter-definitions-from-indirect-files-p (reader method).
(setf filter-definitions-from-indirect-files-p) (writer method).
gccxml-flags-of (reader method).
(setf gccxml-flags-of) (writer method).
gccxml-node-types-to-output-of (reader method).
(setf gccxml-node-types-to-output-of) (writer method).
gccxml-path-of (reader method).
(setf gccxml-path-of) (writer method).
input-files-of (reader method).
(setf input-files-of) (writer method).
name-filter-of (reader method).
(setf name-filter-of) (writer method).
name-transformer-of (reader method).
(setf name-transformer-of) (writer method).
node-filter-of (reader method).
(setf node-filter-of) (writer method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
simple-backend (class).
standard-name-transformer-replacements-of (reader method).
(setf standard-name-transformer-replacements-of) (writer method).
temporary-directory-of (reader method).
(setf temporary-directory-of) (writer method).
temporary-filename-for (function).
temporary-files-of (reader method).
(setf temporary-files-of) (writer method).
transform-name (function).
working-directory-of (reader method).
(setf working-directory-of) (writer method).

4.1.9 `verrazano/src/frontend/filters-and-transformers.lisp`

Dependency

backend.lisp (file).

Source

Parent Component

frontend (module).

Public Interface

camel-case-to-hyphened (function).
dashes-to-hyphens (function).
standard-name-transformer (function).

Internals

%standard-name-transformer (function).
name-kind (type).
standard-export-filter (function).
standard-name-filter (function).
starts-with-dash-p (function).

4.1.10 `verrazano/src/frontend/driver.lisp`

Dependency

filters-and-transformers.lisp (file).

Source

Parent Component

frontend (module).

Public Interface

generate-binding (function).

Internals

ensure-gccxml-is-installed (function).
run-gccxml (function).

4.1.11 `verrazano/src/cffi-backend/cffi.lisp`

Source

Parent Component

cffi-backend (module).

Public Interface

initialize-instance (method).

Internals

*gccxml-fundamental-type->cffi-type* (special variable).
cffi-backend (class).
const-char-pointer-is-string? (reader method).
(setf const-char-pointer-is-string?) (writer method).
enqueue-for-export (function).
exported-symbols-of (reader method).
(setf exported-symbols-of) (writer method).
make-backend (method).
output-filename-of (reader method).
(setf output-filename-of) (writer method).
package-name-of (reader method).
(setf package-name-of) (writer method).
package-nicknames-of (reader method).
(setf package-nicknames-of) (writer method).

4.1.12 `verrazano/src/cffi-backend/writers.lisp`

Dependency

cffi.lisp (file).

Source

Parent Component

cffi-backend (module).

Internals

function-name-of (generic function).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
process-gccxml-node (method).
remove-internal-suffix (function).
symbolify (function).
warn-and-write-as-comment (function).
write-cffi-function (function).
write-cffi-type (generic function).
write-composite-cffi-type (function).
write-composite-cffi-type-field (function).
write-form (function).
write-formatted-text (function).
write-keyword (function).

4.2 Static

verrazano/src/generate-example-bindings.lisp

4.2.1 `verrazano/src/generate-example-bindings.lisp`

Source: verrazano.asd.
Parent Component: src (module).

5 Packages

Packages are listed by definition order.

gccxml
flexml
xml
verrazano-user
verrazano

5.1 `gccxml`

Source

packages.lisp.

Public Interface

argument (class).
arguments-of (generic reader).
(setf arguments-of) (generic writer).
arraytype (class).
artificial? (function).
base (class).
bits-of (generic reader).
(setf bits-of) (generic writer).
body-of (generic function).
(setf body-of) (generic writer).
class (class).
const? (generic reader).
(setf const?) (generic writer).
constructor (class).
context-of (generic reader).
(setf context-of) (generic writer).
converter (class).
cvqualifiedtype (class).
definition (class).
destructor (class).
ellipsis (class).
enumeration (class).
enumvalue (class).
extern? (generic reader).
(setf extern?) (generic writer).
externable-node (class).
field (class).
file (class).
file-of (generic reader).
(setf file-of) (generic writer).
function (class).
functiontype (class).
fundamentaltype (class).
gcc_xml (class).
incomplete? (generic reader).
(setf incomplete?) (generic writer).
line-of (generic reader).
(setf line-of) (generic writer).
macro (class).
mangled-of (generic reader).
(setf mangled-of) (generic writer).
members-of (generic reader).
(setf members-of) (generic writer).
method (class).
name-of (generic reader).
(setf name-of) (generic writer).
namespace (class).
node (class).
node-with-members (class).
node-with-name (class).
node-with-type (class).
offset-of (generic reader).
(setf offset-of) (generic writer).
offsettype (class).
operatorfunction (class).
operatormethod (class).
pointertype (class).
raw-body-of (generic reader).
(setf raw-body-of) (generic writer).
referencetype (class).
returns-of (generic reader).
(setf returns-of) (generic writer).
struct (class).
type-of (generic reader).
(setf type-of) (generic writer).
typedef (class).
union (class).
variable (class).

5.2 `flexml`

Source

Use List

common-lisp.
cxml.

Public Interface

attributes-of (generic reader).
(setf attributes-of) (generic writer).
children-of (generic reader).
(setf children-of) (generic writer).
class-for-node-name (generic function).
class-name-for-node-name (generic function).
cross-referenced-node (type).
cross-referenced-nodes (type).
find-node-by-id (generic function).
first-child-with-local-name (function).
first-child-with-type (function).
flexml-builder (class).
flexml-node (class).
local-name-of (generic reader).
(setf local-name-of) (generic writer).
make-flexml-builder (function).
parent-of (generic reader).
(setf parent-of) (generic writer).
register-flexml-namespace (function).
root-of (generic reader).
(setf root-of) (generic writer).
string-content-of (function).

Internals

*xml-namespace->lisp-package* (special variable).
+xml-namespace-uri+ (special variable).
cross-referencing-slots-of (generic reader).
(setf cross-referencing-slots-of) (generic writer).
default-package-of (generic reader).
(setf default-package-of) (generic writer).
element-stack-of (generic reader).
(setf element-stack-of) (generic writer).
find-lisp-package-for-xml-namespace (function).
find-slot (function).
id->node-of (generic reader).
(setf id->node-of) (generic writer).
id-of (generic reader).
(setf id-of) (generic writer).
include-default-values-p (generic reader).
(setf include-default-values-p) (generic writer).
missing-cross-reference (function).

5.3 `xml`

Source: flexml.lisp.
Public Interface: id (slot).

5.4 `verrazano-user`

Source

packages.lisp.

Use List

alexandria.
cffi.
common-lisp.
iterate.
metabang.bind.
verrazano.

5.5 `verrazano`

Source

packages.lisp.

Use List

alexandria.
common-lisp.
iterate.
metabang.bind.
org.mapcar.parse-number.

Used By List

verrazano-user.

Public Interface

camel-case-to-hyphened (function).
dashes-to-hyphens (function).
generate-binding (function).
standard-name-transformer (function).

Internals

%map-gccxml-nodes/breadth-first (function).
%map-gccxml-nodes/depth-first (function).
%standard-name-transformer (function).
*backend* (special variable).
*gccxml-fundamental-type->cffi-type* (special variable).
*parser* (special variable).
*unique-name-counter* (special variable).
aif (macro).
already-processed-of (generic reader).
(setf already-processed-of) (generic writer).
anonymous? (function).
aprog1 (macro).
awhen (macro).
backend (class).
bits-to-bytes (function).
c-literal-to-lisp-literal (function).
cffi-backend (class).
const-char-pointer-is-string? (generic reader).
(setf const-char-pointer-is-string?) (generic writer).
currently-being-processed-of (generic reader).
(setf currently-being-processed-of) (generic writer).
definitions-to-output-of (generic reader).
(setf definitions-to-output-of) (generic writer).
do-arguments-of-function (macro).
do-fields-of-composite-type (macro).
enqueue-for-export (function).
ensure-gccxml-is-installed (function).
execute-shell-command (function).
export-filter-of (generic reader).
(setf export-filter-of) (generic writer).
exported-symbols-of (generic reader).
(setf exported-symbols-of) (generic writer).
filter-definitions-from-indirect-files-p (generic reader).
(setf filter-definitions-from-indirect-files-p) (generic writer).
find-node-by-name (generic function).
function-name-of (generic function).
gccxml-flags-of (generic reader).
(setf gccxml-flags-of) (generic writer).
gccxml-node-types-to-output-of (generic reader).
(setf gccxml-node-types-to-output-of) (generic writer).
gccxml-parser (class).
gccxml-path-of (generic reader).
(setf gccxml-path-of) (generic writer).
generate-unique-name (function).
id->file-node-of (generic reader).
(setf id->file-node-of) (generic writer).
if-bind (macro).
input-files-of (generic reader).
(setf input-files-of) (generic writer).
macro-name->macro-node-of (generic reader).
(setf macro-name->macro-node-of) (generic writer).
make-backend (generic function).
make-gccxml-parser (function).
map-gccxml-nodes (function).
map-gccxml-nodes/breadth-first (function).
map-gccxml-nodes/depth-first (function).
name-filter-of (generic reader).
(setf name-filter-of) (generic writer).
name-kind (type).
name-transformer-of (generic reader).
(setf name-transformer-of) (generic writer).
node-filter-of (generic reader).
(setf node-filter-of) (generic writer).
output-filename-of (generic reader).
(setf output-filename-of) (generic writer).
package-name-of (generic reader).
(setf package-name-of) (generic writer).
package-nicknames-of (generic reader).
(setf package-nicknames-of) (generic writer).
parse-gccxml-output (function).
parse-macro-definitions (function).
process-gccxml-node (generic function).
prog1-bind (macro).
remove-internal-suffix (function).
root-namespace-of (generic function).
run-gccxml (function).
simple-backend (class).
standard-export-filter (function).
standard-name-filter (function).
standard-name-transformer-replacements-of (generic reader).
(setf standard-name-transformer-replacements-of) (generic writer).
starts-with-dash-p (function).
symbolify (function).
system-relative-pathname (function).
temporary-directory-of (generic reader).
(setf temporary-directory-of) (generic writer).
temporary-filename-for (function).
temporary-files-of (generic reader).
(setf temporary-files-of) (generic writer).
the-void-type? (function).
transform-name (function).
type->name->node-of (generic reader).
(setf type->name->node-of) (generic writer).
unquote-string (function).
warn-and-write-as-comment (function).
when-bind (macro).
working-directory-of (generic reader).
(setf working-directory-of) (generic writer).
write-cffi-function (function).
write-cffi-type (generic function).
write-composite-cffi-type (function).
write-composite-cffi-type-field (function).
write-form (function).
write-formatted-text (function).
write-keyword (function).

6 Definitions

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

Public Interface
Internals

6.1.1 Ordinary functions

Function: artificial? (node) ¶

Package: gccxml.
Source: analyses.lisp.

Function: camel-case-to-hyphened (input) ¶

Insert a hyphen before each subsequent uppercase, lowercase alphanumeric characters

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: dashes-to-hyphens (input) ¶

Replaces _ with - except at the very beginning.

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: first-child-with-local-name (node name) ¶

Package: flexml.
Source: flexml.lisp.

Function: first-child-with-type (node type) ¶

Package: flexml.
Source: flexml.lisp.

Function: generate-binding (backend &key keep-temporary-files) ¶

This is the primary entry point, given a CONFIGURATION generate a binding using BACKEND.

Package: verrazano.
Source: driver.lisp.

Function: make-flexml-builder (&key default-package include-default-values) ¶

Package: flexml.
Source: flexml.lisp.

Function: register-flexml-namespace (namespace-uri lisp-package) ¶

Package: flexml.
Source: flexml.lisp.

Function: standard-name-transformer (input kind) ¶

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: string-content-of (node) ¶

Package: flexml.
Source: flexml.lisp.

6.1.2 Generic functions

Generic Reader: arguments-of (object) ¶

Package

Methods

Reader Method: arguments-of ((macro macro)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: arguments.

Generic Writer: (setf arguments-of) (object) ¶

Package

Methods

Writer Method: (setf arguments-of) ((macro macro)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: arguments.

Generic Reader: attributes-of (object) ¶

Package

Methods

Reader Method: attributes-of ((flexml-node flexml-node)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: attributes.

Generic Writer: (setf attributes-of) (object) ¶

Package

Methods

Writer Method: (setf attributes-of) ((flexml-node flexml-node)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: attributes.

Generic Reader: bits-of (object) ¶

Package

Methods

Reader Method: bits-of ((field field)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: bits.

Generic Writer: (setf bits-of) (object) ¶

Package

Methods

Writer Method: (setf bits-of) ((field field)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: bits.

Generic Function: body-of (object) ¶

Package

Methods

Reader Method: body-of :around ((node macro)) ¶

Source: parser.lisp.
Target Slot: body.

Method: body-of ((macro macro)) ¶

automatically generated reader method

Source: parser.lisp.

Generic Writer: (setf body-of) (object) ¶

Package

Methods

Writer Method: (setf body-of) ((macro macro)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: body.

Generic Reader: children-of (object) ¶

Package

Methods

Reader Method: children-of ((flexml-node flexml-node)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: children.

Generic Writer: (setf children-of) (object) ¶

Package

Methods

Writer Method: (setf children-of) ((flexml-node flexml-node)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: children.

Generic Function: class-for-node-name (builder namespace-uri package local-name qualified-name) ¶

Package

Source

Methods

Method: class-for-node-name (builder namespace-uri package (local-name string) qualified-name) ¶

Generic Function: class-name-for-node-name (builder namespace-uri package local-name qualified-name) ¶

Package

Source

Methods

Method: class-name-for-node-name (builder namespace-uri package (local-name string) qualified-name) ¶

Generic Reader: const? (object) ¶

Package

Methods

Reader Method: const? ((cvqualifiedtype cvqualifiedtype)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: const.

Generic Writer: (setf const?) (object) ¶

Package

Methods

Writer Method: (setf const?) ((cvqualifiedtype cvqualifiedtype)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: const.

Generic Reader: context-of (object) ¶

Package

Methods

Reader Method: context-of ((node node)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: context.

Generic Writer: (setf context-of) (object) ¶

Package

Methods

Writer Method: (setf context-of) ((node node)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: context.

Generic Reader: extern? (object) ¶

Package

Methods

Reader Method: extern? ((externable-node externable-node)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: extern.

Generic Writer: (setf extern?) (object) ¶

Package

Methods

Writer Method: (setf extern?) ((externable-node externable-node)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: extern.

Generic Reader: file-of (object) ¶

Package

Methods

Reader Method: file-of ((node node)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: file.

Generic Writer: (setf file-of) (object) ¶

Package

Methods

Writer Method: (setf file-of) ((node node)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: file.

Generic Function: find-node-by-id (id builder &key otherwise) ¶

Package

Source

Methods

Method: find-node-by-id ((id string) (builder flexml-builder) &key otherwise) ¶

Generic Reader: incomplete? (object) ¶

Package

Methods

Reader Method: incomplete? ((class class)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: incomplete.

Reader Method: incomplete? ((struct struct)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: incomplete.

Generic Writer: (setf incomplete?) (object) ¶

Package

Methods

Writer Method: (setf incomplete?) ((class class)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: incomplete.

Writer Method: (setf incomplete?) ((struct struct)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: incomplete.

Generic Reader: line-of (object) ¶

Package

Methods

Reader Method: line-of ((node node)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: line.

Generic Writer: (setf line-of) (object) ¶

Package

Methods

Writer Method: (setf line-of) ((node node)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: line.

Generic Reader: local-name-of (object) ¶

Package

Methods

Reader Method: local-name-of ((flexml-node flexml-node)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: local-name.

Generic Writer: (setf local-name-of) (object) ¶

Package

Methods

Writer Method: (setf local-name-of) ((flexml-node flexml-node)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: local-name.

Generic Reader: mangled-of (object) ¶

Package

Methods

Reader Method: mangled-of ((node-with-name node-with-name)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: mangled.

Generic Writer: (setf mangled-of) (object) ¶

Package

Methods

Writer Method: (setf mangled-of) ((node-with-name node-with-name)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: mangled.

Generic Reader: members-of (object) ¶

Package

Methods

Reader Method: members-of ((node-with-members node-with-members)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: members.

Generic Writer: (setf members-of) (object) ¶

Package

Methods

Writer Method: (setf members-of) ((node-with-members node-with-members)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: members.

Generic Reader: name-of (object) ¶

Package

Methods

Reader Method: name-of ((macro macro)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: name.

Reader Method: name-of ((node-with-name node-with-name)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: name.

Generic Writer: (setf name-of) (object) ¶

Package

Methods

Writer Method: (setf name-of) ((macro macro)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: name.

Writer Method: (setf name-of) ((node-with-name node-with-name)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: name.

Generic Reader: offset-of (object) ¶

Package

Methods

Reader Method: offset-of ((field field)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: offset.

Generic Writer: (setf offset-of) (object) ¶

Package

Methods

Writer Method: (setf offset-of) ((field field)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: offset.

Generic Reader: parent-of (object) ¶

Package

Methods

Reader Method: parent-of ((flexml-node flexml-node)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: parent.

Generic Writer: (setf parent-of) (object) ¶

Package

Methods

Writer Method: (setf parent-of) ((flexml-node flexml-node)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: parent.

Generic Reader: raw-body-of (object) ¶

Package

Methods

Reader Method: raw-body-of ((macro macro)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: raw-body.

Generic Writer: (setf raw-body-of) (object) ¶

Package

Methods

Writer Method: (setf raw-body-of) ((macro macro)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: raw-body.

Generic Reader: returns-of (object) ¶

Package

Methods

Reader Method: returns-of ((function function)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: returns.

Generic Writer: (setf returns-of) (object) ¶

Package

Methods

Writer Method: (setf returns-of) ((function function)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: returns.

Generic Reader: root-of (object) ¶

Package

Methods

Reader Method: root-of ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: root.

Generic Writer: (setf root-of) (object) ¶

Package

Methods

Writer Method: (setf root-of) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: root.

Generic Reader: type-of (object) ¶

Package

Methods

Reader Method: type-of ((node-with-type node-with-type)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: type.

Generic Writer: (setf type-of) (object) ¶

Package

Methods

Writer Method: (setf type-of) ((node-with-type node-with-type)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: type.

6.1.3 Standalone methods

Method: characters ((builder flexml-builder) data) ¶

Package: sax.
Source: flexml.lisp.

Method: characters ((parser gccxml-parser) data) ¶

Package: sax.
Source: parser.lisp.

Method: end-document ((builder flexml-builder)) ¶

Package: sax.
Source: flexml.lisp.

Method: end-document :after ((builder gccxml-parser)) ¶

Package: sax.
Source: parser.lisp.

Method: end-element ((builder flexml-builder) namespace-uri local-name qname) ¶

Package: sax.
Source: flexml.lisp.

Method: end-element :around ((builder gccxml-parser) namespace-uri local-name qname) ¶

Package: sax.
Source: parser.lisp.

Method: initialize-instance :after ((self cffi-backend) &key) ¶

Source: cffi.lisp.

Method: print-object ((self node-with-name) stream) ¶

Source: parser.lisp.

Method: slot-missing (class (node flexml-node) slot-name operation &optional new-value) ¶

Source: flexml.lisp.

Method: start-element ((builder flexml-builder) namespace-uri local-name qname attributes) ¶

Package: sax.
Source: flexml.lisp.

Method: start-element :around ((parser gccxml-parser) namespace-uri local-name qname attributes) ¶

Package: sax.
Source: parser.lisp.

6.1.4 Classes

Class: argument ¶

Package

Source

Direct superclasses

node-with-name.
node-with-type.

Class: arraytype ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-type.
Direct methods: write-cffi-type.

Class: base ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node.

Class: class ¶

Package

Source

Direct superclasses

definition.
node-with-members.

Direct methods

(setf incomplete?).
incomplete?.
process-gccxml-node.
write-cffi-type.

Direct slots

Slot: incomplete ¶

Type: boolean
Readers: incomplete?.
Writers: (setf incomplete?).

Class: constructor ¶

Package

Source

Direct superclasses

node-with-name.

Direct methods

function-name-of.
process-gccxml-node.

Class: converter ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node.

Class: cvqualifiedtype ¶

Package

Source

Direct superclasses

node-with-type.

Direct methods

(setf const?).
const?.
write-cffi-type.

Direct slots

Slot: const ¶

Type: boolean
Readers: const?.
Writers: (setf const?).

Class: definition ¶

Package

Source

Direct superclasses

node-with-name.

Direct subclasses

class.
enumeration.
externable-node.
functiontype.
macro.
struct.
typedef.
union.

Class: destructor ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node.

Class: ellipsis ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node.

Class: enumeration ¶

Package

Source

Direct superclasses

Direct methods

process-gccxml-node.
write-cffi-type.

Class: enumvalue ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-name.

Class: externable-node ¶

Package

Source

Direct superclasses

Direct subclasses

function.
variable.

Direct methods

(setf extern?).
extern?.

Direct slots

Slot: extern ¶

Type: boolean
Readers: extern?.
Writers: (setf extern?).

Class: field ¶

Package

Source

Direct superclasses

node-with-name.
node-with-type.

Direct methods

(setf bits-of).
bits-of.
(setf offset-of).
offset-of.

Direct slots

Slot: bits ¶

Type: (or null integer)
Readers: bits-of.
Writers: (setf bits-of).

Slot: offset ¶

Type: integer
Readers: offset-of.
Writers: (setf offset-of).

Class: file ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-name.

Class: flexml-builder ¶

Package

Source

Direct superclasses

default-handler.

Direct subclasses

gccxml-parser.

Direct methods

characters.
(setf cross-referencing-slots-of).
cross-referencing-slots-of.
(setf default-package-of).
default-package-of.
(setf element-stack-of).
element-stack-of.
end-document.
end-element.
find-node-by-id.
(setf id->node-of).
id->node-of.
(setf include-default-values-p).
include-default-values-p.
(setf root-of).
root-of.
start-element.

Direct slots

Slot: default-package ¶

Initargs: :default-package
Readers: default-package-of.
Writers: (setf default-package-of).

Slot: element-stack ¶

Readers: element-stack-of.
Writers: (setf element-stack-of).

Slot: root ¶

Readers: root-of.
Writers: (setf root-of).

Slot: include-default-values ¶

Type: boolean
Initform: t
Initargs: :include-default-values
Readers: include-default-values-p.
Writers: (setf include-default-values-p).

Slot: id->node ¶

Initform: (make-hash-table :test (function equal))
Readers: id->node-of.
Writers: (setf id->node-of).

Slot: cross-referencing-slots ¶

Readers: cross-referencing-slots-of.
Writers: (setf cross-referencing-slots-of).

Class: flexml-node ¶

Package

Source

Direct subclasses

Direct methods

(setf attributes-of).
attributes-of.
(setf children-of).
children-of.
(setf id-of).
id-of.
(setf local-name-of).
local-name-of.
(setf parent-of).
parent-of.
slot-missing.

Direct slots

Slot: id ¶

Package: xml.
Readers: id-of.
Writers: (setf id-of).

Slot: parent ¶

Initargs: :paren
Readers: parent-of.
Writers: (setf parent-of).

Slot: children ¶

Initargs: :children
Readers: children-of.
Writers: (setf children-of).

Slot: attributes ¶

Initargs: :attributes
Readers: attributes-of.
Writers: (setf attributes-of).

Slot: local-name ¶

Initargs: :local-name
Readers: local-name-of.
Writers: (setf local-name-of).

Class: function ¶

Package

Source

Direct superclasses

externable-node.

Direct subclasses

method.
operatorfunction.
operatormethod.

Direct methods

function-name-of.
process-gccxml-node.
(setf returns-of).
returns-of.

Direct slots

Slot: returns ¶

Type: flexml:cross-referenced-node
Readers: returns-of.
Writers: (setf returns-of).

Class: functiontype ¶

Package

Source

Direct superclasses

Direct methods

write-cffi-type.

Direct slots

Slot: returns ¶

Type: flexml:cross-referenced-node

Class: fundamentaltype ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-name.
Direct methods: write-cffi-type.

Class: gcc_xml ¶

Package

Source

Direct superclasses

Direct methods

process-gccxml-node.
process-gccxml-node.

Class: macro ¶

Package

Source

Direct superclasses

Direct methods

(setf arguments-of).
arguments-of.
body-of.
(setf body-of).
body-of.
(setf name-of).
name-of.
process-gccxml-node.
(setf raw-body-of).
raw-body-of.

Direct slots

Slot: name ¶

Readers: name-of.
Writers: (setf name-of).

Slot: arguments ¶

Readers: arguments-of.
Writers: (setf arguments-of).

Slot: body ¶

Readers: body-of.
Writers: (setf body-of).

Slot: raw-body ¶

Readers: raw-body-of.
Writers: (setf raw-body-of).

Class: method ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: function.

Class: namespace ¶

Package

Source

Direct superclasses

node-with-members.
node-with-name.
node-with-type.

Class: node ¶

Package

Source

Direct superclasses

flexml-node.

Direct subclasses

base.
converter.
destructor.
ellipsis.
gcc_xml.
node-with-members.
node-with-name.
node-with-type.
offsettype.

Direct methods

(setf context-of).
context-of.
(setf file-of).
file-of.
(setf line-of).
line-of.

Direct slots

Slot: file ¶

Type: flexml:cross-referenced-node
Readers: file-of.
Writers: (setf file-of).

Slot: line ¶

Type: (or null integer)
Readers: line-of.
Writers: (setf line-of).

Slot: context ¶

Type: flexml:cross-referenced-node
Readers: context-of.
Writers: (setf context-of).

Class: node-with-members ¶

Package

Source

Direct superclasses

Direct subclasses

class.
namespace.
struct.
union.

Direct methods

(setf members-of).
members-of.

Direct slots

Slot: members ¶

Type: flexml:cross-referenced-nodes
Initform: #()
Readers: members-of.
Writers: (setf members-of).

Class: node-with-name ¶

Package

Source

Direct superclasses

Direct subclasses

argument.
constructor.
definition.
enumvalue.
field.
file.
fundamentaltype.
namespace.

Direct methods

(setf mangled-of).
mangled-of.
(setf name-of).
name-of.
print-object.
process-gccxml-node.

Direct slots

Slot: name ¶

Readers: name-of.
Writers: (setf name-of).

Slot: mangled ¶

Readers: mangled-of.
Writers: (setf mangled-of).

Class: node-with-type ¶

Package

Source

Direct superclasses

Direct subclasses

argument.
arraytype.
cvqualifiedtype.
field.
namespace.
pointertype.
referencetype.
typedef.
variable.

Direct methods

process-gccxml-node.
(setf type-of).
type-of.

Direct slots

Slot: type ¶

Type: flexml:cross-referenced-node
Readers: type-of.
Writers: (setf type-of).

Class: offsettype ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node.

Class: operatorfunction ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: function.
Direct methods: function-name-of.

Class: operatormethod ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: function.
Direct methods: function-name-of.

Class: pointertype ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-type.
Direct methods: write-cffi-type.

Class: referencetype ¶

Package: gccxml.
Source: parser.lisp.
Direct superclasses: node-with-type.
Direct methods: write-cffi-type.

Class: struct ¶

Package

Source

Direct superclasses

definition.
node-with-members.

Direct methods

(setf incomplete?).
incomplete?.
process-gccxml-node.
write-cffi-type.

Direct slots

Slot: incomplete ¶

Type: boolean
Readers: incomplete?.
Writers: (setf incomplete?).

Class: typedef ¶

Package

Source

Direct superclasses

definition.
node-with-type.

Direct methods

process-gccxml-node.
write-cffi-type.

Class: union ¶

Package

Source

Direct superclasses

definition.
node-with-members.

Direct methods

process-gccxml-node.
write-cffi-type.

Class: variable ¶

Package

Source

Direct superclasses

externable-node.
node-with-type.

Direct methods

process-gccxml-node.

6.1.5 Types

Type: cross-referenced-node () ¶

Package: flexml.
Source: flexml.lisp.

Type: cross-referenced-nodes () ¶

Package: flexml.
Source: flexml.lisp.

6.2 Internals

Special variables
Macros
Ordinary functions
Generic functions
Classes
Types

6.2.1 Special variables

Special Variable: *backend* ¶

Package: verrazano.
Source: api.lisp.

Special Variable: *gccxml-fundamental-type->cffi-type* ¶

Package: verrazano.
Source: cffi.lisp.

Special Variable: *parser* ¶

Package: verrazano.
Source: api.lisp.

Special Variable: *unique-name-counter* ¶

Package: verrazano.
Source: api.lisp.

Special Variable: *xml-namespace->lisp-package* ¶

Package: flexml.
Source: flexml.lisp.

Special Variable: +xml-namespace-uri+ ¶

Package: flexml.
Source: flexml.lisp.

6.2.2 Macros

Macro: aif (test then &optional else) ¶

Package: verrazano.
Source: utility.lisp.

Macro: aprog1 (ret &body body) ¶

Package: verrazano.
Source: utility.lisp.

Macro: awhen (test &body body) ¶

Package: verrazano.
Source: utility.lisp.

Macro: do-arguments-of-function ((variable function-node &key skip-ellipsis) &body body) ¶

Package: verrazano.
Source: utility.lisp.

Macro: do-fields-of-composite-type ((variable node) &body body) ¶

Package: verrazano.
Source: utility.lisp.

Macro: if-bind (var test &body then/else) ¶

Package: verrazano.
Source: utility.lisp.

Macro: prog1-bind (var ret &body body) ¶

Package: verrazano.
Source: utility.lisp.

Macro: when-bind (var test &body body) ¶

Package: verrazano.
Source: utility.lisp.

6.2.3 Ordinary functions

Function: %map-gccxml-nodes/breadth-first (nodes function) ¶

Package: verrazano.
Source: parser.lisp.

Function: %map-gccxml-nodes/depth-first (nodes function) ¶

Package: verrazano.
Source: parser.lisp.

Function: %standard-name-transformer (input) ¶

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: anonymous? (node) ¶

Package: verrazano.
Source: analyses.lisp.

Function: bits-to-bytes (number) ¶

Package: verrazano.
Source: utility.lisp.

Function: c-literal-to-lisp-literal (str) ¶

Package: verrazano.
Source: parser.lisp.

Function: enqueue-for-export (name) ¶

Package: verrazano.
Source: cffi.lisp.

Function: ensure-gccxml-is-installed () ¶

Package: verrazano.
Source: driver.lisp.

Function: execute-shell-command (command-string &key output error-handler) ¶

Package: verrazano.
Source: utility.lisp.

Function: find-lisp-package-for-xml-namespace (namespace-uri) ¶

Package: flexml.
Source: flexml.lisp.

Function: find-slot (class slot-name &optional errorp) ¶

Package: flexml.
Source: flexml.lisp.

Function: generate-unique-name (&optional base) ¶

Package: verrazano.
Source: utility.lisp.

Function: make-gccxml-parser () ¶

Package: verrazano.
Source: parser.lisp.

Function: map-gccxml-nodes (function) ¶

Package: verrazano.
Source: parser.lisp.

Function: map-gccxml-nodes/breadth-first (function) ¶

Package: verrazano.
Source: parser.lisp.

Function: map-gccxml-nodes/depth-first (function) ¶

Package: verrazano.
Source: parser.lisp.

Function: missing-cross-reference (node slot id) ¶

Package: flexml.
Source: flexml.lisp.

Function: parse-gccxml-output (gccxml-file &optional macros-file) ¶

Package: verrazano.
Source: parser.lisp.

Function: parse-macro-definitions (macros-file) ¶

Package: verrazano.
Source: parser.lisp.

Function: remove-internal-suffix (name) ¶

Package: verrazano.
Source: writers.lisp.

Function: run-gccxml (c-file xml-file &optional macro-file) ¶

Package: verrazano.
Source: driver.lisp.

Function: standard-export-filter (name) ¶

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: standard-name-filter (name) ¶

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: starts-with-dash-p (name) ¶

Package: verrazano.
Source: filters-and-transformers.lisp.

Function: symbolify (name) ¶

Package: verrazano.
Source: writers.lisp.

Function: system-relative-pathname (system path) ¶

Return a pathname relative to the given asdf system.

Package: verrazano.
Source: utility.lisp.

Function: temporary-filename-for (file-name) ¶

Package: verrazano.
Source: backend.lisp.

Function: the-void-type? (node) ¶

Package: verrazano.
Source: analyses.lisp.

Function: transform-name (name kind) ¶

Package: verrazano.
Source: backend.lisp.

Function: unquote-string (str) ¶

Package: verrazano.
Source: utility.lisp.

Function: warn-and-write-as-comment (message &rest args) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-cffi-function (backend node) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-composite-cffi-type (backend node type) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-composite-cffi-type-field (field) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-form (form) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-formatted-text (format &rest args) ¶

Package: verrazano.
Source: writers.lisp.

Function: write-keyword (keyword) ¶

Package: verrazano.
Source: writers.lisp.

6.2.4 Generic functions

Generic Reader: already-processed-of (object) ¶

Package

Methods

Reader Method: already-processed-of ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: already-processed.

Generic Writer: (setf already-processed-of) (object) ¶

Package

Methods

Writer Method: (setf already-processed-of) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: already-processed.

Generic Reader: const-char-pointer-is-string? (object) ¶

Package

Methods

Reader Method: const-char-pointer-is-string? ((cffi-backend cffi-backend)) ¶

automatically generated reader method

Source: cffi.lisp.
Target Slot: const-char-pointer-is-string.

Generic Writer: (setf const-char-pointer-is-string?) (object) ¶

Package

Methods

Writer Method: (setf const-char-pointer-is-string?) ((cffi-backend cffi-backend)) ¶

automatically generated writer method

Source: cffi.lisp.
Target Slot: const-char-pointer-is-string.

Generic Reader: cross-referencing-slots-of (object) ¶

Package

Methods

Reader Method: cross-referencing-slots-of ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: cross-referencing-slots.

Generic Writer: (setf cross-referencing-slots-of) (object) ¶

Package

Methods

Writer Method: (setf cross-referencing-slots-of) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: cross-referencing-slots.

Generic Reader: currently-being-processed-of (object) ¶

Package

Methods

Reader Method: currently-being-processed-of ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: currently-being-processed.

Generic Writer: (setf currently-being-processed-of) (object) ¶

Package

Methods

Writer Method: (setf currently-being-processed-of) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: currently-being-processed.

Generic Reader: default-package-of (object) ¶

Package

Methods

Reader Method: default-package-of ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: default-package.

Generic Writer: (setf default-package-of) (object) ¶

Package

Methods

Writer Method: (setf default-package-of) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: default-package.

Generic Reader: definitions-to-output-of (object) ¶

Package

Methods

Reader Method: definitions-to-output-of ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: definitions-to-output.

Generic Writer: (setf definitions-to-output-of) (object) ¶

Package

Methods

Writer Method: (setf definitions-to-output-of) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: definitions-to-output.

Generic Reader: element-stack-of (object) ¶

Package

Methods

Reader Method: element-stack-of ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: element-stack.

Generic Writer: (setf element-stack-of) (object) ¶

Package

Methods

Writer Method: (setf element-stack-of) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: element-stack.

Generic Reader: export-filter-of (object) ¶

Generic Writer: (setf export-filter-of) (object) ¶

Package

Methods

Reader Method: export-filter-of ((simple-backend simple-backend)) ¶

Writer Method: (setf export-filter-of) ((simple-backend simple-backend)) ¶

This predicate can filter out symbols from the export list.

Source: backend.lisp.
Target Slot: export-filter.

Generic Reader: exported-symbols-of (object) ¶

Package

Methods

Reader Method: exported-symbols-of ((cffi-backend cffi-backend)) ¶

automatically generated reader method

Source: cffi.lisp.
Target Slot: exported-symbols.

Generic Writer: (setf exported-symbols-of) (object) ¶

Package

Methods

Writer Method: (setf exported-symbols-of) ((cffi-backend cffi-backend)) ¶

automatically generated writer method

Source: cffi.lisp.
Target Slot: exported-symbols.

Generic Reader: filter-definitions-from-indirect-files-p (object) ¶

Package

Methods

Reader Method: filter-definitions-from-indirect-files-p ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: filter-definitions-from-indirect-files.

Generic Writer: (setf filter-definitions-from-indirect-files-p) (object) ¶

Package

Methods

Writer Method: (setf filter-definitions-from-indirect-files-p) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: filter-definitions-from-indirect-files.

Generic Function: find-node-by-name (name type parser &key otherwise) ¶

Package

Source

Methods

Method: find-node-by-name ((name string) (type symbol) (parser gccxml-parser) &key otherwise) ¶

Generic Function: function-name-of (node) ¶

Package

Source

writers.lisp.

Methods

Method: function-name-of ((node function)) ¶

Method: function-name-of ((node operatormethod)) ¶

Method: function-name-of ((node operatorfunction)) ¶

Method: function-name-of ((node constructor)) ¶

Generic Reader: gccxml-flags-of (object) ¶

Package

Methods

Reader Method: gccxml-flags-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: gccxml-flags.

Generic Writer: (setf gccxml-flags-of) (object) ¶

Package

Methods

Writer Method: (setf gccxml-flags-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: gccxml-flags.

Generic Reader: gccxml-node-types-to-output-of (object) ¶

Generic Writer: (setf gccxml-node-types-to-output-of) (object) ¶

Package

Methods

Reader Method: gccxml-node-types-to-output-of ((simple-backend simple-backend)) ¶

Writer Method: (setf gccxml-node-types-to-output-of) ((simple-backend simple-backend)) ¶

List of gccxml node types that are to be considered for output

Source: backend.lisp.
Target Slot: gccxml-node-types-to-output.

Generic Reader: gccxml-path-of (object) ¶

Package

Methods

Reader Method: gccxml-path-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: gccxml-path.

Generic Writer: (setf gccxml-path-of) (object) ¶

Package

Methods

Writer Method: (setf gccxml-path-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: gccxml-path.

Generic Reader: id->file-node-of (object) ¶

Package

Methods

Reader Method: id->file-node-of ((gccxml-parser gccxml-parser)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: id->file-node.

Generic Writer: (setf id->file-node-of) (object) ¶

Package

Methods

Writer Method: (setf id->file-node-of) ((gccxml-parser gccxml-parser)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: id->file-node.

Generic Reader: id->node-of (object) ¶

Package

Methods

Reader Method: id->node-of ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: id->node.

Generic Writer: (setf id->node-of) (object) ¶

Package

Methods

Writer Method: (setf id->node-of) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: id->node.

Generic Reader: id-of (object) ¶

Package

Methods

Reader Method: id-of ((flexml-node flexml-node)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: id.

Generic Writer: (setf id-of) (object) ¶

Package

Methods

Writer Method: (setf id-of) ((flexml-node flexml-node)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: id.

Generic Reader: include-default-values-p (object) ¶

Package

Methods

Reader Method: include-default-values-p ((flexml-builder flexml-builder)) ¶

automatically generated reader method

Source: flexml.lisp.
Target Slot: include-default-values.

Generic Writer: (setf include-default-values-p) (object) ¶

Package

Methods

Writer Method: (setf include-default-values-p) ((flexml-builder flexml-builder)) ¶

automatically generated writer method

Source: flexml.lisp.
Target Slot: include-default-values.

Generic Reader: input-files-of (object) ¶

Package

Methods

Reader Method: input-files-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: input-files.

Reader Method: input-files-of ((gccxml-parser gccxml-parser)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: input-files.

Generic Writer: (setf input-files-of) (object) ¶

Package

Methods

Writer Method: (setf input-files-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: input-files.

Writer Method: (setf input-files-of) ((gccxml-parser gccxml-parser)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: input-files.

Generic Reader: macro-name->macro-node-of (object) ¶

Package

Methods

Reader Method: macro-name->macro-node-of ((gccxml-parser gccxml-parser)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: macro-name->macro-node.

Generic Writer: (setf macro-name->macro-node-of) (object) ¶

Package

Methods

Writer Method: (setf macro-name->macro-node-of) ((gccxml-parser gccxml-parser)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: macro-name->macro-node.

Generic Function: make-backend (backend-specification &key &allow-other-keys) ¶

Package

Source

api.lisp.

Methods

Method: make-backend ((backend-specification (eql :cffi)) &rest initargs) ¶

Source: cffi.lisp.

Method: make-backend ((backend-specification list) &rest args) ¶

Generic Reader: name-filter-of (object) ¶

Generic Writer: (setf name-filter-of) (object) ¶

Package

Methods

Reader Method: name-filter-of ((simple-backend simple-backend)) ¶

Writer Method: (setf name-filter-of) ((simple-backend simple-backend)) ¶

This predicate can filter out definitions from the output based on their name.

Source: backend.lisp.
Target Slot: name-filter.

Generic Reader: name-transformer-of (object) ¶

Package

Methods

Reader Method: name-transformer-of ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: name-transformer.

Generic Writer: (setf name-transformer-of) (object) ¶

Package

Methods

Writer Method: (setf name-transformer-of) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: name-transformer.

Generic Reader: node-filter-of (object) ¶

Generic Writer: (setf node-filter-of) (object) ¶

Package

Methods

Reader Method: node-filter-of ((simple-backend simple-backend)) ¶

Writer Method: (setf node-filter-of) ((simple-backend simple-backend)) ¶

This predicate can filter out gccxml nodes.

Source: backend.lisp.
Target Slot: node-filter.

Generic Reader: output-filename-of (object) ¶

Package

Methods

Reader Method: output-filename-of ((cffi-backend cffi-backend)) ¶

automatically generated reader method

Source: cffi.lisp.
Target Slot: output-filename.

Generic Writer: (setf output-filename-of) (object) ¶

Package

Methods

Writer Method: (setf output-filename-of) ((cffi-backend cffi-backend)) ¶

automatically generated writer method

Source: cffi.lisp.
Target Slot: output-filename.

Generic Reader: package-name-of (object) ¶

Package

Methods

Reader Method: package-name-of ((cffi-backend cffi-backend)) ¶

automatically generated reader method

Source: cffi.lisp.
Target Slot: package-name.

Generic Writer: (setf package-name-of) (object) ¶

Package

Methods

Writer Method: (setf package-name-of) ((cffi-backend cffi-backend)) ¶

automatically generated writer method

Source: cffi.lisp.
Target Slot: package-name.

Generic Reader: package-nicknames-of (object) ¶

Package

Methods

Reader Method: package-nicknames-of ((cffi-backend cffi-backend)) ¶

automatically generated reader method

Source: cffi.lisp.
Target Slot: package-nicknames.

Generic Writer: (setf package-nicknames-of) (object) ¶

Package

Methods

Writer Method: (setf package-nicknames-of) ((cffi-backend cffi-backend)) ¶

automatically generated writer method

Source: cffi.lisp.
Target Slot: package-nicknames.

Generic Function: process-gccxml-node (backend node) ¶

This is the toplevel protocol method called on the root gccxml node which by default calls it on all its subnodes.

Package

Source

api.lisp.

Methods

Method: process-gccxml-node ((backend cffi-backend) (node node-with-type)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node variable)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node function)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node constructor)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node enumeration)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node typedef)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node macro)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node union)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node class)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend cffi-backend) (node struct)) ¶

Source: writers.lisp.

Method: process-gccxml-node :around ((backend cffi-backend) (node gcc_xml)) ¶

Source: writers.lisp.

Method: process-gccxml-node :around ((backend simple-backend) (node node-with-name)) ¶

Source: writers.lisp.

Method: process-gccxml-node ((backend simple-backend) (node gcc_xml)) ¶

Source: backend.lisp.

Method: process-gccxml-node :around ((backend simple-backend) node) ¶

Source: backend.lisp.

Method: process-gccxml-node (backend node) ¶

Source: backend.lisp.

Generic Function: root-namespace-of (parser) ¶

Package

Source

Methods

Method: root-namespace-of ((parser gccxml-parser)) ¶

Generic Reader: standard-name-transformer-replacements-of (object) ¶

Package

Methods

Reader Method: standard-name-transformer-replacements-of ((simple-backend simple-backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: standard-name-transformer-replacements.

Generic Writer: (setf standard-name-transformer-replacements-of) (object) ¶

Package

Methods

Writer Method: (setf standard-name-transformer-replacements-of) ((simple-backend simple-backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: standard-name-transformer-replacements.

Generic Reader: temporary-directory-of (object) ¶

Package

Methods

Reader Method: temporary-directory-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: temporary-directory.

Generic Writer: (setf temporary-directory-of) (object) ¶

Package

Methods

Writer Method: (setf temporary-directory-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: temporary-directory.

Generic Reader: temporary-files-of (object) ¶

Package

Methods

Reader Method: temporary-files-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: temporary-files.

Generic Writer: (setf temporary-files-of) (object) ¶

Package

Methods

Writer Method: (setf temporary-files-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: temporary-files.

Generic Reader: type->name->node-of (object) ¶

Package

Methods

Reader Method: type->name->node-of ((gccxml-parser gccxml-parser)) ¶

automatically generated reader method

Source: parser.lisp.
Target Slot: type->name->node.

Generic Writer: (setf type->name->node-of) (object) ¶

Package

Methods

Writer Method: (setf type->name->node-of) ((gccxml-parser gccxml-parser)) ¶

automatically generated writer method

Source: parser.lisp.
Target Slot: type->name->node.

Generic Reader: working-directory-of (object) ¶

Package

Methods

Reader Method: working-directory-of ((backend backend)) ¶

automatically generated reader method

Source: backend.lisp.
Target Slot: working-directory.

Generic Writer: (setf working-directory-of) (object) ¶

Package

Methods

Writer Method: (setf working-directory-of) ((backend backend)) ¶

automatically generated writer method

Source: backend.lisp.
Target Slot: working-directory.

Generic Function: write-cffi-type (type) ¶

Package

Source

writers.lisp.

Methods

Method: write-cffi-type ((node fundamentaltype)) ¶

Method: write-cffi-type ((node cvqualifiedtype)) ¶

Method: write-cffi-type ((node referencetype)) ¶

Method: write-cffi-type ((node arraytype)) ¶

Method: write-cffi-type ((node functiontype)) ¶

Method: write-cffi-type ((node pointertype)) ¶

Method: write-cffi-type ((node enumeration)) ¶

Method: write-cffi-type ((node typedef)) ¶

Method: write-cffi-type ((node union)) ¶

Method: write-cffi-type ((node class)) ¶

Method: write-cffi-type ((node struct)) ¶

Method: write-cffi-type (node) ¶

6.2.5 Classes

Class: backend ¶

Package

Source

backend.lisp.

Direct subclasses

simple-backend.

Direct methods

(setf gccxml-flags-of).
gccxml-flags-of.
(setf gccxml-path-of).
gccxml-path-of.
(setf input-files-of).
input-files-of.
(setf temporary-directory-of).
temporary-directory-of.
(setf temporary-files-of).
temporary-files-of.
(setf working-directory-of).
working-directory-of.

Direct slots

Slot: gccxml-path ¶

Initform: "gccxml"
Initargs: :gccxml-path
Readers: gccxml-path-of.
Writers: (setf gccxml-path-of).

Slot: gccxml-flags ¶

Initform: ""
Initargs: :gccxml-flags
Readers: gccxml-flags-of.
Writers: (setf gccxml-flags-of).

Slot: input-files ¶

Initform: (quote nil)
Initargs: :input-files
Readers: input-files-of.
Writers: (setf input-files-of).

Slot: temporary-directory ¶

Initform: (make-pathname :directory "/tmp")
Initargs: :temporary-directory
Readers: temporary-directory-of.
Writers: (setf temporary-directory-of).

Slot: working-directory ¶

Initform: *default-pathname-defaults*
Initargs: :working-directory
Readers: working-directory-of.
Writers: (setf working-directory-of).

Slot: temporary-files ¶

Initform: (list)
Readers: temporary-files-of.
Writers: (setf temporary-files-of).

Class: cffi-backend ¶

Package

Source

cffi.lisp.

Direct superclasses

simple-backend.

Direct methods

(setf const-char-pointer-is-string?).
const-char-pointer-is-string?.
(setf exported-symbols-of).
exported-symbols-of.
initialize-instance.
(setf output-filename-of).
output-filename-of.
(setf package-name-of).
package-name-of.
(setf package-nicknames-of).
package-nicknames-of.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.
process-gccxml-node.

Direct Default Initargs

Initarg	Value
`:gccxml-node-types-to-output`	`(quote (struct class typedef function constructor variable macro))`
`:filter-definitions-from-indirect-files`	`t`

Direct slots

Slot: package-name ¶

Package: common-lisp.
Type: symbol
Initargs: :package-name
Readers: package-name-of.
Writers: (setf package-name-of).

Slot: package-nicknames ¶

Package: common-lisp.
Initargs: :package-nicknames
Readers: package-nicknames-of.
Writers: (setf package-nicknames-of).

Slot: exported-symbols ¶

Initform: (make-hash-table :test (function equal))
Readers: exported-symbols-of.
Writers: (setf exported-symbols-of).

Slot: output-filename ¶

Initargs: :output-filename
Readers: output-filename-of.
Writers: (setf output-filename-of).

Slot: const-char-pointer-is-string ¶

Initform: t
Initargs: :const-char-pointer-is-string
Readers: const-char-pointer-is-string?.
Writers: (setf const-char-pointer-is-string?).

Class: gccxml-parser ¶

Package

Source

Direct superclasses

flexml-builder.

Direct methods

characters.
end-document.
end-element.
find-node-by-name.
(setf id->file-node-of).
id->file-node-of.
(setf input-files-of).
input-files-of.
(setf macro-name->macro-node-of).
macro-name->macro-node-of.
root-namespace-of.
start-element.
(setf type->name->node-of).
type->name->node-of.

Direct slots

Slot: macro-name->macro-node ¶

Initform: (make-hash-table :test (function equal))
Readers: macro-name->macro-node-of.
Writers: (setf macro-name->macro-node-of).

Slot: type->name->node ¶

Initform: (make-hash-table :test (function eq))
Readers: type->name->node-of.
Writers: (setf type->name->node-of).

Slot: id->file-node ¶

Initform: (make-hash-table :test (function equal))
Readers: id->file-node-of.
Writers: (setf id->file-node-of).

Slot: input-files ¶

Initform: (make-hash-table :test (function eq))
Readers: input-files-of.
Writers: (setf input-files-of).

Class: simple-backend ¶

Package