2
******************************************************************************
4
* Copyright (C) 1997-2010, International Business Machines
5
* Corporation and others. All Rights Reserved.
7
******************************************************************************
9
* FILE NAME : putilimp.h
11
* Date Name Description
12
* 10/17/04 grhoten Move internal functions from putil.h to this file.
13
******************************************************************************
19
#include "unicode/utypes.h"
20
#include "unicode/putil.h"
22
/*==========================================================================*/
23
/* Platform utilities */
24
/*==========================================================================*/
27
* Platform utilities isolates the platform dependencies of the
28
* libarary. For each platform which this code is ported to, these
29
* functions may have to be re-implemented.
33
* Floating point utility to determine if a double is Not a Number (NaN).
36
U_INTERNAL UBool U_EXPORT2 uprv_isNaN(double d);
38
* Floating point utility to determine if a double has an infinite value.
41
U_INTERNAL UBool U_EXPORT2 uprv_isInfinite(double d);
43
* Floating point utility to determine if a double has a positive infinite value.
46
U_INTERNAL UBool U_EXPORT2 uprv_isPositiveInfinity(double d);
48
* Floating point utility to determine if a double has a negative infinite value.
51
U_INTERNAL UBool U_EXPORT2 uprv_isNegativeInfinity(double d);
53
* Floating point utility that returns a Not a Number (NaN) value.
56
U_INTERNAL double U_EXPORT2 uprv_getNaN(void);
58
* Floating point utility that returns an infinite value.
61
U_INTERNAL double U_EXPORT2 uprv_getInfinity(void);
64
* Floating point utility to truncate a double.
67
U_INTERNAL double U_EXPORT2 uprv_trunc(double d);
69
* Floating point utility to calculate the floor of a double.
72
U_INTERNAL double U_EXPORT2 uprv_floor(double d);
74
* Floating point utility to calculate the ceiling of a double.
77
U_INTERNAL double U_EXPORT2 uprv_ceil(double d);
79
* Floating point utility to calculate the absolute value of a double.
82
U_INTERNAL double U_EXPORT2 uprv_fabs(double d);
84
* Floating point utility to calculate the fractional and integer parts of a double.
87
U_INTERNAL double U_EXPORT2 uprv_modf(double d, double* pinteger);
89
* Floating point utility to calculate the remainder of a double divided by another double.
92
U_INTERNAL double U_EXPORT2 uprv_fmod(double d, double y);
94
* Floating point utility to calculate d to the power of exponent (d^exponent).
97
U_INTERNAL double U_EXPORT2 uprv_pow(double d, double exponent);
99
* Floating point utility to calculate 10 to the power of exponent (10^exponent).
102
U_INTERNAL double U_EXPORT2 uprv_pow10(int32_t exponent);
104
* Floating point utility to calculate the maximum value of two doubles.
107
U_INTERNAL double U_EXPORT2 uprv_fmax(double d, double y);
109
* Floating point utility to calculate the minimum value of two doubles.
112
U_INTERNAL double U_EXPORT2 uprv_fmin(double d, double y);
114
* Private utility to calculate the maximum value of two integers.
117
U_INTERNAL int32_t U_EXPORT2 uprv_max(int32_t d, int32_t y);
119
* Private utility to calculate the minimum value of two integers.
122
U_INTERNAL int32_t U_EXPORT2 uprv_min(int32_t d, int32_t y);
125
# define uprv_isNegative(number) (*((signed char *)&(number))<0)
127
# define uprv_isNegative(number) (*((signed char *)&(number)+sizeof(number)-1)<0)
131
* Return the largest positive number that can be represented by an integer
132
* type of arbitrary bit length.
135
U_INTERNAL double U_EXPORT2 uprv_maxMantissa(void);
138
* Floating point utility to calculate the logarithm of a double.
141
U_INTERNAL double U_EXPORT2 uprv_log(double d);
144
* Does common notion of rounding e.g. uprv_floor(x + 0.5);
145
* @param x the double number
146
* @return the rounded double
149
U_INTERNAL double U_EXPORT2 uprv_round(double x);
153
* Returns the number of digits after the decimal point in a double number x.
155
* @param x the double number
156
* @return the number of digits after the decimal point in a double number x.
159
/*U_INTERNAL int32_t U_EXPORT2 uprv_digitsAfterDecimal(double x);*/
163
* Time zone utilities
165
* Wrappers for C runtime library functions relating to timezones.
166
* The t_tzset() function (similar to tzset) uses the current setting
167
* of the environment variable TZ to assign values to three global
168
* variables: daylight, timezone, and tzname. These variables have the
169
* following meanings, and are declared in <time.h>.
171
* daylight Nonzero if daylight-saving-time zone (DST) is specified
172
* in TZ; otherwise, 0. Default value is 1.
173
* timezone Difference in seconds between coordinated universal
174
* time and local time. E.g., -28,800 for PST (GMT-8hrs)
175
* tzname(0) Three-letter time-zone name derived from TZ environment
176
* variable. E.g., "PST".
177
* tzname(1) Three-letter DST zone name derived from TZ environment
178
* variable. E.g., "PDT". If DST zone is omitted from TZ,
179
* tzname(1) is an empty string.
181
* Notes: For example, to set the TZ environment variable to correspond
182
* to the current time zone in Germany, you can use one of the
183
* following statements:
188
* If the TZ value is not set, t_tzset() attempts to use the time zone
189
* information specified by the operating system. Under Windows NT
190
* and Windows 95, this information is specified in the Control Panel's
191
* Date/Time application.
194
U_INTERNAL void U_EXPORT2 uprv_tzset(void);
197
* Difference in seconds between coordinated universal
198
* time and local time. E.g., -28,800 for PST (GMT-8hrs)
199
* @return the difference in seconds between coordinated universal time and local time.
202
U_INTERNAL int32_t U_EXPORT2 uprv_timezone(void);
205
* tzname(0) Three-letter time-zone name derived from TZ environment
206
* variable. E.g., "PST".
207
* tzname(1) Three-letter DST zone name derived from TZ environment
208
* variable. E.g., "PDT". If DST zone is omitted from TZ,
209
* tzname(1) is an empty string.
212
U_INTERNAL const char* U_EXPORT2 uprv_tzname(int n);
215
* Get UTC (GMT) time measured in milliseconds since 0:00 on 1/1/1970.
216
* This function is affected by 'faketime' and should be the bottleneck for all user-visible ICU time functions.
217
* @return the UTC time measured in milliseconds
220
U_INTERNAL UDate U_EXPORT2 uprv_getUTCtime(void);
223
* Get UTC (GMT) time measured in milliseconds since 0:00 on 1/1/1970.
224
* This function is not affected by 'faketime', so it should only be used by low level test functions- not by anything that
225
* exposes time to the end user.
226
* @return the UTC time measured in milliseconds
229
U_INTERNAL UDate U_EXPORT2 uprv_getRawUTCtime(void);
232
* Determine whether a pathname is absolute or not, as defined by the platform.
233
* @param path Pathname to test
234
* @return TRUE if the path is absolute
235
* @internal (ICU 3.0)
237
U_INTERNAL UBool U_EXPORT2 uprv_pathIsAbsolute(const char *path);
240
* Use U_MAX_PTR instead of this function.
241
* @param void pointer to test
242
* @return the largest possible pointer greater than the base
243
* @internal (ICU 3.8)
245
U_INTERNAL void * U_EXPORT2 uprv_maximumPtr(void *base);
248
* Maximum value of a (void*) - use to indicate the limit of an 'infinite' buffer.
249
* In fact, buffer sizes must not exceed 2GB so that the difference between
250
* the buffer limit and the buffer start can be expressed in an int32_t.
252
* The definition of U_MAX_PTR must fulfill the following conditions:
253
* - return the largest possible pointer greater than base
254
* - return a valid pointer according to the machine architecture (AS/400, 64-bit, etc.)
255
* - avoid wrapping around at high addresses
256
* - make sure that the returned pointer is not farther from base than 0x7fffffff
258
* @param base The beginning of a buffer to find the maximum offset from
262
# if defined(OS390) && !defined(_LP64)
263
/* We have 31-bit pointers. */
264
# define U_MAX_PTR(base) ((void *)0x7fffffff)
265
# elif defined(OS400)
266
# define U_MAX_PTR(base) uprv_maximumPtr((void *)base)
267
# elif defined(__GNUC__) && __GNUC__ >= 4
269
* Due to a compiler optimization bug, gcc 4 causes test failures when doing
270
* this math arithmetic on pointers on some platforms. It seems like the
271
* pointers are considered signed instead of unsigned. The uintptr_t type
272
* isn't available on all platforms (i.e MSVC 6) and pointers aren't always
273
* a scalar value (i.e. i5/OS see uprv_maximumPtr function).
275
# define U_MAX_PTR(base) \
276
((void *)(((uintptr_t)(base)+0x7fffffffu) > (uintptr_t)(base) \
277
? ((uintptr_t)(base)+0x7fffffffu) \
280
# define U_MAX_PTR(base) \
281
((char *)(((char *)(base)+0x7fffffffu) > (char *)(base) \
282
? ((char *)(base)+0x7fffffffu) \
288
/* Dynamic Library Functions */
292
* @internal (ICU 4.4)
294
U_INTERNAL void * U_EXPORT2 uprv_dl_open(const char *libName, UErrorCode *status);
298
* @internal (ICU 4.4)
300
U_INTERNAL void U_EXPORT2 uprv_dl_close( void *lib, UErrorCode *status);
303
* Extract a symbol from a library
304
* @internal (ICU 4.4)
306
U_INTERNAL void * U_EXPORT2 uprv_dl_sym( void *lib, const char *symbolName, UErrorCode *status);