QwLog Class Reference

Logging and output management system with configurable verbosity levels. More...

#include <QwLog.h>

Inheritance diagram for QwLog:

Collaboration diagram for QwLog:

Public Types
enum	QwLogLevel {   kAlways = -1 , kError = 0 , kWarning = 1 , kMessage = 2 ,   kVerbose = 3 , kDebug = 4 }
	Loglevels. More...

Public Member Functions
void	ProcessOptions (QwOptions *options)
	Process class options for QwOptions.
	QwLog ()
	The constructor.
	~QwLog () override
	The destructor.
bool	IsDebugFunction (const string func_name)
	Determine whether the function name matches a specified list of regular expressions.
void	InitLogFile (const std::string name, const std::ios_base::openmode mode=kAppend)
	Initialize the log file with name 'name'.
void	SetScreenColor (bool flag)
	Set the screen color mode.
void	SetScreenThreshold (int thr)
	Set the screen log level.
void	SetFileThreshold (int thr)
	Set the file log level.
QwLogLevel	GetLogLevel () const
	Get highest log level.
QwLog &	operator() (const QwLogLevel level, const std::string func_sig="<unknown>")
	Set the stream log level.
template<class T>
QwLog &	operator<< (const T &t)
	Stream an object to the output stream.
QwLog &	operator<< (std::ostream &(*manip)(std::ostream &))
	Pass the ios_base manipulators.

Static Public Member Functions
static void	DefineOptions (QwOptions *options)
	Define available class options for QwOptions.
static std::ostream &	endl (std::ostream &)
	End of the line.
static std::ostream &	flush (std::ostream &)
	Flush the streams.

Static Public Attributes
static const std::ios_base::openmode	kTruncate = std::ios::trunc
	Log file open modes.
static const std::ios_base::openmode	kAppend = std::ios::app

Private Member Functions
const char *	GetTime ()
	Get the local time.

Private Attributes
char	fTimeString [128]
QwLogLevel	fScreenThreshold
	Screen thresholds and stream.
std::ostream *	fScreen
QwLogLevel	fFileThreshold
	File thresholds and stream.
std::ostream *	fFile
QwLogLevel	fLogLevel
	Log level of this stream.
bool	fPrintFunctionSignature
	Flag to print function signature on warning or error.
std::map< std::string, bool >	fIsDebugFunction
	List of regular expressions for functions that will have increased log level.
std::vector< std::string >	fDebugFunctionRegexString
bool	fUseColor
	Flag to disable color.

Static Private Attributes
static bool	fFileAtNewLine = true
	Flags only relevant for current line, but static for use in static function.
static bool	fScreenInColor = false
static bool	fScreenAtNewLine = true

Detailed Description

Logging and output management system with configurable verbosity levels.

Provides a hierarchical logging system with multiple output levels (Error, Warning, Message, Verbose, Debug) and predefined log drains (QwError, QwWarning, QwMessage, QwVerbose, QwDebug). Supports output redirection to files, colored output, and function-specific debugging. Should not be used directly; use the predefined macros instead.

Definition at line 73 of file QwLog.h.

Member Enumeration Documentation

QwLogLevel

enum QwLog::QwLogLevel

Loglevels.

enum of possible log levels

Enumerator
kAlways	Explicit output
kError	Error loglevel
kWarning	Warning loglevel
kMessage	Message loglevel
kVerbose	Verbose loglevel
kDebug	Debug loglevel

Definition at line 88 of file QwLog.h.

                    {
      kAlways    = -1, /*!< Explicit output  */
      kError     =  0, /*!< Error loglevel   */
      kWarning   =  1, /*!< Warning loglevel */
      kMessage   =  2, /*!< Message loglevel */
      kVerbose   =  3, /*!< Verbose loglevel */
      kDebug     =  4  /*!< Debug loglevel   */
    };

Constructor & Destructor Documentation

QwLog()

QwLog::QwLog

(

)

The constructor.

The constructor initializes the screen stream and resets the file stream

Definition at line 33 of file QwLog.cc.

: std::ostream(std::cout.rdbuf())
{
  fScreenThreshold = kMessage;
  fScreen = &std::cout;
 
  fFileThreshold = kMessage;
  fFile = 0;
 
  fLogLevel = kMessage;
 
  fUseColor = true;
 
  fPrintFunctionSignature = false;
}

References fFile, fFileThreshold, fLogLevel, fPrintFunctionSignature, fScreen, fScreenThreshold, fUseColor, and kMessage.

Referenced by operator()(), operator<<(), and operator<<().

Here is the caller graph for this function:

~QwLog()

QwLog::~QwLog ( )

override

The destructor.

