This is the parser.ini Reference Manual, version 0.7.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:31:28 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
parser.iniProvides parsing of Ini expressions.
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
Jan Moringen <jmoringe@techfak.uni-bielefeld.de>
LLGPLv3
0.7.0
alexandria (system).
let-plus (system)., at least version "0.2"
more-conditions (system)., at least version "0.1.0"
esrap (system)., at least version "0.15"
architecture.builder-protocol (system)., at least version "0.1"
parser.common-rules (system)., at least version "0.1"
src (module).
readme.org (file).
examples (module).
Modules are listed depth-first from the system components tree.
parser.ini/srcparser.ini (system).
package.lisp (file).
conditions.lisp (file).
variables.lisp (file).
protocol.lisp (file).
grammar.lisp (file).
parser.ini/examplesparser.ini (system).
etc.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
parser.ini/parser.ini.asdparser.ini/src/package.lispparser.ini/src/conditions.lispparser.ini/src/variables.lispparser.ini/src/protocol.lispparser.ini/src/grammar.lispparser.ini/src/conditions.lisppackage.lisp (file).
src (module).
ini-parse-error (condition).
ini-parse-error-location (reader method).
ini-parse-error-source (reader method).
parser.ini/src/variables.lispconditions.lisp (file).
src (module).
*assignment-operator* (special variable).
*comment-starter* (special variable).
*include-empty-sections?* (special variable).
*name-component-separator* (special variable).
*value-terminating-whitespace-expression* (special variable).
parser.ini/src/protocol.lispvariables.lisp (file).
src (module).
parse (generic function).
parser.ini/src/grammar.lispprotocol.lisp (file).
src (module).
parse-assignment-operator/expression (function).
parse-name-component-separator/expression (function).
Packages are listed by definition order.
parser.iniThis package provides the main entry point
parse SOURCE BUILDER [generic function]
Parse the content of SOURCE as "ini-like" configuration
options, construct a parse result using BUILDER and return it.
The builder protocol consists of
architecture.builder-protocol:make-node BUILDER KIND &rest ARGS [generic function]
Create objects representing sections and options with
KIND :section and :option respectively.
architecture.builder-protocol:relate BUILDER RELATION LEFT RIGHT &rest ARGS [generic function]
Attach options to their containing sections with
relation :section-option.
Parsing may signal
ini-parse-error [condition]
Syntactic variants can be controlled by binding the special
variables
*comment-starter* [special variable]
Controls which character initiates a comment. Defaults to "#".
*assignment-expression* [special variable]
Controls assignment expression. Defaults to "=".
*value-terminating-whitespace-expression* [special variable]
Controls which whitespace terminates option values. By default,
all whitespace terminates option values.
alexandria.
common-lisp.
let-plus.
more-conditions.
parser.common-rules.
*assignment-operator* (special variable).
*comment-starter* (special variable).
*include-empty-sections?* (special variable).
*name-component-separator* (special variable).
*value-terminating-whitespace-expression* (special variable).
ini-parse-error (condition).
ini-parse-error-location (generic reader).
ini-parse-error-source (generic reader).
parse (generic function).
parse-assignment-operator/expression (function).
parse-name-component-separator/expression (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Controls the accepted assignment syntax. The default is the character "=".
Controls which character starts a comment. The default is ##.
If bound to either ## or #;, the respective character turns the
rest of the current line into a comment.
If bound to ‘nil’, comments are disallowed.
Controls whether empty sections, i.e. "section" in
[section]
[next section]
should be included in the parse result.
Controls the syntax for separating name components. The default
is the character ".".
Note the value nil corresponds to "no component separator" which leads to names not being split into components.
Controls which kinds of whitespace terminate option values. The
default is :all which corresponds to any whitespace terminating the
value of an option.
For some values of this variable, quoting has to be used when whitespace in option values is required.
ini-parse-error)) ¶ini-parse-error)) ¶Parse the content of SOURCE as "ini-like" configuration options,
construct a parse result using BUILDER and return it.
START and END can be used to restrict parsing to a sub-sequence of
SOURCE.
JUNK-ALLOWED controls whether an error is signaled when a
successful parse does not consume the entire input in SOURCE (or
the sub-sequence delimited by START and END).
Signal a ‘ini-parse-error’ when errors are encountered.
pathname) builder &key start end junk-allowed) ¶stream) builder &key start end junk-allowed) ¶string) builder &key start end junk-allowed) ¶This error is signaled when parsing ini input fails.
chainable-condition.
parse-error.
| Initarg | Value |
|---|---|
:source | (missing-required-initarg (quote ini-parse-error) source) |
Stores the source string in which the parse error occurred.
:source
This slot is read-only.
Stores the location at which the parse error
occurred. The format is
(START . END)
where END can be nil
(quote nil)
:location
This slot is read-only.
| Jump to: | F G I M P |
|---|
| Jump to: | F G I M P |
|---|
| Jump to: | *
L S |
|---|
| Jump to: | *
L S |
|---|
| Jump to: | C E F G I M P R S V |
|---|
| Jump to: | C E F G I M P R S V |
|---|