OXIESEC PANEL

Name	Size	Modified	Perms
📁 ..	-	10/28/2024 06:50:42 AM	rwxr-xr-x
📄 alphaindex.h	26.27 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 appendable.h	8.43 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 basictz.h	8.84 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 brkiter.h	27.54 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 bytestream.h	9.59 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 bytestrie.h	19.26 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 bytestriebuilder.h	7.1 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 calendar.h	105.35 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 caniter.h	7.35 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 casemap.h	25.31 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 char16ptr.h	7.29 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 chariter.h	24 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 choicfmt.h	23.85 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 coleitr.h	13.7 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 coll.h	55.61 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 compactdecimalformat.h	16.58 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 curramt.h	3.69 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 currpinf.h	7.08 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 currunit.h	3.49 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 datefmt.h	40.18 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dbbi.h	1.11 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dcfmtsym.h	17.66 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 decimfmt.h	89.73 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 docmain.h	6.56 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtfmtsym.h	37.64 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtintrv.h	3.76 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtitvfmt.h	42.87 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtitvinf.h	18.46 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtptngen.h	23.72 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 dtrule.h	8.62 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 edits.h	15.54 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 enumset.h	2.05 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 errorcode.h	4.78 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 fieldpos.h	8.63 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 filteredbrk.h	5.46 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 fmtable.h	24.39 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 format.h	12.44 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 fpositer.h	3.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 gender.h	3.18 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 gregocal.h	31.57 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 icudataver.h	1.03 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 icuplug.h	11.86 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 idna.h	12.63 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 listformatter.h	4.98 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 localpointer.h	18.19 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 locdspnm.h	7.05 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 locid.h	31.4 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 measfmt.h	11.25 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 measunit.h	37.74 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 measure.h	4.26 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 messagepattern.h	33.64 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 msgfmt.h	43.16 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 normalizer2.h	33.97 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 normlzr.h	30.74 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 nounit.h	2.6 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 numberformatter.h	64.98 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 numfmt.h	47.76 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 numsys.h	6.73 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 parseerr.h	3.08 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 parsepos.h	5.45 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 platform.h	27.71 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 plurfmt.h	25.66 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 plurrule.h	18.34 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ptypes.h	3.47 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 putil.h	6.34 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 rbbi.h	27.09 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 rbnf.h	49.76 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 rbtz.h	15.47 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 regex.h	84.91 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 region.h	9.12 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 reldatefmt.h	14.3 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 rep.h	9.5 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 resbund.h	18.01 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 schriter.h	6.26 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 scientificnumberformatter.h	6.59 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 search.h	22.21 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 selfmt.h	14.24 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 simpleformatter.h	11.43 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 simpletz.h	45.24 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 smpdtfmt.h	70.09 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 sortkey.h	11.12 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 std_string.h	1015 bytes	10/19/2021 07:44:28 PM	rw-r--r--
📄 strenum.h	10.04 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 stringoptions.h	5.89 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 stringpiece.h	6.46 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 stringtriebuilder.h	15.2 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 stsearch.h	21.29 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 symtable.h	4.21 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tblcoll.h	36.4 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 timezone.h	40.83 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tmunit.h	3.29 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tmutamt.h	4.8 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tmutfmt.h	7.79 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 translit.h	54.53 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tzfmt.h	42.81 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tznames.h	16.79 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tzrule.h	35.32 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 tztrans.h	6.07 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ubidi.h	89.28 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ubiditransform.h	12.71 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ubrk.h	24.08 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucal.h	54.56 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucasemap.h	15.18 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucat.h	5.36 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uchar.h	131.61 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucharstrie.h	21.06 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucharstriebuilder.h	7.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uchriter.h	13.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uclean.h	11.24 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucnv.h	83.06 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucnv_cb.h	6.59 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucnv_err.h	20.98 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucnvsel.h	6.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucol.h	61.36 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucoleitr.h	9.46 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uconfig.h	11.91 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucsdet.h	14.67 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ucurr.h	15.15 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 udat.h	60.13 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 udata.h	15.53 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 udateintervalformat.h	6.79 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 udatpg.h	24.11 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 udisplaycontext.h	5.89 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uenum.h	7.9 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ufieldpositer.h	4.36 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uformattable.h	10.94 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ugender.h	2 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uidna.h	33.37 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uiter.h	22.77 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uldnames.h	10.45 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ulistformatter.h	4.54 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uloc.h	50.75 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ulocdata.h	11.26 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 umachine.h	13.1 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 umisc.h	1.33 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 umsg.h	24.23 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unifilt.h	3.63 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unifunct.h	3.98 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unimatch.h	6.04 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unirepl.h	3.32 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uniset.h	63.98 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unistr.h	175.65 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unorm.h	20.45 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unorm2.h	24.66 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unum.h	52.49 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 unumsys.h	7.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uobject.h	10.72 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 upluralrules.h	6.77 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uregex.h	72.05 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uregion.h	9.84 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ureldatefmt.h	12.22 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 urename.h	124.49 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 urep.h	5.38 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ures.h	36.52 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uscript.h	25.91 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 usearch.h	38.14 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uset.h	39.91 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 usetiter.h	9.49 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ushape.h	18 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uspoof.h	64.9 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 usprep.h	8.13 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ustdio.h	38.54 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ustream.h	1.8 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ustring.h	72.52 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 ustringtrie.h	3.15 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utext.h	58.11 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utf.h	7.86 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utf16.h	22.49 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utf32.h	763 bytes	10/19/2021 07:44:28 PM	rw-r--r--
📄 utf8.h	28.16 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utf_old.h	43.78 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utmscale.h	13.78 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utrace.h	13.89 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utrans.h	25.53 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 utypes.h	29.92 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uvernum.h	5.69 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 uversion.h	6.4 KB	10/19/2021 07:44:28 PM	rw-r--r--
📄 vtzone.h	20.17 KB	10/19/2021 07:44:28 PM	rw-r--r--

