ErrorLogger.cc

Go to the documentation of this file.

#include "utl/ErrorLogger.h"
#include <config.h>

#include <string>
#include <vector>
#include <iostream>
#include <sstream>
#include <cstdio>
#include <unistd.h>

using namespace utl;
using namespace std;


ErrorLogger::ErrorLogger() :
  fBaseDirLength(string(__FILE__).size() - string("Utilities/ErrorLogger/ErrorLogger.cc").size()),
  fColorOutput(isatty(fileno(stderr)))
{ }


string
ErrorLogger::GetSeverityName(const ESeverityLevel severity)
  const
{
  /*
    VT100 console control codes for color:

    <ESC>[{attr1};...;{attrn}m

    The following lists standard attributes:

    0       Reset all attributes
    1       Bright
    2       Dim
    4       Underscore
    5       Blink
    7       Reverse
    8       Hidden

            Foreground Colours
    30      Black
    31      Red
    32      Green
    33      Yellow
    34      Blue
    35      Magenta
    36      Cyan
    37      White

            Background Colours
    40      Black
    41      Red
    42      Green
    43      Yellow
    44      Blue
    45      Magenta
    46      Cyan
    47      White
  */
  if (HasColor()) {
    const char* const names[] = {
      "\033[1;35m[DEBUG]\033[0m",
      "\033[1;34m[INFO]\033[0m",
      "\033[1;36m[WARN]\033[0m",
      "\033[1;31m[ERROR]\033[0m",
      "\033[1;31m[FATAL]\033[0m"
    };
    return names[severity - eMinSeverity];
  } else {
    const char* const names[] = {
      "[DEBUG]",
      "[INFO]",
      "[WARN]",
      "[ERROR]",
      "[FATAL]"
    };
    return names[severity - eMinSeverity];
  }
}


void
ErrorLogger::Log(const ESeverityLevel severity,
                 const string& functionName,
                 const string& fileName,
                 const int lineNumber,
                 const string& message,
                 EVerbosity verbosity,
                 bool stripBaseDir)
  const
{
  if (severity < fMinSeverity)
    return;

  if (verbosity == Verbosity::eDefault)
    verbosity = fVerbosity;

  ostringstream temp;
  if (verbosity >= Verbosity::eSeverity) {
    temp << GetSeverityName(severity) << ' ';
  }
  if (verbosity >= Verbosity::eFileInfo) {
    temp << ((stripBaseDir && fBaseDirLength < fileName.size()) ?
             fileName.substr(fBaseDirLength, fileName.size()) : fileName)
         << ':' << lineNumber << ": ";
  }
  if (verbosity >= Verbosity::eFunction)
    temp << functionName << ": ";

  if (verbosity >= Verbosity::eTerse)
    temp << message << endl;
  const string line = temp.str();

  ostream& output = fOStream ? *fOStream : cerr;

  output << line;

  if (eError <= severity)
    ++fListOfErrorMessages[line];
}


void
ErrorLogger::WriteErrorMessagesToStream()
{
  if (!fListOfErrorMessages.empty()) {
    ostream& output = fOStream ? *fOStream : cerr;
    if (HasColor())
      output << "\n\033[1;36mSummary of previous errors:\033[0m\n";
    else
      output << "\nSummary of previous errors:\n";
    const int maxLines = 50;
    int nLines = 0;
    for (const auto& mn : fListOfErrorMessages) {
      const auto& message = mn.first;
      const auto& count = mn.second;
      output << "\033[1;36m" << count << "x\033[0m " << message;
      ++nLines;
      if (nLines >= maxLines) {
        WARNING("... too long ...");
        ostringstream warn;
        warn << "List of previous errors was truncated at the " << nLines << " lines "
                "out of total " << fListOfErrorMessages.size();
        WARNING(warn);
        break;
      }
    }
  }
}