de6e6f2098
I'm trying to enable a check for the following structure:
```
/** @hide */
public class Class1 {
/** @hide */
@SystemApi // Invalid because the class is hidden.
public void method1() { }
}
```
The internal R.java file violates this, which this change is going to fix.
Bug: 159162473
Test: build (treehugger)
Test: atest aapt2_tests
Change-Id: I613e8611ddaf5f8e4761d351d4cd0142d59c7cc9
82 lines
2.4 KiB
C++
82 lines
2.4 KiB
C++
/*
|
|
* 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 <sstream>
|
|
#include <string>
|
|
#include <unordered_map>
|
|
|
|
#include "androidfw/StringPiece.h"
|
|
|
|
#include "text/Printer.h"
|
|
|
|
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:
|
|
// Extracts the first sentence of a comment. The algorithm selects the substring starting from
|
|
// the beginning of the string, and ending at the first '.' character that is followed by a
|
|
// whitespace character. If these requirements are not met, the whole string is returned.
|
|
static android::StringPiece ExtractFirstSentence(const android::StringPiece& comment);
|
|
|
|
// Adds more comments. Resources can have value definitions for various configurations, and
|
|
// each of the definitions may have comments that need to be processed.
|
|
void AppendComment(const android::StringPiece& comment);
|
|
|
|
void AppendNewLine();
|
|
|
|
// Writes the comments and annotations to the Printer.
|
|
void Print(text::Printer* printer, bool strip_api_annotations = false) const;
|
|
|
|
private:
|
|
std::stringstream comment_;
|
|
std::stringstream mAnnotations;
|
|
bool has_comments_ = false;
|
|
std::unordered_map<uint32_t, std::string> annotation_parameter_map_;
|
|
|
|
void AppendCommentLine(std::string line);
|
|
};
|
|
|
|
} // namespace aapt
|
|
|
|
#endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */
|