2 // Automated Testing Framework (atf)
4 // Copyright (c) 2007 The NetBSD Foundation, Inc.
5 // All rights reserved.
7 // Redistribution and use in source and binary forms, with or without
8 // modification, are permitted provided that the following conditions
10 // 1. Redistributions of source code must retain the above copyright
11 // notice, this list of conditions and the following disclaimer.
12 // 2. Redistributions in binary form must reproduce the above copyright
13 // notice, this list of conditions and the following disclaimer in the
14 // documentation and/or other materials provided with the distribution.
16 // THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND
17 // CONTRIBUTORS ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
18 // INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
19 // MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 // IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS BE LIABLE FOR ANY
21 // DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 // DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE
23 // GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
24 // INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
25 // IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
26 // OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN
27 // IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 #if !defined(_ATF_CXX_APPLICATION_HPP_)
31 #define _ATF_CXX_APPLICATION_HPP_
39 namespace application
{
41 // ------------------------------------------------------------------------
42 // The "usage_error" class.
43 // ------------------------------------------------------------------------
45 class usage_error
: public std::runtime_error
{
49 usage_error(const char*, ...) throw();
50 ~usage_error(void) throw();
52 const char* what(void) const throw();
55 // ------------------------------------------------------------------------
56 // The "option" class.
57 // ------------------------------------------------------------------------
61 std::string m_argument
;
62 std::string m_description
;
67 option(char, const std::string
&, const std::string
&);
69 bool operator<(const option
&) const;
72 // ------------------------------------------------------------------------
74 // ------------------------------------------------------------------------
79 void process_options(void);
80 void usage(std::ostream
&);
85 typedef std::set
< option
> options_set
;
91 const char* m_prog_name
;
92 std::string m_description
;
93 std::string m_manpage
, m_global_manpage
;
96 options_set
options(void);
99 virtual std::string
specific_args(void) const;
100 virtual options_set
specific_options(void) const;
101 virtual void process_option(int, const char*);
102 virtual int main(void) = 0;
105 app(const std::string
&, const std::string
&, const std::string
&,
109 int run(int, char* const*);
112 } // namespace application
115 #endif // !defined(_ATF_CXX_APPLICATION_HPP_)