Data Structures
struct	GblLoggerClass

struct	GblLogger

Macros
Type System
Type UUID and cast operators
#define	GBL_LOGGER_TYPE

#define	GBL_LOGGER(self)

#define	GBL_LOGGER_CLASS(klass)

#define	GBL_LOGGER_GET_CLASS(self)

Logging Macros
Top-level macros used with logging system
#define	GBL_LOG_WRITE(flags, domain, ...)

#define	GBL_LOG_DEBUG(domain, ...)

#define	GBL_LOG_VERBOSE(domain, ...)

#define	GBL_LOG_INFO(domain, ...)

#define	GBL_LOG_WARN(domain, ...)

#define	GBL_LOG_ERROR(domain, ...)

#define	GBL_LOG_PUSH()

#define	GBL_LOG_POP(n)

Typedefs
typedef GblBool(*	GblLoggerIterFn) (GblLogger pLogger, void pClosure)

typedef GblFlags	GBL_LOG_FLAGS

Enumerations
enum	GBL_LOG_FLAGS

Functions
GblType	GblLogger_type (void)

GBL_RESULT	GblLogger_register (GblLogger *pLogger)

GBL_RESULT	GblLogger_unregister (GblLogger *pLogger)

GblBool	GblLogger_foreach (GblLoggerIterFn pIt, void *pClosure)

GBL_RESULT	GblLogger_push (void)

GBL_RESULT	GblLogger_pop (size_t count)

size_t	GblLogger_depth (void)

GBL_RESULT	GblLogger_write (const char pFile, const char pFunction, size_t line, const char pDomain, GBL_LOG_FLAGS flags, const char pFmt,...)

GBL_RESULT	GblLogger_writeVa (const char pFile, const char pFunction, size_t line, const char pDomain, GBL_LOG_FLAGS flags, const char pFmt, va_list varArgs)

GblLogger *	GblLogger_create (GblType derived, size_t allocSize, GblLoggerClass *pClass)

GBL_RESULT	GblLogger_construct (GblLogger pSelf, GblType derived, GblLoggerClass pClass)

GblRefCount	GblLogger_unref (GblLogger *pSelf)

GblBool	GblLogger_hasFilter (const GblLogger pSelf, const GblThd pThread, const char *pDomain, GBL_LOG_FLAGS flags)

GBL_RESULT	GblLogger_setDomainFilters (GblLogger pSelf, const char domains[])

const char **	GblLogger_domainFilters (const GblLogger *pSelf)

GblBool	GblLogger_hasDomainFilter (const GblLogger pSelf, const char pDomain)

GBL_RESULT	GblLogger_setThreadFilters (GblLogger pSelf, const GblThd pThrs[])

const GblThd **	GblLogger_threadFilters (const GblLogger *pSelf)

GblBool	GblLogger_hasThreadFilter (const GblLogger pSelf, const GblThd pThr)

Detailed Description

GblLogger filterable log and logging macros.

This file provides the public API for creating and managing custom logger types as well as the utility macros for actually using the log system.

Todo:

migrate away from GblThd and towards GblThread
Spam filter: deduplicate messages within a certain interval
Default constructor values

Author: 2023 Falco Girgis

Copyright: MIT License

Definition in file gimbal_logger.h.

Macro Definition Documentation

◆ GBL_LOGGER_TYPE

#define GBL_LOGGER_TYPE

Type UUID for GblLogger.

Definition at line 29 of file gimbal_logger.h.

◆ GBL_LOGGER

#define GBL_LOGGER ( self )

Function-style cast to GblLogger.

Definition at line 30 of file gimbal_logger.h.

◆ GBL_LOGGER_CLASS

#define GBL_LOGGER_CLASS ( klass )

Function-style cast to GblLoggerClass.

Definition at line 31 of file gimbal_logger.h.

◆ GBL_LOGGER_GET_CLASS

#define GBL_LOGGER_GET_CLASS ( self )

Get GblLoggerClass from GblLogger.

Definition at line 32 of file gimbal_logger.h.

◆ GBL_LOG_WRITE

#define GBL_LOG_WRITE	(	flags,
		domain,
		...
	)

