deviceupdatesui/devicemanagementnotifiersplugin/PnpUtilLogger.h
author hgs
Tue, 13 Jul 2010 03:42:03 +0530
changeset 43 88e14c3d4c4f
parent 33 7464c1e21dae
permissions -rw-r--r--
201019
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
33
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     1
/*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     2
* Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies). 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     3
* All rights reserved.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     8
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
     9
* Initial Contributors:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    11
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    12
* Contributors:
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    13
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    14
* Description: 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    15
*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    16
*/
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    17
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    18
#ifndef __LOGGER_H__
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    19
#define __LOGGER_H__
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    20
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    21
#ifdef _DEBUG
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    22
    #define LOGGING_ENABLED
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    23
#endif
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    24
#ifdef LOGGING_ENABLED          // This must be enabled to use logging system
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    25
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    26
#define LOGGER_LOGGING          // Log to Logger
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    27
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    28
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    29
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    30
#ifdef LOGGER_LOGGING
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    31
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    32
//  INCLUDES
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    33
#include <flogger.h>
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    34
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    35
// LOG SETTINGS 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    36
_LIT( KPnpLogFolder, "PnP" );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    37
_LIT( KPnpLogFile, "PnPUtil.TXT" );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    38
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    39
#endif
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    40
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    41
// CONSTANTS  
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    42
// None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    43
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    44
// MACROS
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    45
/*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    46
-----------------------------------------------------------------------------
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    47
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    48
    INTERNAL MACROs. 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    49
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    50
    DO NOT USE THESE DIRECTLY !!! 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    51
    SEE EXTERNAL MACROS
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    52
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    53
-----------------------------------------------------------------------------
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    54
*/
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    55
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    56
#ifdef LOGGER_LOGGING
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    57
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    58
_LIT( KTextFormat, "%S%S" );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    59
_LIT( KPnpUtil, "PnpUtil| " );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    60
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    61
#define INTRLOGTEXT( AAA )                                                                                        \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    62
    {                                                                                                            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    63
    RFileLogger::Write( KPnpLogFolder(), KPnpLogFile(), EFileLoggingModeAppend, AAA );            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    64
    }
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    65
#define INTRLOGSTRING( AAA )                                                                                    \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    66
    {                                                                                                            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    67
    _LIT( tempLogDes, AAA );                                                                                    \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    68
    RFileLogger::Write( KPnpLogFolder(), KPnpLogFile(), EFileLoggingModeAppend, tempLogDes() );    \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    69
    }
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    70
// 20 chars is left for the formatted item
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    71
#define INTRLOGSTRING2( AAA, BBB )                                                                                \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    72
    {                                                                                                            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    73
    _LIT( tempLogDes, AAA );                                                                                    \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    74
    RFileLogger::WriteFormat( KPnpLogFolder(), KPnpLogFile(), EFileLoggingModeAppend, TRefByValue<const TDesC>( tempLogDes()), BBB ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    75
    }
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    76
// 40 chars is left for the formatted items
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    77
#define INTRLOGSTRING3( AAA, BBB, CCC )                                                                            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    78
    {                                                                                                            \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    79
    _LIT( tempLogDes, AAA );                                                                                    \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    80
    RFileLogger::WriteFormat( KPnpLogFolder(), KPnpLogFile(), EFileLoggingModeAppend, TRefByValue<const TDesC>( tempLogDes()), BBB, CCC ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    81
    }
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    82
#else
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    83
#define INTRLOGTEXT( AAA )
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    84
#define INTRLOGSTRING( AAA )
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    85
#define INTRLOGSTRING2( AAA, BBB )
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    86
#define INTRLOGSTRING3( AAA, BBB, CCC )
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    87
#endif
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    88
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    89
/*
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    90
-----------------------------------------------------------------------------
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    91
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    92
    EXTERNAL MACROs
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    93
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    94
    USE THESE MACROS IN YOUR CODE !
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    95
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    96
-----------------------------------------------------------------------------
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    97
*/
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    98
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
    99
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   100
#define LOGTEXT( AAA )                { \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   101
                                    INTRLOGTEXT( AAA ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   102
                                    }   // Example: LOGTEXT( own_desc );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   103
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   104
#define LOGSTRING( AAA )            { \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   105
                                    INTRLOGSTRING( AAA ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   106
                                    }   // Example: LOGSTRING( "Test" );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   107
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   108
#define LOGSTRING2( AAA, BBB )        { \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   109
                                    INTRLOGSTRING2( AAA, BBB ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   110
                                    }  // Example: LOGSTRING( "Test %i", aValue );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   111
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   112
#define LOGSTRING3( AAA, BBB, CCC )    { \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   113
                                    INTRLOGSTRING3( AAA, BBB, CCC ); \
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   114
                                    } // Example: LOGSTRING( "Test %i %i", aValue1, aValue2 );
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   115
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   116
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   117
#else   // LOGGING_ENABLED
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   118
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   119
#define LOGTEXT( AAA ) 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   120
#define LOGSTRING( AAA ) 
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   121
#define LOGSTRING2( AAA, BBB )    
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   122
#define LOGSTRING3( AAA, BBB, CCC )    
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   123
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   124
#endif  // LOGGING_ENABLED
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   125
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   126
// DATA TYPES
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   127
// None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   128
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   129
// FUNCTION PROTOTYPES
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   130
// None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   131
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   132
// FORWARD DECLARATIONS
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   133
// None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   134
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   135
// CLASS DECLARATION
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   136
// None.
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   137
7464c1e21dae 201008_internal
hgs
parents:
diff changeset
   138
#endif  // __LOGGER_H__