Parent class for defining application command line parsers. More...

#include <libmythbase/mythcommandlineparser.h>

Inheritance diagram for MythCommandLineParser:

Public Types
enum class	Result : std::uint8_t { kEnd = 0 , kEmpty = 1 , kOptOnly = 2 , kOptVal = 3 , kCombOptVal = 4 , kArg = 5 , kPassthrough = 6 , kInvalid = 7 }

Public Member Functions
	MythCommandLineParser (QString appname)
	Default constructor for MythCommandLineArg class. More...

virtual	~MythCommandLineParser ()

virtual void	LoadArguments (void)

void	PrintHelp (void) const
	Print command line option help. More...

QString	GetHelpString (void) const
	Generate command line option help text. More...

virtual QString	GetHelpHeader (void) const

virtual bool	Parse (int argc, const char const argv)
	Loop through argv and populate arguments with values. More...

CommandLineArg *	add (const QString &arg, const QString &name, bool def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, int def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, uint def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, long long def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, double def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, const char *def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, const QString &def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, QSize def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, const QDateTime &def, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, QMetaType::Type type, QString help, QString longhelp)

CommandLineArg *	add (const QString &arg, const QString &name, QMetaType::Type type, QVariant def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, bool def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, int def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, uint def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, long long def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, double def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, const char *def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, const QString &def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, QSize def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, const QDateTime &def, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, QMetaType::Type type, QString help, QString longhelp)

CommandLineArg *	add (QStringList arglist, const QString &name, QMetaType::Type type, QVariant def, QString help, QString longhelp)
	Add a new command line argument. More...

QVariant	operator[] (const QString &name)
	Returned stored QVariant for given argument, or default value if not used. More...

QStringList	GetArgs (void) const
	Return list of additional values provided on the command line independent of any keyword. More...

QMap< QString, QString >	GetExtra (void) const
	Return map of additional key/value pairs provided on the command line independent of any registered argument. More...

QString	GetPassthrough (void) const
	Return any text supplied on the command line after a bare '–'. More...

QMap< QString, QString >	GetSettingsOverride (void)
	Return map of key/value pairs provided to override database options. More...

QString	GetLogFilePath (void)
	Helper utility for logging interface to pull path from –logpath. More...

int	GetSyslogFacility (void) const
	Helper utility for logging interface to return syslog facility. More...

LogLevel_t	GetLogLevel (void) const
	Helper utility for logging interface to filtering level. More...

QString	GetAppName (void) const

bool	toBool (const QString &key) const
	Returns stored QVariant as a boolean. More...

int	toInt (const QString &key) const
	Returns stored QVariant as an integer, falling to default if not provided. More...

uint	toUInt (const QString &key) const
	Returns stored QVariant as an unsigned integer, falling to default if not provided. More...

long long	toLongLong (const QString &key) const
	Returns stored QVariant as a long integer, falling to default if not provided. More...

double	toDouble (const QString &key) const
	Returns stored QVariant as double floating point value, falling to default if not provided. More...

QSize	toSize (const QString &key) const
	Returns stored QVariant as a QSize value, falling to default if not provided. More...

QString	toString (const QString &key) const
	Returns stored QVariant as a QString, falling to default if not provided. More...

QStringList	toStringList (const QString &key, const QString &sep="") const
	Returns stored QVariant as a QStringList, falling to default if not provided. More...

QMap< QString, QString >	toMap (const QString &key) const
	Returns stored QVariant as a QMap, falling to default if not provided. More...

QDateTime	toDateTime (const QString &key) const
	Returns stored QVariant as a QDateTime, falling to default if not provided. More...

bool	SetValue (const QString &key, const QVariant &value)
	Set a new stored value for an existing argument definition, or spawn a new definition store value in. More...

int	ConfigureLogging (const QString &mask="general", bool progress=false)
	Read in logging options and initialize the logging interface. More...

void	ApplySettingsOverride (void)
	Apply all overrides to the global context. More...

int	Daemonize (void) const
	Fork application into background, and detatch from terminal. More...

