src/foam/db/error/messageStream.C

   1 /*---------------------------------------------------------------------------*\
   2   =========                 |
   3   \\      /  F ield         | foam-extend: Open Source CFD
   4    \\    /   O peration     | Version:     3.2
   5     \\  /    A nd           | Web:         http://www.foam-extend.org
   6      \\/     M anipulation  | For copyright notice see file Copyright
   7 -------------------------------------------------------------------------------
   8 License
   9     This file is part of foam-extend.
  10
  11     foam-extend 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 3 of the License, or (at your
  14     option) any later version.
  15
  16     foam-extend is distributed in the hope that it will be useful, but
  17     WITHOUT ANY WARRANTY; without even the implied warranty of
  18     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  19     General Public License for more details.
  20
  21     You should have received a copy of the GNU General Public License
  22     along with foam-extend.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 \*---------------------------------------------------------------------------*/
  25
  26 #include "error.H"
  27 #include "dictionary.H"
  28 #include "Pstream.H"
  29
  30 // * * * * * * * * * * * * * * Static Data Members * * * * * * * * * * * * * //
  31
  32 Foam::debug::debugSwitch
  33 Foam::messageStream::level
  34 (
  35     "level",
  36     2
  37 );
  38
  39
  40 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
  41
  42 Foam::messageStream::messageStream
  43 (
  44     const string& title,
  45     errorSeverity sev,
  46     const int maxErrors
  47 )
  48 :
  49     title_(title),
  50     severity_(sev),
  51     maxErrors_(maxErrors),
  52     errorCount_(0)
  53 {}
  54
  55
  56 Foam::messageStream::messageStream(const dictionary& dict)
  57 :
  58     title_(dict.lookup("title")),
  59     severity_(FATAL),
  60     maxErrors_(0),
  61     errorCount_(0)
  62 {}
  63
  64
  65 Foam::OSstream& Foam::messageStream::operator()
  66 (
  67     const char* functionName,
  68     const char* sourceFileName,
  69     const int sourceFileLineNumber
  70 )
  71 {
  72     OSstream& os = operator OSstream&();
  73
  74     os  << endl
  75         << "    From function " << functionName << endl
  76         << "    in file " << sourceFileName
  77         << " at line " << sourceFileLineNumber << endl
  78         << "    ";
  79
  80     return os;
  81 }
  82
  83
  84 Foam::OSstream& Foam::messageStream::operator()
  85 (
  86     const string& functionName,
  87     const char* sourceFileName,
  88     const int sourceFileLineNumber
  89 )
  90 {
  91     return operator()
  92     (
  93         functionName.c_str(),
  94         sourceFileName,
  95         sourceFileLineNumber
  96     );
  97 }
  98
  99
 100 Foam::OSstream& Foam::messageStream::operator()
 101 (
 102     const char* functionName,
 103     const char* sourceFileName,
 104     const int sourceFileLineNumber,
 105     const string& ioFileName,
 106     const label ioStartLineNumber,
 107     const label ioEndLineNumber
 108 )
 109 {
 110     OSstream& os = operator OSstream&();
 111
 112     os  << endl
 113         << "    From function " << functionName << endl
 114         << "    in file " << sourceFileName
 115         << " at line " << sourceFileLineNumber << endl
 116         << "    Reading " << ioFileName;
 117
 118     if (ioStartLineNumber >= 0 && ioEndLineNumber >= 0)
 119     {
 120         os  << " from line " << ioStartLineNumber
 121             << " to line " << ioEndLineNumber;
 122     }
 123     else if (ioStartLineNumber >= 0)
 124     {
 125         os  << " at line " << ioStartLineNumber;
 126     }
 127
 128     os << endl  << "    ";
 129
 130     return os;
 131 }
 132
 133
 134 Foam::OSstream& Foam::messageStream::operator()
 135 (
 136     const char* functionName,
 137     const char* sourceFileName,
 138     const int sourceFileLineNumber,
 139     const IOstream& ioStream
 140 )
 141 {
 142     return operator()
 143     (
 144         functionName,
 145         sourceFileName,
 146         sourceFileLineNumber,
 147         ioStream.name(),
 148         ioStream.lineNumber(),
 149         -1
 150     );
 151 }
 152
 153
 154 Foam::OSstream& Foam::messageStream::operator()
 155 (
 156     const char* functionName,
 157     const char* sourceFileName,
 158     const int sourceFileLineNumber,
 159     const dictionary& dict
 160 )
 161 {
 162     return operator()
 163     (
 164         functionName,
 165         sourceFileName,
 166         sourceFileLineNumber,
 167         dict.name(),
 168         dict.startLineNumber(),
 169         dict.endLineNumber()
 170     );
 171 }
 172
 173
 174 Foam::messageStream::operator Foam::OSstream&()
 175 {
 176     if (level)
 177     {
 178         bool collect = (severity_ == INFO || severity_ == WARNING);
 179
 180         // Report the error
 181         if (!Pstream::master() && collect)
 182         {
 183             return Snull;
 184         }
 185         else
 186         {
 187             if (title().size())
 188             {
 189                 if (Pstream::parRun() && !collect)
 190                 {
 191                     Pout<< title().c_str();
 192                 }
 193                 else
 194                 {
 195                     Sout<< title().c_str();
 196                 }
 197             }
 198
 199             if (maxErrors_)
 200             {
 201                 errorCount_++;
 202
 203                 if (errorCount_ >= maxErrors_)
 204                 {
 205                     FatalErrorIn("messageStream::operator OSstream&()")
 206                         << "Too many errors"
 207                         << abort(FatalError);
 208                 }
 209             }
 210
 211             if (Pstream::parRun() && !collect)
 212             {
 213                 return Pout;
 214             }
 215             else
 216             {
 217                 return Sout;
 218             }
 219         }
 220     }
 221
 222     return Snull;
 223 }
 224
 225
 226 // * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * //
 227 // Global messageStream definitions
 228
 229 Foam::messageStream Foam::SeriousError
 230 (
 231     "--> FOAM Serious Error : ",
 232     messageStream::SERIOUS,
 233     100
 234 );
 235
 236 Foam::messageStream Foam::Warning
 237 (
 238     "--> FOAM Warning : ",
 239     messageStream::WARNING
 240 );
 241
 242 Foam::messageStream Foam::Info("", messageStream::INFO);
 243
 244
 245 // ************************************************************************* //