summaryrefslogtreecommitdiffstats
path: root/liblog.h
blob: fb5f097440a5bf85bd1b3618ebfc04d4a5488ba7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
/* See LICENSE file for copyright and license details. */
#ifndef LIBLOG_H
#define LIBLOG_H

#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>



#if defined(__clang__)
# pragma clang diagnostic push
# pragma clang diagnostic ignored "-Wformat-nonliteral"
# pragma clang diagnostic ignored "-Wpadded"
#elif defined(__GNUC__)
# pragma GCC diagnostic push
# pragma GCC diagnostic ignored "-Wformat-nonliteral"
#endif


/**
 * Mark the message as incomplete an deferred
 * printing until LIBLOG_XLOG_UNCORK is used.
 */
#define LIBLOG_XLOG_CORK         0x0001

/**
 * Output message printed since the first
 * LIBLOG_XLOG_CORK (after the last
 * LIBLOG_XLOG_UNCORK if any) as one complete
 * message.
 */
#define LIBLOG_XLOG_UNCORK       0x0002

/**
 * Output a backtrace even if the it is not
 * configured that backtraces should be printed
 * for the selected log level.
 */
#define LIBLOG_XLOG_BACKTRACE    0x0004

/**
 * Do not output a backtrace even if the it is
 * configured that backtraces should be printed
 * for the selected log level.
 */
#define LIBLOG_XLOG_NO_BACKTRACE 0x0008

/**
 * Do not output any new text (apport from potential
 * backtrace); allowing `fmt` to be `NULL`.
 */
#define LIBLOG_XLOG_NO_TEXT      0x0010


/**
 * Opaque data type for the internal state
 * of a `struct liblog_context`
 */
struct liblog_context_internal_state;

/**
 * Log levels
 */
enum liblog_level {
	/**
	 * System is unusable
	 */
	LIBLOG_EMERGENCY = 0,

	/**
	 * Action must be taken immediately
	 */
	LIBLOG_ALERT     = 100,

	/**
	 * Critical condition
	 */
	LIBLOG_CRITICAL  = 200,

	/**
	 * Error condition
	 */
	LIBLOG_ERROR     = 300,

	/**
	 * Warning condition
	 */
	LIBLOG_WARNING   = 400,

	/**
	 * Normal, but significant, condition
	 */
	LIBLOG_NOTICE    = 500,

	/**
	 * Informational message
	 */
	LIBLOG_INFO      = 600,

	/**
	 * Less verbose debug-level message: what is happening on a high level
	 */
	LIBLOG_TRACE     = 700,

	/**
	 * More verbose debug-level message: detailed information about what is going on
	 */
	LIBLOG_DEBUG     = 800
};

/**
 * Log channel types
 */
enum liblog_sink {
	/**
	 * Output to syslog
	 */
	LIBLOG_SYSLOG,

	/**
	 * Output to a file descriptor
	 */
	LIBLOG_FILE,

	/**
	 * Output to a `FILE`
	 */
	LIBLOG_STREAM
};

/**
 * Log output configurations; mapping of log levels to log channels
 * 
 * Destroy with `liblog_destroy_output` if destroying manually
 */
struct liblog_output {
	/**
	 * User defined data
	 * 
	 * This could for example be a path name to the output
	 * file so that the application knows which file that
	 * should be subject to rotation when online log rotation
	 * is performed
	 */
	void *userdata;

