DataContractSerializer.cs source code in C# .NET

Source code for the .NET framework in C#

                        
Code:

                         / WCF / WCF / 3.5.30729.1 / untmp / Orcas / SP / ndp / cdf / src / WCF / Serialization / System / Runtime / Serialization / DataContractSerializer.cs / 2 / DataContractSerializer.cs
                        

                        
                            //------------------------------------------------------------ 
// Copyright (c) Microsoft Corporation.  All rights reserved.
//-----------------------------------------------------------

namespace System.Runtime.Serialization 
{
    using System; 
    using System.Collections; 
    using System.Diagnostics;
    using System.Globalization; 
    using System.IO;
    using System.Reflection;
    using System.Text;
    using System.Xml; 
    using System.Xml.Serialization;
    using System.Collections.Generic; 
    using System.Collections.ObjectModel; 
    using System.Runtime.CompilerServices;
    using DataContractDictionary = System.Collections.Generic.Dictionary; 

    public sealed class DataContractSerializer : XmlObjectSerializer
    {
        Type rootType; 
        DataContract rootContract; // post-surrogate
        bool needsContractNsAtRoot; 
        XmlDictionaryString rootName; 
        XmlDictionaryString rootNamespace;
        int maxItemsInObjectGraph; 
        bool ignoreExtensionDataObject;
        bool preserveObjectReferences;
        IDataContractSurrogate dataContractSurrogate;
        ReadOnlyCollection knownTypeCollection; 
        internal IList knownTypeList;
        internal DataContractDictionary knownDataContracts; 
 
        public DataContractSerializer(Type type)
            : this(type, null) 
        {
        }

        public DataContractSerializer(Type type, IEnumerable knownTypes) 
            : this(type, knownTypes, int.MaxValue, false, false, null)
        { 
        } 

        public DataContractSerializer(Type type, 
            IEnumerable knownTypes,
            int maxItemsInObjectGraph,
            bool ignoreExtensionDataObject,
            bool preserveObjectReferences, 
            IDataContractSurrogate dataContractSurrogate)
        { 
            Initialize(type, knownTypes, maxItemsInObjectGraph, ignoreExtensionDataObject, preserveObjectReferences, dataContractSurrogate); 
        }
 
        public DataContractSerializer(Type type, string rootName, string rootNamespace)
            : this(type, rootName, rootNamespace, null)
        {
        } 

        public DataContractSerializer(Type type, string rootName, string rootNamespace, IEnumerable knownTypes) 
            : this(type, rootName, rootNamespace, knownTypes, int.MaxValue, false, false, null) 
        {
        } 

        public DataContractSerializer(Type type, string rootName, string rootNamespace,
            IEnumerable knownTypes,
            int maxItemsInObjectGraph, 
            bool ignoreExtensionDataObject,
            bool preserveObjectReferences, 
            IDataContractSurrogate dataContractSurrogate) 
        {
            XmlDictionary dictionary = new XmlDictionary(2); 
            Initialize(type, dictionary.Add(rootName), dictionary.Add(DataContract.GetNamespace(rootNamespace)), knownTypes, maxItemsInObjectGraph, ignoreExtensionDataObject, preserveObjectReferences, dataContractSurrogate);
        }

        public DataContractSerializer(Type type, XmlDictionaryString rootName, XmlDictionaryString rootNamespace) 
            : this(type, rootName, rootNamespace, null)
        { 
        } 

        public DataContractSerializer(Type type, XmlDictionaryString rootName, XmlDictionaryString rootNamespace, IEnumerable knownTypes) 
            : this(type, rootName, rootNamespace, knownTypes, int.MaxValue, false, false, null)
        {
        }
 
        public DataContractSerializer(Type type, XmlDictionaryString rootName, XmlDictionaryString rootNamespace,
            IEnumerable knownTypes, 
            int maxItemsInObjectGraph, 
            bool ignoreExtensionDataObject,
            bool preserveObjectReferences, 
            IDataContractSurrogate dataContractSurrogate)
        {
            Initialize(type, rootName, rootNamespace, knownTypes, maxItemsInObjectGraph, ignoreExtensionDataObject, preserveObjectReferences, dataContractSurrogate);
        } 

