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