LOG Class Reference

#include <LOG.hxx>

Collaboration diagram for LOG:

Public Types
using	MAX_LOG_SIZE_BYTES = Constant< 1000000 >

Public Member Functions
	LOG (LogType type)
	Create a Logger. More...
	~LOG ()
	Destroy a Logger. More...
template<class Object >
LOG &	operator<< (const Object &msg)
	Log a message. More...

Private Member Functions
const std::string	getTimeStamp ()
	Gets formatted TimeStamp. More...
void	writeErrorLog (const std::string &errorMessage) const
	Write log message to error.log file. More...

Private Attributes
LogType	m_LogType
std::ostringstream	m_Logger

Static Private Attributes
static Mutex	StreamMutex
static constexpr const char *	LOG_PREFIX_COLORED []
static constexpr const char *	LOG_PREFIX []

Detailed Description

Examples

tests/util/MessageQueue.cxx.

Definition at line 32 of file LOG.hxx.

Member Typedef Documentation

MAX_LOG_SIZE_BYTES

using LOG::MAX_LOG_SIZE_BYTES = Constant<1000000>

Definition at line 50 of file LOG.hxx.

Constructor & Destructor Documentation

LOG()

LOG::LOG

(

LogType

type

)

Create a Logger.

Definition at line 12 of file LOG.cxx.

: m_LogType(type) {}

~LOG()

LOG::~LOG

(

)

Destroy a Logger.

Definition at line 14 of file LOG.cxx.

{
  LockGuard lock(StreamMutex);
  string message = getTimeStamp() + LOG_PREFIX[m_LogType] + m_Logger.str();
  if (!getenv("TERM"))
  {
#ifndef DEBUG
    if (m_LogType != LOG_DEBUG)
#endif
#ifdef __ANDROID__
      __android_log_print(ANDROID_LOG_INFO, "Cytopia", "%s", message.c_str());
#else
    std::cout << message << std::endl;
#endif
  }
  else
  {
#ifndef DEBUG
    if (m_LogType != LOG_DEBUG)
#endif
      std::cout << getTimeStamp() << LOG_PREFIX_COLORED[m_LogType] << m_Logger.str() << std::endl;
  }
#ifndef __ANDROID__
  writeErrorLog(message);
#endif
}

Here is the call graph for this function:

Member Function Documentation

getTimeStamp()

const std::string LOG::getTimeStamp ( )

private

Gets formatted TimeStamp.

Returns

std::string containing current TimeStamp

Definition at line 41 of file LOG.cxx.

{
  std::time_t now = std::chrono::system_clock::to_time_t(std::chrono::system_clock::now());
  char buf[100] = {0};
  std::strftime(buf, sizeof(buf), "%b %d %H:%M:%S", std::localtime(&now)); // lgtm [cpp/potentially-dangerous-function]
  return buf;
}

Here is the caller graph for this function:

operator<<()

template<class Object >

LOG & LOG::operator<<

(

const Object &

msg

)

Log a message.

Template Parameters

msg	the streamable message type

Definition at line 2 of file LOG.inl.hxx.

{
  m_Logger << msg;
  return *this;
}

writeErrorLog()

void LOG::writeErrorLog ( const std::string &  errorMessage ) const

private

Write log message to error.log file.

If the log file exceeds MAX_LOG_SIZE_BYTES, logs will be cut in half

Parameters

errorMessage

to write to error logfile

Definition at line 49 of file LOG.cxx.

{
  fs::createDirectory(CYTOPIA_DATA_DIR);
  string errfname = CYTOPIA_DATA_DIR + string{"error.log"};
 
  /* First we create the file if it doesn't exist */
  std::fstream fs(errfname, std::fstream::out | std::fstream::app);
  if (!fs)
    throw CytopiaError(TRACE_INFO "Could not open file " + errfname);
 
  /* We send the message */
  fs << errorMessage << std::endl;
 
  /* We compute the size of the file */
  fs.seekp(0, std::fstream::end);
  std::streampos Size = fs.tellp();
  if (Size > MAX_LOG_SIZE_BYTES::value)
  {
    /* We need to rotate the logs */
    std::fstream fsToRotate(errfname, std::fstream::in | std::fstream::out);
    fsToRotate.seekg(0);
    string line;
    std::streampos Cut = 0;
    while (Size - Cut > MAX_LOG_SIZE_BYTES::value / 2 && std::getline(fsToRotate, line))
      Cut += line.size() + 1;
    stringstream truncatedstream;
    truncatedstream << fsToRotate.rdbuf();
    fsToRotate.close();
    fsToRotate.open(fs::getBasePath() + string{"error.log"}, std::fstream::trunc | std::fstream::out);
    fsToRotate << truncatedstream.str();
  }
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

LOG_PREFIX

constexpr const char* LOG::LOG_PREFIX[]

staticconstexprprivate

Initial value:

= {
      " - [INFO] - ", " - [DEBUG] - ", " - [WARNING] - ", " - [ERROR] - ", " - [FATAL] - ",
  }

Definition at line 44 of file LOG.hxx.

LOG_PREFIX_COLORED

constexpr const char* LOG::LOG_PREFIX_COLORED[]

staticconstexprprivate

Initial value:

= {
      " - \x1B[38;5;39m\x1B[1m[INFO]\x1B[0m - ",     " - \x1B[38;5;57m\x1B[1m[DEBUG]\x1B[0m - ",
      " - \x1B[38;5;214m\x1B[1m[WARNING]\x1B[0m - ", " - \x1B[38;5;196m\x1B[1m[ERROR]\x1B[0m - ",
      " - \x1B[38;5;124m\x1B[1m[FATAL]\x1B[0m - ",
  }

Definition at line 38 of file LOG.hxx.

m_Logger

std::ostringstream LOG::m_Logger

private

Definition at line 70 of file LOG.hxx.

m_LogType

LogType LOG::m_LogType

private

Definition at line 69 of file LOG.hxx.

StreamMutex

Mutex LOG::StreamMutex

staticprivate

Definition at line 36 of file LOG.hxx.

---

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

• src/util/LOG.hxx
• src/util/LOG.cxx
• src/util/LOG.inl.hxx