The cl-base16 Reference Manual

This is the cl-base16 Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 03:44:05 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-base16

Common Lisp implementation of base16

Author

Thomas Atkinson <>

License

GPLv2

Dependencies
  • uiop (system).
  • cl-yaml (system).
  • cl-mustache (system).
  • cl-slug (system).
  • trivial-shell (system).
Source

cl-base16.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 cl-base16/cl-base16.asd

Source

cl-base16.asd.

Parent Component

cl-base16 (system).

ASDF Systems

cl-base16.


3.1.2 cl-base16/package.lisp

Source

cl-base16.asd.

Parent Component

cl-base16 (system).

Packages

cl-base16.


3.1.3 cl-base16/cl-base16.lisp

Dependency

package.lisp (file).

Source

cl-base16.asd.

Parent Component

cl-base16 (system).

Public Interface
Internals

3.1.4 cl-base16/builder.lisp

Dependency

cl-base16.lisp (file).

Source

cl-base16.asd.

Parent Component

cl-base16 (system).

Public Interface

update (function).

Internals

3.1.5 cl-base16/cl-yaml-parser-fix.lisp

Dependency

builder.lisp (file).

Source

cl-base16.asd.

Parent Component

cl-base16 (system).


4 Packages

Packages are listed by definition order.


4.1 cl-base16

Source

package.lisp.

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

Special Variable: *base-dir*

Base directory to expect input files from.
This is set to the base directory of the source files when loaded with asdf. *base-dir* has to be of type pathname

Package

cl-base16.

Source

cl-base16.lisp.

Special Variable: *source-dir*

Source directory.
This is set to *base-dir*/sources/ when loaded with asdf. *source-dir* has to be of type pathname

Package

cl-base16.

Source

cl-base16.lisp.


5.1.2 Ordinary functions

Function: apply-scheme (scheme template mustache-filename)

Apply Scheme scheme to Template template and return theme as a string.

Package

cl-base16.

Source

cl-base16.lisp.

Function: update ()
Package

cl-base16.

Source

builder.lisp.


5.2 Internals


5.2.1 Ordinary functions

Function: clone-or-update-git-repo (repo url &optional dir)

As it says on the tin.

Package

cl-base16.

Source

builder.lisp.

Function: fetch-list-contents (source-name)

Fetch the contents of source source-name and clone th git repo’s it specifies.

Package

cl-base16.

Source

builder.lisp.

Function: get-template-dir (template)

Get the directory of template.

Package

cl-base16.

Source

cl-base16.lisp.

Function: load-scheme (scheme)

Load Scheme scheme as a cons list.

Package

cl-base16.

Source

cl-base16.lisp.

Function: make-keyword (key)

Make string key into a keyword.

Package

cl-base16.

Source

cl-base16.lisp.

Function: open-template-or-nil (template)

Open template yaml file

Package

cl-base16.

Source

cl-base16.lisp.

Function: save-theme (scheme template)

Save theme specified by scheme after being applied to template. Optionally specify:
The output path out to use

Package

cl-base16.

Source

cl-base16.lisp.

Function: update-sources ()

Update sources
If sources is nil update *base-dir*/sources.yaml If it has a value convert a string to yaml

Package

cl-base16.

Source

builder.lisp.


Appendix A Indexes


A.1 Concepts