Logging facilities

Classes
struct	cv::utils::logging::LogTagAuto

Macros
#define	CV_LOG_LEVEL_SILENT   0
	for using in setLogLevel() call More...
#define	CV_LOG_LEVEL_FATAL   1
	Fatal (critical) error (unrecoverable internal error) More...
#define	CV_LOG_LEVEL_ERROR   2
	Error message. More...
#define	CV_LOG_LEVEL_WARN   3
	Warning message. More...
#define	CV_LOG_LEVEL_INFO   4
	Info message. More...
#define	CV_LOG_LEVEL_DEBUG   5
	Debug message. Disabled in the "Release" build. More...
#define	CV_LOG_LEVEL_VERBOSE   6
	Verbose (trace) messages. Requires verbosity level. Disabled in the "Release" build. More...
#define	CV_LOG_STRIP_LEVEL   CV_LOG_LEVEL_VERBOSE
#define	CV_LOGTAG_PTR_CAST(expr)   static_cast<const cv::utils::logging::LogTag*>(expr)
#define	CV_LOGTAG_EXPAND_NAME(tag)   tag
#define	CV_LOGTAG_FALLBACK   nullptr
#define	CV_LOGTAG_GLOBAL   cv::utils::logging::internal::getGlobalLogTag()
#define	CV_LOG_WITH_TAG(tag, msgLevel, extra_check0, extra_check1, ...)
#define	CV_LOG_FATAL(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_FATAL, , , __VA_ARGS__)
#define	CV_LOG_ERROR(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, , , __VA_ARGS__)
#define	CV_LOG_WARNING(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, , , __VA_ARGS__)
#define	CV_LOG_INFO(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, , , __VA_ARGS__)
#define	CV_LOG_DEBUG(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, , , __VA_ARGS__)
#define	CV_LOG_VERBOSE(tag, v, ...)   CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), , , __VA_ARGS__)
#define	CV_LOG_VERBOSE(tag, v, ...)
#define	CV_LOG_ONCE_ERROR(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)
#define	CV_LOG_ONCE_WARNING(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)
#define	CV_LOG_ONCE_INFO(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)
#define	CV_LOG_ONCE_DEBUG(tag, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)
#define	CV_LOG_ONCE_VERBOSE(tag, v, ...)   CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)
#define	CV_LOG_ONCE_VERBOSE(tag, v, ...)
#define	CV_LOG_IF_FATAL(tag, logging_cond, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_FATAL, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_ERROR(tag, logging_cond, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_WARNING(tag, logging_cond, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_INFO(tag, logging_cond, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_DEBUG(tag, logging_cond, ...)   CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_VERBOSE(tag, v, logging_cond, ...)   CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)
#define	CV_LOG_IF_VERBOSE(tag, v, logging_cond, ...)
#define	CV_TRACE_FUNCTION()
	Macro to trace function. More...
#define	CV_TRACE_FUNCTION_SKIP_NESTED()
#define	CV_TRACE_REGION(name_as_static_string_literal)
#define	CV_TRACE_REGION_NEXT(name_as_static_string_literal)
#define	CV_TRACE_ARG(arg_id)
	Macro to trace argument value. More...
#define	CV_TRACE_ARG_VALUE(arg_id, arg_name, value)
	Macro to trace argument value (expanded version) More...

Functions
CV_EXPORTS LogLevel	cv::utils::logging::setLogLevel (LogLevel logLevel)
CV_EXPORTS LogLevel	cv::utils::logging::getLogLevel ()
CV_EXPORTS void	cv::utils::logging::registerLogTag (cv::utils::logging::LogTag *plogtag)
CV_EXPORTS void	cv::utils::logging::setLogTagLevel (const char *tag, cv::utils::logging::LogLevel level)
CV_EXPORTS cv::utils::logging::LogLevel	cv::utils::logging::getLogTagLevel (const char *tag)

Detailed Description

Macro Definition Documentation

CV_LOG_DEBUG

