diff --git a/src/compiler/java_generator.cc b/src/compiler/java_generator.cc new file mode 100644 index 0000000000000000000000000000000000000000..6915bbfcb20daf139c313b67f9b6b2443cf418f8 --- /dev/null +++ b/src/compiler/java_generator.cc @@ -0,0 +1,701 @@ +/* + * + * Copyright 2014, 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 "src/compiler/java_generator.h" + +#include <map> +#include "net/proto2/compiler/java/public/names.h" +#include <google/protobuf/io/printer.h> +#include <google/protobuf/io/zero_copy_stream.h> +#include "net/proto_compiler/proto.h" +#include "net/proto_compiler/proto-inl.h" + +namespace java_grpc_generator { + +using google::protobuf::FileDescriptor; +using google::protobuf::ServiceDescriptor; +using google::protobuf::MethodDescriptor; +using google::protobuf::Descriptor; +using google::protobuf::io::Printer; + +// Adjust a method name prefix identifier to follow the JavaBean spec: +// - decapitalize the first letter +// - remove embedded underscores & capitalize the following letter +static string MixedLower(const string& word) { + string w; + w += tolower(word[0]); + bool after_underscore = false; + for (int i = 1; i < word.length(); ++i) { + if (word[i] == '_') { + after_underscore = true; + } else { + w += after_underscore ? toupper(word[i]) : word[i]; + after_underscore = false; + } + } + return w; +} + +// Converts to the identifier to the ALL_UPPER_CASE format. +// - An underscore is inserted where a lower case letter is followed by an +// upper case letter. +// - All letters are converted to upper case +static string ToAllUpperCase(const string& word) { + string w; + for (int i = 0; i < word.length(); ++i) { + w += toupper(word[i]); + if ((i < word.length() - 1) && islower(word[i]) && isupper(word[i + 1])) { + w += '_'; + } + } + return w; +} + +static inline string LowerMethodName(const MethodDescriptor* method) { + return MixedLower(method->name()); +} + +static inline string MethodPropertiesFieldName(const MethodDescriptor* method) { + return "METHOD_" + ToAllUpperCase(method->name()); +} + +static inline string MessageFullJavaName(const Descriptor* desc) { + return google::protobuf::compiler::java::ClassName(desc); +} + +static void PrintMethodFields( + const ServiceDescriptor* service, map<string, string>* vars, Printer* p) { + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["method_name"] = method->name(); + (*vars)["input_type"] = MessageFullJavaName(method->input_type()); + (*vars)["output_type"] = MessageFullJavaName(method->output_type()); + (*vars)["method_field_name"] = MethodPropertiesFieldName(method); + bool client_streaming = method->client_streaming(); + bool server_streaming = method->server_streaming(); + if (client_streaming) { + if (server_streaming) { + (*vars)["method_type"] = "DUPLEX_STREAMING"; + } else { + (*vars)["method_type"] = "CLIENT_STREAMING"; + } + } else { + if (server_streaming) { + (*vars)["method_type"] = "SERVER_STREAMING"; + } else { + (*vars)["method_type"] = "UNARY"; + } + } + p->Print( + *vars, + "private static final $Method$<$input_type$,\n" + " $output_type$> $method_field_name$ =\n" + " $Method$.create(\n" + " $MethodType$.$method_type$, \"$method_name$\",\n" + " $ProtoUtils$.marshaller($input_type$.PARSER),\n" + " $ProtoUtils$.marshaller($output_type$.PARSER));\n"); + } + p->Print("\n"); +} + +static void PrintServiceDescriptor( + const ServiceDescriptor* service, map<string, string>* vars, Printer* p) { + (*vars)["service_name"] = service->name(); + p->Print( + *vars, + "@$Immutable$\n"); + p->Print( + *vars, + "public static class $service_name$ServiceDescriptor extends\n" + " $AbstractServiceDescriptor$<$service_name$ServiceDescriptor> {\n"); + p->Indent(); + + // Service descriptor fields + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["input_type"] = MessageFullJavaName(method->input_type()); + (*vars)["output_type"] = MessageFullJavaName(method->output_type()); + (*vars)["lower_method_name"] = LowerMethodName(method); + p->Print( + *vars, + "public final $MethodDescriptor$<$input_type$,\n" + " $output_type$> $lower_method_name$;\n"); + } + + // The default constructor + p->Print( + *vars, + "\nprivate $service_name$ServiceDescriptor() {\n"); + p->Indent(); + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["method_field_name"] = MethodPropertiesFieldName(method); + (*vars)["lower_method_name"] = LowerMethodName(method); + p->Print(*vars, + "$lower_method_name$ = createMethodDescriptor(\n" + " \"$Package$$service_name$\", $method_field_name$);\n"); + } + p->Outdent(); + p->Print("}\n"); + + // The reconfiguring constructor + p->Print( + *vars, + "\nprivate $service_name$ServiceDescriptor(\n" + " $Map$<$String$, $MethodDescriptor$<?, ?>> methodMap) {\n"); + p->Indent(); + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["input_type"] = MessageFullJavaName(method->input_type()); + (*vars)["output_type"] = MessageFullJavaName(method->output_type()); + (*vars)["lower_method_name"] = LowerMethodName(method); + (*vars)["method_field_name"] = MethodPropertiesFieldName(method); + p->Print( + *vars, + "$lower_method_name$ = ($MethodDescriptor$<$input_type$,\n" + " $output_type$>) methodMap.get(\n" + " CONFIG.$lower_method_name$.getName());\n"); + } + p->Outdent(); + p->Print("}\n\n"); + + p->Print( + *vars, + "@$Override$\nprotected $service_name$ServiceDescriptor build(\n" + " $Map$<$String$, $MethodDescriptor$<?, ?>> methodMap) {\n"); + p->Indent(); + p->Print( + *vars, + "return new $service_name$ServiceDescriptor(methodMap);\n"); + p->Outdent(); + p->Print("}\n\n"); + + p->Print( + *vars, + "@$Override$\n" + "public $ImmutableList$<$MethodDescriptor$<?, ?>> methods() {\n"); + p->Indent(); + p->Print( + *vars, + "return $ImmutableList$.<$MethodDescriptor$<?, ?>>of(\n"); + p->Indent(); + p->Indent(); + for (int i = 0; i < service->method_count(); ++i) { + p->Print(MixedLower(service->method(i)->name()).c_str()); + if (i < service->method_count() - 1) { + p->Print(",\n"); + } else { + p->Print(");\n"); + } + } + p->Outdent(); + p->Outdent(); + p->Outdent(); + p->Print("}\n"); + + p->Outdent(); + p->Print("}\n\n"); +} + +enum StubType { + ASYNC_INTERFACE = 0, + BLOCKING_CLIENT_INTERFACE = 1, + FUTURE_CLIENT_INTERFACE = 2, + BLOCKING_SERVER_INTERFACE = 3, + ASYNC_CLIENT_IMPL = 4, + BLOCKING_CLIENT_IMPL = 5, + FUTURE_CLIENT_IMPL = 6 +}; + +enum CallType { + ASYNC_CALL = 0, + BLOCKING_CALL = 1, + FUTURE_CALL = 2 +}; + +// Prints a client interface or implementation class, or a server interface. +static void PrintStub(const google::protobuf::ServiceDescriptor* service, + map<string, string>* vars, + Printer* p, StubType type) { + (*vars)["service_name"] = service->name(); + string interface_name = service->name(); + string impl_name = service->name(); + switch (type) { + case ASYNC_INTERFACE: + case ASYNC_CLIENT_IMPL: + impl_name += "Stub"; + break; + case BLOCKING_CLIENT_INTERFACE: + case BLOCKING_CLIENT_IMPL: + interface_name += "BlockingClient"; + impl_name += "BlockingStub"; + break; + case FUTURE_CLIENT_INTERFACE: + case FUTURE_CLIENT_IMPL: + interface_name += "FutureClient"; + impl_name += "FutureStub"; + break; + case BLOCKING_SERVER_INTERFACE: + interface_name += "BlockingServer"; + break; + default: + LOG(FATAL) << "Unsupported type: " << type; + } + bool impl; + CallType call_type; + switch (type) { + case ASYNC_INTERFACE: + call_type = ASYNC_CALL; + impl = false; + break; + case BLOCKING_CLIENT_INTERFACE: + case BLOCKING_SERVER_INTERFACE: + call_type = BLOCKING_CALL; + impl = false; + break; + case FUTURE_CLIENT_INTERFACE: + call_type = FUTURE_CALL; + impl = false; + break; + case ASYNC_CLIENT_IMPL: + call_type = ASYNC_CALL; + impl = true; + break; + case BLOCKING_CLIENT_IMPL: + call_type = BLOCKING_CALL; + impl = true; + break; + case FUTURE_CLIENT_IMPL: + call_type = FUTURE_CALL; + impl = true; + break; + default: + LOG(FATAL) << "Unsupported type: " << type; + } + (*vars)["interface_name"] = interface_name; + (*vars)["impl_name"] = impl_name; + + // Class head + if (!impl) { + p->Print( + *vars, + "public static interface $interface_name$ {\n"); + } else { + p->Print( + *vars, + "public static class $impl_name$ extends\n" + " $AbstractStub$<$impl_name$, $service_name$ServiceDescriptor>\n" + " implements $interface_name$ {\n"); + } + p->Indent(); + + // Constructor and build() method + if (impl) { + p->Print( + *vars, + "private $impl_name$($Channel$ channel,\n" + " $service_name$ServiceDescriptor config) {\n"); + p->Indent(); + p->Print("super(channel, config);\n"); + p->Outdent(); + p->Print("}\n\n"); + p->Print( + *vars, + "@$Override$\n" + "protected $impl_name$ build($Channel$ channel,\n" + " $service_name$ServiceDescriptor config) {\n"); + p->Indent(); + p->Print( + *vars, + "return new $impl_name$(channel, config);\n"); + p->Outdent(); + p->Print("}\n"); + } + + // RPC methods + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["input_type"] = MessageFullJavaName(method->input_type()); + (*vars)["output_type"] = MessageFullJavaName(method->output_type()); + (*vars)["lower_method_name"] = LowerMethodName(method); + bool client_streaming = method->client_streaming(); + bool server_streaming = method->server_streaming(); + + if (call_type == BLOCKING_CALL && client_streaming) { + // Blocking client interface with client streaming is not available + continue; + } + + if (call_type == FUTURE_CALL && (client_streaming || server_streaming)) { + // Future interface doesn't support streaming. + continue; + } + + // Method signature + p->Print("\n"); + if (impl) { + p->Print( + *vars, + "@$Override$\n"); + } + p->Print("public "); + switch (call_type) { + case BLOCKING_CALL: + // TODO(zhangkun): decide the blocking server interface + CHECK(type != BLOCKING_SERVER_INTERFACE) + << "Blocking server interface is not available"; + CHECK(!client_streaming) + << "Blocking client interface with client streaming is unavailable"; + if (server_streaming) { + // Server streaming + p->Print( + *vars, + "$Iterator$<$output_type$> $lower_method_name$(\n" + " $input_type$ request)"); + } else { + // Simple RPC + p->Print( + *vars, + "$output_type$ $lower_method_name$($input_type$ request)"); + } + break; + case ASYNC_CALL: + if (client_streaming) { + // Duplex streaming or client streaming + p->Print( + *vars, + "$StreamObserver$<$input_type$> $lower_method_name$(\n" + " $StreamObserver$<$output_type$> responseObserver)"); + } else { + // Server streaming or simple RPC + p->Print( + *vars, + "void $lower_method_name$($input_type$ request,\n" + " $StreamObserver$<$output_type$> responseObserver)"); + } + break; + case FUTURE_CALL: + CHECK(!client_streaming && !server_streaming) + << "Future interface doesn't support streaming. " + << "client_streaming=" << client_streaming << ", " + << "server_streaming=" << server_streaming; + p->Print( + *vars, + "$ListenableFuture$<$output_type$> $lower_method_name$(\n" + " $input_type$ request)"); + break; + } + if (impl) { + // Method body for client impls + p->Print(" {\n"); + p->Indent(); + switch (call_type) { + case BLOCKING_CALL: + CHECK(!client_streaming) + << "Blocking client streaming interface is not available"; + if (server_streaming) { + (*vars)["calls_method"] = "blockingServerStreamingCall"; + (*vars)["params"] = "request"; + } else { + (*vars)["calls_method"] = "blockingUnaryCall"; + (*vars)["params"] = "request"; + } + p->Print( + *vars, + "return $calls_method$(\n" + " channel.newCall(config.$lower_method_name$), $params$);\n"); + break; + case ASYNC_CALL: + if (server_streaming) { + if (client_streaming) { + (*vars)["calls_method"] = "duplexStreamingCall"; + (*vars)["params"] = "responseObserver"; + } else { + (*vars)["calls_method"] = "asyncServerStreamingCall"; + (*vars)["params"] = "request, responseObserver"; + } + } else { + if (client_streaming) { + (*vars)["calls_method"] = "asyncClientStreamingCall"; + (*vars)["params"] = "responseObserver"; + } else { + (*vars)["calls_method"] = "asyncUnaryCall"; + (*vars)["params"] = "request, responseObserver"; + } + } + (*vars)["last_line_prefix"] = client_streaming ? "return " : ""; + p->Print( + *vars, + "$last_line_prefix$$calls_method$(\n" + " channel.newCall(config.$lower_method_name$), $params$);\n"); + break; + case FUTURE_CALL: + CHECK(!client_streaming && !server_streaming) + << "Future interface doesn't support streaming. " + << "client_streaming=" << client_streaming << ", " + << "server_streaming=" << server_streaming; + (*vars)["calls_method"] = "unaryFutureCall"; + p->Print( + *vars, + "return $calls_method$(\n" + " channel.newCall(config.$lower_method_name$), request);\n"); + break; + } + p->Outdent(); + p->Print("}\n"); + } else { + p->Print(";\n"); + } + } + p->Outdent(); + p->Print("}\n\n"); +} + +static void PrintBindServiceMethod(const ServiceDescriptor* service, + map<string, string>* vars, + Printer* p) { + (*vars)["service_name"] = service->name(); + p->Print( + *vars, + "public static $ServerServiceDefinition$ bindService(\n" + " final $service_name$ serviceImpl) {\n"); + p->Indent(); + p->Print(*vars, + "return " + "$ServerServiceDefinition$.builder(\"$Package$$service_name$\")\n"); + p->Indent(); + for (int i = 0; i < service->method_count(); ++i) { + const MethodDescriptor* method = service->method(i); + (*vars)["lower_method_name"] = LowerMethodName(method); + (*vars)["method_field_name"] = MethodPropertiesFieldName(method); + (*vars)["input_type"] = MessageFullJavaName(method->input_type()); + (*vars)["output_type"] = MessageFullJavaName(method->output_type()); + bool client_streaming = method->client_streaming(); + if (client_streaming) { + (*vars)["calls_method"] = "asyncStreamingRequestCall"; + (*vars)["invocation_class"] = + "com.google.net.stubby.stub.ServerCalls.StreamingRequestMethod"; + } else { + (*vars)["calls_method"] = "asyncUnaryRequestCall"; + (*vars)["invocation_class"] = + "com.google.net.stubby.stub.ServerCalls.UnaryRequestMethod"; + } + p->Print(*vars, ".addMethod(createMethodDefinition(\n"); + p->Indent(); + p->Indent(); + p->Print( + *vars, + "$method_field_name$,\n" + "$calls_method$(\n"); + p->Indent(); + p->Print( + *vars, + "new $invocation_class$<\n" + " $input_type$,\n" + " $output_type$>() {\n"); + p->Indent(); + p->Print( + *vars, + "@$Override$\n"); + if (client_streaming) { + p->Print( + *vars, + "public $StreamObserver$<$input_type$> invoke(\n" + " $StreamObserver$<$output_type$> responseObserver) {\n" + " return serviceImpl.$lower_method_name$(responseObserver);\n" + "}\n"); + } else { + p->Print( + *vars, + "public void invoke(\n" + " $input_type$ request,\n" + " $StreamObserver$<$output_type$> responseObserver) {\n" + " serviceImpl.$lower_method_name$(request, responseObserver);\n" + "}\n"); + } + p->Outdent(); + p->Print("})))"); + if (i == service->method_count() - 1) { + p->Print(".build();"); + } + p->Print("\n"); + p->Outdent(); + p->Outdent(); + p->Outdent(); + } + p->Outdent(); + p->Outdent(); + p->Print("}\n"); +} + +static void PrintService(const ServiceDescriptor* service, + map<string, string>* vars, + Printer* p) { + (*vars)["service_name"] = service->name(); + (*vars)["service_class_name"] = ServiceClassName(service); + p->Print( + *vars, + "@$Generated$(\"by gRPC proto compiler\")\n" + "public class $service_class_name$ {\n\n"); + p->Indent(); + + PrintMethodFields(service, vars, p); + + p->Print( + *vars, + "public static $service_name$Stub newStub($Channel$ channel) {\n"); + p->Indent(); + p->Print( + *vars, + "return new $service_name$Stub(channel, CONFIG);\n"); + p->Outdent(); + p->Print("}\n\n"); + p->Print( + *vars, + "public static $service_name$BlockingStub newBlockingStub(\n" + " $Channel$ channel) {\n"); + p->Indent(); + p->Print( + *vars, + "return new $service_name$BlockingStub(channel, CONFIG);\n"); + p->Outdent(); + p->Print("}\n\n"); + p->Print( + *vars, + "public static $service_name$FutureStub newFutureStub(\n" + " $Channel$ channel) {\n"); + p->Indent(); + p->Print( + *vars, + "return new $service_name$FutureStub(channel, CONFIG);\n"); + p->Outdent(); + p->Print("}\n\n"); + + p->Print( + *vars, + "public static final $service_name$ServiceDescriptor CONFIG =\n" + " new $service_name$ServiceDescriptor();\n\n"); + PrintServiceDescriptor(service, vars, p); + PrintStub(service, vars, p, ASYNC_INTERFACE); + PrintStub(service, vars, p, BLOCKING_CLIENT_INTERFACE); + PrintStub(service, vars, p, FUTURE_CLIENT_INTERFACE); + PrintStub(service, vars, p, ASYNC_CLIENT_IMPL); + PrintStub(service, vars, p, BLOCKING_CLIENT_IMPL); + PrintStub(service, vars, p, FUTURE_CLIENT_IMPL); + PrintBindServiceMethod(service, vars, p); + p->Outdent(); + p->Print("}\n"); +} + +void PrintImports(Printer* p) { + p->Print( + "import static " + "com.google.net.stubby.stub.Calls.createMethodDescriptor;\n" + "import static " + "com.google.net.stubby.stub.Calls.asyncUnaryCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.asyncServerStreamingCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.asyncClientStreamingCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.duplexStreamingCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.blockingUnaryCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.blockingServerStreamingCall;\n" + "import static " + "com.google.net.stubby.stub.Calls.unaryFutureCall;\n" + "import static " + "com.google.net.stubby.stub.ServerCalls.createMethodDefinition;\n" + "import static " + "com.google.net.stubby.stub.ServerCalls.asyncUnaryRequestCall;\n" + "import static " + "com.google.net.stubby.stub.ServerCalls.asyncStreamingRequestCall;\n\n"); +} + +void GenerateService(const ServiceDescriptor* service, + google::protobuf::io::ZeroCopyOutputStream* out) { + // All non-generated classes must be referred by fully qualified names to + // avoid collision with generated classes. + map<string, string> vars; + vars["String"] = "java.lang.String"; + vars["Override"] = "java.lang.Override"; + vars["Channel"] = "com.google.net.stubby.Channel"; + vars["MethodType"] = "com.google.net.stubby.MethodType"; + vars["ServerServiceDefinition"] = + "com.google.net.stubby.ServerServiceDefinition"; + vars["AbstractStub"] = "com.google.net.stubby.stub.AbstractStub"; + vars["Method"] = "com.google.net.stubby.stub.Method"; + vars["AbstractServiceDescriptor"] = + "com.google.net.stubby.stub.AbstractServiceDescriptor"; + vars["ImmutableList"] = "com.google.common.collect.ImmutableList"; + vars["MethodDescriptor"] = "com.google.net.stubby.MethodDescriptor"; + vars["ProtoUtils"] = "com.google.net.stubby.proto.ProtoUtils"; + vars["StreamObserver"] = "com.google.net.stubby.stub.StreamObserver"; + vars["Iterator"] = "java.util.Iterator"; + vars["Map"] = "java.util.Map"; + vars["TimeUnit"] = "java.util.concurrent.TimeUnit"; + vars["Generated"] = "javax.annotation.Generated"; + vars["Immutable"] = "javax.annotation.concurrent.Immutable"; + vars["ListenableFuture"] = + "com.google.common.util.concurrent.ListenableFuture"; + + Printer printer(out, '$'); + string package_name = ServiceJavaPackage(service->file()); + printer.Print( + "package $package_name$;\n\n", + "package_name", package_name); + PrintImports(&printer); + + // Package string is used to fully qualify method names. + vars["Package"] = service->file()->package(); + if (!vars["Package"].empty()) { + vars["Package"].append("."); + } + PrintService(service, &vars, &printer); +} + +string ServiceJavaPackage(const FileDescriptor* file) { + string result = google::protobuf::compiler::java::ClassName(file); + size_t last_dot_pos = result.find_last_of('.'); + if (last_dot_pos != string::npos) { + result.resize(last_dot_pos); + } + return result; +} + +string ServiceClassName(const google::protobuf::ServiceDescriptor* service) { + return service->name() + "Grpc"; +} + +} // namespace java_grpc_generator diff --git a/src/compiler/java_generator.h b/src/compiler/java_generator.h new file mode 100644 index 0000000000000000000000000000000000000000..58da1254cb89b7811cde147cfc4ac7e127f1f872 --- /dev/null +++ b/src/compiler/java_generator.h @@ -0,0 +1,55 @@ +/* + * + * Copyright 2014, 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 NET_GRPC_COMPILER_JAVA_GENERATOR_H_ +#define NET_GRPC_COMPILER_JAVA_GENERATOR_H_ + +#include <google/protobuf/io/zero_copy_stream.h> +#include <google/protobuf/descriptor.h> + +namespace java_grpc_generator { + +// Returns the package name of the gRPC services defined in the given file. +string ServiceJavaPackage(const google::protobuf::FileDescriptor* file); + +// Returns the name of the outer class that wraps in all the generated code for +// the given service. +string ServiceClassName(const google::protobuf::ServiceDescriptor* service); + +// Writes the generated service interface into the given ZeroCopyOutputStream +void GenerateService(const google::protobuf::ServiceDescriptor* service, + google::protobuf::io::ZeroCopyOutputStream* out); + +} // namespace java_grpc_generator + +#endif // NET_GRPC_COMPILER_JAVA_GENERATOR_H_ diff --git a/src/compiler/java_plugin.cc b/src/compiler/java_plugin.cc new file mode 100644 index 0000000000000000000000000000000000000000..f6f327291b584fd985870e23d4d82e6d0c443850 --- /dev/null +++ b/src/compiler/java_plugin.cc @@ -0,0 +1,84 @@ +/* + * + * Copyright 2014, 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 Java gRPC service interface out of Protobuf IDL. +// +// This is a Proto2 compiler plugin. See net/proto2/compiler/proto/plugin.proto +// and net/proto2/compiler/public/plugin.h for more information on plugins. + +#include <memory> + +#include "src/compiler/java_generator.h" +#include <google/protobuf/compiler/code_generator.h> +#include <google/protobuf/compiler/plugin.h> +#include <google/protobuf/io/zero_copy_stream.h> +#include <google/protobuf/descriptor.h> + +static string JavaPackageToDir(const string& package_name) { + string package_dir = package_name; + for (size_t i = 0; i < package_dir.size(); ++i) { + if (package_dir[i] == '.') { + package_dir[i] = '/'; + } + } + if (!package_dir.empty()) package_dir += "/"; + return package_dir; +} + +class JavaGrpcGenerator : public google::protobuf::compiler::CodeGenerator { + public: + JavaGrpcGenerator() {} + virtual ~JavaGrpcGenerator() {} + + virtual bool Generate(const google::protobuf::FileDescriptor* file, + const string& parameter, + google::protobuf::compiler::GeneratorContext* context, + string* error) const { + string package_name = java_grpc_generator::ServiceJavaPackage(file); + string package_filename = JavaPackageToDir(package_name); + for (int i = 0; i < file->service_count(); ++i) { + const google::protobuf::ServiceDescriptor* service = file->service(i); + string filename = package_filename + + java_grpc_generator::ServiceClassName(service) + ".java"; + std::unique_ptr<google::protobuf::io::ZeroCopyOutputStream> output( + context->Open(filename)); + java_grpc_generator::GenerateService(service, output.get()); + } + return true; + } +}; + +int main(int argc, char* argv[]) { + JavaGrpcGenerator generator; + return google::protobuf::compiler::PluginMain(argc, argv, &generator); +}