	/**
	 * The prefix for each log line
	 * 
	 * A string where the following special symbols will be replaced
	 * -  %{ltime: %}   span that marks formatting of the current local time with strftime(3)
	 * -  %{utime: %}   span that marks formatting of the current UTC time with strftime(3)
	 * -  %[nano]       the nanoseconds of the current time, printed with 9 digits
	 * -  %[micro]      the microseconds of the current time, printed with 6 digits
	 * -  %[milli]      the milliseconds of the current time, printed with 3 digits
	 * -  %[centi]      the centiseconds of the current time, printed with 2 digits
	 * -  %[deci]       the deciseconds of the current time, printed with 1 digit
	 * -  %[function]   function where the log message is being printed from
	 * -  %[file]       file where the log message is being printed from
	 * -  %[line]       line in file where the log message is being printed from
	 * -  %[level]      log level for the message rounded down to a predefined value
	 *                  (printed as string)
	 * -  %[xlevel]     the exact log level for the message, printed as the name of
	 *                  of the log level rounded down to a predfined value, followed
	 *                  by an adjustment
	 * -  %[tid]        the process's thread ID
	 * -  %[pid]        the process's thread group ID (process ID)
	 * -  %[ppid]       the process's parent process ID
	 * -  %[pgid]       the process's process group ID
	 * -  %[sid]        the process's session ID
	 * -  %[uid]        the real user ID of the process
	 * -  %[euid]       the effective user ID of the process
	 * -  %[gid]        the real group ID of the process
	 * -  %[egid]       the effective group ID of the process
	 * -  %[name]       the name of process
	 * -  %[argv0]      the value of the global `const char *argv0`
	 * -  %%            a literal %
	 * 
	 * If `NULL`, this with be replace with a default format
	 */
	const char *prefixfmt;

	/**
	 * If set `.lowest_verbosity` is treated as set to
	 * the lowest possible value
	 */
	unsigned lowest_verbosity_unlimited : 1;

	/**
	 * If set `.higest_verbosity` is treated as set to
	 * the highest possible value
	 */
	unsigned highest_verbosity_unlimited : 1;

	/**
	 * If set, each log message will be prefixed with
	 * a backtrace
	 */
	unsigned use_backtrace : 1;

	unsigned : 0;

	/**
	 * The lowest log level, in regards to verbosity
	 * but higest in regard to criticality, for which
	 * this log output channel shall be used
	 * 
	 * Must not be greater than `.highest_verbosity`
	 */
	enum liblog_level lowest_verbosity;

	/**
	 * The higest log level, in regards to verbosity
	 * but lowest in regard to criticality, for which
	 * this log output channel shall be used
	 * 
	 * Must not be less than `.lowest_verbosity`
	 */
	enum liblog_level highest_verbosity;

	/**
	 * The output channel type
	 */
	enum liblog_sink sink_type;

	/**
	 * The output channel
	 */
	union {
		/**
		 * Used when `.sink_type` is `LIBLOG_SYSLOG`
		 * 
		 * The application is responsible for opening and closing syslog
		 */
		struct {
			/**
			 * The syslog log level to use
			 */
			int level;
		} syslog;

		/**
		 * Used when `.sink_type` is `LIBLOG_FILE`
		 */
		struct {
			/**
			 * The file descriptor to write to
			 */
			int fd;

			/**
			 * Whether the library shall close the file descriptor
			 * when destroying the `struct liblog_output` object
			 */
			unsigned owns_fd : 1;
		} file;

		/**
		 * Used when `.sink_type` is `LIBLOG_STREAM`
		 */
		struct {
			/**
			 * The stream to write to
			 */
			FILE *stream;

			/**
			 * Whether the library shall close the stream
			 * when destroying the `struct liblog_output` object
			 */
			unsigned owns_stream : 1;
		} stream;
	} sink;
};

/**
 * Logging configurations and state
 * 
 * Initialise with `liblog_init_context`, and then
 * configure output using any of the follow functions:
 * - liblog_use_fd
 * - liblog_use_fd_for_range
 * - liblog_use_file
 * - liblog_use_file_for_range
 * - liblog_use_stderr
 * - liblog_use_stderr_for_range
 * - liblog_use_stream
 * - liblog_use_stream_for_range
 * - liblog_use_syslog
 * - liblog_use_syslog_for_range
 * - liblog_use_output
 * 
 * Destroy with `liblog_destroy_context`
 */
struct liblog_context {
	/**
	 * Opaque state
	 */
	struct liblog_context_internal_state *internal_state;

	/**
	 * Log output configurations; mapping of log levels to log channels
	 */
	struct liblog_output *outputs;

	/**
	 * Number of elements in noutputs
	 */
	size_t noutputs;

	/**
	 * Mask of log level groups to exclude when logging
	 */
	unsigned logmask;
};
/* TODO add multithreading support */



