The cl-ini Reference Manual

Table of Contents

The cl-ini Reference Manual

This is the cl-ini Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 14:54:32 2021 GMT+0.

1 Introduction

cl-ini

ava fox

parse an INI file into an alist

Installing

$ mkdir ~/common-lisp
$ git clone https://github.com/compufox/cl-ini ~/common-lisp/cl-ini

then

* (ql:quickload :cl-ini)

API

(parse-ini file) => nested alist

reads FILE in and parses it

if no section is defined then all key-pairs are put into a :GLOBAL section

returns an alist with the same structure of the ini file

(ini-value ini key &key (section :global)) => value OR nil

returns the value of KEY for SECTION in INI

returns NIL if key does not exist

License

MIT

2 Systems

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

2.1 cl-ini

Author

ava fox <dev@computerfox.xyz>

License

MIT

Description

INI file parser

Version

0.1

Dependency

str

Source

cl-ini.asd (file)

Components

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

Location

cl-ini.asd

Systems

cl-ini (system)

3.1.2 cl-ini/package.lisp

Parent

cl-ini (system)

Location

package.lisp

Packages

cl-ini

3.1.3 cl-ini/cl-ini.lisp

Dependency

package.lisp (file)

Parent

cl-ini (system)

Location

cl-ini.lisp

Exported Definitions

• ini-value (function)
• parse-ini (function)

Internal Definitions

• agetf (function)
• comment-p (function)
• parse-keypair (function)
• parse-section-header (function)
• parse-value (function)
• read-file (function)
• section-header-p (function)
• should-remove-p (function)
• to-keyword (function)

4 Packages

Packages are listed by definition order.

4.1 cl-ini

Source

package.lisp (file)

Nickname

ini

Use List

common-lisp

Exported Definitions

• ini-value (function)
• parse-ini (function)

Internal Definitions

• agetf (function)
• comment-p (function)
• parse-keypair (function)
• parse-section-header (function)
• parse-value (function)
• read-file (function)
• section-header-p (function)
• should-remove-p (function)
• 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: ini-value INI KEY &key SECTION

returns the value of KEY for SECTION in INI

returns NIL if key is missing

Package

cl-ini

Source

cl-ini.lisp (file)

Function: parse-ini FILE

reads FILE in and parses it

if no section is defined then all key-pairs are put into a :GLOBAL section

returns an alist with the same structure of the ini file

Package

cl-ini

Source

cl-ini.lisp (file)

5.2 Internal definitions

5.2.1 Functions

Function: agetf PLACE ITEM &optional DEFAULT

Package

cl-ini

Source

cl-ini.lisp (file)

Function: comment-p LINE

Package

cl-ini

Source

cl-ini.lisp (file)

Function: parse-keypair KEYPAIR

Package

cl-ini

Source

cl-ini.lisp (file)

Function: parse-section-header LINE

Package

cl-ini

Source

cl-ini.lisp (file)

Function: parse-value VALUE

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

Package

cl-ini

Source

cl-ini.lisp (file)

Function: read-file FILE

Package

cl-ini

Source

cl-ini.lisp (file)

Function: section-header-p LINE

Package

cl-ini

Source

cl-ini.lisp (file)

Function: should-remove-p LINE

Package

cl-ini

Source

cl-ini.lisp (file)

Function: to-keyword S

Package

cl-ini

Source

cl-ini.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types