        void Initialize(Type type, 
            IEnumerable knownTypes, 
            int maxItemsInObjectGraph,
            bool ignoreExtensionDataObject, 
            bool preserveObjectReferences,
            IDataContractSurrogate dataContractSurrogate)
        {
            CheckNull(type, "type"); 
            this.rootType = type;
 
            if (knownTypes != null) 
            {
                this.knownTypeList = new List(); 
                foreach (Type knownType in knownTypes)
                {
                    this.knownTypeList.Add(knownType);
                } 
            }
 
            if (maxItemsInObjectGraph < 0) 
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(new ArgumentOutOfRangeException("maxItemsInObjectGraph", SR.GetString(SR.ValueMustBeNonNegative)));
            this.maxItemsInObjectGraph = maxItemsInObjectGraph; 

            this.ignoreExtensionDataObject = ignoreExtensionDataObject;
            this.preserveObjectReferences = preserveObjectReferences;
            this.dataContractSurrogate = dataContractSurrogate; 
        }
 
        void Initialize(Type type, XmlDictionaryString rootName, XmlDictionaryString rootNamespace, 
            IEnumerable knownTypes,
            int maxItemsInObjectGraph, 
            bool ignoreExtensionDataObject,
            bool preserveObjectReferences,
            IDataContractSurrogate dataContractSurrogate)
        { 
            Initialize(type, knownTypes, maxItemsInObjectGraph, ignoreExtensionDataObject, preserveObjectReferences, dataContractSurrogate);
            // validate root name and namespace are both non-null 
            this.rootName = rootName; 
            this.rootNamespace = rootNamespace;
        } 

        public ReadOnlyCollection KnownTypes
        {
            get 
            {
                if (knownTypeCollection == null) 
                { 
                    if (knownTypeList != null)
                    { 
                        knownTypeCollection = new ReadOnlyCollection(knownTypeList);
                    }
                    else
                    { 
                        knownTypeCollection = new ReadOnlyCollection(Globals.EmptyTypeArray);
                    } 
                } 
                return knownTypeCollection;
            } 
        }

        internal DataContractDictionary KnownDataContracts
        { 
            get
            { 
                if (this.knownDataContracts == null  && this.knownTypeList != null) 
                {
                    // This assignment may be performed concurrently and thus is a race condition. 
                    // It's safe, however, because at worse a new (and identical) dictionary of
                    // data contracts will be created and re-assigned to this field.  Introduction
                    // of a lock here could lead to deadlocks.
                    this.knownDataContracts = XmlObjectSerializerContext.GetDataContractsForKnownTypes(this.knownTypeList); 
                }
                return this.knownDataContracts; 
            } 
        }
 
        public int MaxItemsInObjectGraph
        {
            get { return maxItemsInObjectGraph; }
        } 

        public IDataContractSurrogate DataContractSurrogate 
        { 
            get { return dataContractSurrogate; }
        } 

        public bool PreserveObjectReferences
        {
            get { return preserveObjectReferences; } 
        }
 
        public bool IgnoreExtensionDataObject 
        {
            get { return ignoreExtensionDataObject; } 
        }

        DataContract RootContract
        { 
            get
            { 
                if (rootContract == null) 
                {
                    rootContract = DataContract.GetDataContract(((dataContractSurrogate == null) ? rootType : GetSurrogatedType(dataContractSurrogate, rootType))); 
                    needsContractNsAtRoot = CheckIfNeedsContractNsAtRoot(rootName, rootNamespace, rootContract);
                }
                return rootContract;
            } 
        }
 
        internal override void InternalWriteObject(XmlWriterDelegator writer, object graph) 
        {
            InternalWriteStartObject(writer, graph); 
            InternalWriteObjectContent(writer, graph);
            InternalWriteEndObject(writer);
        }
 
        public override void WriteObject(XmlWriter writer, object graph)
        { 
            WriteObjectHandleExceptions(new XmlWriterDelegator(writer), graph); 
        }
 
        public override void WriteStartObject(XmlWriter writer, object graph)
        {
            WriteStartObjectHandleExceptions(new XmlWriterDelegator(writer), graph);
        } 

