Gecko [ georgetownmover.com ]

Name	Size	Permission	Date
alphaindex.h	26.48 KB	-rw-r--r--	2024-02-06 07:47
appendable.h	8.49 KB	-rw-r--r--	2024-02-06 07:47
basictz.h	9.68 KB	-rw-r--r--	2024-02-06 07:47
brkiter.h	27.8 KB	-rw-r--r--	2024-02-06 07:47
bytestream.h	10.73 KB	-rw-r--r--	2024-02-06 07:47
bytestrie.h	20.77 KB	-rw-r--r--	2024-02-06 07:47
bytestriebuilder.h	7.29 KB	-rw-r--r--	2024-02-06 07:47
calendar.h	105.88 KB	-rw-r--r--	2024-02-06 07:47
caniter.h	7.43 KB	-rw-r--r--	2024-02-06 07:47
casemap.h	25.33 KB	-rw-r--r--	2024-02-06 07:47
char16ptr.h	7.22 KB	-rw-r--r--	2024-02-06 07:47
chariter.h	24.05 KB	-rw-r--r--	2024-02-06 07:47
choicfmt.h	23.91 KB	-rw-r--r--	2024-02-06 07:47
coleitr.h	13.76 KB	-rw-r--r--	2024-02-06 07:47
coll.h	56.26 KB	-rw-r--r--	2024-02-06 07:47
compactdecimalformat.h	6.88 KB	-rw-r--r--	2024-02-06 07:47
curramt.h	3.76 KB	-rw-r--r--	2024-02-06 07:47
currpinf.h	7.3 KB	-rw-r--r--	2024-02-06 07:47
currunit.h	4 KB	-rw-r--r--	2024-02-06 07:47
datefmt.h	40.67 KB	-rw-r--r--	2024-02-06 07:47
dbbi.h	1.19 KB	-rw-r--r--	2024-02-06 07:47
dcfmtsym.h	20.42 KB	-rw-r--r--	2024-02-06 07:47
decimfmt.h	87.58 KB	-rw-r--r--	2024-02-06 07:47
docmain.h	7.21 KB	-rw-r--r--	2024-02-06 07:47
dtfmtsym.h	37.73 KB	-rw-r--r--	2024-02-06 07:47
dtintrv.h	3.84 KB	-rw-r--r--	2024-02-06 07:47
dtitvfmt.h	49.29 KB	-rw-r--r--	2024-02-06 07:47
dtitvinf.h	18.62 KB	-rw-r--r--	2024-02-06 07:47
dtptngen.h	26.06 KB	-rw-r--r--	2024-02-06 07:47
dtrule.h	8.68 KB	-rw-r--r--	2024-02-06 07:47
edits.h	20.74 KB	-rw-r--r--	2024-02-06 07:47
enumset.h	2.08 KB	-rw-r--r--	2024-02-06 07:47
errorcode.h	4.84 KB	-rw-r--r--	2024-02-06 07:47
fieldpos.h	8.69 KB	-rw-r--r--	2024-02-06 07:47
filteredbrk.h	5.37 KB	-rw-r--r--	2024-02-06 07:47
fmtable.h	24.42 KB	-rw-r--r--	2024-02-06 07:47
format.h	12.5 KB	-rw-r--r--	2024-02-06 07:47
formattedvalue.h	9.75 KB	-rw-r--r--	2024-02-06 07:47
fpositer.h	3.04 KB	-rw-r--r--	2024-02-06 07:47
gender.h	3.33 KB	-rw-r--r--	2024-02-06 07:47
gregocal.h	31.71 KB	-rw-r--r--	2024-02-06 07:47
icudataver.h	1.02 KB	-rw-r--r--	2024-02-06 07:47
icuplug.h	11.83 KB	-rw-r--r--	2024-02-06 07:47
idna.h	12.7 KB	-rw-r--r--	2024-02-06 07:47
listformatter.h	8.79 KB	-rw-r--r--	2024-02-06 07:47
localebuilder.h	11.23 KB	-rw-r--r--	2024-02-06 07:47
localematcher.h	26.98 KB	-rw-r--r--	2024-02-06 07:47
localpointer.h	19.36 KB	-rw-r--r--	2024-02-06 07:47
locdspnm.h	7.12 KB	-rw-r--r--	2024-02-06 07:47
locid.h	47.65 KB	-rw-r--r--	2024-02-06 07:47
measfmt.h	11.37 KB	-rw-r--r--	2024-02-06 07:47
measunit.h	104.66 KB	-rw-r--r--	2024-02-06 07:47
measure.h	4.32 KB	-rw-r--r--	2024-02-06 07:47
messagepattern.h	33.71 KB	-rw-r--r--	2024-02-06 07:47
msgfmt.h	44.12 KB	-rw-r--r--	2024-02-06 07:47
normalizer2.h	33.66 KB	-rw-r--r--	2024-02-06 07:47
normlzr.h	30.94 KB	-rw-r--r--	2024-02-06 07:47
nounit.h	2.3 KB	-rw-r--r--	2024-02-06 07:47
numberformatter.h	92.23 KB	-rw-r--r--	2024-02-06 07:47
numberrangeformatter.h	25.04 KB	-rw-r--r--	2024-02-06 07:47
numfmt.h	49.77 KB	-rw-r--r--	2024-02-06 07:47
numsys.h	7.32 KB	-rw-r--r--	2024-02-06 07:47
parseerr.h	3.08 KB	-rw-r--r--	2024-02-06 07:47
parsepos.h	5.56 KB	-rw-r--r--	2024-02-06 07:47
platform.h	28.08 KB	-rw-r--r--	2024-02-06 07:47
plurfmt.h	25.18 KB	-rw-r--r--	2024-02-06 07:47
plurrule.h	20.84 KB	-rw-r--r--	2024-02-06 07:47
ptypes.h	3.49 KB	-rw-r--r--	2024-02-06 07:47
putil.h	6.32 KB	-rw-r--r--	2024-02-06 07:47
rbbi.h	27.57 KB	-rw-r--r--	2024-02-06 07:47
rbnf.h	48.73 KB	-rw-r--r--	2024-02-06 07:47
rbtz.h	15.72 KB	-rw-r--r--	2024-02-06 07:47
regex.h	84.34 KB	-rw-r--r--	2024-02-06 07:47
region.h	9.18 KB	-rw-r--r--	2024-02-06 07:47
reldatefmt.h	22.22 KB	-rw-r--r--	2024-02-06 07:47
rep.h	9.37 KB	-rw-r--r--	2024-02-06 07:47
resbund.h	18.07 KB	-rw-r--r--	2024-02-06 07:47
schriter.h	6.32 KB	-rw-r--r--	2024-02-06 07:47
scientificnumberformatter.h	6.4 KB	-rw-r--r--	2024-02-06 07:47
search.h	22.22 KB	-rw-r--r--	2024-02-06 07:47
selfmt.h	14.3 KB	-rw-r--r--	2024-02-06 07:47
simpleformatter.h	12.59 KB	-rw-r--r--	2024-02-06 07:47
simpletz.h	45.55 KB	-rw-r--r--	2024-02-06 07:47
smpdtfmt.h	71 KB	-rw-r--r--	2024-02-06 07:47
sortkey.h	11.18 KB	-rw-r--r--	2024-02-06 07:47
std_string.h	1.05 KB	-rw-r--r--	2024-02-06 07:47
strenum.h	9.92 KB	-rw-r--r--	2024-02-06 07:47
stringoptions.h	5.79 KB	-rw-r--r--	2024-02-06 07:47
stringpiece.h	10.05 KB	-rw-r--r--	2024-02-06 07:47
stringtriebuilder.h	15.33 KB	-rw-r--r--	2024-02-06 07:47
stsearch.h	21.3 KB	-rw-r--r--	2024-02-06 07:47
symtable.h	4.27 KB	-rw-r--r--	2024-02-06 07:47
tblcoll.h	36.65 KB	-rw-r--r--	2024-02-06 07:47
timezone.h	41.52 KB	-rw-r--r--	2024-02-06 07:47
tmunit.h	3.38 KB	-rw-r--r--	2024-02-06 07:47
tmutamt.h	4.9 KB	-rw-r--r--	2024-02-06 07:47
tmutfmt.h	7.85 KB	-rw-r--r--	2024-02-06 07:47
translit.h	65.81 KB	-rw-r--r--	2024-02-06 07:47
tzfmt.h	42.89 KB	-rw-r--r--	2024-02-06 07:47
tznames.h	16.85 KB	-rw-r--r--	2024-02-06 07:47
tzrule.h	35.37 KB	-rw-r--r--	2024-02-06 07:47
tztrans.h	6.12 KB	-rw-r--r--	2024-02-06 07:47
ubidi.h	89.54 KB	-rw-r--r--	2024-02-06 07:47
ubiditransform.h	12.7 KB	-rw-r--r--	2024-02-06 07:47
ubrk.h	24.45 KB	-rw-r--r--	2024-02-06 07:47
ucal.h	61 KB	-rw-r--r--	2024-02-06 07:47
ucasemap.h	15.21 KB	-rw-r--r--	2024-02-06 07:47
ucat.h	5.35 KB	-rw-r--r--	2024-02-06 07:47
uchar.h	141.13 KB	-rw-r--r--	2024-02-06 07:47
ucharstrie.h	22.53 KB	-rw-r--r--	2024-02-06 07:47
ucharstriebuilder.h	7.3 KB	-rw-r--r--	2024-02-06 07:47
uchriter.h	13.2 KB	-rw-r--r--	2024-02-06 07:47
uclean.h	11.2 KB	-rw-r--r--	2024-02-06 07:47
ucnv.h	83.04 KB	-rw-r--r--	2024-02-06 07:47
ucnv_cb.h	6.58 KB	-rw-r--r--	2024-02-06 07:47
ucnv_err.h	20.97 KB	-rw-r--r--	2024-02-06 07:47
ucnvsel.h	6.19 KB	-rw-r--r--	2024-02-06 07:47
ucol.h	61.51 KB	-rw-r--r--	2024-02-06 07:47
ucoleitr.h	9.82 KB	-rw-r--r--	2024-02-06 07:47
uconfig.h	12.07 KB	-rw-r--r--	2024-02-06 07:47
ucpmap.h	5.53 KB	-rw-r--r--	2024-02-06 07:47
ucptrie.h	22.51 KB	-rw-r--r--	2024-02-06 07:47
ucsdet.h	14.69 KB	-rw-r--r--	2024-02-06 07:47
ucurr.h	16.77 KB	-rw-r--r--	2024-02-06 07:47
udat.h	62.11 KB	-rw-r--r--	2024-02-06 07:47
udata.h	15.62 KB	-rw-r--r--	2024-02-06 07:47
udateintervalformat.h	11.98 KB	-rw-r--r--	2024-02-06 07:47
udatpg.h	26.76 KB	-rw-r--r--	2024-02-06 07:47
udisplaycontext.h	5.94 KB	-rw-r--r--	2024-02-06 07:47
uenum.h	7.79 KB	-rw-r--r--	2024-02-06 07:47
ufieldpositer.h	4.41 KB	-rw-r--r--	2024-02-06 07:47
uformattable.h	10.97 KB	-rw-r--r--	2024-02-06 07:47
uformattedvalue.h	12.3 KB	-rw-r--r--	2024-02-06 07:47
ugender.h	2.06 KB	-rw-r--r--	2024-02-06 07:47
uidna.h	33.43 KB	-rw-r--r--	2024-02-06 07:47
uiter.h	22.75 KB	-rw-r--r--	2024-02-06 07:47
uldnames.h	10.48 KB	-rw-r--r--	2024-02-06 07:47
ulistformatter.h	10.78 KB	-rw-r--r--	2024-02-06 07:47
uloc.h	54.6 KB	-rw-r--r--	2024-02-06 07:47
ulocdata.h	11.3 KB	-rw-r--r--	2024-02-06 07:47
umachine.h	16.05 KB	-rw-r--r--	2024-02-06 07:47
umisc.h	1.33 KB	-rw-r--r--	2024-02-06 07:47
umsg.h	24.25 KB	-rw-r--r--	2024-02-06 07:47
umutablecptrie.h	8.29 KB	-rw-r--r--	2024-02-06 07:47
unifilt.h	3.96 KB	-rw-r--r--	2024-02-06 07:47
unifunct.h	4.04 KB	-rw-r--r--	2024-02-06 07:47
unimatch.h	6.1 KB	-rw-r--r--	2024-02-06 07:47
unirepl.h	3.38 KB	-rw-r--r--	2024-02-06 07:47
uniset.h	65.04 KB	-rw-r--r--	2024-02-06 07:47
unistr.h	170.46 KB	-rw-r--r--	2024-02-06 07:47
unorm.h	20.52 KB	-rw-r--r--	2024-02-06 07:47
unorm2.h	24.68 KB	-rw-r--r--	2024-02-06 07:47
unum.h	54.88 KB	-rw-r--r--	2024-02-06 07:47
unumberformatter.h	30.55 KB	-rw-r--r--	2024-02-06 07:47
unumberrangeformatter.h	15.38 KB	-rw-r--r--	2024-02-06 07:47
unumsys.h	7.26 KB	-rw-r--r--	2024-02-06 07:47
uobject.h	10.68 KB	-rw-r--r--	2024-02-06 07:47
upluralrules.h	8.8 KB	-rw-r--r--	2024-02-06 07:47
uregex.h	71.99 KB	-rw-r--r--	2024-02-06 07:47
uregion.h	9.81 KB	-rw-r--r--	2024-02-06 07:47
ureldatefmt.h	17.04 KB	-rw-r--r--	2024-02-06 07:47
urename.h	133.97 KB	-rw-r--r--	2024-02-06 07:47
urep.h	5.38 KB	-rw-r--r--	2024-02-06 07:47
ures.h	36.54 KB	-rw-r--r--	2024-02-06 07:47
uscript.h	27.19 KB	-rw-r--r--	2024-02-06 07:47
usearch.h	39.07 KB	-rw-r--r--	2024-02-06 07:47
uset.h	42.59 KB	-rw-r--r--	2024-02-06 07:47
usetiter.h	9.55 KB	-rw-r--r--	2024-02-06 07:47
ushape.h	18 KB	-rw-r--r--	2024-02-06 07:47
uspoof.h	65.84 KB	-rw-r--r--	2024-02-06 07:47
usprep.h	8.19 KB	-rw-r--r--	2024-02-06 07:47
ustdio.h	38.55 KB	-rw-r--r--	2024-02-06 07:47
ustream.h	1.89 KB	-rw-r--r--	2024-02-06 07:47
ustring.h	72.35 KB	-rw-r--r--	2024-02-06 07:47
ustringtrie.h	3.15 KB	-rw-r--r--	2024-02-06 07:47
utext.h	58.08 KB	-rw-r--r--	2024-02-06 07:47
utf.h	7.87 KB	-rw-r--r--	2024-02-06 07:47
utf16.h	23.35 KB	-rw-r--r--	2024-02-06 07:47
utf32.h	763 B	-rw-r--r--	2024-02-06 07:47
utf8.h	30.83 KB	-rw-r--r--	2024-02-06 07:47
utf_old.h	45.83 KB	-rw-r--r--	2024-02-06 07:47
utmscale.h	13.78 KB	-rw-r--r--	2024-02-06 07:47
utrace.h	17.18 KB	-rw-r--r--	2024-02-06 07:47
utrans.h	25.54 KB	-rw-r--r--	2024-02-06 07:47
utypes.h	31.06 KB	-rw-r--r--	2024-02-06 07:47
uvernum.h	6.68 KB	-rw-r--r--	2024-02-06 07:47
uversion.h	5.99 KB	-rw-r--r--	2024-02-06 07:47
vtzone.h	20.67 KB	-rw-r--r--	2024-02-06 07:47

