CommandLineLogger.h

Go to the documentation of this file.

// This file is part of the Peano project. For conditions of distribution and
// use, please see the copyright notice at www.peano-framework.org
#pragma once
 
#ifdef Parallel
#include <mpi.h>
#endif
 
#include <iostream>
#include <fstream>
#include <set>
#include <stack>
 
#include "tarch/multicore/BooleanSemaphore.h"
#include "tarch/multicore/multicore.h"
#include "tarch/logging/Log.h"
 
namespace tarch {
  namespace logging {
    class CommandLineLogger;
  }
}
 
class tarch::logging::CommandLineLogger {
  private:
    static Log _log;
 
    static CommandLineLogger _singleton;
 
    tarch::multicore::BooleanSemaphore _semaphore;
 
    std::string    _logColumnSeparator;
    bool           _logTimeStamp;
    bool           _logTimeStampHumanReadable;
    bool           _logMachineName;
    bool           _logThreadName;
    bool           _logMessageType;
    bool           _logTrace;
    std::ostream*  _outputStream;
    bool           _hasWrittenToOuputStream;
    int            _iterationCounter;
    std::string    _outputFileName;
    bool           _quitOnError;
 
    CommandLineLogger& operator=(const CommandLineLogger&);
 
    CommandLineLogger(const CommandLineLogger&);
 
    static std::string::size_type _indent;
 
    static const std::string::size_type NumberOfIndentSpaces;
 
    static const std::string::size_type NumberOfStandardColumnSpaces;
 
    static const std::string::size_type NumberOfTraceColumnSpaces;
 
    static const int                    DigitsInFilenamesIterationNumer;
 
    std::string addSeparators(std::string::size_type spaces, std::string message) const;
 
    std::string constructMessageString(
      std::string          messageType,
      long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message
    );
 
    static std::string getTimeStampHumanReadable( long int timestampNanoseconds );
 
    void configureOutputStreams();
 
    CommandLineLogger();
 
    std::string getLogColumnSeparator() const;
    bool        getLogTimeStampHumanReadable() const;
    bool        getLogMessageType() const;
 
    std::ostream& out();
 
    void reopenOutputStream();
 
    std::stack< std::string >  _indentTraces;
 
  public:
    ~CommandLineLogger();
 
    static CommandLineLogger& getInstance();
 
    bool        getLogMachineName() const;
 
    bool        getLogThreadName() const;
 
    bool        getLogTrace() const;
 
    bool        getLogTimeStamp() const;
 
    void debug(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
    void info(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
 
    void warning(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
 
    void error(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
 
    void traceIn(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
    void traceOut(   long int timestampNanoseconds, int rank, int threadId, const std::string& trace, const std::string& message);
 
    void indent( bool indent, const std::string& trace, const std::string& message );
 
    void setLogColumnSeparator( const std::string& separator = " ");
    void setLogTimeStamp( bool value = true );
    void setLogTimeStampHumanReadable( bool value = true );
    void setLogMachineName( bool value = true );
    void setLogThreadName( bool value = true );
    void setLogMessageType( bool value = true );
    void setLogTrace( bool value = true );
 
    void setLogFormat(
      const std::string& columnSeparator,
      bool logTimeStamp,
      bool logTimeStampHumanReadable,
      bool logMachineName,
      bool logThreadName,
      bool logMessageType,
      bool logTrace,
      const std::string&  outputLogFileName
    );
 
    void setOutputFile( const std::string&  outputLogFileName );
 
    void setQuitOnError(bool value);
 
    void closeOutputStreamAndReopenNewOne();
 
    void close();
};