format_tdl.hpp

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2006-2024, Knut Reinert & Freie Universität Berlin
// SPDX-FileCopyrightText: 2016-2024, Knut Reinert & MPI für molekulare Genetik
// SPDX-License-Identifier: BSD-3-Clause
 
#pragma once
 
#if !SHARG_HAS_TDL
 
#    include <sharg/detail/format_help.hpp>
 
namespace sharg::detail
{
// A dummy class that is used when TDL is not available.
// This reduces the number of '#if's in the code.
// It will always throw when parse is called.
// For the user, the behavior of the parser will be the same as if `parser::init()` would check for TDL availability.
class format_tdl : public format_help
{
public:
    enum class FileFormat
    {
        CTD,
        CWL
    };
 
    format_tdl(format_tdl const &) = default;
    format_tdl & operator=(format_tdl const &) = default;
    format_tdl(format_tdl &&) = default;
    format_tdl & operator=(format_tdl &&) = default;
    ~format_tdl() = default;
 
    format_tdl(FileFormat fileFormat) : fileFormat{fileFormat}
    {}
 
    void parse(parser_meta_data &, std::vector<std::string> const &)
    {
        throw validation_error{"Validation failed for option --export-help: "
                               "Value must be one of "
                               + detail::supported_exports + "."};
    }
 
    FileFormat fileFormat;
};
 
} // namespace sharg::detail
 
#else
#    include <concepts>
#    include <numeric>
 
#    include <sharg/detail/format_base.hpp>
#    include <sharg/validators.hpp>
 
#    include <tdl/tdl.h>
 
namespace sharg::detail
{
 
inline auto to_tdl(bool v)
{
    return tdl::BoolValue(v);
}
 
auto to_tdl(std::integral auto v)
{
    return tdl::IntValue(v);
}
 
auto to_tdl(std::floating_point auto v)
{
    return tdl::DoubleValue(static_cast<double>(v));
}
 
inline auto to_tdl(std::string const & v)
{
    return tdl::StringValue(v);
}
 
auto to_tdl(auto SHARG_DOXYGEN_ONLY(v)) // NOLINT(performance-unnecessary-value-param)
{
    return tdl::BoolValue(false);
}
 
class format_tdl : format_base
{
public:
    enum class FileFormat : uint8_t
    {
        CTD, 
        CWL, 
    };
 
    std::vector<std::function<void(std::string_view)>> parser_set_up_calls;
    std::vector<std::function<void(std::string_view)>> positional_option_calls; // singled out to be printed on top
    unsigned positional_option_count{0};
 
    tdl::ToolInfo info;
 
    tdl::Node::Children parameters;
 
    FileFormat fileFormat;
 
    parser_meta_data meta;
 
public:
    format_tdl(FileFormat fileFormat) : fileFormat{fileFormat}
    {}
 
    format_tdl(format_tdl const &) = default;             
    format_tdl & operator=(format_tdl const &) = default; 
    format_tdl(format_tdl &&) = default;                  
    format_tdl & operator=(format_tdl &&) = default;      
    ~format_tdl() = default;                              
 
    template <typename option_type, typename validator_t>
    void add_option(option_type & value, config<validator_t> const & config)
    {
        auto description = config.description;
 
        if (config.default_message.empty())
            description += ((config.required) ? std::string{} : get_default_message(value, value));
        else
            description += get_default_message(value, config.default_message);
 
        if (auto const & validator_message = config.validator.get_help_page_message(); !validator_message.empty())
            description += ". " + validator_message;
 
        auto tags = std::set<std::string>{};
        if (config.required)
        {
            tags.insert("required");
        }
        if (config.advanced)
        {
            tags.insert("advanced");
        }
        if constexpr (std::same_as<std::filesystem::path, option_type>)
        {
            auto valueAsStr = to_string(value);
            store_help_page_element(
                [this, config, description, valueAsStr, _tags = tags](std::string_view)
                {
                    auto tags = _tags;
 
                    // Check if validator is a file,directory,input and/or output paremeter
                    using Validator = std::decay_t<decltype(config.validator)>;
                    if constexpr (std::is_base_of_v<sharg::input_file_validator, Validator>)
                    {
                        tags.insert("file");
                    }
                    else if constexpr (std::is_base_of_v<sharg::input_directory_validator, Validator>)
                    {
                        tags.insert("directory");
                    }
                    else if constexpr (std::is_base_of_v<sharg::output_file_validator, Validator>)
                    {
                        tags.insert("file");
                        tags.insert("output");
                    }
                    else if constexpr (std::is_base_of_v<sharg::output_directory_validator, Validator>)
                    {
                        tags.insert("directory");
                        tags.insert("output");
                    }
 
                    // gcc 15 doesn't like having the push_back as a one-liner.
                    parameters.push_back(tdl::Node{.name = config.long_id, .description = description});
 
                    auto & node = parameters.back();
                    node.tags = std::move(tags);
                    node.value = tdl::StringValue{valueAsStr};
 
                    info.cliMapping.emplace_back("--" + config.long_id, config.long_id);
                },
                config);
        }
        else
        {
            store_help_page_element(
                [this, config, value, description, tags](std::string_view)
                {
                    // gcc 15 with hardened flags (fedora-flags) doesn't like having the push_back as a one-liner.
                    parameters.push_back(tdl::Node{.name = config.long_id, .description = description});
 
                    auto & node = parameters.back();
                    node.tags = std::move(tags);
                    node.value = to_tdl(value);
 
                    info.cliMapping.emplace_back("--" + config.long_id, config.long_id);
                },
                config);
        }
    }
 
