| /* |
| ******************************************************************************* |
| * |
| * Copyright (C) 1997-2000, International Business Machines |
| * Corporation and others. All Rights Reserved. |
| * |
| ******************************************************************************* |
| * |
| * FILE NAME : putil.h |
| * |
| * Date Name Description |
| * 05/14/98 nos Creation (content moved here from utypes.h). |
| * 06/17/99 erm Added IEEE_754 |
| * 07/22/98 stephen Added IEEEremainder, max, min, trunc |
| * 08/13/98 stephen Added isNegativeInfinity, isPositiveInfinity |
| * 08/24/98 stephen Added longBitsFromDouble |
| * 03/02/99 stephen Removed openFile(). Added AS400 support. |
| * 04/15/99 stephen Converted to C |
| * 11/15/99 helena Integrated S/390 changes for IEEE support. |
| * 01/11/00 helena Added u_getVersion. |
| ******************************************************************************* |
| */ |
| |
| #ifndef PUTIL_H |
| #define PUTIL_H |
| |
| #include "unicode/utypes.h" |
| |
| /* Define this to 1 if your platform supports IEEE 754 floating point, |
| to 0 if it does not. */ |
| #ifndef IEEE_754 |
| # define IEEE_754 1 |
| #endif |
| |
| /*===========================================================================*/ |
| /* Platform utilities */ |
| /*===========================================================================*/ |
| |
| /** |
| * Platform utilities isolates the platform dependencies of the |
| * libarary. For each platform which this code is ported to, these |
| * functions may have to be re-implemented. */ |
| |
| /* Floating point utilities |
| * @draft |
| */ |
| U_CAPI UBool U_EXPORT2 uprv_isNaN(double); |
| U_CAPI UBool U_EXPORT2 uprv_isInfinite(double); |
| U_CAPI UBool U_EXPORT2 uprv_isPositiveInfinity(double); |
| U_CAPI UBool U_EXPORT2 uprv_isNegativeInfinity(double); |
| U_CAPI double U_EXPORT2 uprv_getNaN(void); |
| U_CAPI double U_EXPORT2 uprv_getInfinity(void); |
| |
| U_CAPI double U_EXPORT2 uprv_floor(double x); |
| U_CAPI double U_EXPORT2 uprv_ceil(double x); |
| U_CAPI double U_EXPORT2 uprv_fabs(double x); |
| U_CAPI double U_EXPORT2 uprv_modf(double x, double* y); |
| U_CAPI double U_EXPORT2 uprv_fmod(double x, double y); |
| U_CAPI double U_EXPORT2 uprv_pow10(int32_t x); |
| U_CAPI double U_EXPORT2 uprv_IEEEremainder(double x, double y); |
| U_CAPI double U_EXPORT2 uprv_fmax(double x, double y); |
| U_CAPI double U_EXPORT2 uprv_fmin(double x, double y); |
| U_CAPI int32_t U_EXPORT2 uprv_max(int32_t x, int32_t y); |
| U_CAPI int32_t U_EXPORT2 uprv_min(int32_t x, int32_t y); |
| U_CAPI double U_EXPORT2 uprv_trunc(double d); |
| U_CAPI void U_EXPORT2 uprv_longBitsFromDouble(double d, int32_t *hi, uint32_t *lo); |
| #if U_IS_BIG_ENDIAN |
| # define uprv_isNegative(number) (*((signed char *)&(number))<0) |
| #else |
| # define uprv_isNegative(number) (*((signed char *)&(number)+sizeof(number)-1)<0) |
| #endif |
| |
| /* Conversion from a digit to the character with radix base from 2-19 */ |
| #define T_CString_itosOffset(a) ((a)<=9?('0'+(a)):('A'+(a)-10)) |
| |
| /* |
| * Return the floor of the log base 10 of a given double. |
| * This method compensates for inaccuracies which arise naturally when |
| * computing logs, and always gives the correct value. The parameter |
| * must be positive and finite. |
| * (Thanks to Alan Liu for supplying this function.) |
| */ |
| /** |
| * Returns the common log of the double value d. |
| * |
| * @param d the double value to apply the common log function for. |
| * @return the log of value d. |
| * @draft |
| */ |
| U_CAPI int16_t U_EXPORT2 uprv_log10(double d); |
| |
| /** |
| * Returns the number of digits after the decimal point in a double number x. |
| * |
| * @param x the double number |
| * @draft |
| */ |
| U_CAPI int32_t U_EXPORT2 uprv_digitsAfterDecimal(double x); |
| |
| /** |
| * Time zone utilities |
| * |
| * Wrappers for C runtime library functions relating to timezones. |
| * The t_tzset() function (similar to tzset) uses the current setting |
| * of the environment variable TZ to assign values to three global |
| * variables: daylight, timezone, and tzname. These variables have the |
| * following meanings, and are declared in <time.h>. |
| * |
| * daylight Nonzero if daylight-saving-time zone (DST) is specified |
| * in TZ; otherwise, 0. Default value is 1. |
| * timezone Difference in seconds between coordinated universal |
| * time and local time. E.g., -28,800 for PST (GMT-8hrs) |
| * tzname(0) Three-letter time-zone name derived from TZ environment |
| * variable. E.g., "PST". |
| * tzname(1) Three-letter DST zone name derived from TZ environment |
| * variable. E.g., "PDT". If DST zone is omitted from TZ, |
| * tzname(1) is an empty string. |
| * |
| * Notes: For example, to set the TZ environment variable to correspond |
| * to the current time zone in Germany, you can use one of the |
| * following statements: |
| * |
| * set TZ=GST1GDT |
| * set TZ=GST+1GDT |
| * |
| * If the TZ value is not set, t_tzset() attempts to use the time zone |
| * information specified by the operating system. Under Windows NT |
| * and Windows 95, this information is specified in the Control Panels |
| * Date/Time application. |
| * @draft |
| */ |
| U_CAPI void U_EXPORT2 uprv_tzset(void); |
| U_CAPI int32_t U_EXPORT2 uprv_timezone(void); |
| U_CAPI char* U_EXPORT2 uprv_tzname(int n); |
| |
| /** |
| * Get UTC (GMT) time measured in seconds since 0:00 on 1/1/70. |
| * @draft |
| */ |
| U_CAPI int32_t U_EXPORT2 uprv_getUTCtime(void); |
| |
| /** |
| * Return the data directory for this platform. |
| * @draft |
| */ |
| U_CAPI const char* U_EXPORT2 u_getDataDirectory(void); |
| |
| /** |
| * Set the data directory. |
| * @draft |
| */ |
| U_CAPI void U_EXPORT2 u_setDataDirectory(const char *directory); |
| |
| /** |
| * Return the default codepage for this platform and locale |
| * @draft |
| */ |
| U_CAPI const char* U_EXPORT2 uprv_getDefaultCodepage(void); |
| |
| /** |
| * Return the default locale ID string by querying ths system, or |
| * zero if one cannot be found. |
| * @draft |
| */ |
| U_CAPI const char* U_EXPORT2 uprv_getDefaultLocaleID(void); |
| |
| /* |
| * Finds the least double greater than d (if positive == true), |
| * or the greatest double less than d (if positive == false). |
| * |
| * This is a special purpose function defined by the ChoiceFormat API |
| * documentation. |
| * It is not a general purpose function and not defined for NaN or Infinity |
| * @draft |
| */ |
| U_CAPI double U_EXPORT2 uprv_nextDouble(double d, UBool positive); |
| |
| /** |
| * Filesystem file and path separator characters. |
| * Example: '/' and ':' on Unix, '\\' and ';' on Windows. |
| * @draft |
| */ |
| #ifdef XP_MAC |
| # define U_FILE_SEP_CHAR ':' |
| # define U_PATH_SEP_CHAR ';' |
| # define U_FILE_SEP_STRING ":" |
| # define U_PATH_SEP_STRING ";" |
| #elif defined(WIN32) || defined(OS2) |
| # define U_FILE_SEP_CHAR '\\' |
| # define U_PATH_SEP_CHAR ';' |
| # define U_FILE_SEP_STRING "\\" |
| # define U_PATH_SEP_STRING ";" |
| #else |
| # define U_FILE_SEP_CHAR '/' |
| # define U_PATH_SEP_CHAR ':' |
| # define U_FILE_SEP_STRING "/" |
| # define U_PATH_SEP_STRING ":" |
| #endif |
| |
| /** |
| * Convert char characters to UChar characters. |
| * This utility function is useful only for "invariant characters" |
| * that are encoded in the platform default encoding. |
| * They are a small, constant subset of the encoding and include |
| * just the latin letters, digits, and some punctuation. |
| * For details, see utypes.h . |
| * |
| * @param cs Input string, points to <code>length</code> |
| * character bytes from a subset of the platform encoding. |
| * @param us Output string, points to memory for <code>length</code> |
| * Unicode characters. |
| * @param length The number of characters to convert; this may |
| * include the terminating <code>NUL</code>. |
| * @stable |
| */ |
| U_CAPI void U_EXPORT2 |
| u_charsToUChars(const char *cs, UChar *us, UTextOffset length); |
| |
| /** |
| * Convert UChar characters to char characters. |
| * This utility function is useful only for "invariant characters" |
| * that can be encoded in the platform default encoding. |
| * They are a small, constant subset of the encoding and include |
| * just the latin letters, digits, and some punctuation. |
| * For details, see utypes.h . |
| * |
| * @param us Input string, points to <code>length</code> |
| * Unicode characters that can be encoded with the |
| * codepage-invariant subset of the platform encoding. |
| * @param cs Output string, points to memory for <code>length</code> |
| * character bytes. |
| * @param length The number of characters to convert; this may |
| * include the terminating <code>NUL</code>. |
| * @stable |
| */ |
| U_CAPI void U_EXPORT2 |
| u_UCharsToChars(const UChar *us, char *cs, UTextOffset length); |
| |
| /** |
| * Parse a string with dotted-decimal version information and |
| * fill in a UVersionInfo structure with the result. |
| * |
| * @param versionArray The destination structure for the version information. |
| * @param versionString A string with dotted-decimal version information, |
| * with up to four non-negative number fields with |
| * values of up to 255 each. |
| */ |
| U_CAPI void U_EXPORT2 |
| u_versionFromString(UVersionInfo versionArray, const char *versionString); |
| |
| /** |
| * Write a string with dotted-decimal version information according |
| * to the input UVersionInfo. |
| * |
| * @param versionArray The version information to be written as a string. |
| * @param versionString A string buffer that will be filled in with |
| * a string corresponding to the numeric version |
| * information in versionArray. |
| * The buffer size must be at least U_MAX_VERSION_STRING_LENGTH. |
| */ |
| U_CAPI void U_EXPORT2 |
| u_versionToString(UVersionInfo versionArray, char *versionString); |
| |
| /** |
| * Gets the ICU release version. The version array stores the version information |
| * for ICU. For example, release "1.3.31.2" is then represented as 0x01031F02. |
| * @param versionArray the version # information, the result will be filled in |
| * @stable |
| */ |
| |
| U_CAPI void U_EXPORT2 |
| u_getVersion(UVersionInfo versionArray); |
| |
| #endif |
