logger.h File Reference

#include <Windows.h>
#include <vector>
#include <fstream>
#include <Strings/components/interface/logger/logger.h>
#include "components/resources/engine_globals/globals.h"

Include dependency graph for logger.h:

Go to the source code of this file.

Classes
class	BlamReportFile
	Class representing a report file. More...
class	BlamReport
	Class representing a report file. More...

Namespaces
	Blam
	Namespace surrounding all major engine components.
	Blam::Logger
	Namespace containing things related to the Blamite Logger.
	Blam::Logger::Queue
	Functions for the logger's message queue.

Macros
#define	DEFAULT_LOG_FILENAME   "debug"
	Specifies the default filename of a log file, without the extension. More...
#define	BLAM

Enumerations
enum	BlamLogFileFormat { BlamLogFileFormat::HTML, BlamLogFileFormat::PlainText, BlamLogFileFormat::Both }
	Enumerator containing possible log file formats. More...

Functions
BLAM void	Blam::Logger::Queue::Initialize ()
	Initializes the logger queue. More...
BLAM void	Blam::Logger::Queue::Shutdown ()
	Flushes the queue and may later be used to perform other shutdown tasks. More...
BLAM void	Blam::Logger::Queue::Flush ()
	Flushes the queue, causing all messages to be written to all places they are configured to do so. More...
BLAM void	Blam::Logger::Queue::AddMessage (BlamLogMessage message)
	Adds a message to the queue. More...
BLAM std::vector< BlamLogMessage > *	Blam::Logger::Queue::GetQueue ()
	Retrieves the current message queue. More...
BLAM void	Blam::Logger::Queue::FlushThread ()
BLAM void	Blam::Logger::Queue::StartFlushThread ()
BLAM void	Blam::Logger::Queue::StopFlushThread ()
BLAM BlamReport *	Blam::Logger::GetReport (BlamReportType type)
	Retrieves report data with the specified type. More...
BLAM std::vector< BlamReport * >	Blam::Logger::GetReports ()
	Retrieves the list of reports. More...
BLAM std::string	Blam::Logger::GetLogLevelCSSClass (BlamLogLevel log_level)
	Gets the CSS class name for the specified log level. More...
BLAM BlamColor	Blam::Logger::GetLogLevelColor (BlamLogLevel log_level)
	Retrieves the BlamColor that a specific log level should display with. More...
BLAM void	Blam::Logger::Initialize ()
	Prepares the logger for use. More...
BLAM void	Blam::Logger::Shutdown ()
	Shuts down the logger. More...
BLAM void	Blam::Logger::LogEventAsync (std::string message)
	Logs a message to the log and/or console asynchronously. More...
BLAM void	Blam::Logger::LogEvent (std::string message)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, bool show_timestamp)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamReportType report_type)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, bool show_timestamp, BlamLogLevel severity)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, bool show_timestamp, BlamLogLevel severity, short r, short g, short b)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamLogLevel severity)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamLogLevel severity, BlamReportType report_type)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamLogLevel severity, BlamLogVisibility visibility)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamColor color)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (std::string message, BlamColor color, BlamLogVisibility visibility)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEvent (BlamLogMessage message)
	Logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (std::string message)
	Forcibly logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (std::string message, BlamLogLevel severity)
	Forcibly logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (std::string message, BlamColor color)
	Forcibly logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (std::string message, BlamLogLevel severity, BlamLogVisibility visibility)
	Forcibly logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (std::string message, BlamLogLevel severity, BlamReportType report_type)
	Forcibly logs a message to the log and/or console. More...
BLAM void	Blam::Logger::LogEventForce (BlamLogMessage message)
	Forcibly logs a message to the log and/or console. More...

Macro Definition Documentation

BLAM

#define BLAM

DEFAULT_LOG_FILENAME

#define DEFAULT_LOG_FILENAME   "debug"

Specifies the default filename of a log file, without the extension.

Enumeration Type Documentation

BlamLogFileFormat

enum BlamLogFileFormat

strong

Enumerator containing possible log file formats.

Enumerator
HTML	The log file will be written with an HTML format.
PlainText	The log file will be written in a plain text (.txt) format.
Both	The log file will be written as both an HTML document and a plain text document.