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 #include <map>
32 #include <string>
33
34 #include <google/protobuf/compiler/objectivec/objectivec_message_field.h>
35 #include <google/protobuf/compiler/objectivec/objectivec_helpers.h>
36 #include <google/protobuf/io/printer.h>
37 #include <google/protobuf/wire_format.h>
38
39 namespace google {
40 namespace protobuf {
41 namespace compiler {
42 namespace objectivec {
43
44 namespace {
45
SetMessageVariables(const FieldDescriptor * descriptor,std::map<std::string,std::string> * variables)46 void SetMessageVariables(const FieldDescriptor* descriptor,
47 std::map<std::string, std::string>* variables) {
48 const std::string& message_type = ClassName(descriptor->message_type());
49 const std::string& containing_class =
50 ClassName(descriptor->containing_type());
51 (*variables)["type"] = message_type;
52 (*variables)["containing_class"] = containing_class;
53 (*variables)["storage_type"] = message_type;
54 (*variables)["group_or_message"] =
55 (descriptor->type() == FieldDescriptor::TYPE_GROUP) ? "Group" : "Message";
56 (*variables)["dataTypeSpecific_value"] = ObjCClass(message_type);
57 }
58
59 } // namespace
60
MessageFieldGenerator(const FieldDescriptor * descriptor)61 MessageFieldGenerator::MessageFieldGenerator(const FieldDescriptor* descriptor)
62 : ObjCObjFieldGenerator(descriptor) {
63 SetMessageVariables(descriptor, &variables_);
64 }
65
~MessageFieldGenerator()66 MessageFieldGenerator::~MessageFieldGenerator() {}
67
DetermineForwardDeclarations(std::set<std::string> * fwd_decls,bool include_external_types) const68 void MessageFieldGenerator::DetermineForwardDeclarations(
69 std::set<std::string>* fwd_decls,
70 bool include_external_types) const {
71 ObjCObjFieldGenerator::DetermineForwardDeclarations(
72 fwd_decls, include_external_types);
73 // Within a file there is no requirement on the order of the messages, so
74 // local references need a forward declaration. External files (not WKTs),
75 // need one when requested.
76 if ((include_external_types &&
77 !IsProtobufLibraryBundledProtoFile(descriptor_->message_type()->file())) ||
78 descriptor_->file() == descriptor_->message_type()->file()) {
79 // Class name is already in "storage_type".
80 fwd_decls->insert("@class " + variable("storage_type"));
81 }
82 }
83
DetermineObjectiveCClassDefinitions(std::set<std::string> * fwd_decls) const84 void MessageFieldGenerator::DetermineObjectiveCClassDefinitions(
85 std::set<std::string>* fwd_decls) const {
86 fwd_decls->insert(ObjCClassDeclaration(variable("storage_type")));
87 }
88
RepeatedMessageFieldGenerator(const FieldDescriptor * descriptor)89 RepeatedMessageFieldGenerator::RepeatedMessageFieldGenerator(
90 const FieldDescriptor* descriptor)
91 : RepeatedFieldGenerator(descriptor) {
92 SetMessageVariables(descriptor, &variables_);
93 variables_["array_storage_type"] = "NSMutableArray";
94 variables_["array_property_type"] =
95 "NSMutableArray<" + variables_["storage_type"] + "*>";
96 }
97
~RepeatedMessageFieldGenerator()98 RepeatedMessageFieldGenerator::~RepeatedMessageFieldGenerator() {}
99
DetermineForwardDeclarations(std::set<std::string> * fwd_decls,bool include_external_types) const100 void RepeatedMessageFieldGenerator::DetermineForwardDeclarations(
101 std::set<std::string>* fwd_decls,
102 bool include_external_types) const {
103 RepeatedFieldGenerator::DetermineForwardDeclarations(
104 fwd_decls, include_external_types);
105 // Within a file there is no requirement on the order of the messages, so
106 // local references need a forward declaration. External files (not WKTs),
107 // need one when requested.
108 if ((include_external_types &&
109 !IsProtobufLibraryBundledProtoFile(descriptor_->message_type()->file())) ||
110 descriptor_->file() == descriptor_->message_type()->file()) {
111 // Class name is already in "storage_type".
112 fwd_decls->insert("@class " + variable("storage_type"));
113 }
114 }
115
DetermineObjectiveCClassDefinitions(std::set<std::string> * fwd_decls) const116 void RepeatedMessageFieldGenerator::DetermineObjectiveCClassDefinitions(
117 std::set<std::string>* fwd_decls) const {
118 fwd_decls->insert(ObjCClassDeclaration(variable("storage_type")));
119 }
120
121 } // namespace objectivec
122 } // namespace compiler
123 } // namespace protobuf
124 } // namespace google
125