LogFilter.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
 
#include <string>
#include <set>
#include <stack>
 
namespace tarch {
  namespace logging {
    class LogFilter;
  }
}
 
class tarch::logging::LogFilter {
  private:
    std::string  _activeProgramPhase;
 
  public:
    struct FilterListEntry {
      static const int AnyRank;
 
      static const std::string TargetAll;
      static const std::string TargetInfo;
      static const std::string TargetDebug;
      static const std::string TargetTrace;
      static const std::string TargetWarning;
 
      static const std::string AlwaysOn;
 
      static const bool BlackListEntry;
      static const bool WhiteListEntry;
 
      std::string _targetName;
 
      int         _rank;
 
      std::string _namespaceName;
 
      bool        _isBlackEntry;
 
      std::string _programPhase;
 
      bool operator<(const FilterListEntry& b) const;
      bool operator==(const FilterListEntry& b) const;
      bool operator!=(const FilterListEntry& b) const;
 
      FilterListEntry( const std::string& targetName="", bool isBlackListEntry=false );
      FilterListEntry( const std::string& targetName, int rank, const std::string& className, bool isBlackListEntry, const std::string& programPhase );
 
      std::string toString() const;
    };
 
    typedef std::set<FilterListEntry> FilterList;
 
    FilterList  _filterlist;
 
    #if !defined(SharedMemoryParallelisation) && PeanoDebug>=1
    std::stack<std::string> _indentTraces;
    #endif
 
    LogFilter();
 
 
    bool filterOut(
      const std::string& targetName,
      const std::string& className
    );
 
  public:
    static LogFilter& getInstance();
 
    ~LogFilter();
 
    void addFilterListEntry( const FilterListEntry& entry);
    void addFilterListEntries( const FilterList&    entries);
    void clearFilterList();
    void printFilterListToCout() const;
 
    bool writeDebug(const std::string& trace);
    bool writeInfo(const std::string& trace);
    bool writeTrace(const std::string& trace);
    bool writeWarning(const std::string& trace);
 
    void switchProgramPhase(const std::string& activeProgramPhase);
};