File size: 11,417 Bytes
5a600cf | 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 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2025 OpenFOAM Foundation
\\/ M anipulation |
-------------------------------------------------------------------------------
License
This file is part of OpenFOAM.
OpenFOAM 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.
OpenFOAM 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 OpenFOAM. If not, see <http://www.gnu.org/licenses/>.
Class
Foam::error
Description
Class to handle errors and exceptions in a simple, consistent stream-based
manner.
The error class is globally instantiated with a title string. Errors,
messages and other data are piped to the messageStream class in the
standard manner. Manipulators are supplied for exit and abort which may
terminate the program or throw an exception depending on whether the
exception handling has been switched on (off by default).
Usage
\code
error << "message1" << "message2" << FoamDataType << exit(errNo);
error << "message1" << "message2" << FoamDataType << abort();
\endcode
SourceFiles
error.C
\*---------------------------------------------------------------------------*/
#ifndef error_H
#define error_H
#include "OStringStream.H"
#include "messageStream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of friend functions and operators
class error;
Ostream& operator<<(Ostream&, const error&);
/*---------------------------------------------------------------------------*\
Class error Declaration
\*---------------------------------------------------------------------------*/
class error
:
public std::exception,
public messageStream
{
protected:
// Protected data
string functionName_;
string sourceFileName_;
label sourceFileLineNumber_;
bool abort_;
bool throwExceptions_;
OStringStream messageStream_;
public:
// Constructors
//- Construct from title string
error(const string& title);
// Member Functions
string message() const;
const string& functionName() const
{
return functionName_;
}
const string& sourceFileName() const
{
return sourceFileName_;
}
label sourceFileLineNumber() const
{
return sourceFileLineNumber_;
}
void throwExceptions()
{
throwExceptions_ = true;
}
void dontThrowExceptions()
{
throwExceptions_ = false;
}
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber = 0
);
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const string& functionName,
const char* sourceFileName,
const int sourceFileLineNumber = 0
);
//- Explicitly convert to OSstream for << operations
OSstream& operator()();
//- Convert to OSstream for << operations
operator OSstream&()
{
return this->operator()();
}
//- Create and return a dictionary
operator dictionary() const;
//- Helper function to print a stack (if OpenFOAM IO not yet
// initialised)
static void safePrintStack(std::ostream&);
//- Helper function to print a stack
static void printStack(Ostream&);
//- Exit : can be called for any error to exit program.
// Prints stack before exiting.
void exit(const int errNo = 1);
//- Abort : used to stop code for fatal errors.
// Prints stack before exiting.
void abort();
// Ostream operator
friend Ostream& operator<<(Ostream&, const error&);
};
// Forward declaration of friend functions and operators
class IOerror;
Ostream& operator<<(Ostream&, const IOerror&);
/*---------------------------------------------------------------------------*\
Class IOerrorLocation Declaration
\*---------------------------------------------------------------------------*/
class IOerrorLocation
{
// Private Data
//- File name
string ioFileName_;
//- Start line number
label ioStartLineNumber_;
//- End line number
label ioEndLineNumber_;
//- Is file global
bool ioGlobal_;
public:
// Constructors
//- Construct null
IOerrorLocation();
//- Construct from components
IOerrorLocation
(
const string& ioFileName,
const label ioStartLineNumber = -1,
const label ioEndLineNumber = -1,
const bool ioGlobal = false
);
//- Construct from a stream
IOerrorLocation(const IOstream&);
//- Construct from a dictionary
IOerrorLocation(const dictionary&);
// Member Functions
//- Access the file name
inline const string& ioFileName() const
{
return ioFileName_;
}
//- Access the start line number
inline label ioStartLineNumber() const
{
return ioStartLineNumber_;
}
//- Access the end line number
inline label ioEndLineNumber() const
{
return ioEndLineNumber_;
}
//- Assess to the global/local file switch
inline bool ioGlobal() const
{
return ioGlobal_;
}
};
/*---------------------------------------------------------------------------*\
Class IOerror Declaration
\*---------------------------------------------------------------------------*/
class IOerror
:
public error,
public IOerrorLocation
{
public:
// Constructors
//- Construct from title string
IOerror(const string& title);
// Member Functions
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber,
const IOerrorLocation& location
);
//- Print basic message and exit. Uses cerr if streams not constructed
// yet (at startup). Use in startup parsing instead of FatalError.
static void SafeFatalIOError
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber,
const IOstream&,
const string& msg
);
//- Create and return a dictionary
operator dictionary() const;
//- Exit : can be called for any error to exit program
void exit(const int errNo = 1);
//- Abort : used to stop code for fatal errors
void abort();
// Ostream operator
friend Ostream& operator<<(Ostream&, const IOerror&);
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Global error declarations: defined in error.C
extern error FatalError;
extern IOerror FatalIOError;
// Template argument dependent "false" for static_assert in templated functions
template <class... T>
constexpr bool False = false;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Convenience macros to add the file name and line number to the function name
//- Report an error message using Foam::FatalError
// for functionName in file __FILE__ at line __LINE__
#define FatalErrorIn(functionName) \
::Foam::FatalError((functionName), __FILE__, __LINE__)
//- Report an error message using Foam::FatalError
// for FUNCTION_NAME in file __FILE__ at line __LINE__
#define FatalErrorInFunction FatalErrorIn(FUNCTION_NAME)
//- Report an error message using Foam::FatalIOError
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define FatalIOErrorIn(functionName, ios) \
::Foam::FatalIOError((functionName), __FILE__, __LINE__, (ios))
//- Report an error message using Foam::FatalIOError
// for FUNCTION_NAME in file __FILE__ at line __LINE__
// for a particular IOstream
#define FatalIOErrorInFunction(ios) FatalIOErrorIn(FUNCTION_NAME, ios)
//- Report an error message using Foam::FatalIOError
// (or cerr if FatalIOError not yet constructed)
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define SafeFatalIOErrorIn(functionName, ios, msg) \
::Foam::IOerror::SafeFatalIOError \
((functionName), __FILE__, __LINE__, (ios), (msg))
//- Report an error message using Foam::FatalIOError
// (or cerr if FatalIOError not yet constructed)
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define SafeFatalIOErrorInFunction(ios, msg) \
SafeFatalIOErrorIn(FUNCTION_NAME, ios, msg)
//- Issue a FatalErrorIn for a function not currently implemented.
// The functionName is printed and then abort is called.
//
// This macro can be particularly useful when methods must be defined to
// complete the interface of a derived class even if they should never be
// called for this derived class.
#define notImplemented(functionName) \
FatalErrorIn(functionName) \
<< "Not implemented" << ::Foam::abort(::Foam::FatalError);
//- Issue a FatalErrorIn for a function not currently implemented.
// The FUNCTION_NAME is printed and then abort is called.
//
// This macro can be particularly useful when methods must be defined to
// complete the interface of a derived class even if they should never be
// called for this derived class.
#define NotImplemented notImplemented(FUNCTION_NAME)
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "errorManip.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|