cpp_generator.h 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106
  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. //
  34. // Generates C++ code for a given .proto file.
  35. #ifndef GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__
  36. #define GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__
  37. #include <string>
  38. #include <google/protobuf/compiler/code_generator.h>
  39. #include <google/protobuf/port_def.inc>
  40. namespace google {
  41. namespace protobuf {
  42. namespace compiler {
  43. namespace cpp {
  44. // CodeGenerator implementation which generates a C++ source file and
  45. // header. If you create your own protocol compiler binary and you want
  46. // it to support C++ output, you can do so by registering an instance of this
  47. // CodeGenerator with the CommandLineInterface in your main() function.
  48. class PROTOC_EXPORT CppGenerator : public CodeGenerator {
  49. public:
  50. CppGenerator();
  51. ~CppGenerator();
  52. enum class Runtime {
  53. kGoogle3, // Use the internal google3 runtime.
  54. kOpensource, // Use the open-source runtime.
  55. // Use the open-source runtime with google3 #include paths. We make these
  56. // absolute to avoid ambiguity, so the runtime will be #included like:
  57. // #include "third_party/protobuf/.../google/protobuf/message.h"
  58. kOpensourceGoogle3
  59. };
  60. void set_opensource_runtime(bool opensource) {
  61. opensource_runtime_ = opensource;
  62. }
  63. // If set to a non-empty string, generated code will do:
  64. // #include "<BASE>/google/protobuf/message.h"
  65. // instead of:
  66. // #include <google/protobuf/message.h>
  67. // This has no effect if opensource_runtime = false.
  68. void set_runtime_include_base(const std::string& base) {
  69. runtime_include_base_ = base;
  70. }
  71. // implements CodeGenerator ----------------------------------------
  72. bool Generate(const FileDescriptor* file, const std::string& parameter,
  73. GeneratorContext* generator_context,
  74. std::string* error) const override;
  75. uint64_t GetSupportedFeatures() const override {
  76. // We don't fully support this yet, but this is needed to unblock the tests,
  77. // and we will have full support before the experimental flag is removed.
  78. return FEATURE_PROTO3_OPTIONAL;
  79. }
  80. private:
  81. bool opensource_runtime_ = true;
  82. std::string runtime_include_base_;
  83. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(CppGenerator);
  84. };
  85. } // namespace cpp
  86. } // namespace compiler
  87. } // namespace protobuf
  88. } // namespace google
  89. #include <google/protobuf/port_undef.inc>
  90. #endif // GOOGLE_PROTOBUF_COMPILER_CPP_GENERATOR_H__