The cl-ini Reference Manual

This is the cl-ini Reference Manual, version 0.1, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 08 17:04:04 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 cl-ini

INI file parser

Author

ava fox <>

License

MIT

Version

0.1

Dependency

str (system).

Source

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

Source

cl-ini.asd.

Parent Component

cl-ini (system).

ASDF Systems

cl-ini.


3.1.2 cl-ini/package.lisp

Source

cl-ini.asd.

Parent Component

cl-ini (system).

Packages

cl-ini.


3.1.3 cl-ini/cl-ini.lisp

Dependency

package.lisp (file).

Source

cl-ini.asd.

Parent Component

cl-ini (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 cl-ini

Source

package.lisp.

Nickname

ini

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 Ordinary 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.

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.


5.2 Internals


5.2.1 Ordinary functions

Function: agetf (place item &optional default)
Package

cl-ini.

Source

cl-ini.lisp.

Function: comment-p (line)
Package

cl-ini.

Source

cl-ini.lisp.

Function: parse-keypair (keypair)
Package

cl-ini.

Source

cl-ini.lisp.

Function: parse-section-header (line)
Package

cl-ini.

Source

cl-ini.lisp.

Function: parse-value (value)

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

Package

cl-ini.

Source

cl-ini.lisp.

Function: read-file (file)
Package

cl-ini.

Source

cl-ini.lisp.

Function: section-header-p (line)
Package

cl-ini.

Source

cl-ini.lisp.

Function: should-remove-p (line)
Package

cl-ini.

Source

cl-ini.lisp.

Function: to-keyword (s)
Package

cl-ini.

Source

cl-ini.lisp.


Appendix A Indexes


A.1 Concepts


A.3 Variables