Free cookie consent management tool by TermsFeed Policy Generator

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

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

Check if namespace is null before splitting the string. (#1310)

File size: 16.3 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.Core;
34using HeuristicLab.Persistence.Auxiliary;
35using HeuristicLab.Persistence.Default.CompositeSerializers.Storable;
36using HeuristicLab.PluginInfrastructure;
37using Microsoft.CSharp;
38
39namespace HeuristicLab.Operators.Programmable {
40
41  [Item("ProgrammableOperator", "An operator that can be programmed for arbitrary needs.")]
42  [StorableClass]
43  public class ProgrammableOperator : Operator, IParameterizedNamedItem, IStorableContent {
44
45    #region Fields & Properties
46
47    public string Filename { get; set; }
48
49    public new ParameterCollection Parameters {
50      get { return base.Parameters; }
51    }
52
53    private MethodInfo executeMethod;
54    public CompilerErrorCollection CompileErrors { get; private set; }
55    public string CompilationUnitCode { get; private set; }
56
57    [Storable]
58    private string code;
59    public string Code {
60      get { return code; }
61      set {
62        if (value != code) {
63          code = value;
64          executeMethod = null;
65          OnCodeChanged();
66        }
67      }
68    }
69
70    private object syncRoot = new object();
71
72    private static object initLock = new object();
73    private static Dictionary<string, List<Assembly>> defaultPluginDict;
74    private static Dictionary<Assembly, bool> defaultAssemblyDict;
75
76    public readonly Dictionary<string, List<Assembly>> Plugins;
77    protected Dictionary<Assembly, bool> Assemblies;
78
79    [Storable(Name = "SelectedAssemblies")]
80    private List<string> _selectedAssemblyNames_persistence {
81      get {
82        return Assemblies.Where(a => a.Value).Select(a => a.Key.FullName).ToList();
83      }
84      set {
85        var selectedAssemblyNames = new HashSet<string>(value);
86        foreach (var a in Assemblies.Keys.ToList()) {
87          Assemblies[a] = selectedAssemblyNames.Contains(a.FullName);
88        }
89      }
90    }
91
92    public IEnumerable<Assembly> AvailableAssemblies {
93      get { return Assemblies.Keys; }
94    }
95
96    public IEnumerable<Assembly> SelectedAssemblies {
97      get { return Assemblies.Where(kvp => kvp.Value).Select(kvp => kvp.Key); }
98    }
99
100    [Storable]
101    private HashSet<string> namespaces;
102    public IEnumerable<string> Namespaces {
103      get { return namespaces; }
104    }
105
106    public override bool CanChangeDescription {
107      get { return true; }
108    }
109
110    #endregion
111
112    #region Extended Accessors
113
114    public void SelectAssembly(Assembly a) {
115      if (a != null && Assemblies.ContainsKey(a) && !Assemblies[a]) {
116        Assemblies[a] = true;
117      }
118    }
119
120    public void UnselectAssembly(Assembly a) {
121      if (a != null && Assemblies.ContainsKey(a) && Assemblies[a]) {
122        Assemblies[a] = false;
123      }
124    }
125
126    public void SelectNamespace(string ns) {
127      namespaces.Add(ns);
128      OnSignatureChanged();
129    }
130
131    public void UnselectNamespace(string ns) {
132      namespaces.Remove(ns);
133      OnSignatureChanged();
134    }
135
136    public IEnumerable<string> GetAllNamespaces(bool selectedAssembliesOnly) {
137      var namespaces = new HashSet<string>();
138      foreach (var a in Assemblies) {
139        if (!selectedAssembliesOnly || a.Value) {
140          foreach (var t in a.Key.GetTypes()) {
141            if (t.IsPublic) {
142              foreach (string ns in GetNamespaceHierachy(t.Namespace)) {
143                namespaces.Add(ns);
144              }
145            }
146          }
147        }
148      }
149      return namespaces;
150    }
151
152    private IEnumerable<string> GetNamespaceHierachy(string ns) {
153      if (ns != null) {
154        for (int i = ns.Length; i != -1; i = ns.LastIndexOf('.', i - 1)) {
155          yield return ns.Substring(0, i);
156        }
157      }
158    }
159
160    #endregion
161
162    #region Construction & Initialization
163
164    [StorableConstructor]
165    protected ProgrammableOperator(bool deserializing)
166      : base(deserializing) {
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      RegisterEvents();
202    }
203
204    public override IDeepCloneable Clone(Cloner cloner) {
205      return new ProgrammableOperator(this, cloner);
206    }
207
208    private void RegisterEvents() {
209      Parameters.ItemsAdded += Parameters_Changed;
210      Parameters.ItemsRemoved += Parameters_Changed;
211      Parameters.ItemsReplaced += Parameters_Changed;
212      Parameters.CollectionReset += Parameters_Changed;
213    }
214
215    private void Parameters_Changed(object sender, CollectionItemsChangedEventArgs<IParameter> args) {
216      OnSignatureChanged();
217    }
218
219    protected void OnSignatureChanged() {
220      executeMethod = null;
221      EventHandler handler = SignatureChanged;
222      if (handler != null) handler(this, EventArgs.Empty);
223    }
224
225    private static void StaticInitialize() {
226      lock (initLock) {
227        if (defaultPluginDict != null && defaultAssemblyDict != null)
228          return;
229        defaultAssemblyDict = DiscoverAssemblies();
230        defaultPluginDict = GroupAssemblies(defaultAssemblyDict.Keys);
231      }
232    }
233
234    private static Dictionary<string, List<Assembly>> GroupAssemblies(IEnumerable<Assembly> assemblies) {
235      var plugins = new Dictionary<string, List<Assembly>>();
236      var locationTable = assemblies.ToDictionary(a => a.Location, a => a);
237
238      foreach (var plugin in ApplicationManager.Manager.Plugins) {
239        var aList = new List<Assembly>();
240        foreach (var aName in from file in plugin.Files
241                              where file.Type == PluginFileType.Assembly
242                              select file.Name) {
243          Assembly a;
244          locationTable.TryGetValue(aName, out a);
245          if (a != null) {
246            aList.Add(a);
247            locationTable.Remove(aName);
248          }
249        }
250        plugins[plugin.Name] = aList;
251      }
252
253      plugins["other"] = locationTable.Values.ToList();
254      return plugins;
255    }
256
257    protected static List<Assembly> defaultAssemblies = new List<Assembly>() {
258      typeof(System.Linq.Enumerable).Assembly,  // add reference to version 3.5 of System.dll
259      typeof(System.Collections.Generic.List<>).Assembly,
260      typeof(System.Text.StringBuilder).Assembly,
261      typeof(System.Data.Linq.DataContext).Assembly,
262      typeof(System.ComponentModel.INotifyPropertyChanged).Assembly,
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", "v3.5" },  // support C# 3.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      if (results.Errors.HasErrors) {
345        CompileErrors = results.Errors;
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        CompileErrors = null;
358        Assembly assembly = results.CompiledAssembly;
359        Type[] types = assembly.GetTypes();
360        executeMethod = types[0].GetMethod("Execute");
361      }
362    }
363
364    private CodeCompileUnit CreateCompilationUnit() {
365      CodeNamespace ns = new CodeNamespace("HeuristicLab.Operators.Programmable.CustomOperators");
366      ns.Types.Add(CreateType());
367      ns.Imports.AddRange(
368        GetSelectedAndValidNamespaces()
369        .Select(n => new CodeNamespaceImport(n))
370        .ToArray());
371      CodeCompileUnit unit = new CodeCompileUnit();
372      unit.Namespaces.Add(ns);
373      return unit;
374    }
375
376    public IEnumerable<string> GetSelectedAndValidNamespaces() {
377      var possibleNamespaces = new HashSet<string>(GetAllNamespaces(true));
378      foreach (var ns in Namespaces)
379        if (possibleNamespaces.Contains(ns))
380          yield return ns;
381    }
382
383    public static readonly Regex SafeTypeNameCharRegex = new Regex("[_a-zA-Z0-9]+");
384    public static readonly Regex SafeTypeNameRegex = new Regex("[_a-zA-Z][_a-zA-Z0-9]*");
385
386    public string CompiledTypeName {
387      get {
388        var sb = new StringBuilder();
389        foreach (string s in SafeTypeNameCharRegex.Matches(Name).Cast<Match>().Select(m => m.Value)) {
390          sb.Append(s);
391        }
392        return SafeTypeNameRegex.Match(sb.ToString()).Value;
393      }
394    }
395
396    private CodeTypeDeclaration CreateType() {
397      CodeTypeDeclaration typeDecl = new CodeTypeDeclaration(CompiledTypeName) {
398        IsClass = true,
399        TypeAttributes = TypeAttributes.Public,
400      };
401      typeDecl.Members.Add(CreateMethod());
402      return typeDecl;
403    }
404
405    public string Signature {
406      get {
407        var sb = new StringBuilder()
408        .Append("public static IOperation Execute(")
409        .Append(TypeNameParser.Parse(GetType().FullName).GetTypeNameInCode(namespaces))
410        .Append(" op, ")
411        .Append(TypeNameParser.Parse(typeof(IExecutionContext).FullName).GetTypeNameInCode(namespaces))
412        .Append(" context");
413        foreach (IParameter param in Parameters) {
414          sb.Append(String.Format(", {0} {1}",
415            TypeNameParser.Parse(param.GetType().FullName).GetTypeNameInCode(namespaces),
416            param.Name));
417        }
418        return sb.Append(")").ToString();
419      }
420    }
421
422    public event EventHandler SignatureChanged;
423
424    private static Regex lineSplitter = new Regex(@"\r\n|\r|\n");
425
426    private CodeMemberMethod CreateMethod() {
427      CodeMemberMethod method = new CodeMemberMethod();
428      method.Name = "Execute";
429      method.ReturnType = new CodeTypeReference(typeof(IOperation));
430      method.Attributes = MemberAttributes.Public | MemberAttributes.Static;
431      method.Parameters.Add(new CodeParameterDeclarationExpression(GetType(), "op"));
432      method.Parameters.Add(new CodeParameterDeclarationExpression(typeof(IExecutionContext), "context"));
433      foreach (var param in Parameters)
434        method.Parameters.Add(new CodeParameterDeclarationExpression(param.GetType(), param.Name));
435      string[] codeLines = lineSplitter.Split(code);
436      for (int i = 0; i < codeLines.Length; i++) {
437        codeLines[i] = string.Format("#line {0} \"ProgrammableOperator\"{1}{2}", i + 1, "\r\n", codeLines[i]);
438      }
439      method.Statements.Add(new CodeSnippetStatement(string.Join("\r\n", codeLines) + MethodSuffix));
440      return method;
441    }
442
443    public virtual string MethodSuffix {
444      get { return "return null;"; }
445    }
446
447    #endregion
448
449    #region HeuristicLab interfaces
450
451    public override IOperation Apply() {
452      lock (syncRoot) {
453        if (executeMethod == null) {
454          Compile();
455        }
456      }
457
458      var parameters = new List<object>() { this, ExecutionContext };
459      parameters.AddRange(Parameters.Select(p => (object)p));
460      return (IOperation)executeMethod.Invoke(null, parameters.ToArray());
461    }
462
463    public event EventHandler CodeChanged;
464    protected virtual void OnCodeChanged() {
465      EventHandler handler = CodeChanged;
466      if (handler != null) handler(this, EventArgs.Empty);
467    }
468
469    #endregion
470  }
471}
Note: See TracBrowser for help on using the repository browser.