#include <logmessage.h>

Public Member Functions
	LogMessage (const QtMsgType type, const QString &message, QHash< QString, QString > *logVars, const QString &file, const QString &function, const int line)

QString	toString (const QString &msgFormat, const QString &timestampFormat) const

QtMsgType	getType () const

Private Attributes
QHash< QString, QString >	logVars

QDateTime	timestamp

QtMsgType	type

Qt::HANDLE	threadId

QString	message

QString	file

QString	function

int	line

Detailed Description

Represents a single log message together with some data that are used to decorate the log message.

The following variables may be used in the message and in msgFormat:

{timestamp} Date and time of creation
{typeNr} Type of the message in numeric format (0-3)
{type} Type of the message in string format (DEBUG, WARNING, CRITICAL, FATAL)
{thread} ID number of the thread
{msg} Message text
{xxx} For any user-defined logger variable

Plus some new variables since QT 5.0, only filled when compiled in debug mode:

{file} Filename where the message was generated
{function} Function where the message was generated
{line} Line number where the message was generated

Definition at line 38 of file logmessage.h.

Constructor & Destructor Documentation

◆ LogMessage()

LogMessage::LogMessage	(	const QtMsgType	type,
		const QString &	message,
		QHash< QString, QString > *	logVars,
		const QString &	file,
		const QString &	function,
		const int	line
	)

Constructor. All parameters are copied, so that later changes to them do not affect this object.

Parameters

type	Type of the message
message	Message text
logVars	Logger variables, 0 is allowed
file	Name of the source file where the message was generated
function	Name of the function where the message was generated
line	Line Number of the source file, where the message was generated

Definition at line 11 of file logmessage.cpp.

References file, line, logVars, message, threadId, timestamp, and type.

 {
     this->type=type;
     this->message=message;
     this->file=file;
     this->function=function;
     this->line=line;
     timestamp=QDateTime::currentDateTime();
     threadId=QThread::currentThreadId();
 
     // Copy the logVars if not null,
     // so that later changes in the original do not affect the copy
     if (logVars)
     {
         this->logVars=*logVars;
     }
 }

Member Function Documentation

◆ getType()

QtMsgType LogMessage::getType ( ) const

Get the message type.

Definition at line 87 of file logmessage.cpp.

References type.

Referenced by qtwebapp::FileLogger::write().

 {
     return type;
 }

Here is the caller graph for this function:

◆ toString()

QString LogMessage::toString	(	const QString &	msgFormat,
		const QString &	timestampFormat
	)		const

Returns the log message as decorated string.

Parameters

msgFormat	Format of the decoration. May contain variables and static text, e.g. "{timestamp} {type} thread={thread}: {msg}".
timestampFormat	Format of timestamp, e.g. "yyyy-MM-dd HH:mm:ss.zzz", see QDateTime::toString().

See also: QDatetime for a description of the timestamp format pattern

Definition at line 29 of file logmessage.cpp.

References file, line, logVars, message, threadId, timestamp, and type.

Referenced by qtwebapp::FileLogger::write(), and qtwebapp::Logger::write().

 {
     QString decorated=msgFormat+"\n";
     decorated.replace("{msg}",message);
 
     if (decorated.contains("{timestamp}"))
     {
         decorated.replace("{timestamp}",timestamp.toString(timestampFormat));
     }
 
     QString typeNr;
     typeNr.setNum(type);
     decorated.replace("{typeNr}",typeNr);
 
     switch (type)
     {
         case QtDebugMsg:
             decorated.replace("{type}","(D)");
             break;
         case QtWarningMsg:
             decorated.replace("{type}","(W)");
             break;
         case QtCriticalMsg:
             decorated.replace("{type}","(C)");
             break;
         case QtFatalMsg:
             decorated.replace("{type}","(F)");
             break;
     #if (QT_VERSION >= QT_VERSION_CHECK(5, 5, 0))
         case QtInfoMsg:
             decorated.replace("{type}","(I)");
             break;
     #endif
         default:
             decorated.replace("{type}",typeNr);
     }
 
     decorated.replace("{file}",file);
     decorated.replace("{function}",function);
     decorated.replace("{line}",QString::number(line));
 
     QString threadId;
     threadId.setNum((std::size_t)QThread::currentThreadId());
     decorated.replace("{thread}",threadId);
 
     // Fill in variables
     if (decorated.contains("{") && !logVars.isEmpty())
     {
         QList<QString> keys=logVars.keys();
         foreach (QString key, keys)
         {
             decorated.replace("{"+key+"}",logVars.value(key));
         }
     }
 
     return decorated;
 }