File size: 10,478 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 | /*---------------------------------------------------------------------------*\
========= |
\\ / F ield | OpenFOAM: The Open Source CFD Toolbox
\\ / O peration | Website: https://openfoam.org
\\ / A nd | Copyright (C) 2011-2024 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::messageStream
Description
Class to handle messaging in a simple, consistent stream-based
manner.
The messageStream class is globally instantiated with a title string a
given severity, which controls the program termination, and a number of
errors before termination. Errors, messages and other data are piped to
the messageStream class in the standard manner.
Usage
\code
messageStream
<< "message1" << "message2" << FoamDataType << endl;
\endcode
SourceFiles
messageStream.C
\*---------------------------------------------------------------------------*/
#ifndef messageStream_H
#define messageStream_H
#include "label.H"
#include "string.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
namespace Foam
{
// Forward declaration of classes
class IOstream;
class Ostream;
class OSstream;
class OStringStream;
class dictionary;
/*---------------------------------------------------------------------------*\
Class messageStream Declaration
\*---------------------------------------------------------------------------*/
class messageStream
{
public:
//- Severity flags
enum errorSeverity
{
INFO, // Debugging information in event of error
WARNING, // Warning of possible problem
SERIOUS, // A serious problem (data corruption?)
FATAL // Oh bugger!
};
protected:
// Private Data
string title_;
errorSeverity severity_;
int maxErrors_;
int errorCount_;
public:
// Debug switches
static int level;
// Constructors
//- Construct from components
messageStream
(
const string& title,
const errorSeverity,
const int maxErrors = 0
);
// Member Functions
//- Return the title of this error type
const string& title() const
{
return title_;
}
//- Return the maximum number of errors before program termination
int maxErrors() const
{
return maxErrors_;
}
//- Return non-const access to the maximum number of errors before
// program termination to enable user to reset it
int& maxErrors()
{
return maxErrors_;
}
//- 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
);
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber,
const string& ioFileName,
const label ioLineNumber = -1
);
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber,
const IOstream&
);
//- Convert to OSstream
// Prints basic message and returns OSstream for further info.
OSstream& operator()
(
const char* functionName,
const char* sourceFileName,
const int sourceFileLineNumber,
const dictionary&
);
//- Explicitly convert to OSstream for << operations
OSstream& operator()(const label communicator = -1);
//- Convert to OSstream for << operations
operator OSstream&()
{
return this->operator()();
}
};
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Global error declarations: defined in messageStream.C
extern messageStream SeriousError;
extern messageStream Warning;
extern messageStream Info;
extern bool writeInfoHeader;
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
} // End namespace Foam
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#include "OSstream.H"
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
// Convenience macros to add the file name and line number to the function name
// Compiler provided function name string:
// for gcc-compatible compilers use __PRETTY_FUNCTION__
// otherwise use the standard __func__
#ifdef __GNUC__
#define FUNCTION_NAME __PRETTY_FUNCTION__
#else
#define FUNCTION_NAME __func__
#endif
//- Report an error message using Foam::SeriousError
// for functionName in file __FILE__ at line __LINE__
#define SeriousErrorIn(functionName) \
::Foam::SeriousError((functionName), __FILE__, __LINE__)
//- Report an error message using Foam::SeriousError
// for FUNCTION_NAME in file __FILE__ at line __LINE__
#define SeriousErrorInFunction SeriousErrorIn(FUNCTION_NAME)
//- Report an IO error message using Foam::SeriousError
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define SeriousIOErrorIn(functionName, ios) \
::Foam::SeriousError((functionName), __FILE__, __LINE__, ios)
//- Report an IO error message using Foam::SeriousError
// for FUNCTION_NAME in file __FILE__ at line __LINE__
// for a particular IOstream
#define SeriousIOErrorInFunction(ios) SeriousIOErrorIn(FUNCTION_NAME, ios)
//- Report a warning using Foam::Warning
// for functionName in file __FILE__ at line __LINE__
#define WarningIn(functionName) \
::Foam::Warning((functionName), __FILE__, __LINE__)
//- Report a warning using Foam::Warning
// for FUNCTION_NAME in file __FILE__ at line __LINE__
#define WarningInFunction WarningIn(FUNCTION_NAME)
//- Report an IO warning using Foam::Warning
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define IOWarningIn(functionName, ios) \
::Foam::Warning((functionName), __FILE__, __LINE__, (ios))
//- Report an IO warning using Foam::Warning
// for FUNCTION_NAME in file __FILE__ at line __LINE__
// for a particular IOstream
#define IOWarningInFunction(ios) IOWarningIn(FUNCTION_NAME, ios)
//- Report an information message using Foam::Info
// for functionName in file __FILE__ at line __LINE__
#define InfoIn(functionName) \
::Foam::Info((functionName), __FILE__, __LINE__)
//- Report an information message using Foam::Info
// for FUNCTION_NAME in file __FILE__ at line __LINE__
#define InfoInFunction InfoIn(FUNCTION_NAME)
//- Report write to Foam::Info if the local log switch is true
#define InfoHeader \
if (::Foam::writeInfoHeader) Info
//- Report write to Foam::Info if the local log switch is true
#define Log \
if (log) Info
//- Report an IO information message using Foam::Info
// for functionName in file __FILE__ at line __LINE__
// for a particular IOstream
#define IOInfoIn(functionName, ios) \
::Foam::Info((functionName), __FILE__, __LINE__, (ios))
//- Report an IO information message using Foam::Info
// for FUNCTION_NAME in file __FILE__ at line __LINE__
// for a particular IOstream
#define IOInfoInFunction(ios) IOInfoIn(FUNCTION_NAME, ios)
//- Report an information message using Foam::Info
// if the local debug switch is true
#define DebugInfo \
if (debug) Info
//- Report an information message using Foam::Info
// for FUNCTION_NAME in file __FILE__ at line __LINE__
// if the local debug switch is true
#define DebugInFunction \
if (debug) InfoInFunction
//- Report a variable name and value
// using Foam::Pout in file __FILE__ at line __LINE__
#define DebugVar(var) \
{ \
::Foam::string oldPrefix(::Foam::Pout.prefix()); \
::Foam::Pout<< "["<< __FILE__ << ":" << __LINE__ << "] "; \
::Foam::Pout.prefix() = oldPrefix + #var " "; \
::Foam::Pout<< var << ::Foam::endl; \
::Foam::Pout.prefix() = oldPrefix; \
}
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
#endif
// ************************************************************************* //
|