epoc32/include/liblogger.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description:
williamr@2
    15
* Name        : LibLogger.h
williamr@2
    16
* Part of     : LIBC/logger
williamr@2
    17
* Contained MRT library code tracing macros and class definition.
williamr@2
    18
* Version     : 1.0
williamr@2
    19
* All rights reserved.
williamr@2
    20
* Redistribution and use in source and binary forms, with or without
williamr@2
    21
* modification, are permitted provided that the following conditions are met:
williamr@2
    22
* Redistributions of source code must retain the above copyright notice, this
williamr@2
    23
* list of conditions and the following disclaimer.
williamr@2
    24
* Redistributions in binary form must reproduce the above copyright notice,
williamr@2
    25
* this list of conditions and the following disclaimer in the documentation
williamr@2
    26
* and/or other materials provided with the distribution.
williamr@2
    27
* Neither the name of the <ORGANIZATION> nor the names of its contributors
williamr@2
    28
* may be used to endorse or promote products derived from this software
williamr@2
    29
* without specific prior written permission.
williamr@2
    30
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
williamr@2
    31
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
williamr@2
    32
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
williamr@2
    33
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE
williamr@2
    34
* FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
williamr@2
    35
* DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
williamr@2
    36
* SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
williamr@2
    37
* CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
williamr@2
    38
* OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
williamr@2
    39
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
williamr@2
    40
*
williamr@2
    41
*/
williamr@2
    42
williamr@2
    43
williamr@2
    44
williamr@2
    45
#ifndef LIB_LOGGER_H
williamr@2
    46
#define LIB_LOGGER_H
williamr@2
    47
williamr@2
    48
//  INCLUDES
williamr@2
    49
williamr@2
    50
#include <e32def.h>
williamr@2
    51
williamr@2
    52
// DATA TYPES
williamr@2
    53
williamr@2
    54
/* Log message type (Info/Minor/Major/Critical) */
williamr@2
    55
typedef enum TLibTraceMessageType
williamr@2
    56
{
williamr@2
    57
	ELibTraceTypeInfo = 1,
williamr@2
    58
	ELibTraceTypeMinor = 2,
williamr@2
    59
	ELibTraceTypeMajor = 4,
williamr@2
    60
	ELibTraceTypeCritical = 8
williamr@2
    61
}TLibTraceMessageType;
williamr@2
    62
williamr@2
    63
// MACROS
williamr@2
    64
williamr@2
    65
// only logging for critical/major
williamr@2
    66
//#define LOG_BITS ( ELibTraceTypeCritical | ELibTraceTypeMajor | ELibTraceTypeInfo )
williamr@2
    67
#define LOG_BITS ( ELibTraceTypeCritical | ELibTraceTypeMajor )
williamr@2
    68
williamr@2
    69
/* this macro will be used for file and line no.
williamr@2
    70
 */
williamr@2
    71
#define LOG_FILE_NAME_LINE __FILE__, __LINE__
williamr@2
    72
williamr@2
    73
#ifdef __cplusplus
williamr@2
    74
extern "C" {
williamr@2
    75
#endif
williamr@2
    76
/*
williamr@2
    77
 * Message logging interface
williamr@2
    78
 */
williamr@2
    79
IMPORT_C int LibTracer(TLibTraceMessageType aLogMessageType,
williamr@2
    80
							char *aFileName,
williamr@2
    81
							int aLine,
williamr@2
    82
							char *aFormat,
williamr@2
    83
							...);
williamr@2
    84
williamr@2
    85
/*
williamr@2
    86
 * Message logging interface
williamr@2
    87
 */
williamr@2
    88
IMPORT_C int LibTracerMarkerList(TLibTraceMessageType aLogMessageType,
williamr@2
    89
							char *aFileName,
williamr@2
    90
							int aLine,
williamr@2
    91
							char *aFormat,
williamr@2
    92
							VA_LIST* aMarkerList);
williamr@2
    93
williamr@2
    94
/*
williamr@2
    95
 * dumping the message in hex format of specific length
williamr@2
    96
 */
williamr@2
    97
IMPORT_C int LibTracerPartialHexDump(TLibTraceMessageType aLogMessageType,
williamr@2
    98
                            char *aFileName,
williamr@2
    99
							int aLine,
williamr@2
   100
							char *aMessage,
williamr@2
   101
							char *aStr,
williamr@2
   102
							int aStrLen);
williamr@2
   103
williamr@2
   104
/*
williamr@2
   105
 * dumping the message in hex format
williamr@2
   106
 */
williamr@2
   107
IMPORT_C int LibTracerHexDump(TLibTraceMessageType aLogMessageType,
williamr@2
   108
                            char *aFileName,
williamr@2
   109
							int aLine,
williamr@2
   110
							char *aMessage,
williamr@2
   111
							char *aFormat,
williamr@2
   112
							...);
williamr@2
   113
williamr@2
   114
/*
williamr@2
   115
 * dumping the message in hex format
williamr@2
   116
 */
williamr@2
   117
IMPORT_C int LibTracerHexDumpMarkerList(TLibTraceMessageType aLogMessageType,
williamr@2
   118
                            char *aFileName,
williamr@2
   119
							int aLine,
williamr@2
   120
							char *aMessage,
williamr@2
   121
							char *aFormat,
williamr@2
   122
							VA_LIST* aMarkerList);
williamr@2
   123
williamr@2
   124
/*
williamr@2
   125
 * Only logs filename and line no with timestamp
williamr@2
   126
 */
williamr@2
   127
IMPORT_C int LibLineExecTracer(char *aFileName, int aLine);
williamr@2
   128
williamr@2
   129
/*
williamr@2
   130
 * Only logging/trace message without timestamp
williamr@2
   131
 */
williamr@2
   132
IMPORT_C int LibMessageTracer(TLibTraceMessageType aLogMessageType,
williamr@2
   133
							char *aFormat,
williamr@2
   134
							VA_LIST* aMarkerList);
williamr@2
   135
williamr@2
   136
/*
williamr@2
   137
 * Only logging/trace message without timestamp
williamr@2
   138
 */
williamr@2
   139
IMPORT_C int LibHexDumpMessagePartTracer(TLibTraceMessageType aLogMessageType,
williamr@2
   140
							char* aMessage,
williamr@2
   141
							char *aFormat,
williamr@2
   142
							VA_LIST* aMarkerList);
williamr@2
   143
williamr@2
   144
williamr@2
   145
#ifdef __cplusplus
williamr@2
   146
}
williamr@2
   147
