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