/* for internal use { */
#define LIBLOG_VA__(FUNC, ...)\
	int ret;\
	va_list args;\
	va_start(args, fmt);\
	ret = FUNC(__VA_ARGS__, args);\
	va_end(args);\
	return ret

#define LIBLOG_OUTPUT_UNRANGED__(...)\
	(&(struct liblog_output){\
		.userdata = NULL,\
		.prefixfmt = prefixfmt,\
		.lowest_verbosity_unlimited = 1U,\
		.highest_verbosity_unlimited = 1U,\
		.use_backtrace = (use_backtrace ? 1U : 0U),\
		__VA_ARGS__\
	})

#define LIBLOG_OUTPUT_RANGED__(...)\
	(&(struct liblog_output){\
		.userdata = NULL,\
		.prefixfmt = prefixfmt,\
		.lowest_verbosity_unlimited = 0U,\
		.highest_verbosity_unlimited = 0U,\
		.use_backtrace = (use_backtrace ? 1U : 0U),\
		.lowest_verbosity = least_verbose,\
		.highest_verbosity = most_verbose,\
		__VA_ARGS__\
	})

#if defined(__clang__)
# define LIBLOG_PRINTF__(FMTIDX)  __attribute__((__format__(__printf__, (FMTIDX), (FMTIDX) + 1)))
# define LIBLOG_VPRINTF__(FMTIDX)  __attribute__((__format__(__printf__, (FMTIDX), 0)))
#elif defined(__GNUC__)
# define LIBLOG_PRINTF__(FMTIDX)  __attribute__((__format__(__gnu_printf__, (FMTIDX), (FMTIDX) + 1)))
# define LIBLOG_VPRINTF__(FMTIDX)  __attribute__((__format__(__gnu_printf__, (FMTIDX), 0)))
#else
# define LIBLOG_PRINTF__(FMTIDX)
# define LIBLOG_VPRINTF__(FMTIDX)
#endif

#if defined(__GNUC__)
# define LIBLOG_CONST__  __attribute__((__const__))
#else
# define LIBLOG_CONST__
#endif

LIBLOG_CONST__ unsigned liblog_logmask__(enum liblog_level least_verbose, enum liblog_level most_verbose);
/* } */


 
/**
 * Initialise a `struct liblog_context`
 * 
 * @param   ctx  That object to initialise
 * @return       0 on success, -1 on failure
 */
int liblog_init_context(struct liblog_context *ctx);

/**
 * Destroy a `struct liblog_context`
 * 
 * @param   ctx  That object to destroy
 * @return       0 on success, -1 on failure (object will
 *               still be completely destroyed)
 */
int liblog_destroy_context(struct liblog_context *ctx);

/**
 * Destroy a `struct liblog_output`
 * 
 * @param   output  That object to destroy
 * @return          0 on success, -1 on failure (object will
 *                  still be completely destroyed)
 */
int liblog_destroy_output(struct liblog_output *output);


/**
 * Remove log level mask, causing all log messages, that
 * have an output configured, to be printed
 * 
 * @param  ctx  Logging configurations and state
 */
inline void
liblog_clear_mask(struct liblog_context *ctx)
{ if (ctx) ctx->logmask = 0U; }

/**
 * Apply log level mask that is configured in the
 * process's environment variable "LIBLOG_LOGMASK"
 * 
 * This is done automatically by `liblog_init_context`
 * 
 * If the LIBLOG_LOGMASK environment variable is
 * unset or empty, anything more verbose than a
 * some specific level (currently `LIBLOG_WARNING`)
 * will be filtered.
 * 
 * @param  ctx  Logging configurations and state
 */
void liblog_apply_env_mask(struct liblog_context *ctx);

/**
 * Stop log messages within a certain range of
 * log levels from being printed
 * 
 * @param  ctx            Logging configurations and state
 * @param  least_verbose  The lowest (least verbose, most critical) log level
 *                        to filter out; will be rounded up or down (unspecified
 *                        which) to the closest predefined log level value
 * @param  most_verbose   The highest (most verbose, least critical) log level
 *                        to filter out; will be rounded up or down (unspecified
 *                        which) to the closest predefined log level value
 * 
 * This function has no effect if, after rounding, `least_verbose > most_verbose`
 */