The destructor destroys the log file, if it was present

Definition at line 51 of file QwLog.cc.

{
  if (fFile) {
    delete fFile;
    fFile = 0;
  }
}

References fFile.

Member Function Documentation

DefineOptions()

void QwLog::DefineOptions ( QwOptions * options )

static

Define available class options for QwOptions.

Defines configuration options for logging class using QwOptions functionality.

Note: this uses a pointer as opposed to a reference, because as indicated above the QwLog class cannot depend on the QwOptions class. When using a pointer we only need a forward declaration and we do not need to include the header file QwOptions.h.

Parameters

options

Options object

Definition at line 71 of file QwLog.cc.

{
  // Define the logging options
  options->AddOptions("Logging options")("QwLog.color",
                po::value<bool>()->default_value(true),
                "colored screen output");
  options->AddOptions("Logging options")("QwLog.logfile",
                po::value<string>(),
                "log file");
  options->AddOptions("Logging options")("QwLog.loglevel-file",
                po::value<int>()->default_value(kMessage),
                "log level for file output");
  options->AddOptions("Logging options")("QwLog.loglevel-screen",
                po::value<int>()->default_value(kMessage),
                "log level for screen output");
  options->AddOptions("Logging options")("QwLog.print-signature",
                po::value<bool>()->default_bool_value(false),
                "print signature on error or warning");
  options->AddOptions("Logging options")("QwLog.debug-function",
                po::value< std::vector<string> >()->multitoken(),
                "print debugging output of function with signatures satisfying the specified regex");
}

References QwOptions::AddOptions(), and kMessage.

Referenced by QwOptions::DefineOptions().

Here is the call graph for this function:

Here is the caller graph for this function:

endl()

std::ostream & QwLog::endl ( std::ostream & strm )

static

End of the line.

End of the line

Definition at line 297 of file QwLog.cc.

{
  if (gQwLog.fScreen && gQwLog.fLogLevel <= gQwLog.fScreenThreshold) {
    if (fScreenInColor)
      *(gQwLog.fScreen) << QwColor(Qw::kNormal) << std::endl;
    else
      *(gQwLog.fScreen) << std::endl;
    fScreenAtNewLine = true;
    fScreenInColor = false;
  }
  if (gQwLog.fFile && gQwLog.fLogLevel <= gQwLog.fFileThreshold) {
    *(gQwLog.fFile) << std::endl;
    fFileAtNewLine = true;
  }
 
  return strm;
}

References fFileAtNewLine, fScreenAtNewLine, fScreenInColor, gQwLog, and Qw::kNormal.

Referenced by __attribute__(), QwDataHandlerArray::AccumulateAllRunningSum(), QwSubsystemArrayParity::AccumulateAllRunningSum(), QwADC18_Channel::AccumulateRunningSum(), QwCorrelator::AccumulateRunningSum(), QwDataHandlerArray::AccumulateRunningSum(), QwHelicityCorrelatedFeedback::AccumulateRunningSum(), QwMollerADC_Channel::AccumulateRunningSum(), QwSubsystemArrayParity::AccumulateRunningSum(), QwVQWK_Channel::AccumulateRunningSum(), VQwHardwareChannel::AccumulateRunningSum(), VQwScaler_Channel::AccumulateRunningSum(), QwOptions::AddConfigFile(), QwPromptSummary::AddElement(), QwDBInterface::AddThisEntryToList(), QwErrDBInterface::AddThisEntryToList(), QwHelicityCorrelatedFeedback::ApplyFeedbackCorrections(), QwHelicityCorrelatedFeedback::ApplyHAIAFeedback(), QwADC18_Channel::ApplyHWChecks(), QwMollerADC_Channel::ApplyHWChecks(), QwVQWK_Channel::ApplyHWChecks(), QwHelicityCorrelatedFeedback::ApplyIAFeedback(), QwHelicityCorrelatedFeedback::ApplyPITAFeedback(), QwSubsystemArray::AtEndOfEventLoop(), VQwSubsystem::AtEndOfEventLoop(), QwSubsystemArrayParity::Blind(), QwSubsystemArrayParity::Blind(), QwHelicity::BuildHelicityBitPattern(), QwCorrelator::CalcCorrelations(), VQwDataHandler::CalcOneOutput(), QwHelicityCorrelatedFeedback::CalculateAsymmetry(), QwHelicityPattern::CalculateAsymmetry(), QwCombinedBPM< T >::CalculateFixedParameter(), QwHelicityPattern::CalculatePairAsymmetry(), QwSubsystemArray::CanContain(), QwAlarmHandler::CheckAlarms(), QwBlinder::CheckBlindability(), QwSubsystemArrayParity::CheckForBurpFail(), QwEventBuffer::CheckForMarkerWords(), QwHelicity::CheckPatternNum(), QwBlinder::CheckTestValues(), VQwCloneable< base_t >::Clone(), QwCorrelator::CloseAliasFile(), QwEventBuffer::CloseStream(), QwEventBuffer::CloseThisSegment(), QwHelicity::CollectRandBits24(), QwHelicity::CollectRandBits30(), QwDatabase::Connect(), LRBCorrector::ConnectChannels(), QwAlarmHandler::ConnectChannels(), QwCombiner::ConnectChannels(), QwCombiner::ConnectChannels(), QwCorrelator::ConnectChannels(), QwExtractor::ConnectChannels(), VQwDataHandler::ConnectChannels(), QwBCM< T >::ConstructBranch(), QwBPMCavity::ConstructBranch(), QwBPMStripline< T >::ConstructBranch(), QwClock< T >::ConstructBranch(), QwCombinedBPM< T >::ConstructBranch(), QwCombinedPMT::ConstructBranch(), QwEnergyCalculator::ConstructBranch(), QwHaloMonitor::ConstructBranch(), QwIntegrationPMT::ConstructBranch(), QwLinearDiodeArray::ConstructBranch(), QwQPD::ConstructBranch(), QwSubsystemArray::ConstructBranch(), QwEPICSEvent::ConstructBranchAndVector(), QwMollerADC_Channel::ConstructBranchAndVector(), QwRootTree::ConstructBranchAndVector(), QwVQWK_Channel::ConstructBranchAndVector(), QwHelicity::ConstructHistograms(), QwRootFile::ConstructHistograms(), QwRootTree::ConstructNewTree(), VQwDataHandler::ConstructNTupleFields(), QwRootFile::ConstructObjects(), QwCorrelator::ConstructTreeBranches(), QwExtractor::ConstructTreeBranches(), VQwDataHandler::ConstructTreeBranches(), VQwBCM::Create(), VQwClock::Create(), VQwBCM::CreateCombo(), VQwBPM::CreateCombo(), VQwBPM::CreateStripline(), QwEventBuffer::DataFileIsSegmented(), QwSubsystemArrayParity::DeaccumulateRunningSum(), Coda2EventDecoder::DecodeEventIDBank(), Coda3EventDecoder::DecodeEventIDBank(), VEventDecoder::DecodeSubbankHeader(), QwEPICSEvent::DetermineIHWPPolarity(), QwDBInterface::DetermineMeasurementTypeID(), QwADC18_Channel::EncodeEventData(), QwHelicity::EncodeEventData(), VQwDetectorArray::ExchangeProcessedData(), QwHelicityCorrelatedFeedback::FeedHAIASetPoint(), QwHelicityCorrelatedFeedback::FeedIASetPoint(), QwHelicityCorrelatedFeedback::FeedPITASetPoints(), QwRootTree::Fill(), QwEventBuffer::FillEPICSData(), QwHelicity::FillHistograms(), QwEventBuffer::FillSubsystemConfigurationData(), QwEventBuffer::FillSubsystemData(), QwRootTree::FillTreeBranches(), QwADC18_Channel::FillTreeVector(), QwEPICSEvent::FillTreeVector(), QwScaler_Channel< data_mask, data_shift >::FillTreeVector(), QwParameterFile::FindFile(), QwADC18_Channel::GetBufferOffset(), QwMollerADC_Channel::GetBufferOffset(), QwVQWK_Channel::GetBufferOffset(), VQwScaler_Channel::GetBufferOffset(), VQwDetectorArray::GetCombinedPMT(), getenv_safe(), VQwFactory< base_t >::GetFactory(), QwHelicityCorrelatedFeedback::GetHAChargeStat(), QwHistogramHelper::GetHistParamsFromFile(), QwHistogramHelper::GetHistParamsFromLine(), QwHistogramHelper::GetHistParamsFromList(), VQwDetectorArray::GetIntegrationPMT(), QwEventBuffer::GetNextEvent(), QwEventBuffer::GetNextEventRange(), QwEventBuffer::GetNextRunRange(), QwHelicity::GetRandbit24(), QwHelicity::GetRandbit30(), QwHelicity::GetRandomSeed(), QwHelicityCorrelatedFeedback::GetTargetChargeStat(), QwHelicityCorrelatedFeedback::GetTargetChargeStat(), QwOptions::GetValue(), QwParameterFile::HasValue(), QwBlinder::InitBlinders(), QwBlinder::InitTestValues(), Coda3EventDecoder::InterpretBankTag(), QwHelicity::IsGoodEventNumber(), QwHelicity::IsGoodHelicity(), QwHelicity::IsGoodPatternNumber(), QwHelicity::IsGoodPhaseNumber(), LinRegBevPeb::LinRegBevPeb(), QwOptions::ListConfigFiles(), MQwPublishable< U, T >::ListPublishedValues(), VQwFactory< base_t >::ListRegisteredTypes(), QwSubsystemArray::LoadAllEventRanges(), LRBCorrector::LoadChannelMap(), QwBeamLine::LoadChannelMap(), QwBeamMod::LoadChannelMap(), QwCombiner::LoadChannelMap(), QwCorrelator::LoadChannelMap(), QwEPICSEvent::LoadChannelMap(), QwHelicity::LoadChannelMap(), QwScaler::LoadChannelMap(), VQwDetectorArray::LoadChannelMap(), QwADC18_Channel::LoadChannelParameters(), QwMollerADC_Channel::LoadChannelParameters(), QwVQWK_Channel::LoadChannelParameters(), QwDataHandlerArray::LoadDataHandlersFromParameterFile(), QwPromptSummary::LoadElementsFromParameterFile(), QwPromptSummary::LoadElementsFromParameterFile(), QwBeamLine::LoadEventCuts_Line(), QwBeamMod::LoadEventCuts_Line(), VQwDetectorArray::LoadEventCuts_Line(), QwHelicityPattern::LoadEventData(), QwBeamLine::LoadGeometryDefinition(), QwHistogramHelper::LoadHistParamsFromFile(), QwScaler::LoadInputParameters(), QwBeamLine::LoadMockDataParameters(), QwSubsystemArrayParity::LoadMockDataParameters(), QwHelicityCorrelatedFeedback::LoadParameterFile(), QwSubsystemArray::LoadSubsystemsFromParameterFile(), QwHistogramHelper::LoadTreeParamsFromFile(), main(), main(), QwHistogramHelper::MatchDeviceParamsFromList(), QwHistogramHelper::MatchVQWKElementFromList(), QwCorrelator::OpenAliasFile(), QwCorrelator::OpenAlphaFile(), QwEventBuffer::OpenDataFile(), QwParameterFile::OpenFile(), QwEventBuffer::OpenNextSegment(), QwEventBuffer::OpenNextStream(), QwHelicity::operator+=(), QwSubsystemArrayParity::operator+=(), QwADC18_Channel::operator/=(), QwMollerADC_Channel::operator/=(), QwVQWK_Channel::operator/=(), VQwScaler_Channel::operator/=(), QwDataHandlerArray::operator=(), QwSubsystemArray::operator=(), QwBPMCavity::ParseChannelName(), QwOptions::ParseCommandLine(), QwCorrelator::ParseConfigFile(), QwOptions::ParseConfigFile(), VQwDataHandler::ParseConfigFile(), QwOptions::ParseEnvironment(), QwParameterFile::ParseInt(), QwParameterFile::ParseIntRange(), QwEventRing::pop(), QwBeamMod::Print(), QwHelicity::Print(), QwHelicityPattern::Print(), QwModChannelID::Print(), QwRootTree::Print(), QwWord::Print(), LinRegBevPeb::print(), QwBlinder::PrintCountersValues(), QwPromptSummary::PrintCSVHeader(), Coda2EventDecoder::PrintDecoderInfo(), Coda3EventDecoder::PrintDecoderInfo(), VEventDecoder::PrintDecoderInfo(), VQwSubsystem::PrintDetectorMaps(), QwRootFile::PrintDirs(), QwADC18_Channel::PrintErrorCounterHead(), QwMollerADC_Channel::PrintErrorCounterHead(), QwVQWK_Channel::PrintErrorCounterHead(), QwADC18_Channel::PrintErrorCounters(), QwBeamLine::PrintErrorCounters(), QwHelicity::PrintErrorCounters(), QwMollerADC_Channel::PrintErrorCounters(), QwVQWK_Channel::PrintErrorCounters(), VQwDetectorArray::PrintErrorCounters(), VQwScaler_Channel::PrintErrorCounters(), QwADC18_Channel::PrintErrorCounterTail(), QwMollerADC_Channel::PrintErrorCounterTail(), QwVQWK_Channel::PrintErrorCounterTail(), QwBlinder::PrintFinalValues(), QwHistogramHelper::PrintHistParams(), QwWord::PrintID(), QwHelicityPattern::PrintIndexMapFile(), QwADC18_Channel::PrintInfo(), QwScaler::PrintInfo(), VQwScaler_Channel::PrintInfo(), QwEventBuffer::PrintRunTimes(), QwDBInterface::PrintStatus(), QwErrDBInterface::PrintStatus(), LinRegBevPeb::printSummaryAlphas(), LinRegBevPeb::printSummaryMeansWithUnc(), LinRegBevPeb::printSummaryMeansWithUncCorrected(), LinRegBevPeb::printSummaryP(), LinRegBevPeb::printSummaryY(), LinRegBevPeb::printSummaryYP(), QwRootFile::PrintTrees(), Coda3EventDecoder::printUserEvent(), QwADC18_Channel::PrintValue(), QwBeamLine::PrintValue(), QwHelicityPattern::PrintValue(), QwMollerADC_Channel::PrintValue(), QwPMT_Channel::PrintValue(), QwScaler::PrintValue(), QwVQWK_Channel::PrintValue(), VQwDataHandler::PrintValue(), VQwDetectorArray::PrintValue(), VQwScaler_Channel::PrintValue(), QwEPICSEvent::PrintVariableList(), QwADC18_Channel::ProcessDataWord(), QwADC18_Channel::ProcessEvBuffer(), QwBeamMod::ProcessEvBuffer(), QwHelicity::ProcessEvBuffer(), QwADC18_Channel::ProcessEvent(), QwCombinedBCM< T >::ProcessEvent(), QwHelicity::ProcessEvent(), QwMollerADC_Channel::ProcessEvent(), QwVQWK_Channel::ProcessEvent(), VQwScaler_Channel::ProcessEvent(), VQwDetectorArray::ProcessEvent_2(), QwHelicity::ProcessEventInputMollerMode(), QwHelicity::ProcessEventInputRegisterMode(), QwHelicity::ProcessEventUserbitMode(), QwBlinder::ProcessOptions(), QwDatabase::ProcessOptions(), QwEventBuffer::ProcessOptions(), QwEventRing::ProcessOptions(), QwHelicity::ProcessOptions(), QwHelicityPattern::ProcessOptions(), QwHistogramHelper::ProcessOptions(), QwRootFile::ProcessOptions(), VQwDetectorArray::ProcessOptions(), MQwPublishable< U, T >::PublishByRequest(), VQwDataHandler::PublishByRequest(), VQwDetectorArray::PublishByRequest(), MQwPublishable< U, T >::PublishInternalValue(), QwBeamLine::PublishInternalValues(), VQwDataHandler::PublishInternalValues(), VQwDetectorArray::PublishInternalValues(), QwEventRing::push(), QwDataHandlerArray::push_back(), QwDataHandlerArray::push_back(), QwSubsystemArray::push_back(), QwSubsystemArray::push_back(), QwBlinder::QwBlinder(), QwCorrelator::QwCorrelator(), QwDatabase::QwDatabase(), QwDatabase::QwDatabase(), QwDataHandlerArray::QwDataHandlerArray(), QwDataHandlerArray::QwDataHandlerArray(), QwHelicityPattern::QwHelicityPattern(), QwParameterFile::QwParameterFile(), QwRootFile::QwRootFile(), QwRootTree::QwRootTree(), QwRootTree::QwRootTree(), QwScopedConnection::QwScopedConnection(), QwSubsystemArray::QwSubsystemArray(), VQwDetectorArray::RandomizeMollerEvent(), QwSubsystemArrayParity::Ratio(), QwParameterFile::ReadNextLine_Greedy(), VQwSubsystem::RegisterMarkerWord(), VQwSubsystem::RegisterROCNumber(), VQwSubsystem::RegisterSubbank(), QwBeamDetectorID::ReportInitErrors(), MQwCodaControlEvent::ReportRunSummary(), MQwPublishable_child< QwDataHandlerArray, VQwDataHandler >::RequestExternalPointer(), QwHelicity::ResetPredictor(), MQwPublishable< U, T >::ReturnInternalValue(), MQwPublishable< QwDataHandlerArray, VQwDataHandler >::ReturnInternalValue(), QwHelicity::RunPredictor(), QwDatabase::SetAccessLevel(), QwOptions::SetCommandLine(), QwOptions::SetConfigFile(), QwHelicity::SetHelicityBitPattern(), QwHelicity::SetHelicityDelay(), QwBlinder::SetIHWPPolarity(), QwBCM< T >::SetSingleEventCuts(), QwBPMCavity::SetSingleEventCuts(), QwBPMStripline< T >::SetSingleEventCuts(), QwClock< T >::SetSingleEventCuts(), QwCombinedPMT::SetSingleEventCuts(), QwEnergyCalculator::SetSingleEventCuts(), QwHaloMonitor::SetSingleEventCuts(), QwIntegrationPMT::SetSingleEventCuts(), QwLinearDiodeArray::SetSingleEventCuts(), QwQPD::SetSingleEventCuts(), VQwBPM::SetSingleEventCuts(), VQwBPM::SetSingleEventCuts(), VQwHardwareChannel::SetSingleEventCuts(), QwBlinder::SetTargetBlindability(), QwPromptSummary::SetupElementList(), QwBlinder::SetWienState(), QwParameterFile::SkipSection(), LinRegBevPeb::solve(), QwDatabase::StoreDBVersion(), Coda3EventDecoder::trigBankDecode(), Coda3EventDecoder::trigBankErrorHandler(), QwEventRing::Unwind(), QwBlinder::Update(), QwBlinder::Update(), QwRootFile::Update(), LRBCorrector::UpdateBurstCounter(), QwSubsystemArrayParity::UpdateErrorFlag(), QwOptions::Usage(), QwDatabase::ValidateConnection(), QwEventBuffer::VerifyCodaVersion(), QwOptions::Version(), QwCorrelator::WriteAliasFile(), QwEPICSEvent::WriteEPICSStringValues(), QwEventBuffer::WriteEvent(), QwBPMStripline< T >::WritePromptSummary(), VQwDataHandler::WritePromptSummary(), VQwDetectorArray::WritePromptSummary(), QwDatabase::~QwDatabase(), and QwRootFile::~QwRootFile().

