The quickproject Reference Manual

Table of Contents

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

The quickproject Reference Manual

This is the quickproject Reference Manual, version 1.3, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 09:15:01 2018 GMT+0.


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

1 Introduction

Quickproject creates the skeleton of a Common Lisp project.

For full documentation, see doc/index.html.

Quickproject is licensed under the MIT license; see LICENSE.txt for
details.

For questions or comments, please email Zach Beane .


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 quickproject

Description

Creates the skeleton of a new Common Lisp project

Version

1.3

Dependencies
Source

quickproject.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 quickproject.asd

Location

quickproject.asd

Systems

quickproject (system)


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

3.1.2 quickproject/package.lisp

Parent

quickproject (system)

Location

package.lisp

Packages

quickproject


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

3.1.3 quickproject/quickproject.lisp

Dependency

package.lisp (file)

Parent

quickproject (system)

Location

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

The Quickproject package.

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 Special variables

Special Variable: *after-make-project-hooks*

A list of functions to call after MAKE-PROJECT is finished making a project. Each function is called with the same arguments passed to MAKE-PROJECT, except that NAME is canonicalized if
necessary. *DEFAULT-PATHNAME-DEFAULTS* bound to the newly created project directory.

Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *author*

Set this variable to your contact information.

Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *include-copyright*

Include a copyright notice at the top of files.

Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *license*
Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *template-directory*

A directory to use as a source of template files.

Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *template-parameter-functions*

A list of functions that return plists for use when rewriting template files. The results of calling each function are appended together to pass to FILL-AND-PRINT-TEMPLATE.

Package

quickproject

Source

quickproject.lisp (file)


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

5.1.2 Functions

Function: default-template-parameters ()

Return a plist of :NAME, :LICENSE, and :AUTHOR parameters.

Package

quickproject

Source

quickproject.lisp (file)

Function: make-project PATHNAME &key TEMPLATE-PARAMETERS (TEMPLATE-DIRECTORY *TEMPLATE-DIRECTORY*) (DEPENDS-ON *DEPENDS-ON*) (AUTHOR *AUTHOR*) (LICENSE *LICENSE*) NAME (INCLUDE-COPYRIGHT *INCLUDE-COPYRIGHT*)

Create a project skeleton for NAME in PATHNAME. If DEPENDS-ON is provided, it is used as the asdf defsystem depends-on list.

Package

quickproject

Source

quickproject.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *depends-on*

Dependencies specified at project creation

Package

quickproject

Source

quickproject.lisp (file)

Special Variable: *name*

The name of the project currently being created.

Package

quickproject

Source

quickproject.lisp (file)


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

5.2.2 Macros

Macro: with-new-file (STREAM FILE) &body BODY

Like WITH-OPEN-FILE, but specialized for output to a file that must not already exist.

Package

quickproject

Source

quickproject.lisp (file)


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

5.2.3 Functions

Function: current-year ()
Package

quickproject

Source

quickproject.lisp (file)

Function: pathname-project-name PATHNAME

Return a project name based on PATHNAME by taking the last element in the pathname-directory list. E.g. returns "awesome-project" for #p"src/awesome-project/".

Package

quickproject

Source

quickproject.lisp (file)

Function: rewrite-templates TEMPLATE-DIRECTORY TARGET-DIRECTORY PARAMETERS

Treat every file in TEMPLATE-DIRECTORY as a template file; fill it out using PARAMETERS into a corresponding file in TARGET-DIRECTORY. The rewriting uses HTML-TEMPLATE. The template start marker is the string "(#|" and the template end marker is the string "|#)". Template vars are not modified or escaped when written.

Package

quickproject

Source

quickproject.lisp (file)

Function: template-parameters INITIAL-PARAMETERS

Return all template parameters returned by calling each element in *TEMPLATE-PARAMETER-FUNCTIONS*, appended together as a single plist.

Package

quickproject

Source

quickproject.lisp (file)

Function: template-pathname->output-name PATH
Package

quickproject

Source

quickproject.lisp (file)

Function: uninterned-symbolize NAME

Return an uninterned symbol named after NAME, which is treated as a string designator and upcased.

Package

quickproject

Source

quickproject.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   Q  
Index Entry  Section

F
File, Lisp, quickproject.asd: The quickproject<dot>asd file
File, Lisp, quickproject/package.lisp: The quickproject/package<dot>lisp file
File, Lisp, quickproject/quickproject.lisp: The quickproject/quickproject<dot>lisp file

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

Q
quickproject.asd: The quickproject<dot>asd file
quickproject/package.lisp: The quickproject/package<dot>lisp file
quickproject/quickproject.lisp: The quickproject/quickproject<dot>lisp file

Jump to:   F   L   Q  

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

A.2 Functions

Jump to:   C   D   F   M   P   R   T   U   W  
Index Entry  Section

C
current-year: Internal functions

D
default-template-parameters: Exported functions

F
Function, current-year: Internal functions
Function, default-template-parameters: Exported functions
Function, make-project: Exported functions
Function, pathname-project-name: Internal functions
Function, rewrite-templates: Internal functions
Function, template-parameters: Internal functions
Function, template-pathname->output-name: Internal functions
Function, uninterned-symbolize: Internal functions

M
Macro, with-new-file: Internal macros
make-project: Exported functions

P
pathname-project-name: Internal functions

R
rewrite-templates: Internal functions

T
template-parameters: Internal functions
template-pathname->output-name: Internal functions

U
uninterned-symbolize: Internal functions

W
with-new-file: Internal macros

Jump to:   C   D   F   M   P   R   T   U   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*after-make-project-hooks*: Exported special variables
*author*: Exported special variables
*depends-on*: Internal special variables
*include-copyright*: Exported special variables
*license*: Exported special variables
*name*: Internal special variables
*template-directory*: Exported special variables
*template-parameter-functions*: Exported special variables

S
Special Variable, *after-make-project-hooks*: Exported special variables
Special Variable, *author*: Exported special variables
Special Variable, *depends-on*: Internal special variables
Special Variable, *include-copyright*: Exported special variables
Special Variable, *license*: Exported special variables
Special Variable, *name*: Internal special variables
Special Variable, *template-directory*: Exported special variables
Special Variable, *template-parameter-functions*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   P   Q   S  
Index Entry  Section

P
Package, quickproject: The quickproject package

Q
quickproject: The quickproject system
quickproject: The quickproject package

S
System, quickproject: The quickproject system

Jump to:   P   Q   S