2 // Copyright (C) 2010 Novell Inc. http://novell.com
4 // Permission is hereby granted, free of charge, to any person obtaining
5 // a copy of this software and associated documentation files (the
6 // "Software"), to deal in the Software without restriction, including
7 // without limitation the rights to use, copy, modify, merge, publish,
8 // distribute, sublicense, and/or sell copies of the Software, and to
9 // permit persons to whom the Software is furnished to do so, subject to
10 // the following conditions:
12 // The above copyright notice and this permission notice shall be
13 // included in all copies or substantial portions of the Software.
15 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
16 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
17 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
18 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
19 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
20 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
21 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 using System.Collections;
25 using System.Collections.Generic;
26 using System.ComponentModel;
28 using System.Reflection;
29 using System.Windows.Markup;
30 using System.Xaml.Schema;
34 public class XamlType : IEquatable<XamlType>
36 public XamlType (Type underlyingType, XamlSchemaContext schemaContext)
37 : this (underlyingType, schemaContext, null)
41 // static readonly Type [] predefined_types = {
42 // typeof (XData), typeof (Uri), typeof (TimeSpan), typeof (PropertyDefinition), typeof (MemberDefinition), typeof (Reference)
45 public XamlType (Type underlyingType, XamlSchemaContext schemaContext, XamlTypeInvoker invoker)
46 : this (schemaContext, invoker)
48 if (underlyingType == null)
49 throw new ArgumentNullException ("underlyingType");
50 type = underlyingType;
51 underlying_type = type;
54 if (XamlLanguage.InitializingTypes) {
55 Name = type.GetXamlName ();
56 PreferredXamlNamespace = XamlLanguage.Xaml2006Namespace;
57 } else if ((xt = XamlLanguage.AllTypes.FirstOrDefault (t => t.UnderlyingType == type)) != null) {
59 PreferredXamlNamespace = XamlLanguage.Xaml2006Namespace;
61 Name = type.GetXamlName ();
62 PreferredXamlNamespace = String.Format ("clr-namespace:{0};assembly={1}", type.Namespace, type.Assembly.GetName ().Name);
66 public XamlType (string unknownTypeNamespace, string unknownTypeName, IList<XamlType> typeArguments, XamlSchemaContext schemaContext)
67 : this (schemaContext, null)
69 if (unknownTypeNamespace == null)
70 throw new ArgumentNullException ("unknownTypeNamespace");
71 if (unknownTypeName == null)
72 throw new ArgumentNullException ("unknownTypeName");
73 if (schemaContext == null)
74 throw new ArgumentNullException ("schemaContext");
76 type = typeof (object);
77 Name = unknownTypeName;
78 PreferredXamlNamespace = unknownTypeNamespace;
79 TypeArguments = typeArguments != null && typeArguments.Count == 0 ? null : typeArguments;
80 explicit_ns = unknownTypeNamespace;
83 protected XamlType (string typeName, IList<XamlType> typeArguments, XamlSchemaContext schemaContext)
84 : this (String.Empty, typeName, typeArguments, schemaContext)
88 XamlType (XamlSchemaContext schemaContext, XamlTypeInvoker invoker)
90 if (schemaContext == null)
91 throw new ArgumentNullException ("schemaContext");
92 SchemaContext = schemaContext;
93 this.invoker = invoker ?? new XamlTypeInvoker (this);
96 Type type, underlying_type;
100 // populated properties
102 XamlTypeInvoker invoker;
104 internal EventHandler<XamlSetMarkupExtensionEventArgs> SetMarkupExtensionHandler {
105 get { return LookupSetMarkupExtensionHandler (); }
108 internal EventHandler<XamlSetTypeConverterEventArgs> SetTypeConverterHandler {
109 get { return LookupSetTypeConverterHandler (); }
112 public IList<XamlType> AllowedContentTypes {
113 get { return LookupAllowedContentTypes (); }
116 public XamlType BaseType {
117 get { return LookupBaseType (); }
120 public bool ConstructionRequiresArguments {
121 get { return LookupConstructionRequiresArguments (); }
124 public XamlMember ContentProperty {
125 get { return LookupContentProperty (); }
128 public IList<XamlType> ContentWrappers {
129 get { return LookupContentWrappers (); }
132 public XamlValueConverter<XamlDeferringLoader> DeferringLoader {
133 get { return LookupDeferringLoader (); }
136 public XamlTypeInvoker Invoker {
137 get { return LookupInvoker (); }
140 public bool IsAmbient {
141 get { return LookupIsAmbient (); }
144 public bool IsArray {
145 get { return LookupCollectionKind () == XamlCollectionKind.Array; }
148 // it somehow treats array as not a collection...
149 public bool IsCollection {
150 get { return LookupCollectionKind () == XamlCollectionKind.Collection; }
153 public bool IsConstructible {
154 get { return LookupIsConstructible (); }
157 public bool IsDictionary {
158 get { return LookupCollectionKind () == XamlCollectionKind.Dictionary; }
161 public bool IsGeneric {
162 get { return type.IsGenericType; }
165 public bool IsMarkupExtension {
166 get { return LookupIsMarkupExtension (); }
168 public bool IsNameScope {
169 get { return LookupIsNameScope (); }
171 public bool IsNameValid {
172 get { return XamlLanguage.IsValidXamlName (Name); }
175 public bool IsNullable {
176 get { return LookupIsNullable (); }
179 public bool IsPublic {
180 get { return LookupIsPublic (); }
183 public bool IsUnknown {
184 get { return LookupIsUnknown (); }
187 public bool IsUsableDuringInitialization {
188 get { return LookupUsableDuringInitialization (); }
191 public bool IsWhitespaceSignificantCollection {
192 get { return LookupIsWhitespaceSignificantCollection (); }
195 public bool IsXData {
196 get { return LookupIsXData (); }
199 public XamlType ItemType {
200 get { return LookupItemType (); }
203 public XamlType KeyType {
204 get { return LookupKeyType (); }
207 public XamlType MarkupExtensionReturnType {
208 get { return LookupMarkupExtensionReturnType (); }
211 public string Name { get; private set; }
213 public string PreferredXamlNamespace { get; private set; }
215 public XamlSchemaContext SchemaContext { get; private set; }
217 public bool TrimSurroundingWhitespace {
218 get { return LookupTrimSurroundingWhitespace (); }
221 public IList<XamlType> TypeArguments { get; private set; }
223 public XamlValueConverter<TypeConverter> TypeConverter {
224 get { return LookupTypeConverter (); }
227 public Type UnderlyingType {
228 get { return LookupUnderlyingType (); }
231 public XamlValueConverter<ValueSerializer> ValueSerializer {
232 get { return LookupValueSerializer (); }
235 internal string InternalXmlName {
237 var stn = XamlLanguage.SpecialNames.FirstOrDefault (s => s.Type == this);
238 return stn != null ? stn.Name : Name;
242 public static bool operator == (XamlType left, XamlType right)
244 return IsNull (left) ? IsNull (right) : left.Equals (right);
247 static bool IsNull (XamlType a)
249 return Object.ReferenceEquals (a, null);
252 public static bool operator != (XamlType left, XamlType right)
254 return !(left == right);
257 public bool Equals (XamlType other)
259 return !IsNull (other) &&
260 UnderlyingType == other.UnderlyingType &&
261 Name == other.Name &&
262 PreferredXamlNamespace == other.PreferredXamlNamespace && TypeArguments.ListEquals (other.TypeArguments);
265 public override bool Equals (object obj)
267 var a = obj as XamlType;
271 public override int GetHashCode ()
273 if (UnderlyingType != null)
274 return UnderlyingType.GetHashCode ();
275 int x = Name.GetHashCode () << 7 + PreferredXamlNamespace.GetHashCode ();
276 if (TypeArguments != null)
277 foreach (var t in TypeArguments)
278 x = t.GetHashCode () + x << 5;
282 public override string ToString ()
284 return String.IsNullOrEmpty (PreferredXamlNamespace) ? Name : String.Concat ("{", PreferredXamlNamespace, "}", Name);
287 public virtual bool CanAssignTo (XamlType xamlType)
289 throw new NotImplementedException ();
292 public XamlMember GetAliasedProperty (XamlDirective directive)
294 return LookupAliasedProperty (directive);
297 public ICollection<XamlMember> GetAllAttachableMembers ()
299 return new List<XamlMember> (LookupAllAttachableMembers ());
302 public ICollection<XamlMember> GetAllMembers ()
304 return new List<XamlMember> (LookupAllMembers ());
307 public XamlMember GetAttachableMember (string name)
309 return LookupAttachableMember (name);
312 public XamlMember GetMember (string name)
314 return LookupMember (name, false);
317 public IList<XamlType> GetPositionalParameters (int parameterCount)
319 return LookupPositionalParameters (parameterCount);
322 public virtual IList<string> GetXamlNamespaces ()
324 throw new NotImplementedException ();
325 /* this does not work like documented!
326 if (explicit_ns != null)
327 return new string [] {explicit_ns};
328 var l = SchemaContext.GetAllXamlNamespaces ();
330 return new List<string> (l);
331 return new string [] {String.Empty};
337 protected virtual XamlMember LookupAliasedProperty (XamlDirective directive)
339 if (directive == XamlLanguage.Key) {
340 var a = this.GetCustomAttribute<DictionaryKeyPropertyAttribute> ();
341 return a != null ? GetMember (a.Name) : null;
343 if (directive == XamlLanguage.Name) {
344 var a = this.GetCustomAttribute<RuntimeNamePropertyAttribute> ();
345 return a != null ? GetMember (a.Name) : null;
347 if (directive == XamlLanguage.Uid) {
348 var a = this.GetCustomAttribute<UidPropertyAttribute> ();
349 return a != null ? GetMember (a.Name) : null;
351 if (directive == XamlLanguage.Lang) {
352 var a = this.GetCustomAttribute<XmlLangPropertyAttribute> ();
353 return a != null ? GetMember (a.Name) : null;
358 protected virtual IEnumerable<XamlMember> LookupAllAttachableMembers ()
360 if (UnderlyingType == null)
361 return BaseType != null ? BaseType.GetAllAttachableMembers () : null;
362 return DoLookupAllAttachableMembers ();
365 IEnumerable<XamlMember> DoLookupAllAttachableMembers ()
367 yield break; // FIXME: what to return here?
370 static readonly XamlMember [] empty_array = new XamlMember [0];
372 protected virtual IEnumerable<XamlMember> LookupAllMembers ()
374 if (UnderlyingType == null)
375 return BaseType != null ? BaseType.GetAllMembers () : empty_array;
376 if (all_members_cache == null) {
377 all_members_cache = new List<XamlMember> (DoLookupAllMembers ());
378 all_members_cache.Sort (CompareMembers);
380 return all_members_cache;
383 int CompareMembers (XamlMember m1, XamlMember m2)
385 // ContentProperty is returned at last.
386 if (m1.DeclaringType.ContentProperty == m1)
388 else if (m2.DeclaringType.ContentProperty == m2)
391 // then, compare names.
392 return String.CompareOrdinal (m1.Name, m2.Name);
395 List<XamlMember> all_members_cache;
397 IEnumerable<XamlMember> DoLookupAllMembers ()
399 // This is a hack that is likely required due to internal implementation difference in System.Uri. Our Uri has two readonly collection properties
400 if (this == XamlLanguage.Uri)
403 var bf = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance;
405 foreach (var pi in UnderlyingType.GetProperties (bf))
406 if (pi.CanRead && (pi.CanWrite && pi.GetIndexParameters ().Length == 0 || IsCollectionType (pi.PropertyType)))
407 yield return new XamlMember (pi, SchemaContext);
408 foreach (var ei in UnderlyingType.GetEvents (bf))
409 yield return new XamlMember (ei, SchemaContext);
412 static bool IsCollectionType (Type type)
419 Type [] ifaces = type.GetInterfaces ();
420 foreach (Type i in ifaces)
421 if (i.IsGenericType && i.GetGenericTypeDefinition ().Equals (typeof (ICollection<>)))
423 foreach (Type i in ifaces)
424 if (i == typeof (IList))
427 foreach (var iface in type.GetInterfaces ())
428 if (iface == typeof (IDictionary) || (iface.IsGenericType && iface.GetGenericTypeDefinition () == typeof (IDictionary<,>)))
434 protected virtual IList<XamlType> LookupAllowedContentTypes ()
436 // the actual implementation is very different from what is documented :(
440 var l = new List<XamlType> ();
441 if (ContentWrappers != null)
442 l.AddRange (ContentWrappers);
443 if (ContentProperty != null)
444 l.Add (ContentProperty.Type);
445 if (ItemType != null)
447 return l.Count > 0 ? l : null;
451 protected virtual XamlMember LookupAttachableMember (string name)
453 throw new NotImplementedException ();
457 protected virtual XamlType LookupBaseType ()
459 if (base_type == null) {
460 if (UnderlyingType == null)
461 // FIXME: probably something advanced is needed here.
462 base_type = new XamlType (typeof (object), SchemaContext, Invoker);
464 base_type = type.BaseType == null || type.BaseType == typeof (object) ? null : new XamlType (type.BaseType, SchemaContext, Invoker);
469 // This implementation is not verified. (No place to use.)
470 protected virtual XamlCollectionKind LookupCollectionKind ()
472 if (UnderlyingType == null)
473 return BaseType != null ? BaseType.LookupCollectionKind () : XamlCollectionKind.None;
475 return XamlCollectionKind.Array;
477 if (type.ImplementsAnyInterfacesOf (typeof (IDictionary), typeof (IDictionary<,>)))
478 return XamlCollectionKind.Dictionary;
480 if (type.ImplementsAnyInterfacesOf (typeof (ICollection), typeof (ICollection<>)))
481 return XamlCollectionKind.Collection;
483 return XamlCollectionKind.None;
486 protected virtual bool LookupConstructionRequiresArguments ()
488 if (UnderlyingType == null)
491 // not sure if it is required, but MemberDefinition return true while they are abstract and it makes no sense.
492 if (UnderlyingType.IsAbstract)
495 // FIXME: probably some primitive types are treated as special.
496 switch (Type.GetTypeCode (UnderlyingType)) {
497 case TypeCode.String:
499 case TypeCode.Object:
500 if (UnderlyingType == typeof (TimeSpan))
507 return UnderlyingType.GetConstructor (BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance, null, Type.EmptyTypes, null) == null;
510 protected virtual XamlMember LookupContentProperty ()
512 var a = this.GetCustomAttribute<ContentPropertyAttribute> ();
513 return a != null && a.Name != null ? GetMember (a.Name) : null;
516 protected virtual IList<XamlType> LookupContentWrappers ()
518 if (GetCustomAttributeProvider () == null)
521 var arr = GetCustomAttributeProvider ().GetCustomAttributes (typeof (ContentWrapperAttribute), false);
522 if (arr == null || arr.Length == 0)
524 var l = new XamlType [arr.Length];
525 for (int i = 0; i < l.Length; i++)
526 l [i] = SchemaContext.GetXamlType (((ContentWrapperAttribute) arr [i]).ContentWrapper);
530 internal ICustomAttributeProvider GetCustomAttributeProvider ()
532 return LookupCustomAttributeProvider ();
535 protected internal virtual ICustomAttributeProvider LookupCustomAttributeProvider ()
537 return UnderlyingType;
540 protected virtual XamlValueConverter<XamlDeferringLoader> LookupDeferringLoader ()
542 throw new NotImplementedException ();
545 protected virtual XamlTypeInvoker LookupInvoker ()
550 protected virtual bool LookupIsAmbient ()
552 return this.GetCustomAttribute<AmbientAttribute> () != null;
555 // It is documented as if it were to reflect spec. section 5.2,
556 // but the actual behavior shows it is *totally* wrong.
557 // Here I have implemented this based on the nunit test results. sigh.
558 protected virtual bool LookupIsConstructible ()
560 if (UnderlyingType == null)
562 if (IsMarkupExtension)
564 if (UnderlyingType.IsAbstract)
571 protected virtual bool LookupIsMarkupExtension ()
573 return typeof (MarkupExtension).IsAssignableFrom (UnderlyingType);
576 protected virtual bool LookupIsNameScope ()
578 return typeof (INameScope).IsAssignableFrom (UnderlyingType);
581 protected virtual bool LookupIsNullable ()
583 return !type.IsValueType || type.ImplementsInterface (typeof (Nullable<>));
586 protected virtual bool LookupIsPublic ()
588 return underlying_type == null || underlying_type.IsPublic || underlying_type.IsNestedPublic;
591 protected virtual bool LookupIsUnknown ()
593 return UnderlyingType == null;
596 protected virtual bool LookupIsWhitespaceSignificantCollection ()
598 // probably for unknown types, it should preserve whitespaces.
599 return IsUnknown || this.GetCustomAttribute<WhitespaceSignificantCollectionAttribute> () != null;
602 protected virtual bool LookupIsXData ()
604 // huh? XamlLanguage.XData.IsXData returns false(!)
605 // return typeof (XData).IsAssignableFrom (UnderlyingType);
609 protected virtual XamlType LookupItemType ()
612 return new XamlType (type.GetElementType (), SchemaContext);
615 return new XamlType (typeof (object), SchemaContext);
616 return new XamlType (type.GetGenericArguments () [1], SchemaContext);
621 return new XamlType (typeof (object), SchemaContext);
622 return new XamlType (type.GetGenericArguments () [0], SchemaContext);
625 protected virtual XamlType LookupKeyType ()
630 return new XamlType (typeof (object), SchemaContext);
631 return new XamlType (type.GetGenericArguments () [0], SchemaContext);
634 protected virtual XamlType LookupMarkupExtensionReturnType ()
636 var a = this.GetCustomAttribute<MarkupExtensionReturnTypeAttribute> ();
637 return a != null ? new XamlType (a.ReturnType, SchemaContext) : null;
640 protected virtual XamlMember LookupMember (string name, bool skipReadOnlyCheck)
642 // FIXME: verify if this does not filter out events.
643 return GetAllMembers ().FirstOrDefault (m => m.Name == name && (skipReadOnlyCheck || !m.IsReadOnly || m.Type.IsCollection || m.Type.IsDictionary || m.Type.IsArray));
646 protected virtual IList<XamlType> LookupPositionalParameters (int parameterCount)
648 if (UnderlyingType == null/* || !IsMarkupExtension*/) // see nunit tests...
651 // check if there is applicable ConstructorArgumentAttribute.
652 // If there is, then return its type.
653 if (parameterCount == 1) {
654 foreach (var xm in GetAllMembers ()) {
655 var ca = xm.GetCustomAttributeProvider ().GetCustomAttribute<ConstructorArgumentAttribute> (false);
657 return new XamlType [] {xm.Type};
661 var methods = (from m in UnderlyingType.GetConstructors (BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) where m.GetParameters ().Length == parameterCount select m).ToArray ();
662 if (methods.Length == 1)
663 return (from p in methods [0].GetParameters () select SchemaContext.GetXamlType (p.ParameterType)).ToArray ();
665 if (SchemaContext.SupportMarkupExtensionsWithDuplicateArity)
666 throw new NotSupportedException ("The default LookupPositionalParameters implementation does not allow duplicate arity of markup extensions");
670 BindingFlags flags_get_static = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static;
672 protected virtual EventHandler<XamlSetMarkupExtensionEventArgs> LookupSetMarkupExtensionHandler ()
674 var a = this.GetCustomAttribute<XamlSetMarkupExtensionAttribute> ();
677 var mi = type.GetMethod (a.XamlSetMarkupExtensionHandler, flags_get_static);
679 throw new ArgumentException ("Binding to XamlSetMarkupExtensionHandler failed");
680 return (EventHandler<XamlSetMarkupExtensionEventArgs>) Delegate.CreateDelegate (typeof (EventHandler<XamlSetMarkupExtensionEventArgs>), mi);
683 protected virtual EventHandler<XamlSetTypeConverterEventArgs> LookupSetTypeConverterHandler ()
685 var a = this.GetCustomAttribute<XamlSetTypeConverterAttribute> ();
688 var mi = type.GetMethod (a.XamlSetTypeConverterHandler, flags_get_static);
690 throw new ArgumentException ("Binding to XamlSetTypeConverterHandler failed");
691 return (EventHandler<XamlSetTypeConverterEventArgs>) Delegate.CreateDelegate (typeof (EventHandler<XamlSetTypeConverterEventArgs>), mi);
694 protected virtual bool LookupTrimSurroundingWhitespace ()
696 return this.GetCustomAttribute<TrimSurroundingWhitespaceAttribute> () != null;
699 protected virtual XamlValueConverter<TypeConverter> LookupTypeConverter ()
701 var t = UnderlyingType;
705 // equivalent to TypeExtension.
706 // FIXME: not sure if it should be specially handled here.
707 if (t == typeof (Type))
708 t = typeof (TypeExtension);
710 var a = GetCustomAttributeProvider ().GetCustomAttribute<TypeConverterAttribute> (false);
712 return SchemaContext.GetValueConverter<TypeConverter> (Type.GetType (a.ConverterTypeName), this);
714 if (t == typeof (object))
715 return SchemaContext.GetValueConverter<TypeConverter> (typeof (TypeConverter), this);
717 // It's still not decent to check CollectionConverter.
718 var tct = TypeDescriptor.GetConverter (t).GetType ();
719 if (tct != typeof (TypeConverter) && tct != typeof (CollectionConverter) && tct != typeof (ReferenceConverter))
720 return SchemaContext.GetValueConverter<TypeConverter> (tct, this);
724 protected virtual Type LookupUnderlyingType ()
726 return underlying_type;
729 protected virtual bool LookupUsableDuringInitialization ()
731 var a = this.GetCustomAttribute<UsableDuringInitializationAttribute> ();
732 return a != null && a.Usable;
735 static XamlValueConverter<ValueSerializer> string_value_serializer;
737 protected virtual XamlValueConverter<ValueSerializer> LookupValueSerializer ()
739 return LookupValueSerializer (this, GetCustomAttributeProvider ());
742 internal static XamlValueConverter<ValueSerializer> LookupValueSerializer (XamlType targetType, ICustomAttributeProvider provider)
744 if (provider == null)
747 var a = provider.GetCustomAttribute<ValueSerializerAttribute> (true);
749 return new XamlValueConverter<ValueSerializer> (a.ValueSerializerType ?? Type.GetType (a.ValueSerializerTypeName), targetType);
751 if (targetType.BaseType != null) {
752 var ret = targetType.BaseType.LookupValueSerializer ();
757 if (targetType.UnderlyingType == typeof (string)) {
758 if (string_value_serializer == null)
759 string_value_serializer = new XamlValueConverter<ValueSerializer> (typeof (StringValueSerializer), targetType);
760 return string_value_serializer;