OpenShot Library | OpenShotAudio  0.2.2
juce::ConsoleApplication Struct Reference

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.
 
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.
 
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 CommandfindCommand (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.
 

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...
 

Detailed Description

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:

int main (int argc, char* argv[])
{
ConsoleApplication app;
app.addHelpCommand ("--help|-h", "Usage:", true);
app.addVersionCommand ("--version|-v", "MyApp version 1.2.3");
app.addCommand ({ "--foo",
"--foo filename",
"Performs a foo operation on the given file",
[] (const auto& args) { doFoo (args); }});
return app.findAndRunCommand (argc, argv);
}
See also
ArgumentList

Definition at line 240 of file juce_ConsoleApplication.h.


Class Documentation

◆ juce::ConsoleApplication::Command

struct juce::ConsoleApplication::Command

Represents a command that can be executed if its command-line arguments are matched.

See also
ConsoleApplication::addCommand(), ConsoleApplication::findAndRunCommand()

Definition at line 250 of file juce_ConsoleApplication.h.

Class Members
String commandOption The option string that must appear in the argument list for this command to be invoked.

This can also be a list of different versions separated by pipes, e.g. "--help|-h"

String argumentDescription A description of the command-line arguments needed for this command, which will be printed as part of the help text.
String shortDescription A short (one line) description of this command, which can be printed by ConsoleApplication::printCommandList().
String longDescription A longer description of this command, for use in extended help.
function< void(const ArgumentList &)> command The actual command that should be invoked to perform this action.

Member Function Documentation

◆ addHelpCommand()

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.

References addCommand(), addDefaultCommand(), and printCommandList().

◆ fail()

void juce::ConsoleApplication::fail ( String  errorMessage,
int  returnCode = 1 
)
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().

See also
ConsoleApplication::invokeCatchingFailures()

Definition at line 296 of file juce_ConsoleApplication.cpp.

Referenced by juce::ArgumentList::checkMinNumArguments(), juce::ArgumentList::failIfOptionIsMissing(), findAndRunCommand(), and juce::ArgumentList::Argument::resolveAsExistingFolder().

◆ invokeCatchingFailures()

int juce::ConsoleApplication::invokeCatchingFailures ( std::function< int()> &&  functionToCall)
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.

See also
ConsoleApplication::fail()

Definition at line 301 of file juce_ConsoleApplication.cpp.

Referenced by findAndRunCommand().

◆ findAndRunCommand()

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.

References fail(), findCommand(), and invokeCatchingFailures().

Referenced by findAndRunCommand().

◆ findCommand()

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().

Referenced by findAndRunCommand().


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