Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 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 | #ifndef AAPT_PROCESS_SYMBOLTABLE_H |
| 18 | #define AAPT_PROCESS_SYMBOLTABLE_H |
| 19 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 20 | #include <algorithm> |
| 21 | #include <memory> |
| 22 | #include <vector> |
| 23 | |
| 24 | #include "android-base/macros.h" |
| 25 | #include "androidfw/AssetManager.h" |
| 26 | #include "utils/JenkinsHash.h" |
| 27 | #include "utils/LruCache.h" |
| 28 | |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 29 | #include "Resource.h" |
| 30 | #include "ResourceTable.h" |
| 31 | #include "ResourceValues.h" |
| 32 | #include "util/Util.h" |
| 33 | |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 34 | namespace aapt { |
| 35 | |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 36 | inline android::hash_t hash_type(const ResourceName& name) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 37 | std::hash<std::string> str_hash; |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 38 | android::hash_t hash = 0; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 39 | hash = android::JenkinsHashMix(hash, (uint32_t)str_hash(name.package)); |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 40 | hash = android::JenkinsHashMix(hash, (uint32_t)name.type); |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 41 | hash = android::JenkinsHashMix(hash, (uint32_t)str_hash(name.entry)); |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 42 | return hash; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 43 | } |
| 44 | |
| 45 | inline android::hash_t hash_type(const ResourceId& id) { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 46 | return android::hash_type(id.id); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 47 | } |
| 48 | |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 49 | class ISymbolSource; |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 50 | class ISymbolTableDelegate; |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 51 | class NameMangler; |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 52 | |
| 53 | class SymbolTable { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 54 | public: |
| 55 | struct Symbol { |
| 56 | Symbol() : Symbol(Maybe<ResourceId>{}) {} |
Adam Lesinski | 626b3db | 2016-04-07 13:24:59 -0700 | [diff] [blame] | 57 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 58 | explicit Symbol(const Maybe<ResourceId>& i) : Symbol(i, nullptr) {} |
Adam Lesinski | 626b3db | 2016-04-07 13:24:59 -0700 | [diff] [blame] | 59 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 60 | Symbol(const Maybe<ResourceId>& i, const std::shared_ptr<Attribute>& attr) |
| 61 | : Symbol(i, attr, false) {} |
Adam Lesinski | 626b3db | 2016-04-07 13:24:59 -0700 | [diff] [blame] | 62 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 63 | Symbol(const Maybe<ResourceId>& i, const std::shared_ptr<Attribute>& attr, |
| 64 | bool pub) |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 65 | : id(i), attribute(attr), is_public(pub) {} |
Adam Lesinski | 626b3db | 2016-04-07 13:24:59 -0700 | [diff] [blame] | 66 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 67 | Symbol(const Symbol&) = default; |
| 68 | Symbol(Symbol&&) = default; |
| 69 | Symbol& operator=(const Symbol&) = default; |
| 70 | Symbol& operator=(Symbol&&) = default; |
Adam Lesinski | 626b3db | 2016-04-07 13:24:59 -0700 | [diff] [blame] | 71 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 72 | Maybe<ResourceId> id; |
| 73 | std::shared_ptr<Attribute> attribute; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 74 | bool is_public = false; |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 75 | }; |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 76 | |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 77 | SymbolTable(NameMangler* mangler); |
| 78 | |
| 79 | // Overrides the default ISymbolTableDelegate, which allows a custom defined strategy for |
| 80 | // looking up resources from a set of sources. |
| 81 | void SetDelegate(std::unique_ptr<ISymbolTableDelegate> delegate); |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 82 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 83 | // Appends a symbol source. The cache is not cleared since entries that |
| 84 | // have already been found would take precedence due to ordering. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 85 | void AppendSource(std::unique_ptr<ISymbolSource> source); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 86 | |
| 87 | // Prepends a symbol source so that its symbols take precedence. This will |
| 88 | // cause the existing cache to be cleared. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 89 | void PrependSource(std::unique_ptr<ISymbolSource> source); |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 90 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 91 | // NOTE: Never hold on to the result between calls to FindByXXX. The |
| 92 | // results are stored in a cache which may evict entries on subsequent calls. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 93 | const Symbol* FindByName(const ResourceName& name); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 94 | |
| 95 | // NOTE: Never hold on to the result between calls to FindByXXX. The |
| 96 | // results are stored in a cache which may evict entries on subsequent calls. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 97 | const Symbol* FindById(const ResourceId& id); |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 98 | |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 99 | // Let's the ISymbolSource decide whether looking up by name or ID is faster, |
| 100 | // if both are available. |
| 101 | // NOTE: Never hold on to the result between calls to FindByXXX. The |
| 102 | // results are stored in a cache which may evict entries on subsequent calls. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 103 | const Symbol* FindByReference(const Reference& ref); |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 104 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 105 | private: |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 106 | NameMangler* mangler_; |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 107 | std::unique_ptr<ISymbolTableDelegate> delegate_; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 108 | std::vector<std::unique_ptr<ISymbolSource>> sources_; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 109 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 110 | // We use shared_ptr because unique_ptr is not supported and |
| 111 | // we need automatic deletion. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 112 | android::LruCache<ResourceName, std::shared_ptr<Symbol>> cache_; |
| 113 | android::LruCache<ResourceId, std::shared_ptr<Symbol>> id_cache_; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 114 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 115 | DISALLOW_COPY_AND_ASSIGN(SymbolTable); |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 116 | }; |
| 117 | |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 118 | // Allows the customization of the lookup strategy/order of a symbol from a set of |
| 119 | // symbol sources. |
| 120 | class ISymbolTableDelegate { |
| 121 | public: |
| 122 | ISymbolTableDelegate() = default; |
| 123 | virtual ~ISymbolTableDelegate() = default; |
| 124 | |
| 125 | // The name is already mangled and does not need further processing. |
| 126 | virtual std::unique_ptr<SymbolTable::Symbol> FindByName( |
| 127 | const ResourceName& name, const std::vector<std::unique_ptr<ISymbolSource>>& sources) = 0; |
| 128 | |
| 129 | virtual std::unique_ptr<SymbolTable::Symbol> FindById( |
| 130 | ResourceId id, const std::vector<std::unique_ptr<ISymbolSource>>& sources) = 0; |
| 131 | |
| 132 | private: |
| 133 | DISALLOW_COPY_AND_ASSIGN(ISymbolTableDelegate); |
| 134 | }; |
| 135 | |
| 136 | class DefaultSymbolTableDelegate : public ISymbolTableDelegate { |
| 137 | public: |
| 138 | DefaultSymbolTableDelegate() = default; |
| 139 | virtual ~DefaultSymbolTableDelegate() = default; |
| 140 | |
| 141 | virtual std::unique_ptr<SymbolTable::Symbol> FindByName( |
| 142 | const ResourceName& name, |
| 143 | const std::vector<std::unique_ptr<ISymbolSource>>& sources) override; |
| 144 | virtual std::unique_ptr<SymbolTable::Symbol> FindById( |
| 145 | ResourceId id, const std::vector<std::unique_ptr<ISymbolSource>>& sources) override; |
| 146 | |
| 147 | private: |
| 148 | DISALLOW_COPY_AND_ASSIGN(DefaultSymbolTableDelegate); |
| 149 | }; |
| 150 | |
| 151 | // An interface that a symbol source implements in order to surface symbol information |
| 152 | // to the symbol table. |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 153 | class ISymbolSource { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 154 | public: |
| 155 | virtual ~ISymbolSource() = default; |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 156 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 157 | virtual std::unique_ptr<SymbolTable::Symbol> FindByName( |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 158 | const ResourceName& name) = 0; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 159 | virtual std::unique_ptr<SymbolTable::Symbol> FindById(ResourceId id) = 0; |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 160 | |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 161 | // Default implementation tries the name if it exists, else the ID. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 162 | virtual std::unique_ptr<SymbolTable::Symbol> FindByReference( |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 163 | const Reference& ref) { |
| 164 | if (ref.name) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 165 | return FindByName(ref.name.value()); |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 166 | } else if (ref.id) { |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 167 | return FindById(ref.id.value()); |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 168 | } |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 169 | return {}; |
| 170 | } |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 171 | }; |
| 172 | |
Adam Lesinski | 1e4b0e5 | 2017-04-27 15:01:10 -0700 | [diff] [blame^] | 173 | // Exposes the resources in a ResourceTable as symbols for SymbolTable. |
| 174 | // Instances of this class must outlive the encompassed ResourceTable. |
| 175 | // Lookups by ID are ignored. |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 176 | class ResourceTableSymbolSource : public ISymbolSource { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 177 | public: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 178 | explicit ResourceTableSymbolSource(ResourceTable* table) : table_(table) {} |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 179 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 180 | std::unique_ptr<SymbolTable::Symbol> FindByName( |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 181 | const ResourceName& name) override; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 182 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 183 | std::unique_ptr<SymbolTable::Symbol> FindById(ResourceId id) override { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 184 | return {}; |
| 185 | } |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 186 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 187 | private: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 188 | ResourceTable* table_; |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 189 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 190 | DISALLOW_COPY_AND_ASSIGN(ResourceTableSymbolSource); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 191 | }; |
| 192 | |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 193 | class AssetManagerSymbolSource : public ISymbolSource { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 194 | public: |
| 195 | AssetManagerSymbolSource() = default; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 196 | |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 197 | bool AddAssetPath(const android::StringPiece& path); |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 198 | std::map<size_t, std::string> GetAssignedPackageIds() const; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 199 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 200 | std::unique_ptr<SymbolTable::Symbol> FindByName( |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 201 | const ResourceName& name) override; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 202 | std::unique_ptr<SymbolTable::Symbol> FindById(ResourceId id) override; |
| 203 | std::unique_ptr<SymbolTable::Symbol> FindByReference( |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 204 | const Reference& ref) override; |
Adam Lesinski | 64587af | 2016-02-18 18:33:06 -0800 | [diff] [blame] | 205 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 206 | private: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 207 | android::AssetManager assets_; |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 208 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 209 | DISALLOW_COPY_AND_ASSIGN(AssetManagerSymbolSource); |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 210 | }; |
| 211 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 212 | } // namespace aapt |
Adam Lesinski | 1ab598f | 2015-08-14 14:26:04 -0700 | [diff] [blame] | 213 | |
| 214 | #endif /* AAPT_PROCESS_SYMBOLTABLE_H */ |