1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
|
/*
* Copyright (C) 2015 The Android Open Source Project
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef AAPT_RESOURCE_TABLE_H
#define AAPT_RESOURCE_TABLE_H
#include "ConfigDescription.h"
#include "Diagnostics.h"
#include "Resource.h"
#include "ResourceValues.h"
#include "Source.h"
#include "StringPool.h"
#include <memory>
#include <string>
#include <tuple>
#include <vector>
namespace aapt {
/**
* The Public status of a resource.
*/
struct Public {
bool isPublic = false;
Source source;
std::u16string comment;
};
/**
* The resource value for a specific configuration.
*/
struct ResourceConfigValue {
ConfigDescription config;
Source source;
std::u16string comment;
std::unique_ptr<Value> value;
};
/**
* Represents a resource entry, which may have
* varying values for each defined configuration.
*/
struct ResourceEntry {
/**
* The name of the resource. Immutable, as
* this determines the order of this resource
* when doing lookups.
*/
const std::u16string name;
/**
* The entry ID for this resource.
*/
Maybe<uint16_t> id;
/**
* Whether this resource is public (and must maintain the same
* entry ID across builds).
*/
Public publicStatus;
/**
* The resource's values for each configuration.
*/
std::vector<ResourceConfigValue> values;
ResourceEntry(const StringPiece16& name) : name(name.toString()) { }
};
/**
* Represents a resource type, which holds entries defined
* for this type.
*/
struct ResourceTableType {
/**
* The logical type of resource (string, drawable, layout, etc.).
*/
const ResourceType type;
/**
* The type ID for this resource.
*/
Maybe<uint8_t> id;
/**
* Whether this type is public (and must maintain the same
* type ID across builds).
*/
Public publicStatus;
/**
* List of resources for this type.
*/
std::vector<std::unique_ptr<ResourceEntry>> entries;
explicit ResourceTableType(const ResourceType type) : type(type) { }
ResourceEntry* findEntry(const StringPiece16& name);
ResourceEntry* findOrCreateEntry(const StringPiece16& name);
};
enum class PackageType {
System,
Vendor,
App,
Dynamic
};
struct ResourceTablePackage {
PackageType type = PackageType::App;
Maybe<uint8_t> id;
std::u16string name;
std::vector<std::unique_ptr<ResourceTableType>> types;
ResourceTableType* findType(ResourceType type);
ResourceTableType* findOrCreateType(const ResourceType type);
};
/**
* The container and index for all resources defined for an app. This gets
* flattened into a binary resource table (resources.arsc).
*/
class ResourceTable {
public:
ResourceTable() = default;
ResourceTable(const ResourceTable&) = delete;
ResourceTable& operator=(const ResourceTable&) = delete;
/**
* When a collision of resources occurs, this method decides which value to keep.
* Returns -1 if the existing value should be chosen.
* Returns 0 if the collision can not be resolved (error).
* Returns 1 if the incoming value should be chosen.
*/
static int resolveValueCollision(Value* existing, Value* incoming);
bool addResource(const ResourceNameRef& name, const ConfigDescription& config,
const Source& source, std::unique_ptr<Value> value,
IDiagnostics* diag);
bool addResource(const ResourceNameRef& name, const ResourceId resId,
const ConfigDescription& config, const Source& source,
std::unique_ptr<Value> value, IDiagnostics* diag);
bool addFileReference(const ResourceNameRef& name, const ConfigDescription& config,
const Source& source, const StringPiece16& path, IDiagnostics* diag);
/**
* Same as addResource, but doesn't verify the validity of the name. This is used
* when loading resources from an existing binary resource table that may have mangled
* names.
*/
bool addResourceAllowMangled(const ResourceNameRef& name, const ConfigDescription& config,
const Source& source, std::unique_ptr<Value> value,
IDiagnostics* diag);
bool markPublic(const ResourceNameRef& name, const ResourceId resId, const Source& source,
IDiagnostics* diag);
bool markPublicAllowMangled(const ResourceNameRef& name, const ResourceId resId,
const Source& source, IDiagnostics* diag);
struct SearchResult {
ResourceTablePackage* package;
ResourceTableType* type;
ResourceEntry* entry;
};
Maybe<SearchResult> findResource(const ResourceNameRef& name);
/**
* The string pool used by this resource table. Values that reference strings must use
* this pool to create their strings.
*
* NOTE: `stringPool` must come before `packages` so that it is destroyed after.
* When `string pool` references are destroyed (as they will be when `packages`
* is destroyed), they decrement a refCount, which would cause invalid
* memory access if the pool was already destroyed.
*/
StringPool stringPool;
/**
* The list of packages in this table, sorted alphabetically by package name.
*/
std::vector<std::unique_ptr<ResourceTablePackage>> packages;
/**
* Returns the package struct with the given name, or nullptr if such a package does not
* exist. The empty string is a valid package and typically is used to represent the
* 'current' package before it is known to the ResourceTable.
*/
ResourceTablePackage* findPackage(const StringPiece16& name);
ResourceTablePackage* findPackageById(uint8_t id);
ResourceTablePackage* createPackage(const StringPiece16& name, Maybe<uint8_t> id = {});
private:
ResourceTablePackage* findOrCreatePackage(const StringPiece16& name);
bool addResourceImpl(const ResourceNameRef& name, const ResourceId resId,
const ConfigDescription& config, const Source& source,
std::unique_ptr<Value> value, const char16_t* validChars,
IDiagnostics* diag);
bool markPublicImpl(const ResourceNameRef& name, const ResourceId resId,
const Source& source, const char16_t* validChars, IDiagnostics* diag);
};
} // namespace aapt
#endif // AAPT_RESOURCE_TABLE_H
|