summaryrefslogtreecommitdiffstats
path: root/plugins/contacts/symbian/contactsmodel/inc/cntapiprofile.h
blob: ec4ae1a5351333f65446f3e6f732e8ad2c1fa7d6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
/*
* Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
* All rights reserved.
* This component and the accompanying materials are made available
* under the terms of "Eclipse Public License v1.0"
* which accompanies this distribution, and is available
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
*
* Initial Contributors:
* Nokia Corporation - initial contribution.
*
* Contributors:
*
* Description: 
*
*/

#if !defined(SYMBIAN_CNT_API_PROFILE)
#define SYMBIAN_CNT_API_PROFILE


// is profile logging enabled?
#if defined(CONTACTS_API_PROFILING)

// for RProcess & RThread
#include <e32std.h>

// Contact Views
#include <cntviewbase.h>


class CContactDbApiTimer;

class TContactsApiProfile
	{
public:
	enum TCntViewClass
		{
		ECntVwClassViewBase,			// "CContactViewBase"
		ECntVwClassLocalView,			// "CContactLocalView"
		ECntVwClassNamedLocalView,		// "CContactNamedLocalView"
		ECntVwClassRemoteViewBase,		// "CContactRemoteViewBase"
		ECntVwClassRemoteView,			// "CContactRemoteView"
		ECntVwClassNamedRemoteView,		// "CContactNamedRemoteView"
		};

	enum TCntViewApi
		{
		ECntViewDestructor,						// "~..."
		// create API
		ECntViewApiNewL,						// "NewL"

		ECntViewApiAllFieldsLC,					// "AllFieldsLC"
		ECntViewApiAtL,							// "AtL"
		ECntViewApiChangeSortOrderL,			// "ChangeSortOrderL"
		ECntViewApiClose,						// "Close"
		ECntViewApiConstructL,					// "ConstructL"
		ECntViewApiContactAtL,					// "ContactAtL"
		ECntViewApiContactViewBase_Reserved_1,	// "ContactViewBase_Reserved_1"
		ECntViewApiContactViewPreferences,		// "ECntViewApiContactViewPreferences"
		ECntViewApiCountL,						// "CountL"
		ECntViewApiFieldsWithSeparatorLC,		// "FieldsWithSeparatorLC"
		ECntViewApiFindL,						// "FindL"
		ECntViewApiGetContactIdsL,				// "GetContactIdsL"
		ECntViewApiGetSortOrderL,				// "GetSortOrderL"
		ECntViewApiGetViewFindConfigPlugin,		// "GetViewFindConfigPlugin"
		ECntViewApiMatchesCriteriaL,			// "MatchesCriteriaL"
		ECntViewApiNotifyObserverAsync,			// "NotifyObserverAsync"
		ECntViewApiNotifyObservers,				// "NotifyObservers"
		ECntViewApiOpen,						// "Open"
		ECntViewApiOpenL,						// "OpenL"
		ECntViewApiSetViewFindConfigPlugin,		// "SetViewFindConfigPlugin"
		ECntViewApiSortL,						// "SortL"
		ECntViewApiSortOrder,					// "SortOrder"
		ECntViewApiUpdateGroupViewL,			// "UpdateGroupViewL"
		};

	enum TCntDbApi
		{
		ECntDbDestructor,					// "~CContactDatabase"
		// create APIs - these create a CContactDatabase object plus NewL/NewLC
		ECntDbApiNewL,						// "NewL/LC"
		ECntDbApiCreateL,					// "CreateL"
		ECntDbApiOpen,						// "Open"
		ECntDbApiOpenL,						// "OpenL"
		ECntDbApiReplaceL,					// "ReplaceL"

		ECntDbApiDoOpenL,					// client side Open

		// most other APIs (omits some very frequently called APIs)
		ECntDbApiAddNewContactL,			// "AddNewContactL"
		ECntDbApiAddContactToGroupL,		// "AddContactToGroupL"

		ECntDbApiCancelAsyncSort,			// "CancelAsyncSort"
		ECntDbApiCloseContactL,				// "CloseContactL"
		ECntDbApiCommitContactL,			// "CommitContactL"
		ECntDbApiCompactL,					// "CompactL"
		ECntDbApiCompressRequired,			// "CompressRequired"
		ECntDbApiConnectionId,				// "ConnectionId"
		ECntDbApiContactDatabaseExistsL,	// "ContactDatabaseExistsL"
		ECntDbApiContactMatchesHintFieldL,	// "ContactMatchesHintFieldL"
		ECntDbApiContactsChangedSinceL,		// "ContactsChangedSinceL"
		ECntDbApiCountL,					// "CountL"

		ECntDbApiCreateCompressorLC,		// "CreateCompressorLC"
		ECntDbApiCreateContactCardTemplateL,	// "CreateContactCardTemplateL/LC"
		ECntDbApiCreateContactGroupL,		// "CreateContactGroupL/LC"
		ECntDbApiCreateRecoverLC,			// "CreateRecoverLC"
		ECntDbApiCreateOwnCardL,			// "CreateOwnCardL/LC"

		ECntDbApiDatabaseBeginL,			// "DatabaseBeginL"
		ECntDbApiDatabaseCommitL,			// "DatabaseCommitL"
		ECntDbApiDatabaseDrive,				// "DatabaseDrive"
		ECntDbApiDatabaseRollback,			// "DatabaseRollback"

		ECntDbApiDeleteContactL,			// "DeleteContactL"
		ECntDbApiDeleteContactsL,			// "DeleteContactsL"
		ECntDbApiDeleteDatabaseL,			// "DeleteDatabaseL"
		ECntDbApiDeletedContactsLC,			// "DeletedContactsLC"
		ECntDbApiDeleteDefaultFileL,		// "DeleteDefaultFileL"

		ECntDbApiExportSelectedContactsL,	// "ExportSelectedContactsL"

		ECntDbApiFileSize,					// "FileSize"
		ECntDbApiFilterDatabaseL,			// "FilterDatabaseL"
		ECntDbApiFindContactFile,			// "FindContactFile"

		ECntDbApiGetCardTemplateIdListL,	// "GetCardTemplateIdListL"
		ECntDbApiGetCurrentDatabase,		// "GetCurrentDatabase"
		ECntDbApiGetCurrentItem,			// "GetCurrentItem"
		ECntDbApiGetDefaultNameL,			// "GetDefaultNameL"
		ECntDbApiGetGroupIdListL,			// "GetGroupIdListL"
		ECntDbApiGetLastSyncDateL,			// "GetLastSyncDateL"
		ECntDbApiGetSpeedDialFieldL,		// "GetSpeedDialFieldL"

		ECntDbApiHandleDatabaseEventL,		// "HandleDatabaseEventL"

		ECntDbApiICCTemplateIdL,			// "ICCTemplateIdL"
		ECntDbApiImportContactsL,			// "ImportContactsL"
		ECntDbApiIsDamaged,					// "IsDamaged"

		ECntDbApiListDatabasesL,			// "ListDatabasesL"
		ECntDbApiLockRecordLC,				// internal method "LockRecordLC"

		ECntDbApiMachineId,					// "MachineId"

		ECntDbApiOpenContactL,				// "OpenContactL/LX"
		ECntDbApiOverrideMachineUniqueId,	// "OverrideMachineUniqueId"

		ECntDbApiPhonebookGroupIdL,			// "PhonebookGroupIdL"

		ECntDbApiReadContactAndAgentL,		// "ReadContactAndAgentL"
		ECntDbApiReadContactL,				// "ReadContactL/LC"
		ECntDbApiReadContactTextDefL,		// "ReadContactTextDefL"
		ECntDbApiReadMinimalContactL,		// "ReadMinimalContactL/LC"

		ECntDbApiRecoverL,					// "RecoverL"
		ECntDbApiRecreateSystemTemplateL,	// "RecreateSystemTemplateL"
		ECntDbApiRemoveContactFromGroupL,	// "RemoveContactFromGroupL"
		ECntDbApiRemoveSpeedDialFieldL,		// "RemoveSpeedDialFieldL"
		ECntDbApiResetServerSpeedDialsL,	// "ResetServerSpeedDialsL"
		ECntDbApiRestoreSortOrderL,			// "RestoreSortOrderL"

		ECntDbApiSetDatabaseDriveL,			// "SetDatabaseDriveL"
		ECntDbApiSetDbViewContactType,		// "SetDbViewContactType"
		ECntDbApiSetCurrentDatabase,		// "SetCurrentDatabase"
		ECntDbApiSetCurrentItem,			// "SetCurrentItem")
		ECntDbApiSetFieldAsSpeedDialL,		// "SetFieldAsSpeedDialL"
		ECntDbApiSetLastSyncDateL,			// "SetLastSyncDateL"
		ECntDbApiSetOwnCardL,				// "SetOwnCardL"
		ECntDbApiSetPrefTempateL,			// "SetPrefTempateL"
		ECntDbApiSetSortedItemsList,		// "SetSortedItemsList"
		ECntDbApiSetViewDefinitionL,		// "SetViewDefinitionL"

		ECntDbApiSortArrayL,				// "SortArrayL/LC"
		ECntDbApiSortAsyncL,				// "SortAsyncL"
		ECntDbApiSortByTypeL,				// "SortByTypeL"
		ECntDbApiSortL,						// "SortL"
		ECntDbApiSortedItemsL,				// "SortedItemsL"

		ECntDbApiStoreSortOrderL,			// "StoreSortOrderL"

		ECntDbApiTemplateId,				// "TemplateId"

		ECntDbApiUnfiledContactsL,			// "UnfiledContactsL"
		ECntDbApiUpdateContactLC,			// "UpdateContactLC"

		ECntDbApiVersion,					// "Version"

		ECntDbApiWastedSpaceInBytes,		// "WastedSpaceInBytes"
		};


	// Logging for CContactDatabase APIs:
	// line 1 = time, PID, Thread Id, method(..);
	// if (aProcessDetail) then line 2 = Proc Name, Thread Name

	// log API method call only
	static	void CntDbMethodLog(const TCntDbApi& aApiId, TBool aProcessDetail=EFalse);
	static	void CntDbMethodLog(const TCntDbApi& aApiId, const TContactItemId aContactId, TBool aProcessDetail=EFalse);
	static	void CntDbMethodLog(const TCntDbApi& aApiId, const TDriveUnit aDriveUnit, TBool aProcessDetail=EFalse);
	static	void CntDbMethodLog(const TCntDbApi& aApiId, const TDesC& aFileName, TBool aProcessDetail=EFalse);
	static	void CntDbMethodLog(const TCntDbApi& aApiId, const TContactItemId aContactItemId, const TContactItemId aContactGroupId, TBool aProcessDetail=EFalse);
	static	void CntDbMethodLog(const TCntDbApi& aApiId, const TContactDbObserverEvent &aDbEvent, TBool aProcessDetail=EFalse);

	// CContactOpen APIs
	static	void CntOpenOpMethodLog(const TDesC& aMethodName, TBool aProcessDetail=EFalse);

	// CContactXyzView classes
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, TInt aIndex);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, const TContactViewEvent& aEvent);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, const RContactViewSortOrder& aSortOrder);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, 
									const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi,
									const RContactViewSortOrder& aSortOrder,TContactViewPreferences aContactTypes, const TDesC8& aSortPluginName);

	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, const TDesC& aViewName,
									const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes);
	static	void CntViewMethodLog(const TCntViewClass& aViewClass, const TCntViewApi& aViewApi, const TDesC& aViewName,
									const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes, const TDesC8& aSortPluginName);

