omads/omadsextensions/adapters/mms/inc/logger.h
author hgs
Tue, 13 Jul 2010 03:39:25 +0530
changeset 40 b63e67867dcd
permissions -rw-r--r--
201025
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
40
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies). 
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description:  Logging macros used by DS plug-in adapters
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef __LOGGER_H__
hgs
parents:
diff changeset
    20
#define __LOGGER_H__
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#ifdef _DEBUG
hgs
parents:
diff changeset
    23
    
hgs
parents:
diff changeset
    24
    // Define this to enable file logging
hgs
parents:
diff changeset
    25
    #define __FLOGGING__
hgs
parents:
diff changeset
    26
    
hgs
parents:
diff changeset
    27
    #include <f32file.h>
hgs
parents:
diff changeset
    28
    #include <flogger.h>
hgs
parents:
diff changeset
    29
    #include <e32std.h>
hgs
parents:
diff changeset
    30
    #include <e32def.h>
hgs
parents:
diff changeset
    31
hgs
parents:
diff changeset
    32
    NONSHARABLE_CLASS(TOverflowTruncate16) : public TDes16Overflow
hgs
parents:
diff changeset
    33
        {
hgs
parents:
diff changeset
    34
    public:
hgs
parents:
diff changeset
    35
        void Overflow(TDes16& /*aDes*/) {}
hgs
parents:
diff changeset
    36
        };
hgs
parents:
diff changeset
    37
    
hgs
parents:
diff changeset
    38
    NONSHARABLE_CLASS(TOverflowTruncate8) : public TDes8Overflow
hgs
parents:
diff changeset
    39
        {
hgs
parents:
diff changeset
    40
    public:
hgs
parents:
diff changeset
    41
        void Overflow(TDes8& /*aDes*/) {}
hgs
parents:
diff changeset
    42
        };
hgs
parents:
diff changeset
    43
    
hgs
parents:
diff changeset
    44
    _LIT(KLogDir,"MMS");
hgs
parents:
diff changeset
    45
    _LIT(KLogFile,"MMSDataproviderLog.txt");
hgs
parents:
diff changeset
    46
    _LIT( KLogFormat, "[MMSDS] %S");
hgs
parents:
diff changeset
    47
    
hgs
parents:
diff changeset
    48
    _LIT(KTracePrefix16, "[MMSDS] ");
hgs
parents:
diff changeset
    49
    _LIT8(KTracePrefix8, "[MMSDS] ");
hgs
parents:
diff changeset
    50
    _LIT8(KFuncEntryFormat8, "%S : Begin");
hgs
parents:
diff changeset
    51
    _LIT8(KFuncExitFormat8, "%S : End");
hgs
parents:
diff changeset
    52
    _LIT8(KFuncFormat8, "><%S");
hgs
parents:
diff changeset
    53
    
hgs
parents:
diff changeset
    54
    const TInt KMaxLogLineLength = 512;
hgs
parents:
diff changeset
    55
    
hgs
parents:
diff changeset
    56
    /**
hgs
parents:
diff changeset
    57
    * Old logging macros
hgs
parents:
diff changeset
    58
    */
hgs
parents:
diff changeset
    59
    #ifdef __FLOGGING__
hgs
parents:
diff changeset
    60
        #define LOG( AAA )      RFileLogger::Write( KLogDir,KLogFile,EFileLoggingModeAppend,AAA )
hgs
parents:
diff changeset
    61
    #else
hgs
parents:
diff changeset
    62
        #define LOG( AAA )
hgs
parents:
diff changeset
    63
    #endif
hgs
parents:
diff changeset
    64
    
hgs
parents:
diff changeset
    65
    
hgs
parents:
diff changeset
    66
    // old function loggin macros
hgs
parents:
diff changeset
    67
    #define LOGGER_ENTERFN( name )      {TRACE_FUNC_ENTRY;}
hgs
parents:
diff changeset
    68
    #define LOGGER_LEAVEFN( name )      {TRACE_FUNC_EXIT;}
hgs
parents:
diff changeset
    69
    
hgs
parents:
diff changeset
    70
    #define LOGGER_WRITE( text )             {_LIT( KTemp, text ); FPrint( KTemp );}
hgs
parents:
diff changeset
    71
    #define LOGGER_WRITE_1( text,par1 )      {_LIT( KTemp, text ); FPrint( KTemp, par1 );}
hgs
parents:
diff changeset
    72
    #define LOGGER_WRITE_2( text,par1,par2 ) {_LIT( KTemp, text ); FPrint( KTemp, par1, par2 );}
hgs
parents:
diff changeset
    73
    
