1 // Copyright (C) 2016 and later: Unicode, Inc. and others.
2 // License & terms of use: http://www.unicode.org/copyright.html
4 *******************************************************************************
5 * Copyright (C) 1999-2016, International Business Machines Corporation
6 * and others. All Rights Reserved.
7 *******************************************************************************
8 * file name: uresdata.cpp
10 * tab size: 8 (not used)
13 * created on: 1999dec08
14 * created by: Markus W. Scherer
15 * Modification History:
17 * Date Name Description
18 * 06/20/2000 helena OS/400 port changes; mostly typecast.
19 * 06/24/02 weiv Added support for resource sharing
22 #include "unicode/utypes.h"
23 #include "unicode/udata.h"
24 #include "unicode/ustring.h"
25 #include "unicode/utf16.h"
38 * Resource access helpers
41 /* get a const char* pointer to the key with the keyOffset byte offset from pRoot */
42 #define RES_GET_KEY16(pResData, keyOffset) \
43 ((keyOffset)<(pResData)->localKeyLimit ? \
44 (const char *)(pResData)->pRoot+(keyOffset) : \
45 (pResData)->poolBundleKeys+(keyOffset)-(pResData)->localKeyLimit)
47 #define RES_GET_KEY32(pResData, keyOffset) \
49 (const char *)(pResData)->pRoot+(keyOffset) : \
50 (pResData)->poolBundleKeys+((keyOffset)&0x7fffffff))
52 #define URESDATA_ITEM_NOT_FOUND -1
54 /* empty resources, returned when the resource offset is 0 */
55 static const uint16_t gEmpty16=0;
66 } gEmptyString={ 0, 0, 0 };
69 * All the type-access functions assume that
70 * the resource is of the expected type.
74 _res_findTableItem(const ResourceData *pResData, const uint16_t *keyOffsets, int32_t length,
75 const char *key, const char **realKey) {
77 int32_t mid, start, limit;
80 /* do a binary search for the key */
84 mid = (start + limit) / 2;
85 tableKey = RES_GET_KEY16(pResData, keyOffsets[mid]);
86 if (pResData->useNativeStrcmp) {
87 result = uprv_strcmp(key, tableKey);
89 result = uprv_compareInvCharsAsAscii(key, tableKey);
93 } else if (result > 0) {
101 return URESDATA_ITEM_NOT_FOUND; /* not found or table is empty. */
105 _res_findTable32Item(const ResourceData *pResData, const int32_t *keyOffsets, int32_t length,
106 const char *key, const char **realKey) {
107 const char *tableKey;
108 int32_t mid, start, limit;
111 /* do a binary search for the key */
115 mid = (start + limit) / 2;
116 tableKey = RES_GET_KEY32(pResData, keyOffsets[mid]);
117 if (pResData->useNativeStrcmp) {
118 result = uprv_strcmp(key, tableKey);
120 result = uprv_compareInvCharsAsAscii(key, tableKey);
124 } else if (result > 0) {
132 return URESDATA_ITEM_NOT_FOUND; /* not found or table is empty. */
135 /* helper for res_load() ---------------------------------------------------- */
137 static UBool U_CALLCONV
138 isAcceptable(void *context,
139 const char * /*type*/, const char * /*name*/,
140 const UDataInfo *pInfo) {
141 uprv_memcpy(context, pInfo->formatVersion, 4);
144 pInfo->isBigEndian==U_IS_BIG_ENDIAN &&
145 pInfo->charsetFamily==U_CHARSET_FAMILY &&
146 pInfo->sizeofUChar==U_SIZEOF_UCHAR &&
147 pInfo->dataFormat[0]==0x52 && /* dataFormat="ResB" */
148 pInfo->dataFormat[1]==0x65 &&
149 pInfo->dataFormat[2]==0x73 &&
150 pInfo->dataFormat[3]==0x42 &&
151 (1<=pInfo->formatVersion[0] && pInfo->formatVersion[0]<=3));
154 /* semi-public functions ---------------------------------------------------- */
157 res_init(ResourceData *pResData,
158 UVersionInfo formatVersion, const void *inBytes, int32_t length,
159 UErrorCode *errorCode) {
162 /* get the root resource */
163 pResData->pRoot=(const int32_t *)inBytes;
164 pResData->rootRes=(Resource)*pResData->pRoot;
165 pResData->p16BitUnits=&gEmpty16;
167 /* formatVersion 1.1 must have a root item and at least 5 indexes */
168 if(length>=0 && (length/4)<((formatVersion[0]==1 && formatVersion[1]==0) ? 1 : 1+5)) {
169 *errorCode=U_INVALID_FORMAT_ERROR;
170 res_unload(pResData);
174 /* currently, we accept only resources that have a Table as their roots */
175 rootType=(UResType)RES_GET_TYPE(pResData->rootRes);
176 if(!URES_IS_TABLE(rootType)) {
177 *errorCode=U_INVALID_FORMAT_ERROR;
178 res_unload(pResData);
182 if(formatVersion[0]==1 && formatVersion[1]==0) {
183 pResData->localKeyLimit=0x10000; /* greater than any 16-bit key string offset */
185 /* bundles with formatVersion 1.1 and later contain an indexes[] array */
186 const int32_t *indexes=pResData->pRoot+1;
187 int32_t indexLength=indexes[URES_INDEX_LENGTH]&0xff;
188 if(indexLength<=URES_INDEX_MAX_TABLE_LENGTH) {
189 *errorCode=U_INVALID_FORMAT_ERROR;
190 res_unload(pResData);
194 (length<((1+indexLength)<<2) ||
195 length<(indexes[URES_INDEX_BUNDLE_TOP]<<2))
197 *errorCode=U_INVALID_FORMAT_ERROR;
198 res_unload(pResData);
201 if(indexes[URES_INDEX_KEYS_TOP]>(1+indexLength)) {
202 pResData->localKeyLimit=indexes[URES_INDEX_KEYS_TOP]<<2;
204 if(formatVersion[0]>=3) {
205 // In formatVersion 1, the indexLength took up this whole int.
206 // In version 2, bits 31..8 were reserved and always 0.
207 // In version 3, they contain bits 23..0 of the poolStringIndexLimit.
208 // Bits 27..24 are in indexes[URES_INDEX_ATTRIBUTES] bits 15..12.
209 pResData->poolStringIndexLimit=(int32_t)((uint32_t)indexes[URES_INDEX_LENGTH]>>8);
211 if(indexLength>URES_INDEX_ATTRIBUTES) {
212 int32_t att=indexes[URES_INDEX_ATTRIBUTES];
213 pResData->noFallback=(UBool)(att&URES_ATT_NO_FALLBACK);
214 pResData->isPoolBundle=(UBool)((att&URES_ATT_IS_POOL_BUNDLE)!=0);
215 pResData->usesPoolBundle=(UBool)((att&URES_ATT_USES_POOL_BUNDLE)!=0);
216 pResData->poolStringIndexLimit|=(att&0xf000)<<12; // bits 15..12 -> 27..24
217 pResData->poolStringIndex16Limit=(int32_t)((uint32_t)att>>16);
219 if((pResData->isPoolBundle || pResData->usesPoolBundle) && indexLength<=URES_INDEX_POOL_CHECKSUM) {
220 *errorCode=U_INVALID_FORMAT_ERROR;
221 res_unload(pResData);
224 if( indexLength>URES_INDEX_16BIT_TOP &&
225 indexes[URES_INDEX_16BIT_TOP]>indexes[URES_INDEX_KEYS_TOP]
227 pResData->p16BitUnits=(const uint16_t *)(pResData->pRoot+indexes[URES_INDEX_KEYS_TOP]);
231 if(formatVersion[0]==1 || U_CHARSET_FAMILY==U_ASCII_FAMILY) {
233 * formatVersion 1: compare key strings in native-charset order
234 * formatVersion 2 and up: compare key strings in ASCII order
236 pResData->useNativeStrcmp=TRUE;
240 U_CAPI void U_EXPORT2
241 res_read(ResourceData *pResData,
242 const UDataInfo *pInfo, const void *inBytes, int32_t length,
243 UErrorCode *errorCode) {
244 UVersionInfo formatVersion;
246 uprv_memset(pResData, 0, sizeof(ResourceData));
247 if(U_FAILURE(*errorCode)) {
250 if(!isAcceptable(formatVersion, NULL, NULL, pInfo)) {
251 *errorCode=U_INVALID_FORMAT_ERROR;
254 res_init(pResData, formatVersion, inBytes, length, errorCode);
258 res_load(ResourceData *pResData,
259 const char *path, const char *name, UErrorCode *errorCode) {
260 UVersionInfo formatVersion;
262 uprv_memset(pResData, 0, sizeof(ResourceData));
264 /* load the ResourceBundle file */
265 pResData->data=udata_openChoice(path, "res", name, isAcceptable, formatVersion, errorCode);
266 if(U_FAILURE(*errorCode)) {
270 /* get its memory and initialize *pResData */
271 res_init(pResData, formatVersion, udata_getMemory(pResData->data), -1, errorCode);
275 res_unload(ResourceData *pResData) {
276 if(pResData->data!=NULL) {
277 udata_close(pResData->data);
282 static const int8_t gPublicTypes[URES_LIMIT] = {
288 URES_TABLE, /* URES_TABLE32 */
289 URES_TABLE, /* URES_TABLE16 */
290 URES_STRING, /* URES_STRING_V2 */
294 URES_ARRAY, /* URES_ARRAY16 */
304 U_CAPI UResType U_EXPORT2
305 res_getPublicType(Resource res) {
306 return (UResType)gPublicTypes[RES_GET_TYPE(res)];
309 U_CAPI const UChar * U_EXPORT2
310 res_getString(const ResourceData *pResData, Resource res, int32_t *pLength) {
312 uint32_t offset=RES_GET_OFFSET(res);
314 if(RES_GET_TYPE(res)==URES_STRING_V2) {
316 if((int32_t)offset<pResData->poolStringIndexLimit) {
317 p=(const UChar *)pResData->poolBundleStrings+offset;
319 p=(const UChar *)pResData->p16BitUnits+(offset-pResData->poolStringIndexLimit);
322 if(!U16_IS_TRAIL(first)) {
324 } else if(first<0xdfef) {
327 } else if(first<0xdfff) {
328 length=((first-0xdfef)<<16)|p[1];
331 length=((int32_t)p[1]<<16)|p[2];
334 } else if(res==offset) /* RES_GET_TYPE(res)==URES_STRING */ {
335 const int32_t *p32= res==0 ? &gEmptyString.length : pResData->pRoot+res;
337 p=(const UChar *)p32;
351 * CLDR string value (three empty-set symbols)=={2205, 2205, 2205}
352 * prevents fallback to the parent bundle.
353 * TODO: combine with other code that handles this marker, use EMPTY_SET constant.
354 * TODO: maybe move to uresbund.cpp?
356 UBool isNoInheritanceMarker(const ResourceData *pResData, Resource res) {
357 uint32_t offset=RES_GET_OFFSET(res);
360 } else if (res == offset) {
361 const int32_t *p32=pResData->pRoot+res;
363 const UChar *p=(const UChar *)p32;
364 return length == 3 && p[2] == 0x2205 && p[3] == 0x2205 && p[4] == 0x2205;
365 } else if (RES_GET_TYPE(res) == URES_STRING_V2) {
367 if((int32_t)offset<pResData->poolStringIndexLimit) {
368 p=(const UChar *)pResData->poolBundleStrings+offset;
370 p=(const UChar *)pResData->p16BitUnits+(offset-pResData->poolStringIndexLimit);
373 if (first == 0x2205) { // implicit length
374 return p[1] == 0x2205 && p[2] == 0x2205 && p[3] == 0;
375 } else if (first == 0xdc03) { // explicit length 3 (should not occur)
376 return p[1] == 0x2205 && p[2] == 0x2205 && p[3] == 0x2205;
378 // Assume that the string has not been stored with more length units than necessary.
385 int32_t getStringArray(const ResourceData *pResData, const icu::ResourceArray &array,
386 icu::UnicodeString *dest, int32_t capacity,
387 UErrorCode &errorCode) {
388 if(U_FAILURE(errorCode)) {
391 if(dest == NULL ? capacity != 0 : capacity < 0) {
392 errorCode = U_ILLEGAL_ARGUMENT_ERROR;
395 int32_t length = array.getSize();
399 if(length > capacity) {
400 errorCode = U_BUFFER_OVERFLOW_ERROR;
403 for(int32_t i = 0; i < length; ++i) {
405 const UChar *s = res_getString(pResData, array.internalGetResource(pResData, i), &sLength);
407 errorCode = U_RESOURCE_TYPE_MISMATCH;
410 dest[i].setTo(TRUE, s, sLength);
417 U_CAPI const UChar * U_EXPORT2
418 res_getAlias(const ResourceData *pResData, Resource res, int32_t *pLength) {
420 uint32_t offset=RES_GET_OFFSET(res);
422 if(RES_GET_TYPE(res)==URES_ALIAS) {
423 const int32_t *p32= offset==0 ? &gEmptyString.length : pResData->pRoot+offset;
425 p=(const UChar *)p32;
436 U_CAPI const uint8_t * U_EXPORT2
437 res_getBinary(const ResourceData *pResData, Resource res, int32_t *pLength) {
439 uint32_t offset=RES_GET_OFFSET(res);
441 if(RES_GET_TYPE(res)==URES_BINARY) {
442 const int32_t *p32= offset==0 ? (const int32_t*)&gEmpty32 : pResData->pRoot+offset;
444 p=(const uint8_t *)p32;
456 U_CAPI const int32_t * U_EXPORT2
457 res_getIntVector(const ResourceData *pResData, Resource res, int32_t *pLength) {
459 uint32_t offset=RES_GET_OFFSET(res);
461 if(RES_GET_TYPE(res)==URES_INT_VECTOR) {
462 p= offset==0 ? (const int32_t *)&gEmpty32 : pResData->pRoot+offset;
474 U_CAPI int32_t U_EXPORT2
475 res_countArrayItems(const ResourceData *pResData, Resource res) {
476 uint32_t offset=RES_GET_OFFSET(res);
477 switch(RES_GET_TYPE(res)) {
483 case URES_INT_VECTOR:
487 return offset==0 ? 0 : *(pResData->pRoot+offset);
489 return offset==0 ? 0 : *((const uint16_t *)(pResData->pRoot+offset));
492 return pResData->p16BitUnits[offset];
500 ResourceDataValue::~ResourceDataValue() {}
502 UResType ResourceDataValue::getType() const {
503 return res_getPublicType(res);
506 const UChar *ResourceDataValue::getString(int32_t &length, UErrorCode &errorCode) const {
507 if(U_FAILURE(errorCode)) {
510 const UChar *s = res_getString(pResData, res, &length);
512 errorCode = U_RESOURCE_TYPE_MISMATCH;
517 const UChar *ResourceDataValue::getAliasString(int32_t &length, UErrorCode &errorCode) const {
518 if(U_FAILURE(errorCode)) {
521 const UChar *s = res_getAlias(pResData, res, &length);
523 errorCode = U_RESOURCE_TYPE_MISMATCH;
528 int32_t ResourceDataValue::getInt(UErrorCode &errorCode) const {
529 if(U_FAILURE(errorCode)) {
532 if(RES_GET_TYPE(res) != URES_INT) {
533 errorCode = U_RESOURCE_TYPE_MISMATCH;
535 return RES_GET_INT(res);
538 uint32_t ResourceDataValue::getUInt(UErrorCode &errorCode) const {
539 if(U_FAILURE(errorCode)) {
542 if(RES_GET_TYPE(res) != URES_INT) {
543 errorCode = U_RESOURCE_TYPE_MISMATCH;
545 return RES_GET_UINT(res);
548 const int32_t *ResourceDataValue::getIntVector(int32_t &length, UErrorCode &errorCode) const {
549 if(U_FAILURE(errorCode)) {
552 const int32_t *iv = res_getIntVector(pResData, res, &length);
554 errorCode = U_RESOURCE_TYPE_MISMATCH;
559 const uint8_t *ResourceDataValue::getBinary(int32_t &length, UErrorCode &errorCode) const {
560 if(U_FAILURE(errorCode)) {
563 const uint8_t *b = res_getBinary(pResData, res, &length);
565 errorCode = U_RESOURCE_TYPE_MISMATCH;
570 ResourceArray ResourceDataValue::getArray(UErrorCode &errorCode) const {
571 if(U_FAILURE(errorCode)) {
572 return ResourceArray();
574 const uint16_t *items16 = NULL;
575 const Resource *items32 = NULL;
576 uint32_t offset=RES_GET_OFFSET(res);
578 switch(RES_GET_TYPE(res)) {
580 if (offset!=0) { // empty if offset==0
581 items32 = (const Resource *)pResData->pRoot+offset;
586 items16 = pResData->p16BitUnits+offset;
590 errorCode = U_RESOURCE_TYPE_MISMATCH;
591 return ResourceArray();
593 return ResourceArray(items16, items32, length);
596 ResourceTable ResourceDataValue::getTable(UErrorCode &errorCode) const {
597 if(U_FAILURE(errorCode)) {
598 return ResourceTable();
600 const uint16_t *keys16 = NULL;
601 const int32_t *keys32 = NULL;
602 const uint16_t *items16 = NULL;
603 const Resource *items32 = NULL;
604 uint32_t offset = RES_GET_OFFSET(res);
606 switch(RES_GET_TYPE(res)) {
608 if (offset != 0) { // empty if offset==0
609 keys16 = (const uint16_t *)(pResData->pRoot+offset);
611 items32 = (const Resource *)(keys16+length+(~length&1));
615 keys16 = pResData->p16BitUnits+offset;
617 items16 = keys16 + length;
620 if (offset != 0) { // empty if offset==0
621 keys32 = pResData->pRoot+offset;
623 items32 = (const Resource *)keys32 + length;
627 errorCode = U_RESOURCE_TYPE_MISMATCH;
628 return ResourceTable();
630 return ResourceTable(keys16, keys32, items16, items32, length);
633 UBool ResourceDataValue::isNoInheritanceMarker() const {
634 return ::isNoInheritanceMarker(pResData, res);
637 int32_t ResourceDataValue::getStringArray(UnicodeString *dest, int32_t capacity,
638 UErrorCode &errorCode) const {
639 return ::getStringArray(pResData, getArray(errorCode), dest, capacity, errorCode);
642 int32_t ResourceDataValue::getStringArrayOrStringAsArray(UnicodeString *dest, int32_t capacity,
643 UErrorCode &errorCode) const {
644 if(URES_IS_ARRAY(res)) {
645 return ::getStringArray(pResData, getArray(errorCode), dest, capacity, errorCode);
647 if(U_FAILURE(errorCode)) {
650 if(dest == NULL ? capacity != 0 : capacity < 0) {
651 errorCode = U_ILLEGAL_ARGUMENT_ERROR;
655 errorCode = U_BUFFER_OVERFLOW_ERROR;
659 const UChar *s = res_getString(pResData, res, &sLength);
661 dest[0].setTo(TRUE, s, sLength);
664 errorCode = U_RESOURCE_TYPE_MISMATCH;
668 UnicodeString ResourceDataValue::getStringOrFirstOfArray(UErrorCode &errorCode) const {
670 if(U_FAILURE(errorCode)) {
674 const UChar *s = res_getString(pResData, res, &sLength);
676 us.setTo(TRUE, s, sLength);
679 ResourceArray array = getArray(errorCode);
680 if(U_FAILURE(errorCode)) {
683 if(array.getSize() > 0) {
684 s = res_getString(pResData, array.internalGetResource(pResData, 0), &sLength);
686 us.setTo(TRUE, s, sLength);
690 errorCode = U_RESOURCE_TYPE_MISMATCH;
697 makeResourceFrom16(const ResourceData *pResData, int32_t res16) {
698 if(res16<pResData->poolStringIndex16Limit) {
699 // Pool string, nothing to do.
701 // Local string, adjust the 16-bit offset to a regular one,
702 // with a larger pool string index limit.
703 res16=res16-pResData->poolStringIndex16Limit+pResData->poolStringIndexLimit;
705 return URES_MAKE_RESOURCE(URES_STRING_V2, res16);
708 U_CAPI Resource U_EXPORT2
709 res_getTableItemByKey(const ResourceData *pResData, Resource table,
710 int32_t *indexR, const char **key) {
711 uint32_t offset=RES_GET_OFFSET(table);
714 if(key == NULL || *key == NULL) {
717 switch(RES_GET_TYPE(table)) {
719 if (offset!=0) { /* empty if offset==0 */
720 const uint16_t *p= (const uint16_t *)(pResData->pRoot+offset);
722 *indexR=idx=_res_findTableItem(pResData, p, length, *key, key);
724 const Resource *p32=(const Resource *)(p+length+(~length&1));
731 const uint16_t *p=pResData->p16BitUnits+offset;
733 *indexR=idx=_res_findTableItem(pResData, p, length, *key, key);
735 return makeResourceFrom16(pResData, p[length+idx]);
740 if (offset!=0) { /* empty if offset==0 */
741 const int32_t *p= pResData->pRoot+offset;
743 *indexR=idx=_res_findTable32Item(pResData, p, length, *key, key);
745 return (Resource)p[length+idx];
756 U_CAPI Resource U_EXPORT2
757 res_getTableItemByIndex(const ResourceData *pResData, Resource table,
758 int32_t indexR, const char **key) {
759 uint32_t offset=RES_GET_OFFSET(table);
761 U_ASSERT(indexR>=0); /* to ensure the index is not negative */
762 switch(RES_GET_TYPE(table)) {
764 if (offset != 0) { /* empty if offset==0 */
765 const uint16_t *p= (const uint16_t *)(pResData->pRoot+offset);
768 const Resource *p32=(const Resource *)(p+length+(~length&1));
770 *key=RES_GET_KEY16(pResData, p[indexR]);
778 const uint16_t *p=pResData->p16BitUnits+offset;
782 *key=RES_GET_KEY16(pResData, p[indexR]);
784 return makeResourceFrom16(pResData, p[length+indexR]);
789 if (offset != 0) { /* empty if offset==0 */
790 const int32_t *p= pResData->pRoot+offset;
794 *key=RES_GET_KEY32(pResData, p[indexR]);
796 return (Resource)p[length+indexR];
807 U_CAPI Resource U_EXPORT2
808 res_getResource(const ResourceData *pResData, const char *key) {
809 const char *realKey=key;
811 return res_getTableItemByKey(pResData, pResData->rootRes, &idx, &realKey);
815 UBool icu::ResourceTable::getKeyAndValue(int32_t i,
816 const char *&key, icu::ResourceValue &value) const {
817 if(0 <= i && i < length) {
818 icu::ResourceDataValue &rdValue = static_cast<icu::ResourceDataValue &>(value);
819 if (keys16 != NULL) {
820 key = RES_GET_KEY16(rdValue.pResData, keys16[i]);
822 key = RES_GET_KEY32(rdValue.pResData, keys32[i]);
825 if (items16 != NULL) {
826 res = makeResourceFrom16(rdValue.pResData, items16[i]);
830 rdValue.setResource(res);
836 U_CAPI Resource U_EXPORT2
837 res_getArrayItem(const ResourceData *pResData, Resource array, int32_t indexR) {
838 uint32_t offset=RES_GET_OFFSET(array);
839 U_ASSERT(indexR>=0); /* to ensure the index is not negative */
840 switch(RES_GET_TYPE(array)) {
842 if (offset!=0) { /* empty if offset==0 */
843 const int32_t *p= pResData->pRoot+offset;
845 return (Resource)p[1+indexR];
851 const uint16_t *p=pResData->p16BitUnits+offset;
853 return makeResourceFrom16(pResData, p[1+indexR]);
863 uint32_t icu::ResourceArray::internalGetResource(const ResourceData *pResData, int32_t i) const {
864 if (items16 != NULL) {
865 return makeResourceFrom16(pResData, items16[i]);
871 UBool icu::ResourceArray::getValue(int32_t i, icu::ResourceValue &value) const {
872 if(0 <= i && i < length) {
873 icu::ResourceDataValue &rdValue = static_cast<icu::ResourceDataValue &>(value);
874 rdValue.setResource(internalGetResource(rdValue.pResData, i));
881 res_findResource(const ResourceData *pResData, Resource r, char** path, const char** key) {
882 char *pathP = *path, *nextSepP = *path;
883 char *closeIndex = NULL;
887 UResType type = (UResType)RES_GET_TYPE(t1);
889 /* if you come in with an empty path, you'll be getting back the same resource */
890 if(!uprv_strlen(pathP)) {
894 /* one needs to have an aggregate resource in order to search in it */
895 if(!URES_IS_CONTAINER(type)) {
899 while(nextSepP && *pathP && t1 != RES_BOGUS && URES_IS_CONTAINER(type)) {
900 /* Iteration stops if: the path has been consumed, we found a non-existing
901 * resource (t1 == RES_BOGUS) or we found a scalar resource (including alias)
903 nextSepP = uprv_strchr(pathP, RES_PATH_SEPARATOR);
904 /* if there are more separators, terminate string
905 * and set path to the remaining part of the string
907 if(nextSepP != NULL) {
908 if(nextSepP == pathP) {
912 *nextSepP = 0; /* overwrite the separator with a NUL to terminate the key */
915 *path = uprv_strchr(pathP, 0);
918 /* if the resource is a table */
919 /* try the key based access */
920 if(URES_IS_TABLE(type)) {
922 t2 = res_getTableItemByKey(pResData, t1, &indexR, key);
923 if(t2 == RES_BOGUS) {
924 /* if we fail to get the resource by key, maybe we got an index */
925 indexR = uprv_strtol(pathP, &closeIndex, 10);
926 if(*closeIndex == 0) {
927 /* if we indeed have an index, try to get the item by index */
928 t2 = res_getTableItemByIndex(pResData, t1, indexR, key);
931 } else if(URES_IS_ARRAY(type)) {
932 indexR = uprv_strtol(pathP, &closeIndex, 10);
933 if(*closeIndex == 0) {
934 t2 = res_getArrayItem(pResData, t1, indexR);
936 t2 = RES_BOGUS; /* have an array, but don't have a valid index */
939 } else { /* can't do much here, except setting t2 to bogus */
943 type = (UResType)RES_GET_TYPE(t1);
944 /* position pathP to next resource key/index */
951 /* resource bundle swapping ------------------------------------------------- */
954 * Need to always enumerate the entire item tree,
955 * track the lowest address of any item to use as the limit for char keys[],
956 * track the highest address of any item to return the size of the data.
958 * We should have thought of storing those in the data...
959 * It is possible to extend the data structure by putting additional values
960 * in places that are inaccessible by ordinary enumeration of the item tree.
961 * For example, additional integers could be stored at the beginning or
962 * end of the key strings; this could be indicated by a minor version number,
963 * and the data swapping would have to know about these values.
965 * The data structure does not forbid keys to be shared, so we must swap
966 * all keys once instead of each key when it is referenced.
968 * These swapping functions assume that a resource bundle always has a length
969 * that is a multiple of 4 bytes.
970 * Currently, this is trivially true because genrb writes bundle tree leaves
971 * physically first, before their branches, so that the root table with its
972 * array of resource items (uint32_t values) is always last.
975 /* definitions for table sorting ------------------------ */
978 * row of a temporary array
980 * gets platform-endian key string indexes and sorting indexes;
981 * after sorting this array by keys, the actual key/value arrays are permutated
982 * according to the sorting indexes
985 int32_t keyIndex, sortIndex;
988 static int32_t U_CALLCONV
989 ures_compareRows(const void *context, const void *left, const void *right) {
990 const char *keyChars=(const char *)context;
991 return (int32_t)uprv_strcmp(keyChars+((const Row *)left)->keyIndex,
992 keyChars+((const Row *)right)->keyIndex);
995 typedef struct TempTable {
996 const char *keyChars;
1000 int32_t localKeyLimit;
1001 uint8_t majorFormatVersion;
1005 STACK_ROW_CAPACITY=200
1008 /* The table item key string is not locally available. */
1009 static const char *const gUnknownKey="";
1011 /* resource table key for collation binaries: "%%CollationBin" */
1012 static const UChar gCollationBinKey[]={
1014 0x43, 0x6f, 0x6c, 0x6c, 0x61, 0x74, 0x69, 0x6f, 0x6e,
1020 * swap one resource item
1023 ures_swapResource(const UDataSwapper *ds,
1024 const Resource *inBundle, Resource *outBundle,
1025 Resource res, /* caller swaps res itself */
1027 TempTable *pTempTable,
1028 UErrorCode *pErrorCode) {
1031 int32_t offset, count;
1033 switch(RES_GET_TYPE(res)) {
1035 case URES_STRING_V2:
1038 /* integer, or points to 16-bit units, nothing to do here */
1044 /* all other types use an offset to point to their data */
1045 offset=(int32_t)RES_GET_OFFSET(res);
1047 /* special offset indicating an empty item */
1050 if(pTempTable->resFlags[offset>>5]&((uint32_t)1<<(offset&0x1f))) {
1051 /* we already swapped this resource item */
1054 /* mark it as swapped now */
1055 pTempTable->resFlags[offset>>5]|=((uint32_t)1<<(offset&0x1f));
1061 switch(RES_GET_TYPE(res)) {
1063 /* physically same value layout as string, fall through */
1066 count=udata_readInt32(ds, (int32_t)*p);
1068 ds->swapArray32(ds, p, 4, q, pErrorCode);
1069 /* swap each UChar (the terminating NUL would not change) */
1070 ds->swapArray16(ds, p+1, 2*count, q+1, pErrorCode);
1073 count=udata_readInt32(ds, (int32_t)*p);
1075 ds->swapArray32(ds, p, 4, q, pErrorCode);
1076 /* no need to swap or copy bytes - ures_swap() copied them all */
1078 /* swap known formats */
1079 #if !UCONFIG_NO_COLLATION
1080 if( key!=NULL && /* the binary is in a table */
1082 /* its table key string is "%%CollationBin" */
1083 0==ds->compareInvChars(ds, key, -1,
1084 gCollationBinKey, UPRV_LENGTHOF(gCollationBinKey)-1) :
1085 /* its table key string is unknown but it looks like a collation binary */
1086 ucol_looksLikeCollationBinary(ds, p+1, count))
1088 ucol_swap(ds, p+1, count, q+1, pErrorCode);
1095 const uint16_t *pKey16;
1098 const int32_t *pKey32;
1102 int32_t i, oldIndex;
1104 if(RES_GET_TYPE(res)==URES_TABLE) {
1105 /* get table item count */
1106 pKey16=(const uint16_t *)p;
1107 qKey16=(uint16_t *)q;
1108 count=ds->readUInt16(*pKey16);
1113 ds->swapArray16(ds, pKey16++, 2, qKey16++, pErrorCode);
1115 offset+=((1+count)+1)/2;
1117 /* get table item count */
1118 pKey32=(const int32_t *)p;
1119 qKey32=(int32_t *)q;
1120 count=udata_readInt32(ds, *pKey32);
1125 ds->swapArray32(ds, pKey32++, 4, qKey32++, pErrorCode);
1134 p=inBundle+offset; /* pointer to table resources */
1138 for(i=0; i<count; ++i) {
1139 const char *itemKey=gUnknownKey;
1141 int32_t keyOffset=ds->readUInt16(pKey16[i]);
1142 if(keyOffset<pTempTable->localKeyLimit) {
1143 itemKey=(const char *)outBundle+keyOffset;
1146 int32_t keyOffset=udata_readInt32(ds, pKey32[i]);
1148 itemKey=(const char *)outBundle+keyOffset;
1151 item=ds->readUInt32(p[i]);
1152 ures_swapResource(ds, inBundle, outBundle, item, itemKey, pTempTable, pErrorCode);
1153 if(U_FAILURE(*pErrorCode)) {
1154 udata_printError(ds, "ures_swapResource(table res=%08x)[%d].recurse(%08x) failed\n",
1160 if(pTempTable->majorFormatVersion>1 || ds->inCharset==ds->outCharset) {
1161 /* no need to sort, just swap the offset/value arrays */
1163 ds->swapArray16(ds, pKey16, count*2, qKey16, pErrorCode);
1164 ds->swapArray32(ds, p, count*4, q, pErrorCode);
1166 /* swap key offsets and items as one array */
1167 ds->swapArray32(ds, pKey32, count*2*4, qKey32, pErrorCode);
1173 * We need to sort tables by outCharset key strings because they
1174 * sort differently for different charset families.
1175 * ures_swap() already set pTempTable->keyChars appropriately.
1176 * First we set up a temporary table with the key indexes and
1177 * sorting indexes and sort that.
1178 * Then we permutate and copy/swap the actual values.
1181 for(i=0; i<count; ++i) {
1182 pTempTable->rows[i].keyIndex=ds->readUInt16(pKey16[i]);
1183 pTempTable->rows[i].sortIndex=i;
1186 for(i=0; i<count; ++i) {
1187 pTempTable->rows[i].keyIndex=udata_readInt32(ds, pKey32[i]);
1188 pTempTable->rows[i].sortIndex=i;
1191 uprv_sortArray(pTempTable->rows, count, sizeof(Row),
1192 ures_compareRows, pTempTable->keyChars,
1194 if(U_FAILURE(*pErrorCode)) {
1195 udata_printError(ds, "ures_swapResource(table res=%08x).uprv_sortArray(%d items) failed\n",
1201 * copy/swap/permutate items
1203 * If we swap in-place, then the permutation must use another
1204 * temporary array (pTempTable->resort)
1205 * before the results are copied to the outBundle.
1211 if(pKey16!=qKey16) {
1214 rKey16=(uint16_t *)pTempTable->resort;
1216 for(i=0; i<count; ++i) {
1217 oldIndex=pTempTable->rows[i].sortIndex;
1218 ds->swapArray16(ds, pKey16+oldIndex, 2, rKey16+i, pErrorCode);
1220 if(qKey16!=rKey16) {
1221 uprv_memcpy(qKey16, rKey16, 2*count);
1226 if(pKey32!=qKey32) {
1229 rKey32=pTempTable->resort;
1231 for(i=0; i<count; ++i) {
1232 oldIndex=pTempTable->rows[i].sortIndex;
1233 ds->swapArray32(ds, pKey32+oldIndex, 4, rKey32+i, pErrorCode);
1235 if(qKey32!=rKey32) {
1236 uprv_memcpy(qKey32, rKey32, 4*count);
1248 r=(Resource *)pTempTable->resort;
1250 for(i=0; i<count; ++i) {
1251 oldIndex=pTempTable->rows[i].sortIndex;
1252 ds->swapArray32(ds, p+oldIndex, 4, r+i, pErrorCode);
1255 uprv_memcpy(q, r, 4*count);
1265 count=udata_readInt32(ds, (int32_t)*p);
1267 ds->swapArray32(ds, p++, 4, q++, pErrorCode);
1270 for(i=0; i<count; ++i) {
1271 item=ds->readUInt32(p[i]);
1272 ures_swapResource(ds, inBundle, outBundle, item, NULL, pTempTable, pErrorCode);
1273 if(U_FAILURE(*pErrorCode)) {
1274 udata_printError(ds, "ures_swapResource(array res=%08x)[%d].recurse(%08x) failed\n",
1281 ds->swapArray32(ds, p, 4*count, q, pErrorCode);
1284 case URES_INT_VECTOR:
1285 count=udata_readInt32(ds, (int32_t)*p);
1286 /* swap length and each integer */
1287 ds->swapArray32(ds, p, 4*(1+count), q, pErrorCode);
1290 /* also catches RES_BOGUS */
1291 *pErrorCode=U_UNSUPPORTED_ERROR;
1296 U_CAPI int32_t U_EXPORT2
1297 ures_swap(const UDataSwapper *ds,
1298 const void *inData, int32_t length, void *outData,
1299 UErrorCode *pErrorCode) {
1300 const UDataInfo *pInfo;
1301 const Resource *inBundle;
1303 int32_t headerSize, maxTableLength;
1305 Row rows[STACK_ROW_CAPACITY];
1306 int32_t resort[STACK_ROW_CAPACITY];
1307 TempTable tempTable;
1309 const int32_t *inIndexes;
1311 /* the following integers count Resource item offsets (4 bytes each), not bytes */
1312 int32_t bundleLength, indexLength, keysBottom, keysTop, resBottom, top;
1314 /* udata_swapDataHeader checks the arguments */
1315 headerSize=udata_swapDataHeader(ds, inData, length, outData, pErrorCode);
1316 if(pErrorCode==NULL || U_FAILURE(*pErrorCode)) {
1320 /* check data format and format version */
1321 pInfo=(const UDataInfo *)((const char *)inData+4);
1323 pInfo->dataFormat[0]==0x52 && /* dataFormat="ResB" */
1324 pInfo->dataFormat[1]==0x65 &&
1325 pInfo->dataFormat[2]==0x73 &&
1326 pInfo->dataFormat[3]==0x42 &&
1327 /* formatVersion 1.1+ or 2.x or 3.x */
1328 ((pInfo->formatVersion[0]==1 && pInfo->formatVersion[1]>=1) ||
1329 pInfo->formatVersion[0]==2 || pInfo->formatVersion[0]==3)
1331 udata_printError(ds, "ures_swap(): data format %02x.%02x.%02x.%02x (format version %02x.%02x) is not a resource bundle\n",
1332 pInfo->dataFormat[0], pInfo->dataFormat[1],
1333 pInfo->dataFormat[2], pInfo->dataFormat[3],
1334 pInfo->formatVersion[0], pInfo->formatVersion[1]);
1335 *pErrorCode=U_UNSUPPORTED_ERROR;
1338 tempTable.majorFormatVersion=pInfo->formatVersion[0];
1340 /* a resource bundle must contain at least one resource item */
1344 bundleLength=(length-headerSize)/4;
1346 /* formatVersion 1.1 must have a root item and at least 5 indexes */
1347 if(bundleLength<(1+5)) {
1348 udata_printError(ds, "ures_swap(): too few bytes (%d after header) for a resource bundle\n",
1350 *pErrorCode=U_INDEX_OUTOFBOUNDS_ERROR;
1355 inBundle=(const Resource *)((const char *)inData+headerSize);
1356 rootRes=ds->readUInt32(*inBundle);
1358 /* formatVersion 1.1 adds the indexes[] array */
1359 inIndexes=(const int32_t *)(inBundle+1);
1361 indexLength=udata_readInt32(ds, inIndexes[URES_INDEX_LENGTH])&0xff;
1362 if(indexLength<=URES_INDEX_MAX_TABLE_LENGTH) {
1363 udata_printError(ds, "ures_swap(): too few indexes for a 1.1+ resource bundle\n");
1364 *pErrorCode=U_INDEX_OUTOFBOUNDS_ERROR;
1367 keysBottom=1+indexLength;
1368 keysTop=udata_readInt32(ds, inIndexes[URES_INDEX_KEYS_TOP]);
1369 if(indexLength>URES_INDEX_16BIT_TOP) {
1370 resBottom=udata_readInt32(ds, inIndexes[URES_INDEX_16BIT_TOP]);
1374 top=udata_readInt32(ds, inIndexes[URES_INDEX_BUNDLE_TOP]);
1375 maxTableLength=udata_readInt32(ds, inIndexes[URES_INDEX_MAX_TABLE_LENGTH]);
1377 if(0<=bundleLength && bundleLength<top) {
1378 udata_printError(ds, "ures_swap(): resource top %d exceeds bundle length %d\n",
1380 *pErrorCode=U_INDEX_OUTOFBOUNDS_ERROR;
1383 if(keysTop>(1+indexLength)) {
1384 tempTable.localKeyLimit=keysTop<<2;
1386 tempTable.localKeyLimit=0;
1390 Resource *outBundle=(Resource *)((char *)outData+headerSize);
1392 /* track which resources we have already swapped */
1393 uint32_t stackResFlags[STACK_ROW_CAPACITY];
1394 int32_t resFlagsLength;
1397 * We need one bit per 4 resource bundle bytes so that we can track
1398 * every possible Resource for whether we have swapped it already.
1399 * Multiple Resource words can refer to the same bundle offsets
1400 * for sharing identical values.
1401 * We could optimize this by allocating only for locations above
1402 * where Resource values are stored (above keys & strings).
1404 resFlagsLength=(length+31)>>5; /* number of bytes needed */
1405 resFlagsLength=(resFlagsLength+3)&~3; /* multiple of 4 bytes for uint32_t */
1406 if(resFlagsLength<=(int32_t)sizeof(stackResFlags)) {
1407 tempTable.resFlags=stackResFlags;
1409 tempTable.resFlags=(uint32_t *)uprv_malloc(resFlagsLength);
1410 if(tempTable.resFlags==NULL) {
1411 udata_printError(ds, "ures_swap(): unable to allocate memory for tracking resources\n");
1412 *pErrorCode=U_MEMORY_ALLOCATION_ERROR;
1416 uprv_memset(tempTable.resFlags, 0, resFlagsLength);
1418 /* copy the bundle for binary and inaccessible data */
1419 if(inData!=outData) {
1420 uprv_memcpy(outBundle, inBundle, 4*top);
1423 /* swap the key strings, but not the padding bytes (0xaa) after the last string and its NUL */
1424 udata_swapInvStringBlock(ds, inBundle+keysBottom, 4*(keysTop-keysBottom),
1425 outBundle+keysBottom, pErrorCode);
1426 if(U_FAILURE(*pErrorCode)) {
1427 udata_printError(ds, "ures_swap().udata_swapInvStringBlock(keys[%d]) failed\n", 4*(keysTop-keysBottom));
1431 /* swap the 16-bit units (strings, table16, array16) */
1432 if(keysTop<resBottom) {
1433 ds->swapArray16(ds, inBundle+keysTop, (resBottom-keysTop)*4, outBundle+keysTop, pErrorCode);
1434 if(U_FAILURE(*pErrorCode)) {
1435 udata_printError(ds, "ures_swap().swapArray16(16-bit units[%d]) failed\n", 2*(resBottom-keysTop));
1440 /* allocate the temporary table for sorting resource tables */
1441 tempTable.keyChars=(const char *)outBundle; /* sort by outCharset */
1442 if(tempTable.majorFormatVersion>1 || maxTableLength<=STACK_ROW_CAPACITY) {
1443 tempTable.rows=rows;
1444 tempTable.resort=resort;
1446 tempTable.rows=(Row *)uprv_malloc(maxTableLength*sizeof(Row)+maxTableLength*4);
1447 if(tempTable.rows==NULL) {
1448 udata_printError(ds, "ures_swap(): unable to allocate memory for sorting tables (max length: %d)\n",
1450 *pErrorCode=U_MEMORY_ALLOCATION_ERROR;
1451 if(tempTable.resFlags!=stackResFlags) {
1452 uprv_free(tempTable.resFlags);
1456 tempTable.resort=(int32_t *)(tempTable.rows+maxTableLength);
1459 /* swap the resources */
1460 ures_swapResource(ds, inBundle, outBundle, rootRes, NULL, &tempTable, pErrorCode);
1461 if(U_FAILURE(*pErrorCode)) {
1462 udata_printError(ds, "ures_swapResource(root res=%08x) failed\n",
1466 if(tempTable.rows!=rows) {
1467 uprv_free(tempTable.rows);
1469 if(tempTable.resFlags!=stackResFlags) {
1470 uprv_free(tempTable.resFlags);
1473 /* swap the root resource and indexes */
1474 ds->swapArray32(ds, inBundle, keysBottom*4, outBundle, pErrorCode);
1477 return headerSize+4*top;