16f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/* 26f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 36f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 46f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Copyright (C) 2001-2013, International Business Machines 56f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* Corporation and others. All Rights Reserved. 66f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 76f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org****************************************************************************** 86f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* file name: ucln.h 96f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* encoding: US-ASCII 106f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* tab size: 8 (not used) 116f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* indentation:4 126f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* 136f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* created on: 2001July05 146f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org* created by: George Rhoten 156f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org*/ 166f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 176f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#ifndef __UCLN_H__ 186f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#define __UCLN_H__ 196f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 206f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#include "unicode/utypes.h" 216f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 226f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** These are the functions used to register a library's memory cleanup 236f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * functions. Each library should define a single library register function 246f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * to call this API. In the i18n library, it is ucln_i18n_registerCleanup(). 256f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 266f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * None of the cleanup functions should use a mutex to clean up an API's 276f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * allocated memory because a cleanup function is not meant to be thread safe, 286f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * and plenty of data cannot be reference counted in order to make sure that 296f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * no one else needs the allocated data. 306f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 316f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * In order to make a cleanup function get called when u_cleanup is called, 326f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * You should add your function to the library specific cleanup function. 336f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * If the cleanup function is not in the common library, the code that 346f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * allocates the memory should call the library specific cleanup function. 356f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For instance, in the i18n library, any memory allocated statically must 366f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * call ucln_i18n_registerCleanup() from the ucln_in.h header. These library 376f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * cleanup functions are needed in order to prevent a circular dependency 386f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * between the common library and any other library. 396f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 406f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * The order of the cleanup is very important. In general, an API that 416f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * depends on a second API should be cleaned up before the second API. 426f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * For instance, the default converter in ustring depends upon the converter 436f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * API. So the default converter should be closed before the converter API 446f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * has its cache flushed. This will prevent any memory leaks due to 456f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * reference counting. 466f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * 476f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Please see common/ucln_cmn.{h,c} and i18n/ucln_in.{h,c} for examples. 486f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 496f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 506f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 516f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Data Type for cleanup function selector. These roughly correspond to libraries. 526f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 536f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef enum ECleanupLibraryType { 546f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_START = -1, 556f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_UPLUG, /* ICU plugins */ 566f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_CUSTOM, /* Custom is for anyone else. */ 576f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_CTESTFW, 586f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_TOOLUTIL, 596f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_LAYOUTEX, 606f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_LAYOUT, 616f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_IO, 626f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_I18N, 636f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org UCLN_COMMON /* This must be the last one to cleanup. */ 646f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org} ECleanupLibraryType; 656f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 666f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 676f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Data type for cleanup function pointer 686f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 696f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CDECL_BEGIN 706f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef UBool U_CALLCONV cleanupFunc(void); 716f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgtypedef void U_CALLCONV initFunc(UErrorCode *); 726f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CDECL_END 736f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 746f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 756f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Register a cleanup function 766f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param type which library to register for. 776f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param func the function pointer 786f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 796f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CAPI void U_EXPORT2 ucln_registerCleanup(ECleanupLibraryType type, 806f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org cleanupFunc *func); 816f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 826f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org/** 836f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Request cleanup for one specific library. 846f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * Not thread safe. 856f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org * @param type which library to cleanup 866f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org */ 876f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.orgU_CAPI void U_EXPORT2 ucln_cleanupOne(ECleanupLibraryType type); 886f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org 896f31ac30b9092fd02a8c97e5216cf53f3e4fae4jshin@chromium.org#endif 90