aboutsummaryrefslogtreecommitdiffhomepage
path: root/csharp/src/ProtocolBuffers/GeneratedMessage.cs
blob: ff3a0c2a0a8dbfb73084fea07f0264287545772a (plain)
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
#region Copyright notice and license

// Protocol Buffers - Google's data interchange format
// Copyright 2008 Google Inc.  All rights reserved.
// http://github.com/jskeet/dotnet-protobufs/
// Original C++/Java/Python code:
// http://code.google.com/p/protobuf/
//
// 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.

#endregion

using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Xml;
using Google.ProtocolBuffers.Collections;
using Google.ProtocolBuffers.Descriptors;
using Google.ProtocolBuffers.FieldAccess;

namespace Google.ProtocolBuffers
{
    /// <summary>
    /// All generated protocol message classes extend this class. It implements
    /// most of the IMessage interface using reflection. Users
    /// can ignore this class as an implementation detail.
    /// </summary>
    public abstract partial class GeneratedMessage<TMessage, TBuilder> : AbstractMessage<TMessage, TBuilder>
        where TMessage : GeneratedMessage<TMessage, TBuilder>
        where TBuilder : GeneratedBuilder<TMessage, TBuilder>, new()
    {
        private UnknownFieldSet unknownFields = UnknownFieldSet.DefaultInstance;

        /// <summary>
        /// Returns the message as a TMessage.
        /// </summary>
        protected abstract TMessage ThisMessage { get; }

        internal FieldAccessorTable<TMessage, TBuilder> FieldAccessorsFromBuilder
        {
            get { return InternalFieldAccessors; }
        }

        protected abstract FieldAccessorTable<TMessage, TBuilder> InternalFieldAccessors { get; }

        public override MessageDescriptor DescriptorForType
        {
            get { return InternalFieldAccessors.Descriptor; }
        }

        internal IDictionary<FieldDescriptor, Object> GetMutableFieldMap()
        {
            // Use a SortedDictionary so we'll end up serializing fields in order
            var ret = new SortedDictionary<FieldDescriptor, object>();
            MessageDescriptor descriptor = DescriptorForType;
            foreach (FieldDescriptor field in descriptor.Fields)
            {
                IFieldAccessor<TMessage, TBuilder> accessor = InternalFieldAccessors[field];
                if (field.IsRepeated)
                {
                    if (accessor.GetRepeatedCount(ThisMessage) != 0)
                    {
                        ret[field] = accessor.GetValue(ThisMessage);
                    }
                }
                else if (HasField(field))
                {
                    ret[field] = accessor.GetValue(ThisMessage);
                }
            }
            return ret;
        }

        public override bool IsInitialized
        {
            get
            {
                foreach (FieldDescriptor field in DescriptorForType.Fields)
                {
                    // Check that all required fields are present.
                    if (field.IsRequired && !HasField(field))
                    {
                        return false;
                    }
                    // Check that embedded messages are initialized.
                    // This code is similar to that in AbstractMessage, but we don't
                    // fetch all the field values - just the ones we need to.
                    if (field.MappedType == MappedType.Message)
                    {
                        if (field.IsRepeated)
                        {
                            // We know it's an IList<T>, but not the exact type - so
                            // IEnumerable is the best we can do. (C# generics aren't covariant yet.)
                            foreach (IMessageLite element in (IEnumerable) this[field])
                            {
                                if (!element.IsInitialized)
                                {
                                    return false;
                                }
                            }
                        }
                        else
                        {
                            if (HasField(field) && !((IMessageLite) this[field]).IsInitialized)
                            {
                                return false;
                            }
                        }
                    }
                }
                return true;
            }
        }

        public override IDictionary<FieldDescriptor, object> AllFields
        {
            get { return Dictionaries.AsReadOnly(GetMutableFieldMap()); }
        }

        public override bool HasOneof(OneofDescriptor oneof)
        {
            return InternalFieldAccessors.Oneof(oneof).Has(ThisMessage);
        }

        public override FieldDescriptor OneofFieldDescriptor(OneofDescriptor oneof)
        {
            return InternalFieldAccessors.Oneof(oneof).GetOneofFieldDescriptor(ThisMessage);
        }

        public override bool HasField(FieldDescriptor field)
        {
            return InternalFieldAccessors[field].Has(ThisMessage);
        }

        public override int GetRepeatedFieldCount(FieldDescriptor field)
        {
            return InternalFieldAccessors[field].GetRepeatedCount(ThisMessage);
        }

        public override object this[FieldDescriptor field, int index]
        {
            get { return InternalFieldAccessors[field].GetRepeatedValue(ThisMessage, index); }
        }

        public override object this[FieldDescriptor field]
        {
            get { return InternalFieldAccessors[field].GetValue(ThisMessage); }
        }

        public override UnknownFieldSet UnknownFields
        {
            get { return unknownFields; }
        }

        /// <summary>
        /// Replaces the set of unknown fields for this message. This should
        /// only be used before a message is built, by the builder. (In the
        /// Java code it is private, but the builder is nested so has access
        /// to it.)
        /// </summary>
        internal void SetUnknownFields(UnknownFieldSet fieldSet)
        {
            unknownFields = fieldSet;
        }
    }
}