OpenShot Library | OpenShotAudio 0.2.2
|
Holds a list of command-line arguments, and provides useful methods for searching and operating on them. More...
#include <juce_ConsoleApplication.h>
Classes | |
struct | Argument |
One of the arguments in an ArgumentList. More... | |
Public Member Functions | |
ArgumentList (String executable, StringArray arguments) | |
Creates an argument list for a given executable. More... | |
ArgumentList (int argc, char *argv[]) | |
Parses a standard argv/argc pair to create an argument list. More... | |
ArgumentList (const String &executable, const String &arguments) | |
Tokenises a string containing all the arguments to create an argument list. More... | |
ArgumentList (const ArgumentList &)=default | |
ArgumentList & | operator= (const ArgumentList &)=default |
int | size () const |
Returns the number of arguments in the list. More... | |
Argument | operator[] (int index) const |
Returns one of the arguments. More... | |
void | checkMinNumArguments (int expectedMinNumberOfArgs) const |
Throws an error unless there are at least the given number of arguments. More... | |
bool | containsOption (StringRef option) const |
Returns true if the given string matches one of the arguments. More... | |
bool | removeOptionIfFound (StringRef option) |
Returns true if the given string matches one of the arguments, and also removes the argument from the list if found. More... | |
int | indexOfOption (StringRef option) const |
Returns the index of the given string if it matches one of the arguments, or -1 if it doesn't. More... | |
void | failIfOptionIsMissing (StringRef option) const |
Throws an error unless the given option is found in the argument list. More... | |
String | getValueForOption (StringRef option) const |
Looks for a given argument and returns either its assigned value (for long options) or the string that follows it (for short options). More... | |
String | removeValueForOption (StringRef option) |
Looks for a given argument and returns either its assigned value (for long options) or the string that follows it (for short options). More... | |
File | getFileForOption (StringRef option) const |
Looks for the value of argument using getValueForOption() and tries to parse that value as a file. More... | |
File | getFileForOptionAndRemove (StringRef option) |
Looks for the value of argument using getValueForOption() and tries to parse that value as a file. More... | |
File | getExistingFileForOption (StringRef option) const |
Looks for a file argument using getFileForOption() and fails with a suitable error if the file doesn't exist. More... | |
File | getExistingFileForOptionAndRemove (StringRef option) |
Looks for a file argument using getFileForOption() and fails with a suitable error if the file doesn't exist. More... | |
File | getExistingFolderForOption (StringRef option) const |
Looks for a filename argument using getFileForOption() and fails with a suitable error if the file isn't a folder that exists. More... | |
File | getExistingFolderForOptionAndRemove (StringRef option) |
Looks for a filename argument using getFileForOption() and fails with a suitable error if the file isn't a folder that exists. More... | |
Public Attributes | |
String | executableName |
The name or path of the executable that was invoked, as it was specified on the command-line. More... | |
Array< Argument > | arguments |
The list of arguments (not including the name of the executable that was invoked). More... | |
Holds a list of command-line arguments, and provides useful methods for searching and operating on them.
You can create an ArgumentList manually, or give it some argv/argc values from a main() function to parse.
Definition at line 42 of file juce_ConsoleApplication.h.
juce::ArgumentList::ArgumentList | ( | String | executable, |
StringArray | arguments | ||
) |
Creates an argument list for a given executable.
Definition at line 137 of file juce_ConsoleApplication.cpp.
References arguments, juce::StringArray::removeEmptyStrings(), and juce::StringArray::trim().
juce::ArgumentList::ArgumentList | ( | int | argc, |
char * | argv[] | ||
) |
Parses a standard argv/argc pair to create an argument list.
Definition at line 147 of file juce_ConsoleApplication.cpp.
Tokenises a string containing all the arguments to create an argument list.
Definition at line 152 of file juce_ConsoleApplication.cpp.
int juce::ArgumentList::size | ( | ) | const |
Returns the number of arguments in the list.
Definition at line 157 of file juce_ConsoleApplication.cpp.
References arguments.
Referenced by checkMinNumArguments().
ArgumentList::Argument juce::ArgumentList::operator[] | ( | int | index | ) | const |
Returns one of the arguments.
Definition at line 158 of file juce_ConsoleApplication.cpp.
References arguments.
void juce::ArgumentList::checkMinNumArguments | ( | int | expectedMinNumberOfArgs | ) | const |
Throws an error unless there are at least the given number of arguments.
Definition at line 160 of file juce_ConsoleApplication.cpp.
References juce::ConsoleApplication::fail(), and size().
bool juce::ArgumentList::containsOption | ( | StringRef | option | ) | const |
Returns true if the given string matches one of the arguments.
The option can also be a list of different versions separated by pipes, e.g. "--help|-h"
Definition at line 177 of file juce_ConsoleApplication.cpp.
References indexOfOption().
bool juce::ArgumentList::removeOptionIfFound | ( | StringRef | option | ) |
Returns true if the given string matches one of the arguments, and also removes the argument from the list if found.
The option can also be a list of different versions separated by pipes, e.g. "--help|-h"
Definition at line 182 of file juce_ConsoleApplication.cpp.
References arguments, and indexOfOption().
int juce::ArgumentList::indexOfOption | ( | StringRef | option | ) | const |
Returns the index of the given string if it matches one of the arguments, or -1 if it doesn't.
The option can also be a list of different versions separated by pipes, e.g. "--help|-h"
Definition at line 166 of file juce_ConsoleApplication.cpp.
References arguments.
Referenced by containsOption(), failIfOptionIsMissing(), juce::ConsoleApplication::findCommand(), and removeOptionIfFound().
void juce::ArgumentList::failIfOptionIsMissing | ( | StringRef | option | ) | const |
Throws an error unless the given option is found in the argument list.
Definition at line 192 of file juce_ConsoleApplication.cpp.
References juce::ConsoleApplication::fail(), and indexOfOption().
Looks for a given argument and returns either its assigned value (for long options) or the string that follows it (for short options).
The option can also be a list of different versions separated by pipes, e.g. "--help|-h" If it finds a long option, it will look for an assignment with a '=' sign, e.g. "--file=foo.txt", and will return the string following the '='. If there's no '=', it will return an empty string. If it finds a short option, it will attempt to return the argument that follows it, unless it's another option. If the argument isn't found, this returns an empty string.
Definition at line 198 of file juce_ConsoleApplication.cpp.
References arguments.
Referenced by getFileForOption().
Looks for a given argument and returns either its assigned value (for long options) or the string that follows it (for short options).
This works like getValueForOption() but also removes the option argument (and any value arguments) from the list if they are found.
Definition at line 224 of file juce_ConsoleApplication.cpp.
References arguments.
Referenced by getFileForOptionAndRemove().
Looks for the value of argument using getValueForOption() and tries to parse that value as a file.
If the option isn't found, or if the value can't be parsed as a filename, it will throw an error.
Definition at line 259 of file juce_ConsoleApplication.cpp.
References getValueForOption().
Referenced by getExistingFileForOption(), and getExistingFolderForOption().
Looks for the value of argument using getValueForOption() and tries to parse that value as a file.
This works like getFileForOption() but also removes the option argument (and any value arguments) from the list if they are found.
Definition at line 264 of file juce_ConsoleApplication.cpp.
References removeValueForOption().
Referenced by getExistingFileForOptionAndRemove(), and getExistingFolderForOptionAndRemove().
Looks for a file argument using getFileForOption() and fails with a suitable error if the file doesn't exist.
Definition at line 269 of file juce_ConsoleApplication.cpp.
References getFileForOption().
Looks for a file argument using getFileForOption() and fails with a suitable error if the file doesn't exist.
This works like getExistingFileForOption() but also removes the option argument (and any value arguments) from the list if they are found.
Definition at line 274 of file juce_ConsoleApplication.cpp.
References getFileForOptionAndRemove().
Looks for a filename argument using getFileForOption() and fails with a suitable error if the file isn't a folder that exists.
Definition at line 279 of file juce_ConsoleApplication.cpp.
References getFileForOption().
Looks for a filename argument using getFileForOption() and fails with a suitable error if the file isn't a folder that exists.
This works like getExistingFolderForOption() but also removes the option argument (and any value arguments) from the list if they are found.
Definition at line 284 of file juce_ConsoleApplication.cpp.
References getFileForOptionAndRemove().
String juce::ArgumentList::executableName |
The name or path of the executable that was invoked, as it was specified on the command-line.
Definition at line 204 of file juce_ConsoleApplication.h.
The list of arguments (not including the name of the executable that was invoked).
Definition at line 207 of file juce_ConsoleApplication.h.
Referenced by ArgumentList(), getValueForOption(), indexOfOption(), operator[](), removeOptionIfFound(), removeValueForOption(), and size().