command-line.parser.private vocabulary
Factor handbook » Vocabulary index

Summary

Metadata

Parents:

command-line.parser

Words

Tuple classes

Class	Superclass	Slots
ambiguous-option	option-error	arg options
cannot-convert-value	option-error	str converter
expected-arguments	option-error	option
invalid-value	option-error	option value
option-error	tuple
required-options	option-error	options
unknown-option	option-error	str
unrecognized-arguments	option-error	args
usage-error	option-error	options

Generic words

Word	Stack effect
>option	( obj -- option )
argvalid?	( val validater -- ? )

Symbol words

print-help?

Ordinary words

Word	Stack effect
(parse-arguments)	( optional positional command-line -- positional' )
HELP	( -- value )
ambiguous-option	( arg options -- * )
argconvert	( str/f converter -- val )
cannot-convert-value	( str converter -- * )
default-options	( options -- defaults )
expected-arguments	( option -- * )
find-option	( arg options -- option )
get-program-name	( -- name )
invalid-value	( option value -- * )
option-#args	( option -- #args )
option-argument	( option -- argument )
option-convert	( arg option -- value )
option-description	( option -- description )
option-error	( -- * )
option-meta	( option -- meta/f )
option-name	( option -- name )
option-value	( args option -- args' value )
option-variable	( option -- variable )
optional?	( option -- ? )
parse-arguments	( options command-line -- arguments )
parse-optional	( options command-line -- command-line' )
parse-positional	( option command-line -- command-line' )
positional?	( option -- ? )
print-arguments	( options -- )
print-help	( options -- )
print-options	( options -- )
print-program-name	( -- )
print-short-usage	( options -- )
required-options	( options -- * )
unknown-option	( str -- * )
unrecognized-arguments	( args -- * )
usage-error	( options -- * )

Class predicate words

Word	Stack effect
ambiguous-option?	( object -- ? )
cannot-convert-value?	( object -- ? )
expected-arguments?	( object -- ? )
invalid-value?	( object -- ? )
option-error?	( object -- ? )
required-options?	( object -- ? )
unknown-option?	( object -- ? )
unrecognized-arguments?	( object -- ? )
usage-error?	( object -- ? )

Files

resource:extra/command-line/parser/parser.factor
resource:extra/command-line/parser/parser-docs.factor
resource:extra/command-line/parser/parser-tests.factor