diff options
Diffstat (limited to 'tools/aapt2/java/AnnotationProcessor.h')
-rw-r--r-- | tools/aapt2/java/AnnotationProcessor.h | 85 |
1 files changed, 85 insertions, 0 deletions
diff --git a/tools/aapt2/java/AnnotationProcessor.h b/tools/aapt2/java/AnnotationProcessor.h new file mode 100644 index 000000000000..e7f2be0dc12b --- /dev/null +++ b/tools/aapt2/java/AnnotationProcessor.h @@ -0,0 +1,85 @@ +/* + * 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 <sstream> +#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: + /** + * Adds more comments. Since resources can have various values with different configurations, + * we need to collect all the comments. + */ + void appendComment(const StringPiece16& comment); + void appendComment(const StringPiece& comment); + + /** + * Writes the comments and annotations to the stream, with the given prefix before each line. + */ + void writeToStream(std::ostream* out, const StringPiece& prefix); + +private: + enum : uint32_t { + kDeprecated = 0x01, + kSystemApi = 0x02, + }; + + std::stringstream mComment; + std::stringstream mAnnotations; + bool mHasComments = false; + uint32_t mAnnotationBitMask = 0; + + void appendCommentLine(const std::string& line); +}; + +} // namespace aapt + +#endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */ |