1 /* 2 * Copyright (C) 2017 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_SPLIT_UTIL_H 18 #define AAPT_SPLIT_UTIL_H 19 20 #include <functional> 21 #include <map> 22 #include <memory> 23 #include <optional> 24 #include <regex> 25 #include <set> 26 #include <string> 27 #include <unordered_set> 28 29 #include "AppInfo.h" 30 #include "SdkConstants.h" 31 #include "androidfw/IDiagnostics.h" 32 #include "androidfw/StringPiece.h" 33 #include "filter/ConfigFilter.h" 34 #include "process/IResourceTableConsumer.h" 35 #include "split/TableSplitter.h" 36 #include "xml/XmlDom.h" 37 38 namespace aapt { 39 40 struct FeatureFlagProperties { 41 bool read_only; 42 std::optional<bool> enabled; 43 FeatureFlagPropertiesFeatureFlagProperties44 FeatureFlagProperties(bool ro, std::optional<bool> e) : read_only(ro), enabled(e) { 45 } 46 47 bool operator==(const FeatureFlagProperties&) const = default; 48 }; 49 50 using FeatureFlagValues = std::map<std::string, FeatureFlagProperties, std::less<>>; 51 52 std::optional<FeatureFlagAttribute> ParseFlag(std::optional<std::string_view> flag_text); 53 54 std::optional<FlagStatus> GetFlagStatus(const std::optional<FeatureFlagAttribute>& flag, 55 const FeatureFlagValues& feature_flag_values, 56 std::string* out_err); 57 58 // Parses a configuration density (ex. hdpi, xxhdpi, 234dpi, anydpi, etc). 59 // Returns Nothing and logs a human friendly error message if the string was not legal. 60 std::optional<uint16_t> ParseTargetDensityParameter(android::StringPiece arg, 61 android::IDiagnostics* diag); 62 63 // Parses a string of the form 'path/to/output.apk:<config>[,<config>...]' and fills in 64 // `out_path` with the path and `out_split` with the set of ConfigDescriptions. 65 // Returns false and logs a human friendly error message if the string was not legal. 66 bool ParseSplitParameter(android::StringPiece arg, android::IDiagnostics* diag, 67 std::string* out_path, SplitConstraints* out_split); 68 69 // Parses a set of config filter strings of the form 'en,fr-rFR' and returns an IConfigFilter. 70 // Returns nullptr and logs a human friendly error message if the string was not legal. 71 std::unique_ptr<IConfigFilter> ParseConfigFilterParameters(const std::vector<std::string>& args, 72 android::IDiagnostics* diag); 73 74 // Parses a feature flags parameter, which can contain one or more pairs of flag names and optional 75 // values, and fills in `out_feature_flag_values` with the parsed values. The pairs in the argument 76 // are separated by ',' and the name is separated from the value by '=' if there is a value given. 77 // Example arg: "flag1=true,flag2=false,flag3=,flag4" where flag3 and flag4 have no given value. 78 bool ParseFeatureFlagsParameter(android::StringPiece arg, android::IDiagnostics* diag, 79 FeatureFlagValues* out_feature_flag_values); 80 81 // Adjust the SplitConstraints so that their SDK version is stripped if it 82 // is less than or equal to the min_sdk. Otherwise the resources that have had 83 // their SDK version stripped due to min_sdk won't ever match. 84 std::vector<SplitConstraints> AdjustSplitConstraintsForMinSdk( 85 int min_sdk, const std::vector<SplitConstraints>& split_constraints); 86 87 // Generates a split AndroidManifest.xml given the split constraints and app info. The resulting 88 // XmlResource does not need to be linked via XmlReferenceLinker. 89 // This will never fail/return nullptr. 90 std::unique_ptr<xml::XmlResource> GenerateSplitManifest(const AppInfo& app_info, 91 const SplitConstraints& constraints); 92 93 // Extracts relevant info from the AndroidManifest.xml. 94 std::optional<AppInfo> ExtractAppInfoFromBinaryManifest(const xml::XmlResource& xml_res, 95 android::IDiagnostics* diag); 96 97 // Returns a copy of 'name' which conforms to the regex '[a-zA-Z]+[a-zA-Z0-9_]*' by 98 // replacing nonconforming characters with underscores. 99 // 100 // See frameworks/base/core/java/android/content/pm/PackageParser.java which 101 // checks this at runtime. 102 std::string MakePackageSafeName(const std::string &name); 103 104 // Sets the versionCode and versionCodeMajor attributes to the version code. Attempts to encode the 105 // version code using the versionCode attribute only, and encodes using both versionCode and 106 // versionCodeMajor if the version code requires more than 32 bits. 107 void SetLongVersionCode(xml::Element* manifest, uint64_t version_code); 108 109 // Returns a case insensitive regular expression based on the input. 110 std::regex GetRegularExpression(const std::string &input); 111 112 bool ParseResourceConfig(const std::string& content, IAaptContext* context, 113 std::unordered_set<ResourceName>& out_resource_exclude_list, 114 std::set<ResourceName>& out_name_collapse_exemptions, 115 std::set<ResourceName>& out_path_shorten_exemptions); 116 117 } // namespace aapt 118 119 #endif /* AAPT_SPLIT_UTIL_H */ 120