AAPT2: Separate out the various steps
An early refactor. Some ideas became clearer as
development continued. Now the various phases are much
clearer and more easily reusable.
Also added a ton of tests!
Change-Id: Ic8f0a70c8222370352e63533b329c40457c0903e
diff --git a/tools/aapt2/ResourceValues.h b/tools/aapt2/ResourceValues.h
index ef6594e..0dae091 100644
--- a/tools/aapt2/ResourceValues.h
+++ b/tools/aapt2/ResourceValues.h
@@ -17,6 +17,7 @@
#ifndef AAPT_RESOURCE_VALUES_H
#define AAPT_RESOURCE_VALUES_H
+#include "util/Maybe.h"
#include "Resource.h"
#include "StringPool.h"
@@ -27,9 +28,7 @@
namespace aapt {
-struct ValueVisitor;
-struct ConstValueVisitor;
-struct ValueVisitorArgs;
+struct RawValueVisitor;
/**
* A resource value. This is an all-encompassing representation
@@ -39,13 +38,15 @@
* but it is the simplest strategy.
*/
struct Value {
+ virtual ~Value() = default;
+
/**
* Whether or not this is an Item.
*/
virtual bool isItem() const;
/**
- * Whether this value is weak and can be overriden without
+ * Whether this value is weak and can be overridden without
* warning or error. Default for base class is false.
*/
virtual bool isWeak() const;
@@ -53,12 +54,7 @@
/**
* Calls the appropriate overload of ValueVisitor.
*/
- virtual void accept(ValueVisitor& visitor, ValueVisitorArgs&& args) = 0;
-
- /**
- * Const version of accept().
- */
- virtual void accept(ConstValueVisitor& visitor, ValueVisitorArgs&& args) const = 0;
+ virtual void accept(RawValueVisitor* visitor) = 0;
/**
* Clone the value.
@@ -68,7 +64,7 @@
/**
* Human readable printout of this value.
*/
- virtual void print(std::ostream& out) const = 0;
+ virtual void print(std::ostream* out) const = 0;
};
/**
@@ -76,8 +72,7 @@
*/
template <typename Derived>
struct BaseValue : public Value {
- virtual void accept(ValueVisitor& visitor, ValueVisitorArgs&& args) override;
- virtual void accept(ConstValueVisitor& visitor, ValueVisitorArgs&& args) const override;
+ void accept(RawValueVisitor* visitor) override;
};
/**
@@ -96,9 +91,9 @@
/**
* Fills in an android::Res_value structure with this Item's binary representation.
- * Returns false if an error ocurred.
+ * Returns false if an error occurred.
*/
- virtual bool flatten(android::Res_value& outValue) const = 0;
+ virtual bool flatten(android::Res_value* outValue) const = 0;
};
/**
@@ -106,8 +101,7 @@
*/
template <typename Derived>
struct BaseItem : public Item {
- virtual void accept(ValueVisitor& visitor, ValueVisitorArgs&& args) override;
- virtual void accept(ConstValueVisitor& visitor, ValueVisitorArgs&& args) const override;
+ void accept(RawValueVisitor* visitor) override;
};
/**
@@ -122,8 +116,8 @@
kAttribute,
};
- ResourceName name;
- ResourceId id;
+ Maybe<ResourceName> name;
+ Maybe<ResourceId> id;
Reference::Type referenceType;
bool privateReference = false;
@@ -131,9 +125,9 @@
Reference(const ResourceNameRef& n, Type type = Type::kResource);
Reference(const ResourceId& i, Type type = Type::kResource);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
Reference* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
/**
@@ -141,9 +135,9 @@
*/
struct Id : public BaseItem<Id> {
bool isWeak() const override;
- bool flatten(android::Res_value& out) const override;
+ bool flatten(android::Res_value* out) const override;
Id* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
/**
@@ -156,9 +150,9 @@
RawString(const StringPool::Ref& ref);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
RawString* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct String : public BaseItem<String> {
@@ -166,9 +160,9 @@
String(const StringPool::Ref& ref);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
String* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct StyledString : public BaseItem<StyledString> {
@@ -176,9 +170,9 @@
StyledString(const StringPool::StyleRef& ref);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
StyledString* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct FileReference : public BaseItem<FileReference> {
@@ -187,9 +181,9 @@
FileReference() = default;
FileReference(const StringPool::Ref& path);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
FileReference* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
/**
@@ -200,10 +194,11 @@
BinaryPrimitive() = default;
BinaryPrimitive(const android::Res_value& val);
+ BinaryPrimitive(uint8_t dataType, uint32_t data);
- bool flatten(android::Res_value& outValue) const override;
+ bool flatten(android::Res_value* outValue) const override;
BinaryPrimitive* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct Attribute : public BaseValue<Attribute> {
@@ -212,7 +207,7 @@
uint32_t value;
};
- bool weak;
+ bool weak;
uint32_t typeMask;
uint32_t minInt;
uint32_t maxInt;
@@ -221,9 +216,9 @@
Attribute(bool w, uint32_t t = 0u);
bool isWeak() const override;
- virtual Attribute* clone(StringPool* newPool) const override;
- void printMask(std::ostream& out) const;
- virtual void print(std::ostream& out) const override;
+ Attribute* clone(StringPool* newPool) const override;
+ void printMask(std::ostream* out) const;
+ void print(std::ostream* out) const override;
};
struct Style : public BaseValue<Style> {
@@ -232,7 +227,7 @@
std::unique_ptr<Item> value;
};
- Reference parent;
+ Maybe<Reference> parent;
/**
* If set to true, the parent was auto inferred from the
@@ -243,14 +238,14 @@
std::vector<Entry> entries;
Style* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct Array : public BaseValue<Array> {
std::vector<std::unique_ptr<Item>> items;
Array* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct Plural : public BaseValue<Plural> {
@@ -267,180 +262,31 @@
std::array<std::unique_ptr<Item>, Count> values;
Plural* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
struct Styleable : public BaseValue<Styleable> {
std::vector<Reference> entries;
Styleable* clone(StringPool* newPool) const override;
- void print(std::ostream& out) const override;
+ void print(std::ostream* out) const override;
};
/**
* Stream operator for printing Value objects.
*/
inline ::std::ostream& operator<<(::std::ostream& out, const Value& value) {
- value.print(out);
+ value.print(&out);
return out;
}
inline ::std::ostream& operator<<(::std::ostream& out, const Attribute::Symbol& s) {
- return out << s.symbol.name.entry << "=" << s.value;
-}
-
-/**
- * The argument object that gets passed through the value
- * back to the ValueVisitor. Subclasses of ValueVisitor should
- * subclass ValueVisitorArgs to contain the data they need
- * to operate.
- */
-struct ValueVisitorArgs {};
-
-/**
- * Visits a value and runs the appropriate method based on its type.
- */
-struct ValueVisitor {
- virtual void visit(Reference& reference, ValueVisitorArgs& args) {
- visitItem(reference, args);
+ if (s.symbol.name) {
+ out << s.symbol.name.value().entry;
+ } else {
+ out << "???";
}
-
- virtual void visit(RawString& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(String& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(StyledString& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(FileReference& file, ValueVisitorArgs& args) {
- visitItem(file, args);
- }
-
- virtual void visit(Id& id, ValueVisitorArgs& args) {
- visitItem(id, args);
- }
-
- virtual void visit(BinaryPrimitive& primitive, ValueVisitorArgs& args) {
- visitItem(primitive, args);
- }
-
- virtual void visit(Attribute& attr, ValueVisitorArgs& args) {}
- virtual void visit(Style& style, ValueVisitorArgs& args) {}
- virtual void visit(Array& array, ValueVisitorArgs& args) {}
- virtual void visit(Plural& array, ValueVisitorArgs& args) {}
- virtual void visit(Styleable& styleable, ValueVisitorArgs& args) {}
-
- virtual void visitItem(Item& item, ValueVisitorArgs& args) {}
-};
-
-/**
- * Const version of ValueVisitor.
- */
-struct ConstValueVisitor {
- virtual void visit(const Reference& reference, ValueVisitorArgs& args) {
- visitItem(reference, args);
- }
-
- virtual void visit(const RawString& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(const String& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(const StyledString& string, ValueVisitorArgs& args) {
- visitItem(string, args);
- }
-
- virtual void visit(const FileReference& file, ValueVisitorArgs& args) {
- visitItem(file, args);
- }
-
- virtual void visit(const Id& id, ValueVisitorArgs& args) {
- visitItem(id, args);
- }
-
- virtual void visit(const BinaryPrimitive& primitive, ValueVisitorArgs& args) {
- visitItem(primitive, args);
- }
-
- virtual void visit(const Attribute& attr, ValueVisitorArgs& args) {}
- virtual void visit(const Style& style, ValueVisitorArgs& args) {}
- virtual void visit(const Array& array, ValueVisitorArgs& args) {}
- virtual void visit(const Plural& array, ValueVisitorArgs& args) {}
- virtual void visit(const Styleable& styleable, ValueVisitorArgs& args) {}
-
- virtual void visitItem(const Item& item, ValueVisitorArgs& args) {}
-};
-
-/**
- * Convenience Visitor that forwards a specific type to a function.
- * Args are not used as the function can bind variables. Do not use
- * directly, use the wrapper visitFunc() method.
- */
-template <typename T, typename TFunc>
-struct ValueVisitorFunc : ValueVisitor {
- TFunc func;
-
- ValueVisitorFunc(TFunc f) : func(f) {
- }
-
- void visit(T& value, ValueVisitorArgs&) override {
- func(value);
- }
-};
-
-/**
- * Const version of ValueVisitorFunc.
- */
-template <typename T, typename TFunc>
-struct ConstValueVisitorFunc : ConstValueVisitor {
- TFunc func;
-
- ConstValueVisitorFunc(TFunc f) : func(f) {
- }
-
- void visit(const T& value, ValueVisitorArgs&) override {
- func(value);
- }
-};
-
-template <typename T, typename TFunc>
-void visitFunc(Value& value, TFunc f) {
- ValueVisitorFunc<T, TFunc> visitor(f);
- value.accept(visitor, ValueVisitorArgs{});
-}
-
-template <typename T, typename TFunc>
-void visitFunc(const Value& value, TFunc f) {
- ConstValueVisitorFunc<T, TFunc> visitor(f);
- value.accept(visitor, ValueVisitorArgs{});
-}
-
-template <typename Derived>
-void BaseValue<Derived>::accept(ValueVisitor& visitor, ValueVisitorArgs&& args) {
- visitor.visit(static_cast<Derived&>(*this), args);
-}
-
-template <typename Derived>
-void BaseValue<Derived>::accept(ConstValueVisitor& visitor, ValueVisitorArgs&& args) const {
- visitor.visit(static_cast<const Derived&>(*this), args);
-}
-
-template <typename Derived>
-void BaseItem<Derived>::accept(ValueVisitor& visitor, ValueVisitorArgs&& args) {
- visitor.visit(static_cast<Derived&>(*this), args);
-}
-
-template <typename Derived>
-void BaseItem<Derived>::accept(ConstValueVisitor& visitor, ValueVisitorArgs&& args) const {
- visitor.visit(static_cast<const Derived&>(*this), args);
+ return out << "=" << s.value;
}
} // namespace aapt