source: stable/HeuristicLab.Scripting.Views/3.3/ScriptView.cs @ 17838

Last change on this file since 17838 was 17838, checked in by mkommend, 8 weeks ago

#3045: Merged r17384, r17385, r17386 into stable.

File size: 9.1 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.Compiler;
24using System.Collections.Generic;
25using System.Drawing;
26using System.Globalization;
27using System.Linq;
28using System.Reflection;
29using System.Windows.Forms;
30using HeuristicLab.Common;
31using HeuristicLab.Common.Resources;
32using HeuristicLab.Core.Views;
33using HeuristicLab.MainForm;
34
35namespace HeuristicLab.Scripting.Views {
36
37  [View("Script View")]
38  [Content(typeof(Script), true)]
39  public partial class ScriptView : NamedItemView {
40    private const string NotCompiledMessage = "Not compiled";
41    private const string CompilationSucceededMessage = "Compilation succeeded";
42    private const string CompilationFailedMessage = "Compilation failed";
43    private const string AssembliesLoadingMessage = "Loading Assemblies";
44    private const string AssembliesUnloadingMessage = "Unloading Assemblies";
45    private const int SilentAssemblyLoadingOperationLimit = 10;
46
47    #region Properties
48    public new Script Content {
49      get { return (Script)base.Content; }
50      set { base.Content = value; }
51    }
52
53    public override bool ReadOnly {
54      get { return codeEditor.ReadOnly || base.ReadOnly; }
55      set { base.ReadOnly = codeEditor.ReadOnly = value; }
56    }
57
58    public override bool Locked {
59      get { return codeEditor.ReadOnly || base.Locked; }
60      set { base.Locked = codeEditor.ReadOnly = value; }
61    }
62    #endregion
63
64    public ScriptView() {
65      InitializeComponent();
66      errorListView.SmallImageList.Images.AddRange(new Image[] { VSImageLibrary.Warning, VSImageLibrary.Error });
67    }
68
69    protected override void RegisterContentEvents() {
70      base.RegisterContentEvents();
71      Content.CodeChanged += Content_CodeChanged;
72    }
73
74    protected override void DeregisterContentEvents() {
75      Content.CodeChanged -= Content_CodeChanged;
76      base.DeregisterContentEvents();
77    }
78
79    #region Overrides
80    protected override void OnContentChanged() {
81      base.OnContentChanged();
82      if (Content == null) {
83        codeEditor.UserCode = string.Empty;
84        codeEditor.ClearEditHistory();
85      } else {
86        codeEditor.UserCode = Content.Code;
87        codeEditor.ClearEditHistory();
88        codeEditor.AddAssembliesAsync(Content.GetAssemblies());
89        if (Content.CompileErrors == null) {
90          UpdateInfoTextLabel(NotCompiledMessage, SystemColors.ControlText);
91        }
92      }
93    }
94
95    protected override void SetEnabledStateOfControls() {
96      base.SetEnabledStateOfControls();
97      compileButton.Enabled = Content != null && !Locked && !ReadOnly;
98      codeEditor.Enabled = Content != null;
99    }
100
101    protected override bool ProcessCmdKey(ref Message msg, Keys keyData) {
102      switch (keyData) {
103        case Keys.F6:
104          if (Content != null && !Locked)
105            Compile();
106          return true;
107      }
108      return base.ProcessCmdKey(ref msg, keyData);
109    }
110    #endregion
111
112    public virtual bool Compile() {
113      ReadOnly = true;
114      Locked = true;
115      errorListView.Items.Clear();
116      outputTextBox.Text = "Compiling ... ";
117      try {
118        Content.Compile();
119        outputTextBox.AppendText(CompilationSucceededMessage);
120        UpdateInfoTextLabel(CompilationSucceededMessage, Color.DarkGreen);
121        return true;
122      } catch (CompilationException) {
123        if (Content.CompileErrors.HasErrors) {
124          outputTextBox.AppendText(CompilationFailedMessage);
125          UpdateInfoTextLabel(CompilationFailedMessage, Color.DarkRed);
126          return false;
127        } else {
128          outputTextBox.AppendText(CompilationSucceededMessage);
129          UpdateInfoTextLabel(CompilationSucceededMessage, Color.DarkGreen);
130          return true;
131        }
132      } finally {
133        ShowCompilationResults();
134        if (Content.CompileErrors.Count > 0)
135          infoTabControl.SelectedTab = errorListTabPage;
136        ReadOnly = false;
137        Locked = false;
138        codeEditor.Focus();
139      }
140    }
141
142    #region Helpers
143    protected virtual void ShowCompilationResults() {
144      var messages = Content.CompileErrors.OfType<CompilerError>()
145                                      .OrderBy(x => x.IsWarning)
146                                      .ThenBy(x => x.Line)
147                                      .ThenBy(x => x.Column);
148
149      foreach (var m in messages) {
150        var item = new ListViewItem { Tag = m };
151        item.SubItems.AddRange(new[] {
152          m.IsWarning ? "Warning" : "Error",
153          m.ErrorNumber,
154          m.Line.ToString(CultureInfo.InvariantCulture),
155          m.Column.ToString(CultureInfo.InvariantCulture),
156          m.ErrorText
157        });
158        item.ImageIndex = m.IsWarning ? 0 : 1;
159        errorListView.Items.Add(item);
160      }
161
162      codeEditor.ShowCompileErrors(Content.CompileErrors);
163
164      AdjustErrorListViewColumnSizes();
165    }
166
167    protected virtual void UpdateInfoTextLabel(string message, Color color) {
168      infoTextLabel.Text = message;
169      infoTextLabel.ForeColor = color;
170    }
171
172    protected virtual void AdjustErrorListViewColumnSizes() {
173      foreach (ColumnHeader ch in errorListView.Columns)
174        // adjusts the column width to the width of the column header
175        ch.Width = -2;
176    }
177
178    #region ProgressView
179    private bool progressViewCreated;
180
181    private void AddProgressView(string progressMessage) {
182      Progress.Show(this, progressMessage, ProgressMode.Indeterminate);
183      progressViewCreated = true;
184    }
185
186    private void RemoveProgressView() {
187      if (!progressViewCreated) return;
188      Progress.Hide(this);
189      progressViewCreated = false;
190    }
191    #endregion
192    #endregion
193
194    #region Event Handlers
195    protected virtual void Content_CodeChanged(object sender, EventArgs e) {
196      if (InvokeRequired) Invoke((Action<object, EventArgs>)Content_CodeChanged, sender, e);
197      else {
198        codeEditor.UserCode = Content.Code;
199      }
200    }
201
202    private void compileButton_Click(object sender, EventArgs e) {
203      Compile();
204    }
205
206    private void codeEditor_TextEditorTextChanged(object sender, EventArgs e) {
207      if (Content == null) return;
208      Content.Code = codeEditor.UserCode;
209    }
210
211    private void errorListView_MouseClick(object sender, MouseEventArgs e) {
212      if (e.Button != MouseButtons.Left) return;
213
214      var item = errorListView.SelectedItems[0];
215      var message = (CompilerError)item.Tag;
216
217      codeEditor.ScrollToPosition(message.Line, message.Column);
218      codeEditor.Focus();
219    }
220
221    private void errorListView_MouseDoubleClick(object sender, MouseEventArgs e) {
222      if (e.Button != MouseButtons.Left) return;
223
224      var item = errorListView.SelectedItems[0];
225      var message = (CompilerError)item.Tag;
226
227      using (var dialog = new CompilerErrorDialog(message)) {
228        dialog.ShowDialog(this);
229      };
230    }
231    #endregion
232
233    private void codeEditor_AssembliesLoading(object sender, EventArgs<IEnumerable<Assembly>> e) {
234      if (InvokeRequired) Invoke((Action<object, EventArgs<IEnumerable<Assembly>>>)codeEditor_AssembliesLoading, sender, e);
235      else {
236        int nrOfAssemblies = e.Value.Count();
237        if (nrOfAssemblies > SilentAssemblyLoadingOperationLimit)
238          AddProgressView(AssembliesLoadingMessage);
239      }
240    }
241
242    private void codeEditor_AssembliesLoaded(object sender, EventArgs<IEnumerable<Assembly>> e) {
243      if (InvokeRequired) Invoke((Action<object, EventArgs<IEnumerable<Assembly>>>)codeEditor_AssembliesLoaded, sender, e);
244      else {
245        RemoveProgressView();
246      }
247    }
248
249    private void codeEditor_AssembliesUnloading(object sender, EventArgs<IEnumerable<Assembly>> e) {
250      if (InvokeRequired) Invoke((Action<object, EventArgs<IEnumerable<Assembly>>>)codeEditor_AssembliesUnloading, sender, e);
251      else {
252        int nrOfAssemblies = e.Value.Count();
253        if (nrOfAssemblies > SilentAssemblyLoadingOperationLimit)
254          AddProgressView(AssembliesUnloadingMessage);
255      }
256    }
257
258    private void codeEditor_AssembliesUnloaded(object sender, EventArgs<IEnumerable<Assembly>> e) {
259      if (InvokeRequired) Invoke((Action<object, EventArgs<IEnumerable<Assembly>>>)codeEditor_AssembliesUnloaded, sender, e);
260      else {
261        RemoveProgressView();
262      }
263    }
264  }
265}
Note: See TracBrowser for help on using the repository browser.