ꦫꦣꦺꦤ꧀ꦄꦤ꧀ꦠꦱꦺꦤ

PATH: usr / include / unicode

/*
**********************************************************************
*   Copyright (C) 1999-2005, International Business Machines
*   Corporation and others.  All Rights Reserved.
**********************************************************************
*   Date        Name        Description
*   03/14/00    aliu        Creation.
*   06/27/00    aliu        Change from C++ class to C struct
**********************************************************************
*/
#ifndef PARSEERR_H
#define PARSEERR_H

#include "unicode/utypes.h"

/**
 * \file
 * \brief C API: Parse Error Information
 */
/**
 * The capacity of the context strings in UParseError.
 * @stable ICU 2.0
 */ 
enum { U_PARSE_CONTEXT_LEN = 16 };

/**
 * 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.
 *
 * <p>The line, offset, and context fields are optional; parsing
 * engines may choose not to use to use them.
 *
 * <p>The preContext and postContext strings include some part of the
 * context surrounding the error.  If the source text is "let for=7"
 * and "for" is the error (e.g., because it is a reserved word), then
 * some examples of what a parser might produce are the following:
 *
 * <pre>
 * preContext   postContext
 * ""           ""            The parser does not support context
 * "let "       "=7"          Pre- and post-context only
 * "let "       "for=7"       Pre- and post-context and error text
 * ""           "for"         Error text only
 * </pre>
 *
 * <p>Examples of engines which use UParseError (or may use it in the
 * future) are Transliterator, RuleBasedBreakIterator, and
 * RegexPattern.
 * 
 * @stable ICU 2.0
 */
typedef struct UParseError {

/**
     * The line on which the error occured.  If the parser uses this
     * field, it sets it to the line number of the source text line on
     * which the error appears, which will be be a value >= 1.  If the
     * parse does not support line numbers, the value will be <= 0.
     * @stable ICU 2.0
     */
    int32_t        line;

/**
     * The character offset to the error.  If the line field is >= 1,
     * then this is the offset from the start of the line.  Otherwise,
     * this is the offset from the start of the text.  If the parser
     * does not support this field, it will have a value < 0.
     * @stable ICU 2.0
     */
    int32_t        offset;

/**
     * Textual context before the error.  Null-terminated.  The empty
     * string if not supported by parser.
     * @stable ICU 2.0   
     */
    UChar          preContext[U_PARSE_CONTEXT_LEN];

/**
     * The error itself and/or textual context after the error.
     * Null-terminated.  The empty string if not supported by parser.
     * @stable ICU 2.0   
     */
    UChar          postContext[U_PARSE_CONTEXT_LEN];

} UParseError;

#endif

