Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 1 | /* |
| 2 | * Copyright (C) 2015 The Android Open Source Project |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | |
| 17 | #ifndef AAPT_JAVA_ANNOTATIONPROCESSOR_H |
| 18 | #define AAPT_JAVA_ANNOTATIONPROCESSOR_H |
| 19 | |
Adam Lesinski | b274e35 | 2015-11-06 15:14:35 -0800 | [diff] [blame] | 20 | #include <sstream> |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 21 | #include <string> |
| 22 | |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 23 | #include "androidfw/StringPiece.h" |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 24 | |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 25 | namespace aapt { |
| 26 | |
| 27 | /** |
| 28 | * Builds a JavaDoc comment from a set of XML comments. |
| 29 | * This will also look for instances of @SystemApi and convert them to |
| 30 | * actual Java annotations. |
| 31 | * |
| 32 | * Example: |
| 33 | * |
| 34 | * Input XML: |
| 35 | * |
| 36 | * <!-- This is meant to be hidden because |
| 37 | * It is system api. Also it is @deprecated |
| 38 | * @SystemApi |
| 39 | * --> |
| 40 | * |
| 41 | * Output JavaDoc: |
| 42 | * |
| 43 | * /\* |
| 44 | * * This is meant to be hidden because |
| 45 | * * It is system api. Also it is @deprecated |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 46 | * *\/ |
| 47 | * |
| 48 | * Output Annotations: |
| 49 | * |
| 50 | * @Deprecated |
| 51 | * @android.annotation.SystemApi |
| 52 | * |
| 53 | */ |
| 54 | class AnnotationProcessor { |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 55 | public: |
Adam Lesinski | 18dc03a | 2017-07-24 18:19:36 -0700 | [diff] [blame] | 56 | static android::StringPiece ExtractFirstSentence(const android::StringPiece& comment); |
| 57 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 58 | /** |
| 59 | * Adds more comments. Since resources can have various values with different |
| 60 | * configurations, |
| 61 | * we need to collect all the comments. |
| 62 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 63 | void AppendComment(const android::StringPiece& comment); |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 64 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 65 | void AppendNewLine(); |
Adam Lesinski | 7656554 | 2016-03-10 21:55:04 -0800 | [diff] [blame] | 66 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 67 | /** |
| 68 | * Writes the comments and annotations to the stream, with the given prefix |
| 69 | * before each line. |
| 70 | */ |
Adam Lesinski | d5083f6 | 2017-01-16 15:07:21 -0800 | [diff] [blame] | 71 | void WriteToStream(std::ostream* out, const android::StringPiece& prefix) const; |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 72 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 73 | private: |
| 74 | enum : uint32_t { |
| 75 | kDeprecated = 0x01, |
| 76 | kSystemApi = 0x02, |
| 77 | }; |
Adam Lesinski | b274e35 | 2015-11-06 15:14:35 -0800 | [diff] [blame] | 78 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 79 | std::stringstream comment_; |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 80 | std::stringstream mAnnotations; |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 81 | bool has_comments_ = false; |
| 82 | uint32_t annotation_bit_mask_ = 0; |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 83 | |
Adam Lesinski | ce5e56e | 2016-10-21 17:56:45 -0700 | [diff] [blame] | 84 | void AppendCommentLine(std::string& line); |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 85 | }; |
| 86 | |
Adam Lesinski | cacb28f | 2016-10-19 12:18:14 -0700 | [diff] [blame] | 87 | } // namespace aapt |
Adam Lesinski | ca5638f | 2015-10-21 14:42:43 -0700 | [diff] [blame] | 88 | |
| 89 | #endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */ |