The bodge-memory Reference Manual

Table of Contents

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

The bodge-memory Reference Manual

This is the bodge-memory Reference Manual, version 1.0.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 11:41:32 2020 GMT+0.


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

1 Introduction

bodge-memory

Core memory handling utilities of bodge library collection.


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

2 Systems

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


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

2.1 bodge-memory

Author

Pavel Korolev

Contact

dev@borodust.org

License

MIT

Description

Memory handling utilities

Version

1.0.0

Dependencies
Source

bodge-memory.asd (file)

Components

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

3 Files

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


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

3.1 Lisp


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

3.1.1 bodge-memory.asd

Location

/home/quickref/quicklisp/dists/quicklisp/software/bodge-memory-stable-git/bodge-memory.asd

Systems

bodge-memory (system)


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

3.1.2 bodge-memory/packages.lisp

Parent

bodge-memory (system)

Location

packages.lisp

Packages

bodge-memory


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

3.1.3 bodge-memory/disposable.lisp

Dependency

packages.lisp (file)

Parent

bodge-memory (system)

Location

disposable.lisp

Exported Definitions
Internal Definitions

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

3.1.4 bodge-memory/foreign-array.lisp

Dependency

disposable.lisp (file)

Parent

bodge-memory (system)

Location

foreign-array.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 bodge-memory

Source

packages.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: *auto-initialize-destructor*
Package

bodge-memory

Source

disposable.lisp (file)

Special Variable: *explicit-dispose-p*
Package

bodge-memory

Source

disposable.lisp (file)


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

5.1.2 Macros

Macro: define-destructor CLASS-NAME (&rest SLOTS) &body BODY

Define destructor for the objects of ‘class-name‘. ‘class-name‘ should be a subclass of ’disposable.

Destructor can be invoked manually by calling ‘#’dispose‘ or automatically during garbage collection. ‘slots‘ (slot names of the object instance) should be set during instance initialization and cannot be null.

Package

bodge-memory

Source

disposable.lisp (file)

Macro: with-disposable (&rest BINDINGS) &body BODY

let*-like bindings that will be disposed at the end of ‘with-disposable‘ block in reverse order

Package

bodge-memory

Source

disposable.lisp (file)


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

5.1.3 Functions

Function: dispose OBJ

Call destructor for object ‘obj‘.

Package

bodge-memory

Source

disposable.lisp (file)

Function: disposedp DISPOSABLE
Package

bodge-memory

Source

disposable.lisp (file)

Function: initialize-destructor INSTANCE
Package

bodge-memory

Source

disposable.lisp (file)

Function: make-foreign-array LENGTH &key ELEMENT-TYPE INITIAL-ELEMENT INITIAL-CONTENTS
Package

bodge-memory

Source

foreign-array.lisp (file)


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

5.1.4 Generic functions

Generic Function: foreign-pointer-of OBJECT
Package

bodge-memory

Source

foreign-array.lisp (file)

Methods
Method: foreign-pointer-of (THIS foreign-array)
Method: foreign-pointer-of (OBJECT null)
Generic Function: simple-array-of OBJECT
Package

bodge-memory

Methods
Method: simple-array-of (FOREIGN-ARRAY foreign-array)

automatically generated reader method

Source

foreign-array.lisp (file)


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

5.1.5 Classes

Class: disposable ()
Package

bodge-memory

Source

disposable.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

foreign-array (class)

Direct methods

initialize-instance (method)

Direct slots
Slot: finalized-p
Initform

(bodge-memory::make-holder)

Class: disposable-container ()
Package

bodge-memory

Source

disposable.lisp (file)

Direct superclasses

standard-object (class)

Direct slots
Slot: disposables
Initform

(trivial-garbage:make-weak-hash-table :weakness :key)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: %ensure-slot-not-null OBJECT SLOT
Package

bodge-memory

Source

disposable.lisp (file)

Function: %ensure-value-not-null VALUE
Package

bodge-memory

Source

disposable.lisp (file)

Function: copy-holder INSTANCE
Package

bodge-memory

Source

disposable.lisp (file)

Function: holder-p OBJECT
Package

bodge-memory

Source

disposable.lisp (file)

Function: holder-value INSTANCE
Function: (setf holder-value) VALUE INSTANCE
Package

bodge-memory

Source

disposable.lisp (file)

Function: make-holder &key (VALUE VALUE)
Package

bodge-memory

Source

disposable.lisp (file)


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

5.2.2 Generic functions

Generic Function: destructor-of OBJ
Package

bodge-memory

Source

disposable.lisp (file)

Methods
Method: destructor-of (THIS0 foreign-array)
Source

foreign-array.lisp (file)

Method: destructor-of OBJ

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

5.2.3 Structures

