diff --git a/CHANGELOG.md b/CHANGELOG.md index 90e1f38..5a6fa25 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # Changelog +## [v0.4.0](https://git.zhirov.kz/dlang/singlog/compare/v0.3.2...v0.4.0) (2023.06.07) + +### New + +- Color output of messages to the terminal and console + +### Bug fixes + +- In Windows, unicode messages are output without distortion to the system log and console (thanks [Adam D. Ruppe](https://arsdnet.net/)) + ## [v0.3.2](https://git.zhirov.kz/dlang/singlog/compare/v0.3.1...v0.3.2) (2023.06.01) - Printing information about the type of the logged message to the standard output stream and file diff --git a/README.md b/README.md index 039b392..ea34a40 100644 --- a/README.md +++ b/README.md @@ -16,25 +16,37 @@ import singlog; void main(string[] argv) { log.output(log.SYSLOG | log.STDOUT | log.FILE) // write to syslog, standard output stream and file - .name(argv[0]) // program name as an identifier (for Windows OS) + .program(argv[0]) // program name as an identifier (for Windows OS) .level(log.DEBUGGING) // logging level + .color(true) // color text output .file("./test.log"); // the path to the log file - log.e("This is an error message"); - log.error("And this is also an error message"); - log.w("This is a warning message"); log.i("This is an information message"); + log.n("This is a notice message"); + log.w("This is a warning message"); + log.e("This is an error message"); + log.c("This is a critical message"); + log.a("This is an alert message"); + log.d("This is a debug message"); } ``` -![output](tests/output.png) +![output](tests/terminal.png) + +![output](tests/cmd.png) ## Examples Setting the name of the logged program (it matters for Windows OS): ```d -log.name("My program"); +log.program("My program"); +``` + +Color output setting (`false` by default): + +```d +log.color(true); ``` Setting the error output level: @@ -77,4 +89,4 @@ log.d("Debugging message") => log.debugging("Debugging message"); ## DUB -Add a dependency on `"singlog": "~>0.3.2"`. +Add a dependency on `"singlog": "~>0.4.0"`. diff --git a/source/singlog.d b/source/singlog.d index 1812870..ace5dd1 100644 --- a/source/singlog.d +++ b/source/singlog.d @@ -2,7 +2,7 @@ module singlog; version(Windows) import core.sys.windows.windows; -else +else version(Posix) import core.sys.posix.syslog; import std.string; @@ -57,28 +57,67 @@ private: this() {} version(Windows) { - int[] _sysLevel = [0, 1, 1, 1, 2, 3, 4]; + int[] _sysPriority = [0, 1, 1, 1, 2, 3, 3]; - WORD[] _sysLevelOS = [ + WORD[] _sysPriorityOS = [ EVENTLOG_SUCCESS, EVENTLOG_ERROR_TYPE, EVENTLOG_WARNING_TYPE, EVENTLOG_INFORMATION_TYPE ]; - void syslog(WORD priority, LPCSTR message) { - HANDLE handleEventLog = RegisterEventSourceA(NULL, this.nameProgram.toStringz()); + void writesyslog(string message, WORD priority) { + import std.utf: toUTF16z; + auto wMessage = message.toUTF16z(); + HANDLE handleEventLog = RegisterEventSourceA(NULL, this._name.toStringz()); if (handleEventLog == NULL) return; - ReportEventA(handleEventLog, priority, 0, 0, NULL, 1, 0, &message, NULL); + ReportEventW(handleEventLog, priority, 0, 0, NULL, 1, 0, &wMessage, NULL); DeregisterEventSource(handleEventLog); } -} else version(Posix) { - int[] _sysLevel = [0, 1, 2, 3, 4, 5, 6]; - int[] _sysLevelOS = [ + WORD[] _color = [ + FOREGROUND_GREEN, + FOREGROUND_BLUE, + FOREGROUND_RED | FOREGROUND_BLUE, + FOREGROUND_RED, + FOREGROUND_RED | FOREGROUND_GREEN, + FOREGROUND_BLUE | FOREGROUND_GREEN, + FOREGROUND_RED | FOREGROUND_BLUE | FOREGROUND_GREEN + ]; + + void colorTextOutput(string time, wstring message, int priority) { + HANDLE handle = GetStdHandle(STD_OUTPUT_HANDLE); + CONSOLE_SCREEN_BUFFER_INFO defaultConsole; + GetConsoleScreenBufferInfo(handle, &defaultConsole); + + writef("%s ", time); + SetConsoleTextAttribute(handle, this._color[priority] | FOREGROUND_INTENSITY); + write(this._type[priority]); + SetConsoleTextAttribute(handle, this._color[priority]); + WriteConsoleW(handle, message.ptr, cast(DWORD)message.length, NULL, NULL); + SetConsoleTextAttribute(handle, defaultConsole.wAttributes); + } + + void defaultTextOutput(string time, wstring message, int priority) { + HANDLE handle = GetStdHandle(STD_OUTPUT_HANDLE); + writef("%s %s", time, this._type[priority]); + WriteConsoleW(handle, message.ptr, cast(DWORD)message.length, NULL, NULL); + } + + void writestdout(string time, string message, int priority) { + wstring wMessage = " %s\n".format(message).to!wstring; + this._ccolor ? + colorTextOutput(time, wMessage, priority) : + defaultTextOutput(time, wMessage, priority); + } + +} else version(Posix) { + int[] _sysPriority = [0, 1, 2, 3, 4, 5, 6]; + + int[] _sysPriorityOS = [ LOG_DEBUG, LOG_ALERT, LOG_CRIT, @@ -98,14 +137,16 @@ version(Windows) { "\x1b[1;97m%s\x1b[0;97m %s\x1b[0;0m", // white ]; - void writestdout(string time, string message, int level) { - writeln( - "%s %s".format( + void writestdout(string time, string message, int priority) { + writefln("%s %s", time, - (this._ccolor ? this._color[level] : "%s %s").format(this._type[level], message) - ) + (this._ccolor ? this._color[priority] : "%s %s").format(this._type[priority], message) ); } + + void writesyslog(string message, int priority) { + syslog(priority, message.toStringz()); + } } public enum { @@ -135,23 +176,23 @@ version(Windows) { } int _output = STDOUT; - int _level = INFORMATION; + int _priority = INFORMATION; - void writeLog(string message, int level) { + void writelog(string message, int priority) { string time; - if (this._level > level) + if (this._priority > priority) return; if (this._output & 1) - syslog(_sysLevelOS[_sysLevel[level]], message.toStringz()); + writesyslog(message, _sysPriorityOS[_sysPriority[priority]]); if (this._output & 6) time = Clock.currTime().format("%Y.%m.%d %H:%M:%S"); if (this._output & 2) - writestdout(time, message, level); + writestdout(time, message, priority); if (this._output & 4) - writeFile(time, message, level); + writefile(time, message, priority); } - void writeFile(string time, string message, int level) { + void writefile(string time, string message, int priority) { if (!this._writeToFile) return; @@ -173,7 +214,7 @@ version(Windows) { } try { - file.writeln("%s %s %s".format(time, this._type[level], message)); + file.writefln("%s %s %s", time, this._type[priority], message); } catch (Exception e) { this._writeToFile = false; this.error("Unable to write to the log file " ~ this._path); @@ -202,16 +243,16 @@ public: Log output(int outs) { this._output = outs; return this._log; } Log program(string name) { this._name = name; return this._log; } Log file(string path) { this._path = path; return this._log; } - Log level(int lvl) { this._level = lvl; return this._log; } + Log level(int priority) { this._priority = priority; return this._log; } Log color(bool condition) { this._ccolor = condition; return this._log; } - void alert(T)(T message) { writeLog(message.to!string, ALERT); } - void critical(T)(T message) { writeLog(message.to!string, CRITICAL); } - void error(T)(T message) { writeLog(message.to!string, ERROR); } - void warning(T)(T message) { writeLog(message.to!string, WARNING); } - void notice(T)(T message) { writeLog(message.to!string, NOTICE); } - void information(T)(T message) { writeLog(message.to!string, INFORMATION); } - void debugging(T)(T message) { writeLog(message.to!string, DEBUGGING); } + void alert(T)(T message) { writelog(message.to!string, ALERT); } + void critical(T)(T message) { writelog(message.to!string, CRITICAL); } + void error(T)(T message) { writelog(message.to!string, ERROR); } + void warning(T)(T message) { writelog(message.to!string, WARNING); } + void notice(T)(T message) { writelog(message.to!string, NOTICE); } + void information(T)(T message) { writelog(message.to!string, INFORMATION); } + void debugging(T)(T message) { writelog(message.to!string, DEBUGGING); } alias a = alert; alias c = critical; diff --git a/tests/cmd.png b/tests/cmd.png new file mode 100644 index 0000000..d15e7e6 Binary files /dev/null and b/tests/cmd.png differ diff --git a/tests/output.png b/tests/output.png deleted file mode 100644 index 7d024e3..0000000 Binary files a/tests/output.png and /dev/null differ diff --git a/tests/terminal.png b/tests/terminal.png new file mode 100644 index 0000000..cc0777b Binary files /dev/null and b/tests/terminal.png differ