TLex16 Class Reference

#include <e32std.h>

class TLex16

Public Member Functions
	TLex16()
	TLex16(const TUint16 *)
	TLex16(const TDesC16 &)
void	Assign(const TLex16 &)
IMPORT_C void	Assign(const TUint16 *)
IMPORT_C void	Assign(const TDesC16 &)
IMPORT_C TInt	BoundedVal(TInt32 &, TInt)
IMPORT_C TInt	BoundedVal(TInt64 &, const TInt64 &)
IMPORT_C TInt	BoundedVal(TUint32 &, TRadix, TUint)
IMPORT_C TInt	BoundedVal(TInt64 &, TRadix, const TInt64 &)
TBool	Eos()
IMPORT_C TChar	Get()
IMPORT_C void	Inc()
IMPORT_C void	Inc(TInt)
void	Mark()
void	Mark(TLexMark16 &)
TInt	MarkedOffset()
IMPORT_C TInt	MarkedOffset(const TLexMark16)
IMPORT_C TPtrC16	MarkedToken()
IMPORT_C TPtrC16	MarkedToken(const TLexMark16)
IMPORT_C TPtrC16	NextToken()
IMPORT_C TInt	Offset()
IMPORT_C TChar	Peek()
IMPORT_C TPtrC16	Remainder()
IMPORT_C TPtrC16	RemainderFromMark()
IMPORT_C TPtrC16	RemainderFromMark(const TLexMark16)
void	SkipAndMark(TInt)
IMPORT_C void	SkipAndMark(TInt, TLexMark16 &)
IMPORT_C void	SkipCharacters()
IMPORT_C void	SkipSpace()
IMPORT_C void	SkipSpaceAndMark(TLexMark16 &)
void	SkipSpaceAndMark()
TInt	TokenLength()
IMPORT_C TInt	TokenLength(const TLexMark16)
IMPORT_C void	UnGet()
void	UnGetToMark()
IMPORT_C void	UnGetToMark(const TLexMark16)
IMPORT_C TInt	Val(TInt8 &)
IMPORT_C TInt	Val(TInt16 &)
IMPORT_C TInt	Val(TInt32 &)
IMPORT_C TInt	Val(TInt64 &)
TInt	Val(TInt &)
IMPORT_C TInt	Val(TUint8 &, TRadix)
IMPORT_C TInt	Val(TUint16 &, TRadix)
IMPORT_C TInt	Val(TUint32 &, TRadix)
IMPORT_C TInt	Val(TInt64 &, TRadix)
TInt	Val(TUint &, TRadix)
IMPORT_C TInt	Val(TReal32 &)
IMPORT_C TInt	Val(TReal32 &, TChar)
IMPORT_C TInt	Val(TReal64 &)
IMPORT_C TInt	Val(TReal64 &, TChar)
TInt	Val(TRealX &)
TInt	Val(TRealX &, TChar)
TInt	Val(TInt32 &, TInt)
TInt	Val(TInt64 &, const TInt64 &)
TInt	Val(TUint32 &, TRadix, TUint)
TInt	Val(TInt64 &, TRadix, const TInt64 &)
void	__DbgTest(TAny *)
void	__DbgTestInvariant()
TLex16 &	operator=(const TUint16 *)
TLex16 &	operator=(const TDesC16 &)

Detailed Description

Provides general string-parsing functions suitable for numeric format conversions and syntactical-element parsing.

The class is the 16-bit variant for Unicode strings and 16-bit wide characters.

An instance of this class stores a string, maintaining an extraction mark to indicate the current lexical element being analysed and a pointer to the next character to be examined.

Objects of this type are normally accessed through the build independent type TLex.

Constructor & Destructor Documentation

TLex16 ( )

IMPORT_C

TLex16

(

)

Default cosntructor.

Constructs a TLex16, initialising its members to NULL.

TLex16 ( const TUint16 * )

TLex16

(

const TUint16 *

aString

)

[inline]

Constructs the object with a pointer to a string.

The extraction mark and next character members are initialised to point to the start of the string.

Parameters
aString	String to be assigned.

TLex16 ( const TDesC16 & )

TLex16

(

const TDesC16 &

aDes

)

[inline]

Constructs the object with a descriptor.

The extraction mark and next character members are initialised to point to the start of the string.

Parameters
aDes	Descriptor to be assigned by reference.

Member Function Documentation

Assign ( const TLex16 & )

void

Assign

(

const TLex16 &

aLex

)

[inline]

