ICU 67.1  67.1
numberrangeformatter.h
Go to the documentation of this file.
1 // © 2018 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 
4 #ifndef __NUMBERRANGEFORMATTER_H__
5 #define __NUMBERRANGEFORMATTER_H__
6 
7 #include "unicode/utypes.h"
8 
9 #if U_SHOW_CPLUSPLUS_API
10 
11 #if !UCONFIG_NO_FORMATTING
12 
13 #include <atomic>
14 #include "unicode/appendable.h"
15 #include "unicode/fieldpos.h"
16 #include "unicode/formattedvalue.h"
17 #include "unicode/fpositer.h"
19 
52 typedef enum UNumberRangeCollapse {
62 
69 
77 
86 
101 
109 
117 
126 
142 
150 
158 
159 #ifndef U_HIDE_INTERNAL_API
165 #endif
166 
168 
169 U_NAMESPACE_BEGIN
170 
171 namespace number { // icu::number
172 
173 // Forward declarations:
174 class UnlocalizedNumberRangeFormatter;
175 class LocalizedNumberRangeFormatter;
176 class FormattedNumberRange;
177 
178 namespace impl {
179 
180 // Forward declarations:
181 struct RangeMacroProps;
182 class DecimalQuantity;
183 class UFormattedNumberRangeData;
184 class NumberRangeFormatterImpl;
185 
186 } // namespace impl
187 
193 #if U_PLATFORM == U_PF_WINDOWS && !defined(U_IN_DOXYGEN)
194 } // namespace icu::number
195 U_NAMESPACE_END
196 
197 template struct U_I18N_API std::atomic< U_NAMESPACE_QUALIFIER number::impl::NumberRangeFormatterImpl*>;
198 
199 U_NAMESPACE_BEGIN
200 namespace number { // icu::number
201 #endif
204 // Other helper classes would go here, but there are none.
205 
206 namespace impl { // icu::number::impl
207 
208 // Do not enclose entire MacroProps with #ifndef U_HIDE_INTERNAL_API, needed for a protected field
212  UnlocalizedNumberFormatter formatter1; // = NumberFormatter::with();
213 
215  UnlocalizedNumberFormatter formatter2; // = NumberFormatter::with();
216 
218  bool singleFormatter = true;
219 
222 
225 
228 
229  // NOTE: Uses default copy and move constructors.
230 
235  bool copyErrorTo(UErrorCode &status) const {
236  return formatter1.copyErrorTo(status) || formatter2.copyErrorTo(status);
237  }
238 };
239 
240 } // namespace impl
241 
247 template<typename Derived>
249  public:
262  Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) const &;
263 
273  Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) &&;
274 
284  Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) const &;
285 
296 
308  Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) const &;
309 
319  Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) &&;
320 
330  Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) const &;
331 
341  Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) &&;
342 
354  Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) const &;
355 
365  Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) &&;
366 
376  Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) const &;
377 
387  Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) &&;
388 
406  Derived collapse(UNumberRangeCollapse collapse) const &;
407 
417  Derived collapse(UNumberRangeCollapse collapse) &&;
418 
439  Derived identityFallback(UNumberRangeIdentityFallback identityFallback) const &;
440 
450  Derived identityFallback(UNumberRangeIdentityFallback identityFallback) &&;
451 
464 
472  LocalPointer<Derived> clone() &&;
473 
480  UBool copyErrorTo(UErrorCode &outErrorCode) const {
481  if (U_FAILURE(outErrorCode)) {
482  // Do not overwrite the older error code
483  return TRUE;
484  }
485  fMacros.copyErrorTo(outErrorCode);
486  return U_FAILURE(outErrorCode);
487  }
488 
489  // NOTE: Uses default copy and move constructors.
490 
491  private:
492  impl::RangeMacroProps fMacros;
493 
494  // Don't construct me directly! Use (Un)LocalizedNumberFormatter.
495  NumberRangeFormatterSettings() = default;
496 
497  friend class LocalizedNumberRangeFormatter;
498  friend class UnlocalizedNumberRangeFormatter;
499 };
500 
511 
512  public:
523 
534 
541 
547 
554 
560 
567 
568  private:
571 
574 
575  // To give the fluent setters access to this class's constructor:
577 
578  // To give NumberRangeFormatter::with() access to this class's constructor:
579  friend class NumberRangeFormatter;
580 };
581 
592  public:
607  const Formattable& first, const Formattable& second, UErrorCode& status) const;
608 
615 
621 
628 
634 
641 
642 #ifndef U_HIDE_INTERNAL_API
643 
654  void formatImpl(impl::UFormattedNumberRangeData& results, bool equalBeforeRounding,
655  UErrorCode& status) const;
656 
657 #endif /* U_HIDE_INTERNAL_API */
658 
664 
665  private:
666  std::atomic<impl::NumberRangeFormatterImpl*> fAtomicFormatter = {};
667 
668  const impl::NumberRangeFormatterImpl* getFormatter(UErrorCode& stauts) const;
669 
672 
675 
676  LocalizedNumberRangeFormatter(const impl::RangeMacroProps &macros, const Locale &locale);
677 
679 
680  void clear();
681 
682  // To give the fluent setters access to this class's constructor:
685 
686  // To give UnlocalizedNumberRangeFormatter::locale() access to this class's constructor:
687  friend class UnlocalizedNumberRangeFormatter;
688 };
689 
699  public:
700  // Copybrief: this method is older than the parent method
709 
710  // Copydoc: this method is new in ICU 64
713 
714  // Copybrief: this method is older than the parent method
722  Appendable &appendTo(Appendable &appendable, UErrorCode& status) const U_OVERRIDE;
723 
724  // Copydoc: this method is new in ICU 64
727 
728 #ifndef U_HIDE_DRAFT_API
744 
760 #endif // U_HIDE_DRAFT_API
761 
772 
777 
782 
789 
796 
802 
803  private:
804  // Can't use LocalPointer because UFormattedNumberRangeData is forward-declared
805  const impl::UFormattedNumberRangeData *fData;
806 
807  // Error code for the terminal methods
808  UErrorCode fErrorCode;
809 
813  explicit FormattedNumberRange(impl::UFormattedNumberRangeData *results)
814  : fData(results), fErrorCode(U_ZERO_ERROR) {}
815 
816  explicit FormattedNumberRange(UErrorCode errorCode)
817  : fData(nullptr), fErrorCode(errorCode) {}
818 
819  void getAllFieldPositionsImpl(FieldPositionIteratorHandler& fpih, UErrorCode& status) const;
820 
821  // To give LocalizedNumberRangeFormatter format methods access to this class's constructor:
822  friend class LocalizedNumberRangeFormatter;
823 };
824 
831  public:
840 
851 
856 };
857 
858 } // namespace number
859 U_NAMESPACE_END
860 
861 #endif /* #if !UCONFIG_NO_FORMATTING */
862 
863 #endif /* U_SHOW_CPLUSPLUS_API */
864 
865 #endif // __NUMBERRANGEFORMATTER_H__
866 
C++ API: Appendable class: Sink for Unicode code points and 16-bit code units (char16_ts).
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.
Formattable objects can be passed to the Format class or its subclasses for formatting.
Definition: fmtable.h:64
An abstract formatted value: a string with associated field attributes.
"Smart pointer" class, deletes objects via the standard C++ delete operator.
Definition: localpointer.h:191
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
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition: unistr.h:295
The result of a number range formatting operation.
UnicodeString getFirstDecimal(UErrorCode &status) const
Export the first formatted number as a decimal number.
UnicodeString toString(UErrorCode &status) const U_OVERRIDE
Returns the formatted string as a self-contained UnicodeString.
FormattedNumberRange(const FormattedNumberRange &)=delete
Copying not supported; use move constructor instead.
FormattedNumberRange & operator=(FormattedNumberRange &&src) U_NOEXCEPT
Move assignment: Leaves the source FormattedNumberRange in an undefined state.
FormattedNumberRange(FormattedNumberRange &&src) U_NOEXCEPT
Move constructor: Leaves the source FormattedNumberRange in an undefined state.
UNumberRangeIdentityResult getIdentityResult(UErrorCode &status) const
Returns whether the pair of numbers was successfully formatted as a range or whether an identity fall...
UnicodeString getSecondDecimal(UErrorCode &status) const
Export the second formatted number as a decimal number.
Appendable & appendTo(Appendable &appendable, UErrorCode &status) const U_OVERRIDE
Appends the formatted string to an Appendable.
UnicodeString toTempString(UErrorCode &status) const U_OVERRIDE
Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
UBool nextPosition(ConstrainedFieldPosition &cfpos, UErrorCode &status) const U_OVERRIDE
Iterates over field positions in the FormattedValue.
FormattedNumberRange & operator=(const FormattedNumberRange &)=delete
Copying not supported; use move assignment instead.
~FormattedNumberRange()
Destruct an instance of FormattedNumberRange, cleaning up any memory it might own.
A NumberRangeFormatter that has a locale associated with it; this means .formatRange() methods are av...
FormattedNumberRange formatFormattableRange(const Formattable &first, const Formattable &second, UErrorCode &status) const
Format the given Formattables to a string using the settings specified in the NumberRangeFormatter fl...
LocalizedNumberRangeFormatter & operator=(LocalizedNumberRangeFormatter &&src) U_NOEXCEPT
Move assignment operator: The source LocalizedNumberRangeFormatter will be left in a valid but undefi...
LocalizedNumberRangeFormatter & operator=(const LocalizedNumberRangeFormatter &other)
Copy assignment operator.
LocalizedNumberRangeFormatter()=default
Default constructor: puts the formatter into a valid but undefined state.
LocalizedNumberRangeFormatter(const LocalizedNumberRangeFormatter &other)
Returns a copy of this LocalizedNumberRangeFormatter.
void formatImpl(impl::UFormattedNumberRangeData &results, bool equalBeforeRounding, UErrorCode &status) const
LocalizedNumberRangeFormatter(LocalizedNumberRangeFormatter &&src) U_NOEXCEPT
Move constructor: The source LocalizedNumberRangeFormatter will be left in a valid but undefined stat...
~LocalizedNumberRangeFormatter()
Destruct this LocalizedNumberRangeFormatter, cleaning up any memory it might own.
UBool copyErrorTo(UErrorCode &outErrorCode) const
Sets the UErrorCode if an error occurred in the fluent chain.
An abstract base class for specifying settings related to number formatting.
Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) &&
Overload of numberFormatterSecond() for use on an rvalue reference.
Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) const &
Overload of numberFormatterFirst() for use on an rvalue reference.
Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) &&
Overload of numberFormatterBoth() for use on an rvalue reference.
Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) &&
Overload of numberFormatterFirst() for use on an rvalue reference.
Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) &&
Overload of numberFormatterBoth() for use on an rvalue reference.
Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) const &
Sets the NumberFormatter instance to use for the numbers in the range.
Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) const &
Overload of numberFormatterBoth() for use on an rvalue reference.
Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) &&
Overload of numberFormatterFirst() for use on an rvalue reference.
Derived identityFallback(UNumberRangeIdentityFallback identityFallback) const &
Sets the behavior when the two sides of the range are the same.
Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) const &
Sets the NumberFormatter instance to use for the first number in the range.
Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) const &
Overload of numberFormatterSecond() for use on an rvalue reference.
Derived collapse(UNumberRangeCollapse collapse) &&
Overload of collapse() for use on an rvalue reference.
Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) const &
Sets the NumberFormatter instance to use for the second number in the range.
Derived collapse(UNumberRangeCollapse collapse) const &
Sets the aggressiveness of "collapsing" fields across the range separator.
Derived identityFallback(UNumberRangeIdentityFallback identityFallback) &&
Overload of identityFallback() for use on an rvalue reference.
Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) &&
Overload of numberFormatterSecond() for use on an rvalue reference.
LocalPointer< Derived > clone() const &
Returns the current (Un)LocalizedNumberRangeFormatter as a LocalPointer wrapping a heap-allocated cop...
See the main description in numberrangeformatter.h for documentation and examples.
static UnlocalizedNumberRangeFormatter with()
Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is not c...
NumberRangeFormatter()=delete
Use factory methods instead of the constructor to create a NumberFormatter.
static LocalizedNumberRangeFormatter withLocale(const Locale &locale)
Call this method at the beginning of a NumberRangeFormatter fluent chain in which the locale is known...
A NumberFormatter that does not yet have a locale.
A NumberRangeFormatter that does not yet have a locale.
UnlocalizedNumberRangeFormatter & operator=(UnlocalizedNumberRangeFormatter &&src) U_NOEXCEPT
Move assignment operator: The source UnlocalizedNumberRangeFormatter will be left in a valid but unde...
UnlocalizedNumberRangeFormatter(UnlocalizedNumberRangeFormatter &&src) U_NOEXCEPT
Move constructor: The source UnlocalizedNumberRangeFormatter will be left in a valid but undefined st...
UnlocalizedNumberRangeFormatter(const UnlocalizedNumberRangeFormatter &other)
Returns a copy of this UnlocalizedNumberRangeFormatter.
LocalizedNumberRangeFormatter locale(const icu::Locale &locale) const &
Associate the given locale with the number range formatter.
LocalizedNumberRangeFormatter locale(const icu::Locale &locale) &&
Overload of locale() for use on an rvalue reference.
UnlocalizedNumberRangeFormatter & operator=(const UnlocalizedNumberRangeFormatter &other)
Copy assignment operator.
UnlocalizedNumberRangeFormatter()=default
Default constructor: puts the formatter into a valid but undefined state.
C++ API: FieldPosition identifies the fields in a formatted output.
C++ API: Abstract operations for localized strings.
C++ API: FieldPosition Iterator.
C++ API: Library for localized number formatting introduced in ICU 60.
UNumberRangeIdentityResult
Used in the result class FormattedNumberRange to indicate to the user whether the numbers formatted i...
@ UNUM_IDENTITY_RESULT_EQUAL_BEFORE_ROUNDING
Used to indicate that the two numbers in the range were equal, even before any rounding rules were ap...
@ UNUM_IDENTITY_RESULT_NOT_EQUAL
Used to indicate that the two numbers in the range were not equal, even after rounding rules were app...
@ UNUM_IDENTITY_RESULT_EQUAL_AFTER_ROUNDING
Used to indicate that the two numbers in the range were equal, but only after rounding rules were app...
@ UNUM_IDENTITY_RESULT_COUNT
The number of entries in this enum.
UNumberRangeIdentityFallback
Defines the behavior when the two numbers in the range are identical after rounding.
@ UNUM_IDENTITY_FALLBACK_APPROXIMATELY
Show the number using a locale-sensitive approximation pattern.
@ UNUM_IDENTITY_FALLBACK_APPROXIMATELY_OR_SINGLE_VALUE
Show the number using a locale-sensitive approximation pattern.
@ UNUM_IDENTITY_FALLBACK_SINGLE_VALUE
Show the number as a single value rather than a range.
@ UNUM_IDENTITY_FALLBACK_RANGE
Show the number as the range of two equal values.
UNumberRangeCollapse
Defines how to merge fields that are identical across the range sign.
@ UNUM_RANGE_COLLAPSE_ALL
Collapse any field that is equal across the range sign.
@ UNUM_RANGE_COLLAPSE_AUTO
Use locale data and heuristics to determine how much of the string to collapse.
@ UNUM_RANGE_COLLAPSE_UNIT
Collapse the unit part of the number, but not the notation, if present.
@ UNUM_RANGE_COLLAPSE_NONE
Do not collapse any part of the number.
#define U_NOEXCEPT
"noexcept" if supported, otherwise empty.
Definition: platform.h:529
UnlocalizedNumberFormatter formatter2
UnlocalizedNumberFormatter formatter1
bool copyErrorTo(UErrorCode &status) const
Check all members for errors.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:261
#define U_OVERRIDE
Defined to the C++11 "override" keyword if available.
Definition: umachine.h:129
#define TRUE
The TRUE value of a UBool.
Definition: umachine.h:265
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_ZERO_ERROR
No error, no warning.
Definition: utypes.h:449
#define U_FAILURE(x)
Does the error code indicate a failure?
Definition: utypes.h:709
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition: utypes.h:301