2 // XmlSerializationWriterInterpreter.cs:
5 // Lluis Sanchez Gual (lluis@ximian.com)
7 // (C) 2002, 2003 Ximian, Inc. http://www.ximian.com
11 // Permission is hereby granted, free of charge, to any person obtaining
12 // a copy of this software and associated documentation files (the
13 // "Software"), to deal in the Software without restriction, including
14 // without limitation the rights to use, copy, modify, merge, publish,
15 // distribute, sublicense, and/or sell copies of the Software, and to
16 // permit persons to whom the Software is furnished to do so, subject to
17 // the following conditions:
19 // The above copyright notice and this permission notice shall be
20 // included in all copies or substantial portions of the Software.
22 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
26 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
27 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
28 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
33 using System.Collections;
34 using System.Reflection;
35 using System.Xml.Schema;
37 namespace System.Xml.Serialization
39 internal class XmlSerializationWriterInterpreter: XmlSerializationWriter
42 SerializationFormat _format;
43 const string xmlNamespace = "http://www.w3.org/2000/xmlns/";
45 public XmlSerializationWriterInterpreter (XmlMapping typeMap)
48 _format = typeMap.Format;
51 protected override void InitCallbacks ()
53 ArrayList maps = _typeMap.RelatedMaps;
56 foreach (XmlTypeMapping map in maps) {
57 CallbackInfo info = new CallbackInfo (this, map);
58 if (map.TypeData.SchemaType == SchemaTypes.Enum) AddWriteCallback(map.TypeData.Type, map.XmlType, map.Namespace, new XmlSerializationWriteCallback (info.WriteEnum));
59 else AddWriteCallback(map.TypeData.Type, map.XmlType, map.Namespace, new XmlSerializationWriteCallback (info.WriteObject));
64 public void WriteRoot (object ob)
66 WriteStartDocument ();
68 if (_typeMap is XmlTypeMapping)
70 XmlTypeMapping mp = (XmlTypeMapping) _typeMap;
71 if (mp.TypeData.SchemaType == SchemaTypes.Class || mp.TypeData.SchemaType == SchemaTypes.Array)
74 if (_format == SerializationFormat.Literal)
75 WriteObject (mp, ob, mp.ElementName, mp.Namespace, true, false, true);
77 WritePotentiallyReferencingElement (mp.ElementName, mp.Namespace, ob, mp.TypeData.Type, true, false);
79 else if (ob is object[])
80 WriteMessage ((XmlMembersMapping)_typeMap, (object[]) ob);
82 throw CreateUnknownTypeException (ob);
84 WriteReferencedElements ();
87 protected XmlTypeMapping GetTypeMap (Type type)
89 ArrayList maps = _typeMap.RelatedMaps;
92 foreach (XmlTypeMapping map in maps)
93 if (map.TypeData.Type == type) return map;
95 throw new InvalidOperationException ("Type " + type + " not mapped");
98 protected virtual void WriteObject (XmlTypeMapping typeMap, object ob, string element, string namesp, bool isNullable, bool needType, bool writeWrappingElem)
104 if (_format == SerializationFormat.Literal) WriteNullTagLiteral(element, namesp);
105 else WriteNullTagEncoded (element, namesp);
112 if (_format == SerializationFormat.Literal) WriteElementLiteral((XmlNode)ob, "", "", true, false);
113 else WriteElementEncoded((XmlNode)ob, "", "", true, false);
117 if (typeMap.TypeData.SchemaType == SchemaTypes.XmlSerializable)
119 WriteSerializable ((IXmlSerializable)ob, element, namesp, isNullable);
123 XmlTypeMapping map = typeMap.GetRealTypeMap (ob.GetType().FullName);
127 WriteTypedPrimitive (element, namesp, ob, true);
131 if (writeWrappingElem)
133 if (map != typeMap || _format == SerializationFormat.Encoded) needType = true;
134 WriteStartElement (element, namesp, ob);
138 WriteXsiType(map.XmlType, map.XmlTypeNamespace);
140 switch (map.TypeData.SchemaType)
142 case SchemaTypes.Class: WriteObjectElement (map, ob, element, namesp); break;
143 case SchemaTypes.Array: WriteListElement (map, ob, element, namesp); break;
144 case SchemaTypes.Primitive: WritePrimitiveElement (map, ob, element, namesp); break;
145 case SchemaTypes.Enum: WriteEnumElement (map, ob, element, namesp); break;
148 if (writeWrappingElem)
149 WriteEndElement (ob);
152 protected virtual void WriteMessage (XmlMembersMapping membersMap, object[] parameters)
154 if (membersMap.HasWrapperElement) {
156 WriteStartElement(membersMap.ElementName, membersMap.Namespace, (_format == SerializationFormat.Encoded));
158 if (Writer.LookupPrefix (XmlSchema.Namespace) == null)
159 WriteAttribute ("xmlns","xsd",XmlSchema.Namespace,XmlSchema.Namespace);
161 if (Writer.LookupPrefix (XmlSchema.InstanceNamespace) == null)
162 WriteAttribute ("xmlns","xsi",XmlSchema.InstanceNamespace,XmlSchema.InstanceNamespace);
165 WriteMembers ((ClassMap)membersMap.ObjectMap, parameters, true);
167 if (membersMap.HasWrapperElement)
171 protected virtual void WriteObjectElement (XmlTypeMapping typeMap, object ob, string element, string namesp)
173 ClassMap map = (ClassMap)typeMap.ObjectMap;
174 if (map.NamespaceDeclarations != null)
175 WriteNamespaceDeclarations ((XmlSerializerNamespaces) map.NamespaceDeclarations.GetValue (ob));
177 WriteObjectElementAttributes (typeMap, ob);
178 WriteObjectElementElements (typeMap, ob);
181 protected virtual void WriteObjectElementAttributes (XmlTypeMapping typeMap, object ob)
183 ClassMap map = (ClassMap)typeMap.ObjectMap;
184 WriteAttributeMembers (map, ob, false);
187 protected virtual void WriteObjectElementElements (XmlTypeMapping typeMap, object ob)
189 ClassMap map = (ClassMap)typeMap.ObjectMap;
190 WriteElementMembers (map, ob, false);
193 void WriteMembers (ClassMap map, object ob, bool isValueList)
195 WriteAttributeMembers (map, ob, isValueList);
196 WriteElementMembers (map, ob, isValueList);
199 void WriteAttributeMembers (ClassMap map, object ob, bool isValueList)
203 XmlTypeMapMember anyAttrMember = map.DefaultAnyAttributeMember;
204 if (anyAttrMember != null && MemberHasValue (anyAttrMember, ob, isValueList))
206 ICollection extraAtts = (ICollection) GetMemberValue (anyAttrMember, ob, isValueList);
207 if (extraAtts != null)
209 foreach (XmlAttribute attr in extraAtts)
210 if (attr.NamespaceURI != xmlNamespace)
211 WriteXmlAttribute (attr, ob);
215 ICollection attributes = map.AttributeMembers;
216 if (attributes != null)
218 foreach (XmlTypeMapMemberAttribute attr in attributes) {
219 if (MemberHasValue (attr, ob, isValueList))
220 WriteAttribute (attr.AttributeName, attr.Namespace, GetStringValue (attr.MappedType, attr.TypeData, GetMemberValue (attr, ob, isValueList)));
225 void WriteElementMembers (ClassMap map, object ob, bool isValueList)
227 ICollection members = map.ElementMembers;
230 foreach (XmlTypeMapMemberElement member in members)
232 if (!MemberHasValue (member, ob, isValueList)) continue;
233 object memberValue = GetMemberValue (member, ob, isValueList);
234 Type memType = member.GetType();
236 if (memType == typeof(XmlTypeMapMemberList))
238 WriteMemberElement ((XmlTypeMapElementInfo) member.ElementInfo[0], memberValue);
240 else if (memType == typeof(XmlTypeMapMemberFlatList))
242 if (memberValue != null)
243 WriteListContent (ob, member.TypeData, ((XmlTypeMapMemberFlatList)member).ListMap, memberValue, null);
245 else if (memType == typeof(XmlTypeMapMemberAnyElement))
247 if (memberValue != null)
248 WriteAnyElementContent ((XmlTypeMapMemberAnyElement)member, memberValue);
250 else if (memType == typeof(XmlTypeMapMemberAnyAttribute))
254 else if (memType == typeof(XmlTypeMapMemberElement))
256 XmlTypeMapElementInfo elem = member.FindElement (ob, memberValue);
257 WriteMemberElement (elem, memberValue);
260 throw new InvalidOperationException ("Unknown member type");
265 object GetMemberValue (XmlTypeMapMember member, object ob, bool isValueList)
267 if (isValueList) return ((object[])ob)[member.Index];
268 else return member.GetValue (ob);
271 bool MemberHasValue (XmlTypeMapMember member, object ob, bool isValueList)
274 return member.Index < ((object[])ob).Length;
276 else if (member.DefaultValue != System.DBNull.Value) {
277 object val = GetMemberValue (member, ob, isValueList);
278 if (val == null && member.DefaultValue == null) return false;
279 if (val != null && val.GetType().IsEnum)
281 if (val.Equals (member.DefaultValue)) return false;
282 Type t = Enum.GetUnderlyingType(val.GetType());
283 val = Convert.ChangeType (val, t);
285 if (val != null && val.Equals (member.DefaultValue)) return false;
287 else if (member.IsOptionalValueType)
288 return member.GetValueSpecified (ob);
293 void WriteMemberElement (XmlTypeMapElementInfo elem, object memberValue)
295 switch (elem.TypeData.SchemaType)
297 case SchemaTypes.XmlNode:
298 string elemName = elem.WrappedElement ? elem.ElementName : "";
299 if (_format == SerializationFormat.Literal) WriteElementLiteral(((XmlNode)memberValue), elemName, elem.Namespace, elem.IsNullable, false);
300 else WriteElementEncoded(((XmlNode)memberValue), elemName, elem.Namespace, elem.IsNullable, false);
303 case SchemaTypes.Enum:
304 case SchemaTypes.Primitive:
305 if (_format == SerializationFormat.Literal)
306 WritePrimitiveValueLiteral (memberValue, elem.ElementName, elem.Namespace, elem.MappedType, elem.TypeData, elem.WrappedElement, elem.IsNullable);
308 WritePrimitiveValueEncoded (memberValue, elem.ElementName, elem.Namespace, new XmlQualifiedName (elem.DataTypeName, elem.DataTypeNamespace), elem.MappedType, elem.TypeData, elem.WrappedElement, elem.IsNullable);
311 case SchemaTypes.Array:
312 if (memberValue == null) {
313 if (!elem.IsNullable) return;
314 if (_format == SerializationFormat.Literal) WriteNullTagLiteral (elem.ElementName, elem.Namespace);
315 else WriteNullTagEncoded (elem.ElementName, elem.Namespace);
317 else if (elem.MappedType.MultiReferenceType)
318 WriteReferencingElement (elem.ElementName, elem.Namespace, memberValue, elem.IsNullable);
320 WriteStartElement(elem.ElementName, elem.Namespace, memberValue);
321 WriteListContent (null, elem.TypeData, (ListMap) elem.MappedType.ObjectMap, memberValue, null);
322 WriteEndElement (memberValue);
326 case SchemaTypes.Class:
327 if (elem.MappedType.MultiReferenceType) {
328 if (elem.MappedType.TypeData.Type == typeof(object))
329 WritePotentiallyReferencingElement (elem.ElementName, elem.Namespace, memberValue, null, false, elem.IsNullable);
331 WriteReferencingElement (elem.ElementName, elem.Namespace, memberValue, elem.IsNullable);
333 else WriteObject (elem.MappedType, memberValue, elem.ElementName, elem.Namespace, elem.IsNullable, false, true);
336 case SchemaTypes.XmlSerializable:
337 WriteSerializable ((IXmlSerializable) memberValue, elem.ElementName, elem.Namespace, elem.IsNullable);
341 throw new NotSupportedException ("Invalid value type");
345 void WritePrimitiveValueLiteral (object memberValue, string name, string ns, XmlTypeMapping mappedType, TypeData typeData, bool wrapped, bool isNullable)
348 WriteValue (GetStringValue (mappedType, typeData, memberValue));
350 else if (isNullable) {
351 if (typeData.Type == typeof(XmlQualifiedName)) WriteNullableQualifiedNameLiteral (name, ns, (XmlQualifiedName)memberValue);
352 else WriteNullableStringLiteral (name, ns, GetStringValue (mappedType, typeData, memberValue));
355 if (typeData.Type == typeof(XmlQualifiedName)) WriteElementQualifiedName (name, ns, (XmlQualifiedName)memberValue);
356 else WriteElementString (name, ns, GetStringValue (mappedType, typeData, memberValue));
360 void WritePrimitiveValueEncoded (object memberValue, string name, string ns, XmlQualifiedName xsiType, XmlTypeMapping mappedType, TypeData typeData, bool wrapped, bool isNullable)
363 WriteValue (GetStringValue (mappedType, typeData, memberValue));
365 else if (isNullable) {
366 if (typeData.Type == typeof(XmlQualifiedName)) WriteNullableQualifiedNameEncoded (name, ns, (XmlQualifiedName)memberValue, xsiType);
367 else WriteNullableStringEncoded (name, ns, GetStringValue (mappedType, typeData, memberValue), xsiType);
370 if (typeData.Type == typeof(XmlQualifiedName)) WriteElementQualifiedName (name, ns, (XmlQualifiedName)memberValue, xsiType);
371 else WriteElementString (name, ns, GetStringValue (mappedType, typeData, memberValue), xsiType);
375 protected virtual void WriteListElement (XmlTypeMapping typeMap, object ob, string element, string namesp)
377 if (_format == SerializationFormat.Encoded)
380 int itemCount = GetListCount (typeMap.TypeData, ob);
381 ((ListMap) typeMap.ObjectMap).GetArrayType (itemCount, out n, out ns);
382 string arrayType = (ns != string.Empty) ? FromXmlQualifiedName (new XmlQualifiedName(n,ns)) : n;
383 WriteAttribute ("arrayType", XmlSerializer.EncodingNamespace, arrayType);
385 WriteListContent (null, typeMap.TypeData, (ListMap) typeMap.ObjectMap, ob, null);
388 void WriteListContent (object container, TypeData listType, ListMap map, object ob, StringBuilder targetString)
390 if (listType.Type.IsArray)
392 Array array = (Array)ob;
393 for (int n=0; n<array.Length; n++)
395 object item = array.GetValue (n);
396 XmlTypeMapElementInfo info = map.FindElement (container, n, item);
397 if (info != null && targetString == null) WriteMemberElement (info, item);
398 else if (info != null && targetString != null) targetString.Append (GetStringValue (info.MappedType, info.TypeData, item)).Append (" ");
399 else if (item != null) throw CreateUnknownTypeException (item);
402 else if (ob is ICollection)
404 int count = (int) ob.GetType().GetProperty ("Count").GetValue(ob,null);
405 PropertyInfo itemProp = TypeData.GetIndexerProperty (listType.Type);
406 object[] index = new object[1];
407 for (int n=0; n<count; n++)
410 object item = itemProp.GetValue (ob, index);
411 XmlTypeMapElementInfo info = map.FindElement (container, n, item);
412 if (info != null && targetString == null) WriteMemberElement (info, item);
413 else if (info != null && targetString != null) targetString.Append (GetStringValue (info.MappedType, info.TypeData, item)).Append (" ");
414 else if (item != null) throw CreateUnknownTypeException (item);
417 else if (ob is IEnumerable)
419 IEnumerable e = (IEnumerable)ob;
420 foreach (object item in e)
422 XmlTypeMapElementInfo info = map.FindElement (container, -1, item);
423 if (info != null && targetString == null) WriteMemberElement (info, item);
424 else if (info != null && targetString != null) targetString.Append (GetStringValue (info.MappedType, info.TypeData, item)).Append (" ");
425 else if (item != null) throw CreateUnknownTypeException (item);
429 throw new Exception ("Unsupported collection type");
432 int GetListCount (TypeData listType, object ob)
434 if (listType.Type.IsArray)
435 return ((Array)ob).Length;
437 return (int) listType.Type.GetProperty ("Count").GetValue(ob,null);
440 void WriteAnyElementContent (XmlTypeMapMemberAnyElement member, object memberValue)
442 if (member.TypeData.Type == typeof (XmlElement)) {
443 memberValue = new object[] { memberValue };
446 Array elems = (Array) memberValue;
447 foreach (XmlNode elem in elems)
449 if (elem is XmlElement)
451 if (member.IsElementDefined (elem.Name, elem.NamespaceURI))
453 if (_format == SerializationFormat.Literal) WriteElementLiteral (elem, "", "", false, true);
454 else WriteElementEncoded (elem, "", "", false, true);
457 throw CreateUnknownAnyElementException (elem.Name, elem.NamespaceURI);
460 elem.WriteTo (Writer);
464 protected virtual void WritePrimitiveElement (XmlTypeMapping typeMap, object ob, string element, string namesp)
466 Writer.WriteString (GetStringValue (typeMap, typeMap.TypeData, ob));
469 protected virtual void WriteEnumElement (XmlTypeMapping typeMap, object ob, string element, string namesp)
471 Writer.WriteString (GetEnumXmlValue (typeMap, ob));
474 string GetStringValue (XmlTypeMapping typeMap, TypeData type, object value)
476 if (type.SchemaType == SchemaTypes.Array) {
477 if (value == null) return null;
478 StringBuilder sb = new StringBuilder ();
479 WriteListContent (null, typeMap.TypeData, (ListMap)typeMap.ObjectMap, value, sb);
480 return sb.ToString ().Trim ();
482 else if (type.SchemaType == SchemaTypes.Enum)
483 return GetEnumXmlValue (typeMap, value);
484 else if (type.Type == typeof (XmlQualifiedName))
485 return FromXmlQualifiedName ((XmlQualifiedName)value);
486 else if (value == null)
489 return XmlCustomFormatter.ToXmlString (type, value);
492 string GetEnumXmlValue (XmlTypeMapping typeMap, object ob)
494 EnumMap map = (EnumMap)typeMap.ObjectMap;
495 return map.GetXmlName (typeMap.TypeFullName, ob);
500 XmlSerializationWriterInterpreter _swi;
501 XmlTypeMapping _typeMap;
503 public CallbackInfo (XmlSerializationWriterInterpreter swi, XmlTypeMapping typeMap)
509 internal void WriteObject (object ob)
511 _swi.WriteObject (_typeMap, ob, _typeMap.ElementName, _typeMap.Namespace, false, false, false);
514 internal void WriteEnum (object ob)
516 _swi.WriteObject (_typeMap, ob, _typeMap.ElementName, _typeMap.Namespace, false, true, false);