        public override void WriteObjectContent(XmlWriter writer, object graph) 
        { 
            WriteObjectContentHandleExceptions(new XmlWriterDelegator(writer), graph);
        } 

        public override void WriteEndObject(XmlWriter writer)
        {
            WriteEndObjectHandleExceptions(new XmlWriterDelegator(writer)); 
        }
 
        public override void WriteStartObject(XmlDictionaryWriter writer, object graph) 
        {
            WriteStartObjectHandleExceptions(new XmlWriterDelegator(writer), graph); 
        }

        public override void WriteObjectContent(XmlDictionaryWriter writer, object graph)
        { 
            WriteObjectContentHandleExceptions(new XmlWriterDelegator(writer), graph);
        } 
 
        public override void WriteEndObject(XmlDictionaryWriter writer)
        { 
            WriteEndObjectHandleExceptions(new XmlWriterDelegator(writer));
        }

        public override object ReadObject(XmlReader reader) 
        {
            return ReadObjectHandleExceptions(new XmlReaderDelegator(reader), true /*verifyObjectName*/); 
        } 

        public override object ReadObject(XmlReader reader, bool verifyObjectName) 
        {
            return ReadObjectHandleExceptions(new XmlReaderDelegator(reader), verifyObjectName);
        }
 
        public override bool IsStartObject(XmlReader reader)
        { 
            return IsStartObjectHandleExceptions(new XmlReaderDelegator(reader)); 
        }
 
        public override object ReadObject(XmlDictionaryReader reader, bool verifyObjectName)
        {
            return ReadObjectHandleExceptions(new XmlReaderDelegator(reader), verifyObjectName);
        } 

        public override bool IsStartObject(XmlDictionaryReader reader) 
        { 
            return IsStartObjectHandleExceptions(new XmlReaderDelegator(reader));
        } 

        internal override void InternalWriteStartObject(XmlWriterDelegator writer, object graph)
        {
            WriteRootElement(writer, RootContract, rootName, rootNamespace, needsContractNsAtRoot); 
        }
 
        internal override void InternalWriteObjectContent(XmlWriterDelegator writer, object graph) 
        {
            if (MaxItemsInObjectGraph == 0) 
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationException(SR.GetString(SR.ExceededMaxItemsQuota, MaxItemsInObjectGraph)));

            DataContract contract = RootContract;
            Type declaredType = contract.UnderlyingType; 
            Type graphType = (graph == null) ? declaredType : graph.GetType();
 
            if (dataContractSurrogate != null) 
                graph = SurrogateToDataContractType(dataContractSurrogate, graph, declaredType, ref graphType);
 
