Repository navigation
Expand file tree
/
Copy pathOptions.cpp
More file actions
executable file
·544 lines (512 loc) · 14.1 KB
/
Copy pathOptions.cpp
File metadata and controls
executable file
·544 lines (512 loc) · 14.1 KB
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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
/*
* Copyright 2010-2012 OpenXcom Developers.
*
* This file is part of OpenXcom.
*
* OpenXcom 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 3 of the License, or
* (at your option) any later version.
*
* OpenXcom 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 OpenXcom. If not, see <http://www.gnu.org/licenses/>.
*/
#include "Options.h"
#include <SDL.h>
#include <SDL_keysym.h>
#include <SDL_mixer.h>
#include <stdio.h>
#include <iostream>
#include <map>
#include <sstream>
#include <fstream>
#include <algorithm>
#include <yaml-cpp/yaml.h>
#include "Exception.h"
#include "Logger.h"
#include "CrossPlatform.h"
namespace OpenXcom
{
namespace Options
{
std::string _version = "0.5.0";
std::string _dataFolder = "";
std::vector<std::string> _dataList;
std::string _userFolder = "";
std::string _configFolder = "";
std::vector<std::string> _userList;
std::map<std::string, std::string> _options;
std::vector<std::string> _rulesets;
/**
* Creates a default set of options based on the system.
*/
void createDefault()
{
_options.clear();
#ifdef DINGOO
setInt("displayWidth", 320);
setInt("displayHeight", 200);
setBool("fullscreen", true);
setBool("asyncBlit", false);
setInt("keyboardMode", KEYBOARD_OFF);
#else
setInt("displayWidth", 640);
setInt("displayHeight", 400);
setBool("fullscreen", false);
setBool("asyncBlit", true);
setInt("keyboardMode", KEYBOARD_ON);
#endif
setInt("baseXResolution", 320);
setInt("baseYResolution", 200);
setBool("useScaleFilter", false);
setBool("useHQXFilter", false);
setBool("useOpenGL", false);
setBool("checkOpenGLErrors", false);
setString("useOpenGLShader", "Shaders/CRT-interlaced.OpenGL.shader");
setBool("vSyncForOpenGL", false);
setBool("useOpenGLSmoothing", true);
setBool("debug", false);
setBool("debugUi", false);
setBool("mute", false);
setInt("soundVolume", MIX_MAX_VOLUME);
setInt("musicVolume", MIX_MAX_VOLUME);
setString("language", "");
setInt("battleScrollSpeed", 24); // 8, 16, 24, 32, 40
setInt("battleScrollType", SCROLL_AUTO);
setInt("battleScrollDragButton", SDL_BUTTON_MIDDLE);
setBool("battleScrollDragInvert", false); // true drags away from the cursor, false drags towards (like a grab)
setInt("battleScrollDragTimeTolerance", 300); // miliSecond
setInt("battleScrollDragPixelTolerance", 10); // count of pixels
setInt("battleFireSpeed", 20); // 40, 30, 20, 10, 5, 1
setInt("battleXcomSpeed", 30); // 40, 30, 20, 10, 5, 1
setInt("battleAlienSpeed", 30); // 40, 30, 20, 10, 5, 1
setBool("battleInstantGrenade", false); // set to true if you want to play with the alternative grenade handling
setInt("battleExplosionHeight", 3); //0, 1, 2, 3
setBool("battlePreviewPath", false); // requires double-click to confirm moves
setBool("battleRangeBasedAccuracy", false);
setBool("fpsCounter", false);
setBool("craftLaunchAlways", false);
setBool("globeSeasons", false);
setBool("globeAllRadarsOnBaseBuild", true);
setBool("allowChangeListValuesByMouseWheel", true); // It applies only for lists, not for scientists/engineers screen
setInt("changeValueByMouseWheel", 10);
setInt("audioSampleRate", 22050);
setInt("audioBitDepth", 16);
setInt("pauseMode", 0);
setBool("alienContainmentHasUpperLimit", false);
setBool("canSellLiveAliens", false);
setBool("canTransferCraftsInAirborne", false); // When the craft can reach the destination base with its fuel
setBool("canManufactureMoreItemsPerHour", false);
setBool("customInitialBase", false);
setBool("aggressiveRetaliation", false);
setBool("strafe", false);
setBool("battleNotifyDeath", false);
setBool("allowBuildingQueue", false);
setBool("allowAutoSellProduction", false);
setBool("showFundsOnGeoscape", false);
setBool("showMoreStatsInInventoryView", false);
setBool("allowResize", false);
setInt("windowedModePositionX", 3);
setInt("windowedModePositionY", 22);
// controls
setInt("keyOk", SDLK_RETURN);
setInt("keyCancel", SDLK_ESCAPE);
setInt("keyScreenshot", SDLK_F12);
setInt("keyFps", SDLK_F5);
setInt("keyGeoLeft", SDLK_LEFT);
setInt("keyGeoRight", SDLK_RIGHT);
setInt("keyGeoUp", SDLK_UP);
setInt("keyGeoDown", SDLK_DOWN);
setInt("keyGeoZoomIn", SDLK_PLUS);
setInt("keyGeoZoomOut", SDLK_MINUS);
setInt("keyGeoSpeed1", SDLK_1);
setInt("keyGeoSpeed2", SDLK_2);
setInt("keyGeoSpeed3", SDLK_3);
setInt("keyGeoSpeed4", SDLK_4);
setInt("keyGeoSpeed5", SDLK_5);
setInt("keyGeoSpeed6", SDLK_6);
setInt("keyGeoIntercept", SDLK_i);
setInt("keyGeoBases", SDLK_b);
setInt("keyGeoGraphs", SDLK_g);
setInt("keyGeoUfopedia", SDLK_u);
setInt("keyGeoOptions", SDLK_ESCAPE);
setInt("keyGeoFunding", SDLK_f);
setInt("keyGeoToggleDetail", SDLK_TAB);
setInt("keyGeoToggleRadar", SDLK_r);
setInt("keyBattleLeft", SDLK_LEFT);
setInt("keyBattleRight", SDLK_RIGHT);
setInt("keyBattleUp", SDLK_UP);
setInt("keyBattleDown", SDLK_DOWN);
setInt("keyBattleLevelUp", SDLK_PAGEUP);
setInt("keyBattleLevelDown", SDLK_PAGEDOWN);
setInt("keyBattleCenterUnit", SDLK_HOME);
setInt("keyBattlePrevUnit", SDLK_LSHIFT);
setInt("keyBattleNextUnit", SDLK_TAB);
setInt("keyBattleDeselectUnit", SDLK_BACKSLASH);
setInt("keyBattleInventory", SDLK_i);
setInt("keyBattleMap", SDLK_m);
setInt("keyBattleOptions", SDLK_ESCAPE);
setInt("keyBattleEndTurn", SDLK_BACKSPACE);
setInt("keyBattleAbort", SDLK_a);
setInt("keyBattleStats", SDLK_F1);
setInt("keyBattleKneel", SDLK_k);
setInt("keyBattleReload", SDLK_r);
setInt("keyBattlePersonalLighting", SDLK_l);
setInt("keyBattleReserveNone", SDLK_F2);
setInt("keyBattleReserveSnap", SDLK_F3);
setInt("keyBattleReserveAimed", SDLK_F4);
setInt("keyBattleReserveAuto", SDLK_F5);
setInt("keyBattleCenterEnemy1", SDLK_1);
setInt("keyBattleCenterEnemy2", SDLK_2);
setInt("keyBattleCenterEnemy3", SDLK_3);
setInt("keyBattleCenterEnemy4", SDLK_4);
setInt("keyBattleCenterEnemy5", SDLK_5);
setInt("keyBattleCenterEnemy6", SDLK_6);
setInt("keyBattleCenterEnemy7", SDLK_7);
setInt("keyBattleCenterEnemy8", SDLK_8);
setInt("keyBattleCenterEnemy9", SDLK_9);
_rulesets.clear();
_rulesets.push_back("Xcom1Ruleset");
}
/**
* Loads options from a set of command line arguments,
* in the format "-option value".
* @param argc Number of arguments.
* @param args Array of argument strings.
*/
void loadArgs(int argc, char** args)
{
for (int i = 1; i < argc; ++i)
{
std::string arg = args[i];
if ((arg[0] == '-' || arg[0] == '/') && arg.length() > 1)
{
std::string argname;
if (arg[1] == '-' && arg.length() > 2)
argname = arg.substr(2, arg.length()-1);
else
argname = arg.substr(1, arg.length()-1);
std::transform(argname.begin(), argname.end(), argname.begin(), ::tolower);
if (argc > i + 1)
{
std::map<std::string, std::string>::iterator it = _options.find(argname);
if (it != _options.end())
{
it->second = args[i+1];
}
else if (argname == "data")
{
_dataFolder = CrossPlatform::endPath(args[i+1]);
}
else if (argname == "user")
{
_userFolder = CrossPlatform::endPath(args[i+1]);
}
else
{
Log(LOG_WARNING) << "Unknown option: " << argname;
}
}
else
{
Log(LOG_WARNING) << "Unknown option: " << argname;
}
}
}
if (_userFolder != "")
{
load();
}
}
/*
* Displays command-line help when appropriate.
* @param argc Number of arguments.
* @param args Array of argument strings.
*/
bool showHelp(int argc, char** args)
{
std::stringstream help;
help << "OpenXcom v" << Options::getVersion() << std::endl;
help << "Usage: openxcom [OPTION]..." << std::endl << std::endl;
help << "-data PATH" << std::endl;
help << " use PATH as the default Data Folder instead of auto-detecting" << std::endl << std::endl;
help << "-user PATH" << std::endl;
help << " use PATH as the default User Folder instead of auto-detecting" << std::endl << std::endl;
help << "-KEY VALUE" << std::endl;
help << " set option KEY to VALUE instead of default/loaded value (eg. -displayWidth 640)" << std::endl << std::endl;
help << "-help" << std::endl;
help << "-?" << std::endl;
help << " show command-line help" << std::endl;
for (int i = 1; i < argc; ++i)
{
std::string arg = args[i];
if ((arg[0] == '-' || arg[0] == '/') && arg.length() > 1)
{
std::string argname;
if (arg[1] == '-' && arg.length() > 2)
argname = arg.substr(2, arg.length()-1);
else
argname = arg.substr(1, arg.length()-1);
std::transform(argname.begin(), argname.end(), argname.begin(), ::tolower);
if (argname == "help" || argname == "?")
{
std::cout << help.str();
return true;
}
}
}
return false;
}
/**
* Handles the initialization of setting up default options
* and finding and loading any existing ones.
* @param argc Number of arguments.
* @param args Array of argument strings.
*/
bool init(int argc, char** args)
{
if (showHelp(argc, args))
return false;
createDefault();
loadArgs(argc, args);
if (_dataFolder == "")
{
_dataList = CrossPlatform::findDataFolders();
// Missing data folder is handled in StartState
}
if (_userFolder == "")
{
std::vector<std::string> user = CrossPlatform::findUserFolders();
_configFolder = CrossPlatform::findConfigFolder();
// Look for an existing user folder
for (std::vector<std::string>::iterator i = user.begin(); i != user.end(); ++i)
{
if (CrossPlatform::folderExists(*i))
{
_userFolder = *i;
break;
}
}
// Set up folders
if (_userFolder == "")
{
for (std::vector<std::string>::iterator i = user.begin(); i != user.end(); ++i)
{
if (CrossPlatform::createFolder(*i))
{
_userFolder = *i;
break;
}
}
}
if (_configFolder == "")
{
_configFolder = _userFolder;
}
// Load existing options
if (CrossPlatform::folderExists(_configFolder))
{
load();
}
// Create config folder and save options
else
{
CrossPlatform::createFolder(_configFolder);
save();
}
}
std::string s = getUserFolder();
s += "openxcom.log";
Logger::logFile() = s;
FILE *file = fopen(Logger::logFile().c_str(), "w");
fflush(file);
fclose(file);
Log(LOG_INFO) << "Data folder is: " << _dataFolder;
for (std::vector<std::string>::iterator i = _dataList.begin(); i != _dataList.end(); ++i)
{
Log(LOG_INFO) << *i;
}
Log(LOG_INFO) << "User folder is: " << _userFolder;
Log(LOG_INFO) << "Config folder is: " << _configFolder;
Log(LOG_INFO) << "Options loaded successfully.";
return true;
}
/**
* Loads options from a YAML file.
* @param filename YAML filename.
*/
void load(const std::string &filename)
{
std::string s = _configFolder + filename + ".cfg";
std::ifstream fin(s.c_str());
if (!fin)
{
//throw Exception(filename + ".cfg" + "not found");
return;
}
YAML::Parser parser(fin);
YAML::Node doc;
parser.GetNextDocument(doc);
const YAML::Node *options = doc.FindValue("options");
if (!options)
{
options = &doc;
}
for (YAML::Iterator i = options->begin(); i != options->end(); ++i)
{
std::string key, value;
i.first() >> key;
i.second() >> value;
_options[key] = value;
}
if (const YAML::Node *pName = doc.FindValue("rulesets"))
{
(*pName) >> _rulesets;
}
fin.close();
}
/**
* Saves options to a YAML file.
* @param filename YAML filename.
*/
void save(const std::string &filename)
{
std::string s = _configFolder + filename + ".cfg";
std::ofstream sav(s.c_str());
if (!sav)
{
Log(LOG_WARNING) << "Failed to save " << filename << ".cfg";
return;
}
YAML::Emitter out;
out << YAML::BeginMap;
out << YAML::Key << "options" << YAML::Value << _options;
out << YAML::Key << "rulesets" << YAML::Value << _rulesets;
out << YAML::EndMap;
sav << out.c_str();
sav.close();
}
/**
* Returns the game's version in x.x format.
* @return String with version number.
*/
std::string getVersion()
{
return _version;
}
/**
* Returns the game's current Data folder where resources
* and X-Com files are loaded from.
* @return Full path to Data folder.
*/
std::string getDataFolder()
{
return _dataFolder;
}
/**
* Changes the game's current Data folder where resources
* and X-Com files are loaded from.
* @param folder Full path to Data folder.
*/
void setDataFolder(const std::string &folder)
{
_dataFolder = folder;
}
/**
* Returns the game's list of possible Data folders.
* @return List of Data paths.
*/
std::vector<std::string> *getDataList()
{
return &_dataList;
}
/**
* Returns the game's User folder where settings
* and saves are stored in.
* @return Full path to User folder.
*/
std::string getUserFolder()
{
return _userFolder;
}
/**
* Returns an option in string format.
* @param id Option ID.
* @return Option value.
*/
std::string getString(const std::string& id)
{
return _options[id];
}
/**
* Returns an option in integer format.
* @param id Option ID.
* @return Option value.
*/
int getInt(const std::string& id)
{
std::stringstream ss;
int value;
ss << std::dec << _options[id];
ss >> std::dec >> value;
return value;
}
/**
* Returns an option in boolean format.
* @param id Option ID.
* @return Option value.
*/
bool getBool(const std::string& id)
{
std::stringstream ss;
bool value;
ss << std::boolalpha << _options[id];
ss >> std::boolalpha >> value;
return value;
}
/**
* Changes an option in string format.
* @param id Option ID.
* @param value New option value.
*/
void setString(const std::string& id, const std::string& value)
{
_options[id] = value;
}
/**
* Changes an option in integer format.
* @param id Option ID.
* @param value New option value.
*/
void setInt(const std::string& id, int value)
{
std::stringstream ss;
ss << std::dec << value;
_options[id] = ss.str();
}
/**
* Changes an option in boolean format.
* @param id Option ID.
* @param value New option value.
*/
void setBool(const std::string& id, bool value)
{
std::stringstream ss;
ss << std::boolalpha << value;
_options[id] = ss.str();
}
/**
* Returns the list of rulesets to be used by the game.
* @return Ruleset list.
*/
std::vector<std::string> getRulesets()
{
return _rulesets;
}
}
}