#include <ELoutput.h>

Inheritance diagram for edm::service::ELoutput:

Public Member Functions
	ELoutput ()

	ELoutput (const ELoutput &orig)

	ELoutput (const std::string &fileName, bool emitAtStart=false)

	ELoutput (std::ostream &os, bool emitAtStart=false)

bool	log (const edm::ErrorObj &msg) override

	~ELoutput () override

Public Member Functions inherited from edm::service::ELdestination
	ELdestination ()

virtual void	excludeModule (std::string const &moduleName)

virtual void	filterModule (std::string const &moduleName)

virtual void	finish ()

virtual int	getLineLength () const

virtual std::string	getNewline () const

virtual void	ignoreModule (std::string const &moduleName)

virtual void	respondToModule (std::string const &moduleName)

void	setInterval (const ELseverityLevel &sv, int interval)

void	setInterval (const std::string &s, int interval)

void	setLimit (const ELseverityLevel &sv, int n)

void	setLimit (const std::string &s, int n)

virtual int	setLineLength (int len)

virtual void	setTableLimit (int n)

void	setThreshold (const ELseverityLevel &sv)

void	setTimespan (const ELseverityLevel &sv, int n)

void	setTimespan (const std::string &s, int n)

void	setTraceThreshold (const ELseverityLevel &sv)

virtual bool	thisShouldBeIgnored (std::string const &s) const

virtual void	wipe ()

virtual void	zero ()

virtual	~ELdestination ()

Protected Member Functions
void	attachEpilogue () override

void	attachTime () override

void	changeFile (const std::string &filename) override

void	changeFile (std::ostream &os) override

void	emitToken (std::string_view s, bool nl=false)

void	flush () override

void	includeContext () override

void	includeModule () override

void	includeSerial () override

void	includeSubroutine () override

void	includeText () override

void	includeTime () override

ELoutput &	operator= (const ELoutput &orig)=delete

void	separateEpilogue () override

void	separateTime () override

void	suppressContext () override

void	suppressModule () override

void	suppressSerial () override

void	suppressSubroutine () override

void	suppressText () override

void	suppressTime () override

void	useContext () override

void	useFullContext () override

Protected Attributes
int	charsOnLine

std::shared_ptr< std::ostream >	os

bool	preambleMode

bool	wantEpilogueSeparate

bool	wantFullContext

bool	wantModule

bool	wantSerial

bool	wantSomeContext

bool	wantSubroutine

bool	wantText

bool	wantTimeSeparate

bool	wantTimestamp

edm::ELextendedID	xid

Protected Attributes inherited from edm::service::ELdestination
bool	ignoreMostModules

std::unordered_set< std::string >	ignoreThese

std::string	indent

ELlimitsTable	limits

int	lineLength

std::string	newline

std::string	preamble

bool	respondToMostModules

std::unordered_set< std::string >	respondToThese

ELseverityLevel	threshold

ELseverityLevel	traceThreshold

Additional Inherited Members
Static Protected Attributes inherited from edm::service::ELdestination
static const int	defaultLineLength = 80

Detailed Description

Definition at line 43 of file ELoutput.h.

Constructor & Destructor Documentation

◆ ELoutput() [1/4]

edm::service::ELoutput::ELoutput ( )

Definition at line 125 of file ELoutput.cc.

         : ELdestination(),
           os(&std::cerr, do_nothing_deleter()),
           charsOnLine(0),
           xid(),
           wantTimestamp(true),
           wantModule(true),
           wantSubroutine(true),
           wantText(true),
           wantSomeContext(true),
           wantSerial(false),
           wantFullContext(false),
           wantTimeSeparate(false),
           wantEpilogueSeparate(false),
           preambleMode(true)  // 006 9/2/10 mf
     {
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Constructor for ELoutput()\n";
 #endif
  
       emitToken("\n=================================================", true);
       emitToken("\nMessage Log File written by MessageLogger service \n");
       emitToken("\n=================================================\n", true);
  
     }  // ELoutput()

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, and emitToken().

◆ ELoutput() [2/4]

edm::service::ELoutput::ELoutput	(	std::ostream &	os,
		bool	emitAtStart = `false`
	)

