OpenShot Library | libopenshot-audio  0.1.9
juce::ArgumentList Struct Reference

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
 
ArgumentListoperator= (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.
 
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...
 
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...
 
File getFileForOption (StringRef option) const
 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.
 
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.
 

Public Attributes

String executableName
 The name or path of the executable that was invoked, as it was specified on the command-line. More...
 
Array< Argumentarguments
 The list of arguments (not including the name of the executable that was invoked). More...
 

Detailed Description

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.

See also
ConsoleApplication

Definition at line 40 of file juce_ConsoleApplication.h.

Constructor & Destructor Documentation

◆ ArgumentList() [1/3]

juce::ArgumentList::ArgumentList ( String  executable,
StringArray  arguments 
)

Creates an argument list for a given executable.

Definition at line 120 of file juce_ConsoleApplication.cpp.

References arguments, juce::StringArray::removeEmptyStrings(), and juce::StringArray::trim().

◆ ArgumentList() [2/3]

juce::ArgumentList::ArgumentList ( int  argc,
char *  argv[] 
)

Parses a standard argv/argc pair to create an argument list.

Definition at line 130 of file juce_ConsoleApplication.cpp.

◆ ArgumentList() [3/3]

juce::ArgumentList::ArgumentList ( const String executable,
const String arguments 
)

Tokenises a string containing all the arguments to create an argument list.

Definition at line 135 of file juce_ConsoleApplication.cpp.

Member Function Documentation

◆ size()

int juce::ArgumentList::size ( ) const

Returns the number of arguments in the list.

Definition at line 140 of file juce_ConsoleApplication.cpp.

References arguments.

Referenced by checkMinNumArguments().

◆ checkMinNumArguments()

void juce::ArgumentList::checkMinNumArguments ( int  expectedMinNumberOfArgs) const

Throws an error unless there are at least the given number of arguments.

Definition at line 143 of file juce_ConsoleApplication.cpp.

References juce::ConsoleApplication::fail(), and size().

◆ containsOption()

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 160 of file juce_ConsoleApplication.cpp.

References indexOfOption().

Referenced by failIfOptionIsMissing().

◆ 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 149 of file juce_ConsoleApplication.cpp.

References arguments.

Referenced by containsOption(), and juce::ConsoleApplication::findCommand().

◆ failIfOptionIsMissing()

void juce::ArgumentList::failIfOptionIsMissing ( StringRef  option) const

Throws an error unless the given option is found in the argument list.

Definition at line 165 of file juce_ConsoleApplication.cpp.

References containsOption(), and juce::ConsoleApplication::fail().

Referenced by getFileForOption().

◆ getValueForOption()

String juce::ArgumentList::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).

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 171 of file juce_ConsoleApplication.cpp.

References arguments.

Referenced by getFileForOption().

◆ getFileForOption()

File juce::ArgumentList::getFileForOption ( StringRef  option) const

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 197 of file juce_ConsoleApplication.cpp.

References juce::ConsoleApplication::fail(), failIfOptionIsMissing(), and getValueForOption().

Referenced by getExistingFileForOption(), and getExistingFolderForOption().

Member Data Documentation

◆ executableName

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 167 of file juce_ConsoleApplication.h.

Referenced by juce::ConsoleApplication::printCommandList().

◆ arguments

Array<Argument> juce::ArgumentList::arguments

The list of arguments (not including the name of the executable that was invoked).

Definition at line 170 of file juce_ConsoleApplication.h.

Referenced by ArgumentList(), getValueForOption(), indexOfOption(), operator[](), and size().


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