williamr@2: /* williamr@2: * Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: * All rights reserved. williamr@2: * This component and the accompanying materials are made available williamr@2: * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members williamr@2: * which accompanies this distribution, and is available williamr@2: * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: * williamr@2: * Initial Contributors: williamr@2: * Nokia Corporation - initial contribution. williamr@2: * williamr@2: * Contributors: williamr@2: * williamr@2: * Description: williamr@2: * Name : LibLogger.h williamr@2: * Part of : LIBC/logger williamr@2: * Contained MRT library code tracing macros and class definition. williamr@2: * Version : 1.0 williamr@2: * All rights reserved. williamr@2: * Redistribution and use in source and binary forms, with or without williamr@2: * modification, are permitted provided that the following conditions are met: williamr@2: * Redistributions of source code must retain the above copyright notice, this williamr@2: * list of conditions and the following disclaimer. williamr@2: * Redistributions in binary form must reproduce the above copyright notice, williamr@2: * this list of conditions and the following disclaimer in the documentation williamr@2: * and/or other materials provided with the distribution. williamr@2: * Neither the name of the nor the names of its contributors williamr@2: * may be used to endorse or promote products derived from this software williamr@2: * without specific prior written permission. williamr@2: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" williamr@2: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE williamr@2: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE williamr@2: * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE williamr@2: * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL williamr@2: * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR williamr@2: * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER williamr@2: * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, williamr@2: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE williamr@2: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. williamr@2: * williamr@2: */ williamr@2: williamr@2: williamr@2: williamr@2: #ifndef LIB_LOGGER_H williamr@2: #define LIB_LOGGER_H williamr@2: williamr@2: // INCLUDES williamr@2: williamr@2: #include williamr@2: williamr@2: // DATA TYPES williamr@2: williamr@2: /* Log message type (Info/Minor/Major/Critical) */ williamr@2: typedef enum TLibTraceMessageType williamr@2: { williamr@2: ELibTraceTypeInfo = 1, williamr@2: ELibTraceTypeMinor = 2, williamr@2: ELibTraceTypeMajor = 4, williamr@2: ELibTraceTypeCritical = 8 williamr@2: }TLibTraceMessageType; williamr@2: williamr@2: // MACROS williamr@2: williamr@2: // only logging for critical/major williamr@2: //#define LOG_BITS ( ELibTraceTypeCritical | ELibTraceTypeMajor | ELibTraceTypeInfo ) williamr@2: #define LOG_BITS ( ELibTraceTypeCritical | ELibTraceTypeMajor ) williamr@2: williamr@2: /* this macro will be used for file and line no. williamr@2: */ williamr@2: #define LOG_FILE_NAME_LINE __FILE__, __LINE__ williamr@2: williamr@2: #ifdef __cplusplus williamr@2: extern "C" { williamr@2: #endif williamr@2: /* williamr@2: * Message logging interface williamr@2: */ williamr@2: IMPORT_C int LibTracer(TLibTraceMessageType aLogMessageType, williamr@2: char *aFileName, williamr@2: int aLine, williamr@2: char *aFormat, williamr@2: ...); williamr@2: williamr@2: /* williamr@2: * Message logging interface williamr@2: */ williamr@2: IMPORT_C int LibTracerMarkerList(TLibTraceMessageType aLogMessageType, williamr@2: char *aFileName, williamr@2: int aLine, williamr@2: char *aFormat, williamr@2: VA_LIST* aMarkerList); williamr@2: williamr@2: /* williamr@2: * dumping the message in hex format of specific length williamr@2: */ williamr@2: IMPORT_C int LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType, williamr@2: char *aFileName, williamr@2: int aLine, williamr@2: char *aMessage, williamr@2: char *aStr, williamr@2: int aStrLen); williamr@2: williamr@2: /* williamr@2: * dumping the message in hex format williamr@2: */ williamr@2: IMPORT_C int LibTracerHexDump(TLibTraceMessageType aLogMessageType, williamr@2: char *aFileName, williamr@2: int aLine, williamr@2: char *aMessage, williamr@2: char *aFormat, williamr@2: ...); williamr@2: williamr@2: /* williamr@2: * dumping the message in hex format williamr@2: */ williamr@2: IMPORT_C int LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType, williamr@2: char *aFileName, williamr@2: int aLine, williamr@2: char *aMessage, williamr@2: char *aFormat, williamr@2: VA_LIST* aMarkerList); williamr@2: williamr@2: /* williamr@2: * Only logs filename and line no with timestamp williamr@2: */ williamr@2: IMPORT_C int LibLineExecTracer(char *aFileName, int aLine); williamr@2: williamr@2: /* williamr@2: * Only logging/trace message without timestamp williamr@2: */ williamr@2: IMPORT_C int LibMessageTracer(TLibTraceMessageType aLogMessageType, williamr@2: char *aFormat, williamr@2: VA_LIST* aMarkerList); williamr@2: williamr@2: /* williamr@2: * Only logging/trace message without timestamp williamr@2: */ williamr@2: IMPORT_C int LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType, williamr@2: char* aMessage, williamr@2: char *aFormat, williamr@2: VA_LIST* aMarkerList); williamr@2: williamr@2: williamr@2: #ifdef __cplusplus williamr@2: } williamr@2: #endif williamr@2: williamr@2: // We are unable to compile the component using non-variadic macros from command line. williamr@2: // throwing error "badly punctuated parameter list in `#define'" williamr@2: williamr@2: williamr@2: #if defined(_DEBUG) williamr@2: //#pragma message("LibC Trace - ENABLE.") williamr@2: williamr@2: #ifdef __cplusplus williamr@2: // C++ source code williamr@2: class CLogger williamr@2: { williamr@2: public: williamr@2: CLogger(char* aFileName, int aLine) : iFileName ( aFileName ), iLine ( aLine) {} williamr@2: inline int Tracer(TLibTraceMessageType aLogMessageType, char* aFormat, ...) williamr@2: { williamr@2: int len = 0; williamr@2: if ( LOG_BITS & aLogMessageType ) williamr@2: { williamr@2: VA_LIST marker; williamr@2: VA_START(marker, aFormat); williamr@2: len = LibTracerMarkerList(aLogMessageType, iFileName, iLine, aFormat, &marker); williamr@2: VA_END(marker); williamr@2: } williamr@2: return len; williamr@2: } williamr@2: inline int Dump(TLibTraceMessageType aLogMessageType, char* aMessage, char* aFormat, ...) williamr@2: { williamr@2: int len = 0; williamr@2: if ( LOG_BITS & aLogMessageType ) williamr@2: { williamr@2: VA_LIST marker; williamr@2: VA_START(marker, aFormat); williamr@2: len = LibTracerHexDumpMarkerList(aLogMessageType, iFileName, iLine, aMessage, aFormat, &marker); williamr@2: VA_END(marker); williamr@2: } williamr@2: return len; williamr@2: } williamr@2: williamr@2: private: williamr@2: char* iFileName; williamr@2: int iLine; williamr@2: }; williamr@2: williamr@2: #else // __cplusplus williamr@2: // C souce code. williamr@2: static int LibcTracer(TLibTraceMessageType aLogMessageType, char* aFormat, ...) williamr@2: { williamr@2: int len = 0; williamr@2: if ( LOG_BITS & aLogMessageType ) williamr@2: { williamr@2: VA_LIST marker; williamr@2: VA_START(marker, aFormat); williamr@2: len = LibMessageTracer(aLogMessageType, aFormat, &marker); williamr@2: VA_END(marker); williamr@2: } williamr@2: return len; williamr@2: } williamr@2: williamr@2: static int LibHexTracer(TLibTraceMessageType aLogMessageType, char* aMessage, char* aFormat, ...) williamr@2: { williamr@2: int len = 0; williamr@2: if ( LOG_BITS & aLogMessageType ) williamr@2: { williamr@2: VA_LIST marker; williamr@2: VA_START(marker, aFormat); williamr@2: len = LibHexDumpMessagePartTracer(aLogMessageType, aMessage, aFormat, &marker); williamr@2: VA_END(marker); williamr@2: } williamr@2: return len; williamr@2: } williamr@2: #endif // __cplusplus williamr@2: williamr@2: /* williamr@2: * usage : LIB_TRACE( williamr@2: * {ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical}, williamr@2: * format, williamr@2: * args); williamr@2: * Remark : Similar to printf except the first additional parameter for message type. williamr@2: */ williamr@2: williamr@2: #ifdef __cplusplus williamr@2: #define LIB_TRACE CLogger(LOG_FILE_NAME_LINE).Tracer williamr@2: #else williamr@2: #define LIB_TRACE LibLineExecTracer(LOG_FILE_NAME_LINE); \ williamr@2: LibcTracer williamr@2: #endif williamr@2: williamr@2: williamr@2: /* williamr@2: * usage : LIB_TRACE_DUMP( williamr@2: * {ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical}, williamr@2: * message, // user wants to add any message before dump, (i.e. TCP message) williamr@2: * format, williamr@2: * args); williamr@2: */ williamr@2: williamr@2: #ifdef __cplusplus williamr@2: #define LIB_TRACE_DUMP CLogger(LOG_FILE_NAME_LINE).Dump williamr@2: #else williamr@2: #define LIB_TRACE_DUMP LibLineExecTracer(LOG_FILE_NAME_LINE); \ williamr@2: LibHexTracer williamr@2: #endif williamr@2: williamr@2: williamr@2: /* williamr@2: * usage : LIB_TRACE_DUMP_LEN( williamr@2: * {ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical}, williamr@2: * message, // user wants to add any message before dump, (i.e. TCP message) williamr@2: * dumpstring, williamr@2: * stringlength); williamr@2: */ williamr@2: williamr@2: williamr@2: #define LIB_TRACE_DUMP_LEN(messageType, message, dumpString, dumpStringLen) \ williamr@2: { \ williamr@2: if ( LOG_BITS & messageType ) \ williamr@2: { \ williamr@2: LibTracerPartialHexDump(messageType, \ williamr@2: LOG_FILE_NAME_LINE, \ williamr@2: message, \ williamr@2: dumpString, \ williamr@2: dumpStringLen); \ williamr@2: } \ williamr@2: } williamr@2: williamr@2: #else williamr@2: // compilation message williamr@2: //#pragma message("LibC Trace - DISABLE.") williamr@2: // Release mode, nothing. williamr@2: williamr@2: /* Release */ williamr@2: williamr@2: #ifdef __cplusplus williamr@2: inline TInt LibTracerDummy(...) williamr@2: { williamr@2: return 0; williamr@2: } williamr@2: #else williamr@2: static TInt LibTracerDummy(TLibTraceMessageType aLogMessageType, ...) williamr@2: { williamr@2: return 0; williamr@2: } williamr@2: #endif williamr@2: williamr@2: #define LIB_TRACE 0 & LibTracerDummy williamr@2: williamr@2: #define LIB_TRACE_DUMP 0 & LibTracerDummy williamr@2: williamr@2: #define LIB_TRACE_DUMP_LEN 0 & LibTracerDummy williamr@2: williamr@2: #endif // _DEBUG williamr@2: williamr@2: williamr@2: #endif //LIB_LOGGER_H williamr@2: williamr@2: williamr@2: // End of file