mirror of https://github.com/grpc/grpc.git
Merge pull request #1226 from murgatroid99/objective_c_plugin
Objective C protoc pluginpull/1231/head
commit
0f6a1ccfd8
7 changed files with 512 additions and 1 deletions
@ -0,0 +1,236 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#include <map> |
||||
|
||||
#include "src/compiler/objective_c_generator.h" |
||||
#include "src/compiler/objective_c_generator_helpers.h" |
||||
|
||||
#include "src/compiler/config.h" |
||||
|
||||
#include <sstream> |
||||
|
||||
namespace grpc_objective_c_generator { |
||||
namespace { |
||||
|
||||
void PrintSimpleBlockSignature(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
(*vars)["method_name"] = method->name(); |
||||
(*vars)["request_type"] = PrefixedName(method->input_type()->name()); |
||||
(*vars)["response_type"] = PrefixedName(method->output_type()->name()); |
||||
|
||||
if (method->server_streaming()) { |
||||
printer->Print("// When the response stream finishes, the handler is " |
||||
"called with nil for both arguments.\n\n"); |
||||
} else { |
||||
printer->Print("// The handler is only called once.\n\n"); |
||||
} |
||||
printer->Print(*vars, "- (id<GRXLiveSource>)$method_name$WithRequest:" |
||||
"($request_type$)request completionHandler:(void(^)" |
||||
"($response_type$ *, NSError *))handler"); |
||||
} |
||||
|
||||
void PrintSimpleDelegateSignature(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
(*vars)["method_name"] = method->name(); |
||||
(*vars)["request_type"] = PrefixedName(method->input_type()->name()); |
||||
|
||||
printer->Print(*vars, "- (id<GRXLiveSource>)$method_name$WithRequest:" |
||||
"($request_type$)request delegate:(id<GRXSink>)delegate"); |
||||
} |
||||
|
||||
void PrintAdvancedSignature(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
(*vars)["method_name"] = method->name(); |
||||
printer->Print(*vars, "- (GRXSource *)$method_name$WithRequest:" |
||||
"(id<GRXSource>)request"); |
||||
} |
||||
|
||||
void PrintSourceMethodSimpleBlock(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
PrintSimpleBlockSignature(printer, method, vars); |
||||
|
||||
(*vars)["method_name"] = method->name(); |
||||
printer->Print(" {\n"); |
||||
printer->Indent(); |
||||
printer->Print(*vars, "return [[self $method_name$WithRequest:request] " |
||||
"connectHandler:^(id value, NSError *error) {\n"); |
||||
printer->Indent(); |
||||
printer->Print("handler(value, error);\n"); |
||||
printer->Outdent(); |
||||
printer->Print("}];\n"); |
||||
printer->Outdent(); |
||||
printer->Print("}\n"); |
||||
} |
||||
|
||||
void PrintSourceMethodSimpleDelegate(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
PrintSimpleDelegateSignature(printer, method, vars); |
||||
|
||||
(*vars)["method_name"] = method->name(); |
||||
printer->Print(" {\n"); |
||||
printer->Indent(); |
||||
printer->Print(*vars, "return [[self $method_name$WithRequest:request]" |
||||
"connectToSink:delegate];\n"); |
||||
printer->Outdent(); |
||||
printer->Print("}\n"); |
||||
} |
||||
|
||||
void PrintSourceMethodAdvanced(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
PrintAdvancedSignature(printer, method, vars); |
||||
|
||||
(*vars)["method_name"] = method->name(); |
||||
printer->Print(" {\n"); |
||||
printer->Indent(); |
||||
printer->Print(*vars, "return [self $method_name$WithRequest:request " |
||||
"client:[self newClient]];\n"); |
||||
printer->Outdent(); |
||||
printer->Print("}\n"); |
||||
} |
||||
|
||||
void PrintSourceMethodHandler(grpc::protobuf::io::Printer *printer, |
||||
const grpc::protobuf::MethodDescriptor *method, |
||||
std::map<grpc::string, grpc::string> *vars) { |
||||
(*vars)["method_name"] = method->name(); |
||||
(*vars)["response_type"] = PrefixedName(method->output_type()->name()); |
||||
(*vars)["caps_name"] = grpc_generator::CapitalizeFirstLetter(method->name()); |
||||
|
||||
printer->Print(*vars, "- (GRXSource *)$method_name$WithRequest:" |
||||
"(id<GRXSource>)request client:(PBgRPCClient *)client {\n"); |
||||
printer->Indent(); |
||||
printer->Print(*vars, |
||||
"return [self responseWithMethod:$@\"$caps_name\"\n"); |
||||
printer->Print(*vars, |
||||
" class:[$response_type$ class]\n"); |
||||
printer->Print(" request:request\n"); |
||||
printer->Print(" client:client];\n"); |
||||
printer->Outdent(); |
||||
printer->Print("}\n"); |
||||
} |
||||
|
||||
} |
||||
|
||||
grpc::string GetHeader(const grpc::protobuf::ServiceDescriptor *service, |
||||
const grpc::string message_header) { |
||||
grpc::string output; |
||||
grpc::protobuf::io::StringOutputStream output_stream(&output); |
||||
grpc::protobuf::io::Printer printer(&output_stream, '$'); |
||||
std::map<grpc::string, grpc::string> vars; |
||||
printer.Print("#import \"PBgRPCClient.h\"\n"); |
||||
printer.Print("#import \"PBStub.h\"\n"); |
||||
vars["message_header"] = message_header; |
||||
printer.Print(vars, "#import \"$message_header$\"\n\n"); |
||||
printer.Print("@protocol GRXSource\n"); |
||||
printer.Print("@class GRXSource\n\n"); |
||||
vars["service_name"] = service->name(); |
||||
printer.Print("@protocol $service_name$Stub <NSObject>\n\n"); |
||||
printer.Print("#pragma mark Simple block handlers\n\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSimpleBlockSignature(&printer, service->method(i), &vars); |
||||
printer.Print(";\n"); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("#pragma mark Simple delegate handlers.\n\n"); |
||||
printer.Print("# TODO(jcanizales): Use high-level snippets to remove this duplication."); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSimpleDelegateSignature(&printer, service->method(i), &vars); |
||||
printer.Print(";\n"); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("#pragma mark Advanced handlers.\n\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintAdvancedSignature(&printer, service->method(i), &vars); |
||||
printer.Print(";\n"); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("@end\n\n"); |
||||
printer.Print("// Basic stub that only does marshalling and parsing\n"); |
||||
printer.Print(vars, "@interface $service_name$Stub :" |
||||
" PBStub<$service_name$Stub>\n"); |
||||
printer.Print("- (instancetype)initWithHost:(NSString *)host;\n"); |
||||
printer.Print("@end\n"); |
||||
return output; |
||||
} |
||||
|
||||
grpc::string GetSource(const grpc::protobuf::ServiceDescriptor *service) { |
||||
grpc::string output; |
||||
grpc::protobuf::io::StringOutputStream output_stream(&output); |
||||
grpc::protobuf::io::Printer printer(&output_stream, '$'); |
||||
std::map<grpc::string, grpc::string> vars; |
||||
vars["service_name"] = service->name(); |
||||
printer.Print(vars, "#import \"$service_name$Stub.pb.h\"\n"); |
||||
printer.Print("#import \"PBGeneratedMessage+GRXSource.h\"\n\n"); |
||||
vars["full_name"] = service->full_name(); |
||||
printer.Print(vars, |
||||
"static NSString *const kInterface = @\"$full_name$\";\n"); |
||||
printer.Print("@implementation $service_name$Stub\n\n"); |
||||
printer.Print("- (instancetype)initWithHost:(NSString *)host {\n"); |
||||
printer.Indent(); |
||||
printer.Print("if ((self = [super initWithHost:host " |
||||
"interface:kInterface])) {\n"); |
||||
printer.Print("}\n"); |
||||
printer.Print("return self;\n"); |
||||
printer.Outdent(); |
||||
printer.Print("}\n\n"); |
||||
printer.Print("#pragma mark Simple block handlers.\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSourceMethodSimpleBlock(&printer, service->method(i), &vars); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("#pragma mark Simple delegate handlers.\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSourceMethodSimpleDelegate(&printer, service->method(i), &vars); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("#pragma mark Advanced handlers.\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSourceMethodAdvanced(&printer, service->method(i), &vars); |
||||
} |
||||
printer.Print("\n"); |
||||
printer.Print("#pragma mark Handlers for subclasses " |
||||
"(stub wrappers) to override.\n"); |
||||
for (int i = 0; i < service->method_count(); i++) { |
||||
PrintSourceMethodHandler(&printer, service->method(i), &vars); |
||||
} |
||||
printer.Print("@end\n"); |
||||
return output; |
||||
} |
||||
|
||||
} // namespace grpc_objective_c_generator
|
@ -0,0 +1,48 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_H |
||||
#define GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_H |
||||
|
||||
#include "src/compiler/config.h" |
||||
|
||||
namespace grpc_objective_c_generator { |
||||
|
||||
grpc::string GetHeader(const grpc::protobuf::ServiceDescriptor *service, |
||||
const grpc::string message_header); |
||||
|
||||
grpc::string GetSource(const grpc::protobuf::ServiceDescriptor *service); |
||||
|
||||
} // namespace grpc_objective_c_generator
|
||||
|
||||
#endif // GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_H
|
@ -0,0 +1,58 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
#ifndef GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_HELPERS_H |
||||
#define GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_HELPERS_H |
||||
|
||||
#include <map> |
||||
#include "src/compiler/config.h" |
||||
#include "src/compiler/generator_helpers.h" |
||||
|
||||
namespace grpc_objective_c_generator { |
||||
|
||||
const grpc::string prefix = "PBG"; |
||||
|
||||
inline grpc::string MessageHeaderName(const grpc::protobuf::FileDescriptor *file) { |
||||
return grpc_generator::FileNameInUpperCamel(file) + ".pb.h"; |
||||
} |
||||
|
||||
inline grpc::string StubFileName(grpc::string service_name) { |
||||
return prefix + service_name + "Stub"; |
||||
} |
||||
|
||||
inline grpc::string PrefixedName(grpc::string name) { |
||||
return prefix + name; |
||||
} |
||||
|
||||
} |
||||
#endif // GRPC_INTERNAL_COMPILER_OBJECTIVE_C_GENERATOR_HELPERS_H
|
@ -0,0 +1,98 @@ |
||||
/*
|
||||
* |
||||
* Copyright 2015, Google Inc. |
||||
* All rights reserved. |
||||
* |
||||
* Redistribution and use in source and binary forms, with or without |
||||
* modification, are permitted provided that the following conditions are |
||||
* met: |
||||
* |
||||
* * Redistributions of source code must retain the above copyright |
||||
* notice, this list of conditions and the following disclaimer. |
||||
* * Redistributions in binary form must reproduce the above |
||||
* copyright notice, this list of conditions and the following disclaimer |
||||
* in the documentation and/or other materials provided with the |
||||
* distribution. |
||||
* * Neither the name of Google Inc. nor the names of its |
||||
* contributors may be used to endorse or promote products derived from |
||||
* this software without specific prior written permission. |
||||
* |
||||
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
||||
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
||||
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
||||
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
||||
* OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
||||
* SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
||||
* LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
||||
* DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
||||
* THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
||||
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
||||
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
||||
* |
||||
*/ |
||||
|
||||
// Generates Objective C gRPC service interface out of Protobuf IDL.
|
||||
|
||||
#include <memory> |
||||
|
||||
#include "src/compiler/config.h" |
||||
#include "src/compiler/objective_c_generator.h" |
||||
#include "src/compiler/objective_c_generator_helpers.h" |
||||
|
||||
class ObjectiveCGrpcGenerator : public grpc::protobuf::compiler::CodeGenerator { |
||||
public: |
||||
ObjectiveCGrpcGenerator() {} |
||||
virtual ~ObjectiveCGrpcGenerator() {} |
||||
|
||||
virtual bool Generate(const grpc::protobuf::FileDescriptor *file, |
||||
const grpc::string ¶meter, |
||||
grpc::protobuf::compiler::GeneratorContext *context, |
||||
grpc::string *error) const { |
||||
|
||||
if (file->service_count() == 0) { |
||||
// No services. Do nothing.
|
||||
return true; |
||||
} |
||||
|
||||
for (int i = 0; i < file->service_count(); i++) { |
||||
const grpc::protobuf::ServiceDescriptor *service = file->service(i); |
||||
grpc::string file_name = grpc_objective_c_generator::StubFileName( |
||||
service->name()); |
||||
|
||||
// Generate .pb.h
|
||||
grpc::string header_code = grpc_objective_c_generator::GetHeader( |
||||
service, grpc_objective_c_generator::MessageHeaderName(file)); |
||||
std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> header_output( |
||||
context->Open(file_name + ".pb.h")); |
||||
grpc::protobuf::io::CodedOutputStream header_coded_out( |
||||
header_output.get()); |
||||
header_coded_out.WriteRaw(header_code.data(), header_code.size()); |
||||
|
||||
// Generate .pb.m
|
||||
grpc::string source_code = grpc_objective_c_generator::GetSource(service); |
||||
std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> source_output( |
||||
context->Open(file_name + ".pb.m")); |
||||
grpc::protobuf::io::CodedOutputStream source_coded_out( |
||||
source_output.get()); |
||||
source_coded_out.WriteRaw(source_code.data(), source_code.size()); |
||||
} |
||||
|
||||
return true; |
||||
} |
||||
|
||||
private: |
||||
// Insert the given code into the given file at the given insertion point.
|
||||
void Insert(grpc::protobuf::compiler::GeneratorContext *context, |
||||
const grpc::string &filename, const grpc::string &insertion_point, |
||||
const grpc::string &code) const { |
||||
std::unique_ptr<grpc::protobuf::io::ZeroCopyOutputStream> output( |
||||
context->OpenForInsert(filename, insertion_point)); |
||||
grpc::protobuf::io::CodedOutputStream coded_out(output.get()); |
||||
coded_out.WriteRaw(code.data(), code.size()); |
||||
} |
||||
}; |
||||
|
||||
int main(int argc, char *argv[]) { |
||||
ObjectiveCGrpcGenerator generator; |
||||
return grpc::protobuf::compiler::PluginMain(argc, argv, &generator); |
||||
} |
Loading…
Reference in new issue