OpenShot Library | OpenShotAudio
0.2.1
|
Represents a the set of commands that a console app can perform, and provides helper functions for performing them. More...
#include <juce_ConsoleApplication.h>
Classes | |
struct | Command |
Represents a command that can be executed if its command-line arguments are matched. More... | |
Public Member Functions | |
void | addCommand (Command) |
Adds a command to the list. More... | |
void | addDefaultCommand (Command) |
Adds a command to the list, and marks it as one which is invoked if no other command matches. | |
void | addVersionCommand (String versionArgument, String versionText) |
Adds a command that will print the given text in response to the "--version" option. More... | |
void | addHelpCommand (String helpArgument, String helpMessage, bool makeDefaultCommand) |
Adds a help command to the list. More... | |
void | printCommandList (const ArgumentList &) const |
Prints out the list of commands and their short descriptions in a format that's suitable for use as help. | |
void | printCommandDetails (const ArgumentList &, const Command &) const |
Prints out a longer description of a particular command, based on its longDescription member. | |
int | findAndRunCommand (const ArgumentList &, bool optionMustBeFirstArg=false) const |
Looks for the first command in the list which matches the given arguments, and tries to invoke it. More... | |
int | findAndRunCommand (int argc, char *argv[]) const |
Creates an ArgumentList object from the argc and argv variablrs, and invokes findAndRunCommand() using it. | |
const Command * | findCommand (const ArgumentList &, bool optionMustBeFirstArg) const |
Looks for the first command in the list which matches the given arguments. More... | |
const std::vector< Command > & | getCommands () const |
Gives read-only access to the list of registered commands. More... | |
Static Public Member Functions | |
static void | fail (String errorMessage, int returnCode=1) |
Throws a failure exception to cause a command-line app to terminate. More... | |
static int | invokeCatchingFailures (std::function< int()> &&functionToCall) |
Invokes a function, catching any fail() calls that it might trigger, and handling them by printing their error message and returning their error code. More... | |
Represents a the set of commands that a console app can perform, and provides helper functions for performing them.
When using these helper classes to implement a console app, you probably want to do something along these lines:
Definition at line 240 of file juce_ConsoleApplication.h.
void juce::ConsoleApplication::addCommand | ( | Command | c | ) |
Adds a command to the list.
Definition at line 352 of file juce_ConsoleApplication.cpp.
Adds a command that will print the given text in response to the "--version" option.
Definition at line 378 of file juce_ConsoleApplication.cpp.
void juce::ConsoleApplication::addHelpCommand | ( | String | helpArgument, |
String | helpMessage, | ||
bool | makeDefaultCommand | ||
) |
Adds a help command to the list.
This command will print the user-supplied message that's passed in here as an argument, followed by a list of all the registered commands.
Definition at line 363 of file juce_ConsoleApplication.cpp.
|
static |
Throws a failure exception to cause a command-line app to terminate.
This is intended to be called from code in a Command, so that the exception will be automatically caught and turned into a printed error message and a return code which will be returned from main().
Definition at line 296 of file juce_ConsoleApplication.cpp.
Referenced by juce::ArgumentList::checkMinNumArguments(), juce::ArgumentList::failIfOptionIsMissing(), and juce::ArgumentList::Argument::resolveAsExistingFolder().
|
static |
Invokes a function, catching any fail() calls that it might trigger, and handling them by printing their error message and returning their error code.
Definition at line 301 of file juce_ConsoleApplication.cpp.
int juce::ConsoleApplication::findAndRunCommand | ( | const ArgumentList & | args, |
bool | optionMustBeFirstArg = false |
||
) | const |
Looks for the first command in the list which matches the given arguments, and tries to invoke it.
If no command is found, and if there is no default command to run, it fails with a suitable error message. If the command calls the fail() function, this will throw an exception that gets automatically caught and handled, and this method will return the error code that was passed into the fail() call.
If optionMustBeFirstArg is true, then only the first argument will be looked at when searching the available commands - this lets you do 'git' style commands where the executable name is followed by a verb.
Definition at line 334 of file juce_ConsoleApplication.cpp.
const ConsoleApplication::Command * juce::ConsoleApplication::findCommand | ( | const ArgumentList & | args, |
bool | optionMustBeFirstArg | ||
) | const |
Looks for the first command in the list which matches the given arguments.
If none is found, this returns either the default command (if one is set) or nullptr. If optionMustBeFirstArg is true, then only the first argument will be looked at when searching the available commands - this lets you do 'git' style commands where the executable name is followed by a verb.
Definition at line 318 of file juce_ConsoleApplication.cpp.
References juce::ArgumentList::indexOfOption().
const std::vector< ConsoleApplication::Command > & juce::ConsoleApplication::getCommands | ( | ) | const |
Gives read-only access to the list of registered commands.
Definition at line 387 of file juce_ConsoleApplication.cpp.
References juce::ConsoleApplication::Command::argumentDescription, juce::ArgumentList::executableName, juce::String::fromLastOccurrenceOf(), juce::String::paddedRight(), and juce::ConsoleApplication::Command::shortDescription.