Abstract base class for all shell commands. More...

#include <ookii/shell_command.h>

Public Types
using	builder_type = basic_parser_builder< CharType, Traits, Alloc >
	The concrete type of basic_parser_builder used.

Public Member Functions
	basic_shell_command ()=default
	Initializes a new instance of the basic_shell_command class.

	basic_shell_command (builder_type &)
	Initializes a new instance of the basic_shell_command class. More...

virtual	~basic_shell_command ()=default
	Default destructor.

virtual int	run ()=0
	Runs the command, after argument parsing was successful. More...

Detailed Description

template<typename CharType = details::default_char_type, typename Traits = std::char_traits<CharType>, typename Alloc = std::allocator<CharType>>
class ookii::basic_shell_command< CharType, Traits, Alloc >

Abstract base class for all shell commands.

When you implement a shell command, you must derive from the basic_shell_command class, and implement the run() method.

In addition, you must provide a constructor that takes a reference to builder_type, which is a typedef for basic_parser_builder, which creates the arguments accepted by this command. This basic_parser_builder will have been initialized with the name and description of the command, as well as basic_parser_builder::case_sensitive() and basic_parser_builder::locale() values matching the basic_shell_command_manager.

To specify a name or description for your command, you can either pass them to basic_shell_command_manager::add_command(), or you can provide static methods that return them. If a name is not provided using either method, the name will match the type name of the shell command class.

For example:

class some_command : public std::shell_command
{
public:
    some_command(builder_type &builder)
    {
        // ...
    }
 
    virtual int run() override
    {
        // ...
    }
 
    static std::string name()
    {
        return "some_name";
    }
 
    static std::string description()
    {
        return "The description.";
    }
};

Several typedefs for common character types are provided:

Type	Definition
`ookii::shell_command`	`ookii::basic_shell_command<char>`
`ookii::wshell_command`	`ookii::basic_shell_command<wchar_t>`

Template Parameters

CharType	The character type used for arguments and other strings.
Traits	The character traits to use for strings. Defaults to `std::char_traits<CharType>`.
Alloc	The allocator to use for strings. Defaults to `std::allocator<CharType>`.

Constructor & Destructor Documentation

◆ basic_shell_command()

template<typename CharType = details::default_char_type, typename Traits = std::char_traits<CharType>, typename Alloc = std::allocator<CharType>>

ookii::basic_shell_command< CharType, Traits, Alloc >::basic_shell_command ( builder_type & )

inline

Initializes a new instance of the basic_shell_command class.

Attention: You don't need to call this constructor when implementing a derived class, as it does nothing. It exists so New-ShellCommand.ps1 can generate code that supports shell commands with a base class that does have a constructor.

Member Function Documentation

◆ run()

template<typename CharType = details::default_char_type, typename Traits = std::char_traits<CharType>, typename Alloc = std::allocator<CharType>>

virtual int ookii::basic_shell_command< CharType, Traits, Alloc >::run ( )

pure virtual

Runs the command, after argument parsing was successful.

Returns: The exit code for the command. Typically, this code will be returned from the application to the OS.

The documentation for this class was generated from the following file:

/mnt/d/Sven/Documents/Code/Ookii.CommandLine.Cpp/include/ookii/shell_command.h

Public Types