javanano_helpers.h revision 47dee56155c7bdb9855e51ff08c99db306d11a2d
15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Protocol Buffers - Google's data interchange format 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Copyright 2008 Google Inc. All rights reserved. 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// http://code.google.com/p/protobuf/ 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Redistribution and use in source and binary forms, with or without 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// modification, are permitted provided that the following conditions are 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// met: 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// * Redistributions of source code must retain the above copyright 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// notice, this list of conditions and the following disclaimer. 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// * Redistributions in binary form must reproduce the above 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// in the documentation and/or other materials provided with the 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// distribution. 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// contributors may be used to endorse or promote products derived from 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// this software without specific prior written permission. 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 295c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles) 311e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)// Author: kenton@google.com (Kenton Varda) 321e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)// Based on original Protocol Buffers design by 33a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles)// Sanjay Ghemawat, Jeff Dean, and others. 34a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles) 35a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles)#ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_HELPERS_H__ 36a854de003a23bf3c7f95ec0f8154ada64092ff5cTorne (Richard Coles)#define GOOGLE_PROTOBUF_COMPILER_JAVA_HELPERS_H__ 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 3810f88d5669dbd969c059d61ba09fa37dd72ac559Ben Murdoch#include <string> 395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include <google/protobuf/compiler/javanano/javanano_params.h> 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include <google/protobuf/descriptor.pb.h> 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include <google/protobuf/descriptor.h> 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)namespace google { 44c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles)namespace protobuf { 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)namespace compiler { 468abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles)namespace javanano { 475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Commonly-used separator comments. Thick is a line of '=', thin is a line 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// of '-'. 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)extern const char kThickSeparator[]; 51c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles)extern const char kThinSeparator[]; 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Converts the field's name to camel-case, e.g. "foo_bar_baz" becomes 545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// "fooBarBaz" or "FooBarBaz", respectively. 555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string UnderscoresToCamelCase(const FieldDescriptor* field); 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string UnderscoresToCapitalizedCamelCase(const FieldDescriptor* field); 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Appends an "_" to the end of a field where the name is a reserved java 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// keyword. For example int32 public = 1 will generate int public_. 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string RenameJavaKeywords(const string& input); 615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Similar, but for method names. (Typically, this merely has the effect 63926b001d589ce2f10facb93dd4b87578ea35a855Torne (Richard Coles)// of lower-casing the first letter of the name.) 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string UnderscoresToCamelCase(const MethodDescriptor* method); 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Strips ".proto" or ".protodevel" from the end of a filename. 675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string StripProto(const string& filename); 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Gets the unqualified class name for the file. Each .proto file becomes a 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// single Java class, with all its contents nested in that class. 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string FileClassName(const Params& params, const FileDescriptor* file); 725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 735c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Returns the file's Java package name. 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string FileJavaPackage(const Params& params, const FileDescriptor* file); 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Returns whether the Java outer class is needed, i.e. whether the option 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// java_multiple_files is false, or the proto file contains any file-scope 785c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// enums/extensions. 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)bool IsOuterClassNeeded(const Params& params, const FileDescriptor* file); 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Converts the given simple name of a proto entity to its fully-qualified name 825c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// in the Java namespace, given that it is in the given file enclosed in the 83f5e4ad553afbc08dd2e729bb77e937a9a94d5827Torne (Richard Coles)// given parent message (or NULL for file-scope entities). Whether the file's 845c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// outer class name should be included in the return value depends on factors 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// inferrable from the given arguments, including is_class which indicates 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// whether the entity translates to a Java class. 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string ToJavaName(const Params& params, const string& name, bool is_class, 885c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) const Descriptor* parent, const FileDescriptor* file); 8902772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// These return the fully-qualified class name corresponding to the given 915c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// descriptor. 925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)inline string ClassName(const Params& params, const Descriptor* descriptor) { 931e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) return ToJavaName(params, descriptor->name(), true, 941e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) descriptor->containing_type(), descriptor->file()); 951e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 961e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)string ClassName(const Params& params, const EnumDescriptor* descriptor); 971e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)inline string ClassName(const Params& params, 981e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) const ServiceDescriptor* descriptor) { 991e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) return ToJavaName(params, descriptor->name(), true, NULL, descriptor->file()); 1001e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles)} 1017242dc3dbeb210b5e876a3c42d1ec1a667fc621aPrimiano Tucciinline string ExtensionIdentifierName(const Params& params, 1021e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) const FieldDescriptor* descriptor) { 1031e202183a5dc46166763171984b285173f8585e5Torne (Richard Coles) return ToJavaName(params, descriptor->name(), false, 1045c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) descriptor->extension_scope(), descriptor->file()); 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} 1065c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string ClassName(const Params& params, const FileDescriptor* descriptor); 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Get the unqualified name that should be used for a field's field 1095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// number constant. 1105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string FieldConstantName(const FieldDescriptor *field); 1115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string FieldDefaultConstantName(const FieldDescriptor *field); 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum JavaType { 1155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_INT, 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_LONG, 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_FLOAT, 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_DOUBLE, 1195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_BOOLEAN, 1205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_STRING, 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_BYTES, 12251b2906e11752df6c18351cf520e30522d3b53a1Torne (Richard Coles) JAVATYPE_ENUM, 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) JAVATYPE_MESSAGE 1245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 1258abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) 126c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles)JavaType GetJavaType(FieldDescriptor::Type field_type); 127c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) 1288abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles)inline JavaType GetJavaType(const FieldDescriptor* field) { 1298abfc5808a4e34d6e03867af8bc440dee641886fTorne (Richard Coles) return GetJavaType(field->type()); 130c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles)} 131c0e19a689c8ac22cdc96b291a8d33a5d3b0b34a4Torne (Richard Coles) 1325c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Get the fully-qualified class name for a boxed primitive type, e.g. 1335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// "java.lang.Integer" for JAVATYPE_INT. Returns NULL for enum and message 1345c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// types. 1355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)const char* BoxedPrimitiveTypeName(JavaType type); 136f5e4ad553afbc08dd2e729bb77e937a9a94d5827Torne (Richard Coles) 1375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string EmptyArrayName(const Params& params, const FieldDescriptor* field); 1385c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1395c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string DefaultValue(const Params& params, const FieldDescriptor* field); 1405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Methods for shared bitfields. 1435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 14402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch// Gets the name of the shared bitfield for the given index. 1455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string GetBitFieldName(int index); 1465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1475c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Gets the name of the shared bitfield for the given bit index. 1485c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Effectively, GetBitFieldName(bit_index / 32) 1495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string GetBitFieldNameForBit(int bit_index); 1505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1515c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Generates the java code for the expression that returns the boolean value 1525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// of the bit of the shared bitfields for the given bit index. 1535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Example: "((bitField1_ & 0x04) == 0x04)" 1545c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string GenerateGetBit(int bit_index); 1555c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Generates the java code for the expression that sets the bit of the shared 1575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// bitfields for the given bit index. 1585c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Example: "bitField1_ = (bitField1_ | 0x04)" 1595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string GenerateSetBit(int bit_index); 1605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1615c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Generates the java code for the expression that clears the bit of the shared 1625c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// bitfields for the given bit index. 1635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)// Example: "bitField1_ = (bitField1_ & ~0x04)" 1645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)string GenerateClearBit(int bit_index); 1655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} // namespace javanano 1675c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} // namespace compiler 1685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} // namespace protobuf 1695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)} // namespace google 1715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif // GOOGLE_PROTOBUF_COMPILER_JAVA_HELPERS_H__ 1725c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)