epoc32/include/ctsy/tflogger.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@4
     1
/*
williamr@4
     2
* Copyright (c) 2006-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4
     3
* All rights reserved.
williamr@4
     4
* This component and the accompanying materials are made available
williamr@4
     5
* under the terms of "Eclipse Public License v1.0"
williamr@4
     6
* which accompanies this distribution, and is available
williamr@4
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4
     8
*
williamr@4
     9
* Initial Contributors:
williamr@4
    10
* Nokia Corporation - initial contribution.
williamr@4
    11
*
williamr@4
    12
* Contributors:
williamr@4
    13
*
williamr@4
    14
* Description:
williamr@4
    15
*
williamr@4
    16
*/
williamr@4
    17
williamr@4
    18
williamr@4
    19
williamr@4
    20
#ifndef __TFLOGGER_H__
williamr@4
    21
#define __TFLOGGER_H__
williamr@4
    22
williamr@4
    23
// CONSTANTS
williamr@4
    24
#ifndef _DEBUG
williamr@4
    25
williamr@4
    26
// UREL BUILD:
williamr@4
    27
#define TF_LOGGING_METHOD  0   // No logging in UREL builds
williamr@4
    28
williamr@4
    29
#else
williamr@4
    30
williamr@4
    31
// UDEB BUILD:
williamr@4
    32
#define TF_LOGGING_METHOD  3   // 0 = No logging, 
williamr@4
    33
                               // 1 = Flogger, 
williamr@4
    34
                               // 2 = RDebug
williamr@4
    35
                               // 3 = CommsDebug
williamr@4
    36
#endif
williamr@4
    37
williamr@4
    38
williamr@4
    39
#if TF_LOGGING_METHOD > 0
williamr@4
    40
#define TF_LOGGING_ENABLED     // This is for backward compatibility
williamr@4
    41
#endif
williamr@4
    42
williamr@4
    43
// FUNCTION PROTOTYPES
williamr@4
    44
#if TF_LOGGING_METHOD == 1      // Flogger
williamr@4
    45
williamr@4
    46
#include <flogger.h>
williamr@4
    47
_LIT(KTfLogFolder,"TF");
williamr@4
    48
_LIT(KTfLogFile,"TFLOG.TXT");
williamr@4
    49
williamr@4
    50
#elif TF_LOGGING_METHOD == 2    // RDebug
williamr@4
    51
williamr@4
    52
#include <e32svr.h>
williamr@4
    53
williamr@4
    54
#elif TF_LOGGING_METHOD == 3    // CommsDebug
williamr@4
    55
williamr@4
    56
#include <comms-infras/commsdebugutility.h>
williamr@4
    57
williamr@4
    58
#endif
williamr@4
    59
williamr@4
    60
williamr@4
    61
/*
williamr@4
    62
-----------------------------------------------------------------------------
williamr@4
    63
williamr@4
    64
	LOGGING MACROs
williamr@4
    65
williamr@4
    66
	USE THESE MACROS IN YOUR CODE !
williamr@4
    67
williamr@4
    68
-----------------------------------------------------------------------------
williamr@4
    69
*/
williamr@4
    70
williamr@4
    71
#if TF_LOGGING_METHOD == 1      // Flogger
williamr@4
    72
williamr@4
    73
#define TFLOGTEXT(AAA)                RFileLogger::Write(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend, AAA)
williamr@4
    74
#define TFLOGSTRING(AAA)              /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RFileLogger::Write(KTfLogFolder(),KTfLogFile(),EFileLoggingModeAppend,tempLogDes()); } while (0)
williamr@4
    75
#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)
williamr@4
    76
#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)
williamr@4
    77
#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)
williamr@4
    78
williamr@4
    79
williamr@4
    80
#elif TF_LOGGING_METHOD == 2    // RDebug
williamr@4
    81
williamr@4
    82
#define TFLOGTEXT(AAA)                RDebug::Print(AAA)
williamr@4
    83
#define TFLOGSTRING(AAA)              /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes); } while (0)
williamr@4
    84
#define TFLOGSTRING2(AAA,BBB)         /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB); } while (0)
williamr@4
    85
#define TFLOGSTRING3(AAA,BBB,CCC)     /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB, CCC); } while (0)
williamr@4
    86
#define TFLOGSTRING4(AAA,BBB,CCC,DDD) /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); RDebug::Print(tempLogDes, BBB, CCC, DDD); } while (0)
williamr@4
    87
williamr@4
    88
williamr@4
    89
#elif TF_LOGGING_METHOD == 3    // CommsDebug
williamr@4
    90
