File: ol_debug.h

package info (click to toggle)
osdlyrics 0.5.5~rc2%2Bdfsg1-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 2,608 kB
  • sloc: ansic: 19,115; python: 4,837; sh: 563; makefile: 354; sed: 16
file content (77 lines) | stat: -rw-r--r-- 3,267 bytes parent folder | download | duplicates (3)
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
/* -*- mode: C; c-basic-offset: 2; indent-tabs-mode: nil; -*- */
/*
 * Copyright (C) 2009-2011  Tiger Soldier <tigersoldier@gmail.com>
 *
 * This file is part of OSD Lyrics.
 * 
 * OSD Lyrics 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 3 of the License, or
 * (at your option) any later version.
 *
 * OSD Lyrics 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 OSD Lyrics.  If not, see <https://www.gnu.org/licenses/>. 
 */
#ifndef _OL_DEBUG_H_
#define _OL_DEBUG_H_

#include <stdio.h>

enum OlDebugLevel {
  OL_LOG_NONE = -1,
  OL_ERROR = 0,
  OL_DEBUG = 1,
  OL_INFO = 2,
  OL_N_LEVELS,
};

#define ol_logf(level, ...)           do {ol_log_printf (level,        \
                                                         __FILE__,     \
                                                         __LINE__,     \
                                                         __FUNCTION__, \
                                                         __VA_ARGS__); } while (0)
#define ol_log_func()                 do {ol_logf (OL_INFO, "%s\n", __FUNCTION__); } while (0)
#define ol_debugf(...)                do {ol_logf (OL_DEBUG, __VA_ARGS__); } while (0)
#define ol_debug(...)                 do {ol_logf (OL_DEBUG, "%s\n", __VA_ARGS__); } while (0)
#define ol_errorf(...)                do {ol_logf (OL_ERROR, __VA_ARGS__); } while (0)
#define ol_error(...)                 do {ol_logf (OL_ERROR, "%s\n", __VA_ARGS__); } while (0)
#define ol_infof(...)                 do {ol_logf (OL_INFO, __VA_ARGS__); } while (0)
#define ol_info(...)                  do {ol_logf (OL_INFO, "%s\n", __VA_ARGS__); } while (0)
#define ol_assert(assertion)          do {if (!(assertion)) {      \
      ol_logf (OL_ERROR, "assert %s failed\n", #assertion);        \
      return;                                                      \
    }} while (0)
#define ol_assert_ret(assertion, ret) do {if (!(assertion)) {   \
      ol_logf (OL_ERROR, "assert %s failed\n", #assertion);     \
      return (ret);                                             \
    }} while (0)

void ol_log_printf (int level, const char *file, int line, const char *funcname,
                    const char *fmt, ...);

/** 
 * @brief Sets the message level to be logged
 *
 * @param level The level of message to be logged. There are 4 levels:<br />
 *                OL_LOG_NONE: Log nothing
 *                OL_ERROR: Log only messages with OL_ERROR
 *                OL_DEBUG: Log messages with OL_ERROR and OL_DEBUG
 *                OL_INFO: Log all messages
 */
void ol_log_set_level (enum OlDebugLevel level);

/** 
 * @brief Sets the file to store log messages.
 * 
 * @param logfile The filename of the log file. if logfile is "-", it represents
 *                standard output
 * @return Return 1 if succeeded, or 0 if failed.
 */
int ol_log_set_file (const char *logfile);

#endif /* _OL_DEBUG_H_ */