1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
|
/*
* 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
* *\/
*
* 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);
void appendNewLine();
/**
* Writes the comments and annotations to the stream, with the given prefix before each line.
*/
void writeToStream(std::ostream* out, const StringPiece& prefix) const;
private:
enum : uint32_t {
kDeprecated = 0x01,
kSystemApi = 0x02,
};
std::stringstream mComment;
std::stringstream mAnnotations;
bool mHasComments = false;
uint32_t mAnnotationBitMask = 0;
void appendCommentLine(std::string& line);
};
} // namespace aapt
#endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */
|