_LIT8(KTSYSubSystem, "tsy");
williamr@4
    91
#ifdef TF_SAT_LOGGING
williamr@4
    92
_LIT8(KTSYCompnt, "sattsy");
williamr@4
    93
#else
williamr@4
    94
_LIT8(KTSYCompnt, "ctsy");
williamr@4
    95
#endif
williamr@4
    96
williamr@4
    97
#define TFLOGTEXT(AAA)                __FLOG_STATIC0(KTSYSubSystem,KTrpCompnt,(AAA))
williamr@4
    98
#define TFLOGSTRING(AAA)              /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); __FLOG_STATIC0(KTSYSubSystem,KTSYCompnt, tempLogDes); } while (0)
williamr@4
    99
#define TFLOGSTRING2(AAA,BBB)         /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); __FLOG_STATIC1(KTSYSubSystem,KTSYCompnt, tempLogDes, BBB); } while (0)
williamr@4
   100
#define TFLOGSTRING3(AAA,BBB,CCC)     /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); __FLOG_STATIC2(KTSYSubSystem,KTSYCompnt, tempLogDes, BBB, CCC); } while (0)
williamr@4
   101
#define TFLOGSTRING4(AAA,BBB,CCC,DDD) /*lint --e{717}, --e{1534} */ do { _LIT(tempLogDes,AAA); __FLOG_STATIC3(KTSYSubSystem,KTSYCompnt, tempLogDes, BBB, CCC, DDD); } while (0)
williamr@4
   102
williamr@4
   103
#else	// TF_LOGGING_METHOD == 0 or invalid
williamr@4
   104
williamr@4
   105
#define TFLOGTEXT(AAA)                // Example: TFLOGTEXT(own_desc);
williamr@4
   106
#define TFLOGSTRING(AAA)              // Example: TFLOGSTRING("Test");
williamr@4
   107
#define TFLOGSTRING2(AAA,BBB)         // Example: TFLOGSTRING("Test %i", aValue);
williamr@4
   108
#define TFLOGSTRING3(AAA,BBB,CCC)     // Example: TFLOGSTRING("Test %i %i", aValue1, aValue2);
williamr@4
   109
#define TFLOGSTRING4(AAA,BBB,CCC,DDD) // Example: TFLOGSTRING("Test %i %i %i", aValue1, aValue2, aValue3);
williamr@4
   110
williamr@4
   111
#endif  // TF_LOGGING_METHOD
williamr@4
   112
williamr@4
   113
#if TF_LOGGING_METHOD == 1 || TF_LOGGING_METHOD == 2 
williamr@4
   114
williamr@4
   115
// Note, #x and __FILE__ must be stored to char string first, making them 16bit 
williamr@4
   116
// strings with _LIT will not work in all compilers. 
williamr@4
   117
williamr@4
   118
#define TF_ASSERT(x) /*lint --e{717} */ do { if (!(x)) { const TUint8 tempX8[] = #x; \
williamr@4
   119
	TBuf<sizeof(tempX8)> tempX; \
williamr@4
   120
	tempX.Copy(TPtrC8(tempX8)); const TUint8 tempF8[] = __FILE__; TBuf<sizeof(tempF8)> tempF;\
williamr@4
   121
	tempF.Copy(TPtrC8(tempF8)); \
williamr@4
   122
    TFLOGSTRING4("TSY: ASSERT FAILED: %S, file %S, line %d", &tempX, &tempF, __LINE__ ); } } while(0) 
williamr@4
   123
        
williamr@4
   124
#define TF_ASSERT_NOT_REACHED() /*lint --e{717} */ do {  const TUint8 tempF8[] = __FILE__;\
williamr@4
   125
	 TBuf<sizeof(tempF8)> tempF; tempF.Copy(TPtrC8(tempF8));\
williamr@4
   126
	 TFLOGSTRING3("TSY: ASSERT FAILED: unreachable code, file %S, line %d", &tempF, __LINE__ ); } while (0) 
williamr@4
   127
williamr@4
   128
#else  // TF_LOGGING_METHOD == 0 or invalid
williamr@4
   129
williamr@4
   130
#define TF_ASSERT(x) 
williamr@4
   131
#define TF_ASSERT_NOT_REACHED() 
williamr@4
   132
williamr@4
   133
#endif  // TF_LOGGING_METHOD == 1 || TF_LOGGING_METHOD == 2
williamr@4
   134
williamr@4
   135
williamr@4
   136
#endif	// __TFLOGGER_H__
williamr@4
   137
williamr@4
   138
//  End of File