/usr/include/openturns/Exception.hxx is in libopenturns-dev 0.15-2.
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 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 | // -*- C++ -*-
/**
* @file Exception.hxx
* @brief Exception defines top-most exception strategies
*
* (C) Copyright 2005-2011 EDF-EADS-Phimeca
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License.
*
* This library 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
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author: $LastChangedBy: schueller $
* @date: $LastChangedDate: 2011-04-11 12:32:27 +0200 (Mon, 11 Apr 2011) $
* Id: $Id: Exception.hxx 1866 2011-04-11 10:32:27Z schueller $
*/
#ifndef OPENTURNS_EXCEPTION_HXX
#define OPENTURNS_EXCEPTION_HXX
#include <exception>
#include "OTprivate.hxx"
#include "OSS.hxx"
namespace OpenTURNS
{
#ifndef SWIG
/*
* A helper class that saves the position where it was instanciated in file.
* This class works in conjonction with the preprocessor (cpp). See HERE macro
*/
class PointInSourceFile
{
public:
PointInSourceFile(const char * file, int line
#ifdef __GNUC__
, const char * function
#endif
)
: file_(file), line_(line)
#ifdef __GNUC__
, function_(function)
#endif
{}
~PointInSourceFile() {}
const char * getFile() const { return file_; }
int getLine() const { return line_; }
#ifdef __GNUC__
const char * getFunction() const { return function_; }
#endif
std::string str() const
{
std::ostringstream oss;
oss << file_ << ":" << line_
#ifdef __GNUC__
<< " (in " << function_ << ")"
#endif
;
return oss.str();
}
private:
const char * file_;
int line_;
#ifdef __GNUC__
const char * function_;
#endif
}; /* class PointInSourceFile */
/*
* The macro HERE creates a PointInSourceFile object that saves the position
* in the source file.
*/
#ifdef __GNUC__
#define HERE OpenTURNS::PointInSourceFile(__FILE__,__LINE__,__FUNCTION__)
#else
#define HERE OpenTURNS::PointInSourceFile(__FILE__,__LINE__)
#endif
#endif /* SWIG */
namespace Base
{
namespace Common
{
/**
* @class Exception
*
* @brief The base class for all Open TURNS' exceptions
*
* Exception defines top-most exception strategies. It derives from STL std::exception
* so Open TURNS' exceptions can be catched as standard exceptions.
*/
class Exception :
public std::exception
{
public:
/** Default constructor
* @internal
*/
Exception(const OpenTURNS::PointInSourceFile & point);
/** Copy constructor */
Exception(const Exception & other);
/** Destructor */
virtual ~Exception() throw();
/** @copydoc Object::__repr__() const */
String __repr__() const throw();
/** Point accessor
*
* This method returns a string describing where the exception was launched.
* No need to free the string.
*/
const char * where() const throw();
/** Reason accessor
*
* This method returns a string describing what was the reason of the exception.
* No need to free the string.
*/
const char * what() const throw();
/** Class name accessor
*
* This method returns a string containing the class of the exception.
* No need to free the string.
*/
const char * type() const throw();
/** Stream operator
*
* This method makes exceptions as friendly as std::ostream to add information.
* @param obj Any object that can be streamed out to an std::ostream can be appended to the exception's reason
*/
template <class T> Exception & operator << (T obj)
{
reason_ += OSS() << obj;
return *this;
}
protected:
/* Inheritance constructor */
Exception(const OpenTURNS::PointInSourceFile & point, const char * type);
private:
/** The point in source file where the exception was raised */
const PointInSourceFile point_;
/** Reason describes what was the exception */
String reason_;
/** Exception class name */
const char * className_;
}; /* class Exception */
/**
* @fn std::ostream & operator <<(std::ostream & os, const Exception & obj)
* @brief Output stream converter
* @param os A STL output stream exception
* @param obj The exception read by \em os
* @return A reference to \em os
*
* Operator << converts the Exception object to an output stream
* so it is easy to show the reason of the exception.
*/
std::ostream & operator <<(std::ostream & os, const Exception & obj);
#ifndef SWIG
OStream & operator <<(OStream & OS, const Exception & obj);
#endif
/*
*
* All exceptions defined for the user are listed below
*
*/
#define NEW_EXCEPTION( CName ) class CName : public OpenTURNS::Base::Common::Exception \
{ \
public: \
CName (const OpenTURNS::PointInSourceFile & point); \
virtual ~CName () throw(); \
template <class T> CName & operator << (T obj) \
{ \
this->Exception::operator << ( obj ); \
return *this; \
} \
}
/**
* @class FileNotFoundException
* @brief Raised when a file can not be found on filesystem
* @internal
*/
NEW_EXCEPTION( FileNotFoundException );
/**
* @class InternalException
* @brief Raised when an internal failure happened preventing processing termination
* @internal
*/
NEW_EXCEPTION( InternalException );
/**
* @class InvalidArgumentException
* @brief Raised when an incorrect argument is passed to a method
* @internal
*/
NEW_EXCEPTION( InvalidArgumentException );
/**
* @class InvalidDimensionException
* @brief Raised when an abject of an incorrect dimension is passed to a method
* @internal
*/
NEW_EXCEPTION( InvalidDimensionException );
/**
* @class NoWrapperFileFoundException
* @brief Raised when a wrapper can not be found on filesystem
* @internal
*/
NEW_EXCEPTION( NoWrapperFileFoundException );
/**
* @class NotYetImplementedException
* @brief Raised when a method has not been implemented yet though it should be
* @internal
*/
NEW_EXCEPTION( NotYetImplementedException );
/**
* @class OutOfBoundException
* @brief Raised when an index of a collection jumped out of the expected bounds
* @internal
*/
NEW_EXCEPTION( OutOfBoundException );
/**
* @class WrapperFileParsingException
* @brief Raised when a wrapper description file has a syntax error or a wrong value
* @internal
*/
NEW_EXCEPTION( WrapperFileParsingException );
/**
* @class WrapperInternalException
* @brief Raised when a wrapper raised an internal error preventing it from going on
* @internal
*/
NEW_EXCEPTION( WrapperInternalException );
/**
* @class XMLException
* @brief Raised when a general XML error was detected
* @internal
*/
NEW_EXCEPTION( XMLException );
/**
* @class XMLParserException
* @brief Raised when an XML error was detected during file parsing
* @internal
*/
NEW_EXCEPTION( XMLParserException );
/**
* @class DynamicLibraryException
* @brief Raised when a dynamic library can not be loaded or when a symbol can not be found in it
* @internal
*/
NEW_EXCEPTION( DynamicLibraryException );
/**
* @class NotSymmetricDefinitePositiveException
* @brief Raised when a matrix seems not to be symmetric nor positive definite
* @internal
*/
NEW_EXCEPTION( NotSymmetricDefinitePositiveException );
/**
* @class InvalidRangeException
* @brief Raised when an incorrect
* @internal
*/
NEW_EXCEPTION( InvalidRangeException );
/**
* @class NotDefinedException
* @brief Raised when raise when a method has no definition and should not have one
* @internal
*/
NEW_EXCEPTION( NotDefinedException );
/**
* @class FileOpenException
* @brief Raised when a file can not be opened
* @internal
*/
NEW_EXCEPTION( FileOpenException );
/**
* @class StudyFileParsingException
* @brief Raised when the study file can be read
* @internal
*/
NEW_EXCEPTION( StudyFileParsingException );
/**
* @class ObjectNotInStudyException
* @brief Raised when a file does not belong to a saved study
* @internal
*/
NEW_EXCEPTION( ObjectNotInStudyException );
/**
* @class ConfigurationFileParsingException
* @brief Raised when the configuration file can not be read
* @internal
*/
NEW_EXCEPTION( ConfigurationFileParsingException );
} /* namespace Common */
} /* namespace Base */
} /* namespace OpenTURNS */
#endif /* OPENTURNS_EXCEPTION_HXX */
|