ICU 74.2: i18n/unicode/formattednumber.h Source File

ICU 74.2 74.2

formattednumber.h
Go to the documentation of this file.
1// © 2022 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3
4#ifndef __FORMATTEDNUMBER_H__
5#define __FORMATTEDNUMBER_H__
6
7#include "unicode/utypes.h"
8
9#if U_SHOW_CPLUSPLUS_API
10
11#if !UCONFIG_NO_FORMATTING
12
13#include "unicode/uobject.h"
14#include "unicode/formattedvalue.h"
15#include "unicode/measunit.h"
16#include "unicode/udisplayoptions.h"
17
25U_NAMESPACE_BEGIN
26
27class FieldPositionIteratorHandler;
28
29namespace number { // icu::number
30
31namespace impl {
32class DecimalQuantity;
33class UFormattedNumberData;
34struct UFormattedNumberImpl;
35} // icu::number::impl
36
37
38
47 class U_I18N_API FormattedNumber : public UMemory, public FormattedValue {
48 public:
49
54 FormattedNumber()
55 : fData(nullptr), fErrorCode(U_INVALID_STATE_ERROR) {}
56
61 FormattedNumber(FormattedNumber&& src) noexcept;
62
67 virtual ~FormattedNumber() override;
68
70 FormattedNumber(const FormattedNumber&) = delete;
71
73 FormattedNumber& operator=(const FormattedNumber&) = delete;
74
79 FormattedNumber& operator=(FormattedNumber&& src) noexcept;
80
81 // Copybrief: this method is older than the parent method
89 UnicodeString toString(UErrorCode& status) const override;
90
91 // Copydoc: this method is new in ICU 64
93 UnicodeString toTempString(UErrorCode& status) const override;
94
95 // Copybrief: this method is older than the parent method
103 Appendable &appendTo(Appendable& appendable, UErrorCode& status) const override;
104
105 // Copydoc: this method is new in ICU 64
107 UBool nextPosition(ConstrainedFieldPosition& cfpos, UErrorCode& status) const override;
108
127 template<typename StringClass>
128 inline StringClass toDecimalNumber(UErrorCode& status) const;
129
141 MeasureUnit getOutputUnit(UErrorCode& status) const;
142
150 UDisplayOptionsNounClass getNounClass(UErrorCode &status) const;
151
152#ifndef U_HIDE_INTERNAL_API
153
158 void getDecimalQuantity(impl::DecimalQuantity& output, UErrorCode& status) const;
159
164 void getAllFieldPositionsImpl(FieldPositionIteratorHandler& fpih, UErrorCode& status) const;
165
166#endif /* U_HIDE_INTERNAL_API */
167
168 private:
169 // Can't use LocalPointer because UFormattedNumberData is forward-declared
170 impl::UFormattedNumberData *fData;
171
172 // Error code for the terminal methods
173 UErrorCode fErrorCode;
174
179 explicit FormattedNumber(impl::UFormattedNumberData *results)
180 : fData(results), fErrorCode(U_ZERO_ERROR) {}
181
182 explicit FormattedNumber(UErrorCode errorCode)
183 : fData(nullptr), fErrorCode(errorCode) {}
184
185 void toDecimalNumber(ByteSink& sink, UErrorCode& status) const;
186
187 // To give LocalizedNumberFormatter format methods access to this class's constructor:
188 friend class LocalizedNumberFormatter;
189 friend class SimpleNumberFormatter;
190
191 // To give C API access to internals
192 friend struct impl::UFormattedNumberImpl;
193};
194
195template<typename StringClass>
196StringClass FormattedNumber::toDecimalNumber(UErrorCode& status) const {
197 StringClass result;
198 StringByteSink<StringClass> sink(&result);
199 toDecimalNumber(sink, status);
200 return result;
201}
202
203} // namespace number
204U_NAMESPACE_END
205
206#endif /* #if !UCONFIG_NO_FORMATTING */
207
208#endif /* U_SHOW_CPLUSPLUS_API */
209
210#endif // __FORMATTEDNUMBER_H__
211
icu::Appendable
Base class for objects to which Unicode characters and strings can be appended.
Definition appendable.h:54
icu::ByteSink
A ByteSink can be filled with bytes.
Definition bytestream.h:53
icu::ConstrainedFieldPosition
Represents a span of a string containing a given field.
Definition formattedvalue.h:41
icu::FormattedValue
An abstract formatted value: a string with associated field attributes.
Definition formattedvalue.h:241
icu::MeasureUnit
A unit such as length, mass, volume, currency, etc.
Definition measunit.h:369
icu::StringByteSink
Implementation of ByteSink that writes to a "string".
Definition bytestream.h:267
icu::UMemory
UMemory is the common ICU base class.
Definition uobject.h:115
icu::UnicodeString
UnicodeString is a string class that stores Unicode characters directly and provides similar function...
Definition unistr.h:296
icu::number::FormattedNumber
The result of a number formatting operation.
Definition formattednumber.h:47
icu::number::FormattedNumber::getDecimalQuantity
void getDecimalQuantity(impl::DecimalQuantity &output, UErrorCode &status) const
Gets the raw DecimalQuantity for plural rule selection.
icu::number::FormattedNumber::getNounClass
UDisplayOptionsNounClass getNounClass(UErrorCode &status) const
Gets the noun class of the formatted output.
icu::number::FormattedNumber::operator=
FormattedNumber & operator=(const FormattedNumber &)=delete
Copying not supported; use move assignment instead.
icu::number::FormattedNumber::FormattedNumber
FormattedNumber(const FormattedNumber &)=delete
Copying not supported; use move constructor instead.
icu::number::FormattedNumber::getOutputUnit
MeasureUnit getOutputUnit(UErrorCode &status) const
Gets the resolved output unit.
icu::number::FormattedNumber::FormattedNumber
FormattedNumber()
Default constructor; makes an empty FormattedNumber.
Definition formattednumber.h:54
icu::number::FormattedNumber::getAllFieldPositionsImpl
void getAllFieldPositionsImpl(FieldPositionIteratorHandler &fpih, UErrorCode &status) const
Populates the mutable builder type FieldPositionIteratorHandler.
icu::number::FormattedNumber::appendTo
Appendable & appendTo(Appendable &appendable, UErrorCode &status) const override
Appends the formatted string to an Appendable.
icu::number::FormattedNumber::~FormattedNumber
virtual ~FormattedNumber() override
Destruct an instance of FormattedNumber.
icu::number::FormattedNumber::toString
UnicodeString toString(UErrorCode &status) const override
Returns the formatted string as a self-contained UnicodeString.
icu::number::FormattedNumber::operator=
FormattedNumber & operator=(FormattedNumber &&src) noexcept
Move assignment: Leaves the source FormattedNumber in an undefined state.
icu::number::FormattedNumber::FormattedNumber
FormattedNumber(FormattedNumber &&src) noexcept
Move constructor: Leaves the source FormattedNumber in an undefined state.
icu::number::FormattedNumber::nextPosition
UBool nextPosition(ConstrainedFieldPosition &cfpos, UErrorCode &status) const override
Iterates over field positions in the FormattedValue.
icu::number::FormattedNumber::toTempString
UnicodeString toTempString(UErrorCode &status) const override
Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
formattedvalue.h
C++ API: Abstract operations for localized strings.
measunit.h
C++ API: A unit for measuring a quantity.
udisplayoptions.h
C API: Display options (enum types, values, helper functions)
UDisplayOptionsNounClass
UDisplayOptionsNounClass
Represents all the grammatical noun classes that are supported by CLDR.
Definition udisplayoptions.h:134
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
uobject.h
C++ API: Common ICU base class UObject.
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:415
U_INVALID_STATE_ERROR
@ U_INVALID_STATE_ERROR
Requested operation can not be completed with ICU in its current state.
Definition utypes.h:478
U_ZERO_ERROR
@ U_ZERO_ERROR
No error, no warning.
Definition utypes.h:449
U_I18N_API
#define U_I18N_API
Set to export library symbols from inside the i18n library, and to import them from outside.
Definition utypes.h:301