args.h

Go to the documentation of this file.

#ifndef ARGS_H
#define ARGS_H
 
#include <memory>
#include <optional>
#include <ostream>
#include <string>
#include <unordered_map>
#include <vector>
 
namespace mazes
{
    class args final
    {
    public:
        static constexpr auto APP_KEY = "app";
 
        static constexpr auto ALGO_ID_FLAG_STR = "-a";
        static constexpr auto ALGO_ID_OPTION_STR = "--algo";
        static constexpr auto ALGO_ID_WORD_STR = "algo";
 
        static constexpr auto BLOCK_ID_FLAG_STR = "-b";
        static constexpr auto BLOCK_ID_OPTION_STR = "--block";
        static constexpr auto BLOCK_ID_WORD_STR = "block";
 
        static constexpr auto ROW_FLAG_STR = "-r";
        static constexpr auto ROW_OPTION_STR = "--rows";
        static constexpr auto ROW_WORD_STR = "rows";
 
        static constexpr auto COLUMN_FLAG_STR = "-c";
        static constexpr auto COLUMN_OPTION_STR = "--columns";
        static constexpr auto COLUMN_WORD_STR = "columns";
 
        static constexpr auto LEVEL_FLAG_STR = "-l";
        static constexpr auto LEVEL_OPTION_STR = "--levels";
        static constexpr auto LEVEL_WORD_STR = "levels";
 
        // JSON related constants
        static constexpr auto JSON_FLAG_STR = "-j";
        static constexpr auto JSON_OPTION_STR = "--json";
        static constexpr auto JSON_WORD_STR = "json";
 
        // Output related constants
        static constexpr auto OUTPUT_ID_FLAG_STR = "-o";
        static constexpr auto OUTPUT_ID_OPTION_STR = "--output";
        static constexpr auto OUTPUT_ID_WORD_STR = "output";
        static constexpr auto DEFAULT_OUTPUT_FILENAME = "maze.txt";
 
        // Output filename related constants
        static constexpr auto OUTPUT_FILENAME_WORD_STR = "output_filename";
 
        // Seed related constants
        static constexpr auto SEED_FLAG_STR = "-s";
        static constexpr auto SEED_OPTION_STR = "--seed";
        static constexpr auto SEED_WORD_STR = "seed";
 
        // Distances related constants
        static constexpr auto DISTANCES_FLAG_STR = "-d";
        static constexpr auto DISTANCES_OPTION_STR = "--distances";
        static constexpr auto DISTANCES_WORD_STR = "distances";
        static constexpr auto DISTANCES_START_STR = "distances_start";
        static constexpr auto DISTANCES_END_STR = "distances_end";
 
        // Image dimension related constants
        static constexpr auto IMAGE_WIDTH_WORD_STR = "image_width";
        static constexpr auto IMAGE_HEIGHT_WORD_STR = "image_height";
        static constexpr auto IMAGE_WIDTH_OPTION_STR = "--image-width";
        static constexpr auto IMAGE_HEIGHT_OPTION_STR = "--image-height";
        static constexpr auto IMAGE_WIDTH_FLAG_STR = "-W";
        static constexpr auto IMAGE_HEIGHT_FLAG_STR = "-H";
 
        // Help related constants
        static constexpr auto HELP_FLAG_STR = "-h";
        static constexpr auto HELP_OPTION_STR = "--help";
        static constexpr auto HELP_WORD_STR = "help";
 
        // Version related constants
        static constexpr auto VERSION_FLAG_STR = "-v";
        static constexpr auto VERSION_OPTION_STR = "--version";
        static constexpr auto VERSION_WORD_STR = "version";
 
        // Mask related constants
        static constexpr auto MASK_FLAG_STR = "-m";
        static constexpr auto MASK_OPTION_STR = "--mask";
        static constexpr auto MASK_WORD_STR = "mask";
 
        // Step visualization constants
        static constexpr auto SHOW_STEPS_OPTION_STR = "--show-steps";
        static constexpr auto SHOW_STEPS_WORD_STR = "show_steps";
 
        // Special values
        static constexpr auto TRUE_VALUE = "true";
        static constexpr auto FALSE_VALUE = "false";
 
        args() noexcept;
 
        ~args();
 
        args(const args& other);
 
        args& operator=(const args& other);
 
        args(args&& other) noexcept;
 
        args& operator=(args&& other) noexcept;
 
        bool parse(const std::vector<std::string>& arguments,
                   bool has_program_name_as_first_arg = false) const noexcept;
 
        bool parse(const std::string& arguments, bool has_program_name_as_first_arg = false) const noexcept;
 
        bool parse(int argc, char** argv, bool has_program_name_as_first_arg = false) const noexcept;
 
        void clear() const noexcept;
 
        [[nodiscard]] std::optional<std::string> get(const std::string& key) const noexcept;
 
        [[nodiscard]] std::optional<std::unordered_map<std::string, std::string>> get() const noexcept;
 
        [[nodiscard]] std::optional<std::vector<std::unordered_map<std::string, std::string>>>
        get_array() const noexcept;
 
    private:
        // Private implementation class (PIMPL idiom)
        class impl;
        std::unique_ptr<impl> pimpl;
    };
}
#endif // ARGS_H