Open Lighting Architecture  Latest Git
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
ServiceGenerator.h
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: [email protected] (Kenton Varda)
32 // Based on original Protocol Buffers design by
33 // Sanjay Ghemawat, Jeff Dean, and others.
34 //
35 // Edited by Simon Newton for OLA
36 
37 #ifndef PROTOC_SERVICEGENERATOR_H_
38 #define PROTOC_SERVICEGENERATOR_H_
39 
40 #include <google/protobuf/stubs/common.h>
41 #include <google/protobuf/io/printer.h>
42 #include <google/protobuf/descriptor.h>
43 
44 #include <map>
45 #include <string>
46 
47 namespace ola {
48 
49 using google::protobuf::ServiceDescriptor;
50 using google::protobuf::io::Printer;
51 using std::string;
52 
54  public:
55  // Generator options:
56  struct Options {
57  Options() : safe_boundary_check(false) {
58  }
59  string dllexport_decl;
60  bool safe_boundary_check;
61  };
62 
63  // See generator.cc for the meaning of dllexport_decl.
64  explicit ServiceGenerator(const ServiceDescriptor* descriptor,
65  const Options& options);
67 
68  // Header stuff.
69 
70  // Generate the class definitions for the service's interface and the
71  // stub implementation.
72  void GenerateDeclarations(Printer* printer);
73 
74  // Source file stuff.
75 
76  // Generate code that initializes the global variable storing the service's
77  // descriptor.
78  void GenerateDescriptorInitializer(Printer* printer, int index);
79 
80  // Generate implementations of everything declared by GenerateDeclarations().
81  void GenerateImplementation(Printer* printer);
82 
83  private:
84  enum RequestOrResponse { REQUEST, RESPONSE };
85  enum VirtualOrNon { VIRTUAL, NON_VIRTUAL };
86 
87  // Header stuff.
88 
89  // Generate the service abstract interface.
90  void GenerateInterface(Printer* printer);
91 
92  // Generate the stub class definition.
93  void GenerateStubDefinition(Printer* printer);
94 
95  // Prints signatures for all methods in the
96  void GenerateMethodSignatures(VirtualOrNon virtual_or_non,
97  Printer* printer);
98 
99  // Source file stuff.
100 
101  // Generate the default implementations of the service methods, which
102  // produce a "not implemented" error.
103  void GenerateNotImplementedMethods(Printer* printer);
104 
105  // Generate the CallMethod() method of the service.
106  void GenerateCallMethod(Printer* printer);
107 
108  // Generate the Get{Request,Response}Prototype() methods.
109  void GenerateGetPrototype(RequestOrResponse which, Printer* printer);
110 
111  // Generate the stub's implementations of the service methods.
112  void GenerateStubMethods(Printer* printer);
113 
114  const ServiceDescriptor* descriptor_;
115  std::map<string, string> vars_;
116 
117  GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator);
118 };
119 
120 } // namespace ola
121 #endif // PROTOC_SERVICEGENERATOR_H_
Definition: ServiceGenerator.h:53
The namespace containing all OLA symbols.
Definition: Credentials.cpp:44
Definition: ServiceGenerator.h:56