xref: /freebsd/contrib/kyua/utils/logging/macros.hpp (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
1 // Copyright 2011 The Kyua Authors.
2 // All rights reserved.
3 //
4 // Redistribution and use in source and binary forms, with or without
5 // modification, are permitted provided that the following conditions are
6 // met:
7 //
8 // * Redistributions of source code must retain the above copyright
9 //   notice, this list of conditions and the following disclaimer.
10 // * Redistributions in binary form must reproduce the above copyright
11 //   notice, this list of conditions and the following disclaimer in the
12 //   documentation and/or other materials provided with the distribution.
13 // * Neither the name of Google Inc. nor the names of its contributors
14 //   may be used to endorse or promote products derived from this software
15 //   without specific prior written permission.
16 //
17 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
18 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
19 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
20 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
21 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
22 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
23 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
24 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
25 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
26 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
27 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28 
29 /// \file utils/logging/macros.hpp
30 /// Convenience macros to simplify usage of the logging library.
31 ///
32 /// This file <em>must not be included from other header files</em>.
33 
34 #if !defined(UTILS_LOGGING_MACROS_HPP)
35 #define UTILS_LOGGING_MACROS_HPP
36 
37 #include "utils/logging/operations.hpp"
38 
39 
40 /// Logs a debug message.
41 ///
42 /// \param message The message to log.
43 #define LD(message) utils::logging::log(utils::logging::level_debug, \
44                                         __FILE__, __LINE__, message)
45 
46 
47 /// Logs an error message.
48 ///
49 /// \param message The message to log.
50 #define LE(message) utils::logging::log(utils::logging::level_error, \
51                                         __FILE__, __LINE__, message)
52 
53 
54 /// Logs an informational message.
55 ///
56 /// \param message The message to log.
57 #define LI(message) utils::logging::log(utils::logging::level_info, \
58                                         __FILE__, __LINE__, message)
59 
60 
61 /// Logs a warning message.
62 ///
63 /// \param message The message to log.
64 #define LW(message) utils::logging::log(utils::logging::level_warning, \
65                                         __FILE__, __LINE__, message)
66 
67 
68 #endif  // !defined(UTILS_LOGGING_MACROS_HPP)
69