#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.IO; namespace Google.Protobuf { /// /// A general message parser, typically used by reflection-based code as all the methods /// return simple . /// public class MessageParser { private Func factory; internal MessageParser(Func factory) { this.factory = factory; } /// /// Creates a template instance ready for population. /// /// An empty message. internal IMessage CreateTemplate() { return factory(); } /// /// Parses a message from a byte array. /// /// The byte array containing the message. Must not be null. /// The newly parsed message. public IMessage ParseFrom(byte[] data) { ProtoPreconditions.CheckNotNull(data, "data"); IMessage message = factory(); message.MergeFrom(data); return message; } /// /// Parses a message from the given byte string. /// /// The data to parse. /// The parsed message. public IMessage ParseFrom(ByteString data) { ProtoPreconditions.CheckNotNull(data, "data"); IMessage message = factory(); message.MergeFrom(data); return message; } /// /// Parses a message from the given stream. /// /// The stream to parse. /// The parsed message. public IMessage ParseFrom(Stream input) { IMessage message = factory(); message.MergeFrom(input); return message; } /// /// Parses a length-delimited message from the given stream. /// /// /// The stream is expected to contain a length and then the data. Only the amount of data /// specified by the length will be consumed. /// /// The stream to parse. /// The parsed message. public IMessage ParseDelimitedFrom(Stream input) { IMessage message = factory(); message.MergeDelimitedFrom(input); return message; } /// /// Parses a message from the given coded input stream. /// /// The stream to parse. /// The parsed message. public IMessage ParseFrom(CodedInputStream input) { IMessage message = factory(); message.MergeFrom(input); return message; } /// /// Parses a message from the given JSON. /// /// The JSON to parse. /// The parsed message. /// The JSON does not comply with RFC 7159 /// The JSON does not represent a Protocol Buffers message correctly public IMessage ParseJson(string json) { IMessage message = factory(); JsonParser.Default.Merge(message, json); return message; } } /// /// A parser for a specific message type. /// /// ///

/// This delegates most behavior to the /// implementation within the original type, but /// provides convenient overloads to parse from a variety of sources. ///

///

/// Most applications will never need to create their own instances of this type; /// instead, use the static Parser property of a generated message type to obtain a /// parser for that type. ///

///
/// The type of message to be parsed. public sealed class MessageParser : MessageParser where T : IMessage { // Implementation note: all the methods here *could* just delegate up to the base class and cast the result. // The current implementation avoids a virtual method call and a cast, which *may* be significant in some cases. // Benchmarking work is required to measure the significance - but it's only a few lines of code in any case. // The API wouldn't change anyway - just the implementation - so this work can be deferred. private readonly Func factory; /// /// Creates a new parser. /// /// /// The factory method is effectively an optimization over using a generic constraint /// to require a parameterless constructor: delegates are significantly faster to execute. /// /// Function to invoke when a new, empty message is required. public MessageParser(Func factory) : base(() => factory()) { this.factory = factory; } /// /// Creates a template instance ready for population. /// /// An empty message. internal new T CreateTemplate() { return factory(); } /// /// Parses a message from a byte array. /// /// The byte array containing the message. Must not be null. /// The newly parsed message. public new T ParseFrom(byte[] data) { ProtoPreconditions.CheckNotNull(data, "data"); T message = factory(); message.MergeFrom(data); return message; } /// /// Parses a message from the given byte string. /// /// The data to parse. /// The parsed message. public new T ParseFrom(ByteString data) { ProtoPreconditions.CheckNotNull(data, "data"); T message = factory(); message.MergeFrom(data); return message; } /// /// Parses a message from the given stream. /// /// The stream to parse. /// The parsed message. public new T ParseFrom(Stream input) { T message = factory(); message.MergeFrom(input); return message; } /// /// Parses a length-delimited message from the given stream. /// /// /// The stream is expected to contain a length and then the data. Only the amount of data /// specified by the length will be consumed. /// /// The stream to parse. /// The parsed message. public new T ParseDelimitedFrom(Stream input) { T message = factory(); message.MergeDelimitedFrom(input); return message; } /// /// Parses a message from the given coded input stream. /// /// The stream to parse. /// The parsed message. public new T ParseFrom(CodedInputStream input) { T message = factory(); message.MergeFrom(input); return message; } /// /// Parses a message from the given JSON. /// /// The JSON to parse. /// The parsed message. /// The JSON does not comply with RFC 7159 /// The JSON does not represent a Protocol Buffers message correctly public new T ParseJson(string json) { T message = factory(); JsonParser.Default.Merge(message, json); return message; } } }