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