File: beep-log.h

package info (click to toggle)
beep 1.4.3-2
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 524 kB
  • sloc: ansic: 863; sh: 228; python: 26; makefile: 10
file content (80 lines) | stat: -rw-r--r-- 2,273 bytes parent folder | download
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
/* beep-log.h - interface to logging and message output
 * Copyright (C) 2018-2019 Hans Ulrich Niedermann
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

#ifndef BEEP_LOG_H
#define BEEP_LOG_H

/** Currently active log level.
 *
 * Default is 0. Values greater than 0 are for verbose output.
 */
extern int log_level;


/** Program name to use in log messages.
 *
 * Set this first thing in main(). Either just set it to some constant
 * string, or run log_init() to set this up from the non-path part of
 * argv[0].
 */
extern const char *progname;


/** Write a standard message */
void log_output(const char *const format, ...)
    __attribute__ ((nonnull (1)))
    __attribute__ ((format (printf, 1, 2)));


/** Log an error message */
void log_error(const char *const format, ...)
    __attribute__ ((nonnull (1)))
    __attribute__ ((format (printf, 1, 2)));


/** Log a warning message */
void log_warning(const char *const format, ...)
    __attribute__ ((nonnull (1)))
    __attribute__ ((format (printf, 1, 2)));


/** Log a verbose message */
void log_verbose(const char *const format, ...)
    __attribute__ ((nonnull (1)))
    __attribute__ ((format (printf, 1, 2)));


/** Log a range of data */
void log_data(const void *const buf, const size_t start_ofs, const size_t size)
    __attribute__ ((nonnull (1)));


/** Initialize the log message prefix from the non-path part of argv[0]. */
void log_init(const int argc, char *const argv[])
    __attribute__ ((nonnull (2)));


#endif /* BEEP_LOG_H */


/*
 * Local Variables:
 * c-basic-offset: 4
 * indent-tabs-mode: nil
 * End:
 */