/
system.cpp
452 lines (382 loc) · 11.8 KB
/
system.cpp
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
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
/** @file system.cpp Action Code Script (ACS) system.
*
* @authors Copyright © 2003-2013 Jaakko Keränen <jaakko.keranen@iki.fi>
* @authors Copyright © 2005-2015 Daniel Swanson <danij@dengine.net>
* @authors Copyright © 1999 Activision
*
* @par License
* GPL: http://www.gnu.org/licenses/gpl.html
*
* <small>This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by the
* Free Software Foundation; either version 2 of the License, or (at your
* option) any later version. 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. You should have received a copy of the GNU
* General Public License along with this program; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA</small>
*/
#include "acs/system.h"
#include <de/ISerializable>
#include <de/Log>
#include <de/NativePath>
#include "acs/interpreter.h"
#include "acs/module.h"
#include "acs/script.h"
#include "gamesession.h"
using namespace de;
namespace acs {
DENG2_PIMPL(System)
{
std::unique_ptr<Module> currentModule;
QList<Script *> scripts; ///< Scripts for the current module (if any).
/**
* When a script must be started on a map that is not currently loaded -
* a deferred task is enqueued.
*/
class ScriptStartTask : public ISerializable
{
public:
de::Uri mapUri; ///< Unique identifier of the target map.
dint32 scriptNumber; ///< Script number to execute on the target map.
Script::Args scriptArgs;
ScriptStartTask() : scriptNumber(-1) {}
ScriptStartTask(de::Uri const &mapUri, dint32 scriptNumber, Script::Args const &scriptArgs)
: mapUri (mapUri)
, scriptNumber(scriptNumber)
, scriptArgs (scriptArgs)
{}
static ScriptStartTask *newFromReader(de::Reader &from)
{
std::unique_ptr<ScriptStartTask> task(new ScriptStartTask);
from >> *task;
return task.release();
}
void operator >> (de::Writer &to) const
{
to << mapUri.compose()
<< scriptNumber;
for(dbyte const &arg : scriptArgs) to << arg;
}
void operator << (de::Reader &from)
{
String mapUriStr;
from >> mapUriStr;
mapUri = de::Uri(mapUriStr, RC_NULL);
if(mapUri.scheme().isEmpty()) mapUri.setScheme("Maps");
from >> scriptNumber;
for(dbyte &arg : scriptArgs) from >> arg;
}
};
QList<ScriptStartTask *> tasks;
Instance(Public *i) : Base(i) {}
~Instance()
{
clearScripts();
clearTasks();
}
void unloadModule()
{
clearScripts();
currentModule.release();
}
void loadModule(Block const &bytecode)
{
// Only one module may be loaded at once...
unloadModule();
// Attempt to load the new module.
currentModule.reset(Module::newFromBytecode(bytecode));
// Make scripts.
currentModule->forAllEntryPoints([this] (Module::EntryPoint const &ep)
{
scripts << new Script(ep);
return LoopContinue;
});
}
void loadModuleFromFile(de::File1 const &file)
{
// Only one module may be loaded at once...
unloadModule();
// Attempt to load the new module.
currentModule.reset(Module::newFromFile(file));
// Make scripts.
currentModule->forAllEntryPoints([this] (Module::EntryPoint const &ep)
{
scripts << new Script(ep);
return LoopContinue;
});
}
void clearScripts()
{
qDeleteAll(scripts); scripts.clear();
}
void clearTasks()
{
qDeleteAll(tasks); tasks.clear();
}
void runAllTasks(de::Uri const &mapUri)
{
for(int i = 0; i < tasks.count(); ++i)
{
ScriptStartTask *task = tasks[i];
if(task->mapUri != mapUri) continue;
if(self.hasScript(task->scriptNumber))
{
self.script(task->scriptNumber)
.start(task->scriptArgs, nullptr, nullptr, 0, TICSPERSEC);
}
else
{
LOG_SCR_WARNING("Unknown script #%i") << task->scriptNumber;
}
delete tasks.takeAt(i);
i -= 1;
}
}
};
System::System() : d(new Instance(this))
{
mapVars.fill(0);
worldVars.fill(0);
}
void System::reset()
{
d->clearTasks();
d->unloadModule();
mapVars.fill(0);
worldVars.fill(0);
}
void System::loadModuleForMap(de::Uri const &mapUri)
{
#if __JHEXEN__
if(IS_CLIENT) return;
if(mapUri.isEmpty()) return;
/// @todo Should be using MapDef here...
lumpnum_t const mapMarkerLumpNum = CentralLumpIndex().findLast(mapUri.path() + ".lmp");
lumpnum_t bytecodeLumpNum = mapMarkerLumpNum + 11 /*ML_BEHAVIOR*/;
if(!CentralLumpIndex().hasLump(bytecodeLumpNum)) return;
de::File1 &file = CentralLumpIndex()[bytecodeLumpNum];
if(!Module::recognize(file)) return;
try
{
d->loadModuleFromFile(file);
}
catch(Module::FormatError const &er)
{
// Empty file / invalid bytecode.
LOG_SCR_WARNING("File %s:%s does not appear to be valid ACS bytecode\n")
<< NativePath(file.container().composePath())
<< file.name()
<< er.asText();
}
#else
DENG2_UNUSED(mapUri);
#endif
}
Module const &System::module() const
{
DENG2_ASSERT(bool( d->currentModule ));
return *d->currentModule;
}
int System::scriptCount() const
{
return d->scripts.count();
}
bool System::hasScript(int scriptNumber) const
{
for(Script const *script : d->scripts)
{
if(script->entryPoint().scriptNumber == scriptNumber)
{
return true;
}
}
return false;
}
Script &System::script(int scriptNumber) const
{
for(Script const *script : d->scripts)
{
if(script->entryPoint().scriptNumber == scriptNumber)
{
return *const_cast<Script *>(script);
}
}
/// @throw MissingScriptError Invalid script number specified.
throw MissingScriptError("acs::System::script", "Unknown script #" + String::number(scriptNumber));
}
LoopResult System::forAllScripts(std::function<LoopResult (Script &)> func) const
{
for(Script *script : d->scripts)
{
if(auto result = func(*script)) return result;
}
return LoopContinue;
}
bool System::deferScriptStart(de::Uri const &mapUri, int scriptNumber,
Script::Args const &scriptArgs)
{
DENG2_ASSERT(!IS_CLIENT);
DENG2_ASSERT(COMMON_GAMESESSION->mapUri() != mapUri);
LOG_AS("acs::System");
// Don't defer tasks in deathmatch.
/// @todo Why the restriction? -ds
if(COMMON_GAMESESSION->rules().deathmatch)
return true;
// Don't allow duplicates.
for(Instance::ScriptStartTask const *task : d->tasks)
{
if(task->scriptNumber == scriptNumber &&
task->mapUri == mapUri)
{
return false;
}
}
// Add it to the store to be started when that map is next entered.
d->tasks << new Instance::ScriptStartTask(mapUri, scriptNumber, scriptArgs);
return true;
}
de::Block System::serializeWorldState() const
{
de::Block data;
de::Writer writer(data);
// Write the world-global variable namespace.
for(auto const &var : worldVars) writer << var;
// Write the deferred task queue.
writer << d->tasks.count();
for(auto const *task : d->tasks) writer << *task;
return data;
}
void System::readWorldState(de::Reader &from)
{
// Read the world-global variable namespace.
for(auto &var : worldVars) from >> var;
// Read the deferred task queue.
d->clearTasks();
int numTasks;
from >> numTasks;
for(int i = 0; i < numTasks; ++i)
{
d->tasks << Instance::ScriptStartTask::newFromReader(from);
}
}
void System::writeMapState(MapStateWriter *msw) const
{
writer_s *writer = msw->writer();
// Write each script state.
for(auto const *script : d->scripts) script->write(writer);
// Write each variable.
for(auto const &var : mapVars) Writer_WriteInt32(writer, var);
}
void System::readMapState(MapStateReader *msr)
{
reader_s *reader = msr->reader();
// Read each script state.
for(auto *script : d->scripts) script->read(reader);
// Read each variable.
for(auto &var : mapVars) var = Reader_ReadInt32(reader);
}
void System::runDeferredTasks(de::Uri const &mapUri)
{
LOG_AS("acs::System");
d->runAllTasks(mapUri);
}
void System::worldSystemMapChanged()
{
mapVars.fill(0);
for(Script *script : d->scripts)
{
if(script->entryPoint().startWhenMapBegins)
{
bool justStarted = script->start(Script::Args()/*default args*/,
nullptr, nullptr, 0, TICSPERSEC);
DENG2_ASSERT(justStarted);
DENG2_UNUSED(justStarted);
}
}
}
D_CMD(InspectACScript)
{
DENG2_UNUSED2(src, argc);
System &scriptSys = Game_ACScriptSystem();
int const scriptNumber = String(argv[1]).toInt();
if(!scriptSys.hasScript(scriptNumber))
{
if(scriptSys.scriptCount())
{
LOG_SCR_WARNING("Unknown ACScript #%i") << scriptNumber;
}
else
{
LOG_SCR_MSG("No ACScripts are currently loaded");
}
return false;
}
Script const &script = scriptSys.script(scriptNumber);
LOG_SCR_MSG("%s\n %s") << script.describe() << script.description();
return true;
}
D_CMD(ListACScripts)
{
DENG2_UNUSED3(src, argc, argv);
System &scriptSys = Game_ACScriptSystem();
if(scriptSys.scriptCount())
{
LOG_SCR_MSG("Available ACScripts:");
scriptSys.forAllScripts([&scriptSys] (Script const &script)
{
LOG_SCR_MSG(" %s") << script.describe();
return LoopContinue;
});
#ifdef DENG2_DEBUG
LOG_SCR_MSG("World variables:");
int idx = 0;
for(int const &var : scriptSys.worldVars)
{
LOG_SCR_MSG(" #%i: %i") << (idx++) << var;
}
LOG_SCR_MSG("Map variables:");
idx = 0;
for(int const &var : scriptSys.mapVars)
{
LOG_SCR_MSG(" #%i: %i") << (idx++) << var;
}
#endif
}
else
{
LOG_SCR_MSG("No ACScripts are currently loaded");
}
return true;
}
void System::consoleRegister() // static
{
C_CMD("inspectacscript", "i", InspectACScript);
/* Alias */ C_CMD("scriptinfo", "i", InspectACScript);
C_CMD("listacscripts", "", ListACScripts);
/* Alias */ C_CMD("scriptinfo", "", ListACScripts);
}
} // namespace acs
static acs::System scriptSys; ///< The One acs::System instance.
acs::System &Game_ACScriptSystem()
{
return scriptSys;
}
// C wrapper API: --------------------------------------------------------------
dd_bool Game_ACScriptSystem_StartScript(int scriptNumber, uri_s const *mapUri_,
byte const args[], mobj_t *activator, Line *line, int side)
{
de::Uri const *mapUri = reinterpret_cast<de::Uri const *>(mapUri_);
acs::Script::Args scriptArgs(args, 4);
if(!mapUri || COMMON_GAMESESSION->mapUri() == *mapUri)
{
if(scriptSys.hasScript(scriptNumber))
{
return scriptSys.script(scriptNumber).start(scriptArgs, activator, line, side);
}
return false;
}
return scriptSys.deferScriptStart(*mapUri, scriptNumber, scriptArgs);
}