CommandLine.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library is distributed in the hope that it will be useful, but        │
│   WITHOUT ANY WARRANTY; without even the implied warranty of                 │
│   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <iostream>
#include <list>
#include <map>
#include <set>
#include <sptk5/RegularExpression.h>
#include <sptk5/cutils>
 
namespace sptk {
 
class SP_EXPORT CommandLine
{
public:
    class SP_EXPORT Visibility
    {
    public:
        Visibility(const String& pattern, bool mustMatch = true);
 
        bool any() const;
 
        bool matches(const String& command) const;
 
    private:
        bool m_inverted;                             
        std::shared_ptr<RegularExpression> m_regexp; 
    };
 
    static void printLine(const String& ch, size_t count);
 
    void printCommands(const String& onlyForCommand, size_t screenColumns, size_t nameColumns,
                       const Strings& sortedCommands, size_t helpTextColumns) const;
 
    void printOptions(const String& onlyForCommand, size_t screenColumns, size_t nameColumns,
                      const Strings& sortedOptions, size_t helpTextColumns) const;
 
    CommandLine(const String& programVersion, const String& description, const String& commandLinePrototype);
 
    void defineOption(const String& fullName, const String& shortName, const Visibility& useForCommands, const String& help);
 
    void defineParameter(const String& fullName, const String& shortName, const String& valueName,
                         const String& validateValue,
                         const Visibility& useForCommands, const String& defaultValue, const String& help);
 
    void defineArgument(const String& fullName, const String& helpText);
 
    void init(size_t argc, const char** argv);
 
    String getOptionValue(const String& name) const;
 
    bool hasOption(const String& name) const;
 
    void setOptionValue(const String& name, const String& value = "yes");
 
    const Strings& arguments() const;
 
    void printHelp(size_t screenColumns) const;
 
    void printHelp(const String& onlyForCommand, size_t screenColumns) const;
 
    void printVersion() const;
 
    static Strings preprocessArguments(const std::vector<const char*>& argv);
 
    static Strings rewriteArguments(const Strings& arguments);
 
    class SP_EXPORT CommandLineElement
    {
    public:
        enum class Type
        {
            IS_UNKNOWN,     
            IS_COMMAND,     
            IS_OPTION,      
            IS_VALUE_OPTION 
        };
 
        CommandLineElement(const String& name, const String& shortName, const String& help,
                           const Visibility& useWithCommands);
 
        virtual ~CommandLineElement() = default;
 
        virtual Type type() const;
 
        virtual String name() const;
 
        virtual String shortName() const;
 
        virtual bool hasValue() const;
 
        virtual void validate(const String& value) const;
 
        virtual String printableName() const;
 
        bool useWithCommand(const String& command) const;
 
        void formatHelp(size_t textWidth, Strings& formattedText) const;
 
        void printHelp(size_t nameWidth, size_t textWidth, const String& optionDefaultValue) const;
 
    private:
        String m_name;
 
        String m_shortName;
 
        String m_help;
 
        Visibility m_useWithCommands;
    };
 
    class SP_EXPORT CommandLineArgument
        : public CommandLineElement
    {
    public:
        CommandLineArgument(const String& name, const String& help);
 
        ~CommandLineArgument() override = default;
    };
 
    class SP_EXPORT CommandLineOption
        : public CommandLineElement
    {
    public:
        CommandLineOption(const String& name, const String& shortName, const Visibility& useWithCommands,
                          const String& help);
 
        ~CommandLineOption() override = default;
 
        bool hasValue() const override;
 
        CommandLineElement::Type type() const override;
 
        String printableName() const override;
    };
 
    class SP_EXPORT CommandLineParameter
        : public CommandLineElement
    {
    public:
        CommandLineParameter(const String& name, const String& shortName, const String& valueName,
                             const String& validateValue,
                             const Visibility& useWithCommands, const String& help);
 
        String printableName() const override;
 
        void validate(const String& value) const override;
 
        bool hasValue() const override;
 
        Type type() const override;
 
    private:
        String m_valueInfo;                                 
        std::shared_ptr<RegularExpression> m_validateValue; 
    };
 
private:
    String m_programVersion;                                                 
    String m_description;                                                    
    String m_commandLinePrototype;                                           
    std::map<String, std::shared_ptr<CommandLineElement>> m_optionTemplates; 
 
    std::map<String, std::shared_ptr<CommandLineArgument>> m_argumentTemplates;
    std::map<String, String> m_values;                            
    Strings m_arguments;                                          
    fs::path m_executablePath;                                    
    std::list<std::shared_ptr<CommandLineElement>> m_allElements; 
 
    static String preprocessArgument(String& arg, String& quote, String& quotedString);
 
    void readOption(const Strings& digestedArgs, size_t& i);
};
 
} // namespace sptk