The template Reference Manual

Table of Contents

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

The template Reference Manual

This is the template Reference Manual, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:38:48 2018 GMT+0.


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

1 Introduction

                               TEMPLATE
                               ========

                           By Robert Smith

TEMPLATE is a package for templates and template functions, similar to
C++ templates.

Example:

;;; Define the templated function.
(define-templated-function add (type) (x y)
  `(locally (declare (type ,type x y))
     (the ,type (+ x y))))

;;; Instantiate it with a few types.
(instantiate-templated-function add fixnum)
(instantiate-templated-function add single-float)

;;; Call it.
(add '(fixnum) 1 2)
(add '(single-float) 1.0 2.0)


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 template

Author

Robert Smith <quad@symbo1ics.com>

License

BSD 3-clause (See LICENSE)

Description

A library for templates and template functions.

Dependencies
Source

template.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.


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

3.1 Lisp


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

3.1.1 template.asd

Location

template.asd

Systems

template (system)


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

3.1.2 template/package.lisp

Dependency

license (file)

Parent

template (system)

Location

package.lisp

Packages

template


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

3.1.3 template/templates.lisp

Dependency

package.lisp (file)

Parent

template (system)

Location

templates.lisp

Exported Definitions
Internal Definitions

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

3.2 Other


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

3.2.1 template/LICENSE

Parent

template (system)

Location

/home/quickbuilder/quicklisp/dists/quicklisp/software/template-20150113-hg/LICENSE (not found)


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

4 Packages

Packages are listed by definition order.


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

4.1 template

Source

package.lisp (file)

Use List

common-lisp

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 Macros

Macro: define-template NAME PARAMS &body BODY
Package

template

Source

templates.lisp (file)

Macro: define-templated-function NAME (&rest TEMPLATE-ARGS) (&rest LAMBDA-LIST) &body BODY
Package

template

Source

templates.lisp (file)

Macro: instantiate-template NAME &rest ARGS
Package

template

Source

templates.lisp (file)

Macro: instantiate-templated-function NAME &rest TEMPLATE-VALUES
Package

template

Source

templates.lisp (file)

Macro: template (&rest PARAMS) &body BODY
Package

template

Source

templates.lisp (file)


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

5.1.2 Functions

Function: expand-template NAME &rest ARGS
Package

template

Source

templates.lisp (file)


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

5.1.3 Structures

Structure: template ()
Package

template

Source

templates.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Readers

template-name (function)

Writers

(setf template-name) (function)

Slot: arity
Readers

template-arity (function)

Writers

(setf template-arity) (function)

Slot: code-generator
Readers

template-code-generator (function)

Writers

(setf template-code-generator) (function)

Slot: function-arguments
Readers

template-function-arguments (function)

Writers

(setf template-function-arguments) (function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *templates*
Package

template

Source

templates.lisp (file)


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

5.2.2 Functions

Function: copy-template INSTANCE
Package

template

Source

templates.lisp (file)

Function: ensure-kw-list X &optional FIRST-ELT
Package

template

Source

templates.lisp (file)

Function: keywordify X
Package

template

Source

templates.lisp (file)

Function: make-template &key (NAME NAME) (ARITY ARITY) (CODE-GENERATOR CODE-GENERATOR) (FUNCTION-ARGUMENTS FUNCTION-ARGUMENTS)
Package

template

Source

templates.lisp (file)

Function: mangle NAME &rest ARGUMENTS
Package

template

Source

templates.lisp (file)

Function: template-arity INSTANCE
Function: (setf template-arity) VALUE INSTANCE
Package

template

Source

templates.lisp (file)

Function: template-code-generator INSTANCE
Function: (setf template-code-generator) VALUE INSTANCE
Package

template

Source

templates.lisp (file)

Function: template-function-arguments INSTANCE
Function: (setf template-function-arguments) VALUE INSTANCE
Package

template

Source

templates.lisp (file)

Function: template-name INSTANCE
Function: (setf template-name) VALUE INSTANCE
Package

template

Source

templates.lisp (file)

Function: template-p OBJECT
Package

template

Source

templates.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   O   T  
Index Entry  Section

F
File, Lisp, template.asd: The template<dot>asd file
File, Lisp, template/package.lisp: The template/package<dot>lisp file
File, Lisp, template/templates.lisp: The template/templates<dot>lisp file
File, other, template/LICENSE: The template/license file

L
Lisp File, template.asd: The template<dot>asd file
Lisp File, template/package.lisp: The template/package<dot>lisp file
Lisp File, template/templates.lisp: The template/templates<dot>lisp file

O
Other File, template/LICENSE: The template/license file

T
template.asd: The template<dot>asd file
template/LICENSE: The template/license file
template/package.lisp: The template/package<dot>lisp file
template/templates.lisp: The template/templates<dot>lisp file

Jump to:   F   L   O   T  

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

A.2 Functions

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

(
(setf template-arity): Internal functions
(setf template-code-generator): Internal functions
(setf template-function-arguments): Internal functions
(setf template-name): Internal functions

C
copy-template: Internal functions

D
define-template: Exported macros
define-templated-function: Exported macros

E
ensure-kw-list: Internal functions
expand-template: Exported functions

F
Function, (setf template-arity): Internal functions
Function, (setf template-code-generator): Internal functions
Function, (setf template-function-arguments): Internal functions
Function, (setf template-name): Internal functions
Function, copy-template: Internal functions
Function, ensure-kw-list: Internal functions
Function, expand-template: Exported functions
Function, keywordify: Internal functions
Function, make-template: Internal functions
Function, mangle: Internal functions
Function, template-arity: Internal functions
Function, template-code-generator: Internal functions
Function, template-function-arguments: Internal functions
Function, template-name: Internal functions
Function, template-p: Internal functions

I
instantiate-template: Exported macros
instantiate-templated-function: Exported macros

K
keywordify: Internal functions

M
Macro, define-template: Exported macros
Macro, define-templated-function: Exported macros
Macro, instantiate-template: Exported macros
Macro, instantiate-templated-function: Exported macros
Macro, template: Exported macros
make-template: Internal functions
mangle: Internal functions

T
template: Exported macros
template-arity: Internal functions
template-code-generator: Internal functions
template-function-arguments: Internal functions
template-name: Internal functions
template-p: Internal functions

Jump to:   (  
C   D   E   F   I   K   M   T  

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

A.3 Variables

Jump to:   *  
A   C   F   N   S  
Index Entry  Section

*
*templates*: Internal special variables

A
arity: Exported structures

C
code-generator: Exported structures

F
function-arguments: Exported structures

N
name: Exported structures

S
Slot, arity: Exported structures
Slot, code-generator: Exported structures
Slot, function-arguments: Exported structures
Slot, name: Exported structures
Special Variable, *templates*: Internal special variables

Jump to:   *  
A   C   F   N   S  

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

A.4 Data types

Jump to:   P   S   T  
Index Entry  Section

P
Package, template: The template package

S
Structure, template: Exported structures
System, template: The template system

T
template: The template system
template: The template package
template: Exported structures

Jump to:   P   S   T