// © 2016 and later: Unicode, Inc. and others. // License & terms of use: http://www.unicode.org/copyright.html /* ******************************************************************************* * * Copyright (C) 2012-2016, International Business Machines * Corporation and others. All Rights Reserved. * ******************************************************************************* * file name: listformatter.h * encoding: UTF-8 * tab size: 8 (not used) * indentation:4 * * created on: 20120426 * created by: Umesh P. Nair */ #ifndef __LISTFORMATTER_H__ #define __LISTFORMATTER_H__ #include "unicode/utypes.h" #if U_SHOW_CPLUSPLUS_API #if !UCONFIG_NO_FORMATTING #include "unicode/unistr.h" #include "unicode/locid.h" #include "unicode/formattedvalue.h" #include "unicode/ulistformatter.h" U_NAMESPACE_BEGIN class FieldPositionHandler; class FormattedListData; class ListFormatter; /** @internal */ class Hashtable; /** @internal */ struct ListFormatInternal; /* The following can't be #ifndef U_HIDE_INTERNAL_API, needed for other .h file declarations */ /** * @internal * \cond */ struct ListFormatData : public UMemory { UnicodeString twoPattern; UnicodeString startPattern; UnicodeString middlePattern; UnicodeString endPattern; Locale locale; ListFormatData(const UnicodeString& two, const UnicodeString& start, const UnicodeString& middle, const UnicodeString& end, const Locale& loc) : twoPattern(two), startPattern(start), middlePattern(middle), endPattern(end), locale(loc) {} }; /** \endcond */ /** * \file * \brief C++ API: API for formatting a list. */ /** * An immutable class containing the result of a list formatting operation. * * Instances of this class are immutable and thread-safe. * * When calling nextPosition(): * The fields are returned from start to end. The special field category * UFIELD_CATEGORY_LIST_SPAN is used to indicate which argument * was inserted at the given position. The span category will * always occur before the corresponding instance of UFIELD_CATEGORY_LIST * in the nextPosition() iterator. * * Not intended for public subclassing. * * @stable ICU 64 */ class U_I18N_API FormattedList : public UMemory, public FormattedValue { public: /** * Default constructor; makes an empty FormattedList. * @stable ICU 64 */ FormattedList() : fData(nullptr), fErrorCode(U_INVALID_STATE_ERROR) {} /** * Move constructor: Leaves the source FormattedList in an undefined state. * @stable ICU 64 */ FormattedList(FormattedList&& src) noexcept; /** * Destruct an instance of FormattedList. * @stable ICU 64 */ virtual ~FormattedList() override; /** Copying not supported; use move constructor instead. */ FormattedList(const FormattedList&) = delete; /** Copying not supported; use move assignment instead. */ FormattedList& operator=(const FormattedList&) = delete; /** * Move assignment: Leaves the source FormattedList in an undefined state. * @stable ICU 64 */ FormattedList& operator=(FormattedList&& src) noexcept; /** @copydoc FormattedValue::toString() */ UnicodeString toString(UErrorCode& status) const override; /** @copydoc FormattedValue::toTempString() */ UnicodeString toTempString(UErrorCode& status) const override; /** @copydoc FormattedValue::appendTo() */ Appendable &appendTo(Appendable& appendable, UErrorCode& status) const override; /** @copydoc FormattedValue::nextPosition() */ UBool nextPosition(ConstrainedFieldPosition& cfpos, UErrorCode& status) const override; private: FormattedListData *fData; UErrorCode fErrorCode; explicit FormattedList(FormattedListData *results) : fData(results), fErrorCode(U_ZERO_ERROR) {} explicit FormattedList(UErrorCode errorCode) : fData(nullptr), fErrorCode(errorCode) {} friend class ListFormatter; }; /** * An immutable class for formatting a list, using data from CLDR (or supplied * separately). * * Example: Input data ["Alice", "Bob", "Charlie", "Delta"] will be formatted * as "Alice, Bob, Charlie and Delta" in English. * * The ListFormatter class is not intended for public subclassing. * @stable ICU 50 */ class U_I18N_API ListFormatter : public UObject{ public: /** * Copy constructor. * @stable ICU 52 */ ListFormatter(const ListFormatter&); /** * Assignment operator. * @stable ICU 52 */ ListFormatter& operator=(const ListFormatter& other); /** * Creates a ListFormatter appropriate for the default locale. * * @param errorCode ICU error code, set if no data available for default locale. * @return Pointer to a ListFormatter object for the default locale, * created from internal data derived from CLDR data. * @stable ICU 50 */ static ListFormatter* createInstance(UErrorCode& errorCode); /** * Creates a ListFormatter appropriate for a locale. * * @param locale The locale. * @param errorCode ICU error code, set if no data available for the given locale. * @return A ListFormatter object created from internal data derived from * CLDR data. * @stable ICU 50 */ static ListFormatter* createInstance(const Locale& locale, UErrorCode& errorCode); /** * Creates a ListFormatter for the given locale, list type, and style. * * @param locale The locale. * @param type The type of list formatting to use. * @param width The width of formatting to use. * @param errorCode ICU error code, set if no data available for the given locale. * @return A ListFormatter object created from internal data derived from CLDR data. * @stable ICU 67 */ static ListFormatter* createInstance( const Locale& locale, UListFormatterType type, UListFormatterWidth width, UErrorCode& errorCode); /** * Destructor. * * @stable ICU 50 */ virtual ~ListFormatter(); /** * Formats a list of strings. * * @param items An array of strings to be combined and formatted. * @param n_items Length of the array items. * @param appendTo The string to which the result should be appended to. * @param errorCode ICU error code, set if there is an error. * @return Formatted string combining the elements of items, appended to appendTo. * @stable ICU 50 */ UnicodeString& format(const UnicodeString items[], int32_t n_items, UnicodeString& appendTo, UErrorCode& errorCode) const; /** * Formats a list of strings to a FormattedList, which exposes field * position information. The FormattedList contains more information than * a FieldPositionIterator. * * @param items An array of strings to be combined and formatted. * @param n_items Length of the array items. * @param errorCode ICU error code returned here. * @return A FormattedList containing field information. * @stable ICU 64 */ FormattedList formatStringsToValue( const UnicodeString items[], int32_t n_items, UErrorCode& errorCode) const; #ifndef U_HIDE_INTERNAL_API /** @internal for MeasureFormat */ UnicodeString& format( const UnicodeString items[], int32_t n_items, UnicodeString& appendTo, int32_t index, int32_t &offset, UErrorCode& errorCode) const; /** * @internal constructor made public for testing. */ ListFormatter(const ListFormatData &data, UErrorCode &errorCode); /** * @internal constructor made public for testing. */ ListFormatter(const ListFormatInternal* listFormatterInternal); #endif /* U_HIDE_INTERNAL_API */ private: /** * Creates a ListFormatter appropriate for a locale and style. * * @param locale The locale. * @param style the style, either "standard", "or", "unit", "unit-narrow", or "unit-short" */ static ListFormatter* createInstance(const Locale& locale, const char* style, UErrorCode& errorCode); static void initializeHash(UErrorCode& errorCode); static const ListFormatInternal* getListFormatInternal(const Locale& locale, const char *style, UErrorCode& errorCode); struct U_HIDDEN ListPatternsSink; static ListFormatInternal* loadListFormatInternal(const Locale& locale, const char* style, UErrorCode& errorCode); ListFormatter() = delete; ListFormatInternal* owned; const ListFormatInternal* data; }; U_NAMESPACE_END #endif /* #if !UCONFIG_NO_FORMATTING */ #endif /* U_SHOW_CPLUSPLUS_API */ #endif // __LISTFORMATTER_H__
Name | Type | Size | Permission | Actions |
---|---|---|---|---|
alphaindex.h | File | 26.54 KB | 0644 |
|
appendable.h | File | 8.54 KB | 0644 |
|
basictz.h | File | 9.99 KB | 0644 |
|
brkiter.h | File | 27.86 KB | 0644 |
|
bytestream.h | File | 10.75 KB | 0644 |
|
bytestrie.h | File | 20.8 KB | 0644 |
|
bytestriebuilder.h | File | 7.48 KB | 0644 |
|
calendar.h | File | 106.52 KB | 0644 |
|
caniter.h | File | 7.47 KB | 0644 |
|
casemap.h | File | 25.42 KB | 0644 |
|
char16ptr.h | File | 7.22 KB | 0644 |
|
chariter.h | File | 24.06 KB | 0644 |
|
choicfmt.h | File | 24 KB | 0644 |
|
coleitr.h | File | 13.78 KB | 0644 |
|
coll.h | File | 56.3 KB | 0644 |
|
compactdecimalformat.h | File | 6.88 KB | 0644 |
|
curramt.h | File | 3.67 KB | 0644 |
|
currpinf.h | File | 7.3 KB | 0644 |
|
currunit.h | File | 4.02 KB | 0644 |
|
datefmt.h | File | 40.72 KB | 0644 |
|
dbbi.h | File | 1.19 KB | 0644 |
|
dcfmtsym.h | File | 20.94 KB | 0644 |
|
decimfmt.h | File | 87.54 KB | 0644 |
|
displayoptions.h | File | 7.08 KB | 0644 |
|
docmain.h | File | 7.3 KB | 0644 |
|
dtfmtsym.h | File | 38.23 KB | 0644 |
|
dtintrv.h | File | 3.85 KB | 0644 |
|
dtitvfmt.h | File | 49.26 KB | 0644 |
|
dtitvinf.h | File | 18.63 KB | 0644 |
|
dtptngen.h | File | 28.64 KB | 0644 |
|
dtrule.h | File | 8.69 KB | 0644 |
|
edits.h | File | 20.73 KB | 0644 |
|
enumset.h | File | 2.08 KB | 0644 |
|
errorcode.h | File | 4.84 KB | 0644 |
|
fieldpos.h | File | 8.7 KB | 0644 |
|
filteredbrk.h | File | 5.37 KB | 0644 |
|
fmtable.h | File | 24.45 KB | 0644 |
|
format.h | File | 12.5 KB | 0644 |
|
formattednumber.h | File | 6.15 KB | 0644 |
|
formattedvalue.h | File | 9.75 KB | 0644 |
|
fpositer.h | File | 3.03 KB | 0644 |
|
gender.h | File | 3.35 KB | 0644 |
|
gregocal.h | File | 30.03 KB | 0644 |
|
icudataver.h | File | 1.02 KB | 0644 |
|
icuplug.h | File | 12.1 KB | 0644 |
|
idna.h | File | 12.71 KB | 0644 |
|
listformatter.h | File | 8.59 KB | 0644 |
|
localebuilder.h | File | 11.08 KB | 0644 |
|
localematcher.h | File | 26.83 KB | 0644 |
|
localpointer.h | File | 19.44 KB | 0644 |
|
locdspnm.h | File | 7.12 KB | 0644 |
|
locid.h | File | 48.27 KB | 0644 |
|
measfmt.h | File | 11.42 KB | 0644 |
|
measunit.h | File | 107.38 KB | 0644 |
|
measure.h | File | 4.69 KB | 0644 |
|
messagepattern.h | File | 33.72 KB | 0644 |
|
msgfmt.h | File | 44.21 KB | 0644 |
|
normalizer2.h | File | 34.73 KB | 0644 |
|
normlzr.h | File | 30.97 KB | 0644 |
|
nounit.h | File | 2.25 KB | 0644 |
|
numberformatter.h | File | 90.03 KB | 0644 |
|
numberrangeformatter.h | File | 25.32 KB | 0644 |
|
numfmt.h | File | 50.26 KB | 0644 |
|
numsys.h | File | 7.23 KB | 0644 |
|
parseerr.h | File | 3.08 KB | 0644 |
|
parsepos.h | File | 5.57 KB | 0644 |
|
platform.h | File | 27.8 KB | 0644 |
|
plurfmt.h | File | 25.25 KB | 0644 |
|
plurrule.h | File | 20.64 KB | 0644 |
|
ptypes.h | File | 3.49 KB | 0644 |
|
putil.h | File | 6.32 KB | 0644 |
|
rbbi.h | File | 32.07 KB | 0644 |
|
rbnf.h | File | 49.92 KB | 0644 |
|
rbtz.h | File | 15.77 KB | 0644 |
|
regex.h | File | 84.45 KB | 0644 |
|
region.h | File | 9.2 KB | 0644 |
|
reldatefmt.h | File | 22.36 KB | 0644 |
|
rep.h | File | 9.38 KB | 0644 |
|
resbund.h | File | 18.11 KB | 0644 |
|
schriter.h | File | 6.1 KB | 0644 |
|
scientificnumberformatter.h | File | 6.44 KB | 0644 |
|
search.h | File | 22.24 KB | 0644 |
|
selfmt.h | File | 14.35 KB | 0644 |
|
simpleformatter.h | File | 12.6 KB | 0644 |
|
simplenumberformatter.h | File | 8.88 KB | 0644 |
|
simpletz.h | File | 45.65 KB | 0644 |
|
smpdtfmt.h | File | 71.85 KB | 0644 |
|
sortkey.h | File | 11.19 KB | 0644 |
|
std_string.h | File | 1.05 KB | 0644 |
|
strenum.h | File | 9.96 KB | 0644 |
|
stringoptions.h | File | 5.79 KB | 0644 |
|
stringpiece.h | File | 10.05 KB | 0644 |
|
stringtriebuilder.h | File | 15.5 KB | 0644 |
|
stsearch.h | File | 21.44 KB | 0644 |
|
symtable.h | File | 4.28 KB | 0644 |
|
tblcoll.h | File | 36.94 KB | 0644 |
|
timezone.h | File | 45.67 KB | 0644 |
|
tmunit.h | File | 3.4 KB | 0644 |
|
tmutamt.h | File | 4.91 KB | 0644 |
|
tmutfmt.h | File | 7.42 KB | 0644 |
|
translit.h | File | 65.83 KB | 0644 |
|
tzfmt.h | File | 42.96 KB | 0644 |
|
tznames.h | File | 16.85 KB | 0644 |
|
tzrule.h | File | 34.86 KB | 0644 |
|
tztrans.h | File | 6.13 KB | 0644 |
|
ubidi.h | File | 89.61 KB | 0644 |
|
ubiditransform.h | File | 12.71 KB | 0644 |
|
ubrk.h | File | 24.43 KB | 0644 |
|
ucal.h | File | 64.28 KB | 0644 |
|
ucasemap.h | File | 15.21 KB | 0644 |
|
ucat.h | File | 5.35 KB | 0644 |
|
uchar.h | File | 145.7 KB | 0644 |
|
ucharstrie.h | File | 22.56 KB | 0644 |
|
ucharstriebuilder.h | File | 7.48 KB | 0644 |
|
uchriter.h | File | 13.42 KB | 0644 |
|
uclean.h | File | 11.21 KB | 0644 |
|
ucnv.h | File | 83.46 KB | 0644 |
|
ucnv_cb.h | File | 6.58 KB | 0644 |
|
ucnv_err.h | File | 20.98 KB | 0644 |
|
ucnvsel.h | File | 6.24 KB | 0644 |
|
ucol.h | File | 62.7 KB | 0644 |
|
ucoleitr.h | File | 9.82 KB | 0644 |
|
uconfig.h | File | 12.31 KB | 0644 |
|
ucpmap.h | File | 5.54 KB | 0644 |
|
ucptrie.h | File | 22.51 KB | 0644 |
|
ucsdet.h | File | 14.69 KB | 0644 |
|
ucurr.h | File | 16.72 KB | 0644 |
|
udat.h | File | 62.36 KB | 0644 |
|
udata.h | File | 15.63 KB | 0644 |
|
udateintervalformat.h | File | 11.93 KB | 0644 |
|
udatpg.h | File | 30.13 KB | 0644 |
|
udisplaycontext.h | File | 5.94 KB | 0644 |
|
udisplayoptions.h | File | 8.86 KB | 0644 |
|
uenum.h | File | 7.79 KB | 0644 |
|
ufieldpositer.h | File | 4.41 KB | 0644 |
|
uformattable.h | File | 10.97 KB | 0644 |
|
uformattednumber.h | File | 8.09 KB | 0644 |
|
uformattedvalue.h | File | 12.25 KB | 0644 |
|
ugender.h | File | 2.06 KB | 0644 |
|
uidna.h | File | 33.43 KB | 0644 |
|
uiter.h | File | 22.75 KB | 0644 |
|
uldnames.h | File | 10.48 KB | 0644 |
|
ulistformatter.h | File | 10.78 KB | 0644 |
|
uloc.h | File | 54.66 KB | 0644 |
|
ulocale.h | File | 6.35 KB | 0644 |
|
ulocbuilder.h | File | 16.72 KB | 0644 |
|
ulocdata.h | File | 11.3 KB | 0644 |
|
umachine.h | File | 15 KB | 0644 |
|
umisc.h | File | 1.34 KB | 0644 |
|
umsg.h | File | 24.25 KB | 0644 |
|
umutablecptrie.h | File | 8.3 KB | 0644 |
|
unifilt.h | File | 4 KB | 0644 |
|
unifunct.h | File | 4.05 KB | 0644 |
|
unimatch.h | File | 6.1 KB | 0644 |
|
unirepl.h | File | 3.38 KB | 0644 |
|
uniset.h | File | 66.85 KB | 0644 |
|
unistr.h | File | 171.35 KB | 0644 |
|
unorm.h | File | 20.55 KB | 0644 |
|
unorm2.h | File | 25.71 KB | 0644 |
|
unum.h | File | 55.16 KB | 0644 |
|
unumberformatter.h | File | 19.68 KB | 0644 |
|
unumberoptions.h | File | 5.23 KB | 0644 |
|
unumberrangeformatter.h | File | 15.35 KB | 0644 |
|
unumsys.h | File | 7.26 KB | 0644 |
|
uobject.h | File | 10.66 KB | 0644 |
|
upluralrules.h | File | 8.79 KB | 0644 |
|
uregex.h | File | 71.99 KB | 0644 |
|
uregion.h | File | 9.81 KB | 0644 |
|
ureldatefmt.h | File | 16.98 KB | 0644 |
|
urename.h | File | 140.82 KB | 0644 |
|
urep.h | File | 5.38 KB | 0644 |
|
ures.h | File | 36.65 KB | 0644 |
|
uscript.h | File | 27.8 KB | 0644 |
|
usearch.h | File | 39.21 KB | 0644 |
|
uset.h | File | 45.61 KB | 0644 |
|
usetiter.h | File | 9.63 KB | 0644 |
|
ushape.h | File | 18 KB | 0644 |
|
usimplenumberformatter.h | File | 7.46 KB | 0644 |
|
uspoof.h | File | 80.32 KB | 0644 |
|
usprep.h | File | 8.19 KB | 0644 |
|
ustdio.h | File | 38.56 KB | 0644 |
|
ustream.h | File | 1.89 KB | 0644 |
|
ustring.h | File | 72.13 KB | 0644 |
|
ustringtrie.h | File | 3.15 KB | 0644 |
|
utext.h | File | 58.1 KB | 0644 |
|
utf.h | File | 7.87 KB | 0644 |
|
utf16.h | File | 23.35 KB | 0644 |
|
utf32.h | File | 763 B | 0644 |
|
utf8.h | File | 30.83 KB | 0644 |
|
utf_old.h | File | 45.8 KB | 0644 |
|
utmscale.h | File | 13.78 KB | 0644 |
|
utrace.h | File | 17.18 KB | 0644 |
|
utrans.h | File | 25.54 KB | 0644 |
|
utypes.h | File | 31.06 KB | 0644 |
|
uvernum.h | File | 6.33 KB | 0644 |
|
uversion.h | File | 5.99 KB | 0644 |
|
vtzone.h | File | 20.69 KB | 0644 |
|