Here is the caller graph for this function:

flush()

std::ostream & QwLog::flush ( std::ostream & strm )

static

Flush the streams.

Flush the streams

Definition at line 317 of file QwLog.cc.

{
  if (gQwLog.fScreen) {
    *(gQwLog.fScreen) << std::flush;
  }
  if (gQwLog.fFile) {
    *(gQwLog.fFile) << std::flush;
  }
  return strm;
}

References gQwLog.

Referenced by QwInterpolator< value_t, value_n >::ReadBinaryFile(), QwInterpolator< value_t, value_n >::ReadText(), QwInterpolator< value_t, value_n >::WriteBinaryFile(), and QwInterpolator< value_t, value_n >::WriteText().

Here is the caller graph for this function:

GetLogLevel()

QwLogLevel QwLog::GetLogLevel ( ) const

inline

Get highest log level.

Definition at line 131 of file QwLog.h.

                                                    {
      return std::max(fScreenThreshold, fFileThreshold);
    };

References fFileThreshold, and fScreenThreshold.

GetTime()

const char * QwLog::GetTime ( )

private

Get the local time.

Get the local time

Definition at line 330 of file QwLog.cc.

{
  time_t now = time(0);
  if (now >= 0) {
    struct tm *currentTime = localtime(&now);
    strftime(fTimeString, 128, "%Y-%m-%d, %T", currentTime);
    return fTimeString;
  } else {
    return "";
  }
}

