1 // 2 // Copyright 2006 The Android Open Source Project 3 // 4 // Build resource files from raw assets. 5 // 6 7 #ifndef STRING_POOL_H 8 #define STRING_POOL_H 9 10 #include "Main.h" 11 #include "AaptAssets.h" 12 13 #include <androidfw/ResourceTypes.h> 14 #include <utils/String16.h> 15 #include <utils/TextOutput.h> 16 #include <utils/TypeHelpers.h> 17 18 #include <sys/types.h> 19 #include <sys/stat.h> 20 #include <fcntl.h> 21 #include <ctype.h> 22 #include <errno.h> 23 24 #include <libexpat/expat.h> 25 26 using namespace android; 27 28 #define PRINT_STRING_METRICS 0 29 30 void strcpy16_htod(uint16_t* dst, const uint16_t* src); 31 32 void printStringPool(const ResStringPool* pool); 33 34 /** 35 * The StringPool class is used as an intermediate representation for 36 * generating the string pool resource data structure that can be parsed with 37 * ResStringPool in include/utils/ResourceTypes.h. 38 */ 39 class StringPool 40 { 41 public: 42 struct entry { 43 entry() : offset(0) { } 44 entry(const String16& _value) : value(_value), offset(0), hasStyles(false) { } 45 entry(const entry& o) : value(o.value), offset(o.offset), 46 hasStyles(o.hasStyles), indices(o.indices), 47 configTypeName(o.configTypeName), configs(o.configs) { } 48 49 String16 value; 50 size_t offset; 51 bool hasStyles; 52 Vector<size_t> indices; 53 String8 configTypeName; 54 Vector<ResTable_config> configs; 55 56 String8 makeConfigsString() const; 57 58 int compare(const entry& o) const; 59 60 inline bool operator<(const entry& o) const { return compare(o) < 0; } 61 inline bool operator<=(const entry& o) const { return compare(o) <= 0; } 62 inline bool operator==(const entry& o) const { return compare(o) == 0; } 63 inline bool operator!=(const entry& o) const { return compare(o) != 0; } 64 inline bool operator>=(const entry& o) const { return compare(o) >= 0; } 65 inline bool operator>(const entry& o) const { return compare(o) > 0; } 66 }; 67 68 struct entry_style_span { 69 String16 name; 70 ResStringPool_span span; 71 }; 72 73 struct entry_style { 74 entry_style() : offset(0) { } 75 76 entry_style(const entry_style& o) : offset(o.offset), spans(o.spans) { } 77 78 size_t offset; 79 Vector<entry_style_span> spans; 80 }; 81 82 /** 83 * If 'utf8' is true, strings will be encoded with UTF-8 instead of 84 * left in Java's native UTF-16. 85 */ 86 explicit StringPool(bool utf8 = false); 87 88 /** 89 * Add a new string to the pool. If mergeDuplicates is true, thenif 90 * the string already exists the existing entry for it will be used; 91 * otherwise, or if the value doesn't already exist, a new entry is 92 * created. 93 * 94 * Returns the index in the entry array of the new string entry. 95 */ 96 ssize_t add(const String16& value, bool mergeDuplicates = false, 97 const String8* configTypeName = NULL, const ResTable_config* config = NULL); 98 99 ssize_t add(const String16& value, const Vector<entry_style_span>& spans, 100 const String8* configTypeName = NULL, const ResTable_config* config = NULL); 101 102 status_t addStyleSpan(size_t idx, const String16& name, 103 uint32_t start, uint32_t end); 104 status_t addStyleSpans(size_t idx, const Vector<entry_style_span>& spans); 105 status_t addStyleSpan(size_t idx, const entry_style_span& span); 106 107 // Sort the contents of the string block by the configuration associated 108 // with each item. After doing this you can use mapOriginalPosToNewPos() 109 // to find out the new position given the position originally returned by 110 // add(). 111 void sortByConfig(); 112 113 // For use after sortByConfig() to map from the original position of 114 // a string to its new sorted position. 115 size_t mapOriginalPosToNewPos(size_t originalPos) const { 116 return mOriginalPosToNewPos.itemAt(originalPos); 117 } 118 119 sp<AaptFile> createStringBlock(); 120 121 status_t writeStringBlock(const sp<AaptFile>& pool); 122 123 /** 124 * Find out an offset in the pool for a particular string. If the string 125 * pool is sorted, this can not be called until after createStringBlock() 126 * or writeStringBlock() has been called 127 * (which determines the offsets). In the case of a string that appears 128 * multiple times in the pool, the first offset will be returned. Returns 129 * -1 if the string does not exist. 130 */ 131 ssize_t offsetForString(const String16& val) const; 132 133 /** 134 * Find all of the offsets in the pool for a particular string. If the 135 * string pool is sorted, this can not be called until after 136 * createStringBlock() or writeStringBlock() has been called 137 * (which determines the offsets). Returns NULL if the string does not exist. 138 */ 139 const Vector<size_t>* offsetsForString(const String16& val) const; 140 141 private: 142 static int config_sort(void* state, const void* lhs, const void* rhs); 143 144 const bool mUTF8; 145 146 // The following data structures represent the actual structures 147 // that will be generated for the final string pool. 148 149 // Raw array of unique strings, in some arbitrary order. This is the 150 // actual strings that appear in the final string pool, in the order 151 // that they will be written. 152 Vector<entry> mEntries; 153 // Array of indices into mEntries, in the order they were 154 // added to the pool. This can be different than mEntries 155 // if the same string was added multiple times (it will appear 156 // once in mEntries, with multiple occurrences in this array). 157 // This is the lookup array that will be written for finding 158 // the string for each offset/position in the string pool. 159 Vector<size_t> mEntryArray; 160 // Optional style span information associated with each index of 161 // mEntryArray. 162 Vector<entry_style> mEntryStyleArray; 163 164 // The following data structures are used for book-keeping as the 165 // string pool is constructed. 166 167 // Unique set of all the strings added to the pool, mapped to 168 // the first index of mEntryArray where the value was added. 169 DefaultKeyedVector<String16, ssize_t> mValues; 170 // This array maps from the original position a string was placed at 171 // in mEntryArray to its new position after being sorted with sortByConfig(). 172 Vector<size_t> mOriginalPosToNewPos; 173 }; 174 175 // The entry types are trivially movable because all fields they contain, including 176 // the vectors and strings, are trivially movable. 177 namespace android { 178 ANDROID_TRIVIAL_MOVE_TRAIT(StringPool::entry); 179 ANDROID_TRIVIAL_MOVE_TRAIT(StringPool::entry_style_span); 180 ANDROID_TRIVIAL_MOVE_TRAIT(StringPool::entry_style); 181 }; 182 183 #endif 184 185
