-CL-READLINE 0.2.0
+CL-READLINE 0.3.0
CL-READLINE is a simple UFFI-based wrapper for the GNU Readline
library.
and CMUCL. Other platforms and UFFI compatible implementations should
work, but may require tweaking.
- To load:
+ To load:
(asdf:oos 'asdf:load-op 'readline)
- The interface exported by the package READLINE (nicknamed RL).
+ CL-READLINE behaviour can be modified via ~/.inputrc, see GNU
+ Readline documentation for details.
-Functions:
- READLINE &key prompt history
+API
+
+ (exported by "READLINE" package, nicknamed "RL")
- prompt -- a string (default "")
- history -- a boolean (default t)
- Prompt is the prompt displayed to user.
+ ADD-COMPLETION
+
+ Add a completion to the custom completion pool.
+
+
+ ADD-HISTORY string
+
+ Adds the given string to history.
+
+
+ CLEAR-COMPLETIONS
+
+ Empty the custom completion pool.
- History controls whether the string read is added to history, or
- not. Note that history is available in any case. Currently there
- is no way to erase history.
READEXPR &key primary-prompt secondary-prompt history
Primary-prompt controls the prompt of the first line,
secondary prompt the prompt of the rest of the lines.
- ADD-HISTORY string
- Adds the given string to history.
+ READLINE &key prompt history
- USE-FILENAME-COMPLETE
+ prompt -- a string (default "")
+ history -- a boolean (default t)
- Use the Readline's default filename-completion system.
+ Prompt is the prompt displayed to user.
- USE-PACKAGE-COMPLETE name
+ History controls whether the string read is added to history, or
+ not. Note that history is available in any case. Currently there
+ is no way to erase history. Leading and trailing whitespace is trimmed
+ from string before they are added to history, and strings that consist
+ entirely of whitespace are not saved to history.
+
+ Dispite the cleanups performed on history, strings are returned as
+ read.
- Insert symbols in package designated by NAME to the custom
- completion pool, and start using the custom completion system.
USE-CUSTOM-COMPLETE
- Use the custom completion system.
+ Use the custom completion system.
- ADD-COMPLETION
- Add a completion to the custom completion pool.
+ USE-FILENAME-COMPLETE
- CLEAR-COMPLETIONS
+ Use the Readline's default filename-completion system.
- Empty the custom completion pool.
+
+ USE-PACKAGE-COMPLETE name
+
+ Clear current custom completion pool, insert symbols in package
+ designated by NAME to the custom completion pool, and start using
+ the custom completion system.
+
+
+ WITHOUT-ECHO form*
+
+ Runs forms without echoing of input on screen.