inline void
liblog_mask_range(struct liblog_context *ctx, enum liblog_level least_verbose, enum liblog_level most_verbose)
{ if (ctx) ctx->logmask |= liblog_logmask__(least_verbose, most_verbose); }

/**
 * Stop log messages with a certain log level or
 * higher (more verbose, less critical) from being printed
 * 
 * @param  ctx    Logging configurations and state
 * @param  least  The lowest (least verbose, most critical) log level to
 *                filter out; will be rounded up or down (unspecified
 *                which) to the closest predefined log level value
 */
inline void
liblog_mask_verbose(struct liblog_context *ctx, enum liblog_level least)
{ liblog_mask_range(ctx, least, LIBLOG_DEBUG); }

/**
 * Stop log messages with a certain log level group
 * (all levels up to but excluding the next predefined
 * log level) from being printed
 * 
 * @param  ctx    Logging configurations and state
 * @param  group  The log level to filter out; will be rounded
 *                up or down (unspecified which) to the closest
 *                predefined log level value
 */
inline void
liblog_mask_level(struct liblog_context *ctx, enum liblog_level group)
{ liblog_mask_range(ctx, group, group); }

/**
 * Stop filtering out log messages within a certain
 * range of log levels from being printed
 * 
 * @param  ctx            Logging configurations and state
 * @param  least_verbose  The lowest (least verbose, most critical) log level to
 *                        stop filtering out; will be rounded up or down (unspecified
 *                        which) to the closest predefined log level value
 * @param  most_verbose   The highest (most verbose, least critical) log level to
 *                        filtering out; will be rounded up or down (unspecified
 *                        which) to the closest predefined log level value
 * 
 * This function has no effect if, after rounding, `least_verbose > most_verbose`
 */
inline void
liblog_unmask_range(struct liblog_context *ctx, enum liblog_level least_verbose, enum liblog_level most_verbose)
{ if (ctx) ctx->logmask &= ~liblog_logmask__(least_verbose, most_verbose); }

/**
 * Stop filtering out log messages with a certain log level or
 * higher (more verbose, less critical) from being printed
 * 
 * @param  ctx    Logging configurations and state
 * @param  least  The lowest (least verbose, most critical) log level to
 *                stop filtering out; will be rounded up or down (unspecified
 *                which) to the closest predefined log level value
 */
inline void
liblog_unmask_verbose(struct liblog_context *ctx, enum liblog_level least)
{ liblog_unmask_range(ctx, least, LIBLOG_DEBUG); }

/**
 * Stop filtering out log messages with a certain log level
 * group (all levels up to but excluding the next predefined
 * log level) from being printed
 * 
 * @param  ctx    Logging configurations and state
 * @param  group  The log level to stop filtering out; will be
 *                rounded up or down (unspecified which) to the
 *                closest predefined log level value
 */
inline void
liblog_unmask_level(struct liblog_context *ctx, enum liblog_level group)
{ liblog_unmask_range(ctx, group, group); }


/**
 * Add a log output
 * 
 * @param   ctx     Logging configurations and state
 * @param   output  The configurations for the additional output
 * @return          The new output configuration (this is an object
 *                  owned by `ctx` and should not be deallocated,
 *                  it is returned so that changes can be made)
 *                  on success, `NULL` on failure
 */
struct liblog_output *liblog_use_output(struct liblog_context *ctx, const struct liblog_output *output);

/**
 * Set up logging with syslog(3)
 * 
 * @param   ctx            Logging configurations and state
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @return                 0 on success, -1 on failure
 * 
 * This function adds multi new output configurations to `ctx`
 */
int liblog_use_syslog(struct liblog_context *ctx, const char *prefixfmt, int use_backtrace);

