cpp_plugin.h 6.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157
  1. /*
  2. *
  3. * Copyright 2019 gRPC authors.
  4. *
  5. * Licensed under the Apache License, Version 2.0 (the "License");
  6. * you may not use this file except in compliance with the License.
  7. * You may obtain a copy of the License at
  8. *
  9. * http://www.apache.org/licenses/LICENSE-2.0
  10. *
  11. * Unless required by applicable law or agreed to in writing, software
  12. * distributed under the License is distributed on an "AS IS" BASIS,
  13. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14. * See the License for the specific language governing permissions and
  15. * limitations under the License.
  16. *
  17. */
  18. #ifndef GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H
  19. #define GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H
  20. #include <memory>
  21. #include <sstream>
  22. #include "src/compiler/config.h"
  23. #include "src/compiler/cpp_generator.h"
  24. #include "src/compiler/generator_helpers.h"
  25. #include "src/compiler/protobuf_plugin.h"
  26. // Cpp Generator for Protobug IDL
  27. class CppGrpcGenerator : public grpc::protobuf::compiler::CodeGenerator {
  28. public:
  29. CppGrpcGenerator() {}
  30. virtual ~CppGrpcGenerator() {}
  31. uint64_t GetSupportedFeatures() const override {
  32. return FEATURE_PROTO3_OPTIONAL;
  33. }
  34. virtual bool Generate(const grpc::protobuf::FileDescriptor* file,
  35. const TString& parameter,
  36. grpc::protobuf::compiler::GeneratorContext* context,
  37. TString* error) const override {
  38. if (file->options().cc_generic_services()) {
  39. *error =
  40. "cpp grpc proto compiler plugin does not work with generic "
  41. "services. To generate cpp grpc APIs, please set \""
  42. "cc_generic_service = false\".";
  43. return false;
  44. }
  45. grpc_cpp_generator::Parameters generator_parameters;
  46. generator_parameters.use_system_headers = true;
  47. generator_parameters.generate_mock_code = false;
  48. generator_parameters.include_import_headers = false;
  49. ProtoBufFile pbfile(file);
  50. if (!parameter.empty()) {
  51. std::vector<TString> parameters_list =
  52. grpc_generator::tokenize(parameter, ",");
  53. for (auto parameter_string = parameters_list.begin();
  54. parameter_string != parameters_list.end(); parameter_string++) {
  55. std::vector<TString> param =
  56. grpc_generator::tokenize(*parameter_string, "=");
  57. if (param[0] == "services_namespace") {
  58. generator_parameters.services_namespace = param[1];
  59. } else if (param[0] == "use_system_headers") {
  60. if (param[1] == "true") {
  61. generator_parameters.use_system_headers = true;
  62. } else if (param[1] == "false") {
  63. generator_parameters.use_system_headers = false;
  64. } else {
  65. *error = TString("Invalid parameter: ") + *parameter_string;
  66. return false;
  67. }
  68. } else if (param[0] == "grpc_search_path") {
  69. generator_parameters.grpc_search_path = param[1];
  70. } else if (param[0] == "generate_mock_code") {
  71. if (param[1] == "true") {
  72. generator_parameters.generate_mock_code = true;
  73. } else if (param[1] != "false") {
  74. *error = TString("Invalid parameter: ") + *parameter_string;
  75. return false;
  76. }
  77. } else if (param[0] == "gmock_search_path") {
  78. generator_parameters.gmock_search_path = param[1];
  79. } else if (param[0] == "additional_header_includes") {
  80. generator_parameters.additional_header_includes =
  81. grpc_generator::tokenize(param[1], ":");
  82. } else if (param[0] == "message_header_extension") {
  83. generator_parameters.message_header_extension = param[1];
  84. } else if (param[0] == "include_import_headers") {
  85. if (param[1] == "true") {
  86. generator_parameters.include_import_headers = true;
  87. } else if (param[1] != "false") {
  88. *error = TString("Invalid parameter: ") + *parameter_string;
  89. return false;
  90. }
  91. } else {
  92. *error = TString("Unknown parameter: ") + *parameter_string;
  93. return false;
  94. }
  95. }
  96. }
  97. TString file_name = grpc_generator::StripProto(file->name());
  98. TString header_code =
  99. grpc_cpp_generator::GetHeaderPrologue(&pbfile, generator_parameters) +
  100. grpc_cpp_generator::GetHeaderIncludes(&pbfile, generator_parameters) +
  101. grpc_cpp_generator::GetHeaderServices(&pbfile, generator_parameters) +
  102. grpc_cpp_generator::GetHeaderEpilogue(&pbfile, generator_parameters);
  103. std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> header_output(
  104. context->Open(file_name + ".grpc.pb.h"));
  105. grpc::protobuf::io::CodedOutputStream header_coded_out(header_output.get());
  106. header_coded_out.WriteRaw(header_code.data(), header_code.size());
  107. TString source_code =
  108. grpc_cpp_generator::GetSourcePrologue(&pbfile, generator_parameters) +
  109. grpc_cpp_generator::GetSourceIncludes(&pbfile, generator_parameters) +
  110. grpc_cpp_generator::GetSourceServices(&pbfile, generator_parameters) +
  111. grpc_cpp_generator::GetSourceEpilogue(&pbfile, generator_parameters);
  112. std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> source_output(
  113. context->Open(file_name + ".grpc.pb.cc"));
  114. grpc::protobuf::io::CodedOutputStream source_coded_out(source_output.get());
  115. source_coded_out.WriteRaw(source_code.data(), source_code.size());
  116. if (!generator_parameters.generate_mock_code) {
  117. return true;
  118. }
  119. TString mock_code =
  120. grpc_cpp_generator::GetMockPrologue(&pbfile, generator_parameters) +
  121. grpc_cpp_generator::GetMockIncludes(&pbfile, generator_parameters) +
  122. grpc_cpp_generator::GetMockServices(&pbfile, generator_parameters) +
  123. grpc_cpp_generator::GetMockEpilogue(&pbfile, generator_parameters);
  124. std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> mock_output(
  125. context->Open(file_name + "_mock.grpc.pb.h"));
  126. grpc::protobuf::io::CodedOutputStream mock_coded_out(mock_output.get());
  127. mock_coded_out.WriteRaw(mock_code.data(), mock_code.size());
  128. return true;
  129. }
  130. private:
  131. // Insert the given code into the given file at the given insertion point.
  132. void Insert(grpc::protobuf::compiler::GeneratorContext* context,
  133. const TString& filename, const TString& insertion_point,
  134. const TString& code) const {
  135. std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> output(
  136. context->OpenForInsert(filename, insertion_point));
  137. grpc::protobuf::io::CodedOutputStream coded_out(output.get());
  138. coded_out.WriteRaw(code.data(), code.size());
  139. }
  140. };
  141. #endif // GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H