Definition at line 151 of file ELoutput.cc.

         : ELdestination(),
           os(&os_, do_nothing_deleter()),
           charsOnLine(0),
           xid(),
           wantTimestamp(true),
           wantModule(true),
           wantSubroutine(true),
           wantText(true),
           wantSomeContext(true),
           wantSerial(false),
           wantFullContext(false),
           wantTimeSeparate(false),
           wantEpilogueSeparate(false),
           preambleMode(true)  // 006 9/2/10 mf
     {
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Constructor for ELoutput( os )\n";
 #endif
  
       // Enh 001 2/13/01 mf
       if (emitAtStart) {
         preambleMode = true;
         emitToken("\n=================================================", true);
         emitToken("\nMessage Log File written by MessageLogger service \n");
         emitToken("\n=================================================\n", true);
       }
  
     }  // ELoutput()

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, emitToken(), and preambleMode.

◆ ELoutput() [3/4]

edm::service::ELoutput::ELoutput	(	const std::string &	fileName,
		bool	emitAtStart = `false`
	)

Definition at line 181 of file ELoutput.cc.

         : ELdestination(),
           os(new std::ofstream(fileName.c_str(), std::ios /*_base*/ ::app), close_and_delete()),
           charsOnLine(0),
           xid(),
           wantTimestamp(true),
           wantModule(true),
           wantSubroutine(true),
           wantText(true),
           wantSomeContext(true),
           wantSerial(false),
           wantFullContext(false),
           wantTimeSeparate(false),
           wantEpilogueSeparate(false),
           preambleMode(true)  // 006 9/2/10 mf
     {
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Constructor for ELoutput( " << fileName << " )\n";
 #endif
  
       preambleMode = true;
       if (os && *os) {
 #ifdef ELoutputCONSTRUCTOR_TRACE
         std::cerr << "          Testing if os is owned\n";
 #endif
 #ifdef ELoutputCONSTRUCTOR_TRACE
         std::cerr << "          About to do first emit\n";
 #endif
         // Enh 001 2/13/01 mf
         if (emitAtStart) {
           emitToken("\n=======================================================", true);
           emitToken("\nError Log File ");
           emitToken(fileName);
           emitToken(" \n");
         }
       } else {
 #ifdef ELoutputCONSTRUCTOR_TRACE
         std::cerr << "          Deleting os\n";
 #endif
         os.reset(&std::cerr, do_nothing_deleter());
 #ifdef ELoutputCONSTRUCTOR_TRACE
         std::cerr << "          about to emit to cerr\n";
 #endif
         if (emitAtStart) {
           emitToken("\n=======================================================", true);
           emitToken("\n%MSG** Logging to cerr is being substituted");
           emitToken(" for specified log file \"");
           emitToken(fileName);
           emitToken("\" which could not be opened for write or append.\n");
         }
       }
       if (emitAtStart) {
         std::string const& ftime = formatTime(time(nullptr));  // Change log 7
         emitToken(ftime, true);
         emitToken("\n=======================================================\n", true);
       }
       // preambleMode = tprm; removed 9/2/10 mf see change log 6
  
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Constructor for ELoutput completed.\n";
 #endif
  
     }  // ELoutput()

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, emitToken(), MillePedeFileConverter_cfg::fileName, os, preambleMode, AlCaHLTBitMon_QueryRunRegistry::string, and ntuplemaker::time.

◆ ELoutput() [4/4]

edm::service::ELoutput::ELoutput ( const ELoutput & orig )

Definition at line 245 of file ELoutput.cc.

         : ELdestination(),
           os(orig.os),
           charsOnLine(orig.charsOnLine),
           xid(orig.xid),
           wantTimestamp(orig.wantTimestamp),
           wantModule(orig.wantModule),
           wantSubroutine(orig.wantSubroutine),
           wantText(orig.wantText),
           wantSomeContext(orig.wantSomeContext),
           wantSerial(orig.wantSerial),
           wantFullContext(orig.wantFullContext),
           wantTimeSeparate(orig.wantTimeSeparate),
           wantEpilogueSeparate(orig.wantEpilogueSeparate),
           preambleMode(orig.preambleMode)  // 006 9/2/10 mf
     {
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Copy constructor for ELoutput\n";
 #endif
  
       // mf 6/15/01 fix of Bug 005
       threshold = orig.threshold;
       traceThreshold = orig.traceThreshold;
       limits = orig.limits;
       preamble = orig.preamble;
       newline = orig.newline;
       indent = orig.indent;
       lineLength = orig.lineLength;
  
       ignoreMostModules = orig.ignoreMostModules;
       respondToThese = orig.respondToThese;
       respondToMostModules = orig.respondToMostModules;
       ignoreThese = orig.ignoreThese;
  
     }  // ELoutput()

