|
sl@0
|
1 |
/*
|
|
sl@0
|
2 |
* Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
|
|
sl@0
|
3 |
* All rights reserved.
|
|
sl@0
|
4 |
* This component and the accompanying materials are made available
|
|
sl@0
|
5 |
* under the terms of the License "Eclipse Public License v1.0"
|
|
sl@0
|
6 |
* which accompanies this distribution, and is available
|
|
sl@0
|
7 |
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
|
|
sl@0
|
8 |
*
|
|
sl@0
|
9 |
* Initial Contributors:
|
|
sl@0
|
10 |
* Nokia Corporation - initial contribution.
|
|
sl@0
|
11 |
*
|
|
sl@0
|
12 |
* Contributors:
|
|
sl@0
|
13 |
*
|
|
sl@0
|
14 |
* Description:
|
|
sl@0
|
15 |
*
|
|
sl@0
|
16 |
*/
|
|
sl@0
|
17 |
|
|
sl@0
|
18 |
|
|
sl@0
|
19 |
#ifndef __T_INPUT_H__
|
|
sl@0
|
20 |
#define __T_INPUT_H__
|
|
sl@0
|
21 |
|
|
sl@0
|
22 |
#include <e32cons.h>
|
|
sl@0
|
23 |
#include <f32file.h>
|
|
sl@0
|
24 |
#include <e32std.h>
|
|
sl@0
|
25 |
|
|
sl@0
|
26 |
/**
|
|
sl@0
|
27 |
* This class provides useful functions to read and parse the input file.
|
|
sl@0
|
28 |
*/
|
|
sl@0
|
29 |
class Input
|
|
sl@0
|
30 |
{
|
|
sl@0
|
31 |
public: // static functions no object required
|
|
sl@0
|
32 |
/*
|
|
sl@0
|
33 |
Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd
|
|
sl@0
|
34 |
NB use these if you want just want to use the result temporarily, because it just points
|
|
sl@0
|
35 |
to the result in aBuf
|
|
sl@0
|
36 |
|
|
sl@0
|
37 |
Parameters
|
|
sl@0
|
38 |
const TDesC& aBuf [IN] - Buffer to search
|
|
sl@0
|
39 |
const TDesC& aStart [IN] - Start tag t be searched for
|
|
sl@0
|
40 |
const TDesC& aEnd [IN] - (Optional)End tag t be searched for (Optional, if not supplied function will default aStart with a / i.e. if aStart <tag> aEnd will be </tag>
|
|
sl@0
|
41 |
TInt& aPos [IN/OUT]- (Optional)Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
|
|
sl@0
|
42 |
TInt& aError [OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
|
|
sl@0
|
43 |
|
|
sl@0
|
44 |
Returns
|
|
sl@0
|
45 |
TPtrC - Returns a TPtr to the position in the buffer between the start and end tags
|
|
sl@0
|
46 |
*/
|
|
sl@0
|
47 |
// base functions for parsing tokens in scripts, but better to use functions below
|
|
sl@0
|
48 |
IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart);
|
|
sl@0
|
49 |
IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
|
|
sl@0
|
50 |
IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
|
|
sl@0
|
51 |
IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
|
|
sl@0
|
52 |
IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
|
|
sl@0
|
53 |
IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
|
|
sl@0
|
54 |
IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
|
|
sl@0
|
55 |
IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart);
|
|
sl@0
|
56 |
IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
|
|
sl@0
|
57 |
IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos, TInt& aError);
|
|
sl@0
|
58 |
/**
|
|
sl@0
|
59 |
* Reads the between the start and end tags assuming the data is in ASCII
|
|
sl@0
|
60 |
* hex format. Returns an HBufC8* which is a binary representation of that
|
|
sl@0
|
61 |
* ASCII hex. (ie a string of length 6 becomes a string of length 3)
|
|
sl@0
|
62 |
*/
|
|
sl@0
|
63 |
IMPORT_C static HBufC8* ParseElementHexL(const TDesC8& aBuf, const TDesC8& aStart);
|
|
sl@0
|
64 |
/**
|
|
sl@0
|
65 |
* Returns ETrue if the the value was "True" or "ETrue" and returns EFalse
|
|
sl@0
|
66 |
* if the value was "False" or "EFalse" (case insensitive comparisons all
|
|
sl@0
|
67 |
* round). Leaves if none of the above is true
|
|
sl@0
|
68 |
*/
|
|
sl@0
|
69 |
IMPORT_C static TBool ParseElementBoolL(const TDesC8& aBuf, const TDesC8& aStart);
|
|
sl@0
|
70 |
/**
|
|
sl@0
|
71 |
* Parses the parameters aBuf to find the section of the script within
|
|
sl@0
|
72 |
* parameters aStart and aEnd, and parses the contants as an integer. Both
|
|
sl@0
|
73 |
* decimal ('123') and hex ('0x7b') format strings are supported.
|
|
sl@0
|
74 |
*
|
|
sl@0
|
75 |
* @param aBuf [IN] - Buffer to search
|
|
sl@0
|
76 |
* @param aStart [IN] - Start tag t be searched for
|
|
sl@0
|
77 |
* @param aEnd [IN] - (Optional)End tag t be searched for (Optional, if not supplied function will default aStart with a / i.e. if aStart <tag> aEnd will be </tag>
|
|
sl@0
|
78 |
* @param aPos [IN/OUT]- (Optional)Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
|
|
sl@0
|
79 |
* @param aError [OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
|
|
sl@0
|
80 |
*
|
|
sl@0
|
81 |
* @return The parsed integer value, or zero.
|
|
sl@0
|
82 |
*/
|
|
sl@0
|
83 |
IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
|
|
sl@0
|
84 |
IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
|
|
sl@0
|
85 |
IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
|
|
sl@0
|
86 |
IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
|
|
sl@0
|
87 |
IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
|
|
sl@0
|
88 |
IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
|
|
sl@0
|
89 |
IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart);
|
|
sl@0
|
90 |
IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
|
|
sl@0
|
91 |
IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos, TInt& aError);
|
|
sl@0
|
92 |
/*
|
|
sl@0
|
93 |
Searches the list of standard error codes (e32err.h 0 to -46) finding the matching error code for the string
|
|
sl@0
|
94 |
|
|
sl@0
|
95 |
Parameters
|
|
sl@0
|
96 |
const TDesC& aResult [IN] - Error code string to be searched from
|
|
sl@0
|
97 |
TInt &aError [OUT] - Matching error code if found
|
|
sl@0
|
98 |
|
|
sl@0
|
99 |
Returns
|
|
sl@0
|
100 |
TBool - True if error code was found, False if it was not
|
|
sl@0
|
101 |
*/
|
|
sl@0
|
102 |
IMPORT_C static TBool GetExpectedResultL(const TDesC& aResult /*in*/, TInt &aError /*out*/);
|
|
sl@0
|
103 |
/*
|
|
sl@0
|
104 |
Searches the list of standard error codes (e32err.h 0 to -46) finding the matching text representaion of the error code
|
|
sl@0
|
105 |
|
|
sl@0
|
106 |
Parameters
|
|
sl@0
|
107 |
TInt &aError [IN] - Error code to return the string of
|
|
sl@0
|
108 |
HBufC*& aResult [OUT] -Reference to a pointer, pointing to the error string of the matching error code (Dont forget to free it)
|
|
sl@0
|
109 |
|
|
sl@0
|
110 |
Returns
|
|
sl@0
|
111 |
TBool - True if error code was found, False if it was not
|
|
sl@0
|
112 |
*/
|
|
sl@0
|
113 |
IMPORT_C static TBool GetExpectedResultL(const TInt &aError /*in*/, HBufC*& aResult /*out*/);
|
|
sl@0
|
114 |
/*
|
|
sl@0
|
115 |
Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd,
|
|
sl@0
|
116 |
then allocs the required memory and places a copy of this section in aMember
|
|
sl@0
|
117 |
use these if you want the result copied into a new area of memory to use, for example when
|
|
sl@0
|
118 |
stored a member data
|
|
sl@0
|
119 |
|
|
sl@0
|
120 |
Parameters
|
|
sl@0
|
121 |
HBufC*& aMember [OUT] - Reference to a pointer that will point to a copy of the section of aBuf
|
|
sl@0
|
122 |
const TDesC& aBuf [IN] - Buffer to search
|
|
sl@0
|
123 |
const TDesC& aStart [IN] - Start tag t be searched for
|
|
sl@0
|
124 |
const TDesC& aEnd [IN] - (Optional) End tag t be searched for (, if not supplied function will default aStart with a / i.e. if aStart <tag> aEnd will be </tag>
|
|
sl@0
|
125 |
TInt& aPos [IN/OUT]- (Optional) Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
|
|
sl@0
|
126 |
TInt& aError [OUT]- (Optional) Returns negative number if start tag cannot be found (Optional)
|
|
sl@0
|
127 |
|
|
sl@0
|
128 |
Returns
|
|
sl@0
|
129 |
TPtrC - Returns a TPtr to the position in the buffer between the start and
|
|
sl@0
|
130 |
end tags
|
|
sl@0
|
131 |
*/
|
|
sl@0
|
132 |
IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
|
|
sl@0
|
133 |
const TDesC& aStart);
|
|
sl@0
|
134 |
IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
|
|
sl@0
|
135 |
const TDesC& aStart);
|
|
sl@0
|
136 |
IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
|
|
sl@0
|
137 |
const TDesC& aStart, TInt& aPos);
|
|
sl@0
|
138 |
IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
|
|
sl@0
|
139 |
const TDesC& aStart, TInt& aPos);
|
|
sl@0
|
140 |
IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
|
|
sl@0
|
141 |
const TDesC& aStart, TInt& aPos, TInt& aError);
|
|
sl@0
|
142 |
IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
|
|
sl@0
|
143 |
const TDesC& aStart, TInt& aPos, TInt& aError);
|
|
sl@0
|
144 |
/*
|
|
sl@0
|
145 |
Reads an entire file into memory into a HBuf8
|
|
sl@0
|
146 |
|
|
sl@0
|
147 |
Parameters
|
|
sl@0
|
148 |
const TDesC& aFilename [IN] - Name of file to read
|
|
sl@0
|
149 |
const TDesC& aPath [IN] - (Optional) Path of file, if aPath is missing the path is taken from aFilename
|
|
sl@0
|
150 |
RFs &aFs [IN] - Reference to the file system handle class
|
|
sl@0
|
151 |
|
|
sl@0
|
152 |
Returns
|
|
sl@0
|
153 |
HBufC8* - Pointer to the 8 bit file data
|
|
sl@0
|
154 |
*/
|
|
sl@0
|
155 |
IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, RFs& aFs);
|
|
sl@0
|
156 |
IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, const TDesC& aPath, RFs& aFs);
|
|
sl@0
|
157 |
IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, RFs& aFs);
|
|
sl@0
|
158 |
IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, const TDesC& aPath, RFs& aFS);
|
|
sl@0
|
159 |
/*
|
|
sl@0
|
160 |
Reads a ascii hex file into a binary HBufC i.e. a file containing "FFAA11" will be converted into a 3 byte buffer
|
|
sl@0
|
161 |
|
|
sl@0
|
162 |
Parameters
|
|
sl@0
|
163 |
const TDesC& aFilename [IN] - Name of file including path to read
|
|
sl@0
|
164 |
RFs &aFs [IN] - Reference to the file system handle class
|
|
sl@0
|
165 |
|
|
sl@0
|
166 |
Returns
|
|
sl@0
|
167 |
HBufC8* - Pointer to the 8 bit file data
|
|
sl@0
|
168 |
*/
|
|
sl@0
|
169 |
IMPORT_C static HBufC8* ReadHexFileLC(const TDesC& aFilename, RFs& aFs);
|
|
sl@0
|
170 |
/**
|
|
sl@0
|
171 |
* This function reads an entire Unicode file and returns it as an HBufC.
|
|
sl@0
|
172 |
* This function only works for Unicode builds of EPOC.
|
|
sl@0
|
173 |
*/
|
|
sl@0
|
174 |
IMPORT_C static HBufC* ReadFile16LC(const TDesC& aFilename, RFs& aFS);
|
|
sl@0
|
175 |
/*
|
|
sl@0
|
176 |
Parses the parameters aBuf to find multiple sections of the script within parameters aStart and aEnd, then adds them to the aElements list
|
|
sl@0
|
177 |
For instance, if the aBuf argument is <StartTag>abc<EndTag><StartTag>xyz<EndTag>, then aElements will contain 2 elements: abc and xyz.
|
|
sl@0
|
178 |
|
|
sl@0
|
179 |
const TDesC& aBuf [IN] - Buffer to search
|
|
sl@0
|
180 |
const TDesC& aStart [IN] - Start tag to be searched for
|
|
sl@0
|
181 |
const TDesC& aEnd [IN]- End tag t be searched for
|
|
sl@0
|
182 |
RPointerArray<HBufC>& aElements [OUT] - Array of sections found
|
|
sl@0
|
183 |
TInt& aPos [IN/OUT]- Position in buffer to start searching, this will be updated with the position after the search
|
|
sl@0
|
184 |
|
|
sl@0
|
185 |
Returns
|
|
sl@0
|
186 |
None
|
|
sl@0
|
187 |
*/
|
|
sl@0
|
188 |
IMPORT_C static void ParseElementListL(const TDesC& aBuf, const TDesC& aStart, const TDesC& aEnd,
|
|
sl@0
|
189 |
RPointerArray<HBufC>& aElements, TInt& aPos);
|
|
sl@0
|
190 |
|
|
sl@0
|
191 |
|
|
sl@0
|
192 |
/**
|
|
sl@0
|
193 |
* Parse a string containg a capability name.
|
|
sl@0
|
194 |
* @leave KErrArgument If the string is not a recognised capability name.
|
|
sl@0
|
195 |
*/
|
|
sl@0
|
196 |
IMPORT_C static TCapability ParseCapabilityNameL(const TDesC8& aName);
|
|
sl@0
|
197 |
|
|
sl@0
|
198 |
/**
|
|
sl@0
|
199 |
* Parse a section of script file describing a capability set.
|
|
sl@0
|
200 |
*
|
|
sl@0
|
201 |
* The script contains zero or more capabilities contained in <capability>
|
|
sl@0
|
202 |
* tags.
|
|
sl@0
|
203 |
*/
|
|
sl@0
|
204 |
IMPORT_C static void ParseCapabilitySetL(const TDesC8& aIn, TCapabilitySet& aOut);
|
|
sl@0
|
205 |
|
|
sl@0
|
206 |
/**
|
|
sl@0
|
207 |
* Parse a section of script file describing a security policy.
|
|
sl@0
|
208 |
*
|
|
sl@0
|
209 |
* The script contains zero or more capabilities contained in <capability>
|
|
sl@0
|
210 |
* tags.
|
|
sl@0
|
211 |
*/
|
|
sl@0
|
212 |
IMPORT_C static void ParseSecurityPolicyL(const TDesC8& aIn, TSecurityPolicy& aOut);
|
|
sl@0
|
213 |
|
|
sl@0
|
214 |
};
|
|
sl@0
|
215 |
|
|
sl@0
|
216 |
#endif
|