ELdestination.cc

Go to the documentation of this file.

// ----------------------------------------------------------------------
//
// ELdestination.cc
//
// History:
//
// 7/5/98       mf      Created
// 6/16/99      jvr     Allow suppress/include options on destinations
// 7/2/99       jvr     Added separate/attachTime, Epilogue, and Serial
//                      options
// 6/7/00       web     Consolidate ELdestination/X; add filterModule()
// 8/22/00      web     Fix omitted .getSymbol() call
// 10/4/00      mf      excludeModule()
// 1/15/01      mf      setLineLength()
// 2/13/01      mf      fix written by pc to accomodate NT problem with
//                      static init { $001$ }.  Corresponding fix is in
//                      .h file.
// 3/13/01      mf      statisticsMap()
// 4/05/01      mf      multi-module filtering
// 4/12/01      mf      repair multi-module filtering
// 6/23/03      mf      changeFile(), flush()
// 1/10/06      mf      finish()
// 6/19/08  mf      summaryForJobReport()
//
// ----------------------------------------------------------------------

#include <iostream>
#include <fstream>

#include "FWCore/MessageService/interface/ELdestination.h"

// Possible Traces:
// #define ELdestinationCONSTRUCTOR_TRACE

namespace edm {
  namespace service {
    // Fix $001 2/13/01 mf
#ifdef DEFECT_NO_STATIC_CONST_INIT
    const int ELdestination::defaultLineLength = 80;
#endif

    ELdestination::ELdestination()
        : threshold(ELzeroSeverity),
          traceThreshold(ELhighestSeverity),
          limits(),
          preamble("%MSG"),
          newline("\n"),
          indent("      "),
          lineLength(defaultLineLength),
          ignoreMostModules(false),
          respondToThese(),
          respondToMostModules(false),
          ignoreThese() {
#ifdef ELdestinationCONSTRUCTOR_TRACE
      std::cerr << "Constructor for ELdestination\n";
#endif

    }  // ELdestination()

    ELdestination::~ELdestination() {
#ifdef ELdestinationCONSTRUCTOR_TRACE
      std::cerr << "Destructor for ELdestination\n";
#endif

    }  // ~ELdestination()

    // ----------------------------------------------------------------------
    // Methods invoked by the ELadministrator:
    // ----------------------------------------------------------------------

    bool ELdestination::log(const edm::ErrorObj&) { return false; }

    // ----------------------------------------------------------------------
    // Methods invoked through the ELdestControl handle:
    // ----------------------------------------------------------------------

    // Each of these must be overridden by any destination for which they make
    // sense.   In this base class, where they are all no-ops, the methods which
    // generate data to a destination, stream or stream will warn at that place,
    // and all the no-op methods will issue an ELwarning2 at their own destination.

    static const ELstring hereMsg = "available via this destination";
    static const ELstring noosMsg = "No ostream";
    static const ELstring notELoutputMsg = "This destination is not an ELoutput";

    // ----------------------------------------------------------------------
    // Behavior control methods invoked by the framework
    // ----------------------------------------------------------------------

    void ELdestination::setThreshold(const ELseverityLevel& sv) { threshold = sv; }

    void ELdestination::setTraceThreshold(const ELseverityLevel& sv) { traceThreshold = sv; }

    void ELdestination::setLimit(const ELstring& s, int n) { limits.setLimit(s, n); }

    void ELdestination::setInterval(const ELseverityLevel& sv, int interval) { limits.setInterval(sv, interval); }

    void ELdestination::setInterval(const ELstring& s, int interval) { limits.setInterval(s, interval); }

    void ELdestination::setLimit(const ELseverityLevel& sv, int n) { limits.setLimit(sv, n); }

    void ELdestination::setTimespan(const ELstring& s, int n) { limits.setTimespan(s, n); }

    void ELdestination::setTimespan(const ELseverityLevel& sv, int n) { limits.setTimespan(sv, n); }

    void ELdestination::wipe() { limits.wipe(); }

    void ELdestination::zero() { limits.zero(); }

    void ELdestination::respondToModule(ELstring const& moduleName) {
      if (moduleName == "*") {
        ignoreMostModules = false;
        respondToMostModules = true;
        ignoreThese.clear();
        respondToThese.clear();
      } else {
        respondToThese.insert(moduleName);
        ignoreThese.erase(moduleName);
      }
    }

    void ELdestination::ignoreModule(ELstring const& moduleName) {
      if (moduleName == "*") {
        respondToMostModules = false;
        ignoreMostModules = true;
        respondToThese.clear();
        ignoreThese.clear();
      } else {
        ignoreThese.insert(moduleName);
        respondToThese.erase(moduleName);
      }
    }

    void ELdestination::filterModule(ELstring const& moduleName) {
      ignoreModule("*");
      respondToModule(moduleName);
    }

    void ELdestination::excludeModule(ELstring const& moduleName) {
      respondToModule("*");
      ignoreModule(moduleName);
    }

    void ELdestination::finish() {}

    void ELdestination::setTableLimit(int n) { limits.setTableLimit(n); }

    void ELdestination::changeFile(std::ostream& /*unused*/) {
      edm::ErrorObj msg(ELwarning, noosMsg);
      msg << notELoutputMsg;
      log(msg);
    }

    void ELdestination::changeFile(const ELstring& filename) {
      edm::ErrorObj msg(ELwarning, noosMsg);
      msg << notELoutputMsg << newline << "file requested is" << filename;
      log(msg);
    }

    void ELdestination::flush() {
      edm::ErrorObj msg(ELwarning, noosMsg);
      msg << "cannot flush()";
      log(msg);
    }

    // ----------------------------------------------------------------------
    // Output format options:
    // ----------------------------------------------------------------------

    void ELdestination::suppressText() { ; }  // $$ jvr
    void ELdestination::includeText() { ; }

    void ELdestination::suppressModule() { ; }
    void ELdestination::includeModule() { ; }

    void ELdestination::suppressSubroutine() { ; }
    void ELdestination::includeSubroutine() { ; }

    void ELdestination::suppressTime() { ; }
    void ELdestination::includeTime() { ; }

    void ELdestination::suppressContext() { ; }
    void ELdestination::includeContext() { ; }

    void ELdestination::suppressSerial() { ; }
    void ELdestination::includeSerial() { ; }

    void ELdestination::useFullContext() { ; }
    void ELdestination::useContext() { ; }

    void ELdestination::separateTime() { ; }
    void ELdestination::attachTime() { ; }

    void ELdestination::separateEpilogue() { ; }
    void ELdestination::attachEpilogue() { ; }

    ELstring ELdestination::getNewline() const { return newline; }

    int ELdestination::setLineLength(int len) {
      int temp = lineLength;
      lineLength = len;
      return temp;
    }

    int ELdestination::getLineLength() const { return lineLength; }

    // ----------------------------------------------------------------------
    // Protected helper methods:
    // ----------------------------------------------------------------------

    bool ELdestination::thisShouldBeIgnored(const ELstring& s) const {
      if (respondToMostModules) {
        return (ignoreThese.find(s) != ignoreThese.end());
      } else if (ignoreMostModules) {
        return (respondToThese.find(s) == respondToThese.end());
      } else {
        return false;
      }
    }

    void close_and_delete::operator()(std::ostream* os) const {
      std::ofstream* p = static_cast<std::ofstream*>(os);
      p->close();
      delete os;
    }

  }  // end of namespace service
}  // end of namespace edm