#endif
williamr@2
   148
williamr@2
   149
// We are unable to compile the component using non-variadic macros from command line.
williamr@2
   150
// throwing error "badly punctuated parameter list in `#define'"
williamr@2
   151
williamr@2
   152
williamr@2
   153
#if defined(_DEBUG)
williamr@2
   154
//#pragma message("LibC Trace - ENABLE.")
williamr@2
   155
williamr@2
   156
#ifdef __cplusplus
williamr@2
   157
// C++ source code
williamr@2
   158
class CLogger
williamr@2
   159
    {
williamr@2
   160
    public:
williamr@2
   161
    CLogger(char* aFileName, int aLine) : iFileName ( aFileName ), iLine ( aLine) {}
williamr@2
   162
    inline int Tracer(TLibTraceMessageType aLogMessageType, char* aFormat, ...)
williamr@2
   163
        {
williamr@2
   164
        int len = 0;
williamr@2
   165
        if ( LOG_BITS & aLogMessageType )
williamr@2
   166
            {
williamr@2
   167
            VA_LIST marker;
williamr@2
   168
            VA_START(marker, aFormat);
williamr@2
   169
            len = LibTracerMarkerList(aLogMessageType, iFileName, iLine, aFormat, &marker);
williamr@2
   170
            VA_END(marker);
williamr@2
   171
            }
williamr@2
   172
        return len;
williamr@2
   173
        }
williamr@2
   174
    inline int Dump(TLibTraceMessageType aLogMessageType, char* aMessage, char* aFormat, ...)
williamr@2
   175
        {
williamr@2
   176
        int len = 0;
williamr@2
   177
        if ( LOG_BITS & aLogMessageType )
williamr@2
   178
            {
williamr@2
   179
            VA_LIST marker;
williamr@2
   180
            VA_START(marker, aFormat);
williamr@2
   181
            len = LibTracerHexDumpMarkerList(aLogMessageType, iFileName, iLine, aMessage, aFormat, &marker);
williamr@2
   182
            VA_END(marker);
williamr@2
   183
            }
williamr@2
   184
        return len;
williamr@2
   185
        }
williamr@2
   186
williamr@2
   187
    private:
williamr@2
   188
    char* iFileName;
williamr@2
   189
    int iLine;
williamr@2
   190
    };
williamr@2
   191
williamr@2
   192
#else // __cplusplus
williamr@2
   193
// C souce code.
williamr@2
   194
static int LibcTracer(TLibTraceMessageType aLogMessageType, char* aFormat, ...)
williamr@2
   195
    {
williamr@2
   196
    int len = 0;
williamr@2
   197
    if ( LOG_BITS & aLogMessageType )
williamr@2
   198
        {
williamr@2
   199
        VA_LIST marker;
williamr@2
   200
        VA_START(marker, aFormat);
williamr@2
   201
        len = LibMessageTracer(aLogMessageType, aFormat, &marker);
williamr@2
   202
        VA_END(marker);
williamr@2
   203
        }
williamr@2
   204
    return len;
williamr@2
   205
    }
williamr@2
   206
williamr@2
   207
