source: trunk/sources/HeuristicLab.PluginInfrastructure/3.3/LightweightApplicationManager.cs @ 7520

Last change on this file since 7520 was 7520, checked in by abeham, 8 years ago

#1774:

  • improved performance of type discovery by moving compatibility check further up the chain (deep cloneable unit test time reduced from 32s to 18s)
File size: 10.3 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2012 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
4 *
5 * This file is part of HeuristicLab.
6 *
7 * HeuristicLab is free software: you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation, either version 3 of the License, or
10 * (at your option) any later version.
11 *
12 * HeuristicLab is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with HeuristicLab. If not, see <http://www.gnu.org/licenses/>.
19 */
20#endregion
21
22using System;
23using System.Collections.Generic;
24using System.Linq;
25using System.Reflection;
26
27namespace HeuristicLab.PluginInfrastructure {
28
29  /// <summary>
30  /// Lightweight application manager is set as the application manager as long as the plugin infrastructure is uninitialized.
31  /// The list of plugins and applications is empty. The default application manager is necessary to provide the type discovery
32  /// functionality in unit tests.
33  /// </summary>
34  internal sealed class LightweightApplicationManager : IApplicationManager {
35    internal LightweightApplicationManager() {
36      AppDomain.CurrentDomain.AssemblyResolve += new ResolveEventHandler(CurrentDomain_AssemblyResolve);
37    }
38
39    Assembly CurrentDomain_AssemblyResolve(object sender, ResolveEventArgs args) {
40      return null;
41    }
42
43
44    #region IApplicationManager Members
45    /// <summary>
46    /// Gets an empty list of plugins. (LightweightApplicationManager doesn't support plugin discovery)
47    /// </summary>
48    public IEnumerable<IPluginDescription> Plugins {
49      get { return new IPluginDescription[0]; }
50    }
51
52    /// <summary>
53    /// Gets an empty list of applications. (LightweightApplicationManager doesn't support application discovery)
54    /// </summary>
55    public IEnumerable<IApplicationDescription> Applications {
56      get { return new IApplicationDescription[0]; }
57    }
58
59    /// <summary>
60    /// Creates an instance of all types that are subtypes or the same type of the specified type
61    /// </summary>
62    /// <typeparam name="T">Most general type.</typeparam>
63    /// <returns>Enumerable of the created instances.</returns>
64    public IEnumerable<T> GetInstances<T>() where T : class {
65      return GetInstances(typeof(T)).Cast<T>();
66    }
67
68    /// <summary>
69    /// Creates an instance of all types that are subtypes or the same type of the specified type
70    /// </summary>
71    /// <param name="type">Most general type.</param>
72    /// <returns>Enumerable of the created instances.</returns>
73    public IEnumerable<object> GetInstances(Type type) {
74      List<object> instances = new List<object>();
75      foreach (Type t in GetTypes(type)) {
76        object instance = null;
77        try { instance = Activator.CreateInstance(t); } catch { }
78        if (instance != null) instances.Add(instance);
79      }
80      return instances;
81    }
82
83    /// <summary>
84    /// Finds all instantiable types that are subtypes or equal to the specified types.
85    /// </summary>
86    /// <param name="types">Most general types for which to find matching types.</param>
87    /// <remarks>Return only types that are instantiable
88    /// (interfaces, abstract classes... are not returned)</remarks>
89    /// <param name="includeGenericTypeDefinitions">Specifies if generic type definitions shall be included</param>
90    /// <returns>Enumerable of the discovered types.</returns>
91    public IEnumerable<Type> GetTypes(IEnumerable<Type> types, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false, bool assignableToAllTypes = true) {
92      IEnumerable<Type> result = GetTypes(types.First(), onlyInstantiable, includeGenericTypeDefinitions);
93      foreach (Type type in types.Skip(1)) {
94        IEnumerable<Type> discoveredTypes = GetTypes(type, onlyInstantiable, includeGenericTypeDefinitions);
95        if (assignableToAllTypes) result = result.Intersect(discoveredTypes);
96        else result = result.Union(discoveredTypes);
97      }
98      return result;
99    }
100
101    /// <summary>
102    /// Finds all types that are subtypes or equal to the specified type.
103    /// </summary>
104    /// <param name="type">Most general type for which to find matching types.</param>
105    /// <param name="onlyInstantiable">Return only types that are instantiable
106    /// (interfaces, abstract classes... are not returned)</param>
107    /// <param name="includeGenericTypeDefinitions">Specifies if generic type definitions shall be included</param>
108    /// <returns>Enumerable of the discovered types.</returns>
109    public IEnumerable<Type> GetTypes(Type type, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false) {
110      return from asm in AppDomain.CurrentDomain.GetAssemblies()
111             from t in GetTypes(type, asm, onlyInstantiable, includeGenericTypeDefinitions)
112             select t;
113    }
114
115    /// <summary>
116    /// Gets types that are assignable (same of subtype) to the specified type only from the given assembly.
117    /// </summary>
118    /// <param name="type">Most general type we want to find.</param>
119    /// <param name="assembly">Assembly that should be searched for types.</param>
120    /// <param name="onlyInstantiable">Return only types that are instantiable
121    /// (interfaces, abstract classes...  are not returned)</param>
122    /// <returns>Enumerable of the discovered types.</returns>
123    private static IEnumerable<Type> GetTypes(Type type, Assembly assembly, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false) {
124      try {
125        var assemblyTypes = assembly.GetTypes();
126
127        var buildTypes = from t in assembly.GetTypes()
128                         where CheckTypeCompatibility(type, t)
129                         where !IsNonDiscoverableType(t)
130                         where onlyInstantiable == false ||
131                               (!t.IsAbstract && !t.IsInterface && !t.HasElementType)
132                         select BuildType(t, type);
133
134        return from t in buildTypes
135               where includeGenericTypeDefinitions || !t.IsGenericTypeDefinition
136               select t;
137      } catch (TypeLoadException) {
138        return Enumerable.Empty<Type>();
139      } catch (ReflectionTypeLoadException) {
140        return Enumerable.Empty<Type>();
141      }
142    }
143
144    private static bool IsNonDiscoverableType(Type t) {
145      return t.GetCustomAttributes(typeof(NonDiscoverableTypeAttribute), false).Any();
146    }
147
148    private static bool CheckTypeCompatibility(Type type, Type other) {
149      if (type.IsAssignableFrom(other))
150        return true;
151      if (type.IsGenericType && other.IsGenericType) {
152        var otherGenericArguments = other.GetGenericArguments();
153        var typeGenericArguments = type.GetGenericArguments();
154
155        //check type arguments count
156        if (otherGenericArguments.Length != typeGenericArguments.Length)
157          return false;
158
159        //check type arguments & constraints
160        int i = 0;
161        foreach (var genericArgument in typeGenericArguments) {
162          if (otherGenericArguments[i].IsGenericParameter) {
163            foreach (var constraint in otherGenericArguments[i].GetGenericParameterConstraints())
164              if (!constraint.IsAssignableFrom(genericArgument)) return false;
165          } else if (genericArgument != otherGenericArguments[i]) return false;
166          i++;
167        }
168        //check types
169        try {
170          var otherGenericTypeDefinition = other.GetGenericTypeDefinition();
171          if (type.IsAssignableFrom(otherGenericTypeDefinition.MakeGenericType(typeGenericArguments)))
172            return true;
173        } catch (Exception) { }
174      }
175      return false;
176    }
177    private static Type BuildType(Type type, Type protoType) {
178      if (type.IsGenericType && protoType.IsGenericType)
179        return type.GetGenericTypeDefinition().MakeGenericType(protoType.GetGenericArguments());
180      else
181        return type;
182    }
183
184    /// <summary>
185    /// Not supported by the LightweightApplicationManager
186    /// </summary>
187    /// <param name="type"></param>
188    /// <param name="plugin"></param>
189    /// <returns></returns>
190    /// <throws>NotSupportedException</throws>
191    public IEnumerable<Type> GetTypes(Type type, IPluginDescription plugin) {
192      throw new NotSupportedException("LightweightApplicationManager doesn't support type discovery for plugins.");
193    }
194
195    /// <summary>
196    /// Not supported by the LightweightApplicationManager
197    /// </summary>
198    /// <param name="type"></param>
199    /// <param name="plugin"></param>
200    /// <param name="onlyInstantiable"></param>
201    /// <param name="includeGenericTypeDefinitions"></param>
202    /// <returns></returns>
203    /// <throws>NotSupportedException</throws>
204    public IEnumerable<Type> GetTypes(Type type, IPluginDescription plugin, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false) {
205      throw new NotSupportedException("LightweightApplicationManager doesn't support type discovery for plugins.");
206    }
207
208    /// <summary>
209    /// Not supported by the LightweightApplicationManager
210    /// </summary>
211    /// <param name="type"></param>
212    /// <param name="plugin"></param>
213    /// <param name="onlyInstantiable"></param>
214    /// <param name="includeGenericTypeDefinitions"></param>
215    /// <returns></returns>
216    /// <throws>NotSupportedException</throws>
217    public IEnumerable<Type> GetTypes(IEnumerable<Type> types, IPluginDescription plugin, bool onlyInstantiable = true, bool includeGenericTypeDefinitions = false, bool assignableToAllTypes = true) {
218      throw new NotSupportedException("LightweightApplicationManager doesn't support type discovery for plugins.");
219    }
220
221    /// <summary>
222    /// Not supported by the LightweightApplicationManager
223    /// </summary>
224    /// <param name="type"></param>
225    /// <returns></returns>
226    /// <throws>NotSupportedException</throws>
227    public IPluginDescription GetDeclaringPlugin(Type type) {
228      throw new NotSupportedException("LightweightApplicationManager doesn't support type discovery for plugins.");
229    }
230
231    #endregion
232  }
233}
Note: See TracBrowser for help on using the repository browser.