/**
 * Set up logging with syslog(3)
 * 
 * @param   ctx            Logging configurations and state
 * @param   syslog_level   The syslog(3) log level that shall be used
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @param   least_verbose  Lower (in regard to verbosity, upper in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @param   most_verbose   Upper (in regard to verbosity, lower in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_syslog_for_range(struct liblog_context *ctx, int syslog_level, const char *prefixfmt, int use_backtrace,
                            enum liblog_level least_verbose, enum liblog_level most_verbose)
{ return liblog_use_output(ctx, LIBLOG_OUTPUT_RANGED__(.sink_type = LIBLOG_SYSLOG, .sink.syslog = {syslog_level})); }

/**
 * Set up logging to a file descriptor
 * 
 * @param   ctx            Logging configurations and state
 * @param   fd             The file descriptor to log to
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_fd(struct liblog_context *ctx, int fd, const char *prefixfmt, int use_backtrace)
{ return liblog_use_output(ctx, LIBLOG_OUTPUT_UNRANGED__(.sink_type = LIBLOG_FILE, .sink.file = {fd, 0})); }

/**
 * Set up logging to a file descriptor
 * 
 * @param   ctx            Logging configurations and state
 * @param   fd             The file descriptor to log to
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @param   least_verbose  Lower (in regard to verbosity, upper in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @param   most_verbose   Upper (in regard to verbosity, lower in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_fd_for_range(struct liblog_context *ctx, int fd, const char *prefixfmt, int use_backtrace,
                        enum liblog_level least_verbose, enum liblog_level most_verbose)
{ return liblog_use_output(ctx, LIBLOG_OUTPUT_RANGED__(.sink_type = LIBLOG_FILE, .sink.file = {fd, 0})); }

/**
 * Set up logging to an output stream
 * 
 * @param   ctx            Logging configurations and state
 * @param   stream         The stream to log to
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_stream(struct liblog_context *ctx, FILE *stream, const char *prefixfmt, int use_backtrace)
{ return liblog_use_output(ctx, LIBLOG_OUTPUT_UNRANGED__(.sink_type = LIBLOG_STREAM, .sink.stream = {stream, 0})); }

/**
 * Set up logging to an output stream
 * 
 * @param   ctx            Logging configurations and state
 * @param   stream         The stream to log to
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @param   least_verbose  Lower (in regard to verbosity, upper in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @param   most_verbose   Upper (in regard to verbosity, lower in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_stream_for_range(struct liblog_context *ctx, FILE *stream, const char *prefixfmt, int use_backtrace,
                            enum liblog_level least_verbose, enum liblog_level most_verbose)
{ return liblog_use_output(ctx, LIBLOG_OUTPUT_RANGED__(.sink_type = LIBLOG_STREAM, .sink.stream = {stream, 0})); }

/**
 * Set up logging to a file
 * 
 * @param   ctx            Logging configurations and state
 * @param   dirfd          File descriptor to the directory `path` is relative to if
 *                         it is a relative path, or -1 to for the path to be absolute,
 *                         failing with EINVAL if it is relative); AT_FDCWD for the
 *                         current working directory
 * @param   path           The path of the file to write to, if `NULL` or `""`
 *                         dirfd will be used as the file descriptor to write to;
 *                         if the file exists, it is opened in append mode, otherwise
 *                         it is created to readable by every user but only writable
 *                         by the current user
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
struct liblog_output *liblog_use_file(struct liblog_context *ctx, int dirfd, const char *path,
                                      const char *prefixfmt, int use_backtrace);

/**
 * Set up logging to a file
 * 
 * @param   ctx            Logging configurations and state
 * @param   dirfd          File descriptor to the directory `path` is relative to if
 *                         it is a relative path, or -1 to for the path to be absolute,
 *                         failing with EINVAL if it is relative); AT_FDCWD for the
 *                         current working directory
 * @param   path           The path of the file to write to, if `NULL` or `""`
 *                         dirfd will be used as the file descriptor to write to;
 *                         if the file exists, it is opened in append mode, otherwise
 *                         it is created to readable by every user but only writable
 *                         by the current user
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @param   least_verbose  Lower (in regard to verbosity, upper in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @param   most_verbose   Upper (in regard to verbosity, lower in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
struct liblog_output *liblog_use_file_for_range(struct liblog_context *ctx, int dirfd, const char *path,
                                                const char *prefixfmt, int use_backtrace,
                                                enum liblog_level least_verbose, enum liblog_level most_verbose);

/**
 * Set up logging to the standard output
 * 
 * @param   ctx            Logging configurations and state
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_stderr(struct liblog_context *ctx, const char *prefixfmt, int use_backtrace)
{ return liblog_use_fd(ctx, 2, prefixfmt, use_backtrace); }

/**
 * Set up logging to the standard output
 * 
 * @param   ctx            Logging configurations and state
 * @param   prefixfmt      See `.prefixfmt` in `struct liblog_output`
 * @param   use_backtrace  Whether each log message should be prefix with a log backtrace
 * @param   least_verbose  Lower (in regard to verbosity, upper in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @param   most_verbose   Upper (in regard to verbosity, lower in regards to criticality),
 *                         inclusive bound for the range liblog log level for which log
 *                         messages should be output to the new output
 * @return                 The new output configuration (this is an object
 *                         owned by `ctx` and should not be deallocated,
 *                         it is returned so that changes can be made)
 *                         on success, `NULL` on failure
 */
