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 31 // Author: kenton@google.com (Kenton Varda) 32 // Based on original Protocol Buffers design by 33 // Sanjay Ghemawat, Jeff Dean, and others. 34 35 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__ 36 #define GOOGLE_PROTOBUF_COMPILER_JAVA_SERVICE_H__ 37 38 #include <map> 39 #include <google/protobuf/descriptor.h> 40 41 namespace google { 42 namespace protobuf { 43 namespace compiler { 44 namespace java { 45 class Context; // context.h 46 class ClassNameResolver; // name_resolver.h 47 } 48 } 49 namespace io { 50 class Printer; // printer.h 51 } 52 } 53 54 namespace protobuf { 55 namespace compiler { 56 namespace java { 57 58 class ServiceGenerator { 59 public: 60 explicit ServiceGenerator(const ServiceDescriptor* descriptor); 61 virtual ~ServiceGenerator(); 62 63 virtual void Generate(io::Printer* printer) = 0; 64 65 enum RequestOrResponse { REQUEST, RESPONSE }; 66 enum IsAbstract { IS_ABSTRACT, IS_CONCRETE }; 67 68 protected: 69 const ServiceDescriptor* descriptor_; 70 71 private: 72 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator); 73 }; 74 75 class ImmutableServiceGenerator : public ServiceGenerator { 76 public: 77 explicit ImmutableServiceGenerator(const ServiceDescriptor* descriptor, 78 Context* context); 79 virtual ~ImmutableServiceGenerator(); 80 81 virtual void Generate(io::Printer* printer); 82 83 private: 84 85 // Generate the getDescriptorForType() method. 86 void GenerateGetDescriptorForType(io::Printer* printer); 87 88 // Generate a Java interface for the service. 89 void GenerateInterface(io::Printer* printer); 90 91 // Generate newReflectiveService() method. 92 void GenerateNewReflectiveServiceMethod(io::Printer* printer); 93 94 // Generate newReflectiveBlockingService() method. 95 void GenerateNewReflectiveBlockingServiceMethod(io::Printer* printer); 96 97 // Generate abstract method declarations for all methods. 98 void GenerateAbstractMethods(io::Printer* printer); 99 100 // Generate the implementation of Service.callMethod(). 101 void GenerateCallMethod(io::Printer* printer); 102 103 // Generate the implementation of BlockingService.callBlockingMethod(). 104 void GenerateCallBlockingMethod(io::Printer* printer); 105 106 // Generate the implementations of Service.get{Request,Response}Prototype(). 107 void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer); 108 109 // Generate a stub implementation of the service. 110 void GenerateStub(io::Printer* printer); 111 112 // Generate a method signature, possibly abstract, without body or trailing 113 // semicolon. 114 void GenerateMethodSignature(io::Printer* printer, 115 const MethodDescriptor* method, 116 IsAbstract is_abstract); 117 118 // Generate a blocking stub interface and implementation of the service. 119 void GenerateBlockingStub(io::Printer* printer); 120 121 // Generate the method signature for one method of a blocking stub. 122 void GenerateBlockingMethodSignature(io::Printer* printer, 123 const MethodDescriptor* method); 124 125 Context* context_; 126 ClassNameResolver* name_resolver_; 127 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableServiceGenerator); 128 }; 129 130 } // namespace java 131 } // namespace compiler 132 } // namespace protobuf 133 134 #endif // NET_PROTO2_COMPILER_JAVA_SERVICE_H__ 135 } // namespace google 136