#include <kcmdlineargs.h>
Public Member Functions | |
TQCString | getOption (const char *option) const |
QCStringList | getOptionList (const char *option) const |
bool | isSet (const char *option) const |
int | count () const |
const char * | arg (int n) const |
KURL | url (int n) const |
void | clear () |
Static Public Member Functions | |
static void | init (int _argc, char **_argv, const char *_appname, const char *programName, const char *_description, const char *_version, bool noKApp=false) |
static void | init (int _argc, char **_argv, const char *_appname, const char *_description, const char *_version, bool noKApp=false) KDE_DEPRECATED |
static void | init (int _argc, char **_argv, const KAboutData *about, bool noKApp=false) |
static void | init (const KAboutData *about) |
static void | addCmdLineOptions (const KCmdLineOptions *options, const char *name=0, const char *id=0, const char *afterId=0) |
static KCmdLineArgs * | parsedArgs (const char *id=0) |
static TQString | cwd () |
static const char * | appName () |
static void | usage (const char *id=0) |
static void | usage (const TQString &error) |
static void | enable_i18n () |
static KURL | makeURL (const char *urlArg) |
static void | setCwd (char *cwd) |
static void | reset () |
static void | loadAppArgs (TQDataStream &) |
static void | addTempFileOption () |
static bool | isTempFileSet () |
Protected Member Functions | |
KCmdLineArgs (const KCmdLineOptions *_options, const char *_name, const char *_id) | |
~KCmdLineArgs () | |
Friends | |
class | KApplication |
class | KUniqueApplication |
class | TQPtrList< KCmdLineArgs > |
Detailed Description
A class for command-line argument handling.
KCmdLineArgs provides simple access to the command-line arguments for an application. It takes into account Qt-specific options, KDE-specific options and application specific options.
This class is used in main() via the static method init().
A typical KDE application using KCmdLineArgs should look like this:
The options that an application supports are configured using the KCmdLineOptions class. An example is shown below:
The I18N_NOOP macro is used to indicate that these strings should be marked for translation. The actual translation is done by KCmdLineArgs. You can't use i18n() here because we are setting up a static data structure and can't do translations at compile time.
Note that a program should define the options before any arguments.
When a long option has a short option as an alias, a program should only test for the long option.
With the above options a command line could look like:
Long binary options can be in the form 'option' and 'nooption'. A command line may contain the same binary option multiple times, the last option determines the outcome:
is the same as:
If an option value is provided multiple times, normally only the last value is used:
is usually the same as:
However, an application can choose to use all values specified as well. As an example of this, consider that you may wish to specify a number of directories to use:
When an application does this it should mention this in the description of the option. To access these options, use getOptionList()
Tips for end-users:
- Single char options like "-a -b -c" may be combined into "-abc"
- The option "--foo bar" may also be written "--foo=bar"
- The option "-P lp1" may also be written "-P=lp1" or "-Plp1"
- The option "--foo bar" may also be written "-foo bar"
- Version
- 0.0.4
Definition at line 222 of file kcmdlineargs.h.
Constructor & Destructor Documentation
|
protected |
Constructor.
The given arguments are assumed to be constants.
Definition at line 991 of file kcmdlineargs.cpp.
|
protected |
Destructor.
Definition at line 1003 of file kcmdlineargs.cpp.
Member Function Documentation
|
static |
Add options to your application.
You must make sure that all possible options have been added before any class uses the command line arguments.
The list of options should look like this:
- "option1" is an option that requires an additional argument, but if one is not provided, it uses "my_extra_arg".
- "option2" is an option that can be turned on. The default is off.
- "option3" is an option that can be turned off. The default is on.
- "o" does not have a description. It is an alias for the option that follows. In this case "option2".
- "+file" specifies an argument. The '+' is removed. If your program doesn't specify that it can use arguments your program will abort when an argument is passed to it. Note that the reverse is not true. If required, you must check yourself the number of arguments specified by the user: KCmdLineArgs *args = KCmdLineArgs::parsedArgs();
In BNF:
Instead of "--option3" one may also use "-option3"
Usage examples:
- "myapp --option1 test"
- "myapp" (same as "myapp --option1 my_extra_arg")
- "myapp --option2"
- "myapp --nooption2" (same as "myapp", since it is off by default)
- "myapp -o" (same as "myapp --option2")
- "myapp --nooption3"
- "myapp --option3 (same as "myapp", since it is on by default) @li "myapp –option2 –nooption2" (same as "myapp", because it option2 is off by default, and the last usage applies)
- "myapp /tmp/file"
- Parameters
-
options A list of options that your code supplies. name the name of the option, can be 0. id A name with which these options can be identified, can be 0. afterId The options are inserted after this set of options, can be 0.
Definition at line 206 of file kcmdlineargs.cpp.
|
static |
|
static |
Get the appname according to argv[0].
- Returns
- the name of the application
Definition at line 199 of file kcmdlineargs.cpp.
const char * KCmdLineArgs::arg | ( | int | n | ) | const |
Read out an argument.
- Parameters
-
n The argument to read. 0 is the first argument. count()-1 is the last argument.
- Returns
- A
const
char
*
pointer to the n'th argument.
Definition at line 1232 of file kcmdlineargs.cpp.
void KCmdLineArgs::clear | ( | ) |
Clear all options and arguments.
Definition at line 1012 of file kcmdlineargs.cpp.
int KCmdLineArgs::count | ( | ) | const |
Read the number of arguments that aren't options (but, for example, filenames).
- Returns
- The number of arguments that aren't options
Definition at line 1224 of file kcmdlineargs.cpp.
|
static |
Get the CWD (Current Working Directory) associated with the current command line arguments.
Typically this is needed in KUniqueApplication::newInstance() since the CWD of the process may be different from the CWD where the user started a second instance.
- Returns
- the current working directory
Definition at line 194 of file kcmdlineargs.cpp.
|
static |
Enable i18n to be able to print a translated error message.
N.B.: This function leaks memory, therefore you are expected to exit afterwards (e.g., by calling usage()).
Definition at line 745 of file kcmdlineargs.cpp.
TQCString KCmdLineArgs::getOption | ( | const char * | option | ) | const |
Read out a string option.
The option must have a corresponding KCmdLineOptions entry of the form:
You cannot test for the presence of an alias - you must always test for the full option.
- Parameters
-
option The name of the option without '-'.
- Returns
- The value of the option. If the option was not present on the command line the default is returned. If the option was present more than the value of the last occurrence is used.
Definition at line 1119 of file kcmdlineargs.cpp.
QCStringList KCmdLineArgs::getOptionList | ( | const char * | option | ) | const |
Read out all occurrences of a string option.
The option must have a corresponding KCmdLineOptions entry of the form:
You cannot test for the presence of an alias - you must always test for the full option.
- Parameters
-
option The name of the option, without '-' or '-no'.
- Returns
- A list of all option values. If no option was present on the command line, an empty list is returned.
Definition at line 1151 of file kcmdlineargs.cpp.
|
static |
Initialize class.
This function should be called as the very first thing in your application.
- Parameters
-
_argc As passed to main
(...)._argv As passed to main
(...)._appname The untranslated name of your application. This should match with argv
[0].programName A program name string to be used for display purposes. This string should be marked for translation. Example: I18N_NOOP("KEdit") _description A short description of what your application is about. _version A version. noKApp Set this true to not add commandline options for TQApplication / KApplication
- Since
- 3.2
Definition at line 127 of file kcmdlineargs.cpp.
|
static |
- Deprecated:
- You should convert any calls to this method to use the one above, by adding in the program name to be used for display purposes. Do not forget to mark it for translation using I18N_NOOP.
Definition at line 136 of file kcmdlineargs.cpp.
|
static |
Initialize class.
This function should be called as the very first thing in your application. It uses KAboutData to replace some of the arguments that would otherwise be required.
- Parameters
-
_argc As passed to main
(...)._argv As passed to main
(...).about A KAboutData object describing your program. noKApp Set this true to not add commandline options for TQApplication / KApplication
Definition at line 162 of file kcmdlineargs.cpp.
|
static |
Initialize Class.
This function should be called as the very first thing in your application. This method will rarely be used, since it doesn't provide any argument parsing. It does provide access to the KAboutData information. This method is exactly the same as calling init(0,0, const KAboutData *about, true).
- Parameters
-
about the about data.
- See Also
- KAboutData
Definition at line 153 of file kcmdlineargs.cpp.
bool KCmdLineArgs::isSet | ( | const char * | option | ) | const |
Read out a boolean option or check for the presence of string option.
- Parameters
-
option The name of the option without '-' or '-no'.
- Returns
- The value of the option. It will be true if the option was specifically turned on in the command line, or if the option is turned on by default (in the KCmdLineOptions list) and was not specifically turned off in the command line. Equivalently, it will be false if the option was specifically turned off in the command line, or if the option is turned off by default (in the KCmdLineOptions list) and was not specifically turned on in the command line.
Definition at line 1181 of file kcmdlineargs.cpp.
|
static |
|
static |
Load arguments from a stream.
Definition at line 264 of file kcmdlineargs.cpp.
|
static |
Used by url().
Made public for apps that don't use KCmdLineArgs
- Parameters
-
urlArg the argument
- Returns
- the url.
Definition at line 1253 of file kcmdlineargs.cpp.
|
static |
Access parsed arguments.
This function returns all command line arguments that your code handles. If unknown command-line arguments are encountered the program is aborted and usage information is shown.
- Parameters
-
id The name of the options you are interested in, can be 0.
Definition at line 310 of file kcmdlineargs.cpp.
|
static |
Reset all option definitions, i.e.
cancel all addCmdLineOptions calls. Note that KApplication's options are removed too, you might want to call KApplication::addCmdLineOptions if you want them back.
You usually don't want to call this method.
Definition at line 1021 of file kcmdlineargs.cpp.
|
inlinestatic |
Made public for apps that don't use KCmdLineArgs To be done before makeURL, to set the current working directory in case makeURL needs it.
- Parameters
-
cwd the new working directory
Definition at line 516 of file kcmdlineargs.h.
KURL KCmdLineArgs::url | ( | int | n | ) | const |
Read out an argument representing a URL.
The argument can be
- an absolute filename
- a relative filename
- a URL
- Parameters
-
n The argument to read. 0 is the first argument. count()-1 is the last argument.
- Returns
- a URL representing the n'th argument.
Definition at line 1248 of file kcmdlineargs.cpp.
|
static |
Print the usage help to stdout and exit.
- Parameters
-
id if 0, print all options. If id is set, only print the option specified by id. The id is the value set by addCmdLineOptions().
Definition at line 774 of file kcmdlineargs.cpp.
|
static |
Print an error to stderr and the usage help to stdout and exit.
- Parameters
-
error the error to print
Definition at line 759 of file kcmdlineargs.cpp.
The documentation for this class was generated from the following files: