paludis::args Namespace Reference

Classes
class	AliasArg
struct	AllowedEnumArg
class	ArgsDumper
class	ArgsError
class	ArgsGroup
class	ArgsHandler
class	ArgsOption
class	ArgsSection
class	ArgsVisitor
class	AsciidocWriter
class	BadArgument
class	BadValue
class	DocWriter
struct	DoHelp
class	EnumArg
class	IntegerArg
class	LogLevelArg
class	MissingValue
class	StringArg
class	StringSequenceArg
class	StringSetArg
class	SwitchArg

Typedefs
typedef Options< ArgsHandlerOption >	ArgsHandlerOptions

Enumerations
enum	ArgsHandlerOption { aho_stop_on_first_parameter, aho_separate_after_dashes, last_dstpo }
enum	ArgsOptionSpecifiedness { aos_not, aos_weak, aos_specified }

Functions
std::ostream &	operator<< (std::ostream &, const ArgsHandlerOption &) PALUDIS_VISIBLE
std::istream &	operator>> (std::istream &, ArgsHandlerOption &) PALUDIS_VISIBLE
std::ostream &	operator<< (std::ostream &, const ArgsHandler &) PALUDIS_VISIBLE
const std::string	escape (const std::string &) PALUDIS_VISIBLE PALUDIS_ATTRIBUTE((warn_unused_result))
void	generate_doc (DocWriter &dw, const ArgsHandler *const h) PALUDIS_VISIBLE

Detailed Description

Commandline argument handling.

Enumeration Type Documentation

enum paludis::args::ArgsHandlerOption

Enumerator
aho_stop_on_first_parameter	Stop on the first parameter encountered.
aho_separate_after_dashes	Since 0.47 Collect everything after a – separately
last_dstpo	Number of keys in paludis::args::ArgsHandlerOption.

Function Documentation

void paludis::args::generate_doc	(	DocWriter &	dw,
		const ArgsHandler *const	h
	)

Write docs to an ostream.

std::ostream& paludis::args::operator<<	(	std::ostream &	,
		const ArgsHandlerOption &
	)

Write a ArgsHandlerOption to a stream.

Referenced by paludis::args::ArgsHandler::man_section().

std::ostream& paludis::args::operator<<	(	std::ostream &	,
		const ArgsHandler &
	)

Output an ArgsHandler to an ostream, for –help output.

std::istream& paludis::args::operator>>	(	std::istream &	,
		ArgsHandlerOption &
	)

Read a ArgsHandlerOption from a stream.