Free cookie consent management tool by TermsFeed Policy Generator

source: trunk/sources/HeuristicLab.Operators.Programmable/3.3/ProgrammableOperator.cs @ 5042

Last change on this file since 5042 was 5042, checked in by epitzer, 12 years ago

Add breakpoint to ProgrammableOperator (#1322)

this patch also adds a shortcut (F6) to recompile, makes minor GUI improvements and gets rid of resource files

File size: 16.4 KB
Line 
1#region License Information
2/* HeuristicLab
3 * Copyright (C) 2002-2010 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 HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
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  [StorableClass]
44  public class ProgrammableOperator : Operator, IParameterizedNamedItem, IStorableContent {
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 override System.Drawing.Image ItemImage { get { return VS2008ImageLibrary.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);
89        foreach (var a in Assemblies.Keys.ToList()) {
90          Assemblies[a] = selectedAssemblyNames.Contains(a.FullName);
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      OnSignatureChanged();
132    }
133
134    public void UnselectNamespace(string ns) {
135      namespaces.Remove(ns);
136      OnSignatureChanged();
137    }
138
139    public IEnumerable<string> GetAllNamespaces(bool selectedAssembliesOnly) {
140      var namespaces = new HashSet<string>();
141      foreach (var a in Assemblies) {
142        if (!selectedAssembliesOnly || a.Value) {
143          foreach (var t in a.Key.GetTypes()) {
144            if (t.IsPublic) {
145              foreach (string ns in GetNamespaceHierachy(t.Namespace)) {
146                namespaces.Add(ns);
147              }
148            }
149          }
150        }
151      }
152      return namespaces;
153    }
154
155    private IEnumerable<string> GetNamespaceHierachy(string ns) {
156      if (ns != null) {
157        for (int i = ns.Length; i != -1; i = ns.LastIndexOf('.', i - 1)) {
158          yield return ns.Substring(0, i);
159        }
160      }
161    }
162
163    #endregion
164
165    #region Construction & Initialization
166
167    [StorableConstructor]
168    protected ProgrammableOperator(bool deserializing)
169      : base(deserializing) {
170      ProgrammableOperator.StaticInitialize();
171      Assemblies = defaultAssemblyDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
172      Plugins = defaultPluginDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToList());
173    }
174
175    protected ProgrammableOperator(ProgrammableOperator original, Cloner cloner)
176      : base(original, cloner) {
177      code = original.Code;
178      executeMethod = original.executeMethod;
179      Assemblies = original.Assemblies.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
180      Plugins = original.Plugins.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
181      namespaces = new HashSet<string>(original.namespaces);
182      CompilationUnitCode = original.CompilationUnitCode;
183      if (original.CompileErrors != null)
184        CompileErrors = new CompilerErrorCollection(original.CompileErrors);
185      RegisterEvents();
186    }
187
188    public ProgrammableOperator() {
189      code = "";
190      executeMethod = null;
191      ProgrammableOperator.StaticInitialize();
192      Assemblies = defaultAssemblyDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value);
193      Plugins = defaultPluginDict.ToDictionary(kvp => kvp.Key, kvp => kvp.Value.ToList());
194      namespaces = new HashSet<string>(DiscoverNamespaces());
195      RegisterEvents();
196    }
197
198    [StorableHook(HookType.AfterDeserialization)]
199    private void AfterDeserialization() {
200      // ensure default namespaces and assemblies are present if deserializing old operators
201      namespaces.Add("HeuristicLab.Operators.Programmable");
202      Assemblies[typeof(HeuristicLab.Operators.Operator).Assembly] = true;
203      Assemblies[typeof(HeuristicLab.Operators.Programmable.ProgrammableOperator).Assembly] = true;
204      RegisterEvents();
205    }
206
207    public override IDeepCloneable Clone(Cloner cloner) {
208      return new ProgrammableOperator(this, cloner);
209    }
210
211    private void RegisterEvents() {
212      Parameters.ItemsAdded += Parameters_Changed;
213      Parameters.ItemsRemoved += Parameters_Changed;
214      Parameters.ItemsReplaced += Parameters_Changed;
215      Parameters.CollectionReset += Parameters_Changed;
216    }
217
218    private void Parameters_Changed(object sender, CollectionItemsChangedEventArgs<IParameter> args) {
219      OnSignatureChanged();
220    }
221
222    protected void OnSignatureChanged() {
223      executeMethod = null;
224      EventHandler handler = SignatureChanged;
225      if (handler != null) handler(this, EventArgs.Empty);
226    }
227
228    private static void StaticInitialize() {
229      lock (initLock) {
230        if (defaultPluginDict != null && defaultAssemblyDict != null)
231          return;
232        defaultAssemblyDict = DiscoverAssemblies();
233        defaultPluginDict = GroupAssemblies(defaultAssemblyDict.Keys);
234      }
235    }
236
237    private static Dictionary<string, List<Assembly>> GroupAssemblies(IEnumerable<Assembly> assemblies) {
238      var plugins = new Dictionary<string, List<Assembly>>();
239      var locationTable = assemblies.ToDictionary(a => a.Location, a => a);
240
241      foreach (var plugin in ApplicationManager.Manager.Plugins) {
242        var aList = new List<Assembly>();
243        foreach (var aName in from file in plugin.Files
244                              where file.Type == PluginFileType.Assembly
245                              select file.Name) {
246          Assembly a;
247          locationTable.TryGetValue(aName, out a);
248          if (a != null) {
249            aList.Add(a);
250            locationTable.Remove(aName);
251          }
252        }
253        plugins[plugin.Name] = aList;
254      }
255
256      plugins["other"] = locationTable.Values.ToList();
257      return plugins;
258    }
259
260    protected static List<Assembly> defaultAssemblies = new List<Assembly>() {
261      typeof(System.Linq.Enumerable).Assembly,  // add reference to version 3.5 of System.dll
262      typeof(System.Collections.Generic.List<>).Assembly,
263      typeof(System.Text.StringBuilder).Assembly,
264      typeof(System.Data.Linq.DataContext).Assembly,
265      typeof(System.ComponentModel.INotifyPropertyChanged).Assembly,
266      typeof(HeuristicLab.Common.IDeepCloneable).Assembly,
267      typeof(HeuristicLab.Core.Item).Assembly,
268      typeof(HeuristicLab.Data.IntValue).Assembly,
269      typeof(HeuristicLab.Parameters.ValueParameter<IItem>).Assembly,
270      typeof(HeuristicLab.Collections.ObservableList<IItem>).Assembly,
271      typeof(HeuristicLab.Operators.Operator).Assembly,
272      typeof(HeuristicLab.Operators.Programmable.ProgrammableOperator).Assembly,
273    };
274
275    protected static Dictionary<Assembly, bool> DiscoverAssemblies() {
276      var assemblies = new Dictionary<Assembly, bool>();
277      foreach (var a in AppDomain.CurrentDomain.GetAssemblies()) {
278        try {
279          if (File.Exists(a.Location)) {
280            assemblies.Add(a, false);
281          }
282        } catch (NotSupportedException) {
283          // NotSupportedException is thrown while accessing
284          // the Location property of the anonymously hosted
285          // dynamic methods assembly, which is related to
286          // LINQ queries
287        }
288      }
289      foreach (var a in defaultAssemblies) {
290        if (assemblies.ContainsKey(a)) {
291          assemblies[a] = true;
292        } else {
293          assemblies.Add(a, true);
294        }
295      }
296      return assemblies;
297    }
298
299    protected static List<string> DiscoverNamespaces() {
300      return new List<string>() {
301        "HeuristicLab.Common",
302        "HeuristicLab.Core",
303        "HeuristicLab.Data",
304        "HeuristicLab.Parameters",
305        "HeuristicLab.Operators.Programmable",
306        "System",
307        "System.Collections.Generic",
308        "System.Text",
309        "System.Linq",
310        "System.Data.Linq",
311      };
312    }
313
314    #endregion
315
316    #region Compilation
317
318    private static CSharpCodeProvider codeProvider =
319      new CSharpCodeProvider(
320        new Dictionary<string, string>() {
321          { "CompilerVersion", "v3.5" },  // support C# 3.0 syntax
322        });
323
324    private CompilerResults DoCompile() {
325      CompilerParameters parameters = new CompilerParameters();
326      parameters.GenerateExecutable = false;
327      parameters.GenerateInMemory = true;
328      parameters.IncludeDebugInformation = false;
329      parameters.ReferencedAssemblies.AddRange(SelectedAssemblies.Select(a => a.Location).ToArray());
330      var unit = CreateCompilationUnit();
331      var writer = new StringWriter();
332      codeProvider.GenerateCodeFromCompileUnit(
333        unit,
334        writer,
335        new CodeGeneratorOptions() {
336          BracingStyle = "C",
337          ElseOnClosing = true,
338          IndentString = "  ",
339        });
340      CompilationUnitCode = writer.ToString();
341      return codeProvider.CompileAssemblyFromDom(parameters, unit);
342    }
343
344    public virtual void Compile() {
345      var results = DoCompile();
346      executeMethod = null;
347      CompileErrors = results.Errors;
348      if (results.Errors.HasErrors) {
349        StringBuilder sb = new StringBuilder();
350        foreach (CompilerError error in results.Errors) {
351          sb.Append(error.Line).Append(':')
352            .Append(error.Column).Append(": ")
353            .AppendLine(error.ErrorText);
354        }
355        throw new Exception(string.Format(
356          "Compilation of \"{0}\" failed:{1}{2}",
357          Name, Environment.NewLine,
358          sb.ToString()));
359      } else {
360        Assembly assembly = results.CompiledAssembly;
361        Type[] types = assembly.GetTypes();
362        executeMethod = types[0].GetMethod("Execute");
363      }
364    }
365
366    private CodeCompileUnit CreateCompilationUnit() {
367      CodeNamespace ns = new CodeNamespace("HeuristicLab.Operators.Programmable.CustomOperators");
368      ns.Types.Add(CreateType());
369      ns.Imports.AddRange(
370        GetSelectedAndValidNamespaces()
371        .Select(n => new CodeNamespaceImport(n))
372        .ToArray());
373      CodeCompileUnit unit = new CodeCompileUnit();
374      unit.Namespaces.Add(ns);
375      return unit;
376    }
377
378    public IEnumerable<string> GetSelectedAndValidNamespaces() {
379      var possibleNamespaces = new HashSet<string>(GetAllNamespaces(true));
380      foreach (var ns in Namespaces)
381        if (possibleNamespaces.Contains(ns))
382          yield return ns;
383    }
384
385    public static readonly Regex SafeTypeNameCharRegex = new Regex("[_a-zA-Z0-9]+");
386    public static readonly Regex SafeTypeNameRegex = new Regex("[_a-zA-Z][_a-zA-Z0-9]*");
387
388    public string CompiledTypeName {
389      get {
390        var sb = new StringBuilder();
391        foreach (string s in SafeTypeNameCharRegex.Matches(Name).Cast<Match>().Select(m => m.Value)) {
392          sb.Append(s);
393        }
394        return SafeTypeNameRegex.Match(sb.ToString()).Value;
395      }
396    }
397
398    private CodeTypeDeclaration CreateType() {
399      CodeTypeDeclaration typeDecl = new CodeTypeDeclaration(CompiledTypeName) {
400        IsClass = true,
401        TypeAttributes = TypeAttributes.Public,
402      };
403      typeDecl.Members.Add(CreateMethod());
404      return typeDecl;
405    }
406
407    public string Signature {
408      get {
409        var sb = new StringBuilder()
410        .Append("public static IOperation Execute(")
411        .Append(TypeNameParser.Parse(GetType().FullName).GetTypeNameInCode(namespaces))
412        .Append(" op, ")
413        .Append(TypeNameParser.Parse(typeof(IExecutionContext).FullName).GetTypeNameInCode(namespaces))
414        .Append(" context");
415        foreach (IParameter param in Parameters) {
416          sb.Append(String.Format(", {0} {1}",
417            TypeNameParser.Parse(param.GetType().FullName).GetTypeNameInCode(namespaces),
418            param.Name));
419        }
420        return sb.Append(")").ToString();
421      }
422    }
423
424    public event EventHandler SignatureChanged;
425
426    private static Regex lineSplitter = new Regex(@"\r\n|\r|\n");
427
428    private CodeMemberMethod CreateMethod() {
429      CodeMemberMethod method = new CodeMemberMethod();
430      method.Name = "Execute";
431      method.ReturnType = new CodeTypeReference(typeof(IOperation));
432      method.Attributes = MemberAttributes.Public | MemberAttributes.Static;
433      method.Parameters.Add(new CodeParameterDeclarationExpression(GetType(), "op"));
434      method.Parameters.Add(new CodeParameterDeclarationExpression(typeof(IExecutionContext), "context"));
435      foreach (var param in Parameters)
436        method.Parameters.Add(new CodeParameterDeclarationExpression(param.GetType(), param.Name));
437      string[] codeLines = lineSplitter.Split(code);
438      for (int i = 0; i < codeLines.Length; i++) {
439        codeLines[i] = string.Format("#line {0} \"ProgrammableOperator\"{1}{2}", i + 1, "\r\n", codeLines[i]);
440      }
441      method.Statements.Add(new CodeSnippetStatement(string.Join("\r\n", codeLines) + MethodSuffix));
442      return method;
443    }
444
445    public virtual string MethodSuffix {
446      get { return "return null;"; }
447    }
448
449    #endregion
450
451    #region HeuristicLab interfaces
452
453    public override IOperation Apply() {
454      lock (syncRoot) {
455        if (executeMethod == null) {
456          Compile();
457        }
458      }
459
460      var parameters = new List<object>() { this, ExecutionContext };
461      parameters.AddRange(Parameters.Select(p => (object)p));
462      return (IOperation)executeMethod.Invoke(null, parameters.ToArray());
463    }
464
465    public event EventHandler CodeChanged;
466    protected virtual void OnCodeChanged() {
467      EventHandler handler = CodeChanged;
468      if (handler != null) handler(this, EventArgs.Empty);
469    }
470
471    #endregion
472  }
473}
Note: See TracBrowser for help on using the repository browser.