Editing: format.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
********************************************************************************
* Copyright (C) 1997-2011, International Business Machines Corporation and others.
* All Rights Reserved.
********************************************************************************
*
* File FORMAT.H
*
* Modification History:
*
*   Date        Name        Description
*   02/19/97    aliu        Converted from java.
*   03/17/97    clhuang     Updated per C++ implementation.
*   03/27/97    helena      Updated to pass the simple test after code review.
********************************************************************************
*/
// *****************************************************************************
// This file was generated from the java source file Format.java
// *****************************************************************************

#ifndef FORMAT_H
#define FORMAT_H

#include "unicode/utypes.h"

/**
 * \file 
 * \brief C++ API: Base class for all formats. 
 */

#if !UCONFIG_NO_FORMATTING

#include "unicode/unistr.h"
#include "unicode/fmtable.h"
#include "unicode/fieldpos.h"
#include "unicode/fpositer.h"
#include "unicode/parsepos.h"
#include "unicode/parseerr.h" 
#include "unicode/locid.h"

U_NAMESPACE_BEGIN

/**
 * Base class for all formats. This is an abstract base class which
 * specifies the protocol for classes which convert other objects or
 * values, such as numeric values and dates, and their string
 * representations. In some cases these representations may be
 * localized or contain localized characters or strings. For example,
 * a numeric formatter such as DecimalFormat may convert a numeric
 * value such as 12345 to the string "$12,345". It may also parse
 * the string back into a numeric value. A date and time formatter
 * like SimpleDateFormat may represent a specific date, encoded
 * numerically, as a string such as "Wednesday, February 26, 1997 AD".
 * 
 * Many of the concrete subclasses of Format employ the notion of
 * a pattern. A pattern is a string representation of the rules which
 * govern the interconversion between values and strings. For example,
 * a DecimalFormat object may be associated with the pattern
 * "$#,##0.00;($#,##0.00)", which is a common US English format for
 * currency values, yielding strings such as "$1,234.45" for 1234.45,
 * and "($987.65)" for 987.6543. The specific syntax of a pattern
 * is defined by each subclass.
 * 
 * Even though many subclasses use patterns, the notion of a pattern
 * is not inherent to Format classes in general, and is not part of
 * the explicit base class protocol.
 * 
 * Two complex formatting classes bear mentioning. These are
 * MessageFormat and ChoiceFormat. ChoiceFormat is a subclass of
 * NumberFormat which allows the user to format different number ranges
 * as strings. For instance, 0 may be represented as "no files", 1 as
 * "one file", and any number greater than 1 as "many files".
 * MessageFormat is a formatter which utilizes other Format objects to
 * format a string containing with multiple values. For instance,
 * A MessageFormat object might produce the string "There are no files
 * on the disk MyDisk on February 27, 1997." given the arguments 0,
 * "MyDisk", and the date value of 2/27/97. See the ChoiceFormat
 * and MessageFormat headers for further information.
 * 
 * If formatting is unsuccessful, a failing UErrorCode is returned when
 * the Format cannot format the type of object, otherwise if there is
 * something illformed about the the Unicode replacement character
 * 0xFFFD is returned.
 * 
 * If there is no match when parsing, a parse failure UErrorCode is
 * retured for methods which take no ParsePosition. For the method
 * that takes a ParsePosition, the index parameter is left unchanged.
 * 
 * User subclasses are not supported. While clients may write
 * subclasses, such code will not necessarily work and will not be
 * guaranteed to work stably from release to release.
 */