References fTimeString.

Referenced by operator()().

Here is the caller graph for this function:

InitLogFile()

void QwLog::InitLogFile	(	const std::string	name,
		const std::ios_base::openmode	mode = kAppend )

Initialize the log file with name 'name'.

Initialize the log file with name 'name'

Definition at line 155 of file QwLog.cc.

{
  if (fFile) {
    delete fFile;
    fFile = 0;
  }
 
  std::ios_base::openmode flags = std::ios::out | mode;
  fFile = new std::ofstream(name.c_str(), flags);
  fFileThreshold = kMessage;
}

References fFile, fFileThreshold, and kMessage.

Referenced by ProcessOptions().

Here is the caller graph for this function:

IsDebugFunction()

bool QwLog::IsDebugFunction

(

const string

func_sig

)

Determine whether the function name matches a specified list of regular expressions.

Determine whether the function name matches a specified list of regular expressions

Definition at line 135 of file QwLog.cc.

{
  // If not in our cached list
  if (fIsDebugFunction.find(func_sig) == fIsDebugFunction.end()) {
    // Look through all regexes
    fIsDebugFunction[func_sig] = false;
    for (size_t i = 0; i < fDebugFunctionRegexString.size(); i++) {
      // When we find a match, cache it and break out
      std::regex regex(fDebugFunctionRegexString.at(i));
      if (std::regex_match(func_sig, regex)) {
        fIsDebugFunction[func_sig] = true;
        break;
      }
    }
  }
  return fIsDebugFunction[func_sig];
}

