1 /* Copyright (c) 2009 The Khronos Group Inc.
2 * Portions copyright (c) 2009-2010 Nokia Corporation and/or its subsidiary(-ies)
4 * Permission is hereby granted, free of charge, to any person obtaining a
5 * copy of this software and/or associated documentation files (the
6 * "Materials"), to deal in the Materials without restriction, including
7 * without limitation the rights to use, copy, modify, merge, publish,
8 * distribute, sublicense, and/or sell copies of the Materials, and to
9 * permit persons to whom the Materials are furnished to do so, subject to
10 * the following conditions:
12 * The above copyright notice and this permission notice shall be included
13 * in all copies or substantial portions of the Materials.
15 * THE MATERIALS ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
18 * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
19 * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
20 * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
21 * MATERIALS OR THE USE OR OTHER DEALINGS IN THE MATERIALS.
39 #ifndef OWF_DEBUG_PREFIX
40 #define OWF_DEBUG_PREFIX "OWF: "
42 int xprintf(const char* aFormat, ...);
44 /* This pair of macros are a standard trick
45 * to convert the content of a macro into a string after expansion
46 * TOSTR causes the macro to be expanded, then TOSTR2 applies quotes.
47 * This is used because .MMP MACRO does not consistantly process macro value quotes.
50 #define TOSTR(x) TOSTR2(x)
53 /* Filters debug messages based on filename or function name.
54 * @param symbol the file or function name string generated by predefined macros
55 * @param symlen the length of the string (calculated at compile-time)
56 * Defining DEBUG_LOG enables all log file output. Do this in the make or .MMP file
57 * The file output can be filtered by filename or by function name:
58 * Defining DEBUG_FUNCTION=fnname will filter for all functions STARTING with the name fnname
59 * Defining DEBUG_FILE=filename will filter for all functions ending with the name filename
61 * These filters utilise the predefined macros __FILE__ and __FUNCTION__ which are defined in current standards,
62 * but may contain platform-specific features such as path names, or linkage decoration,
63 * so the filter-string may require some platform-specific tuning.
65 * Note that use of #pragma message may also be platform-specific, and is only present in order to
66 * print clues about the format of the __FILE__ and __FUNCTION__ macros.
68 int OWF_Debug_DoLog(const char* symbol,int symlen)
70 #if defined(DEBUG_LOG_FILE)
71 #pragma message ("DEBUG filter DEBUG_FILE= '" TOSTR(DEBUG_FILE) "' eg= '" __FILE__ "'")
72 if (symlen>=(sizeof(TOSTR(DEBUG_FILE))-1))
74 return strncmp( symbol+symlen-(sizeof(TOSTR(DEBUG_FILE))-1) , TOSTR(DEBUG_FILE) , sizeof(TOSTR(DEBUG_FILE))-1 )==0;
78 #elif defined(DEBUG_LOG_FUNCTION)
79 #pragma message("DEBUG filter DEBUG_FUNCTION= '" TOSTR(DEBUG_FUNCTION) "' eg= '" __FUNCTION__ "'")
80 if (symlen>=(sizeof(TOSTR(DEBUG_FILE))-1))
82 return(strncmp(TOSTR(DEBUG_FUNCTION),symbol,sizeof(TOSTR(DEBUG_FUNCTION))-1)==0);
94 void OWF_Debug_Print(const char* format, ...)
101 vsnprintf(__spager, 511, format, ap);
102 xprintf("%s %s\n", OWF_DEBUG_PREFIX, __spager);
107 void OWF_Debug_Trace(const char* fmt, ...)
114 void OWF_Debug_TraceIndent()
118 void OWF_Debug_TraceUndent()
122 void OWF_Debug_TraceEnter(const char* func)
126 OWF_Debug_Trace("ENTER %s", func);
128 OWF_Debug_TraceIndent();
131 void OWF_Debug_TraceExit(const char* func)
133 OWF_Debug_TraceUndent();
136 OWF_Debug_Trace("EXIT %s", func);