The interface Reference Manual

This is the interface Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 05:37:25 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 interface

A system for defining interfaces.

Author

Robert Smith <>

License

BSD 3-clause (See LICENSE)

Dependencies
  • alexandria (system).
  • global-vars (system).
Source

interface.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 interface/interface.asd

Source

interface.asd.

Parent Component

interface (system).

ASDF Systems

interface.


3.1.2 interface/package.lisp

Dependency

license (file).

Source

interface.asd.

Parent Component

interface (system).

Packages

interface.


3.1.3 interface/interface.lisp

Dependency

package.lisp (file).

Source

interface.asd.

Parent Component

interface (system).

Public Interface
Internals

3.2 Static


3.2.1 interface/LICENSE

Source

interface.asd.

Parent Component

interface (system).


4 Packages

Packages are listed by definition order.


4.1 interface

Source

package.lisp.

Nickname

intf

Use List

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 Macros

Macro: define-implementation (name (intf-name) &body implementations)
Package

interface.

Source

interface.lisp.

Macro: define-interface (name options &body specs)

Define an interface whose name is NAME and list of options are OPTIONS. (Currently, no options are supported.) The body of the definition should be a list of "interface specifications". An interface specification is:

* A list containing a function name as the first element and the
lambda list as the second element.

* A symbol representing a constant value.

Package

interface.

Source

interface.lisp.


5.1.2 Ordinary functions

Function: calling-form (function-form lambda-list)

Given an ordinary lambda list LAMBDA-LIST and a FUNCALLable FUNCTION-FORM, construct a form which calls FUNCTION-FORM on all of the arguments specified by LAMBDA-LIST.

Package

interface.

Source

interface.lisp.


5.2 Internals


5.2.1 Ordinary functions

Reader: arglist-args (instance)
Writer: (setf arglist-args) (instance)
Package

interface.

Source

interface.lisp.

Target Slot

args.

Function: arglist-form (function-form arglist)

Construct the calling form with the function form FUNCTION-FORM and the arglist ARGLIST.

Package

interface.

Source

interface.lisp.

Function: arglist-p (object)
Package

interface.

Source

interface.lisp.

Reader: arglist-use-apply (instance)
Writer: (setf arglist-use-apply) (instance)
Package

interface.

Source

interface.lisp.

Target Slot

use-apply.

Function: copy-arglist (instance)
Package

interface.

Source

interface.lisp.

Function: extend-arglist (arglist &rest args)

Extend the arglist ARGLIST with the arguments ARGS. Creates a new arglist.

Package

interface.

Source

interface.lisp.

Function: interface-accessor (intf-name slot)
Package

interface.

Source

interface.lisp.

Function: interface-conc-name (intf-name)
Package

interface.

Source

interface.lisp.

Function: interface-function-specification-p (spec)
Package

interface.

Source

interface.lisp.

Function: interface-implementation-constructor-name (intf-name &optional package)
Package

interface.

Source

interface.lisp.

Function: interface-specification-p (spec)
Package

interface.

Source

interface.lisp.

Function: interface-value-specification-p (spec)
Package

interface.

Source

interface.lisp.

Function: make-arglist (&key args use-apply)
Package

interface.

Source

interface.lisp.

Function: make-arglist-use-apply (arglist)

Create an arglist identical to the arglist ARGLIST, except specifying that it must use APPLY.

Package

interface.

Source

interface.lisp.


5.2.2 Structures

Structure: arglist
Package

interface.

Source

interface.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: args
Readers

arglist-args.

Writers

(setf arglist-args).

Slot: use-apply
Readers

arglist-use-apply.

Writers

(setf arglist-use-apply).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
A   C   D   E   F   I   M  
Index Entry  Section

(
(setf arglist-args): Private ordinary functions
(setf arglist-use-apply): Private ordinary functions

A
arglist-args: Private ordinary functions
arglist-form: Private ordinary functions
arglist-p: Private ordinary functions
arglist-use-apply: Private ordinary functions

C
calling-form: Public ordinary functions
copy-arglist: Private ordinary functions

D
define-implementation: Public macros
define-interface: Public macros

E
extend-arglist: Private ordinary functions

F
Function, (setf arglist-args): Private ordinary functions
Function, (setf arglist-use-apply): Private ordinary functions
Function, arglist-args: Private ordinary functions
Function, arglist-form: Private ordinary functions
Function, arglist-p: Private ordinary functions
Function, arglist-use-apply: Private ordinary functions
Function, calling-form: Public ordinary functions
Function, copy-arglist: Private ordinary functions
Function, extend-arglist: Private ordinary functions
Function, interface-accessor: Private ordinary functions
Function, interface-conc-name: Private ordinary functions
Function, interface-function-specification-p: Private ordinary functions
Function, interface-implementation-constructor-name: Private ordinary functions
Function, interface-specification-p: Private ordinary functions
Function, interface-value-specification-p: Private ordinary functions
Function, make-arglist: Private ordinary functions
Function, make-arglist-use-apply: Private ordinary functions

I
interface-accessor: Private ordinary functions
interface-conc-name: Private ordinary functions
interface-function-specification-p: Private ordinary functions
interface-implementation-constructor-name: Private ordinary functions
interface-specification-p: Private ordinary functions
interface-value-specification-p: Private ordinary functions

M
Macro, define-implementation: Public macros
Macro, define-interface: Public macros
make-arglist: Private ordinary functions
make-arglist-use-apply: Private ordinary functions


A.3 Variables

Jump to:   A   S   U  
Index Entry  Section

A
args: Private structures

S
Slot, args: Private structures
Slot, use-apply: Private structures

U
use-apply: Private structures