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_HELPERS_H__ 36fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#define GOOGLE_PROTOBUF_COMPILER_CPP_HELPERS_H__ 37fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 38fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <string> 39fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.h> 40fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#include <google/protobuf/descriptor.pb.h> 41fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 42fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace google { 43fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace protobuf { 44fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace compiler { 45fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillenamespace cpp { 46fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 47fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Commonly-used separator comments. Thick is a line of '=', thin is a line 48fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// of '-'. 49fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleextern const char kThickSeparator[]; 50fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleextern const char kThinSeparator[]; 51fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 52fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Returns the non-nested type name for the given type. If "qualified" is 53fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// true, prefix the type with the full namespace. For example, if you had: 54fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// package foo.bar; 55fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// message Baz { message Qux {} } 56fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Then the qualified ClassName for Qux would be: 57fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// ::foo::bar::Baz_Qux 58fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// While the non-qualified version would be: 59fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Baz_Qux 60fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring ClassName(const Descriptor* descriptor, bool qualified); 61fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring ClassName(const EnumDescriptor* enum_descriptor, bool qualified); 62fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 63d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savillestring SuperClassName(const Descriptor* descriptor); 64d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 65fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Get the (unqualified) name that should be used for this field in C++ code. 66fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// The name is coerced to lower-case to emulate proto1 behavior. People 67fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// should be using lowercase-with-underscores style for proto field names 68fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// anyway, so normally this just returns field->name(). 69fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring FieldName(const FieldDescriptor* field); 70fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 71fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Get the unqualified name that should be used for a field's field 72fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// number constant. 73fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring FieldConstantName(const FieldDescriptor *field); 74fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 75fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Returns the scope where the field was defined (for extensions, this is 76fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// different from the message type to which the field applies). 77fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleinline const Descriptor* FieldScope(const FieldDescriptor* field) { 78fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return field->is_extension() ? 79fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville field->extension_scope() : field->containing_type(); 80fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 81fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 82d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Returns the fully-qualified type name field->message_type(). Usually this 83d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// is just ClassName(field->message_type(), true); 84d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savillestring FieldMessageTypeName(const FieldDescriptor* field); 85d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 86fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Strips ".proto" or ".protodevel" from the end of a filename. 87fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring StripProto(const string& filename); 88fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 89fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Get the C++ type name for a primitive type (e.g. "double", "::google::protobuf::int32", etc.). 90fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Note: non-built-in type names will be qualified, meaning they will start 91fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// with a ::. If you are using the type as a template parameter, you will 92fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// need to insure there is a space between the < and the ::, because the 93fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// ridiculous C++ standard defines "<:" to be a synonym for "[". 94fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleconst char* PrimitiveTypeName(FieldDescriptor::CppType type); 95fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 96fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Get the declared type name in CamelCase format, as is used e.g. for the 97fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// methods of WireFormat. For example, TYPE_INT32 becomes "Int32". 98fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savilleconst char* DeclaredTypeMethodName(FieldDescriptor::Type type); 99fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 100fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Get code that evaluates to the field's default value. 101fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring DefaultValue(const FieldDescriptor* field); 102fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 103fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Convert a file name into a valid identifier. 104fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring FilenameIdentifier(const string& filename); 105fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 106fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Return the name of the AddDescriptors() function for a given file. 107fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring GlobalAddDescriptorsName(const string& filename); 108fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 109fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Return the name of the AssignDescriptors() function for a given file. 110fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring GlobalAssignDescriptorsName(const string& filename); 111fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 112fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Return the name of the ShutdownFile() function for a given file. 113fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Savillestring GlobalShutdownFileName(const string& filename); 114fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 115fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Do message classes in this file keep track of unknown fields? 116d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasUnknownFields(const FileDescriptor *file) { 117fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return file->options().optimize_for() != FileOptions::LITE_RUNTIME; 118fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 119fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 120fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Does this file have generated parsing, serialization, and other 121fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// standard methods for which reflection-based fallback implementations exist? 122d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasGeneratedMethods(const FileDescriptor *file) { 123fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return file->options().optimize_for() != FileOptions::CODE_SIZE; 124fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 125fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 126fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Do message classes in this file have descriptor and refelction methods? 127d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasDescriptorMethods(const FileDescriptor *file) { 128fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return file->options().optimize_for() != FileOptions::LITE_RUNTIME; 129fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 130fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 131d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville// Should we generate generic services for this file? 132d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasGenericServices(const FileDescriptor *file) { 133d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville return file->service_count() > 0 && 134d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville file->options().optimize_for() != FileOptions::LITE_RUNTIME && 135d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville file->options().cc_generic_services(); 136d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville} 137d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 138fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Should string fields in this file verify that their contents are UTF-8? 139d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasUtf8Verification(const FileDescriptor* file) { 140fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return file->options().optimize_for() != FileOptions::LITE_RUNTIME; 141fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 142fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 143fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// Should we generate a separate, super-optimized code path for serializing to 144fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// flat arrays? We don't do this in Lite mode because we'd rather reduce code 145fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville// size. 146d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Savilleinline bool HasFastArraySerialization(const FileDescriptor* file) { 147fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville return file->options().optimize_for() == FileOptions::SPEED; 148fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} 149fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 150d0332953cda33fb4f8e24ebff9c49159b69c43d6Wink Saville 151fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace cpp 152fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace compiler 153fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace protobuf 154fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville 155fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville} // namespace google 156fbaaef999ba563838ebd00874ed8a1c01fbf286dWink Saville#endif // GOOGLE_PROTOBUF_COMPILER_CPP_HELPERS_H__ 157