    template <typename validator_t>
    void add_flag(bool & value, config<validator_t> const & config)
    {
        store_help_page_element(
            [this, config, value](std::string_view)
            {
                parameters.push_back(tdl::Node{
                    .name = config.long_id,
                    .description = config.description,
                    .tags = {},
                    .value = to_tdl(value),
                });
            },
            config);
    }
 
    template <typename option_type, typename validator_t>
    void add_positional_option(option_type & value, config<validator_t> const & config)
    {
        // a list at the end may be empty and thus have a default value
        auto positional_default_message = [&value]() -> std::string
        {
            if constexpr (detail::is_container_option<option_type>)
            {
                return get_default_message(value, value);
            }
            else
            {
                (void)value; // Silence unused variable warning.
                return {};
            }
        };
 
        auto positional_validator_message = [&config]() -> std::string
        {
            if (auto const & validator_message = config.validator.get_help_page_message(); !validator_message.empty())
                return ". " + validator_message;
            else
                return {};
        };
 
        positional_option_calls.push_back(
            [this,
             config,
             default_message = positional_default_message(),
             validator_message = positional_validator_message()](std::string_view)
            {
                auto id = "positional_" + std::to_string(positional_option_count);
                ++positional_option_count;
                auto description = config.description + default_message + validator_message;
 
                parameters.push_back(tdl::Node{.name = id, .description = description});
 
                auto & node = parameters.back();
 
                if constexpr (detail::is_container_option<option_type>)
                {
                    node.value = tdl::StringValueList{};
                }
                else
                {
                    node.value = tdl::StringValue{};
                    node.tags.insert("required");
                }
            });
    }
 
    void parse(parser_meta_data & parser_meta, std::vector<std::string> const & executable_name)
    {
        meta = parser_meta;
 
        // each call will evaluate the function print_list_item()
        for (auto && f : positional_option_calls)
            f(meta.app_name);
 
        // each call will evaluate the function print_list_item()
        for (auto && f : parser_set_up_calls)
            f(meta.app_name);
 
        info.metaInfo = tdl::MetaInfo{
            .version = meta.version,
            .name = meta.app_name,
            .docurl = meta.url,
            .category = "",
            .description = std::accumulate(begin(meta.description),
                                           end(meta.description),
                                           std::string{},
                                           [](auto const & a, auto const & v)
                                           {
                                               return a + v + '\n';
                                           }),
            //            .citations   = {meta.citation},
        };
        if (!executable_name.empty())
        {
            info.metaInfo.executableName = executable_name[0];
        }
        for (size_t i{1}; i < executable_name.size(); ++i)
        {
            parameters = {tdl::Node{
                .name = executable_name[executable_name.size() - i],
                .tags = {"basecommand"},
                .value = parameters,
            }};
        }
        info.params = std::move(parameters);
 
        if (fileFormat == FileFormat::CTD)
        {
            std::cout << tdl::convertToCTD(info);
        }
        else if (fileFormat == FileFormat::CWL)
        {
            std::cout << tdl::convertToCWL(info) << "\n";
        }
        else
        {
            throw std::runtime_error("unsupported file format (this is a bug)");
        }
        std::exit(EXIT_SUCCESS); // program should not continue from here
    }
 
    void add_section(std::string const & SHARG_DOXYGEN_ONLY(title), bool const SHARG_DOXYGEN_ONLY(advanced_only))
    {}
 
    void add_subsection(std::string const & SHARG_DOXYGEN_ONLY(title), bool const SHARG_DOXYGEN_ONLY(advanced_only))
    {}
 
    void add_line(std::string const & SHARG_DOXYGEN_ONLY(text),
                  bool SHARG_DOXYGEN_ONLY(is_paragraph),
                  bool const SHARG_DOXYGEN_ONLY(advanced_only))
    {}
 
    void add_list_item(std::string const & SHARG_DOXYGEN_ONLY(key),
                       std::string const & SHARG_DOXYGEN_ONLY(desc),
                       bool const SHARG_DOXYGEN_ONLY(advanced_only))
    {}
 
private:
    template <typename validator_t>
    void store_help_page_element(std::function<void(std::string_view)> printer, config<validator_t> const & config)
    {
        if (config.hidden)
            return;
        parser_set_up_calls.push_back(std::move(printer));
    }
};
 
} // namespace sharg::detail
 
#endif