#include "KIM_FunctionTypes.h"

Include dependency graph for KIM_Log.h:

Typedefs
typedef struct KIM_LogVerbosity	KIM_LogVerbosity
	Forward declaration. More...

typedef struct KIM_LanguageName	KIM_LanguageName
	Forward declaration. More...

typedef struct KIM_Log	KIM_Log
	Provides the logging interface for the KIM API. More...

Functions
int	KIM_Log_Create (KIM_Log **const log)
	Create a new KIM API Log object. More...

void	KIM_Log_Destroy (KIM_Log **const log)
	Destroy a previously Log::Create'd object. More...

void	KIM_Log_PushDefaultVerbosity (KIM_LogVerbosity const logVerbosity)
	Push a new default LogVerbosity onto the KIM API global default verbosity stack. More...

void	KIM_Log_PopDefaultVerbosity ()
	Pop a LogVerbosity from the KIM API global default verbosity stack. More...

void	KIM_Log_PushDefaultPrintFunction (KIM_LanguageName const languageName, KIM_Function *const fptr)
	Push a new default log PrintFunction onto the KIM API global default log PrintFunction stack. More...

void	KIM_Log_PopDefaultPrintFunction ()
	Pop a log PrintFunction from the KIM API global default log PrintFunction stack. More...

char const *	KIM_Log_GetID (KIM_Log const *const log)
	Get the identity of the Log object. More...

void	KIM_Log_SetID (KIM_Log const log, char const const id)
	Set the identity of the Log object. More...

void	KIM_Log_PushVerbosity (KIM_Log *const log, KIM_LogVerbosity const logVerbosity)
	Push a new LogVerbosity onto the Log object's verbosity stack. More...

void	KIM_Log_PopVerbosity (KIM_Log *const log)
	Pop a LogVerbosity from the Log object's verbosity stack. More...

void	KIM_Log_LogEntry (KIM_Log const const log, KIM_LogVerbosity const logVerbosity, char const const message, int const lineNumber, char const *const fileName)
	Write a log entry into the log file. More...

Typedef Documentation

◆ KIM_LanguageName

typedef struct KIM_LanguageName KIM_LanguageName

Forward declaration.

Since: 2.2

Definition at line 56 of file KIM_Log.h.

◆ KIM_Log

typedef struct KIM_Log KIM_Log

Provides the logging interface for the KIM API.

See also: KIM::Log, kim_log_module::kim_log_handle_type

Since: 2.0

Definition at line 69 of file KIM_Log.h.

◆ KIM_LogVerbosity

typedef struct KIM_LogVerbosity KIM_LogVerbosity

Forward declaration.

Since: 2.0

Definition at line 46 of file KIM_Log.h.

Function Documentation

◆ KIM_Log_Create()

int KIM_Log_Create ( KIM_Log **const log )

Create a new KIM API Log object.

See also: KIM::Log::Create, kim_log_module::kim_log_create

Since: 2.0

◆ KIM_Log_Destroy()

void KIM_Log_Destroy ( KIM_Log **const log )

Destroy a previously Log::Create'd object.

See also: KIM::Log::Destroy, kim_log_module::kim_log_destroy

Since: 2.0

◆ KIM_Log_GetID()

char const* KIM_Log_GetID ( KIM_Log const *const log )

Get the identity of the Log object.

See also: KIM::Log::GetID, kim_log_module::kim_get_id

Since: 2.0

◆ KIM_Log_LogEntry()

void KIM_Log_LogEntry	(	KIM_Log const *const	log,
		KIM_LogVerbosity const	logVerbosity,
		char const *const	message,
		int const	lineNumber,
		char const *const	fileName
	)

Write a log entry into the log file.

See also: KIM::Log::LogEntry, kim_log_module::kim_log_entry

Since: 2.0

◆ KIM_Log_PopDefaultPrintFunction()

void KIM_Log_PopDefaultPrintFunction ( )

Pop a log PrintFunction from the KIM API global default log PrintFunction stack.

See also: KIM::Log::PopDefaultPrintFunction, kim_log_module::kim_pop_default_print_function

Since: 2.2

◆ KIM_Log_PopDefaultVerbosity()

void KIM_Log_PopDefaultVerbosity ( )

Pop a LogVerbosity from the KIM API global default verbosity stack.

See also: KIM::Log::PopDefaultVerbosity, kim_log_module::kim_pop_default_verbosity

Since: 2.0

◆ KIM_Log_PopVerbosity()

void KIM_Log_PopVerbosity ( KIM_Log *const log )

Pop a LogVerbosity from the Log object's verbosity stack.

See also: KIM::Log::PopVerbosity, kim_log_module::kim_pop_verbosity

Since: 2.0

◆ KIM_Log_PushDefaultPrintFunction()

void KIM_Log_PushDefaultPrintFunction	(	KIM_LanguageName const	languageName,
		KIM_Function *const	fptr
	)

Push a new default log PrintFunction onto the KIM API global default log PrintFunction stack.

See also: KIM::Log::PushDefaultPrintFunction, kim_log_module::kim_push_default_print_function

Since: 2.2

◆ KIM_Log_PushDefaultVerbosity()

void KIM_Log_PushDefaultVerbosity ( KIM_LogVerbosity const logVerbosity )

Push a new default LogVerbosity onto the KIM API global default verbosity stack.

See also: KIM::Log::PushDefaultVerbosity, kim_log_module::kim_push_default_verbosity

Since: 2.0

◆ KIM_Log_PushVerbosity()

void KIM_Log_PushVerbosity	(	KIM_Log *const	log,
		KIM_LogVerbosity const	logVerbosity
	)

Push a new LogVerbosity onto the Log object's verbosity stack.

See also: KIM::Log::PushVerbosity, kim_log_module::kim_push_verbosity

Since: 2.0

◆ KIM_Log_SetID()

void KIM_Log_SetID	(	KIM_Log *const	log,
		char const *const	id
	)

Set the identity of the Log object.

See also: KIM::Log::SetID, kim_log_module::kim_set_id

Since: 2.0

Typedefs

Functions