File: undosys.cpp

package info (click to toggle)
freespace2 24.2.0%2Brepack-1
  • links: PTS, VCS
  • area: non-free
  • in suites: forky, sid
  • size: 43,716 kB
  • sloc: cpp: 595,001; ansic: 21,741; python: 1,174; sh: 457; makefile: 248; xml: 181
file content (166 lines) | stat: -rw-r--r-- 3,366 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
/*
* z64555's Undo system, created for the FreeSpace Source Code project
*/

#include "globalincs/pstypes.h"
#include "globalincs/undosys.h"
#include "globalincs/vmallocator.h"

// Pure virtual deconstructors must be defined.
Undo_item_base::~Undo_item_base() = default;

Undo_system::Undo_system()
	: max_undos(10) {};

Undo_system::Undo_system(size_t _undos)
	: max_undos(_undos) {};

void Undo_system::clamp_stacks() {
	while (undo_stack.size() > max_undos) {
		// If we're past the stack limit, de-construct and remove until we're in the limit
		// If max_undos is held constant (as it should be), the loop isn't necassary. 
		//   But, it also isn't that much different from an if{} when assembled, so there's no harm in using it
		delete undo_stack.front();
		undo_stack.pop_front();
	}

	// This while() shouldn't ever be triggered, but this is a safety to prevent any weird edge-cases.
	while (redo_stack.size() > max_undos) {
		delete redo_stack.front();
		redo_stack.pop_front();
	}
}

void Undo_system::clear() {
	clear_redo();

	for (auto &element : undo_stack) {
		delete element;
	}
	undo_stack.clear();
}

void Undo_system::clear_redo() {
	for (auto &element : redo_stack) {
		delete element;
	}
	redo_stack.clear();
}

size_t Undo_system::save_stack(Undo_stack& stack) {
	if (stack.size() == 0) {
		return 0;
	}
	
	clear_redo();

	// Copy the stack onto the heap, and push it into our undo_stack as a single item
	Undo_item_base *new_item = new Undo_stack(stack);

	Assert(new_item != nullptr);
	undo_stack.push_back(new_item);

	// Input stack is told to untrack the items, so that there's only one deletion handler for them
	stack.untrack();

	clamp_stacks();

	return undo_stack.size();
}

std::pair<const void*, const void*> Undo_system::redo() {
	std::pair<const void*, const void*> retval;

	if (redo_stack.empty()) {
		// Nothing to redo
		return {nullptr, nullptr};
	}

	auto &item = redo_stack.back();
	retval = item->restore();
	undo_stack.push_back(item);
	redo_stack.pop_back();

	return retval;
};

std::pair<const void*, const void*> Undo_system::undo() {
	std::pair<const void*, const void*> retval;
	
	if (undo_stack.empty()) {
		// Nothing to undo
		return {nullptr, nullptr};
	}

	auto &item = undo_stack.back();
	retval = item->restore();
	redo_stack.push_back(item);
	undo_stack.pop_back();

	return retval;
};

bool Undo_system::empty() {
	return undo_stack.empty();
}

bool Undo_system::empty_redo() {
	return redo_stack.empty();
}
size_t Undo_system::size() {
	return undo_stack.size();
}

size_t Undo_system::size_redo() {
	return redo_stack.size();
}


Undo_stack::Undo_stack()
	: reverse(false) {
}

Undo_stack::Undo_stack(size_t size)
	: reverse(false) {
	stack.reserve(size);
}

Undo_stack::~Undo_stack() {
	clear();
}

void Undo_stack::reserve(size_t size) {
	stack.reserve(size);
}

std::pair<const void*, const void*> Undo_stack::restore() {
	std::pair<const void*, const void*> retval;

	if (reverse) {
		for (auto it = stack.rbegin(); it != stack.rend(); ++it) {
			retval = (*it)->restore();
		}
	} else {
		for (auto &element : stack) {
			retval = element->restore();
		}
	}

	reverse = !reverse;
	return retval;
}

size_t Undo_stack::size() {
	return stack.size();
}

void Undo_stack::untrack() {
	stack.clear();
}

void Undo_stack::clear() {
	for (auto &element : stack) {
		delete element;
	}
	stack.clear();
}