References fDebugFunctionRegexString, and fIsDebugFunction.

Referenced by operator()().

Here is the caller graph for this function:

operator()()

QwLog & QwLog::operator()	(	const QwLogLevel	level,
		const std::string	func_sig = "<unknown>" )

Set the stream log level.

Set the stream log level

Definition at line 190 of file QwLog.cc.

{
  // Set the log level of this sink
  fLogLevel = level;
 
  // Override log level of this sink when in a debugged function
  if (IsDebugFunction(func_sig)) fLogLevel = QwLog::kAlways;
 
  if (fScreen && fLogLevel <= fScreenThreshold) {
    if (fScreenAtNewLine) {
      // Put something at the beginning of a new line
      switch (level) {
      case kError:
        if (fUseColor) {
          *(fScreen) << QwColor(Qw::kRed);
          fScreenInColor = true;
        }
        if (fPrintFunctionSignature)
          *(fScreen) << "Error (in " << func_sig << "): ";
        else
          *(fScreen) << "Error: ";
        break;
      case kWarning:
        if (fUseColor) {
          *(fScreen) << QwColor(Qw::kRed);
          fScreenInColor = true;
        }
        if (fPrintFunctionSignature)
          *(fScreen) << "Warning (in " << func_sig << "): ";
        else
          *(fScreen) << "Warning: ";
        if (fUseColor) {
          *(fScreen) << QwColor(Qw::kNormal);
          fScreenInColor = false;
        }
        break;
      default:
        fScreenInColor = false;
        break;
      }
    }
    fScreenAtNewLine = false;
  }
 
  if (fFile && fLogLevel <= fFileThreshold) {
    if (fFileAtNewLine) {
      *(fFile) << GetTime();
      switch (level) {
      case kError:   *(fFile) << " EE"; break;
      case kWarning: *(fFile) << " WW"; break;
      case kMessage: *(fFile) << " MM"; break;
      case kVerbose: *(fFile) << " VV"; break;
      case kDebug:   *(fFile) << " DD"; break;
      default: *(fFile) << "   "; break;
      }
      *(fFile) << " - ";
      fFileAtNewLine = false;
    }
  }
 
  return *this;
}

