java_file.h 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117
  1. // Protocol Buffers - Google's data interchange format
  2. // Copyright 2008 Google Inc. All rights reserved.
  3. // https://developers.google.com/protocol-buffers/
  4. //
  5. // Redistribution and use in source and binary forms, with or without
  6. // modification, are permitted provided that the following conditions are
  7. // met:
  8. //
  9. // * Redistributions of source code must retain the above copyright
  10. // notice, this list of conditions and the following disclaimer.
  11. // * Redistributions in binary form must reproduce the above
  12. // copyright notice, this list of conditions and the following disclaimer
  13. // in the documentation and/or other materials provided with the
  14. // distribution.
  15. // * Neither the name of Google Inc. nor the names of its
  16. // contributors may be used to endorse or promote products derived from
  17. // this software without specific prior written permission.
  18. //
  19. // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  20. // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  21. // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
  22. // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  23. // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  24. // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  25. // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  26. // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  27. // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  28. // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
  29. // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  30. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__
  34. #define GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__
  35. #include <memory>
  36. #include <string>
  37. #include <vector>
  38. #include <google/protobuf/stubs/common.h>
  39. #include <google/protobuf/compiler/java/java_options.h>
  40. namespace google {
  41. namespace protobuf {
  42. class FileDescriptor; // descriptor.h
  43. namespace io {
  44. class Printer; // printer.h
  45. }
  46. namespace compiler {
  47. class GeneratorContext; // code_generator.h
  48. namespace java {
  49. class Context; // context.h
  50. class MessageGenerator; // message.h
  51. class GeneratorFactory; // generator_factory.h
  52. class ExtensionGenerator; // extension.h
  53. class ClassNameResolver; // name_resolver.h
  54. }
  55. }
  56. }
  57. namespace protobuf {
  58. namespace compiler {
  59. namespace java {
  60. class FileGenerator {
  61. public:
  62. FileGenerator(const FileDescriptor* file, const Options& options,
  63. bool immutable_api = true);
  64. ~FileGenerator();
  65. // Checks for problems that would otherwise lead to cryptic compile errors.
  66. // Returns true if there are no problems, or writes an error description to
  67. // the given string and returns false otherwise.
  68. bool Validate(string* error);
  69. void Generate(io::Printer* printer);
  70. // If we aren't putting everything into one file, this will write all the
  71. // files other than the outer file (i.e. one for each message, enum, and
  72. // service type).
  73. void GenerateSiblings(const string& package_dir,
  74. GeneratorContext* generator_context,
  75. std::vector<string>* file_list,
  76. std::vector<string>* annotation_list);
  77. const string& java_package() { return java_package_; }
  78. const string& classname() { return classname_; }
  79. private:
  80. void GenerateDescriptorInitializationCodeForImmutable(io::Printer* printer);
  81. void GenerateDescriptorInitializationCodeForMutable(io::Printer* printer);
  82. bool ShouldIncludeDependency(const FileDescriptor* descriptor,
  83. bool immutable_api_);
  84. const FileDescriptor* file_;
  85. string java_package_;
  86. string classname_;
  87. std::vector<std::unique_ptr<MessageGenerator>> message_generators_;
  88. std::vector<std::unique_ptr<ExtensionGenerator>> extension_generators_;
  89. std::unique_ptr<GeneratorFactory> generator_factory_;
  90. std::unique_ptr<Context> context_;
  91. ClassNameResolver* name_resolver_;
  92. const Options options_;
  93. bool immutable_api_;
  94. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(FileGenerator);
  95. };
  96. } // namespace java
  97. } // namespace compiler
  98. } // namespace protobuf
  99. } // namespace google
  100. #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_FILE_H__