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 <regex>
21 #include <set>
22 #include <unordered_set>
23 
24 #include "AppInfo.h"
25 #include "SdkConstants.h"
26 #include "androidfw/IDiagnostics.h"
27 #include "androidfw/StringPiece.h"
28 #include "filter/ConfigFilter.h"
29 #include "process/IResourceTableConsumer.h"
30 #include "split/TableSplitter.h"
31 #include "xml/XmlDom.h"
32 
33 namespace aapt {
34 
35 // Parses a configuration density (ex. hdpi, xxhdpi, 234dpi, anydpi, etc).
36 // Returns Nothing and logs a human friendly error message if the string was not legal.
37 std::optional<uint16_t> ParseTargetDensityParameter(android::StringPiece arg,
38                                                     android::IDiagnostics* diag);
39 
40 // Parses a string of the form 'path/to/output.apk:<config>[,<config>...]' and fills in
41 // `out_path` with the path and `out_split` with the set of ConfigDescriptions.
42 // Returns false and logs a human friendly error message if the string was not legal.
43 bool ParseSplitParameter(android::StringPiece arg, android::IDiagnostics* diag,
44                          std::string* out_path, SplitConstraints* out_split);
45 
46 // Parses a set of config filter strings of the form 'en,fr-rFR' and returns an IConfigFilter.
47 // Returns nullptr and logs a human friendly error message if the string was not legal.
48 std::unique_ptr<IConfigFilter> ParseConfigFilterParameters(const std::vector<std::string>& args,
49                                                            android::IDiagnostics* diag);
50 
51 // Adjust the SplitConstraints so that their SDK version is stripped if it
52 // is less than or equal to the min_sdk. Otherwise the resources that have had
53 // their SDK version stripped due to min_sdk won't ever match.
54 std::vector<SplitConstraints> AdjustSplitConstraintsForMinSdk(
55     int min_sdk, const std::vector<SplitConstraints>& split_constraints);
56 
57 // Generates a split AndroidManifest.xml given the split constraints and app info. The resulting
58 // XmlResource does not need to be linked via XmlReferenceLinker.
59 // This will never fail/return nullptr.
60 std::unique_ptr<xml::XmlResource> GenerateSplitManifest(const AppInfo& app_info,
61                                                         const SplitConstraints& constraints);
62 
63 // Extracts relevant info from the AndroidManifest.xml.
64 std::optional<AppInfo> ExtractAppInfoFromBinaryManifest(const xml::XmlResource& xml_res,
65                                                         android::IDiagnostics* diag);
66 
67 // Returns a copy of 'name' which conforms to the regex '[a-zA-Z]+[a-zA-Z0-9_]*' by
68 // replacing nonconforming characters with underscores.
69 //
70 // See frameworks/base/core/java/android/content/pm/PackageParser.java which
71 // checks this at runtime.
72 std::string MakePackageSafeName(const std::string &name);
73 
74 // Sets the versionCode and versionCodeMajor attributes to the version code. Attempts to encode the
75 // version code using the versionCode attribute only, and encodes using both versionCode and
76 // versionCodeMajor if the version code requires more than 32 bits.
77 void SetLongVersionCode(xml::Element* manifest, uint64_t version_code);
78 
79 // Returns a case insensitive regular expression based on the input.
80 std::regex GetRegularExpression(const std::string &input);
81 
82 bool ParseResourceConfig(const std::string& content, IAaptContext* context,
83                          std::unordered_set<ResourceName>& out_resource_exclude_list,
84                          std::set<ResourceName>& out_name_collapse_exemptions,
85                          std::set<ResourceName>& out_path_shorten_exemptions);
86 
87 }  // namespace aapt
88 
89 #endif /* AAPT_SPLIT_UTIL_H */
90