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
|
/*
* 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_LINKER_H
#define AAPT_LINKER_H
#include "Resolver.h"
#include "ResourceTable.h"
#include "ResourceValues.h"
#include "Source.h"
#include "StringPiece.h"
#include <androidfw/AssetManager.h>
#include <map>
#include <memory>
#include <ostream>
#include <set>
#include <vector>
namespace aapt {
/**
* The Linker has two jobs. It follows resource references
* and verifies that their targert exists and that their
* types are compatible. The Linker will also assign resource
* IDs and fill in all the dependent references with the newly
* assigned resource IDs.
*
* To do this, the Linker builds a graph of references. This
* can be useful to do other analysis, like building a
* dependency graph of source files. The hope is to be able to
* add functionality that operates on the graph without
* overcomplicating the Linker.
*
* TODO(adamlesinski): Build the graph first then run the separate
* steps over the graph.
*/
class Linker : ValueVisitor {
public:
struct Options {
/**
* Assign resource Ids to references when linking.
* When building a static library, set this to false.
*/
bool linkResourceIds = true;
};
/**
* Create a Linker for the given resource table with the sources available in
* IResolver. IResolver should contain the ResourceTable as a source too.
*/
Linker(const std::shared_ptr<ResourceTable>& table,
const std::shared_ptr<IResolver>& resolver, const Options& options);
Linker(const Linker&) = delete;
virtual ~Linker() = default;
/**
* Entry point to the linker. Assigns resource IDs, follows references,
* and validates types. Returns true if all references to defined values
* are type-compatible. Missing resource references are recorded but do
* not cause this method to fail.
*/
bool linkAndValidate();
/**
* Returns any references to resources that were not defined in any of the
* sources.
*/
using ResourceNameToSourceMap = std::map<ResourceName, std::vector<SourceLine>>;
const ResourceNameToSourceMap& getUnresolvedReferences() const;
protected:
virtual void doResolveReference(Reference& reference, const SourceLine& source);
virtual const Attribute* doResolveAttribute(Reference& attribute, const SourceLine& source);
std::shared_ptr<IResolver> mResolver;
private:
struct Args : public ValueVisitorArgs {
Args(const ResourceNameRef& r, const SourceLine& s);
const ResourceNameRef& referrer;
const SourceLine& source;
};
//
// Overrides of ValueVisitor
//
void visit(Reference& reference, ValueVisitorArgs& args) override;
void visit(Attribute& attribute, ValueVisitorArgs& args) override;
void visit(Styleable& styleable, ValueVisitorArgs& args) override;
void visit(Style& style, ValueVisitorArgs& args) override;
void visit(Array& array, ValueVisitorArgs& args) override;
void visit(Plural& plural, ValueVisitorArgs& args) override;
void processAttributeValue(const ResourceNameRef& name, const SourceLine& source,
const Attribute& attr, std::unique_ptr<Item>& value);
void addUnresolvedSymbol(const ResourceNameRef& name, const SourceLine& source);
std::shared_ptr<ResourceTable> mTable;
std::map<ResourceName, std::vector<SourceLine>> mUnresolvedSymbols;
Options mOptions;
bool mError;
};
} // namespace aapt
#endif // AAPT_LINKER_H
|
