The adopt Reference Manual

Table of Contents

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

The adopt Reference Manual

This is the adopt Reference Manual, version 1.0.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 14:26:49 2019 GMT+0.


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

1 Introduction

Adopt

I needed a damn option parsing library.

Adopt is a simple UNIX-style option parser in Common Lisp, heavily influenced by Python's optparse and argparse.

Adopt aims to be a simple, robust option parser. It can automatically print help information and even generate man pages for you.

Adopt is compatible with Quicklisp, but not in Quicklisp (yet). You can clone the repository into your Quicklisp local-projects directory for now.

The adopt system contains the core API and depends on Bobbin and split-sequence.

The adopt/test system contains the test suite, which depends on some other systems. You don't need to load this unless you want to run the unit tests. The tests pass on SBCL, CCL, ECL, and ABCL on Ubuntu 18.04. Further testing is welcome.


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 adopt

Author

Steve Losh <steve@stevelosh.com>

Home Page

https://sjl.bitbucket.io/adopt/

License

MIT

Description

Simple, flexible, UNIX-style option parsing.

Version

1.0.0

Dependencies
Source

adopt.asd (file)

Component

src (module)


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

3 Modules

Modules are listed depth-first from the system components tree.


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

3.1 adopt/src

Parent

adopt (system)

Location

src/

Components

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

4 Files

Files are sorted by type and then listed depth-first from the systems components trees.


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

4.1 Lisp


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

4.1.1 adopt.asd

Location

adopt.asd

Systems

adopt (system)


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

4.1.2 adopt/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

adopt


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

4.1.3 adopt/src/main.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/main.lisp

Exported Definitions
Internal Definitions

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

5 Packages

Packages are listed by definition order.


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

5.1 adopt

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

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

6 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


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

6.1 Exported definitions


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

6.1.1 Macros

Macro: define-string VAR STRING &rest ARGS

Convenience macro for ‘(defparameter ,var (format nil ,string ,@args))‘.

Package

adopt

Source

main.lisp (file)


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

6.1.2 Functions

Function: argv ()

Return a list of the program name and command line arguments.

This is not implemented for every Common Lisp implementation. You can pass your own values to ‘parse-options‘ and ‘print-help‘ if it’s not implemented for your particular Lisp.

Package

adopt

Source

main.lisp (file)

Function: collect LIST EL

Append element ‘el‘ to the end of ‘list‘.

It is useful as a ‘:reduce‘ function when you want to collect all values given for an option.

