RepeatedEnumFieldGenerator.cs 9.77 KB
Newer Older
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
#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 Google.ProtocolBuffers.Descriptors;

namespace Google.ProtocolBuffers.ProtoGen
{
    internal class RepeatedEnumFieldGenerator : FieldGeneratorBase, IFieldSourceGenerator
    {
43 44
        internal RepeatedEnumFieldGenerator(FieldDescriptor descriptor, int fieldOrdinal)
            : base(descriptor, fieldOrdinal)
45 46 47 48 49 50 51 52 53 54
        {
        }

        public void GenerateMembers(TextGenerator writer)
        {
            if (Descriptor.IsPacked && OptimizeSpeed)
            {
                writer.WriteLine("private int {0}MemoizedSerializedSize;", Name);
            }
            writer.WriteLine("private pbc::PopsicleList<{0}> {1}_ = new pbc::PopsicleList<{0}>();", TypeName, Name);
55
            AddDeprecatedFlag(writer);
56 57 58 59 60
            writer.WriteLine("public scg::IList<{0}> {1}List {{", TypeName, PropertyName);
            writer.WriteLine("  get {{ return pbc::Lists.AsReadOnly({0}_); }}", Name);
            writer.WriteLine("}");

            // TODO(jonskeet): Redundant API calls? Possibly - include for portability though. Maybe create an option.
61
            AddDeprecatedFlag(writer);
62 63 64 65
            writer.WriteLine("public int {0}Count {{", PropertyName);
            writer.WriteLine("  get {{ return {0}_.Count; }}", Name);
            writer.WriteLine("}");

66
            AddDeprecatedFlag(writer);
67 68 69 70 71 72 73 74 75
            writer.WriteLine("public {0} Get{1}(int index) {{", TypeName, PropertyName);
            writer.WriteLine("  return {0}_[index];", Name);
            writer.WriteLine("}");
        }

        public void GenerateBuilderMembers(TextGenerator writer)
        {
            // Note:  We can return the original list here, because we make it unmodifiable when we build
            // We return it via IPopsicleList so that collection initializers work more pleasantly.
76
            AddDeprecatedFlag(writer);
77
            writer.WriteLine("public pbc::IPopsicleList<{0}> {1}List {{", TypeName, PropertyName);
78
            writer.WriteLine("  get {{ return PrepareBuilder().{0}_; }}", Name);
79
            writer.WriteLine("}");
80
            AddDeprecatedFlag(writer);
81 82 83
            writer.WriteLine("public int {0}Count {{", PropertyName);
            writer.WriteLine("  get {{ return result.{0}Count; }}", PropertyName);
            writer.WriteLine("}");
84
            AddDeprecatedFlag(writer);
85 86 87
            writer.WriteLine("public {0} Get{1}(int index) {{", TypeName, PropertyName);
            writer.WriteLine("  return result.Get{0}(index);", PropertyName);
            writer.WriteLine("}");
88
            AddDeprecatedFlag(writer);
89
            writer.WriteLine("public Builder Set{0}(int index, {1} value) {{", PropertyName, TypeName);
90
            writer.WriteLine("  PrepareBuilder();");
91 92 93
            writer.WriteLine("  result.{0}_[index] = value;", Name);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
94
            AddDeprecatedFlag(writer);
95
            writer.WriteLine("public Builder Add{0}({1} value) {{", PropertyName, TypeName);
96
            writer.WriteLine("  PrepareBuilder();");
97 98 99
            writer.WriteLine("  result.{0}_.Add(value);", Name, TypeName);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
100
            AddDeprecatedFlag(writer);
101
            writer.WriteLine("public Builder AddRange{0}(scg::IEnumerable<{1}> values) {{", PropertyName, TypeName);
102
            writer.WriteLine("  PrepareBuilder();");
103
            writer.WriteLine("  result.{0}_.Add(values);", Name);
104 105
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
106
            AddDeprecatedFlag(writer);
107
            writer.WriteLine("public Builder Clear{0}() {{", PropertyName);
108
            writer.WriteLine("  PrepareBuilder();");
109 110 111 112 113 114 115 116
            writer.WriteLine("  result.{0}_.Clear();", Name);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
        }

