Help.h

Go to the documentation of this file.

#ifndef Cpl_TShell_Cmd_Help_h
#define Cpl_TShell_Cmd_Help_h
/*-----------------------------------------------------------------------------
* This file is part of the Colony.Core Project.  The Colony.Core Project is an
* open source project with a BSD type of licensing agreement.  See the license
* agreement (license.txt) in the top/ directory or on the Internet at
* http://integerfox.com/colony.core/license.txt
*
* Copyright (c) 2014-2022  John T. Taylor
*
* Redistributions of the source code must retain the above copyright notice.
*----------------------------------------------------------------------------*/
/** @file */
 
#include "colony_config.h"
#include "Cpl/TShell/Cmd/Command.h"
 
 
///
namespace Cpl {
///
namespace TShell {
///
namespace Cmd {
 
 
 
/** This class implements a  Shell command
 */
class Help : public Command
{
public:
    /// The command verb/identifier
    static constexpr const char* verb = "help";
 
    /// The command usage string
    static constexpr const char* usage = "help [* | <cmd>]";
 
    /** The command detailed help string (recommended that lines do not exceed 80 chars)
                                                          1         2         3         4         5         6         7         8
                                                 12345678901234567890123456789012345678901234567890123456789012345678901234567890
     */
    static constexpr const char* detailedHelp = "  Displays list of all supported commands and optionally their detailed help. If\n" 
                                                "  the second argument is command, then the detailed help for that command will\n"   
                                                "  be displayed.";
 
 
public:
    /// See Cpl::TShell::Command
    const char* getUsage() const noexcept { return usage; }
 
    /// See Cpl::TShell::Command
    const char* getHelp() const noexcept { return detailedHelp; }
 
 
public:
    /// Constructor
    Help( Cpl::Container::Map<Cpl::TShell::Command>& commandList,
          Security::Permission_T                     minPermLevel=OPTION_TSHELL_CMD_COMMAND_DEFAULT_PERMISSION_LEVEL ) noexcept;
 
 
public:
    /// See Cpl::TShell::Command
    Cpl::TShell::Command::Result_T execute( Cpl::TShell::Context_& context, char* cmdString, Cpl::Io::Output& outfd ) noexcept;
 
};
 
};      // end namespaces
};
};
#endif  // end header latch