program.hpp

Go to the documentation of this file.

 
#pragma once
 
#include "presentation.hpp"
#include <functional>
#include <span>
 
namespace uni20::presentation
{
struct program_example
{
    std::string command;
    std::string description = {};
};
 
struct program_reference
{
    std::string key;
    std::string citation;
    std::string link = {};
    std::string applicability = {};
};
 
struct program_info
{
    std::string name;
    std::string description = {};
    std::string version = {};
    std::string revision = {};
    std::string copyright = {};
    std::string authors = {};
    std::string project_url = {};
    std::string license = {};
    std::vector<program_example> examples = {};
    std::vector<std::string> notes = {};
    std::function<std::vector<program_reference>()> references = {};
};
 
struct help_option
{
    std::string names;
    std::string description = {};
    std::vector<std::string> attributes = {};
};
 
struct help_group
{
    std::string heading;
    std::string description = {};
    std::vector<help_option> options = {};
};
 
[[nodiscard]] std::string program_identity(program_info const& program);
 
[[nodiscard]] report_builder program_report(program_info const& program);
 
[[nodiscard]] report_builder help_report(program_info const& program, std::string_view usage,
                                         std::span<help_group const> groups);
} // namespace uni20::presentation