inline struct liblog_output *
liblog_use_stderr_for_range(struct liblog_context *ctx, const char *prefixfmt, int use_backtrace,
                            enum liblog_level least_verbose, enum liblog_level most_verbose)
{ return liblog_use_fd_for_range(ctx, 2, prefixfmt, use_backtrace, least_verbose, most_verbose); }


/**
 * Write a log message with a custom log level
 * 
 * This function's behaviour is customisable
 * using its `flags` parameter
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   flags  Modifications the the function's behaviour;
 *                 may be 0 or the OR of any of the following values:
 *                 - LIBLOG_XLOG_CORK:
 *                       Mark the message as incomplete an deferred
 *                       printing until LIBLOG_XLOG_UNCORK is used
 *                 - LIBLOG_XLOG_UNCORK:
 *                       Output message printed since the first
 *                       LIBLOG_XLOG_CORK (after the last
 *                       LIBLOG_XLOG_UNCORK if any) as one complete
 *                       message
 *                 - LIBLOG_XLOG_BACKTRACE:
 *                       Output a backtrace even if the it is not
 *                       configured that backtraces should be printed
 *                       for the selected log level
 *                 - LIBLOG_XLOG_NO_BACKTRACE:
 *                       Do not output a backtrace even if the it is
 *                       configured that backtraces should be printed
 *                       for the selected log level
 *                 - LIBLOG_XLOG_NO_TEXT:
 *                       Do not output any new text (apport from potential
 *                       backtrace); allowing `fmt` to be `NULL`
 *                 However, LIBLOG_XLOG_CORK and LIBLOG_XLOG_UNCORK
 *                 cannot be combined, nor can LIBLOG_XLOG_BACKTRACE
 *                 and LIBLOG_XLOG_NO_BACKTRACE be combined
 * @param   fmt    printf(3) format string for the log message
 * @param   args   Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(4) int
liblog_vxlog(struct liblog_context *ctx, enum liblog_level level, unsigned flags, const char *fmt, va_list args);

/**
 * Write a log message with a custom log level
 * 
 * This function's behaviour is customisable
 * using its `flags` parameter
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   flags  Modifications the the function's behaviour;
 *                 may be 0 or the OR of any of the following values:
 *                 - LIBLOG_XLOG_CORK:
 *                       Mark the message as incomplete an deferred
 *                       printing until LIBLOG_XLOG_UNCORK is used
 *                 - LIBLOG_XLOG_UNCORK:
 *                       Output message printed since the first
 *                       LIBLOG_XLOG_CORK (after the last
 *                       LIBLOG_XLOG_UNCORK if any) as one complete
 *                       message
 *                 - LIBLOG_XLOG_BACKTRACE:
 *                       Output a backtrace even if the it is not
 *                       configured that backtraces should be printed
 *                       for the selected log level
 *                 - LIBLOG_XLOG_NO_BACKTRACE:
 *                       Do not output a backtrace even if the it is
 *                       configured that backtraces should be printed
 *                       for the selected log level
 *                 - LIBLOG_XLOG_NO_TEXT:
 *                       Do not output any new text (apport from potential
 *                       backtrace); allowing `fmt` to be `NULL`.
 *                 However, LIBLOG_XLOG_CORK and LIBLOG_XLOG_UNCORK
 *                 cannot be combined, nor can LIBLOG_XLOG_BACKTRACE
 *                 and LIBLOG_XLOG_NO_BACKTRACE be combined
 * @param   fmt    printf(3) format string for the log message
 * @param   ...    Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_PRINTF__(4) inline int
liblog_xlog(struct liblog_context *ctx, enum liblog_level level, unsigned flags, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vxlog, ctx, level, flags, fmt); }


/**
 * If there is an incomplete log message being constructed,
 * terminate it and print it
 * 
 * @param   ctx  Logging configurations and state
 * @return       0 on success, -1 on failure
 * 
 * @seealso  liblog_xlog
 * @seealso  liblog_dump_backtrace_cork
 * @seealso  liblog_log_cork
 * @seealso  liblog_log_no_backtrace_cork
 * @seealso  liblog_emergency_cork
 * @seealso  liblog_alert_cork
 * @seealso  liblog_critical_cork
 * @seealso  liblog_error_cork
 * @seealso  liblog_warning_cork
 * @seealso  liblog_notice_cork
 * @seealso  liblog_info_cork
 * @seealso  liblog_trace_cork
 * @seealso  liblog_debug_cork
 */
