annotate libsci/log.h @ 35:084dee2bef50

man: updates
author David Demelier <markand@malikania.fr>
date Thu, 04 Aug 2022 18:01:29 +0200
parents 1d0ddf9e6efd
children 71cd8447e3a4
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
18
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
1 /*
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
2 * log.h -- logging routines
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
3 *
32
081e1c258e64 misc: update copyright years
David Demelier <markand@malikania.fr>
parents: 18
diff changeset
4 * Copyright (c) 2020-2022 David Demelier <markand@malikania.fr>
18
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
5 *
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
6 * Permission to use, copy, modify, and/or distribute this software for any
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
7 * purpose with or without fee is hereby granted, provided that the above
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
8 * copyright notice and this permission notice appear in all copies.
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
9 *
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
10 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
11 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
12 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
13 * ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
14 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
15 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
16 * OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
17 */
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
18
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
19 #ifndef SCI_LOG_H
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
20 #define SCI_LOG_H
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
21
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
22 #include <stdarg.h>
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
23 #include <stdlib.h>
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
24
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
25 enum log_level {
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
26 LOG_LEVEL_WARNING = 1,
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
27 LOG_LEVEL_INFO,
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
28 LOG_LEVEL_DEBUG
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
29 };
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
30
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
31 #define log_debug(...) log_write(LOG_LEVEL_DEBUG, __VA_ARGS__)
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
32 #define log_warn(...) log_write(LOG_LEVEL_WARNING, __VA_ARGS__)
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
33 #define log_info(...) log_write(LOG_LEVEL_INFO, __VA_ARGS__)
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
34 #define log_die(...) do { \
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
35 log_write(LOG_LEVEL_WARNING, __VA_ARGS__); \
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
36 exit(1); \
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
37 } while (0)
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
38
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
39 void
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
40 log_open(const char *);
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
41
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
42 void
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
43 log_write(enum log_level, const char *, ...);
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
44
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
45 void
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
46 log_vwrite(enum log_level, const char *, va_list);
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
47
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
48 void
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
49 log_finish(void);
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
50
600204c31bf0 misc: refactor
David Demelier <markand@malikania.fr>
parents:
diff changeset
51 #endif /* !SCI_LOG_H */