1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
|
// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
**********************************************************************
* Copyright (c) 2014-2016, International Business Machines
* Corporation and others. All Rights Reserved.
**********************************************************************
*/
#ifndef SCINUMBERFORMATTER_H
#define SCINUMBERFORMATTER_H
#include "unicode/utypes.h"
#if U_SHOW_CPLUSPLUS_API
#if !UCONFIG_NO_FORMATTING
#include "unicode/unistr.h"
/**
* \file
* \brief C++ API: Formats in scientific notation.
*/
U_NAMESPACE_BEGIN
class FieldPositionIterator;
class DecimalFormatSymbols;
class DecimalFormat;
class Formattable;
/**
* A formatter that formats numbers in user-friendly scientific notation.
*
* Sample code:
* <pre>
* UErrorCode status = U_ZERO_ERROR;
* LocalPointer<ScientificNumberFormatter> fmt(
* ScientificNumberFormatter::createMarkupInstance(
* "en", "<sup>", "</sup>", status));
* if (U_FAILURE(status)) {
* return;
* }
* UnicodeString appendTo;
* // appendTo = "1.23456x10<sup>-78</sup>"
* fmt->format(1.23456e-78, appendTo, status);
* </pre>
*
* @stable ICU 55
*/
class U_I18N_API ScientificNumberFormatter : public UObject {
public:
/**
* Creates a ScientificNumberFormatter instance that uses
* superscript characters for exponents.
* @param fmtToAdopt The DecimalFormat which must be configured for
* scientific notation.
* @param status error returned here.
* @return The new ScientificNumberFormatter instance.
*
* @stable ICU 55
*/
static ScientificNumberFormatter *createSuperscriptInstance(
DecimalFormat *fmtToAdopt, UErrorCode &status);
/**
* Creates a ScientificNumberFormatter instance that uses
* superscript characters for exponents for this locale.
* @param locale The locale
* @param status error returned here.
* @return The ScientificNumberFormatter instance.
*
* @stable ICU 55
*/
static ScientificNumberFormatter *createSuperscriptInstance(
const Locale &locale, UErrorCode &status);
/**
* Creates a ScientificNumberFormatter instance that uses
* markup for exponents.
* @param fmtToAdopt The DecimalFormat which must be configured for
* scientific notation.
* @param beginMarkup the markup to start superscript.
* @param endMarkup the markup to end superscript.
* @param status error returned here.
* @return The new ScientificNumberFormatter instance.
*
* @stable ICU 55
*/
static ScientificNumberFormatter *createMarkupInstance(
DecimalFormat *fmtToAdopt,
const UnicodeString &beginMarkup,
const UnicodeString &endMarkup,
UErrorCode &status);
/**
* Creates a ScientificNumberFormatter instance that uses
* markup for exponents for this locale.
* @param locale The locale
* @param beginMarkup the markup to start superscript.
* @param endMarkup the markup to end superscript.
* @param status error returned here.
* @return The ScientificNumberFormatter instance.
*
* @stable ICU 55
*/
static ScientificNumberFormatter *createMarkupInstance(
const Locale &locale,
const UnicodeString &beginMarkup,
const UnicodeString &endMarkup,
UErrorCode &status);
/**
* Returns a copy of this object. Caller must free returned copy.
* @stable ICU 55
*/
ScientificNumberFormatter *clone() const {
return new ScientificNumberFormatter(*this);
}
/**
* Destructor.
* @stable ICU 55
*/
virtual ~ScientificNumberFormatter();
/**
* Formats a number into user friendly scientific notation.
*
* @param number the number to format.
* @param appendTo formatted string appended here.
* @param status any error returned here.
* @return appendTo
*
* @stable ICU 55
*/
UnicodeString &format(
const Formattable &number,
UnicodeString &appendTo,
UErrorCode &status) const;
private:
class U_I18N_API Style : public UObject {
public:
virtual Style *clone() const = 0;
protected:
virtual UnicodeString &format(
const UnicodeString &original,
FieldPositionIterator &fpi,
const UnicodeString &preExponent,
UnicodeString &appendTo,
UErrorCode &status) const = 0;
private:
friend class ScientificNumberFormatter;
};
class U_I18N_API SuperscriptStyle : public Style {
public:
virtual SuperscriptStyle *clone() const;
protected:
virtual UnicodeString &format(
const UnicodeString &original,
FieldPositionIterator &fpi,
const UnicodeString &preExponent,
UnicodeString &appendTo,
UErrorCode &status) const;
};
class U_I18N_API MarkupStyle : public Style {
public:
MarkupStyle(
const UnicodeString &beginMarkup,
const UnicodeString &endMarkup)
: Style(),
fBeginMarkup(beginMarkup),
fEndMarkup(endMarkup) { }
virtual MarkupStyle *clone() const;
protected:
virtual UnicodeString &format(
const UnicodeString &original,
FieldPositionIterator &fpi,
const UnicodeString &preExponent,
UnicodeString &appendTo,
UErrorCode &status) const;
private:
UnicodeString fBeginMarkup;
UnicodeString fEndMarkup;
};
ScientificNumberFormatter(
DecimalFormat *fmtToAdopt,
Style *styleToAdopt,
UErrorCode &status);
ScientificNumberFormatter(const ScientificNumberFormatter &other);
ScientificNumberFormatter &operator=(const ScientificNumberFormatter &);
static void getPreExponent(
const DecimalFormatSymbols &dfs, UnicodeString &preExponent);
static ScientificNumberFormatter *createInstance(
DecimalFormat *fmtToAdopt,
Style *styleToAdopt,
UErrorCode &status);
UnicodeString fPreExponent;
DecimalFormat *fDecimalFormat;
Style *fStyle;
};
U_NAMESPACE_END
#endif /* !UCONFIG_NO_FORMATTING */
#endif /* U_SHOW_CPLUSPLUS_API */
#endif
|
