The cffi-object Reference Manual

This is the cffi-object Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:53:04 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cffi-object

A Common Lisp library that enables fast and convenient interoperation with foreign objects.

Maintainer

Bohong Huang <>

Author

Bohong Huang <>

Home Page

https://github.com/bohonghuang/cffi-object

Source Control

(GIT https://github.com/bohonghuang/cffi-object.git)

Bug Tracker

https://github.com/bohonghuang/cffi-object/issues

License

Apache-2.0

Version

1.0.0

Dependencies
  • uiop (system).
  • alexandria (system).
  • cffi (system).
  • trivial-garbage (system).
Source

cffi-object.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 cffi-object/cffi-object.asd

Source

cffi-object.asd.

Parent Component

cffi-object (system).

ASDF Systems

cffi-object.


3.1.2 cffi-object/package.lisp

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Packages

cffi-object.


3.1.3 cffi-object/libc.lisp

Dependency

package.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Internals

3.1.4 cffi-object/type.lisp

Dependency

libc.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Internals

3.1.6 cffi-object/allocator.lisp

Dependency

definition.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface
Internals

3.1.7 cffi-object/object.lisp

Dependency

allocator.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface
Internals

3.1.8 cffi-object/pointer.lisp

Dependency

object.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface
Internals

3.1.9 cffi-object/array.lisp

Dependency

pointer.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface
Internals

3.1.10 cffi-object/macros.lisp

Dependency

array.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface

define-cobject-class (macro).

Internals

3.1.11 cffi-object/defcfun.lisp

Dependency

macros.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface

defcobjfun (macro).

Internals

3.1.12 cffi-object/global.lisp

Dependency

defcfun.lisp (file).

Source

cffi-object.asd.

Parent Component

cffi-object (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cffi-object

Source

package.lisp.

Nickname

cobj

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: *define-global-cobject*
Package

cffi-object.

Source

global.lisp.


5.1.2 Macros

Macro: defcobjfun (name result &rest args)
Package

cffi-object.

Source

defcfun.lisp.

Macro: define-cobject-class (desc &rest options)
Package

cffi-object.

Source

macros.lisp.

Macro: define-global-cobject (name val-form)
Package

cffi-object.

Source

global.lisp.

Macro: with-default-allocator (&body body)
Package

cffi-object.

Source

allocator.lisp.

Macro: with-monotonic-buffer-allocator ((&key buffer size upstream values) &body body)
Package

cffi-object.

Source

allocator.lisp.


5.1.3 Ordinary functions

Function: caref (array &rest subscripts)
Package

cffi-object.

Source

array.lisp.

Function: (setf caref) (array &rest subscripts)
Package

cffi-object.

Source

array.lisp.

Function: carray-array (carray)
Package

cffi-object.

Source

array.lisp.

Reader: carray-dimensions (instance)
Writer: (setf carray-dimensions) (instance)
Package

cffi-object.

Source

array.lisp.

Target Slot

dimensions.

Function: carray-displacement (array)
Package

cffi-object.

Source

array.lisp.

Function: carray-element-type (instance)
Package

cffi-object.

Source

array.lisp.

Function: (setf carray-element-type) (instance)
Package

cffi-object.

Source

array.lisp.

Function: carray-equal (array1 array2)
Package

cffi-object.

Source

array.lisp.

Function: carray-list (array)
Package

cffi-object.

Source

array.lisp.

Function: carray-string (carray)
Package

cffi-object.

Source

array.lisp.

Function: (setf carray-string) (carray)
Package

cffi-object.

Source

array.lisp.

Function: cfill (carray item &key start end)
Package

cffi-object.

Source

array.lisp.

Function: clength (carray)
Package

cffi-object.

Source

array.lisp.

Function: cobject-eq (a b)
Package

cffi-object.

Source

object.lisp.

Reader: cobject-pointer (instance)
Package

cffi-object.

Source

object.lisp.

Target Slot

pointer.

Function: cpointer-carray (cpointer dimensions)
Package

cffi-object.

Source

array.lisp.

Function: cpointer-eq (pointer1 pointer2)
Package

cffi-object.

Source

pointer.lisp.

Function: cpointer-equal (pointer1 pointer2 &optional count)
Package

cffi-object.

Source

pointer.lisp.

Function: cref (cpointer &optional subscript)
Package

cffi-object.

Source

pointer.lisp.

Function: (setf cref) (cpointer &optional subscript)
Package

cffi-object.

Source

pointer.lisp.

Function: creplace (target-carray1 source-carray2 &key start1 end1 start2 end2)
Package

cffi-object.

Source

array.lisp.

Function: make-carray (dimensions &key element-type initial-element initial-contents displaced-to displaced-index-offset)
Package

cffi-object.

Source

array.lisp.

Function: manage-cobject (cobject)
Package

cffi-object.

Source

object.lisp.

Function: pointer-carray (pointer element-type dimensions)
Package

cffi-object.

Source

array.lisp.

Function: pointer-cobject (pointer type)
Package

cffi-object.

Source

object.lisp.

Function: pointer-cpointer (pointer element-type)
Package

cffi-object.

Source

pointer.lisp.

Function: unmanage-cobject (cobject)
Package

cffi-object.

Source

object.lisp.


5.1.4 Standalone methods

Method: print-object ((pointer cpointer) stream)
Source

pointer.lisp.

Method: print-object ((array carray) stream)
Source

array.lisp.


5.1.5 Structures

Structure: carray
Package

cffi-object.

Source

array.lisp.

Direct superclasses

cpointer.

Direct subclasses

displaced-carray.

Direct methods

print-object.

Direct slots
Slot: dimensions
Type

(cons fixnum null)

Initform

(quote (0))

Readers

carray-dimensions.

Writers

(setf carray-dimensions).

Structure: cobject
Package

cffi-object.

Source

object.lisp.

Direct superclasses

structure-object.

Direct subclasses

cpointer.

Direct slots
Slot: pointer
Type

cffi-sys:foreign-pointer

Initform

(cffi-sys:null-pointer)

Readers

cobject-pointer.

Writers

This slot is read-only.

Slot: shared-from
Type

(or cffi-object:cobject null)

Readers

cobject-shared-from.

Writers

This slot is read-only.

Structure: cpointer
Package

cffi-object.

Source

pointer.lisp.

Direct superclasses

cobject.

Direct subclasses

carray.

Direct methods

print-object.

Direct slots
Slot: element-type
Type

(or symbol cons)

Readers

cpointer-element-type.

Writers

(setf cpointer-element-type).


5.2 Internals


5.2.1 Constants

Constant: +defcfun+
Package

cffi-object.

Source

defcfun.lisp.


5.2.2 Special variables

Special Variable: *cobject-allocator*
Package

cffi-object.

Source

allocator.lisp.

Special Variable: *cobject-class-definitions*
Package

cffi-object.

Source

definition.lisp.

Special Variable: *default-cobject-allocator*
Package

cffi-object.

Source

allocator.lisp.

Special Variable: *global-cobject-initializer*
Package

cffi-object.

Source

global.lisp.

Special Variable: *global-cobjects*
Package

cffi-object.

Source

global.lisp.

Special Variable: *optimize-object-allocation-p*
Package

cffi-object.

Source

defcfun.lisp.

Special Variable: *optimize-out-temporary-object-p*
Package

cffi-object.

Source

defcfun.lisp.

Special Variable: *return-argument-names*
Package

cffi-object.

Source

defcfun.lisp.

Special Variable: *return-pointer-as-object-p*
Package

cffi-object.

Source

defcfun.lisp.


5.2.3 Macros

Macro: defcfun (name-and-options return-type &body args)

Defines a Lisp function that calls a foreign function.

Package

cffi-object.

Alias for

defcfun.

Macro: define-package-cobject-classes (desc)
Package

cffi-object.

Source

macros.lisp.

Macro: define-prototype-cobject-class (desc)
Package

cffi-object.

Source

macros.lisp.

Macro: define-struct-cobject-class (desc &rest options)
Package

cffi-object.

Source

macros.lisp.

Macro: define-type-cobject-class (desc)
Package

cffi-object.

Source

macros.lisp.

Macro: with-new-cobject-class-definition ((name-form type-form) &body body)
Package

cffi-object.

Source

macros.lisp.

Macro: with-parsed-desc ((name type) desc-form &body body)
Package

cffi-object.

Source

macros.lisp.


5.2.4 Ordinary functions

Function: %make-carray (&key pointer shared-from element-type dimensions)
Package

cffi-object.

Source

array.lisp.

Function: %make-cpointer (&key pointer shared-from element-type)
Package

cffi-object.

Source

pointer.lisp.

Function: %make-displaced-carray (&key pointer shared-from element-type dimensions displaced-index-offset)
Package

cffi-object.

Source

array.lisp.

Function: %make-sized-monotonic-buffer-allocator (&key allocator deallocator pointer size offset)
Package

cffi-object.

Source

allocator.lisp.

Function: carray-p (object)
Package

cffi-object.

Source

array.lisp.

Function: carray-pointer (instance)
Package

cffi-object.

Source

array.lisp.

Function: carray-shared-from (instance)
Package

cffi-object.

Source

array.lisp.

Function: cffi-object-type-p (type)
Package

cffi-object.

Source

defcfun.lisp.

Function: cffi-pointer-type-p (type)
Package

cffi-object.

Source

defcfun.lisp.

Reader: cobject-allocator-allocator (instance)
Writer: (setf cobject-allocator-allocator) (instance)
Package

cffi-object.

Source

allocator.lisp.

Target Slot

allocator.

Reader: cobject-allocator-deallocator (instance)
Writer: (setf cobject-allocator-deallocator) (instance)
Package

cffi-object.

Source

allocator.lisp.

Target Slot

deallocator.

Function: cobject-allocator-p (object)
Package

cffi-object.

Source

allocator.lisp.

Function: cobject-class-definition (type)

Get the class definition of a cobject at runtime.

Package

cffi-object.

Source

definition.lisp.

Reader: cobject-class-definition-class (instance)
Writer: (setf cobject-class-definition-class) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

class.

Reader: cobject-class-definition-constructor (instance)
Writer: (setf cobject-class-definition-constructor) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

constructor.

Reader: cobject-class-definition-copier (instance)
Writer: (setf cobject-class-definition-copier) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

copier.

Reader: cobject-class-definition-equality-comparator (instance)
Writer: (setf cobject-class-definition-equality-comparator) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

equality-comparator.

Reader: cobject-class-definition-in-place-constructor (instance)
Writer: (setf cobject-class-definition-in-place-constructor) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

in-place-constructor.

Reader: cobject-class-definition-internal-constructor (instance)
Writer: (setf cobject-class-definition-internal-constructor) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

internal-constructor.

Function: cobject-class-definition-p (object)
Package

cffi-object.

Source

definition.lisp.

Reader: cobject-class-definition-predicate (instance)
Writer: (setf cobject-class-definition-predicate) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

predicate.

Reader: cobject-class-definition-slot-accessors (instance)
Writer: (setf cobject-class-definition-slot-accessors) (instance)
Package

cffi-object.

Source

definition.lisp.

Target Slot

slot-accessors.

Function: cobject-class-definition-symbols (definition &optional internalp)
Package

cffi-object.

Source

definition.lisp.

Function: cobject-class-object-size (type)
Package

cffi-object.

Source

object.lisp.

Function: cobject-p (object)
Package

cffi-object.

Source

object.lisp.

Reader: cobject-shared-from (instance)
Package

cffi-object.

Source

object.lisp.

Target Slot

shared-from.

Function: cobject-type-constructor (object-type)
Package

cffi-object.

Source

defcfun.lisp.

Function: cobject-type= (type1 type2)
Package

cffi-object.

Source

type.lisp.

Function: copy-carray (instance)
Package

cffi-object.

Source

array.lisp.

Function: copy-cobject (instance)
Package

cffi-object.

Source

object.lisp.

Function: copy-cobject-allocator (instance)
Package

cffi-object.

Source

allocator.lisp.

Function: copy-cobject-class-definition (instance)
Package

cffi-object.

Source

definition.lisp.

Function: copy-cpointer (instance)
Package

cffi-object.

Source

pointer.lisp.

Function: copy-displaced-carray (instance)
Package

cffi-object.

Source

array.lisp.

Function: copy-sized-monotonic-buffer-allocator (instance)
Package

cffi-object.

Source

allocator.lisp.

Reader: cpointer-element-type (instance)
Writer: (setf cpointer-element-type) (instance)
Package

cffi-object.

Source

pointer.lisp.

Target Slot

element-type.

Function: cpointer-p (object)
Package

cffi-object.

Source

pointer.lisp.

Function: cpointer-pointer (instance)
Package

cffi-object.

Source

pointer.lisp.

Function: cpointer-shared-from (instance)
Package

cffi-object.

Source

pointer.lisp.

Function: displaced-carray-dimensions (instance)
Package

cffi-object.

Source

array.lisp.

Function: (setf displaced-carray-dimensions) (instance)
Package

cffi-object.

Source

array.lisp.

Reader: displaced-carray-displaced-index-offset (instance)
Writer: (setf displaced-carray-displaced-index-offset) (instance)
Package

cffi-object.

Source

array.lisp.

Target Slot

displaced-index-offset.

Function: displaced-carray-displaced-to (instance)
Package

cffi-object.

Source

array.lisp.

Function: displaced-carray-element-type (instance)
Package

cffi-object.

Source

array.lisp.

Function: (setf displaced-carray-element-type) (instance)
Package

cffi-object.

Source

array.lisp.

Function: displaced-carray-p (object)
Package

cffi-object.

Source

array.lisp.

Function: displaced-carray-pointer (instance)
Package

cffi-object.

Source

array.lisp.

Function: displaced-carray-shared-from (instance)
Package

cffi-object.

Source

array.lisp.

Function: find-cobject-class-definition (type)

Get the class definition of a cobject at compile-time.

Package

cffi-object.

Source

definition.lisp.

Function: global-cobjects-bytes ()
Package

cffi-object.

Source

global.lisp.

Function: load-global-cobjects ()
Package

cffi-object.

Source

global.lisp.

Function: make-cobject (&key pointer shared-from)
Package

cffi-object.

Source

object.lisp.

Function: make-cobject-allocator (&key allocator deallocator)
Package

cffi-object.

Source

allocator.lisp.

Function: make-cobject-class-definition (&key class internal-constructor constructor in-place-constructor slot-accessors copier predicate equality-comparator)
Package

cffi-object.

Source

definition.lisp.

Function: make-sized-monotonic-buffer-allocator (&key pointer size upstream)
Package

cffi-object.

Source

allocator.lisp.

Function: memcmp (s1 s2 n)
Package

cffi-object.

Source

libc.lisp.

Function: memcpy (dest src n)
Package

cffi-object.

Source

libc.lisp.

Function: memset (s c n)
Package

cffi-object.

Source

libc.lisp.

Function: primitive-type-p (type)
Package

cffi-object.

Source

type.lisp.

Function: save-global-cobjects ()
Package

cffi-object.

Source

global.lisp.

Function: sized-monotonic-buffer-allocator-allocator (instance)
Package

cffi-object.

Source

allocator.lisp.

Function: (setf sized-monotonic-buffer-allocator-allocator) (instance)
Package

cffi-object.

Source

allocator.lisp.

Function: sized-monotonic-buffer-allocator-deallocator (instance)
Package

cffi-object.

Source

allocator.lisp.

Function: (setf sized-monotonic-buffer-allocator-deallocator) (instance)
Package

cffi-object.

Source

allocator.lisp.

Reader: sized-monotonic-buffer-allocator-offset (instance)
Writer: (setf sized-monotonic-buffer-allocator-offset) (instance)
Package

cffi-object.

Source

allocator.lisp.

Target Slot

offset.

Function: sized-monotonic-buffer-allocator-p (object)
Package

cffi-object.

Source

allocator.lisp.

Reader: sized-monotonic-buffer-allocator-pointer (instance)
Writer: (setf sized-monotonic-buffer-allocator-pointer) (instance)
Package

cffi-object.

Source

allocator.lisp.

Target Slot

pointer.

Reader: sized-monotonic-buffer-allocator-size (instance)
Writer: (setf sized-monotonic-buffer-allocator-size) (instance)
Package

cffi-object.

Source

allocator.lisp.

Target Slot

size.

Function: symbol-name= (sym1 sym2)
Package

cffi-object.

Source

defcfun.lisp.


5.2.5 Generic functions

Generic Function: funcall-dynamic-extent-form (function args)
Package

cffi-object.

Source

defcfun.lisp.

Generic Function: funcall-form-type (function args)
Package

cffi-object.

Source

defcfun.lisp.


5.2.6 Conditions

Condition: cobject-class-definition-not-found-error
Package

cffi-object.

Source

definition.lisp.

Direct superclasses

error.

Direct slots
Slot: type
Package

common-lisp.

Initform

(quote nil)

Initargs

:type


5.2.7 Structures

Structure: cobject-allocator
Package

cffi-object.

Source

allocator.lisp.

Direct superclasses

structure-object.

Direct subclasses

sized-monotonic-buffer-allocator.

Direct slots
Slot: allocator
Type

(function (alexandria:non-negative-fixnum) (values cffi-sys:foreign-pointer))

Initform

(constantly (cffi-sys:null-pointer))

Readers

cobject-allocator-allocator.

Writers

(setf cobject-allocator-allocator).

Slot: deallocator
Type

(function (cffi-sys:foreign-pointer))

Initform

(function values)

Readers

cobject-allocator-deallocator.

Writers

(setf cobject-allocator-deallocator).

Structure: cobject-class-definition
Package

cffi-object.

Source

definition.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: class
Package

common-lisp.

Type

(or symbol list)

Readers

cobject-class-definition-class.

Writers

(setf cobject-class-definition-class).

Slot: internal-constructor
Type

(or symbol function)

Readers

cobject-class-definition-internal-constructor.

Writers

(setf cobject-class-definition-internal-constructor).

Slot: constructor
Type

(or symbol function)

Readers

cobject-class-definition-constructor.

Writers

(setf cobject-class-definition-constructor).

Slot: in-place-constructor
Type

(or symbol function)

Readers

cobject-class-definition-in-place-constructor.

Writers

(setf cobject-class-definition-in-place-constructor).

Slot: slot-accessors
Type

list

Readers

cobject-class-definition-slot-accessors.

Writers

(setf cobject-class-definition-slot-accessors).

Slot: copier
Type

(or symbol function)

Readers

cobject-class-definition-copier.

Writers

(setf cobject-class-definition-copier).

Slot: predicate
Type

(or symbol function)

Readers

cobject-class-definition-predicate.

Writers

(setf cobject-class-definition-predicate).

Slot: equality-comparator
Type

(or symbol function)

Readers

cobject-class-definition-equality-comparator.

Writers

(setf cobject-class-definition-equality-comparator).

Structure: displaced-carray
Package

cffi-object.

Source

array.lisp.

Direct superclasses

carray.

Direct slots
Slot: displaced-index-offset
Type

fixnum

Initform

0

Readers

displaced-carray-displaced-index-offset.

Writers

(setf displaced-carray-displaced-index-offset).

Structure: sized-monotonic-buffer-allocator
Package

cffi-object.

Source

allocator.lisp.

Direct superclasses

cobject-allocator.

Direct slots
Slot: pointer
Type

cffi-sys:foreign-pointer

Initform

(cffi-sys:null-pointer)

Readers

sized-monotonic-buffer-allocator-pointer.

Writers

(setf sized-monotonic-buffer-allocator-pointer).

Slot: size
Type

alexandria:non-negative-fixnum

Initform

0

Readers

sized-monotonic-buffer-allocator-size.

Writers

(setf sized-monotonic-buffer-allocator-size).

Slot: offset
Type

alexandria:non-negative-fixnum

Initform

0

Readers

sized-monotonic-buffer-allocator-offset.

Writers

(setf sized-monotonic-buffer-allocator-offset).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
C   D   F   G   L   M   P   S   U   W  
Index Entry  Section

%
%make-carray: Private ordinary functions
%make-cpointer: Private ordinary functions
%make-displaced-carray: Private ordinary functions
%make-sized-monotonic-buffer-allocator: Private ordinary functions

(
(setf caref): Public ordinary functions
(setf carray-dimensions): Public ordinary functions
(setf carray-element-type): Public ordinary functions
(setf carray-string): Public ordinary functions
(setf cobject-allocator-allocator): Private ordinary functions
(setf cobject-allocator-deallocator): Private ordinary functions
(setf cobject-class-definition-class): Private ordinary functions
(setf cobject-class-definition-constructor): Private ordinary functions
(setf cobject-class-definition-copier): Private ordinary functions
(setf cobject-class-definition-equality-comparator): Private ordinary functions
(setf cobject-class-definition-in-place-constructor): Private ordinary functions
(setf cobject-class-definition-internal-constructor): Private ordinary functions
(setf cobject-class-definition-predicate): Private ordinary functions
(setf cobject-class-definition-slot-accessors): Private ordinary functions
(setf cpointer-element-type): Private ordinary functions
(setf cref): Public ordinary functions
(setf displaced-carray-dimensions): Private ordinary functions
(setf displaced-carray-displaced-index-offset): Private ordinary functions
(setf displaced-carray-element-type): Private ordinary functions
(setf sized-monotonic-buffer-allocator-allocator): Private ordinary functions
(setf sized-monotonic-buffer-allocator-deallocator): Private ordinary functions
(setf sized-monotonic-buffer-allocator-offset): Private ordinary functions
(setf sized-monotonic-buffer-allocator-pointer): Private ordinary functions
(setf sized-monotonic-buffer-allocator-size): Private ordinary functions

C
caref: Public ordinary functions
carray-array: Public ordinary functions
carray-dimensions: Public ordinary functions
carray-displacement: Public ordinary functions
carray-element-type: Public ordinary functions
carray-equal: Public ordinary functions
carray-list: Public ordinary functions
carray-p: Private ordinary functions
carray-pointer: Private ordinary functions
carray-shared-from: Private ordinary functions
carray-string: Public ordinary functions
cffi-object-type-p: Private ordinary functions
cffi-pointer-type-p: Private ordinary functions
cfill: Public ordinary functions
clength: Public ordinary functions
cobject-allocator-allocator: Private ordinary functions
cobject-allocator-deallocator: Private ordinary functions
cobject-allocator-p: Private ordinary functions
cobject-class-definition: Private ordinary functions
cobject-class-definition-class: Private ordinary functions
cobject-class-definition-constructor: Private ordinary functions
cobject-class-definition-copier: Private ordinary functions
cobject-class-definition-equality-comparator: Private ordinary functions
cobject-class-definition-in-place-constructor: Private ordinary functions
cobject-class-definition-internal-constructor: Private ordinary functions
cobject-class-definition-p: Private ordinary functions
cobject-class-definition-predicate: Private ordinary functions
cobject-class-definition-slot-accessors: Private ordinary functions
cobject-class-definition-symbols: Private ordinary functions
cobject-class-object-size: Private ordinary functions
cobject-eq: Public ordinary functions
cobject-p: Private ordinary functions
cobject-pointer: Public ordinary functions
cobject-shared-from: Private ordinary functions
cobject-type-constructor: Private ordinary functions
cobject-type=: Private ordinary functions
copy-carray: Private ordinary functions
copy-cobject: Private ordinary functions
copy-cobject-allocator: Private ordinary functions
copy-cobject-class-definition: Private ordinary functions
copy-cpointer: Private ordinary functions
copy-displaced-carray: Private ordinary functions
copy-sized-monotonic-buffer-allocator: Private ordinary functions
cpointer-carray: Public ordinary functions
cpointer-element-type: Private ordinary functions
cpointer-eq: Public ordinary functions
cpointer-equal: Public ordinary functions
cpointer-p: Private ordinary functions
cpointer-pointer: Private ordinary functions
cpointer-shared-from: Private ordinary functions
cref: Public ordinary functions
creplace: Public ordinary functions

D
defcfun: Private macros
defcobjfun: Public macros
define-cobject-class: Public macros
define-global-cobject: Public macros
define-package-cobject-classes: Private macros
define-prototype-cobject-class: Private macros
define-struct-cobject-class: Private macros
define-type-cobject-class: Private macros
displaced-carray-dimensions: Private ordinary functions
displaced-carray-displaced-index-offset: Private ordinary functions
displaced-carray-displaced-to: Private ordinary functions
displaced-carray-element-type: Private ordinary functions
displaced-carray-p: Private ordinary functions
displaced-carray-pointer: Private ordinary functions
displaced-carray-shared-from: Private ordinary functions

F
find-cobject-class-definition: Private ordinary functions
funcall-dynamic-extent-form: Private generic functions
funcall-form-type: Private generic functions
Function, %make-carray: Private ordinary functions
Function, %make-cpointer: Private ordinary functions
Function, %make-displaced-carray: Private ordinary functions
Function, %make-sized-monotonic-buffer-allocator: Private ordinary functions
Function, (setf caref): Public ordinary functions
Function, (setf carray-dimensions): Public ordinary functions
Function, (setf carray-element-type): Public ordinary functions
Function, (setf carray-string): Public ordinary functions
Function, (setf cobject-allocator-allocator): Private ordinary functions
Function, (setf cobject-allocator-deallocator): Private ordinary functions
Function, (setf cobject-class-definition-class): Private ordinary functions
Function, (setf cobject-class-definition-constructor): Private ordinary functions
Function, (setf cobject-class-definition-copier): Private ordinary functions
Function, (setf cobject-class-definition-equality-comparator): Private ordinary functions
Function, (setf cobject-class-definition-in-place-constructor): Private ordinary functions
Function, (setf cobject-class-definition-internal-constructor): Private ordinary functions
Function, (setf cobject-class-definition-predicate): Private ordinary functions
Function, (setf cobject-class-definition-slot-accessors): Private ordinary functions
Function, (setf cpointer-element-type): Private ordinary functions
Function, (setf cref): Public ordinary functions
Function, (setf displaced-carray-dimensions): Private ordinary functions
Function, (setf displaced-carray-displaced-index-offset): Private ordinary functions
Function, (setf displaced-carray-element-type): Private ordinary functions
Function, (setf sized-monotonic-buffer-allocator-allocator): Private ordinary functions
Function, (setf sized-monotonic-buffer-allocator-deallocator): Private ordinary functions
Function, (setf sized-monotonic-buffer-allocator-offset): Private ordinary functions
Function, (setf sized-monotonic-buffer-allocator-pointer): Private ordinary functions
Function, (setf sized-monotonic-buffer-allocator-size): Private ordinary functions
Function, caref: Public ordinary functions
Function, carray-array: Public ordinary functions
Function, carray-dimensions: Public ordinary functions
Function, carray-displacement: Public ordinary functions
Function, carray-element-type: Public ordinary functions
Function, carray-equal: Public ordinary functions
Function, carray-list: Public ordinary functions
Function, carray-p: Private ordinary functions
Function, carray-pointer: Private ordinary functions
Function, carray-shared-from: Private ordinary functions
Function, carray-string: Public ordinary functions
Function, cffi-object-type-p: Private ordinary functions
Function, cffi-pointer-type-p: Private ordinary functions
Function, cfill: Public ordinary functions
Function, clength: Public ordinary functions
Function, cobject-allocator-allocator: Private ordinary functions
Function, cobject-allocator-deallocator: Private ordinary functions
Function, cobject-allocator-p: Private ordinary functions
Function, cobject-class-definition: Private ordinary functions
Function, cobject-class-definition-class: Private ordinary functions
Function, cobject-class-definition-constructor: Private ordinary functions
Function, cobject-class-definition-copier: Private ordinary functions
Function, cobject-class-definition-equality-comparator: Private ordinary functions
Function, cobject-class-definition-in-place-constructor: Private ordinary functions
Function, cobject-class-definition-internal-constructor: Private ordinary functions
Function, cobject-class-definition-p: Private ordinary functions
Function, cobject-class-definition-predicate: Private ordinary functions
Function, cobject-class-definition-slot-accessors: Private ordinary functions
Function, cobject-class-definition-symbols: Private ordinary functions
Function, cobject-class-object-size: Private ordinary functions
Function, cobject-eq: Public ordinary functions
Function, cobject-p: Private ordinary functions
Function, cobject-pointer: Public ordinary functions
Function, cobject-shared-from: Private ordinary functions
Function, cobject-type-constructor: Private ordinary functions
Function, cobject-type=: Private ordinary functions
Function, copy-carray: Private ordinary functions
Function, copy-cobject: Private ordinary functions
Function, copy-cobject-allocator: Private ordinary functions
Function, copy-cobject-class-definition: Private ordinary functions
Function, copy-cpointer: Private ordinary functions
Function, copy-displaced-carray: Private ordinary functions
Function, copy-sized-monotonic-buffer-allocator: Private ordinary functions
Function, cpointer-carray: Public ordinary functions
Function, cpointer-element-type: Private ordinary functions
Function, cpointer-eq: Public ordinary functions
Function, cpointer-equal: Public ordinary functions
Function, cpointer-p: Private ordinary functions
Function, cpointer-pointer: Private ordinary functions
Function, cpointer-shared-from: Private ordinary functions
Function, cref: Public ordinary functions
Function, creplace: Public ordinary functions
Function, displaced-carray-dimensions: Private ordinary functions
Function, displaced-carray-displaced-index-offset: Private ordinary functions
Function, displaced-carray-displaced-to: Private ordinary functions
Function, displaced-carray-element-type: Private ordinary functions
Function, displaced-carray-p: Private ordinary functions
Function, displaced-carray-pointer: Private ordinary functions
Function, displaced-carray-shared-from: Private ordinary functions
Function, find-cobject-class-definition: Private ordinary functions
Function, global-cobjects-bytes: Private ordinary functions
Function, load-global-cobjects: Private ordinary functions
Function, make-carray: Public ordinary functions
Function, make-cobject: Private ordinary functions
Function, make-cobject-allocator: Private ordinary functions
Function, make-cobject-class-definition: Private ordinary functions
Function, make-sized-monotonic-buffer-allocator: Private ordinary functions
Function, manage-cobject: Public ordinary functions
Function, memcmp: Private ordinary functions
Function, memcpy: Private ordinary functions
Function, memset: Private ordinary functions
Function, pointer-carray: Public ordinary functions
Function, pointer-cobject: Public ordinary functions
Function, pointer-cpointer: Public ordinary functions
Function, primitive-type-p: Private ordinary functions
Function, save-global-cobjects: Private ordinary functions
Function, sized-monotonic-buffer-allocator-allocator: Private ordinary functions
Function, sized-monotonic-buffer-allocator-deallocator: Private ordinary functions
Function, sized-monotonic-buffer-allocator-offset: Private ordinary functions
Function, sized-monotonic-buffer-allocator-p: Private ordinary functions
Function, sized-monotonic-buffer-allocator-pointer: Private ordinary functions
Function, sized-monotonic-buffer-allocator-size: Private ordinary functions
Function, symbol-name=: Private ordinary functions
Function, unmanage-cobject: Public ordinary functions

G
Generic Function, funcall-dynamic-extent-form: Private generic functions
Generic Function, funcall-form-type: Private generic functions
global-cobjects-bytes: Private ordinary functions

L
load-global-cobjects: Private ordinary functions

M
Macro, defcfun: Private macros
Macro, defcobjfun: Public macros
Macro, define-cobject-class: Public macros
Macro, define-global-cobject: Public macros
Macro, define-package-cobject-classes: Private macros
Macro, define-prototype-cobject-class: Private macros
Macro, define-struct-cobject-class: Private macros
Macro, define-type-cobject-class: Private macros
Macro, with-default-allocator: Public macros
Macro, with-monotonic-buffer-allocator: Public macros
Macro, with-new-cobject-class-definition: Private macros
Macro, with-parsed-desc: Private macros
make-carray: Public ordinary functions
make-cobject: Private ordinary functions
make-cobject-allocator: Private ordinary functions
make-cobject-class-definition: Private ordinary functions
make-sized-monotonic-buffer-allocator: Private ordinary functions
manage-cobject: Public ordinary functions
memcmp: Private ordinary functions
memcpy: Private ordinary functions
memset: Private ordinary functions
Method, print-object: Public standalone methods
Method, print-object: Public standalone methods

P
pointer-carray: Public ordinary functions
pointer-cobject: Public ordinary functions
pointer-cpointer: Public ordinary functions
primitive-type-p: Private ordinary functions
print-object: Public standalone methods
print-object: Public standalone methods

S
save-global-cobjects: Private ordinary functions
sized-monotonic-buffer-allocator-allocator: Private ordinary functions
sized-monotonic-buffer-allocator-deallocator: Private ordinary functions
sized-monotonic-buffer-allocator-offset: Private ordinary functions
sized-monotonic-buffer-allocator-p: Private ordinary functions
sized-monotonic-buffer-allocator-pointer: Private ordinary functions
sized-monotonic-buffer-allocator-size: Private ordinary functions
symbol-name=: Private ordinary functions

U
unmanage-cobject: Public ordinary functions

W
with-default-allocator: Public macros
with-monotonic-buffer-allocator: Public macros
with-new-cobject-class-definition: Private macros
with-parsed-desc: Private macros


A.3 Variables

Jump to:   *   +  
A   C   D   E   I   O   P   S   T  
Index Entry  Section

*
*cobject-allocator*: Private special variables
*cobject-class-definitions*: Private special variables
*default-cobject-allocator*: Private special variables
*define-global-cobject*: Public special variables
*global-cobject-initializer*: Private special variables
*global-cobjects*: Private special variables
*optimize-object-allocation-p*: Private special variables
*optimize-out-temporary-object-p*: Private special variables
*return-argument-names*: Private special variables
*return-pointer-as-object-p*: Private special variables

+
+defcfun+: Private constants

A
allocator: Private structures

C
class: Private structures
Constant, +defcfun+: Private constants
constructor: Private structures
copier: Private structures

D
deallocator: Private structures
dimensions: Public structures
displaced-index-offset: Private structures

E
element-type: Public structures
equality-comparator: Private structures

I
in-place-constructor: Private structures
internal-constructor: Private structures

O
offset: Private structures

P
pointer: Public structures
pointer: Private structures
predicate: Private structures

S
shared-from: Public structures
size: Private structures
Slot, allocator: Private structures
Slot, class: Private structures
Slot, constructor: Private structures
Slot, copier: Private structures
Slot, deallocator: Private structures
Slot, dimensions: Public structures
Slot, displaced-index-offset: Private structures
Slot, element-type: Public structures
Slot, equality-comparator: Private structures
Slot, in-place-constructor: Private structures
Slot, internal-constructor: Private structures
Slot, offset: Private structures
Slot, pointer: Public structures
Slot, pointer: Private structures
Slot, predicate: Private structures
Slot, shared-from: Public structures
Slot, size: Private structures
Slot, slot-accessors: Private structures
Slot, type: Private conditions
slot-accessors: Private structures
Special Variable, *cobject-allocator*: Private special variables
Special Variable, *cobject-class-definitions*: Private special variables
Special Variable, *default-cobject-allocator*: Private special variables
Special Variable, *define-global-cobject*: Public special variables
Special Variable, *global-cobject-initializer*: Private special variables
Special Variable, *global-cobjects*: Private special variables
Special Variable, *optimize-object-allocation-p*: Private special variables
Special Variable, *optimize-out-temporary-object-p*: Private special variables
Special Variable, *return-argument-names*: Private special variables
Special Variable, *return-pointer-as-object-p*: Private special variables

T
type: Private conditions


A.4 Data types

Jump to:   A   C   D   F   G   L   M   O   P   S   T  
Index Entry  Section

A
allocator.lisp: The cffi-object/allocator․lisp file
array.lisp: The cffi-object/array․lisp file

C
carray: Public structures
cffi-object: The cffi-object system
cffi-object: The cffi-object package
cffi-object.asd: The cffi-object/cffi-object․asd file
cobject: Public structures
cobject-allocator: Private structures
cobject-class-definition: Private structures
cobject-class-definition-not-found-error: Private conditions
Condition, cobject-class-definition-not-found-error: Private conditions
cpointer: Public structures

D
defcfun.lisp: The cffi-object/defcfun․lisp file
definition.lisp: The cffi-object/definition․lisp file
displaced-carray: Private structures

F
File, allocator.lisp: The cffi-object/allocator․lisp file
File, array.lisp: The cffi-object/array․lisp file
File, cffi-object.asd: The cffi-object/cffi-object․asd file
File, defcfun.lisp: The cffi-object/defcfun․lisp file
File, definition.lisp: The cffi-object/definition․lisp file
File, global.lisp: The cffi-object/global․lisp file
File, libc.lisp: The cffi-object/libc․lisp file
File, macros.lisp: The cffi-object/macros․lisp file
File, object.lisp: The cffi-object/object․lisp file
File, package.lisp: The cffi-object/package․lisp file
File, pointer.lisp: The cffi-object/pointer․lisp file
File, type.lisp: The cffi-object/type․lisp file

G
global.lisp: The cffi-object/global․lisp file

L
libc.lisp: The cffi-object/libc․lisp file

M
macros.lisp: The cffi-object/macros․lisp file

O
object.lisp: The cffi-object/object․lisp file

P
Package, cffi-object: The cffi-object package
package.lisp: The cffi-object/package․lisp file
pointer.lisp: The cffi-object/pointer․lisp file

S
sized-monotonic-buffer-allocator: Private structures
Structure, carray: Public structures
Structure, cobject: Public structures
Structure, cobject-allocator: Private structures
Structure, cobject-class-definition: Private structures
Structure, cpointer: Public structures
Structure, displaced-carray: Private structures
Structure, sized-monotonic-buffer-allocator: Private structures
System, cffi-object: The cffi-object system

T
type.lisp: The cffi-object/type․lisp file