diff options
author | Adam Lesinski <adamlesinski@google.com> | 2015-10-21 14:42:43 -0700 |
---|---|---|
committer | Adam Lesinski <adamlesinski@google.com> | 2015-10-30 13:51:11 -0700 |
commit | ca5638fd85098c3d0a699492751043545f75553a (patch) | |
tree | 9ede79caee33fc201b2d5a2da994a77fa25a7c2c /tools/aapt2/java/AnnotationProcessor.h | |
parent | 030cfd3da697d51bf1bffd076881c12acedd851e (diff) |
AAPT2: Support generating Manifest.java
This includes comments from AndroidManifest.xml.
Change-Id: I412d9ecb12bad20a49a683d6b3bea4a0be1235ae
Diffstat (limited to 'tools/aapt2/java/AnnotationProcessor.h')
-rw-r--r-- | tools/aapt2/java/AnnotationProcessor.h | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/tools/aapt2/java/AnnotationProcessor.h b/tools/aapt2/java/AnnotationProcessor.h new file mode 100644 index 000000000000..b47210939d06 --- /dev/null +++ b/tools/aapt2/java/AnnotationProcessor.h @@ -0,0 +1,93 @@ +/* + * 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_ANNOTATIONPROCESSOR_H +#define AAPT_JAVA_ANNOTATIONPROCESSOR_H + +#include "util/StringPiece.h" + +#include <string> + +namespace aapt { + +/** + * Builds a JavaDoc comment from a set of XML comments. + * This will also look for instances of @SystemApi and convert them to + * actual Java annotations. + * + * Example: + * + * Input XML: + * + * <!-- This is meant to be hidden because + * It is system api. Also it is @deprecated + * @SystemApi + * --> + * + * Output JavaDoc: + * + * /\* + * * This is meant to be hidden because + * * It is system api. Also it is @deprecated + * * @SystemApi + * *\/ + * + * Output Annotations: + * + * @Deprecated + * @android.annotation.SystemApi + * + */ +class AnnotationProcessor { +public: + /** + * Creates an AnnotationProcessor with a given prefix for each line generated. + * This is usually a set of spaces for indentation. + */ + AnnotationProcessor(const StringPiece& prefix) : mPrefix(prefix.toString()) { + } + + /** + * Adds more comments. Since resources can have various values with different configurations, + * we need to collect all the comments. + */ + void appendComment(const StringPiece16& comment); + + /** + * Finishes the comment and moves it to the caller. Subsequent calls to buildComment() have + * undefined results. + */ + std::string buildComment(); + + /** + * Finishes the annotation and moves it to the caller. Subsequent calls to buildAnnotations() + * have undefined results. + */ + std::string buildAnnotations(); + +private: + std::string mPrefix; + std::string mComment; + std::string mAnnotations; + bool mDeprecated = false; + bool mSystemApi = false; + + void appendCommentLine(const StringPiece16& line); +}; + +} // namespace aapt + +#endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */ |