application.hpp revision 261897
1// 2// Automated Testing Framework (atf) 3// 4// Copyright (c) 2007 The NetBSD Foundation, Inc. 5// All rights reserved. 6// 7// Redistribution and use in source and binary forms, with or without 8// modification, are permitted provided that the following conditions 9// are met: 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. 15// 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. 28// 29 30#if !defined(_ATF_CXX_APPLICATION_HPP_) 31#define _ATF_CXX_APPLICATION_HPP_ 32 33#include <ostream> 34#include <set> 35#include <stdexcept> 36#include <string> 37 38namespace atf { 39namespace application { 40 41// ------------------------------------------------------------------------ 42// The "usage_error" class. 43// ------------------------------------------------------------------------ 44 45class usage_error : public std::runtime_error { 46 char m_text[4096]; 47 48public: 49 usage_error(const char*, ...) throw(); 50 ~usage_error(void) throw(); 51 52 const char* what(void) const throw(); 53}; 54 55// ------------------------------------------------------------------------ 56// The "option" class. 57// ------------------------------------------------------------------------ 58 59class option { 60 char m_character; 61 std::string m_argument; 62 std::string m_description; 63 64 friend class app; 65 66public: 67 option(char, const std::string&, const std::string&); 68 69 bool operator<(const option&) const; 70}; 71 72// ------------------------------------------------------------------------ 73// The "app" class. 74// ------------------------------------------------------------------------ 75 76class app { 77 void process_options(void); 78 void usage(std::ostream&); 79 80 bool inited(void); 81 82protected: 83 typedef std::set< option > options_set; 84 85 int m_argc; 86 char* const* m_argv; 87 88 const char* m_argv0; 89 const char* m_prog_name; 90 std::string m_description; 91 std::string m_manpage; 92 93 options_set options(void); 94 95 // To be redefined. 96 virtual std::string specific_args(void) const; 97 virtual options_set specific_options(void) const; 98 virtual void process_option(int, const char*); 99 virtual int main(void) = 0; 100 101public: 102 app(const std::string&, const std::string&); 103 virtual ~app(void); 104 105 int run(int, char* const*); 106}; 107 108} // namespace application 109} // namespace atf 110 111#endif // !defined(_ATF_CXX_APPLICATION_HPP_) 112