summaryrefslogtreecommitdiffstats
path: root/source/WorldStorage.cpp
blob: 979283895802ee9ee2c24f0890f334c717a29a02 (plain) (blame)
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
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256

// WorldStorage.cpp

// Implements the cWorldStorage class representing the chunk loading / saving thread

// To add a new storage schema, implement a cWSSchema descendant and add it to cWorldStorage::InitSchemas()

#include "Globals.h"
#include "WorldStorage.h"
#include "WSSCompact.h"
#include "cWorld.h"
#include "cChunkGenerator.h"





/// Example storage schema - forgets all chunks ;)
class cWSSForgetful :
	public cWSSchema
{
public:
	cWSSForgetful(cWorld * a_World) : cWSSchema(a_World) {}
	
protected:
	// cWSSchema overrides:
	virtual bool LoadChunk(const cChunkPtr & a_Chunk) override {return false; }
	virtual bool SaveChunk(const cChunkPtr & a_Chunk) override {return true; }
	virtual const AString GetName(void) const override {return "forgetful"; }
} ;





///////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
// cWorldStorage:

cWorldStorage::cWorldStorage(void) :
	super("cWorldStorage"),
	m_World(NULL),
	m_SaveSchema(NULL)
{
}





cWorldStorage::~cWorldStorage()
{
	for (cWSSchemaList::iterator itr = m_Schemas.begin(); itr != m_Schemas.end(); ++itr)
	{
		delete *itr;
	}  // for itr - m_Schemas[]
	m_LoadQueue.clear();
	m_SaveQueue.clear();
}





bool cWorldStorage::Start(cWorld * a_World, const AString & a_StorageSchemaName)
{
	m_World = a_World;
	m_StorageSchemaName = a_StorageSchemaName;
	InitSchemas();
	
	return super::Start();
}





void cWorldStorage::WaitForFinish(void)
{
	LOG("Waiting for the world storage to finish saving");
	
	// Cancel all loading requests:
	cCSLock Lock(m_CSLoadQueue);
	m_LoadQueue.clear();
	
	// Wait for the thread to finish:
	mShouldTerminate = true;
	m_Event.Set();
	super::Wait();
}





void cWorldStorage::QueueLoadChunk(cChunkPtr & a_Chunk)
{
	// Queues the chunk for loading; if not loaded, the chunk will be generated
	cCSLock Lock(m_CSLoadQueue);
	m_LoadQueue.remove(a_Chunk);  // Don't add twice
	m_LoadQueue.push_back(a_Chunk);
	m_Event.Set();
}





void cWorldStorage::QueueSaveChunk(cChunkPtr & a_Chunk)
{
	cCSLock Lock(m_CSSaveQueue);
	m_SaveQueue.remove(a_Chunk);  // Don't add twice
	m_SaveQueue.push_back(a_Chunk);
	m_Event.Set();
}





void cWorldStorage::UnqueueLoad(const cChunkPtr & a_Chunk)
{
	cCSLock Lock(m_CSLoadQueue);
	m_LoadQueue.remove(a_Chunk);
}





void cWorldStorage::UnqueueSave(const cChunkPtr & a_Chunk)
{
	cCSLock Lock(m_CSSaveQueue);
	m_SaveQueue.remove(a_Chunk);
}





void cWorldStorage::InitSchemas(void)
{
	// The first schema added is considered the default
	m_Schemas.push_back(new cWSSCompact(m_World));
	m_Schemas.push_back(new cWSSForgetful(m_World));
	// Add new schemas here
	
	if (m_StorageSchemaName == "Default")
	{
		m_SaveSchema = m_Schemas.front();
		return;
	}
	for (cWSSchemaList::iterator itr = m_Schemas.begin(); itr != m_Schemas.end(); ++itr)
	{
		if ((*itr)->GetName() == m_StorageSchemaName)
		{
			m_SaveSchema = *itr;
			return;
		}
	}  // for itr - m_Schemas[]
	
	// Unknown schema selected, let the admin know:
	LOGWARNING("Unknown storage schema name \"%s\". Using default. Available schemas:", m_StorageSchemaName.c_str());
	for (cWSSchemaList::iterator itr = m_Schemas.begin(); itr != m_Schemas.end(); ++itr)
	{
		LOGWARNING("\t\"%s\"", (*itr)->GetName().c_str());
	}
	m_SaveSchema = m_Schemas.front();
}





void cWorldStorage::Execute(void)
{
	while (!mShouldTerminate)
	{
		m_Event.Wait();
		
		// Process both queues until they are empty again:
		bool HasMore;
		do
		{
			HasMore = false;
			if (mShouldTerminate)
			{
				return;
			}
			
			// Load 1 chunk:
			cChunkPtr ToLoad;
			{
				cCSLock Lock(m_CSLoadQueue);
				if (m_LoadQueue.size() > 0)
				{
					ToLoad = m_LoadQueue.front();
					m_LoadQueue.pop_front();
				}
				HasMore = (m_LoadQueue.size() > 0);
			}
			if ((ToLoad != NULL) && !LoadChunk(ToLoad))
			{
				// The chunk couldn't be loaded, generate it:
				m_World->GetGenerator().GenerateChunk(ToLoad->GetPosX(), ToLoad->GetPosZ());
			}
			
			// Save 1 chunk:
			cChunkPtr Save;
			{
				cCSLock Lock(m_CSSaveQueue);
				if (m_SaveQueue.size() > 0)
				{
					Save = m_SaveQueue.front();
					m_SaveQueue.pop_front();
				}
				HasMore = HasMore || (m_SaveQueue.size() > 0);
			}
			if ((Save != NULL) && (!m_SaveSchema->SaveChunk(Save)))
			{
				LOGWARNING("Cannot save chunk [%d, %d]", Save->GetPosX(), Save->GetPosZ());
			}
		} while (HasMore);
	}
}





bool cWorldStorage::LoadChunk(const cChunkPtr & a_Chunk)
{
	if (a_Chunk->IsValid())
	{
		// Already loaded (can happen, since the queue is async)
		return true;
	}
	
	if (m_SaveSchema->LoadChunk(a_Chunk))
	{
		return true;
	}
	
	for (cWSSchemaList::iterator itr = m_Schemas.begin(); itr != m_Schemas.end(); ++itr)
	{
		if ((*itr)->LoadChunk(a_Chunk))
		{
			return true;
		}
	}
	
	return false;
}