Configuration

Compile-time configuration of libsir.

Environment variables

The variables in the following table are applied at compile-time when executing make.

Example:

env SIR_PREPROCESSOR_FOO=1 make ...

The Makefile takes care of the rest; for each environment variable that is known to the Makefile, it adds or removes compiler options based on the values provided. This may be a simple mapping of VAR=1 to -DVAR, or a more nuanced configuration:

Variable (default)	State	Compiler settings	Description
SIR_DEBUG (0)	0	-O3 -DNDEBUG -D_FORTIFY_SOURCE=2	Full optimization is applied, source fortification is set to level 2, and no debugging symbols are included.
	1	-g3 -00 -DDEBUG -U_FORTIFY_SOURCE	No optimizations are applied, source fortification is disabled, and full debugging symbols are included.
SIR_SELFLOG (0)	0	N/A	NOOP
	1	-DSIR_SELFLOG	Diagnostic information is sent to stderr to report certain events that may aid in debugging. Includes the function name, source file, and line where the event took place. If SIR_DEBUG and SIR_SELFLOG are enabled, each error handled internally will be logged in real time as it is captured.
SIR_ASSERT_ENABLED (0)	0	N/A	assert will never be called. If SIR_SELFLOG is enabled, where asserts normally would take place, a _sir_selflog call is made, producing output to stderr such as 'somefunc (file.c:123): !!! would be asserting (NULL != ptr)'.
	1	-DSIR_ASSERT_ENABLED	assert will be used. Note that assert has no effect if NDEBUG is defined, so in order for this to be useful, you will also need SIR_DEBUG=1 (or manually change -DNDEBUG to -DDEBUG in the Makefile).
SIR_NO_SYSTEM_LOGGERS (0)	0	N/A	If the current platform has a system logger facility (currently all platforms do by default except Windows), you can utilize it as a destination in libsir.
	1	-DSIR_NO_SYSTEM_LOGGERS	Even if the current platform has a system logger facility, the functionality will be disabled (and most of it compiled out).
SIR_NO_PLUGINS (0)	0	N/A	The plugin system is available for use. Call sir_loadplugin to load a plugin, and sir_unloadplugin to unload one.
	1	-DSIR_NO_PLUGINS	The plugin system's functionality will be disabled (and most of it compiled out).
SIR_NO_SHARED (0)	0	N/A	Shared libraries are created when building the *all* target, and installed with *make install*.
	1	-DSIR_NO_PLUGINS	The SIR_NO_PLUGINS variable is set (to 1), shared libraries are not created when building the *all* target, and are not installed with *make install*.
SIR_USE_EOL_CRLF (0)	0	N/A	The end of line sequence will be SIR_EOL_LF.
	1	-DSIR_USE_EOL_CRLF	The end of line sequence will be SIR_EOL_CR + SIR_EOL_LF.

---

Note

If you plan to use the Visual Studio 2022 solution, see README.md under Help once the solution is loaded.

sirconfig.h

All of the fine-grained compile-time constants, such as (but not limited to):

1. Date/time format strings
2. Default values
3. Miscellaneous format strings
4. Buffer sizes
5. Thresholds

can be found in config.h, and may be modified to fit your specific needs.

Remarks

All format strings containing specifiers such as %d are printf-style. The man page or documentation for printf can be used as a guide.

Attention

Don't make changes until you've examined how these values are utilized elsewhere in the source code! You will break something.