Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

putil.h File Reference

#include "unicode/utypes.h"

Go to the source code of this file.

Defines

#define IEEE_754   1
#define uprv_isNegative(number)    (*((signed char *)&(number)+sizeof(number)-1)<0)
#define T_CString_itosOffset(a)    ((a)<=9?('0'+(a)):('A'+(a)-10))
#define U_FILE_SEP_CHAR   '/'
 Filesystem file and path separator characters. More...

#define U_PATH_SEP_CHAR   ':'
#define U_FILE_SEP_STRING   "/"
#define U_PATH_SEP_STRING   ":"
#define U_UPPER_ORDINAL(x)    ((x)-'A')
#define U_MAX_PTR(base)    ((void *)(((char *)(base)+0x7fffffff) > (char *)(base) ? ((char *)(base)+0x7fffffff) : (char *)-1))
 Maximum value of a (void*) - use to indicate the limit of an 'infinite' buffer. More...


Functions

U_CAPI UBool U_EXPORT2 uprv_isNaN (double)
 Platform utilities isolates the platform dependencies of the libarary. More...

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)
U_CAPI int16_t U_EXPORT2 uprv_log10 (double d)
 Returns the common log of the double value d. More...

U_CAPI int32_t U_EXPORT2 uprv_digitsAfterDecimal (double x)
 Returns the number of digits after the decimal point in a double number x. More...

U_CAPI void U_EXPORT2 uprv_tzset (void)
 Time zone utilities. More...

U_CAPI int32_t U_EXPORT2 uprv_timezone (void)
U_CAPI char* U_EXPORT2 uprv_tzname (int n)
U_CAPI int32_t U_EXPORT2 uprv_getUTCtime (void)
 Get UTC (GMT) time measured in seconds since 0:00 on 1/1/70. More...

U_CAPI const char* U_EXPORT2 u_getDataDirectory (void)
 Return the data directory for this platform. More...

U_CAPI void U_EXPORT2 u_setDataDirectory (const char *directory)
 Set the data directory. More...

U_CAPI const char* U_EXPORT2 uprv_getDefaultCodepage (void)
 Return the default codepage for this platform and locale. More...

U_CAPI const char* U_EXPORT2 uprv_getDefaultLocaleID (void)
 Return the default locale ID string by querying ths system, or zero if one cannot be found. More...

U_CAPI double U_EXPORT2 uprv_nextDouble (double d, UBool positive)
U_CAPI void U_EXPORT2 u_charsToUChars (const char *cs, UChar *us, UTextOffset length)
 Convert char characters to UChar characters. More...

U_CAPI void U_EXPORT2 u_UCharsToChars (const UChar *us, char *cs, UTextOffset length)
 Convert UChar characters to char characters. More...

U_CAPI void U_EXPORT2 u_versionFromString (UVersionInfo versionArray, const char *versionString)
 Parse a string with dotted-decimal version information and fill in a UVersionInfo structure with the result. More...

U_CAPI void U_EXPORT2 u_versionToString (UVersionInfo versionArray, char *versionString)
 Write a string with dotted-decimal version information according to the input UVersionInfo. More...

U_CAPI void U_EXPORT2 u_getVersion (UVersionInfo versionArray)
 Gets the ICU release version. More...


Define Documentation

#define IEEE_754   1
 

Definition at line 32 of file putil.h.

#define T_CString_itosOffset( a )   ((a)<=9?('0'+(a)):('A'+(a)-10))
 

Definition at line 74 of file putil.h.

#define U_FILE_SEP_CHAR   '/'
 

Filesystem file and path separator characters.

Example: '/' and ':' on Unix, '\' and ';' on Windows.

Draft:

Definition at line 203 of file putil.h.

#define U_FILE_SEP_STRING   "/"
 

Definition at line 205 of file putil.h.

#define U_MAX_PTR( base )   ((void *)(((char *)(base)+0x7fffffff) > (char *)(base) ? ((char *)(base)+0x7fffffff) : (char *)-1))
 

Maximum value of a (void*) - use to indicate the limit of an 'infinite' buffer.

In fact, buffer sizes must not exceed 2GB so that the difference between the buffer limit and the buffer start can be expressed in an int32_t.

The definition of U_MAX_PTR must fulfill the following conditions:

  • return the largest possible pointer greater than base
  • return a valid pointer according to the machine architecture (AS/400, 64-bit, etc.)
  • avoid wrapping around at high addresses
  • make sure that the returned pointer is not farther from base than 0x7fffffff
Parameters:
base   The beginning of a buffer to find the maximum offset from

For internal use only.

Definition at line 326 of file putil.h.

#define U_PATH_SEP_CHAR   ':'
 

Definition at line 204 of file putil.h.

#define U_PATH_SEP_STRING   ":"
 

Definition at line 206 of file putil.h.

