searchsrv_plat/cpix_framework_api/inc/harvesterserverlogger.h
changeset 0 671dee74050a
child 23 d4d56f5e7c55
equal deleted inserted replaced
-1:000000000000 0:671dee74050a
       
     1 /*
       
     2 * Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
       
     3 * All rights reserved.
       
     4 * This component and the accompanying materials are made available
       
     5 * under the terms of "Eclipse Public License v1.0"
       
     6 * which accompanies this distribution, and is available
       
     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     8 *
       
     9 * Initial Contributors:
       
    10 * Nokia Corporation - initial contribution.
       
    11 *
       
    12 * Contributors:
       
    13 *
       
    14 * Description:  Logger headerfile for CPixSearchServer
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef HARVESTERSERVERLOGGER_H
       
    19 #define HARVESTERSERVERLOGGER_H
       
    20 
       
    21 
       
    22 /**
       
    23 *
       
    24 * LOG SELECTION
       
    25 *
       
    26 */
       
    27 #ifndef _DEBUG
       
    28     // UREL BUILD:
       
    29     // Set logmode only if not yet set in cpp-file.
       
    30     #ifndef CPIX_LOGGING_METHOD
       
    31     #define CPIX_LOGGING_METHOD  0   // No logging in UREL builds
       
    32     #endif
       
    33 #else
       
    34     // UDEB BUILD:
       
    35     #ifndef CPIX_LOGGING_METHOD
       
    36     #define CPIX_LOGGING_METHOD  1   // 0 = No logging,
       
    37     #endif                          // 1 = Flogger,
       
    38                                     // 2 = RDebug
       
    39                                     // 3 = Same as 1, but tick added
       
    40 #endif //_DEBUG
       
    41 
       
    42 
       
    43 #if CPIX_LOGGING_METHOD > 0
       
    44     #define CPIX_LOGGING_ENABLED    
       
    45 #endif //CPIX_LOGGING_METHOD
       
    46 
       
    47 
       
    48 /**
       
    49 *
       
    50 * FLOGGER SETTINGS
       
    51 *
       
    52 */
       
    53 #if CPIX_LOGGING_METHOD == 1 || CPIX_LOGGING_METHOD == 3     // Flogger
       
    54 
       
    55     #include <flogger.h>
       
    56 
       
    57     _LIT(KCPixLogFolder, "CPix\\HarvesterServer");
       
    58     _LIT(KCPixLogFile, "HarvesterServer.txt");
       
    59 
       
    60 #elif CPIX_LOGGING_METHOD == 2    // RDebug
       
    61 
       
    62     #include <e32svr.h>
       
    63 
       
    64 #endif //CPIX_LOGGING_METHOD
       
    65 
       
    66 
       
    67 /**
       
    68 *
       
    69 * LOGGING MACROs
       
    70 *
       
    71 * USE THESE MACROS IN YOUR CODE !
       
    72 *
       
    73 */
       
    74 
       
    75 #if CPIX_LOGGING_METHOD == 1      // Flogger
       
    76 #define CPIXLOGTEXT(AAA) /*lint -save -e960 */              { RFileLogger::Write(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,AAA); } /*lint -restore */
       
    77 #define CPIXLOGSTRING(AAA) /*lint -save -e960 */            { _LIT(tempLogDes,AAA); RFileLogger::Write(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,tempLogDes()); } /*lint -restore */
       
    78 #define CPIXLOGSTRING2(AAA,BBB) /*lint -save -e960 -e437 */ { _LIT(tempLogDes,AAA); RFileLogger::WriteFormat(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,TRefByValue<const TDesC>(tempLogDes()),BBB); } /*lint -restore */
       
    79 #define CPIXLOGSTRING3(AAA,BBB,CCC) /*lint -save -e960 */   { _LIT(tempLogDes,AAA); RFileLogger::WriteFormat(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,TRefByValue<const TDesC>(tempLogDes()),BBB,CCC); } /*lint -restore */
       
    80 
       
    81 #elif CPIX_LOGGING_METHOD == 2    // RDebug
       
    82 #define CPIXLOGTEXT(AAA)              RDebug::Print(AAA);
       
    83 #define CPIXLOGSTRING(AAA)            RDebug::Print(_L(AAA));
       
    84 #define CPIXLOGSTRING2(AAA,BBB)       RDebug::Print(_L(AAA),BBB);
       
    85 #define CPIXLOGSTRING3(AAA,BBB,CCC)   RDebug::Print(_L(AAA),BBB,CCC);
       
    86 
       
    87 #elif CPIX_LOGGING_METHOD == 3    // Flogger + tick
       
    88 #define CPIXLOGTEXT(AAA) /*lint -save -e960 */              { RFileLogger::Write(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,AAA); } /*lint -restore */
       
    89 #define CPIXLOGSTRING(AAA) /*lint -save -e960 */            { _LIT8(tempLogDes, "%d " ##AAA); TUint tick=User::TickCount(); RFileLogger::WriteFormat(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,tempLogDes,tick); } /*lint -restore */
       
    90 #define CPIXLOGSTRING2(AAA,BBB) /*lint -save -e960 -e437 */ { _LIT8(tempLogDes, "%d " ##AAA); TUint tick=User::TickCount(); RFileLogger::WriteFormat(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,tempLogDes,tick,BBB); } /*lint -restore */
       
    91 #define CPIXLOGSTRING3(AAA,BBB,CCC) /*lint -save -e960 */   { _LIT8(tempLogDes, "%d " ##AAA); TUint tick=User::TickCount(); RFileLogger::WriteFormat(KCPixLogFolder(),KCPixLogFile(),EFileLoggingModeAppend,tempLogDes,tick,BBB,CCC); } /*lint -restore */
       
    92 
       
    93 #else    // CPIX_LOGGING_METHOD == 0 or invalid
       
    94 
       
    95 // Example: CPIXLOGTEXT(own_desc);
       
    96 #define CPIXLOGTEXT(AAA)
       
    97     
       
    98 // Example: CPIXLOGSTRING("Test");
       
    99 #define CPIXLOGSTRING(AAA)
       
   100     
       
   101 // Example: CPIXLOGSTRING2("Test %i", aValue);
       
   102 #define CPIXLOGSTRING2(AAA,BBB)
       
   103     
       
   104 // Example: CPIXLOGSTRING3("Test %i %i", aValue1, aValue2);
       
   105 #define CPIXLOGSTRING3(AAA,BBB,CCC)
       
   106 
       
   107 #endif  // CPIX_LOGGING_METHOD
       
   108 
       
   109 #endif    // CPIXLOGGER_H
       
   110 
       
   111 // End of File