Rename

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html

#ifndef __FORMATTEDVALUE_H__
#define __FORMATTEDVALUE_H__

#include "unicode/utypes.h"

#if U_SHOW_CPLUSPLUS_API

#if !UCONFIG_NO_FORMATTING

#include "unicode/appendable.h"
#include "unicode/fpositer.h"
#include "unicode/unistr.h"
#include "unicode/uformattedvalue.h"

U_NAMESPACE_BEGIN

/**
 * \file
 * \brief C++ API: Abstract operations for localized strings.
 * 
 * This file contains declarations for classes that deal with formatted strings. A number
 * of APIs throughout ICU use these classes for expressing their localized output.
 */

/**
 * Represents a span of a string containing a given field.
 *
 * This class differs from FieldPosition in the following ways:
 *
 *   1. It has information on the field category.
 *   2. It allows you to set constraints to use when iterating over field positions.
 *   3. It is used for the newer FormattedValue APIs.
 *
 * This class is not intended for public subclassing.
 *
 * @stable ICU 64
 */
class U_I18N_API ConstrainedFieldPosition : public UMemory {
  public:

/**
     * Initializes a ConstrainedFieldPosition.
     *
     * By default, the ConstrainedFieldPosition has no iteration constraints.
     *
     * @stable ICU 64
     */
    ConstrainedFieldPosition();

/** @stable ICU 64 */
    ~ConstrainedFieldPosition();

/**
     * Resets this ConstrainedFieldPosition to its initial state, as if it were newly created:
     *
     * - Removes any constraints that may have been set on the instance.
     * - Resets the iteration position.
     *
     * @stable ICU 64
     */
    void reset();

/**
     * Sets a constraint on the field category.
     * 
     * When this instance of ConstrainedFieldPosition is passed to FormattedValue#nextPosition,
     * positions are skipped unless they have the given category.
     *
     * Any previously set constraints are cleared.
     *
     * For example, to loop over only the number-related fields:
     *
     *     ConstrainedFieldPosition cfpos;
     *     cfpos.constrainCategory(UFIELDCATEGORY_NUMBER_FORMAT);
     *     while (fmtval.nextPosition(cfpos, status)) {
     *         // handle the number-related field position
     *     }
     *
     * Changing the constraint while in the middle of iterating over a FormattedValue
     * does not generally have well-defined behavior.
     *
     * @param category The field category to fix when iterating.
     * @stable ICU 64
     */
    void constrainCategory(int32_t category);

/**
     * Sets a constraint on the category and field.
     * 
     * When this instance of ConstrainedFieldPosition is passed to FormattedValue#nextPosition,
     * positions are skipped unless they have the given category and field.
     *
     * Any previously set constraints are cleared.
     *
     * For example, to loop over all grouping separators:
     *
     *     ConstrainedFieldPosition cfpos;
     *     cfpos.constrainField(UFIELDCATEGORY_NUMBER_FORMAT, UNUM_GROUPING_SEPARATOR_FIELD);
     *     while (fmtval.nextPosition(cfpos, status)) {
     *         // handle the grouping separator position
     *     }
     *
     * Changing the constraint while in the middle of iterating over a FormattedValue
     * does not generally have well-defined behavior.
     *
     * @param category The field category to fix when iterating.
     * @param field The field to fix when iterating.
     * @stable ICU 64
     */
    void constrainField(int32_t category, int32_t field);

/**
     * Gets the field category for the current position.
     *
     * The return value is well-defined only after
     * FormattedValue#nextPosition returns true.
     *
     * @return The field category saved in the instance.
     * @stable ICU 64
     */
    inline int32_t getCategory() const {
        return fCategory;
    }

/**
     * Gets the field for the current position.
     *
     * The return value is well-defined only after
     * FormattedValue#nextPosition returns true.
     *
     * @return The field saved in the instance.
     * @stable ICU 64
     */
    inline int32_t getField() const {
        return fField;
    }

/**
     * Gets the INCLUSIVE start index for the current position.
     *
     * The return value is well-defined only after FormattedValue#nextPosition returns true.
     *
     * @return The start index saved in the instance.
     * @stable ICU 64
     */
    inline int32_t getStart() const {
        return fStart;
    }

/**
     * Gets the EXCLUSIVE end index stored for the current position.
     *
     * The return value is well-defined only after FormattedValue#nextPosition returns true.
     *
     * @return The end index saved in the instance.
     * @stable ICU 64
     */
    inline int32_t getLimit() const {
        return fLimit;
    }

////////////////////////////////////////////////////////////////////
    //// The following methods are for FormattedValue implementers; ////
    //// most users can ignore them.                                ////
    ////////////////////////////////////////////////////////////////////

/**
     * Gets an int64 that FormattedValue implementations may use for storage.
     *
     * The initial value is zero.
     *
     * Users of FormattedValue should not need to call this method.
     *
     * @return The current iteration context from {@link #setInt64IterationContext}.
     * @stable ICU 64
     */
    inline int64_t getInt64IterationContext() const {
        return fContext;
    }

/**
     * Sets an int64 that FormattedValue implementations may use for storage.
     *
     * Intended to be used by FormattedValue implementations.
     *
     * @param context The new iteration context.
     * @stable ICU 64
     */
    void setInt64IterationContext(int64_t context);

/**
     * Determines whether a given field should be included given the
     * constraints.
     *
     * Intended to be used by FormattedValue implementations.
     *
     * @param category The category to test.
     * @param field The field to test.
     * @stable ICU 64
     */
    UBool matchesField(int32_t category, int32_t field) const;

/**
     * Sets new values for the primary public getters.
     *
     * Intended to be used by FormattedValue implementations.
     *
     * It is up to the implementation to ensure that the user-requested
     * constraints are satisfied. This method does not check!
     *
     * @param category The new field category.
     * @param field The new field.
     * @param start The new inclusive start index.
     * @param limit The new exclusive end index.
     * @stable ICU 64
     */
    void setState(
        int32_t category,
        int32_t field,
        int32_t start,
        int32_t limit);

private:
    int64_t fContext = 0LL;
    int32_t fField = 0;
    int32_t fStart = 0;
    int32_t fLimit = 0;
    int32_t fCategory = UFIELD_CATEGORY_UNDEFINED;
    int8_t fConstraint = 0;
};