◆ ~ELoutput()

edm::service::ELoutput::~ELoutput ( )

override

Definition at line 281 of file ELoutput.cc.

                         {
 #ifdef ELoutputCONSTRUCTOR_TRACE
       std::cerr << "Destructor for ELoutput\n";
 #endif
  
     }  // ~ELoutput()

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr.

Member Function Documentation

◆ attachEpilogue()

void edm::service::ELoutput::attachEpilogue ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 618 of file ELoutput.cc.

618 { wantEpilogueSeparate = false; }

References wantEpilogueSeparate.

◆ attachTime()

void edm::service::ELoutput::attachTime ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 615 of file ELoutput.cc.

615 { wantTimeSeparate = false; }

References wantTimeSeparate.

◆ changeFile() [1/2]

void edm::service::ELoutput::changeFile ( const std::string & filename )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 633 of file ELoutput.cc.

                                                        {
       os.reset(new std::ofstream(filename.c_str(), std::ios /*_base*/ ::app), close_and_delete());
       emitToken("\n=======================================================", true);
       emitToken("\nError Log changed to this file\n");
       std::string const& ftime = formatTime(time(nullptr));  // Change log 7
       emitToken(ftime, true);
       emitToken("\n=======================================================\n", true);
     }

References emitToken(), corrVsCorr::filename, os, AlCaHLTBitMon_QueryRunRegistry::string, and ntuplemaker::time.

◆ changeFile() [2/2]

void edm::service::ELoutput::changeFile ( std::ostream & os )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 624 of file ELoutput.cc.

                                              {
       os.reset(&os_, do_nothing_deleter());
       emitToken("\n=======================================================", true);
       emitToken("\nError Log changed to this stream\n");
       std::string const& ftime = formatTime(time(nullptr));  // Change log 7
       emitToken(ftime, true);
       emitToken("\n=======================================================\n", true);
     }

References emitToken(), os, AlCaHLTBitMon_QueryRunRegistry::string, and ntuplemaker::time.

◆ emitToken()

void edm::service::ELoutput::emitToken	(	std::string_view	s,
		bool	nl = `false`
	)

protected

Definition at line 511 of file ELoutput.cc.

                                                       {
 #ifdef ELoutput_EMIT_TRACE
       std::cerr << "[][][] in emit:  charsOnLine is " << charsOnLine << '\n';
       std::cerr << "[][][] in emit:  s.length() " << s.length() << '\n';
       std::cerr << "[][][] in emit:  lineLength is " << lineLength << '\n';
 #endif
  
       if (s.length() == 0) {
         if (nl) {
           (*os) << newline << std::flush;
           charsOnLine = 0;
         }
         return;
       }
  
       char first = s[0];
       char second, last, last2;
       second = (s.length() < 2) ? '\0' : s[1];
       last = (s.length() < 2) ? '\0' : s[s.length() - 1];
       last2 = (s.length() < 3) ? '\0' : s[s.length() - 2];
       //checking -2 because the very last char is sometimes a ' ' inserted
       //by ErrorLog::operator<<
  
       if (preambleMode) {
         //Accounts for newline @ the beginning of the ELstring     JV:2
         if (first == '\n' || (charsOnLine + static_cast<int>(s.length())) > lineLength) {
 #ifdef ELoutput_EMIT_TRACE
           std::cerr << "[][][] in emit: about to << to *os \n";
 #endif
 #ifdef HEADERS_BROKEN_INTO_LINES_AND_INDENTED
           // Change log 3: Removed this code 6/11/07 mf
           (*os) << newline << indent;
           charsOnLine = indent.length();
 #else
           charsOnLine = 0;  // Change log 5
 #endif
           if (second != ' ') {
             (*os) << ' ';
             charsOnLine++;
           }
           if (first == '\n') {
             (*os) << s.substr(1);
           } else {
             (*os) << s;
           }
         }
 #ifdef ELoutput_EMIT_TRACE
         std::cerr << "[][][] in emit: about to << s to *os: " << s << " \n";
 #endif
         else {
           (*os) << s;
         }
  
         if (last == '\n' || last2 == '\n') {  //accounts for newline @ end    $$ JV:2
           (*os) << indent;                    //of the ELstring
           if (last != ' ')
             (*os) << ' ';
           charsOnLine = indent.length() + 1;
         }
  
         if (nl) {
           (*os) << newline << std::flush;
           charsOnLine = 0;
         } else {
           charsOnLine += s.length();
         }
       }
  
       if (!preambleMode) {
         (*os) << s;
       }
  
 #ifdef ELoutput_EMIT_TRACE
       std::cerr << "[][][] in emit: completed \n";
 #endif
  
     }  // emitToken()

