Merge pull request #84 from thewilsonator/log-destructor

Remove GC allocation from coloration of log messages
blachlylab · Jul 28, 2021 · 3f34c1b · 3f34c1b
2 parents 6c9f803 + dbf3d5c
commit 3f34c1b
Show file tree

Hide file tree

Showing 2 changed files with 31 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -108,7 +108,7 @@ It's easy to get a segfault by using the direct C API incorrectly. Or possibly c
 
 # Bugs and Warnings
 
-Do not call `hts_log_*` from a destructor, as it is potentialy allocating via `toStringz`
+Do not call `hts_log_*` with `ctx` as anything other than a string literal from a destructor, as it is potentialy allocating via `toStringz`
 
 
 # Programs made with dhtslib

diff --git a/source/htslib/hts_log.d b/source/htslib/hts_log.d
@@ -76,39 +76,59 @@ pragma(inline, true):
 //#define hts_log_error(...) hts_log(HTS_LOG_ERROR, __func__, __VA_ARGS__)
 void hts_log_error(const(char)[] ctx, string msg)
 {
-    string colormsg = "\x1b[0;31m" ~ msg ~ "\x1b[0m";
-    hts_log(htsLogLevel.HTS_LOG_ERROR, toStringz(ctx), toStringz(colormsg));
+    string open_error_color = "\x1b[0;31m";
+    string close_color      = "\x1b[0m";
+    hts_log(htsLogLevel.HTS_LOG_ERROR, toStringz(ctx), "%*.s%*.s%*.s",
+            cast(int)open_error_color.length, open_error_color.ptr,
+            cast(int)msg.length, msg.ptr,
+            cast(int)close_color.length, close_color.ptr);
 }
 /**! Logs an event with severity HTS_LOG_WARNING and default context. Parameters: format, ... */
 //#define hts_log_warning(...) hts_log(HTS_LOG_WARNING, __func__, __VA_ARGS__)
 void hts_log_warning(const(char)[] ctx, string msg)
 {
-    string colormsg = "\x1b[0;33m" ~ msg ~ "\x1b[0m";
-    hts_log(htsLogLevel.HTS_LOG_WARNING, toStringz(ctx), toStringz(colormsg));
+    string open_warning_color = "\x1b[0;33m";
+    string close_color        = "\x1b[0m";
+    hts_log(htsLogLevel.HTS_LOG_WARNING, toStringz(ctx), "%*.s%*.s%*.s",
+            cast(int)open_warning_color.length, open_warning_color.ptr,
+            cast(int)msg.length, msg.ptr,
+            cast(int)close_color.length, close_color.ptr);
 }
 
 /**! Logs an event with severity HTS_LOG_INFO and default context. Parameters: format, ... */
 //#define hts_log_info(...) hts_log(HTS_LOG_INFO, __func__, __VA_ARGS__)
 void hts_log_info(const(char)[] ctx, string msg)
 {
-    string colormsg = "\x1b[0;32m" ~ msg ~ "\x1b[0m";
-    hts_log(htsLogLevel.HTS_LOG_INFO, toStringz(ctx), toStringz(colormsg));
+    string open_info_color = "\x1b[0;32m";
+    string close_color     = "\x1b[0m";
+    hts_log(htsLogLevel.HTS_LOG_INFO, toStringz(ctx), "%*.s%*.s%*.s",
+            cast(int)open_info_color.length, open_info_color.ptr,
+            cast(int)msg.length, msg.ptr,
+            cast(int)close_color.length, close_color.ptr);
 }
 
 /**! Logs an event with severity HTS_LOG_DEBUG and default context. Parameters: format, ... */
 //#define hts_log_debug(...) hts_log(HTS_LOG_DEBUG, __func__, __VA_ARGS__)
 void hts_log_debug(const(char)[] ctx, string msg)
 {
-    string colormsg = "\x1b[0;36m" ~ msg ~ "\x1b[0m";
-    hts_log(htsLogLevel.HTS_LOG_DEBUG, toStringz(ctx), toStringz(colormsg));
+    string open_debug_color = "\x1b[0;36m";
+    string close_color     = "\x1b[0m";
+    hts_log(htsLogLevel.HTS_LOG_DEBUG, toStringz(ctx), "%*.s%*.s%*.s",
+            cast(int)open_debug_color.length, open_debug_color.ptr,
+            cast(int)msg.length, msg.ptr,
+            cast(int)close_color.length, close_color.ptr);
 }
 
 /**! Logs an event with severity HTS_LOG_TRACE and default context. Parameters: format, ... */
 //#define hts_log_trace(...) hts_log(HTS_LOG_TRACE, __func__, __VA_ARGS__)
 void hts_log_trace(const(char)[] ctx, string msg)
 {
-    string colormsg = "\x1b[1;36m" ~ msg ~ "\x1b[0m";
-    hts_log(htsLogLevel.HTS_LOG_TRACE, toStringz(ctx), toStringz(colormsg));
+    string open_trace_color = "\x1b[1;36m";
+    string close_color     = "\x1b[0m";
+    hts_log(htsLogLevel.HTS_LOG_TRACE, toStringz(ctx), "%*.s%*.s%*.s",
+            cast(int)open_trace_color.length, open_trace_color.ptr,
+            cast(int)msg.length, msg.ptr,
+            cast(int)close_color.length, close_color.ptr);
 }
 
 ///