clutchlog  0.11.1
clutchlog.h
Go to the documentation of this file.
1 #pragma once
2 #ifndef CLUTCHLOG_H
3 #define CLUTCHLOG_H
5 
7 #include <ciso646>
8  #ifdef FSEXPERIMENTAL
9  #include <experimental/filesystem>
10  namespace fs = std::experimental::filesystem;
11 #else
12  #include <filesystem>
13  namespace fs = std::filesystem;
14 #endif
15 
16 #include <iostream>
17 #include <sstream>
18 #include <fstream>
19 #include <cassert>
20 #include <cstdlib>
21 #include <string>
22 #include <limits>
23 #include <regex>
24 #include <map>
25 
27 #if __has_include(<execinfo.h>) && __has_include(<stdlib.h>) && __has_include(<libgen.h>)
28  #include <execinfo.h> // execinfo
29  #include <stdlib.h> // getenv
30  #include <libgen.h> // basename
31  #define CLUTCHLOG_HAVE_UNIX_SYSINFO 1
32 #else
33  #define CLUTCHLOG_HAVE_UNIX_SYSINFO 0
34 #endif
35 
37 #if __has_include(<sys/ioctl.h>) && __has_include(<stdio.h>) && __has_include(<unistd.h>)
38  #include <sys/ioctl.h>
39  #include <stdio.h>
40  #include <unistd.h>
41  #define CLUTCHLOG_HAVE_UNIX_SYSIOCTL 1
42 #else
43  #define CLUTCHLOG_HAVE_UNIX_SYSIOCTL 0
44 #endif
45 
46 
47 /**********************************************************************
48  * Enable by default in Debug builds.
49  **********************************************************************/
50 #ifndef WITH_CLUTCHLOG
51  #ifndef NDEBUG
52  #define WITH_CLUTCHLOG
54  #endif
55 #endif
56 
57 /**********************************************************************
58  * Macros definitions
59  **********************************************************************/
60 #ifdef WITH_CLUTCHLOG
61 
65 #ifndef CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG
66  #define CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG clutchlog::level::progress
68 #endif // CLUTCHLOG_DEFAULT_DEPTH_BUILT
69 
76 #define CLUTCHLOC __FILE__, __FUNCTION__, __LINE__
78 
80 #ifndef NDEBUG
81  #define CLUTCHLOG( LEVEL, WHAT ) do { \
82  auto& clutchlog__logger = clutchlog::logger(); \
83  std::ostringstream clutchlog__msg ; clutchlog__msg << WHAT; \
84  clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), CLUTCHLOC); \
85  } while(0)
86 #else // not Debug build.
87  #define CLUTCHLOG( LEVEL, WHAT ) do { \
88  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
89  auto& clutchlog__logger = clutchlog::logger(); \
90  std::ostringstream clutchlog__msg ; clutchlog__msg << WHAT; \
91  clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), CLUTCHLOC); \
92  } \
93  } while(0)
94 #endif // NDEBUG
95 
97 #ifndef NDEBUG
98  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do { \
99  auto& clutchlog__logger = clutchlog::logger(); \
100  clutchlog__logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \
101  CLUTCHLOC, FILENAME, CLUTCHDUMP_DEFAULT_SEP); \
102  } while(0)
103 #else // not Debug build.
104  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do { \
105  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
106  auto& clutchlog__logger = clutchlog::logger(); \
107  clutchlog__logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \
108  CLUTCHLOC, FILENAME, CLUTCHDUMP_DEFAULT_SEP); \
109  } \
110  } while(0)
111 #endif // NDEBUG
112 
114 #ifndef NDEBUG
115  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do { \
116  auto& clutchlog__logger = clutchlog::logger(); \
117  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
118  if(clutchlog__scope.matches) { \
119  FUNC(__VA_ARGS__); \
120  } \
121  } while(0)
122 #else // not Debug build.
123  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do { \
124  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
125  auto& clutchlog__logger = clutchlog::logger(); \
126  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
127  if(clutchlog__scope.matches) { \
128  FUNC(__VA_ARGS__); \
129  } \
130  } \
131  } while(0)
132 #endif // NDEBUG
133 
135 #ifndef NDEBUG
136  #define CLUTCHCODE( LEVEL, ... ) do { \
137  auto& clutchlog__logger = clutchlog::logger(); \
138  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
139  if(clutchlog__scope.matches) { \
140  __VA_ARGS__ \
141  } \
142  } while(0)
143 #else // not Debug build.
144  #define CLUTCHCODE( LEVEL, CODE ) do { \
145  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
146  auto& clutchlog__logger = clutchlog::logger(); \
147  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
148  if(clutchlog__scope.matches) { \
149  CODE \
150  } \
151  } \
152  } while(0)
153 #endif // NDEBUG
154 
157 #else // not WITH_CLUTCHLOG
158  // Disabled macros can still be called in Release builds.
159  #define CLUTCHLOG( LEVEL, WHAT ) do {/*nothing*/} while(0)
160  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do {/*nothing*/} while(0)
161  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do {/*nothing*/} while(0)
162  #define CLUTCHCODE( LEVEL, CODE ) do {/*nothing*/} while(0)
163 #endif // WITH_CLUTCHLOG
164 
165 /**********************************************************************
166  * Implementation
167  **********************************************************************/
168 
169 #ifdef WITH_CLUTCHLOG
170 
177 class clutchlog
178 {
179  protected:
180 
185  #ifndef NDEBUG
186  #ifndef CLUTCHLOG_DEFAULT_FORMAT
187  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1 // Enables: name, depth and depth_marks
189  #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1 // Enables: hfill
190  #define CLUTCHLOG_DEFAULT_FORMAT "[{name}] {level_letter}:{depth_marks} {msg} {hfill} {func} @ {file}:{line}\n"
191  #else
192  #define CLUTCHLOG_DEFAULT_FORMAT "[{name}] {level_letter}:{depth_marks} {msg}\t\t\t\t\t{func} @ {file}:{line}\n"
193  #endif
194  #else
195  #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1
196  #define CLUTCHLOG_DEFAULT_FORMAT "{level_letter} {msg} {hfill} {func} @ {file}:{line}\n"
197  #else
198  #define CLUTCHLOG_DEFAULT_FORMAT "{level_letter} {msg}\t\t\t\t\t{func} @ {file}:{line}\n"
199  #endif
200  #endif
201  #endif
202  #else
203  #ifndef CLUTCHLOG_DEFAULT_FORMAT
204  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
206  #define CLUTCHLOG_DEFAULT_FORMAT "[{name}] {level_letter}:{depth_marks} {msg} {hfill} {func}\n"
207  #else
208  #define CLUTCHLOG_DEFAULT_FORMAT "{level_letter} {msg}\t\t\t\t\t{func}\n"
209  #endif
210  #endif
211  #endif
212  static inline std::string default_format = CLUTCHLOG_DEFAULT_FORMAT;
214 
215  #ifndef NDEBUG
216  #ifndef CLUTCHDUMP_DEFAULT_FORMAT
217  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
219  #define CLUTCHDUMP_DEFAULT_FORMAT "# [{name}] {level} in {func} (at depth {depth}) @ {file}:{line}"
220  #else
221  #define CLUTCHDUMP_DEFAULT_FORMAT "# {level} in {func} @ {file}:{line}"
222  #endif
223  #endif // CLUTCHDUMP_DEFAULT_FORMAT
224  #else
225  #ifndef CLUTCHDUMP_DEFAULT_FORMAT
226  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
228  #define CLUTCHDUMP_DEFAULT_FORMAT "# [{name}] {level} in {func} (at depth {depth})"
229  #else
230  #define CLUTCHDUMP_DEFAULT_FORMAT "# {level} in {func}"
231  #endif
232  #endif // CLUTCHDUMP_DEFAULT_FORMAT
233  #endif
234  static inline std::string dump_default_format = CLUTCHDUMP_DEFAULT_FORMAT;
236 
237  #ifndef CLUTCHDUMP_DEFAULT_SEP
238  #define CLUTCHDUMP_DEFAULT_SEP "\n"
240  #endif // CLUTCHDUMP_DEFAULT_SEP
241  static inline std::string dump_default_sep = CLUTCHDUMP_DEFAULT_SEP;
243 
244  #ifndef CLUTCHLOG_DEFAULT_DEPTH_MARK
245  #define CLUTCHLOG_DEFAULT_DEPTH_MARK ">"
247  #endif // CLUTCHLOG_DEFAULT_DEPTH_MARK
248  static inline std::string default_depth_mark = CLUTCHLOG_DEFAULT_DEPTH_MARK;
250 
251  #ifndef CLUTCHLOG_STRIP_CALLS
252  #define CLUTCHLOG_STRIP_CALLS 5
254  #endif // CLUTCHLOG_STRIP_CALLS
255  static inline unsigned int default_strip_calls = CLUTCHLOG_STRIP_CALLS;
257 
258  #ifndef CLUTCHLOG_HFILL_MARK
259  #define CLUTCHLOG_HFILL_MARK '.'
261  #endif // CLUTCHLOG_HFILL_MARK
262  static inline char default_hfill_char = CLUTCHLOG_HFILL_MARK;
264 
265 
266  #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1
267  #ifndef CLUTCHLOG_HFILL_MAX
268  #define CLUTCHLOG_HFILL_MAX 300
269  #endif
270  #endif
271  static inline size_t default_hfill_max = CLUTCHLOG_HFILL_MAX;
273 
274  // NOTE: there is no CLUTCHLOG_HFILL_STYLE for defaulting,
275  // but you can still set `hfill_style(...)` on the logger singleton.
276  /* @} DefaultConfig */
277  /* @} */
278 
279 
280  public:
281 
291  static clutchlog& logger()
292  {
293  static clutchlog instance;
294  return instance;
295  }
296 
298  enum level {critical=0, error=1, warning=2, progress=3, note=4, info=5, debug=6, xdebug=7};
299 
309  class fmt {
310  public:
312  enum class fg {
313  black = 30,
314  red = 31,
315  green = 32,
316  yellow = 33,
317  blue = 34,
318  magenta = 35,
319  cyan = 36,
320  white = 37,
321  none
322  } fore;
323 
325  enum class bg {
326  black = 40,
327  red = 41,
328  green = 42,
329  yellow = 43,
330  blue = 44,
331  magenta = 45,
332  cyan = 46,
333  white = 47,
334  none
335  } back;
336 
338  enum class typo {
339  reset = 0,
340  bold = 1,
341  underline = 4,
342  inverse = 7,
343  none
344  } style;
345 
347  fmt() : fore(fg::none), back(bg::none), style(typo::none) {}
348 
351  fmt( fg f, bg b = bg::none, typo s = typo::none) : fore(f), back(b), style(s) {}
352  fmt( fg f, typo s , bg b = bg::none) : fore(f), back(b), style(s) {}
353  fmt( bg b, fg f = fg::none, typo s = typo::none) : fore(f), back(b), style(s) {}
354  fmt( bg b, typo s , fg f = fg::none) : fore(f), back(b), style(s) {}
355  fmt(typo s, fg f = fg::none, bg b = bg::none) : fore(f), back(b), style(s) {}
356  fmt(typo s, bg b , fg f = fg::none) : fore(f), back(b), style(s) {}
359  protected:
361  std::ostream& print_on( std::ostream& os) const
362  {
363  std::vector<int> codes; codes.reserve(3);
364  if(this->fore != fg::none) { codes.push_back(static_cast<int>(this->fore ));}
365  if(this->back != bg::none) { codes.push_back(static_cast<int>(this->back ));}
366  if(this->style != typo::none) { codes.push_back(static_cast<int>(this->style));}
367  if(codes.size() == 0) {return os;}
368 
369  os << "\033[";
370  assert(codes.size() > 0);
371  os << codes[0];
372  for(size_t i=1; i < codes.size(); ++i) {
373  os << ";" << codes[i];
374  }
375  os << "m";
376  return os;
377  }
378 
379  public:
391  friend std::ostream& operator<<(std::ostream& os, const fmt& fmt)
392  {
393  return fmt.print_on(os);
394  }
395 
406  std::string operator()( const std::string& msg ) const
407  {
408  std::ostringstream os;
409  this->print_on(os);
410  fmt reset(fmt::typo::reset);
411  os << msg;
412  reset.print_on(os);
413  return os.str();
414  }
415 
418  std::string str() const
419  {
420  std::ostringstream os;
421  this->print_on(os);
422  return os.str();
423  }
424  }; // fmt class
425 
431  public:
432  clutchlog(clutchlog const&) = delete;
433  void operator=(clutchlog const&) = delete;
434 
435  private:
436  clutchlog() :
437  // system, main, log
438  _strip_calls(clutchlog::default_strip_calls),
439  _level_word({
440  {level::critical,"Critical"},
441  {level::error ,"Error"},
442  {level::warning ,"Warning"},
443  {level::progress,"Progress"},
444  {level::note ,"Note"},
445  {level::info ,"Info"},
446  {level::debug ,"Debug"},
447  {level::xdebug ,"XDebug"}
448  }),
449  _level_fmt({
450  {level::critical,fmt(fmt::fg::red, fmt::typo::underline)},
451  {level::error ,fmt(fmt::fg::red, fmt::typo::bold)},
452  {level::warning ,fmt(fmt::fg::magenta, fmt::typo::bold)},
453  {level::progress,fmt()},
454  {level::note ,fmt()},
455  {level::info ,fmt()},
456  {level::debug ,fmt()},
457  {level::xdebug ,fmt()}
458  }),
459  _format_log(clutchlog::default_format),
460  _format_dump(clutchlog::dump_default_format),
461  #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
462  _hfill_char(clutchlog::default_hfill_char),
463  _hfill_fmt(fmt::fg::none),
464  _hfill_max(clutchlog::default_hfill_max),
465  #endif
466  _out(&std::clog),
467  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
468  _depth(std::numeric_limits<size_t>::max() - _strip_calls),
469  _depth_mark(clutchlog::default_depth_mark),
470  #endif
471  _stage(level::error),
472  _in_file(".*"),
473  _in_func(".*"),
474  _in_line(".*")
475  {
476  // Reverse the level->word map into a word->level map.
477  for(auto& lw : _level_word) {
478  _word_level[lw.second] = lw.first;
479  }
480 #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
481  struct winsize w;
482  ioctl(STDERR_FILENO, TIOCGWINSZ, &w);
483  _nb_columns = std::min((size_t)w.ws_col, default_hfill_max);
484 #endif
485  }
486 
487  protected:
489  size_t _strip_calls;
491  const std::map<level,std::string> _level_word;
493  std::map<std::string,level> _word_level;
495  std::map<level,fmt> _level_fmt;
497  std::string _format_log;
499  std::string _format_dump;
500  #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
501 
502  char _hfill_char;
504  fmt _hfill_fmt;
506  size_t _hfill_max;
507  #endif
508 
509  std::ostream* _out;
510  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
511 
512  size_t _depth;
514  std::string _depth_mark;
515  #endif
516 
517  level _stage;
519  std::regex _in_file;
521  std::regex _in_func;
523  std::regex _in_line;
524 
525 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
526 
527  static const size_t _max_buffer = 4096;
528 #endif
529 
530 #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
531 
532  size_t _nb_columns;
533 #endif
534 
536  public:
537 
541  void format(const std::string& format) {_format_log = format;}
544  std::string format() const {return _format_log;}
545 
547  void format_comment(const std::string& format) {_format_dump = format;}
549  std::string format_comment() const {return _format_dump;}
550 
552  void out(std::ostream& out) {_out = &out;}
554  std::ostream& out() {return *_out;}
555 
556 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
557  void depth(size_t d) {_depth = d;}
560  size_t depth() const {return _depth;}
561 
563  void depth_mark(const std::string mark) {_depth_mark = mark;}
565  std::string depth_mark() const {return _depth_mark;}
566 
568  void strip_calls(const size_t n) {_strip_calls = n;}
570  size_t strip_calls() const {return _strip_calls;}
571 #endif
572 #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1
573  void hfill_mark(const char mark) {_hfill_char = mark;}
576  char hfill_mark() const {return _hfill_char;}
578  void hfill_style(fmt style) {_hfill_fmt = style;}
583  template<class ... FMT>
584  void hfill_style(FMT... styles) { this->hfill_style(fmt(styles...)); }
586  fmt hfill_style() const {return _hfill_fmt;}
588  void hfill_max(const size_t nmax) {_hfill_max = nmax;}
590  size_t hfill_max() {return _hfill_max;}
591 #endif
592 
594  void threshold(level l) {_stage = l;}
596  void threshold(const std::string& l) {_stage = this->level_of(l);}
598  level threshold() const {return _stage;}
600  const std::map<std::string,level>& levels() const { return _word_level;}
601 
606  level level_of(const std::string name)
607  {
608  const auto ilevel = _word_level.find(name);
609  if( ilevel != std::end(_word_level)) {
610  return ilevel->second;
611  } else {
612  throw std::out_of_range("'" + name + "' is not a valid log level name");
613  }
614  }
615 
617  void file(std::string file) {_in_file = file;}
619  void func(std::string func) {_in_func = func;}
621  void line(std::string line) {_in_line = line;}
622 
624  void location(
625  const std::string& in_file,
626  const std::string& in_function=".*",
627  const std::string& in_line=".*"
628  )
629  {
630  file(in_file);
631  func(in_function);
632  line(in_line);
633  }
634 
639  template<class ... FMT>
640  void style(level stage, FMT... styles) { this->style(stage,fmt(styles...)); }
642  void style(level stage, fmt style) { _level_fmt.at(stage) = style; }
644  fmt style(level stage) const { return _level_fmt.at(stage); }
645 
648  public:
649 
653  struct scope_t {
656  bool matches;
658  level stage;
659 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
660 
661  size_t depth;
662 #endif
663 
664  bool there;
666  scope_t() :
667  matches(false),
668  stage(level::xdebug),
669 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
670  depth(0),
671 #endif
672  there(false)
673  {}
674  }; // scope_t
675 
676 
678  scope_t locate(
679  const level& stage,
680  const std::string& file,
681  const std::string& func,
682  const size_t line
683  ) const
684  {
685  scope_t scope; // False scope by default.
686 
687  /***** Log level stage *****/
688  // Test stage first, because it's fastest.
689  scope.stage = stage;
690  if(not (scope.stage <= _stage)) {
691  // Bypass useless computations if no match
692  // because of the stage.
693  return scope;
694  }
695 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
696  /***** Stack depth *****/
697  // Backtrace in second, quite fast.
698  size_t stack_depth;
699  void *buffer[_max_buffer];
700  stack_depth = backtrace(buffer, _max_buffer);
701  scope.depth = stack_depth;
702  if(not (scope.depth <= _depth + _strip_calls)) {
703  // Bypass if no match.
704  return scope;
705  }
706 #endif
707 
708  /***** Location *****/
709  // Location last, slowest.
710  std::ostringstream sline; sline << line;
711  scope.there =
712  std::regex_search(file, _in_file)
713  and std::regex_search(func, _in_func)
714  and std::regex_search(sline.str(), _in_line);
715 
716  // No need to retest stage and depth, which are true here.
717  scope.matches = scope.there;
718 
719  return scope;
720  } // locate
721 
729  std::string replace(
730  const std::string& form,
731  const std::string& mark,
732  const std::string& tag
733  ) const
734  {
735  // Useless debug code, unless something fancy would be done with name tags.
736  // std::regex re;
737  // try {
738  // re = std::regex(mark);
739  //
740  // } catch(const std::regex_error& e) {
741  // std::cerr << "ERROR with a regular expression \"" << mark << "\": ";
742  // switch(e.code()) {
743  // case std::regex_constants::error_collate:
744  // std::cerr << "the expression contains an invalid collating element name";
745  // break;
746  // case std::regex_constants::error_ctype:
747  // std::cerr << "the expression contains an invalid character class name";
748  // break;
749  // case std::regex_constants::error_escape:
750  // std::cerr << "the expression contains an invalid escaped character or a trailing escape";
751  // break;
752  // case std::regex_constants::error_backref:
753  // std::cerr << "the expression contains an invalid back reference";
754  // break;
755  // case std::regex_constants::error_brack:
756  // std::cerr << "the expression contains mismatched square brackets ('[' and ']')";
757  // break;
758  // case std::regex_constants::error_paren:
759  // std::cerr << "the expression contains mismatched parentheses ('(' and ')')";
760  // break;
761  // case std::regex_constants::error_brace:
762  // std::cerr << "the expression contains mismatched curly braces ('{' and '}')";
763  // break;
764  // case std::regex_constants::error_badbrace:
765  // std::cerr << "the expression contains an invalid range in a {} expression";
766  // break;
767  // case std::regex_constants::error_range:
768  // std::cerr << "the expression contains an invalid character range (e.g. [b-a])";
769  // break;
770  // case std::regex_constants::error_space:
771  // std::cerr << "there was not enough memory to convert the expression into a finite state machine";
772  // break;
773  // case std::regex_constants::error_badrepeat:
774  // std::cerr << "one of *?+{ was not preceded by a valid regular expression";
775  // break;
776  // case std::regex_constants::error_complexity:
777  // std::cerr << "the complexity of an attempted match exceeded a predefined level";
778  // break;
779  // case std::regex_constants::error_stack:
780  // std::cerr << "there was not enough memory to perform a match";
781  // break;
782  // default:
783  // std::cerr << "unknown error";
784  // }
785  // std::cerr << std::endl;
786  // throw;
787  // } // catch
788 
789  const std::regex re(mark);
790  return std::regex_replace(form, re, tag);
791  }
792 
794  std::string replace(
795  const std::string& form,
796  const std::string& mark,
797  const size_t tag
798  ) const
799  {
800  std::ostringstream stag; stag << tag;
801  return replace(form, mark, stag.str());
802  }
803 
805  std::string format(
806  std::string row,
807  const std::string& what,
808 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
809  const std::string& name,
810 #endif
811  const level& stage,
812  const std::string& file,
813  const std::string& func,
814  const size_t line
815 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
816  ,
817  const size_t depth
818 #endif
819  ) const
820  {
821  row = replace(row, "\\{msg\\}", what);
822  row = replace(row, "\\{file\\}", file);
823  row = replace(row, "\\{func\\}", func);
824  row = replace(row, "\\{line\\}", line);
825 
826  row = replace(row, "\\{level\\}", _level_word.at(stage));
827  std::string letter(1, _level_word.at(stage).at(0)); // char -> string
828  row = replace(row, "\\{level_letter\\}", letter);
829 
830 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
831  row = replace(row, "\\{name\\}", name);
832  row = replace(row, "\\{depth\\}", depth - _strip_calls);
833 
834  std::ostringstream chevrons;
835  for(size_t i = _strip_calls; i < depth; ++i) {
836  chevrons << _depth_mark;
837  }
838  row = replace(row, "\\{depth_marks\\}", chevrons.str());
839 #endif
840 
841  row = replace(row, "\\{level_fmt\\}", _level_fmt.at(stage).str());
842 
843 #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
844  // hfill is replaced last to allow for correct line width estimation.
845  const std::string raw_row = replace(row, "\\x1B\\[([0-9]{1,2}(;[0-9]{1,2})?)?[m|K]", "");
846  const std::string hfill_tag = "{hfill}";
847  const size_t hfill_pos = row.find(hfill_tag);
848  const size_t raw_hfill_pos = raw_row.find(hfill_tag);
849  const size_t nb_columns = std::min(_nb_columns, _hfill_max);
850  if(hfill_pos != std::string::npos) {
851  assert(raw_hfill_pos != std::string::npos);
852  if(nb_columns > 0) {
853  const size_t left_len = raw_hfill_pos;
854  const size_t right_len = raw_row.size() - raw_hfill_pos - hfill_tag.size();
855  if(right_len+left_len > nb_columns) {
856  // The right part would go over the terminal width: add a new row.
857  if(right_len < nb_columns) {
858  // There is room for the right part on a new line.
859  const std::string hfill(std::max((size_t)0, nb_columns-right_len), _hfill_char);
860  const std::string hfill_styled = _hfill_fmt(hfill);
861  row = replace(row, "\\{hfill\\}", "\n"+hfill_styled);
862  } else {
863  // Right part still goes over columns: let it go.
864  const std::string hfill(1, _hfill_char);
865  const std::string hfill_styled = _hfill_fmt(hfill);
866  row = replace(row, "\\{hfill\\}", "\n"+hfill_styled);
867  }
868  } else {
869  // There is some space in between left and right parts.
870  const std::string hfill(std::max((size_t)0, nb_columns - (right_len+left_len)), _hfill_char);
871  const std::string hfill_styled = _hfill_fmt(hfill);
872  row = replace(row, "\\{hfill\\}", hfill_styled);
873  }
874  } else {
875  // We don't know the terminal width.
876  const std::string hfill(1, _hfill_char);
877  const std::string hfill_styled = _hfill_fmt(hfill);
878  row = replace(row, "\\{hfill\\}", hfill_styled);
879  }
880  }
881 #else
882  // We cannot know the terminal width.
883  const std::string hfill(1, _hfill_char);
884  const std::string hfill_styled = _hfill_fmt(hfill);
885  row = replace(row, "\\{hfill\\}", hfill_styled);
886 #endif
887  return _level_fmt.at(stage)(row);
888  }
889 
891  void log(
892  const level& stage,
893  const std::string& what,
894  const std::string& file, const std::string& func, size_t line
895  ) const
896  {
897  scope_t scope = locate(stage, file, func, line);
898 
899  if(scope.matches) {
900 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
901  *_out << format(_format_log, what, basename(getenv("_")),
902  stage, file, func,
903  line, scope.depth );
904 #else
905  *_out << format(_format_log, what,
906  stage, file, func,
907  line );
908 
909 #endif
910  _out->flush();
911  } // if scopes.matches
912  }
913 
915  template<class In>
916  void dump(
917  const level& stage,
918  const In container_begin, const In container_end,
919  const std::string& file, const std::string& func, size_t line,
920  const std::string& filename_template = "dump_{n}.dat",
921  const std::string sep = dump_default_sep
922  ) const
923  {
924  scope_t scope = locate(stage, file, func, line);
925 
926  if(scope.matches) {
927  const std::string tag = "\\{n\\}";
928  const std::regex re(tag);
929  std::string outfile = "";
930 
931  // If the file name template has the {n} tag.
932  if(std::regex_search(filename_template, re)) {
933  // Increment n until a free one is found.
934  size_t n = 0;
935  do {
936  outfile = replace(filename_template, tag, n);
937  n++;
938  } while( fs::exists( outfile ) );
939 
940  } else {
941  // Use the parameter as is.
942  outfile = filename_template;
943  }
944 
945  std::ofstream fd(outfile);
946 
947  if(_format_dump.size() > 0) {
948 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
949  fd << format(_format_dump, "", basename(getenv("_")),
950  stage, file, func,
951  line, scope.depth );
952 #else
953  fd << format(_format_dump, "",
954  stage, file, func,
955  line );
956 #endif
957  fd << sep; // sep after comment line.
958  }
959 
960  std::copy(container_begin, container_end,
961  std::ostream_iterator<typename In::value_type>(fd, sep.c_str()));
962 
963  fd.close();
964  } // if scopes.matches
965  }
966 
968 };
969 
972 #else // not WITH_CLUTCHLOG
973 
974 
975 /**********************************************************************
976  * Fake implementation
977  **********************************************************************/
978 
979 // Equivalent class with empty methods, will be optimized out
980 // while allowing to actually have calls implemented without WITH_CLUTCHLOG guards.
981 #pragma GCC diagnostic push
982 #pragma GCC diagnostic ignored "-Wreturn-type"
983 class clutchlog
984 {
985  public:
986  static clutchlog& logger() {}
987  enum level {critical=0, error=1, warning=2, progress=3, note=4, info=5, debug=6, xdebug=7};
988  class fmt {
989  public:
990  enum class fg { black, red, green, yellow, blue, magenta, cyan, white, none } fore;
991  enum class bg { black, red, green, yellow, blue, magenta, cyan, white, none } back;
992  enum class typo { reset, bold, underline, inverse, none } style;
993  fmt() : fore(fg::none), back(bg::none), style(typo::none) {}
994  fmt( fg f, bg b = bg::none, typo s = typo::none) : fore(f), back(b), style(s) {}
995  fmt( fg f, typo s , bg b = bg::none) : fore(f), back(b), style(s) {}
996  fmt( bg b, fg f = fg::none, typo s = typo::none) : fore(f), back(b), style(s) {}
997  fmt( bg b, typo s , fg f = fg::none) : fore(f), back(b), style(s) {}
998  fmt(typo s, fg f = fg::none, bg b = bg::none) : fore(f), back(b), style(s) {}
999  fmt(typo s, bg b , fg f = fg::none) : fore(f), back(b), style(s) {}
1000  protected:
1001  std::ostream& print_on(std::ostream&) const {}
1002  public:
1003  friend std::ostream& operator<<(std::ostream&, const fmt&) {}
1004  std::string operator()(const std::string&) const {}
1005  };
1006  public:
1007  clutchlog(clutchlog const&) = delete;
1008  void operator=(clutchlog const&) = delete;
1009  private:
1010  clutchlog() {}
1011  protected:
1012  struct scope_t {};
1013  scope_t locate(
1014  const level&,
1015  const std::string&,
1016  const std::string&,
1017  const size_t
1018  ) const
1019  {}
1020  public:
1021  void format(const std::string&) {}
1022  std::string format() const {}
1023 
1024  void format_comment(const std::string&) {}
1025  std::string format_comment() const {}
1026 
1027  void out(std::ostream&) {}
1028  std::ostream& out() {}
1029 
1030 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
1031  void depth(size_t) {}
1032  size_t depth() const {}
1033 
1034  void depth_mark(const std::string) {}
1035  std::string depth_mark() const {}
1036  void strip_calls(const size_t) {}
1037  size_t strip_calls() const {}
1038 #endif
1039 #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1
1040  void hfill_mark(const char) {}
1041  char hfill_mark() const {}
1042  void hfill_fmt(fmt) {}
1043  fmt hfill_fmt() const {}
1044  void hfill_max(const size_t) {}
1045  size_t hfill_max() {}
1046 #endif
1047 
1048  void threshold(level) {}
1049  void threshold(const std::string&) {}
1050  level threshold() const {}
1051  const std::map<std::string,level> levels() const {}
1052  level level_of(const std::string) {}
1053 
1054  void file(std::string) {}
1055  void func(std::string) {}
1056  void line(std::string) {}
1057 
1058 #pragma GCC diagnostic push
1059 #pragma GCC diagnostic ignored "-Wunused-parameter"
1060  void location(
1061  const std::string&,
1062  const std::string& in_function=".*",
1063  const std::string& in_line=".*"
1064  )
1065  {}
1066 #pragma GCC diagnostic pop
1067  template<class ... FMT>
1068  void style(level, FMT...) {}
1069  void style(level, fmt) {}
1070  fmt style(level) const {}
1071  public:
1072  std::string replace(
1073  const std::string&,
1074  const std::string&,
1075  const std::string&
1076  ) const
1077  {}
1078 
1079  std::string replace(
1080  const std::string&,
1081  const std::string&,
1082  const size_t
1083  ) const
1084  {}
1085 
1086  std::string format(
1087  std::string,
1088  const std::string&,
1089 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
1090  const std::string&,
1091 #endif
1092  const level&,
1093  const std::string&,
1094  const std::string&,
1095  const size_t
1096 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
1097  ,
1098  const size_t
1099 #endif
1100  ) const
1101  {}
1102 
1103  void log(
1104  const level&,
1105  const std::string&,
1106  const std::string&, const std::string&, size_t
1107  ) const
1108  {}
1109 
1110  template<class In>
1111  void dump(
1112  const level&,
1113  const In, const In,
1114  const std::string&, const std::string&, size_t,
1115  const std::string&,
1116  const std::string
1117  ) const
1118  {}
1119 };
1120 #pragma GCC diagnostic pop
1121 #endif // WITH_CLUTCHLOG
1122 
1123 #endif // CLUTCHLOG_H
clutchlog::default_depth_mark
static std::string default_depth_mark
Default mark for stack depth.
Definition: clutchlog.h:249
clutchlog::_format_log
std::string _format_log
Current format of the standard output.
Definition: clutchlog.h:497
clutchlog::_level_fmt
std::map< level, fmt > _level_fmt
Dictionary of level identifier to their format.
Definition: clutchlog.h:495
clutchlog::log
void log(const level &stage, const std::string &what, const std::string &file, const std::string &func, size_t line) const
Print a log message IF the location matches the given one.
Definition: clutchlog.h:891
clutchlog::fmt::str
std::string str() const
Return the formatting code as a string.
Definition: clutchlog.h:418
clutchlog::line
void line(std::string line)
Set the regular expression filtering the line location.
Definition: clutchlog.h:621
clutchlog::dump_default_format
static std::string dump_default_format
Default format of the comment line in file dump.
Definition: clutchlog.h:235
clutchlog::out
void out(std::ostream &out)
Set the output stream on which to print.
Definition: clutchlog.h:552
clutchlog::dump_default_sep
static std::string dump_default_sep
Default item separator for dump.
Definition: clutchlog.h:242
clutchlog::format
std::string format(std::string row, const std::string &what, const level &stage, const std::string &file, const std::string &func, const size_t line) const
Substitute all tags in the format string with the corresponding information and apply the style corre...
Definition: clutchlog.h:805
CLUTCHLOG_DEFAULT_DEPTH_MARK
#define CLUTCHLOG_DEFAULT_DEPTH_MARK
Compile-time default mark for stack depth.
Definition: clutchlog.h:246
clutchlog::default_strip_calls
static unsigned int default_strip_calls
Number of call stack levels to remove from depth display by default.
Definition: clutchlog.h:256
clutchlog::replace
std::string replace(const std::string &form, const std::string &mark, const std::string &tag) const
Replace mark by tag in form.
Definition: clutchlog.h:729
clutchlog::fmt::back
enum clutchlog::fmt::bg back
Background color.
clutchlog::fmt::fg
fg
Foreground color codes.
Definition: clutchlog.h:312
clutchlog::fmt::fore
enum clutchlog::fmt::fg fore
Foreground color.
clutchlog::default_hfill_char
static char default_hfill_char
Default character used as a filling for right-align the right part of messages with "{hfill}".
Definition: clutchlog.h:263
clutchlog::scope_t::matches
bool matches
Everything is compatible.
Definition: clutchlog.h:656
clutchlog::fmt::style
enum clutchlog::fmt::typo style
Typographic style.
CLUTCHLOG_HFILL_MARK
#define CLUTCHLOG_HFILL_MARK
Character used as a filling for right-align the right part of messages with "{hfill}".
Definition: clutchlog.h:260
clutchlog::format_comment
void format_comment(const std::string &format)
Set the template string for dumps.
Definition: clutchlog.h:547
clutchlog::file
void file(std::string file)
Set the regular expression filtering the file location.
Definition: clutchlog.h:617
clutchlog::locate
scope_t locate(const level &stage, const std::string &file, const std::string &func, const size_t line) const
Gather information on the current location of the call.
Definition: clutchlog.h:678
clutchlog::fmt::fmt
fmt()
&#160;Empty constructor, only useful for a no-op formatter.
Definition: clutchlog.h:347
clutchlog::style
void style(level stage, fmt style)
Set the style (color and typo) of the given log level, passing a fmt instance.
Definition: clutchlog.h:642
clutchlog::threshold
void threshold(level l)
Set the log level (below which logs are not printed) with an identifier.
Definition: clutchlog.h:594
clutchlog::threshold
level threshold() const
Get the log level below which logs are not printed.
Definition: clutchlog.h:598
clutchlog::level
level
Available log levels.
Definition: clutchlog.h:298
clutchlog::default_hfill_max
static size_t default_hfill_max
Default maximum number of character used as a filling for right-align the right part of messages with...
Definition: clutchlog.h:272
clutchlog::scope_t::scope_t
scope_t()
Constructor.
Definition: clutchlog.h:666
clutchlog::_in_func
std::regex _in_func
Current function location filter.
Definition: clutchlog.h:521
clutchlog::fmt::bg
bg
Background color codes.
Definition: clutchlog.h:325
clutchlog::default_format
static std::string default_format
Default format of the messages.
Definition: clutchlog.h:213
clutchlog::logger
static clutchlog & logger()
Get the logger instance.
Definition: clutchlog.h:291
clutchlog::dump
void dump(const level &stage, const In container_begin, const In container_end, const std::string &file, const std::string &func, size_t line, const std::string &filename_template="dump_{n}.dat", const std::string sep=dump_default_sep) const
Dump a serializable container after a comment line with log information.
Definition: clutchlog.h:916
clutchlog::fmt
Color and style formatter for ANSI terminal escape sequences.
Definition: clutchlog.h:309
clutchlog::func
void func(std::string func)
Set the regular expression filtering the function location.
Definition: clutchlog.h:619
clutchlog::format
std::string format() const
Get the template string.
Definition: clutchlog.h:544
clutchlog::_in_file
std::regex _in_file
Current file location filter.
Definition: clutchlog.h:519
clutchlog::style
void style(level stage, FMT... styles)
Set the style (color and typo) of the given log level.
Definition: clutchlog.h:640
clutchlog::level_of
level level_of(const std::string name)
Return the log level tag corresponding to the given pre-configured name.
Definition: clutchlog.h:606
clutchlog::_level_word
const std::map< level, std::string > _level_word
Dictionary of level identifier to their string representation.
Definition: clutchlog.h:491
clutchlog::fmt::operator()
std::string operator()(const std::string &msg) const
Format the given string with the currently encoded format.
Definition: clutchlog.h:406
CLUTCHLOG_DEFAULT_FORMAT
#define CLUTCHLOG_DEFAULT_FORMAT
Compile-time default format of the messages (debug mode: with absolute location).
Definition: clutchlog.h:198
clutchlog::_in_line
std::regex _in_line
Current line location filter.
Definition: clutchlog.h:523
clutchlog::replace
std::string replace(const std::string &form, const std::string &mark, const size_t tag) const
Replace mark by tag in form, converting tag to its string representation first.
Definition: clutchlog.h:794
clutchlog::format_comment
std::string format_comment() const
Get the template string for dumps.
Definition: clutchlog.h:549
clutchlog::_format_dump
std::string _format_dump
Current format of the file output.
Definition: clutchlog.h:499
CLUTCHDUMP_DEFAULT_SEP
#define CLUTCHDUMP_DEFAULT_SEP
Compile-time default item separator for dump.
Definition: clutchlog.h:239
clutchlog::scope_t
Structure holding a location matching.
Definition: clutchlog.h:654
clutchlog::fmt::print_on
std::ostream & print_on(std::ostream &os) const
Print the currently encoded format escape code on the given output stream.
Definition: clutchlog.h:361
clutchlog::_out
std::ostream * _out
Standard output.
Definition: clutchlog.h:509
clutchlog::out
std::ostream & out()
Get the output stream on which to print.
Definition: clutchlog.h:554
clutchlog::threshold
void threshold(const std::string &l)
Set the log level (below which logs are not printed) with a string.
Definition: clutchlog.h:596
clutchlog::levels
const std::map< std::string, level > & levels() const
Get the map of available log levels string representations toward their identifier....
Definition: clutchlog.h:600
clutchlog::_strip_calls
size_t _strip_calls
Current number of call stack levels to remove from depth display.
Definition: clutchlog.h:489
clutchlog::scope_t::stage
level stage
Current log level.
Definition: clutchlog.h:658
clutchlog::scope_t::there
bool there
Location is compatible.
Definition: clutchlog.h:664
CLUTCHLOG_STRIP_CALLS
#define CLUTCHLOG_STRIP_CALLS
Compile-time number of call stack levels to remove from depth display by default.
Definition: clutchlog.h:253
clutchlog::fmt::operator<<
friend std::ostream & operator<<(std::ostream &os, const fmt &fmt)
Output stream overload.
Definition: clutchlog.h:391
clutchlog::_word_level
std::map< std::string, level > _word_level
Dictionary of level string to their identifier.
Definition: clutchlog.h:493
clutchlog::_stage
level _stage
Current log level.
Definition: clutchlog.h:517
clutchlog::style
fmt style(level stage) const
Get the configured fmt instance of the given log level.
Definition: clutchlog.h:644
clutchlog::fmt::typo
typo
Typographic style codes.
Definition: clutchlog.h:338
clutchlog::location
void location(const std::string &in_file, const std::string &in_function=".*", const std::string &in_line=".*")
Set the regular expressions filtering the location.
Definition: clutchlog.h:624
CLUTCHLOG_HAVE_UNIX_SYSINFO
#define CLUTCHLOG_HAVE_UNIX_SYSINFO
True if POSIX headers necessary for stack depth management are available.
Definition: clutchlog.h:33
clutchlog
The single class which holds everything.
Definition: clutchlog.h:177
CLUTCHDUMP_DEFAULT_FORMAT
#define CLUTCHDUMP_DEFAULT_FORMAT
Compile-time default format of the comment line in file dump.
Definition: clutchlog.h:221