References EcnaPython_AdcPeg12_S1_10_R170298_1_0_150_Dee0::cerr, charsOnLine, edm::first(), edm::service::ELdestination::indent, dqmdumpme::last, edm::service::ELdestination::lineLength, edm::service::ELdestination::newline, preambleMode, alignCSCRings::s, and edm::second().

Referenced by changeFile(), ELoutput(), and log().

◆ flush()

void edm::service::ELoutput::flush ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 642 of file ELoutput.cc.

642 { os->flush(); }

References os.

Referenced by log().

◆ includeContext()

void edm::service::ELoutput::includeContext ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 605 of file ELoutput.cc.

605 { wantSomeContext = true; }

References wantSomeContext.

◆ includeModule()

void edm::service::ELoutput::includeModule ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 596 of file ELoutput.cc.

596 { wantModule = true; }

References wantModule.

◆ includeSerial()

void edm::service::ELoutput::includeSerial ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 609 of file ELoutput.cc.

609 { wantSerial = true; }

References wantSerial.

◆ includeSubroutine()

void edm::service::ELoutput::includeSubroutine ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 599 of file ELoutput.cc.

599 { wantSubroutine = true; }

References wantSubroutine.

◆ includeText()

void edm::service::ELoutput::includeText ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 602 of file ELoutput.cc.

602 { wantText = true; }

References wantText.

◆ includeTime()

void edm::service::ELoutput::includeTime ( )

overrideprotectedvirtual

Reimplemented from edm::service::ELdestination.

Definition at line 593 of file ELoutput.cc.

593 { wantTimestamp = true; }

References wantTimestamp.

◆ log()

bool edm::service::ELoutput::log ( const edm::ErrorObj & msg )

overridevirtual

Reimplemented from edm::service::ELdestination.

