Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -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_LINK_MANIFESTFIXER_H |
| 18 | #define AAPT_LINK_MANIFESTFIXER_H |
| 19 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 20 | #include <string> |
| 21 | |
| 22 | #include "android-base/macros.h" |
| 23 | |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 24 | #include "process/IResourceTableConsumer.h" |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 25 | #include "util/Maybe.h" |
Adam Lesinski | cc5609d | 2016-04-05 12:41:07 -0700 | [diff] [blame] | 26 | #include "xml/XmlActionExecutor.h" |
Adam Lesinski | 467f171 | 2015-11-16 17:35:44 -0800 | [diff] [blame] | 27 | #include "xml/XmlDom.h" |
| 28 | |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 29 | namespace aapt { |
| 30 | |
| 31 | struct ManifestFixerOptions { |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 32 | // The minimum SDK version to set if no 'android:minSdkVersion' is defined in a <uses-sdk> tag. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 33 | Maybe<std::string> min_sdk_version_default; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 34 | |
| 35 | // The target SDK version to set if no 'android:targetSdkVersion' is defined in a <uses-sdk> tag. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 36 | Maybe<std::string> target_sdk_version_default; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 37 | |
| 38 | // The Android package to use instead of the one defined in 'package' in <manifest>. |
| 39 | // This also renames all relative package/class names in the manifest to fully qualified |
| 40 | // Java names. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 41 | Maybe<std::string> rename_manifest_package; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 42 | |
| 43 | // The Android package to use instead of the one defined in 'android:targetPackage' in |
| 44 | // <instrumentation>. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 45 | Maybe<std::string> rename_instrumentation_target_package; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 46 | |
Colin Cross | da02fea | 2018-05-25 22:46:35 -0700 | [diff] [blame^] | 47 | // The version name to set if 'android:versionName' is not defined in <manifest> or if |
| 48 | // replace_version is set. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 49 | Maybe<std::string> version_name_default; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 50 | |
Colin Cross | da02fea | 2018-05-25 22:46:35 -0700 | [diff] [blame^] | 51 | // The version code to set if 'android:versionCode' is not defined in <manifest> or if |
| 52 | // replace_version is set. |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 53 | Maybe<std::string> version_code_default; |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 54 | |
| 55 | // The version of the framework being compiled against to set for 'android:compileSdkVersion' in |
| 56 | // the <manifest> tag. |
| 57 | Maybe<std::string> compile_sdk_version; |
| 58 | |
| 59 | // The version codename of the framework being compiled against to set for |
| 60 | // 'android:compileSdkVersionCodename' in the <manifest> tag. |
| 61 | Maybe<std::string> compile_sdk_version_codename; |
Izabela Orlowska | ad9e132 | 2017-12-19 16:22:42 +0000 | [diff] [blame] | 62 | |
Ryan Mitchell | e5b38a6 | 2018-03-23 13:35:00 -0700 | [diff] [blame] | 63 | // Whether validation errors should be treated only as warnings. If this is 'true', then an |
Izabela Orlowska | ad9e132 | 2017-12-19 16:22:42 +0000 | [diff] [blame] | 64 | // incorrect node will not result in an error, but only as a warning, and the parsing will |
| 65 | // continue. |
| 66 | bool warn_validation = false; |
Ryan Mitchell | e5b38a6 | 2018-03-23 13:35:00 -0700 | [diff] [blame] | 67 | |
| 68 | // Whether to inject the android:debuggable="true" flag into the manifest |
| 69 | bool debug_mode = false; |
Colin Cross | da02fea | 2018-05-25 22:46:35 -0700 | [diff] [blame^] | 70 | |
| 71 | // Whether to replace the manifest version with the the command line version |
| 72 | bool replace_version = false; |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 73 | }; |
| 74 | |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 75 | // Verifies that the manifest is correctly formed and inserts defaults where specified with |
| 76 | // ManifestFixerOptions. |
Adam Lesinski | cc5609d | 2016-04-05 12:41:07 -0700 | [diff] [blame] | 77 | class ManifestFixer : public IXmlResourceConsumer { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 78 | public: |
Adam Lesinski | c628437 | 2017-12-04 13:46:23 -0800 | [diff] [blame] | 79 | explicit ManifestFixer(const ManifestFixerOptions& options) : options_(options) { |
| 80 | } |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 81 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 82 | bool Consume(IAaptContext* context, xml::XmlResource* doc) override; |
Adam Lesinski | cc5609d | 2016-04-05 12:41:07 -0700 | [diff] [blame] | 83 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 84 | private: |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 85 | DISALLOW_COPY_AND_ASSIGN(ManifestFixer); |
Adam Lesinski | cc5609d | 2016-04-05 12:41:07 -0700 | [diff] [blame] | 86 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 87 | bool BuildRules(xml::XmlActionExecutor* executor, IDiagnostics* diag); |
| 88 | |
| 89 | ManifestFixerOptions options_; |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 90 | }; |
| 91 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 92 | } // namespace aapt |
Adam Lesinski | 2ae4a87 | 2015-11-02 16:10:55 -0800 | [diff] [blame] | 93 | |
| 94 | #endif /* AAPT_LINK_MANIFESTFIXER_H */ |