Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 6cbfb1de authored by Adam Lesinski's avatar Adam Lesinski
Browse files

AAPT2: Change how we generate Java classes 

Previously we would be writing out the Manifest.java file as we
processed the AndroidManifest.xml. This would lead to empty
Manifest classes if there were no permissions or permission groups
defined in the AndroidManifest.xml.

This would pose problems for processes that checked for public classes
and considered them part of the API (support lib).

Now we collect the structure of the Java class in memory before deciding
if a file should be created.

Change-Id: I6b909f28d74356414c6ef5ad005180d6ea5e44ca
parent becc3019

tools/aapt2/Android.mk

+1 −0
Original line number Diff line number Diff line
@@ -54,6 +54,7 @@ sources := \ 
	Debug.cpp \

	Flags.cpp \

	java/AnnotationProcessor.cpp \

	java/ClassDefinition.cpp \

	java/JavaClassGenerator.cpp \

	java/ManifestClassGenerator.cpp \

	java/ProguardRules.cpp \

tools/aapt2/java/AnnotationProcessor.cpp

+1 −1
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ void AnnotationProcessor::appendNewLine() { 
    mComment << "\n *";

}



void AnnotationProcessor::writeToStream(std::ostream* out, const StringPiece& prefix) {

void AnnotationProcessor::writeToStream(std::ostream* out, const StringPiece& prefix) const {

    if (mHasComments) {

        std::string result = mComment.str();

        for (StringPiece line : util::tokenize<char>(result, '\n')) {

tools/aapt2/java/AnnotationProcessor.h

+1 −1
Original line number Diff line number Diff line
@@ -66,7 +66,7 @@ public: 
    /**

     * Writes the comments and annotations to the stream, with the given prefix before each line.

     */

    void writeToStream(std::ostream* out, const StringPiece& prefix);

    void writeToStream(std::ostream* out, const StringPiece& prefix) const;



private:

    enum : uint32_t {

tools/aapt2/java/ClassDefinition.cpp

0 → 100644
+75 −0
Original line number Diff line number Diff line 
/*

 * Copyright (C) 2016 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.

 */



#include "java/ClassDefinition.h"

#include "util/StringPiece.h"



#include <ostream>



namespace aapt {



bool ClassDefinition::empty() const {

    for (const std::unique_ptr<ClassMember>& member : mMembers) {

        if (!member->empty()) {

            return false;

        }

    }

    return true;

}



void ClassDefinition::writeToStream(const StringPiece& prefix, bool final,

                                    std::ostream* out) const {

    if (mMembers.empty() && !mCreateIfEmpty) {

        return;

    }



    ClassMember::writeToStream(prefix, final, out);



    *out << prefix << "public ";

    if (mQualifier == ClassQualifier::Static) {

        *out << "static ";

    }

    *out << "final class " << mName << " {\n";



    std::string newPrefix = prefix.toString();

    newPrefix.append(kIndent);



    for (const std::unique_ptr<ClassMember>& member : mMembers) {

        member->writeToStream(newPrefix, final, out);

        *out << "\n";

    }



    *out << prefix << "}";

}



constexpr static const char* sWarningHeader =

        "/* AUTO-GENERATED FILE. DO NOT MODIFY.\n"

        " *\n"

        " * This class was automatically generated by the\n"

        " * aapt tool from the resource data it found. It\n"

        " * should not be modified by hand.\n"

        " */\n\n";



bool ClassDefinition::writeJavaFile(const ClassDefinition* def,

                                    const StringPiece& package,

                                    bool final,

                                    std::ostream* out) {

    *out << sWarningHeader << "package " << package << ";\n\n";

    def->writeToStream("", final, out);

    return bool(*out);

}



} // namespace aapt

tools/aapt2/java/ClassDefinition.h

0 → 100644
+188 −0
Original line number Diff line number Diff line 
/*

 * 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_JAVA_CLASSDEFINITION_H

#define AAPT_JAVA_CLASSDEFINITION_H



#include "Resource.h"

#include "java/AnnotationProcessor.h"

#include "util/StringPiece.h"

#include "util/Util.h"



#include <android-base/macros.h>

#include <sstream>

#include <string>



namespace aapt {



// The number of attributes to emit per line in a Styleable array.

constexpr static size_t kAttribsPerLine = 4;

constexpr static const char* kIndent = "  ";



class ClassMember {

public:

    virtual ~ClassMember() = default;



    AnnotationProcessor* getCommentBuilder() {

        return &mProcessor;

    }



    virtual bool empty() const = 0;



    virtual void writeToStream(const StringPiece& prefix, bool final, std::ostream* out) const {

        mProcessor.writeToStream(out, prefix);

    }



private:

    AnnotationProcessor mProcessor;

};



template <typename T>

class PrimitiveMember : public ClassMember {

public:

    PrimitiveMember(const StringPiece& name, const T& val) :

            mName(name.toString()), mVal(val) {

    }



    bool empty() const override {

        return false;

    }



    void writeToStream(const StringPiece& prefix, bool final, std::ostream* out) const override {

        ClassMember::writeToStream(prefix, final, out);



        *out << prefix << "public static " << (final ? "final " : "")

             << "int " << mName << "=" << mVal << ";";

    }



private:

    std::string mName;

    T mVal;



    DISALLOW_COPY_AND_ASSIGN(PrimitiveMember);

};



/**

 * Specialization for strings so they get the right type and are quoted with "".

 */

template <>

class PrimitiveMember<std::string> : public ClassMember {

public:

    PrimitiveMember(const StringPiece& name, const std::string& val) :

            mName(name.toString()), mVal(val) {

    }



    bool empty() const override {

        return false;

    }



    void writeToStream(const StringPiece& prefix, bool final, std::ostream* out) const override {

        ClassMember::writeToStream(prefix, final, out);



        *out << prefix << "public static " << (final ? "final " : "")

             << "String " << mName << "=\"" << mVal << "\";";

    }



private:

    std::string mName;

    std::string mVal;



    DISALLOW_COPY_AND_ASSIGN(PrimitiveMember);

};



using IntMember = PrimitiveMember<uint32_t>;

using ResourceMember = PrimitiveMember<ResourceId>;

using StringMember = PrimitiveMember<std::string>;



template <typename T>

class PrimitiveArrayMember : public ClassMember {

public:

    PrimitiveArrayMember(const StringPiece& name) :

            mName(name.toString()) {

    }



    void addElement(const T& val) {

        mElements.push_back(val);

    }



    bool empty() const override {

        return false;

    }



    void writeToStream(const StringPiece& prefix, bool final, std::ostream* out) const override {

        ClassMember::writeToStream(prefix, final, out);



        *out << "public static final int[] " << mName << "={";



        const auto begin = mElements.begin();

        const auto end = mElements.end();

        for (auto current = begin; current != end; ++current) {

            if (std::distance(begin, current) % kAttribsPerLine == 0) {

                *out << "\n" << prefix << kIndent << kIndent;

            }



            *out << *current;

            if (std::distance(current, end) > 1) {

                *out << ", ";

            }

        }

        *out << "\n" << prefix << kIndent <<"};";

    }



private:

    std::string mName;

    std::vector<T> mElements;



    DISALLOW_COPY_AND_ASSIGN(PrimitiveArrayMember);

};



using ResourceArrayMember = PrimitiveArrayMember<ResourceId>;



enum class ClassQualifier {

    None,

    Static

};



class ClassDefinition : public ClassMember {

public:

    static bool writeJavaFile(const ClassDefinition* def,

                              const StringPiece& package,

                              bool final,

                              std::ostream* out);



    ClassDefinition(const StringPiece& name, ClassQualifier qualifier, bool createIfEmpty) :

            mName(name.toString()), mQualifier(qualifier), mCreateIfEmpty(createIfEmpty) {

    }



    void addMember(std::unique_ptr<ClassMember> member) {

        mMembers.push_back(std::move(member));

    }



    bool empty() const override;

    void writeToStream(const StringPiece& prefix, bool final, std::ostream* out) const override;



private:

    std::string mName;

    ClassQualifier mQualifier;

    bool mCreateIfEmpty;

    std::vector<std::unique_ptr<ClassMember>> mMembers;



    DISALLOW_COPY_AND_ASSIGN(ClassDefinition);

};



} // namespace aapt



#endif /* AAPT_JAVA_CLASSDEFINITION_H */