upnpdebug.h

Go to the documentation of this file.

/*******************************************************************************
 *
 * Copyright (c) 2000-2003 Intel Corporation
 * Copyright (c) 2006 Rémi Turboult <r3mi@users.sourceforge.net>
 * All rights reserved.
 *
 * 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.
 *
 ******************************************************************************/
 
#ifndef UPNP_DEBUG_H
#define UPNP_DEBUG_H

 
#include "UpnpGlobal.h" /* for UPNP_INLINE */
#include "upnpconfig.h"
 
#include <stdio.h>
 
#ifdef __cplusplus
extern "C" {
#endif


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,
        /* Always the last, please. */
        UPNP_NEVER
} Upnp_LogLevel;
 
/* UPNP_PACKET probably resulted from a confusion between module and
   level and was only used by a few messages in ssdp_device.c (they
   have been moved to INFO). Kept for compatibility, don't use for new
   messages.
*/
#define UPNP_PACKET UPNP_ERROR

#define UPNP_DEFAULT_LOG_LEVEL UPNP_ALL

UPNP_EXPORT_SPEC int UpnpInitLog(void);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
        #define UpnpInitLog UpnpInitLog_Inlined
        /* UPNP_E_SUCCESS is defined in upnp.h; provide fallback if not yet
         * included */
        #ifndef UPNP_E_SUCCESS
                #define UPNP_E_SUCCESS 0
        #endif
static UPNP_INLINE int UpnpInitLog_Inlined(void) { return UPNP_E_SUCCESS; }
#endif
UPNP_EXPORT_SPEC void UpnpSetLogLevel(
        Upnp_LogLevel log_level);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
        #define UpnpSetLogLevel UpnpSetLogLevel_Inlined
static UPNP_INLINE void UpnpSetLogLevel_Inlined(Upnp_LogLevel log_level)
{
        (void)log_level;
        return;
}
#endif

UPNP_EXPORT_SPEC void UpnpCloseLog(void);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
        #define UpnpCloseLog UpnpCloseLog_Inlined
static UPNP_INLINE void UpnpCloseLog_Inlined(void) {}
#endif

UPNP_EXPORT_SPEC void UpnpSetLogFileNames(
        const char *fileName,
        const char *Ignored);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
        #define UpnpSetLogFileNames UpnpSetLogFileNames_Inlined
static UPNP_INLINE void UpnpSetLogFileNames_Inlined(
        const char *ErrFileName, const char *ignored)
{
        (void)ErrFileName;
        (void)ignored;
        return;
}
#endif

UPNP_EXPORT_SPEC FILE *UpnpGetDebugFile(
        Upnp_LogLevel level,
        Dbg_Module module);
 
#if defined NDEBUG && !defined UPNP_DEBUG_C
        #define UpnpGetDebugFile UpnpGetDebugFile_Inlined
static UPNP_INLINE FILE *UpnpGetDebugFile_Inlined(
        Upnp_LogLevel level, Dbg_Module module)
{
        (void)level;
        (void)module;
        return NULL;
}
#endif
 
/* UpnpPrintf is an internal function removed from the public API (issue #365).
 * Library-internal callers: include upnpdebug_internal.h.
 * External callers: use UpnpGetDebugFile() to obtain the log FILE pointer. */
 
#ifdef __cplusplus
}
#endif
 
#endif /* UPNP_DEBUG_H */