| // Protocol Buffers - Google's data interchange format |
| // Copyright 2008 Google Inc. All rights reserved. |
| // https://developers.google.com/protocol-buffers/ |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #ifndef GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ |
| #define GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ |
| |
| #include <map> |
| #include <string> |
| |
| #include <google/protobuf/stubs/common.h> |
| |
| namespace google { |
| namespace protobuf { |
| class Descriptor; |
| class EnumDescriptor; |
| class FieldDescriptor; |
| class FileDescriptor; |
| class ServiceDescriptor; |
| |
| namespace compiler { |
| namespace java { |
| |
| // Used to get the Java class related names for a given descriptor. It caches |
| // the results to avoid redundant calculation across multiple name queries. |
| // Thread-safety note: This class is *not* thread-safe. |
| class ClassNameResolver { |
| public: |
| ClassNameResolver(); |
| ~ClassNameResolver(); |
| |
| // Gets the unqualified outer class name for the file. |
| string GetFileClassName(const FileDescriptor* file, bool immutable); |
| // Gets the unqualified immutable outer class name of a file. |
| string GetFileImmutableClassName(const FileDescriptor* file); |
| // Gets the unqualified default immutable outer class name of a file |
| // (converted from the proto file's name). |
| string GetFileDefaultImmutableClassName(const FileDescriptor* file); |
| |
| // Check whether there is any type defined in the proto file that has |
| // the given class name. |
| bool HasConflictingClassName(const FileDescriptor* file, |
| const string& classname); |
| |
| // Gets the name of the outer class that holds descriptor information. |
| // Descriptors are shared between immutable messages and mutable messages. |
| // Since both of them are generated optionally, the descriptors need to be |
| // put in another common place. |
| string GetDescriptorClassName(const FileDescriptor* file); |
| |
| // Gets the fully-qualified class name corresponding to the given descriptor. |
| string GetClassName(const Descriptor* descriptor, bool immutable); |
| string GetClassName(const EnumDescriptor* descriptor, bool immutable); |
| string GetClassName(const ServiceDescriptor* descriptor, bool immutable); |
| string GetClassName(const FileDescriptor* descriptor, bool immutable); |
| |
| template<class DescriptorType> |
| string GetImmutableClassName(const DescriptorType* descriptor) { |
| return GetClassName(descriptor, true); |
| } |
| template<class DescriptorType> |
| string GetMutableClassName(const DescriptorType* descriptor) { |
| return GetClassName(descriptor, false); |
| } |
| |
| // Gets the fully qualified name of an extension identifier. |
| string GetExtensionIdentifierName(const FieldDescriptor* descriptor, |
| bool immutable); |
| |
| // Gets the fully qualified name for generated classes in Java convention. |
| // Nested classes will be separated using '$' instead of '.' |
| // For example: |
| // com.package.OuterClass$OuterMessage$InnerMessage |
| string GetJavaImmutableClassName(const Descriptor* descriptor); |
| private: |
| // Get the full name of a Java class by prepending the Java package name |
| // or outer class name. |
| string GetClassFullName(const string& name_without_package, |
| const FileDescriptor* file, |
| bool immutable, |
| bool multiple_files); |
| // Get the Java Class style full name of a message. |
| string GetJavaClassFullName( |
| const string& name_without_package, |
| const FileDescriptor* file, |
| bool immutable); |
| // Caches the result to provide better performance. |
| map<const FileDescriptor*, string> file_immutable_outer_class_names_; |
| |
| GOOGLE_DISALLOW_EVIL_CONSTRUCTORS(ClassNameResolver); |
| }; |
| |
| } // namespace java |
| } // namespace compiler |
| } // namespace protobuf |
| |
| } // namespace google |
| #endif // GOOGLE_PROTOBUF_COMPILER_JAVA_NAME_RESOLVER_H__ |