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

The cffi-c-ref Reference Manual

This is the cffi-c-ref Reference Manual, version 1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 14:52:59 2024 GMT+0.

1 Introduction
2 Systems
- 2.1 cffi-c-ref
3 Files
- 3.1 Lisp
  - 3.1.1 cffi-c-ref/cffi-c-ref.asd
  - 3.1.2 cffi-c-ref/cffi-c-ref.lisp
4 Packages
- 4.1 cffi-c-ref
5 Definitions
- 5.1 Public Interface
  - 5.1.1 Macros
- 5.2 Internals
  - 5.2.1 Ordinary functions
Appendix A Indexes

Next: Systems, Previous: The cffi-c-ref Reference Manual, Up: The cffi-c-ref Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The cffi-c-ref Reference Manual [Contents][Index]

2 Systems

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

cffi-c-ref

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

2.1 `cffi-c-ref`

Adds streamlined access to foreign memory

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Version

1.0

Dependencies

alexandria (system).
cffi (system).

Source

cffi-c-ref.asd.

Child Component

cffi-c-ref.lisp (file).

Next: Packages, Previous: Systems, Up: The cffi-c-ref Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: cffi-c-ref/cffi-c-ref.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `cffi-c-ref/cffi-c-ref.asd`

Source: cffi-c-ref.asd.
Parent Component: cffi-c-ref (system).
ASDF Systems: cffi-c-ref.

Previous: cffi-c-ref/cffi-c-ref.asd, Up: Lisp [Contents][Index]

3.1.2 `cffi-c-ref/cffi-c-ref.lisp`

Source

cffi-c-ref.asd.

Parent Component

cffi-c-ref (system).

Packages

cffi-c-ref.

Public Interface

c-let (macro).
c-ref (macro).
c-val (macro).
c-with (macro).

Internals

%mem-offset (function).
%memset (function).
canonicalize-foreign-type (function).
extract-slot-names (function).
find-pointer-or-array-actual-type (function).
find-slot-name (function).
find-slot-offset (function).
find-slot-type (function).
symbol-for-anonymous-field-p (function).

Next: Definitions, Previous: Files, Up: The cffi-c-ref Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

cffi-c-ref

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

4.1 `cffi-c-ref`

Source

cffi-c-ref.lisp.

Use List

alexandria.
common-lisp.

Public Interface

c-let (macro).
c-ref (macro).
c-val (macro).
c-with (macro).

Internals

%mem-offset (function).
%memset (function).
canonicalize-foreign-type (function).
extract-slot-names (function).
find-pointer-or-array-actual-type (function).
find-slot-name (function).
find-slot-offset (function).
find-slot-type (function).
symbol-for-anonymous-field-p (function).

Next: Indexes, Previous: Packages, Up: The cffi-c-ref Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Macros

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Macros

Macro: c-let ((&rest bindings) &body body) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Macro: c-ref (ptr type &rest accessors) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Macro: c-val ((&rest bindings) &body body) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Macro: c-with ((&rest bindings) &body body) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

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

5.2 Internals

Ordinary functions

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

5.2.1 Ordinary functions

Function: %mem-offset (ptr type offset dynamic-offset accessors) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: %memset (destination initial-value size) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: canonicalize-foreign-type (type) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: extract-slot-names (type) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: find-pointer-or-array-actual-type (type) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: find-slot-name (type keyword-name) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: find-slot-offset (type name) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: find-slot-type (type name) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Function: symbol-for-anonymous-field-p (slot-name) ¶

Package: cffi-c-ref.
Source: cffi-c-ref.lisp.

Previous: Definitions, Up: The cffi-c-ref Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	% C E F M S

	Index Entry	Section

%
	`%mem-offset`:	Private ordinary functions
	`%memset`:	Private ordinary functions

C
	`c-let`:	Public macros
	`c-ref`:	Public macros
	`c-val`:	Public macros
	`c-with`:	Public macros
	`canonicalize-foreign-type`:	Private ordinary functions

E
	`extract-slot-names`:	Private ordinary functions

F
	`find-pointer-or-array-actual-type`:	Private ordinary functions
	`find-slot-name`:	Private ordinary functions
	`find-slot-offset`:	Private ordinary functions
	`find-slot-type`:	Private ordinary functions
	`Function, %mem-offset`:	Private ordinary functions
	`Function, %memset`:	Private ordinary functions
	`Function, canonicalize-foreign-type`:	Private ordinary functions
	`Function, extract-slot-names`:	Private ordinary functions
	`Function, find-pointer-or-array-actual-type`:	Private ordinary functions
	`Function, find-slot-name`:	Private ordinary functions
	`Function, find-slot-offset`:	Private ordinary functions
	`Function, find-slot-type`:	Private ordinary functions
	`Function, symbol-for-anonymous-field-p`:	Private ordinary functions

M
	`Macro, c-let`:	Public macros
	`Macro, c-ref`:	Public macros
	`Macro, c-val`:	Public macros
	`Macro, c-with`:	Public macros

S
	`symbol-for-anonymous-field-p`:	Private ordinary functions

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

A.4 Data types

Jump to:	C F P S

	Index Entry	Section

C
	`cffi-c-ref`:	The cffi-c-ref system
	`cffi-c-ref`:	The cffi-c-ref package
	`cffi-c-ref.asd`:	The cffi-c-ref/cffi-c-ref․asd file
	`cffi-c-ref.lisp`:	The cffi-c-ref/cffi-c-ref․lisp file

F
	`File, cffi-c-ref.asd`:	The cffi-c-ref/cffi-c-ref․asd file
	`File, cffi-c-ref.lisp`:	The cffi-c-ref/cffi-c-ref․lisp file

P
	`Package, cffi-c-ref`:	The cffi-c-ref package

S
	`System, cffi-c-ref`:	The cffi-c-ref system

The cffi-c-ref Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 cffi-c-ref

3 Files

3.1 Lisp

3.1.1 cffi-c-ref/cffi-c-ref.asd

3.1.2 cffi-c-ref/cffi-c-ref.lisp

4 Packages

4.1 cffi-c-ref

5 Definitions

5.1 Public Interface

5.1.1 Macros

5.2 Internals

5.2.1 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `cffi-c-ref`

3.1.1 `cffi-c-ref/cffi-c-ref.asd`

3.1.2 `cffi-c-ref/cffi-c-ref.lisp`

4.1 `cffi-c-ref`