Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [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_LINKER_REFERENCELINKER_H |
| 18 | #define AAPT_LINKER_REFERENCELINKER_H |
| 19 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 20 | #include "android-base/macros.h" |
| 21 | |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 22 | #include "Resource.h" |
| 23 | #include "ResourceValues.h" |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 24 | #include "link/Linkers.h" |
| 25 | #include "process/IResourceTableConsumer.h" |
| 26 | #include "process/SymbolTable.h" |
| 27 | #include "xml/XmlDom.h" |
| 28 | |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 29 | namespace aapt { |
| 30 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 31 | // Resolves all references to resources in the ResourceTable and assigns them IDs. |
| 32 | // The ResourceTable must already have IDs assigned to each resource. |
| 33 | // Once the ResourceTable is processed by this linker, it is ready to be flattened. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 34 | class ReferenceLinker : public IResourceTableConsumer { |
| 35 | public: |
| 36 | ReferenceLinker() = default; |
| 37 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 38 | // Performs name mangling and looks up the resource in the symbol table. Uses the callsite's |
Chris Warrington | 481f027 | 2018-02-06 14:03:39 +0000 | [diff] [blame] | 39 | // package if the reference has no package name defined (implicit), or if auto_namespace is |
| 40 | // set try looking in all avaliable packages for a symbol of that name. |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 41 | // Returns nullptr if the symbol was not found. |
| 42 | static const SymbolTable::Symbol* ResolveSymbol(const Reference& reference, |
Chris Warrington | 481f027 | 2018-02-06 14:03:39 +0000 | [diff] [blame] | 43 | const CallSite& callsite, SymbolTable* symbols, |
| 44 | bool auto_namespace); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 45 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 46 | // Performs name mangling and looks up the resource in the symbol table. If the symbol is not |
| 47 | // visible by the reference at the callsite, nullptr is returned. |
| 48 | // `out_error` holds the error message. |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 49 | static const SymbolTable::Symbol* ResolveSymbolCheckVisibility(const Reference& reference, |
Adam Lesinski | f34b6f4 | 2017-03-03 16:33:26 -0800 | [diff] [blame] | 50 | const CallSite& callsite, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 51 | SymbolTable* symbols, |
Chris Warrington | 481f027 | 2018-02-06 14:03:39 +0000 | [diff] [blame] | 52 | bool auto_namespace, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 53 | std::string* out_error); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 54 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 55 | // Same as ResolveSymbolCheckVisibility(), but also makes sure the symbol is an attribute. |
| 56 | // That is, the return value will have a non-null value for ISymbolTable::Symbol::attribute. |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 57 | static const SymbolTable::Symbol* ResolveAttributeCheckVisibility(const Reference& reference, |
Adam Lesinski | f34b6f4 | 2017-03-03 16:33:26 -0800 | [diff] [blame] | 58 | const CallSite& callsite, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 59 | SymbolTable* symbols, |
Chris Warrington | 481f027 | 2018-02-06 14:03:39 +0000 | [diff] [blame] | 60 | bool auto_namespace, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 61 | std::string* out_error); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 62 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 63 | // Resolves the attribute reference and returns an xml::AaptAttribute if successful. |
| 64 | // If resolution fails, outError holds the error message. |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 65 | static Maybe<xml::AaptAttribute> CompileXmlAttribute(const Reference& reference, |
Adam Lesinski | f34b6f4 | 2017-03-03 16:33:26 -0800 | [diff] [blame] | 66 | const CallSite& callsite, |
Chris Warrington | 481f027 | 2018-02-06 14:03:39 +0000 | [diff] [blame] | 67 | SymbolTable* symbols, bool auto_namespace, |
Adam Lesinski | ceb9b2f | 2017-02-16 12:05:42 -0800 | [diff] [blame] | 68 | std::string* out_error); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 69 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 70 | // Writes the resource name to the DiagMessage, using the |
| 71 | // "orig_name (aka <transformed_name>)" syntax. |
| 72 | static void WriteResourceName(const Reference& orig, const CallSite& callsite, |
| 73 | const xml::IPackageDeclStack* decls, DiagMessage* out_msg); |
Adam Lesinski | 28cacf0 | 2015-11-23 14:22:47 -0800 | [diff] [blame] | 74 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 75 | // Same as WriteResourceName but omits the 'attr' part. |
| 76 | static void WriteAttributeName(const Reference& ref, const CallSite& callsite, |
| 77 | const xml::IPackageDeclStack* decls, DiagMessage* out_msg); |
| 78 | |
| 79 | // Transforms the package name of the reference to the fully qualified package name using |
| 80 | // the xml::IPackageDeclStack, then mangles and looks up the symbol. If the symbol is visible |
| 81 | // to the reference at the callsite, the reference is updated with an ID. |
| 82 | // Returns false on failure, and an error message is logged to the IDiagnostics in the context. |
Adam Lesinski | f34b6f4 | 2017-03-03 16:33:26 -0800 | [diff] [blame] | 83 | static bool LinkReference(const CallSite& callsite, Reference* reference, IAaptContext* context, |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 84 | SymbolTable* symbols, const xml::IPackageDeclStack* decls); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 85 | |
Adam Lesinski | 1ef0fa9 | 2017-08-15 21:32:49 -0700 | [diff] [blame] | 86 | // Links all references in the ResourceTable. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 87 | bool Consume(IAaptContext* context, ResourceTable* table) override; |
| 88 | |
| 89 | private: |
| 90 | DISALLOW_COPY_AND_ASSIGN(ReferenceLinker); |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 91 | }; |
| 92 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 93 | } // namespace aapt |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 94 | |
| 95 | #endif /* AAPT_LINKER_REFERENCELINKER_H */ |