1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/security/cryptomgmtlibs/securitytestfw/test/testhandler2/t_input.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,216 @@
1.4 +/*
1.5 +* Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of the License "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +*
1.19 +*/
1.20 +
1.21 +
1.22 +#ifndef __T_INPUT_H__
1.23 +#define __T_INPUT_H__
1.24 +
1.25 +#include <e32cons.h>
1.26 +#include <f32file.h>
1.27 +#include <e32std.h>
1.28 +
1.29 +/**
1.30 + * This class provides useful functions to read and parse the input file.
1.31 + */
1.32 +class Input
1.33 + {
1.34 +public: // static functions no object required
1.35 + /*
1.36 + Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd
1.37 + NB use these if you want just want to use the result temporarily, because it just points
1.38 + to the result in aBuf
1.39 +
1.40 + Parameters
1.41 + const TDesC& aBuf [IN] - Buffer to search
1.42 + const TDesC& aStart [IN] - Start tag t be searched for
1.43 + 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>
1.44 + TInt& aPos [IN/OUT]- (Optional)Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
1.45 + TInt& aError [OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
1.46 +
1.47 + Returns
1.48 + TPtrC - Returns a TPtr to the position in the buffer between the start and end tags
1.49 + */
1.50 + // base functions for parsing tokens in scripts, but better to use functions below
1.51 + IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart);
1.52 + IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
1.53 + IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
1.54 + IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
1.55 + IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
1.56 + IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
1.57 + IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
1.58 + IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart);
1.59 + IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
1.60 + IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos, TInt& aError);
1.61 + /**
1.62 + * Reads the between the start and end tags assuming the data is in ASCII
1.63 + * hex format. Returns an HBufC8* which is a binary representation of that
1.64 + * ASCII hex. (ie a string of length 6 becomes a string of length 3)
1.65 + */
1.66 + IMPORT_C static HBufC8* ParseElementHexL(const TDesC8& aBuf, const TDesC8& aStart);
1.67 + /**
1.68 + * Returns ETrue if the the value was "True" or "ETrue" and returns EFalse
1.69 + * if the value was "False" or "EFalse" (case insensitive comparisons all
1.70 + * round). Leaves if none of the above is true
1.71 + */
1.72 + IMPORT_C static TBool ParseElementBoolL(const TDesC8& aBuf, const TDesC8& aStart);
1.73 + /**
1.74 + * Parses the parameters aBuf to find the section of the script within
1.75 + * parameters aStart and aEnd, and parses the contants as an integer. Both
1.76 + * decimal ('123') and hex ('0x7b') format strings are supported.
1.77 + *
1.78 + * @param aBuf [IN] - Buffer to search
1.79 + * @param aStart [IN] - Start tag t be searched for
1.80 + * @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>
1.81 + * @param aPos [IN/OUT]- (Optional)Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
1.82 + * @param aError [OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
1.83 + *
1.84 + * @return The parsed integer value, or zero.
1.85 + */
1.86 + IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
1.87 + IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
1.88 + IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
1.89 + IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
1.90 + IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
1.91 + IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
1.92 + IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart);
1.93 + IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
1.94 + IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos, TInt& aError);
1.95 + /*
1.96 + Searches the list of standard error codes (e32err.h 0 to -46) finding the matching error code for the string
1.97 +
1.98 + Parameters
1.99 + const TDesC& aResult [IN] - Error code string to be searched from
1.100 + TInt &aError [OUT] - Matching error code if found
1.101 +
1.102 + Returns
1.103 + TBool - True if error code was found, False if it was not
1.104 + */
1.105 + IMPORT_C static TBool GetExpectedResultL(const TDesC& aResult /*in*/, TInt &aError /*out*/);
1.106 + /*
1.107 + Searches the list of standard error codes (e32err.h 0 to -46) finding the matching text representaion of the error code
1.108 +
1.109 + Parameters
1.110 + TInt &aError [IN] - Error code to return the string of
1.111 + HBufC*& aResult [OUT] -Reference to a pointer, pointing to the error string of the matching error code (Dont forget to free it)
1.112 +
1.113 + Returns
1.114 + TBool - True if error code was found, False if it was not
1.115 + */
1.116 + IMPORT_C static TBool GetExpectedResultL(const TInt &aError /*in*/, HBufC*& aResult /*out*/);
1.117 + /*
1.118 + Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd,
1.119 + then allocs the required memory and places a copy of this section in aMember
1.120 + use these if you want the result copied into a new area of memory to use, for example when
1.121 + stored a member data
1.122 +
1.123 + Parameters
1.124 + HBufC*& aMember [OUT] - Reference to a pointer that will point to a copy of the section of aBuf
1.125 + const TDesC& aBuf [IN] - Buffer to search
1.126 + const TDesC& aStart [IN] - Start tag t be searched for
1.127 + 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>
1.128 + TInt& aPos [IN/OUT]- (Optional) Position in buffer to start searching, this will be updated with the position after the search (Optional) default zero
1.129 + TInt& aError [OUT]- (Optional) Returns negative number if start tag cannot be found (Optional)
1.130 +
1.131 + Returns
1.132 + TPtrC - Returns a TPtr to the position in the buffer between the start and
1.133 + end tags
1.134 + */
1.135 + IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
1.136 + const TDesC& aStart);
1.137 + IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
1.138 + const TDesC& aStart);
1.139 + IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
1.140 + const TDesC& aStart, TInt& aPos);
1.141 + IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
1.142 + const TDesC& aStart, TInt& aPos);
1.143 + IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
1.144 + const TDesC& aStart, TInt& aPos, TInt& aError);
1.145 + IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
1.146 + const TDesC& aStart, TInt& aPos, TInt& aError);
1.147 + /*
1.148 + Reads an entire file into memory into a HBuf8
1.149 +
1.150 + Parameters
1.151 + const TDesC& aFilename [IN] - Name of file to read
1.152 + const TDesC& aPath [IN] - (Optional) Path of file, if aPath is missing the path is taken from aFilename
1.153 + RFs &aFs [IN] - Reference to the file system handle class
1.154 +
1.155 + Returns
1.156 + HBufC8* - Pointer to the 8 bit file data
1.157 + */
1.158 + IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, RFs& aFs);
1.159 + IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, const TDesC& aPath, RFs& aFs);
1.160 + IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, RFs& aFs);
1.161 + IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, const TDesC& aPath, RFs& aFS);
1.162 + /*
1.163 + Reads a ascii hex file into a binary HBufC i.e. a file containing "FFAA11" will be converted into a 3 byte buffer
1.164 +
1.165 + Parameters
1.166 + const TDesC& aFilename [IN] - Name of file including path to read
1.167 + RFs &aFs [IN] - Reference to the file system handle class
1.168 +
1.169 + Returns
1.170 + HBufC8* - Pointer to the 8 bit file data
1.171 + */
1.172 + IMPORT_C static HBufC8* ReadHexFileLC(const TDesC& aFilename, RFs& aFs);
1.173 + /**
1.174 + * This function reads an entire Unicode file and returns it as an HBufC.
1.175 + * This function only works for Unicode builds of EPOC.
1.176 + */
1.177 + IMPORT_C static HBufC* ReadFile16LC(const TDesC& aFilename, RFs& aFS);
1.178 + /*
1.179 + Parses the parameters aBuf to find multiple sections of the script within parameters aStart and aEnd, then adds them to the aElements list
1.180 + For instance, if the aBuf argument is <StartTag>abc<EndTag><StartTag>xyz<EndTag>, then aElements will contain 2 elements: abc and xyz.
1.181 +
1.182 + const TDesC& aBuf [IN] - Buffer to search
1.183 + const TDesC& aStart [IN] - Start tag to be searched for
1.184 + const TDesC& aEnd [IN]- End tag t be searched for
1.185 + RPointerArray<HBufC>& aElements [OUT] - Array of sections found
1.186 + TInt& aPos [IN/OUT]- Position in buffer to start searching, this will be updated with the position after the search
1.187 +
1.188 + Returns
1.189 + None
1.190 + */
1.191 + IMPORT_C static void ParseElementListL(const TDesC& aBuf, const TDesC& aStart, const TDesC& aEnd,
1.192 + RPointerArray<HBufC>& aElements, TInt& aPos);
1.193 +
1.194 +
1.195 + /**
1.196 + * Parse a string containg a capability name.
1.197 + * @leave KErrArgument If the string is not a recognised capability name.
1.198 + */
1.199 + IMPORT_C static TCapability ParseCapabilityNameL(const TDesC8& aName);
1.200 +
1.201 + /**
1.202 + * Parse a section of script file describing a capability set.
1.203 + *
1.204 + * The script contains zero or more capabilities contained in <capability>
1.205 + * tags.
1.206 + */
1.207 + IMPORT_C static void ParseCapabilitySetL(const TDesC8& aIn, TCapabilitySet& aOut);
1.208 +
1.209 + /**
1.210 + * Parse a section of script file describing a security policy.
1.211 + *
1.212 + * The script contains zero or more capabilities contained in <capability>
1.213 + * tags.
1.214 + */
1.215 + IMPORT_C static void ParseSecurityPolicyL(const TDesC8& aIn, TSecurityPolicy& aOut);
1.216 +
1.217 + };
1.218 +
1.219 +#endif