The cl-base16 Reference Manual

Table of Contents

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

The cl-base16 Reference Manual

This is the cl-base16 Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Wed Nov 04 11:57:35 2020 GMT+0.


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

1 Introduction

cl-base16

A implementation of a base16 builder for lisp.

Useage

To run the builder run the following:

(ql:quickload :cl-base16)

(cl-base16:update)

The base directory of the builders scheme.yaml can be changed by setting *base-dir* before running update.

The function apply-scheme is also exported allowing a system to specify the scheme and template and have the result returned as a string. A example of this functionality is in base16-stumpwm which then uses the result to apply the scheme to StumpWM as it is running.


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 cl-base16

Author

Thomas Atkinson <thomas@pinegrove.io>

License

GPLv2

Description

Common Lisp implementation of base16

Dependencies
Source

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

Location

cl-base16.asd

Systems

cl-base16 (system)


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

3.1.2 cl-base16/package.lisp

Parent

cl-base16 (system)

Location

package.lisp

Packages

cl-base16


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

3.1.3 cl-base16/cl-base16.lisp

Dependency

package.lisp (file)

Parent

cl-base16 (system)

Location

cl-base16.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cl-base16/builder.lisp

Dependency

cl-base16.lisp (file)

Parent

cl-base16 (system)

Location

builder.lisp

Exported Definitions

update (function)

Internal Definitions

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

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

Dependency

builder.lisp (file)

Parent

cl-base16 (system)

Location

cl-yaml-parser-fix.lisp


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

4 Packages

Packages are listed by definition order.


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

4.1 cl-base16

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: *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 (file)

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 (file)


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

5.1.2 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 (file)

Function: update ()
Package

cl-base16

Source

builder.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Functions

Function: clone-or-update-git-repo REPO URL &optional DIR

As it says on the tin.

Package

cl-base16

Source

builder.lisp (file)

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 (file)

Function: get-template-dir TEMPLATE

Get the directory of template.

Package

cl-base16

Source

cl-base16.lisp (file)

Function: load-scheme SCHEME

Load Scheme scheme as a cons list.

Package

cl-base16

Source

cl-base16.lisp (file)

Function: make-keyword KEY

Make string key into a keyword.

Package

cl-base16

Source

cl-base16.lisp (file)

Function: open-template-or-nil TEMPLATE

Open template yaml file

Package

cl-base16

Source

cl-base16.lisp (file)

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 (file)

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 (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-base16.asd: The cl-base16․asd file
cl-base16/builder.lisp: The cl-base16/builder․lisp file
cl-base16/cl-base16.lisp: The cl-base16/cl-base16․lisp file
cl-base16/cl-yaml-parser-fix.lisp: The cl-base16/cl-yaml-parser-fix․lisp file
cl-base16/package.lisp: The cl-base16/package․lisp file

F
File, Lisp, cl-base16.asd: The cl-base16․asd file
File, Lisp, cl-base16/builder.lisp: The cl-base16/builder․lisp file
File, Lisp, cl-base16/cl-base16.lisp: The cl-base16/cl-base16․lisp file
File, Lisp, cl-base16/cl-yaml-parser-fix.lisp: The cl-base16/cl-yaml-parser-fix․lisp file
File, Lisp, cl-base16/package.lisp: The cl-base16/package․lisp file

L
Lisp File, cl-base16.asd: The cl-base16․asd file
Lisp File, cl-base16/builder.lisp: The cl-base16/builder․lisp file
Lisp File, cl-base16/cl-base16.lisp: The cl-base16/cl-base16․lisp file
Lisp File, cl-base16/cl-yaml-parser-fix.lisp: The cl-base16/cl-yaml-parser-fix․lisp file
Lisp File, cl-base16/package.lisp: The cl-base16/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   C   F   G   L   M   O   S   U  
Index Entry  Section

A
apply-scheme: Exported functions

C
clone-or-update-git-repo: Internal functions

F
fetch-list-contents: Internal functions
Function, apply-scheme: Exported functions
Function, clone-or-update-git-repo: Internal functions
Function, fetch-list-contents: Internal functions
Function, get-template-dir: Internal functions
Function, load-scheme: Internal functions
Function, make-keyword: Internal functions
Function, open-template-or-nil: Internal functions
Function, save-theme: Internal functions
Function, update: Exported functions
Function, update-sources: Internal functions

G
get-template-dir: Internal functions

L
load-scheme: Internal functions

M
make-keyword: Internal functions

O
open-template-or-nil: Internal functions

S
save-theme: Internal functions

U
update: Exported functions
update-sources: Internal functions

Jump to:   A   C   F   G   L   M   O   S   U  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*base-dir*: Exported special variables
*source-dir*: Exported special variables

S
Special Variable, *base-dir*: Exported special variables
Special Variable, *source-dir*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-base16: The cl-base16 system
cl-base16: The cl-base16 package

P
Package, cl-base16: The cl-base16 package

S
System, cl-base16: The cl-base16 system

Jump to:   C   P   S