Page 251	Table of Contents	Index	Page 253
	Chapters
	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 A, B, C, D, E

CHAPTER 24. INPUT EDITING AND COMPLETION FACILITIES

sensitive) help message and a list of possibilities. The exact global contents of this list is un-
specified, but must include the :possibilities gesture name.

=> complete-input stream function &key partial-completers allow-any-input possibility-printer (help-
displays-possibilities t) [Function]
Reads input from the user from the input editing stream stream, completing over a set of possi-
bilities. complete-input is only required to work on input editing streams, but implementations
may extend it to work on interactive streams as well.

function is a function of two arguments. It is called to generate the completion possibilities that
match the user's input; it has dynamic extent. Usually, programmers will pass either complete- from-possibilitiesor complete-from-generator as the value of function. Its first argument
is a string containing the user's input "so far". Its second argument is the completion mode, one
of the following:

:complete-limited - the function must complete the input up to the next partial delim-
iter. This is the mode used when the user types one of the partial completers.
:complete-maximal - the function must complete the input as much as possible. This is
the mode used when the user issues a gesture that matches any of the gesture names in
*completion-gestures*.
:complete - the function must complete the input as much as possible, except that if the
user's input exactly matches one of the possibilities, even if it is a left substring of another
possibility, the shorter possibility is returned as the result. This is the mode used when
the user issues a delimiter or activation gesture that is not a partial completer.
:possibilities - the function must return an alist of the possible completions as its fifth
value. This is the mode used when the user a gesture that matches any of the gesture
names in *possibilities-gestures* or *help-gestures* (if help-displays-possibilities
is true).

function must return five values:

string - the completed input string.
success - true if completion was successful, otherwise false.
object - the object corresponding to the completion, or nil if the completion was unsuc-
cessful.
nmatches - the number of possible completions of the input.
possibilities - an alist of completions whose entries are a list of a string and an object,
returned only when the completion mode is :possibilities. This list will be freshly
created.

Page 251	Table of Contents	Index	Page 253
	Chapters
	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30 A, B, C, D, E