QGCCommandLineParser Namespace Reference

Classes
struct	CommandLineParseResult
	Result of parsing command-line arguments. More...

Enumerations
enum class	AppMode { Gui , BootTest }
	Application execution mode. More...

Functions
static QStringList	normalizeArgs (const QStringList &args)
	Normalizes command-line arguments Converts colon-separated syntax (–option:value) to standard format (–option value) and handles special cases like –unittest without a value.
CommandLineParseResult	parseCommandLine ()
	Parse command-line arguments (requires existing QCoreApplication)
CommandLineParseResult	parse (int argc, char *argv[])
	Parse command-line arguments with automatic QCoreApplication management.
std::optional< int >	handleParseResult (const CommandLineParseResult &result)
	Handle early exit conditions (help, version, error)
AppMode	determineAppMode (const CommandLineParseResult &args)
	Determine the application mode from parsed arguments.

Enumeration Type Documentation

AppMode

enum class QGCCommandLineParser::AppMode

strong

Application execution mode.

Enumerator
Gui	Normal GUI application.
BootTest	Initialize and exit (for CI validation)

Definition at line 78 of file QGCCommandLineParser.h.

Function Documentation

determineAppMode()

AppMode QGCCommandLineParser::determineAppMode

(

const CommandLineParseResult &

args

)

Determine the application mode from parsed arguments.

Parameters

args	Parsed command line arguments

Returns

The mode the application should run in

Definition at line 441 of file QGCCommandLineParser.cc.

References determineAppMode(), QGCCommandLineParser::CommandLineParseResult::listTests, QGCCommandLineParser::CommandLineParseResult::runningUnitTests, and QGCCommandLineParser::CommandLineParseResult::simpleBootTest.

Referenced by determineAppMode(), and main().

handleParseResult()

std::optional< int > QGCCommandLineParser::handleParseResult

(

const CommandLineParseResult &

result

)

Handle early exit conditions (help, version, error)

Parameters

result

The parse result to check

Returns

Exit code if main() should return immediately, std::nullopt to continue

Definition at line 424 of file QGCCommandLineParser.cc.

References QGCCommandLineParser::CommandLineParseResult::errorString, handleParseResult(), and QGCCommandLineParser::CommandLineParseResult::statusCode.

Referenced by handleParseResult(), and main().

normalizeArgs()

static QStringList QGCCommandLineParser::normalizeArgs ( const QStringList &  args )

static

Normalizes command-line arguments Converts colon-separated syntax (–option:value) to standard format (–option value) and handles special cases like –unittest without a value.

Definition at line 62 of file QGCCommandLineParser.cc.

References normalizeArgs().

Referenced by normalizeArgs(), and parseCommandLine().

parse()

CommandLineParseResult QGCCommandLineParser::parse	(	int	argc,
		char *	argv[]
	)

Parse command-line arguments with automatic QCoreApplication management.

Parameters

argc	Argument count from main()
argv	Argument values from main()

Returns

Parsed result with status and option values

Note

Creates a temporary QCoreApplication internally for parsing

Definition at line 415 of file QGCCommandLineParser.cc.

References parse(), and parseCommandLine().

Referenced by main(), and parse().

parseCommandLine()

CommandLineParseResult QGCCommandLineParser::parseCommandLine

(

)

Parse command-line arguments (requires existing QCoreApplication)

Returns

Parsed result with status and option values

Note

Prefer using parse() which manages the QCoreApplication lifecycle

Definition at line 103 of file QGCCommandLineParser.cc.

References normalizeArgs(), parseCommandLine(), and QGCCommandLineParser::CommandLineParseResult::parser.

Referenced by parse(), and parseCommandLine().