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_PROGUARD_RULES_H
18 #define AAPT_PROGUARD_RULES_H
19 
20 #include <map>
21 #include <ostream>
22 #include <set>
23 #include <string>
24 
25 #include "androidfw/StringPiece.h"
26 
27 #include "Resource.h"
28 #include "ResourceTable.h"
29 #include "Source.h"
30 #include "ValueVisitor.h"
31 #include "io/Io.h"
32 #include "process/IResourceTableConsumer.h"
33 #include "xml/XmlDom.h"
34 
35 namespace aapt {
36 namespace proguard {
37 
38 struct UsageLocation {
39   ResourceName name;
40   Source source;
41 };
42 
43 struct NameAndSignature {
44   std::string name;
45   std::string signature;
46 };
47 
48 class KeepSet {
49  public:
50   KeepSet() = default;
51 
KeepSet(bool conditional_keep_rules)52   explicit KeepSet(bool conditional_keep_rules) : conditional_keep_rules_(conditional_keep_rules) {
53   }
54 
AddManifestClass(const UsageLocation & file,const std::string & class_name)55   inline void AddManifestClass(const UsageLocation& file, const std::string& class_name) {
56     manifest_class_set_[class_name].insert(file);
57   }
58 
AddConditionalClass(const UsageLocation & file,const NameAndSignature & class_and_signature)59   inline void AddConditionalClass(const UsageLocation& file,
60                                   const NameAndSignature& class_and_signature) {
61     conditional_class_set_[class_and_signature].insert(file);
62   }
63 
AddMethod(const UsageLocation & file,const NameAndSignature & name_and_signature)64   inline void AddMethod(const UsageLocation& file, const NameAndSignature& name_and_signature) {
65     method_set_[name_and_signature].insert(file);
66   }
67 
AddReference(const UsageLocation & file,const ResourceName & resource_name)68   inline void AddReference(const UsageLocation& file, const ResourceName& resource_name) {
69     reference_set_[resource_name].insert(file);
70   }
71 
72  private:
73   friend void WriteKeepSet(const KeepSet& keep_set, io::OutputStream* out, bool minimal_keep);
74 
75   friend bool CollectLocations(const UsageLocation& location, const KeepSet& keep_set,
76                                std::set<UsageLocation>* locations);
77 
78   bool conditional_keep_rules_ = false;
79   std::map<std::string, std::set<UsageLocation>> manifest_class_set_;
80   std::map<NameAndSignature, std::set<UsageLocation>> method_set_;
81   std::map<NameAndSignature, std::set<UsageLocation>> conditional_class_set_;
82   std::map<ResourceName, std::set<UsageLocation>> reference_set_;
83 };
84 
85 bool CollectProguardRulesForManifest(xml::XmlResource* res, KeepSet* keep_set,
86                                      bool main_dex_only = false);
87 
88 bool CollectProguardRules(IAaptContext* context, xml::XmlResource* res, KeepSet* keep_set);
89 
90 bool CollectResourceReferences(IAaptContext* context, ResourceTable* table, KeepSet* keep_set);
91 
92 void WriteKeepSet(const KeepSet& keep_set, io::OutputStream* out, bool minimal_keep);
93 
94 bool CollectLocations(const UsageLocation& location, const KeepSet& keep_set,
95                       std::set<UsageLocation>* locations);
96 
97 //
98 // UsageLocation implementation.
99 //
100 
101 inline bool operator==(const UsageLocation& lhs, const UsageLocation& rhs) {
102   // The "source" member is ignored because we only need "name" for outputting
103   // keep rules; "source" is used for comments.
104   return lhs.name == rhs.name;
105 }
106 
107 inline bool operator<(const UsageLocation& lhs, const UsageLocation& rhs) {
108   return lhs.name.compare(rhs.name) < 0;
109 }
110 
111 //
112 // NameAndSignature implementation.
113 //
114 
115 inline bool operator<(const NameAndSignature& lhs, const NameAndSignature& rhs) {
116   if (lhs.name < rhs.name) {
117     return true;
118   }
119   if (lhs.name == rhs.name) {
120     return lhs.signature < rhs.signature;
121   }
122   return false;
123 }
124 
125 }  // namespace proguard
126 }  // namespace aapt
127 
128 #endif  // AAPT_PROGUARD_RULES_H
129