        public void GenerateMergingCode(TextGenerator writer)
        {
            writer.WriteLine("if (other.{0}_.Count != 0) {{", Name);
117
            writer.WriteLine("  result.{0}_.Add(other.{0}_);", Name);
118 119 120 121 122
            writer.WriteLine("}");
        }

        public void GenerateBuildingCode(TextGenerator writer)
        {
123
            writer.WriteLine("{0}_.MakeReadOnly();", Name);
124 125 126 127
        }

        public void GenerateParsingCode(TextGenerator writer)
        {
128 129
            writer.WriteLine("scg::ICollection<object> unknownItems;");
            writer.WriteLine("input.ReadEnumArray<{0}>(tag, field_name, result.{1}_, out unknownItems);", TypeName, Name);
130 131
            if (!UseLiteRuntime)
            {
132 133
                writer.WriteLine("if (unknownItems != null) {");
                writer.WriteLine("  if (unknownFields == null) {");
134 135
                writer.WriteLine("    unknownFields = pb::UnknownFieldSet.CreateBuilder(this.UnknownFields);");
                writer.WriteLine("  }");
136 137 138
                writer.WriteLine("  foreach (object rawValue in unknownItems)");
                writer.WriteLine("    if (rawValue is int)");
                writer.WriteLine("      unknownFields.MergeVarintField({0}, (ulong)(int)rawValue);", Number);
139 140 141 142 143 144 145 146 147
                writer.WriteLine("}");
            }
        }

        public void GenerateSerializationCode(TextGenerator writer)
        {
            writer.WriteLine("if ({0}_.Count > 0) {{", Name);
            writer.Indent();
            if (Descriptor.IsPacked)
148 149 150 151 152
            {
                writer.WriteLine(
                    "output.WritePackedEnumArray({0}, field_names[{2}], {1}MemoizedSerializedSize, {1}_);", Number, Name,
                    FieldOrdinal, Descriptor.FieldType);
            }
153
            else
154 155 156 157
            {
                writer.WriteLine("output.WriteEnumArray({0}, field_names[{2}], {1}_);", Number, Name, FieldOrdinal,
                                 Descriptor.FieldType);
            }
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
            writer.Outdent();
            writer.WriteLine("}");
        }

        public void GenerateSerializedSizeCode(TextGenerator writer)
        {
            writer.WriteLine("{");
            writer.Indent();
            writer.WriteLine("int dataSize = 0;");
            writer.WriteLine("if ({0}_.Count > 0) {{", Name);
            writer.Indent();
            writer.WriteLine("foreach ({0} element in {1}_) {{", TypeName, Name);
            writer.WriteLine("  dataSize += pb::CodedOutputStream.ComputeEnumSizeNoTag((int) element);");
            writer.WriteLine("}");
            writer.WriteLine("size += dataSize;");
            int tagSize = CodedOutputStream.ComputeTagSize(Descriptor.FieldNumber);
            if (Descriptor.IsPacked)
            {
                writer.WriteLine("size += {0};", tagSize);
                writer.WriteLine("size += pb::CodedOutputStream.ComputeRawVarint32Size((uint) dataSize);");
            }
            else
            {
                writer.WriteLine("size += {0} * {1}_.Count;", tagSize, Name);
            }
            writer.Outdent();
            writer.WriteLine("}");
            // cache the data size for packed fields.
            if (Descriptor.IsPacked)
            {
                writer.WriteLine("{0}MemoizedSerializedSize = dataSize;", Name);
            }
            writer.Outdent();
            writer.WriteLine("}");
        }

        public override void WriteHash(TextGenerator writer)
        {
            writer.WriteLine("foreach({0} i in {1}_)", TypeName, Name);
            writer.WriteLine("  hash ^= i.GetHashCode();");
        }

        public override void WriteEquals(TextGenerator writer)
        {
            writer.WriteLine("if({0}_.Count != other.{0}_.Count) return false;", Name);
            writer.WriteLine("for(int ix=0; ix < {0}_.Count; ix++)", Name);
            writer.WriteLine("  if(!{0}_[ix].Equals(other.{0}_[ix])) return false;", Name);
        }

        public override void WriteToString(TextGenerator writer)
        {
            writer.WriteLine("PrintField(\"{0}\", {1}_, writer);", Descriptor.Name, Name);
        }
    }
}