            if (graph == null)
            {
                if (IsRootXmlAny(rootName, contract))
                    throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationException(SR.GetString(SR.IsAnyCannotBeNull, declaredType))); 
                WriteNull(writer);
            } 
            else 
            {
                if (declaredType == graphType) 
                {
                    if (contract.CanContainReferences)
                    {
                        XmlObjectSerializerWriteContext context = XmlObjectSerializerWriteContext.CreateContext(this, contract); 
                        context.HandleGraphAtTopLevel(writer, graph, contract);
                        context.SerializeWithoutXsiType(contract, writer, graph, declaredType.TypeHandle); 
                    } 
                    else
                    { 
                        contract.WriteXmlValue(writer, graph, null);
                    }
                }
                else 
                {
                    XmlObjectSerializerWriteContext context = null; 
                    if (IsRootXmlAny(rootName, contract)) 
                        throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationException(SR.GetString(SR.IsAnyCannotBeSerializedAsDerivedType, graphType, contract.UnderlyingType)));
 
                    contract = GetDataContract(contract, declaredType, graphType);
                    context = XmlObjectSerializerWriteContext.CreateContext(this, RootContract);
                    if (contract.CanContainReferences)
                    { 
                        context.HandleGraphAtTopLevel(writer, graph, contract);
                    } 
                    context.OnHandleIsReference(writer, contract, graph); 
                    context.SerializeWithXsiTypeAtTopLevel(contract, writer, graph, declaredType.TypeHandle);
                } 
            }
        }

        internal static DataContract GetDataContract(DataContract declaredTypeContract, Type declaredType, Type objectType) 
        {
            if (declaredType.IsInterface && CollectionDataContract.IsCollectionInterface(declaredType)) 
            { 
                return declaredTypeContract;
            } 
            else if (declaredType.IsArray)//Array covariance is not supported in XSD
            {
                return declaredTypeContract;
            } 
            else
            { 
                return DataContract.GetDataContract(objectType.TypeHandle, objectType, SerializationMode.SharedContract); 
            }
        } 

        internal override void InternalWriteEndObject(XmlWriterDelegator writer)
        {
            if (!IsRootXmlAny(rootName, RootContract)) 
            {
                writer.WriteEndElement(); 
            } 
        }
 
        internal override object InternalReadObject(XmlReaderDelegator xmlReader, bool verifyObjectName)
        {
            if (MaxItemsInObjectGraph == 0)
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationException(SR.GetString(SR.ExceededMaxItemsQuota, MaxItemsInObjectGraph))); 

            if (verifyObjectName) 
            { 
                if (!InternalIsStartObject(xmlReader))
                { 
                    XmlDictionaryString expectedName;
                    XmlDictionaryString expectedNs;
                    if (rootName == null)
                    { 
                        expectedName = RootContract.TopLevelElementName;
                        expectedNs = RootContract.TopLevelElementNamespace; 
                    } 
                    else
                    { 
                        expectedName = rootName;
                        expectedNs = rootNamespace;
                    }
                    throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationExceptionWithReaderDetails(SR.GetString(SR.ExpectingElement, expectedNs, expectedName), xmlReader)); 
                }
            } 
            else if (!IsStartElement(xmlReader)) 
            {
                throw DiagnosticUtility.ExceptionUtility.ThrowHelperError(XmlObjectSerializer.CreateSerializationExceptionWithReaderDetails(SR.GetString(SR.ExpectingElementAtDeserialize, XmlNodeType.Element), xmlReader)); 
            }

            DataContract contract = RootContract;
            if (contract.IsPrimitive && object.ReferenceEquals(contract.UnderlyingType, rootType) /*handle Nullable differently*/) 
            {
                return contract.ReadXmlValue(xmlReader, null); 
            } 

            if (IsRootXmlAny(rootName, contract)) 
            {
                return XmlObjectSerializerReadContext.ReadRootIXmlSerializable(xmlReader, contract as XmlDataContract, false /*isMemberType*/);
            }
 
            XmlObjectSerializerReadContext context = XmlObjectSerializerReadContext.CreateContext(this, contract);
            return context.InternalDeserialize(xmlReader, rootType, contract, null, null); 
        } 

        internal override bool InternalIsStartObject(XmlReaderDelegator reader) 
        {
            return IsRootElement(reader, RootContract, rootName, rootNamespace);
        }
 
        internal override Type GetSerializeType(object graph)
        { 
            return (graph == null) ? rootType : graph.GetType(); 
        }
 
        internal override Type GetDeserializeType()
        {
            return rootType;
        } 

        internal static object SurrogateToDataContractType(IDataContractSurrogate dataContractSurrogate, object oldObj, Type surrogatedDeclaredType, ref Type objType) 
        { 
            object obj = DataContractSurrogateCaller.GetObjectToSerialize(dataContractSurrogate, oldObj, objType, surrogatedDeclaredType);
            if (obj != oldObj) 
            {
                if (obj == null)
                    objType = Globals.TypeOfObject;
                else 
                    objType = obj.GetType();
            } 
            return obj; 
        }
 
        internal static Type GetSurrogatedType(IDataContractSurrogate dataContractSurrogate, Type type)
        {
            return DataContractSurrogateCaller.GetDataContractType(dataContractSurrogate, DataContract.UnwrapNullableType(type));
        } 

    } 
} 

// File provided for Reference Use Only by Microsoft Corporation (c) 2007.
// Copyright (c) Microsoft Corporation. All rights reserved.

Link Menu

Network programming in C#, Network Programming in VB.NET, Network Programming in .NET
This book is available now!
Buy at Amazon US or
Buy at Amazon UK