ICU 53.1  53.1
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
uformattable.h
Go to the documentation of this file.
1 /*
2 ********************************************************************************
3 * Copyright (C) 2013, International Business Machines Corporation and others.
4 * All Rights Reserved.
5 ********************************************************************************
6 *
7 * File UFORMATTABLE.H
8 *
9 * Modification History:
10 *
11 * Date Name Description
12 * 2013 Jun 7 srl New
13 ********************************************************************************
14 */
15 
28 #ifndef UFORMATTABLE_H
29 #define UFORMATTABLE_H
30 
31 #include "unicode/utypes.h"
32 
33 #if !UCONFIG_NO_FORMATTING
34 
35 #ifndef U_HIDE_DRAFT_API
36 
37 #include "unicode/localpointer.h"
38 
46 typedef enum UFormattableType {
47  UFMT_DATE = 0,
56 
57 
64 typedef void *UFormattable;
65 
76 U_DRAFT UFormattable* U_EXPORT2
77 ufmt_open(UErrorCode* status);
78 
85 U_DRAFT void U_EXPORT2
87 
88 #if U_SHOW_CPLUSPLUS_API
89 
91 
102 
104 
105 #endif
106 
117 U_DRAFT UFormattableType U_EXPORT2
118 ufmt_getType(const UFormattable* fmt, UErrorCode *status);
119 
128 U_DRAFT UBool U_EXPORT2
129 ufmt_isNumeric(const UFormattable* fmt);
130 
141 U_DRAFT UDate U_EXPORT2
142 ufmt_getDate(const UFormattable* fmt, UErrorCode *status);
143 
159 U_DRAFT double U_EXPORT2
160 ufmt_getDouble(UFormattable* fmt, UErrorCode *status);
161 
180 U_DRAFT int32_t U_EXPORT2
181 ufmt_getLong(UFormattable* fmt, UErrorCode *status);
182 
183 
201 U_DRAFT int64_t U_EXPORT2
202 ufmt_getInt64(UFormattable* fmt, UErrorCode *status);
203 
214 U_DRAFT const void *U_EXPORT2
215 ufmt_getObject(const UFormattable* fmt, UErrorCode *status);
216 
229 U_DRAFT const UChar* U_EXPORT2
230 ufmt_getUChars(UFormattable* fmt, int32_t *len, UErrorCode *status);
231 
240 U_DRAFT int32_t U_EXPORT2
241 ufmt_getArrayLength(const UFormattable* fmt, UErrorCode *status);
242 
252 U_DRAFT UFormattable * U_EXPORT2
253 ufmt_getArrayItemByIndex(UFormattable* fmt, int32_t n, UErrorCode *status);
254 
277 U_DRAFT const char * U_EXPORT2
278 ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status);
279 #endif /* U_HIDE_DRAFT_API */
280 
281 #endif
282 
283 #endif
UFormattable * ufmt_open(UErrorCode *status)
Initialize a UFormattable, to type UNUM_LONG, value 0 may return error if memory allocation failed...
double ufmt_getDouble(UFormattable *fmt, UErrorCode *status)
Gets the double value of this object.
const UChar * ufmt_getUChars(UFormattable *fmt, int32_t *len, UErrorCode *status)
Gets the string value of this object as a UChar string.
double UDate
Date and Time data type.
Definition: utypes.h:201
UDate ufmt_getDate(const UFormattable *fmt, UErrorCode *status)
Gets the UDate value of this object.
Count of defined UFormattableType values.
Definition: uformattable.h:54
int32_t ufmt_getArrayLength(const UFormattable *fmt, UErrorCode *status)
Get the number of array objects contained, if an array type UFMT_ARRAY.
UFormattableType ufmt_getType(const UFormattable *fmt, UErrorCode *status)
Return the type of this object.
ufmt_getDate() will return without conversion.
Definition: uformattable.h:47
int32_t ufmt_getLong(UFormattable *fmt, UErrorCode *status)
Gets the long (int32_t) value of this object.
ufmt_countArray() and ufmt_getArray() will return the value.
Definition: uformattable.h:51
UFormattableType
Enum designating the type of a UFormattable instance.
Definition: uformattable.h:46
#define U_NAMESPACE_BEGIN
This is used to begin a declaration of a public ICU C++ API.
Definition: uversion.h:129
void ufmt_close(UFormattable *fmt)
Cleanup any additional memory allocated by this UFormattable.
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition: localpointer.h:290
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
ufmt_getInt64() will return without conversion.
Definition: uformattable.h:52
ufmt_getObject() will return without conversion.
Definition: uformattable.h:53
UBool ufmt_isNumeric(const UFormattable *fmt)
Return whether the object is numeric.
int64_t ufmt_getInt64(UFormattable *fmt, UErrorCode *status)
Gets the int64_t value of this object.
UFormattable * ufmt_getArrayItemByIndex(UFormattable *fmt, int32_t n, UErrorCode *status)
Get the specified value from the array of UFormattables.
ufmt_getLong() will return without conversion.
Definition: uformattable.h:49
uint16_t UChar
Define UChar to be UCHAR_TYPE, if that is #defined (for example, to char16_t), or wchar_t if that is ...
Definition: umachine.h:278
#define U_NAMESPACE_END
This is used to end a declaration of a public ICU C++ API.
Definition: uversion.h:130
"Smart pointer" class, closes a UFormattable via ufmt_close().
UErrorCode
Error code to replace exception handling, so that the code is compatible with all C++ compilers...
Definition: utypes.h:476
ufmt_getUChars() will return without conversion.
Definition: uformattable.h:50
Basic definitions for ICU, for both C and C++ APIs.
#define U_DRAFT
This is used to declare a function as a draft public ICU C API.
Definition: umachine.h:111
const void * ufmt_getObject(const UFormattable *fmt, UErrorCode *status)
Returns a pointer to the UObject contained within this formattable (as a const void*), or NULL if this object is not of type UFMT_OBJECT.
void * UFormattable
Opaque type representing various types of data which may be used for formatting and parsing operation...
Definition: uformattable.h:64
ufmt_getDouble() will return without conversion.
Definition: uformattable.h:48
const char * ufmt_getDecNumChars(UFormattable *fmt, int32_t *len, UErrorCode *status)
Returns a numeric string representation of the number contained within this formattable, or NULL if this object does not contain numeric type.
int8_t UBool
The ICU boolean type.
Definition: umachine.h:200