ICU 69.1  69.1
listformatter.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 *******************************************************************************
5 *
6 * Copyright (C) 2012-2016, International Business Machines
7 * Corporation and others. All Rights Reserved.
8 *
9 *******************************************************************************
10 * file name: listformatter.h
11 * encoding: UTF-8
12 * tab size: 8 (not used)
13 * indentation:4
14 *
15 * created on: 20120426
16 * created by: Umesh P. Nair
17 */
18 
19 #ifndef __LISTFORMATTER_H__
20 #define __LISTFORMATTER_H__
21 
22 #include "unicode/utypes.h"
23 
24 #if U_SHOW_CPLUSPLUS_API
25 
26 #if !UCONFIG_NO_FORMATTING
27 
28 #include "unicode/unistr.h"
29 #include "unicode/locid.h"
30 #include "unicode/formattedvalue.h"
31 #include "unicode/ulistformatter.h"
32 
33 U_NAMESPACE_BEGIN
34 
35 class FieldPositionHandler;
36 class FormattedListData;
37 class ListFormatter;
38 
40 class Hashtable;
41 
43 struct ListFormatInternal;
44 
45 /* The following can't be #ifndef U_HIDE_INTERNAL_API, needed for other .h file declarations */
50 struct ListFormatData : public UMemory {
51  UnicodeString twoPattern;
52  UnicodeString startPattern;
53  UnicodeString middlePattern;
54  UnicodeString endPattern;
55  Locale locale;
56 
57  ListFormatData(const UnicodeString& two, const UnicodeString& start, const UnicodeString& middle, const UnicodeString& end,
58  const Locale& loc) :
59  twoPattern(two), startPattern(start), middlePattern(middle), endPattern(end), locale(loc) {}
60 };
87  public:
92  FormattedList() : fData(nullptr), fErrorCode(U_INVALID_STATE_ERROR) {}
93 
99 
105 
107  FormattedList(const FormattedList&) = delete;
108 
110  FormattedList& operator=(const FormattedList&) = delete;
111 
117 
119  UnicodeString toString(UErrorCode& status) const U_OVERRIDE;
120 
122  UnicodeString toTempString(UErrorCode& status) const U_OVERRIDE;
123 
125  Appendable &appendTo(Appendable& appendable, UErrorCode& status) const U_OVERRIDE;
126 
128  UBool nextPosition(ConstrainedFieldPosition& cfpos, UErrorCode& status) const U_OVERRIDE;
129 
130  private:
131  FormattedListData *fData;
132  UErrorCode fErrorCode;
133  explicit FormattedList(FormattedListData *results)
134  : fData(results), fErrorCode(U_ZERO_ERROR) {}
135  explicit FormattedList(UErrorCode errorCode)
136  : fData(nullptr), fErrorCode(errorCode) {}
137  friend class ListFormatter;
138 };
139 
140 
152 
153  public:
154 
160 
166 
176 
186  static ListFormatter* createInstance(const Locale& locale, UErrorCode& errorCode);
187 
199  const Locale& locale, UListFormatterType type, UListFormatterWidth width, UErrorCode& errorCode);
200 
206  virtual ~ListFormatter();
207 
208 
219  UnicodeString& format(const UnicodeString items[], int32_t n_items,
220  UnicodeString& appendTo, UErrorCode& errorCode) const;
221 
234  const UnicodeString items[],
235  int32_t n_items,
236  UErrorCode& errorCode) const;
237 
238 #ifndef U_HIDE_INTERNAL_API
243  const UnicodeString items[],
244  int32_t n_items,
245  UnicodeString& appendTo,
246  int32_t index,
247  int32_t &offset,
248  UErrorCode& errorCode) const;
252  ListFormatter(const ListFormatData &data, UErrorCode &errorCode);
256  ListFormatter(const ListFormatInternal* listFormatterInternal);
257 #endif /* U_HIDE_INTERNAL_API */
258 
259  private:
260 
267  static ListFormatter* createInstance(const Locale& locale, const char* style, UErrorCode& errorCode);
268 
269  static void initializeHash(UErrorCode& errorCode);
270  static const ListFormatInternal* getListFormatInternal(const Locale& locale, const char *style, UErrorCode& errorCode);
271  struct ListPatternsSink;
272  static ListFormatInternal* loadListFormatInternal(const Locale& locale, const char* style, UErrorCode& errorCode);
273 
274  UnicodeString& format_(
275  const UnicodeString items[], int32_t n_items, UnicodeString& appendTo,
276  int32_t index, int32_t &offset, FieldPositionHandler* handler, UErrorCode& errorCode) const;
277 
278  ListFormatter();
279 
280  ListFormatInternal* owned;
281  const ListFormatInternal* data;
282 };
283 
284 U_NAMESPACE_END
285 
286 #endif /* #if !UCONFIG_NO_FORMATTING */
287 
288 #endif /* U_SHOW_CPLUSPLUS_API */
289 
290 #endif // __LISTFORMATTER_H__
Base class for objects to which Unicode characters and strings can be appended.
Definition: appendable.h:54
Represents a span of a string containing a given field.
An immutable class containing the result of a list formatting operation.
Definition: listformatter.h:86
FormattedList(FormattedList &&src) U_NOEXCEPT
Move constructor: Leaves the source FormattedList in an undefined state.
virtual ~FormattedList() U_OVERRIDE
Destruct an instance of FormattedList.
FormattedList()
Default constructor; makes an empty FormattedList.
Definition: listformatter.h:92
An abstract formatted value: a string with associated field attributes.
An immutable class for formatting a list, using data from CLDR (or supplied separately).
static ListFormatter * createInstance(UErrorCode &errorCode)
Creates a ListFormatter appropriate for the default locale.
static ListFormatter * createInstance(const Locale &locale, UErrorCode &errorCode)
Creates a ListFormatter appropriate for a locale.
ListFormatter(const ListFormatInternal *listFormatterInternal)
virtual ~ListFormatter()
Destructor.
static ListFormatter * createInstance(const Locale &locale, UListFormatterType type, UListFormatterWidth width, UErrorCode &errorCode)
Creates a ListFormatter for the given locale, list type, and style.
FormattedList formatStringsToValue(const UnicodeString items[], int32_t n_items, UErrorCode &errorCode) const
Formats a list of strings to a FormattedList, which exposes field position information.
ListFormatter(const ListFormatter &)
Copy constructor.
ListFormatter(const ListFormatData &data, UErrorCode &errorCode)
ListFormatter & operator=(const ListFormatter &other)
Assignment operator.
UnicodeString & format(const UnicodeString items[], int32_t n_items, UnicodeString &appendTo, int32_t index, int32_t &offset, UErrorCode &errorCode) const
UnicodeString & format(const UnicodeString items[], int32_t n_items, UnicodeString &appendTo, UErrorCode &errorCode) const
Formats a list of strings.
A Locale object represents a specific geographical, political, or cultural region.
Definition: locid.h:195
UMemory is the common ICU base class.
Definition: uobject.h:115
UObject is the common ICU "boilerplate" class.
Definition: uobject.h:223
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:296
C++ API: Abstract operations for localized strings.
C++ API: Locale ID object.
#define U_NOEXCEPT
"noexcept" if supported, otherwise empty.
Definition: platform.h:529
C API: Format a list in a locale-appropriate way.
UListFormatterWidth
Verbosity level of the list patterns.
UListFormatterType
Type of meaning expressed by the list.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_OVERRIDE
Defined to the C++11 "override" keyword if available.
Definition: umachine.h:130
C++ API: Unicode String.
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
@ U_INVALID_STATE_ERROR
Requested operation can not be completed with ICU in its current state.
Definition: utypes.h:478
@ U_ZERO_ERROR
No error, no warning.
Definition: utypes.h:449
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301