BinaryResourceParser.h revision 24aad163bc88cb10d2275385e9afc3de7f342d65 
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_BINARY_RESOURCE_PARSER_H
18#define AAPT_BINARY_RESOURCE_PARSER_H
19
20#include "Resolver.h"
21#include "ResourceTable.h"
22#include "ResourceValues.h"
23#include "Source.h"
24
25#include <androidfw/ResourceTypes.h>
26#include <string>
27
28namespace aapt {
29
30struct SymbolTable_entry;
31
32/*
33 * Parses a binary resource table (resources.arsc) and adds the entries
34 * to a ResourceTable. This is different than the libandroidfw ResTable
35 * in that it scans the table from top to bottom and doesn't require
36 * support for random access. It is also able to parse non-runtime
37 * chunks and types.
38 */
39class BinaryResourceParser {
40public:
41    /*
42     * Creates a parser, which will read `len` bytes from `data`, and
43     * add any resources parsed to `table`. `source` is for logging purposes.
44     */
45    BinaryResourceParser(const std::shared_ptr<ResourceTable>& table,
46                         const std::shared_ptr<IResolver>& resolver,
47                         const Source& source,
48                         const void* data, size_t len);
49
50    BinaryResourceParser(const BinaryResourceParser&) = delete; // No copy.
51
52    /*
53     * Parses the binary resource table and returns true if successful.
54     */
55    bool parse();
56
57private:
58    // Helper method to retrieve the symbol name for a given table offset specified
59    // as a pointer.
60    bool getSymbol(const void* data, ResourceNameRef* outSymbol);
61
62    bool parseTable(const android::ResChunk_header* chunk);
63    bool parseSymbolTable(const android::ResChunk_header* chunk);
64
65    // Looks up the resource ID in the reference and converts it to a name if available.
66    bool idToName(Reference* reference);
67
68    bool parsePackage(const android::ResChunk_header* chunk);
69    bool parseTypeSpec(const android::ResChunk_header* chunk);
70    bool parseType(const android::ResChunk_header* chunk);
71
72    std::unique_ptr<Item> parseValue(const ResourceNameRef& name,
73            const ConfigDescription& config, const android::Res_value* value, uint16_t flags);
74
75    std::unique_ptr<Value> parseMapEntry(const ResourceNameRef& name,
76            const ConfigDescription& config, const android::ResTable_map_entry* map);
77
78    std::unique_ptr<Style> parseStyle(const ResourceNameRef& name,
79            const ConfigDescription& config, const android::ResTable_map_entry* map);
80
81    std::unique_ptr<Attribute> parseAttr(const ResourceNameRef& name,
82            const ConfigDescription& config, const android::ResTable_map_entry* map);
83
84    std::unique_ptr<Array> parseArray(const ResourceNameRef& name,
85            const ConfigDescription& config, const android::ResTable_map_entry* map);
86
87    std::unique_ptr<Plural> parsePlural(const ResourceNameRef& name,
88            const ConfigDescription& config, const android::ResTable_map_entry* map);
89
90    std::unique_ptr<Styleable> parseStyleable(const ResourceNameRef& name,
91            const ConfigDescription& config, const android::ResTable_map_entry* map);
92
93    std::shared_ptr<ResourceTable> mTable;
94
95    std::shared_ptr<IResolver> mResolver;
96
97    const Source mSource;
98
99    const void* mData;
100    const size_t mDataLen;
101
102    // The package name of the resource table.
103    std::u16string mPackage;
104
105    // The array of symbol entries. Each element points to an offset
106    // in the table and an index into the symbol table string pool.
107    const SymbolTable_entry* mSymbolEntries = nullptr;
108
109    // Number of symbol entries.
110    size_t mSymbolEntryCount = 0;
111
112    // The symbol table string pool. Holds the names of symbols
113    // referenced in this table but not defined nor resolved to an
114    // ID.
115    android::ResStringPool mSymbolPool;
116
117    // The source string pool. Resource entries may have an extra
118    // field that points into this string pool, which denotes where
119    // the resource was parsed from originally.
120    android::ResStringPool mSourcePool;
121
122    // The standard value string pool for resource values.
123    android::ResStringPool mValuePool;
124
125    // The string pool that holds the names of the types defined
126    // in this table.
127    android::ResStringPool mTypePool;
128
129    // The string pool that holds the names of the entries defined
130    // in this table.
131    android::ResStringPool mKeyPool;
132
133    // A mapping of resource ID to resource name. When we finish parsing
134    // we use this to convert all resource IDs to symbolic references.
135    std::map<ResourceId, ResourceName> mIdIndex;
136};
137
138} // namespace aapt
139
140namespace android {
141
142/**
143 * Iterator functionality for ResTable_map_entry.
144 */
145
146inline const ResTable_map* begin(const ResTable_map_entry* map) {
147    return reinterpret_cast<const ResTable_map*>(
148            reinterpret_cast<const uint8_t*>(map) + map->size);
149}
150
151inline const ResTable_map* end(const ResTable_map_entry* map) {
152    return reinterpret_cast<const ResTable_map*>(
153            reinterpret_cast<const uint8_t*>(map) + map->size) + map->count;
154}
155
156} // namespace android
157
158#endif // AAPT_BINARY_RESOURCE_PARSER_H
159