wlroots/include/wlr/util/log.h

65 lines
2.0 KiB
C
Raw Normal View History

/*
* This is a stable interface of wlroots. Future changes will be limited to:
*
* - New functions
* - New struct members
* - New enum members
*
* Note that wlroots does not make an ABI compatibility promise - in the future,
* the layout and size of structs used by wlroots may change, requiring code
* depending on this header to be recompiled (but not edited).
*
* Breaking changes are announced by email and follow a 1-year deprecation
* schedule. Send an email to ~sircmpwn/wlroots-announce+subscribe@lists.sr.ht
* to receive these announcements.
*/
#ifndef WLR_UTIL_LOG_H
#define WLR_UTIL_LOG_H
#include <stdbool.h>
2017-06-21 16:10:07 +00:00
#include <stdarg.h>
2017-06-05 02:50:33 +00:00
#include <string.h>
#include <errno.h>
2017-06-21 16:10:07 +00:00
2018-07-09 21:49:54 +00:00
enum wlr_log_importance {
WLR_SILENT = 0,
WLR_ERROR = 1,
WLR_INFO = 2,
WLR_DEBUG = 3,
WLR_LOG_IMPORTANCE_LAST,
};
2017-06-21 16:10:07 +00:00
2018-07-09 21:49:54 +00:00
typedef void (*wlr_log_func_t)(enum wlr_log_importance importance,
const char *fmt, va_list args);
2017-06-21 16:10:07 +00:00
2017-12-31 21:29:05 +00:00
// Will log all messages less than or equal to `verbosity`
// If `callback` is NULL, wlr will use its default logger.
2018-09-03 10:51:49 +00:00
// The function can be called multiple times to update the verbosity or
// callback function.
2018-07-09 21:49:54 +00:00
void wlr_log_init(enum wlr_log_importance verbosity, wlr_log_func_t callback);
// Returns the log verbosity provided to wlr_log_init
enum wlr_log_importance wlr_log_get_verbosity(void);
2017-06-05 02:50:33 +00:00
#ifdef __GNUC__
2018-07-09 21:49:54 +00:00
#define _WLR_ATTRIB_PRINTF(start, end) __attribute__((format(printf, start, end)))
2017-06-05 02:50:33 +00:00
#else
2018-07-09 21:49:54 +00:00
#define _WLR_ATTRIB_PRINTF(start, end)
2017-06-05 02:50:33 +00:00
#endif
2018-07-09 21:49:54 +00:00
void _wlr_log(enum wlr_log_importance verbosity, const char *format, ...) _WLR_ATTRIB_PRINTF(2, 3);
void _wlr_vlog(enum wlr_log_importance verbosity, const char *format, va_list args) _WLR_ATTRIB_PRINTF(2, 0);
const char *_wlr_strip_path(const char *filepath);
2017-06-05 02:50:33 +00:00
#define wlr_log(verb, fmt, ...) \
2018-07-09 21:49:54 +00:00
_wlr_log(verb, "[%s:%d] " fmt, _wlr_strip_path(__FILE__), __LINE__, ##__VA_ARGS__)
2017-06-05 02:50:33 +00:00
#define wlr_vlog(verb, fmt, args) \
2018-07-09 21:49:54 +00:00
_wlr_vlog(verb, "[%s:%d] " fmt, _wlr_strip_path(__FILE__), __LINE__, args)
2017-06-05 02:50:33 +00:00
#define wlr_log_errno(verb, fmt, ...) \
wlr_log(verb, fmt ": %s", ##__VA_ARGS__, strerror(errno))
#endif