1 // Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

     2 // All rights reserved.

     3 // This component and the accompanying materials are made available

     4 // under the terms of "Eclipse Public License v1.0"

     5 // which accompanies this distribution, and is available

     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".

     7 //

     8 // Initial Contributors:

     9 // Nokia Corporation - initial contribution.

    10 //

    11 // Contributors:

    12 //

    13 

    14 #ifndef __TFLOGGER_H__

    15 #define __TFLOGGER_H__

    16 

    17 // CONSTANTS

    18 #ifndef _DEBUG

    19 

    20 // UREL BUILD:

    21 #define TF_LOGGING_METHOD  0   // No logging in UREL builds

    22 

    23 #else

    24 

    25 // UDEB BUILD:

    26 #define TF_LOGGING_METHOD  1   // 0 = No logging, 

    27                                // 1 = Flogger, 

    28                                // 2 = RDebug

    29 #endif

    30 

    31 

    32 #if TF_LOGGING_METHOD > 0

    33 #define TF_LOGGING_ENABLED     // This is for backward compatibility

    34 #endif

    35 

    36 // FUNCTION PROTOTYPES

    37 #if TF_LOGGING_METHOD == 1      // Flogger

    38 

    39 #include <flogger.h>

    40 _LIT(KTfLogFolder,"TF");

    41 _LIT(KTfLogFile,"TFLOG.TXT");

    42 

    43 #elif TF_LOGGING_METHOD == 2    // RDebug

    44 

    45 #include <e32svr.h>

    46 

    47 #endif

    48 

    49 

    50 /*

    51 -----------------------------------------------------------------------------

    52 

    53 	LOGGING MACROs

    54 

    55 	USE THESE MACROS IN YOUR CODE !

    56 

    57 -----------------------------------------------------------------------------

    58 */

    59 

    60 #if TF_LOGGING_METHOD == 1      // Flogger

    61 

    62 #define TFLOGTEXT(AAA)                RFileLogger::Write(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend, AAA)

    63 #define TFLOGSTRING(AAA)              /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RFileLogger::Write(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend,tempLogDes()); } while (0)

    64 #define TFLOGSTRING2(AAA,BBB)         /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RFileLogger::WriteFormat(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend,TRefByValue<const TDesC>(tempLogDes()),BBB); } while (0)

    65 #define TFLOGSTRING3(AAA,BBB,CCC)     /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RFileLogger::WriteFormat(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend,TRefByValue<const TDesC>(tempLogDes()),BBB,CCC); } while (0)

    66 #define TFLOGSTRING4(AAA,BBB,CCC,DDD) /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RFileLogger::WriteFormat(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend,TRefByValue<const TDesC>(tempLogDes()),BBB,CCC,DDD); } while (0)

    67 

    68 

    69 #elif TF_LOGGING_METHOD == 2    // RDebug

    70 

    71 #define TFLOGTEXT(AAA)                RDebug::Print(AAA)

    72 #define TFLOGSTRING(AAA)              /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes); } while (0)

    73 #define TFLOGSTRING2(AAA,BBB)         /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB); } while (0)

    74 #define TFLOGSTRING3(AAA,BBB,CCC)     /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB, CCC); } while (0)

    75 #define TFLOGSTRING4(AAA,BBB,CCC,DDD) /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB, CCC, DDD); } while (0)

    76 

    77 #else	// TF_LOGGING_METHOD == 0 or invalid

    78 

    79 #define TFLOGTEXT(AAA)                // Example: TFLOGTEXT(own_desc);

    80 #define TFLOGSTRING(AAA)              // Example: TFLOGSTRING("Test");

    81 #define TFLOGSTRING2(AAA,BBB)         // Example: TFLOGSTRING("Test %i", aValue);

    82 #define TFLOGSTRING3(AAA,BBB,CCC)     // Example: TFLOGSTRING("Test %i %i", aValue1, aValue2);

    83 #define TFLOGSTRING4(AAA,BBB,CCC,DDD) // Example: TFLOGSTRING("Test %i %i %i", aValue1, aValue2, aValue3);

    84 

    85 #endif  // TF_LOGGING_METHOD

    86 

    87 #if TF_LOGGING_METHOD == 1 || TF_LOGGING_METHOD == 2 

    88 

    89 // Note, #x and __FILE__ must be stored to char string first, making them 16bit 

    90 // strings with _LIT will not work in all compilers. 

    91 

    92 #define TF_ASSERT(x) /*lint --e{717} */ do { if (!(x)) { const TUint8 tempX8[] = #x; \

    93 	TBuf<sizeof(tempX8)> tempX; \

    94 	tempX.Copy(TPtrC8(tempX8)); const TUint8 tempF8[] = __FILE__; TBuf<sizeof(tempF8)> tempF;\

    95 	tempF.Copy(TPtrC8(tempF8)); \

    96     TFLOGSTRING4("TSY: ASSERT FAILED: %S, file %S, line %d", &tempX, &tempF, __LINE__ ); } } while(0) 

    97         

    98 #define TF_ASSERT_NOT_REACHED() /*lint --e{717} */ do {  const TUint8 tempF8[] = __FILE__;\

    99 	 TBuf<sizeof(tempF8)> tempF; tempF.Copy(TPtrC8(tempF8));\

   100 	 TFLOGSTRING3("TSY: ASSERT FAILED: unreachable code, file %S, line %d", &tempF, __LINE__ ); } while (0) 

   101 

   102 #else  // TF_LOGGING_METHOD == 0 or invalid

   103 

   104 #define TF_ASSERT(x) 

   105 #define TF_ASSERT_NOT_REACHED() 

   106 

   107 #endif  // TF_LOGGING_METHOD == 1 || TF_LOGGING_METHOD == 2

   108 

   109 

   110 #endif	// __TFLOGGER_H__

   111 

   112 //  End of File