This is the shlex Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 15:42:50 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
shlexLexical analyzer for simple shell-like syntax.
Paul M. Rodriguez <pmr@ruricolist.com>
MIT
alexandria (system).
serapeum (system).
cl-ppcre (system).
cl-unicode (system).
package.lisp (file).
shlex.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
shlex/shlex.lisppackage.lisp (file).
shlex (system).
do-tokens (macro).
initialize-instance (method).
map-tokens (generic function).
quote (function).
split (function).
base-message (reader method).
(setf base-message) (writer method).
default-commenters (symbol macro).
default-whitespace (symbol macro).
ensure-string-stream (function).
find-sorted (function).
get-token (generic function).
lexer-input (reader method).
lexer-line-number (reader method).
lexer-tokens (function).
make-lexer (compiler macro).
make-lexer (function).
map-lexer-tokens (function).
no-closing-quotation (condition).
no-escaped-character (condition).
non-posix-word-chars (symbol macro).
posix-word-chars (symbol macro).
read-token (generic function).
safe-char-map (symbol macro).
safe-char? (function).
shlex (class).
shlex-error (condition).
string-conc (function).
token (method).
(setf token) (method).
Packages are listed by definition order.
shlexalexandria.
common-lisp.
serapeum.
do-tokens (macro).
map-tokens (generic function).
quote (function).
split (function).
base-message (generic reader).
(setf base-message) (generic writer).
default-commenters (symbol macro).
default-whitespace (symbol macro).
ensure-string-stream (function).
find-sorted (function).
get-token (generic function).
lexer-input (generic reader).
lexer-line-number (generic reader).
lexer-tokens (function).
make-lexer (compiler macro).
make-lexer (function).
map-lexer-tokens (function).
no-closing-quotation (condition).
no-escaped-character (condition).
non-posix-word-chars (symbol macro).
posix-word-chars (symbol macro).
read-token (generic function).
safe-char-map (symbol macro).
safe-char? (function).
shlex (class).
shlex-error (condition).
string-conc (function).
token (generic function).
(setf token) (generic function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Iterate over the tokens of SOURCE, using shell-like rules.
Return a shell-escaped version of string S.
Split SOURCE, a string or stream, into tokens using shell-like rules.
Pass ‘:posix‘ (true by default) to obey POSIX parsing rules.
Pass ‘:punctuation-chars‘ (nil by default) if you want runs of punctuation characters (semicolons, greater and less than signs, ampersands, etc.) to be parsed as separate tokens.
Map FN over the tokens of SOURCE, a string or stream, using shell-like rules. See the documentation of ‘split’ for a discussion of possible options.
Find CHAR in STRING, a sorted string, by bisection.
Add X, a character or string, to the end of STRING, an adjustable string with a fill pointer.
shlex-error)) ¶shlex-error)) ¶Return the next token.
Read a raw token.
(quote "missing closing quotation in string")
(quote "no escaped character in string")
| Initarg | Value |
|---|---|
:posix | nil |
:c-strings | nil |
:whitespace | default-whitespace |
:whitespace-split | nil |
:commenters | default-commenters |
:quotes | '" |
:escape | \ |
:escaped-quotes | " |
:debug-input | unknown |
(serapeum:queue)
Characters that will be considered punctuation. Runs of punctuation are returned as a single token.
string
Source line number.
1
This slot is read-only.
stream
:instream
(or null character)
#\
If true, use POSIX-esque parsing rules.
boolean
:posix
If true, interpret ANSI-C quoting.
boolean
:c-strings
If true, only split tokens on whitespaces.
boolean
:whitespace-split
Characters that bound tokens.
string
:whitespace
String of characters to recognize as comment beginnners.
string
:commenters
Characters to be considered an escape.
serapeum.
string
:escape
String of characters to accumulate into tokens.
string
Characters that will be considered string quotes.
string
:quotes
The subset of QUOTES that allow escapes.
string
:escaped-quotes
The token that determines EOF.
string
:debug-input
This slot is read-only.
Token buffer.
(make-array 10 :adjustable t :fill-pointer 0 :element-type (quote character))
| Jump to: | (
B C D E F G I L M Q R S T |
|---|
| Jump to: | (
B C D E F G I L M Q R S T |
|---|
| Jump to: | B C D E I L N P Q S T W |
|---|
| Jump to: | B C D E I L N P Q S T W |
|---|
| Jump to: | C F N P S |
|---|
| Jump to: | C F N P S |
|---|