[apple/icu.git] / icuSources / common / unicode / putil.h

// © 2016 and later: Unicode, Inc. and others.
// License & terms of use: http://www.unicode.org/copyright.html
/*
******************************************************************************
*
*   Copyright (C) 1997-2014, 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"
 /**
  * \file
  * \brief C API: Platform Utilities
  */

/*==========================================================================*/
/* 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.
 */

/**
 * Return the ICU data directory. 
 * The data directory is where common format ICU data files (.dat files)
 *   are loaded from.  Note that normal use of the built-in ICU
 *   facilities does not require loading of an external data file;
 *   unless you are adding custom data to ICU, the data directory
 *   does not need to be set.
 *
 * The data directory is determined as follows:
 *    If u_setDataDirectory() has been called, that is it, otherwise
 *    if the ICU_DATA environment variable is set, use that, otherwise
 *    If a data directory was specifed at ICU build time
 *      <code>
 * \code
 *        #define ICU_DATA_DIR "path" 
 * \endcode
 * </code> use that,
 *    otherwise no data directory is available.
 *
 * @return the data directory, or an empty string ("") if no data directory has
 *         been specified.
 *   
 * @stable ICU 2.0
 */
U_STABLE const char* U_EXPORT2 u_getDataDirectory(void);


/** 
 * Set the ICU data directory. 
 * The data directory is where common format ICU data files (.dat files)
 *   are loaded from.  Note that normal use of the built-in ICU
 *   facilities does not require loading of an external data file;
 *   unless you are adding custom data to ICU, the data directory
 *   does not need to be set.
 *
 * This function should be called at most once in a process, before the
 * first ICU operation (e.g., u_init()) that will require the loading of an
 * ICU data file.
 * This function is not thread-safe. Use it before calling ICU APIs from
 * multiple threads.
 *
 * @param directory The directory to be set.
 *
 * @see u_init
 * @stable ICU 2.0
 */
U_STABLE void U_EXPORT2 u_setDataDirectory(const char *directory);

#ifndef U_HIDE_INTERNAL_API
/**
  * Return the time zone files override directory, or an empty string if
  * no directory was specified. Certain time zone resources will be preferrentially
  * loaded from individual files in this directory.
  *
  * @return the time zone data override directory.
  * @internal
  */ 
U_INTERNAL const char * U_EXPORT2 u_getTimeZoneFilesDirectory(UErrorCode *status);

/**
  * Set the time zone files override directory.
  * This function is not thread safe; it must not be called concurrently with
  *   u_getTimeZoneFilesDirectory() or any other use of ICU time zone functions.
  * This function should only be called before using any ICU service that
  *   will access the time zone data.
  * @internal
  */
U_INTERNAL void U_EXPORT2 u_setTimeZoneFilesDirectory(const char *path, UErrorCode *status);
#endif  /* U_HIDE_INTERNAL_API */


/**
 * @{
 * Filesystem file and path separator characters.
 * Example: '/' and ':' on Unix, '\\' and ';' on Windows.
 * @stable ICU 2.0
 */
#if U_PLATFORM_USES_ONLY_WIN32_API
#   define U_FILE_SEP_CHAR '\\'
#   define U_FILE_ALT_SEP_CHAR '/'
#   define U_PATH_SEP_CHAR ';'
#   define U_FILE_SEP_STRING "\\"
#   define U_FILE_ALT_SEP_STRING "/"
#   define U_PATH_SEP_STRING ";"
#else
#   define U_FILE_SEP_CHAR '/'
#   define U_FILE_ALT_SEP_CHAR '/'
#   define U_PATH_SEP_CHAR ':'
#   define U_FILE_SEP_STRING "/"
#   define U_FILE_ALT_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 U_CHARSET_FAMILY.
 *
 * @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>.
 *
 * @see U_CHARSET_FAMILY
 * @stable ICU 2.0
 */
