daemon_logger.h (5639B)
1 /* SPDX-License-Identifier: LGPL-2.1-or-later OR (GPL-2.0-or-later WITH eCos-exception-2.0) */ 2 /* 3 This file is part of GNU libmicrohttpd. 4 Copyright (C) 2024 Evgeny Grin (Karlson2k) 5 6 GNU libmicrohttpd is free software; you can redistribute it and/or 7 modify it under the terms of the GNU Lesser General Public 8 License as published by the Free Software Foundation; either 9 version 2.1 of the License, or (at your option) any later version. 10 11 GNU libmicrohttpd is distributed in the hope that it will be useful, 12 but WITHOUT ANY WARRANTY; without even the implied warranty of 13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 14 Lesser General Public License for more details. 15 16 Alternatively, you can redistribute GNU libmicrohttpd and/or 17 modify it under the terms of the GNU General Public License as 18 published by the Free Software Foundation; either version 2 of 19 the License, or (at your option) any later version, together 20 with the eCos exception, as follows: 21 22 As a special exception, if other files instantiate templates or 23 use macros or inline functions from this file, or you compile this 24 file and link it with other works to produce a work based on this 25 file, this file does not by itself cause the resulting work to be 26 covered by the GNU General Public License. However the source code 27 for this file must still be made available in accordance with 28 section (3) of the GNU General Public License v2. 29 30 This exception does not invalidate any other reasons why a work 31 based on this file might be covered by the GNU General Public 32 License. 33 34 You should have received copies of the GNU Lesser General Public 35 License and the GNU General Public License along with this library; 36 if not, see <https://www.gnu.org/licenses/>. 37 */ 38 39 /** 40 * @file src/mhd2/daemon_logger.h 41 * @brief The declaration of the logger function and relevant macros 42 * @author Karlson2k (Evgeny Grin) 43 */ 44 45 #ifndef MHD_DAEMON_LOGGER_H 46 #define MHD_DAEMON_LOGGER_H 1 47 48 #include "mhd_sys_options.h" 49 50 #ifdef MHD_SUPPORT_LOG_FUNCTIONALITY 51 52 #include "mhd_public_api.h" /* For enum MHD_StatusCode */ 53 54 struct MHD_Daemon; /* Forward declaration */ 55 56 /* Do not use this function directly, use wrapper macros below */ 57 /** 58 * The daemon logger function. 59 * @param daemon the daemon handle 60 * @param sc the status code of the event 61 * @param fm the format string ('printf()'-style) 62 * @ingroup logging 63 */ 64 MHD_INTERNAL void 65 mhd_logger (struct MHD_Daemon *daemon, 66 enum MHD_StatusCode sc, 67 const char *fm, 68 ...); 69 70 /** 71 * Log a single fixed message. 72 * 73 * The @a msg is a 'printf()' string, treated as format specifiers string. 74 * Any '%' symbols should be doubled ('%%') to avoid interpretation as a format 75 * specifier symbol. 76 * 77 * Note: no printf() parameters allowed (except the format string). To log 78 * message with variable parameters, use #mhd_LOG_PRINT with #mhd_LOG_FMT. 79 */ 80 #define mhd_LOG_MSG(daemon,sc,msg) mhd_logger (daemon,sc,msg) 81 82 /** 83 * Define a message that will be used for logging. 84 * This macro must be used for all log messages defined outside #mhd_LOG_MSG() 85 * macro. For example, when defining a message that passed as a pointer 86 * to the logging function. 87 */ 88 #define mhd_MSG4LOG(msg) msg 89 90 /** 91 * Format message and log it. 92 * 93 * Always use with #mhd_LOG_FMT() for the format string. 94 * 95 * Example: mhd_LOG_PRINT(daemon, MHD_SC_VALUE, mhd_LOG_FMT("Number: %d"), i); 96 */ 97 #define mhd_LOG_PRINT mhd_logger 98 99 /** 100 * The wrapper macro for the format string to be used for format parameter for 101 * the #mhd_LOG_FMT() macro 102 */ 103 #define mhd_LOG_FMT(format_string) format_string 104 105 #else /* ! MHD_SUPPORT_LOG_FUNCTIONALITY */ 106 107 108 #ifdef HAVE_MACRO_VARIADIC 109 110 /** 111 * Log a single fixed message. 112 * 113 * The @a msg is a 'printf()' string, treated as format specifiers string. 114 * Any '%' symbols should be doubled ('%%') to avoid interpretation as a format 115 * specifier symbol. 116 * 117 * Note: no printf() parameters allowed (except the format string). To log 118 * message with variable parameters, use #mhd_LOG_PRINT with #mhd_LOG_FMT. 119 */ 120 #define mhd_LOG_MSG(daemon,sc,msg) do { (void) daemon; } while (0) 121 122 /** 123 * Format message and log it. 124 * 125 * Always use with #mhd_LOG_FMT() for the format string. 126 * 127 * Example: mhd_LOG_PRINT(daemon, MHD_SC_VALUE, mhd_LOG_FMT("Number: %d"), i); 128 */ 129 #define mhd_LOG_PRINT(daemon,sc,fm,...) do { (void) daemon; } while (0) 130 131 #else /* ! HAVE_MACRO_VARIADIC */ 132 133 #include "sys_base_types.h" /* For NULL */ 134 135 /** 136 * Format message and log it 137 * 138 * Always use with #mhd_LOG_FMT() for the format string. 139 */ 140 mhd_static_inline void 141 mhd_LOG_PRINT (struct MHD_Daemon *daemon, 142 enum MHD_StatusCode sc, 143 const char *fm, 144 ...) 145 { 146 (void) daemon; (void) sc; (void) fm; 147 } 148 149 150 /** 151 * Log a single message. 152 * 153 * The @a msg is a 'printf()' string, treated as format specifiers string. 154 * Any '%' symbols should be doubled ('%%') to avoid interpretation as a format 155 * specifier symbol. 156 */ 157 #define mhd_LOG_MSG(daemon,sc,msg) mhd_LOG_PRINT (daemon,sc,NULL) 158 159 #endif /* ! HAVE_MACRO_VARIADIC */ 160 161 /** 162 * Define a message that will be used for logging. 163 * This macro must be used for all log messages defined outside #mhd_LOG_MSG() 164 * macro. For example, when defining a message that passed as a pointer 165 * to the logging function. 166 */ 167 #define mhd_MSG4LOG(msg) NULL 168 169 /** 170 * The wrapper macro for the format string to be used for format parameter for 171 * the #mhd_LOG_FMT() macro 172 */ 173 #define mhd_LOG_FMT(format_string) NULL 174 175 #endif /* ! MHD_SUPPORT_LOG_FUNCTIONALITY */ 176 177 #endif /* ! MHD_DAEMON_LOGGER_H */