[apple/icu.git] / icuSources / tools / toolutil / toolutil.h

/*
*******************************************************************************
*
*   Copyright (C) 1999-2005, International Business Machines
*   Corporation and others.  All Rights Reserved.
*
*******************************************************************************
*   file name:  toolutil.h
*   encoding:   US-ASCII
*   tab size:   8 (not used)
*   indentation:4
*
*   created on: 1999nov19
*   created by: Markus W. Scherer
*
*   This file defines utility functions for ICU tools like genccode.
*/

#ifndef __TOOLUTIL_H__
#define __TOOLUTIL_H__

#include "unicode/utypes.h"

/*
 * For Windows, a path/filename may be the short (8.3) version
 * of the "real", long one. In this case, the short one
 * is abbreviated and contains a tilde etc.
 * This function returns a pointer to the original pathname
 * if it is the "real" one itself, and a pointer to a static
 * buffer (not thread-safe) containing the long version
 * if the pathname is indeed abbreviated.
 *
 * On platforms other than Windows, this function always returns
 * the input pathname pointer.
 *
 * This function is especially useful in tools that are called
 * by a batch file for loop, which yields short pathnames on Win9x.
 */
U_CAPI const char * U_EXPORT2
getLongPathname(const char *pathname);

/*
 * Find the basename at the end of a pathname, i.e., the part
 * after the last file separator, and return a pointer
 * to this part of the pathname.
 * If the pathname only contains a basename and no file separator,
 * then the pathname pointer itself is returned.
 */
U_CAPI const char * U_EXPORT2
findBasename(const char *filename);

/*
 * Creates a diretory with pathname.
 *
 * @param status Set to an error code when mkdir failed.
 */
U_CAPI void U_EXPORT2
uprv_mkdir(const char *pathname, UErrorCode *status);

/*
 * UToolMemory is used for generic, custom memory management.
 * It is allocated with enough space for count*size bytes starting
 * at array.
 * The array is declared with a union of large data types so
 * that its base address is aligned for any types.
 * If size is a multiple of a data type size, then such items
 * can be safely allocated inside the array, at offsets that
 * are themselves multiples of size.
 */
struct UToolMemory;
typedef struct UToolMemory UToolMemory;

/**
 * Open a UToolMemory object for allocation of initialCapacity to maxCapacity
 * items with size bytes each.
 */
U_CAPI UToolMemory * U_EXPORT2
utm_open(const char *name, int32_t initialCapacity, int32_t maxCapacity, int32_t size);

/**
 * Close a UToolMemory object.
 */
U_CAPI void U_EXPORT2
utm_close(UToolMemory *mem);

/**
 * Get the pointer to the beginning of the array of items.
 * The pointer becomes invalid after allocation of new items.
 */
U_CAPI void * U_EXPORT2
utm_getStart(UToolMemory *mem);

/**
 * Get the current number of items.
 */
U_CAPI int32_t U_EXPORT2
utm_countItems(UToolMemory *mem);

/**
 * Allocate one more item and return the pointer to its start in the array.
 */
U_CAPI void * U_EXPORT2
utm_alloc(UToolMemory *mem);

/**
 * Allocate n items and return the pointer to the start of the first one in the array.
 */
U_CAPI void * U_EXPORT2
utm_allocN(UToolMemory *mem, int32_t n);

#endif
Commit	Line	Data
b75a7d8f A	1	/*
	2	*******************************************************************************
	3	*
73c04bcf	4	* Copyright (C) 1999-2005, International Business Machines
b75a7d8f A	5	* Corporation and others. All Rights Reserved.
	6	*
	7	*******************************************************************************
	8	* file name: toolutil.h
	9	* encoding: US-ASCII
	10	* tab size: 8 (not used)
	11	* indentation:4
	12	*
	13	* created on: 1999nov19
	14	* created by: Markus W. Scherer
	15	*
	16	* This file defines utility functions for ICU tools like genccode.
	17	*/
	18
	19	#ifndef __TOOLUTIL_H__
	20	#define __TOOLUTIL_H__
	21
	22	#include "unicode/utypes.h"
	23
b75a7d8f A	24	/*
	25	* For Windows, a path/filename may be the short (8.3) version
	26	* of the "real", long one. In this case, the short one
	27	* is abbreviated and contains a tilde etc.
	28	* This function returns a pointer to the original pathname
	29	* if it is the "real" one itself, and a pointer to a static
	30	* buffer (not thread-safe) containing the long version
	31	* if the pathname is indeed abbreviated.
	32	*
	33	* On platforms other than Windows, this function always returns
	34	* the input pathname pointer.
	35	*
	36	* This function is especially useful in tools that are called
	37	* by a batch file for loop, which yields short pathnames on Win9x.
	38	*/
	39	U_CAPI const char * U_EXPORT2
	40	getLongPathname(const char *pathname);
	41
	42	/*
	43	* Find the basename at the end of a pathname, i.e., the part
	44	* after the last file separator, and return a pointer
	45	* to this part of the pathname.
	46	* If the pathname only contains a basename and no file separator,
	47	* then the pathname pointer itself is returned.
	48	*/
	49	U_CAPI const char * U_EXPORT2
	50	findBasename(const char *filename);
	51
73c04bcf A	52	/*
	53	* Creates a diretory with pathname.
	54	*
	55	* @param status Set to an error code when mkdir failed.
	56	*/
	57	U_CAPI void U_EXPORT2
	58	uprv_mkdir(const char pathname, UErrorCode status);
	59
374ca955 A	60	/*
	61	* UToolMemory is used for generic, custom memory management.
	62	* It is allocated with enough space for count*size bytes starting
	63	* at array.
	64	* The array is declared with a union of large data types so
	65	* that its base address is aligned for any types.
	66	* If size is a multiple of a data type size, then such items
	67	* can be safely allocated inside the array, at offsets that
	68	* are themselves multiples of size.
	69	*/
	70	struct UToolMemory;
	71	typedef struct UToolMemory UToolMemory;
	72
	73	/**
	74	* Open a UToolMemory object for allocation of initialCapacity to maxCapacity
	75	* items with size bytes each.
	76	*/
	77	U_CAPI UToolMemory * U_EXPORT2
	78	utm_open(const char *name, int32_t initialCapacity, int32_t maxCapacity, int32_t size);
	79
	80	/**
	81	* Close a UToolMemory object.
	82	*/
	83	U_CAPI void U_EXPORT2
	84	utm_close(UToolMemory *mem);
	85
	86	/**
	87	* Get the pointer to the beginning of the array of items.
	88	* The pointer becomes invalid after allocation of new items.
	89	*/
	90	U_CAPI void * U_EXPORT2
	91	utm_getStart(UToolMemory *mem);
	92
	93	/**
	94	* Get the current number of items.
	95	*/
	96	U_CAPI int32_t U_EXPORT2
	97	utm_countItems(UToolMemory *mem);
	98
	99	/**
	100	* Allocate one more item and return the pointer to its start in the array.
	101	*/
	102	U_CAPI void * U_EXPORT2
	103	utm_alloc(UToolMemory *mem);
	104
	105	/**
	106	* Allocate n items and return the pointer to the start of the first one in the array.
	107	*/
	108	U_CAPI void * U_EXPORT2
	109	utm_allocN(UToolMemory *mem, int32_t n);
	110
b75a7d8f	111	#endif