1// Protocol Buffers - Google's data interchange format
2// Copyright 2008 Google Inc.  All rights reserved.
3// http://code.google.com/p/protobuf/
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_CPP_SERVICE_H__
36#define GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__
37
38#include <map>
39#include <string>
40#include <google/protobuf/stubs/common.h>
41#include <google/protobuf/compiler/cpp/cpp_options.h>
42#include <google/protobuf/descriptor.h>
43
44namespace google {
45namespace protobuf {
46  namespace io {
47    class Printer;             // printer.h
48  }
49}
50
51namespace protobuf {
52namespace compiler {
53namespace cpp {
54
55class ServiceGenerator {
56 public:
57  // See generator.cc for the meaning of dllexport_decl.
58  explicit ServiceGenerator(const ServiceDescriptor* descriptor,
59                            const Options& options);
60  ~ServiceGenerator();
61
62  // Header stuff.
63
64  // Generate the class definitions for the service's interface and the
65  // stub implementation.
66  void GenerateDeclarations(io::Printer* printer);
67
68  // Source file stuff.
69
70  // Generate code that initializes the global variable storing the service's
71  // descriptor.
72  void GenerateDescriptorInitializer(io::Printer* printer, int index);
73
74  // Generate implementations of everything declared by GenerateDeclarations().
75  void GenerateImplementation(io::Printer* printer);
76
77 private:
78  enum RequestOrResponse { REQUEST, RESPONSE };
79  enum VirtualOrNon { VIRTUAL, NON_VIRTUAL };
80
81  // Header stuff.
82
83  // Generate the service abstract interface.
84  void GenerateInterface(io::Printer* printer);
85
86  // Generate the stub class definition.
87  void GenerateStubDefinition(io::Printer* printer);
88
89  // Prints signatures for all methods in the
90  void GenerateMethodSignatures(VirtualOrNon virtual_or_non,
91                                io::Printer* printer);
92
93  // Source file stuff.
94
95  // Generate the default implementations of the service methods, which
96  // produce a "not implemented" error.
97  void GenerateNotImplementedMethods(io::Printer* printer);
98
99  // Generate the CallMethod() method of the service.
100  void GenerateCallMethod(io::Printer* printer);
101
102  // Generate the Get{Request,Response}Prototype() methods.
103  void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer);
104
105  // Generate the stub's implementations of the service methods.
106  void GenerateStubMethods(io::Printer* printer);
107
108  const ServiceDescriptor* descriptor_;
109  map<string, string> vars_;
110
111  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator);
112};
113
114}  // namespace cpp
115}  // namespace compiler
116}  // namespace protobuf
117
118}  // namespace google
119#endif  // GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__
120