ICU 70.1  70.1
uformattable.h
Go to the documentation of this file.
1 // © 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
3 /*
4 ********************************************************************************
5 * Copyright (C) 2013-2014, International Business Machines Corporation and others.
6 * All Rights Reserved.
7 ********************************************************************************
8 *
9 * File UFORMATTABLE.H
10 *
11 * Modification History:
12 *
13 * Date Name Description
14 * 2013 Jun 7 srl New
15 ********************************************************************************
16 */
17 
30 #ifndef UFORMATTABLE_H
31 #define UFORMATTABLE_H
32 
33 #include "unicode/utypes.h"
34 
35 #if !UCONFIG_NO_FORMATTING
36 
37 #if U_SHOW_CPLUSPLUS_API
38 #include "unicode/localpointer.h"
39 #endif // U_SHOW_CPLUSPLUS_API
40 
48 typedef enum UFormattableType {
49  UFMT_DATE = 0,
56 #ifndef U_HIDE_DEPRECATED_API
62 #endif /* U_HIDE_DEPRECATED_API */
64 
65 
72 typedef void *UFormattable;
73 
84 U_CAPI UFormattable* U_EXPORT2
86 
93 U_CAPI void U_EXPORT2
95 
96 #if U_SHOW_CPLUSPLUS_API
97 
98 U_NAMESPACE_BEGIN
99 
110 
111 U_NAMESPACE_END
112 
113 #endif
114 
125 U_CAPI UFormattableType U_EXPORT2
126 ufmt_getType(const UFormattable* fmt, UErrorCode *status);
127 
136 U_CAPI UBool U_EXPORT2
138 
149 U_CAPI UDate U_EXPORT2
150 ufmt_getDate(const UFormattable* fmt, UErrorCode *status);
151 
167 U_CAPI double U_EXPORT2
169 
188 U_CAPI int32_t U_EXPORT2
190 
191 
209 U_CAPI int64_t U_EXPORT2
211 
222 U_CAPI const void *U_EXPORT2
224 
237 U_CAPI const UChar* U_EXPORT2
238 ufmt_getUChars(UFormattable* fmt, int32_t *len, UErrorCode *status);
239 
248 U_CAPI int32_t U_EXPORT2
250 
260 U_CAPI UFormattable * U_EXPORT2
262 
285 U_CAPI const char * U_EXPORT2
286 ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status);
287 
288 #endif
289 
290 #endif
"Smart pointer" class, closes a UFormattable via ufmt_close().
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:550
U_CAPI void ufmt_close(UFormattable *fmt)
Cleanup any additional memory allocated by this UFormattable.
U_CAPI const UChar * ufmt_getUChars(UFormattable *fmt, int32_t *len, UErrorCode *status)
Gets the string value of this object as a UChar string.
U_CAPI int32_t ufmt_getArrayLength(const UFormattable *fmt, UErrorCode *status)
Get the number of array objects contained, if an array type UFMT_ARRAY.
U_CAPI double ufmt_getDouble(UFormattable *fmt, UErrorCode *status)
Gets the double value of this object.
U_CAPI int64_t ufmt_getInt64(UFormattable *fmt, UErrorCode *status)
Gets the int64_t value of this object.
U_CAPI UBool ufmt_isNumeric(const UFormattable *fmt)
Return whether the object is numeric.
UFormattableType
Enum designating the type of a UFormattable instance.
Definition: uformattable.h:48
@ UFMT_STRING
ufmt_getUChars() will return without conversion.
Definition: uformattable.h:52
@ UFMT_LONG
ufmt_getLong() will return without conversion.
Definition: uformattable.h:51
@ UFMT_ARRAY
ufmt_countArray() and ufmt_getArray() will return the value.
Definition: uformattable.h:53
@ UFMT_OBJECT
ufmt_getObject() will return without conversion.
Definition: uformattable.h:55
@ UFMT_DOUBLE
ufmt_getDouble() will return without conversion.
Definition: uformattable.h:50
@ UFMT_DATE
ufmt_getDate() will return without conversion.
Definition: uformattable.h:49
@ UFMT_COUNT
One more than the highest normal UFormattableType value.
Definition: uformattable.h:61
@ UFMT_INT64
ufmt_getInt64() will return without conversion.
Definition: uformattable.h:54
U_CAPI int32_t ufmt_getLong(UFormattable *fmt, UErrorCode *status)
Gets the long (int32_t) value of this object.
U_CAPI const char * ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status)
Returns a numeric string representation of the number contained within this formattable,...
void * UFormattable
Opaque type representing various types of data which may be used for formatting and parsing operation...
Definition: uformattable.h:72
U_CAPI UFormattable * ufmt_open(UErrorCode *status)
Initialize a UFormattable, to type UNUM_LONG, value 0 may return error if memory allocation failed.
U_CAPI const void * ufmt_getObject(const UFormattable *fmt, UErrorCode *status)
Returns a pointer to the UObject contained within this formattable (as a const void*),...
U_CAPI UDate ufmt_getDate(const UFormattable *fmt, UErrorCode *status)
Gets the UDate value of this object.
U_CAPI UFormattable * ufmt_getArrayItemByIndex(UFormattable *fmt, int32_t n, UErrorCode *status)
Get the specified value from the array of UFormattables.
U_CAPI UFormattableType ufmt_getType(const UFormattable *fmt, UErrorCode *status)
Return the type of this object.
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition: umachine.h:269
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition: umachine.h:110
char16_t UChar
The base type for UTF-16 code units and pointers.
Definition: umachine.h:418
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition: utypes.h:415
double UDate
Date and Time data type.
Definition: utypes.h:203