csharp/src/ProtoGen/MessageFieldGenerator.cs

#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 MessageFieldGenerator : FieldGeneratorBase, IFieldSourceGenerator
    {
        internal MessageFieldGenerator(FieldDescriptor descriptor, int fieldOrdinal)
            : base(descriptor, fieldOrdinal)
        {
        }

        public void GenerateMembers(TextGenerator writer)
        {
            writer.WriteLine("private bool has{0};", PropertyName);
            writer.WriteLine("private {0} {1}_;", TypeName, Name);
            AddDeprecatedFlag(writer);
            writer.WriteLine("public bool Has{0} {{", PropertyName);
            writer.WriteLine("  get {{ return has{0}; }}", PropertyName);
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public {0} {1} {{", TypeName, PropertyName);
            writer.WriteLine("  get {{ return {0}_ ?? {1}; }}", Name, DefaultValue);
            writer.WriteLine("}");
        }

        public void GenerateBuilderMembers(TextGenerator writer)
        {
            AddDeprecatedFlag(writer);
            writer.WriteLine("public bool Has{0} {{", PropertyName);
            writer.WriteLine(" get {{ return result.has{0}; }}", PropertyName);
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public {0} {1} {{", TypeName, PropertyName);
            writer.WriteLine("  get {{ return result.{0}; }}", PropertyName);
            writer.WriteLine("  set {{ Set{0}(value); }}", PropertyName);
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public Builder Set{0}({1} value) {{", PropertyName, TypeName);
            AddNullCheck(writer);
            writer.WriteLine("  PrepareBuilder();");
            writer.WriteLine("  result.has{0} = true;", PropertyName);
            writer.WriteLine("  result.{0}_ = value;", Name);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public Builder Set{0}({1}.Builder builderForValue) {{", PropertyName, TypeName);
            AddNullCheck(writer, "builderForValue");
            writer.WriteLine("  PrepareBuilder();");
            writer.WriteLine("  result.has{0} = true;", PropertyName);
            writer.WriteLine("  result.{0}_ = builderForValue.Build();", Name);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public Builder Merge{0}({1} value) {{", PropertyName, TypeName);
            AddNullCheck(writer);
            writer.WriteLine("  PrepareBuilder();");
            writer.WriteLine("  if (result.has{0} &&", PropertyName);
            writer.WriteLine("      result.{0}_ != {1}) {{", Name, DefaultValue);
            writer.WriteLine("      result.{0}_ = {1}.CreateBuilder(result.{0}_).MergeFrom(value).BuildPartial();", Name,
                             TypeName);
            writer.WriteLine("  } else {");
            writer.WriteLine("    result.{0}_ = value;", Name);
            writer.WriteLine("  }");
            writer.WriteLine("  result.has{0} = true;", PropertyName);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
            AddDeprecatedFlag(writer);
            writer.WriteLine("public Builder Clear{0}() {{", PropertyName);
            writer.WriteLine("  PrepareBuilder();");
            writer.WriteLine("  result.has{0} = false;", PropertyName);
            writer.WriteLine("  result.{0}_ = null;", Name);
            writer.WriteLine("  return this;");
            writer.WriteLine("}");
        }

        public void GenerateMergingCode(TextGenerator writer)
        {
            writer.WriteLine("if (other.Has{0}) {{", PropertyName);
            writer.WriteLine("  Merge{0}(other.{0});", PropertyName);
            writer.WriteLine("}");
        }

        public void GenerateBuildingCode(TextGenerator writer)
        {
            // Nothing to do for singular fields
        }

        public void GenerateParsingCode(TextGenerator writer)
        {
            writer.WriteLine("{0}.Builder subBuilder = {0}.CreateBuilder();", TypeName);
            writer.WriteLine("if (result.has{0}) {{", PropertyName);
            writer.WriteLine("  subBuilder.MergeFrom({0});", PropertyName);
            writer.WriteLine("}");
            if (Descriptor.FieldType == FieldType.Group)
            {
                writer.WriteLine("input.ReadGroup({0}, subBuilder, extensionRegistry);", Number);
            }
            else
            {
                writer.WriteLine("input.ReadMessage(subBuilder, extensionRegistry);");
            }
            writer.WriteLine("{0} = subBuilder.BuildPartial();", PropertyName);
        }

        public void GenerateSerializationCode(TextGenerator writer)
        {
            writer.WriteLine("if (has{0}) {{", PropertyName);
            writer.WriteLine("  output.Write{0}({1}, field_names[{3}], {2});", MessageOrGroup, Number, PropertyName,
                             FieldOrdinal);
            writer.WriteLine("}");
        }

        public void GenerateSerializedSizeCode(TextGenerator writer)
        {
            writer.WriteLine("if (has{0}) {{", PropertyName);
            writer.WriteLine("  size += pb::CodedOutputStream.Compute{0}Size({1}, {2});",
                             MessageOrGroup, Number, PropertyName);
            writer.WriteLine("}");
        }

        public override void WriteHash(TextGenerator writer)
        {
            writer.WriteLine("if (has{0}) hash ^= {1}_.GetHashCode();", PropertyName, Name);
        }

        public override void WriteEquals(TextGenerator writer)
        {
            writer.WriteLine("if (has{0} != other.has{0} || (has{0} && !{1}_.Equals(other.{1}_))) return false;",
                             PropertyName, Name);
        }

        public override void WriteToString(TextGenerator writer)
        {
            writer.WriteLine("PrintField(\"{2}\", has{0}, {1}_, writer);", PropertyName, Name,
                             Descriptor.FieldType == FieldType.Group ? Descriptor.MessageType.Name : Descriptor.Name);
        }
    }
}