sl@0: /*
sl@0: * Copyright (c) 1998-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: * All rights reserved.
sl@0: * This component and the accompanying materials are made available
sl@0: * under the terms of the License "Eclipse Public License v1.0"
sl@0: * which accompanies this distribution, and is available
sl@0: * at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: *
sl@0: * Initial Contributors:
sl@0: * Nokia Corporation - initial contribution.
sl@0: *
sl@0: * Contributors:
sl@0: *
sl@0: * Description: 
sl@0: *
sl@0: */
sl@0: 
sl@0: 
sl@0: #ifndef __T_INPUT_H__
sl@0: #define __T_INPUT_H__
sl@0: 
sl@0: #include <e32cons.h>
sl@0: #include <f32file.h>
sl@0: #include <e32std.h>
sl@0: 
sl@0: /**
sl@0:  * This class provides useful functions to read and parse the input file.
sl@0:  */
sl@0: class Input
sl@0: 	{
sl@0: public: // static functions no object required
sl@0: 	/*
sl@0: 	Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd
sl@0: 	NB use these if you want just want to use the result temporarily, because it just points
sl@0: 	to the result in aBuf
sl@0: 
sl@0: 	Parameters
sl@0: 	const TDesC& aBuf	[IN] - Buffer to search
sl@0: 	const TDesC& aStart	[IN] - Start tag t be searched for
sl@0: 	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: 	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: 	TInt& aError		[OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
sl@0: 
sl@0: 	Returns
sl@0: 	TPtrC		- Returns a TPtr to the position in the buffer between the start and end tags
sl@0: 	*/
sl@0: 	// base functions for parsing tokens in scripts, but better to use functions below
sl@0: 	IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart);
sl@0: 	IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
sl@0: 	IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
sl@0: 	IMPORT_C static TPtrC8 ParseElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
sl@0: 	IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
sl@0: 	IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
sl@0: 	IMPORT_C static TPtrC16 ParseElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
sl@0: 	IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart);
sl@0: 	IMPORT_C static TPtrC ParseElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
sl@0: 	IMPORT_C static TPtrC ParseElement(const TDesC& aBuf,  const TDesC& aStart, TInt& aPos, TInt& aError);
sl@0: 	/**
sl@0: 	 * Reads the between the start and end tags assuming the data is in ASCII
sl@0: 	 * hex format.  Returns an HBufC8* which is a binary representation of that
sl@0: 	 * ASCII hex.  (ie a string of length 6 becomes a string of length 3)
sl@0: 	 */
sl@0: 	IMPORT_C static HBufC8* ParseElementHexL(const TDesC8& aBuf, const TDesC8& aStart);
sl@0: 	/**
sl@0: 	 * Returns ETrue if the the value was "True" or "ETrue" and returns EFalse
sl@0: 	 * if the value was "False" or "EFalse" (case insensitive comparisons all
sl@0: 	 * round).  Leaves if none of the above is true 
sl@0: 	 */
sl@0: 	IMPORT_C static TBool ParseElementBoolL(const TDesC8& aBuf, const TDesC8& aStart);
sl@0: 	/**
sl@0: 	 * Parses the parameters aBuf to find the section of the script within
sl@0: 	 * parameters aStart and aEnd, and parses the contants as an integer.  Both
sl@0: 	 * decimal ('123') and hex ('0x7b') format strings are supported.
sl@0: 	 *
sl@0: 	 * @param aBuf		[IN] - Buffer to search
sl@0: 	 * @param aStart	[IN] - Start tag t be searched for
sl@0: 	 * @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: 	 * @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: 	 * @param aError	[OUT]- (Optional)Returns negative number if start tag cannot be found (Optional)
sl@0: 	 *
sl@0: 	 * @return The parsed integer value, or zero.
sl@0: 	 */
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC8& aBuf, const TDesC8& aStart, const TDesC8& aEnd, TInt& aPos, TInt& aError);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC16& aBuf, const TDesC16& aStart, const TDesC16& aEnd, TInt& aPos, TInt& aError);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC& aBuf, const TDesC& aStart, TInt& aPos);
sl@0: 	IMPORT_C static TUint ParseIntElement(const TDesC& aBuf,  const TDesC& aStart, TInt& aPos, TInt& aError);
sl@0: 	/*
sl@0: 	Searches the list of standard error codes (e32err.h 0 to -46) finding the matching error code for the string 
sl@0: 
sl@0: 	Parameters
sl@0: 	const TDesC& aResult  	[IN] - Error code string to be searched from
sl@0: 	TInt &aError 	 		[OUT] - Matching error code if found
sl@0: 
sl@0: 	Returns
sl@0: 	TBool			- True if error code was found, False if it was not
sl@0: 	*/
sl@0: 	IMPORT_C static TBool GetExpectedResultL(const TDesC& aResult /*in*/, TInt &aError /*out*/);
sl@0: 	/*
sl@0: 	Searches the list of standard error codes (e32err.h 0 to -46) finding the matching text representaion of the error code
sl@0: 
sl@0: 	Parameters
sl@0: 	 TInt &aError 	 	[IN] - Error code to return the string of
sl@0: 	HBufC*& aResult   	[OUT] -Reference to a pointer, pointing to the error string of the matching error code (Dont forget to free it)
sl@0: 
sl@0: 	Returns
sl@0: 	TBool			- True if error code was found, False if it was not
sl@0: 	*/
sl@0: 	IMPORT_C static TBool GetExpectedResultL(const TInt &aError /*in*/, HBufC*& aResult /*out*/);
sl@0: 	/*
sl@0: 	Parses the parameters aBuf to find the section of the script within parameters aStart and aEnd, 
sl@0: 	then allocs the required memory and places a copy of this section in aMember
sl@0: 	use these if you want the result copied into a new area of memory to use, for example when
sl@0: 	stored a member data
sl@0: 
sl@0: 	Parameters
sl@0: 	HBufC*& aMember		[OUT] - Reference to a pointer that will point to a copy of the section of aBuf 
sl@0: 	const TDesC& aBuf	[IN] - Buffer to search
sl@0: 	const TDesC& aStart	[IN] - Start tag t be searched for
sl@0: 	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: 	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: 	TInt& aError		[OUT]- (Optional) Returns negative number if start tag cannot be found (Optional)
sl@0: 
sl@0: 	Returns
sl@0: 	TPtrC		- Returns a TPtr to the position in the buffer between the start and 
sl@0: 	end tags
sl@0: 	*/
sl@0: 	IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf, 
sl@0: 		const TDesC& aStart);
sl@0: 	IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf, 
sl@0: 		const TDesC& aStart);
sl@0: 	IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,
sl@0: 		const TDesC& aStart, TInt& aPos);
sl@0: 	IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,
sl@0: 		const TDesC& aStart, TInt& aPos);
sl@0: 	IMPORT_C static void ParseElementL(HBufC*& aMember, const TDesC& aBuf,  
sl@0: 		const TDesC& aStart, TInt& aPos, TInt& aError);
sl@0: 	IMPORT_C static void ParseElementL(HBufC8*& aMember, const TDesC& aBuf,  
sl@0: 		const TDesC& aStart, TInt& aPos, TInt& aError);
sl@0: 	/*
sl@0: 	Reads an entire file into memory into a HBuf8
sl@0: 
sl@0: 	Parameters
sl@0: 	const TDesC& aFilename 	[IN] - Name of file to read
sl@0: 	const TDesC& aPath		[IN] - (Optional) Path of file, if aPath is missing the path is taken from aFilename
sl@0: 	RFs &aFs				[IN] - Reference to the file system handle class
sl@0: 
sl@0: 	Returns
sl@0: 	HBufC8*		-  Pointer to the 8 bit file data
sl@0: 	*/
sl@0: 	IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, RFs& aFs);
sl@0: 	IMPORT_C static HBufC8* ReadFileL(const TDesC& aFilename, const TDesC& aPath, RFs& aFs);
sl@0: 	IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, RFs& aFs);
sl@0: 	IMPORT_C static HBufC8* ReadFileLC(const TDesC& aFilename, const TDesC& aPath, RFs& aFS);
sl@0: 	/*
sl@0: 	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: 
sl@0: 	Parameters
sl@0: 	const TDesC& aFilename 	[IN] - Name of file including path to read
sl@0: 	RFs &aFs			[IN] - Reference to the file system handle class
sl@0: 
sl@0: 	Returns
sl@0: 	HBufC8*		-  Pointer to the 8 bit file data
sl@0: 	*/
sl@0: 	IMPORT_C static HBufC8* ReadHexFileLC(const TDesC& aFilename, RFs& aFs);
sl@0: 	/**
sl@0: 	 * This function reads an entire Unicode file and returns it as an HBufC.
sl@0: 	 * This function only works for Unicode builds of EPOC.
sl@0: 	 */
sl@0: 	IMPORT_C static HBufC* ReadFile16LC(const TDesC& aFilename, RFs& aFS);
sl@0: 	/*
sl@0: 	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: 	For instance, if the aBuf argument is <StartTag>abc<EndTag><StartTag>xyz<EndTag>,  then aElements will contain 2 elements: abc and xyz.
sl@0: 
sl@0: 	const TDesC& aBuf	[IN] - Buffer to search
sl@0: 	const TDesC& aStart	[IN] - Start tag to be searched for
sl@0: 	const TDesC& aEnd   [IN]- End tag t be searched for
sl@0: 	RPointerArray<HBufC>& aElements [OUT] - Array of sections found
sl@0: 	TInt& aPos		[IN/OUT]- Position in buffer to start searching, this will be updated with the position after the search
sl@0: 
sl@0: 	Returns
sl@0: 	None
sl@0: 	 */
sl@0: 	IMPORT_C static void ParseElementListL(const TDesC& aBuf, const TDesC& aStart, const TDesC& aEnd, 
sl@0: 		RPointerArray<HBufC>& aElements, TInt& aPos);
sl@0: 
sl@0: 	
sl@0: 	/**
sl@0: 	 * Parse a string containg a capability name.
sl@0: 	 * @leave KErrArgument If the string is not a recognised capability name.
sl@0: 	 */
sl@0: 	IMPORT_C static TCapability ParseCapabilityNameL(const TDesC8& aName);
sl@0: 	
sl@0: 	/**
sl@0: 	 * Parse a section of script file describing a capability set.
sl@0: 	 * 
sl@0: 	 * The script contains zero or more capabilities contained in <capability>
sl@0: 	 * tags.
sl@0: 	 */
sl@0: 	IMPORT_C static void ParseCapabilitySetL(const TDesC8& aIn, TCapabilitySet& aOut);
sl@0: 
sl@0: 	/**
sl@0: 	 * Parse a section of script file describing a security policy.
sl@0: 	 * 
sl@0: 	 * The script contains zero or more capabilities contained in <capability>
sl@0: 	 * tags.
sl@0: 	 */
sl@0: 	IMPORT_C static void ParseSecurityPolicyL(const TDesC8& aIn, TSecurityPolicy& aOut);
sl@0: 	
sl@0: 	};
sl@0: 
sl@0: #endif