clutchlog  0.6.0
clutchlog.h
Go to the documentation of this file.
1 #ifndef __CLUTCHLOG_H__
2 #define __CLUTCHLOG_H__
3 #pragma once
4 
6 #include <ciso646>
7  #ifdef FSEXPERIMENTAL
8  #include <experimental/filesystem>
9  namespace fs = std::experimental::filesystem;
10 #else
11  #include <filesystem>
12  namespace fs = std::filesystem;
13 #endif
14 
15 #include <iostream>
16 #include <sstream>
17 #include <fstream>
18 #include <cassert>
19 #include <cstdlib>
20 #include <string>
21 #include <limits>
22 #include <regex>
23 #include <map>
24 
26 #if __has_include(<execinfo.h>) && __has_include(<stdlib.h>) && __has_include(<libgen.h>)
27  #include <execinfo.h> // execinfo
28  #include <stdlib.h> // getenv
29  #include <libgen.h> // basename
30  #define CLUTCHLOG_HAVE_UNIX_SYSINFO 1
31 #else
32  #define CLUTCHLOG_HAVE_UNIX_SYSINFO 0
33 #endif
34 
35 /**********************************************************************
36  * Enable by default in Debug builds.
37  **********************************************************************/
38 #ifndef WITH_CLUTCHLOG
39  #ifndef NDEBUG
40  #define WITH_CLUTCHLOG
42  #endif
43 #endif
44 
45 /**********************************************************************
46  * Macros definitions
47  **********************************************************************/
48 #ifdef WITH_CLUTCHLOG
49 
53 #ifndef CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG
54  #define CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG clutchlog::level::progress
56 #endif // CLUTCHLOG_DEFAULT_DEPTH_BUILT
57 
64 #define CLUTCHLOC __FILE__, __FUNCTION__, __LINE__
66 
68 #ifndef NDEBUG
69  #define CLUTCHLOG( LEVEL, WHAT ) do { \
70  auto& clutchlog__logger = clutchlog::logger(); \
71  std::ostringstream clutchlog__msg ; clutchlog__msg << WHAT; \
72  clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), CLUTCHLOC); \
73  } while(0)
74 #else // not Debug build.
75  #define CLUTCHLOG( LEVEL, WHAT ) do { \
76  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
77  auto& clutchlog__logger = clutchlog::logger(); \
78  std::ostringstream clutchlog__msg ; clutchlog__msg << WHAT; \
79  clutchlog__logger.log(clutchlog::level::LEVEL, clutchlog__msg.str(), CLUTCHLOC); \
80  } \
81  } while(0)
82 #endif // NDEBUG
83 
85 #ifndef NDEBUG
86  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do { \
87  auto& clutchlog__logger = clutchlog::logger(); \
88  clutchlog__logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \
89  CLUTCHLOC, FILENAME, CLUTCHDUMP_DEFAULT_SEP); \
90  } while(0)
91 #else // not Debug build.
92  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do { \
93  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
94  auto& clutchlog__logger = clutchlog::logger(); \
95  clutchlog__logger.dump(clutchlog::level::LEVEL, std::begin(CONTAINER), std::end(CONTAINER), \
96  CLUTCHLOC, FILENAME, CLUTCHDUMP_DEFAULT_SEP); \
97  } \
98  } while(0)
99 #endif // NDEBUG
100 
102 #ifndef NDEBUG
103  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do { \
104  auto& clutchlog__logger = clutchlog::logger(); \
105  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
106  if(clutchlog__scope.matches) { \
107  FUNC(__VA_ARGS__); \
108  } \
109  } while(0)
110 #else // not Debug build.
111  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do { \
112  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
113  auto& clutchlog__logger = clutchlog::logger(); \
114  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
115  if(clutchlog__scope.matches) { \
116  FUNC(__VA_ARGS__); \
117  } \
118  } \
119  } while(0)
120 #endif // NDEBUG
121 
123 #ifndef NDEBUG
124  #define CLUTCHCODE( LEVEL, ... ) do { \
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  __VA_ARGS__ \
129  } \
130  } while(0)
131 #else // not Debug build.
132  #define CLUTCHCODE( LEVEL, CODE ) do { \
133  if(clutchlog::level::LEVEL <= CLUTCHLOG_DEFAULT_DEPTH_BUILT_NODEBUG) { \
134  auto& clutchlog__logger = clutchlog::logger(); \
135  clutchlog::scope_t clutchlog__scope = clutchlog__logger.locate(clutchlog::level::LEVEL, CLUTCHLOC); \
136  if(clutchlog__scope.matches) { \
137  CODE \
138  } \
139  } \
140  } while(0)
141 #endif // NDEBUG
142 
145 #else // not WITH_CLUTCHLOG
146  // Disabled macros can still be called in Release builds.
147  #define CLUTCHLOG( LEVEL, WHAT ) do {/*nothing*/} while(0)
148  #define CLUTCHDUMP( LEVEL, CONTAINER, FILENAME ) do {/*nothing*/} while(0)
149  #define CLUTCHFUNC( LEVEL, FUNC, ... ) do {/*nothing*/} while(0)
150  #define CLUTCHCODE( LEVEL, CODE ) do {/*nothing*/} while(0)
151 #endif // WITH_CLUTCHLOG
152 
153 /**********************************************************************
154  * Implementation
155  **********************************************************************/
156 
157 #ifdef WITH_CLUTCHLOG
158 
165 class clutchlog
166 {
167  protected:
168 
171  #ifndef CLUTCHLOG_DEFAULT_FORMAT
172  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
174  #define CLUTCHLOG_DEFAULT_FORMAT "[{name}] {level_letter}:{depth_marks} {msg}\t\t\t\t\t{func} @ {file}:{line}\n"
175  #else
176  #define CLUTCHLOG_DEFAULT_FORMAT "{level_letter} {msg}\t\t\t\t\t{func} @ {file}:{line}\n"
177  #endif
178  #endif // CLUTCHLOG_DEFAULT_FORMAT
179  static inline std::string default_format = CLUTCHLOG_DEFAULT_FORMAT;
181 
182  #ifndef CLUTCHDUMP_DEFAULT_FORMAT
183  #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
185  #define CLUTCHDUMP_DEFAULT_FORMAT "# [{name}] {level} in {func} (at depth {depth}) @ {file}:{line}"
186  #else
187  #define CLUTCHDUMP_DEFAULT_FORMAT "# {level} in {func} @ {file}:{line}"
188  #endif
189  #endif // CLUTCHDUMP_DEFAULT_FORMAT
190  static inline std::string dump_default_format = CLUTCHDUMP_DEFAULT_FORMAT;
192 
193  #ifndef CLUTCHDUMP_DEFAULT_SEP
194  #define CLUTCHDUMP_DEFAULT_SEP "\n"
196  #endif // CLUTCHDUMP_DEFAULT_SEP
197  static inline std::string dump_default_sep = CLUTCHDUMP_DEFAULT_SEP;
199 
200  #ifndef CLUTCHLOG_DEFAULT_DEPTH_MARK
201  #define CLUTCHLOG_DEFAULT_DEPTH_MARK ">"
203  #endif // CLUTCHLOG_DEFAULT_DEPTH_MARK
204  static inline std::string default_depth_mark = CLUTCHLOG_DEFAULT_DEPTH_MARK;
206 
207  #ifndef CLUTCHLOG_STRIP_CALLS
208  #define CLUTCHLOG_STRIP_CALLS 5
210  #endif // CLUTCHLOG_STRIP_CALLS
211  static inline unsigned int default_strip_calls = CLUTCHLOG_STRIP_CALLS;
213  /* @} */
214 
215 
216  public:
226  static clutchlog& logger()
227  {
228  static clutchlog instance;
229  return instance;
230  }
231 
233  enum level {critical=0, error=1, warning=2, progress=3, note=4, info=5, debug=6, xdebug=7};
234 
247  class fmt {
248  public:
250  enum class fg {
251  black = 30,
252  red = 31,
253  green = 32,
254  yellow = 33,
255  blue = 34,
256  magenta = 35,
257  cyan = 36,
258  white = 37,
259  none
260  } fore;
261 
263  enum class bg {
264  black = 40,
265  red = 41,
266  green = 42,
267  yellow = 43,
268  blue = 44,
269  magenta = 45,
270  cyan = 46,
271  white = 47,
272  none
273  } back;
274 
276  enum class typo {
277  reset = 0,
278  bold = 1,
279  underline = 4,
280  inverse = 7,
281  none
282  } style;
283 
285  fmt() : fore(fg::none), back(bg::none), style(typo::none) { }
286 
289  fmt( fg f, bg b = bg::none, typo s = typo::none) : fore(f), back(b), style(s) { }
290  fmt( fg f, typo s , bg b = bg::none) : fore(f), back(b), style(s) { }
291  fmt( bg b, fg f = fg::none, typo s = typo::none) : fore(f), back(b), style(s) { }
292  fmt( bg b, typo s , fg f = fg::none) : fore(f), back(b), style(s) { }
293  fmt(typo s, fg f = fg::none, bg b = bg::none) : fore(f), back(b), style(s) { }
294  fmt(typo s, bg b , fg f = fg::none) : fore(f), back(b), style(s) { }
297  protected:
299  std::ostream& print_on( std::ostream& os) const
300  {
301  std::vector<int> codes; codes.reserve(3);
302  if(this->fore != fg::none) { codes.push_back(static_cast<int>(this->fore ));}
303  if(this->back != bg::none) { codes.push_back(static_cast<int>(this->back ));}
304  if(this->style != typo::none) { codes.push_back(static_cast<int>(this->style));}
305  if(codes.size() == 0) {return os;}
306 
307  os << "\033[";
308  assert(codes.size() > 0);
309  os << codes[0];
310  for(size_t i=1; i < codes.size(); ++i) {
311  os << ";" << codes[i];
312  }
313  os << "m";
314  return os;
315  }
316 
317  public:
329  friend std::ostream& operator<<(std::ostream& os, const fmt& fmt)
330  {
331  return fmt.print_on(os);
332  }
333 
344  std::string operator()( const std::string& msg ) const
345  {
346  std::ostringstream os;
347  this->print_on(os);
348  fmt reset(fmt::typo::reset);
349  os << msg;
350  reset.print_on(os);
351  return os.str();
352  }
353  }; // fmt class
354 
361  public:
362  clutchlog(clutchlog const&) = delete;
363  void operator=(clutchlog const&) = delete;
364 
365  private:
366  clutchlog() :
367  // system, main, log
368  _strip_calls(clutchlog::default_strip_calls),
369  _level_word({
370  {level::critical,"Critical"},
371  {level::error ,"Error"},
372  {level::warning ,"Warning"},
373  {level::progress,"Progress"},
374  {level::note ,"Note"},
375  {level::info ,"Info"},
376  {level::debug ,"Debug"},
377  {level::xdebug ,"XDebug"}
378  }),
379  _level_fmt({
380  {level::critical,fmt(fmt::fg::red, fmt::typo::underline)},
381  {level::error ,fmt(fmt::fg::red, fmt::typo::bold)},
382  {level::warning ,fmt(fmt::fg::magenta, fmt::typo::bold)},
383  {level::progress,fmt()},
384  {level::note ,fmt()},
385  {level::info ,fmt()},
386  {level::debug ,fmt()},
387  {level::xdebug ,fmt()}
388  }),
389  _format_log(clutchlog::default_format),
390  _format_dump(clutchlog::dump_default_format),
391  _out(&std::clog),
392 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
393  _depth(std::numeric_limits<size_t>::max() - _strip_calls),
394  _depth_mark(clutchlog::default_depth_mark),
395 #endif
396  _stage(level::error),
397  _in_file(".*"),
398  _in_func(".*"),
399  _in_line(".*")
400  {
401  // Reverse the level->word map into a word->level map.
402  for(auto& lw : _level_word) {
403  _word_level[lw.second] = lw.first;
404  }
405  }
406 
407  protected:
409  const size_t _strip_calls;
411  const std::map<level,std::string> _level_word;
413  std::map<std::string,level> _word_level;
415  std::map<level,fmt> _level_fmt;
417  std::string _format_log;
419  std::string _format_dump;
421  std::ostream* _out;
422 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
423 
424  size_t _depth;
426  std::string _depth_mark;
427 #endif
428 
429  level _stage;
431  std::regex _in_file;
433  std::regex _in_func;
435  std::regex _in_line;
436 
437 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
438 
439  static const size_t max_buffer = 4096;
440 #endif
441 
443  public:
444 
448  void format(const std::string& format) {_format_log = format;}
451  std::string format() const {return _format_log;}
452 
454  void format_comment(const std::string& format) {_format_dump = format;}
456  std::string format_comment() const {return _format_dump;}
457 
459  void out(std::ostream& out) {_out = &out;}
461  std::ostream& out() {return *_out;}
462 
463 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
464  void depth(size_t d) {_depth = d;}
467  size_t depth() const {return _depth;}
468 
470  void depth_mark(std::string mark) {_depth_mark = mark;}
472  std::string depth_mark() const {return _depth_mark;}
473 #endif
474 
476  void threshold(level l) {_stage = l;}
478  level threshold() const {return _stage;}
479 
481  void file(std::string file) {_in_file = file;}
483  void func(std::string func) {_in_func = func;}
485  void line(std::string line) {_in_line = line;}
486 
488  void location(
489  const std::string& in_file,
490  const std::string& in_function=".*",
491  const std::string& in_line=".*"
492  )
493  {
494  file(in_file);
495  func(in_function);
496  line(in_line);
497  }
498 
503  template<class ... FMT>
504  void style(level stage, FMT... styles) { this->style(stage,fmt(styles...)); }
506  void style(level stage, fmt style) { _level_fmt.at(stage) = style; }
508  fmt style(level stage) const { return _level_fmt.at(stage); }
509 
514  level level_of(const std::string name)
515  {
516  const auto ilevel = _word_level.find(name);
517  if( ilevel != std::end(_word_level)) {
518  return ilevel->second;
519  } else {
520  throw std::out_of_range("'" + name + "' is not a valid log level name");
521  }
522  }
523 
526  public:
527 
531  struct scope_t {
534  bool matches;
536  level stage;
537 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
538 
539  size_t depth;
540 #endif
541 
542  bool there;
544  scope_t() :
545  matches(false),
546  stage(level::xdebug),
547 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
548  depth(0),
549 #endif
550  there(false)
551  {}
552  }; // scope_t
553 
554 
556  scope_t locate(
557  const level& stage,
558  const std::string& file,
559  const std::string& func,
560  const size_t line
561  ) const
562  {
563  scope_t scope; // False scope by default.
564 
565  /***** Log level stage *****/
566  // Test stage first, because it's fastest.
567  scope.stage = stage;
568  if(not (scope.stage <= _stage)) {
569  // Bypass useless computations if no match
570  // because of the stage.
571  return scope;
572  }
573 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
574  /***** Stack depth *****/
575  // Backtrace in second, quite fast.
576  size_t stack_depth;
577  void *buffer[max_buffer];
578  stack_depth = backtrace(buffer, max_buffer);
579  scope.depth = stack_depth;
580  if(not (scope.depth <= _depth + _strip_calls)) {
581  // Bypass if no match.
582  return scope;
583  }
584 #endif
585 
586  /***** Location *****/
587  // Location last, slowest.
588  std::ostringstream sline; sline << line;
589  scope.there =
590  std::regex_search(file, _in_file)
591  and std::regex_search(func, _in_func)
592  and std::regex_search(sline.str(), _in_line);
593 
594  // No need to retest stage and depth, which are true here.
595  scope.matches = scope.there;
596 
597  return scope;
598  } // locate
599 
607  std::string replace(
608  const std::string& form,
609  const std::string& mark,
610  const std::string& tag
611  ) const
612  {
613  // Useless debug code, unless something fancy would be done with name tags.
614  // std::regex re;
615  // try {
616  // re = std::regex(mark);
617  //
618  // } catch(const std::regex_error& e) {
619  // std::cerr << "ERROR with a regular expression \"" << mark << "\": ";
620  // switch(e.code()) {
621  // case std::regex_constants::error_collate:
622  // std::cerr << "the expression contains an invalid collating element name";
623  // break;
624  // case std::regex_constants::error_ctype:
625  // std::cerr << "the expression contains an invalid character class name";
626  // break;
627  // case std::regex_constants::error_escape:
628  // std::cerr << "the expression contains an invalid escaped character or a trailing escape";
629  // break;
630  // case std::regex_constants::error_backref:
631  // std::cerr << "the expression contains an invalid back reference";
632  // break;
633  // case std::regex_constants::error_brack:
634  // std::cerr << "the expression contains mismatched square brackets ('[' and ']')";
635  // break;
636  // case std::regex_constants::error_paren:
637  // std::cerr << "the expression contains mismatched parentheses ('(' and ')')";
638  // break;
639  // case std::regex_constants::error_brace:
640  // std::cerr << "the expression contains mismatched curly braces ('{' and '}')";
641  // break;
642  // case std::regex_constants::error_badbrace:
643  // std::cerr << "the expression contains an invalid range in a {} expression";
644  // break;
645  // case std::regex_constants::error_range:
646  // std::cerr << "the expression contains an invalid character range (e.g. [b-a])";
647  // break;
648  // case std::regex_constants::error_space:
649  // std::cerr << "there was not enough memory to convert the expression into a finite state machine";
650  // break;
651  // case std::regex_constants::error_badrepeat:
652  // std::cerr << "one of *?+{ was not preceded by a valid regular expression";
653  // break;
654  // case std::regex_constants::error_complexity:
655  // std::cerr << "the complexity of an attempted match exceeded a predefined level";
656  // break;
657  // case std::regex_constants::error_stack:
658  // std::cerr << "there was not enough memory to perform a match";
659  // break;
660  // default:
661  // std::cerr << "unknown error";
662  // }
663  // std::cerr << std::endl;
664  // throw;
665  // } // catch
666 
667  const std::regex re(mark);
668  return std::regex_replace(form, re, tag);
669  }
670 
672  std::string replace(
673  const std::string& form,
674  const std::string& mark,
675  const size_t tag
676  ) const
677  {
678  std::ostringstream stag; stag << tag;
679  return replace(form, mark, stag.str());
680  }
681 
683  std::string format(
684  std::string format,
685  const std::string& what,
686 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
687  const std::string& name,
688 #endif
689  const level& stage,
690  const std::string& file,
691  const std::string& func,
692  const size_t line
693 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
694  ,
695  const size_t depth
696 #endif
697  ) const
698  {
699  format = replace(format, "\\{msg\\}", what);
700  format = replace(format, "\\{file\\}", file);
701  format = replace(format, "\\{func\\}", func);
702  format = replace(format, "\\{line\\}", line);
703 
704  format = replace(format, "\\{level\\}", _level_word.at(stage));
705  std::string letter(1, _level_word.at(stage).at(0)); // char -> string
706  format = replace(format, "\\{level_letter\\}", letter);
707 
708 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
709  format = replace(format, "\\{name\\}", name);
710  format = replace(format, "\\{depth\\}", depth - _strip_calls);
711 
712  std::ostringstream chevrons;
713  for(size_t i = _strip_calls; i < depth; ++i) {
714  chevrons << _depth_mark;
715  }
716  format = replace(format, "\\{depth_marks\\}", chevrons.str());
717 #endif
718 
719  return _level_fmt.at(stage)(format);
720  }
721 
723  void log(
724  const level& stage,
725  const std::string& what,
726  const std::string& file, const std::string& func, size_t line
727  ) const
728  {
729  scope_t scope = locate(stage, file, func, line);
730 
731  if(scope.matches) {
732 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
733  *_out << format(_format_log, what, basename(getenv("_")),
734  stage, file, func,
735  line, scope.depth );
736 #else
737  *_out << format(_format_log, what,
738  stage, file, func,
739  line );
740 
741 #endif
742  _out->flush();
743  } // if scopes.matches
744  }
745 
747  template<class In>
748  void dump(
749  const level& stage,
750  const In container_begin, const In container_end,
751  const std::string& file, const std::string& func, size_t line,
752  const std::string& filename_template = "dump_{n}.dat",
753  const std::string sep = dump_default_sep
754  ) const
755  {
756  scope_t scope = locate(stage, file, func, line);
757 
758  if(scope.matches) {
759  const std::string tag = "\\{n\\}";
760  const std::regex re(tag);
761  std::string outfile = "";
762 
763  // If the file name template has the {n} tag.
764  if(std::regex_search(filename_template, re)) {
765  // Increment n until a free one is found.
766  size_t n = 0;
767  do {
768  outfile = replace(filename_template, tag, n);
769  n++;
770  } while( fs::exists( outfile ) );
771 
772  } else {
773  // Use the parameter as is.
774  outfile = filename_template;
775  }
776 
777  std::ofstream fd(outfile);
778 
779  if(_format_dump.size() > 0) {
780 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
781  fd << format(_format_dump, "", basename(getenv("_")),
782  stage, file, func,
783  line, scope.depth );
784 #else
785  fd << format(_format_dump, "",
786  stage, file, func,
787  line );
788 #endif
789  fd << sep; // sep after comment line.
790  }
791 
792  std::copy(container_begin, container_end,
793  std::ostream_iterator<typename In::value_type>(fd, sep.c_str()));
794 
795  fd.close();
796  } // if scopes.matches
797  }
798 
800 };
801 
804 #else // not WITH_CLUTCHLOG
805 
806 
807 /**********************************************************************
808  * Fake implementation
809  **********************************************************************/
810 
811 // Equivalent class with empty methods, will be optimized out
812 // while allowing to actually have calls implemented without WITH_CLUTCHLOG guards.
813 #pragma GCC diagnostic push
814 #pragma GCC diagnostic ignored "-Wreturn-type"
815 class clutchlog
816 {
817  public:
818  static clutchlog& logger() { }
819  enum level {critical=0, error=1, warning=2, progress=3, note=4, info=5, debug=6, xdebug=7};
820  class fmt {
821  public:
822  enum class fg { black, red, green, yellow, blue, magenta, cyan, white, none } fore;
823  enum class bg { black, red, green, yellow, blue, magenta, cyan, white, none } back;
824  enum class typo { reset, bold, underline, inverse, none } style;
825  fmt() : fore(fg::none), back(bg::none), style(typo::none) { }
826  fmt( fg f, bg b = bg::none, typo s = typo::none) : fore(f), back(b), style(s) { }
827  fmt( fg f, typo s , bg b = bg::none) : fore(f), back(b), style(s) { }
828  fmt( bg b, fg f = fg::none, typo s = typo::none) : fore(f), back(b), style(s) { }
829  fmt( bg b, typo s , fg f = fg::none) : fore(f), back(b), style(s) { }
830  fmt(typo s, fg f = fg::none, bg b = bg::none) : fore(f), back(b), style(s) { }
831  fmt(typo s, bg b , fg f = fg::none) : fore(f), back(b), style(s) { }
832  protected:
833  std::ostream& print_on(std::ostream&) const { }
834  public:
835  friend std::ostream& operator<<(std::ostream&, const fmt&) { }
836  std::string operator()(const std::string&) const { }
837  };
838  public:
839  clutchlog(clutchlog const&) = delete;
840  void operator=(clutchlog const&) = delete;
841  private:
842  clutchlog() {}
843  protected:
844  struct scope_t {};
845  scope_t locate(
846  const level&,
847  const std::string&,
848  const std::string&,
849  const size_t
850  ) const
851  { }
852  public:
853  void format(const std::string&) {}
854  std::string format() const {}
855 
856  void format_comment(const std::string&) {}
857  std::string format_comment() const {}
858 
859  void out(std::ostream&) {}
860  std::ostream& out() {}
861 
862 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
863  void depth(size_t) {}
864  size_t depth() const {}
865 
866  void depth_mark(std::string) {}
867  std::string depth_mark() const {}
868 #endif
869 
870  void threshold(level) {}
871  level threshold() const {}
872 
873  void file(std::string) {}
874  void func(std::string) {}
875  void line(std::string) {}
876 
877 #pragma GCC diagnostic push
878 #pragma GCC diagnostic ignored "-Wunused-parameter"
879  void location(
880  const std::string&,
881  const std::string& in_function=".*",
882  const std::string& in_line=".*"
883  )
884  { }
885 #pragma GCC diagnostic pop
886  void style(level, fmt) { }
887  fmt style(level) const { }
888  level level_of(const std::string) { }
889  public:
890  std::string replace(
891  const std::string&,
892  const std::string&,
893  const std::string&
894  ) const
895  { }
896 
897  std::string replace(
898  const std::string&,
899  const std::string&,
900  const size_t
901  ) const
902  { }
903 
904  std::string format(
905  std::string,
906  const std::string&,
907 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
908  const std::string&,
909 #endif
910  const level&,
911  const std::string&,
912  const std::string&,
913  const size_t
914 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
915  ,
916  const size_t
917 #endif
918  ) const
919  { }
920 
921  void log(
922  const level&,
923  const std::string&,
924  const std::string&, const std::string&, size_t
925  ) const
926  { }
927 
928  template<class In>
929  void dump(
930  const level&,
931  const In, const In,
932  const std::string&, const std::string&, size_t,
933  const std::string&,
934  const std::string
935  ) const
936  { }
937 };
938 #pragma GCC diagnostic pop
939 #endif // WITH_CLUTCHLOG
940 
941 #endif // __CLUTCHLOG_H__
clutchlog::file
void file(std::string file)
Set the regular expression filtering the file location.
Definition: clutchlog.h:481
CLUTCHDUMP_DEFAULT_FORMAT
#define CLUTCHDUMP_DEFAULT_FORMAT
Compile-time default format of the comment line in file dump.
Definition: clutchlog.h:187
clutchlog::fmt::fg
fg
Foreground color codes.
Definition: clutchlog.h:250
clutchlog::dump_default_format
static std::string dump_default_format
Default format of the comment line in file dump.
Definition: clutchlog.h:191
clutchlog::out
void out(std::ostream &out)
Set the output stream on which to print.
Definition: clutchlog.h:459
clutchlog::fmt::fmt
fmt()
&#160;Empty constructor, only useful for a no-op formatter.
Definition: clutchlog.h:285
clutchlog::logger
static clutchlog & logger()
Get the logger instance.
Definition: clutchlog.h:226
clutchlog::line
void line(std::string line)
Set the regular expression filtering the line location.
Definition: clutchlog.h:485
clutchlog::format_comment
void format_comment(const std::string &format)
Set the template string for dumps.
Definition: clutchlog.h:454
clutchlog::fmt::typo
typo
Typographic style codes.
Definition: clutchlog.h:276
CLUTCHDUMP_DEFAULT_SEP
#define CLUTCHDUMP_DEFAULT_SEP
Compile-time default item separator for dump.
Definition: clutchlog.h:195
clutchlog::default_depth_mark
static std::string default_depth_mark
Default mark for stack depth.
Definition: clutchlog.h:205
CLUTCHLOG_DEFAULT_FORMAT
#define CLUTCHLOG_DEFAULT_FORMAT
Compile-time default format of the messages.
Definition: clutchlog.h:176
clutchlog::format
std::string format() const
Get the template string.
Definition: clutchlog.h:451
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:723
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:514
clutchlog::_format_dump
std::string _format_dump
Current format of the file output.
Definition: clutchlog.h:419
clutchlog::fmt::operator()
std::string operator()(const std::string &msg) const
Format the given string with the currently encoded format.
Definition: clutchlog.h:344
clutchlog::format
std::string format(std::string format, 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:683
clutchlog::_format_log
std::string _format_log
Current format of the standard output.
Definition: clutchlog.h:417
clutchlog::level
level
Available log levels.
Definition: clutchlog.h:233
clutchlog::scope_t::stage
level stage
Current log level.
Definition: clutchlog.h:536
CLUTCHLOG_DEFAULT_DEPTH_MARK
#define CLUTCHLOG_DEFAULT_DEPTH_MARK
Compile-time default mark for stack depth.
Definition: clutchlog.h:202
clutchlog::fmt::operator<<
friend std::ostream & operator<<(std::ostream &os, const fmt &fmt)
Output stream overload.
Definition: clutchlog.h:329
clutchlog::_level_fmt
std::map< level, fmt > _level_fmt
Dictionary of level identifier to their format.
Definition: clutchlog.h:415
clutchlog::_in_line
std::regex _in_line
Current line location filter.
Definition: clutchlog.h:435
clutchlog::fmt::style
enum clutchlog::fmt::typo style
Typographic style.
clutchlog::_stage
level _stage
Current log level.
Definition: clutchlog.h:429
clutchlog::_strip_calls
const size_t _strip_calls
Current number of call stack levels to remove from depth display.
Definition: clutchlog.h:409
clutchlog::format_comment
std::string format_comment() const
Get the template string for dumps.
Definition: clutchlog.h:456
CLUTCHLOG_STRIP_CALLS
#define CLUTCHLOG_STRIP_CALLS
Compile-time number of call stack levels to remove from depth display by default.
Definition: clutchlog.h:209
clutchlog::_out
std::ostream * _out
Standard output.
Definition: clutchlog.h:421
clutchlog::func
void func(std::string func)
Set the regular expression filtering the function location.
Definition: clutchlog.h:483
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:488
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:748
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:672
clutchlog::fmt
Color and style formatter for ANSI terminal escape sequences.
Definition: clutchlog.h:247
clutchlog::_in_file
std::regex _in_file
Current file location filter.
Definition: clutchlog.h:431
clutchlog::out
std::ostream & out()
Get the output stream on which to print.
Definition: clutchlog.h:461
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:607
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:212
clutchlog::default_format
static std::string default_format
Default format of the messages.
Definition: clutchlog.h:180
clutchlog::fmt::fore
enum clutchlog::fmt::fg fore
Foreground color.
clutchlog::scope_t::there
bool there
Location is compatible.
Definition: clutchlog.h:542
clutchlog::scope_t
Structure holding a location matching.
Definition: clutchlog.h:532
clutchlog::_in_func
std::regex _in_func
Current function location filter.
Definition: clutchlog.h:433
clutchlog::threshold
void threshold(level l)
Set the log level below which logs are not printed.
Definition: clutchlog.h:476
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:506
clutchlog::_level_word
const std::map< level, std::string > _level_word
Dictionary of level identifier to their string representation.
Definition: clutchlog.h:411
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:556
clutchlog::scope_t::matches
bool matches
Everything is compatible.
Definition: clutchlog.h:534
clutchlog::dump_default_sep
static std::string dump_default_sep
Default item separator for dump.
Definition: clutchlog.h:198
clutchlog::threshold
level threshold() const
Get the log level below which logs are not printed.
Definition: clutchlog.h:478
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:299
clutchlog::_word_level
std::map< std::string, level > _word_level
Dictionary of level string to their identifier.
Definition: clutchlog.h:413
clutchlog::style
void style(level stage, FMT... styles)
Set the style (color and typo) of the given log level.
Definition: clutchlog.h:504
clutchlog::scope_t::scope_t
scope_t()
Constructor.
Definition: clutchlog.h:544
CLUTCHLOG_HAVE_UNIX_SYSINFO
#define CLUTCHLOG_HAVE_UNIX_SYSINFO
POSIX headers necessary for stack depth management are available.
Definition: clutchlog.h:32
clutchlog
Definition: clutchlog.h:165
clutchlog::style
fmt style(level stage) const
Get the configured fmt instance of the given log level.
Definition: clutchlog.h:508
clutchlog::fmt::bg
bg
Background color codes.
Definition: clutchlog.h:263
clutchlog::fmt::back
enum clutchlog::fmt::bg back
Background color.
Generated by   doxygen 1.8.17