private:
	friend class CContactDbApiTimer;
	// convert enumertion to ContactDatabase method name
	static	const TDesC& CntDbMethodName(const TCntDbApi& aApiId);

	// convert enumertions to Contact View class or method names
	static	const TDesC& CntViewClassName(const TCntViewClass& aClassId);
	static	const TDesC& CntViewMethodName(const TCntViewClass& aClassId, const TCntViewApi& aApiId);
	static	const TDesC& CntViewEventName(TInt& aParamFlags, const TContactViewEvent& aEvent);

	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, TBool aProcessDetail);
	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, const TContactItemId aContactId, TBool aProcessDetail);
	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, const TDriveUnit aDriveUnit, TBool aProcessDetail);
	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, const TDesC& aFileName, TBool aProcessDetail);
	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, const TContactItemId aContactItemId, const TContactItemId aContactGroupId, TBool aProcessDetail);
	static	void CntDbMethodLog(TTime& aTime, const TCntDbApi& aApiId, const TContactDbObserverEvent &aDbEvent, TBool aProcessDetail);

	static	void CntDbMethodEndLog(const TContactsApiProfile::TCntDbApi& aApiId, TTime& aStartTime);
#if !defined(EKA2)
	static	void CntDbMethodEndLog(const TContactsApiProfile::TCntDbApi& aApiId, TTime& aStartTime, TInt64& aCpuElapsedTime);
