|
1 /* |
|
2 * Copyright (c) 2006 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: Provides macros for logging |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 |
|
20 #ifndef __CSPLOGGER_H__ |
|
21 #define __CSPLOGGER_H__ |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32def.h> |
|
25 |
|
26 /* |
|
27 ----------------------------------------------------------------------------- |
|
28 |
|
29 USER LOG SELECTION |
|
30 |
|
31 ----------------------------------------------------------------------------- |
|
32 */ |
|
33 |
|
34 inline TUint CSPLOGMASK() |
|
35 { |
|
36 return 0x8fffffff; // This is default mask value. |
|
37 } // User can change mask value to get different king of logging. |
|
38 |
|
39 #ifndef _DEBUG |
|
40 |
|
41 /*************************** |
|
42 * Logging method variants: |
|
43 * 0 = No logging |
|
44 * 1 = Flogger |
|
45 * 2 = RDebug |
|
46 ***************************/ |
|
47 |
|
48 #define CSP_LOGGING_METHOD 0 // UREL BUILD |
|
49 |
|
50 #else |
|
51 |
|
52 #ifdef __WINS__ |
|
53 #define CSP_LOGGING_METHOD 2 // UDEB BUILD, WINS |
|
54 #else |
|
55 #define CSP_LOGGING_METHOD 2 // UDEB BUILD, HW |
|
56 #endif // __WINS__ |
|
57 |
|
58 #endif // _DEBUG |
|
59 |
|
60 |
|
61 // Next is for backward compatibility |
|
62 #if CSP_LOGGING_METHOD > 0 |
|
63 #define CSP_LOGGING_ENABLED |
|
64 #define TF_LOGGING_ENABLED |
|
65 #endif |
|
66 |
|
67 |
|
68 /* |
|
69 ----------------------------------------------------------------------------- |
|
70 |
|
71 LOGGING OPTIONS |
|
72 |
|
73 ----------------------------------------------------------------------------- |
|
74 */ |
|
75 |
|
76 #define CSPOBJECT 0x00000001 // Construction and destruction |
|
77 |
|
78 #define CSPERROR 0x00000002 // Error that can be handled. Describe reason for error situation. |
|
79 #define CSPPANIC 0x00000004 // Critical error: Panic. |
|
80 |
|
81 |
|
82 #define CSPREQIN 0x00000040 // Public interface methods |
|
83 #define CSPREQOUT 0x00000080 // Set outgoing request |
|
84 #define CSPREQEND 0x00000100 // Complete request |
|
85 |
|
86 #define CSPINT 0x00000200 // Internal activity |
|
87 |
|
88 #define CSPMSTATE 0x00000400 // Component state changes |
|
89 |
|
90 #define CSPGENERAL 0x00000800 // For deprecated TFLOGxxx-macros and for temporary usage |
|
91 |
|
92 |
|
93 /* |
|
94 ----------------------------------------------------------------------------- |
|
95 |
|
96 LOG SETTINGS |
|
97 |
|
98 ----------------------------------------------------------------------------- |
|
99 */ |
|
100 |
|
101 #if CSP_LOGGING_METHOD == 1 // Flogger |
|
102 |
|
103 #include <flogger.h> |
|
104 _LIT(KTfLogFolder,"CSP"); |
|
105 _LIT(KTfLogFile,"CSPLOG.TXT"); |
|
106 |
|
107 #elif CSP_LOGGING_METHOD == 2 // RDebug |
|
108 |
|
109 #include <e32svr.h> |
|
110 |
|
111 #endif |
|
112 |
|
113 |
|
114 /* |
|
115 ----------------------------------------------------------------------------- |
|
116 |
|
117 LOGGING MACROs |
|
118 |
|
119 USE THESE MACROS IN YOUR CODE ! |
|
120 |
|
121 ----------------------------------------------------------------------------- |
|
122 */ |
|
123 #define MESSAGE(A) _L(A) |
|
124 |
|
125 #if CSP_LOGGING_METHOD == 1 // Flogger |
|
126 |
|
127 #define CSPLOGTEXT(Type,AAA) { \ |
|
128 if((CSPLOGMASK()&(Type))==(Type)) \ |
|
129 { \ |
|
130 RFileLogger::Write(KTfLogFolder(),KTfLogFile(), \ |
|
131 EFileLoggingModeAppend, AAA); \ |
|
132 } \ |
|
133 } |
|
134 #define CSPLOGSTRING(Type,AAA) { \ |
|
135 if((CSPLOGMASK()&(Type))==(Type)) \ |
|
136 { \ |
|
137 _LIT(tempLogDes,AAA); \ |
|
138 RFileLogger::Write(KTfLogFolder(),KTfLogFile(), \ |
|
139 EFileLoggingModeAppend,tempLogDes()); \ |
|
140 } \ |
|
141 } |
|
142 #define CSPLOGSTRING2(Type,AAA,BBB) { \ |
|
143 if((CSPLOGMASK()&(Type))==(Type)) \ |
|
144 { \ |
|
145 _LIT(tempLogDes,AAA); \ |
|
146 RFileLogger::WriteFormat(KTfLogFolder(),KTfLogFile(), \ |
|
147 EFileLoggingModeAppend, \ |
|
148 TRefByValue<const TDesC>(tempLogDes()),BBB); \ |
|
149 } \ |
|
150 } |
|
151 #define CSPLOGSTRING3(Type,AAA,BBB,CCC) { \ |
|
152 if((CSPLOGMASK()&(Type))==(Type)) \ |
|
153 { \ |
|
154 _LIT(tempLogDes,AAA); \ |
|
155 RFileLogger::WriteFormat(KTfLogFolder(),KTfLogFile(), \ |
|
156 EFileLoggingModeAppend, \ |
|
157 TRefByValue<const TDesC>(tempLogDes()),BBB,CCC); \ |
|
158 } \ |
|
159 } |
|
160 #define CSPLOGSTRING4(Type,AAA,BBB,CCC,DDD) { \ |
|
161 if((CSPLOGMASK()&(Type))==(Type)) \ |
|
162 { \ |
|
163 _LIT(tempLogDes,AAA); \ |
|
164 RFileLogger::WriteFormat(KTfLogFolder(), \ |
|
165 KTfLogFile(),EFileLoggingModeAppend, \ |
|
166 TRefByValue<const TDesC>(tempLogDes()), \ |
|
167 BBB,CCC,DDD); \ |
|
168 } \ |
|
169 } |
|
170 |
|
171 #elif CSP_LOGGING_METHOD == 2 // RDebug |
|
172 |
|
173 #define CSPLOGTEXT(Type,AAA) { \ |
|
174 if((CSPLOGMASK()&(Type))==(Type)) RDebug::Print(AAA); \ |
|
175 } |
|
176 #define CSPLOGSTRING(Type,AAA) { \ |
|
177 if((CSPLOGMASK()&(Type))== \ |
|
178 (Type)) RDebug::Print(_L(AAA)); \ |
|
179 } |
|
180 #define CSPLOGSTRING2(Type,AAA,BBB) { \ |
|
181 if((CSPLOGMASK()&(Type))== \ |
|
182 (Type)) RDebug::Print(_L(AAA),BBB); \ |
|
183 } |
|
184 #define CSPLOGSTRING3(Type,AAA,BBB,CCC) { \ |
|
185 if((CSPLOGMASK()&(Type))== \ |
|
186 (Type)) RDebug::Print(_L(AAA),BBB,CCC); \ |
|
187 } |
|
188 #define CSPLOGSTRING4(Type,AAA,BBB,CCC,DDD) { \ |
|
189 if((CSPLOGMASK()&(Type))== \ |
|
190 (Type)) RDebug::Print(_L(AAA),BBB,CCC,DDD); \ |
|
191 } |
|
192 |
|
193 #else // CSP_LOGGING_METHOD == 0 or invalid |
|
194 |
|
195 #define CSPLOGTEXT(Type,AAA) // Example: TFLOGTEXT(CSPMESOUT, own_desc) |
|
196 #define CSPLOGSTRING(Type,AAA) // Example: TFLOGSTRING(CSPMESIN, "Test") |
|
197 #define CSPLOGSTRING2(Type,AAA,BBB) // Example: TFLOGSTRING(CSPMESINT, "Test %i", aValue) |
|
198 #define CSPLOGSTRING3(Type,AAA,BBB,CCC) // Example: TFLOGSTRING(CSPMESOUT, "Test %i %i", aValue1, aValue2) |
|
199 #define CSPLOGSTRING4(Type,AAA,BBB,CCC,DDD) // Example: TFLOGSTRING(CSPMESOUT, "Test %i %i %i", aValue1, aValue2, aValue3) |
|
200 |
|
201 #endif // CSP_LOGGING_METHOD |
|
202 |
|
203 |
|
204 /* |
|
205 ----------------------------------------------------------------------------- |
|
206 |
|
207 DEPRECATED LOGGING MACROs |
|
208 |
|
209 DON'T USE THESE MACROS IN YOUR CODE ANYMORE! |
|
210 |
|
211 ----------------------------------------------------------------------------- |
|
212 */ |
|
213 |
|
214 #define TFLOGTEXT(AAA) CSPLOGTEXT(CSPGENERAL,AAA); |
|
215 #define TFLOGSTRING(AAA) CSPLOGSTRING(CSPGENERAL,AAA); |
|
216 #define TFLOGSTRING2(AAA,BBB) CSPLOGSTRING2(CSPGENERAL,AAA,BBB); |
|
217 #define TFLOGSTRING3(AAA,BBB,CCC) CSPLOGSTRING3(CSPGENERAL,AAA,BBB,CCC); |
|
218 #define TFLOGSTRING4(AAA,BBB,CCC,DDD) CSPLOGSTRING4(CSPGENERAL,AAA,BBB,CCC,DDD); |
|
219 |
|
220 #endif // CSPLOGGER_H |