numberrangeformatter.h

Go to the documentation of this file.

// © 2018 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
 
#ifndef __NUMBERRANGEFORMATTER_H__
#define __NUMBERRANGEFORMATTER_H__
 
#include "unicode/utypes.h"
 
#if U_SHOW_CPLUSPLUS_API
 
#if !UCONFIG_NO_FORMATTING
 
#include <atomic>
#include "unicode/appendable.h"
#include "unicode/fieldpos.h"
#include "unicode/formattedvalue.h"
#include "unicode/fpositer.h"
#include "unicode/numberformatter.h"
#include "unicode/unumberrangeformatter.h"
 
U_NAMESPACE_BEGIN
 
// Forward declarations:
class PluralRules;
 
namespace number {  // icu::number
 
// Forward declarations:
class UnlocalizedNumberRangeFormatter;
class LocalizedNumberRangeFormatter;
class FormattedNumberRange;
 
namespace impl {
 
// Forward declarations:
struct RangeMacroProps;
class DecimalQuantity;
class UFormattedNumberRangeData;
class NumberRangeFormatterImpl;
struct UFormattedNumberRangeImpl;
 
} // namespace impl
 
#if U_PLATFORM == U_PF_WINDOWS && !defined(U_IN_DOXYGEN) && !defined(U_STATIC_IMPLEMENTATION)
} // namespace icu::number
U_NAMESPACE_END
 
template struct U_I18N_API std::atomic< U_NAMESPACE_QUALIFIER number::impl::NumberRangeFormatterImpl*>;
 
U_NAMESPACE_BEGIN
namespace number {  // icu::number
#endif
// Other helper classes would go here, but there are none.
 
namespace impl {  // icu::number::impl
 
// Do not enclose entire MacroProps with #ifndef U_HIDE_INTERNAL_API, needed for a protected field
struct U_I18N_API RangeMacroProps : public UMemory {
    UnlocalizedNumberFormatter formatter1; // = NumberFormatter::with();
 
    UnlocalizedNumberFormatter formatter2; // = NumberFormatter::with();
 
    bool singleFormatter = true;
 
    UNumberRangeCollapse collapse = UNUM_RANGE_COLLAPSE_AUTO;
 
    UNumberRangeIdentityFallback identityFallback = UNUM_IDENTITY_FALLBACK_APPROXIMATELY;
 
    Locale locale;
 
    // NOTE: Uses default copy and move constructors.
 
    bool copyErrorTo(UErrorCode &status) const {
        return formatter1.copyErrorTo(status) || formatter2.copyErrorTo(status);
    }
};
 
} // namespace impl
 
template<typename Derived>
class U_I18N_API NumberRangeFormatterSettings {
  public:
    Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) const &;
 
    Derived numberFormatterBoth(const UnlocalizedNumberFormatter &formatter) &&;
 
    Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) const &;
 
    Derived numberFormatterBoth(UnlocalizedNumberFormatter &&formatter) &&;
 
    Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) const &;
 
    Derived numberFormatterFirst(const UnlocalizedNumberFormatter &formatterFirst) &&;
 
    Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) const &;
 
    Derived numberFormatterFirst(UnlocalizedNumberFormatter &&formatterFirst) &&;
 
    Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) const &;
 
    Derived numberFormatterSecond(const UnlocalizedNumberFormatter &formatterSecond) &&;
 
    Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) const &;
 
    Derived numberFormatterSecond(UnlocalizedNumberFormatter &&formatterSecond) &&;
 
    Derived collapse(UNumberRangeCollapse collapse) const &;
 
    Derived collapse(UNumberRangeCollapse collapse) &&;
 
    Derived identityFallback(UNumberRangeIdentityFallback identityFallback) const &;
 
    Derived identityFallback(UNumberRangeIdentityFallback identityFallback) &&;
 
    LocalPointer<Derived> clone() const &;
 
    LocalPointer<Derived> clone() &&;
 
    UBool copyErrorTo(UErrorCode &outErrorCode) const {
        if (U_FAILURE(outErrorCode)) {
            // Do not overwrite the older error code
            return true;
        }
        fMacros.copyErrorTo(outErrorCode);
        return U_FAILURE(outErrorCode);
    }
 
    // NOTE: Uses default copy and move constructors.
 
  private:
    impl::RangeMacroProps fMacros;
 
    // Don't construct me directly!  Use (Un)LocalizedNumberFormatter.
    NumberRangeFormatterSettings() = default;
 
    friend class LocalizedNumberRangeFormatter;
    friend class UnlocalizedNumberRangeFormatter;
};
 
// Explicit instantiations in source/i18n/numrange_fluent.cpp.
// (MSVC treats imports/exports of explicit instantiations differently.)
#ifndef _MSC_VER
extern template class NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>;
extern template class NumberRangeFormatterSettings<LocalizedNumberRangeFormatter>;
#endif
 
class U_I18N_API UnlocalizedNumberRangeFormatter
        : public NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>, public UMemory {
 
  public:
    LocalizedNumberRangeFormatter locale(const icu::Locale &locale) const &;
 
    LocalizedNumberRangeFormatter locale(const icu::Locale &locale) &&;
 
    UnlocalizedNumberRangeFormatter() = default;
 
    UnlocalizedNumberRangeFormatter(const UnlocalizedNumberRangeFormatter &other);
 
    UnlocalizedNumberRangeFormatter(UnlocalizedNumberRangeFormatter&& src) noexcept;
 
    UnlocalizedNumberRangeFormatter& operator=(const UnlocalizedNumberRangeFormatter& other);
 
    UnlocalizedNumberRangeFormatter& operator=(UnlocalizedNumberRangeFormatter&& src) noexcept;
 
  private:
    explicit UnlocalizedNumberRangeFormatter(
            const NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>& other);
 
    explicit UnlocalizedNumberRangeFormatter(
            NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>&& src) noexcept;
 
    explicit UnlocalizedNumberRangeFormatter(const impl::RangeMacroProps &macros);
 
    explicit UnlocalizedNumberRangeFormatter(impl::RangeMacroProps &&macros);
 
    // To give the fluent setters access to this class's constructor:
    friend class NumberRangeFormatterSettings<UnlocalizedNumberRangeFormatter>;
 
    // To give NumberRangeFormatter::with() access to this class's constructor: