1// Copyright 2010 The Kyua Authors. 2// All rights reserved. 3// 4// Redistribution and use in source and binary forms, with or without 5// modification, are permitted provided that the following conditions are 6// met: 7// 8// * Redistributions of source code must retain the above copyright 9// notice, this list of conditions and the following disclaimer. 10// * Redistributions in binary form must reproduce the above copyright 11// notice, this list of conditions and the following disclaimer in the 12// documentation and/or other materials provided with the distribution. 13// * Neither the name of Google Inc. nor the names of its contributors 14// may be used to endorse or promote products derived from this software 15// without specific prior written permission. 16// 17// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 18// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 19// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 20// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 21// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 22// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 23// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 24// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 25// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 26// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 27// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 29/// \file cli/cmd_help.hpp 30/// Provides the cmd_help class. 31 32#if !defined(CLI_CMD_HELP_HPP) 33#define CLI_CMD_HELP_HPP 34 35#include "cli/common.hpp" 36#include "utils/cmdline/commands_map_fwd.hpp" 37 38namespace cli { 39 40 41/// Implementation of the "help" subcommand. 42class cmd_help : public cli_command 43{ 44 /// The set of program-wide options for which to provide help. 45 const utils::cmdline::options_vector* _options; 46 47 /// The set of commands for which to provide help. 48 const utils::cmdline::commands_map< cli_command >* _commands; 49 50public: 51 cmd_help(const utils::cmdline::options_vector*, 52 const utils::cmdline::commands_map< cli_command >*); 53 54 int run(utils::cmdline::ui*, const utils::cmdline::parsed_cmdline&, 55 const utils::config::tree&); 56}; 57 58 59} // namespace cli 60 61 62#endif // !defined(CLI_CMD_HELP_HPP) 63