/usr/include/Gyoto/GyotoError.h is in libgyoto4-dev 1.0.2-2ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | /**
* \file GyotoError.h
* \brief Error handling
*
* Gyoto dlopens its plug-ins. The throw/catch C++ mechanism cannot
* pass the dlopen boundary. The Gyoto::Error mechanism alleviates
* this C++ language limitation.
*
* Every Gyoto method (either in the main Gyoto library or in a Gyoto
* plug-in) should check for possible error conditions and throw
* adequate Gyoto::Error exceptions through the
* Gyoto::Error::throw() function. For instance:
* \code
* if (error_condition) Gyoto::Error::throw("Useful error message");
* \endcode
*
* If the main code has set Gyoto::Error::handler_t error handler
* using Gyoto::Error::setHandler(), these errors will then be passed
* to it. Else, the Error is C++-thrown at the main Gyoto library
* level, above the dlopen boundary.
*
* The main code can then catch these exceptions and act appropriately,
* for instance:
* \code
* try { gyoto_code ; }
* catch (Gyoto::Error err)
* {
* err.Report();
* abort();
* }
* \endcode
*
*/
/*
Copyright 2011, 2013 Thibaut Paumard
This file is part of Gyoto.
Gyoto is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Gyoto is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with Gyoto. If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef __GyotoError_H_
#define __GyotoError_H_
/**
* \namespace Gyoto
* \brief Namespace for the Gyoto library
*/
#include <string>
namespace Gyoto {
class Error;
}
/**
* \class Gyoto::Error
* \brief Class for thowing exceptions.
*
* Gyoto dlopens its plug-ins. The throw/catch C++ mechanism cannot
* pass the dlopen boundary. The Gyoto::Error mechanism alleviates
* this C++ language limitation.
*
* Every Gyoto method (either in the main Gyoto library or in a Gyoto
* plug-in) should check for possible error conditions and throw
* adequate Gyoto::Error exceptions through the
* Gyoto::throwError() function. For instance:
* \code
* if (error_condition) Gyoto::throwError("Useful error message");
* \endcode
*
* If the main code has set Gyoto::Error::handler_t error handler
* using Gyoto::Error::setHandler(), these errors will then be passed
* to it. Else, the Error is C++-thrown at the main Gyoto library
* level, above the dlopen boundary.
*
* The main code can then catch these exceptions and act appropriately,
* for instance:
* \code
* try { gyoto_code ; }
* catch (Gyoto::Error err)
* {
* err.Report();
* abort();
* }
* \endcode
*/
class Gyoto::Error
{
private:
/// Error message.
const std::string message;
/// Error code.
/**
* Default value is EXIT_FAILURE from cstdlib. Currently not used in
* practice.
*/
const int errcode;
public:
/// Constructor with an error message.
Error( const std::string m );
/// Print-out error message on standard error.
void Report() const ;
/// Retrieve error code.
/**
* See also operator const char * () const and get_message().
* \return Error code
*/
int getErrcode() const ;
/// Cast to const char *.
/**
* Retrieve error message as a C string. See also get_message() and
* gerErrcode().
*/
operator const char * () const;
/// Retrieve error message for custom handling of the exception.
/**
* See also operator const char * () const and getErrCode().
* \return char* message : pointer to the error message
*/
std::string get_message() const ;
/// Error handler type.
/**
* Instead of catching Gyoto errors directly (for instance if gyoto
* itself is dlopened), you can set a Handler_t error handler using
* setHandler().
*
* A very simple handler could be:
* \code
* void applicationErrorHandler(const Gyoto::Error e) {
* e.Report();
* exit ( e.getErrCode() );
* }
* \endcode
*/
typedef void Handler_t (const Error);
/// Set application error handler.
/**
* Instead of catching Gyoto errors directly (for instance if gyoto
* itself is dlopened), you can set an Error::Handler_t error
* handler using setHandler().
*
* \code
* void applicationErrorHandler(const Gyoto::Error e) {
* e.Report();
* exit ( e.getErrCode() );
* }
* int main() {
* Gyoto::Error::setHandler(&applicationErrorHandler);
* }
* \endcode
* \param phandler Function pointer to the handler.
*/
static void setHandler( Gyoto::Error::Handler_t* phandler);
};
namespace Gyoto {
/// Throw a Gyoto::Error
void throwError( std::string );
}
#endif
|