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 19 #ifndef GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H 20 #define GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H 21 22 #include <memory> 23 #include <sstream> 24 25 #include "src/compiler/config.h" 26 #include "src/compiler/cpp_generator.h" 27 #include "src/compiler/generator_helpers.h" 28 #include "src/compiler/protobuf_plugin.h" 29 30 // Cpp Generator for Protobug IDL 31 class CppGrpcGenerator : public grpc::protobuf::compiler::CodeGenerator { 32 public: CppGrpcGenerator()33 CppGrpcGenerator() {} ~CppGrpcGenerator()34 virtual ~CppGrpcGenerator() {} 35 GetSupportedFeatures()36 uint64_t GetSupportedFeatures() const override { 37 return FEATURE_PROTO3_OPTIONAL 38 #ifdef GRPC_PROTOBUF_EDITION_SUPPORT 39 | FEATURE_SUPPORTS_EDITIONS 40 #endif 41 ; 42 } 43 #ifdef GRPC_PROTOBUF_EDITION_SUPPORT GetMinimumEdition()44 grpc::protobuf::Edition GetMinimumEdition() const override { 45 return grpc::protobuf::Edition::EDITION_PROTO2; 46 } GetMaximumEdition()47 grpc::protobuf::Edition GetMaximumEdition() const override { 48 return grpc::protobuf::Edition::EDITION_2023; 49 } 50 #endif 51 Generate(const grpc::protobuf::FileDescriptor * file,const std::string & parameter,grpc::protobuf::compiler::GeneratorContext * context,std::string * error)52 virtual bool Generate(const grpc::protobuf::FileDescriptor* file, 53 const std::string& parameter, 54 grpc::protobuf::compiler::GeneratorContext* context, 55 std::string* error) const override { 56 if (file->options().cc_generic_services()) { 57 *error = 58 "cpp grpc proto compiler plugin does not work with generic " 59 "services. To generate cpp grpc APIs, please set \"" 60 "cc_generic_service = false\"."; 61 return false; 62 } 63 64 grpc_cpp_generator::Parameters generator_parameters; 65 generator_parameters.use_system_headers = true; 66 generator_parameters.generate_mock_code = false; 67 generator_parameters.include_import_headers = false; 68 generator_parameters.allow_sync_server_api = true; 69 generator_parameters.allow_cq_api = true; 70 71 ProtoBufFile pbfile(file); 72 73 if (!parameter.empty()) { 74 std::vector<std::string> parameters_list = 75 grpc_generator::tokenize(parameter, ","); 76 for (auto parameter_string = parameters_list.begin(); 77 parameter_string != parameters_list.end(); parameter_string++) { 78 std::vector<std::string> param = 79 grpc_generator::tokenize(*parameter_string, "="); 80 if (param[0] == "services_namespace") { 81 generator_parameters.services_namespace = param[1]; 82 } else if (param[0] == "use_system_headers") { 83 if (param[1] == "true") { 84 generator_parameters.use_system_headers = true; 85 } else if (param[1] == "false") { 86 generator_parameters.use_system_headers = false; 87 } else { 88 *error = std::string("Invalid parameter: ") + *parameter_string; 89 return false; 90 } 91 } else if (param[0] == "grpc_search_path") { 92 generator_parameters.grpc_search_path = param[1]; 93 } else if (param[0] == "generate_mock_code") { 94 if (param[1] == "true") { 95 generator_parameters.generate_mock_code = true; 96 } else if (param[1] != "false") { 97 *error = std::string("Invalid parameter: ") + *parameter_string; 98 return false; 99 } 100 } else if (param[0] == "allow_sync_server_api") { 101 if (param[1] == "true") { 102 generator_parameters.allow_sync_server_api = true; 103 } else if (param[1] == "false") { 104 generator_parameters.allow_sync_server_api = false; 105 } else { 106 *error = std::string("Invalid parameter: ") + *parameter_string; 107 return false; 108 } 109 } else if (param[0] == "allow_cq_api") { 110 if (param[1] == "true") { 111 generator_parameters.allow_cq_api = true; 112 } else if (param[1] == "false") { 113 generator_parameters.allow_cq_api = false; 114 } else { 115 *error = std::string("Invalid parameter: ") + *parameter_string; 116 return false; 117 } 118 } else if (param[0] == "gmock_search_path") { 119 generator_parameters.gmock_search_path = param[1]; 120 } else if (param[0] == "additional_header_includes") { 121 generator_parameters.additional_header_includes = 122 grpc_generator::tokenize(param[1], ":"); 123 } else if (param[0] == "message_header_extension") { 124 generator_parameters.message_header_extension = param[1]; 125 } else if (param[0] == "include_import_headers") { 126 if (param[1] == "true") { 127 generator_parameters.include_import_headers = true; 128 } else if (param[1] != "false") { 129 *error = std::string("Invalid parameter: ") + *parameter_string; 130 return false; 131 } 132 } else { 133 *error = std::string("Unknown parameter: ") + *parameter_string; 134 return false; 135 } 136 } 137 } 138 139 std::string file_name = 140 grpc_generator::StripProto(std::string(file->name())); 141 142 std::string header_code = 143 grpc_cpp_generator::GetHeaderPrologue(&pbfile, generator_parameters) + 144 grpc_cpp_generator::GetHeaderIncludes(&pbfile, generator_parameters) + 145 grpc_cpp_generator::GetHeaderServices(&pbfile, generator_parameters) + 146 grpc_cpp_generator::GetHeaderEpilogue(&pbfile, generator_parameters); 147 std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> header_output( 148 context->Open(file_name + ".grpc.pb.h")); 149 grpc::protobuf::io::CodedOutputStream header_coded_out(header_output.get()); 150 header_coded_out.WriteRaw(header_code.data(), header_code.size()); 151 152 std::string source_code = 153 grpc_cpp_generator::GetSourcePrologue(&pbfile, generator_parameters) + 154 grpc_cpp_generator::GetSourceIncludes(&pbfile, generator_parameters) + 155 grpc_cpp_generator::GetSourceServices(&pbfile, generator_parameters) + 156 grpc_cpp_generator::GetSourceEpilogue(&pbfile, generator_parameters); 157 std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> source_output( 158 context->Open(file_name + ".grpc.pb.cc")); 159 grpc::protobuf::io::CodedOutputStream source_coded_out(source_output.get()); 160 source_coded_out.WriteRaw(source_code.data(), source_code.size()); 161 162 if (!generator_parameters.generate_mock_code) { 163 return true; 164 } 165 std::string mock_code = 166 grpc_cpp_generator::GetMockPrologue(&pbfile, generator_parameters) + 167 grpc_cpp_generator::GetMockIncludes(&pbfile, generator_parameters) + 168 grpc_cpp_generator::GetMockServices(&pbfile, generator_parameters) + 169 grpc_cpp_generator::GetMockEpilogue(&pbfile, generator_parameters); 170 std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> mock_output( 171 context->Open(file_name + "_mock.grpc.pb.h")); 172 grpc::protobuf::io::CodedOutputStream mock_coded_out(mock_output.get()); 173 mock_coded_out.WriteRaw(mock_code.data(), mock_code.size()); 174 175 return true; 176 } 177 178 private: 179 // Insert the given code into the given file at the given insertion point. Insert(grpc::protobuf::compiler::GeneratorContext * context,const std::string & filename,const std::string & insertion_point,const std::string & code)180 void Insert(grpc::protobuf::compiler::GeneratorContext* context, 181 const std::string& filename, const std::string& insertion_point, 182 const std::string& code) const { 183 std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> output( 184 context->OpenForInsert(filename, insertion_point)); 185 grpc::protobuf::io::CodedOutputStream coded_out(output.get()); 186 coded_out.WriteRaw(code.data(), code.size()); 187 } 188 }; 189 190 #endif // GRPC_INTERNAL_COMPILER_CPP_PLUGIN_H 191