Generalized log write operation/*#end#*‍/.

Definition at line 41 of file gimbal_logger.h.

◆ GBL_LOG_DEBUG

#define GBL_LOG_DEBUG	(	domain,
		...
	)

Writes to log with GBL_LOG_DEBUG.

Definition at line 42 of file gimbal_logger.h.

◆ GBL_LOG_VERBOSE

#define GBL_LOG_VERBOSE	(	domain,
		...
	)

Writes to log with GBL_LOG_VERBOSE.

Definition at line 43 of file gimbal_logger.h.

◆ GBL_LOG_INFO

#define GBL_LOG_INFO	(	domain,
		...
	)

Writes to log with GBL_LOG_INFO.

Definition at line 44 of file gimbal_logger.h.

◆ GBL_LOG_WARN

#define GBL_LOG_WARN	(	domain,
		...
	)

Writes to log with GBL_LOG_WARN.

Definition at line 45 of file gimbal_logger.h.

◆ GBL_LOG_ERROR

#define GBL_LOG_ERROR	(	domain,
		...
	)

Writes to log with GBL_LOG_ERROR.

Definition at line 46 of file gimbal_logger.h.

◆ GBL_LOG_PUSH

#define GBL_LOG_PUSH ( )

Pushes level to log stack.

Definition at line 47 of file gimbal_logger.h.

◆ GBL_LOG_POP

#define GBL_LOG_POP ( n )

Pops N levels from log stack.

Definition at line 48 of file gimbal_logger.h.

Typedef Documentation

◆ GblLoggerIterFn

typedef GblBool(* GblLoggerIterFn) (GblLogger *pLogger, void *pClosure)

Function signature for iterating over all loggers (see GblLogger_foreach())

Definition at line 58 of file gimbal_logger.h.

◆ GBL_LOG_FLAGS

typedef GblFlags GBL_LOG_FLAGS

Flags used to tag a message or message filter.

Definition at line 61 of file gimbal_logger.h.

Enumeration Type Documentation

◆ GBL_LOG_FLAGS

enum GBL_LOG_FLAGS

Enumerator
GBL_LOG_REENTRANT	Denotes a GblLogger's virtual methods are reentrant.
GBL_LOG_DEBUG	Denotes a "debug" level message, which is typically disabled.
GBL_LOG_VERBOSE	Denotes a "verbose" level message, which is regular-level.
GBL_LOG_INFO	Denotes an "info" message, which is typically used for noteworthy events.
GBL_LOG_WARN	Denotes a "warning" message, which means a potential issue has arisen.
GBL_LOG_ERROR	Denotes an "error" message, which means something has failed.
GBL_LOG_USER	Denotess the first flag which can be used for arbitrary userdata.

Definition at line 61 of file gimbal_logger.h.

              {
            GblLinkedListNode listNode;    //!< Internal generic list node
            GblLogger*        pNext;       //!< Internal pointer to next logger in list
        };
        GblBool               reentrant;   //!< Whether the logger is already handling a messaage
    GBL_PRIVATE_END
    GblFlags                  flagsFilter; //!< Combination of GBL_LOG_FLAGS to filter messages for
GBL_INSTANCE_END
 
//! \cond
GBL_PROPERTIES(GblLogger,
    (flagsFilter,   GBL_GENERIC, (READ, WRITE), GBL_FLAGS_TYPE),
    (threadFilters, GBL_GENERIC, (READ, WRITE), GBL_POINTER_TYPE),
    (domainFilters, GBL_GENERIC, (READ, WRITE), GBL_POINTER_TYPE)
)
//! \endcond
 
// ===== Static Methods =====
GBL_EXPORT GblType      GblLogger_type             (void)                     GBL_NOEXCEPT;
GBL_EXPORT GBL_RESULT   GblLogger_register         (GblLogger* pLogger)       GBL_NOEXCEPT;
GBL_EXPORT GBL_RESULT   GblLogger_unregister       (GblLogger* pLogger)       GBL_NOEXCEPT;
 
GBL_EXPORT GblBool      GblLogger_foreach          (GblLoggerIterFn pIt,
                                                    void*           pClosure) GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_push             (void)                     GBL_NOEXCEPT;
GBL_EXPORT GBL_RESULT   GblLogger_pop              (size_t  count)            GBL_NOEXCEPT;
GBL_EXPORT size_t       GblLogger_depth            (void)                     GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_write            (const char*   pFile,
                                                    const char*   pFunction,
                                                    size_t        line,
                                                    const char*   pDomain,
                                                    GBL_LOG_FLAGS flags,
                                                    const char*   pFmt,
                                                    ...)                      GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_writeVa          (const char*   pFile,
                                                    const char*   pFunction,
                                                    size_t        line,
                                                    const char*   pDomain,
                                                    GBL_LOG_FLAGS flags,
                                                    const char*   pFmt,
                                                    va_list       varArgs)    GBL_NOEXCEPT;
// ===== Instance Methods =====
GBL_EXPORT GblLogger*   GblLogger_create           (GblType         derived,
                                                    size_t          allocSize,
                                                    GblLoggerClass* pClass)   GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_construct        (GBL_SELF,
                                                    GblType         derived,
                                                    GblLoggerClass* pClass)   GBL_NOEXCEPT;
 
GBL_EXPORT GblRefCount  GblLogger_unref            (GBL_SELF)                 GBL_NOEXCEPT;
 
GBL_EXPORT GblBool      GblLogger_hasFilter        (GBL_CSELF,
                                                    const GblThd*    pThread,
                                                    const char*      pDomain,
                                                    GBL_LOG_FLAGS    flags)   GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_setDomainFilters (GBL_SELF,
                                                    const char* domains[])    GBL_NOEXCEPT;
 
GBL_EXPORT const char** GblLogger_domainFilters    (GBL_CSELF)                GBL_NOEXCEPT;
 
GBL_EXPORT GblBool      GblLogger_hasDomainFilter  (GBL_CSELF,
                                                    const char* pDomain)      GBL_NOEXCEPT;
 
GBL_EXPORT GBL_RESULT   GblLogger_setThreadFilters (GBL_SELF,
                                                    const GblThd* pThrs[])    GBL_NOEXCEPT;
 
GBL_EXPORT const GblThd**
                        GblLogger_threadFilters    (GBL_CSELF)                GBL_NOEXCEPT;
 
GBL_EXPORT GblBool      GblLogger_hasThreadFilter  (GBL_CSELF,
                                                    const GblThd* pThr)       GBL_NOEXCEPT;
 
GBL_DECLS_END
 
#undef GBL_SELF_TYPE
 
#endif // GIMBAL_LOGGER_H

Data Structures

Macros

Typedefs

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ GBL_LOGGER_TYPE

◆ GBL_LOGGER

◆ GBL_LOGGER_CLASS

◆ GBL_LOGGER_GET_CLASS

◆ GBL_LOG_WRITE

◆ GBL_LOG_DEBUG

◆ GBL_LOG_VERBOSE

◆ GBL_LOG_INFO

◆ GBL_LOG_WARN

◆ GBL_LOG_ERROR

◆ GBL_LOG_PUSH

◆ GBL_LOG_POP

Typedef Documentation

◆ GblLoggerIterFn

◆ GBL_LOG_FLAGS

Enumeration Type Documentation

◆ GBL_LOG_FLAGS