#endif

	// debug print time, PID etc, and class :: method details
	static	void MethodCallLogHelper(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, TBool aProcessDetail, TBool aNewLine);
	static	void MethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TContactItemId aContactId, TBool aProcessDetail);
	static	void MethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TContactItemId aContactItemId, const TContactItemId aContactGroupId, TBool aProcessDetail);
	static	void MethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TDriveUnit aDriveUnit, TBool aProcessDetail);
	static	void MethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TDesC& aFileName, TBool aProcessDetail);
	static	void MethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TContactDbObserverEvent &aDbEvent, TBool aProcessDetail);


	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, TInt aIndex, TBool aProcessDetail);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TContactViewEvent& aEvent, TBool aProcessDetail);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const RContactViewSortOrder& aSortOrder, TBool aProcessDetail, TBool aNewLine);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName,
											const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes, TBool aProcessDetail, TBool aNewLine);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName,
											const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes, const TDesC8& aSortPluginName, TBool aProcessDetail);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TDesC& aViewName,
											const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes, TBool aProcessDetail, TBool aNewLine);
	static	void ViewMethodCallLog(TTime& aTime, const TDesC& aClassName, const TDesC& aMethodName, const TDesC& aViewName,
											const RContactViewSortOrder& aSortOrder, TContactViewPreferences aContactTypes, const TDesC8& aSortPluginName, TBool aProcessDetail);

	static	void ProcessNameLog();
	};