static int LibHexTracer(TLibTraceMessageType aLogMessageType, char* aMessage, char* aFormat, ...)
williamr@2
   208
    {
williamr@2
   209
    int len = 0;
williamr@2
   210
    if ( LOG_BITS & aLogMessageType )
williamr@2
   211
        {
williamr@2
   212
        VA_LIST marker;
williamr@2
   213
        VA_START(marker, aFormat);
williamr@2
   214
        len = LibHexDumpMessagePartTracer(aLogMessageType, aMessage, aFormat, &marker);
williamr@2
   215
        VA_END(marker);
williamr@2
   216
        }
williamr@2
   217
    return len;
williamr@2
   218
    }
williamr@2
   219
#endif // __cplusplus
williamr@2
   220
williamr@2
   221
/*
williamr@2
   222
 * usage : LIB_TRACE(
williamr@2
   223
 *          <messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},
williamr@2
   224
 *          format,
williamr@2
   225
 *          args);
williamr@2
   226
 * Remark : Similar to printf except the first additional parameter for message type.
williamr@2
   227
 */
williamr@2
   228
williamr@2
   229
#ifdef __cplusplus
williamr@2
   230
#define LIB_TRACE CLogger(LOG_FILE_NAME_LINE).Tracer
williamr@2
   231
#else
williamr@2
   232
#define LIB_TRACE LibLineExecTracer(LOG_FILE_NAME_LINE); \
williamr@2
   233
                   LibcTracer
williamr@2
   234
#endif
williamr@2
   235
williamr@2
   236
williamr@2
   237
/*
williamr@2
   238
 * usage : LIB_TRACE_DUMP(
williamr@2
   239
 *          <messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},
williamr@2
   240
 *          message, // user wants to add any message before dump, (i.e. TCP message)
williamr@2
   241
 *          format,
williamr@2
   242
 *          args);
williamr@2
   243
 */
williamr@2
   244
williamr@2
   245
#ifdef __cplusplus
williamr@2
   246
#define LIB_TRACE_DUMP CLogger(LOG_FILE_NAME_LINE).Dump
williamr@2
   247
#else
williamr@2
   248
#define LIB_TRACE_DUMP LibLineExecTracer(LOG_FILE_NAME_LINE); \
williamr@2
   249
                    LibHexTracer
williamr@2
   250
#endif
williamr@2
   251
williamr@2
   252
williamr@2
   253
/*
williamr@2
   254
 * usage : LIB_TRACE_DUMP_LEN(
williamr@2
   255
 *          <messagetype>{ELibTraceTypeInfo|ELibTraceTypeMinor|ELibTraceTypeMajor|ELibTraceTypeCritical},
williamr@2
   256
 *          message, // user wants to add any message before dump, (i.e. TCP message)
williamr@2
   257
 *          dumpstring,
williamr@2
   258
 *          stringlength);
williamr@2
   259
 */
williamr@2
   260
williamr@2
   261
williamr@2
   262
#define LIB_TRACE_DUMP_LEN(messageType, message, dumpString, dumpStringLen) \
williamr@2
   263
    { \
williamr@2
   264
    if ( LOG_BITS & messageType ) \
williamr@2
   265
        { \
williamr@2
   266
	    LibTracerPartialHexDump(messageType, \
williamr@2
   267
	                    LOG_FILE_NAME_LINE, \
williamr@2
   268
					    message, \
williamr@2
   269
						dumpString, \
williamr@2
   270
						dumpStringLen); \
williamr@2
   271
        } \
williamr@2
   272
    }
williamr@2
   273
williamr@2
   274
#else
williamr@2
   275
// compilation message
williamr@2
   276
//#pragma message("LibC Trace - DISABLE.")
williamr@2
   277
// Release mode, nothing.
williamr@2
   278
williamr@2
   279
/* Release */
williamr@2
   280
williamr@2
   281
#ifdef __cplusplus
williamr@2
   282
inline TInt LibTracerDummy(...)
williamr@2
   283
        {
williamr@2
   284
        return 0;
williamr@2
   285
        }
williamr@2
   286
#else
williamr@2
   287
static TInt LibTracerDummy(TLibTraceMessageType aLogMessageType, ...)
williamr@2
   288
        {
williamr@2
   289
        return 0;
williamr@2
   290
        }
williamr@2
   291
#endif
williamr@2
   292
williamr@2
   293
#define LIB_TRACE        0 & LibTracerDummy
williamr@2
   294
williamr@2
   295
#define LIB_TRACE_DUMP 0 & LibTracerDummy
williamr@2
   296
williamr@2
   297
#define LIB_TRACE_DUMP_LEN 0 & LibTracerDummy
williamr@2
   298
williamr@2
   299
#endif // _DEBUG
williamr@2
   300
williamr@2
   301
williamr@2
   302
#endif //LIB_LOGGER_H
williamr@2
   303
williamr@2
   304
williamr@2
   305
// End of file