sopt::logging Namespace Reference

Classes
class	Log
	Logging system for controlled & formatted writing to stdout. More...

Functions
void	_updateLevels (const Log::LevelMap &defaultLevels, Log::LogMap &existingLogs)
ostream &	operator<< (Log &log, int level)
	Streaming output to a logger must have a Log::Level/int as its first argument. More...
Log &	getLog ()
	Access method to default Log object. More...
void	set_level (const std::string &level)
	Method to set the logging level of the default Log object. More...
template<typename Arg >
void	applyFormat (std::stringstream &ss, char *&pos, Arg &&arg)
template<typename... Args>
std::string	mkFormattedString (const char *txt, Args &&... args)
	Helper method to construct formatted string. More...
const std::string &	mkFormattedString (const std::string &txt)

Function Documentation

_updateLevels()

void sopt::logging::_updateLevels	(	const Log::LevelMap &	defaultLevels,
		Log::LogMap &	existingLogs
	)

Todo:

Add single static setLevel

Todo:

Check ordering - "Foo" should come before "Foo.Bar"

Definition at line 30 of file logging.cc.

                                                                                {
    for (Log::LevelMap::const_iterator lev = defaultLevels.begin(); lev != defaultLevels.end(); ++lev) {
      for (Log::LogMap::iterator log = existingLogs.begin(); log != existingLogs.end(); ++log) {
        if (log->first.find(lev->first) == 0) {
          log->second.setLevel(lev->second);
        }
      }
    }
  }

Referenced by sopt::logging::Log::setLevels().

applyFormat()

template<typename Arg >

void sopt::logging::applyFormat	(	std::stringstream &	ss,
		char *&	pos,
		Arg &&	arg
	)

Helper method to ireplace a set of curly braces with the template argument arg in a string stream

Definition at line 162 of file logging.h.

                                                             {
  char* delim = strstr(pos, "{}");
  if (delim != NULL) {
    ss << std::string(pos, delim-pos) << std::forward<Arg>(arg);
    pos = delim + 2;
  }
  else {
    SOPT_THROW("Insufficient placeholders for number of arguments!");
  }
}

References SOPT_THROW.

Referenced by mkFormattedString().

getLog()

Log& sopt::logging::getLog ( )

inline

Access method to default Log object.

Definition at line 151 of file logging.h.

{ return Log::getLog("sopt::"); }

References sopt::logging::Log::getLog().

Referenced by set_level().

mkFormattedString() [1/2]

template<typename... Args>

std::string sopt::logging::mkFormattedString ( const char *  txt, Args &&...  args  )

inline

Helper method to construct formatted string.

Definition at line 175 of file logging.h.

                                                                     {
  std::string mys = txt;
  std::stringstream rtn;
  char* pos = (char*)txt;
  ((void)applyFormat(rtn, pos, std::forward<Args>(args)), ...);
  rtn << std::string(pos);
  return rtn.str();
}

References applyFormat().

mkFormattedString() [2/2]

const std::string& sopt::logging::mkFormattedString ( const std::string &  txt )

inline

Definition at line 184 of file logging.h.

{ return txt; }

operator<<()

std::ostream & sopt::logging::operator<<	(	Log &	log,
		int	level
	)

Streaming output to a logger must have a Log::Level/int as its first argument.

The streaming operator can use Log's internals.

Definition at line 190 of file logging.cc.

                                           {
    if (log.isActive(level)) {
        if (level > Log::warning) {
            cerr << log.formatMessage(level, "");
            return cerr;
        } else {
            cout << log.formatMessage(level, "");
            return cout;
        }
    } else {
      static ostream devNull(nullptr);
      return devNull;
    }
  }

set_level()

void sopt::logging::set_level ( const std::string &  level )

inline

Method to set the logging level of the default Log object.

Definition at line 154 of file logging.h.

                                              {
  getLog().setLevel(Log::getLevelFromName(level));
}

References sopt::logging::Log::getLevelFromName(), getLog(), and sopt::logging::Log::setLevel().

Referenced by main(), and TEST_CASE().