hgs
parents:
diff changeset
    74
    // New function logging macros
hgs
parents:
diff changeset
    75
    #define TRACE_FUNC_ENTRY {TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); FPrint(KFuncEntryFormat8, &ptr8);}
hgs
parents:
diff changeset
    76
    #define TRACE_FUNC_EXIT {TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); FPrint(KFuncExitFormat8, &ptr8);}
hgs
parents:
diff changeset
    77
    #define TRACE_FUNC {TPtrC8 ptr8((TUint8*)__PRETTY_FUNCTION__); FPrint(KFuncFormat8, &ptr8);}
hgs
parents:
diff changeset
    78
    
hgs
parents:
diff changeset
    79
    
hgs
parents:
diff changeset
    80
    // Declare the FPrint function
hgs
parents:
diff changeset
    81
    inline void FPrint( TRefByValue<const TDesC16> aFmt, ...)
hgs
parents:
diff changeset
    82
        {
hgs
parents:
diff changeset
    83
        VA_LIST list;
hgs
parents:
diff changeset
    84
        VA_START(list,aFmt);
hgs
parents:
diff changeset
    85
    #if defined ( __FLOGGING__ )
hgs
parents:
diff changeset
    86
            RFileLogger::WriteFormat( KLogDir, KLogFile, EFileLoggingModeAppend, aFmt, list );
hgs
parents:
diff changeset
    87
    #endif
hgs
parents:
diff changeset
    88
        
hgs
parents:
diff changeset
    89
        TBuf16<KMaxLogLineLength> theFinalString;
hgs
parents:
diff changeset
    90
        theFinalString.Append(KTracePrefix16);
hgs
parents:
diff changeset
    91
        TOverflowTruncate16 overflow;
hgs
parents:
diff changeset
    92
        theFinalString.AppendFormatList(aFmt,list,&overflow);
hgs
parents:
diff changeset
    93
        RDebug::Print(theFinalString);
hgs
parents:
diff changeset
    94
        }
hgs
parents:
diff changeset
    95
    
hgs
parents:
diff changeset
    96
    inline void FPrint(TRefByValue<const TDesC8> aFmt, ...)
hgs
parents:
diff changeset
    97
        {
hgs
parents:
diff changeset
    98
        VA_LIST list;
hgs
parents:
diff changeset
    99
        VA_START(list, aFmt);
hgs
parents:
diff changeset
   100
    #ifdef __FLOGGING__
hgs
parents:
diff changeset
   101
        RFileLogger::WriteFormat(KLogDir, KLogFile, EFileLoggingModeAppend, aFmt, list);
hgs
parents:
diff changeset
   102
    #endif
hgs
parents:
diff changeset
   103
        TOverflowTruncate8 overflow;
hgs
parents:
diff changeset
   104
        TBuf8<KMaxLogLineLength> buf8;
hgs
parents:
diff changeset
   105
        buf8.Append(KTracePrefix8);
hgs
parents:
diff changeset
   106
        buf8.AppendFormatList(aFmt, list, &overflow);
hgs
parents:
diff changeset
   107
        TBuf16<KMaxLogLineLength> buf16(buf8.Length());
hgs
parents:
diff changeset
   108
        buf16.Copy(buf8);
hgs
parents:
diff changeset
   109
        TRefByValue<const TDesC> tmpFmt(_L("%S"));
hgs
parents:
diff changeset
   110
        RDebug::Print(tmpFmt, &buf16);
hgs
parents:
diff changeset
   111
        }
hgs
parents:
diff changeset
   112
#else // no _DEBUG defined
hgs
parents:
diff changeset
   113
    
hgs
parents:
diff changeset
   114
    #define LOG( A )
hgs
parents:
diff changeset
   115
    
hgs
parents:
diff changeset
   116
    #define LOGGER_ENTERFN( name )
hgs
parents:
diff changeset
   117
    #define LOGGER_LEAVEFN( name )
hgs
parents:
diff changeset
   118
    #define LOGGER_WRITE( text )
hgs
parents:
diff changeset
   119
    #define LOGGER_WRITE_1( text,par1 )
hgs
parents:
diff changeset
   120
    #define LOGGER_WRITE_2( text,par1,par2 )
hgs
parents:
diff changeset
   121
    
hgs
parents:
diff changeset
   122
    #define TRACE_FUNC_ENTRY
hgs
parents:
diff changeset
   123
    #define TRACE_FUNC_EXIT 
hgs
parents:
diff changeset
   124
    #define TRACE_FUNC
hgs
parents:
diff changeset
   125
    
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
#endif // _DEBUG
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
#endif // __LOGGER_H__
hgs
parents:
diff changeset
   130