References fFile, fFileAtNewLine, fFileThreshold, fLogLevel, fPrintFunctionSignature, fScreen, fScreenAtNewLine, fScreenInColor, fScreenThreshold, fUseColor, GetTime(), IsDebugFunction(), kAlways, kDebug, kError, kMessage, Qw::kNormal, Qw::kRed, kVerbose, kWarning, and QwLog().

Here is the call graph for this function:

operator<<() [1/2]

template<class T>

QwLog & QwLog::operator<< ( const T & t )

inline

Stream an object to the output stream.

Definition at line 142 of file QwLog.h.

                                                       {
      if (fScreen && fLogLevel <= fScreenThreshold) {
        *(fScreen) << t;
      }
      if (fFile && fLogLevel <= fFileThreshold) {
        *(fFile) << t;
      }
      return *this;
    }

References fFile, fFileThreshold, fLogLevel, fScreen, fScreenThreshold, and QwLog().

Here is the call graph for this function:

operator<<() [2/2]

QwLog & QwLog::operator<<

(

std::ostream &(*

manip )(std::ostream &)

)

Pass the ios_base manipulators.

Definition at line 278 of file QwLog.cc.

{
  if (fScreen && (fLogLevel <= fScreenThreshold || fLogLevel <= fFileThreshold) ) {
    *(fScreen) << manip;
  }
 
// The following solution leads to double calls to QwLog::endl
//   if (fScreen && fLogLevel <= fScreenThreshold) {
//     *(fScreen) << manip;
//   }
//   if (fFile && fLogLevel <= fFileThreshold) {
//     *(fFile) << manip;
//   }
 
  return *this;
}

References fFileThreshold, fLogLevel, fScreen, fScreenThreshold, and QwLog().

Here is the call graph for this function:

ProcessOptions()

void QwLog::ProcessOptions

(

QwOptions *

options

)

Process class options for QwOptions.

Process configuration options for logging class using QwOptions functionality.

Note: this uses a pointer as opposed to a reference, because as indicated above the QwLog class cannot depend on the QwOptions class. When using a pointer we only need a forward declaration and we do not need to include the header file QwOptions.h.

Parameters

options

Options object

Definition at line 106 of file QwLog.cc.

{
  // Initialize log file
  if (options->HasValue("QwLog.logfile"))
    InitLogFile(options->GetValue<std::string>("QwLog.logfile"));
 
  // Set the logging thresholds
  SetFileThreshold(options->GetValue<int>("QwLog.loglevel-file"));
  SetScreenThreshold(options->GetValue<int>("QwLog.loglevel-screen"));
 
  // Set color flag
  SetScreenColor(options->GetValue<bool>("QwLog.color"));
 
  // Set the flags for function name and signature printing
  fPrintFunctionSignature = options->GetValue<bool>("QwLog.print-signature");
 
  // Set the list of regular expressions for functions to debug
  fDebugFunctionRegexString = options->GetValueVector<std::string>("QwLog.debug-function");
  if (fDebugFunctionRegexString.size() > 0)
    std::cout << "Debug regex list:" << std::endl;
  for (size_t i = 0; i < fDebugFunctionRegexString.size(); i++) {
    std::cout << fDebugFunctionRegexString.back() << std::endl;
  }
}

