tools/aapt2/java/AnnotationProcessor.h

/*
 * 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(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.
  //
  // If add_api_annotations is false, annotations found in the comment (e.g., "@SystemApi")
  // will NOT be converted to Java annotations.
  void AppendComment(android::StringPiece comment, bool add_api_annotations = true);

  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, bool add_api_annotations);
};

}  // namespace aapt

#endif /* AAPT_JAVA_ANNOTATIONPROCESSOR_H */