upnpdebug.hpp

Go to the documentation of this file.

#ifndef COMPA_DEBUG_HPP
#define COMPA_DEBUG_HPP
/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * Copyright (c) 2006 Rémi Turboult <r3mi@users.sourceforge.net>
 * All rights reserved.
 * Copyright (C) 2022+ GPL 3 and higher by Ingo Höft, <Ingo@Hoeft-online.de>
 * Redistribution only with this Copyright remark. Last modified: 2025-06-12
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * - Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 * - Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 * - Neither name of Intel Corporation nor the names of its contributors
 * may be used to endorse or promote products derived from this software
 * without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTEL OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
 * OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 ******************************************************************************/
// Last compare with pupnp original source file on 2023-08-19, ver 1.14.17
#include <upnp.hpp> // for UPNP_E_SUCCESS
#include <stdio.h>
 
#ifdef __cplusplus
extern "C" {
#endif /* __cplusplus */
 
/* ! \name Other debugging features
 *
 * The UPnP SDK contains other features to aid in debugging.
 * @{
 */
 
typedef enum Upnp_Module {
    SSDP,
    SOAP,
    GENA,
    TPOOL,
    MSERV,
    DOM,
    API,
    HTTP
} Dbg_Module;
 
 
typedef enum Upnp_LogLevel_e {
    UPNP_CRITICAL,
    UPNP_ERROR,
    UPNP_INFO,
    UPNP_ALL
} Upnp_LogLevel;
 
#define UPNP_PACKET UPNP_ERROR
 
#define UPNP_DEFAULT_LOG_LEVEL UPNP_ALL
 
UPnPsdk_VIS int UpnpInitLog(void);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
#define UpnpInitLog UpnpInitLog_Inlined
static inline int UpnpInitLog_Inlined(void) { return UPNP_E_SUCCESS; }
#endif
UPnPsdk_VIS void UpnpSetLogLevel(
    Upnp_LogLevel log_level);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
#define UpnpSetLogLevel UpnpSetLogLevel_Inlined
static inline void UpnpSetLogLevel_Inlined(Upnp_LogLevel log_level) {
    (void)log_level;
    return;
}
#endif
 
UPnPsdk_VIS void UpnpCloseLog(void);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
#define UpnpCloseLog UpnpCloseLog_Inlined
static inline void UpnpCloseLog_Inlined(void) {}
#endif
 
UPnPsdk_VIS void UpnpSetLogFileNames(
    const char* fileName,
    const char* Ignored);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
#define UpnpSetLogFileNames UpnpSetLogFileNames_Inlined
static inline void UpnpSetLogFileNames_Inlined(const char* ErrFileName,
                                               const char* ignored) {
    (void)ErrFileName;
    (void)ignored;
    return;
}
#endif
 
UPnPsdk_VIS FILE* UpnpGetDebugFile(
    Upnp_LogLevel DLevel,
    Dbg_Module Module);
 
#if (defined NDEBUG && !defined UPNP_DEBUG_C)
#define UpnpGetDebugFile UpnpGetDebugFile_Inlined
static inline FILE* UpnpGetDebugFile_Inlined(Upnp_LogLevel level,
                                             Dbg_Module module) {
    (void)level, (void)module;
    return NULL;
}
#endif
 
UPnPsdk_VIS void UpnpPrintf(
    Upnp_LogLevel DLevel,
    Dbg_Module Module,
    const char* DbgFileName,
    int DbgLineNo,
    const char* FmtStr,
    ...)
#if (__GNUC__ >= 3)
    /* This enables printf like format checking by the compiler. */
    __attribute__((format(__printf__, 5, 6)))
#endif
    ;
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
#define UpnpPrintf UpnpPrintf_Inlined
// static inline void UpnpPrintf_Inlined(Upnp_LogLevel DLevel,
//      Dbg_Module Module,
//      const char *DbgFileName,
//      int DbgLineNo,
//      const char *FmtStr,
//      ...)
// #if (__GNUC__ >= 3)
//      /* This enables printf like format checking by the compiler. */
//      __attribute__((format(__printf__, 5, 6)))
// #endif
//      ;
static inline void UpnpPrintf_Inlined(Upnp_LogLevel DLevel, Dbg_Module Module,
                                      const char* DbgFileName, int DbgLineNo,
                                      const char* FmtStr, ...) {
    (void)DLevel;
    (void)Module;
    (void)DbgFileName;
    (void)DbgLineNo;
    (void)FmtStr;
    return;
}
#endif /* DEBUG */
 
#ifdef __cplusplus
}
#endif /* __cplusplus */
 
#endif // COMPA_DEBUG_HPP