The cl-ini Reference Manual

Table of Contents

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

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 Tue Dec 22 12:24:37 2020 GMT+0.


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

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


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-ini

Author

ava fox <dev@computerfox.xyz>

License

MIT

Description

INI file parser

Version

0.1

Dependency

str

Source

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

Location

cl-ini.asd

Systems

cl-ini (system)


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

3.1.2 cl-ini/package.lisp

Parent

cl-ini (system)

Location

package.lisp

Packages

cl-ini


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

3.1.3 cl-ini/cl-ini.lisp

Dependency

package.lisp (file)

Parent

cl-ini (system)

Location

cl-ini.lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 cl-ini

Source

package.lisp (file)

Nickname

ini

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


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

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)


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

5.2 Internal definitions


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

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)


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-ini.asd: The cl-ini․asd file
cl-ini/cl-ini.lisp: The cl-ini/cl-ini․lisp file
cl-ini/package.lisp: The cl-ini/package․lisp file

F
File, Lisp, cl-ini.asd: The cl-ini․asd file
File, Lisp, cl-ini/cl-ini.lisp: The cl-ini/cl-ini․lisp file
File, Lisp, cl-ini/package.lisp: The cl-ini/package․lisp file

L
Lisp File, cl-ini.asd: The cl-ini․asd file
Lisp File, cl-ini/cl-ini.lisp: The cl-ini/cl-ini․lisp file
Lisp File, cl-ini/package.lisp: The cl-ini/package․lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   A   C   F   I   P   R   S   T  
Index Entry  Section

A
agetf: Internal functions

C
comment-p: Internal functions

F
Function, agetf: Internal functions
Function, comment-p: Internal functions
Function, ini-value: Exported functions
Function, parse-ini: Exported functions
Function, parse-keypair: Internal functions
Function, parse-section-header: Internal functions
Function, parse-value: Internal functions
Function, read-file: Internal functions
Function, section-header-p: Internal functions
Function, should-remove-p: Internal functions
Function, to-keyword: Internal functions

I
ini-value: Exported functions

P
parse-ini: Exported functions
parse-keypair: Internal functions
parse-section-header: Internal functions
parse-value: Internal functions

R
read-file: Internal functions

S
section-header-p: Internal functions
should-remove-p: Internal functions

T
to-keyword: Internal functions

Jump to:   A   C   F   I   P   R   S   T  

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

A.3 Variables


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

A.4 Data types

Jump to:   C   P   S  
Index Entry  Section

C
cl-ini: The cl-ini system
cl-ini: The cl-ini package

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

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

Jump to:   C   P   S