1fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Protocol Buffers - Google's data interchange format 2fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Copyright 2008 Google Inc. All rights reserved. 3fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// http://code.google.com/p/protobuf/ 4fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 5fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Redistribution and use in source and binary forms, with or without 6fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// modification, are permitted provided that the following conditions are 7fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// met: 8fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 9fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions of source code must retain the above copyright 10fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// notice, this list of conditions and the following disclaimer. 11fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Redistributions in binary form must reproduce the above 12fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// copyright notice, this list of conditions and the following disclaimer 13fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// in the documentation and/or other materials provided with the 14fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// distribution. 15fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// * Neither the name of Google Inc. nor the names of its 16fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// contributors may be used to endorse or promote products derived from 17fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// this software without specific prior written permission. 18fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 19fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 31fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Author: kenton@google.com (Kenton Varda) 32fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Based on original Protocol Buffers design by 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Sanjay Ghemawat, Jeff Dean, and others. 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <map> 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/stubs/common.h> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class Printer; // printer.h 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace cpp { 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass ServiceGenerator { 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // See generator.cc for the meaning of dllexport_decl. 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville explicit ServiceGenerator(const ServiceDescriptor* descriptor, 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& dllexport_decl); 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville ~ServiceGenerator(); 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Header stuff. 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the class definitions for the service's interface and the 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // stub implementation. 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateDeclarations(io::Printer* printer); 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Source file stuff. 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate code that initializes the global variable storing the service's 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // descriptor. 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateDescriptorInitializer(io::Printer* printer, int index); 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate implementations of everything declared by GenerateDeclarations(). 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateImplementation(io::Printer* printer); 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville enum RequestOrResponse { REQUEST, RESPONSE }; 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville enum VirtualOrNon { VIRTUAL, NON_VIRTUAL }; 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Header stuff. 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 82fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the service abstract interface. 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateInterface(io::Printer* printer); 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the stub class definition. 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateStubDefinition(io::Printer* printer); 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Prints signatures for all methods in the 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateMethodSignatures(VirtualOrNon virtual_or_non, 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer); 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Source file stuff. 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the default implementations of the service methods, which 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // produce a "not implemented" error. 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateNotImplementedMethods(io::Printer* printer); 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the CallMethod() method of the service. 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateCallMethod(io::Printer* printer); 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 101fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the Get{Request,Response}Prototype() methods. 102fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateGetPrototype(RequestOrResponse which, io::Printer* printer); 103fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the stub's implementations of the service methods. 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateStubMethods(io::Printer* printer); 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const ServiceDescriptor* descriptor_; 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville map<string, string> vars_; 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 110fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ServiceGenerator); 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace cpp 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_CPP_SERVICE_H__ 119