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