juce_ConsoleApplication.h

Go to the documentation of this file.

 /*
  ==============================================================================
 
   This file is part of the JUCE library.
   Copyright (c) 2022 - Raw Material Software Limited
 
   JUCE is an open source library subject to commercial or open-source
   licensing.
 
   The code included in this file is provided under the terms of the ISC license
   http://www.isc.org/downloads/software-support-policy/isc-license. Permission
   To use, copy, modify, and/or distribute this software for any purpose with or
   without fee is hereby granted provided that the above copyright notice and
   this permission notice appear in all copies.
 
   JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
   EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
   DISCLAIMED.
 
  ==============================================================================
*/
 
namespace juce
{
 
//==============================================================================
struct ArgumentList
{
    ArgumentList (String executable, StringArray arguments);
 
    ArgumentList (int argc, char* argv[]);
 
    ArgumentList (const String& executable, const String& arguments);
 
    ArgumentList (const ArgumentList&) = default;
    ArgumentList& operator= (const ArgumentList&) = default;
 
    //==============================================================================
    struct Argument
    {
        String text;
 
        File resolveAsFile() const;
 
        File resolveAsExistingFile() const;
 
        File resolveAsExistingFolder() const;
 
        bool isLongOption() const;
 
        bool isShortOption() const;
 
        bool isLongOption (const String& optionRoot) const;
 
        String getLongOptionValue() const;
 
        bool isShortOption (char shortOptionCharacter) const;
 
        bool isOption() const;
 
        bool operator== (StringRef stringToCompare) const;
 
        bool operator!= (StringRef stringToCompare) const;
    };
 
    //==============================================================================
    int size() const;
 
    Argument operator[] (int index) const;
 
    void checkMinNumArguments (int expectedMinNumberOfArgs) const;
 
    bool containsOption (StringRef option) const;
 
    bool removeOptionIfFound (StringRef option);
 
    int indexOfOption (StringRef option) const;
 
    void failIfOptionIsMissing (StringRef option) const;
 
    String getValueForOption (StringRef option) const;
 
    String removeValueForOption (StringRef option);
 
    File getFileForOption (StringRef option) const;
 
    File getFileForOptionAndRemove (StringRef option);
 
    File getExistingFileForOption (StringRef option) const;
 
    File getExistingFileForOptionAndRemove (StringRef option);
 
    File getExistingFolderForOption (StringRef option) const;
 
    File getExistingFolderForOptionAndRemove (StringRef option);
 
    String executableName;
 
    Array<Argument> arguments;
};
 
 
//==============================================================================
struct ConsoleApplication
{
    //==============================================================================
    struct Command
    {
        String commandOption;
 
        String argumentDescription;
 
        String shortDescription;
 
        String longDescription;
 
        std::function<void (const ArgumentList&)> command;
    };
 
    //==============================================================================
    void addCommand (Command);
 
    void addDefaultCommand (Command);
 
    void addVersionCommand (String versionArgument, String versionText);
 
    void addHelpCommand (String helpArgument, String helpMessage, bool makeDefaultCommand);
 
    void printCommandList (const ArgumentList&) const;
 
    void printCommandDetails (const ArgumentList&, const Command&) const;
 
    //==============================================================================
    static void fail (String errorMessage, int returnCode = 1);
 
    static int invokeCatchingFailures (std::function<int()>&& functionToCall);
 
    //==============================================================================
    int findAndRunCommand (const ArgumentList&,
                           bool optionMustBeFirstArg = false) const;
 
    int findAndRunCommand (int argc, char* argv[]) const;
 
    const Command* findCommand (const ArgumentList&, bool optionMustBeFirstArg) const;
 
    const std::vector<Command>& getCommands() const;
 
private:
    //==============================================================================
    std::vector<Command> commands;
    int commandIfNoOthersRecognised = -1;
};
 
} // namespace juce