148 lines
4.6 KiB
C++
148 lines
4.6 KiB
C++
/**********************************************************************
|
|
|
|
Audacity: A Digital Audio Editor
|
|
|
|
UndoManager.h
|
|
|
|
Dominic Mazzoni
|
|
|
|
After each operation, call UndoManager's PushState, pass it
|
|
the entire track hierarchy. The UndoManager makes a duplicate
|
|
of every single track using its Duplicate method, which should
|
|
increment reference counts. If we were not at the top of
|
|
the stack when this is called, DELETE above first.
|
|
|
|
If a minor change is made, for example changing the visual
|
|
display of a track or changing the selection, you can call
|
|
ModifyState, which replaces the current state with the
|
|
one you give it, without deleting everything above it.
|
|
|
|
Each action has a long description and a short description
|
|
associated with it. The long description appears in the
|
|
History window and should be a complete sentence in the
|
|
past tense, for example, "Deleted 2 seconds.". The short
|
|
description should be one or two words at most, all
|
|
capitalized, and should represent the name of the command.
|
|
It will be appended on the end of the word "Undo" or "Redo",
|
|
for example the short description of "Deleted 2 seconds."
|
|
would just be "Delete", resulting in menu titles
|
|
"Undo Delete" and "Redo Delete".
|
|
|
|
UndoManager can also automatically consolidate actions into
|
|
a single state change. If the "consolidate" argument to
|
|
PushState is true, then up to 3 identical events in a row
|
|
will result in one PushState and 2 ModifyStates.
|
|
|
|
Undo() temporarily moves down one state and returns the track
|
|
hierarchy. If another PushState is called, the redo information
|
|
is lost.
|
|
|
|
Redo()
|
|
|
|
UndoAvailable()
|
|
|
|
RedoAvailable()
|
|
|
|
**********************************************************************/
|
|
|
|
#ifndef __AUDACITY_UNDOMANAGER__
|
|
#define __AUDACITY_UNDOMANAGER__
|
|
|
|
#include <memory>
|
|
#include <vector>
|
|
#include <wx/string.h>
|
|
#include "ondemand/ODTaskThread.h"
|
|
#include "SelectedRegion.h"
|
|
|
|
class Tags;
|
|
class Track;
|
|
class TrackList;
|
|
|
|
struct UndoStackElem;
|
|
struct UndoState {
|
|
UndoState(std::unique_ptr<TrackList> &&tracks_,
|
|
const std::shared_ptr<Tags> &tags_,
|
|
const SelectedRegion &selectedRegion_)
|
|
: tracks(std::move(tracks_)), tags(tags_), selectedRegion(selectedRegion_)
|
|
{}
|
|
|
|
std::unique_ptr<TrackList> tracks;
|
|
std::shared_ptr<Tags> tags;
|
|
SelectedRegion selectedRegion; // by value
|
|
};
|
|
|
|
using UndoStack = std::vector <std::unique_ptr<UndoStackElem>> ;
|
|
using SpaceArray = std::vector <wxLongLong_t> ;
|
|
|
|
// These flags control what extra to do on a PushState
|
|
// Default is AUTOSAVE
|
|
// Frequent/faster actions use CONSOLIDATE
|
|
enum class UndoPush {
|
|
MINIMAL = 0,
|
|
CONSOLIDATE = 1 << 0,
|
|
AUTOSAVE = 1 << 1
|
|
};
|
|
|
|
inline UndoPush operator | (UndoPush a, UndoPush b)
|
|
{ return static_cast<UndoPush>(static_cast<int>(a) | static_cast<int>(b)); }
|
|
inline UndoPush operator & (UndoPush a, UndoPush b)
|
|
{ return static_cast<UndoPush>(static_cast<int>(a) & static_cast<int>(b)); }
|
|
|
|
class AUDACITY_DLL_API UndoManager {
|
|
public:
|
|
UndoManager();
|
|
~UndoManager();
|
|
|
|
void PushState(const TrackList * l,
|
|
const SelectedRegion &selectedRegion,
|
|
const std::shared_ptr<Tags> &tags,
|
|
const wxString &longDescription, const wxString &shortDescription,
|
|
UndoPush flags = UndoPush::AUTOSAVE);
|
|
void ModifyState(const TrackList * l,
|
|
const SelectedRegion &selectedRegion, const std::shared_ptr<Tags> &tags);
|
|
void ClearStates();
|
|
void RemoveStates(int num); // removes the 'num' oldest states
|
|
void RemoveStateAt(int n); // removes the n'th state (1 is oldest)
|
|
unsigned int GetNumStates();
|
|
unsigned int GetCurrentState();
|
|
|
|
void GetShortDescription(unsigned int n, wxString *desc);
|
|
wxLongLong_t GetLongDescription(unsigned int n, wxString *desc, wxString *size);
|
|
void SetLongDescription(unsigned int n, const wxString &desc);
|
|
|
|
const UndoState &SetStateTo(unsigned int n, SelectedRegion *selectedRegion);
|
|
const UndoState &Undo(SelectedRegion *selectedRegion);
|
|
const UndoState &Redo(SelectedRegion *selectedRegion);
|
|
|
|
bool UndoAvailable();
|
|
bool RedoAvailable();
|
|
|
|
bool UnsavedChanges();
|
|
void StateSaved();
|
|
|
|
void CalculateSpaceUsage();
|
|
|
|
// void Debug(); // currently unused
|
|
|
|
///to mark as unsaved changes without changing the state/tracks.
|
|
void SetODChangesFlag();
|
|
bool HasODChangesFlag();
|
|
void ResetODChangesFlag();
|
|
|
|
private:
|
|
int current;
|
|
int saved;
|
|
UndoStack stack;
|
|
|
|
wxString lastAction;
|
|
int consolidationCount;
|
|
|
|
SpaceArray space;
|
|
|
|
bool mODChanges;
|
|
ODLock mODChangesMutex;//mODChanges is accessed from many threads.
|
|
|
|
};
|
|
|
|
#endif
|