mirror of https://github.com/deavmi/gogga.git
608 lines
15 KiB
D
608 lines
15 KiB
D
/**
|
|
* Core routines and types
|
|
*
|
|
* Authors: Tristan Brice Velloza Kildaire (deavmi)
|
|
*/
|
|
module gogga.core;
|
|
|
|
import dlog.core;
|
|
import dlog.basic;
|
|
import std.conv : to;
|
|
import dlog.utilities : flatten;
|
|
import std.array : join;
|
|
|
|
/**
|
|
* The gogga styles supported
|
|
*/
|
|
public enum GoggaMode
|
|
{
|
|
/**
|
|
* TwoKTwenty3 is: `[<file>] (<module>:<lineNumber>) <message>`
|
|
*/
|
|
TwoKTwenty3,
|
|
|
|
/**
|
|
* Simple mode is just: `[<LEVEL>] <message>`
|
|
*/
|
|
SIMPLE,
|
|
|
|
/**
|
|
* Rustacean mode is: `[<LEVEL>] (<filePath>/<functionName>:<lineNumber>) <message>`
|
|
*/
|
|
RUSTACEAN,
|
|
|
|
/**
|
|
* Simple rustacean mode is: `[<LEVEL>] (<functionName>:<lineNumber>) <message>`
|
|
*/
|
|
RUSTACEAN_SIMPLE
|
|
}
|
|
|
|
/**
|
|
* Information obtained during compilation time (if any)
|
|
*/
|
|
public struct GoggaCompInfo
|
|
{
|
|
/**
|
|
* compile time usage file
|
|
*/
|
|
public string fullFilePath;
|
|
|
|
/**
|
|
* compile time usage file (relative)
|
|
*/
|
|
public string file;
|
|
|
|
/**
|
|
* compile time usage line number
|
|
*/
|
|
public ulong line;
|
|
|
|
/**
|
|
* compile time usage module
|
|
*/
|
|
public string moduleName;
|
|
|
|
/**
|
|
* compile time usage function
|
|
*/
|
|
public string functionName;
|
|
|
|
/**
|
|
* compile time usage function (pretty)
|
|
*/
|
|
public string prettyFunctionName;
|
|
|
|
/**
|
|
* Constructs the compilation information with the provided
|
|
* parameters
|
|
*
|
|
* Params:
|
|
* __FILE_FULL_PATH__ = compile time usage file
|
|
* __FILE__ = compile time usage file (relative)
|
|
* __LINE__ = compile time usage line number
|
|
* __MODULE__ = compile time usage module
|
|
* __FUNCTION__ = compile time usage function
|
|
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
|
|
*/
|
|
this(string fullFilePath, string file, ulong line, string moduleName, string functionName, string prettyFunctionName)
|
|
{
|
|
this.fullFilePath = fullFilePath;
|
|
this.file = file;
|
|
this.line = line;
|
|
this.moduleName = moduleName;
|
|
this.functionName = functionName;
|
|
this.prettyFunctionName = prettyFunctionName;
|
|
}
|
|
|
|
/**
|
|
* Flattens the known compile-time information into a string array
|
|
*
|
|
* Returns: a string[]
|
|
*/
|
|
public string[] toArray()
|
|
{
|
|
return [fullFilePath, file, to!(string)(line), moduleName, functionName, prettyFunctionName];
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A `GoggaMessage` which comprises
|
|
* of a `GoggaCompInfo` for context
|
|
*/
|
|
private class GoggaMessage : BasicMessage
|
|
{
|
|
/**
|
|
* The line information
|
|
*/
|
|
private GoggaCompInfo ctx;
|
|
|
|
/**
|
|
* Sets the context
|
|
*
|
|
* Params:
|
|
* ctx = the context
|
|
*/
|
|
public void setContext(GoggaCompInfo ctx)
|
|
{
|
|
this.ctx = ctx;
|
|
}
|
|
|
|
/**
|
|
* Returns the context
|
|
*
|
|
* Returns: the context
|
|
*/
|
|
public GoggaCompInfo getContext()
|
|
{
|
|
return this.ctx;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* The Gogga transformer which
|
|
* applies stylization to
|
|
* incoming `GoggaMessage`(s)
|
|
*/
|
|
private class GoggaTransform : Transform
|
|
{
|
|
/**
|
|
* Mode to use for stylization
|
|
*/
|
|
private GoggaMode mode;
|
|
|
|
/**
|
|
* Sets the stylization to
|
|
* use when transforming
|
|
* the message's text
|
|
*
|
|
* Params:
|
|
* mode = the `GoggaMode`
|
|
*/
|
|
public void setMode(GoggaMode mode)
|
|
{
|
|
this.mode = mode;
|
|
}
|
|
|
|
/**
|
|
* Transforms the incoming message
|
|
* to use the Gogga stylization. This
|
|
* will be a no-op if the incoming
|
|
* message is not a `GoggaMessage`.
|
|
*
|
|
* Params:
|
|
* message = the message to transform
|
|
* Returns: the transformed message,
|
|
* else the same exact one
|
|
*/
|
|
public Message transform(Message message)
|
|
{
|
|
// Only handle GoggaMessage(s)
|
|
GoggaMessage goggaMesg = cast(GoggaMessage)message;
|
|
if(goggaMesg is null)
|
|
{
|
|
return null;
|
|
}
|
|
|
|
/* The generated output string */
|
|
string finalOutput;
|
|
|
|
|
|
|
|
/* Extract the Level */
|
|
Level level = goggaMesg.getLevel();
|
|
|
|
/* Extract the text */
|
|
string text = goggaMesg.getText();
|
|
|
|
/* get the context data */
|
|
string[] context = goggaMesg.getContext().toArray();
|
|
|
|
|
|
/**
|
|
* Simple mode is just: `[<LEVEL>] <message>`
|
|
*/
|
|
if(this.mode == GoggaMode.SIMPLE)
|
|
{
|
|
finalOutput = cast(string)debugColor("["~to!(string)(level)~"] ", level);
|
|
|
|
finalOutput ~= text~"\n";
|
|
}
|
|
/**
|
|
* TwoKTwenty3 is: `[<file>] (<module>:<lineNumber>) <message>`
|
|
*/
|
|
else if(this.mode == GoggaMode.TwoKTwenty3)
|
|
{
|
|
/* Module information (and status debugColoring) */
|
|
string moduleInfo = cast(string)debugColor("["~context[1]~"]", level);
|
|
|
|
/* Function and line number info */
|
|
string funcInfo = cast(string)(colorSrc("("~context[4]~":"~context[2]~")"));
|
|
|
|
finalOutput = moduleInfo~" "~funcInfo~" "~text~"\n";
|
|
}
|
|
/**
|
|
* Rustacean mode is: `[<LEVEL>] (<filePath>/<functionName>:<lineNumber>) <message>`
|
|
*/
|
|
else if(this.mode == GoggaMode.RUSTACEAN)
|
|
{
|
|
finalOutput = cast(string)debugColor(to!(string)(level)~"\t", level);
|
|
finalOutput ~= cast(string)(colorSrc(context[1]~"/"~context[4]~":"~context[2]~" "));
|
|
finalOutput ~= text~"\n";
|
|
}
|
|
/**
|
|
* Simple rustacean mode is: `[<LEVEL>] (<functionName>:<lineNumber>) <message>`
|
|
*/
|
|
else if(this.mode == GoggaMode.RUSTACEAN_SIMPLE)
|
|
{
|
|
finalOutput = cast(string)debugColor(to!(string)(level)~"\t", level);
|
|
finalOutput ~= cast(string)(colorSrc(context[4]~":"~context[2]~" "));
|
|
finalOutput ~= text~"\n";
|
|
}
|
|
|
|
goggaMesg.setText(finalOutput);
|
|
return message;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* A `GoggaLogger`
|
|
*/
|
|
public final class GoggaLogger : BasicLogger
|
|
{
|
|
/**
|
|
* The Gogga text transformer
|
|
*/
|
|
private GoggaTransform gogTrans;
|
|
|
|
/**
|
|
* Whether debug prints are enabled or not
|
|
*/
|
|
private bool debugEnabled = false;
|
|
|
|
/**
|
|
* Constructs a new `GoggaLogger`
|
|
*/
|
|
this()
|
|
{
|
|
super();
|
|
this.gogTrans = new GoggaTransform();
|
|
addTransform(this.gogTrans);
|
|
}
|
|
|
|
/**
|
|
* Sets the style of logging
|
|
* to use
|
|
*
|
|
* Params:
|
|
* mode = the `GoggaMode`
|
|
*/
|
|
public void mode(GoggaMode mode)
|
|
{
|
|
this.gogTrans.setMode(mode);
|
|
}
|
|
|
|
/**
|
|
* Performs the actual logging
|
|
* by packing up everything before
|
|
* sending it to the `log(Message)`
|
|
* method
|
|
*
|
|
* Params:
|
|
* segments = the compile-time segments
|
|
* info = the context
|
|
* level = the log level to use
|
|
*/
|
|
public void doLog(TextType...)(TextType segments, GoggaCompInfo info, Level level)
|
|
{
|
|
/* Create a new GoggaMessage */
|
|
GoggaMessage message = new GoggaMessage();
|
|
|
|
/* Set context to the line information */
|
|
message.setContext(info);
|
|
|
|
/* Set the level */
|
|
message.setLevel(level);
|
|
|
|
/**
|
|
* Grab all compile-time arguments and make them
|
|
* into an array, then join them together and
|
|
* set that text as the message's text
|
|
*/
|
|
message.setText(join(flatten(segments), " "));
|
|
|
|
/* Log this message */
|
|
log(message);
|
|
}
|
|
|
|
/**
|
|
* Logs using the default context an arbitrary amount of arguments
|
|
* specifically setting the context's level to ERROR
|
|
*
|
|
* Params:
|
|
* segments = the arbitrary argumnets (alias sequence)
|
|
* __FILE_FULL_PATH__ = compile time usage file
|
|
* __FILE__ = compile time usage file (relative)
|
|
* __LINE__ = compile time usage line number
|
|
* __MODULE__ = compile time usage module
|
|
* __FUNCTION__ = compile time usage function
|
|
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
|
|
*/
|
|
public void error(TextType...)(TextType segments,
|
|
string c1 = __FILE_FULL_PATH__,
|
|
string c2 = __FILE__, ulong c3 = __LINE__,
|
|
string c4 = __MODULE__, string c5 = __FUNCTION__,
|
|
string c6 = __PRETTY_FUNCTION__)
|
|
{
|
|
doLog(segments, GoggaCompInfo(c1, c2, c3, c4, c5, c6), Level.ERROR);
|
|
}
|
|
|
|
/**
|
|
* Logs using the default context an arbitrary amount of arguments
|
|
* specifically setting the context's level to INFO
|
|
*
|
|
* Params:
|
|
* segments = the arbitrary argumnets (alias sequence)
|
|
* __FILE_FULL_PATH__ = compile time usage file
|
|
* __FILE__ = compile time usage file (relative)
|
|
* __LINE__ = compile time usage line number
|
|
* __MODULE__ = compile time usage module
|
|
* __FUNCTION__ = compile time usage function
|
|
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
|
|
*/
|
|
public void info(TextType...)(TextType segments,
|
|
string c1 = __FILE_FULL_PATH__,
|
|
string c2 = __FILE__, ulong c3 = __LINE__,
|
|
string c4 = __MODULE__, string c5 = __FUNCTION__,
|
|
string c6 = __PRETTY_FUNCTION__)
|
|
{
|
|
doLog(segments, GoggaCompInfo(c1, c2, c3, c4, c5, c6), Level.INFO);
|
|
}
|
|
|
|
/**
|
|
* Logs using the default context an arbitrary amount of arguments
|
|
* specifically setting the context's level to WARN
|
|
*
|
|
* Params:
|
|
* segments = the arbitrary argumnets (alias sequence)
|
|
* __FILE_FULL_PATH__ = compile time usage file
|
|
* __FILE__ = compile time usage file (relative)
|
|
* __LINE__ = compile time usage line number
|
|
* __MODULE__ = compile time usage module
|
|
* __FUNCTION__ = compile time usage function
|
|
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
|
|
*/
|
|
public void warn(TextType...)(TextType segments,
|
|
string c1 = __FILE_FULL_PATH__,
|
|
string c2 = __FILE__, ulong c3 = __LINE__,
|
|
string c4 = __MODULE__, string c5 = __FUNCTION__,
|
|
string c6 = __PRETTY_FUNCTION__)
|
|
{
|
|
doLog(segments, GoggaCompInfo(c1, c2, c3, c4, c5, c6), Level.WARN);
|
|
}
|
|
|
|
/**
|
|
* Logs using the default context an arbitrary amount of arguments
|
|
* specifically setting the context's level to DEBUG and will
|
|
* only print if debugging is enabled
|
|
*
|
|
* Params:
|
|
* segments = the arbitrary argumnets (alias sequence)
|
|
* __FILE_FULL_PATH__ = compile time usage file
|
|
* __FILE__ = compile time usage file (relative)
|
|
* __LINE__ = compile time usage line number
|
|
* __MODULE__ = compile time usage module
|
|
* __FUNCTION__ = compile time usage function
|
|
* __PRETTY_FUNCTION__ = compile time usage function (pretty)
|
|
*/
|
|
public void debug_(TextType...)(TextType segments,
|
|
string c1 = __FILE_FULL_PATH__,
|
|
string c2 = __FILE__, ulong c3 = __LINE__,
|
|
string c4 = __MODULE__, string c5 = __FUNCTION__,
|
|
string c6 = __PRETTY_FUNCTION__)
|
|
{
|
|
doLog(segments, GoggaCompInfo(c1, c2, c3, c4, c5, c6), Level.DEBUG);
|
|
}
|
|
|
|
/**
|
|
* Alias for debug_
|
|
*/
|
|
public alias dbg = debug_;
|
|
}
|
|
|
|
/**
|
|
* Colorise the text provided accoridng to the level and then
|
|
* reset the colors at the end
|
|
*
|
|
* Params:
|
|
* text = the text to colorise
|
|
* level = the color to use
|
|
* Returns: the byte sequence of characters and controls
|
|
*/
|
|
private byte[] debugColor(string text, Level level)
|
|
{
|
|
/* The generated message */
|
|
byte[] messageBytes;
|
|
|
|
/* If INFO, set green */
|
|
if(level == Level.INFO)
|
|
{
|
|
messageBytes = cast(byte[])[27, '[','3','2','m'];
|
|
}
|
|
/* If WARN, set yellow */
|
|
else if(level == Level.WARN)
|
|
{
|
|
messageBytes = cast(byte[])[27, '[','3','1', ';', '9', '3', 'm'];
|
|
}
|
|
/* If ERROR, set red */
|
|
else if(level == Level.ERROR)
|
|
{
|
|
messageBytes = cast(byte[])[27, '[','3','1','m'];
|
|
}
|
|
/* If DEBUG, set pink */
|
|
else
|
|
{
|
|
messageBytes = cast(byte[])[27, '[','3','5','m'];
|
|
}
|
|
|
|
/* Add the message */
|
|
messageBytes ~= cast(byte[])text;
|
|
|
|
/* Switch back debugColor */
|
|
messageBytes ~= cast(byte[])[27, '[', '3', '9', 'm'];
|
|
|
|
/* Reset coloring */
|
|
messageBytes ~= [27, '[', 'm'];
|
|
|
|
return messageBytes;
|
|
}
|
|
|
|
/**
|
|
* Colors the provided text in a gray fashion and then
|
|
* resets back to normal
|
|
*
|
|
* Params:
|
|
* text = the text to gray color
|
|
* Returns: the byte sequence of characters and controls
|
|
*/
|
|
private byte[] colorSrc(string text)
|
|
{
|
|
/* The generated message */
|
|
byte[] messageBytes;
|
|
|
|
/* Reset coloring */
|
|
messageBytes ~= [27, '[', 'm'];
|
|
|
|
/* Color gray */
|
|
messageBytes ~= [27, '[', '3', '9', ';', '2', 'm'];
|
|
|
|
/* Append the message */
|
|
messageBytes ~= text;
|
|
|
|
/* Reset coloring */
|
|
messageBytes ~= [27, '[', 'm'];
|
|
|
|
return messageBytes;
|
|
}
|
|
|
|
version(unittest)
|
|
{
|
|
import std.stdio : writeln, stdout;
|
|
}
|
|
|
|
unittest
|
|
{
|
|
GoggaLogger gLogger = new GoggaLogger();
|
|
gLogger.addHandler(new FileHandler(stdout));
|
|
gLogger.setLevel(Level.INFO);
|
|
|
|
// Test the normal modes
|
|
gLogger.info("This is an info message");
|
|
gLogger.warn("This is a warning message");
|
|
gLogger.error("This is an error message");
|
|
|
|
// We shouldn't see anything as debug is off
|
|
gLogger.dbg("This is a debug which is hidden", 1);
|
|
|
|
// Now enable debugging and you should see it
|
|
gLogger.setLevel(Level.DEBUG);
|
|
gLogger.dbg("This is a VISIBLE debug", true);
|
|
|
|
// Make space between unit tests
|
|
writeln();
|
|
}
|
|
|
|
unittest
|
|
{
|
|
GoggaLogger gLogger = new GoggaLogger();
|
|
gLogger.addHandler(new FileHandler(stdout));
|
|
gLogger.setLevel(Level.INFO);
|
|
|
|
gLogger.mode(GoggaMode.TwoKTwenty3);
|
|
|
|
// Test the normal modes
|
|
gLogger.info("This is an info message");
|
|
gLogger.warn("This is a warning message");
|
|
gLogger.error("This is an error message");
|
|
|
|
// We shouldn't see anything as debug is off
|
|
gLogger.dbg("This is a debug which is hidden", 1);
|
|
|
|
// Now enable debugging and you should see it
|
|
gLogger.setLevel(Level.DEBUG);
|
|
gLogger.dbg("This is a VISIBLE debug", true);
|
|
|
|
// Make space between unit tests
|
|
writeln();
|
|
}
|
|
|
|
unittest
|
|
{
|
|
GoggaLogger gLogger = new GoggaLogger();
|
|
gLogger.addHandler(new FileHandler(stdout));
|
|
gLogger.setLevel(Level.INFO);
|
|
|
|
gLogger.mode(GoggaMode.SIMPLE);
|
|
|
|
// Test the normal modes
|
|
gLogger.info("This is an info message");
|
|
gLogger.warn("This is a warning message");
|
|
gLogger.error("This is an error message");
|
|
|
|
// We shouldn't see anything as debug is off
|
|
gLogger.dbg("This is a debug which is hidden", 1);
|
|
|
|
// Now enable debugging and you should see it
|
|
gLogger.setLevel(Level.DEBUG);
|
|
gLogger.dbg("This is a VISIBLE debug", true);
|
|
|
|
// Make space between unit tests
|
|
writeln();
|
|
}
|
|
|
|
unittest
|
|
{
|
|
GoggaLogger gLogger = new GoggaLogger();
|
|
gLogger.addHandler(new FileHandler(stdout));
|
|
gLogger.setLevel(Level.INFO);
|
|
|
|
gLogger.mode(GoggaMode.RUSTACEAN);
|
|
|
|
// Test the normal modes
|
|
gLogger.info("This is an info message");
|
|
gLogger.warn("This is a warning message");
|
|
gLogger.error("This is an error message");
|
|
|
|
// We shouldn't see anything as debug is off
|
|
gLogger.dbg("This is a debug which is hidden", 1);
|
|
|
|
// Now enable debugging and you should see it
|
|
gLogger.setLevel(Level.DEBUG);
|
|
gLogger.dbg("This is a VISIBLE debug", true);
|
|
|
|
// Make space between unit tests
|
|
writeln();
|
|
}
|
|
|
|
unittest
|
|
{
|
|
GoggaLogger gLogger = new GoggaLogger();
|
|
gLogger.addHandler(new FileHandler(stdout));
|
|
gLogger.setLevel(Level.INFO);
|
|
|
|
gLogger.mode(GoggaMode.RUSTACEAN_SIMPLE);
|
|
|
|
// Test the normal modes
|
|
gLogger.info("This is an info message");
|
|
gLogger.warn("This is a warning message");
|
|
gLogger.error("This is an error message");
|
|
|
|
// We shouldn't see anything as debug is off
|
|
gLogger.dbg("This is a debug which is hidden", 1);
|
|
|
|
// Now enable debugging and you should see it
|
|
gLogger.setLevel(Level.DEBUG);
|
|
gLogger.dbg("This is a VISIBLE debug", true);
|
|
|
|
// Make space between unit tests
|
|
writeln();
|
|
} |