References fDebugFunctionRegexString, fPrintFunctionSignature, QwOptions::GetValue(), QwOptions::GetValueVector(), QwOptions::HasValue(), InitLogFile(), SetFileThreshold(), SetScreenColor(), and SetScreenThreshold().

Here is the call graph for this function:

SetFileThreshold()

void QwLog::SetFileThreshold

(

int

thr

)

Set the file log level.

Set the file log level

Definition at line 183 of file QwLog.cc.

{
  fFileThreshold = QwLogLevel(thr);
}

References fFileThreshold.

Referenced by ProcessOptions().

Here is the caller graph for this function:

SetScreenColor()

void QwLog::SetScreenColor

(

bool

flag

)

Set the screen color mode.

Set the screen color mode

Definition at line 169 of file QwLog.cc.

{
  fUseColor = flag;
}

References fUseColor.

Referenced by ProcessOptions().

Here is the caller graph for this function:

SetScreenThreshold()

void QwLog::SetScreenThreshold

(

int

thr

)

Set the screen log level.

Set the screen log level

Definition at line 176 of file QwLog.cc.

{
  fScreenThreshold = QwLogLevel(thr);
}

References fScreenThreshold.

Referenced by ProcessOptions().

Here is the caller graph for this function:

Field Documentation

fDebugFunctionRegexString

std::vector<std::string> QwLog::fDebugFunctionRegexString

private

Definition at line 188 of file QwLog.h.

Referenced by IsDebugFunction(), and ProcessOptions().

fFile

std::ostream* QwLog::fFile

private

Definition at line 179 of file QwLog.h.

Referenced by InitLogFile(), operator()(), operator<<(), QwLog(), and ~QwLog().

fFileAtNewLine

bool QwLog::fFileAtNewLine = true

staticprivate

Flags only relevant for current line, but static for use in static function.

Definition at line 194 of file QwLog.h.

Referenced by endl(), and operator()().

fFileThreshold

QwLogLevel QwLog::fFileThreshold

private

File thresholds and stream.

Definition at line 178 of file QwLog.h.

Referenced by GetLogLevel(), InitLogFile(), operator()(), operator<<(), operator<<(), QwLog(), and SetFileThreshold().

fIsDebugFunction

std::map<std::string,bool> QwLog::fIsDebugFunction

private

List of regular expressions for functions that will have increased log level.

Definition at line 187 of file QwLog.h.

Referenced by IsDebugFunction().

fLogLevel

QwLogLevel QwLog::fLogLevel

private

Log level of this stream.

Definition at line 181 of file QwLog.h.

Referenced by operator()(), operator<<(), operator<<(), and QwLog().

fPrintFunctionSignature

bool QwLog::fPrintFunctionSignature

private

Flag to print function signature on warning or error.

Definition at line 184 of file QwLog.h.

Referenced by operator()(), ProcessOptions(), and QwLog().

fScreen

std::ostream* QwLog::fScreen

private

Definition at line 176 of file QwLog.h.

Referenced by operator()(), operator<<(), operator<<(), and QwLog().

fScreenAtNewLine

bool QwLog::fScreenAtNewLine = true

staticprivate

Definition at line 196 of file QwLog.h.

Referenced by endl(), and operator()().

fScreenInColor

bool QwLog::fScreenInColor = false

staticprivate

Definition at line 195 of file QwLog.h.

Referenced by endl(), and operator()().

fScreenThreshold

QwLogLevel QwLog::fScreenThreshold

private

Screen thresholds and stream.

Definition at line 175 of file QwLog.h.

Referenced by GetLogLevel(), operator()(), operator<<(), operator<<(), QwLog(), and SetScreenThreshold().

fTimeString

char QwLog::fTimeString[128]

private

Definition at line 172 of file QwLog.h.

Referenced by GetTime().

fUseColor

bool QwLog::fUseColor

private

Flag to disable color.

Definition at line 191 of file QwLog.h.

Referenced by operator()(), QwLog(), and SetScreenColor().

kAppend

const std::ios_base::openmode QwLog::kAppend = std::ios::app

static

Definition at line 99 of file QwLog.h.

kTruncate

const std::ios_base::openmode QwLog::kTruncate = std::ios::trunc

static

Log file open modes.

Definition at line 98 of file QwLog.h.

---

The documentation for this class was generated from the following files:

• QwLog.h
• QwLog.cc