blob: a01b64d024d213a74042af1016c98bf9cd02093d [file] [log] [blame]
Adam Lesinskia1ad4a82015-06-08 11:41:09 -07001/*
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_PROGUARD_RULES_H
18#define AAPT_PROGUARD_RULES_H
19
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070020#include <map>
21#include <ostream>
22#include <set>
23#include <string>
24
Adam Lesinskia693c4a2017-11-09 11:29:39 -080025#include "androidfw/StringPiece.h"
26
Adam Lesinskice5e56e2016-10-21 17:56:45 -070027#include "Resource.h"
Adam Koskidc21dea2017-07-21 10:55:27 -070028#include "ResourceTable.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070029#include "Source.h"
Adam Koskidc21dea2017-07-21 10:55:27 -070030#include "ValueVisitor.h"
Adam Lesinskia693c4a2017-11-09 11:29:39 -080031#include "io/Io.h"
Adam Koskidc21dea2017-07-21 10:55:27 -070032#include "process/IResourceTableConsumer.h"
Adam Lesinskice5e56e2016-10-21 17:56:45 -070033#include "xml/XmlDom.h"
34
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070035namespace aapt {
36namespace proguard {
37
Adam Koskidc21dea2017-07-21 10:55:27 -070038struct UsageLocation {
39 ResourceName name;
40 Source source;
41};
42
Jake Wharton3001f032018-06-11 12:24:11 -040043struct NameAndSignature {
44 std::string name;
45 std::string signature;
46};
47
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070048class KeepSet {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070049 public:
Adam Koskidc21dea2017-07-21 10:55:27 -070050 KeepSet() = default;
51
Chih-Hung Hsieh1fc78e12018-12-20 13:37:44 -080052 explicit KeepSet(bool conditional_keep_rules) : conditional_keep_rules_(conditional_keep_rules) {
Adam Lesinskicacb28f2016-10-19 12:18:14 -070053 }
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070054
Adam Koskidc21dea2017-07-21 10:55:27 -070055 inline void AddManifestClass(const UsageLocation& file, const std::string& class_name) {
56 manifest_class_set_[class_name].insert(file);
57 }
58
Jake Wharton98100c32018-06-11 15:46:03 -040059 inline void AddConditionalClass(const UsageLocation& file,
60 const NameAndSignature& class_and_signature) {
61 conditional_class_set_[class_and_signature].insert(file);
Adam Koskidc21dea2017-07-21 10:55:27 -070062 }
63
Jake Wharton3001f032018-06-11 12:24:11 -040064 inline void AddMethod(const UsageLocation& file, const NameAndSignature& name_and_signature) {
65 method_set_[name_and_signature].insert(file);
Adam Koskidc21dea2017-07-21 10:55:27 -070066 }
67
68 inline void AddReference(const UsageLocation& file, const ResourceName& resource_name) {
69 reference_set_[resource_name].insert(file);
Adam Lesinskicacb28f2016-10-19 12:18:14 -070070 }
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070071
Adam Lesinskicacb28f2016-10-19 12:18:14 -070072 private:
Jean-Luc Coelho181cbfd2019-11-27 12:37:48 -080073 friend void WriteKeepSet(const KeepSet& keep_set, io::OutputStream* out, bool minimal_keep,
74 bool no_location_reference);
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070075
Adam Koskidc21dea2017-07-21 10:55:27 -070076 friend bool CollectLocations(const UsageLocation& location, const KeepSet& keep_set,
77 std::set<UsageLocation>* locations);
78
79 bool conditional_keep_rules_ = false;
80 std::map<std::string, std::set<UsageLocation>> manifest_class_set_;
Jake Wharton3001f032018-06-11 12:24:11 -040081 std::map<NameAndSignature, std::set<UsageLocation>> method_set_;
Jake Wharton98100c32018-06-11 15:46:03 -040082 std::map<NameAndSignature, std::set<UsageLocation>> conditional_class_set_;
Adam Koskidc21dea2017-07-21 10:55:27 -070083 std::map<ResourceName, std::set<UsageLocation>> reference_set_;
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070084};
85
Adam Koskidc21dea2017-07-21 10:55:27 -070086bool CollectProguardRulesForManifest(xml::XmlResource* res, KeepSet* keep_set,
Adam Lesinskice5e56e2016-10-21 17:56:45 -070087 bool main_dex_only = false);
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070088
Ryan Mitchell9a2f6e62018-05-23 14:23:18 -070089bool CollectProguardRules(IAaptContext* context, xml::XmlResource* res, KeepSet* keep_set);
Adam Lesinskia693c4a2017-11-09 11:29:39 -080090
91bool CollectResourceReferences(IAaptContext* context, ResourceTable* table, KeepSet* keep_set);
92
Jean-Luc Coelho181cbfd2019-11-27 12:37:48 -080093void WriteKeepSet(const KeepSet& keep_set, io::OutputStream* out, bool minimal_keep,
94 bool no_location_reference);
Adam Lesinskia1ad4a82015-06-08 11:41:09 -070095
Adam Koskidc21dea2017-07-21 10:55:27 -070096bool CollectLocations(const UsageLocation& location, const KeepSet& keep_set,
97 std::set<UsageLocation>* locations);
98
99//
100// UsageLocation implementation.
101//
102
103inline bool operator==(const UsageLocation& lhs, const UsageLocation& rhs) {
Donald Chai44fa3422019-05-31 22:13:00 -0700104 // The "source" member is ignored because we only need "name" for outputting
105 // keep rules; "source" is used for comments.
Adam Koskidc21dea2017-07-21 10:55:27 -0700106 return lhs.name == rhs.name;
107}
108
Donald Chai44fa3422019-05-31 22:13:00 -0700109inline bool operator<(const UsageLocation& lhs, const UsageLocation& rhs) {
110 return lhs.name.compare(rhs.name) < 0;
Adam Koskidc21dea2017-07-21 10:55:27 -0700111}
112
Jake Wharton3001f032018-06-11 12:24:11 -0400113//
114// NameAndSignature implementation.
115//
116
117inline bool operator<(const NameAndSignature& lhs, const NameAndSignature& rhs) {
118 if (lhs.name < rhs.name) {
119 return true;
120 }
121 if (lhs.name == rhs.name) {
122 return lhs.signature < rhs.signature;
123 }
124 return false;
125}
126
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700127} // namespace proguard
128} // namespace aapt
Adam Lesinskia1ad4a82015-06-08 11:41:09 -0700129
Adam Lesinskicacb28f2016-10-19 12:18:14 -0700130#endif // AAPT_PROGUARD_RULES_H