1 // © 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"
39 * Resource access helpers
42 /* get a const char* pointer to the key with the keyOffset byte offset from pRoot */
43 #define RES_GET_KEY16(pResData, keyOffset) \
44 ((keyOffset)<(pResData)->localKeyLimit ? \
45 (const char *)(pResData)->pRoot+(keyOffset) : \
46 (pResData)->poolBundleKeys+(keyOffset)-(pResData)->localKeyLimit)
48 #define RES_GET_KEY32(pResData, keyOffset) \
50 (const char *)(pResData)->pRoot+(keyOffset) : \
51 (pResData)->poolBundleKeys+((keyOffset)&0x7fffffff))
53 #define URESDATA_ITEM_NOT_FOUND -1
55 /* empty resources, returned when the resource offset is 0 */
56 static const uint16_t gEmpty16
=0;
67 } gEmptyString
={ 0, 0, 0 };
70 * All the type-access functions assume that
71 * the resource is of the expected type.
75 _res_findTableItem(const ResourceData
*pResData
, const uint16_t *keyOffsets
, int32_t length
,
76 const char *key
, const char **realKey
) {
78 int32_t mid
, start
, limit
;
81 /* do a binary search for the key */
85 mid
= (start
+ limit
) / 2;
86 tableKey
= RES_GET_KEY16(pResData
, keyOffsets
[mid
]);
87 if (pResData
->useNativeStrcmp
) {
88 result
= uprv_strcmp(key
, tableKey
);
90 result
= uprv_compareInvCharsAsAscii(key
, tableKey
);
94 } else if (result
> 0) {
102 return URESDATA_ITEM_NOT_FOUND
; /* not found or table is empty. */
106 _res_findTable32Item(const ResourceData
*pResData
, const int32_t *keyOffsets
, int32_t length
,
107 const char *key
, const char **realKey
) {
108 const char *tableKey
;
109 int32_t mid
, start
, limit
;
112 /* do a binary search for the key */
116 mid
= (start
+ limit
) / 2;
117 tableKey
= RES_GET_KEY32(pResData
, keyOffsets
[mid
]);
118 if (pResData
->useNativeStrcmp
) {
119 result
= uprv_strcmp(key
, tableKey
);
121 result
= uprv_compareInvCharsAsAscii(key
, tableKey
);
125 } else if (result
> 0) {
133 return URESDATA_ITEM_NOT_FOUND
; /* not found or table is empty. */
136 /* helper for res_load() ---------------------------------------------------- */
138 static UBool U_CALLCONV
139 isAcceptable(void *context
,
140 const char * /*type*/, const char * /*name*/,
141 const UDataInfo
*pInfo
) {
142 uprv_memcpy(context
, pInfo
->formatVersion
, 4);
145 pInfo
->isBigEndian
==U_IS_BIG_ENDIAN
&&
146 pInfo
->charsetFamily
==U_CHARSET_FAMILY
&&
147 pInfo
->sizeofUChar
==U_SIZEOF_UCHAR
&&
148 pInfo
->dataFormat
[0]==0x52 && /* dataFormat="ResB" */
149 pInfo
->dataFormat
[1]==0x65 &&
150 pInfo
->dataFormat
[2]==0x73 &&
151 pInfo
->dataFormat
[3]==0x42 &&
152 (1<=pInfo
->formatVersion
[0] && pInfo
->formatVersion
[0]<=3));
155 /* semi-public functions ---------------------------------------------------- */
158 res_init(ResourceData
*pResData
,
159 UVersionInfo formatVersion
, const void *inBytes
, int32_t length
,
160 UErrorCode
*errorCode
) {
163 /* get the root resource */
164 pResData
->pRoot
=(const int32_t *)inBytes
;
165 pResData
->rootRes
=(Resource
)*pResData
->pRoot
;
166 pResData
->p16BitUnits
=&gEmpty16
;
168 /* formatVersion 1.1 must have a root item and at least 5 indexes */
169 if(length
>=0 && (length
/4)<((formatVersion
[0]==1 && formatVersion
[1]==0) ? 1 : 1+5)) {
170 *errorCode
=U_INVALID_FORMAT_ERROR
;
171 res_unload(pResData
);
175 /* currently, we accept only resources that have a Table as their roots */
176 rootType
=(UResType
)RES_GET_TYPE(pResData
->rootRes
);
177 if(!URES_IS_TABLE(rootType
)) {
178 *errorCode
=U_INVALID_FORMAT_ERROR
;
179 res_unload(pResData
);
183 if(formatVersion
[0]==1 && formatVersion
[1]==0) {
184 pResData
->localKeyLimit
=0x10000; /* greater than any 16-bit key string offset */
186 /* bundles with formatVersion 1.1 and later contain an indexes[] array */
187 const int32_t *indexes
=pResData
->pRoot
+1;
188 int32_t indexLength
=indexes
[URES_INDEX_LENGTH
]&0xff;
189 if(indexLength
<=URES_INDEX_MAX_TABLE_LENGTH
) {
190 *errorCode
=U_INVALID_FORMAT_ERROR
;
191 res_unload(pResData
);
195 (length
<((1+indexLength
)<<2) ||
196 length
<(indexes
[URES_INDEX_BUNDLE_TOP
]<<2))
198 *errorCode
=U_INVALID_FORMAT_ERROR
;
199 res_unload(pResData
);
202 if(indexes
[URES_INDEX_KEYS_TOP
]>(1+indexLength
)) {
203 pResData
->localKeyLimit
=indexes
[URES_INDEX_KEYS_TOP
]<<2;
205 if(formatVersion
[0]>=3) {
206 // In formatVersion 1, the indexLength took up this whole int.
207 // In version 2, bits 31..8 were reserved and always 0.
208 // In version 3, they contain bits 23..0 of the poolStringIndexLimit.
209 // Bits 27..24 are in indexes[URES_INDEX_ATTRIBUTES] bits 15..12.
210 pResData
->poolStringIndexLimit
=(int32_t)((uint32_t)indexes
[URES_INDEX_LENGTH
]>>8);
212 if(indexLength
>URES_INDEX_ATTRIBUTES
) {
213 int32_t att
=indexes
[URES_INDEX_ATTRIBUTES
];
214 pResData
->noFallback
=(UBool
)(att
&URES_ATT_NO_FALLBACK
);
215 pResData
->isPoolBundle
=(UBool
)((att
&URES_ATT_IS_POOL_BUNDLE
)!=0);
216 pResData
->usesPoolBundle
=(UBool
)((att
&URES_ATT_USES_POOL_BUNDLE
)!=0);
217 pResData
->poolStringIndexLimit
|=(att
&0xf000)<<12; // bits 15..12 -> 27..24
218 pResData
->poolStringIndex16Limit
=(int32_t)((uint32_t)att
>>16);
220 if((pResData
->isPoolBundle
|| pResData
->usesPoolBundle
) && indexLength
<=URES_INDEX_POOL_CHECKSUM
) {
221 *errorCode
=U_INVALID_FORMAT_ERROR
;
222 res_unload(pResData
);
225 if( indexLength
>URES_INDEX_16BIT_TOP
&&
226 indexes
[URES_INDEX_16BIT_TOP
]>indexes
[URES_INDEX_KEYS_TOP
]
228 pResData
->p16BitUnits
=(const uint16_t *)(pResData
->pRoot
+indexes
[URES_INDEX_KEYS_TOP
]);
232 if(formatVersion
[0]==1 || U_CHARSET_FAMILY
==U_ASCII_FAMILY
) {
234 * formatVersion 1: compare key strings in native-charset order
235 * formatVersion 2 and up: compare key strings in ASCII order
237 pResData
->useNativeStrcmp
=TRUE
;
241 U_CAPI
void U_EXPORT2
242 res_read(ResourceData
*pResData
,
243 const UDataInfo
*pInfo
, const void *inBytes
, int32_t length
,
244 UErrorCode
*errorCode
) {
245 UVersionInfo formatVersion
;
247 uprv_memset(pResData
, 0, sizeof(ResourceData
));
248 if(U_FAILURE(*errorCode
)) {
251 if(!isAcceptable(formatVersion
, NULL
, NULL
, pInfo
)) {
252 *errorCode
=U_INVALID_FORMAT_ERROR
;
255 res_init(pResData
, formatVersion
, inBytes
, length
, errorCode
);
259 res_load(ResourceData
*pResData
,
260 const char *path
, const char *name
, UErrorCode
*errorCode
) {
261 UVersionInfo formatVersion
;
263 uprv_memset(pResData
, 0, sizeof(ResourceData
));
265 /* load the ResourceBundle file */
266 pResData
->data
=udata_openChoice(path
, "res", name
, isAcceptable
, formatVersion
, errorCode
);
267 if(U_FAILURE(*errorCode
)) {
271 /* get its memory and initialize *pResData */
272 res_init(pResData
, formatVersion
, udata_getMemory(pResData
->data
), -1, errorCode
);
276 res_unload(ResourceData
*pResData
) {
277 if(pResData
->data
!=NULL
) {
278 udata_close(pResData
->data
);
283 static const int8_t gPublicTypes
[URES_LIMIT
] = {
289 URES_TABLE
, /* URES_TABLE32 */
290 URES_TABLE
, /* URES_TABLE16 */
291 URES_STRING
, /* URES_STRING_V2 */
295 URES_ARRAY
, /* URES_ARRAY16 */
305 U_CAPI UResType U_EXPORT2
306 res_getPublicType(Resource res
) {
307 return (UResType
)gPublicTypes
[RES_GET_TYPE(res
)];
310 U_CAPI
const UChar
* U_EXPORT2
311 res_getStringNoTrace(const ResourceData
*pResData
, Resource res
, int32_t *pLength
) {
313 uint32_t offset
=RES_GET_OFFSET(res
);
315 if(RES_GET_TYPE(res
)==URES_STRING_V2
) {
317 if((int32_t)offset
<pResData
->poolStringIndexLimit
) {
318 p
=(const UChar
*)pResData
->poolBundleStrings
+offset
;
320 p
=(const UChar
*)pResData
->p16BitUnits
+(offset
-pResData
->poolStringIndexLimit
);
323 if(!U16_IS_TRAIL(first
)) {
325 } else if(first
<0xdfef) {
328 } else if(first
<0xdfff) {
329 length
=((first
-0xdfef)<<16)|p
[1];
332 length
=((int32_t)p
[1]<<16)|p
[2];
335 } else if(res
==offset
) /* RES_GET_TYPE(res)==URES_STRING */ {
336 const int32_t *p32
= res
==0 ? &gEmptyString
.length
: pResData
->pRoot
+res
;
338 p
=(const UChar
*)p32
;
352 * CLDR string value (three empty-set symbols)=={2205, 2205, 2205}
353 * prevents fallback to the parent bundle.
354 * TODO: combine with other code that handles this marker, use EMPTY_SET constant.
355 * TODO: maybe move to uresbund.cpp?
357 UBool
isNoInheritanceMarker(const ResourceData
*pResData
, Resource res
) {
358 uint32_t offset
=RES_GET_OFFSET(res
);
361 } else if (res
== offset
) {
362 const int32_t *p32
=pResData
->pRoot
+res
;
364 const UChar
*p
=(const UChar
*)p32
;
365 return length
== 3 && p
[2] == 0x2205 && p
[3] == 0x2205 && p
[4] == 0x2205;
366 } else if (RES_GET_TYPE(res
) == URES_STRING_V2
) {
368 if((int32_t)offset
<pResData
->poolStringIndexLimit
) {
369 p
=(const UChar
*)pResData
->poolBundleStrings
+offset
;
371 p
=(const UChar
*)pResData
->p16BitUnits
+(offset
-pResData
->poolStringIndexLimit
);
374 if (first
== 0x2205) { // implicit length
375 return p
[1] == 0x2205 && p
[2] == 0x2205 && p
[3] == 0;
376 } else if (first
== 0xdc03) { // explicit length 3 (should not occur)
377 return p
[1] == 0x2205 && p
[2] == 0x2205 && p
[3] == 0x2205;
379 // Assume that the string has not been stored with more length units than necessary.
386 int32_t getStringArray(const ResourceData
*pResData
, const icu::ResourceArray
&array
,
387 icu::UnicodeString
*dest
, int32_t capacity
,
388 UErrorCode
&errorCode
) {
389 if(U_FAILURE(errorCode
)) {
392 if(dest
== NULL
? capacity
!= 0 : capacity
< 0) {
393 errorCode
= U_ILLEGAL_ARGUMENT_ERROR
;
396 int32_t length
= array
.getSize();
400 if(length
> capacity
) {
401 errorCode
= U_BUFFER_OVERFLOW_ERROR
;
404 for(int32_t i
= 0; i
< length
; ++i
) {
406 // No tracing: handled by the caller
407 const UChar
*s
= res_getStringNoTrace(pResData
, array
.internalGetResource(pResData
, i
), &sLength
);
409 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
412 dest
[i
].setTo(TRUE
, s
, sLength
);
419 U_CAPI
const UChar
* U_EXPORT2
420 res_getAlias(const ResourceData
*pResData
, Resource res
, int32_t *pLength
) {
422 uint32_t offset
=RES_GET_OFFSET(res
);
424 if(RES_GET_TYPE(res
)==URES_ALIAS
) {
425 const int32_t *p32
= offset
==0 ? &gEmptyString
.length
: pResData
->pRoot
+offset
;
427 p
=(const UChar
*)p32
;
438 U_CAPI
const uint8_t * U_EXPORT2
439 res_getBinaryNoTrace(const ResourceData
*pResData
, Resource res
, int32_t *pLength
) {
441 uint32_t offset
=RES_GET_OFFSET(res
);
443 if(RES_GET_TYPE(res
)==URES_BINARY
) {
444 const int32_t *p32
= offset
==0 ? (const int32_t*)&gEmpty32
: pResData
->pRoot
+offset
;
446 p
=(const uint8_t *)p32
;
458 U_CAPI
const int32_t * U_EXPORT2
459 res_getIntVectorNoTrace(const ResourceData
*pResData
, Resource res
, int32_t *pLength
) {
461 uint32_t offset
=RES_GET_OFFSET(res
);
463 if(RES_GET_TYPE(res
)==URES_INT_VECTOR
) {
464 p
= offset
==0 ? (const int32_t *)&gEmpty32
: pResData
->pRoot
+offset
;
476 U_CAPI
int32_t U_EXPORT2
477 res_countArrayItems(const ResourceData
*pResData
, Resource res
) {
478 uint32_t offset
=RES_GET_OFFSET(res
);
479 switch(RES_GET_TYPE(res
)) {
485 case URES_INT_VECTOR
:
489 return offset
==0 ? 0 : *(pResData
->pRoot
+offset
);
491 return offset
==0 ? 0 : *((const uint16_t *)(pResData
->pRoot
+offset
));
494 return pResData
->p16BitUnits
[offset
];
502 ResourceDataValue::~ResourceDataValue() {}
504 UResType
ResourceDataValue::getType() const {
505 return res_getPublicType(res
);
508 const UChar
*ResourceDataValue::getString(int32_t &length
, UErrorCode
&errorCode
) const {
509 if(U_FAILURE(errorCode
)) {
512 const UChar
*s
= res_getString(fTraceInfo
, &getData(), res
, &length
);
514 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
519 const UChar
*ResourceDataValue::getAliasString(int32_t &length
, UErrorCode
&errorCode
) const {
520 if(U_FAILURE(errorCode
)) {
523 const UChar
*s
= res_getAlias(&getData(), res
, &length
);
525 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
530 int32_t ResourceDataValue::getInt(UErrorCode
&errorCode
) const {
531 if(U_FAILURE(errorCode
)) {
534 if(RES_GET_TYPE(res
) != URES_INT
) {
535 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
537 return res_getInt(fTraceInfo
, res
);
540 uint32_t ResourceDataValue::getUInt(UErrorCode
&errorCode
) const {
541 if(U_FAILURE(errorCode
)) {
544 if(RES_GET_TYPE(res
) != URES_INT
) {
545 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
547 return res_getUInt(fTraceInfo
, res
);
550 const int32_t *ResourceDataValue::getIntVector(int32_t &length
, UErrorCode
&errorCode
) const {
551 if(U_FAILURE(errorCode
)) {
554 const int32_t *iv
= res_getIntVector(fTraceInfo
, &getData(), res
, &length
);
556 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
561 const uint8_t *ResourceDataValue::getBinary(int32_t &length
, UErrorCode
&errorCode
) const {
562 if(U_FAILURE(errorCode
)) {
565 const uint8_t *b
= res_getBinary(fTraceInfo
, &getData(), res
, &length
);
567 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
572 ResourceArray
ResourceDataValue::getArray(UErrorCode
&errorCode
) const {
573 if(U_FAILURE(errorCode
)) {
574 return ResourceArray();
576 const uint16_t *items16
= NULL
;
577 const Resource
*items32
= NULL
;
578 uint32_t offset
=RES_GET_OFFSET(res
);
580 switch(RES_GET_TYPE(res
)) {
582 if (offset
!=0) { // empty if offset==0
583 items32
= (const Resource
*)getData().pRoot
+offset
;
588 items16
= getData().p16BitUnits
+offset
;
592 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
593 return ResourceArray();
595 return ResourceArray(items16
, items32
, length
, fTraceInfo
);
598 ResourceTable
ResourceDataValue::getTable(UErrorCode
&errorCode
) const {
599 if(U_FAILURE(errorCode
)) {
600 return ResourceTable();
602 const uint16_t *keys16
= NULL
;
603 const int32_t *keys32
= NULL
;
604 const uint16_t *items16
= NULL
;
605 const Resource
*items32
= NULL
;
606 uint32_t offset
= RES_GET_OFFSET(res
);
608 switch(RES_GET_TYPE(res
)) {
610 if (offset
!= 0) { // empty if offset==0
611 keys16
= (const uint16_t *)(getData().pRoot
+offset
);
613 items32
= (const Resource
*)(keys16
+length
+(~length
&1));
617 keys16
= getData().p16BitUnits
+offset
;
619 items16
= keys16
+ length
;
622 if (offset
!= 0) { // empty if offset==0
623 keys32
= getData().pRoot
+offset
;
625 items32
= (const Resource
*)keys32
+ length
;
629 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
630 return ResourceTable();
632 return ResourceTable(keys16
, keys32
, items16
, items32
, length
, fTraceInfo
);
635 UBool
ResourceDataValue::isNoInheritanceMarker() const {
636 return ::isNoInheritanceMarker(&getData(), res
);
639 int32_t ResourceDataValue::getStringArray(UnicodeString
*dest
, int32_t capacity
,
640 UErrorCode
&errorCode
) const {
641 return ::getStringArray(&getData(), getArray(errorCode
), dest
, capacity
, errorCode
);
644 int32_t ResourceDataValue::getStringArrayOrStringAsArray(UnicodeString
*dest
, int32_t capacity
,
645 UErrorCode
&errorCode
) const {
646 if(URES_IS_ARRAY(res
)) {
647 return ::getStringArray(&getData(), getArray(errorCode
), dest
, capacity
, errorCode
);
649 if(U_FAILURE(errorCode
)) {
652 if(dest
== NULL
? capacity
!= 0 : capacity
< 0) {
653 errorCode
= U_ILLEGAL_ARGUMENT_ERROR
;
657 errorCode
= U_BUFFER_OVERFLOW_ERROR
;
661 const UChar
*s
= res_getString(fTraceInfo
, &getData(), res
, &sLength
);
663 dest
[0].setTo(TRUE
, s
, sLength
);
666 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
670 UnicodeString
ResourceDataValue::getStringOrFirstOfArray(UErrorCode
&errorCode
) const {
672 if(U_FAILURE(errorCode
)) {
676 const UChar
*s
= res_getString(fTraceInfo
, &getData(), res
, &sLength
);
678 us
.setTo(TRUE
, s
, sLength
);
681 ResourceArray array
= getArray(errorCode
);
682 if(U_FAILURE(errorCode
)) {
685 if(array
.getSize() > 0) {
686 // Tracing is already performed above (unimportant for trace that this is an array)
687 s
= res_getStringNoTrace(&getData(), array
.internalGetResource(&getData(), 0), &sLength
);
689 us
.setTo(TRUE
, s
, sLength
);
693 errorCode
= U_RESOURCE_TYPE_MISMATCH
;
700 makeResourceFrom16(const ResourceData
*pResData
, int32_t res16
) {
701 if(res16
<pResData
->poolStringIndex16Limit
) {
702 // Pool string, nothing to do.
704 // Local string, adjust the 16-bit offset to a regular one,
705 // with a larger pool string index limit.
706 res16
=res16
-pResData
->poolStringIndex16Limit
+pResData
->poolStringIndexLimit
;
708 return URES_MAKE_RESOURCE(URES_STRING_V2
, res16
);
711 U_CAPI Resource U_EXPORT2
712 res_getTableItemByKey(const ResourceData
*pResData
, Resource table
,
713 int32_t *indexR
, const char **key
) {
714 uint32_t offset
=RES_GET_OFFSET(table
);
717 if(key
== NULL
|| *key
== NULL
) {
720 switch(RES_GET_TYPE(table
)) {
722 if (offset
!=0) { /* empty if offset==0 */
723 const uint16_t *p
= (const uint16_t *)(pResData
->pRoot
+offset
);
725 *indexR
=idx
=_res_findTableItem(pResData
, p
, length
, *key
, key
);
727 const Resource
*p32
=(const Resource
*)(p
+length
+(~length
&1));
734 const uint16_t *p
=pResData
->p16BitUnits
+offset
;
736 *indexR
=idx
=_res_findTableItem(pResData
, p
, length
, *key
, key
);
738 return makeResourceFrom16(pResData
, p
[length
+idx
]);
743 if (offset
!=0) { /* empty if offset==0 */
744 const int32_t *p
= pResData
->pRoot
+offset
;
746 *indexR
=idx
=_res_findTable32Item(pResData
, p
, length
, *key
, key
);
748 return (Resource
)p
[length
+idx
];
759 U_CAPI Resource U_EXPORT2
760 res_getTableItemByIndex(const ResourceData
*pResData
, Resource table
,
761 int32_t indexR
, const char **key
) {
762 uint32_t offset
=RES_GET_OFFSET(table
);
767 switch(RES_GET_TYPE(table
)) {
769 if (offset
!= 0) { /* empty if offset==0 */
770 const uint16_t *p
= (const uint16_t *)(pResData
->pRoot
+offset
);
773 const Resource
*p32
=(const Resource
*)(p
+length
+(~length
&1));
775 *key
=RES_GET_KEY16(pResData
, p
[indexR
]);
783 const uint16_t *p
=pResData
->p16BitUnits
+offset
;
787 *key
=RES_GET_KEY16(pResData
, p
[indexR
]);
789 return makeResourceFrom16(pResData
, p
[length
+indexR
]);
794 if (offset
!= 0) { /* empty if offset==0 */
795 const int32_t *p
= pResData
->pRoot
+offset
;
799 *key
=RES_GET_KEY32(pResData
, p
[indexR
]);
801 return (Resource
)p
[length
+indexR
];
812 U_CAPI Resource U_EXPORT2
813 res_getResource(const ResourceData
*pResData
, const char *key
) {
814 const char *realKey
=key
;
816 return res_getTableItemByKey(pResData
, pResData
->rootRes
, &idx
, &realKey
);
820 UBool
icu::ResourceTable::getKeyAndValue(int32_t i
,
821 const char *&key
, icu::ResourceValue
&value
) const {
822 if(0 <= i
&& i
< length
) {
823 icu::ResourceDataValue
&rdValue
= static_cast<icu::ResourceDataValue
&>(value
);
824 if (keys16
!= nullptr) {
825 key
= RES_GET_KEY16(&rdValue
.getData(), keys16
[i
]);
827 key
= RES_GET_KEY32(&rdValue
.getData(), keys32
[i
]);
830 if (items16
!= nullptr) {
831 res
= makeResourceFrom16(&rdValue
.getData(), items16
[i
]);
835 // Note: the ResourceTracer keeps a reference to the field of this
836 // ResourceTable. This is OK because the ResourceTable should remain
837 // alive for the duration that fields are being read from it
838 // (including nested fields).
839 rdValue
.setResource(res
, ResourceTracer(fTraceInfo
, key
));
845 UBool
icu::ResourceTable::findValue(const char *key
, ResourceValue
&value
) const {
846 icu::ResourceDataValue
&rdValue
= static_cast<icu::ResourceDataValue
&>(value
);
847 const char *realKey
= nullptr;
849 if (keys16
!= nullptr) {
850 i
= _res_findTableItem(&rdValue
.getData(), keys16
, length
, key
, &realKey
);
852 i
= _res_findTable32Item(&rdValue
.getData(), keys32
, length
, key
, &realKey
);
856 if (items16
!= nullptr) {
857 res
= makeResourceFrom16(&rdValue
.getData(), items16
[i
]);
861 // Same note about lifetime as in getKeyAndValue().
862 rdValue
.setResource(res
, ResourceTracer(fTraceInfo
, key
));
868 U_CAPI Resource U_EXPORT2
869 res_getArrayItem(const ResourceData
*pResData
, Resource array
, int32_t indexR
) {
870 uint32_t offset
=RES_GET_OFFSET(array
);
874 switch(RES_GET_TYPE(array
)) {
876 if (offset
!=0) { /* empty if offset==0 */
877 const int32_t *p
= pResData
->pRoot
+offset
;
879 return (Resource
)p
[1+indexR
];
885 const uint16_t *p
=pResData
->p16BitUnits
+offset
;
887 return makeResourceFrom16(pResData
, p
[1+indexR
]);
897 uint32_t icu::ResourceArray::internalGetResource(const ResourceData
*pResData
, int32_t i
) const {
898 if (items16
!= NULL
) {
899 return makeResourceFrom16(pResData
, items16
[i
]);
905 UBool
icu::ResourceArray::getValue(int32_t i
, icu::ResourceValue
&value
) const {
906 if(0 <= i
&& i
< length
) {
907 icu::ResourceDataValue
&rdValue
= static_cast<icu::ResourceDataValue
&>(value
);
908 // Note: the ResourceTracer keeps a reference to the field of this
909 // ResourceArray. This is OK because the ResourceArray should remain
910 // alive for the duration that fields are being read from it
911 // (including nested fields).
913 internalGetResource(&rdValue
.getData(), i
),
914 ResourceTracer(fTraceInfo
, i
));
921 res_findResource(const ResourceData
*pResData
, Resource r
, char** path
, const char** key
) {
922 char *pathP
= *path
, *nextSepP
= *path
;
923 char *closeIndex
= NULL
;
927 UResType type
= (UResType
)RES_GET_TYPE(t1
);
929 /* if you come in with an empty path, you'll be getting back the same resource */
930 if(!uprv_strlen(pathP
)) {
934 /* one needs to have an aggregate resource in order to search in it */
935 if(!URES_IS_CONTAINER(type
)) {
939 while(nextSepP
&& *pathP
&& t1
!= RES_BOGUS
&& URES_IS_CONTAINER(type
)) {
940 /* Iteration stops if: the path has been consumed, we found a non-existing
941 * resource (t1 == RES_BOGUS) or we found a scalar resource (including alias)
943 nextSepP
= uprv_strchr(pathP
, RES_PATH_SEPARATOR
);
944 /* if there are more separators, terminate string
945 * and set path to the remaining part of the string
947 if(nextSepP
!= NULL
) {
948 if(nextSepP
== pathP
) {
952 *nextSepP
= 0; /* overwrite the separator with a NUL to terminate the key */
955 *path
= uprv_strchr(pathP
, 0);
958 /* if the resource is a table */
959 /* try the key based access */
960 if(URES_IS_TABLE(type
)) {
962 t2
= res_getTableItemByKey(pResData
, t1
, &indexR
, key
);
963 if(t2
== RES_BOGUS
) {
964 /* if we fail to get the resource by key, maybe we got an index */
965 indexR
= uprv_strtol(pathP
, &closeIndex
, 10);
966 if(indexR
>= 0 && *closeIndex
== 0) {
967 /* if we indeed have an index, try to get the item by index */
968 t2
= res_getTableItemByIndex(pResData
, t1
, indexR
, key
);
969 } // else t2 is already RES_BOGUS
971 } else if(URES_IS_ARRAY(type
)) {
972 indexR
= uprv_strtol(pathP
, &closeIndex
, 10);
973 if(indexR
>= 0 && *closeIndex
== 0) {
974 t2
= res_getArrayItem(pResData
, t1
, indexR
);
976 t2
= RES_BOGUS
; /* have an array, but don't have a valid index */
979 } else { /* can't do much here, except setting t2 to bogus */
983 type
= (UResType
)RES_GET_TYPE(t1
);
984 /* position pathP to next resource key/index */
991 /* resource bundle swapping ------------------------------------------------- */
994 * Need to always enumerate the entire item tree,
995 * track the lowest address of any item to use as the limit for char keys[],
996 * track the highest address of any item to return the size of the data.
998 * We should have thought of storing those in the data...
999 * It is possible to extend the data structure by putting additional values
1000 * in places that are inaccessible by ordinary enumeration of the item tree.
1001 * For example, additional integers could be stored at the beginning or
1002 * end of the key strings; this could be indicated by a minor version number,
1003 * and the data swapping would have to know about these values.
1005 * The data structure does not forbid keys to be shared, so we must swap
1006 * all keys once instead of each key when it is referenced.
1008 * These swapping functions assume that a resource bundle always has a length
1009 * that is a multiple of 4 bytes.
1010 * Currently, this is trivially true because genrb writes bundle tree leaves
1011 * physically first, before their branches, so that the root table with its
1012 * array of resource items (uint32_t values) is always last.
1015 /* definitions for table sorting ------------------------ */
1018 * row of a temporary array
1020 * gets platform-endian key string indexes and sorting indexes;
1021 * after sorting this array by keys, the actual key/value arrays are permutated
1022 * according to the sorting indexes
1024 typedef struct Row
{
1025 int32_t keyIndex
, sortIndex
;
1028 static int32_t U_CALLCONV
1029 ures_compareRows(const void *context
, const void *left
, const void *right
) {
1030 const char *keyChars
=(const char *)context
;
1031 return (int32_t)uprv_strcmp(keyChars
+((const Row
*)left
)->keyIndex
,
1032 keyChars
+((const Row
*)right
)->keyIndex
);
1035 typedef struct TempTable
{
1036 const char *keyChars
;
1040 int32_t localKeyLimit
;
1041 uint8_t majorFormatVersion
;
1045 STACK_ROW_CAPACITY
=200
1048 /* The table item key string is not locally available. */
1049 static const char *const gUnknownKey
="";
1051 /* resource table key for collation binaries: "%%CollationBin" */
1052 static const UChar gCollationBinKey
[]={
1054 0x43, 0x6f, 0x6c, 0x6c, 0x61, 0x74, 0x69, 0x6f, 0x6e,
1060 * swap one resource item
1063 ures_swapResource(const UDataSwapper
*ds
,
1064 const Resource
*inBundle
, Resource
*outBundle
,
1065 Resource res
, /* caller swaps res itself */
1067 TempTable
*pTempTable
,
1068 UErrorCode
*pErrorCode
) {
1071 int32_t offset
, count
;
1073 switch(RES_GET_TYPE(res
)) {
1075 case URES_STRING_V2
:
1078 /* integer, or points to 16-bit units, nothing to do here */
1084 /* all other types use an offset to point to their data */
1085 offset
=(int32_t)RES_GET_OFFSET(res
);
1087 /* special offset indicating an empty item */
1090 if(pTempTable
->resFlags
[offset
>>5]&((uint32_t)1<<(offset
&0x1f))) {
1091 /* we already swapped this resource item */
1094 /* mark it as swapped now */
1095 pTempTable
->resFlags
[offset
>>5]|=((uint32_t)1<<(offset
&0x1f));
1101 switch(RES_GET_TYPE(res
)) {
1103 /* physically same value layout as string, fall through */
1106 count
=udata_readInt32(ds
, (int32_t)*p
);
1108 ds
->swapArray32(ds
, p
, 4, q
, pErrorCode
);
1109 /* swap each UChar (the terminating NUL would not change) */
1110 ds
->swapArray16(ds
, p
+1, 2*count
, q
+1, pErrorCode
);
1113 count
=udata_readInt32(ds
, (int32_t)*p
);
1115 ds
->swapArray32(ds
, p
, 4, q
, pErrorCode
);
1116 /* no need to swap or copy bytes - ures_swap() copied them all */
1118 /* swap known formats */
1119 #if !UCONFIG_NO_COLLATION
1120 if( key
!=NULL
&& /* the binary is in a table */
1122 /* its table key string is "%%CollationBin" */
1123 0==ds
->compareInvChars(ds
, key
, -1,
1124 gCollationBinKey
, UPRV_LENGTHOF(gCollationBinKey
)-1) :
1125 /* its table key string is unknown but it looks like a collation binary */
1126 ucol_looksLikeCollationBinary(ds
, p
+1, count
))
1128 ucol_swap(ds
, p
+1, count
, q
+1, pErrorCode
);
1135 const uint16_t *pKey16
;
1138 const int32_t *pKey32
;
1142 int32_t i
, oldIndex
;
1144 if(RES_GET_TYPE(res
)==URES_TABLE
) {
1145 /* get table item count */
1146 pKey16
=(const uint16_t *)p
;
1147 qKey16
=(uint16_t *)q
;
1148 count
=ds
->readUInt16(*pKey16
);
1153 ds
->swapArray16(ds
, pKey16
++, 2, qKey16
++, pErrorCode
);
1155 offset
+=((1+count
)+1)/2;
1157 /* get table item count */
1158 pKey32
=(const int32_t *)p
;
1159 qKey32
=(int32_t *)q
;
1160 count
=udata_readInt32(ds
, *pKey32
);
1165 ds
->swapArray32(ds
, pKey32
++, 4, qKey32
++, pErrorCode
);
1174 p
=inBundle
+offset
; /* pointer to table resources */
1178 for(i
=0; i
<count
; ++i
) {
1179 const char *itemKey
=gUnknownKey
;
1181 int32_t keyOffset
=ds
->readUInt16(pKey16
[i
]);
1182 if(keyOffset
<pTempTable
->localKeyLimit
) {
1183 itemKey
=(const char *)outBundle
+keyOffset
;
1186 int32_t keyOffset
=udata_readInt32(ds
, pKey32
[i
]);
1188 itemKey
=(const char *)outBundle
+keyOffset
;
1191 item
=ds
->readUInt32(p
[i
]);
1192 ures_swapResource(ds
, inBundle
, outBundle
, item
, itemKey
, pTempTable
, pErrorCode
);
1193 if(U_FAILURE(*pErrorCode
)) {
1194 udata_printError(ds
, "ures_swapResource(table res=%08x)[%d].recurse(%08x) failed\n",
1200 if(pTempTable
->majorFormatVersion
>1 || ds
->inCharset
==ds
->outCharset
) {
1201 /* no need to sort, just swap the offset/value arrays */
1203 ds
->swapArray16(ds
, pKey16
, count
*2, qKey16
, pErrorCode
);
1204 ds
->swapArray32(ds
, p
, count
*4, q
, pErrorCode
);
1206 /* swap key offsets and items as one array */
1207 ds
->swapArray32(ds
, pKey32
, count
*2*4, qKey32
, pErrorCode
);
1213 * We need to sort tables by outCharset key strings because they
1214 * sort differently for different charset families.
1215 * ures_swap() already set pTempTable->keyChars appropriately.
1216 * First we set up a temporary table with the key indexes and
1217 * sorting indexes and sort that.
1218 * Then we permutate and copy/swap the actual values.
1221 for(i
=0; i
<count
; ++i
) {
1222 pTempTable
->rows
[i
].keyIndex
=ds
->readUInt16(pKey16
[i
]);
1223 pTempTable
->rows
[i
].sortIndex
=i
;
1226 for(i
=0; i
<count
; ++i
) {
1227 pTempTable
->rows
[i
].keyIndex
=udata_readInt32(ds
, pKey32
[i
]);
1228 pTempTable
->rows
[i
].sortIndex
=i
;
1231 uprv_sortArray(pTempTable
->rows
, count
, sizeof(Row
),
1232 ures_compareRows
, pTempTable
->keyChars
,
1234 if(U_FAILURE(*pErrorCode
)) {
1235 udata_printError(ds
, "ures_swapResource(table res=%08x).uprv_sortArray(%d items) failed\n",
1241 * copy/swap/permutate items
1243 * If we swap in-place, then the permutation must use another
1244 * temporary array (pTempTable->resort)
1245 * before the results are copied to the outBundle.
1251 if(pKey16
!=qKey16
) {
1254 rKey16
=(uint16_t *)pTempTable
->resort
;
1256 for(i
=0; i
<count
; ++i
) {
1257 oldIndex
=pTempTable
->rows
[i
].sortIndex
;
1258 ds
->swapArray16(ds
, pKey16
+oldIndex
, 2, rKey16
+i
, pErrorCode
);
1260 if(qKey16
!=rKey16
) {
1261 uprv_memcpy(qKey16
, rKey16
, 2*count
);
1266 if(pKey32
!=qKey32
) {
1269 rKey32
=pTempTable
->resort
;
1271 for(i
=0; i
<count
; ++i
) {
1272 oldIndex
=pTempTable
->rows
[i
].sortIndex
;
1273 ds
->swapArray32(ds
, pKey32
+oldIndex
, 4, rKey32
+i
, pErrorCode
);
1275 if(qKey32
!=rKey32
) {
1276 uprv_memcpy(qKey32
, rKey32
, 4*count
);
1288 r
=(Resource
*)pTempTable
->resort
;
1290 for(i
=0; i
<count
; ++i
) {
1291 oldIndex
=pTempTable
->rows
[i
].sortIndex
;
1292 ds
->swapArray32(ds
, p
+oldIndex
, 4, r
+i
, pErrorCode
);
1295 uprv_memcpy(q
, r
, 4*count
);
1305 count
=udata_readInt32(ds
, (int32_t)*p
);
1307 ds
->swapArray32(ds
, p
++, 4, q
++, pErrorCode
);
1310 for(i
=0; i
<count
; ++i
) {
1311 item
=ds
->readUInt32(p
[i
]);
1312 ures_swapResource(ds
, inBundle
, outBundle
, item
, NULL
, pTempTable
, pErrorCode
);
1313 if(U_FAILURE(*pErrorCode
)) {
1314 udata_printError(ds
, "ures_swapResource(array res=%08x)[%d].recurse(%08x) failed\n",
1321 ds
->swapArray32(ds
, p
, 4*count
, q
, pErrorCode
);
1324 case URES_INT_VECTOR
:
1325 count
=udata_readInt32(ds
, (int32_t)*p
);
1326 /* swap length and each integer */
1327 ds
->swapArray32(ds
, p
, 4*(1+count
), q
, pErrorCode
);
1330 /* also catches RES_BOGUS */
1331 *pErrorCode
=U_UNSUPPORTED_ERROR
;
1336 U_CAPI
int32_t U_EXPORT2
1337 ures_swap(const UDataSwapper
*ds
,
1338 const void *inData
, int32_t length
, void *outData
,
1339 UErrorCode
*pErrorCode
) {
1340 const UDataInfo
*pInfo
;
1341 const Resource
*inBundle
;
1343 int32_t headerSize
, maxTableLength
;
1345 Row rows
[STACK_ROW_CAPACITY
];
1346 int32_t resort
[STACK_ROW_CAPACITY
];
1347 TempTable tempTable
;
1349 const int32_t *inIndexes
;
1351 /* the following integers count Resource item offsets (4 bytes each), not bytes */
1352 int32_t bundleLength
, indexLength
, keysBottom
, keysTop
, resBottom
, top
;
1354 /* udata_swapDataHeader checks the arguments */
1355 headerSize
=udata_swapDataHeader(ds
, inData
, length
, outData
, pErrorCode
);
1356 if(pErrorCode
==NULL
|| U_FAILURE(*pErrorCode
)) {
1360 /* check data format and format version */
1361 pInfo
=(const UDataInfo
*)((const char *)inData
+4);
1363 pInfo
->dataFormat
[0]==0x52 && /* dataFormat="ResB" */
1364 pInfo
->dataFormat
[1]==0x65 &&
1365 pInfo
->dataFormat
[2]==0x73 &&
1366 pInfo
->dataFormat
[3]==0x42 &&
1367 /* formatVersion 1.1+ or 2.x or 3.x */
1368 ((pInfo
->formatVersion
[0]==1 && pInfo
->formatVersion
[1]>=1) ||
1369 pInfo
->formatVersion
[0]==2 || pInfo
->formatVersion
[0]==3)
1371 udata_printError(ds
, "ures_swap(): data format %02x.%02x.%02x.%02x (format version %02x.%02x) is not a resource bundle\n",
1372 pInfo
->dataFormat
[0], pInfo
->dataFormat
[1],
1373 pInfo
->dataFormat
[2], pInfo
->dataFormat
[3],
1374 pInfo
->formatVersion
[0], pInfo
->formatVersion
[1]);
1375 *pErrorCode
=U_UNSUPPORTED_ERROR
;
1378 tempTable
.majorFormatVersion
=pInfo
->formatVersion
[0];
1380 /* a resource bundle must contain at least one resource item */
1384 bundleLength
=(length
-headerSize
)/4;
1386 /* formatVersion 1.1 must have a root item and at least 5 indexes */
1387 if(bundleLength
<(1+5)) {
1388 udata_printError(ds
, "ures_swap(): too few bytes (%d after header) for a resource bundle\n",
1390 *pErrorCode
=U_INDEX_OUTOFBOUNDS_ERROR
;
1395 inBundle
=(const Resource
*)((const char *)inData
+headerSize
);
1396 rootRes
=ds
->readUInt32(*inBundle
);
1398 /* formatVersion 1.1 adds the indexes[] array */
1399 inIndexes
=(const int32_t *)(inBundle
+1);
1401 indexLength
=udata_readInt32(ds
, inIndexes
[URES_INDEX_LENGTH
])&0xff;
1402 if(indexLength
<=URES_INDEX_MAX_TABLE_LENGTH
) {
1403 udata_printError(ds
, "ures_swap(): too few indexes for a 1.1+ resource bundle\n");
1404 *pErrorCode
=U_INDEX_OUTOFBOUNDS_ERROR
;
1407 keysBottom
=1+indexLength
;
1408 keysTop
=udata_readInt32(ds
, inIndexes
[URES_INDEX_KEYS_TOP
]);
1409 if(indexLength
>URES_INDEX_16BIT_TOP
) {
1410 resBottom
=udata_readInt32(ds
, inIndexes
[URES_INDEX_16BIT_TOP
]);
1414 top
=udata_readInt32(ds
, inIndexes
[URES_INDEX_BUNDLE_TOP
]);
1415 maxTableLength
=udata_readInt32(ds
, inIndexes
[URES_INDEX_MAX_TABLE_LENGTH
]);
1417 if(0<=bundleLength
&& bundleLength
<top
) {
1418 udata_printError(ds
, "ures_swap(): resource top %d exceeds bundle length %d\n",
1420 *pErrorCode
=U_INDEX_OUTOFBOUNDS_ERROR
;
1423 if(keysTop
>(1+indexLength
)) {
1424 tempTable
.localKeyLimit
=keysTop
<<2;
1426 tempTable
.localKeyLimit
=0;
1430 Resource
*outBundle
=(Resource
*)((char *)outData
+headerSize
);
1432 /* track which resources we have already swapped */
1433 uint32_t stackResFlags
[STACK_ROW_CAPACITY
];
1434 int32_t resFlagsLength
;
1437 * We need one bit per 4 resource bundle bytes so that we can track
1438 * every possible Resource for whether we have swapped it already.
1439 * Multiple Resource words can refer to the same bundle offsets
1440 * for sharing identical values.
1441 * We could optimize this by allocating only for locations above
1442 * where Resource values are stored (above keys & strings).
1444 resFlagsLength
=(length
+31)>>5; /* number of bytes needed */
1445 resFlagsLength
=(resFlagsLength
+3)&~3; /* multiple of 4 bytes for uint32_t */
1446 if(resFlagsLength
<=(int32_t)sizeof(stackResFlags
)) {
1447 tempTable
.resFlags
=stackResFlags
;
1449 tempTable
.resFlags
=(uint32_t *)uprv_malloc(resFlagsLength
);
1450 if(tempTable
.resFlags
==NULL
) {
1451 udata_printError(ds
, "ures_swap(): unable to allocate memory for tracking resources\n");
1452 *pErrorCode
=U_MEMORY_ALLOCATION_ERROR
;
1456 uprv_memset(tempTable
.resFlags
, 0, resFlagsLength
);
1458 /* copy the bundle for binary and inaccessible data */
1459 if(inData
!=outData
) {
1460 uprv_memcpy(outBundle
, inBundle
, 4*top
);
1463 /* swap the key strings, but not the padding bytes (0xaa) after the last string and its NUL */
1464 udata_swapInvStringBlock(ds
, inBundle
+keysBottom
, 4*(keysTop
-keysBottom
),
1465 outBundle
+keysBottom
, pErrorCode
);
1466 if(U_FAILURE(*pErrorCode
)) {
1467 udata_printError(ds
, "ures_swap().udata_swapInvStringBlock(keys[%d]) failed\n", 4*(keysTop
-keysBottom
));
1471 /* swap the 16-bit units (strings, table16, array16) */
1472 if(keysTop
<resBottom
) {
1473 ds
->swapArray16(ds
, inBundle
+keysTop
, (resBottom
-keysTop
)*4, outBundle
+keysTop
, pErrorCode
);
1474 if(U_FAILURE(*pErrorCode
)) {
1475 udata_printError(ds
, "ures_swap().swapArray16(16-bit units[%d]) failed\n", 2*(resBottom
-keysTop
));
1480 /* allocate the temporary table for sorting resource tables */
1481 tempTable
.keyChars
=(const char *)outBundle
; /* sort by outCharset */
1482 if(tempTable
.majorFormatVersion
>1 || maxTableLength
<=STACK_ROW_CAPACITY
) {
1483 tempTable
.rows
=rows
;
1484 tempTable
.resort
=resort
;
1486 tempTable
.rows
=(Row
*)uprv_malloc(maxTableLength
*sizeof(Row
)+maxTableLength
*4);
1487 if(tempTable
.rows
==NULL
) {
1488 udata_printError(ds
, "ures_swap(): unable to allocate memory for sorting tables (max length: %d)\n",
1490 *pErrorCode
=U_MEMORY_ALLOCATION_ERROR
;
1491 if(tempTable
.resFlags
!=stackResFlags
) {
1492 uprv_free(tempTable
.resFlags
);
1496 tempTable
.resort
=(int32_t *)(tempTable
.rows
+maxTableLength
);
1499 /* swap the resources */
1500 ures_swapResource(ds
, inBundle
, outBundle
, rootRes
, NULL
, &tempTable
, pErrorCode
);
1501 if(U_FAILURE(*pErrorCode
)) {
1502 udata_printError(ds
, "ures_swapResource(root res=%08x) failed\n",
1506 if(tempTable
.rows
!=rows
) {
1507 uprv_free(tempTable
.rows
);
1509 if(tempTable
.resFlags
!=stackResFlags
) {
1510 uprv_free(tempTable
.resFlags
);
1513 /* swap the root resource and indexes */
1514 ds
->swapArray32(ds
, inBundle
, keysBottom
*4, outBundle
, pErrorCode
);
1517 return headerSize
+4*top
;