2 // XmlTypeMapping.cs:
\r
5 // John Donagher (john@webmeta.com)
\r
6 // Lluis Sanchez Gual (lluis@ximian.com)
\r
8 // (C) 2002 John Donagher
\r
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;
\r
35 using System.Globalization;
36 using System.Xml.Schema;
\r
38 namespace System.Xml.Serialization
\r
40 public class XmlTypeMapping : XmlMapping
\r
42 private string xmlType;
\r
43 private string xmlTypeNamespace;
\r
45 XmlTypeMapping baseMap;
\r
46 bool multiReferenceType = false;
\r
48 string documentation;
\r
49 bool includeInSchema;
\r
50 bool isNullable = true;
\r
52 ArrayList _derivedTypes = new ArrayList();
\r
54 internal XmlTypeMapping(string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
\r
55 : base (elementName, ns)
\r
57 this.type = typeData;
\r
58 this.xmlType = xmlType;
\r
59 this.xmlTypeNamespace = xmlTypeNamespace;
\r
63 public string ElementName
\r
65 get { return _elementName; }
\r
68 public string Namespace
\r
70 get { return _namespace; }
\r
74 public string TypeFullName
\r
76 get { return type.FullTypeName; }
\r
79 public string TypeName
\r
81 get { return type.TypeName; }
\r
84 internal TypeData TypeData
\r
86 get { return type; }
\r
89 internal string XmlType
\r
91 get { return xmlType; }
\r
94 internal string XmlTypeNamespace
\r
96 get { return xmlTypeNamespace; }
\r
99 internal ArrayList DerivedTypes
\r
101 get { return _derivedTypes; }
\r
102 set { _derivedTypes = value; }
\r
105 internal bool MultiReferenceType
\r
107 get { return multiReferenceType; }
\r
108 set { multiReferenceType = value; }
\r
111 internal XmlTypeMapping BaseMap
\r
113 get { return baseMap; }
\r
114 set { baseMap = value; }
\r
117 internal bool IsSimpleType
\r
119 get { return isSimpleType; }
\r
120 set { isSimpleType = value; }
\r
123 internal string Documentation
\r
125 set { documentation = value; }
\r
126 get { return documentation; }
\r
129 internal bool IncludeInSchema
\r
131 get { return includeInSchema; }
\r
132 set { includeInSchema = value; }
\r
135 internal bool IsNullable
\r
137 get { return isNullable; }
\r
138 set { isNullable = value; }
\r
141 internal XmlTypeMapping GetRealTypeMap (string objectFullTypeName)
\r
143 // Returns the map for a subtype of this map's type
\r
145 objectFullTypeName = objectFullTypeName.Replace ('+','.');
\r
146 if (TypeFullName == objectFullTypeName) return this;
\r
147 for (int n=0; n<_derivedTypes.Count; n++) {
\r
148 XmlTypeMapping map = (XmlTypeMapping) _derivedTypes[n];
\r
149 if (map.TypeFullName == objectFullTypeName) return map;
\r
155 internal XmlTypeMapping GetRealElementMap (string name, string ens)
\r
157 if (xmlType == name && xmlTypeNamespace == ens) return this;
\r
158 foreach (XmlTypeMapping map in _derivedTypes)
\r
159 if (map.xmlType == name && map.xmlTypeNamespace == ens) return map;
\r
164 internal void UpdateRoot (XmlQualifiedName qname)
\r
166 if (qname != null) {
\r
167 this._elementName = qname.Name;
\r
168 this._namespace = qname.Namespace;
\r
174 // Mapping info for XmlSerializable
175 internal class XmlSerializableMapping : XmlTypeMapping
179 internal XmlSerializableMapping(string elementName, string ns, TypeData typeData, string xmlType, string xmlTypeNamespace)
180 : base(elementName, ns, typeData, xmlType, xmlTypeNamespace)
182 IXmlSerializable serializable = (IXmlSerializable)Activator.CreateInstance(typeData.Type);
183 _schema = serializable.GetSchema();
186 if (_schema.Id == null || _schema.Id.Length == 0)
187 throw new InvalidOperationException("Schema Id is missing. The schema returned from " + typeData.Type.FullName + ".GetSchema() must have an Id.");
191 internal XmlSchema Schema
193 get { return _schema; }
198 // Mapping info for classes and structs
\r
200 internal class ClassMap: ObjectMap
\r
202 Hashtable _elements = new Hashtable ();
\r
203 ArrayList _elementMembers;
\r
204 Hashtable _attributeMembers;
\r
205 XmlTypeMapMemberAttribute[] _attributeMembersArray;
\r
206 XmlTypeMapElementInfo[] _elementsByIndex;
\r
207 ArrayList _flatLists;
\r
208 ArrayList _allMembers = new ArrayList ();
\r
209 ArrayList _membersWithDefault;
\r
210 ArrayList _listMembers;
\r
211 XmlTypeMapMemberAnyElement _defaultAnyElement;
\r
212 XmlTypeMapMemberAnyAttribute _defaultAnyAttribute;
\r
213 XmlTypeMapMemberNamespaces _namespaceDeclarations;
\r
214 XmlTypeMapMember _xmlTextCollector;
\r
215 XmlTypeMapMember _returnMember;
\r
216 bool _ignoreMemberNamespace;
\r
217 bool _canBeSimpleType = true;
\r
219 public void AddMember (XmlTypeMapMember member)
\r
221 _allMembers.Add (member);
\r
223 if (!(member.DefaultValue is System.DBNull) && member.DefaultValue != null) {
\r
224 if (_membersWithDefault == null) _membersWithDefault = new ArrayList ();
\r
225 _membersWithDefault.Add (member);
\r
228 if (member.IsReturnValue)
\r
229 _returnMember = member;
\r
231 if (member is XmlTypeMapMemberAttribute)
\r
233 XmlTypeMapMemberAttribute atm = (XmlTypeMapMemberAttribute)member;
\r
234 if (_attributeMembers == null) _attributeMembers = new Hashtable();
\r
235 string key = BuildKey (atm.AttributeName, atm.Namespace);
\r
236 if (_attributeMembers.ContainsKey (key))
\r
237 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.");
\r
238 member.Index = _attributeMembers.Count;
\r
239 _attributeMembers.Add (key, member);
\r
242 else if (member is XmlTypeMapMemberFlatList)
\r
244 RegisterFlatList ((XmlTypeMapMemberFlatList)member);
\r
246 else if (member is XmlTypeMapMemberAnyElement)
\r
248 XmlTypeMapMemberAnyElement mem = (XmlTypeMapMemberAnyElement) member;
\r
249 if (mem.IsDefaultAny) _defaultAnyElement = mem;
\r
250 if (mem.TypeData.IsListType) RegisterFlatList (mem);
\r
252 else if (member is XmlTypeMapMemberAnyAttribute)
\r
254 _defaultAnyAttribute = (XmlTypeMapMemberAnyAttribute) member;
\r
257 else if (member is XmlTypeMapMemberNamespaces)
\r
259 _namespaceDeclarations = (XmlTypeMapMemberNamespaces) member;
\r
263 if (member is XmlTypeMapMemberElement && ((XmlTypeMapMemberElement)member).IsXmlTextCollector)
\r
265 if (_xmlTextCollector != null) throw new InvalidOperationException ("XmlTextAttribute can only be applied once in a class");
\r
266 _xmlTextCollector = member;
\r
269 if (_elementMembers == null) {
\r
270 _elementMembers = new ArrayList();
\r
271 _elements = new Hashtable();
\r
274 member.Index = _elementMembers.Count;
\r
275 _elementMembers.Add (member);
\r
277 ICollection elemsInfo = ((XmlTypeMapMemberElement)member).ElementInfo;
\r
278 foreach (XmlTypeMapElementInfo elem in elemsInfo)
\r
280 string key = BuildKey (elem.ElementName, elem.Namespace);
\r
281 if (_elements.ContainsKey (key))
\r
282 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.");
\r
283 _elements.Add (key, elem);
\r
286 if (member.TypeData.IsListType && member.TypeData.Type != null && !member.TypeData.Type.IsArray) {
287 if (_listMembers == null) _listMembers = new ArrayList ();
\r
288 _listMembers.Add (member);
\r
292 void RegisterFlatList (XmlTypeMapMemberExpandable member)
\r
294 if (_flatLists == null) _flatLists = new ArrayList ();
\r
295 member.FlatArrayIndex = _flatLists.Count;
\r
296 _flatLists.Add (member);
\r
299 public XmlTypeMapMemberAttribute GetAttribute (string name, string ns)
\r
301 if (_attributeMembers == null) return null;
\r
302 return (XmlTypeMapMemberAttribute)_attributeMembers [BuildKey(name,ns)];
\r
305 public XmlTypeMapElementInfo GetElement (string name, string ns)
\r
307 if (_elements == null) return null;
\r
308 return (XmlTypeMapElementInfo)_elements [BuildKey(name,ns)];
\r
311 public XmlTypeMapElementInfo GetElement (int index)
\r
313 if (_elements == null) return null;
\r
315 if (_elementsByIndex == null)
\r
317 _elementsByIndex = new XmlTypeMapElementInfo [_elementMembers.Count];
\r
318 foreach (XmlTypeMapMemberElement mem in _elementMembers)
\r
320 if (mem.ElementInfo.Count != 1)
\r
321 throw new InvalidOperationException ("Read by order only possible for encoded/bare format");
\r
323 _elementsByIndex [mem.Index] = (XmlTypeMapElementInfo) mem.ElementInfo [0];
\r
327 return _elementsByIndex [index];
\r
330 private string BuildKey (string name, string ns)
\r
332 if (_ignoreMemberNamespace) return name;
\r
333 else return name + " / " + ns;
\r
336 public ICollection AllElementInfos
\r
338 get { return _elements.Values; }
\r
342 public bool IgnoreMemberNamespace
\r
344 get { return _ignoreMemberNamespace; }
\r
345 set { _ignoreMemberNamespace = value; }
\r
348 public XmlTypeMapMember FindMember (string name)
\r
350 for (int n=0; n<_allMembers.Count; n++)
\r
351 if (((XmlTypeMapMember)_allMembers[n]).Name == name) return (XmlTypeMapMember)_allMembers[n];
\r
355 public XmlTypeMapMemberAnyElement DefaultAnyElementMember
\r
357 get { return _defaultAnyElement; }
\r
360 public XmlTypeMapMemberAnyAttribute DefaultAnyAttributeMember
\r
362 get { return _defaultAnyAttribute; }
\r
365 public XmlTypeMapMemberNamespaces NamespaceDeclarations
\r
367 get { return _namespaceDeclarations; }
\r
370 public ICollection AttributeMembers
\r
374 if (_attributeMembers == null) return null;
\r
375 if (_attributeMembersArray != null) return _attributeMembersArray;
\r
377 _attributeMembersArray = new XmlTypeMapMemberAttribute[_attributeMembers.Count];
\r
378 foreach (XmlTypeMapMemberAttribute mem in _attributeMembers.Values)
\r
379 _attributeMembersArray [mem.Index] = mem;
\r
380 return _attributeMembersArray;
\r
384 public ICollection ElementMembers
\r
386 get { return _elementMembers; }
\r
389 public ArrayList AllMembers
\r
391 get { return _allMembers; }
\r
394 public ArrayList FlatLists
\r
396 get { return _flatLists; }
\r
399 public ArrayList MembersWithDefault
\r
401 get { return _membersWithDefault; }
\r
404 public ArrayList ListMembers
\r
406 get { return _listMembers; }
\r
409 public XmlTypeMapMember XmlTextCollector
\r
411 get { return _xmlTextCollector; }
\r
414 public XmlTypeMapMember ReturnMember
\r
416 get { return _returnMember; }
\r
419 public XmlQualifiedName SimpleContentBaseType
\r
423 if (!_canBeSimpleType || _elementMembers == null || _elementMembers.Count != 1) return null;
\r
424 XmlTypeMapMemberElement member = (XmlTypeMapMemberElement) _elementMembers[0];
\r
425 if (member.ElementInfo.Count != 1) return null;
\r
426 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) member.ElementInfo[0];
\r
427 if (!einfo.IsTextElement) return null;
\r
428 if (member.TypeData.SchemaType == SchemaTypes.Primitive || member.TypeData.SchemaType == SchemaTypes.Enum)
\r
429 return new XmlQualifiedName (einfo.TypeData.XmlType, einfo.DataTypeNamespace);
\r
434 public void SetCanBeSimpleType (bool can)
\r
436 _canBeSimpleType = can;
\r
439 public bool HasSimpleContent
\r
443 return SimpleContentBaseType != null;
\r
449 // Mapping info for arrays and lists
\r
451 internal class ListMap: ObjectMap
\r
453 XmlTypeMapElementInfoList _itemInfo;
\r
454 bool _gotNestedMapping;
\r
455 XmlTypeMapping _nestedArrayMapping;
456 string _choiceMember;
458 public bool IsMultiArray
\r
462 return (NestedArrayMapping != null);
\r
466 public string ChoiceMember
468 get { return _choiceMember; }
469 set { _choiceMember = value; }
472 public XmlTypeMapping NestedArrayMapping
\r
476 if (_gotNestedMapping) return _nestedArrayMapping;
\r
477 _gotNestedMapping = true;
\r
479 _nestedArrayMapping = ((XmlTypeMapElementInfo)_itemInfo[0]).MappedType;
\r
481 if (_nestedArrayMapping == null) return null;
\r
483 if (_nestedArrayMapping.TypeData.SchemaType != SchemaTypes.Array) {
\r
484 _nestedArrayMapping = null; return null;
\r
487 foreach (XmlTypeMapElementInfo elem in _itemInfo)
\r
488 if (elem.MappedType != _nestedArrayMapping) {
\r
489 _nestedArrayMapping = null;
\r
493 return _nestedArrayMapping;
\r
497 public XmlTypeMapElementInfoList ItemInfo
\r
500 get { return _itemInfo; }
\r
501 set { _itemInfo = value; }
\r
504 public XmlTypeMapElementInfo FindElement (object ob, int index, object memberValue)
\r
506 if (_itemInfo.Count == 1)
\r
507 return (XmlTypeMapElementInfo) _itemInfo[0];
\r
508 else if (_choiceMember != null && index != -1)
510 Array values = (Array) XmlTypeMapMember.GetValue (ob, _choiceMember);
511 if (values == null || index >= values.Length)
512 throw new InvalidOperationException ("Invalid or missing choice enum value in member '" + _choiceMember + "'.");
513 object val = values.GetValue (index);
514 foreach (XmlTypeMapElementInfo elem in _itemInfo)
515 if (elem.ChoiceValue != null && elem.ChoiceValue.Equals (val))
520 if (memberValue == null) return null;
\r
521 Type type = memberValue.GetType();
\r
522 foreach (XmlTypeMapElementInfo elem in _itemInfo)
\r
523 if (elem.TypeData.Type == type) return elem;
\r
528 public XmlTypeMapElementInfo FindElement (string elementName, string ns)
\r
530 foreach (XmlTypeMapElementInfo elem in _itemInfo)
\r
531 if (elem.ElementName == elementName && elem.Namespace == ns) return elem;
\r
535 public XmlTypeMapElementInfo FindTextElement ()
\r
537 foreach (XmlTypeMapElementInfo elem in _itemInfo)
\r
538 if (elem.IsTextElement) return elem;
\r
542 public string GetSchemaArrayName ()
\r
544 XmlTypeMapElementInfo einfo = (XmlTypeMapElementInfo) _itemInfo[0];
\r
545 if (einfo.MappedType != null) return TypeTranslator.GetArrayName (einfo.MappedType.XmlType);
\r
546 else return TypeTranslator.GetArrayName (einfo.TypeData.XmlType);
\r
549 public void GetArrayType (int itemCount, out string localName, out string ns)
\r
552 if (itemCount != -1) arrayDim = "[" + itemCount + "]";
\r
553 else arrayDim = "[]";
\r
555 XmlTypeMapElementInfo info = (XmlTypeMapElementInfo) _itemInfo[0];
\r
556 if (info.TypeData.SchemaType == SchemaTypes.Array)
\r
559 ((ListMap)info.MappedType.ObjectMap).GetArrayType (-1, out nm, out ns);
\r
560 localName = nm + arrayDim;
\r
564 if (info.MappedType != null)
\r
566 localName = info.MappedType.XmlType + arrayDim;
\r
567 ns = info.MappedType.Namespace;
\r
571 localName = info.TypeData.XmlType + arrayDim;
\r
572 ns = info.DataTypeNamespace;
\r
577 public override bool Equals (object other)
\r
579 ListMap lmap = other as ListMap;
\r
580 if (lmap == null) return false;
\r
582 if (_itemInfo.Count != lmap._itemInfo.Count) return false;
\r
583 for (int n=0; n<_itemInfo.Count; n++)
\r
584 if (!_itemInfo[n].Equals (lmap._itemInfo[n])) return false;
\r
588 public override int GetHashCode ()
\r
590 return base.GetHashCode ();
\r
594 internal class EnumMap: ObjectMap
\r
596 EnumMapMember[] _members;
\r
599 public class EnumMapMember
\r
603 string _documentation;
\r
605 public EnumMapMember (string xmlName, string enumName)
\r
607 _xmlName = xmlName;
\r
608 _enumName = enumName;
\r
611 public string XmlName
\r
613 get { return _xmlName; }
\r
616 public string EnumName
\r
618 get { return _enumName; }
\r
621 public string Documentation
\r
623 get { return _documentation; }
\r
624 set { _documentation = value; }
\r
628 public EnumMap (EnumMapMember[] members, bool isFlags)
\r
630 _members = members;
\r
631 _isFlags = isFlags;
\r
634 public bool IsFlags
\r
636 get { return _isFlags; }
\r
639 public EnumMapMember[] Members
\r
641 get { return _members; }
\r
644 public string GetXmlName (object enumValue)
\r
646 string enumName = enumValue.ToString();
\r
648 if (_isFlags && enumName.IndexOf (',') != -1)
\r
650 System.Text.StringBuilder sb = new System.Text.StringBuilder ();
\r
651 string[] enumNames = enumValue.ToString().Split (',');
\r
652 foreach (string name in enumNames)
\r
654 string tname = name.Trim();
\r
655 foreach (EnumMapMember mem in _members)
\r
656 if (mem.EnumName == tname) {
\r
657 sb.Append (mem.XmlName).Append (' ');
\r
661 sb.Remove (sb.Length-1, 1);
\r
662 return sb.ToString ();
\r
665 foreach (EnumMapMember mem in _members)
\r
666 if (mem.EnumName == enumName) return mem.XmlName;
\r
668 return Convert.ToInt64(enumValue).ToString(CultureInfo.InvariantCulture);
\r
671 public string GetEnumName (string xmlName)
\r
673 if (_isFlags && xmlName.Length == 0)
\r
676 if (_isFlags && xmlName.Trim().IndexOf (' ') != -1)
\r
678 System.Text.StringBuilder sb = new System.Text.StringBuilder ();
\r
679 string[] enumNames = xmlName.ToString().Split (' ');
\r
680 foreach (string name in enumNames)
\r
682 if (name == string.Empty) continue;
\r
683 string foundEnumValue = null;
\r
684 foreach (EnumMapMember mem in _members)
\r
685 if (mem.XmlName == name) { foundEnumValue = mem.EnumName; break; }
\r
687 if (foundEnumValue != null) sb.Append (foundEnumValue).Append (',');
\r
690 sb.Remove (sb.Length-1, 1);
\r
691 return sb.ToString ();
\r
694 foreach (EnumMapMember mem in _members)
\r
695 if (mem.XmlName == xmlName) return mem.EnumName;
\r