/**
 * An abstract formatted value: a string with associated field attributes.
 * Many formatters format to classes implementing FormattedValue.
 *
 * @stable ICU 64
 */
class U_I18N_API FormattedValue /* not : public UObject because this is an interface/mixin class */ {
  public:
    /** @stable ICU 64 */
    virtual ~FormattedValue();

/**
     * Returns the formatted string as a self-contained UnicodeString.
     *
     * If you need the string within the current scope only, consider #toTempString.
     *
     * @param status Set if an error occurs.
     * @return a UnicodeString containing the formatted string.
     *
     * @stable ICU 64
     */
    virtual UnicodeString toString(UErrorCode& status) const = 0;

/**
     * Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
     *
     * The return value is valid only as long as this FormattedValue is present and unchanged in
     * memory. If you need the string outside the current scope, consider #toString.
     *
     * The buffer returned by calling UnicodeString#getBuffer() on the return value is
     * guaranteed to be NUL-terminated.
     *
     * @param status Set if an error occurs.
     * @return a temporary UnicodeString containing the formatted string.
     *
     * @stable ICU 64
     */
    virtual UnicodeString toTempString(UErrorCode& status) const = 0;

/**
     * Appends the formatted string to an Appendable.
     *
     * @param appendable
     *         The Appendable to which to append the string output.
     * @param status Set if an error occurs.
     * @return The same Appendable, for chaining.
     *
     * @stable ICU 64
     * @see Appendable
     */
    virtual Appendable& appendTo(Appendable& appendable, UErrorCode& status) const = 0;

/**
     * Iterates over field positions in the FormattedValue. This lets you determine the position
     * of specific types of substrings, like a month or a decimal separator.
     *
     * To loop over all field positions:
     *
     *     ConstrainedFieldPosition cfpos;
     *     while (fmtval.nextPosition(cfpos, status)) {
     *         // handle the field position; get information from cfpos
     *     }
     *
     * @param cfpos
     *         The object used for iteration state. This can provide constraints to iterate over
     *         only one specific category or field;
     *         see ConstrainedFieldPosition#constrainCategory
     *         and ConstrainedFieldPosition#constrainField.
     * @param status Set if an error occurs.
     * @return true if a new occurrence of the field was found;
     *         false otherwise or if an error was set.
     *
     * @stable ICU 64
     */
    virtual UBool nextPosition(ConstrainedFieldPosition& cfpos, UErrorCode& status) const = 0;
};

U_NAMESPACE_END

#endif /* #if !UCONFIG_NO_FORMATTING */

#endif /* U_SHOW_CPLUSPLUS_API */

#endif // __FORMATTEDVALUE_H__