Static Public Member Functions
static QStringList	MythSplitCommandString (const QString &line)
	Parse a string into separate tokens. More...

static void	PrintVersion (void)
	Print application version information. More...

static const char *	NamedOptType (Result type)

Public Attributes
friend	TestCommandLineParser

Protected Member Functions
void	allowArgs (bool allow=true)
	Specify that parser should allow and collect values provided independent of any keyword. More...

void	allowExtras (bool allow=true)
	Specify that parser should allow and collect additional key/value pairs not explicitly defined for processing. More...

void	allowPassthrough (bool allow=true)
	Specify that parser should allow a bare '–', and collect all subsequent text as a QString. More...

void	addHelp (void)
	Canned argument definition for –help. More...

void	addVersion (void)
	Canned argument definition for –version. More...

void	addWindowed (void)
	Canned argument definition for –windowed and -no-windowed. More...

void	addMouse (void)
	Canned argument definition for –mouse-cursor and –no-mouse-cursor. More...

void	addDaemon (void)
	Canned argument definition for –daemon. More...

void	addSettingsOverride (void)
	Canned argument definition for –override-setting and –override-settings-file. More...

void	addRecording (void)
	Canned argument definition for –chanid and –starttime. More...

void	addGeometry (void)
	Canned argument definition for –geometry. More...

void	addDisplay (void)
	Canned argument definition for -display. More...

void	addUPnP (void)
	Canned argument definition for –noupnp. More...

void	addDVBv3 (void)
	Canned argument definition for –dvbv3. More...

void	addLogging (const QString &defaultVerbosity="general", LogLevel_t defaultLogLevel=LOG_INFO)
	Canned argument definition for all logging options, including –verbose, –logpath, –quiet, –loglevel, –syslog, –loglong. More...

void	addPIDFile (void)
	Canned argument definition for –pidfile. More...

void	addJob (void)
	Canned argument definition for –jobid. More...

void	addInFile (bool addOutFile=false)
	Canned argument definition for –infile and –outfile. More...

void	addPlatform (void)
	Pass through the platform argument to Qt for GUI applications. More...

Private Member Functions
Result	getOpt (int argc, const char const argv, int &argpos, QString &opt, QByteArray &val)
	Internal use. More...

bool	ReconcileLinks (void)
	Replace dummy arguments used to define interdependency with pointers to their real counterparts. More...

Private Attributes
QString	m_appname

QMap< QString, CommandLineArg * >	m_optionedArgs

QMap< QString, CommandLineArg * >	m_namedArgs

bool	m_passthroughActive {false}

bool	m_overridesImported {false}

bool	m_verbose {false}

Detailed Description

Parent class for defining application command line parsers.

This class provides a generic interface for defining and parsing available command line options. Options can be provided manually using the add() method, or one of several canned add*() methods. Once defined, the command line is parsed using the Parse() method, and results are available through Qt standard to<Type>() methods.

Definition at line 116 of file mythcommandlineparser.h.

Member Enumeration Documentation

◆ Result

enum class MythCommandLineParser::Result : std::uint8_t

strong

Enumerator
kEnd
kEmpty
kOptOnly
kOptVal
kCombOptVal
kArg
kPassthrough
kInvalid

Definition at line 121 of file mythcommandlineparser.h.

Constructor & Destructor Documentation

◆ MythCommandLineParser()

MythCommandLineParser::MythCommandLineParser ( QString appname )

explicit

Default constructor for MythCommandLineArg class.

Definition at line 1286 of file mythcommandlineparser.cpp.

◆ ~MythCommandLineParser()

MythCommandLineParser::~MythCommandLineParser ( )

virtual

Definition at line 1298 of file mythcommandlineparser.cpp.

Member Function Documentation