inline int
liblog_uncork(struct liblog_context *ctx)
{ return liblog_xlog(ctx, 0, LIBLOG_XLOG_NO_BACKTRACE | LIBLOG_XLOG_NO_TEXT | LIBLOG_XLOG_UNCORK, NULL); }


/**
 * Write the backtrace as a log message with a custom log level
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @return         0 on success, -1 on failure
 */
inline int
liblog_dump_backtrace(struct liblog_context *ctx, enum liblog_level level)
{ return liblog_xlog(ctx, level, LIBLOG_XLOG_BACKTRACE | LIBLOG_XLOG_NO_TEXT, NULL); }

/**
 * Write the backtrace as a log message with a custom log level
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * The backtrace will be terminated by a new line
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @return         0 on success, -1 on failure
 */
inline int
liblog_dump_backtrace_cork(struct liblog_context *ctx, enum liblog_level level)
{ return liblog_xlog(ctx, level, LIBLOG_XLOG_BACKTRACE | LIBLOG_XLOG_NO_TEXT | LIBLOG_XLOG_CORK, NULL); }


/**
 * Write a log message with a custom log level
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   args   Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(3) inline int
liblog_vlog(struct liblog_context *ctx, enum liblog_level level, const char *fmt, va_list args)
{ return liblog_xlog(ctx, level, 0, fmt, args); }

/**
 * Write a log message with a custom log level
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   ...    Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_PRINTF__(3) inline int
liblog_log(struct liblog_context *ctx, enum liblog_level level, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vlog, ctx, level, fmt); }

/**
 * Write a log message with a custom log level
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   args   Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(3) inline int
liblog_vlog_cork(struct liblog_context *ctx, enum liblog_level level, const char *fmt, va_list args)
{ return liblog_xlog(ctx, level, LIBLOG_XLOG_CORK, fmt, args); }

/**
 * Write a log message with a custom log level
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   ...    Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_PRINTF__(3) inline int
liblog_log_cork(struct liblog_context *ctx, enum liblog_level level, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vlog_cork, ctx, level, fmt); }


/**
 * Write a log message with a custom log level
 * 
 * Even if configured that backtraces should be printed for the
 * the specificed log level, no backtrace will be printed
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   args   Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(3) inline int
liblog_vlog_no_backtrace(struct liblog_context *ctx, enum liblog_level level, const char *fmt, va_list args)
{ return liblog_xlog(ctx, level, LIBLOG_XLOG_NO_BACKTRACE, fmt, args); }

/**
 * Write a log message with a custom log level
 * 
 * Even if configured that backtraces should be printed for the
 * the specificed log level, no backtrace will be printed
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   ...    Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_PRINTF__(3) inline int
liblog_log_no_backtrace(struct liblog_context *ctx, enum liblog_level level, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vlog_no_backtrace, ctx, level, fmt); }

/**
 * Write a log message with a custom log level
 * 
 * Even if configured that backtraces should be printed for the
 * the specificed log level, no backtrace will be printed
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   args   Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(3) inline int
liblog_vlog_no_backtrace_cork(struct liblog_context *ctx, enum liblog_level level, const char *fmt, va_list args)
{ return liblog_xlog(ctx, level, LIBLOG_XLOG_NO_BACKTRACE | LIBLOG_XLOG_CORK, fmt, args); }

/**
 * Write a log message with a custom log level
 * 
 * Even if configured that backtraces should be printed for the
 * the specificed log level, no backtrace will be printed
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx    Logging configurations and state
 * @param   level  The log level for the message; does not have to
 *                 be predefined in `enum liblog_level`
 * @param   fmt    printf(3) format string for the log message
 * @param   ...    Arguments for `fmt`
 * @return         0 on success, -1 on failure
 */
