program_options.h

Go to the documentation of this file.

// MIT License
// 
// Copyright (c) 2019 Ruhr University Bochum, Chair for Embedded Security. All Rights reserved.
// Copyright (c) 2019 Marc Fyrbiak, Sebastian Wallat, Max Hoffmann ("ORIGINAL AUTHORS"). All rights reserved.
// Copyright (c) 2021 Max Planck Institute for Security and Privacy. All Rights reserved.
// Copyright (c) 2021 Jörn Langheinrich, Julian Speith, Nils Albartus, René Walendy, Simon Klix ("ORIGINAL AUTHORS"). All Rights reserved.
// 
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
// 
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
// 
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
 
#pragma once
 
#include "hal_core/defines.h"
 
#include <initializer_list>
#include <map>
#include <memory>
#include <set>
#include <string>
#include <tuple>
#include <vector>
 
namespace hal
{
    class ProgramArguments;
 
    class CORE_API ProgramOptions
    {
    public:
        static const std::string A_REQUIRED_PARAMETER;
 
        ProgramOptions(const std::string& name = "");
 
        ~ProgramOptions() = default;
 
        ProgramArguments parse(int argc, const char* argv[]);
 
        std::vector<std::string> get_unknown_arguments();
 
        bool is_registered(const std::string& flag) const;
 
        bool add(const std::string& flag, const std::string& description, const std::initializer_list<std::string>& parameters = {});
 
        bool add(const std::initializer_list<std::string>& flags, const std::string& description, const std::initializer_list<std::string>& parameters = {});
 
        bool add_flags(const std::vector<std::string>& flags, const std::string& description, const std::vector<std::string>& parameters = {});
 
        bool add(const ProgramOptions& other_options, const std::string& category = "");
 
        bool remove(const std::string& flag);
 
        std::string get_options_string() const;
 
        std::vector<std::tuple<std::set<std::string>, std::string>> get_options() const;
 
    private:
        struct Option
        {
            std::string description;
            std::vector<std::string> parameters;
            std::set<std::string> flags;
        };
 
        std::string m_name;
 
        std::vector<Option> m_options;
 
        std::map<std::string, std::vector<ProgramOptions>> m_suboptions;
 
        std::vector<std::string> m_unknown_options;
 
        // returns all options, including those of added ProgramOptions objects
        std::vector<const Option*> get_all_options() const;
 
        // resets all options, including those of added ProgramOptions objects
        void reset_all_options();
 
        // resets a single option
        void reset_option(Option*);
 
        // returns the length of the longest formatted string containing the flags
        size_t get_flag_length() const;
 
        // returns the formatted string and starts the always after fill_length characters (space filled)
        std::string get_options_string_internal(size_t fill_length, size_t max_line_width) const;
    };
}    // namespace hal