shell_command_usage_options.h

Go to the documentation of this file.

#ifndef SHELL_COMMAND_USAGE_OPTIONS_H_
#define SHELL_COMMAND_USAGE_OPTIONS_H_
 
#pragma once
 
#include "usage_options.h"
 
namespace ookii
{
 
    template<typename CharType, typename Traits = std::char_traits<CharType>, typename Alloc = std::allocator<CharType>>
    class basic_shell_command_usage_options : public basic_usage_options<CharType, Traits, Alloc>
    {
    public:
        struct defaults
        {
            static constexpr auto command_usage_format = literal_cast<CharType>("{} <command> [args...]");
            static constexpr auto command_format = literal_cast<CharType>("    {}\n{}\n");
            static constexpr auto available_commands_header = literal_cast<CharType>("The following commands are available:");
            static constexpr size_t command_indent = 8;
        };
 
        using base_type = basic_usage_options<CharType, Traits, Alloc>;
        using string_type = typename base_type::string_type;
        using stream_type = typename base_type::stream_type;
 
        basic_shell_command_usage_options() = default;
 
        basic_shell_command_usage_options(stream_type &output)
            : base_type(output)
        {
        }
 
        basic_shell_command_usage_options(stream_type &output, stream_type &error)
            : base_type(output, error)
        {
        }
 
        string_type command_usage_format{defaults::command_usage_format.data()};
 
        string_type command_format{defaults::command_format.data()};
 
        string_type available_commands_header{defaults::available_commands_header.data()};
 
        size_t command_indent{defaults::command_indent};
    };
 
    using shell_command_usage_options = basic_shell_command_usage_options<char>;
    using wshell_command_usage_options = basic_shell_command_usage_options<wchar_t>;
}
 
#endif