1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
|
// 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.
#include <google/protobuf/compiler/java/context.h>
#include <google/protobuf/descriptor.h>
#include <google/protobuf/stubs/strutil.h>
#include <google/protobuf/compiler/java/field.h>
#include <google/protobuf/compiler/java/helpers.h>
#include <google/protobuf/compiler/java/name_resolver.h>
#include <google/protobuf/stubs/map_util.h>
namespace google {
namespace protobuf {
namespace compiler {
namespace java {
Context::Context(const FileDescriptor* file, const Options& options)
: name_resolver_(new ClassNameResolver), options_(options) {
InitializeFieldGeneratorInfo(file);
}
Context::~Context() {}
ClassNameResolver* Context::GetNameResolver() const {
return name_resolver_.get();
}
namespace {
// Whether two fields have conflicting accessors (assuming name1 and name2
// are different). name1 and name2 are field1 and field2's camel-case name
// respectively.
bool IsConflicting(const FieldDescriptor* field1, const TProtoStringType& name1,
const FieldDescriptor* field2, const TProtoStringType& name2,
TProtoStringType* info) {
if (field1->is_repeated()) {
if (field2->is_repeated()) {
// Both fields are repeated.
return false;
} else {
// field1 is repeated, and field2 is not.
if (name1 + "Count" == name2) {
*info = "both repeated field \"" + field1->name() + "\" and singular " +
"field \"" + field2->name() + "\" generate the method \"" +
"get" + name1 + "Count()\"";
return true;
}
if (name1 + "List" == name2) {
*info = "both repeated field \"" + field1->name() + "\" and singular " +
"field \"" + field2->name() + "\" generate the method \"" +
"get" + name1 + "List()\"";
return true;
}
// Well, there are obviously many more conflicting cases, but it probably
// doesn't worth the effort to exhaust all of them because they rarely
// happen and as we are continuing adding new methods/changing existing
// methods the number of different conflicting cases will keep growing.
// We can just add more cases here when they are found in the real world.
return false;
}
} else {
if (field2->is_repeated()) {
return IsConflicting(field2, name2, field1, name1, info);
} else {
// None of the two fields are repeated.
return false;
}
}
}
} // namespace
void Context::InitializeFieldGeneratorInfo(const FileDescriptor* file) {
for (int i = 0; i < file->message_type_count(); ++i) {
InitializeFieldGeneratorInfoForMessage(file->message_type(i));
}
}
void Context::InitializeFieldGeneratorInfoForMessage(
const Descriptor* message) {
for (int i = 0; i < message->nested_type_count(); ++i) {
InitializeFieldGeneratorInfoForMessage(message->nested_type(i));
}
std::vector<const FieldDescriptor*> fields;
fields.reserve(message->field_count());
for (int i = 0; i < message->field_count(); ++i) {
fields.push_back(message->field(i));
}
InitializeFieldGeneratorInfoForFields(fields);
for (int i = 0; i < message->oneof_decl_count(); ++i) {
const OneofDescriptor* oneof = message->oneof_decl(i);
OneofGeneratorInfo info;
info.name = UnderscoresToCamelCase(oneof->name(), false);
info.capitalized_name = UnderscoresToCamelCase(oneof->name(), true);
oneof_generator_info_map_[oneof] = info;
}
}
void Context::InitializeFieldGeneratorInfoForFields(
const std::vector<const FieldDescriptor*>& fields) {
// Find out all fields that conflict with some other field in the same
// message.
std::vector<bool> is_conflict(fields.size());
std::vector<TProtoStringType> conflict_reason(fields.size());
for (int i = 0; i < fields.size(); ++i) {
const FieldDescriptor* field = fields[i];
const TProtoStringType& name = UnderscoresToCapitalizedCamelCase(field);
for (int j = i + 1; j < fields.size(); ++j) {
const FieldDescriptor* other = fields[j];
const TProtoStringType& other_name = UnderscoresToCapitalizedCamelCase(other);
if (name == other_name) {
is_conflict[i] = is_conflict[j] = true;
conflict_reason[i] = conflict_reason[j] =
"capitalized name of field \"" + field->name() +
"\" conflicts with field \"" + other->name() + "\"";
} else if (IsConflicting(field, name, other, other_name,
&conflict_reason[j])) {
is_conflict[i] = is_conflict[j] = true;
conflict_reason[i] = conflict_reason[j];
}
}
if (is_conflict[i]) {
GOOGLE_LOG(WARNING) << "field \"" << field->full_name() << "\" is conflicting "
<< "with another field: " << conflict_reason[i];
}
}
for (int i = 0; i < fields.size(); ++i) {
const FieldDescriptor* field = fields[i];
FieldGeneratorInfo info;
info.name = CamelCaseFieldName(field);
info.capitalized_name = UnderscoresToCapitalizedCamelCase(field);
// For fields conflicting with some other fields, we append the field
// number to their field names in generated code to avoid conflicts.
if (is_conflict[i]) {
info.name += StrCat(field->number());
info.capitalized_name += StrCat(field->number());
info.disambiguated_reason = conflict_reason[i];
}
field_generator_info_map_[field] = info;
}
}
const FieldGeneratorInfo* Context::GetFieldGeneratorInfo(
const FieldDescriptor* field) const {
const FieldGeneratorInfo* result =
FindOrNull(field_generator_info_map_, field);
if (result == NULL) {
GOOGLE_LOG(FATAL) << "Can not find FieldGeneratorInfo for field: "
<< field->full_name();
}
return result;
}
const OneofGeneratorInfo* Context::GetOneofGeneratorInfo(
const OneofDescriptor* oneof) const {
const OneofGeneratorInfo* result =
FindOrNull(oneof_generator_info_map_, oneof);
if (result == NULL) {
GOOGLE_LOG(FATAL) << "Can not find OneofGeneratorInfo for oneof: "
<< oneof->name();
}
return result;
}
// Does this message class have generated parsing, serialization, and other
// standard methods for which reflection-based fallback implementations exist?
bool Context::HasGeneratedMethods(const Descriptor* descriptor) const {
return options_.enforce_lite ||
descriptor->file()->options().optimize_for() != FileOptions::CODE_SIZE;
}
} // namespace java
} // namespace compiler
} // namespace protobuf
} // namespace google
|