LIBLOG_PRINTF__(3) inline int
liblog_log_no_backtrace_cork(struct liblog_context *ctx, enum liblog_level level, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vlog_no_backtrace_cork, ctx, level, fmt); }


/* Everything from this point onwards is just for convenience */


/**
 * Write a log message with log level `LIBLOG_EMERGENCY`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vemergency(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_EMERGENCY, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_EMERGENCY`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_emergency(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vemergency, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_EMERGENCY`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vemergency_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_EMERGENCY, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_EMERGENCY`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_emergency_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vemergency_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_ALERT`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_valert(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_ALERT, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_ALERT`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_alert(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_valert, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_ALERT`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_valert_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_ALERT, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_ALERT`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_alert_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_valert_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_CRITICAL`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vcritical(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_CRITICAL, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_CRITICAL`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_critical(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vcritical, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_CRITICAL`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vcritical_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_CRITICAL, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_CRITICAL`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_critical_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vcritical_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_ERROR`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_verror(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_ERROR, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_ERROR`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_error(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_verror, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_ERROR`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_verror_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_ERROR, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_ERROR`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_error_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_verror_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_WARNING`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vwarning(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_WARNING, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_WARNING`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_warning(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vwarning, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_WARNING`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vwarning_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_WARNING, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_WARNING`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_warning_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vwarning_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_NOTICE`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vnotice(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_NOTICE, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_NOTICE`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_notice(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vnotice, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_NOTICE`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vnotice_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_NOTICE, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_NOTICE`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_notice_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vnotice_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_INFO`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vinfo(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_INFO, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_INFO`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_info(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vinfo, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_INFO`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vinfo_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_INFO, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_INFO`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_info_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vinfo_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_TRACE`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vtrace(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_TRACE, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_TRACE`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_trace(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vtrace, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_TRACE`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vtrace_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_TRACE, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_TRACE`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_trace_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vtrace_cork, ctx, fmt); }


/**
 * Write a log message with log level `LIBLOG_DEBUG`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vdebug(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog(ctx, LIBLOG_DEBUG, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_DEBUG`
 * 
 * The log message is printed immediately as one complete log message
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_debug(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vdebug, ctx, fmt); }

/**
 * Write a log message with log level `LIBLOG_DEBUG`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx   Logging configurations and state
 * @param   fmt   printf(3) format string for the log message
 * @param   args  Arguments for `fmt`
 * @return        0 on success, -1 on failure
 */
LIBLOG_VPRINTF__(2) inline int
liblog_vdebug_cork(struct liblog_context *ctx, const char *fmt, va_list args)
{ return liblog_vlog_cork(ctx, LIBLOG_DEBUG, fmt, args); }

/**
 * Write a log message with log level `LIBLOG_DEBUG`
 * 
 * The log message is treated as incomplete, and can be extended using
 * any log message writing function using the same `ctx`, and will be
 * printed once `liblog_uncork` is called using the same `ctx`
 * 
 * @param   ctx  Logging configurations and state
 * @param   fmt  printf(3) format string for the log message
 * @param   ...  Arguments for `fmt`
 * @return       0 on success, -1 on failure
 */
LIBLOG_PRINTF__(2) inline int
liblog_debug_cork(struct liblog_context *ctx, const char *fmt, ...)
{ LIBLOG_VA__(liblog_vdebug_cork, ctx, fmt); }



#if defined(__clang__)
# pragma clang diagnostic pop
#elif defined(__GNUC__)
# pragma GCC diagnostic pop
#endif

#endif