Structure: holder ()
Package

bodge-memory

Source

disposable.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: value
Type

boolean

Readers

holder-value (function)

Writers

(setf holder-value) (function)


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

5.2.4 Classes

Class: foreign-array ()
Package

bodge-memory

Source

foreign-array.lisp (file)

Direct superclasses

disposable (class)

Direct methods
Direct slots
Slot: array
Type

(simple-array * *)

Initargs

:array

Readers

simple-array-of (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   B   F   L  
Index Entry  Section

B
bodge-memory.asd: The bodge-memory․asd file
bodge-memory/disposable.lisp: The bodge-memory/disposable․lisp file
bodge-memory/foreign-array.lisp: The bodge-memory/foreign-array․lisp file
bodge-memory/packages.lisp: The bodge-memory/packages․lisp file

F
File, Lisp, bodge-memory.asd: The bodge-memory․asd file
File, Lisp, bodge-memory/disposable.lisp: The bodge-memory/disposable․lisp file
File, Lisp, bodge-memory/foreign-array.lisp: The bodge-memory/foreign-array․lisp file
File, Lisp, bodge-memory/packages.lisp: The bodge-memory/packages․lisp file

L
Lisp File, bodge-memory.asd: The bodge-memory․asd file
Lisp File, bodge-memory/disposable.lisp: The bodge-memory/disposable․lisp file
Lisp File, bodge-memory/foreign-array.lisp: The bodge-memory/foreign-array․lisp file
Lisp File, bodge-memory/packages.lisp: The bodge-memory/packages․lisp file

Jump to:   B   F   L  

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

A.2 Functions

Jump to:   %   (  
C   D   F   G   H   I   M   S   W  
Index Entry  Section

%
%ensure-slot-not-null: Internal functions
%ensure-value-not-null: Internal functions

(
(setf holder-value): Internal functions

C
copy-holder: Internal functions

D
define-destructor: Exported macros
destructor-of: Internal generic functions
destructor-of: Internal generic functions
destructor-of: Internal generic functions
dispose: Exported functions
disposedp: Exported functions

F
foreign-pointer-of: Exported generic functions
foreign-pointer-of: Exported generic functions
foreign-pointer-of: Exported generic functions
Function, %ensure-slot-not-null: Internal functions
Function, %ensure-value-not-null: Internal functions
Function, (setf holder-value): Internal functions
Function, copy-holder: Internal functions
Function, dispose: Exported functions
Function, disposedp: Exported functions
Function, holder-p: Internal functions
Function, holder-value: Internal functions
Function, initialize-destructor: Exported functions
Function, make-foreign-array: Exported functions
Function, make-holder: Internal functions

G
Generic Function, destructor-of: Internal generic functions
Generic Function, foreign-pointer-of: Exported generic functions
Generic Function, simple-array-of: Exported generic functions

H
holder-p: Internal functions
holder-value: Internal functions

I
initialize-destructor: Exported functions

M
Macro, define-destructor: Exported macros
Macro, with-disposable: Exported macros
make-foreign-array: Exported functions
make-holder: Internal functions
Method, destructor-of: Internal generic functions
Method, destructor-of: Internal generic functions
Method, foreign-pointer-of: Exported generic functions
Method, foreign-pointer-of: Exported generic functions
Method, simple-array-of: Exported generic functions

S
simple-array-of: Exported generic functions
simple-array-of: Exported generic functions

W
with-disposable: Exported macros

Jump to:   %   (  
C   D   F   G   H   I   M   S   W  

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

A.3 Variables

Jump to:   *  
A   D   F   S   V  
Index Entry  Section

*
*auto-initialize-destructor*: Exported special variables
*explicit-dispose-p*: Exported special variables

A
array: Internal classes

D
disposables: Exported classes

F
finalized-p: Exported classes

S
Slot, array: Internal classes
Slot, disposables: Exported classes
Slot, finalized-p: Exported classes
Slot, value: Internal structures
Special Variable, *auto-initialize-destructor*: Exported special variables
Special Variable, *explicit-dispose-p*: Exported special variables

V
value: Internal structures

Jump to:   *  
A   D   F   S   V  

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

A.4 Data types

Jump to:   B   C   D   F   H   P   S  
Index Entry  Section

B
bodge-memory: The bodge-memory system
bodge-memory: The bodge-memory package

C
Class, disposable: Exported classes
Class, disposable-container: Exported classes
Class, foreign-array: Internal classes

D
disposable: Exported classes
disposable-container: Exported classes

F
foreign-array: Internal classes

H
holder: Internal structures

P
Package, bodge-memory: The bodge-memory package

S
Structure, holder: Internal structures
System, bodge-memory: The bodge-memory system

Jump to:   B   C   D   F   H   P   S