Free cookie consent management tool by TermsFeed Policy Generator

source: branches/2994-AutoDiffForIntervals/HeuristicLab.Operators.Programmable/3.3/ProgrammableOperator.cs @ 17285

Last change on this file since 17285 was 17209, checked in by gkronber, 5 years ago

#2994: merged r17132:17198 from trunk to branch

File size: 16.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 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.CodeDom;
24using System.CodeDom.Compiler;
25using System.Collections.Generic;
26using System.IO;
27using System.Linq;
28using System.Reflection;
29using System.Text;
30using System.Text.RegularExpressions;
31using HeuristicLab.Collections;
32using HeuristicLab.Common;
33using HeuristicLab.Common.Resources;
34using HeuristicLab.Core;
35using HeuristicLab.Persistence.Auxiliary;
36using HEAL.Attic;
37using HeuristicLab.PluginInfrastructure;
38using Microsoft.CSharp;
39
40namespace HeuristicLab.Operators.Programmable {
41
42  [Item("ProgrammableOperator", "An operator that can be programmed for arbitrary needs.")]
43  [StorableType("741279E4-4C38-4D66-B9F1-03E0F8B47A78")]
44  public class ProgrammableOperator : Operator, IParameterizedNamedItem, IStorableContent, IProgrammableItem {
45
46    #region Fields & Properties
47
48    public string Filename { get; set; }
49
50    public new ParameterCollection Parameters {
51      get { return base.Parameters; }
52    }
53
54    public static new System.Drawing.Image StaticItemImage { get { return VSImageLibrary.Script; } }
55
56    private MethodInfo executeMethod;
57    public CompilerErrorCollection CompileErrors { get; private set; }
58    public string CompilationUnitCode { get; private set; }
59
60    [Storable]
61    private string code;
62    public string Code {
63      get { return code; }
64      set {
65        if (value != code) {
66          code = value;
67          executeMethod = null;
68          OnCodeChanged();
69        }
70      }
71    }
72
73    private object syncRoot = new object();
74
75    private static object initLock = new object();
76    private static Dictionary<string, List<Assembly>> defaultPluginDict;
77    private static Dictionary<Assembly, bool> defaultAssemblyDict;
78
79    public readonly Dictionary<string, List<Assembly>> Plugins;
80    protected Dictionary<Assembly, bool> Assemblies;
81
82    [Storable(Name = "SelectedAssemblies")]
83    private List<string> _selectedAssemblyNames_persistence {
84      get {
85        return Assemblies.Where(a => a.Value).Select(a => a.Key.FullName).ToList();
86      }
87      set {
88        var selectedAssemblyNames = new HashSet<string>(value.Select(n => new AssemblyName(n).Name));
89        foreach (var a in Assemblies.Keys.ToList()) {
90          Assemblies[a] = selectedAssemblyNames.Contains(new AssemblyName(a.FullName).Name);
91        }
92      }
93    }
94
95    public IEnumerable<Assembly> AvailableAssemblies {
96      get { return Assemblies.Keys; }
97    }
98
99    public IEnumerable<Assembly> SelectedAssemblies {
100      get { return Assemblies.Where(kvp => kvp.Value).Select(kvp => kvp.Key); }
101    }
102
103    [Storable]
104    private HashSet<string> namespaces;
105    public IEnumerable<string> Namespaces {
106      get { return namespaces; }
107    }
108
109    public override bool CanChangeDescription {
110      get { return true; }
111    }
112
113    #endregion
114
115    #region Extended Accessors
116
117    public void SelectAssembly(Assembly a) {
118      if (a != null && Assemblies.ContainsKey(a) && !Assemblies[a]) {
119        Assemblies[a] = true;
120      }
121    }
122
123    public void UnselectAssembly(Assembly a) {
124      if (a != null && Assemblies.ContainsKey(a) && Assemblies[a]) {
125        Assemblies[a] = false;
126      }
127    }
128
129    public void SelectNamespace(string ns) {
130      namespaces.Add(ns);
131    }
132
133    public void UnselectNamespace(string ns) {
134      namespaces.Remove(ns);
135    }
136
137    public IEnumerable<string> GetAllNamespaces(bool selectedAssembliesOnly) {
138      var namespaces = new HashSet<string>();
139      foreach (var a in Assemblies) {
140        if (!selectedAssembliesOnly || a.Value) {
141          foreach (var t in a.Key.GetTypes()) {
142            if (t.IsPublic) {
143              foreach (string ns in GetNamespaceHierachy(t.Namespace)) {
144                namespaces.Add(ns);
145              }
146            }
147          }
148        }
149      }
150      return namespaces;
151    }
152
153    private IEnumerable<string> GetNamespaceHierachy(string ns) {
154      if (ns != null) {
155        for (int i = ns.Length; i != -1; i = ns.LastIndexOf('.', i - 1)) {
156          yield return ns.Substring(0, i);
157        }
158      }
159    }
160
161    #endregion
162
163    #region Construction & Initialization
164
165    [StorableConstructor]
166    protected ProgrammableOperator(StorableConstructorFlag _) : base(_) {
167      ProgrammableOperator.StaticInitialize();
168      Assemblies = defaultAssemblyDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
169      Plugins = defaultPluginDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToList());
170    }
171
172    protected ProgrammableOperator(ProgrammableOperator original, Cloner cloner)
173      : base(original, cloner) {
174      code = original.Code;
175      executeMethod = original.executeMethod;
176      Assemblies = original.Assemblies.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
177      Plugins = original.Plugins.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
178      namespaces = new HashSet<string>(original.namespaces);
179      CompilationUnitCode = original.CompilationUnitCode;
180      if (original.CompileErrors != null)
181        CompileErrors = new CompilerErrorCollection(original.CompileErrors);
182      RegisterEvents();
183    }
184
185    public ProgrammableOperator() {
186      code = "";
187      executeMethod = null;
188      ProgrammableOperator.StaticInitialize();
189      Assemblies = defaultAssemblyDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
190      Plugins = defaultPluginDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToList());
191      namespaces = new HashSet<string>(DiscoverNamespaces());
192      RegisterEvents();
193    }
194
195    [StorableHook(HookType.AfterDeserialization)]
196    private void AfterDeserialization() {
197      // ensure default namespaces and assemblies are present if deserializing old operators
198      namespaces.Add("HeuristicLab.Operators.Programmable");
199      Assemblies[typeof(HeuristicLab.Operators.Operator).Assembly] = true;
200      Assemblies[typeof(HeuristicLab.Operators.Programmable.ProgrammableOperator).Assembly] = true;
201      Assemblies[typeof(System.Threading.Barrier).Assembly] = true; // ensure new System assembly is selected (4.0.0.0)
202      RegisterEvents();
203    }
204
205    public override IDeepCloneable Clone(Cloner cloner) {
206      return new ProgrammableOperator(this, cloner);
207    }
208
209    private void RegisterEvents() {
210      Parameters.ItemsAdded += Parameters_Changed;
211      Parameters.ItemsRemoved += Parameters_Changed;
212      Parameters.ItemsReplaced += Parameters_Changed;
213      Parameters.CollectionReset += Parameters_Changed;
214    }
215
216    private void Parameters_Changed(object sender, CollectionItemsChangedEventArgs<IParameter> args) {
217      OnSignatureChanged();
218    }
219
220    protected void OnSignatureChanged() {
221      executeMethod = null;
222      EventHandler handler = SignatureChanged;
223      if (handler != null) handler(this, EventArgs.Empty);
224    }
225
226    private static void StaticInitialize() {
227      lock (initLock) {
228        if (defaultPluginDict != null && defaultAssemblyDict != null)
229          return;
230        defaultAssemblyDict = DiscoverAssemblies();
231        defaultPluginDict = GroupAssemblies(defaultAssemblyDict.Keys);
232      }
233    }
234
235    private static Dictionary<string, List<Assembly>> GroupAssemblies(IEnumerable<Assembly> assemblies) {
236      var plugins = new Dictionary<string, List<Assembly>>();
237      var locationTable = assemblies.ToDictionary(a => a.Location, a => a);
238
239      foreach (var plugin in ApplicationManager.Manager.Plugins) {
240        var aList = new List<Assembly>();
241        foreach (var aName in from file in plugin.Files
242                              where file.Type == PluginFileType.Assembly
243                              select file.Name) {
244          Assembly a;
245          locationTable.TryGetValue(aName, out a);
246          if (a != null) {
247            aList.Add(a);
248            locationTable.Remove(aName);
249          }
250        }
251        plugins[plugin.Name] = aList;
252      }
253
254      plugins["other"] = locationTable.Values.ToList();
255      return plugins;
256    }
257
258    protected static List<Assembly> defaultAssemblies = new List<Assembly>() {
259      // mscorlib automatically included (would cause duplicate)
260      typeof(System.ComponentModel.INotifyPropertyChanged).Assembly, // System.dll
261      typeof(System.Linq.Enumerable).Assembly,  // System.Core.dll
262      typeof(System.Data.Linq.DataContext).Assembly, // System.Data.Linq.dll
263      typeof(HeuristicLab.Common.IDeepCloneable).Assembly,
264      typeof(HeuristicLab.Core.Item).Assembly,
265      typeof(HeuristicLab.Data.IntValue).Assembly,
266      typeof(HeuristicLab.Parameters.ValueParameter<IItem>).Assembly,
267      typeof(HeuristicLab.Collections.ObservableList<IItem>).Assembly,
268      typeof(HeuristicLab.Operators.Operator).Assembly,
269      typeof(HeuristicLab.Operators.Programmable.ProgrammableOperator).Assembly,
270    };
271
272    protected static Dictionary<Assembly, bool> DiscoverAssemblies() {
273      var assemblies = new Dictionary<Assembly, bool>();
274      foreach (var a in AppDomain.CurrentDomain.GetAssemblies()) {
275        try {
276          if (File.Exists(a.Location)) {
277            assemblies.Add(a, false);
278          }
279        } catch (NotSupportedException) {
280          // NotSupportedException is thrown while accessing
281          // the Location property of the anonymously hosted
282          // dynamic methods assembly, which is related to
283          // LINQ queries
284        }
285      }
286      foreach (var a in defaultAssemblies) {
287        if (assemblies.ContainsKey(a)) {
288          assemblies[a] = true;
289        } else {
290          assemblies.Add(a, true);
291        }
292      }
293      return assemblies;
294    }
295
296    protected static List<string> DiscoverNamespaces() {
297      return new List<string>() {
298        "HeuristicLab.Common",
299        "HeuristicLab.Core",
300        "HeuristicLab.Data",
301        "HeuristicLab.Parameters",
302        "HeuristicLab.Operators.Programmable",
303        "System",
304        "System.Collections.Generic",
305        "System.Text",
306        "System.Linq",
307        "System.Data.Linq",
308      };
309    }
310
311    #endregion
312
313    #region Compilation
314
315    private static CSharpCodeProvider codeProvider =
316      new CSharpCodeProvider(
317        new Dictionary<string, string>() {
318          { "CompilerVersion", "v4.0" },  // support C# 4.0 syntax
319        });
320
321    private CompilerResults DoCompile() {
322      CompilerParameters parameters = new CompilerParameters();
323      parameters.GenerateExecutable = false;
324      parameters.GenerateInMemory = true;
325      parameters.IncludeDebugInformation = false;
326      parameters.ReferencedAssemblies.AddRange(SelectedAssemblies.Select(a => a.Location).ToArray());
327      var unit = CreateCompilationUnit();
328      var writer = new StringWriter();
329      codeProvider.GenerateCodeFromCompileUnit(
330        unit,
331        writer,
332        new CodeGeneratorOptions() {
333          BracingStyle = "C",
334          ElseOnClosing = true,
335          IndentString = "  ",
336        });
337      CompilationUnitCode = writer.ToString();
338      return codeProvider.CompileAssemblyFromDom(parameters, unit);
339    }
340
341    public virtual void Compile() {
342      var results = DoCompile();
343      executeMethod = null;
344      CompileErrors = results.Errors;
345      if (results.Errors.HasErrors) {
346        StringBuilder sb = new StringBuilder();
347        foreach (CompilerError error in results.Errors) {
348          sb.Append(error.Line).Append(':')
349            .Append(error.Column).Append(": ")
350            .AppendLine(error.ErrorText);
351        }
352        throw new Exception(string.Format(
353          "Compilation of \"{0}\" failed:{1}{2}",
354          Name, Environment.NewLine,
355          sb.ToString()));
356      } else {
357        Assembly assembly = results.CompiledAssembly;
358        Type[] types = assembly.GetTypes();
359        executeMethod = types[0].GetMethod("Execute");
360      }
361    }
362
363    private CodeCompileUnit CreateCompilationUnit() {
364      CodeNamespace ns = new CodeNamespace("HeuristicLab.Operators.Programmable.CustomOperators");
365      ns.Types.Add(CreateType());
366      ns.Imports.AddRange(
367        GetSelectedAndValidNamespaces()
368        .Select(n => new CodeNamespaceImport(n))
369        .ToArray());
370      CodeCompileUnit unit = new CodeCompileUnit();
371      unit.Namespaces.Add(ns);
372      return unit;
373    }
374
375    public IEnumerable<string> GetSelectedAndValidNamespaces() {
376      var possibleNamespaces = new HashSet<string>(GetAllNamespaces(true));
377      foreach (var ns in Namespaces)
378        if (possibleNamespaces.Contains(ns))
379          yield return ns;
380    }
381
382    public static readonly Regex SafeTypeNameCharRegex = new Regex("[_a-zA-Z0-9]+");
383    public static readonly Regex SafeTypeNameRegex = new Regex("[_a-zA-Z][_a-zA-Z0-9]*");
384
385    public string CompiledTypeName {
386      get {
387        var sb = new StringBuilder();
388        foreach (string s in SafeTypeNameCharRegex.Matches(Name).Cast<Match>().Select(m => m.Value)) {
389          sb.Append(s);
390        }
391        return SafeTypeNameRegex.Match(sb.ToString()).Value;
392      }
393    }
394
395    private CodeTypeDeclaration CreateType() {
396      CodeTypeDeclaration typeDecl = new CodeTypeDeclaration(CompiledTypeName) {
397        IsClass = true,
398        TypeAttributes = TypeAttributes.Public,
399      };
400      typeDecl.Members.Add(CreateMethod());
401      return typeDecl;
402    }
403
404    public string Signature {
405      get {
406        var sb = new StringBuilder()
407        .Append("public static IOperation Execute(")
408        .Append(TypeNameParser.Parse(GetType().FullName).GetTypeNameInCode(namespaces))
409        .Append(" op, ")
410        .Append(TypeNameParser.Parse(typeof(IExecutionContext).FullName).GetTypeNameInCode(namespaces))
411        .Append(" context");
412        foreach (IParameter param in Parameters) {
413          sb.Append(String.Format(", {0} {1}",
414            TypeNameParser.Parse(param.GetType().FullName).GetTypeNameInCode(namespaces),
415            param.Name));
416        }
417        return sb.Append(")").ToString();
418      }
419    }
420
421    public event EventHandler SignatureChanged;
422
423    private static Regex lineSplitter = new Regex(@"\r\n|\r|\n");
424
425    private CodeMemberMethod CreateMethod() {
426      CodeMemberMethod method = new CodeMemberMethod();
427      method.Name = "Execute";
428      method.ReturnType = new CodeTypeReference(typeof(IOperation));
429      method.Attributes = MemberAttributes.Public | MemberAttributes.Static;
430      method.Parameters.Add(new CodeParameterDeclarationExpression(GetType(), "op"));
431      method.Parameters.Add(new CodeParameterDeclarationExpression(typeof(IExecutionContext), "context"));
432      foreach (var param in Parameters)
433        method.Parameters.Add(new CodeParameterDeclarationExpression(param.GetType(), param.Name));
434      string[] codeLines = lineSplitter.Split(code);
435      for (int i = 0; i < codeLines.Length; i++) {
436        codeLines[i] = string.Format("#line {0} \"ProgrammableOperator\"{1}{2}", i + 1, "\r\n", codeLines[i]);
437      }
438      method.Statements.Add(new CodeSnippetStatement(string.Join("\r\n", codeLines) + MethodSuffix));
439      return method;
440    }
441
442    public virtual string MethodSuffix {
443      get { return "return null;"; }
444    }
445
446    #endregion
447
448    #region HeuristicLab interfaces
449
450    public override IOperation Apply() {
451      lock (syncRoot) {
452        if (executeMethod == null) {
453          Compile();
454        }
455      }
456
457      var parameters = new List<object>() { this, ExecutionContext };
458      parameters.AddRange(Parameters.Select(p => (object)p));
459      return (IOperation)executeMethod.Invoke(null, parameters.ToArray());
460    }
461
462    public event EventHandler CodeChanged;
463    protected virtual void OnCodeChanged() {
464      EventHandler handler = CodeChanged;
465      if (handler != null) handler(this, EventArgs.Empty);
466    }
467
468    #endregion
469  }
470}
Note: See TracBrowser for help on using the repository browser.