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 // Author: kenton@google.com (Kenton Varda)
32 // Based on original Protocol Buffers design by
33 // Sanjay Ghemawat, Jeff Dean, and others.
34
35 #include <google/protobuf/compiler/java/java_extension.h>
36
37 #include <google/protobuf/compiler/java/java_context.h>
38 #include <google/protobuf/compiler/java/java_doc_comment.h>
39 #include <google/protobuf/compiler/java/java_helpers.h>
40 #include <google/protobuf/compiler/java/java_name_resolver.h>
41 #include <google/protobuf/io/printer.h>
42 #include <google/protobuf/stubs/strutil.h>
43
44
45 namespace google {
46 namespace protobuf {
47 namespace compiler {
48 namespace java {
49
ImmutableExtensionGenerator(const FieldDescriptor * descriptor,Context * context)50 ImmutableExtensionGenerator::ImmutableExtensionGenerator(
51 const FieldDescriptor* descriptor, Context* context)
52 : descriptor_(descriptor), name_resolver_(context->GetNameResolver()) {
53 if (descriptor_->extension_scope() != NULL) {
54 scope_ =
55 name_resolver_->GetImmutableClassName(descriptor_->extension_scope());
56 } else {
57 scope_ = name_resolver_->GetImmutableClassName(descriptor_->file());
58 }
59 }
60
~ImmutableExtensionGenerator()61 ImmutableExtensionGenerator::~ImmutableExtensionGenerator() {}
62
63 // Initializes the vars referenced in the generated code templates.
InitTemplateVars(const FieldDescriptor * descriptor,const std::string & scope,bool immutable,ClassNameResolver * name_resolver,std::map<std::string,std::string> * vars_pointer)64 void ExtensionGenerator::InitTemplateVars(
65 const FieldDescriptor* descriptor, const std::string& scope, bool immutable,
66 ClassNameResolver* name_resolver,
67 std::map<std::string, std::string>* vars_pointer) {
68 std::map<std::string, std::string>& vars = *vars_pointer;
69 vars["scope"] = scope;
70 vars["name"] = UnderscoresToCamelCaseCheckReserved(descriptor);
71 vars["containing_type"] =
72 name_resolver->GetClassName(descriptor->containing_type(), immutable);
73 vars["number"] = StrCat(descriptor->number());
74 vars["constant_name"] = FieldConstantName(descriptor);
75 vars["index"] = StrCat(descriptor->index());
76 vars["default"] = descriptor->is_repeated()
77 ? ""
78 : DefaultValue(descriptor, immutable, name_resolver);
79 vars["type_constant"] = FieldTypeName(GetType(descriptor));
80 vars["packed"] = descriptor->is_packed() ? "true" : "false";
81 vars["enum_map"] = "null";
82 vars["prototype"] = "null";
83
84 JavaType java_type = GetJavaType(descriptor);
85 std::string singular_type;
86 switch (java_type) {
87 case JAVATYPE_MESSAGE:
88 singular_type =
89 name_resolver->GetClassName(descriptor->message_type(), immutable);
90 vars["prototype"] = singular_type + ".getDefaultInstance()";
91 break;
92 case JAVATYPE_ENUM:
93 singular_type =
94 name_resolver->GetClassName(descriptor->enum_type(), immutable);
95 vars["enum_map"] = singular_type + ".internalGetValueMap()";
96 break;
97 case JAVATYPE_STRING:
98 singular_type = "java.lang.String";
99 break;
100 case JAVATYPE_BYTES:
101 singular_type = immutable ? "com.google.protobuf.ByteString" : "byte[]";
102 break;
103 default:
104 singular_type = BoxedPrimitiveTypeName(java_type);
105 break;
106 }
107 vars["type"] = descriptor->is_repeated()
108 ? "java.util.List<" + singular_type + ">"
109 : singular_type;
110 vars["singular_type"] = singular_type;
111 }
112
Generate(io::Printer * printer)113 void ImmutableExtensionGenerator::Generate(io::Printer* printer) {
114 std::map<std::string, std::string> vars;
115 const bool kUseImmutableNames = true;
116 InitTemplateVars(descriptor_, scope_, kUseImmutableNames, name_resolver_,
117 &vars);
118 printer->Print(vars, "public static final int $constant_name$ = $number$;\n");
119
120 WriteFieldDocComment(printer, descriptor_);
121 if (descriptor_->extension_scope() == NULL) {
122 // Non-nested
123 printer->Print(
124 vars,
125 "public static final\n"
126 " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
127 " $containing_type$,\n"
128 " $type$> $name$ = com.google.protobuf.GeneratedMessage\n"
129 " .newFileScopedGeneratedExtension(\n"
130 " $singular_type$.class,\n"
131 " $prototype$);\n");
132 } else {
133 // Nested
134 printer->Print(
135 vars,
136 "public static final\n"
137 " com.google.protobuf.GeneratedMessage.GeneratedExtension<\n"
138 " $containing_type$,\n"
139 " $type$> $name$ = com.google.protobuf.GeneratedMessage\n"
140 " .newMessageScopedGeneratedExtension(\n"
141 " $scope$.getDefaultInstance(),\n"
142 " $index$,\n"
143 " $singular_type$.class,\n"
144 " $prototype$);\n");
145 }
146 printer->Annotate("name", descriptor_);
147 }
148
GenerateNonNestedInitializationCode(io::Printer * printer)149 int ImmutableExtensionGenerator::GenerateNonNestedInitializationCode(
150 io::Printer* printer) {
151 int bytecode_estimate = 0;
152 if (descriptor_->extension_scope() == NULL) {
153 // Only applies to non-nested extensions.
154 printer->Print(
155 "$name$.internalInit(descriptor.getExtensions().get($index$));\n",
156 "name", UnderscoresToCamelCaseCheckReserved(descriptor_), "index",
157 StrCat(descriptor_->index()));
158 bytecode_estimate += 21;
159 }
160 return bytecode_estimate;
161 }
162
GenerateRegistrationCode(io::Printer * printer)163 int ImmutableExtensionGenerator::GenerateRegistrationCode(
164 io::Printer* printer) {
165 printer->Print("registry.add($scope$.$name$);\n", "scope", scope_, "name",
166 UnderscoresToCamelCaseCheckReserved(descriptor_));
167 return 7;
168 }
169
170 } // namespace java
171 } // namespace compiler
172 } // namespace protobuf
173 } // namespace google
174