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: robinson@google.com (Will Robinson) 32fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// 33fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Generates Python code for a given .proto file. 34fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 35fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#ifndef GOOGLE_PROTOBUF_COMPILER_PYTHON_GENERATOR_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_PYTHON_GENERATOR_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/compiler/code_generator.h> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/stubs/common.h> 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass Descriptor; 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass EnumDescriptor; 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass EnumValueDescriptor; 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass FieldDescriptor; 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass ServiceDescriptor; 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace io { class Printer; } 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace python { 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// CodeGenerator implementation for generated Python protocol buffer classes. 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// If you create your own protocol compiler binary and you want it to support 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Python output, you can do so by registering an instance of this 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// CodeGenerator with the CommandLineInterface in your main() function. 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass LIBPROTOC_EXPORT Generator : public CodeGenerator { 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville Generator(); 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual ~Generator(); 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // CodeGenerator methods. 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville virtual bool Generate(const FileDescriptor* file, 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& parameter, 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville OutputDirectory* output_directory, 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string* error) const; 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintImports() const; 74d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville void PrintFileDescriptor() const; 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintTopLevelEnums() const; 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintAllNestedEnumsInFile() const; 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintNestedEnums(const Descriptor& descriptor) const; 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintEnum(const EnumDescriptor& enum_descriptor) const; 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintTopLevelExtensions() const; 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 82fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintFieldDescriptor( 83fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor& field, bool is_extension) const; 84fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintFieldDescriptorsInDescriptor( 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const Descriptor& message_descriptor, 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville bool is_extension, 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& list_variable_name, 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville int (Descriptor::*CountFn)() const, 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* (Descriptor::*GetterFn)(int) const) const; 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintFieldsInDescriptor(const Descriptor& message_descriptor) const; 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintExtensionsInDescriptor(const Descriptor& message_descriptor) const; 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintMessageDescriptors() const; 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintDescriptor(const Descriptor& message_descriptor) const; 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintNestedDescriptors(const Descriptor& containing_descriptor) const; 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintMessages() const; 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintMessage(const Descriptor& message_descriptor) const; 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintNestedMessages(const Descriptor& containing_descriptor) const; 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void FixForeignFieldsInDescriptors() const; 101d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville void FixForeignFieldsInDescriptor( 102d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const Descriptor& descriptor, 103d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const Descriptor* containing_descriptor) const; 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void FixForeignFieldsInField(const Descriptor* containing_type, 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor& field, 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& python_dict_name) const; 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string FieldReferencingExpression(const Descriptor* containing_type, 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor& field, 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& python_dict_name) const; 110d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville template <typename DescriptorT> 111d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville void FixContainingTypeInDescriptor( 112d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const DescriptorT& descriptor, 113d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const Descriptor* containing_descriptor) const; 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void FixForeignFieldsInExtensions() const; 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void FixForeignFieldsInExtension( 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor& extension_field) const; 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void FixForeignFieldsInNestedExtensions(const Descriptor& descriptor) const; 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 120fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintServices() const; 121fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintServiceDescriptor(const ServiceDescriptor& descriptor) const; 122fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintServiceClass(const ServiceDescriptor& descriptor) const; 123fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintServiceStub(const ServiceDescriptor& descriptor) const; 124fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 125fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void PrintEnumValueDescriptor(const EnumValueDescriptor& descriptor) const; 126fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string OptionsValue(const string& class_name, 127fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const string& serialized_options) const; 128fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville bool GeneratingDescriptorProto() const; 129fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 130fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville template <typename DescriptorT> 131fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string ModuleLevelDescriptorName(const DescriptorT& descriptor) const; 132fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string ModuleLevelMessageName(const Descriptor& descriptor) const; 133fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville string ModuleLevelServiceDescriptorName( 134fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const ServiceDescriptor& descriptor) const; 135fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 136d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville template <typename DescriptorT, typename DescriptorProtoT> 137d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville void PrintSerializedPbInterval( 138d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville const DescriptorT& descriptor, DescriptorProtoT& proto) const; 139d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 140fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Very coarse-grained lock to ensure that Generate() is reentrant. 141d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville // Guards file_, printer_ and file_descriptor_serialized_. 142fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville mutable Mutex mutex_; 143fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville mutable const FileDescriptor* file_; // Set in Generate(). Under mutex_. 144d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville mutable string file_descriptor_serialized_; 145fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville mutable io::Printer* printer_; // Set in Generate(). Under mutex_. 146fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 147fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(Generator); 148fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 149fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 150fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace python 151fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 152fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 153fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 154fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 155fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_PYTHON_GENERATOR_H__ 156