java_message.h revision a3b2a6da25a76f17c73d31def3952feb0fd2296e
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_JAVA_MESSAGE_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 39a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson#include <map> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/compiler/java/java_field.h> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 44a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson namespace compiler { 45a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson namespace java { 46a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson class Context; // context.h 47a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson class ClassNameResolver; // name_resolver.h 48a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson } 49a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson } 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville namespace io { 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville class Printer; // printer.h 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville } 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace java { 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleclass MessageGenerator { 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville public: 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville explicit MessageGenerator(const Descriptor* descriptor); 62a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual ~MessageGenerator(); 63fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 64fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // All static variables have to be declared at the top-level of the file 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // so that we can control initialization order, which is important for 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // DescriptorProto bootstrapping to work. 67a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateStaticVariables(io::Printer* printer) = 0; 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Output code which initializes the static variables generated by 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // GenerateStaticVariables(). 71a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateStaticVariableInitializers(io::Printer* printer) = 0; 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate the class itself. 74a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void Generate(io::Printer* printer) = 0; 75a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 76a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson // Generates the base interface that both the class and its builder implement 77a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateInterface(io::Printer* printer) = 0; 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // Generate code to register all contained extensions with an 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville // ExtensionRegistry. 81a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateExtensionRegistrationCode(io::Printer* printer) = 0; 82a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 83a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson protected: 84a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson const Descriptor* descriptor_; 85fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville private: 87a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(MessageGenerator); 88a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson}; 89a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 90a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidsonclass ImmutableMessageGenerator : public MessageGenerator { 91a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson public: 92a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson explicit ImmutableMessageGenerator(const Descriptor* descriptor, 93a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson Context* context); 94a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual ~ImmutableMessageGenerator(); 95a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 96a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void Generate(io::Printer* printer); 97a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateInterface(io::Printer* printer); 98a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateExtensionRegistrationCode(io::Printer* printer); 99a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateStaticVariables(io::Printer* printer); 100a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson virtual void GenerateStaticVariableInitializers(io::Printer* printer); 101a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 102a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson private: 103a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson enum UseMemoization { 104a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson MEMOIZE, 105a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson DONT_MEMOIZE 106a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson }; 107a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 108a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateFieldAccessorTable(io::Printer* printer); 109a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateFieldAccessorTableInitializer(io::Printer* printer); 110a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateMessageSerializationMethods(io::Printer* printer); 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateParseFromMethods(io::Printer* printer); 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateSerializeOneField(io::Printer* printer, 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville const FieldDescriptor* field); 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateSerializeOneExtensionRange( 116fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville io::Printer* printer, const Descriptor::ExtensionRange* range); 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateBuilder(io::Printer* printer); 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateCommonBuilderMethods(io::Printer* printer); 120a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateDescriptorMethods(io::Printer* printer); 121fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville void GenerateBuilderParsingMethods(io::Printer* printer); 122a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateIsInitialized(io::Printer* printer, 123a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson UseMemoization useMemoization); 124a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateEqualsAndHashCode(io::Printer* printer); 125a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateParser(io::Printer* printer); 126a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson void GenerateParsingConstructor(io::Printer* printer); 127fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 128a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson Context* context_; 129a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson ClassNameResolver* name_resolver_; 130a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson FieldGeneratorMap<ImmutableFieldGenerator> field_generators_; 131fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 132a3b2a6da25a76f17c73d31def3952feb0fd2296eJeff Davidson GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ImmutableMessageGenerator); 133fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville}; 134fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 135fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace java 136fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 137fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 138fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 139fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 140fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_JAVA_MESSAGE_H__ 141