From e38294a62d7f37c0661273a9a26fda16d557423f Mon Sep 17 00:00:00 2001 From: Jon Skeet Date: Tue, 9 Jun 2015 19:30:44 +0100 Subject: First pass at the mutable API. Quite a bit more to do - in particular, it's pretty slow right now. --- csharp/src/ProtocolBuffers/IMessage.cs | 216 ++------------------------------- 1 file changed, 13 insertions(+), 203 deletions(-) (limited to 'csharp/src/ProtocolBuffers/IMessage.cs') diff --git a/csharp/src/ProtocolBuffers/IMessage.cs b/csharp/src/ProtocolBuffers/IMessage.cs index dd309d4e..4e06f6e8 100644 --- a/csharp/src/ProtocolBuffers/IMessage.cs +++ b/csharp/src/ProtocolBuffers/IMessage.cs @@ -37,217 +37,27 @@ using System; using System.Collections.Generic; using System.IO; -using Google.ProtocolBuffers.Descriptors; +using Google.Protobuf.Descriptors; +using Google.Protobuf.FieldAccess; -namespace Google.ProtocolBuffers +namespace Google.Protobuf { - /// - /// Non-generic interface used for all parts of the API which don't require - /// any type knowledge. - /// - public interface IMessage : IMessageLite - { - /// - /// Returns the message's type's descriptor. This differs from the - /// Descriptor property of each generated message class in that this - /// method is an abstract method of IMessage whereas Descriptor is - /// a static property of a specific class. They return the same thing. - /// - MessageDescriptor DescriptorForType { get; } - - /// - /// Returns a collection of all the fields in this message which are set - /// and their corresponding values. A singular ("required" or "optional") - /// field is set iff HasField() returns true for that field. A "repeated" - /// field is set iff GetRepeatedFieldSize() is greater than zero. The - /// values are exactly what would be returned by calling - /// GetField(FieldDescriptor) for each field. The map - /// is guaranteed to be a sorted map, so iterating over it will return fields - /// in order by field number. - /// - IDictionary AllFields { get; } - - bool HasOneof(OneofDescriptor oneof); - - FieldDescriptor OneofFieldDescriptor(OneofDescriptor oneof); - - /// - /// Returns true if the given field is set. This is exactly equivalent - /// to calling the generated "Has" property corresponding to the field. - /// - /// the field is a repeated field, - /// or it's not a field of this type - bool HasField(FieldDescriptor field); - - /// - /// Obtains the value of the given field, or the default value if - /// it isn't set. For value type fields, the boxed value is returned. - /// For enum fields, the EnumValueDescriptor for the enum is returned. - /// For embedded message fields, the sub-message - /// is returned. For repeated fields, an IList<T> is returned. - /// - object this[FieldDescriptor field] { get; } - - /// - /// Returns the number of elements of a repeated field. This is - /// exactly equivalent to calling the generated "Count" property - /// corresponding to the field. - /// - /// the field is not a repeated field, - /// or it's not a field of this type - int GetRepeatedFieldCount(FieldDescriptor field); - - /// - /// Gets an element of a repeated field. For value type fields - /// excluding enums, the boxed value is returned. For embedded - /// message fields, the sub-message is returned. For enums, the - /// relevant EnumValueDescriptor is returned. - /// - /// the field is not a repeated field, - /// or it's not a field of this type - /// the index is out of - /// range for the repeated field's value - object this[FieldDescriptor field, int index] { get; } - - /// - /// Returns the unknown fields for this message. - /// - UnknownFieldSet UnknownFields { get; } - - /// - /// Returns true iff all required fields in the message and all embedded - /// messages are set. - /// - new bool IsInitialized { get; } - - /// - /// Serializes the message and writes it to the given output stream. - /// This does not flush or close the stream. - /// - /// - /// Protocol Buffers are not self-delimiting. Therefore, if you write - /// any more data to the stream after the message, you must somehow ensure - /// that the parser on the receiving end does not interpret this as being - /// part of the protocol message. One way of doing this is by writing the size - /// of the message before the data, then making sure you limit the input to - /// that size when receiving the data. Alternatively, use WriteDelimitedTo(Stream). - /// - new void WriteTo(ICodedOutputStream output); - - /// - /// Like WriteTo(Stream) but writes the size of the message as a varint before - /// writing the data. This allows more data to be written to the stream after the - /// message without the need to delimit the message data yourself. Use - /// IBuilder.MergeDelimitedFrom(Stream) or the static method - /// YourMessageType.ParseDelimitedFrom(Stream) to parse messages written by this method. - /// - /// - new void WriteDelimitedTo(Stream output); - - /// - /// Returns the number of bytes required to encode this message. - /// The result is only computed on the first call and memoized after that. - /// - new int SerializedSize { get; } - - #region Comparison and hashing - - /// - /// Compares the specified object with this message for equality. - /// Returns true iff the given object is a message of the same type - /// (as defined by DescriptorForType) and has identical values - /// for all its fields. - /// - new bool Equals(object other); - /// - /// Returns the hash code value for this message. - /// TODO(jonskeet): Specify the hash algorithm, but better than the Java one! - /// - new int GetHashCode(); - - #endregion - - #region Convenience methods - - /// - /// Converts the message to a string in protocol buffer text format. - /// This is just a trivial wrapper around TextFormat.PrintToString. - /// - new string ToString(); - - /// - /// Serializes the message to a ByteString. This is a trivial wrapper - /// around WriteTo(ICodedOutputStream). - /// - new ByteString ToByteString(); - - /// - /// Serializes the message to a byte array. This is a trivial wrapper - /// around WriteTo(ICodedOutputStream). - /// - new byte[] ToByteArray(); - - /// - /// Serializes the message and writes it to the given stream. - /// This is just a wrapper around WriteTo(ICodedOutputStream). This - /// does not flush or close the stream. - /// - /// - new void WriteTo(Stream output); - - #endregion - - /// - /// Creates a builder for the type, but in a weakly typed manner. This - /// is typically implemented by strongly typed messages by just returning - /// the result of CreateBuilderForType. - /// - new IBuilder WeakCreateBuilderForType(); - - /// - /// Creates a builder with the same contents as this message. This - /// is typically implemented by strongly typed messages by just returning - /// the result of ToBuilder. - /// - new IBuilder WeakToBuilder(); - - new IMessage WeakDefaultInstanceForType { get; } + // TODO(jonskeet): Do we want a "weak" version of IReflectedMessage? + public interface IReflectedMessage where T : IMessage + { + FieldAccessorTable Fields { get; } } - public interface IMessage : IMessage, IMessageLite + public interface IMessage { - /// - /// Returns an instance of this message type with all fields set to - /// their default values. This may or may not be a singleton. This differs - /// from the DefaultInstance property of each generated message class in that this - /// method is an abstract method of IMessage whereas DefaultInstance is - /// a static property of a specific class. They return the same thing. - /// - new TMessage DefaultInstanceForType { get; } + void MergeFrom(ICodedInputStream input); + void WriteTo(ICodedOutputStream output); + int CalculateSize(); } - /// - /// Type-safe interface for all generated messages to implement. - /// - public interface IMessage : IMessage, IMessageLite - where TMessage : IMessage - where TBuilder : IBuilder + public interface IMessage : IMessage where T : IMessage { - #region Builders - - /// - /// Constructs a new builder for a message of the same type as this message. - /// - new TBuilder CreateBuilderForType(); - - /// - /// Creates a builder with the same contents as this current instance. - /// This is typically implemented by strongly typed messages by just - /// returning the result of ToBuilder(). - /// - new TBuilder ToBuilder(); - - #endregion + void MergeFrom(T message); } } \ No newline at end of file -- cgit v1.2.3