TLex8 Class Reference

#include <e32std.h>

class TLex8
Public Member Functions
TLex8()
TLex8(const TUint8 *)
TLex8(const TDesC8 &)
voidAssign(const TLex8 &)
IMPORT_C voidAssign(const TUint8 *)
IMPORT_C voidAssign(const TDesC8 &)
IMPORT_C TIntBoundedVal(TInt32 &, TInt)
IMPORT_C TIntBoundedVal(TInt64 &, const TInt64 &)
IMPORT_C TIntBoundedVal(TUint32 &, TRadix, TUint)
IMPORT_C TIntBoundedVal(TInt64 &, TRadix, const TInt64 &)
TBool Eos()
IMPORT_C TCharGet()
IMPORT_C voidInc()
IMPORT_C voidInc(TInt)
voidMark(TLexMark8 &)
voidMark()
TInt MarkedOffset()
IMPORT_C TIntMarkedOffset(const TLexMark8)
IMPORT_C TPtrC8MarkedToken()
IMPORT_C TPtrC8MarkedToken(const TLexMark8)
IMPORT_C TPtrC8NextToken()
IMPORT_C TIntOffset()
IMPORT_C TCharPeek()
IMPORT_C TPtrC8Remainder()
IMPORT_C TPtrC8RemainderFromMark()
IMPORT_C TPtrC8RemainderFromMark(const TLexMark8)
voidSkipAndMark(TInt)
IMPORT_C voidSkipAndMark(TInt, TLexMark8 &)
IMPORT_C voidSkipCharacters()
IMPORT_C voidSkipSpace()
voidSkipSpaceAndMark()
IMPORT_C voidSkipSpaceAndMark(TLexMark8 &)
TInt TokenLength()
IMPORT_C TIntTokenLength(const TLexMark8)
IMPORT_C voidUnGet()
voidUnGetToMark()
IMPORT_C voidUnGetToMark(const TLexMark8)
IMPORT_C TIntVal(TInt8 &)
IMPORT_C TIntVal(TInt16 &)
IMPORT_C TIntVal(TInt32 &)
IMPORT_C TIntVal(TInt64 &)
TInt Val(TInt &)
IMPORT_C TIntVal(TUint8 &, TRadix)
IMPORT_C TIntVal(TUint16 &, TRadix)
IMPORT_C TIntVal(TUint32 &, TRadix)
IMPORT_C TIntVal(TInt64 &, TRadix)
TInt Val(TUint &, TRadix)
IMPORT_C TIntVal(TReal32 &)
IMPORT_C TIntVal(TReal32 &, TChar)
IMPORT_C TIntVal(TReal64 &)
IMPORT_C TIntVal(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 &)
TLex8 &operator=(const TUint8 *)
TLex8 &operator=(const TDesC8 &)

Detailed Description

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

The class is the 8-bit variant for non-Unicode strings and 8-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.

See also: TLex

Constructor & Destructor Documentation

TLex8 ( )

IMPORT_CTLex8()

Default constructor.

Constructs a TLex8, initialising its members to NULL.

TLex8 ( const TUint8 * )

