Blam::Logger::Internal Namespace Reference

Internal functions used by the logger. More...

Functions
BLAM void	PrepareTextLog (std::string report_filename)
	Prepares the plain text log file for writing. More...
BLAM void	PrepareHTMLLog (std::string report_filename)
	Prepares the HTML log file. More...
BLAM std::string	PrepareHTMLTemplate (std::string log_title)
	Prepares the contents of the default HTML log template. More...
BLAM void	CreateReportViewerPage ()
	Prepares the HTML file for the BlamReport Viewer. More...
BLAM void	LoadConsoleColors ()
	Loads console color configuration. More...

Detailed Description

Internal functions used by the logger.

Should not be called outside of the logger's own functions.

Function Documentation

CreateReportViewerPage()

void Blam::Logger::Internal::CreateReportViewerPage

(

)

Prepares the HTML file for the BlamReport Viewer.

The BlamReport Viewer is a brand spankin' new extension of Halo 2's HTML logging concept. What started as having stylized HTML log files to take advantage of the format eventually evolved into a nice viewer to access all Reports from one page.

This function will create the needed CSS, Images, and BlamReport Viewer page.

LoadConsoleColors()

void Blam::Logger::Internal::LoadConsoleColors

(

)

Loads console color configuration.

PrepareHTMLLog()

void Blam::Logger::Internal::PrepareHTMLLog

(

std::string

report_filename

)

Prepares the HTML log file.

This function will write the default contents of the HTML file in order to ensure that messages can be logged without error.

Parameters

report_filename

- The filename of the report, without any file extension.

PrepareHTMLTemplate()

std::string Blam::Logger::Internal::PrepareHTMLTemplate

(

std::string

log_title

)

Prepares the contents of the default HTML log template.

Parameters

log_title

- The title of the log file. Should be the filename, without the extension.

Returns

The prepared HTML template for the log file.

PrepareTextLog()

void Blam::Logger::Internal::PrepareTextLog

(

std::string

report_filename

)

Prepares the plain text log file for writing.

This function will only create the file, and clear it if the setting is enabled in config. No fancy formatting required - it's plain text, after all.

Parameters

report_filename

- The filename of the report, without any file extension.