intl/icu/source/i18n/unicode/fmtable.h@fc2d59ddac77
intl/icu/source/i18n/unicode/fmtable.h
Wed, 31 Dec 2014 07:22:50 +0100
- author
- Michael Schloh von Bennewitz <michael@schloh.com>
- date
- Wed, 31 Dec 2014 07:22:50 +0100
- branch
- TOR_BUG_3246
- changeset 4
- fc2d59ddac77
- permissions
- -rw-r--r--
Correct previous dual key logic pending first delivery installment.
1 /*
2 ********************************************************************************
3 * Copyright (C) 1997-2013, International Business Machines
4 * Corporation and others. All Rights Reserved.
5 ********************************************************************************
6 *
7 * File FMTABLE.H
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 02/29/97 aliu Creation.
13 ********************************************************************************
14 */
15 #ifndef FMTABLE_H
16 #define FMTABLE_H
18 #include "unicode/utypes.h"
20 /**
21 * \file
22 * \brief C++ API: Formattable is a thin wrapper for primitive types used for formatting and parsing
23 */
25 #if !UCONFIG_NO_FORMATTING
27 #include "unicode/unistr.h"
28 #include "unicode/stringpiece.h"
29 #include "unicode/uformattable.h"
31 U_NAMESPACE_BEGIN
33 class CharString;
34 class DigitList;
36 /**
37 * \def UNUM_INTERNAL_STACKARRAY_SIZE
38 * @internal
39 */
40 #if U_PLATFORM == U_PF_OS400
41 #define UNUM_INTERNAL_STACKARRAY_SIZE 144
42 #else
43 #define UNUM_INTERNAL_STACKARRAY_SIZE 128
44 #endif
46 /**
47 * Formattable objects can be passed to the Format class or
48 * its subclasses for formatting. Formattable is a thin wrapper
49 * class which interconverts between the primitive numeric types
50 * (double, long, etc.) as well as UDate and UnicodeString.
51 *
52 * <p>Internally, a Formattable object is a union of primitive types.
53 * As such, it can only store one flavor of data at a time. To
54 * determine what flavor of data it contains, use the getType method.
55 *
56 * <p>As of ICU 3.0, Formattable may also wrap a UObject pointer,
57 * which it owns. This allows an instance of any ICU class to be
58 * encapsulated in a Formattable. For legacy reasons and for
59 * efficiency, primitive numeric types are still stored directly
60 * within a Formattable.
61 *
62 * <p>The Formattable class is not suitable for subclassing.
63 *
64 * <p>See UFormattable for a C wrapper.
65 */
66 class U_I18N_API Formattable : public UObject {
67 public:
68 /**
69 * This enum is only used to let callers distinguish between
70 * the Formattable(UDate) constructor and the Formattable(double)
71 * constructor; the compiler cannot distinguish the signatures,
72 * since UDate is currently typedefed to be either double or long.
73 * If UDate is changed later to be a bonafide class
74 * or struct, then we no longer need this enum.
75 * @stable ICU 2.4
76 */
77 enum ISDATE { kIsDate };
79 /**
80 * Default constructor
81 * @stable ICU 2.4
82 */
83 Formattable(); // Type kLong, value 0
85 /**
86 * Creates a Formattable object with a UDate instance.
87 * @param d the UDate instance.
88 * @param flag the flag to indicate this is a date. Always set it to kIsDate
89 * @stable ICU 2.0
90 */
91 Formattable(UDate d, ISDATE flag);
93 /**
94 * Creates a Formattable object with a double number.
95 * @param d the double number.
96 * @stable ICU 2.0
97 */
98 Formattable(double d);
100 /**
101 * Creates a Formattable object with a long number.
102 * @param l the long number.
103 * @stable ICU 2.0
104 */
105 Formattable(int32_t l);
107 /**
108 * Creates a Formattable object with an int64_t number
109 * @param ll the int64_t number.
110 * @stable ICU 2.8
111 */
112 Formattable(int64_t ll);
114 #if !UCONFIG_NO_CONVERSION
115 /**
116 * Creates a Formattable object with a char string pointer.
117 * Assumes that the char string is null terminated.
118 * @param strToCopy the char string.
119 * @stable ICU 2.0
120 */
121 Formattable(const char* strToCopy);
122 #endif
124 /**
125 * Creates a Formattable object of an appropriate numeric type from a
126 * a decimal number in string form. The Formattable will retain the
127 * full precision of the input in decimal format, even when it exceeds
128 * what can be represented by a double or int64_t.
129 *
130 * @param number the unformatted (not localized) string representation
131 * of the Decimal number.
132 * @param status the error code. Possible errors include U_INVALID_FORMAT_ERROR
133 * if the format of the string does not conform to that of a
134 * decimal number.
135 * @stable ICU 4.4
136 */
137 Formattable(const StringPiece &number, UErrorCode &status);
139 /**
140 * Creates a Formattable object with a UnicodeString object to copy from.
141 * @param strToCopy the UnicodeString string.
142 * @stable ICU 2.0
143 */
144 Formattable(const UnicodeString& strToCopy);
146 /**
147 * Creates a Formattable object with a UnicodeString object to adopt from.
148 * @param strToAdopt the UnicodeString string.
149 * @stable ICU 2.0
150 */
151 Formattable(UnicodeString* strToAdopt);
153 /**
154 * Creates a Formattable object with an array of Formattable objects.
155 * @param arrayToCopy the Formattable object array.
156 * @param count the array count.
157 * @stable ICU 2.0
158 */
159 Formattable(const Formattable* arrayToCopy, int32_t count);
161 /**
162 * Creates a Formattable object that adopts the given UObject.
163 * @param objectToAdopt the UObject to set this object to
164 * @stable ICU 3.0
165 */
166 Formattable(UObject* objectToAdopt);
168 /**
169 * Copy constructor.
170 * @stable ICU 2.0
171 */
172 Formattable(const Formattable&);
174 /**
175 * Assignment operator.
176 * @param rhs The Formattable object to copy into this object.
177 * @stable ICU 2.0
178 */
179 Formattable& operator=(const Formattable &rhs);
181 /**
182 * Equality comparison.
183 * @param other the object to be compared with.
184 * @return TRUE if other are equal to this, FALSE otherwise.
185 * @stable ICU 2.0
186 */
187 UBool operator==(const Formattable &other) const;
189 /**
190 * Equality operator.
191 * @param other the object to be compared with.
192 * @return TRUE if other are unequal to this, FALSE otherwise.
193 * @stable ICU 2.0
194 */
195 UBool operator!=(const Formattable& other) const
196 { return !operator==(other); }
198 /**
199 * Destructor.
200 * @stable ICU 2.0
201 */
202 virtual ~Formattable();
204 /**
205 * Clone this object.
206 * Clones can be used concurrently in multiple threads.
207 * If an error occurs, then NULL is returned.
208 * The caller must delete the clone.
209 *
210 * @return a clone of this object
211 *
212 * @see getDynamicClassID
213 * @stable ICU 2.8
214 */
215 Formattable *clone() const;
217 /**
218 * Selector for flavor of data type contained within a
219 * Formattable object. Formattable is a union of several
220 * different types, and at any time contains exactly one type.
221 * @stable ICU 2.4
222 */
223 enum Type {
224 /**
225 * Selector indicating a UDate value. Use getDate to retrieve
226 * the value.
227 * @stable ICU 2.4
228 */
229 kDate,
231 /**
232 * Selector indicating a double value. Use getDouble to
233 * retrieve the value.
234 * @stable ICU 2.4
235 */
236 kDouble,
238 /**
239 * Selector indicating a 32-bit integer value. Use getLong to
240 * retrieve the value.
241 * @stable ICU 2.4
242 */
243 kLong,
245 /**
246 * Selector indicating a UnicodeString value. Use getString
247 * to retrieve the value.
248 * @stable ICU 2.4
249 */
250 kString,
252 /**
253 * Selector indicating an array of Formattables. Use getArray
254 * to retrieve the value.
255 * @stable ICU 2.4
256 */
257 kArray,
259 /**
260 * Selector indicating a 64-bit integer value. Use getInt64
261 * to retrieve the value.
262 * @stable ICU 2.8
263 */
264 kInt64,
266 /**
267 * Selector indicating a UObject value. Use getObject to
268 * retrieve the value.
269 * @stable ICU 3.0
270 */
271 kObject
272 };
274 /**
275 * Gets the data type of this Formattable object.
276 * @return the data type of this Formattable object.
277 * @stable ICU 2.0
278 */
279 Type getType(void) const;
281 /**
282 * Returns TRUE if the data type of this Formattable object
283 * is kDouble, kLong, or kInt64
284 * @return TRUE if this is a pure numeric object
285 * @stable ICU 3.0
286 */
287 UBool isNumeric() const;
289 /**
290 * Gets the double value of this object. If this object is not of type
291 * kDouble then the result is undefined.
292 * @return the double value of this object.
293 * @stable ICU 2.0
294 */
295 double getDouble(void) const { return fValue.fDouble; }
297 /**
298 * Gets the double value of this object. If this object is of type
299 * long, int64 or Decimal Number then a conversion is peformed, with
300 * possible loss of precision. If the type is kObject and the
301 * object is a Measure, then the result of
302 * getNumber().getDouble(status) is returned. If this object is
303 * neither a numeric type nor a Measure, then 0 is returned and
304 * the status is set to U_INVALID_FORMAT_ERROR.
305 * @param status the error code
306 * @return the double value of this object.
307 * @stable ICU 3.0
308 */
309 double getDouble(UErrorCode& status) const;
311 /**
312 * Gets the long value of this object. If this object is not of type
313 * kLong then the result is undefined.
314 * @return the long value of this object.
315 * @stable ICU 2.0
316 */
317 int32_t getLong(void) const { return (int32_t)fValue.fInt64; }
319 /**
320 * Gets the long value of this object. If the magnitude is too
321 * large to fit in a long, then the maximum or minimum long value,
322 * as appropriate, is returned and the status is set to
323 * U_INVALID_FORMAT_ERROR. If this object is of type kInt64 and
324 * it fits within a long, then no precision is lost. If it is of
325 * type kDouble, then a conversion is peformed, with
326 * truncation of any fractional part. If the type is kObject and
327 * the object is a Measure, then the result of
328 * getNumber().getLong(status) is returned. If this object is
329 * neither a numeric type nor a Measure, then 0 is returned and
330 * the status is set to U_INVALID_FORMAT_ERROR.
331 * @param status the error code
332 * @return the long value of this object.
333 * @stable ICU 3.0
334 */
335 int32_t getLong(UErrorCode& status) const;
337 /**
338 * Gets the int64 value of this object. If this object is not of type
339 * kInt64 then the result is undefined.
340 * @return the int64 value of this object.
341 * @stable ICU 2.8
342 */
343 int64_t getInt64(void) const { return fValue.fInt64; }
345 /**
346 * Gets the int64 value of this object. If this object is of a numeric
347 * type and the magnitude is too large to fit in an int64, then
348 * the maximum or minimum int64 value, as appropriate, is returned
349 * and the status is set to U_INVALID_FORMAT_ERROR. If the
350 * magnitude fits in an int64, then a casting conversion is
351 * peformed, with truncation of any fractional part. If the type
352 * is kObject and the object is a Measure, then the result of
353 * getNumber().getDouble(status) is returned. If this object is
354 * neither a numeric type nor a Measure, then 0 is returned and
355 * the status is set to U_INVALID_FORMAT_ERROR.
356 * @param status the error code
357 * @return the int64 value of this object.
358 * @stable ICU 3.0
359 */
360 int64_t getInt64(UErrorCode& status) const;
362 /**
363 * Gets the Date value of this object. If this object is not of type
364 * kDate then the result is undefined.
365 * @return the Date value of this object.
366 * @stable ICU 2.0
367 */
368 UDate getDate() const { return fValue.fDate; }
370 /**
371 * Gets the Date value of this object. If the type is not a date,
372 * status is set to U_INVALID_FORMAT_ERROR and the return value is
373 * undefined.
374 * @param status the error code.
375 * @return the Date value of this object.
376 * @stable ICU 3.0
377 */
378 UDate getDate(UErrorCode& status) const;
380 /**
381 * Gets the string value of this object. If this object is not of type
382 * kString then the result is undefined.
383 * @param result Output param to receive the Date value of this object.
384 * @return A reference to 'result'.
385 * @stable ICU 2.0
386 */
387 UnicodeString& getString(UnicodeString& result) const
388 { result=*fValue.fString; return result; }
390 /**
391 * Gets the string value of this object. If the type is not a
392 * string, status is set to U_INVALID_FORMAT_ERROR and a bogus
393 * string is returned.
394 * @param result Output param to receive the Date value of this object.
395 * @param status the error code.
396 * @return A reference to 'result'.
397 * @stable ICU 3.0
398 */
399 UnicodeString& getString(UnicodeString& result, UErrorCode& status) const;
401 /**
402 * Gets a const reference to the string value of this object. If
403 * this object is not of type kString then the result is
404 * undefined.
405 * @return a const reference to the string value of this object.
406 * @stable ICU 2.0
407 */
408 inline const UnicodeString& getString(void) const;
410 /**
411 * Gets a const reference to the string value of this object. If
412 * the type is not a string, status is set to
413 * U_INVALID_FORMAT_ERROR and the result is a bogus string.
414 * @param status the error code.
415 * @return a const reference to the string value of this object.
416 * @stable ICU 3.0
417 */
418 const UnicodeString& getString(UErrorCode& status) const;
420 /**
421 * Gets a reference to the string value of this object. If this
422 * object is not of type kString then the result is undefined.
423 * @return a reference to the string value of this object.
424 * @stable ICU 2.0
425 */
426 inline UnicodeString& getString(void);
428 /**
429 * Gets a reference to the string value of this object. If the
430 * type is not a string, status is set to U_INVALID_FORMAT_ERROR
431 * and the result is a bogus string.
432 * @param status the error code.
433 * @return a reference to the string value of this object.
434 * @stable ICU 3.0
435 */
436 UnicodeString& getString(UErrorCode& status);
438 /**
439 * Gets the array value and count of this object. If this object
440 * is not of type kArray then the result is undefined.
441 * @param count fill-in with the count of this object.
442 * @return the array value of this object.
443 * @stable ICU 2.0
444 */
445 const Formattable* getArray(int32_t& count) const
446 { count=fValue.fArrayAndCount.fCount; return fValue.fArrayAndCount.fArray; }
448 /**
449 * Gets the array value and count of this object. If the type is
450 * not an array, status is set to U_INVALID_FORMAT_ERROR, count is
451 * set to 0, and the result is NULL.
452 * @param count fill-in with the count of this object.
453 * @param status the error code.
454 * @return the array value of this object.
455 * @stable ICU 3.0
456 */
457 const Formattable* getArray(int32_t& count, UErrorCode& status) const;
459 /**
460 * Accesses the specified element in the array value of this
461 * Formattable object. If this object is not of type kArray then
462 * the result is undefined.
463 * @param index the specified index.
464 * @return the accessed element in the array.
465 * @stable ICU 2.0
466 */
467 Formattable& operator[](int32_t index) { return fValue.fArrayAndCount.fArray[index]; }
469 /**
470 * Returns a pointer to the UObject contained within this
471 * formattable, or NULL if this object does not contain a UObject.
472 * @return a UObject pointer, or NULL
473 * @stable ICU 3.0
474 */
475 const UObject* getObject() const;
477 /**
478 * Returns a numeric string representation of the number contained within this
479 * formattable, or NULL if this object does not contain numeric type.
480 * For values obtained by parsing, the returned decimal number retains
481 * the full precision and range of the original input, unconstrained by
482 * the limits of a double floating point or a 64 bit int.
483 *
484 * This function is not thread safe, and therfore is not declared const,
485 * even though it is logically const.
486 *
487 * Possible errors include U_MEMORY_ALLOCATION_ERROR, and
488 * U_INVALID_STATE if the formattable object has not been set to
489 * a numeric type.
490 *
491 * @param status the error code.
492 * @return the unformatted string representation of a number.
493 * @stable ICU 4.4
494 */
495 StringPiece getDecimalNumber(UErrorCode &status);
497 /**
498 * Sets the double value of this object and changes the type to
499 * kDouble.
500 * @param d the new double value to be set.
501 * @stable ICU 2.0
502 */
503 void setDouble(double d);
505 /**
506 * Sets the long value of this object and changes the type to
507 * kLong.
508 * @param l the new long value to be set.
509 * @stable ICU 2.0
510 */
511 void setLong(int32_t l);
513 /**
514 * Sets the int64 value of this object and changes the type to
515 * kInt64.
516 * @param ll the new int64 value to be set.
517 * @stable ICU 2.8
518 */
519 void setInt64(int64_t ll);
521 /**
522 * Sets the Date value of this object and changes the type to
523 * kDate.
524 * @param d the new Date value to be set.
525 * @stable ICU 2.0
526 */
527 void setDate(UDate d);
529 /**
530 * Sets the string value of this object and changes the type to
531 * kString.
532 * @param stringToCopy the new string value to be set.
533 * @stable ICU 2.0
534 */
535 void setString(const UnicodeString& stringToCopy);
537 /**
538 * Sets the array value and count of this object and changes the
539 * type to kArray.
540 * @param array the array value.
541 * @param count the number of array elements to be copied.
542 * @stable ICU 2.0
543 */
544 void setArray(const Formattable* array, int32_t count);
546 /**
547 * Sets and adopts the string value and count of this object and
548 * changes the type to kArray.
549 * @param stringToAdopt the new string value to be adopted.
550 * @stable ICU 2.0
551 */
552 void adoptString(UnicodeString* stringToAdopt);
554 /**
555 * Sets and adopts the array value and count of this object and
556 * changes the type to kArray.
557 * @stable ICU 2.0
558 */
559 void adoptArray(Formattable* array, int32_t count);
561 /**
562 * Sets and adopts the UObject value of this object and changes
563 * the type to kObject. After this call, the caller must not
564 * delete the given object.
565 * @param objectToAdopt the UObject value to be adopted
566 * @stable ICU 3.0
567 */
568 void adoptObject(UObject* objectToAdopt);
570 /**
571 * Sets the the numeric value from a decimal number string, and changes
572 * the type to to a numeric type appropriate for the number.
573 * The syntax of the number is a "numeric string"
574 * as defined in the Decimal Arithmetic Specification, available at
575 * http://speleotrove.com/decimal
576 * The full precision and range of the input number will be retained,
577 * even when it exceeds what can be represented by a double or an int64.
578 *
579 * @param numberString a string representation of the unformatted decimal number.
580 * @param status the error code. Set to U_INVALID_FORMAT_ERROR if the
581 * incoming string is not a valid decimal number.
582 * @stable ICU 4.4
583 */
584 void setDecimalNumber(const StringPiece &numberString,
585 UErrorCode &status);
587 /**
588 * ICU "poor man's RTTI", returns a UClassID for the actual class.
589 *
590 * @stable ICU 2.2
591 */
592 virtual UClassID getDynamicClassID() const;
594 /**
595 * ICU "poor man's RTTI", returns a UClassID for this class.
596 *
597 * @stable ICU 2.2
598 */
599 static UClassID U_EXPORT2 getStaticClassID();
601 #ifndef U_HIDE_DRAFT_API
602 /**
603 * Convert the UFormattable to a Formattable. Internally, this is a reinterpret_cast.
604 * @param fmt a valid UFormattable
605 * @return the UFormattable as a Formattable object pointer. This is an alias to the original
606 * UFormattable, and so is only valid while the original argument remains in scope.
607 * @draft ICU 52
608 */
609 static inline Formattable *fromUFormattable(UFormattable *fmt);
611 /**
612 * Convert the const UFormattable to a const Formattable. Internally, this is a reinterpret_cast.
613 * @param fmt a valid UFormattable
614 * @return the UFormattable as a Formattable object pointer. This is an alias to the original
615 * UFormattable, and so is only valid while the original argument remains in scope.
616 * @draft ICU 52
617 */
618 static inline const Formattable *fromUFormattable(const UFormattable *fmt);
620 /**
621 * Convert this object pointer to a UFormattable.
622 * @return this object as a UFormattable pointer. This is an alias to this object,
623 * and so is only valid while this object remains in scope.
624 * @draft ICU 52
625 */
626 inline UFormattable *toUFormattable();
628 /**
629 * Convert this object pointer to a UFormattable.
630 * @return this object as a UFormattable pointer. This is an alias to this object,
631 * and so is only valid while this object remains in scope.
632 * @draft ICU 52
633 */
634 inline const UFormattable *toUFormattable() const;
635 #endif /* U_HIDE_DRAFT_API */
637 #ifndef U_HIDE_DEPRECATED_API
638 /**
639 * Deprecated variant of getLong(UErrorCode&).
640 * @param status the error code
641 * @return the long value of this object.
642 * @deprecated ICU 3.0 use getLong(UErrorCode&) instead
643 */
644 inline int32_t getLong(UErrorCode* status) const;
645 #endif /* U_HIDE_DEPRECATED_API */
647 #ifndef U_HIDE_INTERNAL_API
648 /**
649 * Internal function, do not use.
650 * TODO: figure out how to make this be non-public.
651 * NumberFormat::format(Formattable, ...
652 * needs to get at the DigitList, if it exists, for
653 * big decimal formatting.
654 * @internal
655 */
656 DigitList *getDigitList() const { return fDecimalNum;}
658 /**
659 * @internal
660 */
661 DigitList *getInternalDigitList();
663 /**
664 * Adopt, and set value from, a DigitList
665 * Internal Function, do not use.
666 * @param dl the Digit List to be adopted
667 * @internal
668 */
669 void adoptDigitList(DigitList *dl);
671 /**
672 * Internal function to return the CharString pointer.
673 * @param status error code
674 * @return pointer to the CharString - may become invalid if the object is modified
675 * @internal
676 */
677 CharString *internalGetCharString(UErrorCode &status);
679 #endif /* U_HIDE_INTERNAL_API */
681 private:
682 /**
683 * Cleans up the memory for unwanted values. For example, the adopted
684 * string or array objects.
685 */
686 void dispose(void);
688 /**
689 * Common initialization, for use by constructors.
690 */
691 void init();
693 UnicodeString* getBogus() const;
695 union {
696 UObject* fObject;
697 UnicodeString* fString;
698 double fDouble;
699 int64_t fInt64;
700 UDate fDate;
701 struct {
702 Formattable* fArray;
703 int32_t fCount;
704 } fArrayAndCount;
705 } fValue;
707 CharString *fDecimalStr;
709 DigitList *fDecimalNum;
711 char fStackData[UNUM_INTERNAL_STACKARRAY_SIZE]; // must be big enough for DigitList
713 Type fType;
714 UnicodeString fBogus; // Bogus string when it's needed.
715 };
717 inline UDate Formattable::getDate(UErrorCode& status) const {
718 if (fType != kDate) {
719 if (U_SUCCESS(status)) {
720 status = U_INVALID_FORMAT_ERROR;
721 }
722 return 0;
723 }
724 return fValue.fDate;
725 }
727 inline const UnicodeString& Formattable::getString(void) const {
728 return *fValue.fString;
729 }
731 inline UnicodeString& Formattable::getString(void) {
732 return *fValue.fString;
733 }
735 #ifndef U_HIDE_DEPRECATED_API
736 inline int32_t Formattable::getLong(UErrorCode* status) const {
737 return getLong(*status);
738 }
739 #endif /* U_HIDE_DEPRECATED_API */
741 #ifndef U_HIDE_DRAFT_API
742 inline UFormattable* Formattable::toUFormattable() {
743 return reinterpret_cast<UFormattable*>(this);
744 }
746 inline const UFormattable* Formattable::toUFormattable() const {
747 return reinterpret_cast<const UFormattable*>(this);
748 }
750 inline Formattable* Formattable::fromUFormattable(UFormattable *fmt) {
751 return reinterpret_cast<Formattable *>(fmt);
752 }
754 inline const Formattable* Formattable::fromUFormattable(const UFormattable *fmt) {
755 return reinterpret_cast<const Formattable *>(fmt);
756 }
757 #endif /* U_HIDE_DRAFT_API */
759 U_NAMESPACE_END
761 #endif /* #if !UCONFIG_NO_FORMATTING */
763 #endif //_FMTABLE
764 //eof