◆ add() [1/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		bool	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1789 of file mythcommandlineparser.cpp.

◆ add() [2/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		const char *	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1819 of file mythcommandlineparser.cpp.

◆ add() [3/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		const QDateTime &	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1837 of file mythcommandlineparser.cpp.

◆ add() [4/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		const QString &	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1825 of file mythcommandlineparser.cpp.

◆ add() [5/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		double	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1813 of file mythcommandlineparser.cpp.

◆ add() [6/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		int	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1795 of file mythcommandlineparser.cpp.

◆ add() [7/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		long long	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1807 of file mythcommandlineparser.cpp.

◆ add() [8/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		QMetaType::Type	type,
		QString	help,
		QString	longhelp
	)

Definition at line 1843 of file mythcommandlineparser.cpp.

◆ add() [9/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		QMetaType::Type	type,
		QVariant	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1855 of file mythcommandlineparser.cpp.

◆ add() [10/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		QSize	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1831 of file mythcommandlineparser.cpp.

◆ add() [11/22]

CommandLineArg * MythCommandLineParser::add	(	const QString &	arg,
		const QString &	name,
		uint	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1801 of file mythcommandlineparser.cpp.

◆ add() [12/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		bool	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1862 of file mythcommandlineparser.cpp.

◆ add() [13/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		const char *	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1892 of file mythcommandlineparser.cpp.

◆ add() [14/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		const QDateTime &	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1910 of file mythcommandlineparser.cpp.

◆ add() [15/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		const QString &	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1898 of file mythcommandlineparser.cpp.

◆ add() [16/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		double	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1886 of file mythcommandlineparser.cpp.

◆ add() [17/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		int	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1868 of file mythcommandlineparser.cpp.

◆ add() [18/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		long long	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1880 of file mythcommandlineparser.cpp.

◆ add() [19/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		QMetaType::Type	type,
		QString	help,
		QString	longhelp
	)

Definition at line 1916 of file mythcommandlineparser.cpp.

◆ add() [20/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		QMetaType::Type	type,
		QVariant	def,
		QString	help,
		QString	longhelp
	)

Add a new command line argument.

This is the primary method for adding new arguments for processing. There are several overloaded convenience methods that tie into this, allowing it to be called with fewer inputs.

Parameters

arglist	list of arguments to allow use of on the command line
name	internal name to be used when pulling processed data out
type	type of variable to be processed. The allowed types are listed below.
def	default value to provide if one is not supplied or option is not used
help	short help text, displayed when printing all available options with '–help'. If this is empty, the argument will not be shown
longhelp	Extended help text, displayed when help about a specific option is requested using '–help <option>'

Type	Description
Bool	set to value, or default if value is not provided
String	set to value, or default if value is not provided
Int	set to value, or behaves as counter for multiple uses if value is not provided
UInt
LongLong
Double
DateTime	accepts ISO8601 and Myth's flattened version
StringList	accepts multiple uses, appended as individual strings
Map	accepts multiple pairs, in the syntax "key=value"
Size	accepts size in the syntax "XxY"

Definition at line 1357 of file mythcommandlineparser.cpp.

◆ add() [21/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		QSize	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1904 of file mythcommandlineparser.cpp.

◆ add() [22/22]

CommandLineArg * MythCommandLineParser::add	(	QStringList	arglist,
		const QString &	name,
		uint	def,
		QString	help,
		QString	longhelp
	)

Definition at line 1874 of file mythcommandlineparser.cpp.

◆ addDaemon()

void MythCommandLineParser::addDaemon ( void )

protected

Canned argument definition for –daemon.

Definition at line 2610 of file mythcommandlineparser.cpp.

Referenced by MythBackendCommandLineParser::LoadArguments(), MythJobQueueCommandLineParser::LoadArguments(), MythLCDServerCommandLineParser::LoadArguments(), and MythMediaServerCommandLineParser::LoadArguments().

◆ addDisplay()

void MythCommandLineParser::addDisplay ( void )

protected

Canned argument definition for -display.

Only works on X11 systems.

Definition at line 2776 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythFrontendCommandLineParser::LoadArguments(), MythScreenWizardCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and MythWelcomeCommandLineParser::LoadArguments().

◆ addDVBv3()

void MythCommandLineParser::addDVBv3 ( void )

protected

Canned argument definition for –dvbv3.

Definition at line 2667 of file mythcommandlineparser.cpp.

Referenced by MythBackendCommandLineParser::LoadArguments().

◆ addGeometry()

void MythCommandLineParser::addGeometry ( void )

protected

Canned argument definition for –geometry.

Definition at line 2651 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythFrontendCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and MythWelcomeCommandLineParser::LoadArguments().

◆ addHelp()

void MythCommandLineParser::addHelp ( void )

protected

Canned argument definition for –help.

Definition at line 2558 of file mythcommandlineparser.cpp.

◆ addInFile()

void MythCommandLineParser::addInFile ( bool addOutFile = false )

protected

Canned argument definition for –infile and –outfile.

Definition at line 2767 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythFileRecorderCommandLineParser::LoadArguments(), and MythUtilCommandLineParser::LoadArguments().

◆ addJob()

void MythCommandLineParser::addJob ( void )

protected

Canned argument definition for –jobid.

Definition at line 2757 of file mythcommandlineparser.cpp.

Referenced by MythCommFlagCommandLineParser::LoadArguments(), MythMetadataLookupCommandLineParser::LoadArguments(), and MythTranscodeCommandLineParser::LoadArguments().

◆ addLogging()

void MythCommandLineParser::addLogging	(	const QString &	defaultVerbosity = `"general"`,
		LogLevel_t	defaultLogLevel = `LOG_INFO`
	)

protected

Canned argument definition for all logging options, including –verbose, –logpath, –quiet, –loglevel, –syslog, –loglong.

Definition at line 2675 of file mythcommandlineparser.cpp.

◆ addMouse()

void MythCommandLineParser::addMouse ( void )

protected

Canned argument definition for –mouse-cursor and –no-mouse-cursor.

Definition at line 2596 of file mythcommandlineparser.cpp.

Referenced by MythFrontendCommandLineParser::LoadArguments(), MythScreenWizardCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and MythWelcomeCommandLineParser::LoadArguments().

◆ addPIDFile()

void MythCommandLineParser::addPIDFile ( void )

protected

Canned argument definition for –pidfile.

Definition at line 2745 of file mythcommandlineparser.cpp.

Referenced by MythBackendCommandLineParser::LoadArguments(), MythJobQueueCommandLineParser::LoadArguments(), and MythMediaServerCommandLineParser::LoadArguments().

◆ addPlatform()

void MythCommandLineParser::addPlatform ( void )

protected

Pass through the platform argument to Qt for GUI applications.

Definition at line 2787 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythFrontendCommandLineParser::LoadArguments(), MythScreenWizardCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and MythWelcomeCommandLineParser::LoadArguments().

◆ addRecording()

void MythCommandLineParser::addRecording ( void )

protected

Canned argument definition for –chanid and –starttime.

Definition at line 2638 of file mythcommandlineparser.cpp.

Referenced by MythCommFlagCommandLineParser::LoadArguments(), MythMetadataLookupCommandLineParser::LoadArguments(), MythPreviewGeneratorCommandLineParser::LoadArguments(), MythTranscodeCommandLineParser::LoadArguments(), and MythUtilCommandLineParser::LoadArguments().

◆ addSettingsOverride()

void MythCommandLineParser::addSettingsOverride ( void )

protected

Canned argument definition for –override-setting and –override-settings-file.

Definition at line 2622 of file mythcommandlineparser.cpp.

◆ addUPnP()

void MythCommandLineParser::addUPnP ( void )

protected

Canned argument definition for –noupnp.

Definition at line 2660 of file mythcommandlineparser.cpp.

Referenced by MythBackendCommandLineParser::LoadArguments(), and MythFrontendCommandLineParser::LoadArguments().

◆ addVersion()

void MythCommandLineParser::addVersion ( void )

protected

Canned argument definition for –version.

Definition at line 2571 of file mythcommandlineparser.cpp.

◆ addWindowed()

void MythCommandLineParser::addWindowed ( void )

protected

Canned argument definition for –windowed and -no-windowed.

Definition at line 2581 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythFrontendCommandLineParser::LoadArguments(), MythTVSetupCommandLineParser::LoadArguments(), and MythWelcomeCommandLineParser::LoadArguments().

◆ allowArgs()

void MythCommandLineParser::allowArgs ( bool allow = true )

protected

Specify that parser should allow and collect values provided independent of any keyword.

Definition at line 2499 of file mythcommandlineparser.cpp.

Referenced by MythAVTestCommandLineParser::LoadArguments(), MythExternRecorderCommandLineParser::LoadArguments(), and MythFileRecorderCommandLineParser::LoadArguments().

◆ allowExtras()

void MythCommandLineParser::allowExtras ( bool allow = true )

protected

Specify that parser should allow and collect additional key/value pairs not explicitly defined for processing.

Definition at line 2518 of file mythcommandlineparser.cpp.

Referenced by MythUtilCommandLineParser::LoadArguments().

◆ allowPassthrough()

void MythCommandLineParser::allowPassthrough ( bool allow = true )

protected

Specify that parser should allow a bare '–', and collect all subsequent text as a QString.

Definition at line 2539 of file mythcommandlineparser.cpp.

Referenced by MythFillDatabaseCommandLineParser::LoadArguments().

◆ ApplySettingsOverride()

void MythCommandLineParser::ApplySettingsOverride ( void )

Apply all overrides to the global context.

WARNING: this must not be called until after MythContext is initialized

Definition at line 2960 of file mythcommandlineparser.cpp.

Referenced by main().

◆ ConfigureLogging()

int MythCommandLineParser::ConfigureLogging	(	const QString &	mask = `"general"`,
		bool	progress = `false`
	)

Read in logging options and initialize the logging interface.

Definition at line 2889 of file mythcommandlineparser.cpp.

Referenced by main(), and main_local().

◆ Daemonize()

int MythCommandLineParser::Daemonize ( void ) const

Fork application into background, and detatch from terminal.

Definition at line 3066 of file mythcommandlineparser.cpp.

Referenced by main().

◆ GetAppName()

QString MythCommandLineParser::GetAppName ( void ) const

inline

Definition at line 224 of file mythcommandlineparser.h.

◆ GetArgs()

QStringList MythCommandLineParser::GetArgs ( void ) const

Return list of additional values provided on the command line independent of any keyword.

Definition at line 2108 of file mythcommandlineparser.cpp.

Referenced by main().

◆ GetExtra()

QMap< QString, QString > MythCommandLineParser::GetExtra ( void ) const

Return map of additional key/value pairs provided on the command line independent of any registered argument.

Definition at line 2116 of file mythcommandlineparser.cpp.

Referenced by SendMessage().

◆ GetHelpHeader()

virtual QString MythCommandLineParser::GetHelpHeader ( void ) const

inlinevirtual

Reimplemented in MythAVTestCommandLineParser, MythBackendCommandLineParser, MythCCExtractorCommandLineParser, MythExternRecorderCommandLineParser, MythFileRecorderCommandLineParser, MythFrontendCommandLineParser, MythJobQueueCommandLineParser, MythMediaServerCommandLineParser, MythScreenWizardCommandLineParser, MythTVSetupCommandLineParser, MythUtilCommandLineParser, and MythWelcomeCommandLineParser.

Definition at line 141 of file mythcommandlineparser.h.

Referenced by GetHelpString().

◆ GetHelpString()

QString MythCommandLineParser::GetHelpString ( void ) const

Generate command line option help text.

Generates generic help or specific help, depending on whether a value was provided to the –help option

Definition at line 1424 of file mythcommandlineparser.cpp.

Referenced by PrintHelp().

◆ GetLogFilePath()

QString MythCommandLineParser::GetLogFilePath ( void )

Helper utility for logging interface to pull path from –logpath.

Definition at line 2796 of file mythcommandlineparser.cpp.

Referenced by ConfigureLogging(), and main().

◆ GetLogLevel()

LogLevel_t MythCommandLineParser::GetLogLevel ( void ) const

Helper utility for logging interface to filtering level.

Definition at line 2838 of file mythcommandlineparser.cpp.

Referenced by ConfigureLogging().

◆ getOpt()

MythCommandLineParser::Result MythCommandLineParser::getOpt	(	int	argc,
		const char const	argv,
		int &	argpos,
		QString &	opt,
		QByteArray &	val
	)

private

Internal use.

Pull next key/value pair from argv.

Definition at line 1492 of file mythcommandlineparser.cpp.

Referenced by Parse().

◆ GetPassthrough()

QString MythCommandLineParser::GetPassthrough ( void ) const

Return any text supplied on the command line after a bare '–'.

Definition at line 2123 of file mythcommandlineparser.cpp.

Referenced by main(), and Parse().

◆ GetSettingsOverride()

QMap< QString, QString > MythCommandLineParser::GetSettingsOverride ( void )

Return map of key/value pairs provided to override database options.

This method is used for the -O/–override-setting options, as well as the specific arguments to override the window border and mouse cursor. On its first use, this method will also read in any addition settings provided in the –override-settings-file

Definition at line 2135 of file mythcommandlineparser.cpp.

Referenced by ApplySettingsOverride().

◆ GetSyslogFacility()

int MythCommandLineParser::GetSyslogFacility ( void ) const

Helper utility for logging interface to return syslog facility.

Definition at line 2827 of file mythcommandlineparser.cpp.

Referenced by ConfigureLogging().

◆ LoadArguments()

virtual void MythCommandLineParser::LoadArguments ( void )

inlinevirtual

◆ MythSplitCommandString()

QStringList MythCommandLineParser::MythSplitCommandString ( const QString & line )

static

Parse a string into separate tokens.

This function understands quoting and the escape character.

Definition at line 156 of file mythcommandlineparser.cpp.

Referenced by MythExternRecApp::Cleanup(), MythExternRecApp::DataStarted(), MythExternRecApp::LoadChannels(), MythExternRecApp::NewEpisodeStarting(), MythExternRecApp::StartStreaming(), and MythExternRecApp::TuneChannel().

◆ NamedOptType()

const char * MythCommandLineParser::NamedOptType ( Result type )

static

Definition at line 223 of file mythcommandlineparser.cpp.

Referenced by Parse().

◆ operator[]()

QVariant MythCommandLineParser::operator[] ( const QString & name )

Returned stored QVariant for given argument, or default value if not used.

Definition at line 2089 of file mythcommandlineparser.cpp.

◆ Parse()

bool MythCommandLineParser::Parse	(	int	argc,
		const char const	argv
	)

virtual

Loop through argv and populate arguments with values.

This should not be called until all arguments are added to the parser. This returns false if the parser hits an argument it is not designed to handle.

Definition at line 1573 of file mythcommandlineparser.cpp.

Referenced by main(), and main_local().

◆ PrintHelp()

void MythCommandLineParser::PrintHelp ( void ) const

Print command line option help.

Definition at line 1413 of file mythcommandlineparser.cpp.

Referenced by main(), and main_local().

◆ PrintVersion()

void MythCommandLineParser::PrintVersion ( void )

static

Print application version information.

Definition at line 1397 of file mythcommandlineparser.cpp.

Referenced by main(), and main_local().

◆ ReconcileLinks()

bool MythCommandLineParser::ReconcileLinks ( void )

private

Replace dummy arguments used to define interdependency with pointers to their real counterparts.

Definition at line 1932 of file mythcommandlineparser.cpp.

Referenced by Parse().

◆ SetValue()

bool MythCommandLineParser::SetValue	(	const QString &	key,
		const QVariant &	value
	)

Set a new stored value for an existing argument definition, or spawn a new definition store value in.

Argument is subsequently marked as being provided on the command line.

Definition at line 2856 of file mythcommandlineparser.cpp.

Referenced by GetLogFilePath(), main(), and Parse().

◆ toBool()

bool MythCommandLineParser::toBool ( const QString & key ) const

Returns stored QVariant as a boolean.

If the stored value is of type boolean, this will return the actual stored or default value. For all other types, this will return whether the argument was supplied on the command line or not.

Definition at line 2216 of file mythcommandlineparser.cpp.

Referenced by CheckRecordings(), ClearEIT(), ConfigureLogging(), MythDisplay::ConfigureQtGUI(), Daemonize(), FlagCommercials(), GetProgramInfo(), GetSettingsOverride(), handle_command(), main(), main_local(), Parse(), pid_printer(), print_warnings(), QueueCommFlagJob(), run_backend(), ScanMusic(), and SendMessage().

◆ toDateTime()

QDateTime MythCommandLineParser::toDateTime ( const QString & key ) const

Returns stored QVariant as a QDateTime, falling to default if not provided.

Definition at line 2472 of file mythcommandlineparser.cpp.

Referenced by GetProgramInfo(), main(), and UpdateMeta().

◆ toDouble()

double MythCommandLineParser::toDouble ( const QString & key ) const

Returns stored QVariant as double floating point value, falling to default if not provided.

Definition at line 2319 of file mythcommandlineparser.cpp.

◆ toInt()

int MythCommandLineParser::toInt ( const QString & key ) const

Returns stored QVariant as an integer, falling to default if not provided.

Definition at line 2238 of file mythcommandlineparser.cpp.

Referenced by CalcTrackLength(), ClearEIT(), ConfigureLogging(), ExtractImage(), FindLyrics(), main(), main_local(), QueueJob(), and UpdateMeta().

◆ toLongLong()

long long MythCommandLineParser::toLongLong ( const QString & key ) const

Returns stored QVariant as a long integer, falling to default if not provided.

Definition at line 2292 of file mythcommandlineparser.cpp.

Referenced by ConfigureLogging(), and main().

◆ toMap()

QMap< QString, QString > MythCommandLineParser::toMap ( const QString & key ) const

Returns stored QVariant as a QMap, falling to default if not provided.

Definition at line 2438 of file mythcommandlineparser.cpp.

Referenced by GetExtra(), and GetSettingsOverride().

◆ toSize()

QSize MythCommandLineParser::toSize ( const QString & key ) const

Returns stored QVariant as a QSize value, falling to default if not provided.

Definition at line 2346 of file mythcommandlineparser.cpp.

Referenced by main().

◆ toString()

QString MythCommandLineParser::toString ( const QString & key ) const

Returns stored QVariant as a QString, falling to default if not provided.

Definition at line 2373 of file mythcommandlineparser.cpp.

Referenced by CalcTrackLength(), ConfigureLogging(), MythDisplay::ConfigureQtGUI(), CopyFile(), Daemonize(), DownloadFile(), ExtractImage(), FindLyrics(), FlagCommercials(), GetHelpString(), GetLogFilePath(), GetLogLevel(), GetMarkup(), GetProgramInfo(), GetSettingsOverride(), GetSyslogFacility(), handle_command(), main(), main_local(), ParseVideoFilename(), pid_counter(), pid_filter(), pid_printer(), QueueJob(), SendMessage(), SendSystemEvent(), SetCutList(), SetMarkup(), SetSkipList(), UpdateMeta(), and ~MythCommandLineParser().

◆ toStringList()

QStringList MythCommandLineParser::toStringList	(	const QString &	key,
		const QString &	sep = `""`
	)		const

Returns stored QVariant as a QStringList, falling to default if not provided.

Optional separator can be specified to split result if stored value is a QString.

Definition at line 2404 of file mythcommandlineparser.cpp.

Referenced by GetArgs(), GetPassthrough(), main(), Parse(), and SendEvent().

◆ toUInt()

uint MythCommandLineParser::toUInt ( const QString & key ) const

Returns stored QVariant as an unsigned integer, falling to default if not provided.

Definition at line 2265 of file mythcommandlineparser.cpp.

Referenced by MythDisplay::ConfigureQtGUI(), GetProgramInfo(), main(), main_local(), pid_counter(), pid_filter(), and SendMessage().

Member Data Documentation

◆ m_appname

QString MythCommandLineParser::m_appname

private

Definition at line 271 of file mythcommandlineparser.h.

Referenced by GetHelpString().

◆ m_namedArgs

QMap<QString,CommandLineArg*> MythCommandLineParser::m_namedArgs

private

Definition at line 273 of file mythcommandlineparser.h.

Referenced by add(), allowArgs(), allowExtras(), allowPassthrough(), GetHelpString(), GetSettingsOverride(), operator[](), Parse(), ReconcileLinks(), SetValue(), toBool(), toDateTime(), toDouble(), toInt(), toLongLong(), toMap(), toSize(), toString(), toStringList(), toUInt(), and ~MythCommandLineParser().

◆ m_optionedArgs

QMap<QString,CommandLineArg*> MythCommandLineParser::m_optionedArgs

private

Definition at line 272 of file mythcommandlineparser.h.

Referenced by add(), GetHelpString(), Parse(), and ~MythCommandLineParser().

◆ m_overridesImported

bool MythCommandLineParser::m_overridesImported {false}

private

Definition at line 275 of file mythcommandlineparser.h.

Referenced by GetSettingsOverride().

◆ m_passthroughActive

bool MythCommandLineParser::m_passthroughActive {false}

private

Definition at line 274 of file mythcommandlineparser.h.

Referenced by getOpt(), and Parse().

◆ m_verbose

bool MythCommandLineParser::m_verbose {false}

private

Definition at line 276 of file mythcommandlineparser.h.

Referenced by add(), ApplySettingsOverride(), GetSettingsOverride(), MythCommandLineParser(), Parse(), and ReconcileLinks().

◆ TestCommandLineParser

friend MythCommandLineParser::TestCommandLineParser

Definition at line 119 of file mythcommandlineparser.h.

The documentation for this class was generated from the following files:

mythtv/libs/libmythbase/mythcommandlineparser.h
mythtv/libs/libmythbase/mythcommandlineparser.cpp

Public Types

Public Member Functions

Static Public Member Functions

Public Attributes

Protected Member Functions

Private Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Result

Constructor & Destructor Documentation

◆ MythCommandLineParser()

◆ ~MythCommandLineParser()

Member Function Documentation

◆ add() [1/22]

◆ add() [2/22]

◆ add() [3/22]

◆ add() [4/22]

◆ add() [5/22]

◆ add() [6/22]

◆ add() [7/22]

◆ add() [8/22]

◆ add() [9/22]

◆ add() [10/22]

◆ add() [11/22]

◆ add() [12/22]

◆ add() [13/22]

◆ add() [14/22]

◆ add() [15/22]

◆ add() [16/22]

◆ add() [17/22]

◆ add() [18/22]

◆ add() [19/22]

◆ add() [20/22]

◆ add() [21/22]

◆ add() [22/22]

◆ addDaemon()

◆ addDisplay()

◆ addDVBv3()

◆ addGeometry()

◆ addHelp()

◆ addInFile()

◆ addJob()

◆ addLogging()

◆ addMouse()

◆ addPIDFile()

◆ addPlatform()

◆ addRecording()

◆ addSettingsOverride()

◆ addUPnP()

◆ addVersion()

◆ addWindowed()

◆ allowArgs()

◆ allowExtras()

◆ allowPassthrough()

◆ ApplySettingsOverride()

◆ ConfigureLogging()

◆ Daemonize()

◆ GetAppName()

◆ GetArgs()

◆ GetExtra()

◆ GetHelpHeader()

◆ GetHelpString()

◆ GetLogFilePath()

◆ GetLogLevel()

◆ getOpt()

◆ GetPassthrough()

◆ GetSettingsOverride()

◆ GetSyslogFacility()

◆ LoadArguments()

◆ MythSplitCommandString()

◆ NamedOptType()

◆ operator[]()

◆ Parse()

◆ PrintHelp()

◆ PrintVersion()

◆ ReconcileLinks()

◆ SetValue()

◆ toBool()

◆ toDateTime()