#define CV_LOG_DEBUG	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, , , __VA_ARGS__)

CV_LOG_ERROR

#define CV_LOG_ERROR	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, , , __VA_ARGS__)

CV_LOG_FATAL

#define CV_LOG_FATAL	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_FATAL, , , __VA_ARGS__)

CV_LOG_IF_DEBUG

#define CV_LOG_IF_DEBUG	(		tag,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_IF_ERROR

#define CV_LOG_IF_ERROR	(		tag,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_IF_FATAL

#define CV_LOG_IF_FATAL	(		tag,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_FATAL, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_IF_INFO

#define CV_LOG_IF_INFO	(		tag,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_IF_VERBOSE [1/2]

#define CV_LOG_IF_VERBOSE	(		tag,
			v,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_IF_VERBOSE [2/2]

#define CV_LOG_IF_VERBOSE	(		tag,
			v,
			logging_cond,
			...
	)

CV_LOG_IF_WARNING

#define CV_LOG_IF_WARNING	(		tag,
			logging_cond,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, , CV__LOG_IF_CHECK(logging_cond), __VA_ARGS__)

CV_LOG_INFO

#define CV_LOG_INFO	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, , , __VA_ARGS__)

CV_LOG_LEVEL_DEBUG

#define CV_LOG_LEVEL_DEBUG   5

Debug message. Disabled in the "Release" build.

CV_LOG_LEVEL_ERROR

#define CV_LOG_LEVEL_ERROR   2

Error message.

CV_LOG_LEVEL_FATAL

#define CV_LOG_LEVEL_FATAL   1

Fatal (critical) error (unrecoverable internal error)

CV_LOG_LEVEL_INFO

#define CV_LOG_LEVEL_INFO   4

Info message.

CV_LOG_LEVEL_SILENT

#define CV_LOG_LEVEL_SILENT   0

for using in setLogLevel() call

CV_LOG_LEVEL_VERBOSE

#define CV_LOG_LEVEL_VERBOSE   6

Verbose (trace) messages. Requires verbosity level. Disabled in the "Release" build.

CV_LOG_LEVEL_WARN

#define CV_LOG_LEVEL_WARN   3

Warning message.

CV_LOG_ONCE_DEBUG

#define CV_LOG_ONCE_DEBUG	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_DEBUG, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)

CV_LOG_ONCE_ERROR

#define CV_LOG_ONCE_ERROR	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_ERROR, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)

CV_LOG_ONCE_INFO

#define CV_LOG_ONCE_INFO	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_INFO, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)

CV_LOG_ONCE_VERBOSE [1/2]

#define CV_LOG_ONCE_VERBOSE	(		tag,
			v,
			...
	)		CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)

CV_LOG_ONCE_VERBOSE [2/2]

#define CV_LOG_ONCE_VERBOSE	(		tag,
			v,
			...
	)

CV_LOG_ONCE_WARNING

#define CV_LOG_ONCE_WARNING	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, CV__LOG_ONCE_CHECK_PRE, CV__LOG_ONCE_CHECK_POST, __VA_ARGS__)

CV_LOG_STRIP_LEVEL

#define CV_LOG_STRIP_LEVEL   CV_LOG_LEVEL_VERBOSE

Define CV_LOG_STRIP_LEVEL=CV_LOG_LEVEL_[DEBUG|INFO|WARN|ERROR|FATAL|SILENT] to compile out anything at that and before that logging level

CV_LOG_VERBOSE [1/2]

#define CV_LOG_VERBOSE	(		tag,
			v,
			...
	)		CV_LOG_WITH_TAG(tag, (cv::utils::logging::LOG_LEVEL_VERBOSE + (int)(v)), , , __VA_ARGS__)

CV_LOG_VERBOSE [2/2]

#define CV_LOG_VERBOSE	(		tag,
			v,
			...
	)

CV_LOG_WARNING

#define CV_LOG_WARNING	(		tag,
			...
	)		CV_LOG_WITH_TAG(tag, cv::utils::logging::LOG_LEVEL_WARNING, , , __VA_ARGS__)

