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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
|
// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.
// http://code.google.com/p/protobuf/
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
using System;
using System.Collections;
using System.Collections.Generic;
using Google.ProtocolBuffers.Collections;
using Google.ProtocolBuffers.Descriptors;
namespace Google.ProtocolBuffers {
/// <summary>
/// A class which represents an arbitrary set of fields of some message type.
/// This is used to implement DynamicMessage, and also to represent extensions
/// in GeneratedMessage. This class is internal, since outside users should probably
/// be using DynamicMessage.
///
/// As in the Java implementation, this class goes against the rest of the framework
/// in terms of mutability. Instead of having a mutable Builder class and an immutable
/// FieldSet class, FieldSet just has a MakeImmutable() method. This is safe so long as
/// all callers are careful not to let a mutable FieldSet escape into the open. This would
/// be impossible to guarantee if this were a public class, of course.
///
/// All repeated fields are stored as IList[object] even
/// TODO(jonskeet): Finish this comment!
/// </summary>
internal sealed class FieldSet {
private static readonly FieldSet defaultInstance = new FieldSet(new Dictionary<FieldDescriptor, object>()).MakeImmutable();
private IDictionary<FieldDescriptor, object> fields;
private FieldSet(IDictionary<FieldDescriptor, object> fields) {
this.fields = fields;
}
public static FieldSet CreateInstance() {
// Use SortedList to keep fields in the canonical order
return new FieldSet(new SortedList<FieldDescriptor, object>());
}
/// <summary>
/// Makes this FieldSet immutable, and returns it for convenience. Any
/// mutable repeated fields are made immutable, as well as the map itself.
/// </summary>
internal FieldSet MakeImmutable() {
// First check if we have any repeated values
bool hasRepeats = false;
foreach (object value in fields.Values) {
IList<object> list = value as IList<object>;
if (list != null && !list.IsReadOnly) {
hasRepeats = true;
break;
}
}
if (hasRepeats) {
var tmp = new SortedList<FieldDescriptor, object>();
foreach (KeyValuePair<FieldDescriptor, object> entry in fields) {
IList<object> list = entry.Value as IList<object>;
tmp[entry.Key] = list == null ? entry.Value : Lists.AsReadOnly(list);
}
fields = tmp;
}
fields = Dictionaries.AsReadOnly(fields);
return this;
}
/// <summary>
/// Returns the default, immutable instance with no fields defined.
/// </summary>
internal static FieldSet DefaultInstance {
get { return defaultInstance; }
}
/// <summary>
/// Returns an immutable mapping of fields. Note that although the mapping itself
/// is immutable, the entries may not be (i.e. any repeated values are represented by
/// mutable lists). The behaviour is not specified if the contents are mutated.
/// </summary>
internal IDictionary<FieldDescriptor, object> AllFields {
get { return Dictionaries.AsReadOnly(fields); }
}
/// <summary>
/// See <see cref="IMessage.HasField"/>.
/// </summary>
public bool HasField(FieldDescriptor field) {
if (field.IsRepeated) {
throw new ArgumentException("HasField() can only be called on non-repeated fields.");
}
return fields.ContainsKey(field);
}
/// <summary>
/// Clears all fields.
/// </summary>
internal void Clear() {
fields.Clear();
}
/// <summary>
/// See <see cref="IMessage.Item(FieldDescriptor)"/>
/// </summary>
/// <remarks>
/// If the field is not set, the behaviour when fetching this property varies by field type:
/// <list>
/// <item>For singular message values, null is returned.</item>
/// <item>For singular non-message values, the default value of the field is returned.</item>
/// <item>For repeated values, an empty immutable list is returned. This will be compatible
/// with IList[object], regardless of the type of the repeated item.</item>
/// </list>
/// This method returns null if the field is a singular message type
/// and is not set; in this case it is up to the caller to fetch the
/// message's default instance. For repeated fields of message types,
/// an empty collection is returned. For repeated fields of non-message
/// types, null is returned.
/// <para />
/// When setting this property, any list values are copied, and each element is checked
/// to ensure it is of an appropriate type.
/// </remarks>
///
internal object this[FieldDescriptor field] {
get {
object result;
if (fields.TryGetValue(field, out result)) {
return result;
}
if (field.MappedType == MappedType.Message) {
if (field.IsRepeated) {
return new List<object>();
} else {
return null;
}
}
return field.DefaultValue;
}
set {
if (field.IsRepeated) {
List<object> list = value as List<object>;
if (list == null) {
throw new ArgumentException("Wrong object type used with protocol message reflection.");
}
// Wrap the contents in a new list so that the caller cannot change
// the list's contents after setting it.
List<object> newList = new List<object>(list);
foreach (object element in newList) {
VerifyType(field, element);
}
value = newList;
}
else {
VerifyType(field, value);
}
fields[field] = value;
}
}
/// <summary>
/// See <see cref="IMessage.Item(FieldDescriptor,int)" />
/// </summary>
internal object this[FieldDescriptor field, int index] {
get {
if (!field.IsRepeated) {
throw new ArgumentException("Indexer specifying field and index can only be called on repeated fields.");
}
return ((IList<object>) this[field])[index];
}
set {
if (!field.IsRepeated) {
throw new ArgumentException("Indexer specifying field and index can only be called on repeated fields.");
}
VerifyType(field, value);
object list;
if (!fields.TryGetValue(field, out list)) {
throw new ArgumentOutOfRangeException();
}
((IList<object>) list)[index] = value;
}
}
/// <summary>
/// See <see cref="IBuilder{TMessage, TBuilder}.AddRepeatedField" />
/// </summary>
internal void AddRepeatedField(FieldDescriptor field, object value) {
if (!field.IsRepeated) {
throw new ArgumentException("AddRepeatedField can only be called on repeated fields.");
}
VerifyType(field, value);
object list;
if (!fields.TryGetValue(field, out list)) {
list = new List<object>();
fields[field] = list;
}
((IList<object>) list).Add(value);
}
/// <summary>
/// Returns an enumerator for the field map. Used to write the fields out.
/// </summary>
internal IEnumerator<KeyValuePair<FieldDescriptor, object>> GetEnumerator() {
return fields.GetEnumerator();
}
/// <summary>
/// See <see cref="IMessage.IsInitialized" />
/// </summary>
/// <remarks>
/// Since FieldSet itself does not have any way of knowing about
/// required fields that aren't actually present in the set, it is up
/// to the caller to check for genuinely required fields. This property
/// merely checks that any messages present are themselves initialized.
/// </remarks>
internal bool IsInitialized {
get {
foreach (KeyValuePair<FieldDescriptor, object> entry in fields) {
FieldDescriptor field = entry.Key;
if (field.MappedType == MappedType.Message) {
if (field.IsRepeated) {
foreach(IMessage message in (IEnumerable) entry.Value) {
if (!message.IsInitialized) {
return false;
}
}
} else {
if (!((IMessage) entry.Value).IsInitialized) {
return false;
}
}
}
}
return true;
}
}
/// <summary>
/// Verifies whether all the required fields in the specified message
/// descriptor are present in this field set, as well as whether
/// all the embedded messages are themselves initialized.
/// </summary>
internal bool IsInitializedWithRespectTo(MessageDescriptor type) {
foreach (FieldDescriptor field in type.Fields) {
if (field.IsRequired && !HasField(field)) {
return false;
}
}
return IsInitialized;
}
/// <summary>
/// See <see cref="IBuilder{TMessage, TBuilder}.ClearField" />
/// </summary>
public void ClearField(FieldDescriptor field) {
fields.Remove(field);
}
/// <summary>
/// See <see cref="IMessage.GetRepeatedFieldCount" />
/// </summary>
public int GetRepeatedFieldCount(FieldDescriptor field) {
if (!field.IsRepeated) {
throw new ArgumentException("GetRepeatedFieldCount() can only be called on repeated fields.");
}
return ((IList<object>) this[field]).Count;
}
/// <summary>
/// Implementation of both <c>MergeFrom</c> methods.
/// </summary>
/// <param name="otherFields"></param>
private void MergeFields(IEnumerable<KeyValuePair<FieldDescriptor, object>> otherFields) {
// Note: We don't attempt to verify that other's fields have valid
// types. Doing so would be a losing battle. We'd have to verify
// all sub-messages as well, and we'd have to make copies of all of
// them to insure that they don't change after verification (since
// the IMessage interface itself cannot enforce immutability of
// implementations).
// TODO(jonskeet): Provide a function somewhere called MakeDeepCopy()
// which allows people to make secure deep copies of messages.
foreach (KeyValuePair<FieldDescriptor, object> entry in otherFields) {
FieldDescriptor field = entry.Key;
object existingValue;
fields.TryGetValue(field, out existingValue);
if (field.IsRepeated) {
if (existingValue == null) {
existingValue = new List<object>();
fields[field] = existingValue;
}
IList<object> list = (IList<object>) existingValue;
foreach (object otherValue in (IEnumerable) entry.Value) {
list.Add(otherValue);
}
} else if (field.MappedType == MappedType.Message && existingValue != null) {
IMessage existingMessage = (IMessage)existingValue;
IMessage merged = existingMessage.WeakCreateBuilderForType()
.WeakMergeFrom(existingMessage)
.WeakMergeFrom((IMessage) entry.Value)
.WeakBuild();
this[field] = merged;
} else {
this[field] = entry.Value;
}
}
}
/// <summary>
/// See <see cref="IBuilder{TMessage, TBuilder}.MergeFrom(IMessage)" />
/// </summary>
public void MergeFrom(IMessage other) {
MergeFields(other.AllFields);
}
/// <summary>
/// Like <see cref="MergeFrom(IMessage)"/>, but merges from another <c>FieldSet</c>.
/// </summary>
public void MergeFrom(FieldSet other) {
MergeFields(other.fields);
}
/// <summary>
/// See <see cref="IMessage.WriteTo(CodedOutputStream)" />.
/// </summary>
public void WriteTo(CodedOutputStream output) {
foreach (KeyValuePair<FieldDescriptor, object> entry in fields) {
WriteField(entry.Key, entry.Value, output);
}
}
/// <summary>
/// Writes a single field to a CodedOutputStream.
/// </summary>
public void WriteField(FieldDescriptor field, Object value, CodedOutputStream output) {
if (field.IsExtension && field.ContainingType.Options.MessageSetWireFormat) {
output.WriteMessageSetExtension(field.FieldNumber, (IMessage) value);
} else {
if (field.IsRepeated) {
foreach (object element in (IEnumerable) value) {
output.WriteField(field.FieldType, field.FieldNumber, element);
}
} else {
output.WriteField(field.FieldType, field.FieldNumber, value);
}
}
}
/// <summary>
/// See <see cref="IMessage.SerializedSize" />. It's up to the caller to
/// cache the resulting size if desired.
/// </summary>
public int SerializedSize {
get {
int size = 0;
foreach (KeyValuePair<FieldDescriptor, object> entry in fields) {
FieldDescriptor field = entry.Key;
object value = entry.Value;
if (field.IsExtension && field.ContainingType.Options.MessageSetWireFormat) {
size += CodedOutputStream.ComputeMessageSetExtensionSize(field.FieldNumber, (IMessage) value);
} else {
if (field.IsRepeated) {
foreach (object element in (IEnumerable) value) {
size += CodedOutputStream.ComputeFieldSize(field.FieldType, field.FieldNumber, element);
}
} else {
size += CodedOutputStream.ComputeFieldSize(field.FieldType, field.FieldNumber, value);
}
}
}
return size;
}
}
/// <summary>
/// Verifies that the given object is of the correct type to be a valid
/// value for the given field.
/// </summary>
/// <remarks>
/// For repeated fields, this checks if the object is of the right
/// element type, not whether it's a list.
/// </remarks>
/// <exception cref="ArgumentException">The value is not of the right type.</exception>
private static void VerifyType(FieldDescriptor field, object value) {
bool isValid = false;
switch (field.MappedType) {
case MappedType.Int32: isValid = value is int; break;
case MappedType.Int64: isValid = value is long; break;
case MappedType.UInt32: isValid = value is uint; break;
case MappedType.UInt64: isValid = value is ulong; break;
case MappedType.Single: isValid = value is float; break;
case MappedType.Double: isValid = value is double; break;
case MappedType.Boolean: isValid = value is bool; break;
case MappedType.String: isValid = value is string; break;
case MappedType.ByteString: isValid = value is ByteString; break;
case MappedType.Enum:
EnumValueDescriptor enumValue = value as EnumValueDescriptor;
isValid = enumValue != null && enumValue.EnumDescriptor == field.EnumType;
break;
case MappedType.Message:
IMessage messageValue = value as IMessage;
isValid = messageValue != null && messageValue.DescriptorForType == field.MessageType;
break;
}
if (!isValid) {
// When chaining calls to SetField(), it can be hard to tell from
// the stack trace which exact call failed, since the whole chain is
// considered one line of code. So, let's make sure to include the
// field name and other useful info in the exception.
throw new ArgumentException("Wrong object type used with protocol message reflection. "
+ "Message type \"" + field.ContainingType.FullName
+ "\", field \"" + (field.IsExtension ? field.FullName : field.Name)
+ "\", value was type \"" + value.GetType().Name + "\".");
}
}
}
}
|