Definition at line 295 of file ELoutput.cc.

                                              {
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: Log to an ELoutput \n";
 #endif
  
       xid = msg.xid();  // Save the xid.
  
 #ifdef THRESHTRACE
       std::cerr << "    =:=:=: Log to an ELoutput \n"
                 << "           severity  = " << xid.severity << "\n"
                 << "           threshold = " << threshold << "\n"
                 << "           id        = " << xid.id << "\n";
 #endif
  
       // See if this message is to be acted upon, and add it to limits table
       // if it was not already present:
       //
       if (xid.severity < threshold)
         return false;
       if (thisShouldBeIgnored(xid.module) && (xid.severity < ELsevere) /* change log 2 */)
         return false;
       if (!limits.add(xid) && (xid.severity < ELsevere) /* change log 2 */)
         return false;
  
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: Limits table work done \n";
 #endif
  
       // Output the prologue:
       //
       preambleMode = true;
  
       if (!msg.is_verbatim()) {
         charsOnLine = 0;  // Change log 5
         emitToken(preamble);
         emitToken(xid.severity.getSymbol());
         emitToken(" ");
         emitToken(xid.id);
         emitToken(msg.idOverflow());
         emitToken(": ");
       }
  
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: Prologue done \n";
 #endif
       // Output serial number of message:
       //
       if (!msg.is_verbatim()) {
         if (wantSerial) {
           std::ostringstream s;
           s << msg.serial();
           emitToken("[serial #" + s.str() + "] ");
         }
       }
  
 #ifdef OUTPUT_FORMATTED_ERROR_MESSAGES
       // Output each item in the message (before the epilogue):
       //
       if (wantText) {
         ELlist_string::const_iterator it;
         for (it = msg.items().begin(); it != msg.items().end(); ++it) {
 #ifdef ELoutputTRACE_LOG
           std::cerr << "      =:=:=: Item:  " << *it << '\n';
 #endif
           emitToken(*it);
         }
       }
 #endif
  
       // Provide further identification:
       //
       bool needAspace = true;
       if (!msg.is_verbatim()) {
         if (wantEpilogueSeparate) {
           if (xid.module.length() + xid.subroutine.length() > 0) {
             emitToken("\n");
             needAspace = false;
           } else if (wantTimestamp && !wantTimeSeparate) {
             emitToken("\n");
             needAspace = false;
           }
         }
         if (wantModule && (xid.module.length() > 0)) {
           if (needAspace) {
             emitToken(" ");
             needAspace = false;
           }
           emitToken(xid.module + " ");
         }
         if (wantSubroutine && (xid.subroutine.length() > 0)) {
           if (needAspace) {
             emitToken(" ");
             needAspace = false;
           }
           emitToken(xid.subroutine + "() ");
         }
       }
  
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: Module and Subroutine done \n";
 #endif
  
       // Provide time stamp:
       //
       if (!msg.is_verbatim()) {
         if (wantTimestamp) {
           if (wantTimeSeparate) {
             emitToken("\n");
             needAspace = false;
           }
           if (needAspace) {
             emitToken(" ");
             needAspace = false;
           }
           std::string const& ftime = formatTime(msg.timestamp());  // Change log 7
           emitToken(ftime + " ");
         }
       }
  
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: TimeStamp done \n";
 #endif
  
       // Provide the context information:
       //
       if (!msg.is_verbatim()) {
         if (wantSomeContext) {
           if (needAspace) {
             emitToken(" ");
             needAspace = false;
           }
           assert(!needAspace);
           if (wantFullContext) {
             emitToken(msg.context());
 #ifdef ELoutputTRACE_LOG
             std::cerr << "    =:=:=: fullContext done: \n";
 #endif
           } else {
             emitToken(msg.context());
 #ifdef ELoutputTRACE_LOG
             std::cerr << "    =:=:=: Context done: \n";
 #endif
           }
         }
       }
  
       // Provide traceback information:
       //
  
       bool insertNewlineAfterHeader = (msg.xid().severity != ELdebug);
       // ELdebug is what LogDebug issues
  
       if (!msg.is_verbatim()) {
         if (msg.xid().severity >= traceThreshold) {
           emitToken("\n", insertNewlineAfterHeader);
         } else {  //else statement added JV:1
           emitToken("", insertNewlineAfterHeader);
         }
       }
 #ifdef ELoutputTRACE_LOG
       std::cerr << "    =:=:=: Trace routine done: \n";
 #endif
  
 #ifndef OUTPUT_FORMATTED_ERROR_MESSAGES
       // Finally, output each item in the message:
       //
       preambleMode = false;
       if (wantText) {
         ELlist_string::const_iterator it;
         int item_count = 0;
         for (it = msg.items().begin(); it != msg.items().end(); ++it) {
 #ifdef ELoutputTRACE_LOG
           std::cerr << "      =:=:=: Item:  " << *it << '\n';
 #endif
           ++item_count;
           if (!msg.is_verbatim()) {
             if (!insertNewlineAfterHeader && (item_count == 3)) {
               // in a LogDebug message, the first 3 items are FILE, :, and LINE
               emitToken(*it, true);
             } else {
               emitToken(*it);
             }
           } else {
             emitToken(*it);
           }
         }
       }
 #endif
  
       // And after the message, add a %MSG on its own line
       // Change log 4  6/11/07 mf
  
       if (!msg.is_verbatim()) {
         emitToken("\n%MSG");
       }
  
       // Done; message has been fully processed; separate, flush, and leave
       //
  
       (*os) << newline;
       flush();
  
 #ifdef ELoutputTRACE_LOG
       std::cerr << "  =:=:=: log(msg) done: \n";
 #endif
  
       return true;
  
     }  // log()