ZoneBuilder/Source/Core/Controls/ScriptDocumentTab.cs
2016-01-30 00:04:41 +01:00

467 lines
13 KiB
C#

#region ================== Copyright (c) 2007 Pascal vd Heiden
/*
* Copyright (c) 2007 Pascal vd Heiden, www.codeimp.com
* This program is released under GNU General Public License
*
* This program 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.
*
*/
#endregion
#region ================== Namespaces
using System;
using System.IO;
using System.Collections.Generic;
using System.Drawing;
using System.Windows.Forms;
using CodeImp.DoomBuilder.Windows;
using CodeImp.DoomBuilder.Config;
using CodeImp.DoomBuilder.Compilers;
using CodeImp.DoomBuilder.GZBuilder.Data;
using CodeImp.DoomBuilder.GZBuilder.GZDoom;
using ScintillaNET;
#endregion
namespace CodeImp.DoomBuilder.Controls
{
internal abstract class ScriptDocumentTab : TabPage
{
#region ================== Constants
private const int EDITOR_BORDER_TOP = 4;
private const int EDITOR_BORDER_BOTTOM = 4;
private const int EDITOR_BORDER_LEFT = 4;
private const int EDITOR_BORDER_RIGHT = 4;
#endregion
#region ================== Variables
// The script edit control
protected readonly ScriptEditorControl editor;
private bool preventchanges; //mxd
private string title; //mxd
// Derived classes must set this!
protected ScriptConfiguration config;
// The panel we're on
protected readonly ScriptEditorPanel panel;
#endregion
#region ================== Properties
public virtual bool ExplicitSave { get { return true; } }
public virtual bool IsSaveAsRequired { get { return true; } }
public virtual bool IsClosable { get { return true; } }
public virtual bool IsReconfigurable { get { return true; } }
public virtual string Filename { get { return null; } }
public ScriptEditorPanel Panel { get { return panel; } }
internal Scintilla Scintilla { get { return editor.Scintilla; } } //mxd
public string Title { get { return title; } } //mxd
public bool IsChanged { get { return editor.IsChanged; } }
public int SelectionStart { get { return editor.SelectionStart; } set { editor.SelectionStart = value; } }
public int SelectionEnd { get { return editor.SelectionEnd; } set { editor.SelectionEnd = value; } }
public bool ShowWhitespace { get { return editor.ShowWhitespace; } set { editor.ShowWhitespace = value; } } //mxd
public bool WrapLongLines { get { return editor.WrapLongLines; } set { editor.WrapLongLines = value; } } //mxd
public string SelectedText { get { return editor.SelectedText; } } //mxd
public ScriptConfiguration Config { get { return config; } }
#endregion
#region ================== Events (mxd)
public new event EventHandler OnTextChanged; //mxd
#endregion
#region ================== Constructor
// Constructor
protected ScriptDocumentTab(ScriptEditorPanel panel)
{
// Keep panel
this.panel = panel;
// Make the script control
editor = new ScriptEditorControl();
editor.Location = new Point(EDITOR_BORDER_LEFT, EDITOR_BORDER_TOP);
editor.Size = new Size(this.ClientSize.Width - EDITOR_BORDER_LEFT - EDITOR_BORDER_RIGHT,
this.ClientSize.Height - EDITOR_BORDER_TOP - EDITOR_BORDER_BOTTOM);
editor.Anchor = AnchorStyles.Top | AnchorStyles.Bottom | AnchorStyles.Left | AnchorStyles.Right;
editor.Name = "editor";
editor.TabStop = true;
editor.TabIndex = 1;
this.Controls.Add(editor);
// Bind events
editor.OnExplicitSaveTab += panel.ExplicitSaveCurrentTab;
editor.OnOpenScriptBrowser += panel.OpenBrowseScript;
editor.OnOpenFindAndReplace += panel.OpenFindAndReplace;
editor.OnFindNext += panel.FindNext;
editor.OnFindPrevious += panel.FindPrevious; //mxd
editor.OnTextChanged += editor_TextChanged; //mxd
//mxd. Bind functionbar events
editor.FunctionBar.DropDown += functionbar_DropDown;
editor.FunctionBar.SelectedIndexChanged += functionbar_SelectedIndexChanged;
}
// Disposer
protected override void Dispose(bool disposing)
{
// Remove events
editor.OnExplicitSaveTab -= panel.ExplicitSaveCurrentTab;
editor.OnOpenScriptBrowser -= panel.OpenBrowseScript;
editor.OnOpenFindAndReplace -= panel.OpenFindAndReplace;
editor.OnFindNext -= panel.FindNext;
editor.OnFindPrevious -= panel.FindPrevious; //mxd
editor.OnTextChanged -= editor_TextChanged; //mxd
base.Dispose(disposing);
}
#endregion
#region ================== Methods
// This launches keyword help website
public bool LaunchKeywordHelp()
{
return editor.LaunchKeywordHelp();
}
// This refreshes the style settings
public virtual void RefreshSettings()
{
editor.RefreshStyle();
}
// This moves the caret to the given line
public virtual void MoveToLine(int linenumber)
{
editor.MoveToLine(linenumber);
}
// This clears all marks
public virtual void ClearMarks()
{
editor.ClearMarks();
}
// This creates error marks for errors that apply to this file
public virtual void MarkScriptErrors(IEnumerable<CompilerError> errors)
{
// Clear all marks
ClearMarks();
// Go for all errors that apply to this script
foreach(CompilerError e in errors)
{
if(VerifyErrorForScript(e))
{
// Add a mark on the line where this error occurred
editor.AddMark(e.linenumber);
}
}
}
// This verifies if the specified error applies to this script
public virtual bool VerifyErrorForScript(CompilerError e)
{
return false;
}
// This compiles the script
public virtual void Compile() { }
// This saves the document (used for both explicit and implicit)
// Return true when successfully saved
public virtual bool Save()
{
return false;
}
// This saves the document to a new file
// Return true when successfully saved
public virtual bool SaveAs(string filename)
{
return false;
}
// This changes the script configurations
public virtual void ChangeScriptConfig(ScriptConfiguration newconfig)
{
UpdateNavigator(); //mxd
}
// Call this to set the tab title
protected void SetTitle(string title)
{
this.title = title; //mxd
base.Text = (editor.IsChanged ? "\u25CF " + title : title); //mxd
}
//mxd
protected void UpdateTitle()
{
SetTitle(title);
}
// Perform undo
public void Undo()
{
editor.Undo();
}
// Perform redo
public void Redo()
{
editor.Redo();
}
// Perform cut
public void Cut()
{
editor.Cut();
}
// Perform copy
public void Copy()
{
editor.Copy();
}
// Perform paste
public void Paste()
{
editor.Paste();
}
// Find next result (mxd)
public bool FindNext(FindReplaceOptions options)
{
return FindNext(options, false);
}
// Find next result
public bool FindNext(FindReplaceOptions options, bool useselectionstart)
{
return editor.FindNext(options, useselectionstart);
}
// Find previous result (mxd)
public bool FindPrevious(FindReplaceOptions options)
{
return editor.FindPrevious(options);
}
// This replaces the selection with the given text
public void ReplaceSelection(string replacement)
{
editor.ReplaceSelection(replacement);
}
//mxd
protected void UpdateNavigator()
{
// Store currently selected item name
string prevtext = editor.FunctionBar.Text;
switch (config.ScriptType)
{
case ScriptType.ACS:
UpdateNavigatorAcs(new MemoryStream(editor.GetText()));
break;
case ScriptType.DECORATE:
UpdateNavigatorDecorate(new MemoryStream(editor.GetText()));
break;
case ScriptType.MODELDEF:
UpdateNavigatorModeldef(new MemoryStream(editor.GetText()));
break;
default: // Unsupported script type. Just clear the items
editor.FunctionBar.Items.Clear();
break;
}
// Put some text in the navigator (but don't actually trigger selection event)
editor.FunctionBar.Enabled = (editor.FunctionBar.Items.Count > 0);
if (editor.FunctionBar.Items.Count > 0)
{
preventchanges = true;
// Put the text back if we still have the corresponding item
if (!string.IsNullOrEmpty(prevtext))
{
foreach (var item in editor.FunctionBar.Items)
{
if (item.ToString() == prevtext)
{
editor.FunctionBar.Text = item.ToString();
break;
}
}
}
// No dice. Use the first item
if (string.IsNullOrEmpty(editor.FunctionBar.Text))
editor.FunctionBar.Text = editor.FunctionBar.Items[0].ToString();
preventchanges = false;
}
}
//mxd
private void UpdateNavigatorDecorate(MemoryStream stream)
{
if(stream == null) return;
editor.FunctionBar.Items.Clear();
DecorateParserSE parser = new DecorateParserSE();
if(parser.Parse(stream, "DECORATE", false))
{
editor.FunctionBar.Items.AddRange(parser.Actors.ToArray());
}
if(parser.HasError)
{
panel.ShowErrors(new List<CompilerError> { new CompilerError(parser.ErrorDescription, parser.ErrorSource, parser.ErrorLine) });
}
}
//mxd
private void UpdateNavigatorModeldef(MemoryStream stream)
{
if(stream == null) return;
editor.FunctionBar.Items.Clear();
ModeldefParserSE parser = new ModeldefParserSE();
if(parser.Parse(stream, "MODELDEF", false))
{
editor.FunctionBar.Items.AddRange(parser.Models.ToArray());
}
if(parser.HasError)
{
panel.ShowErrors(new List<CompilerError> { new CompilerError(parser.ErrorDescription, parser.ErrorSource, parser.ErrorLine) });
}
}
//mxd
private void UpdateNavigatorAcs(MemoryStream stream)
{
if(stream == null) return;
editor.FunctionBar.Items.Clear();
AcsParserSE parser = new AcsParserSE { AddArgumentsToScriptNames = true, IsMapScriptsLump = this is ScriptLumpDocumentTab };
if(parser.Parse(stream, "SCRIPTS", false))
{
editor.FunctionBar.Items.AddRange(parser.NamedScripts.ToArray());
editor.FunctionBar.Items.AddRange(parser.NumberedScripts.ToArray());
editor.FunctionBar.Items.AddRange(parser.Functions.ToArray());
}
if(parser.HasError)
{
panel.ShowErrors(new List<CompilerError> { new CompilerError(parser.ErrorDescription, parser.ErrorSource, parser.ErrorLine) });
}
}
//mxd
internal ScriptType VerifyScriptType()
{
ScriptTypeParserSE parser = new ScriptTypeParserSE();
if(parser.Parse(new MemoryStream(editor.GetText()), config.Description, false))
{
if(parser.ScriptType != ScriptType.UNKNOWN && config.ScriptType != parser.ScriptType)
return parser.ScriptType;
}
if(parser.HasError)
{
panel.ShowErrors(new List<CompilerError> { new CompilerError(parser.ErrorDescription, parser.ErrorSource, parser.ErrorLine) });
}
return ScriptType.UNKNOWN;
}
//mxd
internal void InsertSnippet(string name)
{
string[] lines = config.GetSnippet(name);
if (lines != null) editor.InsertSnippet(lines);
}
//mxd
internal void IndentSelection(bool indent)
{
editor.IndentSelection(indent);
}
#endregion
#region ================== Events
// Mouse released
protected override void OnMouseUp(MouseEventArgs e)
{
base.OnMouseUp(e);
// Focus to the editor!
editor.Focus();
editor.GrabFocus();
}
// Receiving focus?
protected override void OnGotFocus(EventArgs e)
{
base.OnGotFocus(e);
// Focus to the editor!
editor.Focus();
editor.GrabFocus();
}
//mxd
private void functionbar_SelectedIndexChanged(object sender, EventArgs e)
{
if (!preventchanges && editor.FunctionBar.SelectedItem is ScriptItem)
{
ScriptItem si = editor.FunctionBar.SelectedItem as ScriptItem;
editor.EnsureLineVisible(editor.LineFromPosition(si.CursorPosition));
editor.SelectionStart = si.CursorPosition;
editor.SelectionEnd = si.CursorPosition;
// Focus to the editor!
editor.Focus();
editor.GrabFocus();
}
}
//mxd
private void functionbar_DropDown(object sender, EventArgs e)
{
if(!preventchanges && editor.IsChanged) UpdateNavigator();
}
//mxd
private void editor_TextChanged(object sender, EventArgs eventArgs)
{
UpdateTitle();
if(OnTextChanged != null) OnTextChanged(this, EventArgs.Empty);
}
#endregion
}
}