|
85
|
1 |
/*
|
|
|
2 |
* Copyright (c) 2008 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:
|
|
|
15 |
*
|
|
|
16 |
*/
|
|
|
17 |
|
|
|
18 |
|
|
|
19 |
#ifndef C_WIDGETSCANNERPARSER_H
|
|
|
20 |
#define C_WIDGETSCANNERPARSER_H
|
|
|
21 |
|
|
|
22 |
// INCLUDES
|
|
|
23 |
#include <e32base.h>
|
|
98
|
24 |
#include <xml/dom/xmlengdomimplementation.h>
|
|
85
|
25 |
#include <badesca.h>
|
|
|
26 |
#include <f32file.h>
|
|
|
27 |
#include "cawidgetdescription.h"
|
|
98
|
28 |
#include "castorage_global.h"
|
|
85
|
29 |
|
|
|
30 |
// CONSTANTS
|
|
|
31 |
|
|
|
32 |
// FORWARD DECLARATIONS
|
|
98
|
33 |
|
|
85
|
34 |
class CDir;
|
|
98
|
35 |
CA_STORAGE_TEST_CLASS( T_CaWidgetScanner )
|
|
|
36 |
class TXmlEngElement;
|
|
85
|
37 |
/**
|
|
|
38 |
* Widget Parser
|
|
|
39 |
*
|
|
|
40 |
* @since Series Series60 5.x
|
|
|
41 |
*/
|
|
|
42 |
class CCaWidgetScannerParser : public CBase
|
|
|
43 |
{
|
|
|
44 |
|
|
|
45 |
public:
|
|
|
46 |
// Constructors and destructor
|
|
|
47 |
|
|
|
48 |
/**
|
|
|
49 |
* Two-phased constructor.
|
|
|
50 |
*/
|
|
|
51 |
static CCaWidgetScannerParser* NewL( RFs& aFs );
|
|
|
52 |
static CCaWidgetScannerParser* NewLC( RFs& aFs );
|
|
|
53 |
|
|
|
54 |
/**
|
|
|
55 |
* Destructor.
|
|
|
56 |
*/
|
|
|
57 |
virtual ~CCaWidgetScannerParser();
|
|
|
58 |
|
|
|
59 |
/**
|
|
|
60 |
* WidgetsL
|
|
|
61 |
* @return array containing widgets description
|
|
|
62 |
*/
|
|
98
|
63 |
RWidgetArray& WidgetsScanL( const RWidgetArray& aWidgets );
|
|
93
|
64 |
|
|
85
|
65 |
private:
|
|
|
66 |
|
|
|
67 |
/**
|
|
|
68 |
* C++ default constructor.
|
|
|
69 |
*/
|
|
|
70 |
CCaWidgetScannerParser( RFs& aFs );
|
|
|
71 |
|
|
|
72 |
/**
|
|
|
73 |
* By default Symbian 2nd phase constructor is private.
|
|
|
74 |
*/
|
|
|
75 |
void ConstructL( );
|
|
|
76 |
|
|
98
|
77 |
|
|
|
78 |
/**
|
|
|
79 |
* Looks for manifests on a drive
|
|
|
80 |
* @param aDrive drive to use
|
|
|
81 |
*/
|
|
|
82 |
void ScanOnDriveL( TChar& aDrive );
|
|
|
83 |
|
|
|
84 |
/**
|
|
|
85 |
* Parses all manifest files in a directory
|
|
|
86 |
* @param aDirectoryName directory name
|
|
|
87 |
* @param aDrive drive to use
|
|
|
88 |
*/
|
|
|
89 |
void ParseDirectoryL( const TDesC& aDirectoryName, TChar& aDrive );
|
|
|
90 |
|
|
|
91 |
/**
|
|
|
92 |
* Parse manifest file
|
|
|
93 |
* @param aFilePath full file path to manifest file
|
|
|
94 |
* @param aPackageUid descriptor containing package uid
|
|
|
95 |
* @param aDrive drive to use
|
|
|
96 |
*/
|
|
|
97 |
void ParseManifestFileL( const TDesC& aFilePath,
|
|
|
98 |
const TDesC& aPackageUid, TChar& aDrive );
|
|
|
99 |
|
|
|
100 |
/**
|
|
|
101 |
* Parse a widget, store parsed object in an internal array
|
|
|
102 |
* @param aFilePath full file path to manifest file
|
|
|
103 |
* @param aElement widget element
|
|
|
104 |
* @param aPackageUid descriptor containing package uid
|
|
|
105 |
* @param aDrive drive to use
|
|
|
106 |
*/
|
|
|
107 |
void ParseWidgetL( const TDesC& aFilePath,
|
|
|
108 |
TXmlEngElement& aElement, const TDesC& aPackageUid,
|
|
|
109 |
TChar& aDrive );
|
|
|
110 |
|
|
|
111 |
/**
|
|
|
112 |
* Gets all directories from import folder
|
|
|
113 |
* @param aDriveLetter drive letter
|
|
|
114 |
* @return directories
|
|
|
115 |
*/
|
|
|
116 |
CDir* GetDirectoriesLC( TChar& aDrive );
|
|
|
117 |
|
|
|
118 |
/**
|
|
|
119 |
* Returns import path
|
|
|
120 |
* @param aDriveLetter drive letter
|
|
|
121 |
* @return import path
|
|
|
122 |
*/
|
|
|
123 |
HBufC* FullPathLC( TChar& aDrive ) const;
|
|
|
124 |
|
|
|
125 |
/**
|
|
|
126 |
* Returns manifest directory path
|
|
|
127 |
* @param aDriveLetter drive letter
|
|
|
128 |
* @param aDirectoryName directory name
|
|
|
129 |
* @param aDrive drive to use
|
|
|
130 |
* @return manifest directory path
|
|
|
131 |
*/
|
|
|
132 |
HBufC* GetManifestDirectoryPathLC( const TDesC& aDirectoryName, TChar& aDrive ) const;
|
|
|
133 |
|
|
|
134 |
/**
|
|
|
135 |
* Sets widgets URI
|
|
|
136 |
* @param aElement xml element
|
|
|
137 |
* @param aWidget widget to set value
|
|
|
138 |
*/
|
|
|
139 |
void SetUriL( TXmlEngElement& aElement, CCaWidgetDescription* aWidget );
|
|
|
140 |
|
|
|
141 |
/**
|
|
|
142 |
* Sets widgets library and path created from library
|
|
|
143 |
* @param aElement xml element
|
|
|
144 |
* @param aPackageUid package uid
|
|
|
145 |
* @param aWidget widget to set value
|
|
|
146 |
*/
|
|
|
147 |
void SetLibraryL( TXmlEngElement& aElement, const TDesC& aPackageUid,
|
|
|
148 |
CCaWidgetDescription* aWidget, TChar& aDrive );
|
|
85
|
149 |
|
|
98
|
150 |
/**
|
|
|
151 |
* Sets widgets title
|
|
|
152 |
* @param aElement xml element
|
|
|
153 |
* @param aWidget widget to set value
|
|
|
154 |
*/
|
|
|
155 |
void SetTitleL( TXmlEngElement& aElement,
|
|
|
156 |
CCaWidgetDescription* aWidget );
|
|
|
157 |
|
|
|
158 |
/**
|
|
|
159 |
* Sets widgets description
|
|
|
160 |
* @param aElement xml element
|
|
|
161 |
* @param aWidget widget to set value
|
|
|
162 |
*/
|
|
|
163 |
void SetDescriptionL( TXmlEngElement& aElement,
|
|
|
164 |
CCaWidgetDescription* aWidget );
|
|
|
165 |
|
|
|
166 |
/**
|
|
|
167 |
* Sets widgets visibility
|
|
|
168 |
* @param aElement xml element
|
|
|
169 |
* @param aWidget widget to set value
|
|
|
170 |
*/
|
|
|
171 |
void SetVisibilityL( TXmlEngElement& aElement,
|
|
|
172 |
CCaWidgetDescription* aWidget );
|
|
|
173 |
|
|
|
174 |
/**
|
|
|
175 |
* Sets icons URI
|
|
|
176 |
* @param aElement xml element
|
|
|
177 |
* @param aPackageUid package uid
|
|
|
178 |
* @param aWidget widget to set value
|
|
|
179 |
*/
|
|
|
180 |
void SetIconUriL( TXmlEngElement& aElement, const TDesC& aPackageUid,
|
|
|
181 |
CCaWidgetDescription* aWidget, TChar& aDrive );
|
|
|
182 |
|
|
|
183 |
/**
|
|
|
184 |
* Sets widgets mmc id
|
|
|
185 |
* @param aWidget widget to set value
|
|
85
|
186 |
*/
|
|
98
|
187 |
void SetMmcIdL( CCaWidgetDescription* aWidget, TChar& aDrive );
|
|
|
188 |
|
|
|
189 |
void ParseUriL( TXmlEngElement& aElement,
|
|
|
190 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
191 |
void ParseTitleL( TXmlEngElement& aElement,
|
|
|
192 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
193 |
void ParseIconL( TXmlEngElement& aElement, const TDesC& aPackageUid,
|
|
|
194 |
CCaWidgetDescription* aWidgetDescriptor, TChar& aDrive );
|
|
|
195 |
void ParseDescriptionL( TXmlEngElement& aElement,
|
|
|
196 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
197 |
void ParseHiddenL( TXmlEngElement& aElement,
|
|
|
198 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
199 |
void ParseServiceXmlL(TXmlEngElement & aElement,
|
|
|
200 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
201 |
void SetModificationTimeL( const TDesC& aFilePath,
|
|
|
202 |
CCaWidgetDescription* aWidgetDescriptor );
|
|
|
203 |
|
|
|
204 |
void ParsePreviewImageNameL( TXmlEngElement& aElement,
|
|
|
205 |
const TDesC& aPackageUid,
|
|
|
206 |
CCaWidgetDescription* aWidgetDescriptor,
|
|
|
207 |
TChar& aDrive );
|
|
|
208 |
|
|
|
209 |
/**
|
|
|
210 |
* @param aElement xml document element.
|
|
|
211 |
* @return created descriptor with element's text value. Ownership
|
|
|
212 |
* of the descriptor is passed to the caller.
|
|
|
213 |
*/
|
|
|
214 |
HBufC *CCaWidgetScannerParser::GetElementTextLC(
|
|
|
215 |
const TXmlEngElement& aElement ) const;
|
|
|
216 |
|
|
|
217 |
/**
|
|
|
218 |
* Parses graphics name value and if the name has a file extension
|
|
|
219 |
* adds widget root directory path to it.
|
|
|
220 |
* @param aElement xml document element.
|
|
|
221 |
* @return created descriptor with graphics name value. Ownership
|
|
|
222 |
* of the descriptor is passed to the caller.
|
|
|
223 |
*/
|
|
|
224 |
HBufC* GetThemableGraphicsNameLC(
|
|
|
225 |
const TXmlEngElement & aElement,
|
|
|
226 |
const TDesC & aPackageUid,
|
|
|
227 |
TChar& aDrive ) const;
|
|
|
228 |
|
|
|
229 |
|
|
|
230 |
|
|
|
231 |
private:
|
|
|
232 |
// Data
|
|
85
|
233 |
|
|
|
234 |
/*
|
|
|
235 |
* File server session.Not Own
|
|
|
236 |
*/
|
|
|
237 |
RFs iFs;
|
|
|
238 |
|
|
|
239 |
/*
|
|
|
240 |
* Path to the private directory (wihout drive).own
|
|
|
241 |
*/
|
|
|
242 |
RBuf iImportPath;
|
|
|
243 |
|
|
|
244 |
/*
|
|
|
245 |
* Widgets. Own.
|
|
|
246 |
*/
|
|
|
247 |
RWidgetArray iWidgets;
|
|
98
|
248 |
|
|
|
249 |
/*
|
|
|
250 |
* Widgets. Not own.
|
|
|
251 |
*/
|
|
|
252 |
RWidgetArray iFetchedWidgets;
|
|
85
|
253 |
/*
|
|
|
254 |
* Own.
|
|
|
255 |
*/
|
|
|
256 |
RXmlEngDOMImplementation iDomImpl;
|
|
93
|
257 |
|
|
98
|
258 |
|
|
|
259 |
CA_STORAGE_TEST_FRIEND_CLASS( T_CaWidgetScanner )
|
|
|
260 |
|
|
85
|
261 |
};
|
|
|
262 |
|
|
|
263 |
#endif // C_WIDGETSCANNERPARSER_H
|
|
|
264 |
// End of File
|