ICU 76.1: common/unicode/udata.h Source File

ICU 76.1 76.1

udata.h
Go to the documentation of this file.
1// © 2016 and later: Unicode, Inc. and others.
2// License & terms of use: http://www.unicode.org/copyright.html
3/*
4******************************************************************************
5*
6* Copyright (C) 1999-2014, International Business Machines
7* Corporation and others. All Rights Reserved.
8*
9******************************************************************************
10* file name: udata.h
11* encoding: UTF-8
12* tab size: 8 (not used)
13* indentation:4
14*
15* created on: 1999oct25
16* created by: Markus W. Scherer
17*/
18
19#ifndef __UDATA_H__
20#define __UDATA_H__
21
22#include "unicode/utypes.h"
23
24#if U_SHOW_CPLUSPLUS_API
25#include "unicode/localpointer.h"
26#endif // U_SHOW_CPLUSPLUS_API
27
28 U_CDECL_BEGIN
29
45#ifndef U_HIDE_INTERNAL_API
50#define U_TREE_SEPARATOR '-'
51
56#define U_TREE_SEPARATOR_STRING "-"
57
62#define U_TREE_ENTRY_SEP_CHAR '/'
63
68#define U_TREE_ENTRY_SEP_STRING "/"
69
74#define U_ICUDATA_ALIAS "ICUDATA"
75
76#endif /* U_HIDE_INTERNAL_API */
77
116 typedef struct {
119 uint16_t size;
120
123 uint16_t reservedWord;
124
125 /* platform data properties */
128 uint8_t isBigEndian;
129
132 uint8_t charsetFamily;
133
136 uint8_t sizeofUChar;
137
140 uint8_t reservedByte;
141
144 uint8_t dataFormat[4];
145
148 uint8_t formatVersion[4];
149
152 uint8_t dataVersion[4];
153} UDataInfo;
154
155/* API for reading data -----------------------------------------------------*/
156
161 typedef struct UDataMemory UDataMemory;
162
176typedef UBool U_CALLCONV
177UDataMemoryIsAcceptable(void *context,
178 const char *type, const char *name,
179 const UDataInfo *pInfo);
180
181
203 U_CAPI UDataMemory * U_EXPORT2
204udata_open(const char *path, const char *type, const char *name,
205 UErrorCode *pErrorCode);
206
255 U_CAPI UDataMemory * U_EXPORT2
256udata_openChoice(const char *path, const char *type, const char *name,
257 UDataMemoryIsAcceptable *isAcceptable, void *context,
258 UErrorCode *pErrorCode);
259
267 U_CAPI void U_EXPORT2
268udata_close(UDataMemory *pData);
269
279 U_CAPI const void * U_EXPORT2
280udata_getMemory(UDataMemory *pData);
281
300 U_CAPI void U_EXPORT2
301udata_getInfo(UDataMemory *pData, UDataInfo *pInfo);
302
346 U_CAPI void U_EXPORT2
347udata_setCommonData(const void *data, UErrorCode *err);
348
349
377 U_CAPI void U_EXPORT2
378udata_setAppData(const char *packageName, const void *data, UErrorCode *err);
379
385 typedef enum UDataFileAccess {
387 UDATA_FILES_FIRST,
389 UDATA_DEFAULT_ACCESS = UDATA_FILES_FIRST,
391 UDATA_ONLY_PACKAGES,
394 UDATA_PACKAGES_FIRST,
396 UDATA_NO_FILES,
397#ifndef U_HIDE_DEPRECATED_API
402 UDATA_FILE_ACCESS_COUNT
403#endif // U_HIDE_DEPRECATED_API
404} UDataFileAccess;
405
416 U_CAPI void U_EXPORT2
417udata_setFileAccess(UDataFileAccess access, UErrorCode *status);
418
419 U_CDECL_END
420
421#if U_SHOW_CPLUSPLUS_API
422
423U_NAMESPACE_BEGIN
424
434 U_DEFINE_LOCAL_OPEN_POINTER(LocalUDataMemoryPointer, UDataMemory, udata_close);
435
436U_NAMESPACE_END
437
438#endif // U_SHOW_CPLUSPLUS_API
439
440#endif
LocalUDataMemoryPointer
"Smart pointer" class, closes a UDataMemory via udata_close().
localpointer.h
C++ API: "Smart pointers" for use with and in ICU4C C++ code.
U_DEFINE_LOCAL_OPEN_POINTER
#define U_DEFINE_LOCAL_OPEN_POINTER(LocalPointerClassName, Type, closeFunction)
"Smart pointer" definition macro, deletes objects via the closeFunction.
Definition localpointer.h:550
U_CALLCONV
#define U_CALLCONV
Similar to U_CDECL_BEGIN/U_CDECL_END, this qualifier is necessary in callback function typedefs to ma...
Definition platform.h:845
UDataInfo
UDataInfo contains the properties about the requested data.
Definition udata.h:116
UDataInfo::sizeofUChar
uint8_t sizeofUChar
sizeof(UChar), one of { 1, 2, 4 }
Definition udata.h:136
UDataInfo::charsetFamily
uint8_t charsetFamily
see U_CHARSET_FAMILY values in utypes.h
Definition udata.h:132
UDataInfo::isBigEndian
uint8_t isBigEndian
0 for little-endian machine, 1 for big-endian
Definition udata.h:128
UDataInfo::size
uint16_t size
sizeof(UDataInfo)
Definition udata.h:119
UDataInfo::reservedByte
uint8_t reservedByte
unused, set to 0
Definition udata.h:140
UDataInfo::reservedWord
uint16_t reservedWord
unused, set to 0
Definition udata.h:123
udata_setAppData
U_CAPI void udata_setAppData(const char *packageName, const void *data, UErrorCode *err)
This function bypasses the normal ICU data loading process for application-specific data and allows y...
udata_open
U_CAPI UDataMemory * udata_open(const char *path, const char *type, const char *name, UErrorCode *pErrorCode)
Convenience function.
UDataFileAccess
UDataFileAccess
Possible settings for udata_setFileAccess()
Definition udata.h:385
UDATA_FILE_ACCESS_COUNT
@ UDATA_FILE_ACCESS_COUNT
Number of real UDataFileAccess values.
Definition udata.h:402
UDATA_ONLY_PACKAGES
@ UDATA_ONLY_PACKAGES
ICU only loads data from packages, not from single files.
Definition udata.h:391
UDATA_DEFAULT_ACCESS
@ UDATA_DEFAULT_ACCESS
An alias for the default access mode.
Definition udata.h:389
UDATA_FILES_FIRST
@ UDATA_FILES_FIRST
ICU looks for data in single files first, then in packages.
Definition udata.h:387
UDATA_PACKAGES_FIRST
@ UDATA_PACKAGES_FIRST
ICU loads data from packages first, and only from single files if the data cannot be found in a packa...
Definition udata.h:394
UDATA_NO_FILES
@ UDATA_NO_FILES
ICU does not access the file system for data loading.
Definition udata.h:396
udata_getInfo
U_CAPI void udata_getInfo(UDataMemory *pData, UDataInfo *pInfo)
Get the information from the data memory header.
udata_setFileAccess
U_CAPI void udata_setFileAccess(UDataFileAccess access, UErrorCode *status)
This function may be called to control how ICU loads data.
udata_getMemory
U_CAPI const void * udata_getMemory(UDataMemory *pData)
Get the pointer to the actual data inside the data memory.
udata_close
U_CAPI void udata_close(UDataMemory *pData)
Close the data memory.
udata_setCommonData
U_CAPI void udata_setCommonData(const void *data, UErrorCode *err)
This function bypasses the normal ICU data loading process and allows you to force ICU's system data ...
UDataMemoryIsAcceptable
UBool UDataMemoryIsAcceptable(void *context, const char *type, const char *name, const UDataInfo *pInfo)
Callback function for udata_openChoice().
Definition udata.h:177
UDataMemory
struct UDataMemory UDataMemory
Forward declaration of the data memory type.
Definition udata.h:161
udata_openChoice
U_CAPI UDataMemory * udata_openChoice(const char *path, const char *type, const char *name, UDataMemoryIsAcceptable *isAcceptable, void *context, UErrorCode *pErrorCode)
Data loading function.
U_CDECL_END
#define U_CDECL_END
This is used to end a declaration of a library private ICU C API.
Definition umachine.h:86
UBool
int8_t UBool
The ICU boolean type, a signed-byte integer.
Definition umachine.h:247
U_CAPI
#define U_CAPI
This is used to declare a function as a public ICU C API.
Definition umachine.h:110
U_CDECL_BEGIN
#define U_CDECL_BEGIN
This is used to begin a declaration of a library private ICU C API.
Definition umachine.h:85
utypes.h
Basic definitions for ICU, for both C and C++ APIs.
UErrorCode
UErrorCode
Standard ICU4C error code type, a substitute for exceptions.
Definition utypes.h:430