#region Copyright notice and license // Protocol Buffers - Google's data interchange format // Copyright 2015 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. #endregion using System; using System.Collections.Generic; namespace XGame.Framework.Network.Protobuf { /// /// Factory methods for . /// public static class FieldCodec { // TODO: Avoid the "dual hit" of lambda expressions: create open delegates instead. (At least test...) /// /// Retrieves a codec suitable for a string field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForString(uint tag) { return new FieldCodec(input => input.ReadString(), (output, value) => output.WriteString(value), CodedOutputStream.ComputeStringSize, tag); } /// /// Retrieves a codec suitable for a bytes field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForBytes(uint tag) { return new FieldCodec(input => input.ReadBytes(), (output, value) => output.WriteBytes(value), CodedOutputStream.ComputeBytesSize, tag); } /// /// Retrieves a codec suitable for a bool field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForBool(uint tag) { return new FieldCodec(input => input.ReadBool(), (output, value) => output.WriteBool(value), CodedOutputStream.ComputeBoolSize, tag); } /// /// Retrieves a codec suitable for an int32 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForInt32(uint tag) { return new FieldCodec(input => input.ReadInt32(), (output, value) => output.WriteInt32(value), CodedOutputStream.ComputeInt32Size, tag); } /// /// Retrieves a codec suitable for an sint32 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForSInt32(uint tag) { return new FieldCodec(input => input.ReadSInt32(), (output, value) => output.WriteSInt32(value), CodedOutputStream.ComputeSInt32Size, tag); } /// /// Retrieves a codec suitable for a fixed32 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForFixed32(uint tag) { return new FieldCodec(input => input.ReadFixed32(), (output, value) => output.WriteFixed32(value), 4, tag); } /// /// Retrieves a codec suitable for an sfixed32 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForSFixed32(uint tag) { return new FieldCodec(input => input.ReadSFixed32(), (output, value) => output.WriteSFixed32(value), 4, tag); } /// /// Retrieves a codec suitable for a uint32 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForUInt32(uint tag) { return new FieldCodec(input => input.ReadUInt32(), (output, value) => output.WriteUInt32(value), CodedOutputStream.ComputeUInt32Size, tag); } /// /// Retrieves a codec suitable for an int64 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForInt64(uint tag) { return new FieldCodec(input => input.ReadInt64(), (output, value) => output.WriteInt64(value), CodedOutputStream.ComputeInt64Size, tag); } /// /// Retrieves a codec suitable for an sint64 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForSInt64(uint tag) { return new FieldCodec(input => input.ReadSInt64(), (output, value) => output.WriteSInt64(value), CodedOutputStream.ComputeSInt64Size, tag); } /// /// Retrieves a codec suitable for a fixed64 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForFixed64(uint tag) { return new FieldCodec(input => input.ReadFixed64(), (output, value) => output.WriteFixed64(value), 8, tag); } /// /// Retrieves a codec suitable for an sfixed64 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForSFixed64(uint tag) { return new FieldCodec(input => input.ReadSFixed64(), (output, value) => output.WriteSFixed64(value), 8, tag); } /// /// Retrieves a codec suitable for a uint64 field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForUInt64(uint tag) { return new FieldCodec(input => input.ReadUInt64(), (output, value) => output.WriteUInt64(value), CodedOutputStream.ComputeUInt64Size, tag); } /// /// Retrieves a codec suitable for a float field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForFloat(uint tag) { return new FieldCodec(input => input.ReadFloat(), (output, value) => output.WriteFloat(value), CodedOutputStream.ComputeFloatSize, tag); } /// /// Retrieves a codec suitable for a double field with the given tag. /// /// The tag. /// A codec for the given tag. public static FieldCodec ForDouble(uint tag) { return new FieldCodec(input => input.ReadDouble(), (output, value) => output.WriteDouble(value), CodedOutputStream.ComputeDoubleSize, tag); } // Enums are tricky. We can probably use expression trees to build these delegates automatically, // but it's easy to generate the code for it. /// /// Retrieves a codec suitable for an enum field with the given tag. /// /// The tag. /// A conversion function from to the enum type. /// A conversion function from the enum type to . /// A codec for the given tag. public static FieldCodec ForEnum(uint tag, Func toInt32, Func fromInt32) { return new FieldCodec(input => fromInt32( input.ReadEnum()), (output, value) => output.WriteEnum(toInt32(value)), value => CodedOutputStream.ComputeEnumSize(toInt32(value)), tag); } ///// ///// Retrieves a codec suitable for a message field with the given tag. ///// ///// The tag. ///// A parser to use for the message type. ///// A codec for the given tag. //public static FieldCodec ForMessage(uint tag, MessageParser parser) where T : IMessage //{ // return new FieldCodec(input => { T message = parser.CreateTemplate(); input.ReadMessage(message); return message; }, // (output, value) => output.WriteMessage(value), message => CodedOutputStream.ComputeMessageSize(message), tag); //} public static FieldCodec ForMessage(uint tag, MessageParser parser) where T : IMsgParser { return new FieldCodec( input => { T message = (T)parser.CreateTemplate(); input.ReadMessage(message); return message; }, (output, value) => output.WriteMessage(value), message => CodedOutputStream.ComputeMessageSize(message), tag); } ///// ///// Creates a codec for a wrapper type of a class - which must be string or ByteString. ///// //public static FieldCodec ForClassWrapper(uint tag) where T : class //{ // var nestedCodec = WrapperCodecs.GetCodec(); // return new FieldCodec( // input => WrapperCodecs.Read(input, nestedCodec), // (output, value) => WrapperCodecs.Write(output, value, nestedCodec), // value => WrapperCodecs.CalculateSize(value, nestedCodec), // tag, // null); // Default value for the wrapper //} ///// ///// Creates a codec for a wrapper type of a struct - which must be Int32, Int64, UInt32, UInt64, ///// Bool, Single or Double. ///// //public static FieldCodec ForStructWrapper(uint tag) where T : struct //{ // var nestedCodec = WrapperCodecs.GetCodec(); // return new FieldCodec( // input => WrapperCodecs.Read(input, nestedCodec), // (output, value) => WrapperCodecs.Write(output, value.Value, nestedCodec), // value => value == null ? 0 : WrapperCodecs.CalculateSize(value.Value, nestedCodec), // tag, // null); // Default value for the wrapper //} /// /// Helper code to create codecs for wrapper types. /// /// /// Somewhat ugly with all the static methods, but the conversions involved to/from nullable types make it /// slightly tricky to improve. So long as we keep the public API (ForClassWrapper, ForStructWrapper) in place, /// we can refactor later if we come up with something cleaner. /// private static class WrapperCodecs { //private static readonly Dictionary Codecs = new Dictionary //{ // { typeof(bool), ForBool(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Varint)) }, // { typeof(int), ForInt32(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Varint)) }, // { typeof(long), ForInt64(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Varint)) }, // { typeof(uint), ForUInt32(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Varint)) }, // { typeof(ulong), ForUInt64(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Varint)) }, // { typeof(float), ForFloat(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Fixed32)) }, // { typeof(double), ForDouble(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.Fixed64)) }, // { typeof(string), ForString(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.LengthDelimited)) }, // { typeof(ByteString), ForBytes(WireFormat.MakeTag(WrappersReflection.WrapperValueFieldNumber, WireFormat.WireType.LengthDelimited)) } //}; ///// ///// Returns a field codec which effectively wraps a value of type T in a message. ///// ///// //internal static FieldCodec GetCodec() //{ // object value; // if (!Codecs.TryGetValue(typeof(T), out value)) // { // throw new InvalidOperationException("Invalid type argument requested for wrapper codec: " + typeof(T)); // } // return (FieldCodec)value; //} internal static T Read(CodedInputStream input, FieldCodec codec) { int length = input.ReadLength(); int oldLimit = input.PushLimit(length); uint tag; T value = codec.DefaultValue; while ((tag = input.ReadTag()) != 0) { if (tag == codec.Tag) { value = codec.Read(input); } else { input.SkipLastField(); } } input.CheckReadEndOfStreamTag(); input.PopLimit(oldLimit); return value; } internal static void Write(CodedOutputStream output, T value, FieldCodec codec) { output.WriteLength(codec.CalculateSizeWithTag(value)); codec.WriteTagAndValue(output, value); } internal static int CalculateSize(T value, FieldCodec codec) { int fieldLength = codec.CalculateSizeWithTag(value); return CodedOutputStream.ComputeLengthSize(fieldLength) + fieldLength; } } } /// /// /// An encode/decode pair for a single field. This effectively encapsulates /// all the information needed to read or write the field value from/to a coded /// stream. /// /// /// This class is public and has to be as it is used by generated code, but its public /// API is very limited - just what the generated code needs to call directly. /// /// /// /// This never writes default values to the stream, and does not address "packedness" /// in repeated fields itself, other than to know whether or not the field *should* be packed. /// public sealed class FieldCodec { private static readonly EqualityComparer EqualityComparer = ProtobufEqualityComparers.GetEqualityComparer(); private static readonly T DefaultDefault; // Only non-nullable value types support packing. This is the simplest way of detecting that. private static readonly bool TypeSupportsPacking = default(T) != null; static FieldCodec() { if (typeof(T) == typeof(string)) { DefaultDefault = (T)(object)""; } else if (typeof(T) == typeof(ByteString)) { DefaultDefault = (T)(object)ByteString.Empty; } // Otherwise it's the default value of the CLR type } internal static bool IsPackedRepeatedField(uint tag) => TypeSupportsPacking && WireFormat.GetTagWireType(tag) == WireFormat.WireType.LengthDelimited; internal bool PackedRepeatedField { get; } /// /// Returns a delegate to write a value (unconditionally) to a coded output stream. /// internal Action ValueWriter { get; } /// /// Returns the size calculator for just a value. /// internal Func ValueSizeCalculator { get; } /// /// Returns a delegate to read a value from a coded input stream. It is assumed that /// the stream is already positioned on the appropriate tag. /// internal Func ValueReader { get; } /// /// Returns the fixed size for an entry, or 0 if sizes vary. /// internal int FixedSize { get; } /// /// Gets the tag of the codec. /// /// /// The tag of the codec. /// internal uint Tag { get; } /// /// Default value for this codec. Usually the same for every instance of the same type, but /// for string/ByteString wrapper fields the codec's default value is null, whereas for /// other string/ByteString fields it's "" or ByteString.Empty. /// /// /// The default value of the codec's type. /// internal T DefaultValue { get; } private readonly int tagSize; internal FieldCodec( Func reader, Action writer, int fixedSize, uint tag) : this(reader, writer, _ => fixedSize, tag) { FixedSize = fixedSize; } internal FieldCodec( Func reader, Action writer, Func sizeCalculator, uint tag) : this(reader, writer, sizeCalculator, tag, DefaultDefault) { } internal FieldCodec( Func reader, Action writer, Func sizeCalculator, uint tag, T defaultValue) { ValueReader = reader; ValueWriter = writer; ValueSizeCalculator = sizeCalculator; FixedSize = 0; Tag = tag; DefaultValue = defaultValue; tagSize = CodedOutputStream.ComputeRawVarint32Size(tag); // Detect packed-ness once, so we can check for it within RepeatedField. PackedRepeatedField = IsPackedRepeatedField(tag); } /// /// Write a tag and the given value, *if* the value is not the default. /// public void WriteTagAndValue(CodedOutputStream output, T value) { if (!IsDefault(value)) { output.WriteTag(Tag); ValueWriter(output, value); } } /// /// Reads a value of the codec type from the given . /// /// The input stream to read from. /// The value read from the stream. public T Read(CodedInputStream input) => ValueReader(input); /// /// Calculates the size required to write the given value, with a tag, /// if the value is not the default. /// public int CalculateSizeWithTag(T value) => IsDefault(value) ? 0 : ValueSizeCalculator(value) + tagSize; private static Type[] argTypes = new Type[] { typeof(T), typeof(T) }; private static object[] parameters = new object[2]; private bool IsDefault(object value) { var method = ProtobufEqualityComparers.GetMethod("Equals", EqualityComparer.GetType(), argTypes); parameters[0] = value; parameters[1] = DefaultDefault; return (bool)method.Invoke(EqualityComparer, parameters); } } }