#include <e32std.h>
| class TLex16 |
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.
See also: TLex
| IMPORT_C | TLex16 | ( | ) |
Default cosntructor.
Constructs a TLex16, initialising its members to NULL.
| 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.
| Parameter | Description |
|---|---|
| aString | String to be assigned. |
| 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.
| Parameter | Description |
|---|---|
| aDes | Descriptor to be assigned by reference. |
| IMPORT_C void | Assign | ( | const TUint16 * | aString | ) |
Assigns a string to this object from another string.
| Parameter | Description |
|---|---|
| aString | A pointer to a string to be assigned. |
| IMPORT_C void | Assign | ( | const TDesC16 & | aDes | ) |
Assigns a string to this object from a descriptor.
| Parameter | Description |
|---|---|
| aDes | The descriptor to be assigned. |
Parses the string to extract a 32-bit signed integer, and checks that it is within the specified limit.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aLimit | The 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.
Parses the string to extract a 64-bit signed integer, and checks that it is within the specified limit.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aLimit | The 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The radix to use when converting the number. |
| aLimit | The 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The radix to use when converting the number. |
| aLimit | The 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.
| 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.
| IMPORT_C TChar | Get | ( | ) |
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.
| IMPORT_C void | Inc | ( | ) |
Increments to the next character position.
| IMPORT_C void | Inc | ( | TInt | aNumber | ) |
Increments the next character position by aNumber.
| Parameter | Description |
|---|---|
| aNumber | The number of characters to increment the next character position by. |
| void | Mark | ( | TLexMark16 & | aMark | ) | const [inline] |
Sets the supplied extraction mark to the TLex16's next character position.
| Parameter | Description |
|---|---|
| aMark | On return, set to the next character position. |
| TInt | MarkedOffset | ( | ) | const [inline] |
Gets the offset of the extraction mark from the start of the string.
Returns: The offset of the extraction mark.
| IMPORT_C TInt | MarkedOffset | ( | const TLexMark16 | aMark | ) | const |
Gets the offset of the specified extraction mark from the start of the string.
| Parameter | Description |
|---|---|
| aMark | Extraction mark. |
Returns: The offset of the extraction mark.
| IMPORT_C TPtrC16 | MarkedToken | ( | ) | const |
Extracts the marked token.
Note that the function assumes that the current extraction mark is valid.
Returns: Extracted token.
| IMPORT_C TPtrC16 | MarkedToken | ( | const TLexMark16 | aMark | ) | const |
Extracts the token, starting at the specified mark
| Parameter | Description |
|---|---|
| aMark | Extraction mark indicating the start of the token. |
Returns: Extracted token.
| IMPORT_C TPtrC16 | NextToken | ( | ) |
Strips any white space and extracts the next token.
Returns: Extracted token.
| IMPORT_C TInt | Offset | ( | ) | const |
Gets the offset of the next character position from the start of the string.
Returns: Offset of next character position.
| IMPORT_C TChar | Peek | ( | ) | const |
Shows the next character to be returned by Get().
See also: TLex16::Get
Returns: Character to be returned by the next call to Get(). 0 if at the end of the string.
| IMPORT_C TPtrC16 | Remainder | ( | ) | const |
Gets a descriptor containing all the text from the next character position to the end of the string.
Returns: Text from the next character position onwards.
| 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.
Returns: Text from the extraction mark onwards.
| 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.
| Parameter | Description |
|---|---|
| aMark | Extraction mark indicating where remaining text starts. |
Returns: Text from the specified extraction mark onwards.
| void | SkipAndMark | ( | TInt | aNumber | ) | [inline] |
Moves the next character position a specified number of characters.
| Parameter | Description |
|---|---|
| aNumber | Number of characters to skip. |
| 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.
| Parameter | Description |
|---|---|
| aNumber | Number of characters to skip. |
| aMark | On return, set to the next character position. |
| 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.
| IMPORT_C void | SkipSpace | ( | ) |
Moves the next character position past any white space (space or separator).
Stops if at the end of string.
| 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.
| Parameter | Description |
|---|---|
| aMark | On return, contains a reference to the next character position. |
| 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.
| 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.
| IMPORT_C TInt | TokenLength | ( | const TLexMark16 | aMark | ) | const |
Gets the length of the token starting at the specified extraction mark.
| Parameter | Description |
|---|---|
| aMark | Extraction mark indicating the start of the token. |
Returns: Length of the token.
| IMPORT_C void | UnGet | ( | ) |
Decrements the next character position, allowing the previously "got" character to be re-read.
| void | UnGetToMark | ( | ) | [inline] |
Sets the next character position to the current extraction mark position.
| IMPORT_C void | UnGetToMark | ( | const TLexMark16 | aMark | ) |
Sets the next character position to the supplied extraction mark position.
| Parameter | Description |
|---|---|
| aMark | Mark to copy to the next character position. |
Parses the string to extract a signed 8-bit integer.
| Parameter | Description |
|---|---|
| aVal | On 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.
Parses the string to extract a signed 16-bit integer.
| Parameter | Description |
|---|---|
| aVal | On 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.
Parses the string to extract a signed 32-bit integer.
| Parameter | Description |
|---|---|
| aVal | On 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.
Parses the string to extract a signed 64-bit integer.
| Parameter | Description |
|---|---|
| aVal | On 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.
Parses the string to extract a signed integer.
| Parameter | Description |
|---|---|
| aVal | On 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The 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.
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.
| Parameter | Description |
|---|---|
| aVal | On return, contains the extracted integer. |
| aRadix | The 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.
Parses the string to extract an unsigned integer, using the specified radix.
| Parameter | Description |
|---|---|
| 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. |
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.