The simple-config Reference Manual

Table of Contents

The simple-config Reference Manual

This is the simple-config Reference Manual, version 1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 17:46:51 2021 GMT+0.

1 Introduction

simple-config

ava fox

a library to load and parse simple config files of the format KEY = VALUE

attempts to parse each value into its proper lisp data type.

config example:

env = development
program-version=2
aws_bucket = config-bucket

Install

(ql:quickload :simple-config)

API

load-config - file-path &key parse-lists list-separator

Loads a config file from FILE-PATH

if PARSE-LISTS is non-nil VALUES are checked for LIST-SEPARATOR and split by it.

PARSE-LISTS defaults to t

LIST-SEPARATOR defaults to #\,

Returns t if successfully loaded, otherwise nil

config - key &optional default

Checks loaded config for KEY, returning nil if not found

If DEFAULT is given, returns it instead of nil if KEY isn't found

save-config - file-path

writes the currently loaded config to FILE-PATH, overwriting it if it already exists

License

BSD 3-Clause

2 Systems

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

2.1 simple-config

Author

ava fox <dev@computerfox.xyz>

License

BSD 3-Clause

Description

loads and parses a KEY=VALUE style config file

Version

1.0

Dependencies

• str
• uiop

Source

simple-config.asd (file)

Components

• package.lisp (file)
• simple-config.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 simple-config.asd

Location

simple-config.asd

Systems

simple-config (system)

3.1.2 simple-config/package.lisp

Parent

simple-config (system)

Location

package.lisp

Packages

simple-config

3.1.3 simple-config/simple-config.lisp

Dependency

package.lisp (file)

Parent

simple-config (system)

Location

simple-config.lisp

Exported Definitions

• config (function)
• (setf config) (method)
• (setf config) (method)
• load-config (function)
• save-config (function)

Internal Definitions

• *config* (special variable)
• *list-separator* (special variable)
• *parse-lists* (special variable)
• line-comment-p (function)
• parse-value (function)
• print-config (function)
• string-to-keyword (function)

4 Packages

Packages are listed by definition order.

4.1 simple-config

Source

package.lisp (file)

Nickname

conf

Use List

common-lisp

Exported Definitions

• config (function)
• (setf config) (generic function)
• (setf config) (method)
• (setf config) (generic function)
• (setf config) (method)
• load-config (function)
• save-config (function)

Internal Definitions

• *config* (special variable)
• *list-separator* (special variable)
• *parse-lists* (special variable)
• line-comment-p (function)
• parse-value (function)
• print-config (function)
• string-to-keyword (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: config KEY &optional DEFAULT

retrieve the value from config using KEY, returns nil if not found

if DEFAULT is given returns it instead of nil when KEY is not found

Package

simple-config

Source

simple-config.lisp (file)

Writer

(setf config) (generic function)

Function: load-config FILE-PATH &key PARSE-LISTS LIST-SEPARATOR

loads config at FILE-PATH

PARSE-LISTS defaults to t
LIST-SEPARATOR defaults to #,

if PARSE-LISTS is non-nil we check any value for character LIST-SEPARATOR and split it by that

returns T on success, NIL otherwise

Package

simple-config

Source

simple-config.lisp (file)

Function: save-config FILE-PATH

saves currently loaded config to FILEPATH

Package

simple-config

Source

simple-config.lisp (file)

5.1.2 Generic functions

Generic Function: (setf config) VALUE KEY

Package

simple-config

Reader

config (function)

Methods

Method: (setf config) VALUE KEY

allows us to do setf on (config) calls

Source

simple-config.lisp (file)

5.2 Internal definitions

5.2.1 Special variables

Special Variable: *config*

our loaded config

Package

simple-config

Source

simple-config.lisp (file)

Special Variable: *list-separator*

Package

simple-config

Source

simple-config.lisp (file)

Special Variable: *parse-lists*

Package

simple-config

Source

simple-config.lisp (file)

5.2.2 Functions

Function: line-comment-p LINE

checks if LINE is a full line comments

Package

simple-config

Source

simple-config.lisp (file)

Function: parse-value VALUE

determines what kind of data VALUE is, and parses it correctly

Package

simple-config

Source

simple-config.lisp (file)

Function: print-config STREAM DATA &optional COLONP ATSIGNP

custom format function that prints out config

Package

simple-config

Source

simple-config.lisp (file)

Function: string-to-keyword STR

converts STR into a keyword

replaces all underscores with hyphens

Package

simple-config

Source

simple-config.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types