[-] tzrule.h [edit]
[-] utrans.h [edit]
[-] ucnv.h [edit]
[-] dtrule.h [edit]
[-] format.h [edit]
[-] uvernum.h [edit]
[-] utf32.h [edit]
[-] ubidi.h [edit]
[-] enumset.h [edit]
[-] normlzr.h [edit]
[-] measfmt.h [edit]
[-] ubrk.h [edit]
[-] upluralrules.h [edit]
[-] sortkey.h [edit]
[-] bytestrie.h [edit]
[-] fpositer.h [edit]
[-] utf_old.h [edit]
[-] tmutamt.h [edit]
[-] uconfig.h [edit]
[-] alphaindex.h [edit]
[-] vtzone.h [edit]
[-] locdspnm.h [edit]
[-] numsys.h [edit]
[-] simpletz.h [edit]
[-] tznames.h [edit]
[-] stringpiece.h [edit]
[-] parseerr.h [edit]
[-] ucsdet.h [edit]
[-] appendable.h [edit]
[+] ..
[-] dtptngen.h [edit]
[-] dtintrv.h [edit]
[-] resbund.h [edit]
[-] ptypes.h [edit]
[-] ustdio.h [edit]
[-] symtable.h [edit]
[-] ucnv_err.h [edit]
[-] utypes.h [edit]
[-] bytestream.h [edit]
[-] dtfmtsym.h [edit]
[-] unorm2.h [edit]
[-] udateintervalformat.h [edit]
[-] ucat.h [edit]
[-] usearch.h [edit]
[-] platform.h [edit]
[-] unum.h [edit]
[-] locid.h [edit]
[-] uversion.h [edit]
[-] regex.h [edit]
[-] strenum.h [edit]
[-] ucasemap.h [edit]
[-] utmscale.h [edit]
[-] decimfmt.h [edit]
[-] messagepattern.h [edit]
[-] brkiter.h [edit]
[-] ucurr.h [edit]
[-] uset.h [edit]
[-] tztrans.h [edit]
[-] udata.h [edit]
[-] currpinf.h [edit]
[-] datefmt.h [edit]
[-] rbbi.h [edit]
[-] parsepos.h [edit]
[-] rbtz.h [edit]
[-] ucnv_cb.h [edit]
[-] ucoleitr.h [edit]
[-] udat.h [edit]
[-] putil.h [edit]
[-] coll.h [edit]
[-] gender.h [edit]
[-] ucharstriebuilder.h [edit]
[-] unimatch.h [edit]
[-] currunit.h [edit]
[-] ugender.h [edit]
[-] colldata.h [edit]
[-] uchriter.h [edit]
[-] tmunit.h [edit]
[-] ulocdata.h [edit]
[-] timezone.h [edit]
[-] unirepl.h [edit]
[-] umisc.h [edit]
[-] tmutfmt.h [edit]
[-] ushape.h [edit]
[-] dtitvinf.h [edit]
[-] usetiter.h [edit]
[-] uniset.h [edit]
[-] listformatter.h [edit]
[-] umsg.h [edit]
[-] ustream.h [edit]
[-] ustringtrie.h [edit]
[-] icudataver.h [edit]
[-] bytestriebuilder.h [edit]
[-] bms.h [edit]
[-] uldnames.h [edit]
[-] uregex.h [edit]
[-] schriter.h [edit]
[-] uenum.h [edit]
[-] uclean.h [edit]
[-] bmsearch.h [edit]
[-] utf16.h [edit]
[-] normalizer2.h [edit]
[-] calendar.h [edit]
[-] udatpg.h [edit]
[-] unifunct.h [edit]
[-] dbbi.h [edit]
[-] utext.h [edit]
[-] uchar.h [edit]
[-] tzfmt.h [edit]
[-] urep.h [edit]
[-] uscript.h [edit]
[-] urename.h [edit]
[-] std_string.h [edit]
[-] choicfmt.h [edit]
[-] rep.h [edit]
[-] idna.h [edit]
[-] unorm.h [edit]
[-] dtitvfmt.h [edit]
[-] utrace.h [edit]
[-] uidna.h [edit]
[-] search.h [edit]
[-] uobject.h [edit]
[-] basictz.h [edit]
[-] dcfmtsym.h [edit]
[-] coleitr.h [edit]
[-] translit.h [edit]
[-] ures.h [edit]
[-] unistr.h [edit]
[-] udisplaycontext.h [edit]
[-] fmtable.h [edit]
[-] rbnf.h [edit]
[-] gregocal.h [edit]
[-] uiter.h [edit]
[-] umachine.h [edit]
[-] plurrule.h [edit]
[-] plurfmt.h [edit]
[-] ucnvsel.h [edit]
[-] curramt.h [edit]
[-] ucal.h [edit]
[-] measure.h [edit]
[-] utf8.h [edit]
[-] uspoof.h [edit]
[-] icuplug.h [edit]
[-] chariter.h [edit]
[-] stringtriebuilder.h [edit]
[-] caniter.h [edit]
[-] utf.h [edit]
[-] fieldpos.h [edit]
[-] ucharstrie.h [edit]
[-] tblcoll.h [edit]
[-] ustring.h [edit]
[-] errorcode.h [edit]
[-] stsearch.h [edit]
[-] localpointer.h [edit]
[-] usprep.h [edit]
[-] docmain.h [edit]
[-] msgfmt.h [edit]
[-] selfmt.h [edit]
[-] unifilt.h [edit]
[-] uloc.h [edit]
[-] measunit.h [edit]
[-] ucol.h [edit]
[-] numfmt.h [edit]
[-] smpdtfmt.h [edit]