Assigns a string to this object from another TLex16 object.

Parameters
aLex	The object to be assigned.

Assign ( const TUint16 * )

IMPORT_C void

Assign

(

const TUint16 *

aString

)

Assigns a string to this object from another string.

Parameters
aString	A pointer to a string to be assigned.

Assign ( const TDesC16 & )

IMPORT_C void

Assign

(

const TDesC16 &

aDes

)

Assigns a string to this object from a descriptor.

Parameters
aDes	The descriptor to be assigned.

BoundedVal ( TInt32 &, TInt )

IMPORT_C TInt	BoundedVal	(	TInt32 &	aVal,
			TInt	aLimit
		)

Parses the string to extract a 32-bit signed integer, and checks that it is within the specified limit.

Parameters
aVal	On return, contains the extracted integer.
aLimit	The upper limit.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

BoundedVal ( TInt64 &, const TInt64 & )

IMPORT_C TInt	BoundedVal	(	TInt64 &	aVal,
			const TInt64 &	aLimit
		)

Parses the string to extract a 64-bit signed integer, and checks that it is within the specified limit.

Parameters
aVal	On return, contains the extracted integer.
aLimit	The upper limit.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

BoundedVal ( TUint32 &, TRadix, TUint )

IMPORT_C TInt	BoundedVal	(	TUint32 &	aVal,
			TRadix	aRadix,
			TUint	aLimit
		)

Parses the string to extract a 32-bit unsigned integer, using the specified radix, and checks that it is within the specified limit.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.
aLimit	The upper limit.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

BoundedVal ( TInt64 &, TRadix, const TInt64 & )

IMPORT_C TInt	BoundedVal	(	TInt64 &	aVal,
			TRadix	aRadix,
			const TInt64 &	aLimit
		)

Parses the string to extract a 64-bit signed integer, using the specified radix, and checks that it is within the specified limit.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.
aLimit	The upper limit.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Eos ( )

TBool

Eos

(

)

const [inline]

Tests whether the next character position is at the end of the string.

Return Value: True if at end of string, false otherwise.

Get ( )

IMPORT_C TChar

Get

(

)

Gets the next character in the string and increments the next character position.

Return Value: Next character to be read. 0 if at the end of the string.

Inc ( )

IMPORT_C void

Inc

(

)

Increments to the next character position.

Panic Codes
USER	65, if the increment puts the next character position before the start or beyond the end of the string.

Inc ( TInt )

IMPORT_C void

Inc

(

TInt

aNumber

)

Increments the next character position by aNumber.

Parameters
aNumber	The number of characters to increment the next character position by.

Panic Codes
USER	65, if the increment puts the next character position before the start or beyond the end of the string.

Mark ( )

void

Mark

(

)

[inline]

Sets the TLex16's next character position to its extraction mark.

Mark ( TLexMark16 & )

void

Mark

(

TLexMark16 &

aMark

)

const [inline]

Sets the supplied extraction mark to the TLex16's next character position.

Parameters
aMark	On return, set to the next character position.

MarkedOffset ( )

TInt

MarkedOffset

(

)

const [inline]

Gets the offset of the extraction mark from the start of the string.

Return Value: The offset of the extraction mark.

MarkedOffset ( const TLexMark16 )

IMPORT_C TInt

MarkedOffset

(

const TLexMark16

aMark

)

const

Gets the offset of the specified extraction mark from the start of the string.

Parameters
aMark	Extraction mark.

Return Value: The offset of the extraction mark.

Panic Codes
USER	68, if the specified mark is before the start or beyond the end of the string.

MarkedToken ( )

IMPORT_C TPtrC16

MarkedToken

(

)

const

Extracts the marked token.

Note that the function assumes that the current extraction mark is valid.

Return Value: Extracted token.

Panic Codes
USER	68, if the specified mark is before the start or beyond the end of the string.

MarkedToken ( const TLexMark16 )

IMPORT_C TPtrC16

MarkedToken

(

const TLexMark16

aMark

)

const

Extracts the token, starting at the specified mark

Parameters
aMark	Extraction mark indicating the start of the token.

Return Value: Extracted token.

Panic Codes
USER	68, if the specified mark is before the start or beyond the end of the string.

NextToken ( )

IMPORT_C TPtrC16

NextToken

(

)

Strips any white space and extracts the next token.

Return Value: Extracted token.

Offset ( )

IMPORT_C TInt

Offset

(

)

const

Gets the offset of the next character position from the start of the string.