U_STABLE void U_EXPORT2
u_charsToUChars(const char *cs, UChar *us, int32_t 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 U_CHARSET_FAMILY.
 *
 * @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>.
 *
 * @see U_CHARSET_FAMILY
 * @stable ICU 2.0
 */
U_STABLE void U_EXPORT2
u_UCharsToChars(const UChar *us, char *cs, int32_t length);

#endif
Commit	Line	Data
f3c0d7a5 A	1	// © 2016 and later: Unicode, Inc. and others.
f3c0d7a5 A	2	// License & terms of use: http://www.unicode.org/copyright.html
b75a7d8f A	3	/*
	4	******************************************************************************
	5	*
b331163b	6	* Copyright (C) 1997-2014, International Business Machines
b75a7d8f A	7	* Corporation and others. All Rights Reserved.
	8	*
	9	******************************************************************************
	10	*
	11	* FILE NAME : putil.h
	12	*
	13	* Date Name Description
	14	* 05/14/98 nos Creation (content moved here from utypes.h).
	15	* 06/17/99 erm Added IEEE_754
	16	* 07/22/98 stephen Added IEEEremainder, max, min, trunc
	17	* 08/13/98 stephen Added isNegativeInfinity, isPositiveInfinity
	18	* 08/24/98 stephen Added longBitsFromDouble
	19	* 03/02/99 stephen Removed openFile(). Added AS400 support.
	20	* 04/15/99 stephen Converted to C
	21	* 11/15/99 helena Integrated S/390 changes for IEEE support.
	22	* 01/11/00 helena Added u_getVersion.
	23	******************************************************************************
	24	*/
	25
	26	#ifndef PUTIL_H
	27	#define PUTIL_H
	28
	29	#include "unicode/utypes.h"
73c04bcf A	30	/**
	31	* \file
	32	* \brief C API: Platform Utilities
	33	*/
729e4ab9	34
b75a7d8f A	35	/==========================================================================/
	36	/* Platform utilities */
	37	/==========================================================================/
	38
	39	/**
	40	* Platform utilities isolates the platform dependencies of the
	41	* libarary. For each platform which this code is ported to, these
	42	* functions may have to be re-implemented.
	43	*/
	44
b75a7d8f A	45	/**
	46	* Return the ICU data directory.
	47	* The data directory is where common format ICU data files (.dat files)
	48	* are loaded from. Note that normal use of the built-in ICU
	49	* facilities does not require loading of an external data file;
	50	* unless you are adding custom data to ICU, the data directory
	51	* does not need to be set.
	52	*
	53	* The data directory is determined as follows:
	54	* If u_setDataDirectory() has been called, that is it, otherwise
	55	* if the ICU_DATA environment variable is set, use that, otherwise
	56	* If a data directory was specifed at ICU build time
729e4ab9 A	57	* <code>
	58	* \code
	59	* #define ICU_DATA_DIR "path"
	60	* \endcode
	61	* </code> use that,
b75a7d8f A	62	* otherwise no data directory is available.
	63	*
	64	* @return the data directory, or an empty string ("") if no data directory has
	65	* been specified.
	66	*
	67	* @stable ICU 2.0
	68	*/
374ca955	69	U_STABLE const char* U_EXPORT2 u_getDataDirectory(void);
b75a7d8f	70
b331163b	71
b75a7d8f A	72	/**
	73	* Set the ICU data directory.
	74	* The data directory is where common format ICU data files (.dat files)
	75	* are loaded from. Note that normal use of the built-in ICU
	76	* facilities does not require loading of an external data file;
	77	* unless you are adding custom data to ICU, the data directory
	78	* does not need to be set.
	79	*
	80	* This function should be called at most once in a process, before the
	81	* first ICU operation (e.g., u_init()) that will require the loading of an
	82	* ICU data file.
	83	* This function is not thread-safe. Use it before calling ICU APIs from
	84	* multiple threads.
	85	*
	86	* @param directory The directory to be set.
	87	*
	88	* @see u_init
	89	* @stable ICU 2.0
	90	*/
374ca955	91	U_STABLE void U_EXPORT2 u_setDataDirectory(const char *directory);
b75a7d8f	92
b331163b A	93	#ifndef U_HIDE_INTERNAL_API
	94	/**
	95	* Return the time zone files override directory, or an empty string if
	96	* no directory was specified. Certain time zone resources will be preferrentially
	97	* loaded from individual files in this directory.
	98	*
	99	* @return the time zone data override directory.
	100	* @internal
	101	*/
	102	U_INTERNAL const char * U_EXPORT2 u_getTimeZoneFilesDirectory(UErrorCode *status);
	103
	104	/**
	105	* Set the time zone files override directory.
	106	* This function is not thread safe; it must not be called concurrently with
	107	* u_getTimeZoneFilesDirectory() or any other use of ICU time zone functions.
	108	* This function should only be called before using any ICU service that
	109	* will access the time zone data.
	110	* @internal
	111	*/
	112	U_INTERNAL void U_EXPORT2 u_setTimeZoneFilesDirectory(const char path, UErrorCode status);
	113	#endif /* U_HIDE_INTERNAL_API */
	114
	115
b75a7d8f	116	/**
729e4ab9	117	* @{
b75a7d8f A	118	* Filesystem file and path separator characters.
	119	* Example: '/' and ':' on Unix, '\\' and ';' on Windows.
	120	* @stable ICU 2.0
	121	*/
b331163b	122	#if U_PLATFORM_USES_ONLY_WIN32_API
b75a7d8f	123	# define U_FILE_SEP_CHAR '\\'
374ca955	124	# define U_FILE_ALT_SEP_CHAR '/'
b75a7d8f A	125	# define U_PATH_SEP_CHAR ';'
b75a7d8f A	126	# define U_FILE_SEP_STRING "\\"
374ca955	127	# define U_FILE_ALT_SEP_STRING "/"
b75a7d8f A	128	# define U_PATH_SEP_STRING ";"
	129	#else
	130	# define U_FILE_SEP_CHAR '/'
374ca955	131	# define U_FILE_ALT_SEP_CHAR '/'
b75a7d8f A	132	# define U_PATH_SEP_CHAR ':'
b75a7d8f A	133	# define U_FILE_SEP_STRING "/"
374ca955	134	# define U_FILE_ALT_SEP_STRING "/"
b75a7d8f A	135	# define U_PATH_SEP_STRING ":"
	136	#endif
	137
729e4ab9 A	138	/** @} */
729e4ab9 A	139
b75a7d8f A	140	/**
	141	* Convert char characters to UChar characters.
	142	* This utility function is useful only for "invariant characters"
	143	* that are encoded in the platform default encoding.
	144	* They are a small, constant subset of the encoding and include
	145	* just the latin letters, digits, and some punctuation.
374ca955	146	* For details, see U_CHARSET_FAMILY.
b75a7d8f A	147	*
	148	* @param cs Input string, points to <code>length</code>
	149	* character bytes from a subset of the platform encoding.
	150	* @param us Output string, points to memory for <code>length</code>
	151	* Unicode characters.
	152	* @param length The number of characters to convert; this may
	153	* include the terminating <code>NUL</code>.
374ca955 A	154	*
374ca955 A	155	* @see U_CHARSET_FAMILY
b75a7d8f A	156	* @stable ICU 2.0
b75a7d8f A	157	*/
374ca955	158	U_STABLE void U_EXPORT2
b75a7d8f A	159	u_charsToUChars(const char cs, UChar us, int32_t length);
	160
	161	/**
	162	* Convert UChar characters to char characters.
	163	* This utility function is useful only for "invariant characters"
	164	* that can be encoded in the platform default encoding.
	165	* They are a small, constant subset of the encoding and include
	166	* just the latin letters, digits, and some punctuation.
374ca955	167	* For details, see U_CHARSET_FAMILY.
b75a7d8f A	168	*
	169	* @param us Input string, points to <code>length</code>
	170	* Unicode characters that can be encoded with the
	171	* codepage-invariant subset of the platform encoding.
	172	* @param cs Output string, points to memory for <code>length</code>
	173	* character bytes.
	174	* @param length The number of characters to convert; this may
	175	* include the terminating <code>NUL</code>.
374ca955 A	176	*
374ca955 A	177	* @see U_CHARSET_FAMILY
b75a7d8f A	178	* @stable ICU 2.0
b75a7d8f A	179	*/
374ca955	180	U_STABLE void U_EXPORT2
b75a7d8f A	181	u_UCharsToChars(const UChar us, char cs, int32_t length);
b75a7d8f A	182
b75a7d8f	183	#endif