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
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
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
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
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 UPNP_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 UPNP_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
#endif /* UPNP_DEBUG_H */
UpnpGlobal.h
Defines constants that for some reason are not defined on some systems.
UPNP_EXPORT_SPEC
#define UPNP_EXPORT_SPEC
Export functions on WIN32 DLLs.
Definition UpnpGlobal.h:105
UPNP_INLINE
#define UPNP_INLINE
Declares an inline function.
Definition UpnpGlobal.h:119
UPNP_E_SUCCESS
#define UPNP_E_SUCCESS
The operation completed successfully.
Definition upnp.h:97
UpnpSetLogLevel
void UpnpSetLogLevel(Upnp_LogLevel log_level)
Set the log level (see Upnp_LogLevel).
Definition upnpdebug.c:114
UpnpGetDebugFile
FILE * UpnpGetDebugFile(Upnp_LogLevel level, Dbg_Module module)
Check if the module is turned on for debug and returns the file descriptor corresponding to the debug...
Definition upnpdebug.c:295
UpnpSetLogFileNames
void UpnpSetLogFileNames(const char *fileName, const char *Ignored)
Set the name for the log file. There used to be 2 separate files. The second parameter has been kept ...
Definition upnpdebug.c:141
UpnpCloseLog
void UpnpCloseLog(void)
Closes the log files.
Definition upnpdebug.c:120
UpnpInitLog
int UpnpInitLog(void)
Initialize the log files.
Definition upnpdebug.c:71
UpnpPrintf
void UpnpPrintf(Upnp_LogLevel DLevel, Dbg_Module Module, const char *DbgFileName, int DbgLineNo, const char *FmtStr,...)
Prints the debug statement either on the standard output or log file along with the information from ...
Definition upnpdebug.c:259