Return Value: Offset of next character position.

Peek ( )

IMPORT_C TChar

Peek

(

)

const

Shows the next character to be returned by Get().

Remainder ( )

IMPORT_C TPtrC16

Remainder

(

)

const

Gets a descriptor containing all the text from the next character position to the end of the string.

Return Value: Text from the next character position onwards.

Panic Codes
USER	17, if the value of (next character position - extraction mark) is negative.

RemainderFromMark ( )

IMPORT_C TPtrC16

RemainderFromMark

(

)

const

Gets a descriptor containing all the text from the extraction mark to the end of the string.

The function assumes that the current extraction mark is valid.

Return Value: Text from the extraction mark onwards.

RemainderFromMark ( const TLexMark16 )

IMPORT_C TPtrC16

RemainderFromMark

(

const TLexMark16

aMark

)

const

Gets a descriptor containing all the text from the specified extraction mark to the end of the string.

Parameters
aMark	Extraction mark indicating where remaining text starts.

Return Value: Text from the specified extraction mark onwards.

Panic Codes
USER	17, if the value of (next character position - extraction mark) is negative.
USER	68, if the specified mark is before the start or beyond the end of the string.

SkipAndMark ( TInt )

void

SkipAndMark

(

TInt

aNumber

)

[inline]

Moves the next character position a specified number of characters.

Parameters
aNumber	Number of characters to skip.

Panic Codes
USER	68, if the skip moves the next character position either to before the start or beyond the end of the string.

SkipAndMark ( TInt, TLexMark16 & )

IMPORT_C void	SkipAndMark	(	TInt	aNumber,
			TLexMark16 &	aMark
		)

Moves the next character position a specified number of characters and copies it to the specified extraction mark.

Parameters
aNumber	Number of characters to skip.
aMark	On return, set to the next character position.

Panic Codes
USER	66, if the skip moves the next character position either to before the start or beyond the end of the string.

SkipCharacters ( )

IMPORT_C void

SkipCharacters

(

)

Moves the next character position to the next white space (space or separator).

Stops if at the end of the string.

SkipSpace ( )

IMPORT_C void

SkipSpace

(

)

Moves the next character position past any white space (space or separator).

Stops if at the end of string.

SkipSpaceAndMark ( TLexMark16 & )

IMPORT_C void

SkipSpaceAndMark

(

TLexMark16 &

aMark

)

Moves the next character position past any white space and copies it to the specified extraction mark.

Stops if at the end of the string.

Parameters
aMark	On return, contains a reference to the next character position.

SkipSpaceAndMark ( )

void

SkipSpaceAndMark

(

)

[inline]

Moves the next character position past any white space and copies it to the TLex16's extraction mark.

Stops if at the end of the string.

TokenLength ( )

TInt

TokenLength

(

)

const [inline]

Gets the length of the token.

This is the difference between the next character position and the extraction mark.

Return Value: Length of the token.

TokenLength ( const TLexMark16 )

IMPORT_C TInt

TokenLength

(

const TLexMark16

aMark

)

const

Gets the length of the token starting at the specified extraction mark.

Parameters
aMark	Extraction mark indicating the start of the token.

Return Value: Length of the token.

Panic Codes
USER	68, if the specified mark is before the start or beyond the end of the string.

UnGet ( )

IMPORT_C void

UnGet

(

)

Decrements the next character position, allowing the previously "got" character to be re-read.

Panic Codes
USER	64, if the previous character is before the start of the string.

UnGetToMark ( )

void

UnGetToMark

(

)

[inline]

Sets the next character position to the current extraction mark position.

Panic Codes
USER	68, if the specified mark is before the start or beyond the end of the string.

UnGetToMark ( const TLexMark16 )

IMPORT_C void

UnGetToMark

(

const TLexMark16

aMark

)

Sets the next character position to the supplied extraction mark position.

Parameters
aMark	Mark to copy to the next character position.

Panic Codes
USER	68, if the extraction mark is before the start or beyond the end of the string.

Val ( TInt8 & )

IMPORT_C TInt

Val

(

TInt8 &

aVal

)

Parses the string to extract a signed 8-bit integer.

Parameters
aVal	On return, contains the extracted integer.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TInt16 & )

IMPORT_C TInt

Val

(

TInt16 &

aVal

)

Parses the string to extract a signed 16-bit integer.

Parameters
aVal	On return, contains the extracted integer.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TInt32 & )

IMPORT_C TInt

Val

(

TInt32 &

aVal

)

