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; }
111 set { xmlTypeNamespace = value; }
114 internal ArrayList DerivedTypes
116 get { return _derivedTypes; }
117 set { _derivedTypes = value; }
120 internal bool MultiReferenceType
122 get { return multiReferenceType; }
123 set { multiReferenceType = value; }
126 internal XmlTypeMapping BaseMap
128 get { return baseMap; }
129 set { baseMap = value; }
132 internal bool IsSimpleType
134 get { return isSimpleType; }
135 set { isSimpleType = value; }
138 internal string Documentation
140 set { documentation = value; }
141 get { return documentation; }
144 internal bool IncludeInSchema
146 get { return includeInSchema; }
147 set { includeInSchema = value; }
150 internal bool IsNullable
152 get { return isNullable; }
153 set { isNullable = value; }
156 internal XmlTypeMapping GetRealTypeMap (Type objectType)
158 if (TypeData.SchemaType == SchemaTypes.Enum)
161 // Returns the map for a subtype of this map's type
162 if (TypeData.Type == objectType) return this;
163 for (int n=0; n<_derivedTypes.Count; n++) {
164 XmlTypeMapping map = (XmlTypeMapping) _derivedTypes[n];
165 if (map.TypeData.Type == objectType) return map;
171 internal XmlTypeMapping GetRealElementMap (string name, string ens)
173 if (xmlType == name && xmlTypeNamespace == ens) return this;
174 foreach (XmlTypeMapping map in _derivedTypes)
175 if (map.xmlType == name && map.xmlTypeNamespace == ens) return map;
180 internal void UpdateRoot (XmlQualifiedName qname)
183 this._elementName = qname.Name;
184 this._namespace = qname.Namespace;
190 // Mapping info for XmlSerializable
191 internal class XmlSerializableMapping : XmlTypeMapping
195 XmlSchemaComplexType _schemaType;
196 XmlQualifiedName _schemaTypeName;
199 internal XmlSerializableMapping(string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
200 : base(elementName, ns, typeData, xmlType, xmlTypeNamespace)
203 XmlSchemaProviderAttribute schemaProvider = (XmlSchemaProviderAttribute) Attribute.GetCustomAttribute (typeData.Type, typeof (XmlSchemaProviderAttribute));
205 if (schemaProvider != null) {
206 string method = schemaProvider.MethodName;
207 MethodInfo mi = typeData.Type.GetMethod (method, BindingFlags.Static | BindingFlags.Public | BindingFlags.FlattenHierarchy);
209 throw new InvalidOperationException (String.Format ("Type '{0}' must implement public static method '{1}'", typeData.Type, method));
210 if (!typeof (XmlQualifiedName).IsAssignableFrom (mi.ReturnType) &&
211 // LAMESPEC: it is undocumented. (We don't have to tell users about it in the error message.)
212 // Also do not add such a silly compatibility test to assert that it does not raise an error.
213 !typeof (XmlSchemaComplexType).IsAssignableFrom (mi.ReturnType))
214 throw new InvalidOperationException (String.Format ("Method '{0}' indicated by XmlSchemaProviderAttribute must have its return type as XmlQualifiedName", method));
215 XmlSchemaSet xs = new XmlSchemaSet ();
216 object retVal = mi.Invoke (null, new object [] { xs });
217 _schemaTypeName = XmlQualifiedName.Empty;
221 if (retVal is XmlSchemaComplexType) {
222 _schemaType = (XmlSchemaComplexType) retVal;
223 if (!_schemaType.QualifiedName.IsEmpty)
224 _schemaTypeName = _schemaType.QualifiedName;
226 _schemaTypeName = new XmlQualifiedName (xmlType, xmlTypeNamespace);
228 else if (retVal is XmlQualifiedName) {
229 _schemaTypeName = (XmlQualifiedName)retVal;
232 throw new InvalidOperationException (
233 String.Format ("Method {0}.{1}() specified by XmlSchemaProviderAttribute has invalid signature: return type must be compatible with System.Xml.XmlQualifiedName.", typeData.Type.Name, method));
235 // defaultNamespace at XmlReflectionImporter takes precedence for Namespace, but not for XsdTypeNamespace.
236 UpdateRoot (new XmlQualifiedName (_schemaTypeName.Name, Namespace ?? _schemaTypeName.Namespace));
237 XmlTypeNamespace = _schemaTypeName.Namespace;
238 XmlType = _schemaTypeName.Name;
240 if (!_schemaTypeName.IsEmpty && xs.Count > 0) {
241 XmlSchema [] schemas = new XmlSchema [xs.Count];
242 xs.CopyTo (schemas, 0);
243 _schema = schemas [0];
249 IXmlSerializable serializable = (IXmlSerializable)Activator.CreateInstance (typeData.Type, true);
250 _schema = serializable.GetSchema();
253 if (_schema.Id == null || _schema.Id.Length == 0)
254 throw new InvalidOperationException("Schema Id is missing. The schema returned from " + typeData.Type.FullName + ".GetSchema() must have an Id.");
258 internal XmlSchema Schema
260 get { return _schema; }
264 internal XmlSchemaType SchemaType {
265 get { return _schemaType; }
268 internal XmlQualifiedName SchemaTypeName {
269 get { return _schemaTypeName; }
275 // Mapping info for classes and structs
277 internal class ClassMap: ObjectMap
279 Hashtable _elements = new Hashtable ();
280 ArrayList _elementMembers;
281 Hashtable _attributeMembers;
282 XmlTypeMapMemberAttribute[] _attributeMembersArray;
283 XmlTypeMapElementInfo[] _elementsByIndex;
284 ArrayList _flatLists;
285 ArrayList _allMembers = new ArrayList ();
286 ArrayList _membersWithDefault;
287 ArrayList _listMembers;
288 XmlTypeMapMemberAnyElement _defaultAnyElement;
289 XmlTypeMapMemberAnyAttribute _defaultAnyAttribute;
290 XmlTypeMapMemberNamespaces _namespaceDeclarations;
291 XmlTypeMapMember _xmlTextCollector;
292 XmlTypeMapMember _returnMember;
293 bool _ignoreMemberNamespace;
294 bool _canBeSimpleType = true;
296 public void AddMember (XmlTypeMapMember member)
298 member.GlobalIndex = _allMembers.Count;
299 _allMembers.Add (member);
301 if (!(member.DefaultValue is System.DBNull) && member.DefaultValue != null) {
302 if (_membersWithDefault == null) _membersWithDefault = new ArrayList ();
303 _membersWithDefault.Add (member);
306 if (member.IsReturnValue)
307 _returnMember = member;
309 if (member is XmlTypeMapMemberAttribute)
311 XmlTypeMapMemberAttribute atm = (XmlTypeMapMemberAttribute)member;
312 if (_attributeMembers == null) _attributeMembers = new Hashtable();
313 string key = BuildKey (atm.AttributeName, atm.Namespace);
314 if (_attributeMembers.ContainsKey (key))
315 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.");
316 member.Index = _attributeMembers.Count;
317 _attributeMembers.Add (key, member);
320 else if (member is XmlTypeMapMemberFlatList)
322 RegisterFlatList ((XmlTypeMapMemberFlatList)member);
324 else if (member is XmlTypeMapMemberAnyElement)
326 XmlTypeMapMemberAnyElement mem = (XmlTypeMapMemberAnyElement) member;
327 if (mem.IsDefaultAny) _defaultAnyElement = mem;
328 if (mem.TypeData.IsListType) RegisterFlatList (mem);
330 else if (member is XmlTypeMapMemberAnyAttribute)
332 _defaultAnyAttribute = (XmlTypeMapMemberAnyAttribute) member;
335 else if (member is XmlTypeMapMemberNamespaces)
337 _namespaceDeclarations = (XmlTypeMapMemberNamespaces) member;
341 if (member is XmlTypeMapMemberElement && ((XmlTypeMapMemberElement)member).IsXmlTextCollector)
343 if (_xmlTextCollector != null) throw new InvalidOperationException ("XmlTextAttribute can only be applied once in a class");
344 _xmlTextCollector = member;
347 if (_elementMembers == null) {
348 _elementMembers = new ArrayList();
349 _elements = new Hashtable();
352 member.Index = _elementMembers.Count;
353 _elementMembers.Add (member);
355 ICollection elemsInfo = ((XmlTypeMapMemberElement)member).ElementInfo;
356 foreach (XmlTypeMapElementInfo elem in elemsInfo)
358 string key = BuildKey (elem.ElementName, elem.Namespace);
359 if (_elements.ContainsKey (key))
360 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.");
361 _elements.Add (key, elem);
364 if (member.TypeData.IsListType && member.TypeData.Type != null && !member.TypeData.Type.IsArray) {
365 if (_listMembers == null) _listMembers = new ArrayList ();
366 _listMembers.Add (member);
370 void RegisterFlatList (XmlTypeMapMemberExpandable member)
372 if (_flatLists == null) _flatLists = new ArrayList ();
373 member.FlatArrayIndex = _flatLists.Count;
374 _flatLists.Add (member);
377 public XmlTypeMapMemberAttribute GetAttribute (string name, string ns)
379 if (_attributeMembers == null) return null;
380 return (XmlTypeMapMemberAttribute)_attributeMembers [BuildKey(name,ns)];
383 public XmlTypeMapElementInfo GetElement (string name, string ns)
385 if (_elements == null) return null;
386 return (XmlTypeMapElementInfo)_elements [BuildKey(name,ns)];
389 public XmlTypeMapElementInfo GetElement (int index)
391 if (_elements == null) return null;
393 if (_elementsByIndex == null)
395 _elementsByIndex = new XmlTypeMapElementInfo [_elementMembers.Count];
396 foreach (XmlTypeMapMemberElement mem in _elementMembers)
398 if (mem.ElementInfo.Count != 1)
399 throw new InvalidOperationException ("Read by order only possible for encoded/bare format");
401 _elementsByIndex [mem.Index] = (XmlTypeMapElementInfo) mem.ElementInfo [0];
405 return _elementsByIndex [index];
408 private string BuildKey (string name, string ns)
410 if (_ignoreMemberNamespace) return name;
411 else return name + " / " + ns;
414 public ICollection AllElementInfos
416 get { return _elements.Values; }
420 public bool IgnoreMemberNamespace
422 get { return _ignoreMemberNamespace; }
423 set { _ignoreMemberNamespace = value; }
426 public XmlTypeMapMember FindMember (string name)
428 for (int n=0; n<_allMembers.Count; n++)
429 if (((XmlTypeMapMember)_allMembers[n]).Name == name) return (XmlTypeMapMember)_allMembers[n];
433 public XmlTypeMapMemberAnyElement DefaultAnyElementMember
435 get { return _defaultAnyElement; }
438 public XmlTypeMapMemberAnyAttribute DefaultAnyAttributeMember
440 get { return _defaultAnyAttribute; }
443 public XmlTypeMapMemberNamespaces NamespaceDeclarations
445 get { return _namespaceDeclarations; }
448 public ICollection AttributeMembers
452 if (_attributeMembers == null) return null;
453 if (_attributeMembersArray != null) return _attributeMembersArray;
455 _attributeMembersArray = new XmlTypeMapMemberAttribute[_attributeMembers.Count];
456 foreach (XmlTypeMapMemberAttribute mem in _attributeMembers.Values)
457 _attributeMembersArray [mem.Index] = mem;
458 return _attributeMembersArray;
462 public ICollection ElementMembers
464 get { return _elementMembers; }
467 public ArrayList AllMembers
469 get { return _allMembers; }
472 public ArrayList FlatLists
474 get { return _flatLists; }
477 public ArrayList MembersWithDefault
479 get { return _membersWithDefault; }
482 public ArrayList ListMembers
484 get { return _listMembers; }
487 public XmlTypeMapMember XmlTextCollector
489 get { return _xmlTextCollector; }
492 public XmlTypeMapMember ReturnMember
494 get { return _returnMember; }
497 public XmlQualifiedName SimpleContentBaseType
501 if (!_canBeSimpleType || _elementMembers == null || _elementMembers.Count != 1) return null;
502 XmlTypeMapMemberElement member = (XmlTypeMapMemberElement) _elementMembers[0];
503 if (member.ElementInfo.Count != 1) return null;
504 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) member.ElementInfo[0];
505 if (!einfo.IsTextElement) return null;
506 if (member.TypeData.SchemaType == SchemaTypes.Primitive || member.TypeData.SchemaType == SchemaTypes.Enum)
507 return new XmlQualifiedName (einfo.TypeData.XmlType, einfo.DataTypeNamespace);
512 public void SetCanBeSimpleType (bool can)
514 _canBeSimpleType = can;
517 public bool HasSimpleContent
521 return SimpleContentBaseType != null;
527 // Mapping info for arrays and lists
529 internal class ListMap: ObjectMap
531 XmlTypeMapElementInfoList _itemInfo;
532 bool _gotNestedMapping;
533 XmlTypeMapping _nestedArrayMapping;
534 string _choiceMember;
536 public bool IsMultiArray
540 return (NestedArrayMapping != null);
544 public string ChoiceMember
546 get { return _choiceMember; }
547 set { _choiceMember = value; }
550 public XmlTypeMapping NestedArrayMapping
554 if (_gotNestedMapping) return _nestedArrayMapping;
555 _gotNestedMapping = true;
557 _nestedArrayMapping = ((XmlTypeMapElementInfo)_itemInfo[0]).MappedType;
559 if (_nestedArrayMapping == null) return null;
561 if (_nestedArrayMapping.TypeData.SchemaType != SchemaTypes.Array) {
562 _nestedArrayMapping = null; return null;
565 foreach (XmlTypeMapElementInfo elem in _itemInfo)
566 if (elem.MappedType != _nestedArrayMapping) {
567 _nestedArrayMapping = null;
571 return _nestedArrayMapping;
575 public XmlTypeMapElementInfoList ItemInfo
578 get { return _itemInfo; }
579 set { _itemInfo = value; }
582 public XmlTypeMapElementInfo FindElement (object ob, int index, object memberValue)
584 if (_itemInfo.Count == 1)
585 return (XmlTypeMapElementInfo) _itemInfo[0];
586 else if (_choiceMember != null && index != -1)
588 Array values = (Array) XmlTypeMapMember.GetValue (ob, _choiceMember);
589 if (values == null || index >= values.Length)
590 throw new InvalidOperationException ("Invalid or missing choice enum value in member '" + _choiceMember + "'.");
591 object val = values.GetValue (index);
592 foreach (XmlTypeMapElementInfo elem in _itemInfo)
593 if (elem.ChoiceValue != null && elem.ChoiceValue.Equals (val))
598 if (memberValue == null) return null;
599 Type type = memberValue.GetType();
600 foreach (XmlTypeMapElementInfo elem in _itemInfo)
601 if (elem.TypeData.Type == type) return elem;
606 public XmlTypeMapElementInfo FindElement (string elementName, string ns)
608 foreach (XmlTypeMapElementInfo elem in _itemInfo)
609 if (elem.ElementName == elementName && elem.Namespace == ns) return elem;
613 public XmlTypeMapElementInfo FindTextElement ()
615 foreach (XmlTypeMapElementInfo elem in _itemInfo)
616 if (elem.IsTextElement) return elem;
620 public string GetSchemaArrayName ()
622 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) _itemInfo[0];
623 if (einfo.MappedType != null) return TypeTranslator.GetArrayName (einfo.MappedType.XmlType);
624 else return TypeTranslator.GetArrayName (einfo.TypeData.XmlType);
627 public void GetArrayType (int itemCount, out string localName, out string ns)
630 if (itemCount != -1) arrayDim = "[" + itemCount + "]";
631 else arrayDim = "[]";
633 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo) _itemInfo[0];
634 if (info.TypeData.SchemaType == SchemaTypes.Array)
637 ((ListMap)info.MappedType.ObjectMap).GetArrayType (-1, out nm, out ns);
638 localName = nm + arrayDim;
642 if (info.MappedType != null)
644 localName = info.MappedType.XmlType + arrayDim;
645 ns = info.MappedType.Namespace;
649 localName = info.TypeData.XmlType + arrayDim;
650 ns = info.DataTypeNamespace;
655 public override bool Equals (object other)
657 ListMap lmap = other as ListMap;
658 if (lmap == null) return false;
660 if (_itemInfo.Count != lmap._itemInfo.Count) return false;
661 for (int n=0; n<_itemInfo.Count; n++)
662 if (!_itemInfo[n].Equals (lmap._itemInfo[n])) return false;
666 public override int GetHashCode ()
668 return base.GetHashCode ();
672 internal class EnumMap: ObjectMap
674 readonly EnumMapMember[] _members;
675 readonly bool _isFlags;
676 readonly string[] _enumNames = null;
677 readonly string[] _xmlNames = null;
678 readonly long[] _values = null;
680 public class EnumMapMember
682 readonly string _xmlName;
683 readonly string _enumName;
684 readonly long _value;
685 string _documentation;
687 public EnumMapMember (string xmlName, string enumName)
688 : this (xmlName, enumName, 0)
692 public EnumMapMember (string xmlName, string enumName, long value)
695 _enumName = enumName;
699 public string XmlName
701 get { return _xmlName; }
704 public string EnumName
706 get { return _enumName; }
711 get { return _value; }
714 public string Documentation
716 get { return _documentation; }
717 set { _documentation = value; }
721 public EnumMap (EnumMapMember[] members, bool isFlags)
726 _enumNames = new string[_members.Length];
727 _xmlNames = new string[_members.Length];
728 _values = new long[_members.Length];
730 for (int i = 0; i < _members.Length; i++) {
731 EnumMapMember mem = _members[i];
732 _enumNames[i] = mem.EnumName;
733 _xmlNames[i] = mem.XmlName;
734 _values[i] = mem.Value;
740 get { return _isFlags; }
743 public EnumMapMember[] Members
745 get { return _members; }
748 public string[] EnumNames
755 public string[] XmlNames
769 public string GetXmlName (string typeName, object enumValue)
771 if (enumValue is string) {
772 throw new InvalidCastException ();
778 value = ((IConvertible) enumValue).ToInt64 (CultureInfo.CurrentCulture);
779 } catch (FormatException) {
780 throw new InvalidCastException ();
783 for (int i = 0; i < Values.Length; i++) {
784 if (Values[i] == value)
788 if (IsFlags && value == 0)
791 string xmlName = string.Empty;
794 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values, typeName);
796 xmlName = XmlCustomFormatter.FromEnum (value, XmlNames, Values);
800 if (xmlName.Length == 0) {
802 throw new InvalidOperationException (string.Format(CultureInfo.CurrentCulture,
803 "'{0}' is not a valid value for {1}.", value, typeName));
805 return value.ToString (CultureInfo.InvariantCulture);
811 public string GetEnumName (string typeName, string xmlName)
814 xmlName = xmlName.Trim ();
815 if (xmlName.Length == 0)
818 System.Text.StringBuilder sb = new System.Text.StringBuilder ();
819 string[] enumNames = xmlName.Split (null);
820 foreach (string name in enumNames) {
821 if (name == string.Empty) continue;
822 string foundEnumValue = null;
823 for (int i = 0; i < XmlNames.Length; i++)
824 if (XmlNames[i] == name) {
825 foundEnumValue = EnumNames[i];
829 if (foundEnumValue != null) {
832 sb.Append (foundEnumValue);
834 throw new InvalidOperationException (string.Format (CultureInfo.CurrentCulture,
835 "'{0}' is not a valid value for {1}.", name, typeName));
838 return sb.ToString ();
841 foreach (EnumMapMember mem in _members)
842 if (mem.XmlName == xmlName) return mem.EnumName;