Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members   Search  

UParseError Struct Reference

A UParseError struct is used to returned detailed information about parsing errors. More...

#include <parseerr.h>

List of all members.

Public Attributes

int32_t line
 The line on which the error occured. More...

int32_t offset
 The character offset to the error. More...

UChar preContext [U_PARSE_CONTEXT_LEN]
 Textual context before the error. More...

UChar postContext [U_PARSE_CONTEXT_LEN]
 Textual context after the error. More...


Detailed Description

A UParseError struct is used to returned detailed information about parsing errors.

It is used by ICU parsing engines that parse long rules, patterns, or programs, where the text being parsed is long enough that more information than a UErrorCode is needed to localize the error.

The code field is an integer error code specific to each parsing engine, but globally unique. See the engine header file for possible values. The line, offset, and context fields are optional; parsing engines may choose not to use to use them.

Examples of engines which use UParseError (or may use it in the future) are RuleBasedTransliterator and RuleBasedBreakIterator.

Stable:
ICU 2.0

Definition at line 40 of file parseerr.h.


Member Data Documentation

int32_t UParseError::line
 

The line on which the error occured.

If the parse engine is not using this field, it should set it to zero. Otherwise it should be a positive integer. The default value of this field is -1. It will be set to 0 if the code populating this struct is not using line numbers.

Stable:
ICU 2.0

Definition at line 63 of file parseerr.h.

int32_t UParseError::offset
 

The character offset to the error.

If the line field is being used, then this offset is from the start of the line. If the line field is not being used, then this offset is from the start of the text.The default value of this field is -1. It will be set to appropriate value by the code that populating the struct.

Stable:
ICU 2.0

Definition at line 74 of file parseerr.h.

UChar UParseError::postContext[U_PARSE_CONTEXT_LEN]
 

Textual context after the error.

Null-terminated. May be the empty string if not implemented by parser.

Stable:
ICU 2.0

Definition at line 88 of file parseerr.h.

UChar UParseError::preContext[U_PARSE_CONTEXT_LEN]
 

Textual context before the error.

Null-terminated. May be the empty string if not implemented by parser.

Stable:
ICU 2.0

Definition at line 81 of file parseerr.h.


The documentation for this struct was generated from the following file:
Generated on Mon Nov 24 14:37:09 2003 for ICU 2.8 by doxygen1.2.11.1 written by Dimitri van Heesch, © 1997-2001