nojhan/clutchlog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

fix: adds hfill_max

Browse source 
- fix: get nb_columns from stderr instead of stdout.
- Avoid long hfill when standard output is redirected.
This commit is contained in:
Johann Dreo 2022-09-07 22:06:41 +02:00
commit 8765a53dac
2 changed files with 50 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -234,7 +234,16 @@ and its default with the `CLUTCHLOG_DEFAULT_HFILL_MARK` macro:
log.hfill_mark(CLUTCHLOG_DEFAULT_HFILL_MARK); // Defaults to '.'. log.hfill_mark(CLUTCHLOG_DEFAULT_HFILL_MARK); // Defaults to '.'.
``` ```
Note: if the system detects no terminal, only a single fill character is inserted. Clutchlog measures the width of the standard error channel.
If it is redirected, it may be measured as very large.
Thus, the `hfill_max` accessors allow to set a maximum width (in number of characters).
```cpp
log.hfill_max(CLUTCHLOG_DEFAULT_HFILL_MAX); // Defaults to 300.
```
Note: clutchlog will select the minimum between `hfill_max`
and the measured number of columns in the terminal,
so that you may use `hfill_max` as a way to constraint the output width
in any cases.
## Stack Depth ## Stack Depth

58
clutchlog/clutchlog.h
View file

@ -258,6 +258,15 @@ class clutchlog
//! Default character used as a filling for right-align the right part of messages with "{hfill}". //! Default character used as a filling for right-align the right part of messages with "{hfill}".
static inline char default_hfill_char = CLUTCHLOG_HFILL_MARK; static inline char default_hfill_char = CLUTCHLOG_HFILL_MARK;
#if CLUTCHLOG_HAVE_UNIX_SYSIOCTL == 1
#ifndef CLUTCHLOG_HFILL_MAX
#define CLUTCHLOG_HFILL_MAX 300
#endif
#endif
//! Default maximum number of character used as a filling for right-align the right part of messages with "{hfill}".
static inline unsigned short default_hfill_max = CLUTCHLOG_HFILL_MAX;
// NOTE: there is no CLUTCHLOG_HFILL_STYLE for defaulting, // NOTE: there is no CLUTCHLOG_HFILL_STYLE for defaulting,
// but you can still set `hfill_style(...)` on the logger singleton. // but you can still set `hfill_style(...)` on the logger singleton.
/* @} */ /* @} */
@ -439,13 +448,16 @@ class clutchlog
}), }),
_format_log(clutchlog::default_format), _format_log(clutchlog::default_format),
_format_dump(clutchlog::dump_default_format), _format_dump(clutchlog::dump_default_format),
_hfill_char(clutchlog::default_hfill_char), #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
_hfill_fmt(fmt::fg::none), _hfill_char(clutchlog::default_hfill_char),
_hfill_fmt(fmt::fg::none),
_hfill_max(clutchlog::default_hfill_max),
#endif
_out(&std::clog), _out(&std::clog),
#if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
_depth(std::numeric_limits<size_t>::max() - _strip_calls), _depth(std::numeric_limits<size_t>::max() - _strip_calls),
_depth_mark(clutchlog::default_depth_mark), _depth_mark(clutchlog::default_depth_mark),
#endif #endif
_stage(level::error), _stage(level::error),
_in_file(".*"), _in_file(".*"),
_in_func(".*"), _in_func(".*"),
@ -457,8 +469,8 @@ class clutchlog
} }
#if CLUTCHLOG_HAVE_UNIX_SYSIOCTL #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
struct winsize w; struct winsize w;
ioctl(STDOUT_FILENO, TIOCGWINSZ, &w); ioctl(STDERR_FILENO, TIOCGWINSZ, &w);
_nb_columns = w.ws_col; _nb_columns = std::min(w.ws_col, default_hfill_max);
#endif #endif
} }
@ -475,18 +487,22 @@ class clutchlog
std::string _format_log; std::string _format_log;
/** Current format of the file output. */ /** Current format of the file output. */
std::string _format_dump; std::string _format_dump;
/** Character for filling. */ #if CLUTCHLOG_HAVE_UNIX_SYSIOCTL
char _hfill_char; /** Character for filling. */
/** Style of the filling. */ char _hfill_char;
fmt _hfill_fmt; /** Style of the filling. */
fmt _hfill_fmt;
/** Maximum number of fill char. */
unsigned short _hfill_max;
#endif
/** Standard output. */ /** Standard output. */
std::ostream* _out; std::ostream* _out;
#if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1 #if CLUTCHLOG_HAVE_UNIX_SYSINFO == 1
/** Current stack depth (above which logs are not printed). */ /** Current stack depth (above which logs are not printed). */
size_t _depth; size_t _depth;
/** Current depth mark. */ /** Current depth mark. */
std::string _depth_mark; std::string _depth_mark;
#endif #endif
/** Current log level. */ /** Current log level. */
level _stage; level _stage;
/** Current file location filter. */ /** Current file location filter. */
@ -553,6 +569,10 @@ class clutchlog
void style(FMT... styles) { this->hfill_style(fmt(styles...)); } void style(FMT... styles) { this->hfill_style(fmt(styles...)); }
//! Get the character for the stretching hfill marker. //! Get the character for the stretching hfill marker.
fmt hfill_style() const {return _hfill_fmt;} fmt hfill_style() const {return _hfill_fmt;}
//! Set the maximum number of hfill characters. */
void hfill_max(const size_t nmax) {_hfill_max = nmax;}
//! Get the maximum number of hfill characters. */
unsigned short hfill_max() {return _hfill_max;}
#endif #endif
//! Set the log level (below which logs are not printed) with an identifier. //! Set the log level (below which logs are not printed) with an identifier.
@ -983,6 +1003,8 @@ class clutchlog
char hfill_mark() const {} char hfill_mark() const {}
void hfill_fmt(fmt) {} void hfill_fmt(fmt) {}
fmt hfill_fmt() const {} fmt hfill_fmt() const {}
void hfill_max(const size_t) {}
unsigned short hfill_max() {}
#endif #endif
void threshold(level) {} void threshold(level) {}