This is implemented as ‘(append list (list el))‘. It is not particularly fast. If you can live with reversed output consider ‘(flip #’cons)‘ instead.

Package

adopt

Source

main.lisp (file)

Function: discard-option CONDITION

Invoke the ‘discard-option‘ restart properly.

Example:

(handler-bind ((unrecognized-option ’discard-option)) (multiple-value-bind (arguments options) (parse-options *ui*) (run arguments options)))

Package

adopt

Source

main.lisp (file)

Function: exit &optional CODE

Exit the program with status ‘code‘.

This is not implemented for every Common Lisp implementation. You can write your own version of it and pass it to ‘print-help-and-exit‘ and ‘print-error-and-exit‘ if it’s not implemented for your particular Lisp.

Package

adopt

Source

main.lisp (file)

Function: first OLD NEW

Return ‘new‘ if ‘old‘ is ‘nil‘, otherwise return ‘old‘.

It is useful as a ‘:reduce‘ function when you want to just keep the first-given value for an option.

Package

adopt

Source

main.lisp (file)

Function: flip FUNCTION

Return a function of two arguments X and Y that calls ‘function‘ with Y and X.

Useful for wrapping existing functions that expect their arguments in the opposite order.

Examples:

(funcall #’cons 1 2) ; => (1 . 2)
(funcall (flip #’cons) 1 2) ; => (2 . 1)
(reduce (flip #’cons) ’(1 2 3) :initial-value nil)
; => (3 2 1)

Package

adopt

Source

main.lisp (file)

Function: last OLD NEW

Return ‘new‘.

It is useful as a ‘:reduce‘ function when you want to just keep the last-given value for an option.

Package

adopt

Source

main.lisp (file)

Function: make-group NAME &key TITLE HELP MANUAL OPTIONS

Create and return an option group, suitable for use in an interface.

This function takes a number of arguments that define how the group is
presented to the user:

* ‘name‘ (**required**): a symbol naming the group.
* ‘title‘ (optional): a title for the group for use in the help text.
* ‘help‘ (optional): a short summary of this group of options for use in the help text. * ‘manual‘ (optional): used in place of ‘help‘ when rendering a man page.
* ‘options‘ (**required**): the options to include in the group.

See the full documentation for more information.

Package

adopt

Source

main.lisp (file)

Function: make-interface &key NAME SUMMARY USAGE HELP MANUAL EXAMPLES CONTENTS

Create and return a command line interface.

This function takes a number of arguments that define how the interface is
presented to the user:

* ‘name‘ (**required**): a symbol naming the interface.
* ‘summary‘ (**required**): a string of a concise, one-line summary of what the program does.
* ‘usage‘ (**required**): a string of a UNIX-style usage summary, e.g. ‘"[OPTIONS] PATTERN [FILE...]"‘.
* ‘help‘ (**required**): a string of a longer description of the program.
* ‘manual‘ (optional): a string to use in place of ‘help‘ when rendering a man page.
* ‘examples‘ (optional): an alist of ‘(prose . command)‘ conses to render as a list of examples.
* ‘contents‘ (optional): a list of options and groups. Ungrouped options will be collected into a single top-level group.

See the full documentation for more information.

Package

adopt

Source

main.lisp (file)

Function: make-option NAME &key LONG SHORT HELP MANUAL PARAMETER REDUCE INITIAL-VALUE RESULT-KEY KEY FINALLY

Create and return an option, suitable for use in an interface.

This function takes a number of arguments, some required, that define how the
option interacts with the user.

* ‘name‘ (**required**): a symbol naming the option.
* ‘help‘ (**required**): a short string describing what the option does.
* ‘result-key‘ (optional): a symbol to use as the key for this option in the hash table of results.
* ‘long‘ (optional): a string for the long form of the option (e.g. ‘–foo‘).
* ‘short‘ (optional): a character for the short form of the option (e.g. ‘-f‘). At least one of ‘short‘ and ‘long‘ must be given.
* ‘manual‘ (optional): a string to use in place of ‘help‘ when rendering a man page.
* ‘parameter‘ (optional): a string. If given, it will turn this option into a parameter-taking option (e.g. ‘–foo=bar‘) and will be used as a placeholder
in the help text.
* ‘reduce‘ (**required**): a function designator that will be called every time the option is specified by the user.
* ‘initial-value‘ (optional): a value to use as the initial value of the option.
* ‘key‘ (optional): a function designator, only allowed for parameter-taking options, to be called on the values given by the user before they are passed along to the reducing function. It will not be called on the initial value. * ‘finally‘ (optional): a function designator to be called on the final result after all parsing is complete.

The manner in which the reducer is called depends on whether the option takes a parameter:

* For options that don’t take parameters, it will be called with the old value.
* For options that take parameters, it will be called with the old value and the value given by the user.

See the full documentation for more information.

Package

adopt

Source

main.lisp (file)

Function: parse-options INTERFACE &optional ARGUMENTS

Parse ‘arguments‘ according to ‘interface‘.

Two values are returned:

1. A fresh list of top-level, unaccounted-for arguments that don’t correspond to any options defined in ‘interface‘.
2. An ‘EQL‘ hash table of option keys to values.

See the full documentation for more information.

Package

adopt

Source

main.lisp (file)

Function: print-error-and-exit ERROR &key STREAM EXIT-FUNCTION EXIT-CODE PREFIX

Print ‘prefix‘ and ‘error‘ to ‘stream‘ and exit.

Example:

(handler-case
(multiple-value-bind (arguments options) (parse-options *ui*) (run arguments options))
(unrecognized-option (c)
(print-error-and-exit c)))

Package

adopt

Source

main.lisp (file)

Function: print-help INTERFACE &key STREAM PROGRAM-NAME WIDTH OPTION-WIDTH INCLUDE-EXAMPLES

Print a pretty help document for ‘interface‘ to ‘stream‘.

‘width‘ should be the total width (in characters) for line-wrapping purposes. Care will be taken to ensure lines are no longer than this, though some edge cases (extremely long short/long option names and parameters) may slip through.

‘option-width‘ should be the width of the column of short/long options (in characters). If the short/long option help is shorter than this, the option’s help string will start on the same line. Otherwise the option’s help string will start on the next line.

The result will look something like:

(print-help *program-interface* :width 60 :option-width 15)
; =>
; foo - do some things and meow
;
; USAGE: /bin/foo [options] FILES
;
; Foo is a program to frobulate some files, meowing as it
; happens.
;
; Options:
; -v, –verbose Output extra information.
; -q, –quiet Shut up.
; –ignore FILE Ignore FILE. May be specified multiple
; times.
; -n NAME, –name NAME
; Your name. May be specified many times,
; last one wins.
; -m, –meow Meow.
; 0.........1.... option-width
; 0........1.........2.........3.........4.........5.........6

Package

adopt

Source

main.lisp (file)

Function: print-help-and-exit INTERFACE &key STREAM PROGRAM-NAME WIDTH OPTION-WIDTH INCLUDE-EXAMPLES EXIT-FUNCTION EXIT-CODE

Print a pretty help document for ‘interface‘ to ‘stream‘ and exit.

Handy for easily providing –help:

(multiple-value-bind (arguments options) (parse-options *ui*) (when (gethash ’help options)
(print-help-and-exit *ui*))
(run arguments options))

Package

adopt

Source

main.lisp (file)

Function: print-manual INTERFACE &key STREAM MANUAL-SECTION

Print a troff-formatted man page for ‘interface‘ to ‘stream‘.

Example:

(with-open-file (manual "man/man1/foo.1"
:direction :output
:if-exists :supersede) (print-manual *ui* manual))

Package

adopt

Source

main.lisp (file)

Function: supply-new-value CONDITION VALUE

Invoke the ‘supply-new-value‘ restart properly.

Example:

(handler-bind
((unrecognized-option (alexandria:rcurry ’supply-new-value "–foo")) (multiple-value-bind (arguments options) (parse-options *ui*)
(run arguments options)))

Package

adopt

Source

main.lisp (file)

Function: treat-as-argument CONDITION

Invoke the ‘treat-as-argument‘ restart properly.

Example:

(handler-bind ((unrecognized-option ’treat-as-argument)) (multiple-value-bind (arguments options) (parse-options *ui*) (run arguments options)))

Package

adopt

Source

main.lisp (file)


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

6.1.3 Generic functions

Generic Function: problematic-option CONDITION
Generic Function: (setf problematic-option) NEW-VALUE CONDITION
Package

adopt

Methods
Method: problematic-option (CONDITION unrecognized-option)
Method: (setf problematic-option) NEW-VALUE (CONDITION unrecognized-option)
Source

main.lisp (file)


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

6.1.4 Conditions

Condition: unrecognized-option ()
Package

adopt

Source

main.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: problematic-option
Initargs

:problematic-option

Readers

problematic-option (generic function)

Writers

(setf problematic-option) (generic function)


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

6.2 Internal definitions


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

6.2.1 Macros

Macro: check-types &rest PLACE-TYPE-PAIRS
Package

adopt

Source

main.lisp (file)

Macro: defclass* NAME &rest SLOTS
Package

adopt

Source

main.lisp (file)

Macro: funcallf PLACE FUNCTION
Package

adopt

Source

main.lisp (file)


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

6.2.2 Functions

Function: escape STRING
Package

adopt

Source

main.lisp (file)

Function: finalize-results INTERFACE RESULTS
Package

adopt

Source

main.lisp (file)

Function: funcall% VALUE FUNCTION
Package

adopt

Source

main.lisp (file)

Function: groupp OBJECT
Package

adopt

Source

main.lisp (file)

Function: initialize-results INTERFACE RESULTS
Package

adopt

Source

main.lisp (file)

Function: longp ARG
Package

adopt

Source

main.lisp (file)

Function: make-default-group OPTIONS
Package

adopt

Source

main.lisp (file)

Function: option-string OPTION
Package

adopt

Source

main.lisp (file)

Function: option-troff OPTION
Package

adopt

Source

main.lisp (file)

Function: optionp OBJECT
Package

adopt

Source

main.lisp (file)

Function: parse-long INTERFACE RESULTS ARG REMAINING
Package

adopt

Source

main.lisp (file)

Function: parse-short INTERFACE RESULTS ARG REMAINING
Package

adopt

Source

main.lisp (file)

Function: print-option-help STREAM OPTION OPTION-COLUMN DOC-COLUMN DOC-WIDTH

Print ‘option‘’s help to ‘stream‘, indented/wrapped properly.

Assumes the last thing printed to ‘stream‘ was a newline.

The option string will start at ‘option-column‘. The help will start at ‘doc-column‘ and be line-wrapped to ‘doc-width‘.

Package

adopt

Source

main.lisp (file)

Function: shortp ARG
Package

adopt

Source

main.lisp (file)

Function: split-paragraphs STRING &key DELIMITER ESCAPE
Package

adopt

Source

main.lisp (file)

Function: terminatorp ARG
Package

adopt

Source

main.lisp (file)

Function: unrecognized-option-p VALUE
Package

adopt

Source

main.lisp (file)


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

6.2.3 Generic functions

Generic Function: examples OBJECT
Generic Function: (setf examples) NEW-VALUE OBJECT
Package

adopt

Methods
Method: examples (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf examples) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Generic Function: finally OBJECT
Generic Function: (setf finally) NEW-VALUE OBJECT
Package

adopt

Methods
Method: finally (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf finally) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: groups OBJECT
Generic Function: (setf groups) NEW-VALUE OBJECT
Package

adopt

Methods
Method: groups (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf groups) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Generic Function: help OBJECT
Generic Function: (setf help) NEW-VALUE OBJECT
Package

adopt

Methods
Method: help (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf help) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Method: help (GROUP group)

automatically generated reader method

Source

main.lisp (file)

Method: (setf help) NEW-VALUE (GROUP group)

automatically generated writer method

Source

main.lisp (file)

Method: help (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf help) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: initial-value OBJECT
Generic Function: (setf initial-value) NEW-VALUE OBJECT
Package

adopt

Methods
Method: initial-value (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf initial-value) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: key OBJECT
Generic Function: (setf key) NEW-VALUE OBJECT
Package

adopt

Methods
Method: key (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf key) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: long OBJECT
Generic Function: (setf long) NEW-VALUE OBJECT
Package

adopt

Methods
Method: long (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf long) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: long-options OBJECT
Generic Function: (setf long-options) NEW-VALUE OBJECT
Package

adopt

Methods
Method: long-options (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf long-options) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Generic Function: manual OBJECT
Generic Function: (setf manual) NEW-VALUE OBJECT
Package

adopt

Methods
Method: manual (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf manual) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Method: manual (GROUP group)

automatically generated reader method

Source

main.lisp (file)

Method: (setf manual) NEW-VALUE (GROUP group)

automatically generated writer method

Source

main.lisp (file)

Method: manual (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf manual) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: name OBJECT
Generic Function: (setf name) NEW-VALUE OBJECT
Package

adopt

Methods
Method: name (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf name) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Method: name (GROUP group)

automatically generated reader method

Source

main.lisp (file)

Method: (setf name) NEW-VALUE (GROUP group)

automatically generated writer method

Source

main.lisp (file)

Method: name (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf name) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: options OBJECT
Generic Function: (setf options) NEW-VALUE OBJECT
Package

adopt

Methods
Method: options (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf options) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Method: options (GROUP group)

automatically generated reader method

Source

main.lisp (file)

Method: (setf options) NEW-VALUE (GROUP group)

automatically generated writer method

Source

main.lisp (file)

Generic Function: parameter OBJECT
Generic Function: (setf parameter) NEW-VALUE OBJECT
Package

adopt

Methods
Method: parameter (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf parameter) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: reduce OBJECT
Generic Function: (setf reduce) NEW-VALUE OBJECT
Package

adopt

Methods
Method: reduce (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf reduce) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: result-key OBJECT
Generic Function: (setf result-key) NEW-VALUE OBJECT
Package

adopt

Methods
Method: result-key (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf result-key) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: short OBJECT
Generic Function: (setf short) NEW-VALUE OBJECT
Package

adopt

Methods
Method: short (OPTION option)

automatically generated reader method

Source

main.lisp (file)

Method: (setf short) NEW-VALUE (OPTION option)

automatically generated writer method

Source

main.lisp (file)

Generic Function: short-options OBJECT
Generic Function: (setf short-options) NEW-VALUE OBJECT
Package

adopt

Methods
Method: short-options (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf short-options) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Generic Function: summary OBJECT
Generic Function: (setf summary) NEW-VALUE OBJECT
Package

adopt

Methods
Method: summary (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf summary) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)

Generic Function: title OBJECT
Generic Function: (setf title) NEW-VALUE OBJECT
Package

adopt

Methods
Method: title (GROUP group)

automatically generated reader method

Source

main.lisp (file)

Method: (setf title) NEW-VALUE (GROUP group)

automatically generated writer method

Source

main.lisp (file)

Generic Function: usage OBJECT
Generic Function: (setf usage) NEW-VALUE OBJECT
Package

adopt

Methods
Method: usage (INTERFACE interface)

automatically generated reader method

Source

main.lisp (file)

Method: (setf usage) NEW-VALUE (INTERFACE interface)

automatically generated writer method

Source

main.lisp (file)


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

6.2.4 Classes

Class: group ()
Package

adopt

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • options (method)
  • options (method)
  • manual (method)
  • manual (method)
  • help (method)
  • help (method)
  • title (method)
  • title (method)
  • name (method)
  • name (method)
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: title
Initargs

:title

Readers

title (generic function)

Writers

(setf title) (generic function)

Slot: help
Initargs

:help

Readers

help (generic function)

Writers

(setf help) (generic function)

Slot: manual
Initargs

:manual

Readers

manual (generic function)

Writers

(setf manual) (generic function)

Slot: options
Initargs

:options

Readers

options (generic function)

Writers

(setf options) (generic function)

Class: interface ()
Package

adopt

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • manual (method)
  • manual (method)
  • help (method)
  • help (method)
  • usage (method)
  • usage (method)
  • long-options (method)
  • long-options (method)
  • short-options (method)
  • short-options (method)
  • groups (method)
  • groups (method)
  • options (method)
  • options (method)
  • examples (method)
  • examples (method)
  • summary (method)
  • summary (method)
  • name (method)
  • name (method)
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: summary
Initargs

:summary

Readers

summary (generic function)

Writers

(setf summary) (generic function)

Slot: examples
Initargs

:examples

Readers

examples (generic function)

Writers

(setf examples) (generic function)

Slot: options
Initargs

:options

Readers

options (generic function)

Writers

(setf options) (generic function)

Slot: groups
Initargs

:groups

Readers

groups (generic function)

Writers

(setf groups) (generic function)

Slot: short-options
Initargs

:short-options

Readers

short-options (generic function)

Writers

(setf short-options) (generic function)

Slot: long-options
Initargs

:long-options

Readers

long-options (generic function)

Writers

(setf long-options) (generic function)

Slot: usage
Initargs

:usage

Readers

usage (generic function)

Writers

(setf usage) (generic function)

Slot: help
Initargs

:help

Readers

help (generic function)

Writers

(setf help) (generic function)

Slot: manual
Initargs

:manual

Readers

manual (generic function)

Writers

(setf manual) (generic function)

Class: option ()
Package

adopt

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • print-object (method)
  • reduce (method)
  • reduce (method)
  • finally (method)
  • finally (method)
  • key (method)
  • key (method)
  • initial-value (method)
  • initial-value (method)
  • parameter (method)
  • parameter (method)
  • long (method)
  • long (method)
  • short (method)
  • short (method)
  • manual (method)
  • manual (method)
  • help (method)
  • help (method)
  • result-key (method)
  • result-key (method)
  • name (method)
  • name (method)
Direct slots
Slot: name
Initargs

:name

Readers

name (generic function)

Writers

(setf name) (generic function)

Slot: result-key
Initargs

:result-key

Readers

result-key (generic function)

Writers

(setf result-key) (generic function)

Slot: help
Initargs

:help

Readers

help (generic function)

Writers

(setf help) (generic function)

Slot: manual
Initargs

:manual

Readers

manual (generic function)

Writers

(setf manual) (generic function)

Slot: short
Initargs

:short

Readers

short (generic function)

Writers

(setf short) (generic function)

Slot: long
Initargs

:long

Readers

long (generic function)

Writers

(setf long) (generic function)

Slot: parameter
Initargs

:parameter

Readers

parameter (generic function)

Writers

(setf parameter) (generic function)

Slot: initial-value
Initargs

:initial-value

Readers

initial-value (generic function)

Writers

(setf initial-value) (generic function)

Slot: key
Initargs

:key

Readers

key (generic function)

Writers

(setf key) (generic function)

Slot: finally
Initargs

:finally

Readers

finally (generic function)

Writers

(setf finally) (generic function)

Slot: reduce
Initargs

:reduce

Readers

reduce (generic function)

Writers

(setf reduce) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   A   F   L   M  
Index Entry  Section

A
adopt.asd: The adopt<dot>asd file
adopt/src: The adopt/src module
adopt/src/main.lisp: The adopt/src/main<dot>lisp file
adopt/src/package.lisp: The adopt/src/package<dot>lisp file

F
File, Lisp, adopt.asd: The adopt<dot>asd file
File, Lisp, adopt/src/main.lisp: The adopt/src/main<dot>lisp file
File, Lisp, adopt/src/package.lisp: The adopt/src/package<dot>lisp file

L
Lisp File, adopt.asd: The adopt<dot>asd file
Lisp File, adopt/src/main.lisp: The adopt/src/main<dot>lisp file
Lisp File, adopt/src/package.lisp: The adopt/src/package<dot>lisp file

M
Module, adopt/src: The adopt/src module

Jump to:   A   F   L   M  

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

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U  
Index Entry  Section

(
(setf examples): Internal generic functions
(setf examples): Internal generic functions
(setf finally): Internal generic functions
(setf finally): Internal generic functions
(setf groups): Internal generic functions
(setf groups): Internal generic functions
(setf help): Internal generic functions
(setf help): Internal generic functions
(setf help): Internal generic functions
(setf help): Internal generic functions
(setf initial-value): Internal generic functions
(setf initial-value): Internal generic functions
(setf key): Internal generic functions
(setf key): Internal generic functions
(setf long): Internal generic functions
(setf long): Internal generic functions
(setf long-options): Internal generic functions
(setf long-options): Internal generic functions
(setf manual): Internal generic functions
(setf manual): Internal generic functions
(setf manual): Internal generic functions
(setf manual): Internal generic functions
(setf name): Internal generic functions
(setf name): Internal generic functions
(setf name): Internal generic functions
(setf name): Internal generic functions
(setf options): Internal generic functions
(setf options): Internal generic functions
(setf options): Internal generic functions
(setf parameter): Internal generic functions
(setf parameter): Internal generic functions
(setf problematic-option): Exported generic functions
(setf problematic-option): Exported generic functions
(setf reduce): Internal generic functions
(setf reduce): Internal generic functions
(setf result-key): Internal generic functions
(setf result-key): Internal generic functions
(setf short): Internal generic functions
(setf short): Internal generic functions
(setf short-options): Internal generic functions
(setf short-options): Internal generic functions
(setf summary): Internal generic functions
(setf summary): Internal generic functions
(setf title): Internal generic functions
(setf title): Internal generic functions
(setf usage): Internal generic functions
(setf usage): Internal generic functions

A
argv: Exported functions

C
check-types: Internal macros
collect: Exported functions

D
defclass*: Internal macros
define-string: Exported macros
discard-option: Exported functions

E
escape: Internal functions
examples: Internal generic functions
examples: Internal generic functions
exit: Exported functions

F
finalize-results: Internal functions
finally: Internal generic functions
finally: Internal generic functions
first: Exported functions
flip: Exported functions
funcall%: Internal functions
funcallf: Internal macros
Function, argv: Exported functions
Function, collect: Exported functions
Function, discard-option: Exported functions
Function, escape: Internal functions
Function, exit: Exported functions
Function, finalize-results: Internal functions
Function, first: Exported functions
Function, flip: Exported functions
Function, funcall%: Internal functions
Function, groupp: Internal functions
Function, initialize-results: Internal functions
Function, last: Exported functions
Function, longp: Internal functions
Function, make-default-group: Internal functions
Function, make-group: Exported functions
Function, make-interface: Exported functions
Function, make-option: Exported functions
Function, option-string: Internal functions
Function, option-troff: Internal functions
Function, optionp: Internal functions
Function, parse-long: Internal functions
Function, parse-options: Exported functions
Function, parse-short: Internal functions
Function, print-error-and-exit: Exported functions
Function, print-help: Exported functions
Function, print-help-and-exit: Exported functions
Function, print-manual: Exported functions
Function, print-option-help: Internal functions
Function, shortp: Internal functions
Function, split-paragraphs: Internal functions
Function, supply-new-value: Exported functions
Function, terminatorp: Internal functions
Function, treat-as-argument: Exported functions
Function, unrecognized-option-p: Internal functions

G
Generic Function, (setf examples): Internal generic functions
Generic Function, (setf finally): Internal generic functions
Generic Function, (setf groups): Internal generic functions
Generic Function, (setf help): Internal generic functions
Generic Function, (setf initial-value): Internal generic functions
Generic Function, (setf key): Internal generic functions
Generic Function, (setf long): Internal generic functions
Generic Function, (setf long-options): Internal generic functions
Generic Function, (setf manual): Internal generic functions
Generic Function, (setf name): Internal generic functions
Generic Function, (setf options): Internal generic functions
Generic Function, (setf parameter): Internal generic functions
Generic Function, (setf problematic-option): Exported generic functions
Generic Function, (setf reduce): Internal generic functions
Generic Function, (setf result-key): Internal generic functions
Generic Function, (setf short): Internal generic functions
Generic Function, (setf short-options): Internal generic functions
Generic Function, (setf summary): Internal generic functions
Generic Function, (setf title): Internal generic functions
Generic Function, (setf usage): Internal generic functions
Generic Function, examples: Internal generic functions
Generic Function, finally: Internal generic functions
Generic Function, groups: Internal generic functions
Generic Function, help: Internal generic functions
Generic Function, initial-value: Internal generic functions
Generic Function, key: Internal generic functions
Generic Function, long: Internal generic functions
Generic Function, long-options: Internal generic functions
Generic Function, manual: Internal generic functions
Generic Function, name: Internal generic functions
Generic Function, options: Internal generic functions
Generic Function, parameter: Internal generic functions
Generic Function, problematic-option: Exported generic functions
Generic Function, reduce: Internal generic functions
Generic Function, result-key: Internal generic functions
Generic Function, short: Internal generic functions
Generic Function, short-options: Internal generic functions
Generic Function, summary: Internal generic functions
Generic Function, title: Internal generic functions
Generic Function, usage: Internal generic functions
groupp: Internal functions
groups: Internal generic functions
groups: Internal generic functions

H
help: Internal generic functions
help: Internal generic functions
help: Internal generic functions
help: Internal generic functions

I
initial-value: Internal generic functions
initial-value: Internal generic functions
initialize-results: Internal functions

K
key: Internal generic functions
key: Internal generic functions

L
last: Exported functions
long: Internal generic functions
long: Internal generic functions
long-options: Internal generic functions
long-options: Internal generic functions
longp: Internal functions

M
Macro, check-types: Internal macros
Macro, defclass*: Internal macros
Macro, define-string: Exported macros
Macro, funcallf: Internal macros
make-default-group: Internal functions
make-group: Exported functions
make-interface: Exported functions
make-option: Exported functions
manual: Internal generic functions
manual: Internal generic functions
manual: Internal generic functions
manual: Internal generic functions
Method, (setf examples): Internal generic functions
Method, (setf finally): Internal generic functions
Method, (setf groups): Internal generic functions
Method, (setf help): Internal generic functions
Method, (setf help): Internal generic functions
Method, (setf help): Internal generic functions
Method, (setf initial-value): Internal generic functions
Method, (setf key): Internal generic functions
Method, (setf long): Internal generic functions
Method, (setf long-options): Internal generic functions
Method, (setf manual): Internal generic functions
Method, (setf manual): Internal generic functions
Method, (setf manual): Internal generic functions
Method, (setf name): Internal generic functions
Method, (setf name): Internal generic functions
Method, (setf name): Internal generic functions
Method, (setf options): Internal generic functions
Method, (setf options): Internal generic functions
Method, (setf parameter): Internal generic functions
Method, (setf problematic-option): Exported generic functions
Method, (setf reduce): Internal generic functions
Method, (setf result-key): Internal generic functions
Method, (setf short): Internal generic functions
Method, (setf short-options): Internal generic functions
Method, (setf summary): Internal generic functions
Method, (setf title): Internal generic functions
Method, (setf usage): Internal generic functions
Method, examples: Internal generic functions
Method, finally: Internal generic functions
Method, groups: Internal generic functions
Method, help: Internal generic functions
Method, help: Internal generic functions
Method, help: Internal generic functions
Method, initial-value: Internal generic functions
Method, key: Internal generic functions
Method, long: Internal generic functions
Method, long-options: Internal generic functions
Method, manual: Internal generic functions
Method, manual: Internal generic functions
Method, manual: Internal generic functions
Method, name: Internal generic functions
Method, name: Internal generic functions
Method, name: Internal generic functions
Method, options: Internal generic functions
Method, options: Internal generic functions
Method, parameter: Internal generic functions
Method, problematic-option: Exported generic functions
Method, reduce: Internal generic functions
Method, result-key: Internal generic functions
Method, short: Internal generic functions
Method, short-options: Internal generic functions
Method, summary: Internal generic functions
Method, title: Internal generic functions
Method, usage: Internal generic functions

N
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions
name: Internal generic functions

O
option-string: Internal functions
option-troff: Internal functions
optionp: Internal functions
options: Internal generic functions
options: Internal generic functions
options: Internal generic functions

P
parameter: Internal generic functions
parameter: Internal generic functions
parse-long: Internal functions
parse-options: Exported functions
parse-short: Internal functions
print-error-and-exit: Exported functions
print-help: Exported functions
print-help-and-exit: Exported functions
print-manual: Exported functions
print-option-help: Internal functions
problematic-option: Exported generic functions
problematic-option: Exported generic functions

R
reduce: Internal generic functions
reduce: Internal generic functions
result-key: Internal generic functions
result-key: Internal generic functions

S
short: Internal generic functions
short: Internal generic functions
short-options: Internal generic functions
short-options: Internal generic functions
shortp: Internal functions
split-paragraphs: Internal functions
summary: Internal generic functions
summary: Internal generic functions
supply-new-value: Exported functions

T
terminatorp: Internal functions
title: Internal generic functions
title: Internal generic functions
treat-as-argument: Exported functions

U
unrecognized-option-p: Internal functions
usage: Internal generic functions
usage: Internal generic functions

Jump to:   (  
A   C   D   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U  

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

A.3 Variables

Jump to:   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U  
Index Entry  Section

E
examples: Internal classes

F
finally: Internal classes

G
groups: Internal classes

H
help: Internal classes
help: Internal classes
help: Internal classes

I
initial-value: Internal classes

K
key: Internal classes

L
long: Internal classes
long-options: Internal classes

M
manual: Internal classes
manual: Internal classes
manual: Internal classes

N
name: Internal classes
name: Internal classes
name: Internal classes

O
options: Internal classes
options: Internal classes

P
parameter: Internal classes
problematic-option: Exported conditions

R
reduce: Internal classes
result-key: Internal classes

S
short: Internal classes
short-options: Internal classes
Slot, examples: Internal classes
Slot, finally: Internal classes
Slot, groups: Internal classes
Slot, help: Internal classes
Slot, help: Internal classes
Slot, help: Internal classes
Slot, initial-value: Internal classes
Slot, key: Internal classes
Slot, long: Internal classes
Slot, long-options: Internal classes
Slot, manual: Internal classes
Slot, manual: Internal classes
Slot, manual: Internal classes
Slot, name: Internal classes
Slot, name: Internal classes
Slot, name: Internal classes
Slot, options: Internal classes
Slot, options: Internal classes
Slot, parameter: Internal classes
Slot, problematic-option: Exported conditions
Slot, reduce: Internal classes
Slot, result-key: Internal classes
Slot, short: Internal classes
Slot, short-options: Internal classes
Slot, summary: Internal classes
Slot, title: Internal classes
Slot, usage: Internal classes
summary: Internal classes

T
title: Internal classes

U
usage: Internal classes

Jump to:   E   F   G   H   I   K   L   M   N   O   P   R   S   T   U  

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

A.4 Data types

Jump to:   A   C   G   I   O   P   S   U  
Index Entry  Section

A
adopt: The adopt system
adopt: The adopt package

C
Class, group: Internal classes
Class, interface: Internal classes
Class, option: Internal classes
Condition, unrecognized-option: Exported conditions

G
group: Internal classes

I
interface: Internal classes

O
option: Internal classes

P
Package, adopt: The adopt package

S
System, adopt: The adopt system

U
unrecognized-option: Exported conditions

Jump to:   A   C   G   I   O   P   S   U