(glibc ≳2.4, musl ≳1.2.3, uClibc‑ng ≳1.0.43) | **GCC** (4.8.4 ‑ 14.0.1), **Clang** (3.8 ‑ 18.1.5), **Oracle Studio C/C++** (≳12.6), **Circle** (1.0.0‑200), **IBM Advance Toolchain** (14 ‑ 17), **IBM XL C/C++** (16.1.1.2 ‑ 16.1.1.15), **IBM Open XL C/C++** (17.1.1.0 ‑ 17.1.1.2), **NVIDIA HPC SDK C/C++** (23.5 ‑ 24.3), **Arm HPC C/C++** (22.1 ‑ 23.10), **DMD ImportC** (2.104.2 ‑ 2.108.1), **AMD Optimizing C/C++** (4.0.0 ‑ 4.2.0), **Intel oneAPI DPC++/C++** (2023.1 ‑ 2024.1.0), **Open64** (5, AMD 4.5.2.1), **Intel C++ Compiler Classic** (2021.9.0 ‑ 2021.10.0), **Portable C Compiler** (1.2.0.DEVEL‑20230730), **Kefir** (≳0.3.0), **Chibicc** (2020.12.6), **CompCert C** (3.11 ‑ 3.14, no‑TLS), **Chamois‑CompCert C** (3.14‑20231130, TLS) | +| **Linux** ≳2.6.32
(glibc ≳2.4, musl ≳1.2.3, uClibc‑ng ≳1.0.43) | **GCC** (4.8.4 ‑ 14.1.1), **Clang** (3.8 ‑ 18.1.5), **Oracle Studio C/C++** (≳12.6), **Circle** (1.0.0‑200), **IBM Advance Toolchain** (14 ‑ 17), **IBM XL C/C++** (16.1.1.2 ‑ 16.1.1.15), **IBM Open XL C/C++** (17.1.1.0 ‑ 17.1.1.2), **NVIDIA HPC SDK C/C++** (23.5 ‑ 24.3), **Arm HPC C/C++** (22.1 ‑ 23.10), **DMD ImportC** (2.104.2 ‑ 2.109.0), **AMD Optimizing C/C++** (4.0.0 ‑ 4.2.0), **Intel oneAPI DPC++/C++** (2023.1 ‑ 2024.1.0), **Open64** (5, AMD 4.5.2.1), **Intel C++ Compiler Classic** (2021.9.0 ‑ 2021.10.0), **Portable C Compiler** (1.2.0.DEVEL‑20230730), **Kefir** (≳0.3.0), **Chibicc** (2020.12.6), **CompCert C** (3.11 ‑ 3.14, no‑TLS), **Chamois‑CompCert C** (3.14‑20231130, TLS) | | **Android** ≳5 | **Android NDK** (r25c ‑ r26d) | | **IBM AIX** 7.2, 7.3 | **GCC** (8.3 ‑ 12.3), **Clang** (18.1.2 ‑ 18.1.5), **IBM XL C/C++** (16.1.0.3 ‑ 16.1.0.17), **IBM Open XL C/C++** (17.1.1.1 ‑ 17.1.2.5) | | **IBM i** (**PASE**) 7.5 | **GCC** (10.3.0 ‑ 10.5.0), **IBM XL C/C++** (16.1.0.15 ‑ 16.1.0.17) | -| **macOS** ≳10.15 | **Xcode** (11.7 ‑ 15.3), **GCC** (10.4 ‑ 13.2.1), **Clang** (11.0.3 ‑ 17.0.6), **DMD ImportC** (2.105.0 ‑ 2.108.1), **Intel C++ Compiler Classic** (2021.9.0 ‑ 2021.10.0) | +| **macOS** ≳10.15 | **Xcode** (11.7 ‑ 15.3), **GCC** (10.4 ‑ 13.2.1), **Clang** (11.0.3 ‑ 17.0.6), **DMD ImportC** (2.105.0 ‑ 2.109.0), **Intel C++ Compiler Classic** (2021.9.0 ‑ 2021.10.0) | | **Windows** ≳10, 11 | **Microsoft Visual C/C++** (17.6 ‑ 17.9.6), **Clang‑CL** (16.0.6 ‑ 18.1.5), **GCC‑MinGW** (12.2.1 ‑ 14.0.1), **LLVM‑MinGW** (15.0 ‑ 18.1.5), **Embarcadero C++** (7.20 ‑ 7.70), **OrangeC** (≳6.71.10) | | **Cygwin** 3.4 | **GCC** (11.2 ‑ 13.2.1) | -| **FreeBSD** ≳11.3 | **GCC** (11.4 ‑ 13.2.1), **Clang** (10 ‑ 17.0.6), **DMD ImportC** (2.105.0 ‑ 2.108.1) | +| **FreeBSD** ≳11.3 | **GCC** (11.4 ‑ 13.2.1), **Clang** (10 ‑ 17.0.6), **DMD ImportC** (2.105.0 ‑ 2.109.0) | | **NetBSD** 9.2 | **GCC** (7.5 ‑ 13.2), **Clang** (15.0.7 ‑ 17.0.6) | | **OpenBSD** 7.3 | **GCC** (11.2), **Clang** (13 ‑ 17.0.6), **DMD ImportC** (2.106.0) | | **DragonFly** **BSD** 6.4 | **GCC** (8.3 ‑ 13), **Clang** (10.0.1 ‑ 17.0.6) | diff --git a/bindings/ch/_sir_strredact.chf b/bindings/ch/_sir_strredact.chf index 978b3a772..4f4e05b81 100644 --- a/bindings/ch/_sir_strredact.chf +++ b/bindings/ch/_sir_strredact.chf @@ -33,7 +33,7 @@ char* _sir_strredact(char *str, const char *sub, const char c) { - void* fptr; + void* fptr; char* retval; fptr = dlsym(_Chsir_handle, "_sir_strredact_chdl"); diff --git a/docs/annotated.html b/docs/annotated.html index 026cfbb02..ac99fdd3d 100644 --- a/docs/annotated.html +++ b/docs/annotated.html @@ -4,7 +4,7 @@ - + @@ -32,6 +32,7 @@ + @@ -54,7 +55,7 @@ - + @@ -84,7 +85,7 @@
@@ -114,8 +115,8 @@
Here are the data structures with brief descriptions:
-
-
+
-
+
@@ -84,7 +85,7 @@
@@ -323,31 +324,22 @@ #define SIR_COLOR
[detail level 12]
| ▼Nsir | Libsir C++ wrapper implementation |
| ▼Nsir | Libsir C++ wrapper implementation |
| Cadapter | Defines the abstract interface for an adapter, which ultimately becomes a public base class of logger (there can be more than one) |
| Cboost_format_adapter | Adapter for boost::format (when available) |
| Cdefault_adapter | The default adapter implementation |
@@ -144,7 +145,7 @@
#define SIR_R_ARROW "\xe2\x86\x92"
A few fun characters.
#define SIR_COLOR(attr, fg, bg, s) SIR_ESC_SEQ(#attr ";" #fg ";" #bg, s) SIR_ESC_SEQE("0;39;49") #define SIR_COLOR(attr, fg, bg, s) SIR_ESC_SEQ(#attr ";" #fg ";" #bg, s) SIR_ESC_SEQE("0;39;49") Creates a sequence of colored characters 's' with foreground color 'fg', background color 'bg', and attributes 'attr' (
@@ -172,131 +173,131 @@
Blinking text.
-#define SIR_BLACK(s) SIR_COLOR(0, 30, 49, s) SIR_BLACK(s) SIR_COLOR(0, 30, 49, s)
Black foreground text.
-#define SIR_BLACKB(s) SIR_COLOR(1, 30, 49, s) SIR_BLACKB(s) SIR_COLOR(1, 30, 49, s)
Bold black foreground text.
-#define SIR_RED(s) SIR_COLOR(0, 31, 49, s) SIR_RED(s) SIR_COLOR(0, 31, 49, s)
Red foreground text.
-#define SIR_REDB(s) SIR_COLOR(1, 31, 49, s) SIR_REDB(s) SIR_COLOR(1, 31, 49, s)
Bold red foreground text.
-#define SIR_BRED(s) SIR_COLOR(0, 91, 49, s) SIR_BRED(s) SIR_COLOR(0, 91, 49, s)
Bright red foreground text.
-#define SIR_BREDB(s) SIR_COLOR(1, 91, 49, s) SIR_BREDB(s) SIR_COLOR(1, 91, 49, s)
Bold bright red foreground text.
-#define SIR_GREEN(s) SIR_COLOR(0, 32, 49, s) SIR_GREEN(s) SIR_COLOR(0, 32, 49, s)
Green foreground text.
-#define SIR_GREENB(s) SIR_COLOR(1, 32, 49, s) SIR_GREENB(s) SIR_COLOR(1, 32, 49, s)
Bold green foreground text.
-#define SIR_BGREEN(s) SIR_COLOR(0, 92, 49, s) SIR_BGREEN(s) SIR_COLOR(0, 92, 49, s)
Bright green foreground text.
-#define SIR_BGREENB(s) SIR_COLOR(1, 92, 49, s) SIR_BGREENB(s) SIR_COLOR(1, 92, 49, s)
Bold bright green foreground text.
-#define SIR_YELLOW(s) SIR_COLOR(0, 33, 49, s) SIR_YELLOW(s) SIR_COLOR(0, 33, 49, s)
Yellow foreground text.
-#define SIR_YELLOWB(s) SIR_COLOR(1, 33, 49, s) SIR_YELLOWB(s) SIR_COLOR(1, 33, 49, s)
Bold yellow foreground text.
-#define SIR_BYELLOW(s) SIR_COLOR(0, 93, 49, s) SIR_BYELLOW(s) SIR_COLOR(0, 93, 49, s)
Bright yellow foreground text.
-#define SIR_BYELLOWB(s) SIR_COLOR(1, 93, 49, s) SIR_BYELLOWB(s) SIR_COLOR(1, 93, 49, s)
Bold bright yellow foreground text.
-#define SIR_BLUE(s) SIR_COLOR(0, 34, 49, s) SIR_BLUE(s) SIR_COLOR(0, 34, 49, s)
Blue foreground text.
-#define SIR_BLUEB(s) SIR_COLOR(1, 34, 49, s) SIR_BLUEB(s) SIR_COLOR(1, 34, 49, s)
Bold blue foreground text.
-#define SIR_BBLUE(s) SIR_COLOR(0, 94, 49, s) SIR_BBLUE(s) SIR_COLOR(0, 94, 49, s)
Bright blue foreground text.
-#define SIR_BBLUEB(s) SIR_COLOR(1, 94, 49, s) SIR_BBLUEB(s) SIR_COLOR(1, 94, 49, s)
Bold bright blue foreground text.
-#define SIR_MAGENTA(s) SIR_COLOR(0, 35, 49, s) SIR_MAGENTA(s) SIR_COLOR(0, 35, 49, s)
Magenta foreground text.
-#define SIR_MAGENTAB(s) SIR_COLOR(1, 35, 49, s) SIR_MAGENTAB(s) SIR_COLOR(1, 35, 49, s)
Bold magenta foreground text.
-#define SIR_BMAGENTA(s) SIR_COLOR(0, 95, 49, s) SIR_BMAGENTA(s) SIR_COLOR(0, 95, 49, s)
Bright magenta foreground text.
-#define SIR_BMAGENTAB(s) SIR_COLOR(1, 95, 49, s) SIR_BMAGENTAB(s) SIR_COLOR(1, 95, 49, s)
Bold bright magenta foreground text.
-#define SIR_CYAN(s) SIR_COLOR(0, 36, 49, s) SIR_CYAN(s) SIR_COLOR(0, 36, 49, s)
Cyan foreground text.
-#define SIR_CYANB(s) SIR_COLOR(1, 36, 49, s) SIR_CYANB(s) SIR_COLOR(1, 36, 49, s)
Bold cyan foreground text.
-#define SIR_BCYAN(s) SIR_COLOR(0, 96, 49, s) SIR_BCYAN(s) SIR_COLOR(0, 96, 49, s)
Bright cyan foreground text.
-#define SIR_BCYANB(s) SIR_COLOR(1, 96, 49, s) SIR_BCYANB(s) SIR_COLOR(1, 96, 49, s)
Bold bright cyan foreground text.
-#define SIR_BGRAY(s) SIR_COLOR(0, 37, 49, s) SIR_BGRAY(s) SIR_COLOR(0, 37, 49, s)
Bright gray foreground text.
-#define SIR_BGRAYB(s) SIR_COLOR(1, 37, 49, s) SIR_BGRAYB(s) SIR_COLOR(1, 37, 49, s)
Bold bright gray foreground text.
-#define SIR_DGRAY(s) SIR_COLOR(0, 90, 49, s) SIR_DGRAY(s) SIR_COLOR(0, 90, 49, s)
Dark gray foreground text.
-#define SIR_DGRAYB(s) SIR_COLOR(1, 90, 49, s) SIR_DGRAYB(s) SIR_COLOR(1, 90, 49, s)
Bold dark gray foreground text.
-#define SIR_WHITE(s) SIR_COLOR(0, 97, 49, s) SIR_WHITE(s) SIR_COLOR(0, 97, 49, s)
White foreground text.
-#define SIR_WHITEB(s) SIR_COLOR(1, 97, 49, s) SIR_WHITEB(s) SIR_COLOR(1, 97, 49, s)
Bold white foreground text.
0=normal, 1=bold, 2=dim, 3=italic, 4=underlined, 5=blinking, 7=inverted, 9=strikethrough). #define SIR_COLOR
(
-
- attr,
+ attr,
- fg,
+ fg,
- bg,
+ bg,
- s
-
-
- )
- SIR_ESC_SEQ(#attr ";" #fg ";" #bg, s) SIR_ESC_SEQE("0;39;49")
+ s ) SIR_ESC_SEQ(#attr ";" #fg ";" #bg, s) SIR_ESC_SEQE("0;39;49")
@@ -364,7 +356,7 @@
diff --git a/docs/ansimacros_8h_source.html b/docs/ansimacros_8h_source.html
index dcd4385bd..3a727fc56 100644
--- a/docs/ansimacros_8h_source.html
+++ b/docs/ansimacros_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
- - Generated by
1.9.8
+ - Generated by 1.10.0
1.9.8 1.10.0
@@ -257,7 +258,7 @@
diff --git a/docs/classes.html b/docs/classes.html
index 7d22cd613..3162c839f 100644
--- a/docs/classes.html
+++ b/docs/classes.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -146,7 +147,7 @@
diff --git a/docs/classsir_1_1adapter.html b/docs/classsir_1_1adapter.html
index 08f617d76..7d5344877 100644
--- a/docs/classsir_1_1adapter.html
+++ b/docs/classsir_1_1adapter.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,7 +116,7 @@
Defines the abstract interface for an adapter, which ultimately becomes a public base class of logger (there can be more than one). - More...
+ More...
Inheritance diagram for sir::adapter:
@@ -135,7 +136,7 @@
diff --git a/docs/classsir_1_1boost__format__adapter.html b/docs/classsir_1_1boost__format__adapter.html
index 38f4244a2..cc34f3623 100644
--- a/docs/classsir_1_1boost__format__adapter.html
+++ b/docs/classsir_1_1boost__format__adapter.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,7 +116,7 @@
-
+
@@ -84,7 +85,7 @@
Adapter for boost::format (when available). - More...
+ More...
Inheritance diagram for sir::boost_format_adapter< TPolicy >:
@@ -132,7 +133,7 @@
-
static bool throw_on_policy(bool expr) noexcept(false)
Handles a potential error; if an error is present and the policy in place requires throwing an except...
Definition sir.hh:289
- See also
- boost_logger
- See also
- boost_logger
- Template Parameters
-
TPolicy A derived class of policy which controls the behavior of logger and by association, its adapters. diff --git a/docs/classsir_1_1default__adapter.html b/docs/classsir_1_1default__adapter.html index c0ffccab3..5f6f2546a 100644 --- a/docs/classsir_1_1default__adapter.html +++ b/docs/classsir_1_1default__adapter.html @@ -4,7 +4,7 @@ - + @@ -32,6 +32,7 @@ + @@ -54,7 +55,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
- Generated by
@@ -117,7 +118,7 @@
The default adapter implementation. - More...
+ More...
Inheritance diagram for sir::default_adapter< TPolicy >:
@@ -179,7 +180,7 @@
diff --git a/docs/classsir_1_1default__policy.html b/docs/classsir_1_1default__policy.html
index f61f3a3bb..d2e58e0fe 100644
--- a/docs/classsir_1_1default__policy.html
+++ b/docs/classsir_1_1default__policy.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -117,7 +118,7 @@
-
+
@@ -84,7 +85,7 @@
In the event that no custom configuration or behavior is desired, provides defaults for everything. - More...
+ More...
Inheritance diagram for sir::default_policy:
@@ -126,16 +127,16 @@
@@ -204,7 +204,7 @@ constexpr bool sir::default_policy::on_init_complete
diff --git a/docs/classsir_1_1exception.html b/docs/classsir_1_1exception.html
index bac74f781..f73d88976 100644
--- a/docs/classsir_1_1exception.html
+++ b/docs/classsir_1_1exception.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
Public Member Functions | |
| bool | get_init_data (sirinit &data) const noexcept final |
| bool | get_init_data (sirinit &data) const noexcept final |
| Called by logger before initializing libsir. | |
| constexpr bool | on_init_complete () const noexcept final |
| constexpr bool | on_init_complete () const noexcept final |
| Called by logger immediately after libsir has been initialized. | |
Additional Inherited Members | |
 Static Public Member Functions inherited from sir::policy | |
| Static Public Member Functions inherited from sir::policy | |
| static constexpr bool | throw_on_error () noexcept |
| Determines whether or not exceptions are thrown in the event that an unercoverable error is encountered by logger or its associated adapter(s). | |
| ( | -sirinit & | -data | ) | +sirinit & | data | ) | const |
constexpr bool sir::default_policy::on_init_complete
(
- )
+ )
const
@@ -239,7 +239,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,7 +116,7 @@
diff --git a/docs/classsir_1_1fmt__format__adapter.html b/docs/classsir_1_1fmt__format__adapter.html
index 2a3333d45..b191fc20c 100644
--- a/docs/classsir_1_1fmt__format__adapter.html
+++ b/docs/classsir_1_1fmt__format__adapter.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
The exception type thrown by libsir. - More...
+ More...Inherits std::runtime_error.
Detailed Description
@@ -133,7 +134,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,7 +116,7 @@
-
+
@@ -84,7 +85,7 @@
Adapter for {fmt} (when available). - More...
+ More...
Inheritance diagram for sir::fmt_format_adapter< TPolicy >:
@@ -132,7 +133,7 @@
-
static bool throw_on_policy(bool expr) noexcept(false)
Handles a potential error; if an error is present and the policy in place requires throwing an except...
Definition sir.hh:289
- See also
- fmt_logger
- See also
- fmt_logger
- Template Parameters
-
TPolicy A derived class of policy which controls the behavior of logger and by association, its adapters. diff --git a/docs/classsir_1_1logger.html b/docs/classsir_1_1logger.html index 318733c51..8bd44b2b3 100644 --- a/docs/classsir_1_1logger.html +++ b/docs/classsir_1_1logger.html @@ -4,7 +4,7 @@ - + @@ -32,6 +32,7 @@ + @@ -54,7 +55,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
- Generated by
@@ -115,7 +116,7 @@
class sir::logger< RAII, TPolicy, TAdapters >
-
+
@@ -84,7 +85,7 @@
The primary C++ interface to libsir. - More...
+ More...Inherits TAdapters< TPolicy >.
Detailed Description
@@ -123,7 +124,7 @@ requires DerivedFromT<adapter, TAdapters<TPolicy>...>class sir::logger< RAII, TPolicy, TAdapters >
The primary C++ interface to libsir.
Instantiate this class in order to access libsir with all the benefits of C++, including RAII initialization/cleanup, custom adapters, and more.
-- See also
- default_logger
- See also
- default_logger
- Template Parameters
-
RAII Set to true to enable 'resource acquisition is initialization' behavior (i.e., libsir is initialized by the ctor, and cleaned up by the dtor). Set to false for manual management of initialization/cleanup. diff --git a/docs/classsir_1_1policy.html b/docs/classsir_1_1policy.html index ac2d4e34d..9d7958479 100644 --- a/docs/classsir_1_1policy.html +++ b/docs/classsir_1_1policy.html @@ -4,7 +4,7 @@ - + @@ -32,6 +32,7 @@ + @@ -54,7 +55,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
- Generated by
@@ -118,7 +119,7 @@
-
+
@@ -84,7 +85,7 @@
Defines the partially abstract interface for a policy which controls the behavior of logger at runtime. - More...
+ More...
Inheritance diagram for sir::policy:
@@ -127,16 +128,16 @@
@@ -156,8 +157,7 @@ virtual bool sir::policy::get_init_data
diff --git a/docs/classsir_1_1std__format__adapter.html b/docs/classsir_1_1std__format__adapter.html
index b46b86b92..b9cfb8c29 100644
--- a/docs/classsir_1_1std__format__adapter.html
+++ b/docs/classsir_1_1std__format__adapter.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
Public Member Functions | |
| virtual bool | get_init_data (sirinit &data) const noexcept=0 |
| virtual bool | get_init_data (sirinit &data) const noexcept=0 |
| Called by logger before initializing libsir. | |
| virtual bool | on_init_complete () const noexcept=0 |
| virtual bool | on_init_complete () const noexcept=0 |
| Called by logger immediately after libsir has been initialized. | |
Static Public Member Functions | |
| static constexpr bool | throw_on_error () noexcept |
| static constexpr bool | throw_on_error () noexcept |
| Determines whether or not exceptions are thrown in the event that an unercoverable error is encountered by logger or its associated adapter(s). | |
virtual bool sir::policy::get_init_data
(
- sirinit &
- data )
+ sirinit & data )
const
@@ -200,7 +200,7 @@ virtual bool sir::policy::on_init_complete
(
- )
+ )
const
@@ -237,7 +237,7 @@ static constexpr bool sir::policy::throw_on_error
(
- )
+ )
- - Generated by 1.9.8
+ - Generated by 1.10.0
static constexpr bool sir::policy::throw_on_error
(
- )
+ )
- - Generated by 1.9.8
+ - Generated by 1.10.0
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,7 +116,7 @@
-
+
@@ -84,7 +85,7 @@
Adapter for std::format (when available). - More...
+ More...
Inheritance diagram for sir::std_format_adapter< TPolicy >:
@@ -132,7 +133,7 @@
-
static bool throw_on_policy(bool expr) noexcept(false)
Handles a potential error; if an error is present and the policy in place requires throwing an except...
Definition sir.hh:289
- See also
- std_format_logger
- See also
- std_format_logger
- Template Parameters
-
TPolicy A derived class of policy which controls the behavior of logger and by association, its adapters. diff --git a/docs/classsir_1_1std__iostream__adapter.html b/docs/classsir_1_1std__iostream__adapter.html index 641605925..8a3379898 100644 --- a/docs/classsir_1_1std__iostream__adapter.html +++ b/docs/classsir_1_1std__iostream__adapter.html @@ -4,7 +4,7 @@ - + @@ -32,6 +32,7 @@ + @@ -54,7 +55,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
- Generated by
@@ -115,7 +116,7 @@
Provides a std::iostream interface to libsir's logging functions. - More...
+ More...
Inheritance diagram for sir::std_iostream_adapter< TPolicy >:
@@ -150,7 +151,7 @@
diff --git a/docs/clipboard.js b/docs/clipboard.js
new file mode 100644
index 000000000..42c1fb0e0
--- /dev/null
+++ b/docs/clipboard.js
@@ -0,0 +1,61 @@
+/**
+
+The code below is based on the Doxygen Awesome project, see
+https://github.com/jothepro/doxygen-awesome-css
+
+MIT License
+
+Copyright (c) 2021 - 2022 jothepro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+*/
+
+let clipboard_title = "Copy to clipboard"
+let clipboard_icon = ``
+let clipboard_successIcon = ``
+let clipboard_successDuration = 1000
+
+$(function() {
+ if(navigator.clipboard) {
+ const fragments = document.getElementsByClassName("fragment")
+ for(const fragment of fragments) {
+ const clipboard_div = document.createElement("div")
+ clipboard_div.classList.add("clipboard")
+ clipboard_div.innerHTML = clipboard_icon
+ clipboard_div.title = clipboard_title
+ $(clipboard_div).click(function() {
+ const content = this.parentNode.cloneNode(true)
+ // filter out line number and folded fragments from file listings
+ content.querySelectorAll(".lineno, .ttc, .foldclosed").forEach((node) => { node.remove() })
+ let text = content.textContent
+ // remove trailing newlines and trailing spaces from empty lines
+ text = text.replace(/^\s*\n/gm,'\n').replace(/\n*$/,'')
+ navigator.clipboard.writeText(text);
+ this.classList.add("success")
+ this.innerHTML = clipboard_successIcon
+ window.setTimeout(() => { // switch back to normal icon after timeout
+ this.classList.remove("success")
+ this.innerHTML = clipboard_icon
+ }, clipboard_successDuration);
+ })
+ fragment.insertBefore(clipboard_div, fragment.firstChild)
+ }
+ }
+})
diff --git a/docs/concepts.html b/docs/concepts.html
index 456b28898..d80827131 100644
--- a/docs/concepts.html
+++ b/docs/concepts.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -114,8 +115,8 @@
Here is a list of all documented concepts with brief descriptions:
-
-
+
-
+
@@ -84,7 +85,7 @@
-
+
@@ -84,7 +85,7 @@
[detail level 12]
| ▼Nsir | Libsir C++ wrapper implementation |
| ▼Nsir | Libsir C++ wrapper implementation |
| RDerivedFromPolicy | Ensures that T derives from policy |
| RDerivedFromStreamBuf | Ensures that T derives from std::streambuf |
| RDerivedFromT | True if all Ts are derived classes of TBase, otherwise false |
@@ -120,7 +121,7 @@
diff --git a/docs/conceptsir_1_1_derived_from_stream_buf.html b/docs/conceptsir_1_1_derived_from_stream_buf.html
index eede3b17f..76a791938 100644
--- a/docs/conceptsir_1_1_derived_from_stream_buf.html
+++ b/docs/conceptsir_1_1_derived_from_stream_buf.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -120,7 +121,7 @@
diff --git a/docs/conceptsir_1_1_derived_from_t.html b/docs/conceptsir_1_1_derived_from_t.html
index 9b9d76afb..dc25ecf04 100644
--- a/docs/conceptsir_1_1_derived_from_t.html
+++ b/docs/conceptsir_1_1_derived_from_t.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -120,7 +121,7 @@
diff --git a/docs/condition_8h.html b/docs/condition_8h.html
index 4d63db743..1999de0b1 100644
--- a/docs/condition_8h.html
+++ b/docs/condition_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -125,16 +126,16 @@
@@ -157,8 +158,7 @@ bool _sir_condbroadcast
Functions | |
| bool | _sir_condcreate (sir_condition *cond) |
| bool | _sir_condcreate (sir_condition *cond) |
| Creates/initializes a new condition variable. | |
| bool | _sir_condbroadcast (sir_condition *cond) |
| bool | _sir_condbroadcast (sir_condition *cond) |
| Broadcast signals a condition variable. | |
| bool | _sir_conddestroy (sir_condition *cond) |
| bool | _sir_conddestroy (sir_condition *cond) |
| Destroys a condition variable. | |
| bool | _sir_condwait_timeout (sir_condition *cond, sir_mutex *mutex, const sir_wait *howlong) |
| bool | _sir_condwait_timeout (sir_condition *cond, sir_mutex *mutex, const sir_wait *howlong) |
| Waits a given amount of time for a condition variable to become signaled. | |
bool _sir_condbroadcast
(
- sir_condition *
- cond )
+ sir_condition * cond )
bool _sir_condcreate
(
- sir_condition *
- cond )
+ sir_condition * cond )
bool _sir_conddestroy
(
- sir_condition *
- cond )
+ sir_condition * cond )
bool _sir_condwait_timeout
(
- sir_condition *
- cond,
+ sir_condition * cond,
sir_mutex *
- mutex,
+ sir_mutex * mutex,
const sir_wait *
- howlong
-
-
- )
- const sir_wait * howlong )
bool _sir_conddestroy
(
- sir_condition *
- cond )
+ sir_condition * cond )
bool _sir_condwait_timeout
(
- sir_condition *
- cond,
+ sir_condition * cond,
sir_mutex *
- mutex,
+ sir_mutex * mutex,
const sir_wait *
- howlong
-
-
- )
- const sir_wait * howlong )
@@ -281,7 +271,7 @@
diff --git a/docs/condition_8h_source.html b/docs/condition_8h_source.html
index b51c8cfb7..76e32adf1 100644
--- a/docs/condition_8h_source.html
+++ b/docs/condition_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
1.9.8 1.10.0
@@ -152,7 +153,7 @@
diff --git a/docs/config.html b/docs/config.html
index 14b750f8f..ab8d05c26 100644
--- a/docs/config.html
+++ b/docs/config.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -113,7 +114,7 @@
Configuration
-
diff --git a/docs/config_8h.html b/docs/config_8h.html
index c73efe07c..5a00325d6 100644
--- a/docs/config_8h.html
+++ b/docs/config_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
Compile-time configuration of libsir.
+Compile-time configuration of libsir.
Environment variables
The variables in the following table are applied at compile-time when executing make.
Example:
@@ -172,7 +173,7 @@sirconfig.h
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -128,10 +129,10 @@
Macros | |
| #define | SIR_TIMEFORMAT "%H:%M:%S" |
| #define | SIR_TIMEFORMAT "%H:%M:%S" |
| The time stamp format string at the start of log messages-not including milliseconds (as::SIR_MSECFORMAT), which is added separately. | |
| #define | SIR_MSECFORMAT ".%03ld" |
| #define | SIR_MSECFORMAT ".%03ld" |
| The format for milliseconds (1000ths of a second) in time stamps. | |
| @@ -142,56 +143,56 @@ #define | SIR_EOL_LF "\n" |
| The line feed (LF) character to use in the end of line sequence. | |
| #define | SIR_EOL SIR_EOL_LF |
| #define | SIR_EOL SIR_EOL_LF |
| The end of line sequence. | |
| #define | SIR_LEVELPREFIX "[" |
| #define | SIR_LEVELPREFIX "[" |
| The string placed directly before the human-readable logging level. | |
| #define | SIR_LEVELSUFFIX "]" |
| #define | SIR_LEVELSUFFIX "]" |
| The string placed directly after the human-readable logging level. | |
| #define | SIR_PIDPREFIX "(" |
| #define | SIR_PIDPREFIX "(" |
| The string placed directly before process and thread IDs. | |
| #define | SIR_PIDSUFFIX ")" |
| #define | SIR_PIDSUFFIX ")" |
| The character placed directly after process and thread IDs. | |
| #define | SIR_PIDFORMAT "%d" |
| #define | SIR_PIDFORMAT "%d" |
| The format for the current process ID. | |
| #define | SIR_TIDFORMAT "%d" |
| #define | SIR_TIDFORMAT "%d" |
| The format for the current thread ID. | |
| #define | SIR_PIDSEPARATOR "." |
| #define | SIR_PIDSEPARATOR "." |
| The string to place between process and thread IDs. | |
| #define | SIR_FOPENMODE "a" |
| The string passed to fopen/fopen_s for log files. | |
| #define | SIR_FROLLSIZE (1024 * 1024 * 5) |
| #define | SIR_FROLLSIZE (1024 * 1024 * 5) |
| The size, in bytes, at which a log file will be rolled/archived. | |
| #define | SIR_FHTIMEFORMAT "%H:%M:%S %a %d %b %Y (%z)" |
| The time format string used in file headers (see SIR_FHFORMAT). | |
| #define | SIR_FHTIMEFORMAT "%H:%M:%S %a %d %b %Y (%z)" |
| The time format string used in file headers (see SIR_FHFORMAT). | |
| #define | SIR_FHFORMAT SIR_EOL SIR_EOL "----- %s %s -----" SIR_EOL SIR_EOL |
| #define | SIR_FHFORMAT SIR_EOL SIR_EOL "----- %s %s -----" SIR_EOL SIR_EOL |
| The format string written to a log file when logging begins or the file is rolled/archived. | |
| #define | SIR_FHBEGIN "session begin @" |
| The string included in SIR_FHFORMAT when a logging session begins. | |
| #define | SIR_FHBEGIN "session begin @" |
| The string included in SIR_FHFORMAT when a logging session begins. | |
| #define | SIR_FHROLLED "archived as %s due to size @" |
| The string included in SIR_FHFORMAT when a file is rolled/archived due to becoming larger than SIR_FROLLSIZE bytes in size. | |
| #define | SIR_FHROLLED "archived as %s due to size @" |
| The string included in SIR_FHFORMAT when a file is rolled/archived due to becoming larger than SIR_FROLLSIZE bytes in size. | |
| #define | SIR_FNAMETIMEFORMAT "%Y-%m-%d-%H%M%S" |
| The time format string for rolled/archived log files (see SIR_FNAMEFORMAT). | |
| #define | SIR_FNAMETIMEFORMAT "%Y-%m-%d-%H%M%S" |
| The time format string for rolled/archived log files (see SIR_FNAMEFORMAT). | |
| #define | SIR_FNAMESEQFORMAT "-%hu" |
| The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT). | |
| #define | SIR_FNAMESEQFORMAT "-%hu" |
| The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT). | |
| #define | SIR_FNAMEFORMAT "%s-%s%s%s" |
| #define | SIR_FNAMEFORMAT "%s-%s%s%s" |
| The format string for rolled/archived log file names. | |
| @@ -238,7 +239,7 @@ #define | SIR_MAXFHEADER 128 |
| The size, in characters, of the buffer used to hold file header format strings. | |
| #define | SIR_MAXMESSAGE 4096 |
| #define | SIR_MAXMESSAGE 4096 |
| The maximum number of characters allowable in one log message. | |
| @@ -281,7 +282,7 @@ #define | SIR_MAXERROR 256 |
| The maximum size, in characters, of an error message. | |
| #define | SIR_ERRORFORMAT "Error in %s (%s:%u): '%s'" |
| #define | SIR_ERRORFORMAT "Error in %s (%s:%u): '%s'" |
| The format string for error messages returned by sir_geterror. | |
| @@ -316,7 +317,7 @@ #define | SIR_NUMOPTIONS 8 |
| The number of actual options; SIRO_ALL, SIRO_DEFAULT, and SIRO_MSGONLY are pseudo options that end up being mapped (or not) to the others. | |
| #define | SIR_HNAME_CHK_INTERVAL 60 |
| #define | SIR_HNAME_CHK_INTERVAL 60 |
| The number of seconds to let elapse before checking if the hostname needs refreshing. | |
| @@ -329,15 +330,15 @@ | |
| #define | SIR_SQUELCH_THRESHOLD 5 |
| The number of consecutive duplicate messages that will cause libsir to squelch further identical messages, and instead log the message SIR_SQUELCH_MSG_FORMAT. | |
| The number of consecutive duplicate messages that will cause libsir to squelch further identical messages, and instead log the message SIR_SQUELCH_MSG_FORMAT. | |
| #define | SIR_SQUELCH_BACKOFF_FACTOR 2 |
| If duplicate messages continue to be logged after the threshold is met, the threshold will be multiplied by this number, resulting in longer intervals between SIR_SQUELCH_MSG_FORMAT messages. | |
| If duplicate messages continue to be logged after the threshold is met, the threshold will be multiplied by this number, resulting in longer intervals between SIR_SQUELCH_MSG_FORMAT messages. | |
| #define | SIR_SQUELCH_MSG_FORMAT "previous message repeated %zu times" |
| The message to be logged when SIR_SQUELCH_THRESHOLD (or a multiple thereof) consecutive duplicate messages are logged. | |
| The message to be logged when SIR_SQUELCH_THRESHOLD (or a multiple thereof) consecutive duplicate messages are logged. | |
Detailed Description
@@ -359,7 +360,7 @@
- #define SIR_EOL SIR_EOL_LF
+ #define SIR_EOL SIR_EOL_LF
@@ -404,7 +405,7 @@
-
@@ -416,7 +417,7 @@
-The string included in SIR_FHFORMAT when a logging session begins.
+The string included in SIR_FHFORMAT when a logging session begins.
- Remarks
- Only applies if SIRO_NOHDR is not set.
- #define SIR_FHFORMAT SIR_EOL SIR_EOL "----- %s %s -----" SIR_EOL SIR_EOL
+ #define SIR_FHFORMAT SIR_EOL SIR_EOL "----- %s %s -----" SIR_EOL SIR_EOL
@@ -425,11 +426,11 @@
@@ -446,7 +447,7 @@ Remarks Only applies if SIRO_NOHDR is not set.
- The first
%s format specifier is the message:
-- The second
%s is the current date/time in the format specified by SIR_FHTIMEFORMAT.
+- The second
%s is the current date/time in the format specified by SIR_FHTIMEFORMAT.
%s format specifier is the message:
%s is the current date/time in the format specified by SIR_FHTIMEFORMAT. %s is the current date/time in the format specified by SIR_FHTIMEFORMAT.
-The string included in SIR_FHFORMAT when a file is rolled/archived due to becoming larger than SIR_FROLLSIZE bytes in size.
+The string included in SIR_FHFORMAT when a file is rolled/archived due to becoming larger than SIR_FROLLSIZE bytes in size.
- Remarks
- Only applies if SIRO_NOHDR is not set.
The %s format specifier is the path of the archived file.
@@ -464,7 +465,7 @@
-The time format string used in file headers (see SIR_FHFORMAT).
+The time format string used in file headers (see SIR_FHFORMAT).
- Remarks
- Only applies if SIRO_NOHDR is not set.
Example
15:13:41 Fri 9 Jun 2023 (-0600)
@@ -485,8 +486,8 @@ SIR_FNAMETIMEFORMAT.
-The third %s is a sequence number, which may be used in the event that a log file with the same name already exists (i.e., 2 or more files are rolled/archived within a second). Its format is defined by SIR_FNAMESEQFORMAT.
+The second %s is the time stamp as defined by SIR_FNAMETIMEFORMAT.
+The third %s is a sequence number, which may be used in the event that a log file with the same name already exists (i.e., 2 or more files are rolled/archived within a second). Its format is defined by SIR_FNAMESEQFORMAT.
The fourth %s is the original file name including, and beyond the last full stop, if one was found.
Example
`oldname.log` -> `oldname-23-06-09-122049-1.log`
@@ -505,7 +506,7 @@
-The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
-1
@@ -522,7 +523,7 @@
-The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
2023-06-09-122049
@@ -608,7 +609,7 @@
The maximum number of characters allowable in one log message.
-This does not include accompanying formatted output (see SIR_MAXOUTPUT).
+This does not include accompanying formatted output (see SIR_MAXOUTPUT).
@@ -743,7 +744,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/config_8h_source.html b/docs/config_8h_source.html
index 8874a52f2..c956c4622 100644
--- a/docs/config_8h_source.html
+++ b/docs/config_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -384,7 +385,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/console_8h_source.html b/docs/console_8h_source.html
index bf506380a..8c999efd5 100644
--- a/docs/console_8h_source.html
+++ b/docs/console_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/cookie.js b/docs/cookie.js
new file mode 100644
index 000000000..53ad21d98
--- /dev/null
+++ b/docs/cookie.js
@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+ cookie_namespace: 'doxygen_',
+
+ readSetting(cookie,defVal) {
+ if (window.chrome) {
+ const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+ sessionStorage.getItem(this.cookie_namespace+cookie);
+ if (val) return val;
+ } else {
+ let myCookie = this.cookie_namespace+cookie+"=";
+ if (document.cookie) {
+ const index = document.cookie.indexOf(myCookie);
+ if (index != -1) {
+ const valStart = index + myCookie.length;
+ let valEnd = document.cookie.indexOf(";", valStart);
+ if (valEnd == -1) {
+ valEnd = document.cookie.length;
+ }
+ return document.cookie.substring(valStart, valEnd);
+ }
+ }
+ }
+ return defVal;
+ },
+
+ writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+ if (window.chrome) {
+ if (days==0) {
+ sessionStorage.setItem(this.cookie_namespace+cookie,val);
+ } else {
+ localStorage.setItem(this.cookie_namespace+cookie,val);
+ }
+ } else {
+ let date = new Date();
+ date.setTime(date.getTime()+(days*24*60*60*1000));
+ const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+ document.cookie = this.cookie_namespace + cookie + "=" +
+ val + "; SameSite=Lax;" + expiration + "path=/";
+ }
+ },
+
+ eraseSetting(cookie) {
+ if (window.chrome) {
+ if (localStorage.getItem(this.cookie_namespace+cookie)) {
+ localStorage.removeItem(this.cookie_namespace+cookie);
+ } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+ sessionStorage.removeItem(this.cookie_namespace+cookie);
+ }
+ } else {
+ this.writeSetting(cookie,'',-1);
+ }
+ },
+}
diff --git a/docs/defaults_8h.html b/docs/defaults_8h.html
index b742b4c17..c4b5fd011 100644
--- a/docs/defaults_8h.html
+++ b/docs/defaults_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/defaults_8h_source.html b/docs/defaults_8h_source.html
index 96e11ddaa..2c529901a 100644
--- a/docs/defaults_8h_source.html
+++ b/docs/defaults_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -265,7 +266,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
index 3cc1e0d28..3abcaea79 100644
--- a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
+++ b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_49e56c817e5e54854c35e136979f97ca.html b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
index 287fa94db..a05d101da 100644
--- a/docs/dir_49e56c817e5e54854c35e136979f97ca.html
+++ b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
index 50134e9f5..9a8f2aadb 100644
--- a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
+++ b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -132,7 +133,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
index ac52e9b30..5a9deb136 100644
--- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
+++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_89aa746955889ced97536d9f51ce6c73.html b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
index 0685ebed1..97e71bbec 100644
--- a/docs/dir_89aa746955889ced97536d9f51ce6c73.html
+++ b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -175,7 +176,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
index 88819b411..9c4c988e3 100644
--- a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
+++ b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
index 0901fb760..1004ee66c 100644
--- a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
+++ b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -127,7 +128,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
index 0218ffcbb..4d1d173ea 100644
--- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -135,7 +136,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d4f373425b53e326d93013419ec79018.html b/docs/dir_d4f373425b53e326d93013419ec79018.html
index 4e2e8d8fe..3ac0fc466 100644
--- a/docs/dir_d4f373425b53e326d93013419ec79018.html
+++ b/docs/dir_d4f373425b53e326d93013419ec79018.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html
new file mode 100644
index 000000000..fe7f70be1
--- /dev/null
+++ b/docs/doxygen_crawl.html
@@ -0,0 +1,207 @@
+
+
+
+Validator / crawler helper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
index 71c1dbd44..00dca41ad 100644
--- a/docs/dynsections.js
+++ b/docs/dynsections.js
@@ -22,171 +22,173 @@
@licend The above is the entire license notice for the JavaScript code in this file
*/
-function toggleVisibility(linkObj)
-{
- var base = $(linkObj).attr('id');
- var summary = $('#'+base+'-summary');
- var content = $('#'+base+'-content');
- var trigger = $('#'+base+'-trigger');
- var src=$(trigger).attr('src');
- if (content.is(':visible')===true) {
- content.hide();
- summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
- } else {
- content.show();
- summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
- }
- return false;
-}
-
-function updateStripes()
-{
- $('table.directory tr').
- removeClass('even').filter(':visible:even').addClass('even');
- $('table.directory tr').
- removeClass('odd').filter(':visible:odd').addClass('odd');
-}
-
-function toggleLevel(level)
-{
- $('table.directory tr').each(function() {
- var l = this.id.split('_').length-1;
- var i = $('#img'+this.id.substring(3));
- var a = $('#arr'+this.id.substring(3));
- if (l');
- // add vertical lines to other rows
- $('span[class=lineno]').not(':eq(0)').append('');
- // add toggle controls to lines with fold divs
- $('div[class=foldopen]').each(function() {
- // extract specific id to use
- var id = $(this).attr('id').replace('foldopen','');
- // extract start and end foldable fragment attributes
- var start = $(this).attr('data-start');
- var end = $(this).attr('data-end');
- // replace normal fold span with controls for the first line of a foldable fragment
- $(this).find('span[class=fold]:first').replaceWith('');
- // append div for folded (closed) representation
- $(this).after('');
- // extract the first line from the "open" section to represent closed content
- var line = $(this).children().first().clone();
- // remove any glow that might still be active on the original line
- $(line).removeClass('glow');
- if (start) {
- // if line already ends with a start marker (e.g. trailing {), remove it
- $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ this.updateStripes();
+ },
+
+ toggleFolder : function(id) {
+ // the clicked row
+ const currentRow = $('#row_'+id);
+
+ // all rows after the clicked row
+ const rows = currentRow.nextAll("tr");
+
+ const re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
+
+ // only match elements AFTER this one (can't hide elements before)
+ const childRows = rows.filter(function() { return this.id.match(re); });
+
+ // first row is visible we are HIDING
+ if (childRows.filter(':first').is(':visible')===true) {
+ // replace down arrow by right arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ currentRowSpans.filter(".arrow").html('►');
+ rows.filter("[id^=row_"+id+"]").hide(); // hide all children
+ } else { // we are SHOWING
+ // replace right arrow by down arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfclosed").removeClass("iconfclosed").addClass("iconfopen");
+ currentRowSpans.filter(".arrow").html('▼');
+ // replace down arrows by right arrows for child rows
+ const childRowsSpans = childRows.find("span");
+ childRowsSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ childRowsSpans.filter(".arrow").html('►');
+ childRows.show(); //show all children
}
- // replace minus with plus symbol
- $(line).find('span[class=fold]').css('background-image',plusImg[relPath]);
- // append ellipsis
- $(line).append(' '+start+'…'+end);
- // insert constructed line into closed div
- $('#foldclosed'+id).html(line);
- });
-}
-
+ this.updateStripes();
+ },
+
+ toggleInherit : function(id) {
+ const rows = $('tr.inherit.'+id);
+ const img = $('tr.inherit_header.'+id+' img');
+ const src = $(img).attr('src');
+ if (rows.filter(':first').is(':visible')===true) {
+ rows.css('display','none');
+ $(img).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ rows.css('display','table-row'); // using show() causes jump in firefox
+ $(img).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ },
+};
+
+let codefold = {
+ opened : true,
+
+ // in case HTML_COLORSTYLE is LIGHT or DARK the vars will be replaced, so we write them out explicitly and use double quotes
+ plusImg: [ "url('plusd.svg')", "url('../../plusd.svg')" ],
+ minusImg: [ "url('minusd.svg')", "url('../../minusd.svg')" ],
+
+ // toggle all folding blocks
+ toggle_all : function(relPath) {
+ if (this.opened) {
+ $('#fold_all').css('background-image',this.plusImg[relPath]);
+ $('div[id^=foldopen]').hide();
+ $('div[id^=foldclosed]').show();
+ } else {
+ $('#fold_all').css('background-image',this.minusImg[relPath]);
+ $('div[id^=foldopen]').show();
+ $('div[id^=foldclosed]').hide();
+ }
+ this.opened=!this.opened;
+ },
+
+ // toggle single folding block
+ toggle : function(id) {
+ $('#foldopen'+id).toggle();
+ $('#foldclosed'+id).toggle();
+ },
+
+ init : function(relPath) {
+ $('span[class=lineno]').css({
+ 'padding-right':'4px',
+ 'margin-right':'2px',
+ 'display':'inline-block',
+ 'width':'54px',
+ 'background':'linear-gradient(#808080,#808080) no-repeat 46px/2px 100%'
+ });
+ // add global toggle to first line
+ $('span[class=lineno]:first').append('');
+ // add vertical lines to other rows
+ $('span[class=lineno]').not(':eq(0)').append('');
+ // add toggle controls to lines with fold divs
+ $('div[class=foldopen]').each(function() {
+ // extract specific id to use
+ const id = $(this).attr('id').replace('foldopen','');
+ // extract start and end foldable fragment attributes
+ const start = $(this).attr('data-start');
+ const end = $(this).attr('data-end');
+ // replace normal fold span with controls for the first line of a foldable fragment
+ $(this).find('span[class=fold]:first').replaceWith('');
+ // append div for folded (closed) representation
+ $(this).after('');
+ // extract the first line from the "open" section to represent closed content
+ const line = $(this).children().first().clone();
+ // remove any glow that might still be active on the original line
+ $(line).removeClass('glow');
+ if (start) {
+ // if line already ends with a start marker (e.g. trailing {), remove it
+ $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ }
+ // replace minus with plus symbol
+ $(line).find('span[class=fold]').css('background-image',codefold.plusImg[relPath]);
+ // append ellipsis
+ $(line).append(' '+start+'…'+end);
+ // insert constructed line into closed div
+ $('#foldclosed'+id).html(line);
+ });
+ },
+};
/* @license-end */
diff --git a/docs/errors_8h_source.html b/docs/errors_8h_source.html
index 508fdf3f6..4db3d46b1 100644
--- a/docs/errors_8h_source.html
+++ b/docs/errors_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -298,7 +299,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/example_8c.html b/docs/example_8c.html
index 103f15316..a19ee0ad2 100644
--- a/docs/example_8c.html
+++ b/docs/example_8c.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -121,13 +122,13 @@
Functions
int report_error (void) int report_error (void) Prints the last libsir error to stderr.
void report_warning (const char *warning) void report_warning (const char *warning) Prints a warning message along with the last libsir error to stderr.
int main (void) int main (void) This is a basic example of initializing and configuring libsir for use.
@@ -151,8 +152,7 @@ int main
(
- void
- )
+ void )
int report_error
(
- void
- )
+ void )
void report_warning
(
- const char *
- warning )
+ const char * warning )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filecache_8h_source.html b/docs/filecache_8h_source.html
index 58caf1bae..0e61ea42b 100644
--- a/docs/filecache_8h_source.html
+++ b/docs/filecache_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -207,7 +208,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/files.html b/docs/files.html
index 74aae1a9f..f52455e99 100644
--- a/docs/files.html
+++ b/docs/files.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -114,11 +115,11 @@
Here is a list of all documented files with brief descriptions:
-[detail level 123]
- ▼ example
+ ▼ example example.c A simple demonstration of initialization, configuration, and basic usage of libsir ▼ include ▼ sir ▼ include ▼ sir ansimacros.h ANSI escape sequence macros condition.h config.h Compile-time configuration wineventlog.h sir.h Public interface to libsir sir.hh C++ interface to libsir ▼ plugins ▼ sample ▼ plugins ▼ sample plugin_sample.h ▼ src ▼ src sir.c Public interface to libsir sircondition.c ▼ tests ▼ tests tests++.hh tests.h tests_malloc.h
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filesystem_8h_source.html b/docs/filesystem_8h_source.html
index 4871d831d..d6d3509b6 100644
--- a/docs/filesystem_8h_source.html
+++ b/docs/filesystem_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -222,7 +223,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions.html b/docs/functions.html
index ce4c8aed5..59022523d 100644
--- a/docs/functions.html
+++ b/docs/functions.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -271,7 +272,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_func.html b/docs/functions_func.html
index cb77c0ae0..21b125620 100644
--- a/docs/functions_func.html
+++ b/docs/functions_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_vars.html b/docs/functions_vars.html
index 73569c835..497bf9b6f 100644
--- a/docs/functions_vars.html
+++ b/docs/functions_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -252,7 +253,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals.html b/docs/globals.html
index bf2f8e7d8..18a27c580 100644
--- a/docs/globals.html
+++ b/docs/globals.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -291,7 +292,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_defs.html b/docs/globals_defs.html
index a1c9362ec..d6497fbfd 100644
--- a/docs/globals_defs.html
+++ b/docs/globals_defs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -221,7 +222,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_func.html b/docs/globals_func.html
index 50e58d8d7..ec8bf8e66 100644
--- a/docs/globals_func.html
+++ b/docs/globals_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -174,7 +175,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_vars.html b/docs/globals_vars.html
index 05f07ec1f..090fcb904 100644
--- a/docs/globals_vars.html
+++ b/docs/globals_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/graph_legend.html b/docs/graph_legend.html
index c2791ac76..02bb5368d 100644
--- a/docs/graph_legend.html
+++ b/docs/graph_legend.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -179,7 +180,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.html b/docs/group__cpp.html
index bd3e677ad..01f2a417c 100644
--- a/docs/group__cpp.html
+++ b/docs/group__cpp.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.map b/docs/group__cpp.map
index 3cddb093b..5acc3c6c2 100644
--- a/docs/group__cpp.map
+++ b/docs/group__cpp.map
@@ -1,5 +1,5 @@
diff --git a/docs/group__cpp.md5 b/docs/group__cpp.md5
index 891a96f59..815a92132 100644
--- a/docs/group__cpp.md5
+++ b/docs/group__cpp.md5
@@ -1 +1 @@
-462b92518fe0cc3c91f0d70199ee7926
\ No newline at end of file
+f24d7dff3b01a595a06f85abf0c13140
\ No newline at end of file
diff --git a/docs/group__cpp.svg b/docs/group__cpp.svg
index 8835f76d2..b2c3882c1 100644
--- a/docs/group__cpp.svg
+++ b/docs/group__cpp.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__cpp_org.svg b/docs/group__cpp_org.svg
index e0ef50308..1b8ad1580 100644
--- a/docs/group__cpp_org.svg
+++ b/docs/group__cpp_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__default.html b/docs/group__default.html
index d8c337c35..b0beeb479 100644
--- a/docs/group__default.html
+++ b/docs/group__default.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -115,63 +116,60 @@
Defaults
-
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
-More...
Detailed Description
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
+Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
- See also
- SIRO_DEFAULT
-
SIRL_DEFAULT
@@ -660,7 +658,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__plugins.html b/docs/group__plugins.html
index a022001ff..fa690d928 100644
--- a/docs/group__plugins.html
+++ b/docs/group__plugins.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -118,16 +119,16 @@
Functions
PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) Called by libsir after the plugin library object is loaded, but before any other functions are probed or called.
PLUGIN_EXPORT bool sir_plugin_init (void) PLUGIN_EXPORT bool sir_plugin_init (void) Called by libsir after the plugin is queried and successfully validated.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_cleanup (void) PLUGIN_EXPORT bool sir_plugin_cleanup (void) Called by libsir when the plugin is about to be unloaded.
@@ -199,7 +200,7 @@ Creating your own plugin
static const char* desc = "Logs messages and function calls to stdout.";
static const uint64_t caps = 0ULL;
-
+
info->iface_ver = SIR_PLUGIN_VCURRENT;
info->maj_ver = maj_ver;
info->min_ver = min_ver;
@@ -214,28 +215,28 @@ Creating your own plugin
return true;
}
-
+
return true;
}
-
+
__func__, level, message);
return true;
}
-
+
return true;
}
ANSI escape sequence macros.
-PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
-PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
-PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
-PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
+PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
+PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
+PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
+PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
@@ -268,8 +269,7 @@ PLUGIN_EXPORT bool sir_plugin_cleanup
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_init
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_query
(
- sir_plugininfo *
- info )
+ sir_plugininfo * info )
sir_option
-Defaults
+Defaults
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
(
- sir_level
- level,
+ sir_level level,
const char *
- message
-
-
- )
- const char * message )
-Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
+Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
The message string will be pre-formatted according to the sir_option set in the opts bitmask of the sir_plugininfo structure.
-
+
@@ -84,7 +85,7 @@
-
-Functions and types that comprise the public interface to libsir.
-More...
Collaboration diagram for Public Interface:
@@ -125,12 +123,15 @@
-Modules
Functions
Types
C++ Wrapper
Detailed Description
@@ -141,7 +142,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__public.map b/docs/group__public.map
index ebdfeaff4..64aee1563 100644
--- a/docs/group__public.map
+++ b/docs/group__public.map
@@ -1,6 +1,6 @@
diff --git a/docs/group__public.md5 b/docs/group__public.md5
index ed48908b4..7a1ce9965 100644
--- a/docs/group__public.md5
+++ b/docs/group__public.md5
@@ -1 +1 @@
-f1c3db5e4bd882209737e22a617d9779
\ No newline at end of file
+39105cf86342456b103521902c43f5ea
\ No newline at end of file
diff --git a/docs/group__public.svg b/docs/group__public.svg
index fc21fb067..f5a782426 100644
--- a/docs/group__public.svg
+++ b/docs/group__public.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__public_org.svg b/docs/group__public_org.svg
index d07be5f40..c15a4d330 100644
--- a/docs/group__public_org.svg
+++ b/docs/group__public_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publicfuncs.html b/docs/group__publicfuncs.html
index ff96dc7ea..d8d2ed1c0 100644
--- a/docs/group__publicfuncs.html
+++ b/docs/group__publicfuncs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -123,109 +124,109 @@
Functions
bool sir_makeinit (sirinit *si) bool sir_makeinit (sirinit *si) Fills out a sirinit structure with default values.
bool sir_init (sirinit *si) bool sir_init (sirinit *si) Initializes libsir for use.
bool sir_cleanup (void) bool sir_cleanup (void) Tears down and cleans up libsir after use.
bool sir_isinitialized (void) bool sir_isinitialized (void) Determines whether or not libsir is in the initialized state.
uint16_t sir_geterror (char message[SIR_MAXERROR]) 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 associated error code.
void sir_geterrorinfo (sir_errorinfo *err) void sir_geterrorinfo (sir_errorinfo *err) Retrieves granular information about the last error that occurred on the calling thread.
bool sir_debug (PRINTF_FORMAT const char *format,...) bool sir_debug (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_DEBUG level message.
bool sir_info (PRINTF_FORMAT const char *format,...) bool sir_info (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_INFO level message.
bool sir_notice (PRINTF_FORMAT const char *format,...) bool sir_notice (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_NOTICE level message.
bool sir_warn (PRINTF_FORMAT const char *format,...) bool sir_warn (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_WARN level message.
bool sir_error (PRINTF_FORMAT const char *format,...) bool sir_error (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ERROR level message.
bool sir_crit (PRINTF_FORMAT const char *format,...) bool sir_crit (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_CRIT level message.
bool sir_alert (PRINTF_FORMAT const char *format,...) bool sir_alert (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ALERT level message.
bool sir_emerg (PRINTF_FORMAT const char *format,...) bool sir_emerg (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_EMERG level message.
sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) Adds a log file and registers it to receive log output.
bool sir_remfile (sirfileid id) bool sir_remfile (sirfileid id) Removes a file previously added to libsir.
sirpluginid sir_loadplugin (const char *path) sirpluginid sir_loadplugin (const char *path) Loads a plugin module from disk.
bool sir_unloadplugin (sirpluginid id) bool sir_unloadplugin (sirpluginid id) Unloads a previously registered plugin module.
bool sir_filelevels (sirfileid id, sir_levels levels) bool sir_filelevels (sirfileid id, sir_levels levels) Set new level registrations for a log file already managed by libsir.
bool sir_fileopts (sirfileid id, sir_options opts) bool sir_fileopts (sirfileid id, sir_options opts) Set new formatting options for a log file already managed by libsir.
bool sir_settextstyle (sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg) 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.
bool sir_resettextstyles (void) bool sir_resettextstyles (void) Reset text styling for stdio (stdout/stderr) destinations to their default values.
sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) Creates a sir_textcolor from red, green, and blue components.
bool sir_setcolormode (sir_colormode mode) bool sir_setcolormode (sir_colormode mode) Sets the ANSI color mode for stdio destinations.
bool sir_stdoutlevels (sir_levels levels) bool sir_stdoutlevels (sir_levels levels) Set new level registrations for stdout.
bool sir_stdoutopts (sir_options opts) bool sir_stdoutopts (sir_options opts) Set new formatting options for stdout.
bool sir_stderrlevels (sir_levels levels) bool sir_stderrlevels (sir_levels levels) Set new level registrations for stderr.
bool sir_stderropts (sir_options opts) bool sir_stderropts (sir_options opts) Set new formatting options for stderr.
bool sir_sysloglevels (sir_levels levels) bool sir_sysloglevels (sir_levels levels) Set new level registrations for the system logger destination.
bool sir_syslogopts (sir_options opts) bool sir_syslogopts (sir_options opts) Set new formatting options for the system logger destination.
bool sir_syslogid (const char *identity) bool sir_syslogid (const char *identity) Set new system logger identity.
bool sir_syslogcat (const char *category) bool sir_syslogcat (const char *category) Set new system logger category.
const char * sir_getversionstring (void) const char * sir_getversionstring (void) Returns the current libsir version as a string.
uint32_t sir_getversionhex (void) uint32_t sir_getversionhex (void) Returns the current libsir version as a number.
bool sir_isprerelease (void) bool sir_isprerelease (void) Whether or not this is a pre-release version of libsir.
@@ -240,25 +241,17 @@ sirfileid sir_addfile
(
- const char *
- path,
+ const char * path,
sir_levels
- levels,
+ sir_levels levels,
sir_options
- opts
-
-
- )
- sir_options opts )
@@ -273,8 +266,8 @@ sir_filelevels and sir_fileopts, respectively.
-- See also
- sir_remfile
+To change the file's level registrations or options after adding it, call sir_filelevels and sir_fileopts, respectively.
+- See also
- sir_remfile
- Parameters
-
Dispatches a SIRL_ALERT level message.
The message will be delivered to all destinations registered to receive alert-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Tears down and cleans up libsir after use.
-Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
-May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
-- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
+May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
+- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -364,31 +349,24 @@ bool sir_crit
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_CRIT level message.
The message will be delivered to all destinations registered to receive critical-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_DEBUG level message.
The message will be delivered to all destinations registered to receive debug-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_EMERG level message.
The message will be delivered to all destinations registered to receive emergency-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_ERROR level message.
The message will be delivered to all destinations registered to receive error-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
@@ -566,7 +516,7 @@ See also sir_fileopts
+- See also
- sir_fileopts
- Parameters
-
@@ -610,7 +553,7 @@ SIRO_ALL
SIRO_NOHOST
-- See also
- sir_filelevels
+- See also
- sir_filelevels
- Parameters
-
Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.
-To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
+To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -660,15 +602,14 @@ void sir_geterrorinfo
(
- sir_errorinfo *
- err )
+ sir_errorinfo * err )
Retrieves granular information about the last error that occurred on the calling thread.
-To retrieve just an error code and a formatted message, use sir_geterror.
+To retrieve just an error code and a formatted message, use sir_geterror.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -688,8 +629,7 @@ uint32_t sir_getversionhex
(
- void
- )
+ void )
@@ -710,8 +650,7 @@ const char * sir_getversionstring
(
- void
- )
+ void )
bool sir_info
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_INFO level message.
The message will be delivered to all destinations registered to receive information-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Initializes libsir for use.
-Must be called before making any other calls into libsir (with the exception of sir_makeinit).
-For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
-- See also
- sir_makeinit
+Must be called before making any other calls into libsir (with the exception of sir_makeinit).
+For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
+- See also
- sir_makeinit
-
-sir_cleanup
+sir_cleanup
- Parameters
-
si Pointer to a sirinit structure containing the desired settings and configuration. libsir makes a copy of this structure, so its lifetime is not a concern.
-- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -811,8 +742,7 @@ bool sir_isinitialized
(
- void
- )
+ void )
Remarks Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
-- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
+- Remarks
- Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
+- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
@@ -834,8 +764,7 @@ bool sir_isprerelease
(
- void
- )
+ void )
sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
%s format specifier is the path of the archived file. The time format string used in file headers (see SIR_FHFORMAT).
+The time format string used in file headers (see SIR_FHFORMAT).
- Remarks
- Only applies if SIRO_NOHDR is not set.
Example
15:13:41 Fri 9 Jun 2023 (-0600)
SIR_FNAMETIMEFORMAT.
-The third %s is a sequence number, which may be used in the event that a log file with the same name already exists (i.e., 2 or more files are rolled/archived within a second). Its format is defined by SIR_FNAMESEQFORMAT.
+The second %s is the time stamp as defined by SIR_FNAMETIMEFORMAT.
+The third %s is a sequence number, which may be used in the event that a log file with the same name already exists (i.e., 2 or more files are rolled/archived within a second). Its format is defined by SIR_FNAMESEQFORMAT.
The fourth %s is the original file name including, and beyond the last full stop, if one was found.
Example
`oldname.log` -> `oldname-23-06-09-122049-1.log`
@@ -505,7 +506,7 @@
-The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
-1
@@ -522,7 +523,7 @@
-The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
2023-06-09-122049
@@ -608,7 +609,7 @@
The maximum number of characters allowable in one log message.
-This does not include accompanying formatted output (see SIR_MAXOUTPUT).
+This does not include accompanying formatted output (see SIR_MAXOUTPUT).
@@ -743,7 +744,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/config_8h_source.html b/docs/config_8h_source.html
index 8874a52f2..c956c4622 100644
--- a/docs/config_8h_source.html
+++ b/docs/config_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -384,7 +385,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/console_8h_source.html b/docs/console_8h_source.html
index bf506380a..8c999efd5 100644
--- a/docs/console_8h_source.html
+++ b/docs/console_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/cookie.js b/docs/cookie.js
new file mode 100644
index 000000000..53ad21d98
--- /dev/null
+++ b/docs/cookie.js
@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+ cookie_namespace: 'doxygen_',
+
+ readSetting(cookie,defVal) {
+ if (window.chrome) {
+ const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+ sessionStorage.getItem(this.cookie_namespace+cookie);
+ if (val) return val;
+ } else {
+ let myCookie = this.cookie_namespace+cookie+"=";
+ if (document.cookie) {
+ const index = document.cookie.indexOf(myCookie);
+ if (index != -1) {
+ const valStart = index + myCookie.length;
+ let valEnd = document.cookie.indexOf(";", valStart);
+ if (valEnd == -1) {
+ valEnd = document.cookie.length;
+ }
+ return document.cookie.substring(valStart, valEnd);
+ }
+ }
+ }
+ return defVal;
+ },
+
+ writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+ if (window.chrome) {
+ if (days==0) {
+ sessionStorage.setItem(this.cookie_namespace+cookie,val);
+ } else {
+ localStorage.setItem(this.cookie_namespace+cookie,val);
+ }
+ } else {
+ let date = new Date();
+ date.setTime(date.getTime()+(days*24*60*60*1000));
+ const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+ document.cookie = this.cookie_namespace + cookie + "=" +
+ val + "; SameSite=Lax;" + expiration + "path=/";
+ }
+ },
+
+ eraseSetting(cookie) {
+ if (window.chrome) {
+ if (localStorage.getItem(this.cookie_namespace+cookie)) {
+ localStorage.removeItem(this.cookie_namespace+cookie);
+ } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+ sessionStorage.removeItem(this.cookie_namespace+cookie);
+ }
+ } else {
+ this.writeSetting(cookie,'',-1);
+ }
+ },
+}
diff --git a/docs/defaults_8h.html b/docs/defaults_8h.html
index b742b4c17..c4b5fd011 100644
--- a/docs/defaults_8h.html
+++ b/docs/defaults_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/defaults_8h_source.html b/docs/defaults_8h_source.html
index 96e11ddaa..2c529901a 100644
--- a/docs/defaults_8h_source.html
+++ b/docs/defaults_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -265,7 +266,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
index 3cc1e0d28..3abcaea79 100644
--- a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
+++ b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_49e56c817e5e54854c35e136979f97ca.html b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
index 287fa94db..a05d101da 100644
--- a/docs/dir_49e56c817e5e54854c35e136979f97ca.html
+++ b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
index 50134e9f5..9a8f2aadb 100644
--- a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
+++ b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -132,7 +133,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
index ac52e9b30..5a9deb136 100644
--- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
+++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_89aa746955889ced97536d9f51ce6c73.html b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
index 0685ebed1..97e71bbec 100644
--- a/docs/dir_89aa746955889ced97536d9f51ce6c73.html
+++ b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -175,7 +176,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
index 88819b411..9c4c988e3 100644
--- a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
+++ b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
index 0901fb760..1004ee66c 100644
--- a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
+++ b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -127,7 +128,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
index 0218ffcbb..4d1d173ea 100644
--- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -135,7 +136,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d4f373425b53e326d93013419ec79018.html b/docs/dir_d4f373425b53e326d93013419ec79018.html
index 4e2e8d8fe..3ac0fc466 100644
--- a/docs/dir_d4f373425b53e326d93013419ec79018.html
+++ b/docs/dir_d4f373425b53e326d93013419ec79018.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html
new file mode 100644
index 000000000..fe7f70be1
--- /dev/null
+++ b/docs/doxygen_crawl.html
@@ -0,0 +1,207 @@
+
+
+
+Validator / crawler helper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
index 71c1dbd44..00dca41ad 100644
--- a/docs/dynsections.js
+++ b/docs/dynsections.js
@@ -22,171 +22,173 @@
@licend The above is the entire license notice for the JavaScript code in this file
*/
-function toggleVisibility(linkObj)
-{
- var base = $(linkObj).attr('id');
- var summary = $('#'+base+'-summary');
- var content = $('#'+base+'-content');
- var trigger = $('#'+base+'-trigger');
- var src=$(trigger).attr('src');
- if (content.is(':visible')===true) {
- content.hide();
- summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
- } else {
- content.show();
- summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
- }
- return false;
-}
-
-function updateStripes()
-{
- $('table.directory tr').
- removeClass('even').filter(':visible:even').addClass('even');
- $('table.directory tr').
- removeClass('odd').filter(':visible:odd').addClass('odd');
-}
-
-function toggleLevel(level)
-{
- $('table.directory tr').each(function() {
- var l = this.id.split('_').length-1;
- var i = $('#img'+this.id.substring(3));
- var a = $('#arr'+this.id.substring(3));
- if (l');
- // add vertical lines to other rows
- $('span[class=lineno]').not(':eq(0)').append('');
- // add toggle controls to lines with fold divs
- $('div[class=foldopen]').each(function() {
- // extract specific id to use
- var id = $(this).attr('id').replace('foldopen','');
- // extract start and end foldable fragment attributes
- var start = $(this).attr('data-start');
- var end = $(this).attr('data-end');
- // replace normal fold span with controls for the first line of a foldable fragment
- $(this).find('span[class=fold]:first').replaceWith('');
- // append div for folded (closed) representation
- $(this).after('');
- // extract the first line from the "open" section to represent closed content
- var line = $(this).children().first().clone();
- // remove any glow that might still be active on the original line
- $(line).removeClass('glow');
- if (start) {
- // if line already ends with a start marker (e.g. trailing {), remove it
- $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ this.updateStripes();
+ },
+
+ toggleFolder : function(id) {
+ // the clicked row
+ const currentRow = $('#row_'+id);
+
+ // all rows after the clicked row
+ const rows = currentRow.nextAll("tr");
+
+ const re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
+
+ // only match elements AFTER this one (can't hide elements before)
+ const childRows = rows.filter(function() { return this.id.match(re); });
+
+ // first row is visible we are HIDING
+ if (childRows.filter(':first').is(':visible')===true) {
+ // replace down arrow by right arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ currentRowSpans.filter(".arrow").html('►');
+ rows.filter("[id^=row_"+id+"]").hide(); // hide all children
+ } else { // we are SHOWING
+ // replace right arrow by down arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfclosed").removeClass("iconfclosed").addClass("iconfopen");
+ currentRowSpans.filter(".arrow").html('▼');
+ // replace down arrows by right arrows for child rows
+ const childRowsSpans = childRows.find("span");
+ childRowsSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ childRowsSpans.filter(".arrow").html('►');
+ childRows.show(); //show all children
}
- // replace minus with plus symbol
- $(line).find('span[class=fold]').css('background-image',plusImg[relPath]);
- // append ellipsis
- $(line).append(' '+start+'…'+end);
- // insert constructed line into closed div
- $('#foldclosed'+id).html(line);
- });
-}
-
+ this.updateStripes();
+ },
+
+ toggleInherit : function(id) {
+ const rows = $('tr.inherit.'+id);
+ const img = $('tr.inherit_header.'+id+' img');
+ const src = $(img).attr('src');
+ if (rows.filter(':first').is(':visible')===true) {
+ rows.css('display','none');
+ $(img).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ rows.css('display','table-row'); // using show() causes jump in firefox
+ $(img).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ },
+};
+
+let codefold = {
+ opened : true,
+
+ // in case HTML_COLORSTYLE is LIGHT or DARK the vars will be replaced, so we write them out explicitly and use double quotes
+ plusImg: [ "url('plusd.svg')", "url('../../plusd.svg')" ],
+ minusImg: [ "url('minusd.svg')", "url('../../minusd.svg')" ],
+
+ // toggle all folding blocks
+ toggle_all : function(relPath) {
+ if (this.opened) {
+ $('#fold_all').css('background-image',this.plusImg[relPath]);
+ $('div[id^=foldopen]').hide();
+ $('div[id^=foldclosed]').show();
+ } else {
+ $('#fold_all').css('background-image',this.minusImg[relPath]);
+ $('div[id^=foldopen]').show();
+ $('div[id^=foldclosed]').hide();
+ }
+ this.opened=!this.opened;
+ },
+
+ // toggle single folding block
+ toggle : function(id) {
+ $('#foldopen'+id).toggle();
+ $('#foldclosed'+id).toggle();
+ },
+
+ init : function(relPath) {
+ $('span[class=lineno]').css({
+ 'padding-right':'4px',
+ 'margin-right':'2px',
+ 'display':'inline-block',
+ 'width':'54px',
+ 'background':'linear-gradient(#808080,#808080) no-repeat 46px/2px 100%'
+ });
+ // add global toggle to first line
+ $('span[class=lineno]:first').append('');
+ // add vertical lines to other rows
+ $('span[class=lineno]').not(':eq(0)').append('');
+ // add toggle controls to lines with fold divs
+ $('div[class=foldopen]').each(function() {
+ // extract specific id to use
+ const id = $(this).attr('id').replace('foldopen','');
+ // extract start and end foldable fragment attributes
+ const start = $(this).attr('data-start');
+ const end = $(this).attr('data-end');
+ // replace normal fold span with controls for the first line of a foldable fragment
+ $(this).find('span[class=fold]:first').replaceWith('');
+ // append div for folded (closed) representation
+ $(this).after('');
+ // extract the first line from the "open" section to represent closed content
+ const line = $(this).children().first().clone();
+ // remove any glow that might still be active on the original line
+ $(line).removeClass('glow');
+ if (start) {
+ // if line already ends with a start marker (e.g. trailing {), remove it
+ $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ }
+ // replace minus with plus symbol
+ $(line).find('span[class=fold]').css('background-image',codefold.plusImg[relPath]);
+ // append ellipsis
+ $(line).append(' '+start+'…'+end);
+ // insert constructed line into closed div
+ $('#foldclosed'+id).html(line);
+ });
+ },
+};
/* @license-end */
diff --git a/docs/errors_8h_source.html b/docs/errors_8h_source.html
index 508fdf3f6..4db3d46b1 100644
--- a/docs/errors_8h_source.html
+++ b/docs/errors_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -298,7 +299,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/example_8c.html b/docs/example_8c.html
index 103f15316..a19ee0ad2 100644
--- a/docs/example_8c.html
+++ b/docs/example_8c.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -121,13 +122,13 @@
Functions
int report_error (void) int report_error (void) Prints the last libsir error to stderr.
void report_warning (const char *warning) void report_warning (const char *warning) Prints a warning message along with the last libsir error to stderr.
int main (void) int main (void) This is a basic example of initializing and configuring libsir for use.
@@ -151,8 +152,7 @@ int main
(
- void
- )
+ void )
int report_error
(
- void
- )
+ void )
void report_warning
(
- const char *
- warning )
+ const char * warning )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filecache_8h_source.html b/docs/filecache_8h_source.html
index 58caf1bae..0e61ea42b 100644
--- a/docs/filecache_8h_source.html
+++ b/docs/filecache_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -207,7 +208,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/files.html b/docs/files.html
index 74aae1a9f..f52455e99 100644
--- a/docs/files.html
+++ b/docs/files.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -114,11 +115,11 @@
Here is a list of all documented files with brief descriptions:
-[detail level 123]
- ▼ example
+ ▼ example example.c A simple demonstration of initialization, configuration, and basic usage of libsir ▼ include ▼ sir ▼ include ▼ sir ansimacros.h ANSI escape sequence macros condition.h config.h Compile-time configuration wineventlog.h sir.h Public interface to libsir sir.hh C++ interface to libsir ▼ plugins ▼ sample ▼ plugins ▼ sample plugin_sample.h ▼ src ▼ src sir.c Public interface to libsir sircondition.c ▼ tests ▼ tests tests++.hh tests.h tests_malloc.h
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filesystem_8h_source.html b/docs/filesystem_8h_source.html
index 4871d831d..d6d3509b6 100644
--- a/docs/filesystem_8h_source.html
+++ b/docs/filesystem_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -222,7 +223,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions.html b/docs/functions.html
index ce4c8aed5..59022523d 100644
--- a/docs/functions.html
+++ b/docs/functions.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -271,7 +272,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_func.html b/docs/functions_func.html
index cb77c0ae0..21b125620 100644
--- a/docs/functions_func.html
+++ b/docs/functions_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_vars.html b/docs/functions_vars.html
index 73569c835..497bf9b6f 100644
--- a/docs/functions_vars.html
+++ b/docs/functions_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -252,7 +253,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals.html b/docs/globals.html
index bf2f8e7d8..18a27c580 100644
--- a/docs/globals.html
+++ b/docs/globals.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -291,7 +292,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_defs.html b/docs/globals_defs.html
index a1c9362ec..d6497fbfd 100644
--- a/docs/globals_defs.html
+++ b/docs/globals_defs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -221,7 +222,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_func.html b/docs/globals_func.html
index 50e58d8d7..ec8bf8e66 100644
--- a/docs/globals_func.html
+++ b/docs/globals_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -174,7 +175,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_vars.html b/docs/globals_vars.html
index 05f07ec1f..090fcb904 100644
--- a/docs/globals_vars.html
+++ b/docs/globals_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/graph_legend.html b/docs/graph_legend.html
index c2791ac76..02bb5368d 100644
--- a/docs/graph_legend.html
+++ b/docs/graph_legend.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -179,7 +180,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.html b/docs/group__cpp.html
index bd3e677ad..01f2a417c 100644
--- a/docs/group__cpp.html
+++ b/docs/group__cpp.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.map b/docs/group__cpp.map
index 3cddb093b..5acc3c6c2 100644
--- a/docs/group__cpp.map
+++ b/docs/group__cpp.map
@@ -1,5 +1,5 @@
diff --git a/docs/group__cpp.md5 b/docs/group__cpp.md5
index 891a96f59..815a92132 100644
--- a/docs/group__cpp.md5
+++ b/docs/group__cpp.md5
@@ -1 +1 @@
-462b92518fe0cc3c91f0d70199ee7926
\ No newline at end of file
+f24d7dff3b01a595a06f85abf0c13140
\ No newline at end of file
diff --git a/docs/group__cpp.svg b/docs/group__cpp.svg
index 8835f76d2..b2c3882c1 100644
--- a/docs/group__cpp.svg
+++ b/docs/group__cpp.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__cpp_org.svg b/docs/group__cpp_org.svg
index e0ef50308..1b8ad1580 100644
--- a/docs/group__cpp_org.svg
+++ b/docs/group__cpp_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__default.html b/docs/group__default.html
index d8c337c35..b0beeb479 100644
--- a/docs/group__default.html
+++ b/docs/group__default.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -115,63 +116,60 @@
Defaults
-
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
-More...
Detailed Description
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
+Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
- See also
- SIRO_DEFAULT
-
SIRL_DEFAULT
@@ -660,7 +658,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__plugins.html b/docs/group__plugins.html
index a022001ff..fa690d928 100644
--- a/docs/group__plugins.html
+++ b/docs/group__plugins.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -118,16 +119,16 @@
Functions
PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) Called by libsir after the plugin library object is loaded, but before any other functions are probed or called.
PLUGIN_EXPORT bool sir_plugin_init (void) PLUGIN_EXPORT bool sir_plugin_init (void) Called by libsir after the plugin is queried and successfully validated.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_cleanup (void) PLUGIN_EXPORT bool sir_plugin_cleanup (void) Called by libsir when the plugin is about to be unloaded.
@@ -199,7 +200,7 @@ Creating your own plugin
static const char* desc = "Logs messages and function calls to stdout.";
static const uint64_t caps = 0ULL;
-
+
info->iface_ver = SIR_PLUGIN_VCURRENT;
info->maj_ver = maj_ver;
info->min_ver = min_ver;
@@ -214,28 +215,28 @@ Creating your own plugin
return true;
}
-
+
return true;
}
-
+
__func__, level, message);
return true;
}
-
+
return true;
}
ANSI escape sequence macros.
-PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
-PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
-PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
-PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
+PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
+PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
+PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
+PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
@@ -268,8 +269,7 @@ PLUGIN_EXPORT bool sir_plugin_cleanup
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_init
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_query
(
- sir_plugininfo *
- info )
+ sir_plugininfo * info )
sir_option
-Defaults
+Defaults
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
(
- sir_level
- level,
+ sir_level level,
const char *
- message
-
-
- )
- const char * message )
-Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
+Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
The message string will be pre-formatted according to the sir_option set in the opts bitmask of the sir_plugininfo structure.
-
+
@@ -84,7 +85,7 @@
-
-Functions and types that comprise the public interface to libsir.
-More...
Collaboration diagram for Public Interface:
@@ -125,12 +123,15 @@
-Modules
Functions
Types
C++ Wrapper
Detailed Description
@@ -141,7 +142,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__public.map b/docs/group__public.map
index ebdfeaff4..64aee1563 100644
--- a/docs/group__public.map
+++ b/docs/group__public.map
@@ -1,6 +1,6 @@
diff --git a/docs/group__public.md5 b/docs/group__public.md5
index ed48908b4..7a1ce9965 100644
--- a/docs/group__public.md5
+++ b/docs/group__public.md5
@@ -1 +1 @@
-f1c3db5e4bd882209737e22a617d9779
\ No newline at end of file
+39105cf86342456b103521902c43f5ea
\ No newline at end of file
diff --git a/docs/group__public.svg b/docs/group__public.svg
index fc21fb067..f5a782426 100644
--- a/docs/group__public.svg
+++ b/docs/group__public.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__public_org.svg b/docs/group__public_org.svg
index d07be5f40..c15a4d330 100644
--- a/docs/group__public_org.svg
+++ b/docs/group__public_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publicfuncs.html b/docs/group__publicfuncs.html
index ff96dc7ea..d8d2ed1c0 100644
--- a/docs/group__publicfuncs.html
+++ b/docs/group__publicfuncs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -123,109 +124,109 @@
Functions
bool sir_makeinit (sirinit *si) bool sir_makeinit (sirinit *si) Fills out a sirinit structure with default values.
bool sir_init (sirinit *si) bool sir_init (sirinit *si) Initializes libsir for use.
bool sir_cleanup (void) bool sir_cleanup (void) Tears down and cleans up libsir after use.
bool sir_isinitialized (void) bool sir_isinitialized (void) Determines whether or not libsir is in the initialized state.
uint16_t sir_geterror (char message[SIR_MAXERROR]) 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 associated error code.
void sir_geterrorinfo (sir_errorinfo *err) void sir_geterrorinfo (sir_errorinfo *err) Retrieves granular information about the last error that occurred on the calling thread.
bool sir_debug (PRINTF_FORMAT const char *format,...) bool sir_debug (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_DEBUG level message.
bool sir_info (PRINTF_FORMAT const char *format,...) bool sir_info (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_INFO level message.
bool sir_notice (PRINTF_FORMAT const char *format,...) bool sir_notice (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_NOTICE level message.
bool sir_warn (PRINTF_FORMAT const char *format,...) bool sir_warn (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_WARN level message.
bool sir_error (PRINTF_FORMAT const char *format,...) bool sir_error (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ERROR level message.
bool sir_crit (PRINTF_FORMAT const char *format,...) bool sir_crit (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_CRIT level message.
bool sir_alert (PRINTF_FORMAT const char *format,...) bool sir_alert (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ALERT level message.
bool sir_emerg (PRINTF_FORMAT const char *format,...) bool sir_emerg (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_EMERG level message.
sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) Adds a log file and registers it to receive log output.
bool sir_remfile (sirfileid id) bool sir_remfile (sirfileid id) Removes a file previously added to libsir.
sirpluginid sir_loadplugin (const char *path) sirpluginid sir_loadplugin (const char *path) Loads a plugin module from disk.
bool sir_unloadplugin (sirpluginid id) bool sir_unloadplugin (sirpluginid id) Unloads a previously registered plugin module.
bool sir_filelevels (sirfileid id, sir_levels levels) bool sir_filelevels (sirfileid id, sir_levels levels) Set new level registrations for a log file already managed by libsir.
bool sir_fileopts (sirfileid id, sir_options opts) bool sir_fileopts (sirfileid id, sir_options opts) Set new formatting options for a log file already managed by libsir.
bool sir_settextstyle (sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg) 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.
bool sir_resettextstyles (void) bool sir_resettextstyles (void) Reset text styling for stdio (stdout/stderr) destinations to their default values.
sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) Creates a sir_textcolor from red, green, and blue components.
bool sir_setcolormode (sir_colormode mode) bool sir_setcolormode (sir_colormode mode) Sets the ANSI color mode for stdio destinations.
bool sir_stdoutlevels (sir_levels levels) bool sir_stdoutlevels (sir_levels levels) Set new level registrations for stdout.
bool sir_stdoutopts (sir_options opts) bool sir_stdoutopts (sir_options opts) Set new formatting options for stdout.
bool sir_stderrlevels (sir_levels levels) bool sir_stderrlevels (sir_levels levels) Set new level registrations for stderr.
bool sir_stderropts (sir_options opts) bool sir_stderropts (sir_options opts) Set new formatting options for stderr.
bool sir_sysloglevels (sir_levels levels) bool sir_sysloglevels (sir_levels levels) Set new level registrations for the system logger destination.
bool sir_syslogopts (sir_options opts) bool sir_syslogopts (sir_options opts) Set new formatting options for the system logger destination.
bool sir_syslogid (const char *identity) bool sir_syslogid (const char *identity) Set new system logger identity.
bool sir_syslogcat (const char *category) bool sir_syslogcat (const char *category) Set new system logger category.
const char * sir_getversionstring (void) const char * sir_getversionstring (void) Returns the current libsir version as a string.
uint32_t sir_getversionhex (void) uint32_t sir_getversionhex (void) Returns the current libsir version as a number.
bool sir_isprerelease (void) bool sir_isprerelease (void) Whether or not this is a pre-release version of libsir.
@@ -240,25 +241,17 @@ sirfileid sir_addfile
(
- const char *
- path,
+ const char * path,
sir_levels
- levels,
+ sir_levels levels,
sir_options
- opts
-
-
- )
- sir_options opts )
@@ -273,8 +266,8 @@ sir_filelevels and sir_fileopts, respectively.
-- See also
- sir_remfile
+To change the file's level registrations or options after adding it, call sir_filelevels and sir_fileopts, respectively.
+- See also
- sir_remfile
- Parameters
-
Dispatches a SIRL_ALERT level message.
The message will be delivered to all destinations registered to receive alert-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Tears down and cleans up libsir after use.
-Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
-May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
-- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
+May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
+- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -364,31 +349,24 @@ bool sir_crit
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_CRIT level message.
The message will be delivered to all destinations registered to receive critical-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_DEBUG level message.
The message will be delivered to all destinations registered to receive debug-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_EMERG level message.
The message will be delivered to all destinations registered to receive emergency-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_ERROR level message.
The message will be delivered to all destinations registered to receive error-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
@@ -566,7 +516,7 @@ See also sir_fileopts
+- See also
- sir_fileopts
- Parameters
-
@@ -610,7 +553,7 @@ SIRO_ALL
SIRO_NOHOST
-- See also
- sir_filelevels
+- See also
- sir_filelevels
- Parameters
-
Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.
-To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
+To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -660,15 +602,14 @@ void sir_geterrorinfo
(
- sir_errorinfo *
- err )
+ sir_errorinfo * err )
Retrieves granular information about the last error that occurred on the calling thread.
-To retrieve just an error code and a formatted message, use sir_geterror.
+To retrieve just an error code and a formatted message, use sir_geterror.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -688,8 +629,7 @@ uint32_t sir_getversionhex
(
- void
- )
+ void )
@@ -710,8 +650,7 @@ const char * sir_getversionstring
(
- void
- )
+ void )
bool sir_info
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_INFO level message.
The message will be delivered to all destinations registered to receive information-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Initializes libsir for use.
-Must be called before making any other calls into libsir (with the exception of sir_makeinit).
-For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
-- See also
- sir_makeinit
+Must be called before making any other calls into libsir (with the exception of sir_makeinit).
+For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
+- See also
- sir_makeinit
-
-sir_cleanup
+sir_cleanup
- Parameters
-
si Pointer to a sirinit structure containing the desired settings and configuration. libsir makes a copy of this structure, so its lifetime is not a concern.
-- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -811,8 +742,7 @@ bool sir_isinitialized
(
- void
- )
+ void )
Remarks Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
-- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
+- Remarks
- Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
+- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
@@ -834,8 +764,7 @@ bool sir_isprerelease
(
- void
- )
+ void )
sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
`oldname.log` -> `oldname-23-06-09-122049-1.log`
@@ -505,7 +506,7 @@
-The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The sequence number format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
-1
-1
The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
+The time format string for rolled/archived log files (see SIR_FNAMEFORMAT).
Example
2023-06-09-122049
The maximum number of characters allowable in one log message.
-This does not include accompanying formatted output (see SIR_MAXOUTPUT).
+This does not include accompanying formatted output (see SIR_MAXOUTPUT).
@@ -743,7 +744,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/config_8h_source.html b/docs/config_8h_source.html
index 8874a52f2..c956c4622 100644
--- a/docs/config_8h_source.html
+++ b/docs/config_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -384,7 +385,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/console_8h_source.html b/docs/console_8h_source.html
index bf506380a..8c999efd5 100644
--- a/docs/console_8h_source.html
+++ b/docs/console_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/cookie.js b/docs/cookie.js
new file mode 100644
index 000000000..53ad21d98
--- /dev/null
+++ b/docs/cookie.js
@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+ cookie_namespace: 'doxygen_',
+
+ readSetting(cookie,defVal) {
+ if (window.chrome) {
+ const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+ sessionStorage.getItem(this.cookie_namespace+cookie);
+ if (val) return val;
+ } else {
+ let myCookie = this.cookie_namespace+cookie+"=";
+ if (document.cookie) {
+ const index = document.cookie.indexOf(myCookie);
+ if (index != -1) {
+ const valStart = index + myCookie.length;
+ let valEnd = document.cookie.indexOf(";", valStart);
+ if (valEnd == -1) {
+ valEnd = document.cookie.length;
+ }
+ return document.cookie.substring(valStart, valEnd);
+ }
+ }
+ }
+ return defVal;
+ },
+
+ writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+ if (window.chrome) {
+ if (days==0) {
+ sessionStorage.setItem(this.cookie_namespace+cookie,val);
+ } else {
+ localStorage.setItem(this.cookie_namespace+cookie,val);
+ }
+ } else {
+ let date = new Date();
+ date.setTime(date.getTime()+(days*24*60*60*1000));
+ const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+ document.cookie = this.cookie_namespace + cookie + "=" +
+ val + "; SameSite=Lax;" + expiration + "path=/";
+ }
+ },
+
+ eraseSetting(cookie) {
+ if (window.chrome) {
+ if (localStorage.getItem(this.cookie_namespace+cookie)) {
+ localStorage.removeItem(this.cookie_namespace+cookie);
+ } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+ sessionStorage.removeItem(this.cookie_namespace+cookie);
+ }
+ } else {
+ this.writeSetting(cookie,'',-1);
+ }
+ },
+}
diff --git a/docs/defaults_8h.html b/docs/defaults_8h.html
index b742b4c17..c4b5fd011 100644
--- a/docs/defaults_8h.html
+++ b/docs/defaults_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -195,7 +196,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/defaults_8h_source.html b/docs/defaults_8h_source.html
index 96e11ddaa..2c529901a 100644
--- a/docs/defaults_8h_source.html
+++ b/docs/defaults_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -265,7 +266,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
index 3cc1e0d28..3abcaea79 100644
--- a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
+++ b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_49e56c817e5e54854c35e136979f97ca.html b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
index 287fa94db..a05d101da 100644
--- a/docs/dir_49e56c817e5e54854c35e136979f97ca.html
+++ b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
index 50134e9f5..9a8f2aadb 100644
--- a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
+++ b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -132,7 +133,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
index ac52e9b30..5a9deb136 100644
--- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
+++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_89aa746955889ced97536d9f51ce6c73.html b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
index 0685ebed1..97e71bbec 100644
--- a/docs/dir_89aa746955889ced97536d9f51ce6c73.html
+++ b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -175,7 +176,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
index 88819b411..9c4c988e3 100644
--- a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
+++ b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -120,7 +121,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
index 0901fb760..1004ee66c 100644
--- a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
+++ b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -127,7 +128,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
index 0218ffcbb..4d1d173ea 100644
--- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -135,7 +136,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/dir_d4f373425b53e326d93013419ec79018.html b/docs/dir_d4f373425b53e326d93013419ec79018.html
index 4e2e8d8fe..3ac0fc466 100644
--- a/docs/dir_d4f373425b53e326d93013419ec79018.html
+++ b/docs/dir_d4f373425b53e326d93013419ec79018.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -126,7 +127,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html
new file mode 100644
index 000000000..fe7f70be1
--- /dev/null
+++ b/docs/doxygen_crawl.html
@@ -0,0 +1,207 @@
+
+
+
+Validator / crawler helper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
index 71c1dbd44..00dca41ad 100644
--- a/docs/dynsections.js
+++ b/docs/dynsections.js
@@ -22,171 +22,173 @@
@licend The above is the entire license notice for the JavaScript code in this file
*/
-function toggleVisibility(linkObj)
-{
- var base = $(linkObj).attr('id');
- var summary = $('#'+base+'-summary');
- var content = $('#'+base+'-content');
- var trigger = $('#'+base+'-trigger');
- var src=$(trigger).attr('src');
- if (content.is(':visible')===true) {
- content.hide();
- summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
- } else {
- content.show();
- summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
- }
- return false;
-}
-
-function updateStripes()
-{
- $('table.directory tr').
- removeClass('even').filter(':visible:even').addClass('even');
- $('table.directory tr').
- removeClass('odd').filter(':visible:odd').addClass('odd');
-}
-
-function toggleLevel(level)
-{
- $('table.directory tr').each(function() {
- var l = this.id.split('_').length-1;
- var i = $('#img'+this.id.substring(3));
- var a = $('#arr'+this.id.substring(3));
- if (l');
- // add vertical lines to other rows
- $('span[class=lineno]').not(':eq(0)').append('');
- // add toggle controls to lines with fold divs
- $('div[class=foldopen]').each(function() {
- // extract specific id to use
- var id = $(this).attr('id').replace('foldopen','');
- // extract start and end foldable fragment attributes
- var start = $(this).attr('data-start');
- var end = $(this).attr('data-end');
- // replace normal fold span with controls for the first line of a foldable fragment
- $(this).find('span[class=fold]:first').replaceWith('');
- // append div for folded (closed) representation
- $(this).after('');
- // extract the first line from the "open" section to represent closed content
- var line = $(this).children().first().clone();
- // remove any glow that might still be active on the original line
- $(line).removeClass('glow');
- if (start) {
- // if line already ends with a start marker (e.g. trailing {), remove it
- $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ this.updateStripes();
+ },
+
+ toggleFolder : function(id) {
+ // the clicked row
+ const currentRow = $('#row_'+id);
+
+ // all rows after the clicked row
+ const rows = currentRow.nextAll("tr");
+
+ const re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
+
+ // only match elements AFTER this one (can't hide elements before)
+ const childRows = rows.filter(function() { return this.id.match(re); });
+
+ // first row is visible we are HIDING
+ if (childRows.filter(':first').is(':visible')===true) {
+ // replace down arrow by right arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ currentRowSpans.filter(".arrow").html('►');
+ rows.filter("[id^=row_"+id+"]").hide(); // hide all children
+ } else { // we are SHOWING
+ // replace right arrow by down arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfclosed").removeClass("iconfclosed").addClass("iconfopen");
+ currentRowSpans.filter(".arrow").html('▼');
+ // replace down arrows by right arrows for child rows
+ const childRowsSpans = childRows.find("span");
+ childRowsSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ childRowsSpans.filter(".arrow").html('►');
+ childRows.show(); //show all children
}
- // replace minus with plus symbol
- $(line).find('span[class=fold]').css('background-image',plusImg[relPath]);
- // append ellipsis
- $(line).append(' '+start+'…'+end);
- // insert constructed line into closed div
- $('#foldclosed'+id).html(line);
- });
-}
-
+ this.updateStripes();
+ },
+
+ toggleInherit : function(id) {
+ const rows = $('tr.inherit.'+id);
+ const img = $('tr.inherit_header.'+id+' img');
+ const src = $(img).attr('src');
+ if (rows.filter(':first').is(':visible')===true) {
+ rows.css('display','none');
+ $(img).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ rows.css('display','table-row'); // using show() causes jump in firefox
+ $(img).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ },
+};
+
+let codefold = {
+ opened : true,
+
+ // in case HTML_COLORSTYLE is LIGHT or DARK the vars will be replaced, so we write them out explicitly and use double quotes
+ plusImg: [ "url('plusd.svg')", "url('../../plusd.svg')" ],
+ minusImg: [ "url('minusd.svg')", "url('../../minusd.svg')" ],
+
+ // toggle all folding blocks
+ toggle_all : function(relPath) {
+ if (this.opened) {
+ $('#fold_all').css('background-image',this.plusImg[relPath]);
+ $('div[id^=foldopen]').hide();
+ $('div[id^=foldclosed]').show();
+ } else {
+ $('#fold_all').css('background-image',this.minusImg[relPath]);
+ $('div[id^=foldopen]').show();
+ $('div[id^=foldclosed]').hide();
+ }
+ this.opened=!this.opened;
+ },
+
+ // toggle single folding block
+ toggle : function(id) {
+ $('#foldopen'+id).toggle();
+ $('#foldclosed'+id).toggle();
+ },
+
+ init : function(relPath) {
+ $('span[class=lineno]').css({
+ 'padding-right':'4px',
+ 'margin-right':'2px',
+ 'display':'inline-block',
+ 'width':'54px',
+ 'background':'linear-gradient(#808080,#808080) no-repeat 46px/2px 100%'
+ });
+ // add global toggle to first line
+ $('span[class=lineno]:first').append('');
+ // add vertical lines to other rows
+ $('span[class=lineno]').not(':eq(0)').append('');
+ // add toggle controls to lines with fold divs
+ $('div[class=foldopen]').each(function() {
+ // extract specific id to use
+ const id = $(this).attr('id').replace('foldopen','');
+ // extract start and end foldable fragment attributes
+ const start = $(this).attr('data-start');
+ const end = $(this).attr('data-end');
+ // replace normal fold span with controls for the first line of a foldable fragment
+ $(this).find('span[class=fold]:first').replaceWith('');
+ // append div for folded (closed) representation
+ $(this).after('');
+ // extract the first line from the "open" section to represent closed content
+ const line = $(this).children().first().clone();
+ // remove any glow that might still be active on the original line
+ $(line).removeClass('glow');
+ if (start) {
+ // if line already ends with a start marker (e.g. trailing {), remove it
+ $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ }
+ // replace minus with plus symbol
+ $(line).find('span[class=fold]').css('background-image',codefold.plusImg[relPath]);
+ // append ellipsis
+ $(line).append(' '+start+'…'+end);
+ // insert constructed line into closed div
+ $('#foldclosed'+id).html(line);
+ });
+ },
+};
/* @license-end */
diff --git a/docs/errors_8h_source.html b/docs/errors_8h_source.html
index 508fdf3f6..4db3d46b1 100644
--- a/docs/errors_8h_source.html
+++ b/docs/errors_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -298,7 +299,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/example_8c.html b/docs/example_8c.html
index 103f15316..a19ee0ad2 100644
--- a/docs/example_8c.html
+++ b/docs/example_8c.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -121,13 +122,13 @@
Functions
int report_error (void) int report_error (void) Prints the last libsir error to stderr.
void report_warning (const char *warning) void report_warning (const char *warning) Prints a warning message along with the last libsir error to stderr.
int main (void) int main (void) This is a basic example of initializing and configuring libsir for use.
@@ -151,8 +152,7 @@ int main
(
- void
- )
+ void )
int report_error
(
- void
- )
+ void )
void report_warning
(
- const char *
- warning )
+ const char * warning )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filecache_8h_source.html b/docs/filecache_8h_source.html
index 58caf1bae..0e61ea42b 100644
--- a/docs/filecache_8h_source.html
+++ b/docs/filecache_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -207,7 +208,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/files.html b/docs/files.html
index 74aae1a9f..f52455e99 100644
--- a/docs/files.html
+++ b/docs/files.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -114,11 +115,11 @@
Here is a list of all documented files with brief descriptions:
-[detail level 123]
- ▼ example
+ ▼ example example.c A simple demonstration of initialization, configuration, and basic usage of libsir ▼ include ▼ sir ▼ include ▼ sir ansimacros.h ANSI escape sequence macros condition.h config.h Compile-time configuration wineventlog.h sir.h Public interface to libsir sir.hh C++ interface to libsir ▼ plugins ▼ sample ▼ plugins ▼ sample plugin_sample.h ▼ src ▼ src sir.c Public interface to libsir sircondition.c ▼ tests ▼ tests tests++.hh tests.h tests_malloc.h
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/filesystem_8h_source.html b/docs/filesystem_8h_source.html
index 4871d831d..d6d3509b6 100644
--- a/docs/filesystem_8h_source.html
+++ b/docs/filesystem_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
@@ -222,7 +223,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions.html b/docs/functions.html
index ce4c8aed5..59022523d 100644
--- a/docs/functions.html
+++ b/docs/functions.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -271,7 +272,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_func.html b/docs/functions_func.html
index cb77c0ae0..21b125620 100644
--- a/docs/functions_func.html
+++ b/docs/functions_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -129,7 +130,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/functions_vars.html b/docs/functions_vars.html
index 73569c835..497bf9b6f 100644
--- a/docs/functions_vars.html
+++ b/docs/functions_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -252,7 +253,7 @@ - w -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals.html b/docs/globals.html
index bf2f8e7d8..18a27c580 100644
--- a/docs/globals.html
+++ b/docs/globals.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -291,7 +292,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_defs.html b/docs/globals_defs.html
index a1c9362ec..d6497fbfd 100644
--- a/docs/globals_defs.html
+++ b/docs/globals_defs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -221,7 +222,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_func.html b/docs/globals_func.html
index 50e58d8d7..ec8bf8e66 100644
--- a/docs/globals_func.html
+++ b/docs/globals_func.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -174,7 +175,7 @@ - s -
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/globals_vars.html b/docs/globals_vars.html
index 05f07ec1f..090fcb904 100644
--- a/docs/globals_vars.html
+++ b/docs/globals_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/graph_legend.html b/docs/graph_legend.html
index c2791ac76..02bb5368d 100644
--- a/docs/graph_legend.html
+++ b/docs/graph_legend.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -179,7 +180,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.html b/docs/group__cpp.html
index bd3e677ad..01f2a417c 100644
--- a/docs/group__cpp.html
+++ b/docs/group__cpp.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -134,7 +135,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__cpp.map b/docs/group__cpp.map
index 3cddb093b..5acc3c6c2 100644
--- a/docs/group__cpp.map
+++ b/docs/group__cpp.map
@@ -1,5 +1,5 @@
diff --git a/docs/group__cpp.md5 b/docs/group__cpp.md5
index 891a96f59..815a92132 100644
--- a/docs/group__cpp.md5
+++ b/docs/group__cpp.md5
@@ -1 +1 @@
-462b92518fe0cc3c91f0d70199ee7926
\ No newline at end of file
+f24d7dff3b01a595a06f85abf0c13140
\ No newline at end of file
diff --git a/docs/group__cpp.svg b/docs/group__cpp.svg
index 8835f76d2..b2c3882c1 100644
--- a/docs/group__cpp.svg
+++ b/docs/group__cpp.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__cpp_org.svg b/docs/group__cpp_org.svg
index e0ef50308..1b8ad1580 100644
--- a/docs/group__cpp_org.svg
+++ b/docs/group__cpp_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__default.html b/docs/group__default.html
index d8c337c35..b0beeb479 100644
--- a/docs/group__default.html
+++ b/docs/group__default.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -115,63 +116,60 @@
Defaults
-
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
-More...
Detailed Description
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
+Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
- See also
- SIRO_DEFAULT
-
SIRL_DEFAULT
@@ -660,7 +658,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__plugins.html b/docs/group__plugins.html
index a022001ff..fa690d928 100644
--- a/docs/group__plugins.html
+++ b/docs/group__plugins.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -118,16 +119,16 @@
Functions
PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) PLUGIN_EXPORT bool sir_plugin_query (sir_plugininfo *info) Called by libsir after the plugin library object is loaded, but before any other functions are probed or called.
PLUGIN_EXPORT bool sir_plugin_init (void) PLUGIN_EXPORT bool sir_plugin_init (void) Called by libsir after the plugin is queried and successfully validated.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_write (sir_level level, const char *message) Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
PLUGIN_EXPORT bool sir_plugin_cleanup (void) PLUGIN_EXPORT bool sir_plugin_cleanup (void) Called by libsir when the plugin is about to be unloaded.
@@ -199,7 +200,7 @@ Creating your own plugin
static const char* desc = "Logs messages and function calls to stdout.";
static const uint64_t caps = 0ULL;
-
+
info->iface_ver = SIR_PLUGIN_VCURRENT;
info->maj_ver = maj_ver;
info->min_ver = min_ver;
@@ -214,28 +215,28 @@ Creating your own plugin
return true;
}
-
+
return true;
}
-
+
__func__, level, message);
return true;
}
-
+
return true;
}
ANSI escape sequence macros.
-PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
-PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
-PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
-PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
+PLUGIN_EXPORT bool sir_plugin_init(void)Called by libsir after the plugin is queried and successfully validated.Definition plugin_sample.c:70
+PLUGIN_EXPORT bool sir_plugin_cleanup(void)Called by libsir when the plugin is about to be unloaded.Definition plugin_sample.c:81
+PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...Definition plugin_sample.c:75
+PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)Called by libsir after the plugin library object is loaded, but before any other functions are probed...Definition plugin_sample.c:55
@@ -268,8 +269,7 @@ PLUGIN_EXPORT bool sir_plugin_cleanup
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_init
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_query
(
- sir_plugininfo *
- info )
+ sir_plugininfo * info )
sir_option
-Defaults
+Defaults
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
(
- sir_level
- level,
+ sir_level level,
const char *
- message
-
-
- )
- const char * message )
-Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
+Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
The message string will be pre-formatted according to the sir_option set in the opts bitmask of the sir_plugininfo structure.
-
+
@@ -84,7 +85,7 @@
-
-Functions and types that comprise the public interface to libsir.
-More...
Collaboration diagram for Public Interface:
@@ -125,12 +123,15 @@
-Modules
Functions
Types
C++ Wrapper
Detailed Description
@@ -141,7 +142,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__public.map b/docs/group__public.map
index ebdfeaff4..64aee1563 100644
--- a/docs/group__public.map
+++ b/docs/group__public.map
@@ -1,6 +1,6 @@
diff --git a/docs/group__public.md5 b/docs/group__public.md5
index ed48908b4..7a1ce9965 100644
--- a/docs/group__public.md5
+++ b/docs/group__public.md5
@@ -1 +1 @@
-f1c3db5e4bd882209737e22a617d9779
\ No newline at end of file
+39105cf86342456b103521902c43f5ea
\ No newline at end of file
diff --git a/docs/group__public.svg b/docs/group__public.svg
index fc21fb067..f5a782426 100644
--- a/docs/group__public.svg
+++ b/docs/group__public.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__public_org.svg b/docs/group__public_org.svg
index d07be5f40..c15a4d330 100644
--- a/docs/group__public_org.svg
+++ b/docs/group__public_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publicfuncs.html b/docs/group__publicfuncs.html
index ff96dc7ea..d8d2ed1c0 100644
--- a/docs/group__publicfuncs.html
+++ b/docs/group__publicfuncs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -123,109 +124,109 @@
Functions
bool sir_makeinit (sirinit *si) bool sir_makeinit (sirinit *si) Fills out a sirinit structure with default values.
bool sir_init (sirinit *si) bool sir_init (sirinit *si) Initializes libsir for use.
bool sir_cleanup (void) bool sir_cleanup (void) Tears down and cleans up libsir after use.
bool sir_isinitialized (void) bool sir_isinitialized (void) Determines whether or not libsir is in the initialized state.
uint16_t sir_geterror (char message[SIR_MAXERROR]) 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 associated error code.
void sir_geterrorinfo (sir_errorinfo *err) void sir_geterrorinfo (sir_errorinfo *err) Retrieves granular information about the last error that occurred on the calling thread.
bool sir_debug (PRINTF_FORMAT const char *format,...) bool sir_debug (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_DEBUG level message.
bool sir_info (PRINTF_FORMAT const char *format,...) bool sir_info (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_INFO level message.
bool sir_notice (PRINTF_FORMAT const char *format,...) bool sir_notice (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_NOTICE level message.
bool sir_warn (PRINTF_FORMAT const char *format,...) bool sir_warn (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_WARN level message.
bool sir_error (PRINTF_FORMAT const char *format,...) bool sir_error (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ERROR level message.
bool sir_crit (PRINTF_FORMAT const char *format,...) bool sir_crit (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_CRIT level message.
bool sir_alert (PRINTF_FORMAT const char *format,...) bool sir_alert (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_ALERT level message.
bool sir_emerg (PRINTF_FORMAT const char *format,...) bool sir_emerg (PRINTF_FORMAT const char *format,...) Dispatches a SIRL_EMERG level message.
sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) sirfileid sir_addfile (const char *path, sir_levels levels, sir_options opts) Adds a log file and registers it to receive log output.
bool sir_remfile (sirfileid id) bool sir_remfile (sirfileid id) Removes a file previously added to libsir.
sirpluginid sir_loadplugin (const char *path) sirpluginid sir_loadplugin (const char *path) Loads a plugin module from disk.
bool sir_unloadplugin (sirpluginid id) bool sir_unloadplugin (sirpluginid id) Unloads a previously registered plugin module.
bool sir_filelevels (sirfileid id, sir_levels levels) bool sir_filelevels (sirfileid id, sir_levels levels) Set new level registrations for a log file already managed by libsir.
bool sir_fileopts (sirfileid id, sir_options opts) bool sir_fileopts (sirfileid id, sir_options opts) Set new formatting options for a log file already managed by libsir.
bool sir_settextstyle (sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg) 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.
bool sir_resettextstyles (void) bool sir_resettextstyles (void) Reset text styling for stdio (stdout/stderr) destinations to their default values.
sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) sir_textcolor sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) Creates a sir_textcolor from red, green, and blue components.
bool sir_setcolormode (sir_colormode mode) bool sir_setcolormode (sir_colormode mode) Sets the ANSI color mode for stdio destinations.
bool sir_stdoutlevels (sir_levels levels) bool sir_stdoutlevels (sir_levels levels) Set new level registrations for stdout.
bool sir_stdoutopts (sir_options opts) bool sir_stdoutopts (sir_options opts) Set new formatting options for stdout.
bool sir_stderrlevels (sir_levels levels) bool sir_stderrlevels (sir_levels levels) Set new level registrations for stderr.
bool sir_stderropts (sir_options opts) bool sir_stderropts (sir_options opts) Set new formatting options for stderr.
bool sir_sysloglevels (sir_levels levels) bool sir_sysloglevels (sir_levels levels) Set new level registrations for the system logger destination.
bool sir_syslogopts (sir_options opts) bool sir_syslogopts (sir_options opts) Set new formatting options for the system logger destination.
bool sir_syslogid (const char *identity) bool sir_syslogid (const char *identity) Set new system logger identity.
bool sir_syslogcat (const char *category) bool sir_syslogcat (const char *category) Set new system logger category.
const char * sir_getversionstring (void) const char * sir_getversionstring (void) Returns the current libsir version as a string.
uint32_t sir_getversionhex (void) uint32_t sir_getversionhex (void) Returns the current libsir version as a number.
bool sir_isprerelease (void) bool sir_isprerelease (void) Whether or not this is a pre-release version of libsir.
@@ -240,25 +241,17 @@ sirfileid sir_addfile
(
- const char *
- path,
+ const char * path,
sir_levels
- levels,
+ sir_levels levels,
sir_options
- opts
-
-
- )
- sir_options opts )
@@ -273,8 +266,8 @@ sir_filelevels and sir_fileopts, respectively.
-- See also
- sir_remfile
+To change the file's level registrations or options after adding it, call sir_filelevels and sir_fileopts, respectively.
+- See also
- sir_remfile
- Parameters
-
Dispatches a SIRL_ALERT level message.
The message will be delivered to all destinations registered to receive alert-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Tears down and cleans up libsir after use.
-Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
-May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
-- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
+May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
+- Returns
- bool
true if cleanup was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -364,31 +349,24 @@ bool sir_crit
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_CRIT level message.
The message will be delivered to all destinations registered to receive critical-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_DEBUG level message.
The message will be delivered to all destinations registered to receive debug-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_EMERG level message.
The message will be delivered to all destinations registered to receive emergency-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_ERROR level message.
The message will be delivered to all destinations registered to receive error-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
@@ -566,7 +516,7 @@ See also sir_fileopts
+- See also
- sir_fileopts
- Parameters
-
@@ -610,7 +553,7 @@ SIRO_ALL
SIRO_NOHOST
-- See also
- sir_filelevels
+- See also
- sir_filelevels
- Parameters
-
Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.
-To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
+To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -660,15 +602,14 @@ void sir_geterrorinfo
(
- sir_errorinfo *
- err )
+ sir_errorinfo * err )
Retrieves granular information about the last error that occurred on the calling thread.
-To retrieve just an error code and a formatted message, use sir_geterror.
+To retrieve just an error code and a formatted message, use sir_geterror.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -688,8 +629,7 @@ uint32_t sir_getversionhex
(
- void
- )
+ void )
@@ -710,8 +650,7 @@ const char * sir_getversionstring
(
- void
- )
+ void )
bool sir_info
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_INFO level message.
The message will be delivered to all destinations registered to receive information-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Initializes libsir for use.
-Must be called before making any other calls into libsir (with the exception of sir_makeinit).
-For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
-- See also
- sir_makeinit
+Must be called before making any other calls into libsir (with the exception of sir_makeinit).
+For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
+- See also
- sir_makeinit
-
-sir_cleanup
+sir_cleanup
- Parameters
-
si Pointer to a sirinit structure containing the desired settings and configuration. libsir makes a copy of this structure, so its lifetime is not a concern.
-- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -811,8 +742,7 @@ bool sir_isinitialized
(
- void
- )
+ void )
Remarks Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
-- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
+- Remarks
- Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
+- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
@@ -834,8 +764,7 @@ bool sir_isprerelease
(
- void
- )
+ void )
sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -384,7 +385,7 @@
diff --git a/docs/console_8h_source.html b/docs/console_8h_source.html
index bf506380a..8c999efd5 100644
--- a/docs/console_8h_source.html
+++ b/docs/console_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -195,7 +196,7 @@
diff --git a/docs/cookie.js b/docs/cookie.js
new file mode 100644
index 000000000..53ad21d98
--- /dev/null
+++ b/docs/cookie.js
@@ -0,0 +1,58 @@
+/*!
+ Cookie helper functions
+ Copyright (c) 2023 Dimitri van Heesch
+ Released under MIT license.
+*/
+let Cookie = {
+ cookie_namespace: 'doxygen_',
+
+ readSetting(cookie,defVal) {
+ if (window.chrome) {
+ const val = localStorage.getItem(this.cookie_namespace+cookie) ||
+ sessionStorage.getItem(this.cookie_namespace+cookie);
+ if (val) return val;
+ } else {
+ let myCookie = this.cookie_namespace+cookie+"=";
+ if (document.cookie) {
+ const index = document.cookie.indexOf(myCookie);
+ if (index != -1) {
+ const valStart = index + myCookie.length;
+ let valEnd = document.cookie.indexOf(";", valStart);
+ if (valEnd == -1) {
+ valEnd = document.cookie.length;
+ }
+ return document.cookie.substring(valStart, valEnd);
+ }
+ }
+ }
+ return defVal;
+ },
+
+ writeSetting(cookie,val,days=10*365) { // default days='forever', 0=session cookie, -1=delete
+ if (window.chrome) {
+ if (days==0) {
+ sessionStorage.setItem(this.cookie_namespace+cookie,val);
+ } else {
+ localStorage.setItem(this.cookie_namespace+cookie,val);
+ }
+ } else {
+ let date = new Date();
+ date.setTime(date.getTime()+(days*24*60*60*1000));
+ const expiration = days!=0 ? "expires="+date.toGMTString()+";" : "";
+ document.cookie = this.cookie_namespace + cookie + "=" +
+ val + "; SameSite=Lax;" + expiration + "path=/";
+ }
+ },
+
+ eraseSetting(cookie) {
+ if (window.chrome) {
+ if (localStorage.getItem(this.cookie_namespace+cookie)) {
+ localStorage.removeItem(this.cookie_namespace+cookie);
+ } else if (sessionStorage.getItem(this.cookie_namespace+cookie)) {
+ sessionStorage.removeItem(this.cookie_namespace+cookie);
+ }
+ } else {
+ this.writeSetting(cookie,'',-1);
+ }
+ },
+}
diff --git a/docs/defaults_8h.html b/docs/defaults_8h.html
index b742b4c17..c4b5fd011 100644
--- a/docs/defaults_8h.html
+++ b/docs/defaults_8h.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -195,7 +196,7 @@
diff --git a/docs/defaults_8h_source.html b/docs/defaults_8h_source.html
index 96e11ddaa..2c529901a 100644
--- a/docs/defaults_8h_source.html
+++ b/docs/defaults_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -265,7 +266,7 @@
diff --git a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
index 3cc1e0d28..3abcaea79 100644
--- a/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
+++ b/docs/dir_38c8d24aef3972a7f87b834274e76e31.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -126,7 +127,7 @@
diff --git a/docs/dir_49e56c817e5e54854c35e136979f97ca.html b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
index 287fa94db..a05d101da 100644
--- a/docs/dir_49e56c817e5e54854c35e136979f97ca.html
+++ b/docs/dir_49e56c817e5e54854c35e136979f97ca.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -120,7 +121,7 @@
diff --git a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
index 50134e9f5..9a8f2aadb 100644
--- a/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
+++ b/docs/dir_59425e443f801f1f2fd8bbe4959a3ccf.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -132,7 +133,7 @@
diff --git a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
index ac52e9b30..5a9deb136 100644
--- a/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
+++ b/docs/dir_68267d1309a1af8e8297ef4c3efbcdba.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -129,7 +130,7 @@
diff --git a/docs/dir_89aa746955889ced97536d9f51ce6c73.html b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
index 0685ebed1..97e71bbec 100644
--- a/docs/dir_89aa746955889ced97536d9f51ce6c73.html
+++ b/docs/dir_89aa746955889ced97536d9f51ce6c73.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -175,7 +176,7 @@
diff --git a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
index 88819b411..9c4c988e3 100644
--- a/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
+++ b/docs/dir_98b0b4f2b7ada084522cf3f9258d0075.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -120,7 +121,7 @@
diff --git a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
index 0901fb760..1004ee66c 100644
--- a/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
+++ b/docs/dir_cfafba98a580ce4b62f8a6fa96d7cbb0.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -127,7 +128,7 @@
diff --git a/docs/dir_d44c64559bbebec7f509842c48db8b23.html b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
index 0218ffcbb..4d1d173ea 100644
--- a/docs/dir_d44c64559bbebec7f509842c48db8b23.html
+++ b/docs/dir_d44c64559bbebec7f509842c48db8b23.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -135,7 +136,7 @@
diff --git a/docs/dir_d4f373425b53e326d93013419ec79018.html b/docs/dir_d4f373425b53e326d93013419ec79018.html
index 4e2e8d8fe..3ac0fc466 100644
--- a/docs/dir_d4f373425b53e326d93013419ec79018.html
+++ b/docs/dir_d4f373425b53e326d93013419ec79018.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -126,7 +127,7 @@
diff --git a/docs/doxygen_crawl.html b/docs/doxygen_crawl.html
new file mode 100644
index 000000000..fe7f70be1
--- /dev/null
+++ b/docs/doxygen_crawl.html
@@ -0,0 +1,207 @@
+
+
+
+Validator / crawler helper
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/docs/dynsections.js b/docs/dynsections.js
index 71c1dbd44..00dca41ad 100644
--- a/docs/dynsections.js
+++ b/docs/dynsections.js
@@ -22,171 +22,173 @@
@licend The above is the entire license notice for the JavaScript code in this file
*/
-function toggleVisibility(linkObj)
-{
- var base = $(linkObj).attr('id');
- var summary = $('#'+base+'-summary');
- var content = $('#'+base+'-content');
- var trigger = $('#'+base+'-trigger');
- var src=$(trigger).attr('src');
- if (content.is(':visible')===true) {
- content.hide();
- summary.show();
- $(linkObj).addClass('closed').removeClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-8)+'closed.png');
- } else {
- content.show();
- summary.hide();
- $(linkObj).removeClass('closed').addClass('opened');
- $(trigger).attr('src',src.substring(0,src.length-10)+'open.png');
- }
- return false;
-}
-
-function updateStripes()
-{
- $('table.directory tr').
- removeClass('even').filter(':visible:even').addClass('even');
- $('table.directory tr').
- removeClass('odd').filter(':visible:odd').addClass('odd');
-}
-
-function toggleLevel(level)
-{
- $('table.directory tr').each(function() {
- var l = this.id.split('_').length-1;
- var i = $('#img'+this.id.substring(3));
- var a = $('#arr'+this.id.substring(3));
- if (l');
- // add vertical lines to other rows
- $('span[class=lineno]').not(':eq(0)').append('');
- // add toggle controls to lines with fold divs
- $('div[class=foldopen]').each(function() {
- // extract specific id to use
- var id = $(this).attr('id').replace('foldopen','');
- // extract start and end foldable fragment attributes
- var start = $(this).attr('data-start');
- var end = $(this).attr('data-end');
- // replace normal fold span with controls for the first line of a foldable fragment
- $(this).find('span[class=fold]:first').replaceWith('');
- // append div for folded (closed) representation
- $(this).after('');
- // extract the first line from the "open" section to represent closed content
- var line = $(this).children().first().clone();
- // remove any glow that might still be active on the original line
- $(line).removeClass('glow');
- if (start) {
- // if line already ends with a start marker (e.g. trailing {), remove it
- $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ this.updateStripes();
+ },
+
+ toggleFolder : function(id) {
+ // the clicked row
+ const currentRow = $('#row_'+id);
+
+ // all rows after the clicked row
+ const rows = currentRow.nextAll("tr");
+
+ const re = new RegExp('^row_'+id+'\\d+_$', "i"); //only one sub
+
+ // only match elements AFTER this one (can't hide elements before)
+ const childRows = rows.filter(function() { return this.id.match(re); });
+
+ // first row is visible we are HIDING
+ if (childRows.filter(':first').is(':visible')===true) {
+ // replace down arrow by right arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ currentRowSpans.filter(".arrow").html('►');
+ rows.filter("[id^=row_"+id+"]").hide(); // hide all children
+ } else { // we are SHOWING
+ // replace right arrow by down arrow for current row
+ const currentRowSpans = currentRow.find("span");
+ currentRowSpans.filter(".iconfclosed").removeClass("iconfclosed").addClass("iconfopen");
+ currentRowSpans.filter(".arrow").html('▼');
+ // replace down arrows by right arrows for child rows
+ const childRowsSpans = childRows.find("span");
+ childRowsSpans.filter(".iconfopen").removeClass("iconfopen").addClass("iconfclosed");
+ childRowsSpans.filter(".arrow").html('►');
+ childRows.show(); //show all children
}
- // replace minus with plus symbol
- $(line).find('span[class=fold]').css('background-image',plusImg[relPath]);
- // append ellipsis
- $(line).append(' '+start+'…'+end);
- // insert constructed line into closed div
- $('#foldclosed'+id).html(line);
- });
-}
-
+ this.updateStripes();
+ },
+
+ toggleInherit : function(id) {
+ const rows = $('tr.inherit.'+id);
+ const img = $('tr.inherit_header.'+id+' img');
+ const src = $(img).attr('src');
+ if (rows.filter(':first').is(':visible')===true) {
+ rows.css('display','none');
+ $(img).attr('src',src.substring(0,src.length-8)+'closed.png');
+ } else {
+ rows.css('display','table-row'); // using show() causes jump in firefox
+ $(img).attr('src',src.substring(0,src.length-10)+'open.png');
+ }
+ },
+};
+
+let codefold = {
+ opened : true,
+
+ // in case HTML_COLORSTYLE is LIGHT or DARK the vars will be replaced, so we write them out explicitly and use double quotes
+ plusImg: [ "url('plusd.svg')", "url('../../plusd.svg')" ],
+ minusImg: [ "url('minusd.svg')", "url('../../minusd.svg')" ],
+
+ // toggle all folding blocks
+ toggle_all : function(relPath) {
+ if (this.opened) {
+ $('#fold_all').css('background-image',this.plusImg[relPath]);
+ $('div[id^=foldopen]').hide();
+ $('div[id^=foldclosed]').show();
+ } else {
+ $('#fold_all').css('background-image',this.minusImg[relPath]);
+ $('div[id^=foldopen]').show();
+ $('div[id^=foldclosed]').hide();
+ }
+ this.opened=!this.opened;
+ },
+
+ // toggle single folding block
+ toggle : function(id) {
+ $('#foldopen'+id).toggle();
+ $('#foldclosed'+id).toggle();
+ },
+
+ init : function(relPath) {
+ $('span[class=lineno]').css({
+ 'padding-right':'4px',
+ 'margin-right':'2px',
+ 'display':'inline-block',
+ 'width':'54px',
+ 'background':'linear-gradient(#808080,#808080) no-repeat 46px/2px 100%'
+ });
+ // add global toggle to first line
+ $('span[class=lineno]:first').append('');
+ // add vertical lines to other rows
+ $('span[class=lineno]').not(':eq(0)').append('');
+ // add toggle controls to lines with fold divs
+ $('div[class=foldopen]').each(function() {
+ // extract specific id to use
+ const id = $(this).attr('id').replace('foldopen','');
+ // extract start and end foldable fragment attributes
+ const start = $(this).attr('data-start');
+ const end = $(this).attr('data-end');
+ // replace normal fold span with controls for the first line of a foldable fragment
+ $(this).find('span[class=fold]:first').replaceWith('');
+ // append div for folded (closed) representation
+ $(this).after('');
+ // extract the first line from the "open" section to represent closed content
+ const line = $(this).children().first().clone();
+ // remove any glow that might still be active on the original line
+ $(line).removeClass('glow');
+ if (start) {
+ // if line already ends with a start marker (e.g. trailing {), remove it
+ $(line).html($(line).html().replace(new RegExp('\\s*'+start+'\\s*$','g'),''));
+ }
+ // replace minus with plus symbol
+ $(line).find('span[class=fold]').css('background-image',codefold.plusImg[relPath]);
+ // append ellipsis
+ $(line).append(' '+start+'…'+end);
+ // insert constructed line into closed div
+ $('#foldclosed'+id).html(line);
+ });
+ },
+};
/* @license-end */
diff --git a/docs/errors_8h_source.html b/docs/errors_8h_source.html
index 508fdf3f6..4db3d46b1 100644
--- a/docs/errors_8h_source.html
+++ b/docs/errors_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -298,7 +299,7 @@
diff --git a/docs/example_8c.html b/docs/example_8c.html
index 103f15316..a19ee0ad2 100644
--- a/docs/example_8c.html
+++ b/docs/example_8c.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -121,13 +122,13 @@
@@ -151,8 +152,7 @@ int main
diff --git a/docs/filecache_8h_source.html b/docs/filecache_8h_source.html
index 58caf1bae..0e61ea42b 100644
--- a/docs/filecache_8h_source.html
+++ b/docs/filecache_8h_source.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -89,7 +90,7 @@
Functions | |
| int | report_error (void) |
| int | report_error (void) |
| Prints the last libsir error to stderr. | |
| void | report_warning (const char *warning) |
| void | report_warning (const char *warning) |
| Prints a warning message along with the last libsir error to stderr. | |
| int | main (void) |
| int | main (void) |
| This is a basic example of initializing and configuring libsir for use. | |
int main
(
- void
- )
+ void )
int report_error
(
- void
- )
+ void )
void report_warning
(
- const char *
- warning )
+ const char * warning )
- - Generated by 1.9.8
+ - Generated by 1.10.0
void report_warning
(
- const char *
- warning )
+ const char * warning )
- - Generated by 1.9.8
+ - Generated by 1.10.0
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -207,7 +208,7 @@
diff --git a/docs/files.html b/docs/files.html
index 74aae1a9f..f52455e99 100644
--- a/docs/files.html
+++ b/docs/files.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -114,11 +115,11 @@
Here is a list of all documented files with brief descriptions:
-
-
+
-
+
@@ -89,7 +90,7 @@
-
+
@@ -84,7 +85,7 @@
[detail level 123]
| ▼ example |
| ▼ example | |
| example.c | A simple demonstration of initialization, configuration, and basic usage of libsir |
| ▼ include | |
| ▼ sir | |
| ▼ include | |
| ▼ sir | |
| ansimacros.h | ANSI escape sequence macros |
| condition.h | |
| config.h | Compile-time configuration |
| wineventlog.h | |
| sir.h | Public interface to libsir |
| sir.hh | C++ interface to libsir |
| ▼ plugins | |
| ▼ sample | |
| ▼ plugins | |
| ▼ sample | |
| plugin_sample.h | |
| ▼ src | |
| ▼ src | |
| sir.c | Public interface to libsir |
| sircondition.c | |
| ▼ tests | |
| ▼ tests | |
| tests++.hh | |
| tests.h | |
| tests_malloc.h |
@@ -222,7 +223,7 @@
diff --git a/docs/functions.html b/docs/functions.html
index ce4c8aed5..59022523d 100644
--- a/docs/functions.html
+++ b/docs/functions.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -271,7 +272,7 @@
-
+
@@ -84,7 +85,7 @@
- w -
- Generated by 1.9.8
+
- Generated by 1.10.0
-
-
@@ -129,7 +130,7 @@
diff --git a/docs/functions_vars.html b/docs/functions_vars.html
index 73569c835..497bf9b6f 100644
--- a/docs/functions_vars.html
+++ b/docs/functions_vars.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -252,7 +253,7 @@
-
+
@@ -84,7 +85,7 @@
- w -
- Generated by 1.9.8
+
- Generated by 1.10.0
-
-
@@ -291,7 +292,7 @@
-
+
@@ -84,7 +85,7 @@
- s -
- Generated by 1.9.8
+
- Generated by 1.10.0
-
-
@@ -221,7 +222,7 @@
-
+
@@ -84,7 +85,7 @@
- s -
- Generated by 1.9.8
+
- Generated by 1.10.0
-
-
@@ -174,7 +175,7 @@
-
+
@@ -84,7 +85,7 @@
- s -
- Generated by 1.9.8
+
- Generated by 1.10.0
-
-
@@ -134,7 +135,7 @@
diff --git a/docs/graph_legend.html b/docs/graph_legend.html
index c2791ac76..02bb5368d 100644
--- a/docs/graph_legend.html
+++ b/docs/graph_legend.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -179,7 +180,7 @@
diff --git a/docs/group__cpp.html b/docs/group__cpp.html
index bd3e677ad..01f2a417c 100644
--- a/docs/group__cpp.html
+++ b/docs/group__cpp.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -134,7 +135,7 @@
diff --git a/docs/group__cpp.map b/docs/group__cpp.map
index 3cddb093b..5acc3c6c2 100644
--- a/docs/group__cpp.map
+++ b/docs/group__cpp.map
@@ -1,5 +1,5 @@
diff --git a/docs/group__cpp.md5 b/docs/group__cpp.md5
index 891a96f59..815a92132 100644
--- a/docs/group__cpp.md5
+++ b/docs/group__cpp.md5
@@ -1 +1 @@
-462b92518fe0cc3c91f0d70199ee7926
\ No newline at end of file
+f24d7dff3b01a595a06f85abf0c13140
\ No newline at end of file
diff --git a/docs/group__cpp.svg b/docs/group__cpp.svg
index 8835f76d2..b2c3882c1 100644
--- a/docs/group__cpp.svg
+++ b/docs/group__cpp.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__cpp_org.svg b/docs/group__cpp_org.svg
index e0ef50308..1b8ad1580 100644
--- a/docs/group__cpp_org.svg
+++ b/docs/group__cpp_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__default.html b/docs/group__default.html
index d8c337c35..b0beeb479 100644
--- a/docs/group__default.html
+++ b/docs/group__default.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -115,63 +116,60 @@
Defaults
-
-
diff --git a/docs/group__plugins.html b/docs/group__plugins.html
index a022001ff..fa690d928 100644
--- a/docs/group__plugins.html
+++ b/docs/group__plugins.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks. -More...
Detailed Description
-Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
+Default sir_option bitmasks, sir_level registrations, and sir_textstyle bitmasks.
- See also
- SIRO_DEFAULT
- SIRL_DEFAULT
- - Generated by 1.9.8
+ - Generated by 1.10.0
1.9.8 1.10.0
@@ -118,16 +119,16 @@
@@ -199,7 +200,7 @@
-
+
-
+
-
+
-
+
-
-
-
-
+
+
+
+
@@ -268,8 +269,7 @@ PLUGIN_EXPORT bool sir_plugin_cleanup
Functions | |
| PLUGIN_EXPORT bool | sir_plugin_query (sir_plugininfo *info) |
| PLUGIN_EXPORT bool | sir_plugin_query (sir_plugininfo *info) |
| Called by libsir after the plugin library object is loaded, but before any other functions are probed or called. | |
| PLUGIN_EXPORT bool | sir_plugin_init (void) |
| PLUGIN_EXPORT bool | sir_plugin_init (void) |
| Called by libsir after the plugin is queried and successfully validated. | |
| PLUGIN_EXPORT bool | sir_plugin_write (sir_level level, const char *message) |
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called. | |
| PLUGIN_EXPORT bool | sir_plugin_write (sir_level level, const char *message) |
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called. | |
| PLUGIN_EXPORT bool | sir_plugin_cleanup (void) |
| PLUGIN_EXPORT bool | sir_plugin_cleanup (void) |
| Called by libsir when the plugin is about to be unloaded. | |
Creating your own plugin
static const char* desc = "Logs messages and function calls to stdout.";
static const uint64_t caps = 0ULL;
info->iface_ver = SIR_PLUGIN_VCURRENT;
info->maj_ver = maj_ver;
info->min_ver = min_ver;
@@ -214,28 +215,28 @@ Creating your own plugin
return true;
}
return true;
}
__func__, level, message);
return true;
}
return true;
}
ANSI escape sequence macros.
PLUGIN_EXPORT bool sir_plugin_init(void)
Called by libsir after the plugin is queried and successfully validated.
Definition plugin_sample.c:70
PLUGIN_EXPORT bool sir_plugin_cleanup(void)
Called by libsir when the plugin is about to be unloaded.
Definition plugin_sample.c:81
PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...
Definition plugin_sample.c:75
PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)
Called by libsir after the plugin library object is loaded, but before any other functions are probed...
Definition plugin_sample.c:55
PLUGIN_EXPORT bool sir_plugin_init(void)
Called by libsir after the plugin is queried and successfully validated.
Definition plugin_sample.c:70
PLUGIN_EXPORT bool sir_plugin_cleanup(void)
Called by libsir when the plugin is about to be unloaded.
Definition plugin_sample.c:81
PLUGIN_EXPORT bool sir_plugin_write(sir_level level, const char *message)
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of...
Definition plugin_sample.c:75
PLUGIN_EXPORT bool sir_plugin_query(sir_plugininfo *info)
Called by libsir after the plugin library object is loaded, but before any other functions are probed...
Definition plugin_sample.c:55
PLUGIN_EXPORT bool sir_plugin_cleanup
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_init
(
- void
- )
+ void )
PLUGIN_EXPORT bool sir_plugin_query
(
- sir_plugininfo *
- info )
+ sir_plugininfo * info )
sir_option
-Defaults
+Defaults
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
(
- sir_level
- level,
+ sir_level level,
const char *
- message
-
-
- )
- const char * message )
PLUGIN_EXPORT bool sir_plugin_query
(
- sir_plugininfo *
- info )
+ sir_plugininfo * info )
sir_option
-Defaults
+Defaults
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
(
- sir_level
- level,
+ sir_level level,
const char *
- message
-
-
- )
- const char * message )
- Parameters
-
info Pointer to a sir_plugininfo structure to be initialized by the plugin. PLUGIN_EXPORT bool sir_plugin_write
( -sir_level -level, +sir_level level, - const char * -message -- - ) -+ const char * message )
-
-
+
@@ -84,7 +85,7 @@
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
Called by libsir when a message is dispatched on any level whose bit was set in the levels bitmask of the sir_plugininfo structure when sir_plugin_query was called.
The message string will be pre-formatted according to the sir_option set in the opts bitmask of the sir_plugininfo structure.
-
-
diff --git a/docs/group__public.map b/docs/group__public.map
index ebdfeaff4..64aee1563 100644
--- a/docs/group__public.map
+++ b/docs/group__public.map
@@ -1,6 +1,6 @@
diff --git a/docs/group__public.md5 b/docs/group__public.md5
index ed48908b4..7a1ce9965 100644
--- a/docs/group__public.md5
+++ b/docs/group__public.md5
@@ -1 +1 @@
-f1c3db5e4bd882209737e22a617d9779
\ No newline at end of file
+39105cf86342456b103521902c43f5ea
\ No newline at end of file
diff --git a/docs/group__public.svg b/docs/group__public.svg
index fc21fb067..f5a782426 100644
--- a/docs/group__public.svg
+++ b/docs/group__public.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__public_org.svg b/docs/group__public_org.svg
index d07be5f40..c15a4d330 100644
--- a/docs/group__public_org.svg
+++ b/docs/group__public_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publicfuncs.html b/docs/group__publicfuncs.html
index ff96dc7ea..d8d2ed1c0 100644
--- a/docs/group__publicfuncs.html
+++ b/docs/group__publicfuncs.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
Functions and types that comprise the public interface to libsir. -More...
Collaboration diagram for Public Interface:
@@ -125,12 +123,15 @@
-Modules | |
| Functions | |
| Types | |
| C++ Wrapper | |
Detailed Description
@@ -141,7 +142,7 @@-
-
- Generated by 1.9.8
+
- Generated by 1.10.0
@@ -123,109 +124,109 @@
@@ -240,25 +241,17 @@ sirfileid sir_addfile
Functions | |
| bool | sir_makeinit (sirinit *si) |
| bool | sir_makeinit (sirinit *si) |
| Fills out a sirinit structure with default values. | |
| bool | sir_init (sirinit *si) |
| bool | sir_init (sirinit *si) |
| Initializes libsir for use. | |
| bool | sir_cleanup (void) |
| bool | sir_cleanup (void) |
| Tears down and cleans up libsir after use. | |
| bool | sir_isinitialized (void) |
| bool | sir_isinitialized (void) |
| Determines whether or not libsir is in the initialized state. | |
| uint16_t | sir_geterror (char message[SIR_MAXERROR]) |
| 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 associated error code. | |
| void | sir_geterrorinfo (sir_errorinfo *err) |
| void | sir_geterrorinfo (sir_errorinfo *err) |
| Retrieves granular information about the last error that occurred on the calling thread. | |
| bool | sir_debug (PRINTF_FORMAT const char *format,...) |
| bool | sir_debug (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_DEBUG level message. | |
| bool | sir_info (PRINTF_FORMAT const char *format,...) |
| bool | sir_info (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_INFO level message. | |
| bool | sir_notice (PRINTF_FORMAT const char *format,...) |
| bool | sir_notice (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_NOTICE level message. | |
| bool | sir_warn (PRINTF_FORMAT const char *format,...) |
| bool | sir_warn (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_WARN level message. | |
| bool | sir_error (PRINTF_FORMAT const char *format,...) |
| bool | sir_error (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_ERROR level message. | |
| bool | sir_crit (PRINTF_FORMAT const char *format,...) |
| bool | sir_crit (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_CRIT level message. | |
| bool | sir_alert (PRINTF_FORMAT const char *format,...) |
| bool | sir_alert (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_ALERT level message. | |
| bool | sir_emerg (PRINTF_FORMAT const char *format,...) |
| bool | sir_emerg (PRINTF_FORMAT const char *format,...) |
| Dispatches a SIRL_EMERG level message. | |
| sirfileid | sir_addfile (const char *path, sir_levels levels, sir_options opts) |
| sirfileid | sir_addfile (const char *path, sir_levels levels, sir_options opts) |
| Adds a log file and registers it to receive log output. | |
| bool | sir_remfile (sirfileid id) |
| bool | sir_remfile (sirfileid id) |
| Removes a file previously added to libsir. | |
| sirpluginid | sir_loadplugin (const char *path) |
| sirpluginid | sir_loadplugin (const char *path) |
| Loads a plugin module from disk. | |
| bool | sir_unloadplugin (sirpluginid id) |
| bool | sir_unloadplugin (sirpluginid id) |
| Unloads a previously registered plugin module. | |
| bool | sir_filelevels (sirfileid id, sir_levels levels) |
| bool | sir_filelevels (sirfileid id, sir_levels levels) |
| Set new level registrations for a log file already managed by libsir. | |
| bool | sir_fileopts (sirfileid id, sir_options opts) |
| bool | sir_fileopts (sirfileid id, sir_options opts) |
| Set new formatting options for a log file already managed by libsir. | |
| bool | sir_settextstyle (sir_level level, sir_textattr attr, sir_textcolor fg, sir_textcolor bg) |
| 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. | |
| bool | sir_resettextstyles (void) |
| bool | sir_resettextstyles (void) |
| Reset text styling for stdio (stdout/stderr) destinations to their default values. | |
| sir_textcolor | sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) |
| sir_textcolor | sir_makergb (sir_textcolor r, sir_textcolor g, sir_textcolor b) |
| Creates a sir_textcolor from red, green, and blue components. | |
| bool | sir_setcolormode (sir_colormode mode) |
| bool | sir_setcolormode (sir_colormode mode) |
| Sets the ANSI color mode for stdio destinations. | |
| bool | sir_stdoutlevels (sir_levels levels) |
| bool | sir_stdoutlevels (sir_levels levels) |
Set new level registrations for stdout. | |
| bool | sir_stdoutopts (sir_options opts) |
| bool | sir_stdoutopts (sir_options opts) |
Set new formatting options for stdout. | |
| bool | sir_stderrlevels (sir_levels levels) |
| bool | sir_stderrlevels (sir_levels levels) |
Set new level registrations for stderr. | |
| bool | sir_stderropts (sir_options opts) |
| bool | sir_stderropts (sir_options opts) |
Set new formatting options for stderr. | |
| bool | sir_sysloglevels (sir_levels levels) |
| bool | sir_sysloglevels (sir_levels levels) |
| Set new level registrations for the system logger destination. | |
| bool | sir_syslogopts (sir_options opts) |
| bool | sir_syslogopts (sir_options opts) |
| Set new formatting options for the system logger destination. | |
| bool | sir_syslogid (const char *identity) |
| bool | sir_syslogid (const char *identity) |
| Set new system logger identity. | |
| bool | sir_syslogcat (const char *category) |
| bool | sir_syslogcat (const char *category) |
| Set new system logger category. | |
| const char * | sir_getversionstring (void) |
| const char * | sir_getversionstring (void) |
| Returns the current libsir version as a string. | |
| uint32_t | sir_getversionhex (void) |
| uint32_t | sir_getversionhex (void) |
| Returns the current libsir version as a number. | |
| bool | sir_isprerelease (void) |
| bool | sir_isprerelease (void) |
| Whether or not this is a pre-release version of libsir. | |
sirfileid sir_addfile
(
- const char *
- path,
+ const char * path,
sir_levels
- levels,
+ sir_levels levels,
sir_options
- opts
-
-
- )
- sir_options opts )
@@ -273,8 +266,8 @@ sir_filelevels and sir_fileopts, respectively.
-
sir_filelevels and sir_fileopts, respectively.
-- See also
- sir_remfile
+To change the file's level registrations or options after adding it, call sir_filelevels and sir_fileopts, respectively.
+- See also
- sir_remfile
- Parameters
-
Dispatches a SIRL_ALERT level message.
The message will be delivered to all destinations registered to receive alert-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Tears down and cleans up libsir after use.
-Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
-May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
-- Returns
- bool
trueif cleanup was successful,false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
Deallocates resources such as memory buffers, file descriptors, etc. and resets the internal state. No calls into libsir will succeed after calling sir_cleanup (with the exception of sir_makeinit, sir_init, sir_isinitialized,sir_geterror, and sir_geterrorinfo).
+May be called from any thread. If you wish to utilize libsir again during the same process' lifetime, simply call sir_init again.
+- Returns
- bool
trueif cleanup was successful,false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
bool sir_crit
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_CRIT level message.
The message will be delivered to all destinations registered to receive critical-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_DEBUG level message.
The message will be delivered to all destinations registered to receive debug-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_EMERG level message.
The message will be delivered to all destinations registered to receive emergency-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Dispatches a SIRL_ERROR level message.
The message will be delivered to all destinations registered to receive error-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
@@ -566,7 +516,7 @@ See also sir_fileopts
+- See also
- sir_fileopts
- Parameters
-
@@ -610,7 +553,7 @@ SIRO_ALL
SIRO_NOHOST
-- See also
- sir_filelevels
+- See also
- sir_filelevels
- Parameters
-
Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.
-To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
+To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -660,15 +602,14 @@ void sir_geterrorinfo
(
- sir_errorinfo *
- err )
+ sir_errorinfo * err )
Retrieves granular information about the last error that occurred on the calling thread.
-To retrieve just an error code and a formatted message, use sir_geterror.
+To retrieve just an error code and a formatted message, use sir_geterror.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -688,8 +629,7 @@ uint32_t sir_getversionhex
(
- void
- )
+ void )
@@ -710,8 +650,7 @@ const char * sir_getversionstring
(
- void
- )
+ void )
bool sir_info
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_INFO level message.
The message will be delivered to all destinations registered to receive information-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Initializes libsir for use.
-Must be called before making any other calls into libsir (with the exception of sir_makeinit).
-For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
-- See also
- sir_makeinit
+Must be called before making any other calls into libsir (with the exception of sir_makeinit).
+For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
+- See also
- sir_makeinit
-
-sir_cleanup
+sir_cleanup
- Parameters
-
si Pointer to a sirinit structure containing the desired settings and configuration. libsir makes a copy of this structure, so its lifetime is not a concern.
-- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if initialization was successful, false otherwise. Call sir_geterror to obtain information about any error that may have occurred.
@@ -811,8 +742,7 @@ bool sir_isinitialized
(
- void
- )
+ void )
Remarks Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
-- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
+- Remarks
- Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
+- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
@@ -834,8 +764,7 @@ bool sir_isprerelease
(
- void
- )
+ void )
sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
Dispatches a SIRL_CRIT level message.
The message will be delivered to all destinations registered to receive critical-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Dispatches a SIRL_DEBUG level message.
The message will be delivered to all destinations registered to receive debug-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Dispatches a SIRL_EMERG level message.
The message will be delivered to all destinations registered to receive emergency-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Dispatches a SIRL_ERROR level message.
The message will be delivered to all destinations registered to receive error-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
See also sir_fileopts
+- See also
- sir_fileopts
- Parameters
-
SIRO_ALL
SIRO_NOHOST
-- See also
- sir_filelevels
+- See also
- sir_filelevels
- Parameters
-
Retrieves a formatted message for the last error that occurred on the calling thread and returns the associated error code.
-To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
+To retrieve more granular information about an error, or to customize the error message format, use sir_geterrorinfo.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -660,15 +602,14 @@
void sir_geterrorinfo
( -sir_errorinfo * -err ) +sir_errorinfo * err )
Retrieves granular information about the last error that occurred on the calling thread.
-To retrieve just an error code and a formatted message, use sir_geterror.
+To retrieve just an error code and a formatted message, use sir_geterror.
- Remarks
- libsir maintains errors on a per-thread basis, so it's important that the same thread that encountered a failed library call be the one to retrieve the error message.
- Parameters
-
@@ -688,8 +629,7 @@
@@ -710,8 +650,7 @@uint32_t sir_getversionhex
( -void -) +void ) const char * sir_getversionstring
( -void -) +void ) @@ -734,31 +673,24 @@ bool sir_info
( -PRINTF_FORMAT const char * -format, +PRINTF_FORMAT const char * format, - ... -- - ) -+ ... )
Dispatches a SIRL_INFO level message.
The message will be delivered to all destinations registered to receive information-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Initializes libsir for use.
-Must be called before making any other calls into libsir (with the exception of sir_makeinit).
-For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
-- See also
- sir_makeinit +
- See also
- sir_makeinit
- -sir_cleanup
Must be called before making any other calls into libsir (with the exception of sir_makeinit).
+For every call to sir_init, there must be a corresponding call to sir_cleanup. All exported libsir functions are thread-safe, so you may initialize and cleanup on whichever thread you wish.
+- Parameters
-
si Pointer to a sirinit structure containing the desired settings and configuration. libsir makes a copy of this structure, so its lifetime is not a concern.
- Returns
- bool
trueif initialization was successful,falseotherwise. Call sir_geterror to obtain information about any error that may have occurred.
- Returns
- bool
trueif initialization was successful,falseotherwise. Call sir_geterror to obtain information about any error that may have occurred.
Remarks Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
-- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
+- Remarks
- Calling sir_init after libsir is initialized produces an error. Similarly, sir_cleanup behaves the same way if libsir is not initialized.
+- Returns
- bool
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made.
@@ -834,8 +764,7 @@ bool sir_isprerelease
(
- void
- )
+ void )
sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made. true if sir_init has been called and libsir is initialized; false if sir_init has not yet been called, or a corresponding call to sir_cleanup has already been made. sirpluginid sir_loadplugin
(
- const char *
- path )
+ const char * path )
Remarks If path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.
The return value from this function is only valid for the lifetime of the process. If a crash or restart occurs, you will no longer be able to refer to the plugin by that identifier, and will have to load it again (libsir does not persist its plugin cache).
-- See also
- sir_unloadplugin
+- See also
- sir_unloadplugin
-
Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
@@ -890,8 +818,7 @@ bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
-- See also
- sir_setcolormode
+- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-- See also
- sir_filelevels
+- See also
- sir_filelevels
-
-sir_fileopts
+sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir.
-- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the file is known to libsir and was successfully removed, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
-- See also
- sir_setcolormode
+- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
+- See also
- sir_setcolormode
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
-- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+Defaults
+- Returns
- bool
true if successfully reset, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
- See also
- sir_makergb
+- See also
- sir_makergb
-
-sir_settextstyle
+sir_settextstyle
-
-Defaults
+Defaults
- Parameters
-
mode One of the SIRCM_* constants, defining the mode to use.
-- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the color mode was changed successfully, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1115,42 +1024,33 @@ bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
path is a relative path, it shall be treated as relative to the current working directory. This is not necessarily the same directory that your application's binary file resides in.- See also
- sir_unloadplugin +
- See also
- sir_unloadplugin
- Plugins
- Parameters
-
@@ -877,7 +805,7 @@
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
- Returns
- sirpluginid If successful, a unique identifier that may later be used to unload the plugin module. Upon failure, returns zero. Use sir_geterror to obtain information about any error that may have occurred.
- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
- See also
- sir_setcolormode +
- Note
- Use this function to create colors suitable for sir_settextstyle when using RGB color mode.
- See also
- sir_setcolormode
- -sir_settextstyle +sir_settextstyle
- -Defaults
- Parameters
-
r The red component (0..255) bool sir_notice
( -PRINTF_FORMAT const char * -format, +PRINTF_FORMAT const char * format, - ... -- - ) -+ ... ) - Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle. - Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle. - See also
- sir_level
- sir_option
- -Defaults
- Parameters
- See also
- sir_filelevels +
- See also
- sir_filelevels
- -sir_fileopts
- Parameters
-
id The sirfileid obtained when the file was added to libsir. - Returns
- bool
trueif the file is known to libsir and was successfully removed,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred. - Returns
- bool
trueif the file is known to libsir and was successfully removed,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred. - Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
- See also
- sir_setcolormode +
- Note
- The text styling will be applied according to the current color mode (as previously set by sir_setcolormode, or by default, 16-color mode).
- See also
- sir_setcolormode
- -sir_settextstyle +sir_settextstyle
- -Defaults
- Returns
- bool
trueif successfully reset,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred. - Returns
- bool
trueif successfully reset,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred. - See also
- sir_makergb +
- See also
- sir_makergb
- -sir_settextstyle +sir_settextstyle
- -Defaults
bool sir_makeinit
(
- sirinit *
- si )
+ sirinit * si )
sir_textcolor sir_makergb
(
- sir_textcolor
- r,
+ sir_textcolor r,
sir_textcolor
- g,
+ sir_textcolor g,
sir_textcolor
- b
-
-
- )
- sir_textcolor b )
Creates a sir_textcolor from red, green, and blue components.
-
-
+
+Defaults
Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-
+
+Defaults
Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
+Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-
+sir_fileopts
-
+
@@ -1047,21 +958,20 @@ bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-
-
+
-
+Defaults
+
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
+Defaults
Creates a sir_textcolor from red, green, and blue components.
-Dispatches a SIRL_NOTICE level message.
The message will be delivered to all destinations registered to receive notice-level messages, each with their own formatting and styling options.
-Removes a file previously added to libsir.
-Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Immediately causes the file represented by id (the value returned from sir_addfile) to be removed from libsir, and its file descriptor closed.
Its contents will remain intact, and any pending writes will be flushed to the file before it is closed.
-bool sir_resettextstyles
(
- void
- )
+ void )
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-
-
+
-
+Defaults
+
@@ -1074,8 +984,7 @@ bool sir_setcolormode
(
- sir_colormode
- mode )
+ sir_colormode mode )
+Defaults
Reset text styling for stdio (stdout/stderr) destinations to their default values.
-
+Defaults
- Parameters
-
mode One of the SIRCM_*constants, defining the mode to use.
- Returns
- bool
trueif the color mode was changed successfully,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred.
- Returns
- bool
trueif the color mode was changed successfully,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred.
bool sir_settextstyle
(
- sir_level
- level,
+ sir_level level,
sir_textattr
- attr,
+ sir_textattr attr,
sir_textcolor
- fg,
+ sir_textcolor fg,
sir_textcolor
- bg
-
-
- )
- sir_textcolor bg )
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode
+
-- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
+Defaults
+- Note
- Use
SIRTC_DEFAULT to get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts.
-- See also
- sir_stderropts
+To modify formatting options for stderr, use sir_stderropts.
+- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1209,8 +1108,7 @@ bool sir_stderropts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
Set new text styling for stdio (stdout/stderr) destinations on a per-level basis.
-- See also
- sir_setcolormode + -
- Note
- Use
SIRTC_DEFAULTto get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Note
- Use
SIRTC_DEFAULTto get the default foreground or background color. To set colors in RGB color mode, use sir_makergb to create the foreground and background colors.
- Parameters
-
sir_stderropts. -
- See also
- sir_stderropts
To modify formatting options for
+stderr, use sir_stderropts.- See also
- sir_stderropts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
- Returns
- bool
trueif successfully updated,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred.
- Returns
- bool
trueif successfully updated,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred.
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stderr, use sir_stderrlevels.
-- See also
- sir_stderrlevels
+To modify level registrations for stderr, use sir_stderrlevels.
+- See also
- sir_stderrlevels
- Parameters
-
opts New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1245,8 +1143,7 @@ bool sir_stdoutlevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
stderr, use sir_stderrlevels.stderr, use sir_stderrlevels.| opts | New bitmask of sir_option for stderr. If you wish to use the default values, pass SIRL_DEFAULT. |
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. sir_stdoutopts.
-- See also
- sir_stdoutopts
+To modify formatting options for stdout, use sir_stdoutopts.
+- See also
- sir_stdoutopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1281,8 +1178,7 @@ bool sir_stdoutopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
stdout, use sir_stdoutopts.| levels | New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT. |
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. SIRO_NOPID
SIRO_NOTID
-To modify level registrations for stdout, use sir_stdoutlevels.
-- See also
- sir_stdoutlevels
+To modify level registrations for stdout, use sir_stdoutlevels.
+- See also
- sir_stdoutlevels
- Parameters
-
opts New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1317,8 +1213,7 @@ bool sir_syslogcat
(
- const char *
- category )
+ const char * category )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
stdout, use sir_stdoutlevels.stdout, use sir_stdoutlevels.| opts | New bitmask of sir_option for stdout. If you wish to use the default values, pass SIRL_DEFAULT. |
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1352,8 +1247,7 @@ bool sir_syslogid
(
- const char *
- identity )
+ const char * identity )
Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. Returns bool true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1388,8 +1282,7 @@ bool sir_sysloglevels
(
- sir_levels
- levels )
+ sir_levels levels )
sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. sir_syslogopts.
-- See also
- sir_syslogopts
+To modify formatting options for the system logger, use sir_syslogopts.
+- See also
- sir_syslogopts
- Parameters
-
levels New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1425,8 +1318,7 @@ bool sir_syslogopts
(
- sir_options
- opts )
+ sir_options opts )
SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
| levels | New bitmask of sir_level to register for. If you wish to use the default levels, pass SIRL_DEFAULT. |
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. SIRO_MSGONLY
-To modify level registrations for the system logger, use sir_sysloglevels.
-- See also
- sir_sysloglevels
+To modify level registrations for the system logger, use sir_sysloglevels.
+- See also
- sir_sysloglevels
- Parameters
-
opts New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT.
-- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1458,17 +1350,16 @@ bool sir_unloadplugin
(
- sirpluginid
- id )
+ sirpluginid id )
Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
+Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin
+- See also
- sir_loadplugin
-
Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
+- Returns
- bool
true if the plugin was located and successfully unloaded,false otherwise. Use sir_geterror to obtain information about any error that may have occurred.
@@ -1490,31 +1381,24 @@ bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
| opts | New bitmask of sir_option for the system logger. If you wish to use the default values, pass SIRO_DEFAULT. |
true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. true if successfully updated, false otherwise. Use sir_geterror to obtain information about any error that may have occurred. Unloads a previously registered plugin module.
-Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
Cleans up, de-registers, and unloads a plugin represented by id (the value returned from sir_loadplugin).
If the plugin is located in the cache, it is instructed to clean up and prepare to be unloaded. Upon completion of the plugin's clean up routine, it is unloaded.
-- See also
- sir_loadplugin +
- See also
- sir_loadplugin
- Plugins
- Parameters
-
@@ -1477,7 +1368,7 @@
- Returns
- bool
trueif the plugin was located and successfully unloaded,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred. - Returns
- bool
trueif the plugin was located and successfully unloaded,falseotherwise. Use sir_geterror to obtain information about any error that may have occurred.
bool sir_warn
(
- PRINTF_FORMAT const char *
- format,
+ PRINTF_FORMAT const char * format,
- ...
-
-
- )
- ... )
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
+- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
-
sir_option
-
-Defaults
+Defaults
- Parameters
-
-
+
@@ -84,7 +85,7 @@
@@ -126,23 +127,23 @@
Data Structures
struct sir_errorinfo Information about an error that occurred. More...
struct sir_errorinfo Information about an error that occurred. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_textstyle Container for all the information associated with the appearance of text in the context of stdio. More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_stdio_dest Configuration for stdio destinations (stdout and stderr). More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sir_syslog_dest Configuration for the system logger destination. More...
struct sirinit libsir initialization and configuration data. More...
struct sirinit libsir initialization and configuration data. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
struct sir_syslog_dest._state Reserved for internal use; do not modify. More...
@@ -197,7 +198,7 @@
#define SIRO_NOTIME 0x00000100U Exclude time stamps (implies SIRO_NOMSEC).
Exclude time stamps (implies SIRO_NOMSEC).
#define SIRO_NOMSEC 0x00000200U
#define SIRO_MSGONLY 0x00007f00U Sets all other options except SIRO_NOHDR.
Sets all other options except SIRO_NOHDR.
#define SIRO_DEFAULT 0x00100000U
typedef uint16_t sir_level The sir_level type.
The sir_level type.
typedef uint16_t sir_levels sir_level bitmask type.
sir_level bitmask type.
typedef uint32_t sir_option The sir_option type.
The sir_option type.
typedef uint32_t sir_options sir_option bitmask type.
sir_option bitmask type.
typedef uint32_t sir_textcolor
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__tests.map b/docs/group__tests.map
index 085ad2a90..ad952d8d2 100644
--- a/docs/group__tests.map
+++ b/docs/group__tests.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__tests.md5 b/docs/group__tests.md5
index 46144e7df..b4d20b070 100644
--- a/docs/group__tests.md5
+++ b/docs/group__tests.md5
@@ -1 +1 @@
-db77adefc3d96cc84c078a0646048943
\ No newline at end of file
+302ef8db879c584dfc6d30c5c968652c
\ No newline at end of file
diff --git a/docs/group__tests.svg b/docs/group__tests.svg
index 1b89865b0..1b4ed08d1 100644
--- a/docs/group__tests.svg
+++ b/docs/group__tests.svg
@@ -1,7 +1,7 @@
-
Dispatches a SIRL_WARN level message.
The message will be delivered to all destinations registered to receive warning-level messages, each with their own formatting and styling options.
-- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- Remarks
- To change options or level registrations for
stdout/stderr, call sir_stdoutopts/sir_stdoutlevels and sir_stderropts/sir_stderrlevels, respectively. To change the text styling on a per-level basis, call sir_settextstyle.
- See also
- sir_level
- sir_option
- -Defaults
- Parameters
Data Structures | |
| struct | sir_errorinfo |
| Information about an error that occurred. More... | |
| struct | sir_errorinfo |
| Information about an error that occurred. More... | |
| struct | sir_textstyle |
| Container for all the information associated with the appearance of text in the context of stdio. More... | |
| struct | sir_textstyle |
| Container for all the information associated with the appearance of text in the context of stdio. More... | |
| struct | sir_stdio_dest |
| Configuration for stdio destinations (stdout and stderr). More... | |
| struct | sir_stdio_dest |
| Configuration for stdio destinations (stdout and stderr). More... | |
| struct | sir_syslog_dest |
| Configuration for the system logger destination. More... | |
| struct | sir_syslog_dest |
| Configuration for the system logger destination. More... | |
| struct | sirinit |
| libsir initialization and configuration data. More... | |
| struct | sirinit |
| libsir initialization and configuration data. More... | |
| struct | sir_syslog_dest._state |
| Reserved for internal use; do not modify. More... | |
| struct | sir_syslog_dest._state |
| Reserved for internal use; do not modify. More... | |
@@ -197,7 +198,7 @@
| | Exclude time stamps (implies SIRO_NOMSEC). | | | | Sets all other options except SIRO_NOHDR. | | | | The sir_level type. | | | sir_level bitmask type. | | | The sir_option type. | | | sir_option bitmask type. | | | ||||||||||||||||||||||||||||||||||||||||
Detailed Description
@@ -408,7 +409,7 @@
code
-Numeric error code (see sir_errorcode).
+Numeric error code (see sir_errorcode).
const char *
@@ -465,19 +466,19 @@
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
(
- void
- )
+ void )
bool sirtest_exceedmaxsize
(
- void
- )
+ void )
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
Data Fields
-sir_textattr
+sir_textattr
attr
Text attributes.
-sir_textcolor
+sir_textcolor
bg
Background color.
-sir_textcolor
+sir_textcolor
fg
@@ -498,21 +499,21 @@ &
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
+- See also
- sir_syslog_dest
Data Fields
-sir_levels
+sir_levels
levels
-sir_level bitmask defining output levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output.
@@ -529,11 +530,11 @@
Data Fields
-struct sir_syslog_dest._state
+struct sir_syslog_dest._state
_state
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. - See also
- sir_syslogid
-sir_levels
+sir_levels
levels
-sir_level bitmask defining levels to register for.
-sir_options
+sir_options
opts
-sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
+sir_option bitmask defining the formatting of output. - Remarks
- Unlike the stdio and log file destinations, not all options are supported. This is due to the fact that system logging facilities typically already include the information represented by sir_option on their own.
Furthermore, the supported options vary based on the system logging facility in use.
- Note
- If your system supports syslog, and libsir is compiled with the intent to use it (SIR_SYSLOG_ENABLED is defined), then at least SIRO_NOPID is supported.
◆
- Note
- Pass a pointer to an instance of this structure to sir_init to begin using libsir.
- See also
- sir_makeinit
-
-sir_stdio_dest
+sir_stdio_dest
-
-sir_syslog_dest
+sir_syslog_dest
Data Fields
-sir_stdio_dest
+sir_stdio_dest
d_stderr
stderr configuration.
-sir_stdio_dest
+sir_stdio_dest
d_stdout
stdout configuration.
-sir_syslog_dest
+sir_syslog_dest
d_syslog
@@ -614,7 +615,7 @@ ◆
name[SIR_MAXNAME]
-The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
+The name to use in log messages (usually the process name). Set SIRO_NONAME in a destination's options bitmask to suppress it.
@@ -710,7 +711,7 @@
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
-
+
@@ -84,7 +85,7 @@
@@ -116,9 +117,6 @@
Tests
-
-libsir integrity tests
-More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
Functions
bool sirtest_threadrace (void) bool sirtest_threadrace (void) Properly handle multiple threads competing for locked sections.
bool sirtest_exceedmaxsize (void) bool sirtest_exceedmaxsize (void) Properly handle messages that exceed internal buffer sizes.
bool sirtest_logwritesanity (void) bool sirtest_logwritesanity (void) Ensure the correct (and complete) message is written to a log file.
bool sirtest_failnooutputdest (void) bool sirtest_failnooutputdest (void) Properly handle the lack of any output destinations.
bool sirtest_failnulls (void) bool sirtest_failnulls (void) Properly handle null/empty input.
bool sirtest_failemptymessage (void) bool sirtest_failemptymessage (void) Ensure an empty message is properly handled.
bool sirtest_filecachesanity (void) bool sirtest_filecachesanity (void) Properly handle adding and removing log files.
bool sirtest_failinvalidfilename (void) bool sirtest_failinvalidfilename (void) Properly handle invalid log file name.
bool sirtest_failfilebadpermission (void) bool sirtest_failfilebadpermission (void) Properly handle log file without appropriate permissions.
bool sirtest_faildupefile (void) bool sirtest_faildupefile (void) Properly refuse to add a duplicate file.
bool sirtest_failremovebadfile (void) bool sirtest_failremovebadfile (void) Properly refuse to remove a file that isn't added.
bool sirtest_rollandarchivefile (void) bool sirtest_rollandarchivefile (void) Properly roll/archive a file when it hits max size.
bool sirtest_failwithoutinit (void) bool sirtest_failwithoutinit (void) Properly handle calls without initialization.
bool sirtest_isinitialized (void) bool sirtest_isinitialized (void) bool sirtest_failinittwice (void) bool sirtest_failinittwice (void) Properly handle two initialization calls without corresponding cleanup.
bool sirtest_failinvalidinitdata (void) bool sirtest_failinvalidinitdata (void) Properly handle initialization with junk memory.
bool sirtest_initcleanupinit (void) bool sirtest_initcleanupinit (void) Properly handle initialization, cleanup, re-initialization.
bool sirtest_initmakeinit (void) bool sirtest_initmakeinit (void) Properly initialize using sir_makeinit.
bool sirtest_failaftercleanup (void) bool sirtest_failaftercleanup (void) Properly handle calls after cleanup.
bool sirtest_errorsanity (void) bool sirtest_errorsanity (void) Properly return valid codes and messages for all possible errors.
bool sirtest_textstylesanity (void) bool sirtest_textstylesanity (void) Properly style stdio output for each level, and handle style overrides.
bool sirtest_optionssanity (void) bool sirtest_optionssanity (void) Properly reject invalid option bitmasks.
bool sirtest_levelssanity (void) bool sirtest_levelssanity (void) Properly reject invalid level bitmasks.
bool sirtest_mutexsanity (void) bool sirtest_mutexsanity (void) Ensure that the mutex implementation is functioning properly.
bool sirtest_perf (void) bool sirtest_perf (void) Performance evaluation.
bool sirtest_updatesanity (void) bool sirtest_updatesanity (void) Properly update levels/options at runtime.
bool sirtest_threadidsanity (void) bool sirtest_threadidsanity (void) Properly format thread ID/names in output.
bool sirtest_syslog (void) bool sirtest_syslog (void) Properly open, configure, and send messages to syslog().
bool sirtest_os_log (void) bool sirtest_os_log (void) Properly open, configure, and send messages to os_log().
bool sirtest_win_eventlog (void) bool sirtest_win_eventlog (void) Properly open, configure, and send messages to the Windows event log.
bool sirtest_filesystem (void) bool sirtest_filesystem (void) Ensure the proper functionality of portable filesystem implementation.
bool sirtest_squelchspam (void) bool sirtest_squelchspam (void) Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir.
bool sirtest_pluginloader (void) bool sirtest_pluginloader (void) Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected.
bool sirtest_stringutils (void) bool sirtest_stringutils (void) Ensure the string utility routines are functioning properly.
bool sirtest_getcpucount (void) bool sirtest_getcpucount (void) Ensure the processor counting routines are functioning properly.
bool sirtest_getversioninfo (void) bool sirtest_getversioninfo (void) Ensure that version retrieval exports are functioning properly.
bool sirtest_threadpool (void) bool sirtest_threadpool (void) Ensure the proper functioning of the thread pool and job queue mech- anisms.
@@ -259,8 +257,7 @@ bool sirtest_errorsanity
&
Configuration for stdio destinations (stdout and stderr).
-- See also
- sir_syslog_dest
- See also
- sir_syslog_dest
| Data Fields | ||
|---|---|---|
| -sir_levels | +sir_levelslevels | -sir_level bitmask defining output levels to register for. |
| -sir_options | +sir_optionsopts | -sir_option bitmask defining the formatting of output. |
| Data Fields | ||||
|---|---|---|---|---|
| -struct sir_syslog_dest._state | +struct sir_syslog_dest._state_state |
@@ -553,17 +554,17 @@
The identity string to pass to the system logger. | ||
| -sir_levels | +sir_levelslevels | -sir_level bitmask defining levels to register for. | ||
| -sir_options | +sir_optionsopts |
-sir_option bitmask defining the formatting of output.
Furthermore, the supported options vary based on the system logging facility in use.
| ||
| Data Fields | ||||
|---|---|---|---|---|
| -sir_stdio_dest | +sir_stdio_destd_stderr | stderr configuration. | ||
| -sir_stdio_dest | +sir_stdio_destd_stdout | stdout configuration. | ||
| -sir_syslog_dest | +sir_syslog_destd_syslog |
@@ -614,7 +615,7 @@ ◆
Set SIRO_NONAME in a destination's options bitmask to suppress it. +The name to use in log messages (usually the process name).Set SIRO_NONAME in a destination's options bitmask to suppress it. | ||
- enum sir_colormode
+ enum sir_colormode
@@ -736,7 +737,7 @@
- enum sir_errorcode
+ enum sir_errorcode
@@ -802,7 +803,7 @@
- enum sir_textattr
+ enum sir_textattr
@@ -829,7 +830,7 @@
- - Generated by 1.9.8
+ - Generated by 1.10.0
diff --git a/docs/group__publictypes.map b/docs/group__publictypes.map
index 31b0c9d2d..8f098da67 100644
--- a/docs/group__publictypes.map
+++ b/docs/group__publictypes.map
@@ -1,4 +1,4 @@
diff --git a/docs/group__publictypes.md5 b/docs/group__publictypes.md5
index a18c6eb04..a6aaa9202 100644
--- a/docs/group__publictypes.md5
+++ b/docs/group__publictypes.md5
@@ -1 +1 @@
-592859f31934e12bbc2fae14392963cb
\ No newline at end of file
+fdd951f04936449c1c4d517a61be34e1
\ No newline at end of file
diff --git a/docs/group__publictypes.svg b/docs/group__publictypes.svg
index 634a7c3f1..6beea046f 100644
--- a/docs/group__publictypes.svg
+++ b/docs/group__publictypes.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__publictypes_org.svg b/docs/group__publictypes_org.svg
index 2ca46a134..d45ca4cda 100644
--- a/docs/group__publictypes_org.svg
+++ b/docs/group__publictypes_org.svg
@@ -1,7 +1,7 @@
-
diff --git a/docs/group__tests.html b/docs/group__tests.html
index c165cd6db..1737fdb37 100644
--- a/docs/group__tests.html
+++ b/docs/group__tests.html
@@ -4,7 +4,7 @@
-
+
@@ -32,6 +32,7 @@
+
@@ -54,7 +55,7 @@
- enum sir_errorcode
+ enum sir_errorcode
- enum sir_textattr
+ enum sir_textattr
- - Generated by 1.9.8
+ - Generated by 1.10.0
1.9.8 1.10.0
@@ -116,9 +117,6 @@
Tests
-
-
libsir integrity tests -More...
Collaboration diagram for Tests:
@@ -136,114 +134,114 @@
@@ -259,8 +257,7 @@
Functions | |
| bool | sirtest_threadrace (void) |
| bool | sirtest_threadrace (void) |
| Properly handle multiple threads competing for locked sections. | |
| bool | sirtest_exceedmaxsize (void) |
| bool | sirtest_exceedmaxsize (void) |
| Properly handle messages that exceed internal buffer sizes. | |
| bool | sirtest_logwritesanity (void) |
| bool | sirtest_logwritesanity (void) |
| Ensure the correct (and complete) message is written to a log file. | |
| bool | sirtest_failnooutputdest (void) |
| bool | sirtest_failnooutputdest (void) |
| Properly handle the lack of any output destinations. | |
| bool | sirtest_failnulls (void) |
| bool | sirtest_failnulls (void) |
| Properly handle null/empty input. | |
| bool | sirtest_failemptymessage (void) |
| bool | sirtest_failemptymessage (void) |
| Ensure an empty message is properly handled. | |
| bool | sirtest_filecachesanity (void) |
| bool | sirtest_filecachesanity (void) |
| Properly handle adding and removing log files. | |
| bool | sirtest_failinvalidfilename (void) |
| bool | sirtest_failinvalidfilename (void) |
| Properly handle invalid log file name. | |
| bool | sirtest_failfilebadpermission (void) |
| bool | sirtest_failfilebadpermission (void) |
| Properly handle log file without appropriate permissions. | |
| bool | sirtest_faildupefile (void) |
| bool | sirtest_faildupefile (void) |
| Properly refuse to add a duplicate file. | |
| bool | sirtest_failremovebadfile (void) |
| bool | sirtest_failremovebadfile (void) |
| Properly refuse to remove a file that isn't added. | |
| bool | sirtest_rollandarchivefile (void) |
| bool | sirtest_rollandarchivefile (void) |
| Properly roll/archive a file when it hits max size. | |
| bool | sirtest_failwithoutinit (void) |
| bool | sirtest_failwithoutinit (void) |
| Properly handle calls without initialization. | |
| bool | sirtest_isinitialized (void) |
| bool | sirtest_isinitialized (void) |
| bool | sirtest_failinittwice (void) |
| bool | sirtest_failinittwice (void) |
| Properly handle two initialization calls without corresponding cleanup. | |
| bool | sirtest_failinvalidinitdata (void) |
| bool | sirtest_failinvalidinitdata (void) |
| Properly handle initialization with junk memory. | |
| bool | sirtest_initcleanupinit (void) |
| bool | sirtest_initcleanupinit (void) |
| Properly handle initialization, cleanup, re-initialization. | |
| bool | sirtest_initmakeinit (void) |
| bool | sirtest_initmakeinit (void) |
| Properly initialize using sir_makeinit. | |
| bool | sirtest_failaftercleanup (void) |
| bool | sirtest_failaftercleanup (void) |
| Properly handle calls after cleanup. | |
| bool | sirtest_errorsanity (void) |
| bool | sirtest_errorsanity (void) |
| Properly return valid codes and messages for all possible errors. | |
| bool | sirtest_textstylesanity (void) |
| bool | sirtest_textstylesanity (void) |
| Properly style stdio output for each level, and handle style overrides. | |
| bool | sirtest_optionssanity (void) |
| bool | sirtest_optionssanity (void) |
| Properly reject invalid option bitmasks. | |
| bool | sirtest_levelssanity (void) |
| bool | sirtest_levelssanity (void) |
| Properly reject invalid level bitmasks. | |
| bool | sirtest_mutexsanity (void) |
| bool | sirtest_mutexsanity (void) |
| Ensure that the mutex implementation is functioning properly. | |
| bool | sirtest_perf (void) |
| bool | sirtest_perf (void) |
| Performance evaluation. | |
| bool | sirtest_updatesanity (void) |
| bool | sirtest_updatesanity (void) |
| Properly update levels/options at runtime. | |
| bool | sirtest_threadidsanity (void) |
| bool | sirtest_threadidsanity (void) |
| Properly format thread ID/names in output. | |
| bool | sirtest_syslog (void) |
| bool | sirtest_syslog (void) |
| Properly open, configure, and send messages to syslog(). | |
| bool | sirtest_os_log (void) |
| bool | sirtest_os_log (void) |
| Properly open, configure, and send messages to os_log(). | |
| bool | sirtest_win_eventlog (void) |
| bool | sirtest_win_eventlog (void) |
| Properly open, configure, and send messages to the Windows event log. | |
| bool | sirtest_filesystem (void) |
| bool | sirtest_filesystem (void) |
| Ensure the proper functionality of portable filesystem implementation. | |
| bool | sirtest_squelchspam (void) |
| bool | sirtest_squelchspam (void) |
| Ensure that spam messages are squelched, normal messages are not, and proper return values result from calls into libsir. | |
| bool | sirtest_pluginloader (void) |
| bool | sirtest_pluginloader (void) |
| Ensure that well-formed, valid plugins are successfully loaded, and that ill-formed/incorrectly behaving plugins are rejected. | |
| bool | sirtest_stringutils (void) |
| bool | sirtest_stringutils (void) |
| Ensure the string utility routines are functioning properly. | |
| bool | sirtest_getcpucount (void) |
| bool | sirtest_getcpucount (void) |
| Ensure the processor counting routines are functioning properly. | |
| bool | sirtest_getversioninfo (void) |
| bool | sirtest_getversioninfo (void) |
| Ensure that version retrieval exports are functioning properly. | |
| bool | sirtest_threadpool (void) |
| bool | sirtest_threadpool (void) |
| Ensure the proper functioning of the thread pool and job queue mech- anisms. | |
bool sirtest_errorsanity
bool sirtest_failaftercleanup
(
- void
- )
+ void )
bool sirtest_faildupefile
(
- void
- )
+ void )
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_failemptymessage
(
- void
- )
+ void )
bool sirtest_failfilebadpermission
(
- void
- )
+ void )
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_failinittwice
(
- void
- )
+ void )
bool sirtest_failinvalidfilename
(
- void
- )
+ void )
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_failinvalidinitdata
(
- void
- )
+ void )
bool sirtest_failnooutputdest
(
- void
- )
+ void )
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_failnulls
(
- void
- )
+ void )
bool sirtest_failremovebadfile
(
- void
- )
+ void )
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_failwithoutinit
(
- void
- )
+ void )
bool sirtest_filecachesanity
(
- void
- )
+ void )
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_filesystem
(
- void
- )
+ void )
bool sirtest_getcpucount
(
- void
- )
+ void )
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_getversioninfo
(
- void
- )
+ void )
bool sirtest_initcleanupinit
(
- void
- )
+ void )
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_initmakeinit
(
- void
- )
+ void )
bool sirtest_isinitialized
(
- void
- )
+ void )
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_levelssanity
(
- void
- )
+ void )
bool sirtest_logwritesanity
(
- void
- )
+ void )
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_mutexsanity
(
- void
- )
+ void )
bool sirtest_optionssanity
(
- void
- )
+ void )
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_os_log
(
- void
- )
+ void )
bool sirtest_perf
(
- void
- )
+ void )
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_pluginloader
(
- void
- )
+ void )
bool sirtest_rollandarchivefile
(
- void
- )
+ void )
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_squelchspam
(
- void
- )
+ void )
bool sirtest_stringutils
(
- void
- )
+ void )
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_syslog
(
- void
- )
+ void )
bool sirtest_textstylesanity
(
- void
- )
+ void )
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_threadidsanity
(
- void
- )
+ void )
bool sirtest_threadpool
(
- void
- )
+ void )
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_threadrace
(
- void
- )
+ void )
bool sirtest_updatesanity
(
- void
- )
+ void )
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
bool sirtest_win_eventlog
(
- void
- )
+ void )
- - Generated by 1.9.8
+ - Generated by 1.10.0
-
-
- Generated by 1.9.8
+
- Generated by 1.10.0