The clad Reference Manual

Table of Contents

The clad Reference Manual

This is the clad Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:32:19 2021 GMT+0.

1 Introduction

CLAD

Copyright (c) 2018-2020 Marco Antoniotti See file COPYING for licensing information

DESCRIPTION

The Common Lisp Application Directories (CLAD) library is a simple API collection that provides access to a set of "standard" Common Lisp folders on a "per-application" or "per-library" basis.

2 Systems

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

2.1 clad

Author

Marco Antoniotti

License

BSD

Description

The CLAD System.

Source

clad.asd (file)

Components

• clad-package.lisp (file)
• clad.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 clad.asd

Location

clad.asd

Systems

clad (system)

3.1.2 clad/clad-package.lisp

Parent

clad (system)

Location

clad-package.lisp

Packages

it.unimib.disco.ma.clad

3.1.3 clad/clad.lisp

Dependency

clad-package.lisp (file)

Parent

clad (system)

Location

clad.lisp

Exported Definitions

• app-or-library-data-folder (function)
• app-or-library-data-folders (function)
• ensure-app-or-library-data-folder (function)
• known-apps-or-libraries-data (function)
• user-cl-data-folder (function)
• user-common-lisp-data-directory (function)

Internal Definitions

• +cl-subfolder-name+ (special variable)
• reset-app-or-data-folder (function)
• system-dependent-cl-subfolder-name (function)

4 Packages

Packages are listed by definition order.

4.1 it.unimib.disco.ma.clad

Source

clad-package.lisp (file)

Nickname

clad

Use List

common-lisp

Exported Definitions

• app-or-library-data-folder (function)
• app-or-library-data-folders (function)
• ensure-app-or-library-data-folder (function)
• known-apps-or-libraries-data (function)
• user-cl-data-folder (function)
• user-common-lisp-data-directory (function)

Internal Definitions

• +cl-subfolder-name+ (special variable)
• reset-app-or-data-folder (function)
• system-dependent-cl-subfolder-name (function)

5 Definitions

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

5.1 Exported definitions

5.1.1 Functions

Function: app-or-library-data-folder APP-OR-LIBRARY-NAME &key VERSION-NAME IMPL-DEPENDENT-TOO &aux ADDL

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: app-or-library-data-folders ()

Returns a list of the folder pathnames present in the CL data folder.

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: ensure-app-or-library-data-folder APP-OR-LIBRARY-NAME &key VERSION-NAME IMPL-DEPENDENT-TOO

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: known-apps-or-libraries-data ()

Returns a list of known apps or libraries listed in the CL data folder.

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: user-cl-data-folder ()

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: user-common-lisp-data-directory ()

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: +cl-subfolder-name+

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

5.2.2 Functions

Function: reset-app-or-data-folder APP-OR-LIBRARY-NAME &optional ABORT-IF-NON-EMPTY

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Function: system-dependent-cl-subfolder-name ()

Package

it.unimib.disco.ma.clad

Source

clad.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types