CV_LOG_WITH_TAG

#define CV_LOG_WITH_TAG	(		tag,
			msgLevel,
			extra_check0,
			extra_check1,
			...
	)

Value:

    for(;;) { \
        extra_check0; \
        const auto cv_temp_msglevel = (cv::utils::logging::LogLevel)(msgLevel); \
        if (cv_temp_msglevel >= (CV_LOG_STRIP_LEVEL)) break; \
        auto cv_temp_logtagptr = CV_LOGTAG_PTR_CAST(CV_LOGTAG_EXPAND_NAME(tag)); \
        if (!cv_temp_logtagptr) cv_temp_logtagptr = CV_LOGTAG_PTR_CAST(CV_LOGTAG_FALLBACK); \
        if (!cv_temp_logtagptr) cv_temp_logtagptr = CV_LOGTAG_PTR_CAST(CV_LOGTAG_GLOBAL); \
        if (cv_temp_logtagptr && (cv_temp_msglevel > cv_temp_logtagptr->level)) break; \
        extra_check1; \
        std::stringstream cv_temp_logstream; \
        cv_temp_logstream << __VA_ARGS__; \
        cv::utils::logging::internal::writeLogMessageEx( \
            cv_temp_msglevel, \
            (cv_temp_logtagptr ? cv_temp_logtagptr->name : nullptr), \
            __FILE__, \
            __LINE__, \
            CV_Func, \
            cv_temp_logstream.str().c_str()); \
        break; \
    }

CV_LOGTAG_EXPAND_NAME

#define CV_LOGTAG_EXPAND_NAME

(

tag

)

tag

CV_LOGTAG_FALLBACK

#define CV_LOGTAG_FALLBACK   nullptr

CV_LOGTAG_GLOBAL

#define CV_LOGTAG_GLOBAL   cv::utils::logging::internal::getGlobalLogTag()

CV_LOGTAG_PTR_CAST

#define CV_LOGTAG_PTR_CAST

(

expr

)

static_cast<const cv::utils::logging::LogTag*>(expr)

CV_TRACE_ARG

#define CV_TRACE_ARG

(

arg_id

)

Macro to trace argument value.

CV_TRACE_ARG_VALUE

#define CV_TRACE_ARG_VALUE	(		arg_id,
			arg_name,
			value
	)

Macro to trace argument value (expanded version)

CV_TRACE_FUNCTION

#define CV_TRACE_FUNCTION

(

)

Macro to trace function.

CV_TRACE_FUNCTION_SKIP_NESTED

#define CV_TRACE_FUNCTION_SKIP_NESTED

(

)

CV_TRACE_REGION

#define CV_TRACE_REGION

(

name_as_static_string_literal

)

Trace code scope.

Note

Dynamic names are not supported in this macro (on stack or heap). Use string literals here only, like "initialize".

CV_TRACE_REGION_NEXT

#define CV_TRACE_REGION_NEXT

(

name_as_static_string_literal

)

mark completed of the current opened region and create new one

Note

Dynamic names are not supported in this macro (on stack or heap). Use string literals here only, like "step1".

Function Documentation

getLogLevel()

CV_EXPORTS LogLevel cv::utils::logging::getLogLevel

(

)

Get global logging level

getLogTagLevel()

CV_EXPORTS cv::utils::logging::LogLevel cv::utils::logging::getLogTagLevel

(

const char *

tag

)

registerLogTag()

CV_EXPORTS void cv::utils::logging::registerLogTag

(

cv::utils::logging::LogTag *

plogtag

)

setLogLevel()

CV_EXPORTS LogLevel cv::utils::logging::setLogLevel

(

LogLevel

logLevel

)

Set global logging level

Returns

previous logging level

setLogTagLevel()

CV_EXPORTS void cv::utils::logging::setLogTagLevel	(	const char *	tag,
		cv::utils::logging::LogLevel	level
	)