#define U_UPPER_ORDINAL( x )   ((x)-'A')
 

Definition at line 285 of file putil.h.

#define uprv_isNegative( number )   (*((signed char *)&(number)+sizeof(number)-1)<0)
 

Definition at line 70 of file putil.h.


Function Documentation

U_CAPI void U_EXPORT2 u_UCharsToChars ( const UChar * us,
char * cs,
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 .

Parameters:
us   Input string, points to length Unicode characters that can be encoded with the codepage-invariant subset of the platform encoding.
cs   Output string, points to memory for length character bytes.
length   The number of characters to convert; this may include the terminating NUL.
Stable:

U_CAPI void U_EXPORT2 u_charsToUChars ( const char * cs,
UChar * us,
UTextOffset length )
 

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 .

Parameters:
cs   Input string, points to length character bytes from a subset of the platform encoding.
us   Output string, points to memory for length Unicode characters.
length   The number of characters to convert; this may include the terminating NUL.
Stable:

U_CAPI const char *U_EXPORT2 u_getDataDirectory ( void )
 

Return the data directory for this platform.

Draft:

U_CAPI void U_EXPORT2 u_getVersion ( UVersionInfo versionArray )
 

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.

Parameters:
versionArray   the version # information, the result will be filled in
Stable:

U_CAPI void U_EXPORT2 u_setDataDirectory ( const char * directory )
 

Set the data directory.

Draft:

U_CAPI void U_EXPORT2 u_versionFromString ( UVersionInfo versionArray,
const char * versionString )
 

Parse a string with dotted-decimal version information and fill in a UVersionInfo structure with the result.

Parameters:
versionArray   The destination structure for the version information.
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_versionToString ( UVersionInfo versionArray,
char * versionString )
 

Write a string with dotted-decimal version information according to the input UVersionInfo.

Parameters:
versionArray   The version information to be written as a string.
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 double U_EXPORT2 uprv_IEEEremainder ( double x,
double y )
 

U_CAPI double U_EXPORT2 uprv_ceil ( double x )
 

U_CAPI int32_t U_EXPORT2 uprv_digitsAfterDecimal ( double x )
 

Returns the number of digits after the decimal point in a double number x.

Parameters:
x   the double number
Draft:

U_CAPI double U_EXPORT2 uprv_fabs ( double x )
 

U_CAPI double U_EXPORT2 uprv_floor ( double x )
 

U_CAPI double U_EXPORT2 uprv_fmax ( double x,
double y )
 

U_CAPI double U_EXPORT2 uprv_fmin ( double x,
double y )
 

U_CAPI double U_EXPORT2 uprv_fmod ( double x,
double y )
 

Referenced by GregorianCalendar::julianDayToDayOfWeek().

U_CAPI const char *U_EXPORT2 uprv_getDefaultCodepage ( void )
 

Return the default codepage for this platform and locale.

Draft:

U_CAPI const char *U_EXPORT2 uprv_getDefaultLocaleID ( void )
 

Return the default locale ID string by querying ths system, or zero if one cannot be found.

Draft:

U_CAPI double U_EXPORT2 uprv_getInfinity ( void )
 

U_CAPI double U_EXPORT2 uprv_getNaN ( void )
 

U_CAPI int32_t U_EXPORT2 uprv_getUTCtime ( void )
 

Get UTC (GMT) time measured in seconds since 0:00 on 1/1/70.

Draft:

U_CAPI UBool U_EXPORT2 uprv_isInfinite ( double )
 

U_CAPI UBool U_EXPORT2 uprv_isNaN ( double )
 

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.

U_CAPI UBool U_EXPORT2 uprv_isNegativeInfinity ( double )
 

U_CAPI UBool U_EXPORT2 uprv_isPositiveInfinity ( double )
 

U_CAPI int16_t U_EXPORT2 uprv_log10 ( double d )
 

Returns the common log of the double value d.

Parameters:
d   the double value to apply the common log function for.
Returns:
the log of value d.
Draft:

U_CAPI void U_EXPORT2 uprv_longBitsFromDouble ( double d,
int32_t * hi,
uint32_t * lo )
 

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_modf ( double x,
double * y )
 

U_CAPI double U_EXPORT2 uprv_nextDouble ( double d,
UBool positive )
 

U_CAPI double U_EXPORT2 uprv_pow10 ( int32_t x )
 

U_CAPI int32_t U_EXPORT2 uprv_timezone ( void )
 

U_CAPI double U_EXPORT2 uprv_trunc ( double d )
 

U_CAPI char* U_EXPORT2 uprv_tzname ( int n )
 

U_CAPI void U_EXPORT2 uprv_tzset ( void )
 

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 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 Panel’s Date/Time application.

Draft:


Generated at Tue Jun 12 14:04:04 2001 for ICU 1.8.1 by doxygen1.2.3 written by Dimitri van Heesch, © 1997-2000