ICU 73.2 73.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"
15#include "unicode/measunit.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
48 public:
49
55 : fData(nullptr), fErrorCode(U_INVALID_STATE_ERROR) {}
56
62
67 virtual ~FormattedNumber() override;
68
71
74
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
142
143#ifndef U_HIDE_DRAFT_API
144
153
154#endif // U_HIDE_DRAFT_API
155
156#ifndef U_HIDE_INTERNAL_API
157
162 void getDecimalQuantity(impl::DecimalQuantity& output, UErrorCode& status) const;
163
168 void getAllFieldPositionsImpl(FieldPositionIteratorHandler& fpih, UErrorCode& status) const;
169
170#endif /* U_HIDE_INTERNAL_API */
171
172 private:
173 // Can't use LocalPointer because UFormattedNumberData is forward-declared
174 impl::UFormattedNumberData *fData;
175
176 // Error code for the terminal methods
177 UErrorCode fErrorCode;
178
183 explicit FormattedNumber(impl::UFormattedNumberData *results)
184 : fData(results), fErrorCode(U_ZERO_ERROR) {}
185
186 explicit FormattedNumber(UErrorCode errorCode)
187 : fData(nullptr), fErrorCode(errorCode) {}
188
189 void toDecimalNumber(ByteSink& sink, UErrorCode& status) const;
190
191 // To give LocalizedNumberFormatter format methods access to this class's constructor:
192 friend class LocalizedNumberFormatter;
193 friend class SimpleNumberFormatter;
194
195 // To give C API access to internals
196 friend struct impl::UFormattedNumberImpl;
197};
198
199template<typename StringClass>
200StringClass FormattedNumber::toDecimalNumber(UErrorCode& status) const {
201 StringClass result;
202 StringByteSink<StringClass> sink(&result);
203 toDecimalNumber(sink, status);
204 return result;
205}
206
207} // namespace number
208U_NAMESPACE_END
209
210#endif /* #if !UCONFIG_NO_FORMATTING */
211
212#endif /* U_SHOW_CPLUSPLUS_API */
213
214#endif // __FORMATTEDNUMBER_H__
215
Base class for objects to which Unicode characters and strings can be appended.
Definition appendable.h:54
A ByteSink can be filled with bytes.
Definition bytestream.h:53
Represents a span of a string containing a given field.
An abstract formatted value: a string with associated field attributes.
A unit such as length, mass, volume, currency, etc.
Definition measunit.h:369
Implementation of ByteSink that writes to a "string".
Definition bytestream.h:267
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:296
The result of a number formatting operation.
void getDecimalQuantity(impl::DecimalQuantity &output, UErrorCode &status) const
Gets the raw DecimalQuantity for plural rule selection.
UDisplayOptionsNounClass getNounClass(UErrorCode &status) const
Gets the noun class of the formatted output.
FormattedNumber & operator=(const FormattedNumber &)=delete
Copying not supported; use move assignment instead.
FormattedNumber(const FormattedNumber &)=delete
Copying not supported; use move constructor instead.
MeasureUnit getOutputUnit(UErrorCode &status) const
Gets the resolved output unit.
FormattedNumber()
Default constructor; makes an empty FormattedNumber.
void getAllFieldPositionsImpl(FieldPositionIteratorHandler &fpih, UErrorCode &status) const
Populates the mutable builder type FieldPositionIteratorHandler.
Appendable & appendTo(Appendable &appendable, UErrorCode &status) const override
Appends the formatted string to an Appendable.
virtual ~FormattedNumber() override
Destruct an instance of FormattedNumber.
UnicodeString toString(UErrorCode &status) const override
Returns the formatted string as a self-contained UnicodeString.
FormattedNumber & operator=(FormattedNumber &&src) noexcept
Move assignment: Leaves the source FormattedNumber in an undefined state.
FormattedNumber(FormattedNumber &&src) noexcept
Move constructor: Leaves the source FormattedNumber in an undefined state.
UBool nextPosition(ConstrainedFieldPosition &cfpos, UErrorCode &status) const override
Iterates over field positions in the FormattedValue.
UnicodeString toTempString(UErrorCode &status) const override
Returns the formatted string as a read-only alias to memory owned by the FormattedValue.
C++ API: Abstract operations for localized strings.
C++ API: A unit for measuring a quantity.
C API: Display options (enum types, values, helper functions)
UDisplayOptionsNounClass
Represents all the grammatical noun classes that are supported by CLDR.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
C++ API: Common ICU base class UObject.
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