2010-01-20 Zoltan Varga <vargaz@gmail.com>
[mono.git] / mcs / class / System.Runtime.Serialization / System.Runtime.Serialization / SerializationMap.cs
1 //
2 // SerializationMap.cs
3 //
4 // Author:
5 //      Atsushi Enomoto <atsushi@ximian.com>
6 //      Ankit Jain <JAnkit@novell.com>
7 //      Duncan Mak (duncan@ximian.com)
8 //      Eyal Alaluf (eyala@mainsoft.com)
9 //
10 // Copyright (C) 2005 Novell, Inc.  http://www.novell.com
11 // Copyright (C) 2006 Novell, Inc.  http://www.novell.com
12 //
13 // Permission is hereby granted, free of charge, to any person obtaining
14 // a copy of this software and associated documentation files (the
15 // "Software"), to deal in the Software without restriction, including
16 // without limitation the rights to use, copy, modify, merge, publish,
17 // distribute, sublicense, and/or sell copies of the Software, and to
18 // permit persons to whom the Software is furnished to do so, subject to
19 // the following conditions:
20 // 
21 // The above copyright notice and this permission notice shall be
22 // included in all copies or substantial portions of the Software.
23 // 
24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
31 //
32 #if NET_2_0
33 using System;
34 using System.Collections;
35 using System.Collections.Generic;
36 using System.Collections.ObjectModel;
37 using System.Linq;
38 using System.Reflection;
39 using System.Xml;
40 using System.Xml.Schema;
41 using System.Xml.Serialization;
42
43 using QName = System.Xml.XmlQualifiedName;
44
45 namespace System.Runtime.Serialization
46 {
47 /*
48         XmlFormatter implementation design inference:
49
50         type definitions:
51         - No XML Schema types are directly used. There are some maps from
52           xs:blahType to ms:blahType where the namespaceURI for prefix "ms" is
53           "http://schemas.microsoft.com/2003/10/Serialization/" .
54
55         serializable types:
56         - An object being serialized 1) must be of type System.Object, or
57           2) must be null, or 3) must have either a [DataContract] attribute
58           or a [Serializable] attribute to be serializable.
59         - When the object is either of type System.Object or null, then the
60           XML type is "anyType".
61         - When the object is [Serializable], then the runtime-serialization
62           compatible object graph is written.
63         - Otherwise the serialization is based on contract attributes.
64           ([Serializable] takes precedence).
65
66         type derivation:
67         - For type A to be serializable, the base type B of A must be
68           serializable.
69         - If a type which is [Serializable] and whose base type has a
70           [DataContract], then for base type members [DataContract] is taken.
71         - It is vice versa i.e. if the base type is [Serializable] and the
72           derived type has a [DataContract], then [Serializable] takes place
73           for base members.
74
75         known type collection:
76         - It internally manages mapping store keyed by contract QNames.
77           KnownTypeCollection.Add() checks if the same QName contract already
78           exists (and raises InvalidOperationException if required).
79
80 */
81         internal abstract class SerializationMap
82         {
83                 public const BindingFlags AllInstanceFlags =
84                         BindingFlags.Public | BindingFlags.NonPublic |
85                         BindingFlags.Instance;
86
87                 public readonly KnownTypeCollection KnownTypes;
88                 public readonly Type RuntimeType;
89                 public bool IsReference; // new in 3.5 SP1
90                 public List<DataMemberInfo> Members;
91 #if !NET_2_1
92                 XmlSchemaSet schema_set;
93 #endif
94  
95                 //FIXME FIXME
96                 Dictionary<Type, QName> qname_table = new Dictionary<Type, QName> ();
97
98                 protected SerializationMap (
99                         Type type, QName qname, KnownTypeCollection knownTypes)
100                 {
101                         KnownTypes = knownTypes;
102                         RuntimeType = type;
103                         if (qname.Namespace == null)
104                                 qname = new QName (qname.Name,
105                                         KnownTypeCollection.DefaultClrNamespaceBase + type.Namespace);
106
107                         XmlName = qname;
108                         Members = new List<DataMemberInfo> ();
109                 }
110
111                 public virtual bool OutputXsiType {
112                         get { return true; }
113                 }
114
115                 public QName XmlName { get; set; }
116
117                 public CollectionDataContractAttribute GetCollectionDataContractAttribute (Type type)
118                 {
119                         object [] atts = type.GetCustomAttributes (
120                                 typeof (CollectionDataContractAttribute), false);
121                         return atts.Length == 0 ? null : (CollectionDataContractAttribute) atts [0];
122                 }
123
124                 public DataMemberAttribute GetDataMemberAttribute (
125                         MemberInfo mi)
126                 {
127                         object [] atts = mi.GetCustomAttributes (
128                                 typeof (DataMemberAttribute), false);
129                         if (atts.Length == 0)
130                                 return null;
131                         return (DataMemberAttribute) atts [0];
132                 }
133
134                 bool IsPrimitive (Type type)
135                 {
136                         return (Type.GetTypeCode (type) != TypeCode.Object || type == typeof (object));
137                 }
138
139 #if !NET_2_1
140                 /* Returns the XmlSchemaType AND adds it to @schemas */
141                 public virtual XmlSchemaType GetSchemaType (XmlSchemaSet schemas, Dictionary<QName, XmlSchemaType> generated_schema_types)
142                 {
143                         if (IsPrimitive (RuntimeType))
144                                 return null;
145
146                         if (generated_schema_types.ContainsKey (XmlName)) // Caching  
147                                 return generated_schema_types [XmlName] as XmlSchemaType;
148
149                         XmlSchemaComplexType complex_type = null;
150
151                         complex_type = new XmlSchemaComplexType ();
152                         complex_type.Name = XmlName.Name;
153                         generated_schema_types [XmlName] = complex_type;
154
155                         if (RuntimeType.BaseType == typeof (object)) {
156                                 complex_type.Particle = GetSequence (schemas, generated_schema_types);
157                         } else {
158                                 //Has a non-System.Object base class
159                                 XmlSchemaComplexContentExtension extension = new XmlSchemaComplexContentExtension ();
160                                 XmlSchemaComplexContent content = new XmlSchemaComplexContent ();
161
162                                 complex_type.ContentModel = content;
163                                 content.Content = extension;
164
165                                 KnownTypes.Add (RuntimeType.BaseType);
166                                 SerializationMap map = KnownTypes.FindUserMap (RuntimeType.BaseType);
167                                 //FIXME: map == null ?
168                                 map.GetSchemaType (schemas, generated_schema_types);
169
170                                 extension.Particle = GetSequence (schemas, generated_schema_types);
171                                 extension.BaseTypeName = GetQualifiedName (RuntimeType.BaseType);
172                         }
173                         
174                         XmlSchemaElement schemaElement = GetSchemaElement (XmlName, complex_type);
175                         XmlSchema schema = GetSchema (schemas, XmlName.Namespace);
176                         schema.Items.Add (complex_type);
177                         schema.Items.Add (schemaElement);
178                         schemas.Reprocess (schema);
179
180                         return complex_type;
181                 }
182
183                 /* Returns the <xs:sequence> for the data members */
184                 XmlSchemaSequence GetSequence (XmlSchemaSet schemas,
185                                 Dictionary<QName, XmlSchemaType> generated_schema_types)
186                 {
187                         List<DataMemberInfo> members = GetMembers ();
188
189                         XmlSchema schema = GetSchema (schemas, XmlName.Namespace);
190                         XmlSchemaSequence sequence = new XmlSchemaSequence ();
191                         foreach (DataMemberInfo dmi in members) {
192                                 // delegates are not supported.
193                                 if (!dmi.MemberType.IsAbstract && typeof (System.Delegate).IsAssignableFrom (dmi.MemberType))
194                                         continue;
195
196                                 XmlSchemaElement element = new XmlSchemaElement ();
197                                 element.Name = dmi.XmlName;
198
199                                 KnownTypes.Add (dmi.MemberType);
200                                 SerializationMap map = KnownTypes.FindUserMap (dmi.MemberType);
201                                 if (map != null) {
202                                         XmlSchemaType schema_type = map.GetSchemaType (schemas, generated_schema_types);
203                                         if (schema_type is XmlSchemaComplexType)
204                                                 element.IsNillable = true;
205                                 } else {
206                                         //Primitive type
207                                         if (dmi.MemberType == typeof (string))
208                                                 element.IsNillable = true;
209                                 }
210
211                                 element.MinOccurs = 0;
212
213                                 element.SchemaTypeName = GetQualifiedName (dmi.MemberType);
214                                 AddImport (schema, element.SchemaTypeName.Namespace);
215
216                                 sequence.Items.Add (element);
217                         }
218
219                         schemas.Reprocess (schema);
220                         return sequence;
221                 }
222
223                 //FIXME: Replace with a dictionary ?
224                 void AddImport (XmlSchema schema, string ns)
225                 {
226                         if (ns == XmlSchema.Namespace || schema.TargetNamespace == ns)
227                                 return;
228
229                         foreach (XmlSchemaObject o in schema.Includes) {
230                                 XmlSchemaImport import = o as XmlSchemaImport;
231                                 if (import == null)
232                                         continue;
233                                 if (import.Namespace == ns)
234                                         return;
235                         }
236
237                         XmlSchemaImport imp = new XmlSchemaImport ();
238                         imp.Namespace = ns;
239                         schema.Includes.Add (imp);
240                 }
241 #endif
242
243                 //Returns list of data members for this type ONLY
244                 public virtual List<DataMemberInfo> GetMembers ()
245                 {
246                         throw new NotImplementedException (String.Format ("Implement me for {0}", this));
247                 }
248
249 #if !NET_2_1
250                 protected XmlSchemaElement GetSchemaElement (QName qname, XmlSchemaType schemaType)
251                 {
252                         XmlSchemaElement schemaElement = new XmlSchemaElement ();
253                         schemaElement.Name = qname.Name;
254                         schemaElement.SchemaTypeName = qname;
255
256                         if (schemaType is XmlSchemaComplexType)
257                                 schemaElement.IsNillable = true;
258
259                         return schemaElement;
260                 }
261
262                 protected XmlSchema GetSchema (XmlSchemaSet schemas, string ns)
263                 {
264                         ICollection colln = schemas.Schemas (ns);
265                         if (colln.Count > 0) {
266                                 if (colln.Count > 1)
267                                         throw new Exception (String.Format (
268                                                 "More than 1 schema for namespace '{0}' found.", ns));
269                                 foreach (object o in colln)
270                                         //return colln [0]
271                                         return (o as XmlSchema);
272                         }
273
274                         XmlSchema schema = new XmlSchema ();
275                         schema.TargetNamespace = ns;
276                         schema.ElementFormDefault = XmlSchemaForm.Qualified;
277                         schemas.Add (schema);
278
279                         return schema;
280                 }
281
282                 protected XmlQualifiedName GetQualifiedName (Type type)
283                 {
284                         if (qname_table.ContainsKey (type))
285                                 return qname_table [type];
286
287                         QName qname = KnownTypes.GetQName (type);
288                         if (qname.Namespace == KnownTypeCollection.MSSimpleNamespace)
289                                 qname = new QName (qname.Name, XmlSchema.Namespace);
290
291                         qname_table [type] = qname;
292                         return qname;
293                 }
294 #endif
295
296                 public virtual void Serialize (object graph,
297                         XmlFormatterSerializer serializer)
298                 {
299                         string label = null;
300                         if (IsReference) {
301                                 label = (string) serializer.References [graph];
302                                 if (label != null) {
303                                         serializer.Writer.WriteAttributeString ("z", "Ref", KnownTypeCollection.MSSimpleNamespace, label);
304                                         return;
305                                 }
306                                 label = "i" + (serializer.References.Count + 1);
307                                 serializer.References.Add (graph, label);
308                         }
309                         else if (serializer.SerializingObjects.Contains (graph))
310                                 throw new SerializationException (String.Format ("Circular reference of an object in the object graph was found: '{0}' of type {1}", graph, graph.GetType ()));
311                         serializer.SerializingObjects.Add (graph);
312
313                         if (label != null)
314                                 serializer.Writer.WriteAttributeString ("z", "Id", KnownTypeCollection.MSSimpleNamespace, label);
315
316                         SerializeNonReference (graph, serializer);
317
318                         serializer.SerializingObjects.Remove (graph);
319                 }
320
321                 public virtual void SerializeNonReference (object graph,
322                         XmlFormatterSerializer serializer)
323                 {
324                         foreach (DataMemberInfo dmi in Members) {
325                                 FieldInfo fi = dmi.Member as FieldInfo;
326                                 PropertyInfo pi = fi == null ?
327                                         (PropertyInfo) dmi.Member : null;
328                                 Type type = fi != null ?
329                                         fi.FieldType : pi.PropertyType;
330                                 object value = fi != null ?
331                                         fi.GetValue (graph) :
332                                         pi.GetValue (graph, null);
333
334                                 serializer.WriteStartElement (dmi.XmlName, dmi.XmlRootNamespace, dmi.XmlNamespace);
335                                 serializer.Serialize (type, value);
336                                 serializer.WriteEndElement ();
337                         }
338                 }
339
340                 public virtual object DeserializeObject (XmlReader reader, XmlFormatterDeserializer deserializer)
341                 {
342                         bool isEmpty = reader.IsEmptyElement;
343                         reader.ReadStartElement ();
344                         reader.MoveToContent ();
345
346                         object res;
347
348                         if (isEmpty)
349                                 res = DeserializeEmptyContent (reader, deserializer);
350                         else
351                                 res = DeserializeContent (reader, deserializer);
352
353                         reader.MoveToContent ();
354                         if (!isEmpty && reader.NodeType == XmlNodeType.EndElement)
355                                 reader.ReadEndElement ();
356                         else if (!isEmpty && reader.NodeType != XmlNodeType.None) {
357                                 var li = reader as IXmlLineInfo;
358                                 throw new SerializationException (String.Format ("Deserializing type '{3}'. Expecting state 'EndElement'. Encountered state '{0}' with name '{1}' with namespace '{2}'.{4}",
359                                         reader.NodeType,
360                                         reader.Name,
361                                         reader.NamespaceURI,
362                                         RuntimeType.FullName,
363                                         li != null && li.HasLineInfo () ? String.Format (" {0}({1},{2})", reader.BaseURI, li.LineNumber, li.LinePosition) : String.Empty));
364                         }
365                         return res;
366                 }
367
368                 // This is sort of hack. The argument reader already moved ahead of
369                 // the actual empty element.It's just for historical consistency.
370                 public virtual object DeserializeEmptyContent (XmlReader reader,
371                         XmlFormatterDeserializer deserializer)
372                 {
373                         return DeserializeContent (reader, deserializer, true);
374                 }
375
376                 public virtual object DeserializeContent (XmlReader reader,
377                         XmlFormatterDeserializer deserializer)
378                 {
379                         return DeserializeContent (reader, deserializer, false);
380                 }
381
382                 object DeserializeContent (XmlReader reader,
383                         XmlFormatterDeserializer deserializer, bool empty)
384                 {
385                         object instance = FormatterServices.GetUninitializedObject (RuntimeType);
386                         int depth = reader.NodeType == XmlNodeType.None ? reader.Depth : reader.Depth - 1;
387                         bool [] filled = new bool [Members.Count];
388                         int memberInd = -1, ordered = -1;
389                         while (!empty && reader.NodeType == XmlNodeType.Element && reader.Depth > depth) {
390                                 DataMemberInfo dmi = null;
391                                 int i = 0;
392                                 for (; i < Members.Count; i++) { // unordered
393                                         if (Members [i].Order >= 0)
394                                                 break;
395                                         if (reader.LocalName == Members [i].XmlName &&
396                                                 reader.NamespaceURI == Members [i].XmlRootNamespace) {
397                                                 memberInd = i;
398                                                 dmi = Members [i];
399                                                 break;
400                                         }
401                                 }
402                                 for (i = Math.Max (i, ordered); i < Members.Count; i++) { // ordered
403                                         if (dmi != null)
404                                                 break;
405                                         if (reader.LocalName == Members [i].XmlName &&
406                                                 reader.NamespaceURI == Members [i].XmlRootNamespace) {
407                                                 memberInd = i;
408                                                 ordered = i;
409                                                 dmi = Members [i];
410                                                 break;
411                                         }
412                                 }
413
414                                 if (dmi == null) {
415                                         reader.Skip ();
416                                         continue;
417                                 }
418                                 SetValue (dmi, instance, deserializer.Deserialize (dmi.MemberType, reader));
419                                 filled [memberInd] = true;
420                                 reader.MoveToContent ();
421                         }
422                         for (int i = 0; i < Members.Count; i++)
423                                 if (!filled [i] && Members [i].IsRequired)
424                                         throw MissingRequiredMember (Members [i], reader);
425
426                         return instance;
427                 }
428
429                 // For now it could be private.
430                 protected Exception MissingRequiredMember (DataMemberInfo dmi, XmlReader reader)
431                 {
432                         var li = reader as IXmlLineInfo;
433                         return new ArgumentException (String.Format ("Data contract member {0} for the type {1} is required, but missing in the input XML.{2}",
434                                 new QName (dmi.XmlName, dmi.XmlNamespace),
435                                 RuntimeType,
436                                 li != null && li.HasLineInfo () ? String.Format (" {0}({1},{2})", reader.BaseURI, li.LineNumber, li.LinePosition) : null));
437                 }
438
439                 // For now it could be private.
440                 protected void SetValue (DataMemberInfo dmi, object obj, object value)
441                 {
442                         try {
443                                 if (dmi.Member is PropertyInfo)
444                                         ((PropertyInfo) dmi.Member).SetValue (obj, value, null);
445                                 else
446                                         ((FieldInfo) dmi.Member).SetValue (obj, value);
447                         } catch (Exception ex) {
448                                 throw new InvalidOperationException (String.Format ("Failed to set value of type {0} for property {1}", value != null ? value.GetType () : null, dmi.Member), ex);
449                         }
450                 }
451
452                 protected DataMemberInfo CreateDataMemberInfo (DataMemberAttribute dma, MemberInfo mi, Type type)
453                 {
454                         KnownTypes.Add (type);
455                         QName qname = KnownTypes.GetQName (type);
456                         string rootNamespace = KnownTypes.GetQName (mi.DeclaringType).Namespace;
457                         if (KnownTypeCollection.GetPrimitiveTypeFromName (qname.Name) != null)
458                                 return new DataMemberInfo (mi, dma, rootNamespace, null);
459                         else
460                                 return new DataMemberInfo (mi, dma, rootNamespace, qname.Namespace);
461                 }
462         }
463
464         internal class XmlSerializableMap : SerializationMap
465         {
466                 public XmlSerializableMap (Type type, QName qname, KnownTypeCollection knownTypes)
467                         : base (type, qname, knownTypes)
468                 {
469                 }
470
471                 public override void Serialize (object graph, XmlFormatterSerializer serializer)
472                 {
473                         IXmlSerializable ixs = graph as IXmlSerializable;
474                         if (ixs == null)
475                                 //FIXME: Throw what exception here?
476                                 throw new SerializationException ();
477
478                         ixs.WriteXml (serializer.Writer);
479                 }
480
481                 public override object DeserializeObject (XmlReader reader, XmlFormatterDeserializer deserializer)
482                 {
483                         IXmlSerializable ixs = (IXmlSerializable) FormatterServices.GetUninitializedObject (RuntimeType);
484                         ixs.ReadXml (reader);
485                         return ixs;
486                 }
487
488 #if !NET_2_1
489                 // FIXME: verify return value sanity.
490                 public override XmlSchemaType GetSchemaType (XmlSchemaSet schemas, Dictionary<QName, XmlSchemaType> generated_schema_types)
491                 {
492                         return null;
493                 }
494 #endif
495         }
496
497         internal class SharedContractMap : SerializationMap
498         {
499                 public SharedContractMap (
500                         Type type, QName qname, KnownTypeCollection knownTypes)
501                         : base (type, qname, knownTypes)
502                 {
503                 }
504
505                 internal void Initialize ()
506                 {
507                         Type baseType = RuntimeType;
508                         List <DataMemberInfo> members = new List <DataMemberInfo> ();
509                         object [] atts = baseType.GetCustomAttributes (
510                                 typeof (DataContractAttribute), false);
511                         IsReference = atts.Length > 0 ? (((DataContractAttribute) atts [0]).IsReference) : false;
512
513                         while (baseType != null) {
514                                 QName bqname = KnownTypes.GetQName (baseType);
515                                         
516                                 members = GetMembers (baseType, bqname, true);
517                                 members.Sort (DataMemberInfo.DataMemberInfoComparer.Instance);
518                                 Members.InsertRange (0, members);
519                                 members.Clear ();
520
521                                 baseType = baseType.BaseType;
522                         }
523                 }
524
525                 List<DataMemberInfo> GetMembers (Type type, QName qname, bool declared_only)
526                 {
527                         List<DataMemberInfo> data_members = new List<DataMemberInfo> ();
528                         BindingFlags flags = AllInstanceFlags;
529                         if (declared_only)
530                                 flags |= BindingFlags.DeclaredOnly;
531
532                         foreach (PropertyInfo pi in type.GetProperties (flags)) {
533                                 DataMemberAttribute dma =
534                                         GetDataMemberAttribute (pi);
535                                 if (dma == null)
536                                         continue;
537                                 KnownTypes.TryRegister (pi.PropertyType);
538                                 var map = KnownTypes.FindUserMap (pi.PropertyType);
539                                 if (!pi.CanRead || (!pi.CanWrite && !(map is ICollectionTypeMap)))
540                                         throw new InvalidDataContractException (String.Format (
541                                                         "DataMember property '{0}' on type '{1}' must have both getter and setter.", pi, pi.DeclaringType));
542                                 data_members.Add (CreateDataMemberInfo (dma, pi, pi.PropertyType));
543                         }
544
545                         foreach (FieldInfo fi in type.GetFields (flags)) {
546                                 DataMemberAttribute dma =
547                                         GetDataMemberAttribute (fi);
548                                 if (dma == null)
549                                         continue;
550                                 if (fi.IsInitOnly)
551                                         throw new InvalidDataContractException (String.Format (
552                                                         "DataMember field {0} must not be read-only.", fi));
553                                 data_members.Add (CreateDataMemberInfo (dma, fi, fi.FieldType));
554                         }
555
556                         return data_members;
557                 }
558
559                 public override List<DataMemberInfo> GetMembers ()
560                 {
561                         return Members;
562                 }
563         }
564
565         internal class DefaultTypeMap : SerializationMap
566         {
567                 public DefaultTypeMap (Type type, KnownTypeCollection knownTypes)
568                         : base (type, KnownTypeCollection.GetContractQName (type, null, null), knownTypes)
569                 {
570                         Members.AddRange (GetDefaultMembers ());
571                 }
572
573                 List<DataMemberInfo> GetDefaultMembers ()
574                 {
575                         var l = new List<DataMemberInfo> ();
576                         foreach (var mi in RuntimeType.GetMembers ()) {
577                                 Type mt = null;
578                                 FieldInfo fi = mi as FieldInfo;
579                                 mt = fi == null ? null : fi.FieldType;
580                                 PropertyInfo pi = mi as PropertyInfo;
581                                 if (pi != null && pi.CanRead && pi.CanWrite && pi.GetIndexParameters ().Length == 0)
582                                         mt = pi.PropertyType;
583                                 if (mt == null)
584                                         continue;
585                                 if (mi.GetCustomAttributes (typeof (IgnoreDataMemberAttribute), false).Length != 0)
586                                         continue;
587                                 l.Add (new DataMemberInfo (mi, new DataMemberAttribute (), null, null));
588                         }
589                         l.Sort (DataMemberInfo.DataMemberInfoComparer.Instance);
590                         return l;
591                 }
592         }
593
594         // FIXME: it still needs to consider ItemName/KeyName/ValueName
595         // (especially Dictionary collection is not likely considered yet.)
596         internal class CollectionContractTypeMap : CollectionTypeMap
597         {
598                 public CollectionContractTypeMap (
599                         Type type, CollectionDataContractAttribute a, Type elementType,
600                         QName qname, KnownTypeCollection knownTypes)
601                         : base (type, elementType, qname, knownTypes)
602                 {
603                         IsReference = a.IsReference;
604                 }
605
606                 internal override string CurrentNamespace {
607                         get { return XmlName.Namespace; }
608                 }
609         }
610
611         internal interface ICollectionTypeMap
612         {
613         }
614
615         internal class CollectionTypeMap : SerializationMap, ICollectionTypeMap
616         {
617                 Type element_type;
618                 internal QName element_qname;
619                 MethodInfo add_method;
620
621                 public CollectionTypeMap (
622                         Type type, Type elementType,
623                         QName qname, KnownTypeCollection knownTypes)
624                         : base (type, qname, knownTypes)
625                 {
626                         element_type = elementType;
627                         element_qname = KnownTypes.GetQName (element_type);
628                         var icoll = GetGenericCollectionInterface (RuntimeType);
629                         if (icoll != null) {
630                                 if (RuntimeType.IsInterface) {
631                                         add_method = RuntimeType.GetMethod ("Add", icoll.GetGenericArguments ());
632                                 } else {
633                                         var imap = RuntimeType.GetInterfaceMap (icoll);
634                                         for (int i = 0; i < imap.InterfaceMethods.Length; i++)
635                                                 if (imap.InterfaceMethods [i].Name == "Add") {
636                                                         add_method = imap.TargetMethods [i];
637                                                         break;
638                                                 }
639                                         if (add_method == null)
640                                                 add_method = type.GetMethod ("Add", icoll.GetGenericArguments ());
641                                 }
642                         }
643                 }
644
645                 static Type GetGenericCollectionInterface (Type type)
646                 {
647                         foreach (var iface in type.GetInterfaces ())
648                                 if (iface.IsGenericType && iface.GetGenericTypeDefinition () == typeof (ICollection<>))
649                                         return iface;
650
651                         return null;
652                 }
653
654                 public override bool OutputXsiType {
655                         get { return false; }
656                 }
657
658                 internal virtual string CurrentNamespace {
659                         get {
660                                 string ns = element_qname.Namespace;
661                                 if (ns == KnownTypeCollection.MSSimpleNamespace)
662                                         ns = KnownTypeCollection.MSArraysNamespace;
663                                 return ns;
664                         }
665                 }
666
667                 public override void SerializeNonReference (object graph,
668                         XmlFormatterSerializer serializer)
669                 {
670
671                         foreach (object o in (IEnumerable) graph) {
672                                 serializer.WriteStartElement (element_qname.Name, XmlName.Namespace, CurrentNamespace);
673                                 serializer.Serialize (element_type, o);
674                                 serializer.WriteEndElement ();
675                         }
676                 }
677
678                 object CreateInstance ()
679                 {
680                         if (RuntimeType.IsArray)
681                                 return new ArrayList ();
682                         if (RuntimeType.IsInterface) {
683                                 var icoll = GetGenericCollectionInterface (RuntimeType);
684                                 if (icoll != null)
685                                         return Activator.CreateInstance (typeof (List<>).MakeGenericType (RuntimeType.GetGenericArguments () [0])); // List<T>
686                                 else // non-generic
687                                         return new ArrayList ();
688                         }
689 #if NET_2_1 // FIXME: is it fine?
690                         return Activator.CreateInstance (RuntimeType);
691 #else
692                         return Activator.CreateInstance (RuntimeType, true);
693 #endif
694                 }
695
696                 public override object DeserializeEmptyContent (XmlReader reader, XmlFormatterDeserializer deserializer)
697                 {
698                         return CreateInstance ();
699                 }
700
701                 public override object DeserializeContent (XmlReader reader, XmlFormatterDeserializer deserializer)
702                 {
703                         object instance = CreateInstance ();
704                         int depth = reader.NodeType == XmlNodeType.None ? reader.Depth : reader.Depth - 1;
705                         while (reader.NodeType == XmlNodeType.Element && reader.Depth > depth) {
706                                 object elem = deserializer.Deserialize (element_type, reader);
707                                 if (instance is IList)
708                                         ((IList)instance).Add (elem);
709                                 else if (add_method != null)
710                                         add_method.Invoke (instance, new object [] {elem});
711                                 else
712                                         throw new NotImplementedException (String.Format ("Type {0} is not supported", RuntimeType));
713                                 reader.MoveToContent ();
714                         }
715                         if (RuntimeType.IsArray)
716                                 return ((ArrayList)instance).ToArray (element_type);
717                         return instance;
718                 }
719
720                 public override List<DataMemberInfo> GetMembers ()
721                 {
722                         //Shouldn't come here at all!
723                         throw new NotImplementedException ();
724                 }
725                 
726 #if !NET_2_1
727                 public override XmlSchemaType GetSchemaType (XmlSchemaSet schemas, Dictionary<QName, XmlSchemaType> generated_schema_types)
728                 {
729                         if (generated_schema_types.ContainsKey (XmlName))
730                                 return null;
731
732                         if (generated_schema_types.ContainsKey (XmlName))
733                                 return generated_schema_types [XmlName];
734
735                         QName element_qname = GetQualifiedName (element_type);
736
737                         XmlSchemaComplexType complex_type = new XmlSchemaComplexType ();
738                         complex_type.Name = XmlName.Name;
739
740                         XmlSchemaSequence sequence = new XmlSchemaSequence ();
741                         XmlSchemaElement element = new XmlSchemaElement ();
742
743                         element.MinOccurs = 0;
744                         element.MaxOccursString = "unbounded";
745                         element.Name = element_qname.Name;
746
747                         KnownTypes.Add (element_type);
748                         SerializationMap map = KnownTypes.FindUserMap (element_type);
749                         if (map != null) {// non-primitive type
750                                 map.GetSchemaType (schemas, generated_schema_types);
751                                 element.IsNillable = true;
752                         }
753
754                         element.SchemaTypeName = element_qname;
755
756                         sequence.Items.Add (element);
757                         complex_type.Particle = sequence;
758
759                         XmlSchema schema = GetSchema (schemas, XmlName.Namespace);
760                         schema.Items.Add (complex_type);
761                         schema.Items.Add (GetSchemaElement (XmlName, complex_type));
762                         schemas.Reprocess (schema);
763
764                         generated_schema_types [XmlName] = complex_type;
765
766                         return complex_type;
767                 }
768 #endif
769         }
770
771         internal class DictionaryTypeMap : SerializationMap, ICollectionTypeMap
772         {
773                 Type key_type, value_type;
774                 QName dict_qname, item_qname, key_qname, value_qname;
775                 MethodInfo add_method;
776                 CollectionDataContractAttribute a;
777
778                 public DictionaryTypeMap (
779                         Type type, CollectionDataContractAttribute a, KnownTypeCollection knownTypes)
780                         : base (type, QName.Empty, knownTypes)
781                 {
782                         this.a = a;
783
784                         key_type = typeof (object);
785                         value_type = typeof (object);
786
787                         var idic = GetGenericDictionaryInterface (RuntimeType);
788                         if (idic != null) {
789                                 var imap = RuntimeType.GetInterfaceMap (idic);
790                                 for (int i = 0; i < imap.InterfaceMethods.Length; i++)
791                                         if (imap.InterfaceMethods [i].Name == "Add") {
792                                                 add_method = imap.TargetMethods [i];
793                                                 break;
794                                         }
795                                 var argtypes = idic.GetGenericArguments();
796                                 key_type = argtypes [0];
797                                 value_type = argtypes [1];
798                                 if (add_method == null)
799                                         add_method = type.GetMethod ("Add", argtypes);
800                         }
801
802                         XmlName = GetDictionaryQName ();
803                         item_qname = GetItemQName ();
804                         key_qname = GetKeyQName ();
805                         value_qname = GetValueQName ();
806                 }
807
808                 static Type GetGenericDictionaryInterface (Type type)
809                 {
810                         foreach (var iface in type.GetInterfaces ())
811                                 if (iface.IsGenericType && iface.GetGenericTypeDefinition () == typeof (IDictionary<,>))
812                                         return iface;
813
814                         return null;
815                 }
816
817                 string ContractNamespace {
818                         get { return a != null && !String.IsNullOrEmpty (a.Namespace) ? a.Namespace : KnownTypeCollection.MSArraysNamespace; }
819                 }
820
821                 public Type KeyType { get { return key_type; } }
822                 public Type ValueType { get { return value_type; } }
823
824                 static readonly QName kvpair_key_qname = new QName ("Key", KnownTypeCollection.MSArraysNamespace);
825                 static readonly QName kvpair_value_qname = new QName ("Value", KnownTypeCollection.MSArraysNamespace);
826
827                 internal virtual QName GetDictionaryQName ()
828                 {
829                         if (a != null && !String.IsNullOrEmpty (a.Name))
830                                 return new QName (a.Name, ContractNamespace);
831                         return new QName ("ArrayOf" + GetItemQName ().Name, KnownTypeCollection.MSArraysNamespace);
832                 }
833
834                 internal virtual QName GetItemQName ()
835                 {
836                         if (a != null && !String.IsNullOrEmpty (a.ItemName))
837                                 return new QName (a.ItemName, ContractNamespace);
838                         return new QName ("KeyValueOf" + KnownTypes.GetQName (key_type).Name + KnownTypes.GetQName (value_type).Name, KnownTypeCollection.MSArraysNamespace);
839                 }
840
841                 internal virtual QName GetKeyQName ()
842                 {
843                         if (a != null && !String.IsNullOrEmpty (a.KeyName))
844                                 return new QName (a.KeyName, ContractNamespace);
845                         return kvpair_key_qname;
846                 }
847
848                 internal virtual QName GetValueQName ()
849                 {
850                         if (a != null && !String.IsNullOrEmpty (a.ValueName))
851                                 return new QName (a.ValueName, ContractNamespace);
852                         return kvpair_value_qname;
853                 }
854
855                 internal virtual string CurrentNamespace {
856                         get {
857                                 string ns = item_qname.Namespace;
858                                 if (ns == KnownTypeCollection.MSSimpleNamespace)
859                                         ns = KnownTypeCollection.MSArraysNamespace;
860                                 return ns;
861                         }
862                 }
863
864                 Type pair_type;
865                 PropertyInfo pair_key_property, pair_value_property;
866
867                 public override void SerializeNonReference (object graph,
868                         XmlFormatterSerializer serializer)
869                 {
870                         if (add_method != null) { // generic
871                                 if (pair_type == null) {
872                                         pair_type = typeof (KeyValuePair<,>).MakeGenericType (add_method.DeclaringType.GetGenericArguments ());
873                                         pair_key_property = pair_type.GetProperty ("Key");
874                                         pair_value_property = pair_type.GetProperty ("Value");
875                                 }
876                                 foreach (object p in (IEnumerable) graph) {
877                                         serializer.WriteStartElement (item_qname.Name, item_qname.Namespace, CurrentNamespace);
878                                         serializer.WriteStartElement (key_qname.Name, key_qname.Namespace, CurrentNamespace);
879                                         serializer.Serialize (pair_key_property.PropertyType, pair_key_property.GetValue (p, null));
880                                         serializer.WriteEndElement ();
881                                         serializer.WriteStartElement (value_qname.Name, value_qname.Namespace, CurrentNamespace);
882                                         serializer.Serialize (pair_value_property.PropertyType, pair_value_property.GetValue (p, null));
883                                         serializer.WriteEndElement ();
884                                         serializer.WriteEndElement ();
885                                 }
886                         } else { // non-generic
887                                 foreach (DictionaryEntry p in (IEnumerable) graph) {
888                                         serializer.WriteStartElement (item_qname.Name, item_qname.Namespace, CurrentNamespace);
889                                         serializer.WriteStartElement (key_qname.Name, key_qname.Namespace, CurrentNamespace);
890                                         serializer.Serialize (key_type, p.Key);
891                                         serializer.WriteEndElement ();
892                                         serializer.WriteStartElement (value_qname.Name, value_qname.Namespace, CurrentNamespace);
893                                         serializer.Serialize (value_type, p.Value);
894                                         serializer.WriteEndElement ();
895                                         serializer.WriteEndElement ();
896                                 }
897                         }
898                 }
899
900                 object CreateInstance ()
901                 {
902                         if (RuntimeType.IsInterface) {
903                                 if (RuntimeType.IsGenericType && Array.IndexOf (RuntimeType.GetGenericTypeDefinition ().GetInterfaces (), typeof (IDictionary<,>)) >= 0) {
904                                         var gargs = RuntimeType.GetGenericArguments ();
905                                         return Activator.CreateInstance (typeof (Dictionary<,>).MakeGenericType (gargs [0], gargs [1])); // Dictionary<T>
906                                 }
907                                 else // non-generic
908                                         return new Hashtable ();
909                         }
910 #if NET_2_1 // FIXME: is it fine?
911                         return Activator.CreateInstance (RuntimeType);
912 #else
913                         return Activator.CreateInstance (RuntimeType, true);
914 #endif
915                 }
916
917                 public override object DeserializeEmptyContent (XmlReader reader, XmlFormatterDeserializer deserializer)
918                 {
919                         return DeserializeContent (reader, deserializer);
920                 }
921
922                 public override object DeserializeContent(XmlReader reader, XmlFormatterDeserializer deserializer)
923                 {
924                         object instance = CreateInstance ();
925                         int depth = reader.NodeType == XmlNodeType.None ? reader.Depth : reader.Depth - 1;
926                         while (reader.NodeType == XmlNodeType.Element && reader.Depth > depth) {
927                                 if (reader.IsEmptyElement)
928                                         throw new XmlException (String.Format ("Unexpected empty element for dictionary entry: name {0}", reader.Name));
929                                 // FIXME: sloppy parsing
930                                 reader.ReadStartElement ();// item_qname.Name, item_qname.Namespace);
931                                 reader.MoveToContent ();
932                                 object key = deserializer.Deserialize (key_type, reader);
933                                 reader.MoveToContent ();
934                                 object val = deserializer.Deserialize (value_type, reader);
935                                 reader.ReadEndElement (); // of pair
936
937                                 if (instance is IDictionary)
938                                         ((IDictionary)instance).Add (key, val);
939                                 else if (add_method != null)
940                                         add_method.Invoke (instance, new object [] {key, val});
941                                 else
942                                         throw new NotImplementedException (String.Format ("Type {0} is not supported", RuntimeType));
943                         }
944                         return instance;
945                 }
946
947                 public override List<DataMemberInfo> GetMembers ()
948                 {
949                         //Shouldn't come here at all!
950                         throw new NotImplementedException ();
951                 }
952                 
953 #if !NET_2_1
954                 public override XmlSchemaType GetSchemaType (XmlSchemaSet schemas, Dictionary<QName, XmlSchemaType> generated_schema_types)
955                 {
956                         throw new NotImplementedException ();
957                 }
958 #endif
959         }
960
961         internal class SharedTypeMap : SerializationMap
962         {
963                 public SharedTypeMap (
964                         Type type, QName qname, KnownTypeCollection knownTypes)
965                         : base (type, qname, knownTypes)
966                 {
967                         Members = GetMembers (type, XmlName, false);
968                 }
969
970                 List<DataMemberInfo> GetMembers (Type type, QName qname, bool declared_only)
971                 {
972                         List<DataMemberInfo> data_members = new List<DataMemberInfo> ();
973                         BindingFlags flags = AllInstanceFlags;
974                         if (declared_only)
975                                 flags |= BindingFlags.DeclaredOnly;
976                         
977                         foreach (FieldInfo fi in type.GetFields (flags)) {
978                                 if (fi.GetCustomAttributes (
979                                         typeof (NonSerializedAttribute),
980                                         false).Length > 0)
981                                         continue;
982
983                                 if (fi.IsInitOnly)
984                                         throw new InvalidDataContractException (String.Format ("DataMember field {0} must not be read-only.", fi));
985                                 DataMemberAttribute dma = new DataMemberAttribute ();
986                                 data_members.Add (CreateDataMemberInfo (dma, fi, fi.FieldType));
987                         }
988
989                         data_members.Sort (DataMemberInfo.DataMemberInfoComparer.Instance); // alphabetic order.
990
991                         return data_members;
992                 }
993
994                 // Does this make sense? I doubt.
995                 public override List<DataMemberInfo> GetMembers ()
996                 {
997                         return Members;
998                         //return GetMembers (RuntimeType, XmlName, true);
999                 }
1000         }
1001
1002         internal class EnumMap : SerializationMap
1003         {
1004                 List<EnumMemberInfo> enum_members;
1005                 bool flag_attr;
1006
1007                 public EnumMap (
1008                         Type type, QName qname, KnownTypeCollection knownTypes)
1009                         : base (type, qname, knownTypes)
1010                 {
1011                         bool has_dc = false;
1012                         object [] atts = RuntimeType.GetCustomAttributes (
1013                                 typeof (DataContractAttribute), false);
1014                         if (atts.Length != 0)
1015                                 has_dc = true;
1016                         flag_attr = type.GetCustomAttributes (typeof (FlagsAttribute), false).Length > 0;
1017
1018                         enum_members = new List<EnumMemberInfo> ();
1019                         BindingFlags flags = BindingFlags.Public | BindingFlags.DeclaredOnly | BindingFlags.Static;
1020                         
1021                         foreach (FieldInfo fi in RuntimeType.GetFields (flags)) {
1022                                 string name = fi.Name;
1023                                 if (has_dc) {
1024                                         EnumMemberAttribute ema =
1025                                                 GetEnumMemberAttribute (fi);
1026                                         if (ema == null)
1027                                                 continue;
1028
1029                                         if (ema.Value != null)
1030                                                 name = ema.Value;
1031                                 }
1032
1033                                 enum_members.Add (new EnumMemberInfo (name, fi.GetValue (null)));
1034                         }
1035                 }
1036
1037                 private EnumMemberAttribute GetEnumMemberAttribute (
1038                         MemberInfo mi)
1039                 {
1040                         object [] atts = mi.GetCustomAttributes (
1041                                 typeof (EnumMemberAttribute), false);
1042                         if (atts.Length == 0)
1043                                 return null;
1044                         return (EnumMemberAttribute) atts [0];
1045                 }
1046
1047 #if !NET_2_1
1048                 public override XmlSchemaType GetSchemaType (XmlSchemaSet schemas, Dictionary<QName, XmlSchemaType> generated_schema_types)
1049                 {
1050                         if (generated_schema_types.ContainsKey (XmlName))
1051                                 return generated_schema_types [XmlName];
1052
1053                         XmlSchemaSimpleType simpleType = new XmlSchemaSimpleType ();
1054                         simpleType.Name = XmlName.Name;
1055
1056                         XmlSchemaSimpleTypeRestriction simpleRestriction = new XmlSchemaSimpleTypeRestriction ();
1057                         simpleType.Content = simpleRestriction;
1058                         simpleRestriction.BaseTypeName = new XmlQualifiedName ("string", XmlSchema.Namespace);
1059
1060                         foreach (EnumMemberInfo emi in enum_members) {
1061                                 XmlSchemaEnumerationFacet e = new XmlSchemaEnumerationFacet ();
1062                                 e.Value = emi.XmlName;
1063                                 simpleRestriction.Facets.Add (e);
1064                         }
1065
1066                         generated_schema_types [XmlName] = simpleType;
1067                         
1068                         XmlSchema schema = GetSchema (schemas, XmlName.Namespace);
1069                         XmlSchemaElement element = GetSchemaElement (XmlName, simpleType);
1070                         element.IsNillable = true;
1071
1072                         schema.Items.Add (simpleType);
1073                         schema.Items.Add (element);
1074
1075                         return simpleType;
1076                 }
1077 #endif
1078
1079                 public override void Serialize (object graph,
1080                         XmlFormatterSerializer serializer)
1081                 {
1082                         foreach (EnumMemberInfo emi in enum_members) {
1083                                 if (Enum.Equals (emi.Value, graph)) {
1084                                         serializer.Writer.WriteString (emi.XmlName);
1085                                         return;
1086                                 }
1087                         }
1088
1089                         throw new SerializationException (String.Format (
1090                                 "Enum value '{0}' is invalid for type '{1}' and cannot be serialized.", graph, RuntimeType));
1091                 }
1092
1093                 public override object DeserializeEmptyContent (XmlReader reader,
1094                         XmlFormatterDeserializer deserializer)
1095                 {
1096                         if (!flag_attr)
1097                                 throw new SerializationException (String.Format ("Enum value '' is invalid for type '{0}' and cannot be deserialized.", RuntimeType));
1098                         return Enum.ToObject (RuntimeType, 0);
1099                 }
1100
1101                 public override object DeserializeContent (XmlReader reader,
1102                         XmlFormatterDeserializer deserializer)
1103                 {
1104                         string value = reader.NodeType != XmlNodeType.Text ? String.Empty : reader.ReadContentAsString ();
1105
1106                         if (value != String.Empty) {
1107                                 foreach (EnumMemberInfo emi in enum_members)
1108                                         if (emi.XmlName == value)
1109                                                 return emi.Value;
1110                         }
1111
1112                         if (!flag_attr)
1113                                 throw new SerializationException (String.Format ("Enum value '{0}' is invalid for type '{1}' and cannot be deserialized.", value, RuntimeType));
1114                         return Enum.ToObject (RuntimeType, 0);
1115                 }
1116         }
1117
1118         internal struct EnumMemberInfo
1119         {
1120                 public readonly string XmlName;
1121                 public readonly object Value;
1122
1123                 public EnumMemberInfo (string name, object value)
1124                 {
1125                         XmlName = name;
1126                         Value = value;
1127                 }
1128         }
1129
1130         internal class DataMemberInfo //: KeyValuePair<int, MemberInfo>
1131         {
1132                 public readonly int Order;
1133                 public readonly bool IsRequired;
1134                 public readonly string XmlName;
1135                 public readonly MemberInfo Member;
1136                 public readonly string XmlNamespace;
1137                 public readonly string XmlRootNamespace;
1138                 public readonly Type MemberType;
1139
1140                 public DataMemberInfo (MemberInfo member, DataMemberAttribute dma, string rootNamespce, string ns)
1141                 {
1142                         if (dma == null)
1143                                 throw new ArgumentNullException ("dma");
1144                         Order = dma.Order;
1145                         Member = member;
1146                         IsRequired = dma.IsRequired;
1147                         XmlName = dma.Name != null ? dma.Name : member.Name;
1148                         XmlNamespace = ns;
1149                         XmlRootNamespace = rootNamespce;
1150                         if (Member is FieldInfo)
1151                                 MemberType = ((FieldInfo) Member).FieldType;
1152                         else
1153                                 MemberType = ((PropertyInfo) Member).PropertyType;
1154                 }
1155
1156                 public class DataMemberInfoComparer : IComparer<DataMemberInfo>
1157                         , IComparer // see bug #76361
1158                 {
1159                         public static readonly DataMemberInfoComparer Instance
1160                                 = new DataMemberInfoComparer ();
1161
1162                         private DataMemberInfoComparer () {}
1163
1164                         public int Compare (object o1, object o2)
1165                         {
1166                                 return Compare ((DataMemberInfo) o1,
1167                                         (DataMemberInfo) o2);
1168                         }
1169
1170                         public int Compare (DataMemberInfo d1, DataMemberInfo d2)
1171                         {
1172                                 if (d1.Order == d2.Order)
1173                                         return String.CompareOrdinal (d1.XmlName, d2.XmlName);
1174
1175                                 return d1.Order - d2.Order;
1176                         }
1177                 }
1178         }
1179 }
1180 #endif