TLex8(const TUint8 *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.

ParameterDescription
aStringString to be assigned.

TLex8 ( const TDesC8 & )

TLex8(const TDesC8 &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.

ParameterDescription
aDesDescriptor to be assigned by reference.

Member Function Documentation

Assign ( const TLex8 & )

voidAssign(const TLex8 &aLex)[inline]

Assigns a string to this object from another TLex8 object.

ParameterDescription
aLexThe object to be assigned.

Assign ( const TUint8 * )

IMPORT_C voidAssign(const TUint8 *aString)

Assigns a string to this object from another string.

ParameterDescription
aStringA pointer to a string to be assigned.

Assign ( const TDesC8 & )

IMPORT_C voidAssign(const TDesC8 &aDes)

Assigns a string to this object from a descriptor.

ParameterDescription
aDesThe descriptor to be assigned.

BoundedVal ( TInt32 &, TInt )

IMPORT_C TIntBoundedVal(TInt32 &aVal,
TIntaLimit
)

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

ParameterDescription
aValOn return, contains the extracted integer.
aLimitThe upper limit.

Returns: 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 TIntBoundedVal(TInt64 &aVal,
const TInt64 &aLimit
)

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

ParameterDescription
aValOn return, contains the extracted integer.
aLimitThe upper limit.

Returns: 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 TIntBoundedVal(TUint32 &aVal,
TRadixaRadix,
TUintaLimit
)

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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.
aLimitThe upper limit.

Returns: 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 TIntBoundedVal(TInt64 &aVal,
TRadixaRadix,
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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.
aLimitThe upper limit.

Returns: 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.

Returns: True if at end of string, false otherwise.

Get ( )

IMPORT_C TCharGet()

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

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

Inc ( )

IMPORT_C voidInc()

Increments to the next character position.

panic
USER 60, if the increment puts the next character position beyond the end of the string.

Inc ( TInt )

IMPORT_C voidInc(TIntaNumber)

Increments the next character position by aNumber.

panic
USER 60, if the increment puts the next character position before the start or beyond the end of the string.
ParameterDescription
aNumberThe number of characters to increment the next character position by.

Mark ( TLexMark8 & )

voidMark(TLexMark8 &aMark)const [inline]

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

ParameterDescription
aMarkOn return, this is set to the next character position.

Mark ( )

voidMark()[inline]

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

MarkedOffset ( )

TInt MarkedOffset()const [inline]

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

Returns: The offset of the extraction mark.

MarkedOffset ( const TLexMark8 )

IMPORT_C TIntMarkedOffset(const TLexMark8aMark)const

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

panic
USER 63, if the specified mark is before the start or beyond the end of the string.
ParameterDescription
aMarkExtraction mark.

Returns: The offset of the extraction mark.

MarkedToken ( )

IMPORT_C TPtrC8MarkedToken()const

Extracts the marked token.

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

panic
USER 63, if the specified mark is before the start or beyond the end of the string.

Returns: Extracted token.

MarkedToken ( const TLexMark8 )

IMPORT_C TPtrC8MarkedToken(const TLexMark8aMark)const

Extracts the token, starting at the specified mark

panic
USER 63, if the specified mark is before the start or beyond the end of the string.
ParameterDescription
aMarkExtraction mark indicating the start of the token.

Returns: Extracted token.

NextToken ( )

IMPORT_C TPtrC8NextToken()

Strips any white space and extracts the next token.

Returns: Extracted token.

Offset ( )

IMPORT_C TIntOffset()const

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

Returns: Offset of next character position.

Peek ( )

IMPORT_C TCharPeek()const

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

See also: TLex8::Get

Returns: Character to be returned by the next call to Get(). 0 if at the end of the string.

Remainder ( )

IMPORT_C TPtrC8Remainder()const

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

panic
USER 29, if the value of (next character position - extraction mark) is negative.

Returns: Text from the next character position onwards.

RemainderFromMark ( )

IMPORT_C TPtrC8RemainderFromMark()const

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

The function assumes that the current extraction mark is valid.

Returns: Text from the extraction mark onwards.

RemainderFromMark ( const TLexMark8 )

IMPORT_C TPtrC8RemainderFromMark(const TLexMark8aMark)const

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

panic
USER 29, if the value of (next character position - extraction mark) is negative.
panic
USER 63, if the specified mark is before the start or beyond the end of the string.
ParameterDescription
aMarkExtraction mark indicating where remaining text starts.

Returns: Text from the specified extraction mark onwards.

SkipAndMark ( TInt )

voidSkipAndMark(TIntaNumber)[inline]

Moves the next character position a specified number of characters.

panic
USER 61, if the skip moves the next character position either to before the start or beyond the end of the string.
ParameterDescription
aNumberNumber of characters to skip.

SkipAndMark ( TInt, TLexMark8 & )

IMPORT_C voidSkipAndMark(TIntaNumber,
TLexMark8 &aMark
)

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

panic
USER 61, if the skip moves the next character position either to before the start or beyond the end of the string.
ParameterDescription
aNumberNumber of characters to skip.
aMarkOn return, set to the next character position.

SkipCharacters ( )

IMPORT_C voidSkipCharacters()

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

Stops if at the end of the string.

SkipSpace ( )

IMPORT_C voidSkipSpace()

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

Stops if at the end of string.

SkipSpaceAndMark ( )

voidSkipSpaceAndMark()[inline]

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

Stops if at the end of the string.

SkipSpaceAndMark ( TLexMark8 & )

IMPORT_C voidSkipSpaceAndMark(TLexMark8 &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.

ParameterDescription
aMarkOn return, contains a reference to the next character position.

TokenLength ( )

TInt TokenLength()const [inline]

Gets the length of the token.

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

Returns: Length of the token.

TokenLength ( const TLexMark8 )

IMPORT_C TIntTokenLength(const TLexMark8aMark)const

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

panic
USER 63, if the specified mark is before the start or beyond the end of the string.
ParameterDescription
aMarkExtraction mark indicating the start of the token.

Returns: Length of the token.

UnGet ( )

IMPORT_C voidUnGet()

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

panic
USER 59, if the previous character is before the start of the string.

UnGetToMark ( )

voidUnGetToMark()[inline]

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

panic
USER 63, if the extraction mark is before the start or beyond the end of the string.

UnGetToMark ( const TLexMark8 )

IMPORT_C voidUnGetToMark(const TLexMark8aMark)

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

panic
USER 63, if the extraction mark is before the start or beyond the end of the string.
ParameterDescription
aMarkMark to copy to the next character position.

Val ( TInt8 & )

IMPORT_C TIntVal(TInt8 &aVal)

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

ParameterDescription
aValOn return, contains the extracted integer.

Returns: 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 TIntVal(TInt16 &aVal)

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

ParameterDescription
aValOn return, contains the extracted integer.

Returns: 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 TIntVal(TInt32 &aVal)

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

ParameterDescription
aValOn return, contains the extracted integer.

Returns: 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 TIntVal(TInt64 &aVal)

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

ParameterDescription
aValOn return, contains the extracted integer.

Returns: 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.

ParameterDescription
aValOn return, contains the extracted integer.

Returns: 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 TIntVal(TUint8 &aVal,
TRadixaRadix
)

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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.

Returns: 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 TIntVal(TUint16 &aVal,
TRadixaRadix
)

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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.

Returns: 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 TIntVal(TUint32 &aVal,
TRadixaRadix
)

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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.

Returns: 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 TIntVal(TInt64 &aVal,
TRadixaRadix
)

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.

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number.

Returns: 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,
TRadixaRadix = EDecimal
)[inline]

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

ParameterDescription
aValOn return, contains the extracted integer.
aRadixThe radix to use when converting the number. The default radix for this function overload is decimal.

Returns: 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 TIntVal(TReal32 &aVal)

Val ( TReal32 &, TChar )

IMPORT_C TIntVal(TReal32 &aVal,
TCharaPoint
)

Val ( TReal64 & )

IMPORT_C TIntVal(TReal64 &aVal)

Val ( TReal64 &, TChar )

IMPORT_C TIntVal(TReal64 &aVal,
TCharaPoint
)

Val ( TRealX & )

TInt Val(TRealX &aVal)

Val ( TRealX &, TChar )

TInt Val(TRealX &aVal,
TCharaPoint
)

Val ( TInt32 &, TInt )

Val ( TInt64 &, const TInt64 & )

Val ( TUint32 &, TRadix, TUint )

Val ( TInt64 &, TRadix, const TInt64 & )

operator= ( const TUint8 * )

TLex8 &operator=(const TUint8 *aString)[inline]

Allows strings to be assigned to a TLex8.

ParameterDescription
aStringString to be assigned to the TLex8.

Returns: TLex8 descriptor.

operator= ( const TDesC8 & )

TLex8 &operator=(const TDesC8 &aDes)[inline]

Allows descriptors to be assigned to a TLex8.

ParameterDescription
aDesDescriptor to be assigned to the TLex8.

Returns: TLex8 descriptor.