ResourceTypes.h revision 6022debdbcc4498736580640c6287b57872617a2
1/* 2 * Copyright (C) 2005 The Android Open Source Project 3 * 4 * Licensed under the Apache License, Version 2.0 (the "License"); 5 * you may not use this file except in compliance with the License. 6 * You may obtain a copy of the License at 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 10 * Unless required by applicable law or agreed to in writing, software 11 * distributed under the License is distributed on an "AS IS" BASIS, 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 * See the License for the specific language governing permissions and 14 * limitations under the License. 15 */ 16 17// 18// Definitions of resource data structures. 19// 20#ifndef _LIBS_UTILS_RESOURCE_TYPES_H 21#define _LIBS_UTILS_RESOURCE_TYPES_H 22 23#include <androidfw/Asset.h> 24#include <utils/ByteOrder.h> 25#include <utils/Errors.h> 26#include <utils/String16.h> 27#include <utils/Vector.h> 28#include <utils/KeyedVector.h> 29 30#include <utils/threads.h> 31 32#include <stdint.h> 33#include <sys/types.h> 34 35#include <android/configuration.h> 36 37namespace android { 38 39/** ******************************************************************** 40 * PNG Extensions 41 * 42 * New private chunks that may be placed in PNG images. 43 * 44 *********************************************************************** */ 45 46/** 47 * This chunk specifies how to split an image into segments for 48 * scaling. 49 * 50 * There are J horizontal and K vertical segments. These segments divide 51 * the image into J*K regions as follows (where J=4 and K=3): 52 * 53 * F0 S0 F1 S1 54 * +-----+----+------+-------+ 55 * S2| 0 | 1 | 2 | 3 | 56 * +-----+----+------+-------+ 57 * | | | | | 58 * | | | | | 59 * F2| 4 | 5 | 6 | 7 | 60 * | | | | | 61 * | | | | | 62 * +-----+----+------+-------+ 63 * S3| 8 | 9 | 10 | 11 | 64 * +-----+----+------+-------+ 65 * 66 * Each horizontal and vertical segment is considered to by either 67 * stretchable (marked by the Sx labels) or fixed (marked by the Fy 68 * labels), in the horizontal or vertical axis, respectively. In the 69 * above example, the first is horizontal segment (F0) is fixed, the 70 * next is stretchable and then they continue to alternate. Note that 71 * the segment list for each axis can begin or end with a stretchable 72 * or fixed segment. 73 * 74 * The relative sizes of the stretchy segments indicates the relative 75 * amount of stretchiness of the regions bordered by the segments. For 76 * example, regions 3, 7 and 11 above will take up more horizontal space 77 * than regions 1, 5 and 9 since the horizontal segment associated with 78 * the first set of regions is larger than the other set of regions. The 79 * ratios of the amount of horizontal (or vertical) space taken by any 80 * two stretchable slices is exactly the ratio of their corresponding 81 * segment lengths. 82 * 83 * xDivs and yDivs are arrays of horizontal and vertical pixel 84 * indices. The first pair of Divs (in either array) indicate the 85 * starting and ending points of the first stretchable segment in that 86 * axis. The next pair specifies the next stretchable segment, etc. So 87 * in the above example xDiv[0] and xDiv[1] specify the horizontal 88 * coordinates for the regions labeled 1, 5 and 9. xDiv[2] and 89 * xDiv[3] specify the coordinates for regions 3, 7 and 11. Note that 90 * the leftmost slices always start at x=0 and the rightmost slices 91 * always end at the end of the image. So, for example, the regions 0, 92 * 4 and 8 (which are fixed along the X axis) start at x value 0 and 93 * go to xDiv[0] and slices 2, 6 and 10 start at xDiv[1] and end at 94 * xDiv[2]. 95 * 96 * The colors array contains hints for each of the regions. They are 97 * ordered according left-to-right and top-to-bottom as indicated above. 98 * For each segment that is a solid color the array entry will contain 99 * that color value; otherwise it will contain NO_COLOR. Segments that 100 * are completely transparent will always have the value TRANSPARENT_COLOR. 101 * 102 * The PNG chunk type is "npTc". 103 */ 104struct Res_png_9patch 105{ 106 Res_png_9patch() : wasDeserialized(false), xDivsOffset(0), 107 yDivsOffset(0), colorsOffset(0) { } 108 109 int8_t wasDeserialized; 110 int8_t numXDivs; 111 int8_t numYDivs; 112 int8_t numColors; 113 114 // The offset (from the start of this structure) to the xDivs & yDivs 115 // array for this 9patch. To get a pointer to this array, call 116 // getXDivs or getYDivs. Note that the serialized form for 9patches places 117 // the xDivs, yDivs and colors arrays immediately after the location 118 // of the Res_png_9patch struct. 119 uint32_t xDivsOffset; 120 uint32_t yDivsOffset; 121 122 int32_t paddingLeft, paddingRight; 123 int32_t paddingTop, paddingBottom; 124 125 enum { 126 // The 9 patch segment is not a solid color. 127 NO_COLOR = 0x00000001, 128 129 // The 9 patch segment is completely transparent. 130 TRANSPARENT_COLOR = 0x00000000 131 }; 132 133 // The offset (from the start of this structure) to the colors array 134 // for this 9patch. 135 uint32_t colorsOffset; 136 137 // Convert data from device representation to PNG file representation. 138 void deviceToFile(); 139 // Convert data from PNG file representation to device representation. 140 void fileToDevice(); 141 142 // Serialize/Marshall the patch data into a newly malloc-ed block. 143 static void* serialize(const Res_png_9patch& patchHeader, const int32_t* xDivs, 144 const int32_t* yDivs, const uint32_t* colors); 145 // Serialize/Marshall the patch data into |outData|. 146 static void serialize(const Res_png_9patch& patchHeader, const int32_t* xDivs, 147 const int32_t* yDivs, const uint32_t* colors, void* outData); 148 // Deserialize/Unmarshall the patch data 149 static Res_png_9patch* deserialize(void* data); 150 // Compute the size of the serialized data structure 151 size_t serializedSize() const; 152 153 // These tell where the next section of a patch starts. 154 // For example, the first patch includes the pixels from 155 // 0 to xDivs[0]-1 and the second patch includes the pixels 156 // from xDivs[0] to xDivs[1]-1. 157 inline int32_t* getXDivs() const { 158 return reinterpret_cast<int32_t*>(reinterpret_cast<uintptr_t>(this) + xDivsOffset); 159 } 160 inline int32_t* getYDivs() const { 161 return reinterpret_cast<int32_t*>(reinterpret_cast<uintptr_t>(this) + yDivsOffset); 162 } 163 inline uint32_t* getColors() const { 164 return reinterpret_cast<uint32_t*>(reinterpret_cast<uintptr_t>(this) + colorsOffset); 165 } 166 167} __attribute__((packed)); 168 169/** ******************************************************************** 170 * Base Types 171 * 172 * These are standard types that are shared between multiple specific 173 * resource types. 174 * 175 *********************************************************************** */ 176 177/** 178 * Header that appears at the front of every data chunk in a resource. 179 */ 180struct ResChunk_header 181{ 182 // Type identifier for this chunk. The meaning of this value depends 183 // on the containing chunk. 184 uint16_t type; 185 186 // Size of the chunk header (in bytes). Adding this value to 187 // the address of the chunk allows you to find its associated data 188 // (if any). 189 uint16_t headerSize; 190 191 // Total size of this chunk (in bytes). This is the chunkSize plus 192 // the size of any data associated with the chunk. Adding this value 193 // to the chunk allows you to completely skip its contents (including 194 // any child chunks). If this value is the same as chunkSize, there is 195 // no data associated with the chunk. 196 uint32_t size; 197}; 198 199enum { 200 RES_NULL_TYPE = 0x0000, 201 RES_STRING_POOL_TYPE = 0x0001, 202 RES_TABLE_TYPE = 0x0002, 203 RES_XML_TYPE = 0x0003, 204 205 // Chunk types in RES_XML_TYPE 206 RES_XML_FIRST_CHUNK_TYPE = 0x0100, 207 RES_XML_START_NAMESPACE_TYPE= 0x0100, 208 RES_XML_END_NAMESPACE_TYPE = 0x0101, 209 RES_XML_START_ELEMENT_TYPE = 0x0102, 210 RES_XML_END_ELEMENT_TYPE = 0x0103, 211 RES_XML_CDATA_TYPE = 0x0104, 212 RES_XML_LAST_CHUNK_TYPE = 0x017f, 213 // This contains a uint32_t array mapping strings in the string 214 // pool back to resource identifiers. It is optional. 215 RES_XML_RESOURCE_MAP_TYPE = 0x0180, 216 217 // Chunk types in RES_TABLE_TYPE 218 RES_TABLE_PACKAGE_TYPE = 0x0200, 219 RES_TABLE_TYPE_TYPE = 0x0201, 220 RES_TABLE_TYPE_SPEC_TYPE = 0x0202, 221 RES_TABLE_LIBRARY_TYPE = 0x0203 222}; 223 224/** 225 * Macros for building/splitting resource identifiers. 226 */ 227#define Res_VALIDID(resid) (resid != 0) 228#define Res_CHECKID(resid) ((resid&0xFFFF0000) != 0) 229#define Res_MAKEID(package, type, entry) \ 230 (((package+1)<<24) | (((type+1)&0xFF)<<16) | (entry&0xFFFF)) 231#define Res_GETPACKAGE(id) ((id>>24)-1) 232#define Res_GETTYPE(id) (((id>>16)&0xFF)-1) 233#define Res_GETENTRY(id) (id&0xFFFF) 234 235#define Res_INTERNALID(resid) ((resid&0xFFFF0000) != 0 && (resid&0xFF0000) == 0) 236#define Res_MAKEINTERNAL(entry) (0x01000000 | (entry&0xFFFF)) 237#define Res_MAKEARRAY(entry) (0x02000000 | (entry&0xFFFF)) 238 239#define Res_MAXPACKAGE 255 240#define Res_MAXTYPE 255 241 242/** 243 * Representation of a value in a resource, supplying type 244 * information. 245 */ 246struct Res_value 247{ 248 // Number of bytes in this structure. 249 uint16_t size; 250 251 // Always set to 0. 252 uint8_t res0; 253 254 // Type of the data value. 255 enum { 256 // Contains no data. 257 TYPE_NULL = 0x00, 258 // The 'data' holds a ResTable_ref, a reference to another resource 259 // table entry. 260 TYPE_REFERENCE = 0x01, 261 // The 'data' holds an attribute resource identifier. 262 TYPE_ATTRIBUTE = 0x02, 263 // The 'data' holds an index into the containing resource table's 264 // global value string pool. 265 TYPE_STRING = 0x03, 266 // The 'data' holds a single-precision floating point number. 267 TYPE_FLOAT = 0x04, 268 // The 'data' holds a complex number encoding a dimension value, 269 // such as "100in". 270 TYPE_DIMENSION = 0x05, 271 // The 'data' holds a complex number encoding a fraction of a 272 // container. 273 TYPE_FRACTION = 0x06, 274 // The 'data' holds a dynamic ResTable_ref, which needs to be 275 // resolved before it can be used like a TYPE_REFERENCE. 276 TYPE_DYNAMIC_REFERENCE = 0x07, 277 278 // Beginning of integer flavors... 279 TYPE_FIRST_INT = 0x10, 280 281 // The 'data' is a raw integer value of the form n..n. 282 TYPE_INT_DEC = 0x10, 283 // The 'data' is a raw integer value of the form 0xn..n. 284 TYPE_INT_HEX = 0x11, 285 // The 'data' is either 0 or 1, for input "false" or "true" respectively. 286 TYPE_INT_BOOLEAN = 0x12, 287 288 // Beginning of color integer flavors... 289 TYPE_FIRST_COLOR_INT = 0x1c, 290 291 // The 'data' is a raw integer value of the form #aarrggbb. 292 TYPE_INT_COLOR_ARGB8 = 0x1c, 293 // The 'data' is a raw integer value of the form #rrggbb. 294 TYPE_INT_COLOR_RGB8 = 0x1d, 295 // The 'data' is a raw integer value of the form #argb. 296 TYPE_INT_COLOR_ARGB4 = 0x1e, 297 // The 'data' is a raw integer value of the form #rgb. 298 TYPE_INT_COLOR_RGB4 = 0x1f, 299 300 // ...end of integer flavors. 301 TYPE_LAST_COLOR_INT = 0x1f, 302 303 // ...end of integer flavors. 304 TYPE_LAST_INT = 0x1f 305 }; 306 uint8_t dataType; 307 308 // Structure of complex data values (TYPE_UNIT and TYPE_FRACTION) 309 enum { 310 // Where the unit type information is. This gives us 16 possible 311 // types, as defined below. 312 COMPLEX_UNIT_SHIFT = 0, 313 COMPLEX_UNIT_MASK = 0xf, 314 315 // TYPE_DIMENSION: Value is raw pixels. 316 COMPLEX_UNIT_PX = 0, 317 // TYPE_DIMENSION: Value is Device Independent Pixels. 318 COMPLEX_UNIT_DIP = 1, 319 // TYPE_DIMENSION: Value is a Scaled device independent Pixels. 320 COMPLEX_UNIT_SP = 2, 321 // TYPE_DIMENSION: Value is in points. 322 COMPLEX_UNIT_PT = 3, 323 // TYPE_DIMENSION: Value is in inches. 324 COMPLEX_UNIT_IN = 4, 325 // TYPE_DIMENSION: Value is in millimeters. 326 COMPLEX_UNIT_MM = 5, 327 328 // TYPE_FRACTION: A basic fraction of the overall size. 329 COMPLEX_UNIT_FRACTION = 0, 330 // TYPE_FRACTION: A fraction of the parent size. 331 COMPLEX_UNIT_FRACTION_PARENT = 1, 332 333 // Where the radix information is, telling where the decimal place 334 // appears in the mantissa. This give us 4 possible fixed point 335 // representations as defined below. 336 COMPLEX_RADIX_SHIFT = 4, 337 COMPLEX_RADIX_MASK = 0x3, 338 339 // The mantissa is an integral number -- i.e., 0xnnnnnn.0 340 COMPLEX_RADIX_23p0 = 0, 341 // The mantissa magnitude is 16 bits -- i.e, 0xnnnn.nn 342 COMPLEX_RADIX_16p7 = 1, 343 // The mantissa magnitude is 8 bits -- i.e, 0xnn.nnnn 344 COMPLEX_RADIX_8p15 = 2, 345 // The mantissa magnitude is 0 bits -- i.e, 0x0.nnnnnn 346 COMPLEX_RADIX_0p23 = 3, 347 348 // Where the actual value is. This gives us 23 bits of 349 // precision. The top bit is the sign. 350 COMPLEX_MANTISSA_SHIFT = 8, 351 COMPLEX_MANTISSA_MASK = 0xffffff 352 }; 353 354 // The data for this item, as interpreted according to dataType. 355 uint32_t data; 356 357 void copyFrom_dtoh(const Res_value& src); 358}; 359 360/** 361 * This is a reference to a unique entry (a ResTable_entry structure) 362 * in a resource table. The value is structured as: 0xpptteeee, 363 * where pp is the package index, tt is the type index in that 364 * package, and eeee is the entry index in that type. The package 365 * and type values start at 1 for the first item, to help catch cases 366 * where they have not been supplied. 367 */ 368struct ResTable_ref 369{ 370 uint32_t ident; 371}; 372 373/** 374 * Reference to a string in a string pool. 375 */ 376struct ResStringPool_ref 377{ 378 // Index into the string pool table (uint32_t-offset from the indices 379 // immediately after ResStringPool_header) at which to find the location 380 // of the string data in the pool. 381 uint32_t index; 382}; 383 384/** ******************************************************************** 385 * String Pool 386 * 387 * A set of strings that can be references by others through a 388 * ResStringPool_ref. 389 * 390 *********************************************************************** */ 391 392/** 393 * Definition for a pool of strings. The data of this chunk is an 394 * array of uint32_t providing indices into the pool, relative to 395 * stringsStart. At stringsStart are all of the UTF-16 strings 396 * concatenated together; each starts with a uint16_t of the string's 397 * length and each ends with a 0x0000 terminator. If a string is > 398 * 32767 characters, the high bit of the length is set meaning to take 399 * those 15 bits as a high word and it will be followed by another 400 * uint16_t containing the low word. 401 * 402 * If styleCount is not zero, then immediately following the array of 403 * uint32_t indices into the string table is another array of indices 404 * into a style table starting at stylesStart. Each entry in the 405 * style table is an array of ResStringPool_span structures. 406 */ 407struct ResStringPool_header 408{ 409 struct ResChunk_header header; 410 411 // Number of strings in this pool (number of uint32_t indices that follow 412 // in the data). 413 uint32_t stringCount; 414 415 // Number of style span arrays in the pool (number of uint32_t indices 416 // follow the string indices). 417 uint32_t styleCount; 418 419 // Flags. 420 enum { 421 // If set, the string index is sorted by the string values (based 422 // on strcmp16()). 423 SORTED_FLAG = 1<<0, 424 425 // String pool is encoded in UTF-8 426 UTF8_FLAG = 1<<8 427 }; 428 uint32_t flags; 429 430 // Index from header of the string data. 431 uint32_t stringsStart; 432 433 // Index from header of the style data. 434 uint32_t stylesStart; 435}; 436 437/** 438 * This structure defines a span of style information associated with 439 * a string in the pool. 440 */ 441struct ResStringPool_span 442{ 443 enum { 444 END = 0xFFFFFFFF 445 }; 446 447 // This is the name of the span -- that is, the name of the XML 448 // tag that defined it. The special value END (0xFFFFFFFF) indicates 449 // the end of an array of spans. 450 ResStringPool_ref name; 451 452 // The range of characters in the string that this span applies to. 453 uint32_t firstChar, lastChar; 454}; 455 456/** 457 * Convenience class for accessing data in a ResStringPool resource. 458 */ 459class ResStringPool 460{ 461public: 462 ResStringPool(); 463 ResStringPool(const void* data, size_t size, bool copyData=false); 464 ~ResStringPool(); 465 466 void setToEmpty(); 467 status_t setTo(const void* data, size_t size, bool copyData=false); 468 469 status_t getError() const; 470 471 void uninit(); 472 473 // Return string entry as UTF16; if the pool is UTF8, the string will 474 // be converted before returning. 475 inline const char16_t* stringAt(const ResStringPool_ref& ref, size_t* outLen) const { 476 return stringAt(ref.index, outLen); 477 } 478 const char16_t* stringAt(size_t idx, size_t* outLen) const; 479 480 // Note: returns null if the string pool is not UTF8. 481 const char* string8At(size_t idx, size_t* outLen) const; 482 483 // Return string whether the pool is UTF8 or UTF16. Does not allow you 484 // to distinguish null. 485 const String8 string8ObjectAt(size_t idx) const; 486 487 const ResStringPool_span* styleAt(const ResStringPool_ref& ref) const; 488 const ResStringPool_span* styleAt(size_t idx) const; 489 490 ssize_t indexOfString(const char16_t* str, size_t strLen) const; 491 492 size_t size() const; 493 size_t styleCount() const; 494 size_t bytes() const; 495 496 bool isSorted() const; 497 bool isUTF8() const; 498 499private: 500 status_t mError; 501 void* mOwnedData; 502 const ResStringPool_header* mHeader; 503 size_t mSize; 504 mutable Mutex mDecodeLock; 505 const uint32_t* mEntries; 506 const uint32_t* mEntryStyles; 507 const void* mStrings; 508 char16_t mutable** mCache; 509 uint32_t mStringPoolSize; // number of uint16_t 510 const uint32_t* mStyles; 511 uint32_t mStylePoolSize; // number of uint32_t 512}; 513 514/** 515 * Wrapper class that allows the caller to retrieve a string from 516 * a string pool without knowing which string pool to look. 517 */ 518class StringPoolRef { 519public: 520 StringPoolRef(); 521 StringPoolRef(const ResStringPool* pool, uint32_t index); 522 523 const char* string8(size_t* outLen) const; 524 const char16_t* string16(size_t* outLen) const; 525 526private: 527 const ResStringPool* mPool; 528 uint32_t mIndex; 529}; 530 531/** ******************************************************************** 532 * XML Tree 533 * 534 * Binary representation of an XML document. This is designed to 535 * express everything in an XML document, in a form that is much 536 * easier to parse on the device. 537 * 538 *********************************************************************** */ 539 540/** 541 * XML tree header. This appears at the front of an XML tree, 542 * describing its content. It is followed by a flat array of 543 * ResXMLTree_node structures; the hierarchy of the XML document 544 * is described by the occurrance of RES_XML_START_ELEMENT_TYPE 545 * and corresponding RES_XML_END_ELEMENT_TYPE nodes in the array. 546 */ 547struct ResXMLTree_header 548{ 549 struct ResChunk_header header; 550}; 551 552/** 553 * Basic XML tree node. A single item in the XML document. Extended info 554 * about the node can be found after header.headerSize. 555 */ 556struct ResXMLTree_node 557{ 558 struct ResChunk_header header; 559 560 // Line number in original source file at which this element appeared. 561 uint32_t lineNumber; 562 563 // Optional XML comment that was associated with this element; -1 if none. 564 struct ResStringPool_ref comment; 565}; 566 567/** 568 * Extended XML tree node for CDATA tags -- includes the CDATA string. 569 * Appears header.headerSize bytes after a ResXMLTree_node. 570 */ 571struct ResXMLTree_cdataExt 572{ 573 // The raw CDATA character data. 574 struct ResStringPool_ref data; 575 576 // The typed value of the character data if this is a CDATA node. 577 struct Res_value typedData; 578}; 579 580/** 581 * Extended XML tree node for namespace start/end nodes. 582 * Appears header.headerSize bytes after a ResXMLTree_node. 583 */ 584struct ResXMLTree_namespaceExt 585{ 586 // The prefix of the namespace. 587 struct ResStringPool_ref prefix; 588 589 // The URI of the namespace. 590 struct ResStringPool_ref uri; 591}; 592 593/** 594 * Extended XML tree node for element start/end nodes. 595 * Appears header.headerSize bytes after a ResXMLTree_node. 596 */ 597struct ResXMLTree_endElementExt 598{ 599 // String of the full namespace of this element. 600 struct ResStringPool_ref ns; 601 602 // String name of this node if it is an ELEMENT; the raw 603 // character data if this is a CDATA node. 604 struct ResStringPool_ref name; 605}; 606 607/** 608 * Extended XML tree node for start tags -- includes attribute 609 * information. 610 * Appears header.headerSize bytes after a ResXMLTree_node. 611 */ 612struct ResXMLTree_attrExt 613{ 614 // String of the full namespace of this element. 615 struct ResStringPool_ref ns; 616 617 // String name of this node if it is an ELEMENT; the raw 618 // character data if this is a CDATA node. 619 struct ResStringPool_ref name; 620 621 // Byte offset from the start of this structure where the attributes start. 622 uint16_t attributeStart; 623 624 // Size of the ResXMLTree_attribute structures that follow. 625 uint16_t attributeSize; 626 627 // Number of attributes associated with an ELEMENT. These are 628 // available as an array of ResXMLTree_attribute structures 629 // immediately following this node. 630 uint16_t attributeCount; 631 632 // Index (1-based) of the "id" attribute. 0 if none. 633 uint16_t idIndex; 634 635 // Index (1-based) of the "class" attribute. 0 if none. 636 uint16_t classIndex; 637 638 // Index (1-based) of the "style" attribute. 0 if none. 639 uint16_t styleIndex; 640}; 641 642struct ResXMLTree_attribute 643{ 644 // Namespace of this attribute. 645 struct ResStringPool_ref ns; 646 647 // Name of this attribute. 648 struct ResStringPool_ref name; 649 650 // The original raw string value of this attribute. 651 struct ResStringPool_ref rawValue; 652 653 // Processesd typed value of this attribute. 654 struct Res_value typedValue; 655}; 656 657class ResXMLTree; 658 659class ResXMLParser 660{ 661public: 662 ResXMLParser(const ResXMLTree& tree); 663 664 enum event_code_t { 665 BAD_DOCUMENT = -1, 666 START_DOCUMENT = 0, 667 END_DOCUMENT = 1, 668 669 FIRST_CHUNK_CODE = RES_XML_FIRST_CHUNK_TYPE, 670 671 START_NAMESPACE = RES_XML_START_NAMESPACE_TYPE, 672 END_NAMESPACE = RES_XML_END_NAMESPACE_TYPE, 673 START_TAG = RES_XML_START_ELEMENT_TYPE, 674 END_TAG = RES_XML_END_ELEMENT_TYPE, 675 TEXT = RES_XML_CDATA_TYPE 676 }; 677 678 struct ResXMLPosition 679 { 680 event_code_t eventCode; 681 const ResXMLTree_node* curNode; 682 const void* curExt; 683 }; 684 685 void restart(); 686 687 const ResStringPool& getStrings() const; 688 689 event_code_t getEventType() const; 690 // Note, unlike XmlPullParser, the first call to next() will return 691 // START_TAG of the first element. 692 event_code_t next(); 693 694 // These are available for all nodes: 695 int32_t getCommentID() const; 696 const uint16_t* getComment(size_t* outLen) const; 697 uint32_t getLineNumber() const; 698 699 // This is available for TEXT: 700 int32_t getTextID() const; 701 const uint16_t* getText(size_t* outLen) const; 702 ssize_t getTextValue(Res_value* outValue) const; 703 704 // These are available for START_NAMESPACE and END_NAMESPACE: 705 int32_t getNamespacePrefixID() const; 706 const uint16_t* getNamespacePrefix(size_t* outLen) const; 707 int32_t getNamespaceUriID() const; 708 const uint16_t* getNamespaceUri(size_t* outLen) const; 709 710 // These are available for START_TAG and END_TAG: 711 int32_t getElementNamespaceID() const; 712 const uint16_t* getElementNamespace(size_t* outLen) const; 713 int32_t getElementNameID() const; 714 const uint16_t* getElementName(size_t* outLen) const; 715 716 // Remaining methods are for retrieving information about attributes 717 // associated with a START_TAG: 718 719 size_t getAttributeCount() const; 720 721 // Returns -1 if no namespace, -2 if idx out of range. 722 int32_t getAttributeNamespaceID(size_t idx) const; 723 const uint16_t* getAttributeNamespace(size_t idx, size_t* outLen) const; 724 725 int32_t getAttributeNameID(size_t idx) const; 726 const uint16_t* getAttributeName(size_t idx, size_t* outLen) const; 727 uint32_t getAttributeNameResID(size_t idx) const; 728 729 // These will work only if the underlying string pool is UTF-8. 730 const char* getAttributeNamespace8(size_t idx, size_t* outLen) const; 731 const char* getAttributeName8(size_t idx, size_t* outLen) const; 732 733 int32_t getAttributeValueStringID(size_t idx) const; 734 const uint16_t* getAttributeStringValue(size_t idx, size_t* outLen) const; 735 736 int32_t getAttributeDataType(size_t idx) const; 737 int32_t getAttributeData(size_t idx) const; 738 ssize_t getAttributeValue(size_t idx, Res_value* outValue) const; 739 740 ssize_t indexOfAttribute(const char* ns, const char* attr) const; 741 ssize_t indexOfAttribute(const char16_t* ns, size_t nsLen, 742 const char16_t* attr, size_t attrLen) const; 743 744 ssize_t indexOfID() const; 745 ssize_t indexOfClass() const; 746 ssize_t indexOfStyle() const; 747 748 void getPosition(ResXMLPosition* pos) const; 749 void setPosition(const ResXMLPosition& pos); 750 751private: 752 friend class ResXMLTree; 753 754 event_code_t nextNode(); 755 756 const ResXMLTree& mTree; 757 event_code_t mEventCode; 758 const ResXMLTree_node* mCurNode; 759 const void* mCurExt; 760}; 761 762class DynamicRefTable; 763 764/** 765 * Convenience class for accessing data in a ResXMLTree resource. 766 */ 767class ResXMLTree : public ResXMLParser 768{ 769public: 770 ResXMLTree(const DynamicRefTable* dynamicRefTable); 771 ResXMLTree(); 772 ~ResXMLTree(); 773 774 status_t setTo(const void* data, size_t size, bool copyData=false); 775 776 status_t getError() const; 777 778 void uninit(); 779 780private: 781 friend class ResXMLParser; 782 783 status_t validateNode(const ResXMLTree_node* node) const; 784 785 const DynamicRefTable* const mDynamicRefTable; 786 787 status_t mError; 788 void* mOwnedData; 789 const ResXMLTree_header* mHeader; 790 size_t mSize; 791 const uint8_t* mDataEnd; 792 ResStringPool mStrings; 793 const uint32_t* mResIds; 794 size_t mNumResIds; 795 const ResXMLTree_node* mRootNode; 796 const void* mRootExt; 797 event_code_t mRootCode; 798}; 799 800/** ******************************************************************** 801 * RESOURCE TABLE 802 * 803 *********************************************************************** */ 804 805/** 806 * Header for a resource table. Its data contains a series of 807 * additional chunks: 808 * * A ResStringPool_header containing all table values. This string pool 809 * contains all of the string values in the entire resource table (not 810 * the names of entries or type identifiers however). 811 * * One or more ResTable_package chunks. 812 * 813 * Specific entries within a resource table can be uniquely identified 814 * with a single integer as defined by the ResTable_ref structure. 815 */ 816struct ResTable_header 817{ 818 struct ResChunk_header header; 819 820 // The number of ResTable_package structures. 821 uint32_t packageCount; 822}; 823 824/** 825 * A collection of resource data types within a package. Followed by 826 * one or more ResTable_type and ResTable_typeSpec structures containing the 827 * entry values for each resource type. 828 */ 829struct ResTable_package 830{ 831 struct ResChunk_header header; 832 833 // If this is a base package, its ID. Package IDs start 834 // at 1 (corresponding to the value of the package bits in a 835 // resource identifier). 0 means this is not a base package. 836 uint32_t id; 837 838 // Actual name of this package, \0-terminated. 839 char16_t name[128]; 840 841 // Offset to a ResStringPool_header defining the resource 842 // type symbol table. If zero, this package is inheriting from 843 // another base package (overriding specific values in it). 844 uint32_t typeStrings; 845 846 // Last index into typeStrings that is for public use by others. 847 uint32_t lastPublicType; 848 849 // Offset to a ResStringPool_header defining the resource 850 // key symbol table. If zero, this package is inheriting from 851 // another base package (overriding specific values in it). 852 uint32_t keyStrings; 853 854 // Last index into keyStrings that is for public use by others. 855 uint32_t lastPublicKey; 856 857 uint32_t typeIdOffset; 858}; 859 860// The most specific locale can consist of: 861// 862// - a 3 char language code 863// - a 3 char region code prefixed by a 'r' 864// - a 4 char script code prefixed by a 's' 865// - a 8 char variant code prefixed by a 'v' 866// 867// each separated by a single char separator, which sums up to a total of 24 868// chars, (25 include the string terminator) rounded up to 28 to be 4 byte 869// aligned. 870#define RESTABLE_MAX_LOCALE_LEN 28 871 872 873/** 874 * Describes a particular resource configuration. 875 */ 876struct ResTable_config 877{ 878 // Number of bytes in this structure. 879 uint32_t size; 880 881 union { 882 struct { 883 // Mobile country code (from SIM). 0 means "any". 884 uint16_t mcc; 885 // Mobile network code (from SIM). 0 means "any". 886 uint16_t mnc; 887 }; 888 uint32_t imsi; 889 }; 890 891 union { 892 struct { 893 // This field can take three different forms: 894 // - \0\0 means "any". 895 // 896 // - Two 7 bit ascii values interpreted as ISO-639-1 language 897 // codes ('fr', 'en' etc. etc.). The high bit for both bytes is 898 // zero. 899 // 900 // - A single 16 bit little endian packed value representing an 901 // ISO-639-2 3 letter language code. This will be of the form: 902 // 903 // {1, t, t, t, t, t, s, s, s, s, s, f, f, f, f, f} 904 // 905 // bit[0, 4] = first letter of the language code 906 // bit[5, 9] = second letter of the language code 907 // bit[10, 14] = third letter of the language code. 908 // bit[15] = 1 always 909 // 910 // For backwards compatibility, languages that have unambiguous 911 // two letter codes are represented in that format. 912 // 913 // The layout is always bigendian irrespective of the runtime 914 // architecture. 915 char language[2]; 916 917 // This field can take three different forms: 918 // - \0\0 means "any". 919 // 920 // - Two 7 bit ascii values interpreted as 2 letter region 921 // codes ('US', 'GB' etc.). The high bit for both bytes is zero. 922 // 923 // - An UN M.49 3 digit region code. For simplicity, these are packed 924 // in the same manner as the language codes, though we should need 925 // only 10 bits to represent them, instead of the 15. 926 // 927 // The layout is always bigendian irrespective of the runtime 928 // architecture. 929 char country[2]; 930 }; 931 uint32_t locale; 932 }; 933 934 enum { 935 ORIENTATION_ANY = ACONFIGURATION_ORIENTATION_ANY, 936 ORIENTATION_PORT = ACONFIGURATION_ORIENTATION_PORT, 937 ORIENTATION_LAND = ACONFIGURATION_ORIENTATION_LAND, 938 ORIENTATION_SQUARE = ACONFIGURATION_ORIENTATION_SQUARE, 939 }; 940 941 enum { 942 TOUCHSCREEN_ANY = ACONFIGURATION_TOUCHSCREEN_ANY, 943 TOUCHSCREEN_NOTOUCH = ACONFIGURATION_TOUCHSCREEN_NOTOUCH, 944 TOUCHSCREEN_STYLUS = ACONFIGURATION_TOUCHSCREEN_STYLUS, 945 TOUCHSCREEN_FINGER = ACONFIGURATION_TOUCHSCREEN_FINGER, 946 }; 947 948 enum { 949 DENSITY_DEFAULT = ACONFIGURATION_DENSITY_DEFAULT, 950 DENSITY_LOW = ACONFIGURATION_DENSITY_LOW, 951 DENSITY_MEDIUM = ACONFIGURATION_DENSITY_MEDIUM, 952 DENSITY_TV = ACONFIGURATION_DENSITY_TV, 953 DENSITY_HIGH = ACONFIGURATION_DENSITY_HIGH, 954 DENSITY_XHIGH = ACONFIGURATION_DENSITY_XHIGH, 955 DENSITY_XXHIGH = ACONFIGURATION_DENSITY_XXHIGH, 956 DENSITY_XXXHIGH = ACONFIGURATION_DENSITY_XXXHIGH, 957 DENSITY_NONE = ACONFIGURATION_DENSITY_NONE 958 }; 959 960 union { 961 struct { 962 uint8_t orientation; 963 uint8_t touchscreen; 964 uint16_t density; 965 }; 966 uint32_t screenType; 967 }; 968 969 enum { 970 KEYBOARD_ANY = ACONFIGURATION_KEYBOARD_ANY, 971 KEYBOARD_NOKEYS = ACONFIGURATION_KEYBOARD_NOKEYS, 972 KEYBOARD_QWERTY = ACONFIGURATION_KEYBOARD_QWERTY, 973 KEYBOARD_12KEY = ACONFIGURATION_KEYBOARD_12KEY, 974 }; 975 976 enum { 977 NAVIGATION_ANY = ACONFIGURATION_NAVIGATION_ANY, 978 NAVIGATION_NONAV = ACONFIGURATION_NAVIGATION_NONAV, 979 NAVIGATION_DPAD = ACONFIGURATION_NAVIGATION_DPAD, 980 NAVIGATION_TRACKBALL = ACONFIGURATION_NAVIGATION_TRACKBALL, 981 NAVIGATION_WHEEL = ACONFIGURATION_NAVIGATION_WHEEL, 982 }; 983 984 enum { 985 MASK_KEYSHIDDEN = 0x0003, 986 KEYSHIDDEN_ANY = ACONFIGURATION_KEYSHIDDEN_ANY, 987 KEYSHIDDEN_NO = ACONFIGURATION_KEYSHIDDEN_NO, 988 KEYSHIDDEN_YES = ACONFIGURATION_KEYSHIDDEN_YES, 989 KEYSHIDDEN_SOFT = ACONFIGURATION_KEYSHIDDEN_SOFT, 990 }; 991 992 enum { 993 MASK_NAVHIDDEN = 0x000c, 994 SHIFT_NAVHIDDEN = 2, 995 NAVHIDDEN_ANY = ACONFIGURATION_NAVHIDDEN_ANY << SHIFT_NAVHIDDEN, 996 NAVHIDDEN_NO = ACONFIGURATION_NAVHIDDEN_NO << SHIFT_NAVHIDDEN, 997 NAVHIDDEN_YES = ACONFIGURATION_NAVHIDDEN_YES << SHIFT_NAVHIDDEN, 998 }; 999 1000 union { 1001 struct { 1002 uint8_t keyboard; 1003 uint8_t navigation; 1004 uint8_t inputFlags; 1005 uint8_t inputPad0; 1006 }; 1007 uint32_t input; 1008 }; 1009 1010 enum { 1011 SCREENWIDTH_ANY = 0 1012 }; 1013 1014 enum { 1015 SCREENHEIGHT_ANY = 0 1016 }; 1017 1018 union { 1019 struct { 1020 uint16_t screenWidth; 1021 uint16_t screenHeight; 1022 }; 1023 uint32_t screenSize; 1024 }; 1025 1026 enum { 1027 SDKVERSION_ANY = 0 1028 }; 1029 1030 enum { 1031 MINORVERSION_ANY = 0 1032 }; 1033 1034 union { 1035 struct { 1036 uint16_t sdkVersion; 1037 // For now minorVersion must always be 0!!! Its meaning 1038 // is currently undefined. 1039 uint16_t minorVersion; 1040 }; 1041 uint32_t version; 1042 }; 1043 1044 enum { 1045 // screenLayout bits for screen size class. 1046 MASK_SCREENSIZE = 0x0f, 1047 SCREENSIZE_ANY = ACONFIGURATION_SCREENSIZE_ANY, 1048 SCREENSIZE_SMALL = ACONFIGURATION_SCREENSIZE_SMALL, 1049 SCREENSIZE_NORMAL = ACONFIGURATION_SCREENSIZE_NORMAL, 1050 SCREENSIZE_LARGE = ACONFIGURATION_SCREENSIZE_LARGE, 1051 SCREENSIZE_XLARGE = ACONFIGURATION_SCREENSIZE_XLARGE, 1052 1053 // screenLayout bits for wide/long screen variation. 1054 MASK_SCREENLONG = 0x30, 1055 SHIFT_SCREENLONG = 4, 1056 SCREENLONG_ANY = ACONFIGURATION_SCREENLONG_ANY << SHIFT_SCREENLONG, 1057 SCREENLONG_NO = ACONFIGURATION_SCREENLONG_NO << SHIFT_SCREENLONG, 1058 SCREENLONG_YES = ACONFIGURATION_SCREENLONG_YES << SHIFT_SCREENLONG, 1059 1060 // screenLayout bits for layout direction. 1061 MASK_LAYOUTDIR = 0xC0, 1062 SHIFT_LAYOUTDIR = 6, 1063 LAYOUTDIR_ANY = ACONFIGURATION_LAYOUTDIR_ANY << SHIFT_LAYOUTDIR, 1064 LAYOUTDIR_LTR = ACONFIGURATION_LAYOUTDIR_LTR << SHIFT_LAYOUTDIR, 1065 LAYOUTDIR_RTL = ACONFIGURATION_LAYOUTDIR_RTL << SHIFT_LAYOUTDIR, 1066 }; 1067 1068 enum { 1069 // uiMode bits for the mode type. 1070 MASK_UI_MODE_TYPE = 0x0f, 1071 UI_MODE_TYPE_ANY = ACONFIGURATION_UI_MODE_TYPE_ANY, 1072 UI_MODE_TYPE_NORMAL = ACONFIGURATION_UI_MODE_TYPE_NORMAL, 1073 UI_MODE_TYPE_DESK = ACONFIGURATION_UI_MODE_TYPE_DESK, 1074 UI_MODE_TYPE_CAR = ACONFIGURATION_UI_MODE_TYPE_CAR, 1075 UI_MODE_TYPE_TELEVISION = ACONFIGURATION_UI_MODE_TYPE_TELEVISION, 1076 UI_MODE_TYPE_APPLIANCE = ACONFIGURATION_UI_MODE_TYPE_APPLIANCE, 1077 UI_MODE_TYPE_WATCH = ACONFIGURATION_UI_MODE_TYPE_WATCH, 1078 1079 // uiMode bits for the night switch. 1080 MASK_UI_MODE_NIGHT = 0x30, 1081 SHIFT_UI_MODE_NIGHT = 4, 1082 UI_MODE_NIGHT_ANY = ACONFIGURATION_UI_MODE_NIGHT_ANY << SHIFT_UI_MODE_NIGHT, 1083 UI_MODE_NIGHT_NO = ACONFIGURATION_UI_MODE_NIGHT_NO << SHIFT_UI_MODE_NIGHT, 1084 UI_MODE_NIGHT_YES = ACONFIGURATION_UI_MODE_NIGHT_YES << SHIFT_UI_MODE_NIGHT, 1085 }; 1086 1087 union { 1088 struct { 1089 uint8_t screenLayout; 1090 uint8_t uiMode; 1091 uint16_t smallestScreenWidthDp; 1092 }; 1093 uint32_t screenConfig; 1094 }; 1095 1096 union { 1097 struct { 1098 uint16_t screenWidthDp; 1099 uint16_t screenHeightDp; 1100 }; 1101 uint32_t screenSizeDp; 1102 }; 1103 1104 // The ISO-15924 short name for the script corresponding to this 1105 // configuration. (eg. Hant, Latn, etc.). Interpreted in conjunction with 1106 // the locale field. 1107 char localeScript[4]; 1108 1109 // A single BCP-47 variant subtag. Will vary in length between 5 and 8 1110 // chars. Interpreted in conjunction with the locale field. 1111 char localeVariant[8]; 1112 1113 void copyFromDeviceNoSwap(const ResTable_config& o); 1114 1115 void copyFromDtoH(const ResTable_config& o); 1116 1117 void swapHtoD(); 1118 1119 int compare(const ResTable_config& o) const; 1120 int compareLogical(const ResTable_config& o) const; 1121 1122 // Flags indicating a set of config values. These flag constants must 1123 // match the corresponding ones in android.content.pm.ActivityInfo and 1124 // attrs_manifest.xml. 1125 enum { 1126 CONFIG_MCC = ACONFIGURATION_MCC, 1127 CONFIG_MNC = ACONFIGURATION_MNC, 1128 CONFIG_LOCALE = ACONFIGURATION_LOCALE, 1129 CONFIG_TOUCHSCREEN = ACONFIGURATION_TOUCHSCREEN, 1130 CONFIG_KEYBOARD = ACONFIGURATION_KEYBOARD, 1131 CONFIG_KEYBOARD_HIDDEN = ACONFIGURATION_KEYBOARD_HIDDEN, 1132 CONFIG_NAVIGATION = ACONFIGURATION_NAVIGATION, 1133 CONFIG_ORIENTATION = ACONFIGURATION_ORIENTATION, 1134 CONFIG_DENSITY = ACONFIGURATION_DENSITY, 1135 CONFIG_SCREEN_SIZE = ACONFIGURATION_SCREEN_SIZE, 1136 CONFIG_SMALLEST_SCREEN_SIZE = ACONFIGURATION_SMALLEST_SCREEN_SIZE, 1137 CONFIG_VERSION = ACONFIGURATION_VERSION, 1138 CONFIG_SCREEN_LAYOUT = ACONFIGURATION_SCREEN_LAYOUT, 1139 CONFIG_UI_MODE = ACONFIGURATION_UI_MODE, 1140 CONFIG_LAYOUTDIR = ACONFIGURATION_LAYOUTDIR, 1141 }; 1142 1143 // Compare two configuration, returning CONFIG_* flags set for each value 1144 // that is different. 1145 int diff(const ResTable_config& o) const; 1146 1147 // Return true if 'this' is more specific than 'o'. 1148 bool isMoreSpecificThan(const ResTable_config& o) const; 1149 1150 // Return true if 'this' is a better match than 'o' for the 'requested' 1151 // configuration. This assumes that match() has already been used to 1152 // remove any configurations that don't match the requested configuration 1153 // at all; if they are not first filtered, non-matching results can be 1154 // considered better than matching ones. 1155 // The general rule per attribute: if the request cares about an attribute 1156 // (it normally does), if the two (this and o) are equal it's a tie. If 1157 // they are not equal then one must be generic because only generic and 1158 // '==requested' will pass the match() call. So if this is not generic, 1159 // it wins. If this IS generic, o wins (return false). 1160 bool isBetterThan(const ResTable_config& o, const ResTable_config* requested) const; 1161 1162 // Return true if 'this' can be considered a match for the parameters in 1163 // 'settings'. 1164 // Note this is asymetric. A default piece of data will match every request 1165 // but a request for the default should not match odd specifics 1166 // (ie, request with no mcc should not match a particular mcc's data) 1167 // settings is the requested settings 1168 bool match(const ResTable_config& settings) const; 1169 1170 // Get the string representation of the locale component of this 1171 // Config. The maximum size of this representation will be 1172 // |RESTABLE_MAX_LOCALE_LEN| (including a terminating '\0'). 1173 // 1174 // Example: en-US, en-Latn-US, en-POSIX. 1175 void getBcp47Locale(char* out) const; 1176 1177 // Sets the values of language, region, script and variant to the 1178 // well formed BCP-47 locale contained in |in|. The input locale is 1179 // assumed to be valid and no validation is performed. 1180 void setBcp47Locale(const char* in); 1181 1182 inline void clearLocale() { 1183 locale = 0; 1184 memset(localeScript, 0, sizeof(localeScript)); 1185 memset(localeVariant, 0, sizeof(localeVariant)); 1186 } 1187 1188 // Get the 2 or 3 letter language code of this configuration. Trailing 1189 // bytes are set to '\0'. 1190 size_t unpackLanguage(char language[4]) const; 1191 // Get the 2 or 3 letter language code of this configuration. Trailing 1192 // bytes are set to '\0'. 1193 size_t unpackRegion(char region[4]) const; 1194 1195 // Sets the language code of this configuration to the first three 1196 // chars at |language|. 1197 // 1198 // If |language| is a 2 letter code, the trailing byte must be '\0' or 1199 // the BCP-47 separator '-'. 1200 void packLanguage(const char* language); 1201 // Sets the region code of this configuration to the first three bytes 1202 // at |region|. If |region| is a 2 letter code, the trailing byte must be '\0' 1203 // or the BCP-47 separator '-'. 1204 void packRegion(const char* region); 1205 1206 // Returns a positive integer if this config is more specific than |o| 1207 // with respect to their locales, a negative integer if |o| is more specific 1208 // and 0 if they're equally specific. 1209 int isLocaleMoreSpecificThan(const ResTable_config &o) const; 1210 1211 String8 toString() const; 1212}; 1213 1214/** 1215 * A specification of the resources defined by a particular type. 1216 * 1217 * There should be one of these chunks for each resource type. 1218 * 1219 * This structure is followed by an array of integers providing the set of 1220 * configuration change flags (ResTable_config::CONFIG_*) that have multiple 1221 * resources for that configuration. In addition, the high bit is set if that 1222 * resource has been made public. 1223 */ 1224struct ResTable_typeSpec 1225{ 1226 struct ResChunk_header header; 1227 1228 // The type identifier this chunk is holding. Type IDs start 1229 // at 1 (corresponding to the value of the type bits in a 1230 // resource identifier). 0 is invalid. 1231 uint8_t id; 1232 1233 // Must be 0. 1234 uint8_t res0; 1235 // Must be 0. 1236 uint16_t res1; 1237 1238 // Number of uint32_t entry configuration masks that follow. 1239 uint32_t entryCount; 1240 1241 enum { 1242 // Additional flag indicating an entry is public. 1243 SPEC_PUBLIC = 0x40000000 1244 }; 1245}; 1246 1247/** 1248 * A collection of resource entries for a particular resource data 1249 * type. Followed by an array of uint32_t defining the resource 1250 * values, corresponding to the array of type strings in the 1251 * ResTable_package::typeStrings string block. Each of these hold an 1252 * index from entriesStart; a value of NO_ENTRY means that entry is 1253 * not defined. 1254 * 1255 * There may be multiple of these chunks for a particular resource type, 1256 * supply different configuration variations for the resource values of 1257 * that type. 1258 * 1259 * It would be nice to have an additional ordered index of entries, so 1260 * we can do a binary search if trying to find a resource by string name. 1261 */ 1262struct ResTable_type 1263{ 1264 struct ResChunk_header header; 1265 1266 enum { 1267 NO_ENTRY = 0xFFFFFFFF 1268 }; 1269 1270 // The type identifier this chunk is holding. Type IDs start 1271 // at 1 (corresponding to the value of the type bits in a 1272 // resource identifier). 0 is invalid. 1273 uint8_t id; 1274 1275 // Must be 0. 1276 uint8_t res0; 1277 // Must be 0. 1278 uint16_t res1; 1279 1280 // Number of uint32_t entry indices that follow. 1281 uint32_t entryCount; 1282 1283 // Offset from header where ResTable_entry data starts. 1284 uint32_t entriesStart; 1285 1286 // Configuration this collection of entries is designed for. 1287 ResTable_config config; 1288}; 1289 1290/** 1291 * This is the beginning of information about an entry in the resource 1292 * table. It holds the reference to the name of this entry, and is 1293 * immediately followed by one of: 1294 * * A Res_value structure, if FLAG_COMPLEX is -not- set. 1295 * * An array of ResTable_map structures, if FLAG_COMPLEX is set. 1296 * These supply a set of name/value mappings of data. 1297 */ 1298struct ResTable_entry 1299{ 1300 // Number of bytes in this structure. 1301 uint16_t size; 1302 1303 enum { 1304 // If set, this is a complex entry, holding a set of name/value 1305 // mappings. It is followed by an array of ResTable_map structures. 1306 FLAG_COMPLEX = 0x0001, 1307 // If set, this resource has been declared public, so libraries 1308 // are allowed to reference it. 1309 FLAG_PUBLIC = 0x0002 1310 }; 1311 uint16_t flags; 1312 1313 // Reference into ResTable_package::keyStrings identifying this entry. 1314 struct ResStringPool_ref key; 1315}; 1316 1317/** 1318 * Extended form of a ResTable_entry for map entries, defining a parent map 1319 * resource from which to inherit values. 1320 */ 1321struct ResTable_map_entry : public ResTable_entry 1322{ 1323 // Resource identifier of the parent mapping, or 0 if there is none. 1324 // This is always treated as a TYPE_DYNAMIC_REFERENCE. 1325 ResTable_ref parent; 1326 // Number of name/value pairs that follow for FLAG_COMPLEX. 1327 uint32_t count; 1328}; 1329 1330/** 1331 * A single name/value mapping that is part of a complex resource 1332 * entry. 1333 */ 1334struct ResTable_map 1335{ 1336 // The resource identifier defining this mapping's name. For attribute 1337 // resources, 'name' can be one of the following special resource types 1338 // to supply meta-data about the attribute; for all other resource types 1339 // it must be an attribute resource. 1340 ResTable_ref name; 1341 1342 // Special values for 'name' when defining attribute resources. 1343 enum { 1344 // This entry holds the attribute's type code. 1345 ATTR_TYPE = Res_MAKEINTERNAL(0), 1346 1347 // For integral attributes, this is the minimum value it can hold. 1348 ATTR_MIN = Res_MAKEINTERNAL(1), 1349 1350 // For integral attributes, this is the maximum value it can hold. 1351 ATTR_MAX = Res_MAKEINTERNAL(2), 1352 1353 // Localization of this resource is can be encouraged or required with 1354 // an aapt flag if this is set 1355 ATTR_L10N = Res_MAKEINTERNAL(3), 1356 1357 // for plural support, see android.content.res.PluralRules#attrForQuantity(int) 1358 ATTR_OTHER = Res_MAKEINTERNAL(4), 1359 ATTR_ZERO = Res_MAKEINTERNAL(5), 1360 ATTR_ONE = Res_MAKEINTERNAL(6), 1361 ATTR_TWO = Res_MAKEINTERNAL(7), 1362 ATTR_FEW = Res_MAKEINTERNAL(8), 1363 ATTR_MANY = Res_MAKEINTERNAL(9) 1364 1365 }; 1366 1367 // Bit mask of allowed types, for use with ATTR_TYPE. 1368 enum { 1369 // No type has been defined for this attribute, use generic 1370 // type handling. The low 16 bits are for types that can be 1371 // handled generically; the upper 16 require additional information 1372 // in the bag so can not be handled generically for TYPE_ANY. 1373 TYPE_ANY = 0x0000FFFF, 1374 1375 // Attribute holds a references to another resource. 1376 TYPE_REFERENCE = 1<<0, 1377 1378 // Attribute holds a generic string. 1379 TYPE_STRING = 1<<1, 1380 1381 // Attribute holds an integer value. ATTR_MIN and ATTR_MIN can 1382 // optionally specify a constrained range of possible integer values. 1383 TYPE_INTEGER = 1<<2, 1384 1385 // Attribute holds a boolean integer. 1386 TYPE_BOOLEAN = 1<<3, 1387 1388 // Attribute holds a color value. 1389 TYPE_COLOR = 1<<4, 1390 1391 // Attribute holds a floating point value. 1392 TYPE_FLOAT = 1<<5, 1393 1394 // Attribute holds a dimension value, such as "20px". 1395 TYPE_DIMENSION = 1<<6, 1396 1397 // Attribute holds a fraction value, such as "20%". 1398 TYPE_FRACTION = 1<<7, 1399 1400 // Attribute holds an enumeration. The enumeration values are 1401 // supplied as additional entries in the map. 1402 TYPE_ENUM = 1<<16, 1403 1404 // Attribute holds a bitmaks of flags. The flag bit values are 1405 // supplied as additional entries in the map. 1406 TYPE_FLAGS = 1<<17 1407 }; 1408 1409 // Enum of localization modes, for use with ATTR_L10N. 1410 enum { 1411 L10N_NOT_REQUIRED = 0, 1412 L10N_SUGGESTED = 1 1413 }; 1414 1415 // This mapping's value. 1416 Res_value value; 1417}; 1418 1419/** 1420 * A package-id to package name mapping for any shared libraries used 1421 * in this resource table. The package-id's encoded in this resource 1422 * table may be different than the id's assigned at runtime. We must 1423 * be able to translate the package-id's based on the package name. 1424 */ 1425struct ResTable_lib_header 1426{ 1427 struct ResChunk_header header; 1428 1429 // The number of shared libraries linked in this resource table. 1430 uint32_t count; 1431}; 1432 1433/** 1434 * A shared library package-id to package name entry. 1435 */ 1436struct ResTable_lib_entry 1437{ 1438 // The package-id this shared library was assigned at build time. 1439 // We use a uint32 to keep the structure aligned on a uint32 boundary. 1440 uint32_t packageId; 1441 1442 // The package name of the shared library. \0 terminated. 1443 char16_t packageName[128]; 1444}; 1445 1446/** 1447 * Holds the shared library ID table. Shared libraries are assigned package IDs at 1448 * build time, but they may be loaded in a different order, so we need to maintain 1449 * a mapping of build-time package ID to run-time assigned package ID. 1450 * 1451 * Dynamic references are not currently supported in overlays. Only the base package 1452 * may have dynamic references. 1453 */ 1454class DynamicRefTable 1455{ 1456public: 1457 DynamicRefTable(uint8_t packageId); 1458 1459 // Loads an unmapped reference table from the package. 1460 status_t load(const ResTable_lib_header* const header); 1461 1462 // Adds mappings from the other DynamicRefTable 1463 status_t addMappings(const DynamicRefTable& other); 1464 1465 // Creates a mapping from build-time package ID to run-time package ID for 1466 // the given package. 1467 status_t addMapping(const String16& packageName, uint8_t packageId); 1468 1469 // Performs the actual conversion of build-time resource ID to run-time 1470 // resource ID. 1471 inline status_t lookupResourceId(uint32_t* resId) const; 1472 inline status_t lookupResourceValue(Res_value* value) const; 1473 1474 inline const KeyedVector<String16, uint8_t>& entries() const { 1475 return mEntries; 1476 } 1477 1478private: 1479 const uint8_t mAssignedPackageId; 1480 uint8_t mLookupTable[256]; 1481 KeyedVector<String16, uint8_t> mEntries; 1482}; 1483 1484/** 1485 * Convenience class for accessing data in a ResTable resource. 1486 */ 1487class ResTable 1488{ 1489public: 1490 ResTable(); 1491 ResTable(const void* data, size_t size, const int32_t cookie, 1492 bool copyData=false); 1493 ~ResTable(); 1494 1495 status_t add(const void* data, size_t size, const int32_t cookie=-1, bool copyData=false); 1496 status_t add(const void* data, size_t size, const void* idmapData, size_t idmapDataSize, 1497 const int32_t cookie=-1, bool copyData=false); 1498 1499 status_t add(Asset* asset, const int32_t cookie=-1, bool copyData=false); 1500 status_t add(Asset* asset, Asset* idmapAsset, const int32_t cookie=-1, bool copyData=false); 1501 1502 status_t add(ResTable* src); 1503 status_t addEmpty(const int32_t cookie); 1504 1505 status_t getError() const; 1506 1507 void uninit(); 1508 1509 struct resource_name 1510 { 1511 const char16_t* package; 1512 size_t packageLen; 1513 const char16_t* type; 1514 const char* type8; 1515 size_t typeLen; 1516 const char16_t* name; 1517 const char* name8; 1518 size_t nameLen; 1519 }; 1520 1521 bool getResourceName(uint32_t resID, bool allowUtf8, resource_name* outName) const; 1522 1523 /** 1524 * Retrieve the value of a resource. If the resource is found, returns a 1525 * value >= 0 indicating the table it is in (for use with 1526 * getTableStringBlock() and getTableCookie()) and fills in 'outValue'. If 1527 * not found, returns a negative error code. 1528 * 1529 * Note that this function does not do reference traversal. If you want 1530 * to follow references to other resources to get the "real" value to 1531 * use, you need to call resolveReference() after this function. 1532 * 1533 * @param resID The desired resoruce identifier. 1534 * @param outValue Filled in with the resource data that was found. 1535 * 1536 * @return ssize_t Either a >= 0 table index or a negative error code. 1537 */ 1538 ssize_t getResource(uint32_t resID, Res_value* outValue, bool mayBeBag = false, 1539 uint16_t density = 0, 1540 uint32_t* outSpecFlags = NULL, 1541 ResTable_config* outConfig = NULL) const; 1542 1543 inline ssize_t getResource(const ResTable_ref& res, Res_value* outValue, 1544 uint32_t* outSpecFlags=NULL) const { 1545 return getResource(res.ident, outValue, false, 0, outSpecFlags, NULL); 1546 } 1547 1548 ssize_t resolveReference(Res_value* inOutValue, 1549 ssize_t blockIndex, 1550 uint32_t* outLastRef = NULL, 1551 uint32_t* inoutTypeSpecFlags = NULL, 1552 ResTable_config* outConfig = NULL) const; 1553 1554 enum { 1555 TMP_BUFFER_SIZE = 16 1556 }; 1557 const char16_t* valueToString(const Res_value* value, size_t stringBlock, 1558 char16_t tmpBuffer[TMP_BUFFER_SIZE], 1559 size_t* outLen); 1560 1561 struct bag_entry { 1562 ssize_t stringBlock; 1563 ResTable_map map; 1564 }; 1565 1566 /** 1567 * Retrieve the bag of a resource. If the resoruce is found, returns the 1568 * number of bags it contains and 'outBag' points to an array of their 1569 * values. If not found, a negative error code is returned. 1570 * 1571 * Note that this function -does- do reference traversal of the bag data. 1572 * 1573 * @param resID The desired resource identifier. 1574 * @param outBag Filled inm with a pointer to the bag mappings. 1575 * 1576 * @return ssize_t Either a >= 0 bag count of negative error code. 1577 */ 1578 ssize_t lockBag(uint32_t resID, const bag_entry** outBag) const; 1579 1580 void unlockBag(const bag_entry* bag) const; 1581 1582 void lock() const; 1583 1584 ssize_t getBagLocked(uint32_t resID, const bag_entry** outBag, 1585 uint32_t* outTypeSpecFlags=NULL) const; 1586 1587 void unlock() const; 1588 1589 class Theme { 1590 public: 1591 Theme(const ResTable& table); 1592 ~Theme(); 1593 1594 inline const ResTable& getResTable() const { return mTable; } 1595 1596 status_t applyStyle(uint32_t resID, bool force=false); 1597 status_t setTo(const Theme& other); 1598 1599 /** 1600 * Retrieve a value in the theme. If the theme defines this 1601 * value, returns a value >= 0 indicating the table it is in 1602 * (for use with getTableStringBlock() and getTableCookie) and 1603 * fills in 'outValue'. If not found, returns a negative error 1604 * code. 1605 * 1606 * Note that this function does not do reference traversal. If you want 1607 * to follow references to other resources to get the "real" value to 1608 * use, you need to call resolveReference() after this function. 1609 * 1610 * @param resID A resource identifier naming the desired theme 1611 * attribute. 1612 * @param outValue Filled in with the theme value that was 1613 * found. 1614 * 1615 * @return ssize_t Either a >= 0 table index or a negative error code. 1616 */ 1617 ssize_t getAttribute(uint32_t resID, Res_value* outValue, 1618 uint32_t* outTypeSpecFlags = NULL) const; 1619 1620 /** 1621 * This is like ResTable::resolveReference(), but also takes 1622 * care of resolving attribute references to the theme. 1623 */ 1624 ssize_t resolveAttributeReference(Res_value* inOutValue, 1625 ssize_t blockIndex, uint32_t* outLastRef = NULL, 1626 uint32_t* inoutTypeSpecFlags = NULL, 1627 ResTable_config* inoutConfig = NULL) const; 1628 1629 void dumpToLog() const; 1630 1631 private: 1632 Theme(const Theme&); 1633 Theme& operator=(const Theme&); 1634 1635 struct theme_entry { 1636 ssize_t stringBlock; 1637 uint32_t typeSpecFlags; 1638 Res_value value; 1639 }; 1640 1641 struct type_info { 1642 size_t numEntries; 1643 theme_entry* entries; 1644 }; 1645 1646 struct package_info { 1647 type_info types[Res_MAXTYPE + 1]; 1648 }; 1649 1650 void free_package(package_info* pi); 1651 package_info* copy_package(package_info* pi); 1652 1653 const ResTable& mTable; 1654 package_info* mPackages[Res_MAXPACKAGE]; 1655 }; 1656 1657 void setParameters(const ResTable_config* params); 1658 void getParameters(ResTable_config* params) const; 1659 1660 // Retrieve an identifier (which can be passed to getResource) 1661 // for a given resource name. The 'name' can be fully qualified 1662 // (<package>:<type>.<basename>) or the package or type components 1663 // can be dropped if default values are supplied here. 1664 // 1665 // Returns 0 if no such resource was found, else a valid resource ID. 1666 uint32_t identifierForName(const char16_t* name, size_t nameLen, 1667 const char16_t* type = 0, size_t typeLen = 0, 1668 const char16_t* defPackage = 0, 1669 size_t defPackageLen = 0, 1670 uint32_t* outTypeSpecFlags = NULL) const; 1671 1672 static bool expandResourceRef(const uint16_t* refStr, size_t refLen, 1673 String16* outPackage, 1674 String16* outType, 1675 String16* outName, 1676 const String16* defType = NULL, 1677 const String16* defPackage = NULL, 1678 const char** outErrorMsg = NULL, 1679 bool* outPublicOnly = NULL); 1680 1681 static bool stringToInt(const char16_t* s, size_t len, Res_value* outValue); 1682 static bool stringToFloat(const char16_t* s, size_t len, Res_value* outValue); 1683 1684 // Used with stringToValue. 1685 class Accessor 1686 { 1687 public: 1688 inline virtual ~Accessor() { } 1689 1690 virtual const String16& getAssetsPackage() const = 0; 1691 1692 virtual uint32_t getCustomResource(const String16& package, 1693 const String16& type, 1694 const String16& name) const = 0; 1695 virtual uint32_t getCustomResourceWithCreation(const String16& package, 1696 const String16& type, 1697 const String16& name, 1698 const bool createIfNeeded = false) = 0; 1699 virtual uint32_t getRemappedPackage(uint32_t origPackage) const = 0; 1700 virtual bool getAttributeType(uint32_t attrID, uint32_t* outType) = 0; 1701 virtual bool getAttributeMin(uint32_t attrID, uint32_t* outMin) = 0; 1702 virtual bool getAttributeMax(uint32_t attrID, uint32_t* outMax) = 0; 1703 virtual bool getAttributeEnum(uint32_t attrID, 1704 const char16_t* name, size_t nameLen, 1705 Res_value* outValue) = 0; 1706 virtual bool getAttributeFlags(uint32_t attrID, 1707 const char16_t* name, size_t nameLen, 1708 Res_value* outValue) = 0; 1709 virtual uint32_t getAttributeL10N(uint32_t attrID) = 0; 1710 virtual bool getLocalizationSetting() = 0; 1711 virtual void reportError(void* accessorCookie, const char* fmt, ...) = 0; 1712 }; 1713 1714 // Convert a string to a resource value. Handles standard "@res", 1715 // "#color", "123", and "0x1bd" types; performs escaping of strings. 1716 // The resulting value is placed in 'outValue'; if it is a string type, 1717 // 'outString' receives the string. If 'attrID' is supplied, the value is 1718 // type checked against this attribute and it is used to perform enum 1719 // evaluation. If 'acccessor' is supplied, it will be used to attempt to 1720 // resolve resources that do not exist in this ResTable. If 'attrType' is 1721 // supplied, the value will be type checked for this format if 'attrID' 1722 // is not supplied or found. 1723 bool stringToValue(Res_value* outValue, String16* outString, 1724 const char16_t* s, size_t len, 1725 bool preserveSpaces, bool coerceType, 1726 uint32_t attrID = 0, 1727 const String16* defType = NULL, 1728 const String16* defPackage = NULL, 1729 Accessor* accessor = NULL, 1730 void* accessorCookie = NULL, 1731 uint32_t attrType = ResTable_map::TYPE_ANY, 1732 bool enforcePrivate = true) const; 1733 1734 // Perform processing of escapes and quotes in a string. 1735 static bool collectString(String16* outString, 1736 const char16_t* s, size_t len, 1737 bool preserveSpaces, 1738 const char** outErrorMsg = NULL, 1739 bool append = false); 1740 1741 size_t getBasePackageCount() const; 1742 const String16 getBasePackageName(size_t idx) const; 1743 uint32_t getBasePackageId(size_t idx) const; 1744 uint32_t getLastTypeIdForPackage(size_t idx) const; 1745 1746 // Return the number of resource tables that the object contains. 1747 size_t getTableCount() const; 1748 // Return the values string pool for the resource table at the given 1749 // index. This string pool contains all of the strings for values 1750 // contained in the resource table -- that is the item values themselves, 1751 // but not the names their entries or types. 1752 const ResStringPool* getTableStringBlock(size_t index) const; 1753 // Return unique cookie identifier for the given resource table. 1754 int32_t getTableCookie(size_t index) const; 1755 1756 const DynamicRefTable* getDynamicRefTableForCookie(int32_t cookie) const; 1757 1758 // Return the configurations (ResTable_config) that we know about 1759 void getConfigurations(Vector<ResTable_config>* configs) const; 1760 1761 void getLocales(Vector<String8>* locales) const; 1762 1763 // Generate an idmap. 1764 // 1765 // Return value: on success: NO_ERROR; caller is responsible for free-ing 1766 // outData (using free(3)). On failure, any status_t value other than 1767 // NO_ERROR; the caller should not free outData. 1768 status_t createIdmap(const ResTable& overlay, 1769 uint32_t targetCrc, uint32_t overlayCrc, 1770 const char* targetPath, const char* overlayPath, 1771 void** outData, size_t* outSize) const; 1772 1773 enum { 1774 IDMAP_HEADER_SIZE_BYTES = 4 * sizeof(uint32_t) + 2 * 256, 1775 }; 1776 1777 // Retrieve idmap meta-data. 1778 // 1779 // This function only requires the idmap header (the first 1780 // IDMAP_HEADER_SIZE_BYTES) bytes of an idmap file. 1781 static bool getIdmapInfo(const void* idmap, size_t size, 1782 uint32_t* pVersion, 1783 uint32_t* pTargetCrc, uint32_t* pOverlayCrc, 1784 String8* pTargetPath, String8* pOverlayPath); 1785 1786 void print(bool inclValues) const; 1787 static String8 normalizeForOutput(const char* input); 1788 1789private: 1790 struct Header; 1791 struct Type; 1792 struct Entry; 1793 struct Package; 1794 struct PackageGroup; 1795 struct bag_set; 1796 typedef Vector<Type*> TypeList; 1797 1798 status_t addInternal(const void* data, size_t size, const void* idmapData, size_t idmapDataSize, 1799 const int32_t cookie, bool copyData); 1800 1801 ssize_t getResourcePackageIndex(uint32_t resID) const; 1802 1803 status_t getEntry( 1804 const PackageGroup* packageGroup, int typeIndex, int entryIndex, 1805 const ResTable_config* config, 1806 Entry* outEntry) const; 1807 1808 status_t parsePackage( 1809 const ResTable_package* const pkg, const Header* const header); 1810 1811 void print_value(const Package* pkg, const Res_value& value) const; 1812 1813 mutable Mutex mLock; 1814 1815 status_t mError; 1816 1817 ResTable_config mParams; 1818 1819 // Array of all resource tables. 1820 Vector<Header*> mHeaders; 1821 1822 // Array of packages in all resource tables. 1823 Vector<PackageGroup*> mPackageGroups; 1824 1825 // Mapping from resource package IDs to indices into the internal 1826 // package array. 1827 uint8_t mPackageMap[256]; 1828 1829 uint8_t mNextPackageId; 1830}; 1831 1832} // namespace android 1833 1834#endif // _LIBS_UTILS_RESOURCE_TYPES_H 1835