argument_base.hpp

Go to the documentation of this file.

// Copyright (c) 2023-2025 Jakub Musiał
// This file is part of the CPP-AP project (https://github.com/SpectraL519/cpp-ap).
// Licensed under the MIT License. See the LICENSE file in the project root for full license information.
 
#pragma once
 
#include "argument_descriptor.hpp"
#include "argument_name.hpp"
 
#include <any>
#include <iostream>
#include <vector>
 
namespace ap {
 
class argument_parser;
 
namespace detail {
 
class argument_base {
public:
    virtual ~argument_base() = default;
 
    friend class ::ap::argument_parser;
 
protected:
    argument_base(const argument_name& name, const bool required = false)
    : _name(name), _required(required) {}
 
    [[nodiscard]] const ap::detail::argument_name& name() const noexcept {
        return this->_name;
    }
 
    [[nodiscard]] const std::optional<std::string>& help() const noexcept {
        return this->_help_msg;
    }
 
    [[nodiscard]] bool is_hidden() const noexcept {
        return this->_hidden;
    }
 
    [[nodiscard]] bool is_required() const noexcept {
        return this->_required;
    }
 
    [[nodiscard]] bool bypass_required_enabled() const noexcept {
        return not this->_required and this->_bypass_required;
    }
 
    virtual detail::argument_descriptor desc(const bool verbose) const noexcept = 0;
 
    virtual bool mark_used() = 0;
 
    virtual bool is_used() const noexcept = 0;
 
    virtual std::size_t count() const noexcept = 0;
 
    virtual bool set_value(const std::string& value) = 0;
 
    virtual bool has_value() const noexcept = 0;
 
    virtual bool has_parsed_values() const noexcept = 0;
 
    virtual std::weak_ordering nvalues_ordering() const noexcept = 0;
 
    virtual const std::any& value() const = 0;
 
    virtual const std::vector<std::any>& values() const = 0;
 
    const ap::detail::argument_name _name;
    std::optional<std::string> _help_msg;
 
    bool _required : 1;
    bool _bypass_required : 1 = false;
    bool _hidden : 1 = false;
};
 
template <c_argument_value_type T>
[[nodiscard]] bool is_valid_choice(const T& value, const std::vector<T>& choices) noexcept {
    return choices.empty() or std::ranges::find(choices, value) != choices.end();
}
 
} // namespace detail
} // namespace ap