auxiliary.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2026, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2026, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#include <string>
#include <vector>
 
#include <sharg/platform.hpp>
 
namespace sharg
{
 
enum class update_notifications : uint8_t
{
    on, 
    off 
};
 
class vector_of_string : public std::vector<std::string>
{
private:
    using base_t = std::vector<std::string>;
 
public:
    using base_t::base_t;
 
    vector_of_string() = default;                                     
    vector_of_string(vector_of_string const &) = default;             
    vector_of_string & operator=(vector_of_string const &) = default; 
    vector_of_string(vector_of_string &&) = default;                  
    vector_of_string & operator=(vector_of_string &&) = default;      
    ~vector_of_string() = default;                                    
 
    template <typename... t>
        requires std::constructible_from<std::string, t...>
    constexpr vector_of_string(t &&... str) : base_t{std::string(std::forward<t>(str)...)}
    {}
 
    template <typename Iter>
        requires std::constructible_from<std::string, Iter, Iter>
              && std::same_as<std::decay_t<Iter>, std::string::value_type *>
    constexpr vector_of_string(Iter begin, Iter end) : base_t{std::string(begin, end)}
    {}
 
    constexpr vector_of_string(std::initializer_list<std::string::value_type> il) : base_t{{il}}
    {}
};
 
struct parser_meta_data // holds all meta information
{
    std::string app_name{};
 
    std::string version{};
 
    std::string short_description{};
 
    std::string author{};
 
    std::string email{};
 
    std::string date{};
 
    std::string url{};
 
    std::string short_copyright{};
 
    std::string long_copyright{};
 
    vector_of_string citation{};
 
    std::string man_page_title{};
 
    unsigned man_page_section{1};
 
    std::vector<std::string> description{};
 
    std::vector<std::string> synopsis{};
 
    std::vector<std::string> examples{};
 
    constexpr friend bool operator==(parser_meta_data, parser_meta_data) = default;
};
 
} // namespace sharg