#region License Information
/* HeuristicLab
* Copyright (C) 2002-2018 Heuristic and Evolutionary Algorithms Laboratory (HEAL)
*
* This file is part of HeuristicLab.
*
* HeuristicLab is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* HeuristicLab is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with HeuristicLab. If not, see .
*/
#endregion
using System;
using System.CodeDom.Compiler;
using System.Collections.Generic;
using System.Drawing;
using System.Globalization;
using System.Linq;
using System.Reflection;
using System.Windows.Forms;
using HeuristicLab.Common;
using HeuristicLab.Common.Resources;
using HeuristicLab.Core.Views;
using HeuristicLab.MainForm;
namespace HeuristicLab.Scripting.Views {
[View("Script View")]
[Content(typeof(Script), true)]
public partial class ScriptView : NamedItemView {
private const string NotCompiledMessage = "Not compiled";
private const string CompilationSucceededMessage = "Compilation succeeded";
private const string CompilationFailedMessage = "Compilation failed";
private const string AssembliesLoadingMessage = "Loading Assemblies";
private const string AssembliesUnloadingMessage = "Unloading Assemblies";
private const int SilentAssemblyLoadingOperationLimit = 10;
#region Properties
public new Script Content {
get { return (Script)base.Content; }
set { base.Content = value; }
}
public override bool ReadOnly {
get { return codeEditor.ReadOnly || base.ReadOnly; }
set { base.ReadOnly = codeEditor.ReadOnly = value; }
}
public override bool Locked {
get { return codeEditor.ReadOnly || base.Locked; }
set { base.Locked = codeEditor.ReadOnly = value; }
}
#endregion
public ScriptView() {
InitializeComponent();
errorListView.SmallImageList.Images.AddRange(new Image[] { VSImageLibrary.Warning, VSImageLibrary.Error });
}
protected override void RegisterContentEvents() {
base.RegisterContentEvents();
Content.CodeChanged += Content_CodeChanged;
}
protected override void DeregisterContentEvents() {
Content.CodeChanged -= Content_CodeChanged;
base.DeregisterContentEvents();
}
#region Overrides
protected override void OnContentChanged() {
base.OnContentChanged();
if (Content == null) {
codeEditor.UserCode = string.Empty;
codeEditor.ClearEditHistory();
} else {
codeEditor.UserCode = Content.Code;
codeEditor.ClearEditHistory();
codeEditor.AddAssembliesAsync(Content.GetAssemblies());
if (Content.CompileErrors == null) {
UpdateInfoTextLabel(NotCompiledMessage, SystemColors.ControlText);
}
}
}
protected override void SetEnabledStateOfControls() {
base.SetEnabledStateOfControls();
compileButton.Enabled = Content != null && !Locked && !ReadOnly;
codeEditor.Enabled = Content != null;
}
protected override bool ProcessCmdKey(ref Message msg, Keys keyData) {
switch (keyData) {
case Keys.F6:
if (Content != null && !Locked)
Compile();
return true;
}
return base.ProcessCmdKey(ref msg, keyData);
}
#endregion
public virtual bool Compile() {
ReadOnly = true;
Locked = true;
errorListView.Items.Clear();
outputTextBox.Text = "Compiling ... ";
try {
Content.Compile();
outputTextBox.AppendText(CompilationSucceededMessage);
UpdateInfoTextLabel(CompilationSucceededMessage, Color.DarkGreen);
return true;
} catch (CompilationException) {
if (Content.CompileErrors.HasErrors) {
outputTextBox.AppendText(CompilationFailedMessage);
UpdateInfoTextLabel(CompilationFailedMessage, Color.DarkRed);
return false;
} else {
outputTextBox.AppendText(CompilationSucceededMessage);
UpdateInfoTextLabel(CompilationSucceededMessage, Color.DarkGreen);
return true;
}
} finally {
ShowCompilationResults();
if (Content.CompileErrors.Count > 0)
infoTabControl.SelectedTab = errorListTabPage;
ReadOnly = false;
Locked = false;
codeEditor.Focus();
}
}
#region Helpers
protected virtual void ShowCompilationResults() {
var messages = Content.CompileErrors.OfType()
.OrderBy(x => x.IsWarning)
.ThenBy(x => x.Line)
.ThenBy(x => x.Column);
foreach (var m in messages) {
var item = new ListViewItem { Tag = m };
item.SubItems.AddRange(new[] {
m.IsWarning ? "Warning" : "Error",
m.ErrorNumber,
m.Line.ToString(CultureInfo.InvariantCulture),
m.Column.ToString(CultureInfo.InvariantCulture),
m.ErrorText
});
item.ImageIndex = m.IsWarning ? 0 : 1;
errorListView.Items.Add(item);
}
codeEditor.ShowCompileErrors(Content.CompileErrors);
AdjustErrorListViewColumnSizes();
}
protected virtual void UpdateInfoTextLabel(string message, Color color) {
infoTextLabel.Text = message;
infoTextLabel.ForeColor = color;
}
protected virtual void AdjustErrorListViewColumnSizes() {
foreach (ColumnHeader ch in errorListView.Columns)
// adjusts the column width to the width of the column header
ch.Width = -2;
}
#region ProgressView
private bool progressViewCreated;
private void AddProgressView(string progressMessage) {
var mainForm = MainFormManager.GetMainForm();
mainForm.AddOperationProgressToView(this, progressMessage);
progressViewCreated = true;
}
private void RemoveProgressView() {
if (!progressViewCreated) return;
var mainForm = MainFormManager.GetMainForm();
mainForm.RemoveOperationProgressFromView(this);
progressViewCreated = false;
}
#endregion
#endregion
#region Event Handlers
protected virtual void Content_CodeChanged(object sender, EventArgs e) {
if (InvokeRequired) Invoke((Action