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 // These are special. Only XamlLanguage members are with shorthand name.
56 if (type == typeof (PropertyDefinition))
58 else if (type == typeof (MemberDefinition))
61 Name = GetXamlName (type);
62 PreferredXamlNamespace = XamlLanguage.Xaml2006Namespace;
63 } else if ((xt = XamlLanguage.AllTypes.FirstOrDefault (t => t.UnderlyingType == type)) != null) {
65 PreferredXamlNamespace = XamlLanguage.Xaml2006Namespace;
67 Name = GetXamlName (type);
68 PreferredXamlNamespace = String.Format ("clr-namespace:{0};assembly={1}", type.Namespace, type.Assembly.GetName ().Name);
70 if (type.IsGenericType) {
71 TypeArguments = new List<XamlType> ();
72 foreach (var gta in type.GetGenericArguments ())
73 TypeArguments.Add (schemaContext.GetXamlType (gta));
77 public XamlType (string unknownTypeNamespace, string unknownTypeName, IList<XamlType> typeArguments, XamlSchemaContext schemaContext)
78 : this (schemaContext, null)
80 if (unknownTypeNamespace == null)
81 throw new ArgumentNullException ("unknownTypeNamespace");
82 if (unknownTypeName == null)
83 throw new ArgumentNullException ("unknownTypeName");
84 if (schemaContext == null)
85 throw new ArgumentNullException ("schemaContext");
87 type = typeof (object);
88 Name = unknownTypeName;
89 PreferredXamlNamespace = unknownTypeNamespace;
90 TypeArguments = typeArguments != null && typeArguments.Count == 0 ? null : typeArguments;
91 explicit_ns = unknownTypeNamespace;
94 protected XamlType (string typeName, IList<XamlType> typeArguments, XamlSchemaContext schemaContext)
95 : this (String.Empty, typeName, typeArguments, schemaContext)
99 XamlType (XamlSchemaContext schemaContext, XamlTypeInvoker invoker)
101 if (schemaContext == null)
102 throw new ArgumentNullException ("schemaContext");
103 SchemaContext = schemaContext;
104 this.invoker = invoker ?? new XamlTypeInvoker (this);
107 Type type, underlying_type;
111 // populated properties
113 XamlTypeInvoker invoker;
115 internal EventHandler<XamlSetMarkupExtensionEventArgs> SetMarkupExtensionHandler {
116 get { return LookupSetMarkupExtensionHandler (); }
119 internal EventHandler<XamlSetTypeConverterEventArgs> SetTypeConverterHandler {
120 get { return LookupSetTypeConverterHandler (); }
123 public IList<XamlType> AllowedContentTypes {
124 get { return LookupAllowedContentTypes (); }
127 public XamlType BaseType {
128 get { return LookupBaseType (); }
131 public bool ConstructionRequiresArguments {
132 get { return LookupConstructionRequiresArguments (); }
135 public XamlMember ContentProperty {
136 get { return LookupContentProperty (); }
139 public IList<XamlType> ContentWrappers {
140 get { return LookupContentWrappers (); }
143 public XamlValueConverter<XamlDeferringLoader> DeferringLoader {
144 get { return LookupDeferringLoader (); }
147 public XamlTypeInvoker Invoker {
148 get { return LookupInvoker (); }
151 public bool IsAmbient {
152 get { return LookupIsAmbient (); }
155 public bool IsArray {
156 get { return LookupCollectionKind () == XamlCollectionKind.Array; }
159 // it somehow treats array as not a collection...
160 public bool IsCollection {
161 get { return LookupCollectionKind () == XamlCollectionKind.Collection; }
164 public bool IsConstructible {
165 get { return LookupIsConstructible (); }
168 public bool IsDictionary {
169 get { return LookupCollectionKind () == XamlCollectionKind.Dictionary; }
172 public bool IsGeneric {
173 get { return type.IsGenericType; }
176 public bool IsMarkupExtension {
177 get { return LookupIsMarkupExtension (); }
179 public bool IsNameScope {
180 get { return LookupIsNameScope (); }
182 public bool IsNameValid {
183 get { return XamlLanguage.IsValidXamlName (Name); }
186 public bool IsNullable {
187 get { return LookupIsNullable (); }
190 public bool IsPublic {
191 get { return LookupIsPublic (); }
194 public bool IsUnknown {
195 get { return LookupIsUnknown (); }
198 public bool IsUsableDuringInitialization {
199 get { return LookupUsableDuringInitialization (); }
202 public bool IsWhitespaceSignificantCollection {
203 get { return LookupIsWhitespaceSignificantCollection (); }
206 public bool IsXData {
207 get { return LookupIsXData (); }
210 public XamlType ItemType {
211 get { return LookupItemType (); }
214 public XamlType KeyType {
215 get { return LookupKeyType (); }
218 public XamlType MarkupExtensionReturnType {
219 get { return LookupMarkupExtensionReturnType (); }
222 public string Name { get; private set; }
224 public string PreferredXamlNamespace { get; private set; }
226 public XamlSchemaContext SchemaContext { get; private set; }
228 public bool TrimSurroundingWhitespace {
229 get { return LookupTrimSurroundingWhitespace (); }
232 public IList<XamlType> TypeArguments { get; private set; }
234 public XamlValueConverter<TypeConverter> TypeConverter {
235 get { return LookupTypeConverter (); }
238 public Type UnderlyingType {
239 get { return LookupUnderlyingType (); }
242 public XamlValueConverter<ValueSerializer> ValueSerializer {
243 get { return LookupValueSerializer (); }
246 internal string GetInternalXmlName ()
248 if (IsMarkupExtension && Name.EndsWith ("Extension", StringComparison.Ordinal))
249 return Name.Substring (0, Name.Length - 9);
250 var stn = XamlLanguage.SpecialNames.FirstOrDefault (s => s.Type == this);
251 return stn != null ? stn.Name : Name;
254 public static bool operator == (XamlType left, XamlType right)
256 return IsNull (left) ? IsNull (right) : left.Equals (right);
259 static bool IsNull (XamlType a)
261 return Object.ReferenceEquals (a, null);
264 public static bool operator != (XamlType left, XamlType right)
266 return !(left == right);
269 public bool Equals (XamlType other)
271 // It does not compare XamlSchemaContext.
272 return !IsNull (other) &&
273 UnderlyingType == other.UnderlyingType &&
274 Name == other.Name &&
275 PreferredXamlNamespace == other.PreferredXamlNamespace && TypeArguments.ListEquals (other.TypeArguments);
278 public override bool Equals (object obj)
280 var a = obj as XamlType;
284 public override int GetHashCode ()
286 if (UnderlyingType != null)
287 return UnderlyingType.GetHashCode ();
288 int x = Name.GetHashCode () << 7 + PreferredXamlNamespace.GetHashCode ();
289 if (TypeArguments != null)
290 foreach (var t in TypeArguments)
291 x = t.GetHashCode () + x << 5;
295 public override string ToString ()
297 return new XamlTypeName (this).ToString ();
298 //return String.IsNullOrEmpty (PreferredXamlNamespace) ? Name : String.Concat ("{", PreferredXamlNamespace, "}", Name);
301 public virtual bool CanAssignTo (XamlType xamlType)
303 if (this.UnderlyingType == null)
305 var ut = xamlType.UnderlyingType ?? typeof (object);
306 return ut.IsAssignableFrom (UnderlyingType);
309 public XamlMember GetAliasedProperty (XamlDirective directive)
311 return LookupAliasedProperty (directive);
314 public ICollection<XamlMember> GetAllAttachableMembers ()
316 return new List<XamlMember> (LookupAllAttachableMembers ());
319 public ICollection<XamlMember> GetAllMembers ()
321 return new List<XamlMember> (LookupAllMembers ());
324 public XamlMember GetAttachableMember (string name)
326 return LookupAttachableMember (name);
329 public XamlMember GetMember (string name)
331 return LookupMember (name, true);
334 public IList<XamlType> GetPositionalParameters (int parameterCount)
336 return LookupPositionalParameters (parameterCount);
339 public virtual IList<string> GetXamlNamespaces ()
341 throw new NotImplementedException ();
342 /* this does not work like documented!
343 if (explicit_ns != null)
344 return new string [] {explicit_ns};
345 var l = SchemaContext.GetAllXamlNamespaces ();
347 return new List<string> (l);
348 return new string [] {String.Empty};
354 protected virtual XamlMember LookupAliasedProperty (XamlDirective directive)
356 if (directive == XamlLanguage.Key) {
357 var a = this.GetCustomAttribute<DictionaryKeyPropertyAttribute> ();
358 return a != null ? GetMember (a.Name) : null;
360 if (directive == XamlLanguage.Name) {
361 var a = this.GetCustomAttribute<RuntimeNamePropertyAttribute> ();
362 return a != null ? GetMember (a.Name) : null;
364 if (directive == XamlLanguage.Uid) {
365 var a = this.GetCustomAttribute<UidPropertyAttribute> ();
366 return a != null ? GetMember (a.Name) : null;
368 if (directive == XamlLanguage.Lang) {
369 var a = this.GetCustomAttribute<XmlLangPropertyAttribute> ();
370 return a != null ? GetMember (a.Name) : null;
375 protected virtual IEnumerable<XamlMember> LookupAllAttachableMembers ()
377 if (UnderlyingType == null)
378 return BaseType != null ? BaseType.GetAllAttachableMembers () : null;
379 return DoLookupAllAttachableMembers ();
382 IEnumerable<XamlMember> DoLookupAllAttachableMembers ()
384 yield break; // FIXME: what to return here?
387 static readonly XamlMember [] empty_array = new XamlMember [0];
389 protected virtual IEnumerable<XamlMember> LookupAllMembers ()
391 if (UnderlyingType == null)
392 return BaseType != null ? BaseType.GetAllMembers () : empty_array;
393 if (all_members_cache == null) {
394 all_members_cache = new List<XamlMember> (DoLookupAllMembers ());
395 all_members_cache.Sort (TypeExtensionMethods.CompareMembers);
397 return all_members_cache;
400 List<XamlMember> all_members_cache;
402 IEnumerable<XamlMember> DoLookupAllMembers ()
404 // This is a hack that is likely required due to internal implementation difference in System.Uri. Our Uri has two readonly collection properties
405 if (this == XamlLanguage.Uri)
408 var bf = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance;
410 foreach (var pi in UnderlyingType.GetProperties (bf))
411 if (pi.CanRead && (pi.CanWrite || IsCollectionType (pi.PropertyType)) && pi.GetIndexParameters ().Length == 0)
412 yield return new XamlMember (pi, SchemaContext);
413 foreach (var ei in UnderlyingType.GetEvents (bf))
414 yield return new XamlMember (ei, SchemaContext);
417 static bool IsPublicAccessor (MethodInfo mi)
419 return mi != null && mi.IsPublic;
422 bool IsCollectionType (Type type)
426 var xt = SchemaContext.GetXamlType (type);
427 return xt.LookupCollectionKind () != XamlCollectionKind.None;
430 protected virtual IList<XamlType> LookupAllowedContentTypes ()
432 // the actual implementation is very different from what is documented :(
436 var l = new List<XamlType> ();
437 if (ContentWrappers != null)
438 l.AddRange (ContentWrappers);
439 if (ContentProperty != null)
440 l.Add (ContentProperty.Type);
441 if (ItemType != null)
443 return l.Count > 0 ? l : null;
447 protected virtual XamlMember LookupAttachableMember (string name)
449 throw new NotImplementedException ();
453 protected virtual XamlType LookupBaseType ()
455 if (base_type == null) {
456 if (UnderlyingType == null)
457 // FIXME: probably something advanced is needed here.
458 base_type = new XamlType (typeof (object), SchemaContext, Invoker);
460 base_type = type.BaseType == null || type.BaseType == typeof (object) ? null : new XamlType (type.BaseType, SchemaContext, Invoker);
465 // This implementation is not verified. (No place to use.)
466 protected virtual XamlCollectionKind LookupCollectionKind ()
468 if (UnderlyingType == null)
469 return BaseType != null ? BaseType.LookupCollectionKind () : XamlCollectionKind.None;
471 return XamlCollectionKind.Array;
473 if (type.ImplementsAnyInterfacesOf (typeof (IDictionary), typeof (IDictionary<,>)))
474 return XamlCollectionKind.Dictionary;
476 if (type.ImplementsAnyInterfacesOf (typeof (IList), typeof (ICollection<>)))
477 return XamlCollectionKind.Collection;
479 return XamlCollectionKind.None;
482 protected virtual bool LookupConstructionRequiresArguments ()
484 if (UnderlyingType == null)
487 // not sure if it is required, but MemberDefinition return true while they are abstract and it makes no sense.
488 if (UnderlyingType.IsAbstract)
491 // FIXME: probably some primitive types are treated as special.
492 switch (Type.GetTypeCode (UnderlyingType)) {
493 case TypeCode.String:
495 case TypeCode.Object:
496 if (UnderlyingType == typeof (TimeSpan))
503 return UnderlyingType.GetConstructor (BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance, null, Type.EmptyTypes, null) == null;
506 protected virtual XamlMember LookupContentProperty ()
508 var a = this.GetCustomAttribute<ContentPropertyAttribute> ();
509 return a != null && a.Name != null ? GetMember (a.Name) : null;
512 protected virtual IList<XamlType> LookupContentWrappers ()
514 if (GetCustomAttributeProvider () == null)
517 var arr = GetCustomAttributeProvider ().GetCustomAttributes (typeof (ContentWrapperAttribute), false);
518 if (arr == null || arr.Length == 0)
520 var l = new XamlType [arr.Length];
521 for (int i = 0; i < l.Length; i++)
522 l [i] = SchemaContext.GetXamlType (((ContentWrapperAttribute) arr [i]).ContentWrapper);
526 internal ICustomAttributeProvider GetCustomAttributeProvider ()
528 return LookupCustomAttributeProvider ();
531 protected internal virtual ICustomAttributeProvider LookupCustomAttributeProvider ()
533 return UnderlyingType;
536 protected virtual XamlValueConverter<XamlDeferringLoader> LookupDeferringLoader ()
538 throw new NotImplementedException ();
541 protected virtual XamlTypeInvoker LookupInvoker ()
546 protected virtual bool LookupIsAmbient ()
548 return this.GetCustomAttribute<AmbientAttribute> () != null;
551 // It is documented as if it were to reflect spec. section 5.2,
552 // but the actual behavior shows it is *totally* wrong.
553 // Here I have implemented this based on the nunit test results. sigh.
554 protected virtual bool LookupIsConstructible ()
556 if (UnderlyingType == null)
558 if (IsMarkupExtension)
560 if (UnderlyingType.IsAbstract)
567 protected virtual bool LookupIsMarkupExtension ()
569 return typeof (MarkupExtension).IsAssignableFrom (UnderlyingType);
572 protected virtual bool LookupIsNameScope ()
574 return typeof (INameScope).IsAssignableFrom (UnderlyingType);
577 protected virtual bool LookupIsNullable ()
579 return !type.IsValueType || type.ImplementsInterface (typeof (Nullable<>));
582 protected virtual bool LookupIsPublic ()
584 return underlying_type == null || underlying_type.IsPublic || underlying_type.IsNestedPublic;
587 protected virtual bool LookupIsUnknown ()
589 return UnderlyingType == null;
592 protected virtual bool LookupIsWhitespaceSignificantCollection ()
594 // probably for unknown types, it should preserve whitespaces.
595 return IsUnknown || this.GetCustomAttribute<WhitespaceSignificantCollectionAttribute> () != null;
598 protected virtual bool LookupIsXData ()
600 // huh? XamlLanguage.XData.IsXData returns false(!)
601 // return typeof (XData).IsAssignableFrom (UnderlyingType);
605 protected virtual XamlType LookupItemType ()
608 return new XamlType (type.GetElementType (), SchemaContext);
611 return new XamlType (typeof (object), SchemaContext);
612 return new XamlType (type.GetGenericArguments () [1], SchemaContext);
617 return new XamlType (typeof (object), SchemaContext);
618 return new XamlType (type.GetGenericArguments () [0], SchemaContext);
621 protected virtual XamlType LookupKeyType ()
626 return new XamlType (typeof (object), SchemaContext);
627 return new XamlType (type.GetGenericArguments () [0], SchemaContext);
630 protected virtual XamlType LookupMarkupExtensionReturnType ()
632 var a = this.GetCustomAttribute<MarkupExtensionReturnTypeAttribute> ();
633 return a != null ? new XamlType (a.ReturnType, SchemaContext) : null;
636 protected virtual XamlMember LookupMember (string name, bool skipReadOnlyCheck)
638 // FIXME: verify if this does not filter out events.
639 return GetAllMembers ().FirstOrDefault (m => m.Name == name && (skipReadOnlyCheck || !m.IsReadOnly || m.Type.IsCollection || m.Type.IsDictionary || m.Type.IsArray));
642 protected virtual IList<XamlType> LookupPositionalParameters (int parameterCount)
644 if (UnderlyingType == null/* || !IsMarkupExtension*/) // see nunit tests...
647 // check if there is applicable ConstructorArgumentAttribute.
648 // If there is, then return its type.
649 if (parameterCount == 1) {
650 foreach (var xm in GetAllMembers ()) {
651 var ca = xm.GetCustomAttributeProvider ().GetCustomAttribute<ConstructorArgumentAttribute> (false);
653 return new XamlType [] {xm.Type};
657 var methods = (from m in UnderlyingType.GetConstructors (BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance) where m.GetParameters ().Length == parameterCount select m).ToArray ();
658 if (methods.Length == 1)
659 return (from p in methods [0].GetParameters () select SchemaContext.GetXamlType (p.ParameterType)).ToArray ();
661 if (SchemaContext.SupportMarkupExtensionsWithDuplicateArity)
662 throw new NotSupportedException ("The default LookupPositionalParameters implementation does not allow duplicate arity of markup extensions");
666 BindingFlags flags_get_static = BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Static;
668 protected virtual EventHandler<XamlSetMarkupExtensionEventArgs> LookupSetMarkupExtensionHandler ()
670 var a = this.GetCustomAttribute<XamlSetMarkupExtensionAttribute> ();
673 var mi = type.GetMethod (a.XamlSetMarkupExtensionHandler, flags_get_static);
675 throw new ArgumentException ("Binding to XamlSetMarkupExtensionHandler failed");
676 return (EventHandler<XamlSetMarkupExtensionEventArgs>) Delegate.CreateDelegate (typeof (EventHandler<XamlSetMarkupExtensionEventArgs>), mi);
679 protected virtual EventHandler<XamlSetTypeConverterEventArgs> LookupSetTypeConverterHandler ()
681 var a = this.GetCustomAttribute<XamlSetTypeConverterAttribute> ();
684 var mi = type.GetMethod (a.XamlSetTypeConverterHandler, flags_get_static);
686 throw new ArgumentException ("Binding to XamlSetTypeConverterHandler failed");
687 return (EventHandler<XamlSetTypeConverterEventArgs>) Delegate.CreateDelegate (typeof (EventHandler<XamlSetTypeConverterEventArgs>), mi);
690 protected virtual bool LookupTrimSurroundingWhitespace ()
692 return this.GetCustomAttribute<TrimSurroundingWhitespaceAttribute> () != null;
695 protected virtual XamlValueConverter<TypeConverter> LookupTypeConverter ()
697 var t = UnderlyingType;
701 // equivalent to TypeExtension.
702 // FIXME: not sure if it should be specially handled here.
703 if (t == typeof (Type))
704 t = typeof (TypeExtension);
706 var a = GetCustomAttributeProvider ();
707 var ca = a != null ? a.GetCustomAttribute<TypeConverterAttribute> (false) : null;
709 return SchemaContext.GetValueConverter<TypeConverter> (Type.GetType (ca.ConverterTypeName), this);
711 if (t == typeof (object)) // This is a special case. ConverterType is null.
712 return SchemaContext.GetValueConverter<TypeConverter> (null, this);
714 // It's still not decent to check CollectionConverter.
715 var tct = TypeDescriptor.GetConverter (t).GetType ();
716 if (tct != typeof (TypeConverter) && tct != typeof (CollectionConverter) && tct != typeof (ReferenceConverter))
717 return SchemaContext.GetValueConverter<TypeConverter> (tct, this);
721 protected virtual Type LookupUnderlyingType ()
723 return underlying_type;
726 protected virtual bool LookupUsableDuringInitialization ()
728 var a = this.GetCustomAttribute<UsableDuringInitializationAttribute> ();
729 return a != null && a.Usable;
732 static XamlValueConverter<ValueSerializer> string_value_serializer;
734 protected virtual XamlValueConverter<ValueSerializer> LookupValueSerializer ()
736 return LookupValueSerializer (this, GetCustomAttributeProvider ());
739 internal static XamlValueConverter<ValueSerializer> LookupValueSerializer (XamlType targetType, ICustomAttributeProvider provider)
741 if (provider == null)
744 var a = provider.GetCustomAttribute<ValueSerializerAttribute> (true);
746 return new XamlValueConverter<ValueSerializer> (a.ValueSerializerType ?? Type.GetType (a.ValueSerializerTypeName), targetType);
748 if (targetType.BaseType != null) {
749 var ret = targetType.BaseType.LookupValueSerializer ();
754 if (targetType.UnderlyingType == typeof (string)) {
755 if (string_value_serializer == null)
756 string_value_serializer = new XamlValueConverter<ValueSerializer> (typeof (StringValueSerializer), targetType);
757 return string_value_serializer;
763 static string GetXamlName (Type type)
769 n = GetXamlName (type.DeclaringType) + "+" + type.Name;
770 if (type.IsGenericType && !type.ContainsGenericParameters) // the latter condition is to filter out "nested non-generic type within generic type".
771 return n.Substring (0, n.IndexOf ('`'));