cpp_service.h 4.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121
  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. // Author: kenton@google.com (Kenton Varda)
  31. // Based on original Protocol Buffers design by
  32. // Sanjay Ghemawat, Jeff Dean, and others.
  33. #ifndef GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__
  34. #define GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__
  35. #include <map>
  36. #include <string>
  37. #include <google/protobuf/compiler/cpp/cpp_options.h>
  38. #include <google/protobuf/descriptor.h>
  39. namespace google {
  40. namespace protobuf {
  41. namespace io {
  42. class Printer; // printer.h
  43. }
  44. }
  45. namespace protobuf {
  46. namespace compiler {
  47. namespace cpp {
  48. class ServiceGenerator {
  49. public:
  50. // See generator.cc for the meaning of dllexport_decl.
  51. explicit ServiceGenerator(const ServiceDescriptor* descriptor,
  52. const Options& options);
  53. ~ServiceGenerator();
  54. // Header stuff.
  55. // Generate the class definitions for the service's interface and the
  56. // stub implementation.
  57. void GenerateDeclarations(io::Printer* printer);
  58. // Source file stuff.
  59. // Generate code that initializes the global variable storing the service's
  60. // descriptor.
  61. void GenerateDescriptorInitializer(io::Printer* printer, int index);
  62. // Generate implementations of everything declared by GenerateDeclarations().
  63. void GenerateImplementation(io::Printer* printer);
  64. private:
  65. enum RequestOrResponse { REQUEST, RESPONSE };
  66. enum VirtualOrNon { VIRTUAL, NON_VIRTUAL };
  67. // Header stuff.
  68. // Generate the service abstract interface.
  69. void GenerateInterface(io::Printer* printer);
  70. // Generate the stub class definition.
  71. void GenerateStubDefinition(io::Printer* printer);
  72. // Prints signatures for all methods in the
  73. void GenerateMethodSignatures(VirtualOrNon virtual_or_non,
  74. io::Printer* printer);
  75. // Source file stuff.
  76. // Generate the default implementations of the service methods, which
  77. // produce a "not implemented" error.
  78. void GenerateNotImplementedMethods(io::Printer* printer);
  79. // Generate the CallMethod() method of the service.
  80. void GenerateCallMethod(io::Printer* printer);
  81. // Generate the Get{Request,Response}Prototype() methods.
  82. void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer);
  83. // Generate the stub's implementations of the service methods.
  84. void GenerateStubMethods(io::Printer* printer);
  85. const ServiceDescriptor* descriptor_;
  86. std::map<string, string> vars_;
  87. int index_in_metadata_;
  88. friend class FileGenerator;
  89. GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator);
  90. };
  91. } // namespace cpp
  92. } // namespace compiler
  93. } // namespace protobuf
  94. } // namespace google
  95. #endif // GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__