The cl-project Reference Manual

Child Component

src (module).

Next: Files, Previous: Systems, Up: The cl-project Reference Manual [Contents][Index]

3 Modules

Modules are listed depth-first from the system components tree.

cl-project/src

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

3.1 `cl-project/src`

Source

Parent Component

cl-project (system).

Child Components

cl-project.lisp (file).
file.lisp (file).
skeleton.lisp (file).
io.lisp (file).
middleware.lisp (file).
specials.lisp (file).

Next: Packages, Previous: Modules, Up: The cl-project Reference Manual [Contents][Index]

4 Files

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

Lisp

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

Next: cl-project/src/cl-project.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

4.1.1 `cl-project/cl-project.asd`

Source: cl-project.asd.
Parent Component: cl-project (system).
ASDF Systems: cl-project.

Next: cl-project/src/file.lisp, Previous: cl-project/cl-project.asd, Up: Lisp [Contents][Index]

4.1.2 `cl-project/src/cl-project.lisp`

Dependencies

specials.lisp (file).
file.lisp (file).
skeleton.lisp (file).

Source

Parent Component

src (module).

Packages

cl-project.

Public Interface

generate-skeleton (function).
make-project (function).

Next: cl-project/src/skeleton.lisp, Previous: cl-project/src/cl-project.lisp, Up: Lisp [Contents][Index]

4.1.3 `cl-project/src/file.lisp`

Dependencies

specials.lisp (file).
io.lisp (file).

Source

Parent Component

src (module).

Packages

Public Interface

generate (generic function).
make-template-file (function).
template-file (class).
template-file-path (reader method).
(setf template-file-path) (writer method).

Next: cl-project/src/io.lisp, Previous: cl-project/src/file.lisp, Up: Lisp [Contents][Index]

4.1.4 `cl-project/src/skeleton.lisp`

Dependencies

specials.lisp (file).
file.lisp (file).
middleware.lisp (file).

Source

Parent Component

src (module).

Packages

Public Interface

generate (method).
make-skeleton (function).
make-skeleton-from-directory (function).
skeleton (class).

Internals

maptree (function).
skeleton-children (reader method).
(setf skeleton-children) (writer method).
skeleton-path (reader method).
(setf skeleton-path) (writer method).

Next: cl-project/src/middleware.lisp, Previous: cl-project/src/skeleton.lisp, Up: Lisp [Contents][Index]

4.1.5 `cl-project/src/io.lisp`

Dependency: specials.lisp (file).
Source: cl-project.asd.
Parent Component: src (module).
Packages: cl-project.io.
Public Interface: copy-file-to-file (function).

Next: cl-project/src/specials.lisp, Previous: cl-project/src/io.lisp, Up: Lisp [Contents][Index]

4.1.6 `cl-project/src/middleware.lisp`

Dependency: file.lisp (file).
Source: cl-project.asd.
Parent Component: src (module).
Packages: cl-project.middleware.
Public Interface: *without-tests* (special variable).

Previous: cl-project/src/middleware.lisp, Up: Lisp [Contents][Index]

4.1.7 `cl-project/src/specials.lisp`

Source

Parent Component

src (module).

Packages

cl-project.specials.

Public Interface

*default-skeleton-directory* (special variable).
*skeleton-directory* (special variable).
*skeleton-parameters* (special variable).

Next: Definitions, Previous: Files, Up: The cl-project Reference Manual [Contents][Index]

5 Packages

Packages are listed by definition order.

cl-project.file
cl-project
cl-project.specials
cl-project.skeleton
cl-project.middleware
cl-project.io

Next: cl-project, Previous: Packages, Up: Packages [Contents][Index]

5.1 `cl-project.file`

Source

file.lisp.

Use List

cl-project.specials.
common-lisp.

Public Interface

generate (generic function).
make-template-file (function).
template-file (class).
template-file-path (generic reader).
(setf template-file-path) (generic writer).

Next: cl-project.specials, Previous: cl-project.file, Up: Packages [Contents][Index]

5.2 `cl-project`

Source

cl-project.lisp.

Use List

common-lisp.

Public Interface

generate-skeleton (function).
make-project (function).

Next: cl-project.skeleton, Previous: cl-project, Up: Packages [Contents][Index]

5.3 `cl-project.specials`

Source

specials.lisp.

Use List

common-lisp.

Used By List

cl-project.file.
cl-project.io.
cl-project.skeleton.

Public Interface

*default-skeleton-directory* (special variable).
*skeleton-directory* (special variable).
*skeleton-parameters* (special variable).

Next: cl-project.middleware, Previous: cl-project.specials, Up: Packages [Contents][Index]

5.4 `cl-project.skeleton`

Source

skeleton.lisp.

Use List

cl-project.specials.
common-lisp.

Public Interface

make-skeleton (function).
make-skeleton-from-directory (function).
skeleton (class).

Internals

maptree (function).
skeleton-children (generic reader).
(setf skeleton-children) (generic writer).
skeleton-path (generic reader).
(setf skeleton-path) (generic writer).

