ZoneBuilder/Source/Core/Editing/CopyPasteManager.cs
biwa f59fbed358 Sector/Linedef/Thing/Vertex Edit Form: the map will not be marked as changed anymore when canceling changes made in the forms, when the map wasn't marked as changed before
Copying map elements doesn't mark the map as changed anymore if the map wasn't marked as changed before copying
2023-05-08 13:21:15 +02:00

645 lines
19 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.Collections.Generic;
using System.IO;
using System.Windows.Forms;
using CodeImp.DoomBuilder.Actions;
using CodeImp.DoomBuilder.Config;
using CodeImp.DoomBuilder.Geometry;
using CodeImp.DoomBuilder.GZBuilder.Data;
using CodeImp.DoomBuilder.IO;
using CodeImp.DoomBuilder.Map;
using CodeImp.DoomBuilder.Types;
using CodeImp.DoomBuilder.Windows;
#endregion
namespace CodeImp.DoomBuilder.Editing
{
public class CopyPasteManager
{
#region ================== Constants
private const string CLIPBOARD_DATA_FORMAT = "GZDOOM_BUILDER_GEOMETRY";
private const string CLIPBOARD_DATA_FORMAT_DB2 = "DOOM_BUILDER_GEOMETRY";
#endregion
#region ================== Variables
// Disposing
private bool isdisposed;
// Last inserted prefab
private string lastprefabfile;
#endregion
#region ================== Properties
public bool IsDisposed { get { return isdisposed; } }
public bool IsPreviousPrefabAvailable { get { return (lastprefabfile != null); } }
#endregion
#region ================== Constructor / Disposer
// Constructor
internal CopyPasteManager()
{
// Initialize
// Bind any methods
General.Actions.BindMethods(this);
// We have no destructor
GC.SuppressFinalize(this);
}
// Disposer
internal void Dispose()
{
// Not already disposed?
if(!isdisposed)
{
// Unbind any methods
General.Actions.UnbindMethods(this);
// Done
isdisposed = true;
}
}
#endregion
#region ================== Methods
// This makes a prefab of the selection. Returns null when cancelled.
private static MemoryStream MakePrefab()
{
// Let the plugins know
if(General.Plugins.OnCopyBegin())
{
// Ask the editing mode to prepare selection for copying.
// The edit mode should mark all vertices, lines and sectors
// that need to be copied.
if(General.Editing.Mode.OnCopyBegin())
{
// Copy the marked geometry
// This links sidedefs that are not linked to a marked sector to a virtual sector
MapSet copyset = General.Map.Map.CloneMarked();
// Convert flags and activations to UDMF fields, if needed
if(!(General.Map.FormatInterface is UniversalMapSetIO || General.Map.FormatInterface is SRB2MapSetIO)) copyset.TranslateToUDMF(General.Map.FormatInterface.GetType());
// Write data to stream
MemoryStream memstream = new MemoryStream();
UniversalStreamWriter writer = new UniversalStreamWriter();
writer.RememberCustomTypes = false;
writer.Write(copyset, memstream, null);
// Compress the stream
memstream.Seek(0, SeekOrigin.Begin);
MemoryStream compressed = SharpCompressHelper.CompressStream(memstream);//mxd
// Done
memstream.Dispose();
General.Editing.Mode.OnCopyEnd();
General.Plugins.OnCopyEnd();
return compressed;
}
}
// Aborted
return null;
}
// This pastes a prefab. Returns false when paste was cancelled.
public void InsertPrefabStream(Stream stream, PasteOptions options)
{
// Cancel volatile mode
General.Editing.DisengageVolatileMode();
// Let the plugins know
if(General.Plugins.OnPasteBegin(options))
{
// Ask the editing mode to prepare selection for pasting.
if(General.Editing.Mode.OnPasteBegin(options))
{
Cursor oldcursor = Cursor.Current;
Cursor.Current = Cursors.WaitCursor;
if(stream != null)
PastePrefab(stream, options);
General.MainWindow.UpdateInterface();
Cursor.Current = oldcursor;
}
}
}
// This pastes a prefab. Returns false when paste was cancelled.
private static void PastePrefab(Stream filedata, PasteOptions options)
{
// Create undo
General.MainWindow.DisplayStatus(StatusType.Action, "Inserted prefab.");
General.Map.UndoRedo.CreateUndo("Insert prefab");
// Decompress stream
MemoryStream memstream; //mxd
try
{
memstream = SharpCompressHelper.DecompressStream(filedata); //mxd
memstream.Seek(0, SeekOrigin.Begin);
}
catch(Exception e)
{
General.ErrorLogger.Add(ErrorType.Error, e.GetType().Name + " while reading prefab from file: " + e.Message);
General.WriteLogLine(e.StackTrace);
General.ShowErrorMessage("Unable to load prefab. See log file for error details.", MessageBoxButtons.OK);
return;
}
// Mark all current geometry
General.Map.Map.ClearAllMarks(true);
// Read data stream
UniversalStreamReader reader = new UniversalStreamReader(General.Map.FormatInterface.UIFields); //mxd
reader.StrictChecking = false;
General.Map.Map.BeginAddRemove();
//mxd. UniversalStreamReader can now throw errors
try
{
reader.Read(General.Map.Map, memstream);
}
catch(Exception e)
{
General.ErrorLogger.Add(ErrorType.Error, "Unable to load prefab. " + e.GetType().Name + ": " + e.Message);
General.ShowErrorMessage("Unable to load prefab." + Environment.NewLine + Environment.NewLine + e.Message, MessageBoxButtons.OK);
return;
}
finally
{
General.Map.Map.EndAddRemove();
}
// The new geometry is not marked, so invert the marks to get it marked
General.Map.Map.InvertAllMarks();
// Convert UDMF fields back to flags and activations, if needed
if(!(General.Map.FormatInterface is UniversalMapSetIO || General.Map.FormatInterface is SRB2MapSetIO)) General.Map.Map.TranslateFromUDMF();
// Modify tags and actions if preferred
if(options.ChangeTags == PasteOptions.TAGS_REMOVE) Tools.RemoveMarkedTags();
if(options.ChangeTags == PasteOptions.TAGS_RENUMBER) Tools.RenumberMarkedTags();
if(options.RemoveActions) Tools.RemoveMarkedActions();
// Done
memstream.Dispose();
General.Map.Map.UpdateConfiguration();
General.Map.ThingsFilter.Update();
General.Editing.Mode.OnPasteEnd(options);
General.Plugins.OnPasteEnd(options);
}
// This performs the copy. Returns false when copy was cancelled.
private static bool DoCopySelection(string desc)
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
// Let the plugins know
if(General.Plugins.OnCopyBegin())
{
// Ask the editing mode to prepare selection for copying.
// The edit mode should mark all vertices, lines and sectors
// that need to be copied.
if(General.Editing.Mode.OnCopyBegin())
{
bool oldmapischanged = General.Map.IsChanged;
General.MainWindow.DisplayStatus(StatusType.Action, desc);
// Copy the marked geometry
// This links sidedefs that are not linked to a marked sector to a virtual sector
MapSet copyset = General.Map.Map.CloneMarked();
// Convert flags and activations to UDMF fields, if needed
if (!(General.Map.FormatInterface is UniversalMapSetIO || General.Map.FormatInterface is SRB2MapSetIO)) copyset.TranslateToUDMF(General.Map.FormatInterface.GetType());
// Write data to stream
MemoryStream memstream = new MemoryStream();
ClipboardStreamWriter writer = new ClipboardStreamWriter(); //mxd
writer.Write(copyset, memstream);
// Set on clipboard
Clipboard.SetData(CLIPBOARD_DATA_FORMAT, memstream);
// General.Map.Map.CloneMarked will set General.Map.IsChanged to true, since it recreated the map. But since this
// creation happens in another MapSet, the currently opened map is actually not changed. Force the IsChanged property
// to false if the map wasn't changed before doing the copying
if (oldmapischanged == false)
General.Map.ForceMapIsChangedFalse();
// Done
memstream.Dispose();
General.Editing.Mode.OnCopyEnd();
General.Plugins.OnCopyEnd();
return true;
}
}
}
else
{
// Copy not allowed
General.MessageBeep(MessageBeepType.Warning);
}
// Aborted
return false;
}
// This performs the paste. Returns false when paste was cancelled.
private static void DoPasteSelection(PasteOptions options)
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
bool havepastedata = Clipboard.ContainsData(CLIPBOARD_DATA_FORMAT); //mxd
bool havedb2pastedata = Clipboard.ContainsData(CLIPBOARD_DATA_FORMAT_DB2); //mxd
// Anything to paste?
if(havepastedata || havedb2pastedata)
{
// Cancel volatile mode
General.Editing.DisengageVolatileMode();
// Let the plugins know
if(General.Plugins.OnPasteBegin(options))
{
// Ask the editing mode to prepare selection for pasting.
if(General.Editing.Mode.OnPasteBegin(options.Copy()))
{
// Create undo
General.MainWindow.DisplayStatus(StatusType.Action, "Pasted selected elements.");
General.Map.UndoRedo.CreateUndo("Paste");
// Mark all current geometry
General.Map.Map.ClearAllMarks(true);
// Read from clipboard
if(havepastedata)
{
using(Stream memstream = (Stream)Clipboard.GetData(CLIPBOARD_DATA_FORMAT))
{
// Rewind before use
memstream.Seek(0, SeekOrigin.Begin);
// Read data stream
ClipboardStreamReader reader = new ClipboardStreamReader(); //mxd
General.Map.Map.BeginAddRemove();
bool success = reader.Read(General.Map.Map, memstream);
General.Map.Map.EndAddRemove();
if(!success) //mxd
{
General.Map.UndoRedo.WithdrawUndo(); // This will also mess with the marks...
General.Map.Map.ClearAllMarks(true); // So re-mark all current geometry...
}
}
}
// mxd. DB2/DB64 interop
else if(havedb2pastedata)
{
using(Stream memstream = (Stream)Clipboard.GetData(CLIPBOARD_DATA_FORMAT_DB2))
{
// Read data stream
UniversalStreamReader reader = new UniversalStreamReader(new Dictionary<MapElementType, Dictionary<string, UniversalType>>());
reader.StrictChecking = false;
General.Map.Map.BeginAddRemove();
reader.Read(General.Map.Map, memstream);
General.Map.Map.EndAddRemove();
}
}
else
{
throw new NotImplementedException("Unknown clipboard data format!");
}
// The new geometry is not marked, so invert the marks to get it marked
General.Map.Map.InvertAllMarks();
// Check if anything was pasted
List<Thing> things = General.Map.Map.GetMarkedThings(true); //mxd
int totalpasted = things.Count;
totalpasted += General.Map.Map.GetMarkedVertices(true).Count;
totalpasted += General.Map.Map.GetMarkedLinedefs(true).Count;
totalpasted += General.Map.Map.GetMarkedSidedefs(true).Count;
totalpasted += General.Map.Map.GetMarkedSectors(true).Count;
if(totalpasted > 0)
{
// Convert UDMF fields back to flags and activations, if needed
if(!(General.Map.FormatInterface is UniversalMapSetIO || General.Map.FormatInterface is SRB2MapSetIO)) General.Map.Map.TranslateFromUDMF();
//mxd. Translate texture names
General.Map.Map.TranslateTextureNames(General.Map.Config.UseLongTextureNames, true);
// Modify tags and actions if preferred
if(options.ChangeTags == PasteOptions.TAGS_REMOVE) Tools.RemoveMarkedTags();
if(options.ChangeTags == PasteOptions.TAGS_RENUMBER) Tools.RenumberMarkedTags();
if(options.RemoveActions) Tools.RemoveMarkedActions();
foreach(Thing t in things) t.UpdateConfiguration(); //mxd
General.Map.ThingsFilter.Update();
General.Editing.Mode.OnPasteEnd(options.Copy());
General.Plugins.OnPasteEnd(options);
}
}
}
}
else
{
// Nothing usefull on the clipboard
General.MessageBeep(MessageBeepType.Warning);
}
}
else
{
// Paste not allowed
General.MessageBeep(MessageBeepType.Warning);
}
}
#endregion
#region ================== Actions
// This copies the current selection
[BeginAction("copyselection")]
public void CopySelection()
{
DoCopySelection("Copied selected elements.");
}
// This cuts the current selection
[BeginAction("cutselection")]
public void CutSelection()
{
// Copy selected geometry
if(DoCopySelection("Cut selected elements."))
{
// Get the delete action and check if it's bound
Actions.Action deleteitem = General.Actions["builder_deleteitem"];
if(deleteitem.BeginBound)
{
// Perform delete action
deleteitem.Begin();
deleteitem.End();
}
else
{
// Action not bound
General.Interface.DisplayStatus(StatusType.Warning, "Cannot remove that in this mode.");
}
}
}
// This pastes what is on the clipboard and marks the new geometry
[BeginAction("pasteselectionspecial")]
public void PasteSelectionSpecial()
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
PasteOptionsForm form = new PasteOptionsForm();
DialogResult result = form.ShowDialog(General.MainWindow);
if(result == DialogResult.OK) DoPasteSelection(form.Options);
form.Dispose();
}
else
{
// Paste not allowed
General.MessageBeep(MessageBeepType.Warning);
}
}
// This pastes what is on the clipboard and marks the new geometry
[BeginAction("pasteselection")]
public void PasteSelection()
{
DoPasteSelection(General.Settings.PasteOptions);
}
// This creates a new prefab from selection
[BeginAction("createprefab")]
public void CreatePrefab()
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
Cursor oldcursor = Cursor.Current;
Cursor.Current = Cursors.WaitCursor;
MemoryStream data = MakePrefab();
if(data != null)
{
Cursor.Current = oldcursor;
SaveFileDialog savefile = new SaveFileDialog();
savefile.Filter = "Doom Builder Prefabs (*.dbprefab)|*.dbprefab";
savefile.Title = "Save Prefab As";
savefile.AddExtension = true;
savefile.CheckPathExists = true;
savefile.OverwritePrompt = true;
savefile.ValidateNames = true;
if(savefile.ShowDialog(General.MainWindow) == DialogResult.OK)
{
try
{
Cursor.Current = Cursors.WaitCursor;
if(File.Exists(savefile.FileName)) File.Delete(savefile.FileName);
File.WriteAllBytes(savefile.FileName, data.ToArray());
}
catch(Exception e)
{
Cursor.Current = oldcursor;
General.ErrorLogger.Add(ErrorType.Error, e.GetType().Name + " while writing prefab to file: " + e.Message);
General.WriteLogLine(e.StackTrace);
General.ShowErrorMessage("Error while writing prefab to file! See log file for error details.", MessageBoxButtons.OK);
}
}
data.Dispose();
}
else
{
// Can't make a prefab right now
General.MessageBeep(MessageBeepType.Warning);
}
// Done
General.MainWindow.UpdateInterface();
Cursor.Current = oldcursor;
}
else
{
// Create prefab not allowed
General.MessageBeep(MessageBeepType.Warning);
}
}
// This pastes a prefab from file
[BeginAction("insertprefabfile")]
public void InsertPrefabFile()
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
PasteOptions options = General.Settings.PasteOptions.Copy();
// Cancel volatile mode
General.Editing.DisengageVolatileMode();
// Let the plugins know
if(General.Plugins.OnPasteBegin(options))
{
// Ask the editing mode to prepare selection for pasting.
if(General.Editing.Mode.OnPasteBegin(options))
{
Cursor oldcursor = Cursor.Current;
OpenFileDialog openfile = new OpenFileDialog();
openfile.Filter = "Doom Builder Prefabs (*.dbprefab)|*.dbprefab";
openfile.Title = "Open Prefab";
openfile.AddExtension = false;
openfile.CheckFileExists = true;
openfile.Multiselect = false;
openfile.ValidateNames = true;
if(openfile.ShowDialog(General.MainWindow) == DialogResult.OK)
{
FileStream stream = null;
try
{
Cursor.Current = Cursors.WaitCursor;
stream = File.OpenRead(openfile.FileName);
}
catch(Exception e)
{
Cursor.Current = oldcursor;
General.ErrorLogger.Add(ErrorType.Error, e.GetType().Name + " while reading prefab from file: " + e.Message);
General.WriteLogLine(e.StackTrace);
General.ShowErrorMessage("Error while reading prefab from file! See log file for error details.", MessageBoxButtons.OK);
}
if(stream != null)
{
PastePrefab(stream, options);
lastprefabfile = openfile.FileName;
stream.Dispose();
}
General.MainWindow.UpdateInterface();
}
Cursor.Current = oldcursor;
}
}
}
else
{
// Insert not allowed
General.MessageBeep(MessageBeepType.Warning);
}
}
// This pastes the previously inserted prefab
[BeginAction("insertpreviousprefab")]
public void InsertPreviousPrefab()
{
// Check if possible to copy/paste
if(General.Editing.Mode.Attributes.AllowCopyPaste)
{
PasteOptions options = General.Settings.PasteOptions.Copy();
// Is there a previously inserted prefab?
if(IsPreviousPrefabAvailable)
{
// Does the file still exist?
if(File.Exists(lastprefabfile))
{
// Cancel volatile mode
General.Editing.DisengageVolatileMode();
// Let the plugins know
if(General.Plugins.OnPasteBegin(options))
{
// Ask the editing mode to prepare selection for pasting.
if(General.Editing.Mode.OnPasteBegin(options))
{
Cursor oldcursor = Cursor.Current;
FileStream stream = null;
try
{
Cursor.Current = Cursors.WaitCursor;
stream = File.OpenRead(lastprefabfile);
}
catch(Exception e)
{
Cursor.Current = oldcursor;
General.ErrorLogger.Add(ErrorType.Error, e.GetType().Name + " while reading prefab from file: " + e.Message);
General.WriteLogLine(e.StackTrace);
General.ShowErrorMessage("Error while reading prefab from file! See log file for error details.", MessageBoxButtons.OK);
}
if (stream != null)
{
PastePrefab(stream, options);
stream.Dispose();
}
General.MainWindow.UpdateInterface();
Cursor.Current = oldcursor;
}
}
}
else
{
General.MessageBeep(MessageBeepType.Warning);
lastprefabfile = null;
General.MainWindow.UpdateInterface();
}
}
else
{
General.MessageBeep(MessageBeepType.Warning);
}
}
else
{
// Insert not allowed
General.MessageBeep(MessageBeepType.Warning);
}
}
#endregion
}
}