class U_I18N_API Format : public UObject {
public:

/** Destructor
     * @stable ICU 2.4
     */
    virtual ~Format();

/**
     * Return true if the given Format objects are semantically equal.
     * Objects of different subclasses are considered unequal.
     * @param other    the object to be compared with.
     * @return         Return true if the given Format objects are semantically equal.
     *                 Objects of different subclasses are considered unequal.
     * @stable ICU 2.0
     */
    virtual UBool operator==(const Format& other) const = 0;

/**
     * Return true if the given Format objects are not semantically
     * equal.
     * @param other    the object to be compared with.
     * @return         Return true if the given Format objects are not semantically.
     * @stable ICU 2.0
     */
    UBool operator!=(const Format& other) const { return !operator==(other); }

/**
     * Clone this object polymorphically.  The caller is responsible
     * for deleting the result when done.
     * @return    A copy of the object
     * @stable ICU 2.0
     */
    virtual Format* clone() const = 0;

/**
     * Formats an object to produce a string.
     *
     * @param obj       The object to format.
     * @param appendTo  Output parameter to receive result.
     *                  Result is appended to existing contents.
     * @param status    Output parameter filled in with success or failure status.
     * @return          Reference to 'appendTo' parameter.
     * @stable ICU 2.0
     */
    UnicodeString& format(const Formattable& obj,
                          UnicodeString& appendTo,
                          UErrorCode& status) const;

/**
     * Format an object to produce a string.  This is a pure virtual method which
     * subclasses must implement. This method allows polymorphic formatting
     * of Formattable objects. If a subclass of Format receives a Formattable
     * object type it doesn't handle (e.g., if a numeric Formattable is passed
     * to a DateFormat object) then it returns a failing UErrorCode.
     *
     * @param obj       The object to format.
     * @param appendTo  Output parameter to receive result.
     *                  Result is appended to existing contents.
     * @param pos       On input: an alignment field, if desired.
     *                  On output: the offsets of the alignment field.
     * @param status    Output param filled with success/failure status.
     * @return          Reference to 'appendTo' parameter.
     * @stable ICU 2.0
     */
    virtual UnicodeString& format(const Formattable& obj,
                                  UnicodeString& appendTo,
                                  FieldPosition& pos,
                                  UErrorCode& status) const = 0;
    /**
     * Format an object to produce a string.  Subclasses should override this
     * method. This method allows polymorphic formatting of Formattable objects.
     * If a subclass of Format receives a Formattable object type it doesn't
     * handle (e.g., if a numeric Formattable is passed to a DateFormat object)
     * then it returns a failing UErrorCode.
     *
     * @param obj       The object to format.
     * @param appendTo  Output parameter to receive result.
     *                  Result is appended to existing contents.
     * @param posIter   On return, can be used to iterate over positions
     *                  of fields generated by this format call.
     * @param status    Output param filled with success/failure status.
     * @return          Reference to 'appendTo' parameter.
     * @stable ICU 4.4
     */
    virtual UnicodeString& format(const Formattable& obj,
                                  UnicodeString& appendTo,
                                  FieldPositionIterator* posIter,
                                  UErrorCode& status) const;

/**
 * Parse a string to produce an object. This is a pure virtual
 * method which subclasses must implement. This method allows
 * polymorphic parsing of strings into Formattable objects.
 * 
 * Before calling, set parse_pos.index to the offset you want to
 * start parsing at in the source. After calling, parse_pos.index
 * is the end of the text you parsed. If error occurs, index is
 * unchanged.
 * 
 * When parsing, leading whitespace is discarded (with successful
 * parse), while trailing whitespace is left as is.
 * 
 * Example:
 * 
 * Parsing "_12_xy" (where _ represents a space) for a number,
 * with index == 0 will result in the number 12, with
 * parse_pos.index updated to 3 (just before the second space).
 * Parsing a second time will result in a failing UErrorCode since
 * "xy" is not a number, and leave index at 3.
 * 
 * Subclasses will typically supply specific parse methods that
 * return different types of values. Since methods can't overload
 * on return types, these will typically be named "parse", while
 * this polymorphic method will always be called parseObject. Any
 * parse method that does not take a parse_pos should set status
 * to an error value when no text in the required format is at the
 * start position.
 *
 * @param source The string to be parsed into an object.
 * @param result Formattable to be set to the parse result.
 * If parse fails, return contents are undefined.
 * @param parse_pos The position to start parsing at. Upon return
 * this param is set to the position after the
 * last character successfully parsed. If the
 * source is not parsed successfully, this param
 * will remain unchanged.
 * @stable ICU 2.0
 */
 virtual void parseObject(const UnicodeString& source,
 Formattable& result,
 ParsePosition& parse_pos) const = 0;

/**
     * Parses a string to produce an object. This is a convenience method
     * which calls the pure virtual parseObject() method, and returns a
     * failure UErrorCode if the ParsePosition indicates failure.
     *
     * @param source    The string to be parsed into an object.
     * @param result    Formattable to be set to the parse result.
     *                  If parse fails, return contents are undefined.
     * @param status    Output param to be filled with success/failure
     *                  result code.
     * @stable ICU 2.0
     */
    void parseObject(const UnicodeString& source,
                     Formattable& result,
                     UErrorCode& status) const;

/** Get the locale for this format object. You can choose between valid and actual locale.
     *  @param type type of the locale we're looking for (valid or actual) 
     *  @param status error code for the operation
     *  @return the locale
     *  @stable ICU 2.8
     */
    Locale getLocale(ULocDataLocaleType type, UErrorCode& status) const;

#ifndef U_HIDE_INTERNAL_API
    /** Get the locale for this format object. You can choose between valid and actual locale.
     *  @param type type of the locale we're looking for (valid or actual) 
     *  @param status error code for the operation
     *  @return the locale
     *  @internal
     */
    const char* getLocaleID(ULocDataLocaleType type, UErrorCode &status) const;
#endif  /* U_HIDE_INTERNAL_API */

protected:
    /** @stable ICU 2.8 */
    void setLocaleIDs(const char* valid, const char* actual);

protected:
    /**
     * Default constructor for subclass use only.  Does nothing.
     * @stable ICU 2.0
     */
    Format();

/**
     * @stable ICU 2.0
     */
    Format(const Format&); // Does nothing; for subclasses only

/**
     * @stable ICU 2.0
     */
    Format& operator=(const Format&); // Does nothing; for subclasses

/**
     * Simple function for initializing a UParseError from a UnicodeString.
     *
     * @param pattern The pattern to copy into the parseError
     * @param pos The position in pattern where the error occured
     * @param parseError The UParseError object to fill in
     * @stable ICU 2.4
     */
    static void syntaxError(const UnicodeString& pattern,
                            int32_t pos,
                            UParseError& parseError);

private:
    char actualLocale[ULOC_FULLNAME_CAPACITY];
    char validLocale[ULOC_FULLNAME_CAPACITY];
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif // _FORMAT
//eof