1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2015 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 #include <map>
32 #include <string>
33
34 #include <google/protobuf/compiler/objectivec/objectivec_map_field.h>
35 #include <google/protobuf/compiler/objectivec/objectivec_helpers.h>
36 #include <google/protobuf/io/printer.h>
37
38 namespace google {
39 namespace protobuf {
40 namespace compiler {
41 namespace objectivec {
42
43 // MapFieldGenerator uses RepeatedFieldGenerator as the parent because it
44 // provides a bunch of things (no has* methods, comments for contained type,
45 // etc.).
46
47 namespace {
48
MapEntryTypeName(const FieldDescriptor * descriptor,bool isKey)49 const char* MapEntryTypeName(const FieldDescriptor* descriptor, bool isKey) {
50 ObjectiveCType type = GetObjectiveCType(descriptor);
51 switch (type) {
52 case OBJECTIVECTYPE_INT32:
53 return "Int32";
54 case OBJECTIVECTYPE_UINT32:
55 return "UInt32";
56 case OBJECTIVECTYPE_INT64:
57 return "Int64";
58 case OBJECTIVECTYPE_UINT64:
59 return "UInt64";
60 case OBJECTIVECTYPE_FLOAT:
61 return "Float";
62 case OBJECTIVECTYPE_DOUBLE:
63 return "Double";
64 case OBJECTIVECTYPE_BOOLEAN:
65 return "Bool";
66 case OBJECTIVECTYPE_STRING:
67 return (isKey ? "String" : "Object");
68 case OBJECTIVECTYPE_DATA:
69 return "Object";
70 case OBJECTIVECTYPE_ENUM:
71 return "Enum";
72 case OBJECTIVECTYPE_MESSAGE:
73 return "Object";
74 }
75
76 // Some compilers report reaching end of function even though all cases of
77 // the enum are handed in the switch.
78 GOOGLE_LOG(FATAL) << "Can't get here.";
79 return NULL;
80 }
81
82 } // namespace
83
MapFieldGenerator(const FieldDescriptor * descriptor,const Options & options)84 MapFieldGenerator::MapFieldGenerator(const FieldDescriptor* descriptor,
85 const Options& options)
86 : RepeatedFieldGenerator(descriptor, options) {
87 const FieldDescriptor* key_descriptor =
88 descriptor->message_type()->map_key();
89 const FieldDescriptor* value_descriptor =
90 descriptor->message_type()->map_value();
91 value_field_generator_.reset(FieldGenerator::Make(value_descriptor, options));
92
93 // Pull over some variables_ from the value.
94 variables_["field_type"] = value_field_generator_->variable("field_type");
95 variables_["default"] = value_field_generator_->variable("default");
96 variables_["default_name"] = value_field_generator_->variable("default_name");
97
98 // Build custom field flags.
99 std::vector<std::string> field_flags;
100 field_flags.push_back("GPBFieldMapKey" + GetCapitalizedType(key_descriptor));
101 // Pull over the current text format custom name values that was calculated.
102 if (variables_["fieldflags"].find("GPBFieldTextFormatNameCustom") !=
103 std::string::npos) {
104 field_flags.push_back("GPBFieldTextFormatNameCustom");
105 }
106 // Pull over some info from the value's flags.
107 const std::string& value_field_flags =
108 value_field_generator_->variable("fieldflags");
109 if (value_field_flags.find("GPBFieldHasDefaultValue") != std::string::npos) {
110 field_flags.push_back("GPBFieldHasDefaultValue");
111 }
112 if (value_field_flags.find("GPBFieldHasEnumDescriptor") !=
113 std::string::npos) {
114 field_flags.push_back("GPBFieldHasEnumDescriptor");
115 }
116
117 variables_["fieldflags"] = BuildFlagsString(FLAGTYPE_FIELD, field_flags);
118
119 ObjectiveCType value_objc_type = GetObjectiveCType(value_descriptor);
120 const bool value_is_object_type =
121 ((value_objc_type == OBJECTIVECTYPE_STRING) ||
122 (value_objc_type == OBJECTIVECTYPE_DATA) ||
123 (value_objc_type == OBJECTIVECTYPE_MESSAGE));
124 if ((GetObjectiveCType(key_descriptor) == OBJECTIVECTYPE_STRING) &&
125 value_is_object_type) {
126 variables_["array_storage_type"] = "NSMutableDictionary";
127 variables_["array_property_type"] =
128 "NSMutableDictionary<NSString*, " +
129 value_field_generator_->variable("storage_type") + "*>";
130 } else {
131 std::string class_name("GPB");
132 class_name += MapEntryTypeName(key_descriptor, true);
133 class_name += MapEntryTypeName(value_descriptor, false);
134 class_name += "Dictionary";
135 variables_["array_storage_type"] = class_name;
136 if (value_is_object_type) {
137 variables_["array_property_type"] =
138 class_name + "<" +
139 value_field_generator_->variable("storage_type") + "*>";
140 }
141 }
142
143 variables_["dataTypeSpecific_name"] =
144 value_field_generator_->variable("dataTypeSpecific_name");
145 variables_["dataTypeSpecific_value"] =
146 value_field_generator_->variable("dataTypeSpecific_value");
147 }
148
~MapFieldGenerator()149 MapFieldGenerator::~MapFieldGenerator() {}
150
FinishInitialization(void)151 void MapFieldGenerator::FinishInitialization(void) {
152 RepeatedFieldGenerator::FinishInitialization();
153 // Use the array_comment support in RepeatedFieldGenerator to output what the
154 // values in the map are.
155 const FieldDescriptor* value_descriptor =
156 descriptor_->message_type()->FindFieldByName("value");
157 if (GetObjectiveCType(value_descriptor) == OBJECTIVECTYPE_ENUM) {
158 variables_["array_comment"] =
159 "// |" + variables_["name"] + "| values are |" + value_field_generator_->variable("storage_type") + "|\n";
160 }
161 }
162
DetermineForwardDeclarations(std::set<std::string> * fwd_decls) const163 void MapFieldGenerator::DetermineForwardDeclarations(
164 std::set<std::string>* fwd_decls) const {
165 RepeatedFieldGenerator::DetermineForwardDeclarations(fwd_decls);
166 const FieldDescriptor* value_descriptor =
167 descriptor_->message_type()->FindFieldByName("value");
168 if (GetObjectiveCType(value_descriptor) == OBJECTIVECTYPE_MESSAGE) {
169 const std::string& value_storage_type =
170 value_field_generator_->variable("storage_type");
171 fwd_decls->insert("@class " + value_storage_type);
172 }
173 }
174
DetermineObjectiveCClassDefinitions(std::set<std::string> * fwd_decls) const175 void MapFieldGenerator::DetermineObjectiveCClassDefinitions(
176 std::set<std::string>* fwd_decls) const {
177 // Class name is already in "storage_type".
178 const FieldDescriptor* value_descriptor =
179 descriptor_->message_type()->FindFieldByName("value");
180 if (GetObjectiveCType(value_descriptor) == OBJECTIVECTYPE_MESSAGE) {
181 fwd_decls->insert(ObjCClassDeclaration(
182 value_field_generator_->variable("storage_type")));
183 }
184 }
185
186 } // namespace objectivec
187 } // namespace compiler
188 } // namespace protobuf
189 } // namespace google
190