java_name_resolver.cc 9.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274
  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. #include <google/protobuf/compiler/java/java_name_resolver.h>
  31. #include <map>
  32. #include <string>
  33. #include <google/protobuf/compiler/java/java_helpers.h>
  34. #include <google/protobuf/stubs/substitute.h>
  35. namespace google {
  36. namespace protobuf {
  37. namespace compiler {
  38. namespace java {
  39. namespace {
  40. // A suffix that will be appended to the file's outer class name if the name
  41. // conflicts with some other types defined in the file.
  42. const char* kOuterClassNameSuffix = "OuterClass";
  43. // Strip package name from a descriptor's full name.
  44. // For example:
  45. // Full name : foo.Bar.Baz
  46. // Package name: foo
  47. // After strip : Bar.Baz
  48. string StripPackageName(const string& full_name,
  49. const FileDescriptor* file) {
  50. if (file->package().empty()) {
  51. return full_name;
  52. } else {
  53. // Strip package name
  54. return full_name.substr(file->package().size() + 1);
  55. }
  56. }
  57. // Get the name of a message's Java class without package name prefix.
  58. string ClassNameWithoutPackage(const Descriptor* descriptor,
  59. bool immutable) {
  60. return StripPackageName(descriptor->full_name(),
  61. descriptor->file());
  62. }
  63. // Get the name of an enum's Java class without package name prefix.
  64. string ClassNameWithoutPackage(const EnumDescriptor* descriptor,
  65. bool immutable) {
  66. // Doesn't append "Mutable" for enum type's name.
  67. const Descriptor* message_descriptor = descriptor->containing_type();
  68. if (message_descriptor == NULL) {
  69. return descriptor->name();
  70. } else {
  71. return ClassNameWithoutPackage(message_descriptor, immutable) +
  72. "." + descriptor->name();
  73. }
  74. }
  75. // Get the name of a service's Java class without package name prefix.
  76. string ClassNameWithoutPackage(const ServiceDescriptor* descriptor,
  77. bool immutable) {
  78. string full_name = StripPackageName(descriptor->full_name(),
  79. descriptor->file());
  80. // We don't allow nested service definitions.
  81. GOOGLE_CHECK(full_name.find('.') == string::npos);
  82. return full_name;
  83. }
  84. // Check whether a given message or its nested types has the given class name.
  85. bool MessageHasConflictingClassName(const Descriptor* message,
  86. const string& classname) {
  87. if (message->name() == classname) return true;
  88. for (int i = 0; i < message->nested_type_count(); ++i) {
  89. if (MessageHasConflictingClassName(message->nested_type(i), classname)) {
  90. return true;
  91. }
  92. }
  93. for (int i = 0; i < message->enum_type_count(); ++i) {
  94. if (message->enum_type(i)->name() == classname) {
  95. return true;
  96. }
  97. }
  98. return false;
  99. }
  100. } // namespace
  101. ClassNameResolver::ClassNameResolver() {
  102. }
  103. ClassNameResolver::~ClassNameResolver() {
  104. }
  105. string ClassNameResolver::GetFileDefaultImmutableClassName(
  106. const FileDescriptor* file) {
  107. string basename;
  108. string::size_type last_slash = file->name().find_last_of('/');
  109. if (last_slash == string::npos) {
  110. basename = file->name();
  111. } else {
  112. basename = file->name().substr(last_slash + 1);
  113. }
  114. return UnderscoresToCamelCase(StripProto(basename), true);
  115. }
  116. string ClassNameResolver::GetFileImmutableClassName(
  117. const FileDescriptor* file) {
  118. string& class_name = file_immutable_outer_class_names_[file];
  119. if (class_name.empty()) {
  120. if (file->options().has_java_outer_classname()) {
  121. class_name = file->options().java_outer_classname();
  122. } else {
  123. class_name = GetFileDefaultImmutableClassName(file);
  124. if (HasConflictingClassName(file, class_name)) {
  125. class_name += kOuterClassNameSuffix;
  126. }
  127. }
  128. }
  129. return class_name;
  130. }
  131. string ClassNameResolver::GetFileClassName(const FileDescriptor* file,
  132. bool immutable) {
  133. if (immutable) {
  134. return GetFileImmutableClassName(file);
  135. } else {
  136. return "Mutable" + GetFileImmutableClassName(file);
  137. }
  138. }
  139. // Check whether there is any type defined in the proto file that has
  140. // the given class name.
  141. bool ClassNameResolver::HasConflictingClassName(
  142. const FileDescriptor* file, const string& classname) {
  143. for (int i = 0; i < file->enum_type_count(); i++) {
  144. if (file->enum_type(i)->name() == classname) {
  145. return true;
  146. }
  147. }
  148. for (int i = 0; i < file->service_count(); i++) {
  149. if (file->service(i)->name() == classname) {
  150. return true;
  151. }
  152. }
  153. for (int i = 0; i < file->message_type_count(); i++) {
  154. if (MessageHasConflictingClassName(file->message_type(i), classname)) {
  155. return true;
  156. }
  157. }
  158. return false;
  159. }
  160. string ClassNameResolver::GetDescriptorClassName(
  161. const FileDescriptor* descriptor) {
  162. return GetFileImmutableClassName(descriptor);
  163. }
  164. string ClassNameResolver::GetClassName(const FileDescriptor* descriptor,
  165. bool immutable) {
  166. string result = FileJavaPackage(descriptor, immutable);
  167. if (!result.empty()) result += '.';
  168. result += GetFileClassName(descriptor, immutable);
  169. return result;
  170. }
  171. // Get the full name of a Java class by prepending the Java package name
  172. // or outer class name.
  173. string ClassNameResolver::GetClassFullName(const string& name_without_package,
  174. const FileDescriptor* file,
  175. bool immutable,
  176. bool multiple_files) {
  177. string result;
  178. if (multiple_files) {
  179. result = FileJavaPackage(file, immutable);
  180. } else {
  181. result = GetClassName(file, immutable);
  182. }
  183. if (!result.empty()) {
  184. result += '.';
  185. }
  186. result += name_without_package;
  187. return result;
  188. }
  189. string ClassNameResolver::GetClassName(const Descriptor* descriptor,
  190. bool immutable) {
  191. return GetClassFullName(ClassNameWithoutPackage(descriptor, immutable),
  192. descriptor->file(), immutable,
  193. MultipleJavaFiles(descriptor->file(), immutable));
  194. }
  195. string ClassNameResolver::GetClassName(const EnumDescriptor* descriptor,
  196. bool immutable) {
  197. return GetClassFullName(ClassNameWithoutPackage(descriptor, immutable),
  198. descriptor->file(), immutable,
  199. MultipleJavaFiles(descriptor->file(), immutable));
  200. }
  201. string ClassNameResolver::GetClassName(const ServiceDescriptor* descriptor,
  202. bool immutable) {
  203. return GetClassFullName(ClassNameWithoutPackage(descriptor, immutable),
  204. descriptor->file(), immutable,
  205. MultipleJavaFiles(descriptor->file(), immutable));
  206. }
  207. // Get the Java Class style full name of a message.
  208. string ClassNameResolver::GetJavaClassFullName(
  209. const string& name_without_package,
  210. const FileDescriptor* file,
  211. bool immutable) {
  212. string result;
  213. if (MultipleJavaFiles(file, immutable)) {
  214. result = FileJavaPackage(file, immutable);
  215. if (!result.empty()) result += '.';
  216. } else {
  217. result = GetClassName(file, immutable);
  218. if (!result.empty()) result += '$';
  219. }
  220. result += StringReplace(name_without_package, ".", "$", true);
  221. return result;
  222. }
  223. string ClassNameResolver::GetExtensionIdentifierName(
  224. const FieldDescriptor* descriptor, bool immutable) {
  225. return GetClassName(descriptor->containing_type(), immutable) + "." +
  226. descriptor->name();
  227. }
  228. string ClassNameResolver::GetJavaImmutableClassName(
  229. const Descriptor* descriptor) {
  230. return GetJavaClassFullName(
  231. ClassNameWithoutPackage(descriptor, true),
  232. descriptor->file(), true);
  233. }
  234. string ClassNameResolver::GetJavaImmutableClassName(
  235. const EnumDescriptor* descriptor) {
  236. return GetJavaClassFullName(
  237. ClassNameWithoutPackage(descriptor, true),
  238. descriptor->file(), true);
  239. }
  240. } // namespace java
  241. } // namespace compiler
  242. } // namespace protobuf
  243. } // namespace google