Next: cl-project.io, Previous: cl-project.skeleton, Up: Packages [Contents][Index]

5.5 `cl-project.middleware`

Source: middleware.lisp.
Use List: common-lisp.
Public Interface: *without-tests* (special variable).

Previous: cl-project.middleware, Up: Packages [Contents][Index]

5.6 `cl-project.io`

Source

io.lisp.

Use List

cl-project.specials.
common-lisp.

Public Interface

copy-file-to-file (function).

Next: Indexes, Previous: Packages, Up: The cl-project Reference Manual [Contents][Index]

6 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]

6.1 Public Interface

Special variables
Ordinary functions
Generic functions
Classes

Next: Ordinary functions, Previous: Public Interface, Up: Public Interface [Contents][Index]

6.1.1 Special variables

Special Variable: *default-skeleton-directory* ¶

Package: cl-project.specials.
Source: specials.lisp.

Special Variable: *skeleton-directory* ¶

Package: cl-project.specials.
Source: specials.lisp.

Special Variable: *skeleton-parameters* ¶

Package: cl-project.specials.
Source: specials.lisp.

Special Variable: *without-tests* ¶

Package: cl-project.middleware.
Source: middleware.lisp.

Next: Generic functions, Previous: Special variables, Up: Public Interface [Contents][Index]

6.1.2 Ordinary functions

Function: copy-file-to-file (source-path target-path &key verbose) ¶

Copy a file ‘source-path‘ to the ‘target-path‘.

Package: cl-project.io.
Source: io.lisp.

Function: generate-skeleton (source-dir target-dir &key env verbose) ¶

General skeleton generator.

Package: cl-project.
Source: cl-project.lisp.

Function: make-project (path &rest params &key name long-name version description long-description author maintainer email license homepage bug-tracker source-control depends-on use import-from export code load-system without-tests verbose &allow-other-keys) ¶

Generate a skeleton.

Package: cl-project.
Source: cl-project.lisp.

Function: make-skeleton (path children) ¶

Package: cl-project.skeleton.
Source: skeleton.lisp.

Function: make-skeleton-from-directory (directory) ¶

Package: cl-project.skeleton.
Source: skeleton.lisp.

Function: make-template-file (path) ¶

Package: cl-project.file.
Source: file.lisp.

Next: Classes, Previous: Ordinary functions, Up: Public Interface [Contents][Index]

6.1.3 Generic functions

Generic Function: generate (file target-dir &key verbose) ¶

Package

Source

file.lisp.

Methods

Method: generate ((skeleton skeleton) target-dir &key verbose) ¶

Source: skeleton.lisp.

Method: generate ((file template-file) target-dir &key verbose) ¶

Generic Reader: template-file-path (object) ¶

Package

Methods

Reader Method: template-file-path ((template-file template-file)) ¶

automatically generated reader method

Source: file.lisp.
Target Slot: path.

Generic Writer: (setf template-file-path) (object) ¶

Package

Methods

Writer Method: (setf template-file-path) ((template-file template-file)) ¶

automatically generated writer method

Source: file.lisp.
Target Slot: path.

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

6.1.4 Classes

Class: skeleton ¶

Package

Source

skeleton.lisp.

Direct methods

generate.
(setf skeleton-children).
skeleton-children.
(setf skeleton-path).
skeleton-path.

Direct slots

Slot: path ¶

Type: pathname
Initargs: :path
Readers: skeleton-path.
Writers: (setf skeleton-path).

Slot: children ¶

Type: list
Initform: (quote nil)
Initargs: :children
Readers: skeleton-children.
Writers: (setf skeleton-children).

Class: template-file ¶

Package

Source

file.lisp.

Direct methods

generate.
(setf template-file-path).
template-file-path.

Direct slots

Slot: path ¶

Type: pathname
Initargs: :path
Readers: template-file-path.
Writers: (setf template-file-path).

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

6.2 Internals

Ordinary functions
Generic functions

Next: Generic functions, Previous: Internals, Up: Internals [Contents][Index]

6.2.1 Ordinary functions

Function: maptree (fn path) ¶

Package: cl-project.skeleton.
Source: skeleton.lisp.

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

6.2.2 Generic functions

Generic Reader: skeleton-children (object) ¶

Package

Methods

Reader Method: skeleton-children ((skeleton skeleton)) ¶

automatically generated reader method

Source: skeleton.lisp.
Target Slot: children.

Generic Writer: (setf skeleton-children) (object) ¶

Package

Methods

Writer Method: (setf skeleton-children) ((skeleton skeleton)) ¶

automatically generated writer method

Source: skeleton.lisp.
Target Slot: children.

Generic Reader: skeleton-path (object) ¶

Package

Methods

Reader Method: skeleton-path ((skeleton skeleton)) ¶

automatically generated reader method

Source: skeleton.lisp.
Target Slot: path.

Generic Writer: (setf skeleton-path) (object) ¶

Package