src/OpenFOAM/db/error/messageStream.H

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | OpenFOAM: The Open Source CFD Toolbox
   4    \\    /   O peration     |
   5     \\  /    A nd           | Copyright held by original author
   6      \\/     M anipulation  |
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of OpenFOAM.
  10
  11     OpenFOAM is free software; you can redistribute it and/or modify it
  12     under the terms of the GNU General Public License as published by the
  13     Free Software Foundation; either version 2 of the License, or (at your
  14     option) any later version.
  15
  16     OpenFOAM is distributed in the hope that it will be useful, but WITHOUT
  17     ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  18     FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  19     for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with OpenFOAM; if not, write to the Free Software Foundation,
  23     Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
  24
  25 Class
  26     Foam::messageStream
  27
  28 Description
  29     Class to handle messaging in a simple, consistent stream-based
  30     manner.
  31
  32     The messageStream class is globaly instantiated with a title string a
  33     given severity, which controls the program termination, and a number of
  34     errors before termination.  Errors, messages and other data are piped to
  35     the messageStream class in the standard manner.
  36
  37 Usage
  38     @code
  39         messageStream << "message1" << "message2" << FoamDataType << endl;
  40     @endcode
  41
  42 SourceFiles
  43     messageStream.C
  44
  45 \*---------------------------------------------------------------------------*/
  46
  47 #ifndef messageStream_H
  48 #define messageStream_H
  49
  50 #include "label.H"
  51 #include "string.H"
  52
  53 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  54
  55 namespace Foam
  56 {
  57
  58 class IOstream;
  59 class Ostream;
  60 class OSstream;
  61 class OStringStream;
  62 class dictionary;
  63
  64 /*---------------------------------------------------------------------------*\
  65                            Class messageStream Declaration
  66 \*---------------------------------------------------------------------------*/
  67
  68 class messageStream
  69 {
  70
  71 public:
  72
  73     //- Severity flags
  74     enum errorSeverity
  75     {
  76         INFO,       // Debugging information in event of error
  77         WARNING,    // Warning of possible problem
  78         SERIOUS,    // A serious problem (data corruption?)
  79         FATAL       // Oh bugger!
  80     };
  81
  82
  83 protected:
  84
  85     // Private data
  86
  87         string title_;
  88         errorSeverity severity_;
  89         int maxErrors_;
  90         int errorCount_;
  91
  92
  93 public:
  94
  95     // Debug switches
  96
  97         static int level;
  98
  99
 100     // Constructors
 101
 102         //- Construct from components
 103         messageStream
 104         (
 105             const string& title,
 106             errorSeverity sev,
 107             const int maxErrors = 0
 108         );
 109
 110
 111         //- Construct from dictionary
 112         messageStream(const dictionary& dict);
 113
 114
 115     // Member functions
 116
 117         //- Return the title of this error type
 118         const string& title() const
 119         {
 120             return title_;
 121         }
 122
 123         //- Return the maximum number of errors before program termination
 124         int maxErrors() const
 125         {
 126             return maxErrors_;
 127         }
 128
 129         //- Return non-const access to the maximum number of errors before
 130         //  program termination to enable user to reset it
 131         int& maxErrors()
 132         {
 133             return maxErrors_;
 134         }
 135
 136         //- Convert to Ostream
 137         //  Prints basic message and then returns Ostream for further info.
 138         OSstream& operator()
 139         (
 140             const char* functionName,
 141             const char* sourceFileName,
 142             const int sourceFileLineNumber = 0
 143         );
 144
 145         OSstream& operator()
 146         (
 147             const string& functionName,
 148             const char* sourceFileName,
 149             const int sourceFileLineNumber = 0
 150         );
 151
 152         //- Convert to Ostream
 153         //  Prints basic message and then returns Ostream for further info.
 154         OSstream& operator()
 155         (
 156             const char* functionName,
 157             const char* sourceFileName,
 158             const int sourceFileLineNumber,
 159             const string& ioFileName,
 160             const label ioStartLineNumber = -1,
 161             const label ioEndLineNumber = -1
 162         );
 163
 164         //- Convert to Ostream
 165         //  Prints basic message and then returns Ostream for further info.
 166         OSstream& operator()
 167         (
 168             const char* functionName,
 169             const char* sourceFileName,
 170             const int sourceFileLineNumber,
 171             const IOstream&
 172         );
 173
 174         //- Convert to Ostream
 175         //  Prints basic message and then returns Ostream for further info.
 176         OSstream& operator()
 177         (
 178             const char* functionName,
 179             const char* sourceFileName,
 180             const int sourceFileLineNumber,
 181             const dictionary&
 182         );
 183
 184         //- Convert to Ostream for << operations
 185         operator OSstream&();
 186
 187         //- Explicitly convert to Ostream for << operations
 188         OSstream& operator()()
 189         {
 190             return operator OSstream&();
 191         }
 192 };
 193
 194
 195 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 196 // Global error declarations: defined in messageStream.C
 197
 198 extern messageStream SeriousError;
 199 extern messageStream Warning;
 200 extern messageStream Info;
 201
 202 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 203 // Convienient macros to add the file name and line number to the function name
 204
 205 #define SeriousErrorIn(fn) SeriousError(fn, __FILE__, __LINE__)
 206 #define SeriousIOErrorIn(fn, ios) SeriousError(fn, __FILE__, __LINE__, ios)
 207
 208 #define WarningIn(fn) Warning(fn, __FILE__, __LINE__)
 209 #define IOWarningIn(fn, ios) Warning(fn, __FILE__, __LINE__, ios)
 210
 211 #define InfoIn(fn) Info(fn, __FILE__, __LINE__)
 212 #define IOInfoIn(fn, ios) Info(fn, __FILE__, __LINE__, ios)
 213
 214 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 215
 216 } // End namespace Foam
 217
 218 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 219
 220 #include "OSstream.H"
 221
 222 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 223
 224 #endif
 225
 226 // ************************************************************************* //