LogManager.h

Go to the documentation of this file.

#pragma once
 
#include "../StringView.h"
 
#include <cstdarg>
 
#if defined( _MSC_VER )
  #define VALIDATE_ARGS(a)
#else
  #define _Printf_format_string_
  #define VALIDATE_ARGS(a)           __attribute__((format(printf, a, a+1)))
#endif
 
namespace Cogs
{
  namespace Logging
  {
    using LoggerCallback = void(const char* message, const char* source, int category);
 
    using FileLineLoggerCallback = void(const char* file, int line, const char* message, const char* source, int category);
 
    enum class Category
    {
      Trace = 0,
      Debug,
      Info,
      Warning,
      Error,
      Fatal
    };
 
    enum ErrorGroup : uint32_t {
      Unspecified,                              
 
      // Cogs.Foundation systems should add new values to this first section...
      FirstFoundation         = 0x00100000,
      FoundationIO            = 0x00110000,
      FoundationModule        = 0x00120000,
      FoundationNetwork       = 0x00130000,
 
      // Cogs.Rendering modules belong in this section...
      FirstRendering          = 0x01000000,
 
      // Cogs.Core should define additional IDs in this section...
      FirstCore               = 0x10000000,
 
      // Cogs.Desktop can define group IDs here...
      FirstDesktop            = 0x20000000,
 
      // Cogs.Terrain related systems...
      FirstTerrain            = 0x30000000,
 
      // Known Cogs.Core extensions should use this section...
      FirstCoreExtension      = 0x40000000,
 
      // External Cogs.Core extensions should define their own system IDs above this value...
      // (But lower than FirstThirdParty, obviously.)
      FirstExternalExtension  = 0x90000000,
 
      // Third party libraries (or users of them) can use group IDs from this section...
      FirstThirdParty         = 0xB0000000,
      NvidiaCUDA              = 0xB0010000,     
      NvidiaNvEnc             = 0xB0020000,     
      LibSRT                  = 0xB0030000,     
 
      // Application specific systems should define group IDs above this value...
      FirstApplication        = 0xC0000000,
    };
 
    class Consumer;
 
    void COGSFOUNDATION_API setLoggerCategory(Category category);
 
    void COGSFOUNDATION_API updateLoggerCategory(Category category);
 
    void updateMinimumCategory();
 
    void COGSFOUNDATION_API enableUnhandledExceptionLogging();
 
    void COGSFOUNDATION_API registerConsumer(Consumer* consumer);
 
    void COGSFOUNDATION_API unregisterConsumer(Consumer* consumer);
 
    void COGSFOUNDATION_API log(const char* message, const char* source, const Category category, uint32_t errorNumber);
 
    void COGSFOUNDATION_API log(const char* source, const Category category, uint32_t errorNumber, _Printf_format_string_ const char * fmt, ...) VALIDATE_ARGS(4);
 
    void COGSFOUNDATION_API logFileLine(const char* file, const int line, const char* source, const Category category, uint32_t errorNumber, _Printf_format_string_ const char * fmt, ...) VALIDATE_ARGS(6);
 
    void COGSFOUNDATION_API logArgs(const char* source, const Category category, uint32_t errorNumber, const char * fmt, va_list args);
 
    void COGSFOUNDATION_API logFileLineArgs(const char* file, const int line, const char * source, const Category category, uint32_t errorNumber, const char * fmt, va_list args);
 
    Category COGSFOUNDATION_API parseCategoryString(const StringView category);
 
    bool COGSFOUNDATION_API isErrorGroup(uint32_t errorNumber, ErrorGroup group);
 
    class COGSFOUNDATION_API Log
    {
    public:
      template<size_t LEN>
      constexpr explicit Log(const char(&n)[LEN]) noexcept : literalName(n) {}
 
      void logFileLine(const char* file, const int line, const Category category, uint32_t errorNumber, _Printf_format_string_ const char * fmt, ...) const VALIDATE_ARGS(6)
      {
        va_list argptr;
        va_start(argptr, fmt);
        Cogs::Logging::logFileLineArgs(file, line, getName(), category, errorNumber, fmt, argptr);
        va_end(argptr);
      }
 
      void log(const Category category, uint32_t errorNumber, _Printf_format_string_ const char * fmt, ...) const VALIDATE_ARGS(4)
      {
        va_list argptr;
        va_start(argptr, fmt);
        Cogs::Logging::logArgs(getName(), category, errorNumber, fmt, argptr);
        va_end(argptr);
      }
 
      [[nodiscard]] constexpr const char* getName() const noexcept {
        return literalName;
      }
 
    protected:
      const char* literalName = nullptr;
 
      Log() = default;
    };
 
    template<size_t LEN>
    constexpr Log getLogger(const char(&name)[LEN]) noexcept { return Log(name); }
  }
}