xref: /freebsd/contrib/kyua/cli/cmd_about.hpp (revision 8881d206f4e68b564c2c5f50fc717086fc3e827a)
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_about.hpp
30 /// Provides the cmd_about class.
31 
32 #if !defined(CLI_CMD_ABOUT_HPP)
33 #define CLI_CMD_ABOUT_HPP
34 
35 #include "cli/common.hpp"
36 
37 namespace cli {
38 
39 
40 /// Implementation of the "about" subcommand.
41 class cmd_about : public cli_command
42 {
43     /// Path to the directory containing the distribution documents.
44     const std::string _docdir;
45 
46 public:
47     cmd_about(void);
48 
49     int run(utils::cmdline::ui*, const utils::cmdline::parsed_cmdline&,
50             const utils::config::tree&);
51 };
52 
53 
54 }  // namespace cli
55 
56 
57 #endif  // !defined(CLI_CMD_ABOUT_HPP)
58