cohtml::Logging

Classes

Name
classcohtml::Logging::ILogHandler
Interface to allow custom logging.
structcohtml::Logging::LoggingSettings
Controls filtering of categorized log messages. Used during library initialization to specify which TargetUser and MessageType categories should be emitted by the logger. By default all categories are enabled and MinimumSeverity is Info.
structcohtml::Logging::LogInfo
Describes the metadata associated with a log message.

Types

Name
enum class unsignedTargetUser { None = 0, Internal = 1 « 0, Content = 1 « 1, Integration = 1 « 2, All = Internal
enum class unsignedMessageType { None = 0, General = 1 « 0, Internal = 1 « 1, Rendering = 1 « 2, PerformanceHint = 1 « 3, UsageHint = 1 « 4, Compatibility = 1 « 5, Deprecation = 1 « 6, ScriptOutput = 1 « 7, Binding = 1 « 8, All = General
enumSeverity { Trace = 0, Debug = 1, Info = 2, Warning = 3, Error = 4, AssertFailure = 5, Critical = 5, SeveritiesCount = 6}

Functions

Name
COHTML_DEFINE_ENUM_FLAG_OPERATORS(cohtml::Logging::TargetUser )
COHTML_DEFINE_ENUM_FLAG_OPERATORS(cohtml::Logging::MessageType )

Types Documentation

enum TargetUser

EnumeratorValueDescription
None0No audiences enabled. Suppresses all log output when used as EnabledTargetUsers.
Internal1 « 0Intended for developers of the Cohtml & Renoir libraries, mainly useful for debugging.
Content1 « 1Diagnostics intended for authors of HTML/CSS/JS UI content.
Integration1 « 2Diagnostics intended for engine developers responsible for integrating Cohtml.
AllInternalContent

Identifies the primary audience for a diagnostic Values can be combined as bit flags to filter logs for multiple audiences in LoggingSettings - EnabledTargetUsers.

enum MessageType

EnumeratorValueDescription
None0No message categories enabled. Suppresses all log output when used as EnabledMessageTypes.
General1 « 0General-purpose diagnostic with no specific category.
Internal1 « 1Diagnostic category for internal development and troubleshooting.
Rendering1 « 2Diagnostic related to rendering-specific behavior or the Renoir rendering library.
PerformanceHint1 « 3Advisory diagnostic related to performance or memory cost.
UsageHint1 « 4Advisory diagnostic about recommended or correct usage.
Compatibility1 « 5Diagnostic related to platform, specification, or feature support differences.
Deprecation1 « 6Diagnostic indicating use of deprecated functionality.
ScriptOutput1 « 7Output from JavaScript console methods (console.log, console.warn, etc.)
Binding1 « 8Diagnostics related to the binding/data-binding features of Cohtml.
AllGeneralInternal

Describes the kind of diagnostic independently of severity and audience Values can be combined as bit flags to filter logs for multiple diagnostic categories in LoggingSettings - EnabledMessageTypes.

enum Severity

EnumeratorValueDescription
Trace0
Debug1
Info2
Warning3
Error4
AssertFailure5
Critical5
SeveritiesCount6

Functions Documentation

function COHTML_DEFINE_ENUM_FLAG_OPERATORS

COHTML_DEFINE_ENUM_FLAG_OPERATORS(
    cohtml::Logging::TargetUser 
)

function COHTML_DEFINE_ENUM_FLAG_OPERATORS

COHTML_DEFINE_ENUM_FLAG_OPERATORS(
    cohtml::Logging::MessageType 
)