command_line_generated.h File Reference

Provides helpers for using the New-Parser.ps1 and New-Subcommand.ps1 scripts. More...

#include "command_line.h"

Include dependency graph for command_line_generated.h:

Go to the source code of this file.

Namespaces
	ookii
	Namespace containing the core Ookii.CommandLine.Cpp types.

Macros
#define	OOKII_DECLARE_CREATE_BUILDER_METHOD()   OOKII_DECLARE_CREATE_BUILDER_METHOD_EX(ookii::details::default_char_type)
	A macro to declare the static build() method that the New-Parser.ps1 script will generate, using the specified character type. More...
#define	OOKII_DECLARE_CREATE_BUILDER_METHOD_EX(char_type)
	A macro to declare the static build() method that the New-Parser.ps1 script will generate, using the specified character type. More...
#define	OOKII_GENERATED_METHODS(type)   OOKII_GENERATED_METHODS_EX(type, ookii::details::default_char_type)
	A macro to declare the methods that a struct used with New-Parser.ps1 must have, using the default character type. More...
#define	OOKII_GENERATED_METHODS_EX(type, char_type)
	A macro to declare the methods that a struct used with New-Parser.ps1 must have, using the specified character type. More...

Functions
basic_command_manager< details::default_char_type >	ookii::register_commands (std::basic_string< details::default_char_type > application_name, basic_localized_string_provider< details::default_char_type > *string_provider=nullptr, const std::locale &locale={})
	Function that registers all the subcommands generated by New-Subcommand.ps1. More...

Detailed Description

Provides helpers for using the New-Parser.ps1 and New-Subcommand.ps1 scripts.

Macro Definition Documentation

OOKII_DECLARE_CREATE_BUILDER_METHOD

#define OOKII_DECLARE_CREATE_BUILDER_METHOD

(

)

OOKII_DECLARE_CREATE_BUILDER_METHOD_EX(ookii::details::default_char_type)

A macro to declare the static build() method that the New-Parser.ps1 script will generate, using the specified character type.

When using New-Parser.ps1, the definition of this method will be generated. This macro makes it easy to define a method that matches the exact signature expected.

The default character type is wchar_t if _UNICODE is defined; otherwise, it's char.

OOKII_DECLARE_CREATE_BUILDER_METHOD_EX

#define OOKII_DECLARE_CREATE_BUILDER_METHOD_EX

(

char_type

)

Value:

    ::ookii::basic_parser_builder<char_type> create_builder(::std::basic_string<char_type> command_name, \
        ::ookii::basic_localized_string_provider<char_type> *string_provider = nullptr, const std::locale &locale = {})

A macro to declare the static build() method that the New-Parser.ps1 script will generate, using the specified character type.

When using New-Parser.ps1, the definition of this method will be generated. This macro makes it easy to define a method that matches the exact signature expected.

Parameters

char_type

The character type to use for strings.

OOKII_GENERATED_METHODS

#define OOKII_GENERATED_METHODS

(

type

)

OOKII_GENERATED_METHODS_EX(type, ookii::details::default_char_type)

A macro to declare the methods that a struct used with New-Parser.ps1 must have, using the default character type.

This will add a build() method, which creates a ookii::basic_parser_builder, and a static parse() method, which will parse the arguments and handle errors. The New-Parser.ps1 script generates the definition of the build() method; the parse() method is defined by this macro.

The default character type is wchar_t if _UNICODE is defined; otherwise, it's char.

Parameters

type	The type of the struct or class that contains the arguments.

OOKII_GENERATED_METHODS_EX

#define OOKII_GENERATED_METHODS_EX	(		type,
			char_type
	)

Value:

    static ::std::optional<type> parse(int argc, const char_type* const argv[], ::ookii::basic_usage_writer<char_type> *usage = nullptr, \
        ::ookii::basic_localized_string_provider<char_type> *string_provider = nullptr, const std::locale &locale = {}) \
    { \
        auto name = ::ookii::basic_command_line_parser<char_type>::get_executable_name(argc, argv); \
        type args{}; \
        auto parser = args.create_builder(name, string_provider, locale).build(); \
        if (parser.parse(argc, argv, usage)) \
        { \
            return args; \
        } \
        return {}; \
    } \
    OOKII_DECLARE_CREATE_BUILDER_METHOD_EX(char_type)

A macro to declare the methods that a struct used with New-Parser.ps1 must have, using the specified character type.

This will add a build() method, which creates a ookii::basic_parser_builder, and a static parse() method, which will parse the arguments and handle errors. The New-Parser.ps1 script generates the definition of the build() method; the parse() method is defined by this macro.

Parameters

type	The type of the struct or class that contains the arguments.
char_type	The character type to use for strings.