clogger  Version 2.1.1
API Reference for clogger
core.h File Reference

Common types and macros used in the library. More...

Data Structures

struct  CLoggerConsoleColour
 Data structure representing a pair of colours used for text in the terminal/console. More...
 
struct  CLogger
 Data structure representing a clogger More...
 

Macros

#define CLOGGER_TRUE   (CLoggerBool) 1
 
#define CLOGGER_FALSE   (CLoggerBool) 0
 
#define CLOGGER_COLOR_CLEAR   CLOGGER_COLOUR_CLEAR
 
#define CLOGGER_COLOR_BLACK   CLOGGER_COLOUR_BLACK
 
#define CLOGGER_COLOR_RED   CLOGGER_COLOUR_RED
 
#define CLOGGER_COLOR_GREEN   CLOGGER_COLOUR_GREEN
 
#define CLOGGER_COLOR_YELLOW   CLOGGER_COLOUR_YELLOW
 
#define CLOGGER_COLOR_BLUE   CLOGGER_COLOUR_BLUE
 
#define CLOGGER_COLOR_MAGENTA   CLOGGER_COLOUR_MAGENTA
 
#define CLOGGER_COLOR_CYAN   CLOGGER_COLOUR_CYAN
 
#define CLOGGER_COLOR_WHITE   CLOGGER_COLOUR_WHITE
 

Typedefs

typedef int8_t CLoggerInt8
 
typedef int16_t CLoggerInt16
 
typedef int32_t CLoggerInt32
 
typedef int64_t CLoggerInt64
 
typedef uint8_t CLoggerUInt8
 
typedef uint16_t CLoggerUInt16
 
typedef uint32_t CLoggerUInt32
 
typedef uint64_t CLoggerUInt64
 
typedef size_t CLoggerSize
 
typedef CLoggerUInt8 CLoggerBool
 
typedef CLoggerColour CLoggerColor
 US English variant of CLoggerColour.
 
typedef CLoggerConsoleColour CLoggerConsoleColor
 US English variant of CLoggerConsoleColour.
 

Enumerations

enum  CLoggerLevel {
  CLOGGER_LEVEL_MESSAGE, CLOGGER_LEVEL_INFO, CLOGGER_LEVEL_DEBUG, CLOGGER_LEVEL_WARNING,
  CLOGGER_LEVEL_ERROR, CLOGGER_LEVEL_CRITICAL, CLOGGER_LEVEL_FATAL_ASSERT, CLOGGER_LEVEL_NON_FATAL_ASSERT
}
 Enum representing the log message level. More...
 
enum  CLoggerColour {
  CLOGGER_COLOUR_CLEAR, CLOGGER_COLOUR_BLACK, CLOGGER_COLOUR_RED, CLOGGER_COLOUR_GREEN,
  CLOGGER_COLOUR_YELLOW, CLOGGER_COLOUR_BLUE, CLOGGER_COLOUR_MAGENTA, CLOGGER_COLOUR_CYAN,
  CLOGGER_COLOUR_WHITE
}
 Enum representing colours.
 

Detailed Description

Common types and macros used in the library.

Enumeration Type Documentation

◆ CLoggerLevel

Enum representing the log message level.

Enumerator
CLOGGER_LEVEL_MESSAGE 

Standard level, not of particular interest.

CLOGGER_LEVEL_INFO 

INFO level

CLOGGER_LEVEL_DEBUG 

DEBUG level

CLOGGER_LEVEL_WARNING 

WARNING level

CLOGGER_LEVEL_ERROR 

ERROR level

CLOGGER_LEVEL_CRITICAL 

CRITICAL level

CLOGGER_LEVEL_FATAL_ASSERT 

A failed assertion that should abort the program.

CLOGGER_LEVEL_NON_FATAL_ASSERT 

A failed assertion that should keep calm and carry on.