63 lines
2.3 KiB
C++
63 lines
2.3 KiB
C++
|
// Copyright 2010 Google Inc.
|
||
|
|
// All rights reserved.
|
||
|
|
//
|
||
|
|
// Redistribution and use in source and binary forms, with or without
|
||
|
|
// modification, are permitted provided that the following conditions are
|
||
|
|
// met:
|
||
|
|
//
|
||
|
|
// * Redistributions of source code must retain the above copyright
|
||
|
|
// notice, this list of conditions and the following disclaimer.
|
||
|
|
// * Redistributions in binary form must reproduce the above copyright
|
||
|
|
// notice, this list of conditions and the following disclaimer in the
|
||
|
|
// documentation and/or other materials provided with the distribution.
|
||
|
|
// * Neither the name of Google Inc. nor the names of its contributors
|
||
|
|
// may be used to endorse or promote products derived from this software
|
||
|
|
// without specific prior written permission.
|
||
|
|
//
|
||
|
|
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
|
||
|
|
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
|
||
|
|
// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||
|
|
// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
|
||
|
|
// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
|
||
|
|
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
|
||
|
|
// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
|
||
|
|
// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
|
||
|
|
// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
|
||
|
|
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
|
||
|
|
// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||
|
|
|
||
|
|
/// \file cli/cmd_help.hpp
|
||
|
|
/// Provides the cmd_help class.
|
||
|
|
|
||
|
|
#if !defined(CLI_CMD_HELP_HPP)
|
||
|
|
#define CLI_CMD_HELP_HPP
|
||
|
|
|
||
|
|
#include "cli/common.hpp"
|
||
|
|
#include "utils/cmdline/commands_map.hpp"
|
||
|
|
|
||
|
|
namespace cli {
|
||
|
|
|
||
|
|
|
||
|
|
/// Implementation of the "help" subcommand.
|
||
|
|
class cmd_help : public cli_command
|
||
|
|
{
|
||
|
|
/// The set of program-wide options for which to provide help.
|
||
|
|
const utils::cmdline::options_vector* _options;
|
||
|
|
|
||
|
|
/// The set of commands for which to provide help.
|
||
|
|
const utils::cmdline::commands_map< cli_command >* _commands;
|
||
|
|
|
||
|
|
public:
|
||
|
|
cmd_help(const utils::cmdline::options_vector*,
|
||
|
|
const utils::cmdline::commands_map< cli_command >*);
|
||
|
|
|
||
|
|
int run(utils::cmdline::ui*, const utils::cmdline::parsed_cmdline&,
|
||
|
|
const utils::config::tree&);
|
||
|
|
};
|
||
|
|
|
||
|
|
|
||
|
|
} // namespace cli
|
||
|
|
|
||
|
|
|
||
|
|
#endif // !defined(CLI_CMD_HELP_HPP)
|