sbgl_internal_log.h File Reference

#include <stdbool.h>
#include <stdint.h>
#include <stddef.h>

Include dependency graph for sbgl_internal_log.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures
struct	sbgl_LogConfig
	Logging configuration. More...

Macros
#define	sbgl_log_impl(level, category, msg)

Enumerations
enum	sbgl_LogLevel {   SBGL_LOG_DEBUG = 0 , SBGL_LOG_INFO = 1 , SBGL_LOG_WARN = 2 , SBGL_LOG_ERROR = 3 ,   SBGL_LOG_CRITICAL = 4 }
	Logging severity levels. More...
enum	sbgl_LogCategory {   SBGL_LOG_CAT_CORE = 0 , SBGL_LOG_CAT_PLATFORM = 1 , SBGL_LOG_CAT_GFX = 2 , SBGL_LOG_CAT_INPUT = 3 ,   SBGL_LOG_CAT_VOXEL = 4 , SBGL_LOG_CAT_COUNT = 5 }
	Logging categories for component filtering. More...

Functions
void	sbgl_internal_log_impl (sbgl_LogLevel level, sbgl_LogCategory category, const char *file, int line, const char *function, const char *message)
void	sbgl_LogSetLevel (sbgl_LogLevel minLevel)
void	sbgl_LogSetOutput (const char *path)
void	sbgl_LogSetFileRotation (uint32_t maxFiles, size_t maxSize)
const char *	sbgl_ResultToString (int result)
const char *	sbgl_VkResultToString (int32_t vkResult)

Macro Definition Documentation

sbgl_log_impl

#define sbgl_log_impl	(		level,
			category,
			msg )

Value:

    sbgl_internal_log_impl(level, category, __FILE__, __LINE__, __func__, msg)

Definition at line 52 of file sbgl_internal_log.h.

#define sbgl_log_impl(level, category, msg) \
    sbgl_internal_log_impl(level, category, __FILE__, __LINE__, __func__, msg)

Enumeration Type Documentation

sbgl_LogCategory

enum sbgl_LogCategory

Logging categories for component filtering.

Enumerator
SBGL_LOG_CAT_CORE
SBGL_LOG_CAT_PLATFORM
SBGL_LOG_CAT_GFX
SBGL_LOG_CAT_INPUT
SBGL_LOG_CAT_VOXEL
SBGL_LOG_CAT_COUNT

Definition at line 22 of file sbgl_internal_log.h.

             {
  SBGL_LOG_CAT_CORE = 0,
  SBGL_LOG_CAT_PLATFORM = 1,
  SBGL_LOG_CAT_GFX = 2,
  SBGL_LOG_CAT_INPUT = 3,
  SBGL_LOG_CAT_VOXEL = 4,
  SBGL_LOG_CAT_COUNT = 5,
} sbgl_LogCategory;

sbgl_LogLevel

enum sbgl_LogLevel

Logging severity levels.

Enumerator
SBGL_LOG_DEBUG
SBGL_LOG_INFO
SBGL_LOG_WARN
SBGL_LOG_ERROR
SBGL_LOG_CRITICAL

Definition at line 11 of file sbgl_internal_log.h.

             {
  SBGL_LOG_DEBUG = 0,
  SBGL_LOG_INFO = 1,
  SBGL_LOG_WARN = 2,
  SBGL_LOG_ERROR = 3,
  SBGL_LOG_CRITICAL = 4,
} sbgl_LogLevel;

Function Documentation

sbgl_internal_log_impl()

void sbgl_internal_log_impl	(	sbgl_LogLevel	level,
		sbgl_LogCategory	category,
		const char *	file,
		int	line,
		const char *	function,
		const char *	message )

Definition at line 116 of file sbgl_log.c.

  {
  if (level < s_config.minLevel) return;
  if (!((1u << category) & s_config.categoryMask)) return;
 
  time_t now = time(NULL);
  struct tm* tm_info = localtime(&now);
  char time_buf[32];
  strftime(time_buf, sizeof(time_buf), "%Y-%m-%d %H:%M:%S", tm_info);
 
  char out[1024];
  int len = snprintf(out, sizeof(out), "[%s] [%s] [%s] %s:%d (%s): %s\n",
    time_buf,
    level_strings[level],
    category_strings[category],
    file,
    line,
    function,
    message
  );
 
  if (len < 0) return;
 
  if (s_config.fileEnabled) {
    if (!s_file) {
      open_log_file();
    }
 
    if (s_file) {
      if (ftell(s_file) > (long)s_config.maxFileSize) {
        rotate_logs();
        open_log_file();
      }
 
      if (s_file) {
        fwrite(out, 1, len, s_file);
        fflush(s_file);
      }
    }
  }
 
  FILE* dst = (level >= SBGL_LOG_ERROR) ? stderr : stdout;
  fwrite(out, 1, len, dst);
}

sbgl_LogSetFileRotation()

void sbgl_LogSetFileRotation	(	uint32_t	maxFiles,
		size_t	maxSize )

Definition at line 186 of file sbgl_log.c.

                                                                    {
  s_config.maxFiles = maxFiles;
  s_config.maxFileSize = maxFileSize;
}

sbgl_LogSetLevel()

void sbgl_LogSetLevel

(

sbgl_LogLevel

minLevel

)

Definition at line 167 of file sbgl_log.c.

                                              {
  s_config.minLevel = minLevel;
}

sbgl_LogSetOutput()

void sbgl_LogSetOutput

(

const char *

path

)

Definition at line 171 of file sbgl_log.c.

                                         {
  if (!path) {
    s_config.fileEnabled = false;
    if (s_file) {
      fclose(s_file);
      s_file = NULL;
    }
    return;
  }
 
  s_config.fileEnabled = true;
  s_config.filePath = path;
  open_log_file();
}

sbgl_ResultToString()

const char * sbgl_ResultToString

(

int

result

)

Definition at line 191 of file sbgl_log.c.

                                            {
  if (result >= 0 && result < (int)(sizeof(SBGL_RESULT_STRINGS) / sizeof(SBGL_RESULT_STRINGS[0]))) {
    return SBGL_RESULT_STRINGS[result];
  }
  return "SBGL_UNKNOWN_ERROR";
}

sbgl_VkResultToString()

const char * sbgl_VkResultToString

(

int32_t

vkResult

)

Definition at line 198 of file sbgl_log.c.

                                                    {
  for (int i = 0; i < VK_RESULT_COUNT; i++) {
    if (VK_RESULT_CODES[i] == vkResult) {
      return VK_RESULT_STRINGS[i];
    }
  }
  return "VK_UNKNOWN";
}