1 // Protocol Buffers - Google's data interchange format 2 // Copyright 2008 Google Inc. All rights reserved. 3 // https://developers.google.com/protocol-buffers/ 4 // 5 // Redistribution and use in source and binary forms, with or without 6 // modification, are permitted provided that the following conditions are 7 // met: 8 // 9 // * Redistributions of source code must retain the above copyright 10 // notice, this list of conditions and the following disclaimer. 11 // * Redistributions in binary form must reproduce the above 12 // copyright notice, this list of conditions and the following disclaimer 13 // in the documentation and/or other materials provided with the 14 // distribution. 15 // * Neither the name of Google Inc. nor the names of its 16 // contributors may be used to endorse or promote products derived from 17 // this software without specific prior written permission. 18 // 19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 30 31 #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ 32 #define GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ 33 34 #include <map> 35 #include <string> 36 37 #include <google/protobuf/stubs/common.h> 38 39 namespace google { 40 namespace protobuf { 41 class Descriptor; 42 class EnumDescriptor; 43 class FieldDescriptor; 44 class FileDescriptor; 45 class ServiceDescriptor; 46 47 namespace compiler { 48 namespace java { 49 50 // Indicates how closely the two class names match. 51 enum NameEquality { NO_MATCH, EXACT_EQUAL, EQUAL_IGNORE_CASE }; 52 53 // Used to get the Java class related names for a given descriptor. It caches 54 // the results to avoid redundant calculation across multiple name queries. 55 // Thread-safety note: This class is *not* thread-safe. 56 class ClassNameResolver { 57 public: 58 ClassNameResolver(); 59 ~ClassNameResolver(); 60 61 // Gets the unqualified outer class name for the file. 62 std::string GetFileClassName(const FileDescriptor* file, bool immutable); 63 std::string GetFileClassName(const FileDescriptor* file, bool immutable, 64 bool kotlin); 65 // Gets the unqualified immutable outer class name of a file. 66 std::string GetFileImmutableClassName(const FileDescriptor* file); 67 // Gets the unqualified default immutable outer class name of a file 68 // (converted from the proto file's name). 69 std::string GetFileDefaultImmutableClassName(const FileDescriptor* file); 70 71 // Check whether there is any type defined in the proto file that has 72 // the given class name. 73 bool HasConflictingClassName(const FileDescriptor* file, 74 const std::string& classname, 75 NameEquality equality_mode); 76 77 // Gets the name of the outer class that holds descriptor information. 78 // Descriptors are shared between immutable messages and mutable messages. 79 // Since both of them are generated optionally, the descriptors need to be 80 // put in another common place. 81 std::string GetDescriptorClassName(const FileDescriptor* file); 82 83 // Gets the fully-qualified class name corresponding to the given descriptor. 84 std::string GetClassName(const Descriptor* descriptor, bool immutable); 85 std::string GetClassName(const Descriptor* descriptor, bool immutable, 86 bool kotlin); 87 std::string GetClassName(const EnumDescriptor* descriptor, bool immutable); 88 std::string GetClassName(const EnumDescriptor* descriptor, bool immutable, 89 bool kotlin); 90 std::string GetClassName(const ServiceDescriptor* descriptor, bool immutable); 91 std::string GetClassName(const ServiceDescriptor* descriptor, bool immutable, 92 bool kotlin); 93 std::string GetClassName(const FileDescriptor* descriptor, bool immutable); 94 std::string GetClassName(const FileDescriptor* descriptor, bool immutable, 95 bool kotlin); 96 97 template <class DescriptorType> GetImmutableClassName(const DescriptorType * descriptor)98 std::string GetImmutableClassName(const DescriptorType* descriptor) { 99 return GetClassName(descriptor, true); 100 } 101 template <class DescriptorType> GetMutableClassName(const DescriptorType * descriptor)102 std::string GetMutableClassName(const DescriptorType* descriptor) { 103 return GetClassName(descriptor, false); 104 } 105 106 // Gets the fully qualified name of an extension identifier. 107 std::string GetExtensionIdentifierName(const FieldDescriptor* descriptor, 108 bool immutable); 109 std::string GetExtensionIdentifierName(const FieldDescriptor* descriptor, 110 bool immutable, bool kotlin); 111 112 // Gets the fully qualified name for generated classes in Java convention. 113 // Nested classes will be separated using '$' instead of '.' 114 // For example: 115 // com.package.OuterClass$OuterMessage$InnerMessage 116 std::string GetJavaImmutableClassName(const Descriptor* descriptor); 117 std::string GetJavaImmutableClassName(const EnumDescriptor* descriptor); 118 std::string GetKotlinFactoryName(const Descriptor* descriptor); 119 std::string GetKotlinExtensionsClassName(const Descriptor* descriptor); 120 std::string GetJavaMutableClassName(const Descriptor* descriptor); 121 std::string GetJavaMutableClassName(const EnumDescriptor* descriptor); 122 // Gets the outer class and the actual class for downgraded mutable messages. 123 std::string GetDowngradedFileClassName(const FileDescriptor* file); 124 std::string GetDowngradedClassName(const Descriptor* descriptor); 125 126 // Get the full name of a Java class by prepending the Java package name 127 // or outer class name. 128 std::string GetClassFullName(const std::string& name_without_package, 129 const FileDescriptor* file, bool immutable, 130 bool is_own_file); 131 std::string GetClassFullName(const std::string& name_without_package, 132 const FileDescriptor* file, bool immutable, 133 bool is_own_file, bool kotlin); 134 135 private: 136 // Get the Java Class style full name of a message. 137 std::string GetJavaClassFullName(const std::string& name_without_package, 138 const FileDescriptor* file, bool immutable); 139 std::string GetJavaClassFullName(const std::string& name_without_package, 140 const FileDescriptor* file, bool immutable, 141 bool kotlin); 142 // Caches the result to provide better performance. 143 std::map<const FileDescriptor*, std::string> 144 file_immutable_outer_class_names_; 145 146 GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ClassNameResolver); 147 }; 148 149 } // namespace java 150 } // namespace compiler 151 } // namespace protobuf 152 } // namespace google 153 154 #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ 155