| /* |
| ******************************************************************************* |
| * * |
| * Copyright (C) 1999, International Business Machines Corporation and others. * |
| * All Rights Reserved. * |
| * * |
| ******************************************************************************* |
| * file name: uresdata.h |
| * encoding: US-ASCII |
| * tab size: 8 (not used) |
| * indentation:4 |
| * |
| * created on: 1999dec08 |
| * created by: Markus W. Scherer |
| */ |
| |
| #ifndef __RESDATA_H__ |
| #define __RESDATA_H__ |
| |
| #include "unicode/utypes.h" |
| #include "unicode/udata.h" |
| |
| /* |
| * A Resource is a 32-bit value that has 2 bit fields: |
| * 31..28 4-bit type, see enum below |
| * 27..0 28-bit four-byte-offset or value according to the type |
| */ |
| typedef uint32_t Resource; |
| |
| #define RES_BOGUS 0xffffffff |
| |
| #define RES_GET_TYPE(res) ((res)>>28UL) |
| #define RES_GET_OFFSET(res) ((res)&0xfffffff) |
| #define RES_GET_POINTER(pRoot, res) ((pRoot)+RES_GET_OFFSET(res)) |
| |
| /* |
| * Resource types: |
| * Most resources have their values stored at four-byte offsets from the start |
| * of the resource data. These values are at least 4-aligned. |
| * Some resource values are stored directly in the offset field of the Resource itself. |
| * |
| * Type Name Memory layout of values |
| * (in parentheses: scalar, non-offset values) |
| * |
| * 0 Unicode String: int32_t length, UChar[length], (UChar)0, (padding) |
| * or (empty string ("") if offset==0) |
| * |
| * 1 Integer Vector: int32_t length, int32_t[length] |
| * 2 Binary: int32_t length, uint8_t[length], (padding) |
| * - this value should be 16-aligned - |
| * |
| * 7 Integer: (28-bit offset is integer value) |
| * |
| * 14 Array: int32_t count, Resource[count] |
| * 15 Table: uint16_t count, uint16_t keyStringOffsets[count], (uint16_t padding), Resource[count] |
| */ |
| enum { |
| RES_STRING, |
| RES_INT_VECTOR, |
| RES_BINARY, |
| |
| RES_INT=7, |
| |
| RES_ARRAY=14, |
| RES_TABLE |
| }; |
| |
| /* |
| * Structure for a single, memory-mapped ResourceBundle. |
| */ |
| typedef struct { |
| UDataMemory *data; |
| Resource *pRoot; |
| Resource rootRes; |
| } ResourceData; |
| |
| /* |
| * Load a resource bundle file. |
| * The ResourceData structure must be allocated externally. |
| */ |
| U_CFUNC bool_t |
| res_load(ResourceData *pResData, |
| const char *path, const char *name, UErrorCode *errorCode); |
| |
| /* |
| * Release a resource bundle file. |
| * This does not release the ResourceData structure itself. |
| */ |
| U_CFUNC void |
| res_unload(ResourceData *pResData); |
| |
| /* |
| * Return a pointer to a zero-terminated, const UChar* string |
| * and set its length in *pLength. |
| * Returns NULL if not found. |
| */ |
| U_CFUNC const UChar * |
| res_getString(ResourceData *pResData, const char *key, int32_t *pLength); |
| |
| /* |
| * Get a Resource handle for an array of strings, and get the number of strings. |
| * Returns RES_BOGUS if not found. |
| */ |
| U_CFUNC Resource |
| res_getStringArray(ResourceData *pResData, const char *key, int32_t *pCount); |
| |
| /* |
| * Get a string from a string array. |
| * This assumes that arrayRes is a valid handle to an array of strings as returned |
| * by res_getStringArray(), and that index is within bounds. |
| */ |
| U_CFUNC const UChar * |
| res_getStringArrayItem(ResourceData *pResData, |
| Resource arrayRes, int32_t index, int32_t *pLength); |
| |
| #endif |