2 // XmlSerializationReaderInterpreter.cs:
5 // Lluis Sanchez Gual (lluis@ximian.com)
7 // (C) 2002, 2003 Ximian, Inc. http://www.ximian.com
11 using System.Reflection;
12 using System.Collections;
14 namespace System.Xml.Serialization
16 internal class XmlSerializationReaderInterpreter: XmlSerializationReader
19 SerializationFormat _format;
21 public XmlSerializationReaderInterpreter(XmlMapping typeMap)
24 _format = typeMap.Format;
27 protected override void InitCallbacks ()
29 ArrayList maps = _typeMap.RelatedMaps;
32 foreach (XmlTypeMapping map in maps)
34 if (map.TypeData.SchemaType == SchemaTypes.Class || map.TypeData.SchemaType == SchemaTypes.Enum)
36 ReaderCallbackInfo info = new ReaderCallbackInfo (this, map);
37 AddReadCallback (map.XmlType, map.Namespace, map.TypeData.Type, new XmlSerializationReadCallback (info.ReadObject));
43 protected override void InitIDs ()
47 protected XmlTypeMapping GetTypeMap (Type type)
49 ArrayList maps = _typeMap.RelatedMaps;
52 foreach (XmlTypeMapping map in maps)
53 if (map.TypeData.Type == type) return map;
55 throw new InvalidOperationException ("Type " + type + " not mapped");
58 public object ReadObject ()
60 Reader.MoveToContent();
61 if (_typeMap is XmlTypeMapping)
63 if (_format == SerializationFormat.Literal)
64 return ReadRoot ((XmlTypeMapping)_typeMap);
66 return ReadEncodedObject ((XmlTypeMapping)_typeMap);
69 return ReadMessage ((XmlMembersMapping)_typeMap);
72 object ReadEncodedObject (XmlTypeMapping typeMap)
75 Reader.MoveToContent();
76 if (Reader.NodeType == System.Xml.XmlNodeType.Element)
78 if (Reader.LocalName == typeMap.ElementName && Reader.NamespaceURI == typeMap.Namespace)
79 ob = ReadReferencedElement();
81 throw CreateUnknownNodeException();
86 ReadReferencedElements();
90 protected virtual object ReadMessage (XmlMembersMapping typeMap)
92 object[] parameters = new object[typeMap.Count];
94 if (typeMap.HasWrapperElement)
96 if (_format == SerializationFormat.Encoded)
98 while (Reader.NodeType == System.Xml.XmlNodeType.Element)
100 string root = Reader.GetAttribute ("root", XmlSerializer.EncodingNamespace);
101 if (root == null || System.Xml.XmlConvert.ToBoolean(root)) break;
102 ReadReferencedElement ();
103 Reader.MoveToContent ();
107 while (Reader.NodeType != System.Xml.XmlNodeType.EndElement)
109 if (Reader.IsStartElement(typeMap.ElementName, typeMap.Namespace)
110 || _format == SerializationFormat.Encoded)
112 if (Reader.IsEmptyElement) { Reader.Skip(); Reader.MoveToContent(); continue; }
113 Reader.ReadStartElement();
114 ReadMembers ((ClassMap)typeMap.ObjectMap, parameters, true, false);
121 Reader.MoveToContent();
125 ReadMembers ((ClassMap)typeMap.ObjectMap, parameters, true, _format == SerializationFormat.Encoded);
127 if (_format == SerializationFormat.Encoded)
128 ReadReferencedElements();
133 object ReadRoot (XmlTypeMapping rootMap)
135 if (rootMap.TypeData.SchemaType == SchemaTypes.XmlNode)
137 return ReadXmlNodeElement (rootMap, true);
141 if (Reader.LocalName != rootMap.ElementName || Reader.NamespaceURI != rootMap.Namespace)
142 throw CreateUnknownNodeException();
144 return ReadObject (rootMap, true, true);
149 protected virtual object ReadObject (XmlTypeMapping typeMap, bool isNullable, bool checkType)
151 switch (typeMap.TypeData.SchemaType)
153 case SchemaTypes.Class: return ReadClassInstance (typeMap, isNullable, checkType);
154 case SchemaTypes.Array: return ReadListElement (typeMap, isNullable, null, true);
155 case SchemaTypes.XmlNode: return ReadXmlNodeElement (typeMap, isNullable);
156 case SchemaTypes.Primitive: return ReadPrimitiveElement (typeMap, isNullable);
157 case SchemaTypes.Enum: return ReadEnumElement (typeMap, isNullable);
158 case SchemaTypes.XmlSerializable: return ReadXmlSerializableElement (typeMap, isNullable);
159 default: throw new Exception ("Unsupported map type");
163 protected virtual object ReadClassInstance (XmlTypeMapping typeMap, bool isNullable, bool checkType)
165 if (isNullable && ReadNull()) return null;
169 System.Xml.XmlQualifiedName t = GetXsiType();
172 XmlTypeMapping realMap = typeMap.GetRealElementMap (t.Name, t.Namespace);
173 if (realMap == null) {
174 if (typeMap.TypeData.Type == typeof(object))
175 return ReadTypedPrimitive (t);
177 throw CreateUnknownTypeException((System.Xml.XmlQualifiedName)t);
179 if (realMap != typeMap)
180 return ReadObject (realMap, false, false);
184 object ob = Activator.CreateInstance (typeMap.TypeData.Type);
186 Reader.MoveToElement();
187 bool isEmpty = Reader.IsEmptyElement;
188 ReadClassInstanceMembers (typeMap, ob);
190 if (isEmpty) Reader.Skip();
191 else ReadEndElement();
196 protected virtual void ReadClassInstanceMembers (XmlTypeMapping typeMap, object ob)
198 ReadMembers ((ClassMap) typeMap.ObjectMap, ob, false, false);
201 void ReadMembers (ClassMap map, object ob, bool isValueList, bool readByOrder)
203 // A value list cannot have attributes
209 XmlTypeMapMember anyAttrMember = map.DefaultAnyAttributeMember;
210 int anyAttributeIndex = 0;
211 object anyAttributeArray = null;
213 while (Reader.MoveToNextAttribute())
215 XmlTypeMapMemberAttribute member = map.GetAttribute (Reader.LocalName, Reader.NamespaceURI);
219 SetMemberValue (member, ob, GetValueFromXmlString (Reader.Value, member.TypeData, member.MappedType), isValueList);
221 else if (IsXmlnsAttribute(Reader.Name))
223 // If the map has NamespaceDeclarations,
224 // then store this xmlns to the given member.
225 // If the instance doesn't exist, then create.
226 if (map.NamespaceDeclarations != null) {
227 XmlSerializerNamespaces nss = this.GetMemberValue (map.NamespaceDeclarations, ob, isValueList) as XmlSerializerNamespaces;
229 nss = new XmlSerializerNamespaces ();
230 SetMemberValue (map.NamespaceDeclarations, ob, nss, isValueList);
232 if (Reader.Prefix == "xmlns")
233 nss.Add (Reader.LocalName, Reader.Value);
235 nss.Add ("", Reader.Value);
238 else if (anyAttrMember != null)
240 XmlAttribute attr = (XmlAttribute) Document.ReadNode(Reader);
241 ParseWsdlArrayType (attr);
242 AddListValue (anyAttrMember.TypeData, ref anyAttributeArray, anyAttributeIndex++, attr, true);
245 ProcessUnknownAttribute(ob);
248 if (anyAttrMember != null)
250 anyAttributeArray = ShrinkArray ((Array)anyAttributeArray, anyAttributeIndex, anyAttrMember.TypeData.Type.GetElementType(), true);
251 SetMemberValue (anyAttrMember, ob, anyAttributeArray, isValueList);
254 Reader.MoveToElement();
255 if (Reader.IsEmptyElement)
258 Reader.ReadStartElement();
263 bool[] readFlag = new bool[(map.ElementMembers != null) ? map.ElementMembers.Count : 0];
265 Reader.MoveToContent();
267 int[] indexes = null;
268 object[] flatLists = null;
274 if (map.ElementMembers != null) maxInd = map.ElementMembers.Count;
278 maxInd = int.MaxValue;
280 if (map.FlatLists != null)
282 indexes = new int[map.FlatLists.Count];
283 flatLists = new object[map.FlatLists.Count];
284 foreach (XmlTypeMapMemberExpandable mem in map.FlatLists)
285 if (IsReadOnly (mem, ob, isValueList)) flatLists[mem.FlatArrayIndex] = mem.GetValue (ob);
288 if (_format == SerializationFormat.Encoded && map.ElementMembers != null)
290 FixupCallbackInfo info = new FixupCallbackInfo (this, map, isValueList);
291 fixup = new Fixup(ob, new XmlSerializationFixupCallback(info.FixupMembers), map.ElementMembers.Count);
293 if (readByOrder) maxInd = map.ElementMembers.Count;
296 while (Reader.NodeType != System.Xml.XmlNodeType.EndElement && (ind < maxInd))
298 if (Reader.NodeType == System.Xml.XmlNodeType.Element)
300 XmlTypeMapElementInfo info = !readByOrder ? map.GetElement (Reader.LocalName, Reader.NamespaceURI) : map.GetElement (ind++);
301 if (info != null && !readFlag[info.Member.Index] )
303 if (info.Member.GetType() == typeof (XmlTypeMapMemberList))
305 if (_format == SerializationFormat.Encoded && info.MultiReferenceType)
307 object list = ReadReferencingElement (out fixup.Ids[info.Member.Index]);
308 if (fixup.Ids[info.Member.Index] == null) // Already read
310 if (IsReadOnly (info.Member, ob, isValueList)) throw CreateReadOnlyCollectionException (info.TypeData.FullTypeName);
311 else SetMemberValue (info.Member, ob, list, isValueList);
313 else if (!info.MappedType.TypeData.Type.IsArray)
315 if (IsReadOnly (info.Member, ob, isValueList))
316 list = GetMemberValue (info.Member, ob, isValueList);
318 list = CreateList (info.MappedType.TypeData.Type);
319 SetMemberValue (info.Member, ob, list, isValueList);
321 AddFixup (new CollectionFixup (list, new XmlSerializationCollectionFixupCallback (FillList), fixup.Ids[info.Member.Index]));
322 fixup.Ids[info.Member.Index] = null; // The member already has the value, no further fix needed.
327 if (IsReadOnly (info.Member, ob, isValueList)) ReadListElement (info.MappedType, info.IsNullable, GetMemberValue (info.Member, ob, isValueList), false);
328 else SetMemberValue (info.Member, ob, ReadListElement (info.MappedType, info.IsNullable, null, true), isValueList);
330 readFlag[info.Member.Index] = true;
332 else if (info.Member.GetType() == typeof (XmlTypeMapMemberFlatList))
334 XmlTypeMapMemberFlatList mem = (XmlTypeMapMemberFlatList)info.Member;
335 AddListValue (mem.TypeData, ref flatLists[mem.FlatArrayIndex], indexes[mem.FlatArrayIndex]++, ReadObjectElement (info), !IsReadOnly (info.Member, ob, isValueList));
337 else if (info.Member.GetType() == typeof (XmlTypeMapMemberAnyElement))
339 XmlTypeMapMemberAnyElement mem = (XmlTypeMapMemberAnyElement)info.Member;
340 if (mem.TypeData.IsListType) AddListValue (mem.TypeData, ref flatLists[mem.FlatArrayIndex], indexes[mem.FlatArrayIndex]++, ReadXmlNode (false), true);
341 else SetMemberValue (mem, ob, ReadXmlNode (false), isValueList);
343 else if (info.Member.GetType() == typeof(XmlTypeMapMemberElement))
346 readFlag[info.Member.Index] = true;
347 if (_format == SerializationFormat.Encoded && info.MultiReferenceType)
349 val = ReadReferencingElement (out fixup.Ids[info.Member.Index]);
350 if (fixup.Ids[info.Member.Index] == null) // already read
351 SetMemberValue (info.Member, ob, val, isValueList);
354 SetMemberValue (info.Member, ob, ReadObjectElement (info), isValueList);
357 throw new InvalidOperationException ("Unknown member type");
359 else if (map.DefaultAnyElementMember != null)
361 XmlTypeMapMemberAnyElement mem = map.DefaultAnyElementMember;
362 if (mem.TypeData.IsListType) AddListValue (mem.TypeData, ref flatLists[mem.FlatArrayIndex], indexes[mem.FlatArrayIndex]++, ReadXmlNode (false), true);
363 else SetMemberValue (mem, ob, ReadXmlNode (false), isValueList);
366 ProcessUnknownElement(ob);
368 else if (Reader.NodeType == System.Xml.XmlNodeType.Text && map.XmlTextCollector != null)
370 if (map.XmlTextCollector is XmlTypeMapMemberExpandable)
372 XmlTypeMapMemberExpandable mem = (XmlTypeMapMemberExpandable)map.XmlTextCollector;
373 XmlTypeMapMemberFlatList flatl = mem as XmlTypeMapMemberFlatList;
374 Type itype = (flatl == null) ? mem.TypeData.ListItemType : flatl.ListMap.FindTextElement().TypeData.Type;
376 object val = (itype == typeof (string)) ? (object) Reader.ReadString() : (object) ReadXmlNode (false);
377 AddListValue (mem.TypeData, ref flatLists[mem.FlatArrayIndex], indexes[mem.FlatArrayIndex]++, val, true);
381 XmlTypeMapMemberElement mem = (XmlTypeMapMemberElement) map.XmlTextCollector;
382 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo) mem.ElementInfo [0];
383 if (info.TypeData.Type == typeof (string))
384 SetMemberValue (mem, ob, ReadString ((string) GetMemberValue (mem, ob, isValueList)), isValueList);
386 SetMemberValue (mem, ob, GetValueFromXmlString (Reader.ReadString(), info.TypeData, info.MappedType), isValueList);
392 Reader.MoveToContent();
395 if (flatLists != null)
397 foreach (XmlTypeMapMemberExpandable mem in map.FlatLists)
399 Object list = flatLists[mem.FlatArrayIndex];
400 if (mem.TypeData.Type.IsArray)
401 list = ShrinkArray ((Array)list, indexes[mem.FlatArrayIndex], mem.TypeData.Type.GetElementType(), true);
402 if (!IsReadOnly (mem, ob, isValueList))
403 SetMemberValue (mem, ob, list, isValueList);
408 internal void FixupMembers (ClassMap map, object obfixup, bool isValueList)
410 Fixup fixup = (Fixup)obfixup;
411 ICollection members = map.ElementMembers;
412 string[] ids = fixup.Ids;
413 foreach (XmlTypeMapMember member in members)
415 if (ids[member.Index] != null)
416 SetMemberValue (member, fixup.Source, GetTarget(ids[member.Index]), isValueList);
420 protected virtual void ProcessUnknownAttribute (object target)
422 UnknownNode (target);
425 protected virtual void ProcessUnknownElement (object target)
427 UnknownNode (target);
430 bool IsReadOnly (XmlTypeMapMember member, object ob, bool isValueList)
432 if (isValueList) return false;
433 else return member.IsReadOnly (ob.GetType());
436 void SetMemberValue (XmlTypeMapMember member, object ob, object value, bool isValueList)
438 if (isValueList) ((object[])ob)[member.Index] = value;
440 member.SetValue (ob, value);
441 if (member.IsOptionalValueType)
442 member.SetValueSpecified (ob, true);
446 object GetMemberValue (XmlTypeMapMember member, object ob, bool isValueList)
448 if (isValueList) return ((object[])ob)[member.Index];
449 else return member.GetValue (ob);
452 object ReadObjectElement (XmlTypeMapElementInfo elem)
454 switch (elem.TypeData.SchemaType)
456 case SchemaTypes.XmlNode:
457 return ReadXmlNode (true);
459 case SchemaTypes.Primitive:
460 case SchemaTypes.Enum:
461 return ReadPrimitiveValue (elem);
463 case SchemaTypes.Array:
464 return ReadListElement (elem.MappedType, elem.IsNullable, null, true);
466 case SchemaTypes.Class:
467 return ReadObject (elem.MappedType, elem.IsNullable, true);
469 case SchemaTypes.XmlSerializable:
470 object ob = Activator.CreateInstance (elem.TypeData.Type);
471 return ReadSerializable ((IXmlSerializable)ob);
474 throw new NotSupportedException ("Invalid value type");
478 object ReadPrimitiveValue (XmlTypeMapElementInfo elem)
480 if (elem.TypeData.Type == typeof (XmlQualifiedName)) {
481 if (elem.IsNullable) return ReadNullableQualifiedName ();
482 else return ReadElementQualifiedName ();
484 else if (elem.IsNullable)
485 return GetValueFromXmlString (ReadNullableString (), elem.TypeData, elem.MappedType);
487 return GetValueFromXmlString (Reader.ReadElementString (), elem.TypeData, elem.MappedType);
490 object GetValueFromXmlString (string value, TypeData typeData, XmlTypeMapping typeMap)
492 if (typeData.SchemaType == SchemaTypes.Array)
493 return ReadListString (typeMap, value);
494 else if (typeData.SchemaType == SchemaTypes.Enum)
495 return GetEnumValue (typeMap, value);
496 else if (typeData.Type == typeof (XmlQualifiedName))
497 return ToXmlQualifiedName (value);
499 return XmlCustomFormatter.FromXmlString (typeData, value);
502 object ReadListElement (XmlTypeMapping typeMap, bool isNullable, object list, bool canCreateInstance)
504 Type listType = typeMap.TypeData.Type;
505 ListMap listMap = (ListMap)typeMap.ObjectMap;
507 if (ReadNull()) return null;
510 if (canCreateInstance) list = CreateList (listType);
511 else throw CreateReadOnlyCollectionException (typeMap.TypeFullName);
514 if (Reader.IsEmptyElement) {
516 if (listType.IsArray)
517 list = ShrinkArray ((Array)list, 0, listType.GetElementType(), isNullable);
522 Reader.ReadStartElement();
523 Reader.MoveToContent();
525 while (Reader.NodeType != System.Xml.XmlNodeType.EndElement)
527 if (Reader.NodeType == System.Xml.XmlNodeType.Element)
529 XmlTypeMapElementInfo elemInfo = listMap.FindElement (Reader.LocalName, Reader.NamespaceURI);
530 if (elemInfo != null)
531 AddListValue (typeMap.TypeData, ref list, index++, ReadObjectElement (elemInfo), false);
538 Reader.MoveToContent();
542 if (listType.IsArray)
543 list = ShrinkArray ((Array)list, index, listType.GetElementType(), isNullable);
548 object ReadListString (XmlTypeMapping typeMap, string values)
550 Type listType = typeMap.TypeData.Type;
551 ListMap listMap = (ListMap)typeMap.ObjectMap;
552 values = values.Trim ();
554 if (values == string.Empty)
556 return Array.CreateInstance (listType.GetElementType(), 0);
559 string[] valueArray = values.Split (' ');
560 Array list = Array.CreateInstance (listType.GetElementType(), valueArray.Length);
562 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo)listMap.ItemInfo[0];
564 for (int index = 0; index < valueArray.Length; index++)
565 list.SetValue (GetValueFromXmlString (valueArray[index], info.TypeData, info.MappedType), index);
570 void AddListValue (TypeData listType, ref object list, int index, object value, bool canCreateInstance)
572 Type type = listType.Type;
575 list = EnsureArrayIndex ((Array)list, index, type.GetElementType());
576 ((Array)list).SetValue (value, index);
578 else // Must be IEnumerable
581 if (canCreateInstance) list = Activator.CreateInstance (type);
582 else throw CreateReadOnlyCollectionException (type.FullName);
585 MethodInfo mi = type.GetMethod ("Add", new Type[] {listType.ListItemType} );
586 mi.Invoke (list, new object[] { value });
590 object CreateList (Type listType)
592 if (listType.IsArray)
593 return EnsureArrayIndex (null, 0, listType.GetElementType());
595 return Activator.CreateInstance (listType);
598 void FillList (object list, object items)
600 CopyEnumerableList (items, list);
603 void CopyEnumerableList (object source, object dest)
605 if (dest == null) throw CreateReadOnlyCollectionException (source.GetType().FullName);
607 object[] param = new object[1];
608 MethodInfo mi = dest.GetType().GetMethod ("Add");
609 foreach (object ob in (IEnumerable)source)
612 mi.Invoke (dest, param);
616 int GetListCount (TypeData listType, object ob)
618 if (listType.Type.IsArray)
619 return ((Array)ob).Length;
621 return (int) listType.Type.GetProperty ("Count").GetValue(ob,null);
624 object ReadXmlNodeElement (XmlTypeMapping typeMap, bool isNullable)
626 return ReadXmlNode (false);
629 object ReadPrimitiveElement (XmlTypeMapping typeMap, bool isNullable)
631 XmlQualifiedName t = GetXsiType();
632 if (t == null) t = new XmlQualifiedName (typeMap.XmlType, typeMap.Namespace);
633 return ReadTypedPrimitive (t);
636 object ReadEnumElement (XmlTypeMapping typeMap, bool isNullable)
638 Reader.ReadStartElement ();
639 object o = GetEnumValue (typeMap, Reader.ReadString());
640 Reader.ReadEndElement ();
644 object GetEnumValue (XmlTypeMapping typeMap, string val)
646 EnumMap map = (EnumMap) typeMap.ObjectMap;
647 string ev = map.GetEnumName (val);
648 if (ev == null) throw CreateUnknownConstantException (val, typeMap.TypeData.Type);
649 return Enum.Parse (typeMap.TypeData.Type, ev);
652 object ReadXmlSerializableElement (XmlTypeMapping typeMap, bool isNullable)
654 Reader.MoveToContent ();
655 if (Reader.NodeType == XmlNodeType.Element)
657 if (Reader.LocalName == typeMap.ElementName && Reader.NamespaceURI == typeMap.Namespace)
659 object ob = Activator.CreateInstance (typeMap.TypeData.Type);
660 return ReadSerializable ((IXmlSerializable)ob);
663 throw CreateUnknownNodeException ();
672 class FixupCallbackInfo
674 XmlSerializationReaderInterpreter _sri;
678 public FixupCallbackInfo (XmlSerializationReaderInterpreter sri, ClassMap map, bool isValueList)
682 _isValueList = isValueList;
685 public void FixupMembers (object fixup)
687 _sri.FixupMembers (_map, fixup, _isValueList);
691 class ReaderCallbackInfo
693 XmlSerializationReaderInterpreter _sri;
694 XmlTypeMapping _typeMap;
696 public ReaderCallbackInfo (XmlSerializationReaderInterpreter sri, XmlTypeMapping typeMap)
702 internal object ReadObject ()
704 return _sri.ReadObject (_typeMap, true, true);