sir_8h_source.html

#ifndef _SIR_H_INCLUDED

# define _SIR_H_INCLUDED


# include "sir/platform.h"

# include "sir/version.h"

# include "sir/types.h"


# if defined(SWIG)

#  define PRINTF_FORMAT

#  define PRINTF_FORMAT_ATTR(fmt_p, va_p)

# endif


# if defined(__cplusplus)

extern "C" {

# endif


bool sir_makeinit(sirinit* si);


bool sir_init(sirinit* si);


bool sir_cleanup(void);


bool sir_isinitialized(void);


uint16_t sir_geterror(char message[SIR_MAXERROR]);


void sir_geterrorinfo(sir_errorinfo* err);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_debug(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_info(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_notice(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_warn(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_error(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_crit(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_alert(PRINTF_FORMAT const char* format, ...);


PRINTF_FORMAT_ATTR(1, 2)

bool sir_emerg(PRINTF_FORMAT const char* format, ...);


sirfileid sir_addfile(const char* path, sir_levels levels, sir_options opts);


bool sir_remfile(sirfileid id);


sirpluginid sir_loadplugin(const char* path);


bool sir_unloadplugin(sirpluginid id);


bool sir_filelevels(sirfileid id, sir_levels levels);


bool sir_fileopts(sirfileid id, sir_options opts);


bool sir_settextstyle(sir_level level, sir_textattr attr, sir_textcolor fg,

    sir_textcolor bg);


bool sir_resettextstyles(void);


sir_textcolor sir_makergb(sir_textcolor r, sir_textcolor g, sir_textcolor b);


bool sir_setcolormode(sir_colormode mode);


bool sir_stdoutlevels(sir_levels levels);


bool sir_stdoutopts(sir_options opts);


bool sir_stderrlevels(sir_levels levels);


bool sir_stderropts(sir_options opts);


bool sir_sysloglevels(sir_levels levels);


bool sir_syslogopts(sir_options opts);


bool sir_syslogid(const char* identity);


bool sir_syslogcat(const char* category);


const char* sir_getversionstring(void);


uint32_t sir_getversionhex(void);


bool sir_isprerelease(void);


# if defined(__cplusplus)

}

# endif


#endif /* !_SIR_H_INCLUDED */

SIR_MAXERROR
#define SIR_MAXERROR
The maximum size, in characters, of an error message.
Definition config.h:419

sir_stderropts
bool sir_stderropts(sir_options opts)
Set new formatting options for stderr.
Definition sir.c:211

sir_settextstyle
bool sir_settextstyle(sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg)
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
Definition sir.c:170

sir_loadplugin
sirpluginid sir_loadplugin(const char *path)
Loads a plugin module from disk.
Definition sir.c:140

sir_alert
bool sir_alert(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_ALERT level message.
Definition sir.c:117

sir_sysloglevels
bool sir_sysloglevels(sir_levels levels)
Set new level registrations for the system logger destination.
Definition sir.c:217

sir_setcolormode
bool sir_setcolormode(sir_colormode mode)
Sets the ANSI color mode for stdio destinations.
Definition sir.c:189

sir_error
bool sir_error(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_ERROR level message.
Definition sir.c:101

sir_notice
bool sir_notice(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_NOTICE level message.
Definition sir.c:85

sir_stderrlevels
bool sir_stderrlevels(sir_levels levels)
Set new level registrations for stderr.
Definition sir.c:205

sir_makergb
sir_textcolor sir_makergb(sir_textcolor r, sir_textcolor g, sir_textcolor b)
Creates a sir_textcolor from red, green, and blue components.
Definition sir.c:185

sir_filelevels
bool sir_filelevels(sirfileid id, sir_levels levels)
Set new level registrations for a log file already managed by libsir.
Definition sir.c:158

sir_syslogopts
bool sir_syslogopts(sir_options opts)
Set new formatting options for the system logger destination.
Definition sir.c:228

sir_unloadplugin
bool sir_unloadplugin(sirpluginid id)
Unloads a previously registered plugin module.
Definition sir.c:149

sir_stdoutlevels
bool sir_stdoutlevels(sir_levels levels)
Set new level registrations for stdout.
Definition sir.c:193

sir_getversionhex
uint32_t sir_getversionhex(void)
Returns the current libsir version as a number.
Definition sir.c:263

sir_debug
bool sir_debug(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_DEBUG level message.
Definition sir.c:69

sir_resettextstyles
bool sir_resettextstyles(void)
Reset text styling for stdio (stdout/stderr) destinations to their default values.
Definition sir.c:181

sir_info
bool sir_info(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_INFO level message.
Definition sir.c:77

sir_cleanup
bool sir_cleanup(void)
Tears down and cleans up libsir after use.
Definition sir.c:52

sir_addfile
sirfileid sir_addfile(const char *path, sir_levels levels, sir_options opts)
Adds a log file and registers it to receive log output.
Definition sir.c:132

sir_init
bool sir_init(sirinit *si)
Initializes libsir for use.
Definition sir.c:48

sir_crit
bool sir_crit(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_CRIT level message.
Definition sir.c:109

sir_remfile
bool sir_remfile(sirfileid id)
Removes a file previously added to libsir.
Definition sir.c:136

sir_syslogid
bool sir_syslogid(const char *identity)
Set new system logger identity.
Definition sir.c:239

sir_warn
bool sir_warn(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_WARN level message.
Definition sir.c:93

sir_geterror
uint16_t sir_geterror(char message[SIR_MAXERROR])
Retrieves a formatted message for the last error that occurred on the calling thread and returns the ...
Definition sir.c:60

sir_stdoutopts
bool sir_stdoutopts(sir_options opts)
Set new formatting options for stdout.
Definition sir.c:199

sir_makeinit
bool sir_makeinit(sirinit *si)
Fills out a sirinit structure with default values.
Definition sir.c:44

sir_syslogcat
bool sir_syslogcat(const char *category)
Set new system logger category.
Definition sir.c:249

sir_isinitialized
bool sir_isinitialized(void)
Determines whether or not libsir is in the initialized state.
Definition sir.c:56

sir_getversionstring
const char * sir_getversionstring(void)
Returns the current libsir version as a string.
Definition sir.c:259

sir_geterrorinfo
void sir_geterrorinfo(sir_errorinfo *err)
Retrieves granular information about the last error that occurred on the calling thread.
Definition sir.c:64

sir_fileopts
bool sir_fileopts(sirfileid id, sir_options opts)
Set new formatting options for a log file already managed by libsir.
Definition sir.c:164

sir_isprerelease
bool sir_isprerelease(void)
Whether or not this is a pre-release version of libsir.
Definition sir.c:267

sir_emerg
bool sir_emerg(PRINTF_FORMAT const char *format,...)
Dispatches a SIRL_EMERG level message.
Definition sir.c:125

sir_level
uint16_t sir_level
The sir_level type.
Definition types.h:71

sirfileid
uint32_t sirfileid
Log file identifier type.
Definition types.h:49

sir_textattr
sir_textattr
Attributes for stdio output.
Definition types.h:107

sir_colormode
sir_colormode
Color mode selection.
Definition types.h:99

sir_levels
uint16_t sir_levels
sir_level bitmask type.
Definition types.h:74

sir_textcolor
uint32_t sir_textcolor
stdio text color type.
Definition types.h:141

sirpluginid
uint32_t sirpluginid
Plugin module identifier type.
Definition types.h:52

sir_options
uint32_t sir_options
sir_option bitmask type.
Definition types.h:96

sir_errorinfo
Information about an error that occurred.
Definition types.h:150

sirinit
libsir initialization and configuration data.
Definition types.h:244