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

_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 code
 An integer indicating the type of error. More...

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

UTextOffset 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.

Definition at line 37 of file parseerr.h.


Member Data Documentation

int32_t _UParseError::code
 

An integer indicating the type of error.

If no error was encountered, the parse engine sets this to zero, and the other fields' values should be ignored.

Each parse engine should use a range of codes from 0xNNNN0001 to 0xNNNNFFFF, where NNNN is a 16-bit integer between 0x0001 and 0xFFFF unique to each parse engine. Parse engines should define the enum PARSE_ERROR_BASE to be 0xNNNN0000.

Definition at line 50 of file parseerr.h.

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.

Definition at line 57 of file parseerr.h.

UTextOffset _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.

Definition at line 65 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.

Definition at line 77 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.

Definition at line 71 of file parseerr.h.


The documentation for this struct was generated from the following file:
Generated at Tue Jun 12 14:04:20 2001 for ICU 1.8.1 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000