This is the utility-arguments Reference Manual, version 0.161029, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 08:01:06 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
utility-argumentsUtility to handle command-line arguments.
Frank A. U.
ICS
0.161029
alexandria (system).
packages.lisp (file).
utils.lisp (file).
error.lisp (file).
option.lisp (file).
parser.lisp (file).
operand.lisp (file).
usage.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
utility-arguments/utility-arguments.asdutility-arguments/packages.lisputility-arguments/utils.lisputility-arguments/error.lisputility-arguments/option.lisputility-arguments/parser.lisputility-arguments/operand.lisputility-arguments/usage.lisputility-arguments/utility-arguments.asdutility-arguments (system).
utility-arguments/utils.lisppackages.lisp (file).
utility-arguments (system).
allow-other-keys-lambda? (function).
blank? (function).
lambda-arity (function).
lambda-key-parameters (function).
lambda-variables (function).
normalize-space (function).
plist-keys (function).
plist-keys-if (function).
separate (function).
split-at (function).
trim-space (function).
utility-arguments/error.lisputils.lisp (file).
utility-arguments (system).
conflicting-usages (reader method).
no-such-usage (function).
no-such-usage (condition).
usage-conflict (function).
usage-conflict (condition).
usage-error (condition).
utility-argument-error (function).
utility-argument-error (condition).
utility-arguments (reader method).
excessive-option-arguments (function).
invalid-operand-argument (function).
invalid-option-argument (function).
missing-option-argument (function).
no-such-option (function).
syntax-error (function).
utility-argument-error-text (reader method).
utility-arguments/option.lisperror.lisp (file).
utility-arguments (system).
find-option (generic function).
initialize-instance (method).
make-option-flag (function).
make-option-with-argument (function).
make-option-with-optional-argument (function).
make-option-with-optional-sequence (function).
make-option-with-sequence (function).
option (class).
option-flag (class).
option-with-argument (class).
option-with-optional-argument (class).
option-with-optional-sequence (class).
option-with-sequence (class).
parse-option-argument (function).
utility-arguments/parser.lispoption.lisp (file).
utility-arguments (system).
*separator* (special variable).
csv (function).
end-of-options? (function).
long-option? (function).
parse-long-spec (function).
parse-option (generic function).
parse-short-spec (function).
parse-utility-arguments (function).
short-option? (function).
split-long-spec (function).
utility-arguments/operand.lispparser.lisp (file).
utility-arguments (system).
find-operand (function).
initialize-instance (method).
make-operand (function).
operand (class).
parse-operand-argument (function).
utility-arguments/usage.lispoperand.lisp (file).
utility-arguments (system).
apply-usage (function).
defusage (macro).
complete-usage (function).
find-all-usages (function).
operand-lambda-list (function).
option-lambda-list (function).
parse-operands (function).
Packages are listed by definition order.
utility-argumentsalexandria.
common-lisp.
*separator* (special variable).
apply-usage (function).
conflicting-usages (generic reader).
defusage (macro).
find-operand (function).
find-option (generic function).
make-operand (function).
make-option-flag (function).
make-option-with-argument (function).
make-option-with-optional-argument (function).
make-option-with-optional-sequence (function).
make-option-with-sequence (function).
no-such-usage (function).
no-such-usage (condition).
usage-conflict (function).
usage-conflict (condition).
usage-error (condition).
utility-argument-error (function).
utility-argument-error (condition).
utility-arguments (generic reader).
allow-other-keys-lambda? (function).
blank? (function).
complete-usage (function).
csv (function).
end-of-options? (function).
excessive-option-arguments (function).
find-all-usages (function).
invalid-operand-argument (function).
invalid-option-argument (function).
lambda-arity (function).
lambda-key-parameters (function).
lambda-variables (function).
long-option? (function).
missing-option-argument (function).
no-such-option (function).
normalize-space (function).
operand (class).
operand-lambda-list (function).
option (class).
option-flag (class).
option-lambda-list (function).
option-with-argument (class).
option-with-optional-argument (class).
option-with-optional-sequence (class).
option-with-sequence (class).
parse-long-spec (function).
parse-operand-argument (function).
parse-operands (function).
parse-option (generic function).
parse-option-argument (function).
parse-short-spec (function).
parse-utility-arguments (function).
plist-keys (function).
plist-keys-if (function).
separate (function).
short-option? (function).
split-at (function).
split-long-spec (function).
syntax-error (function).
trim-space (function).
utility-argument-error-text (generic reader).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Character that separates the arguments in a sequence. Setting it to nil, disables separation.
Define a new usage for operands and options.
NAME is a symbol and denotes the name of the usage.
OPERAND-LAMBDA-LIST describes operands. It resembles a lambda list
with required, optional, or rest parameter specifiers as the only
elements allowed. The parameters receive the operands’ values.
OPTION-LAMBDA-LIST describes options. It resembles a lambda list with
keyword and rest parameter specifiers as the only elements allowed.
The parameters receive the options’ values.
Optional and keyword parameter that specify an init-form make it
optional in this usage.
The forms of BODY are executed when the usage is applied.
Apply a usage to utility arguments.
USAGES is a list of symbols naming usages defined with defusage.
The lists OPERANDS and OPTIONS hold objects that complement the
parameters on usage lambda lists in providing additional type and
syntactic information. Correlation is established by object key and
parameter name.
UTILITY-ARGUMENTS is a list of strings that is parsed into operands
and options. The operand and options are matched against the usage
lambda lists to find a suitable usage which is then applied to the
operand’s and option’s values.
An error condition of utility-argument-error, no-such-usage, or usage-conflict may be signaled.
Find operand identifiable by KEY.
KEY is a symbol. OPERANDS is a list of operand objects.
Make a new operand.
KEY is a symbol that correlates the operand with a positional
parameter on a usage lambda list.
The parameter TYPE is documented in make-option-with-argument.
Make a new option flag.
Its number of appearances on a utility argument list is the assumed
value.
The parameters KEY, SHORT, and LONG are documented in make-option-with-argument.
Make a new option that receives one argument.
KEY is a symbol that correlates the option with a keyword parameter on
a usage lambda list.
SHORT is a case-sensitive character. LONG is a case-insensitive but
case-preserving string. Both designators are equivalent and request
the option on a utility argument list. At least one of the two must
be specified.
TYPE is a Lisp type specifier the object must conform to the Lisp
reader builds from the received argument. The built object becomes
the assumed value.
TYPE is a function of two string arguments: the first of which is the received argument for the option, and the second the designator that requested the option. The object returned becomes the assumed value.
TYPE is nil, the received argument is the assumed value.
Make a new option that optionally receives one argument.
If the option doesn’t receive an argument, nil is assumed.
The parameters KEY, SHORT, LONG, and TYPE are documented in make-option-with-argument.
Make a new option that optionally receives a sequence of arguments.
If the option doesn’t receive an argument, nil is assumed. See also
make-option-with-sequence.
The parameters KEY, SHORT, LONG, and TYPE are documented in make-option-with-argument.
Make a new option that receives a sequence of arguments.
Multiple arguments in a sequence are separated from each other by the
separator registered with *separator*.
Received arguments are subject to type parsing as described in
make-option-with-argument. The assumed values are collected into a
list by order of utility arguments.
The parameters KEY, SHORT, LONG, and TYPE are documented in make-option-with-argument.
usage-conflict)) ¶Find option identifiable by ITEM.
ITEM is either a symbol, character, or a string. OPTIONS is a list of option objects.
no-such-usage)) ¶Condition signaled if no suitable usage was found.
:utility-arguments
This slot is read-only.
Condition signaled if more than one suitable usage was found.
:usages
This slot is read-only.
Condition signaled for usage related errors.
error.
Condition signaled for utility argument related errors, such as bad syntax, unknown options, or type errors.
error.
:text
This slot is read-only.
option-with-optional-sequence) designator plist utility-arguments argument) ¶option-with-sequence) designator plist utility-arguments argument) ¶option-with-optional-argument) designator plist utility-arguments argument) ¶option-with-argument) designator plist utility-arguments argument) ¶option-flag) designator plist utility-arguments argument) ¶utility-argument-error)) ¶text.
| Jump to: | A B C D E F G I L M N O P S T U |
|---|
| Jump to: | A B C D E F G I L M N O P S T U |
|---|
| Jump to: | *
K L S T U |
|---|
| Jump to: | *
K L S T U |
|---|
| Jump to: | C E F N O P S U |
|---|
| Jump to: | C E F N O P S U |
|---|