5 // John Donagher (john@webmeta.com)
6 // Lluis Sanchez Gual (lluis@ximian.com)
8 // (C) 2002 John Donagher
12 // Permission is hereby granted, free of charge, to any person obtaining
13 // a copy of this software and associated documentation files (the
14 // "Software"), to deal in the Software without restriction, including
15 // without limitation the rights to use, copy, modify, merge, publish,
16 // distribute, sublicense, and/or sell copies of the Software, and to
17 // permit persons to whom the Software is furnished to do so, subject to
18 // the following conditions:
20 // The above copyright notice and this permission notice shall be
21 // included in all copies or substantial portions of the Software.
23 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
27 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
28 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
29 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
34 using System.Collections;
35 using System.Globalization;
36 using System.Xml.Schema;
37 using System.Reflection;
39 namespace System.Xml.Serialization
41 public class XmlTypeMapping : XmlMapping
43 private string xmlType;
44 private string xmlTypeNamespace;
46 XmlTypeMapping baseMap;
47 bool multiReferenceType = false;
51 bool isNullable = true;
53 ArrayList _derivedTypes = new ArrayList();
55 internal XmlTypeMapping(string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
56 : base (elementName, ns)
59 this.xmlType = xmlType;
60 this.xmlTypeNamespace = xmlTypeNamespace;
64 public string ElementName
66 get { return _elementName; }
69 public string Namespace
71 get { return _namespace; }
75 public string TypeFullName
77 get { return type.FullTypeName; }
80 public string TypeName
82 get { return type.TypeName; }
86 public string XsdTypeName
88 get { return XmlType; }
91 public string XsdTypeNamespace
93 get { return XmlTypeNamespace; }
97 internal TypeData TypeData
102 internal string XmlType
104 get { return xmlType; }
105 set { xmlType = value; }
108 internal string XmlTypeNamespace
110 get { return xmlTypeNamespace ?? string.Empty; }
111 set { xmlTypeNamespace = value; }
114 internal bool HasXmlTypeNamespace
116 get { return xmlTypeNamespace != null; }
119 internal ArrayList DerivedTypes
121 get { return _derivedTypes; }
122 set { _derivedTypes = value; }
125 internal bool MultiReferenceType
127 get { return multiReferenceType; }
128 set { multiReferenceType = value; }
131 internal XmlTypeMapping BaseMap
133 get { return baseMap; }
134 set { baseMap = value; }
137 internal bool IsSimpleType
139 get { return isSimpleType; }
140 set { isSimpleType = value; }
143 internal string Documentation
145 set { documentation = value; }
146 get { return documentation; }
149 internal bool IncludeInSchema
151 get { return includeInSchema; }
152 set { includeInSchema = value; }
155 internal bool IsNullable
157 get { return isNullable; }
158 set { isNullable = value; }
161 internal XmlTypeMapping GetRealTypeMap (Type objectType)
163 if (TypeData.SchemaType == SchemaTypes.Enum)
166 // Returns the map for a subtype of this map's type
167 if (TypeData.Type == objectType) return this;
168 for (int n=0; n<_derivedTypes.Count; n++) {
169 XmlTypeMapping map = (XmlTypeMapping) _derivedTypes[n];
170 if (map.TypeData.Type == objectType) return map;
176 internal XmlTypeMapping GetRealElementMap (string name, string ens)
178 if (xmlType == name && XmlTypeNamespace == ens) return this;
179 foreach (XmlTypeMapping map in _derivedTypes)
180 if (map.xmlType == name && map.XmlTypeNamespace == ens) return map;
185 internal void UpdateRoot (XmlQualifiedName qname)
188 this._elementName = qname.Name;
189 this._namespace = qname.Namespace;
195 // Mapping info for XmlSerializable
196 internal class XmlSerializableMapping : XmlTypeMapping
199 #if NET_2_0 && !MOONLIGHT
200 XmlSchemaComplexType _schemaType;
201 XmlQualifiedName _schemaTypeName;
204 internal XmlSerializableMapping(XmlRootAttribute root, string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
205 : base(elementName, ns, typeData, xmlType, xmlTypeNamespace)
207 #if NET_2_0 && !MOONLIGHT
208 XmlSchemaProviderAttribute schemaProvider = (XmlSchemaProviderAttribute) Attribute.GetCustomAttribute (typeData.Type, typeof (XmlSchemaProviderAttribute));
210 if (schemaProvider != null) {
211 string method = schemaProvider.MethodName;
212 MethodInfo mi = typeData.Type.GetMethod (method, BindingFlags.Static | BindingFlags.Public | BindingFlags.FlattenHierarchy);
214 throw new InvalidOperationException (String.Format ("Type '{0}' must implement public static method '{1}'", typeData.Type, method));
215 if (!typeof (XmlQualifiedName).IsAssignableFrom (mi.ReturnType) &&
216 // LAMESPEC: it is undocumented. (We don't have to tell users about it in the error message.)
217 // Also do not add such a silly compatibility test to assert that it does not raise an error.
218 !typeof (XmlSchemaComplexType).IsAssignableFrom (mi.ReturnType))
219 throw new InvalidOperationException (String.Format ("Method '{0}' indicated by XmlSchemaProviderAttribute must have its return type as XmlQualifiedName", method));
220 XmlSchemaSet xs = new XmlSchemaSet ();
221 object retVal = mi.Invoke (null, new object [] { xs });
222 _schemaTypeName = XmlQualifiedName.Empty;
226 if (retVal is XmlSchemaComplexType) {
227 _schemaType = (XmlSchemaComplexType) retVal;
228 if (!_schemaType.QualifiedName.IsEmpty)
229 _schemaTypeName = _schemaType.QualifiedName;
231 _schemaTypeName = new XmlQualifiedName (xmlType, xmlTypeNamespace);
233 else if (retVal is XmlQualifiedName) {
234 _schemaTypeName = (XmlQualifiedName)retVal;
237 throw new InvalidOperationException (
238 String.Format ("Method {0}.{1}() specified by XmlSchemaProviderAttribute has invalid signature: return type must be compatible with System.Xml.XmlQualifiedName.", typeData.Type.Name, method));
240 // defaultNamespace at XmlReflectionImporter takes precedence for Namespace, but not for XsdTypeNamespace.
241 UpdateRoot (new XmlQualifiedName (root != null ? root.ElementName : _schemaTypeName.Name, root != null ? root.Namespace : Namespace ?? _schemaTypeName.Namespace));
242 XmlTypeNamespace = _schemaTypeName.Namespace;
243 XmlType = _schemaTypeName.Name;
245 if (!_schemaTypeName.IsEmpty && xs.Count > 0) {
246 XmlSchema [] schemas = new XmlSchema [xs.Count];
247 xs.CopyTo (schemas, 0);
248 _schema = schemas [0];
254 #if NET_2_0 && !MOONLIGHT
255 IXmlSerializable serializable = (IXmlSerializable)Activator.CreateInstance (typeData.Type, true);
257 _schema = serializable.GetSchema();
258 } catch (Exception) {
259 // LAMESPEC: .NET has a bad exception catch and swallows it silently.
262 IXmlSerializable serializable = (IXmlSerializable)Activator.CreateInstance (typeData.Type);
263 _schema = serializable.GetSchema();
268 if (_schema.Id == null || _schema.Id.Length == 0)
269 throw new InvalidOperationException("Schema Id is missing. The schema returned from " + typeData.Type.FullName + ".GetSchema() must have an Id.");
274 internal XmlSchema Schema
276 get { return _schema; }
279 #if NET_2_0 && !MOONLIGHT
280 internal XmlSchemaType SchemaType {
281 get { return _schemaType; }
284 internal XmlQualifiedName SchemaTypeName {
285 get { return _schemaTypeName; }
291 // Mapping info for classes and structs
293 internal class ClassMap: ObjectMap
295 Hashtable _elements = new Hashtable ();
296 ArrayList _elementMembers;
297 Hashtable _attributeMembers;
298 XmlTypeMapMemberAttribute[] _attributeMembersArray;
299 XmlTypeMapElementInfo[] _elementsByIndex;
300 ArrayList _flatLists;
301 ArrayList _allMembers = new ArrayList ();
302 ArrayList _membersWithDefault;
303 ArrayList _listMembers;
304 XmlTypeMapMemberAnyElement _defaultAnyElement;
305 XmlTypeMapMemberAnyAttribute _defaultAnyAttribute;
306 XmlTypeMapMemberNamespaces _namespaceDeclarations;
307 XmlTypeMapMember _xmlTextCollector;
308 XmlTypeMapMember _returnMember;
309 bool _ignoreMemberNamespace;
310 bool _canBeSimpleType = true;
311 bool? _isOrderDependentMap;
313 public void AddMember (XmlTypeMapMember member)
315 // If GlobalIndex has not been set, set it now
316 if (member.GlobalIndex == -1)
317 member.GlobalIndex = _allMembers.Count;
319 _allMembers.Add (member);
321 if (!(member.DefaultValue is System.DBNull) && member.DefaultValue != null) {
322 if (_membersWithDefault == null) _membersWithDefault = new ArrayList ();
323 _membersWithDefault.Add (member);
326 if (member.IsReturnValue)
327 _returnMember = member;
329 if (member is XmlTypeMapMemberAttribute)
331 XmlTypeMapMemberAttribute atm = (XmlTypeMapMemberAttribute)member;
332 if (_attributeMembers == null) _attributeMembers = new Hashtable();
333 string key = BuildKey (atm.AttributeName, atm.Namespace, -1);
334 if (_attributeMembers.ContainsKey (key))
335 throw new InvalidOperationException ("The XML attribute named '" + atm.AttributeName + "' from namespace '" + atm.Namespace + "' is already present in the current scope. Use XML attributes to specify another XML name or namespace for the attribute.");
336 member.Index = _attributeMembers.Count;
337 _attributeMembers.Add (key, member);
340 else if (member is XmlTypeMapMemberFlatList)
342 RegisterFlatList ((XmlTypeMapMemberFlatList)member);
344 else if (member is XmlTypeMapMemberAnyElement)
346 XmlTypeMapMemberAnyElement mem = (XmlTypeMapMemberAnyElement) member;
347 if (mem.IsDefaultAny) _defaultAnyElement = mem;
348 if (mem.TypeData.IsListType) RegisterFlatList (mem);
350 else if (member is XmlTypeMapMemberAnyAttribute)
352 _defaultAnyAttribute = (XmlTypeMapMemberAnyAttribute) member;
355 else if (member is XmlTypeMapMemberNamespaces)
357 _namespaceDeclarations = (XmlTypeMapMemberNamespaces) member;
361 if (member is XmlTypeMapMemberElement && ((XmlTypeMapMemberElement)member).IsXmlTextCollector)
363 if (_xmlTextCollector != null) throw new InvalidOperationException ("XmlTextAttribute can only be applied once in a class");
364 _xmlTextCollector = member;
367 if (_elementMembers == null) {
368 _elementMembers = new ArrayList();
369 _elements = new Hashtable();
372 member.Index = _elementMembers.Count;
373 _elementMembers.Add (member);
375 ICollection elemsInfo = ((XmlTypeMapMemberElement)member).ElementInfo;
376 foreach (XmlTypeMapElementInfo elem in elemsInfo)
378 string key = BuildKey (elem.ElementName, elem.Namespace, elem.ExplicitOrder);
379 if (_elements.ContainsKey (key))
380 throw new InvalidOperationException ("The XML element named '" + elem.ElementName + "' from namespace '" + elem.Namespace + "' is already present in the current scope. Use XML attributes to specify another XML name or namespace for the element.");
381 _elements.Add (key, elem);
384 if (member.TypeData.IsListType && member.TypeData.Type != null && !member.TypeData.Type.IsArray) {
385 if (_listMembers == null) _listMembers = new ArrayList ();
386 _listMembers.Add (member);
390 void RegisterFlatList (XmlTypeMapMemberExpandable member)
392 if (_flatLists == null) _flatLists = new ArrayList ();
393 member.FlatArrayIndex = _flatLists.Count;
394 _flatLists.Add (member);
397 public XmlTypeMapMemberAttribute GetAttribute (string name, string ns)
399 if (_attributeMembers == null) return null;
400 return (XmlTypeMapMemberAttribute)_attributeMembers [BuildKey (name,ns, -1)];
403 public XmlTypeMapElementInfo GetElement (string name, string ns, int order)
405 if (_elements == null) return null;
406 return (XmlTypeMapElementInfo)_elements [BuildKey (name,ns, order)];
409 public XmlTypeMapElementInfo GetElement(string name, string ns)
411 if (_elements == null) return null;
413 foreach (XmlTypeMapElementInfo info in _elements.Values)
414 if (info.ElementName == name && info.Namespace == ns)
420 public XmlTypeMapElementInfo GetElement (int index)
422 if (_elements == null) return null;
424 if (_elementsByIndex == null)
426 _elementsByIndex = new XmlTypeMapElementInfo [_elementMembers.Count];
427 foreach (XmlTypeMapMemberElement mem in _elementMembers)
429 if (mem.ElementInfo.Count != 1)
430 throw new InvalidOperationException ("Read by order only possible for encoded/bare format");
432 _elementsByIndex [mem.Index] = (XmlTypeMapElementInfo) mem.ElementInfo [0];
435 if (index >= _elementMembers.Count)
437 return _elementsByIndex [index];
440 private string BuildKey (string name, string ns, int explicitOrder)
442 if (_ignoreMemberNamespace) return name;
443 else return name + " / " + ns + (explicitOrder < 0 ? "" : "/" + explicitOrder);
446 public ICollection AllElementInfos
448 get { return _elements.Values; }
452 public bool IgnoreMemberNamespace
454 get { return _ignoreMemberNamespace; }
455 set { _ignoreMemberNamespace = value; }
458 public bool IsOrderDependentMap {
460 if (_isOrderDependentMap == null) {
461 _isOrderDependentMap = false;
462 foreach (XmlTypeMapElementInfo ei in _elements.Values)
463 if (ei.ExplicitOrder >= 0) {
464 _isOrderDependentMap = true;
468 return (bool) _isOrderDependentMap;
472 public XmlTypeMapMember FindMember (string name)
474 for (int n=0; n<_allMembers.Count; n++)
475 if (((XmlTypeMapMember)_allMembers[n]).Name == name) return (XmlTypeMapMember)_allMembers[n];
479 public XmlTypeMapMemberAnyElement DefaultAnyElementMember
481 get { return _defaultAnyElement; }
484 public XmlTypeMapMemberAnyAttribute DefaultAnyAttributeMember
486 get { return _defaultAnyAttribute; }
489 public XmlTypeMapMemberNamespaces NamespaceDeclarations
491 get { return _namespaceDeclarations; }
494 public ICollection AttributeMembers
498 if (_attributeMembers == null) return null;
499 if (_attributeMembersArray != null) return _attributeMembersArray;
501 _attributeMembersArray = new XmlTypeMapMemberAttribute[_attributeMembers.Count];
502 foreach (XmlTypeMapMemberAttribute mem in _attributeMembers.Values)
503 _attributeMembersArray [mem.Index] = mem;
504 return _attributeMembersArray;
508 public ICollection ElementMembers
510 get { return _elementMembers; }
513 public ArrayList AllMembers
515 get { return _allMembers; }
518 public ArrayList FlatLists
520 get { return _flatLists; }
523 public ArrayList MembersWithDefault
525 get { return _membersWithDefault; }
528 public ArrayList ListMembers
530 get { return _listMembers; }
533 public XmlTypeMapMember XmlTextCollector
535 get { return _xmlTextCollector; }
538 public XmlTypeMapMember ReturnMember
540 get { return _returnMember; }
543 public XmlQualifiedName SimpleContentBaseType
547 if (!_canBeSimpleType || _elementMembers == null || _elementMembers.Count != 1) return null;
548 XmlTypeMapMemberElement member = (XmlTypeMapMemberElement) _elementMembers[0];
549 if (member.ElementInfo.Count != 1) return null;
550 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) member.ElementInfo[0];
551 if (!einfo.IsTextElement) return null;
552 if (member.TypeData.SchemaType == SchemaTypes.Primitive || member.TypeData.SchemaType == SchemaTypes.Enum)
553 return new XmlQualifiedName (einfo.TypeData.XmlType, einfo.DataTypeNamespace);
558 public void SetCanBeSimpleType (bool can)
560 _canBeSimpleType = can;
563 public bool HasSimpleContent
567 return SimpleContentBaseType != null;
573 // Mapping info for arrays and lists
575 internal class ListMap: ObjectMap
577 XmlTypeMapElementInfoList _itemInfo;
578 bool _gotNestedMapping;
579 XmlTypeMapping _nestedArrayMapping;
580 string _choiceMember;
582 public bool IsMultiArray
586 return (NestedArrayMapping != null);
590 public string ChoiceMember
592 get { return _choiceMember; }
593 set { _choiceMember = value; }
596 public XmlTypeMapping NestedArrayMapping
600 if (_gotNestedMapping) return _nestedArrayMapping;
601 _gotNestedMapping = true;
603 _nestedArrayMapping = ((XmlTypeMapElementInfo)_itemInfo[0]).MappedType;
605 if (_nestedArrayMapping == null) return null;
607 if (_nestedArrayMapping.TypeData.SchemaType != SchemaTypes.Array) {
608 _nestedArrayMapping = null; return null;
611 foreach (XmlTypeMapElementInfo elem in _itemInfo)
612 if (elem.MappedType != _nestedArrayMapping) {
613 _nestedArrayMapping = null;
617 return _nestedArrayMapping;
621 public XmlTypeMapElementInfoList ItemInfo
624 get { return _itemInfo; }
625 set { _itemInfo = value; }
628 public XmlTypeMapElementInfo FindElement (object ob, int index, object memberValue)
630 if (_itemInfo.Count == 1)
631 return (XmlTypeMapElementInfo) _itemInfo[0];
632 else if (_choiceMember != null && index != -1)
634 Array values = (Array) XmlTypeMapMember.GetValue (ob, _choiceMember);
635 if (values == null || index >= values.Length)
636 throw new InvalidOperationException ("Invalid or missing choice enum value in member '" + _choiceMember + "'.");
637 object val = values.GetValue (index);
638 foreach (XmlTypeMapElementInfo elem in _itemInfo)
639 if (elem.ChoiceValue != null && elem.ChoiceValue.Equals (val))
644 if (memberValue == null) return null;
645 Type type = memberValue.GetType();
646 foreach (XmlTypeMapElementInfo elem in _itemInfo)
647 if (elem.TypeData.Type == type) return elem;
652 public XmlTypeMapElementInfo FindElement (string elementName, string ns)
654 foreach (XmlTypeMapElementInfo elem in _itemInfo)
655 if (elem.ElementName == elementName && elem.Namespace == ns) return elem;
659 public XmlTypeMapElementInfo FindTextElement ()
661 foreach (XmlTypeMapElementInfo elem in _itemInfo)
662 if (elem.IsTextElement) return elem;
666 public string GetSchemaArrayName ()
668 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) _itemInfo[0];
669 if (einfo.MappedType != null) return TypeTranslator.GetArrayName (einfo.MappedType.XmlType);
670 else return TypeTranslator.GetArrayName (einfo.TypeData.XmlType);
673 public void GetArrayType (int itemCount, out string localName, out string ns)
676 if (itemCount != -1) arrayDim = "[" + itemCount + "]";
677 else arrayDim = "[]";
679 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo) _itemInfo[0];
680 if (info.TypeData.SchemaType == SchemaTypes.Array)
683 ((ListMap)info.MappedType.ObjectMap).GetArrayType (-1, out nm, out ns);
684 localName = nm + arrayDim;
688 if (info.MappedType != null)
690 localName = info.MappedType.XmlType + arrayDim;
691 ns = info.MappedType.Namespace;
695 localName = info.TypeData.XmlType + arrayDim;
696 ns = info.DataTypeNamespace;
701 public override bool Equals (object other)
703 ListMap lmap = other as ListMap;
704 if (lmap == null) return false;
706 if (_itemInfo.Count != lmap._itemInfo.Count) return false;
707 for (int n=0; n<_itemInfo.Count; n++)
708 if (!_itemInfo[n].Equals (lmap._itemInfo[n])) return false;
712 public override int GetHashCode ()
714 return base.GetHashCode ();
718 internal class EnumMap: ObjectMap
720 readonly EnumMapMember[] _members;
721 readonly bool _isFlags;
722 readonly string[] _enumNames = null;
723 readonly string[] _xmlNames = null;
724 readonly long[] _values = null;
726 public class EnumMapMember
728 readonly string _xmlName;
729 readonly string _enumName;
730 readonly long _value;
731 string _documentation;
733 public EnumMapMember (string xmlName, string enumName)
734 : this (xmlName, enumName, 0)
738 public EnumMapMember (string xmlName, string enumName, long value)
741 _enumName = enumName;
745 public string XmlName
747 get { return _xmlName; }
750 public string EnumName
752 get { return _enumName; }
757 get { return _value; }
760 public string Documentation
762 get { return _documentation; }
763 set { _documentation = value; }
767 public EnumMap (EnumMapMember[] members, bool isFlags)
772 _enumNames = new string[_members.Length];
773 _xmlNames = new string[_members.Length];
774 _values = new long[_members.Length];
776 for (int i = 0; i < _members.Length; i++) {
777 EnumMapMember mem = _members[i];
778 _enumNames[i] = mem.EnumName;
779 _xmlNames[i] = mem.XmlName;
780 _values[i] = mem.Value;
786 get { return _isFlags; }
789 public EnumMapMember[] Members
791 get { return _members; }
794 public string[] EnumNames
801 public string[] XmlNames
815 public string GetXmlName (string typeName, object enumValue)
817 if (enumValue is string) {
818 throw new InvalidCastException ();
824 value = ((IConvertible) enumValue).ToInt64 (CultureInfo.CurrentCulture);
825 } catch (FormatException) {
826 throw new InvalidCastException ();
829 for (int i = 0; i < Values.Length; i++) {
830 if (Values[i] == value)
834 if (IsFlags && value == 0)
837 string xmlName = string.Empty;
840 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values, typeName);
842 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values);
846 if (xmlName.Length == 0) {
848 throw new InvalidOperationException (string.Format(CultureInfo.CurrentCulture,
849 "'{0}' is not a valid value for {1}.", value, typeName));
851 return value.ToString (CultureInfo.InvariantCulture);
857 public string GetEnumName (string typeName, string xmlName)
860 xmlName = xmlName.Trim ();
861 if (xmlName.Length == 0)
864 System.Text.StringBuilder sb = new System.Text.StringBuilder ();
865 string[] enumNames = xmlName.Split (null);
866 foreach (string name in enumNames) {
867 if (name == string.Empty) continue;
868 string foundEnumValue = null;
869 for (int i = 0; i < XmlNames.Length; i++)
870 if (XmlNames[i] == name) {
871 foundEnumValue = EnumNames[i];
875 if (foundEnumValue != null) {
878 sb.Append (foundEnumValue);
880 throw new InvalidOperationException (string.Format (CultureInfo.CurrentCulture,
881 "'{0}' is not a valid value for {1}.", name, typeName));
884 return sb.ToString ();
887 foreach (EnumMapMember mem in _members)
888 if (mem.XmlName == xmlName) return mem.EnumName;