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 XmlSchemaComplexType _schemaType;
200 XmlQualifiedName _schemaTypeName;
202 internal XmlSerializableMapping(XmlRootAttribute root, string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
203 : base(elementName, ns, typeData, xmlType, xmlTypeNamespace)
205 XmlSchemaProviderAttribute schemaProvider = (XmlSchemaProviderAttribute) Attribute.GetCustomAttribute (typeData.Type, typeof (XmlSchemaProviderAttribute));
207 if (schemaProvider != null) {
208 string method = schemaProvider.MethodName;
209 MethodInfo mi = typeData.Type.GetMethod (method, BindingFlags.Static | BindingFlags.Public | BindingFlags.FlattenHierarchy);
211 throw new InvalidOperationException (String.Format ("Type '{0}' must implement public static method '{1}'", typeData.Type, method));
212 if (!typeof (XmlQualifiedName).IsAssignableFrom (mi.ReturnType) &&
213 // LAMESPEC: it is undocumented. (We don't have to tell users about it in the error message.)
214 // Also do not add such a silly compatibility test to assert that it does not raise an error.
215 !typeof (XmlSchemaComplexType).IsAssignableFrom (mi.ReturnType))
216 throw new InvalidOperationException (String.Format ("Method '{0}' indicated by XmlSchemaProviderAttribute must have its return type as XmlQualifiedName", method));
217 XmlSchemaSet xs = new XmlSchemaSet ();
218 object retVal = mi.Invoke (null, new object [] { xs });
219 _schemaTypeName = XmlQualifiedName.Empty;
223 if (retVal is XmlSchemaComplexType) {
224 _schemaType = (XmlSchemaComplexType) retVal;
225 if (!_schemaType.QualifiedName.IsEmpty)
226 _schemaTypeName = _schemaType.QualifiedName;
228 _schemaTypeName = new XmlQualifiedName (xmlType, xmlTypeNamespace);
230 else if (retVal is XmlQualifiedName) {
231 _schemaTypeName = (XmlQualifiedName)retVal;
234 throw new InvalidOperationException (
235 String.Format ("Method {0}.{1}() specified by XmlSchemaProviderAttribute has invalid signature: return type must be compatible with System.Xml.XmlQualifiedName.", typeData.Type.Name, method));
237 // defaultNamespace at XmlReflectionImporter takes precedence for Namespace, but not for XsdTypeNamespace.
238 UpdateRoot (new XmlQualifiedName (root != null ? root.ElementName : _schemaTypeName.Name, root != null ? root.Namespace : Namespace ?? _schemaTypeName.Namespace));
239 XmlTypeNamespace = _schemaTypeName.Namespace;
240 XmlType = _schemaTypeName.Name;
242 if (!_schemaTypeName.IsEmpty && xs.Count > 0) {
243 XmlSchema [] schemas = new XmlSchema [xs.Count];
244 xs.CopyTo (schemas, 0);
245 _schema = schemas [0];
251 IXmlSerializable serializable = (IXmlSerializable)Activator.CreateInstance (typeData.Type, true);
253 _schema = serializable.GetSchema();
254 } catch (Exception) {
255 // LAMESPEC: .NET has a bad exception catch and swallows it silently.
260 if (_schema.Id == null || _schema.Id.Length == 0)
261 throw new InvalidOperationException("Schema Id is missing. The schema returned from " + typeData.Type.FullName + ".GetSchema() must have an Id.");
265 internal XmlSchema Schema
267 get { return _schema; }
270 internal XmlSchemaType SchemaType {
271 get { return _schemaType; }
274 internal XmlQualifiedName SchemaTypeName {
275 get { return _schemaTypeName; }
280 // Mapping info for classes and structs
282 internal class ClassMap: ObjectMap
284 Hashtable _elements = new Hashtable ();
285 ArrayList _elementMembers;
286 Hashtable _attributeMembers;
287 XmlTypeMapMemberAttribute[] _attributeMembersArray;
288 XmlTypeMapElementInfo[] _elementsByIndex;
289 ArrayList _flatLists;
290 ArrayList _allMembers = new ArrayList ();
291 ArrayList _membersWithDefault;
292 ArrayList _listMembers;
293 XmlTypeMapMemberAnyElement _defaultAnyElement;
294 XmlTypeMapMemberAnyAttribute _defaultAnyAttribute;
295 XmlTypeMapMemberNamespaces _namespaceDeclarations;
296 XmlTypeMapMember _xmlTextCollector;
297 XmlTypeMapMember _returnMember;
298 bool _ignoreMemberNamespace;
299 bool _canBeSimpleType = true;
300 bool? _isOrderDependentMap;
302 public void AddMember (XmlTypeMapMember member)
304 // If GlobalIndex has not been set, set it now
305 if (member.GlobalIndex == -1)
306 member.GlobalIndex = _allMembers.Count;
308 _allMembers.Add (member);
310 if (!(member.DefaultValue is System.DBNull) && member.DefaultValue != null) {
311 if (_membersWithDefault == null) _membersWithDefault = new ArrayList ();
312 _membersWithDefault.Add (member);
315 if (member.IsReturnValue)
316 _returnMember = member;
318 if (member is XmlTypeMapMemberAttribute)
320 XmlTypeMapMemberAttribute atm = (XmlTypeMapMemberAttribute)member;
321 if (_attributeMembers == null) _attributeMembers = new Hashtable();
322 string key = BuildKey (atm.AttributeName, atm.Namespace, -1);
323 if (_attributeMembers.ContainsKey (key))
324 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.");
325 member.Index = _attributeMembers.Count;
326 _attributeMembers.Add (key, member);
329 else if (member is XmlTypeMapMemberFlatList)
331 RegisterFlatList ((XmlTypeMapMemberFlatList)member);
333 else if (member is XmlTypeMapMemberAnyElement)
335 XmlTypeMapMemberAnyElement mem = (XmlTypeMapMemberAnyElement) member;
336 if (mem.IsDefaultAny) _defaultAnyElement = mem;
337 if (mem.TypeData.IsListType) RegisterFlatList (mem);
339 else if (member is XmlTypeMapMemberAnyAttribute)
341 _defaultAnyAttribute = (XmlTypeMapMemberAnyAttribute) member;
344 else if (member is XmlTypeMapMemberNamespaces)
346 _namespaceDeclarations = (XmlTypeMapMemberNamespaces) member;
350 if (member is XmlTypeMapMemberElement && ((XmlTypeMapMemberElement)member).IsXmlTextCollector)
352 if (_xmlTextCollector != null) throw new InvalidOperationException ("XmlTextAttribute can only be applied once in a class");
353 _xmlTextCollector = member;
356 if (_elementMembers == null) {
357 _elementMembers = new ArrayList();
358 _elements = new Hashtable();
361 member.Index = _elementMembers.Count;
362 _elementMembers.Add (member);
364 ICollection elemsInfo = ((XmlTypeMapMemberElement)member).ElementInfo;
365 foreach (XmlTypeMapElementInfo elem in elemsInfo)
367 string key = BuildKey (elem.ElementName, elem.Namespace, elem.ExplicitOrder);
368 if (_elements.ContainsKey (key))
369 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.");
370 _elements.Add (key, elem);
373 if (member.TypeData.IsListType && member.TypeData.Type != null && !member.TypeData.Type.IsArray) {
374 if (_listMembers == null) _listMembers = new ArrayList ();
375 _listMembers.Add (member);
379 void RegisterFlatList (XmlTypeMapMemberExpandable member)
381 if (_flatLists == null) _flatLists = new ArrayList ();
382 member.FlatArrayIndex = _flatLists.Count;
383 _flatLists.Add (member);
386 public XmlTypeMapMemberAttribute GetAttribute (string name, string ns)
388 if (_attributeMembers == null) return null;
389 return (XmlTypeMapMemberAttribute)_attributeMembers [BuildKey (name,ns, -1)];
392 public XmlTypeMapElementInfo GetElement(string name, string ns, int minimalOrder)
394 if (_elements == null) return null;
396 foreach (XmlTypeMapElementInfo info in _elements.Values)
397 if (info.ElementName == name && info.Namespace == ns && info.ExplicitOrder >= minimalOrder)
403 public XmlTypeMapElementInfo GetElement(string name, string ns)
405 if (_elements == null) return null;
407 foreach (XmlTypeMapElementInfo info in _elements.Values)
408 if (info.ElementName == name && info.Namespace == ns)
414 public XmlTypeMapElementInfo GetElement (int index)
416 if (_elements == null) return null;
418 if (_elementsByIndex == null)
420 _elementsByIndex = new XmlTypeMapElementInfo [_elementMembers.Count];
421 foreach (XmlTypeMapMemberElement mem in _elementMembers)
423 if (mem.ElementInfo.Count != 1)
424 throw new InvalidOperationException ("Read by order only possible for encoded/bare format");
426 _elementsByIndex [mem.Index] = (XmlTypeMapElementInfo) mem.ElementInfo [0];
429 if (index >= _elementMembers.Count)
431 return _elementsByIndex [index];
434 private string BuildKey (string name, string ns, int explicitOrder)
436 if (_ignoreMemberNamespace) return name;
437 else return name + " / " + ns + (explicitOrder < 0 ? "" : "/" + explicitOrder);
440 public ICollection AllElementInfos
442 get { return _elements.Values; }
446 public bool IgnoreMemberNamespace
448 get { return _ignoreMemberNamespace; }
449 set { _ignoreMemberNamespace = value; }
452 public bool IsOrderDependentMap {
454 if (_isOrderDependentMap == null) {
455 _isOrderDependentMap = false;
456 foreach (XmlTypeMapElementInfo ei in _elements.Values)
457 if (ei.ExplicitOrder >= 0) {
458 _isOrderDependentMap = true;
462 return (bool) _isOrderDependentMap;
466 public XmlTypeMapMember FindMember (string name)
468 for (int n=0; n<_allMembers.Count; n++)
469 if (((XmlTypeMapMember)_allMembers[n]).Name == name) return (XmlTypeMapMember)_allMembers[n];
473 public XmlTypeMapMemberAnyElement DefaultAnyElementMember
475 get { return _defaultAnyElement; }
478 public XmlTypeMapMemberAnyAttribute DefaultAnyAttributeMember
480 get { return _defaultAnyAttribute; }
483 public XmlTypeMapMemberNamespaces NamespaceDeclarations
485 get { return _namespaceDeclarations; }
488 public ICollection AttributeMembers
492 if (_attributeMembers == null) return null;
493 if (_attributeMembersArray != null) return _attributeMembersArray;
495 _attributeMembersArray = new XmlTypeMapMemberAttribute[_attributeMembers.Count];
496 foreach (XmlTypeMapMemberAttribute mem in _attributeMembers.Values)
497 _attributeMembersArray [mem.Index] = mem;
498 return _attributeMembersArray;
502 public ICollection ElementMembers
504 get { return _elementMembers; }
507 public ArrayList AllMembers
509 get { return _allMembers; }
512 public ArrayList FlatLists
514 get { return _flatLists; }
517 public ArrayList MembersWithDefault
519 get { return _membersWithDefault; }
522 public ArrayList ListMembers
524 get { return _listMembers; }
527 public XmlTypeMapMember XmlTextCollector
529 get { return _xmlTextCollector; }
532 public XmlTypeMapMember ReturnMember
534 get { return _returnMember; }
537 public XmlQualifiedName SimpleContentBaseType
541 if (!_canBeSimpleType || _elementMembers == null || _elementMembers.Count != 1) return null;
542 XmlTypeMapMemberElement member = (XmlTypeMapMemberElement) _elementMembers[0];
543 if (member.ElementInfo.Count != 1) return null;
544 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) member.ElementInfo[0];
545 if (!einfo.IsTextElement) return null;
546 if (member.TypeData.SchemaType == SchemaTypes.Primitive || member.TypeData.SchemaType == SchemaTypes.Enum)
547 return new XmlQualifiedName (einfo.TypeData.XmlType, einfo.DataTypeNamespace);
552 public void SetCanBeSimpleType (bool can)
554 _canBeSimpleType = can;
557 public bool HasSimpleContent
561 return SimpleContentBaseType != null;
567 // Mapping info for arrays and lists
569 internal class ListMap: ObjectMap
571 XmlTypeMapElementInfoList _itemInfo;
572 bool _gotNestedMapping;
573 XmlTypeMapping _nestedArrayMapping;
574 string _choiceMember;
576 public bool IsMultiArray
580 return (NestedArrayMapping != null);
584 public string ChoiceMember
586 get { return _choiceMember; }
587 set { _choiceMember = value; }
590 public XmlTypeMapping NestedArrayMapping
594 if (_gotNestedMapping) return _nestedArrayMapping;
595 _gotNestedMapping = true;
597 _nestedArrayMapping = ((XmlTypeMapElementInfo)_itemInfo[0]).MappedType;
599 if (_nestedArrayMapping == null) return null;
601 if (_nestedArrayMapping.TypeData.SchemaType != SchemaTypes.Array) {
602 _nestedArrayMapping = null; return null;
605 foreach (XmlTypeMapElementInfo elem in _itemInfo)
606 if (elem.MappedType != _nestedArrayMapping) {
607 _nestedArrayMapping = null;
611 return _nestedArrayMapping;
615 public XmlTypeMapElementInfoList ItemInfo
618 get { return _itemInfo; }
619 set { _itemInfo = value; }
622 public XmlTypeMapElementInfo FindElement (object ob, int index, object memberValue)
624 if (_itemInfo.Count == 1)
625 return (XmlTypeMapElementInfo) _itemInfo[0];
626 else if (_choiceMember != null && index != -1)
628 Array values = (Array) XmlTypeMapMember.GetValue (ob, _choiceMember);
629 if (values == null || index >= values.Length)
630 throw new InvalidOperationException ("Invalid or missing choice enum value in member '" + _choiceMember + "'.");
631 object val = values.GetValue (index);
632 foreach (XmlTypeMapElementInfo elem in _itemInfo)
633 if (elem.ChoiceValue != null && elem.ChoiceValue.Equals (val))
638 if (memberValue == null) return null;
639 Type type = memberValue.GetType();
640 foreach (XmlTypeMapElementInfo elem in _itemInfo)
641 if (elem.TypeData.Type == type) return elem;
646 public XmlTypeMapElementInfo FindElement (string elementName, string ns)
648 foreach (XmlTypeMapElementInfo elem in _itemInfo)
649 if (elem.ElementName == elementName && elem.Namespace == ns) return elem;
653 public XmlTypeMapElementInfo FindTextElement ()
655 foreach (XmlTypeMapElementInfo elem in _itemInfo)
656 if (elem.IsTextElement) return elem;
660 public string GetSchemaArrayName ()
662 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) _itemInfo[0];
663 if (einfo.MappedType != null) return TypeTranslator.GetArrayName (einfo.MappedType.XmlType);
664 else return TypeTranslator.GetArrayName (einfo.TypeData.XmlType);
667 public void GetArrayType (int itemCount, out string localName, out string ns)
670 if (itemCount != -1) arrayDim = "[" + itemCount + "]";
671 else arrayDim = "[]";
673 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo) _itemInfo[0];
674 if (info.TypeData.SchemaType == SchemaTypes.Array)
677 ((ListMap)info.MappedType.ObjectMap).GetArrayType (-1, out nm, out ns);
678 localName = nm + arrayDim;
682 if (info.MappedType != null)
684 localName = info.MappedType.XmlType + arrayDim;
685 ns = info.MappedType.Namespace;
689 localName = info.TypeData.XmlType + arrayDim;
690 ns = info.DataTypeNamespace;
695 public override bool Equals (object other)
697 ListMap lmap = other as ListMap;
698 if (lmap == null) return false;
700 if (_itemInfo.Count != lmap._itemInfo.Count) return false;
701 for (int n=0; n<_itemInfo.Count; n++)
702 if (!_itemInfo[n].Equals (lmap._itemInfo[n])) return false;
706 public override int GetHashCode ()
708 return base.GetHashCode ();
712 internal class EnumMap: ObjectMap
714 readonly EnumMapMember[] _members;
715 readonly bool _isFlags;
716 readonly string[] _enumNames = null;
717 readonly string[] _xmlNames = null;
718 readonly long[] _values = null;
720 public class EnumMapMember
722 readonly string _xmlName;
723 readonly string _enumName;
724 readonly long _value;
725 string _documentation;
727 public EnumMapMember (string xmlName, string enumName)
728 : this (xmlName, enumName, 0)
732 public EnumMapMember (string xmlName, string enumName, long value)
735 _enumName = enumName;
739 public string XmlName
741 get { return _xmlName; }
744 public string EnumName
746 get { return _enumName; }
751 get { return _value; }
754 public string Documentation
756 get { return _documentation; }
757 set { _documentation = value; }
761 public EnumMap (EnumMapMember[] members, bool isFlags)
766 _enumNames = new string[_members.Length];
767 _xmlNames = new string[_members.Length];
768 _values = new long[_members.Length];
770 for (int i = 0; i < _members.Length; i++) {
771 EnumMapMember mem = _members[i];
772 _enumNames[i] = mem.EnumName;
773 _xmlNames[i] = mem.XmlName;
774 _values[i] = mem.Value;
780 get { return _isFlags; }
783 public EnumMapMember[] Members
785 get { return _members; }
788 public string[] EnumNames
795 public string[] XmlNames
809 public string GetXmlName (string typeName, object enumValue)
811 if (enumValue is string) {
812 throw new InvalidCastException ();
818 value = ((IConvertible) enumValue).ToInt64 (CultureInfo.CurrentCulture);
819 } catch (FormatException) {
820 throw new InvalidCastException ();
823 for (int i = 0; i < Values.Length; i++) {
824 if (Values[i] == value)
828 if (IsFlags && value == 0)
831 string xmlName = string.Empty;
834 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values, typeName);
836 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values);
840 if (xmlName.Length == 0) {
842 throw new InvalidOperationException (string.Format(CultureInfo.CurrentCulture,
843 "'{0}' is not a valid value for {1}.", value, typeName));
845 return value.ToString (CultureInfo.InvariantCulture);
851 public string GetEnumName (string typeName, string xmlName)
854 xmlName = xmlName.Trim ();
855 if (xmlName.Length == 0)
858 System.Text.StringBuilder sb = new System.Text.StringBuilder ();
859 string[] enumNames = xmlName.Split (null);
860 foreach (string name in enumNames) {
861 if (name == string.Empty) continue;
862 string foundEnumValue = null;
863 for (int i = 0; i < XmlNames.Length; i++)
864 if (XmlNames[i] == name) {
865 foundEnumValue = EnumNames[i];
869 if (foundEnumValue != null) {
872 sb.Append (foundEnumValue);
874 throw new InvalidOperationException (string.Format (CultureInfo.CurrentCulture,
875 "'{0}' is not a valid value for {1}.", name, typeName));
878 return sb.ToString ();
881 foreach (EnumMapMember mem in _members)
882 if (mem.XmlName == xmlName) return mem.EnumName;