Parses the string to extract a signed 32-bit integer.

Parameters
aVal	On return, contains the extracted integer.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TInt64 & )

IMPORT_C TInt

Val

(

TInt64 &

aVal

)

Parses the string to extract a signed 64-bit integer.

Parameters
aVal	On return, contains the extracted integer.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TInt & )

TInt

Val

(

TInt &

aVal

)

[inline]

Parses the string to extract a signed integer.

Parameters
aVal	On return, contains the extracted integer.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TUint8 &, TRadix )

IMPORT_C TInt	Val	(	TUint8 &	aVal,
			TRadix	aRadix
		)

Parses the string to extract an 8-bit unsigned integer, using the specified radix.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TUint16 &, TRadix )

IMPORT_C TInt	Val	(	TUint16 &	aVal,
			TRadix	aRadix
		)

Parses the string to extract a 16-bit unsigned integer, using the specified radix.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TUint32 &, TRadix )

IMPORT_C TInt	Val	(	TUint32 &	aVal,
			TRadix	aRadix
		)

Parses the string to extract a 32-bit unsigned integer, using the specified radix.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TInt64 &, TRadix )

IMPORT_C TInt	Val	(	TInt64 &	aVal,
			TRadix	aRadix
		)

Parses the string to extract a 64-bit integer (treated as unsigned), using the specified radix.

The specified radix is one of binary, octal, decimal, or hexadecimal.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TUint &, TRadix )

TInt	Val	(	TUint &	aVal,
			TRadix	aRadix = EDecimal
		)	[inline]

Parses the string to extract an unsigned integer, using the specified radix.

Parameters
aVal	On return, contains the extracted integer.
aRadix	The radix to use when converting the number. The default radix for this function overload is decimal.

Return Value: KErrNone if successful. KErrGeneral if the next character position is initially at the end of the string or no valid characters found initially. KErrOverflow if there is sign overflow, i.e. converted value greater than limit. If error codes KErrGeneral or KErrOverflow are returned, the object's members are left unaltered.

Val ( TReal32 & )

IMPORT_C TInt

Val

(

TReal32 &

aVal

)

Val ( TReal32 &, TChar )

IMPORT_C TInt	Val	(	TReal32 &	aVal,
			TChar	aPoint
		)

Val ( TReal64 & )

IMPORT_C TInt

Val

(

TReal64 &

aVal

)

Val ( TReal64 &, TChar )

IMPORT_C TInt	Val	(	TReal64 &	aVal,
			TChar	aPoint
		)

Val ( TRealX & )

TInt

Val

(

TRealX &

aVal

)

Val ( TRealX &, TChar )

TInt	Val	(	TRealX &	aVal,
			TChar	aPoint
		)

Val ( TInt32 &, TInt )

TInt	Val	(	TInt32 &	aVal,
			TInt	aLimit
		)	[inline]

DeprecatedUse BoundedVal(TInt32& aVal,TInt aLimit)

Val ( TInt64 &, const TInt64 & )

TInt	Val	(	TInt64 &	aVal,
			const TInt64 &	aLimit
		)	[inline]

DeprecatedUse BoundedVal(TInt64& aVal,const TInt64& aLimit)

Val ( TUint32 &, TRadix, TUint )

TInt	Val	(	TUint32 &	aVal,
			TRadix	aRadix,
			TUint	aLimit
		)	[inline]

DeprecatedUse BoundedVal(TUint32& aVal,TRadix aRadix,TUint aLimit)

Val ( TInt64 &, TRadix, const TInt64 & )

TInt	Val	(	TInt64 &	aVal,
			TRadix	aRadix,
			const TInt64 &	aLimit
		)	[inline]

DeprecatedUse BoundedVal(TInt64& aVal,TRadix aRadix,const TInt64& aLimit)

__DbgTest ( TAny * )

void

__DbgTest

(

TAny *

aPtr

)

const

__DbgTestInvariant ( )

void

__DbgTestInvariant

(

)

const

operator= ( const TUint16 * )

TLex16 &

operator=

(

const TUint16 *

aString

)

[inline]

Allows strings to be assigned to a TLex16.

Parameters
aString	String to be assigned to the TLex16.

Return Value: TLex16 descriptor.

operator= ( const TDesC16 & )

TLex16 &

operator=

(

const TDesC16 &

aDes

)

[inline]

Allows descriptors to be assigned to a TLex16.

Parameters
aDes	Descriptor to be assigned to the TLex16.

Return Value: TLex8 descriptor.