// Log & time API method call
NONSHARABLE_CLASS(CContactDbApiTimer) : public CBase
	{	
public:
	static	CContactDbApiTimer* CntDbMethodTimeBeginLC(const TContactsApiProfile::TCntDbApi& aApiId);
	static	CContactDbApiTimer* CntDbMethodTimeBeginLC(const TContactsApiProfile::TCntDbApi& aApiId, const TContactItemId aContactId);
	static	CContactDbApiTimer* CntDbMethodTimeBeginLC(const TContactsApiProfile::TCntDbApi& aApiId, const TDriveUnit aDriveUnit);
	static	CContactDbApiTimer* CntDbMethodTimeBeginLC(const TContactsApiProfile::TCntDbApi& aApiId, const TDesC& aFileName);
	static	CContactDbApiTimer* CntDbMethodTimeBeginLC(const TContactsApiProfile::TCntDbApi& aApiId, const TContactItemId aContactItemId, const TContactItemId aContactGroupId);

	~CContactDbApiTimer();
private:
	CContactDbApiTimer(const TContactsApiProfile::TCntDbApi& aApiId);

private:
	TContactsApiProfile::TCntDbApi	iCntDbApi;
	TTime							iStartTime;
#if !defined(EKA2)
	TTimeIntervalMicroSeconds		iCpuStartTime;
	TTimeIntervalMicroSeconds		iCpuEndTime;
	TInt64							iCpuElapsedTime;
#endif
	};


#endif // CONTACTS_API_PROFILING



// SYMBIAN_CNT_API_PROFILE
#endif