1

/* $Id$ */

     2

     3

/** @file settings.cpp

     4

 * All actions handling saving and loading of the settings/configuration goes on in this file.

     5

 * The file consists of four parts:

     6

 * <ol>

     7

 * <li>Parsing the configuration file (openttd.cfg). This is achieved with the ini_ functions which

     8

 *     handle various types, such as normal 'key = value' pairs, lists and value combinations of

     9

 *     lists, strings, integers, 'bit'-masks and element selections.

    10

 * <li>Defining the data structures that go into the configuration. These include for example

    11

 *     the _patches struct, but also network-settings, banlists, newgrf, etc. There are a lot

    12

 *     of helper macros available for the various types, and also saving/loading of these settings

    13

 *     in a savegame is handled inside these structures.

    14

 * <li>Handle reading and writing to the setting-structures from inside the game either from

    15

 *     the console for example or through the gui with CMD_ functions.

    16

 * <li>Handle saving/loading of the PATS chunk inside the savegame.

    17

 * </ol>

    18

 * @see SettingDesc

    19

 * @see SaveLoad

    20

 */

    21

    22

#include "stdafx.h"

    23

#include "openttd.h"

    24

#include "currency.h"

    25

#include "screenshot.h"

    26

#include "variables.h"

    27

#include "network/network.h"

    28

#include "network/network_internal.h"

    29

#include "settings_internal.h"

    30

#include "command_func.h"

    31

#include "console.h"

    32

#include "saveload.h"

    33

#include "npf.h"

    34

#include "yapf/yapf.h"

    35

#include "newgrf.h"

    36

#include "newgrf_config.h"

    37

#include "genworld.h"

    38

#include "rail.h"

    39

#include "train.h"

    40

#include "news_func.h"

    41

#include "window_func.h"

    42

#include "strings_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

#include "core/alloc_func.hpp"

    46

#include "player_func.h"

    47

#include "rev.h"

    48

#ifdef WITH_FREETYPE

    49

#include "fontcache.h"

    50

#endif

    51

#include "spritecache.h"

    52

#include "transparency.h"

    53

#include "textbuf_gui.h"

    54

#include "string_func.h"

    55

#include "rail_gui.h"

    56

#include "elrail_func.h"

    57

#include "gui.h"

    58

#include "town.h"

    59

#include "video/video_driver.hpp"

    60

#include "sound/sound_driver.hpp"

    61

#include "music/music_driver.hpp"

    62

#include "blitter/factory.hpp"

    63

    64

#include "table/strings.h"

    65

    66

GameOptions _opt;

    67

GameOptions _opt_newgame;

    68

GameOptions *_opt_ptr;

    69

Patches _patches;

    70

Patches _patches_newgame;

    71

    72

struct IniFile;

    73

struct IniItem;

    74

struct IniGroup;

    75

struct SettingsMemoryPool;

    76

    77

typedef const char *SettingListCallbackProc(const IniItem *item, uint index);

    78

typedef void SettingDescProc(IniFile *ini, const SettingDesc *desc, const char *grpname, void *object);

    79

typedef void SettingDescProcList(IniFile *ini, const char *grpname, char **list, uint len, SettingListCallbackProc proc);

    80

    81

static void pool_init(SettingsMemoryPool **pool);

    82

static void *pool_alloc(SettingsMemoryPool **pool, size_t size);

    83

static void *pool_strdup(SettingsMemoryPool **pool, const char *mem, size_t size);

    84

static void pool_free(SettingsMemoryPool **pool);

    85

static bool IsSignedVarMemType(VarType vt);

    86

    87

struct SettingsMemoryPool {

    88

	size_t pos, size;

    89

	SettingsMemoryPool *next;

    90

	byte mem[1];

    91

};

    92

    93

static SettingsMemoryPool *pool_new(size_t minsize)

    94

{

    95

	SettingsMemoryPool *p;

    96

	if (minsize < 4096 - 12) minsize = 4096 - 12;

    97

    98

	p = (SettingsMemoryPool*)MallocT<byte>(sizeof(SettingsMemoryPool) - 1 + minsize);

    99

	p->pos = 0;

   100

	p->size = minsize;

   101

	p->next = NULL;

   102

	return p;

   103

}

   104

   105

static void pool_init(SettingsMemoryPool **pool)

   106

{

   107

	*pool = pool_new(0);

   108

}

   109

   110

static void *pool_alloc(SettingsMemoryPool **pool, size_t size)

   111

{

   112

	size_t pos;

   113

	SettingsMemoryPool *p = *pool;

   114

   115

	size = Align(size, sizeof(void*));

   116

   117

	/* first check if there's memory in the next pool */

   118

	if (p->next && p->next->pos + size <= p->next->size) {

   119

		p = p->next;

   120

	/* then check if there's not memory in the cur pool */

   121

	} else if (p->pos + size > p->size) {

   122

		SettingsMemoryPool *n = pool_new(size);

   123

		*pool = n;

   124

		n->next = p;

   125

		p = n;

   126

	}

   127

   128

	pos = p->pos;

   129

	p->pos += size;

   130

	return p->mem + pos;

   131

}

   132

   133

static void *pool_strdup(SettingsMemoryPool **pool, const char *mem, size_t size)

   134

{

   135

	byte *p = (byte*)pool_alloc(pool, size + 1);

   136

	p[size] = 0;

   137

	memcpy(p, mem, size);

   138

	return p;

   139

}

   140

   141

static void pool_free(SettingsMemoryPool **pool)

   142

{

   143

	SettingsMemoryPool *p = *pool, *n;

   144

	*pool = NULL;

   145

	while (p) {

   146

		n = p->next;

   147

		free(p);

   148

		p = n;

   149

	}

   150

}

   151

   152

/** structs describing the ini format. */

   153

struct IniItem {

   154

	char *name;

   155

	char *value;

   156

	char *comment;

   157

	IniItem *next;

   158

};

   159

   160

struct IniGroup {

   161

	char *name;        ///< name of group

   162

	char *comment;     ///<comment for group

   163

	IniItem *item, **last_item;

   164

	IniGroup *next;

   165

	IniFile *ini;

   166

	IniGroupType type; ///< type of group

   167

};

   168

   169

struct IniFile {

   170

	SettingsMemoryPool *pool;

   171

	IniGroup *group, **last_group;

   172

	char *comment;     ///< last comment in file

   173

};

   174

   175

/** allocate an inifile object */

   176

static IniFile *ini_alloc()

   177

{

   178

	IniFile *ini;

   179

	SettingsMemoryPool *pool;

   180

	pool_init(&pool);

   181

	ini = (IniFile*)pool_alloc(&pool, sizeof(IniFile));

   182

	ini->pool = pool;

   183

	ini->group = NULL;

   184

	ini->last_group = &ini->group;

   185

	ini->comment = NULL;

   186

	return ini;

   187

}

   188

   189

/** allocate an ini group object */

   190

static IniGroup *ini_group_alloc(IniFile *ini, const char *grpt, size_t len)

   191

{

   192

	IniGroup *grp = (IniGroup*)pool_alloc(&ini->pool, sizeof(IniGroup));

   193

	grp->ini = ini;

   194

	grp->name = (char*)pool_strdup(&ini->pool, grpt, len);

   195

	if (!strcmp(grp->name, "newgrf") || !strcmp(grp->name, "servers") || !strcmp(grp->name, "bans")) {

   196

		grp->type = IGT_LIST;

   197

	} else {

   198

		grp->type = IGT_VARIABLES;

   199

	}

   200

	grp->next = NULL;

   201

	grp->item = NULL;

   202

	grp->comment = NULL;

   203

	grp->last_item = &grp->item;

   204

	*ini->last_group = grp;

   205

	ini->last_group = &grp->next;

   206

	return grp;

   207

}

   208

   209

static IniItem *ini_item_alloc(IniGroup *group, const char *name, size_t len)

   210

{

   211

	IniItem *item = (IniItem*)pool_alloc(&group->ini->pool, sizeof(IniItem));

   212

	item->name = (char*)pool_strdup(&group->ini->pool, name, len);

   213

	item->next = NULL;

   214

	item->comment = NULL;

   215

	item->value = NULL;

   216

	*group->last_item = item;

   217

	group->last_item = &item->next;

   218

	return item;

   219

}

   220

   221

/** load an ini file into the "abstract" format */

   222

static IniFile *ini_load(const char *filename)

   223

{

   224

	char buffer[1024], c, *s, *t, *e;

   225

	FILE *in;

   226

	IniFile *ini;

   227

	IniGroup *group = NULL;

   228

	IniItem *item;

   229

   230

	char *comment = NULL;

   231

	uint comment_size = 0;

   232

	uint comment_alloc = 0;

   233

   234

	ini = ini_alloc();

   235

   236

	in = fopen(filename, "r");

   237

	if (in == NULL) return ini;

   238

   239

	/* for each line in the file */

   240

	while (fgets(buffer, sizeof(buffer), in)) {

   241

   242

		/* trim whitespace from the left side */

   243

		for (s = buffer; *s == ' ' || *s == '\t'; s++) {}

   244

   245

		/* trim whitespace from right side. */

   246

		e = s + strlen(s);

   247

		while (e > s && ((c = e[-1]) == '\n' || c == '\r' || c == ' ' || c == '\t')) e--;

   248

		*e = '\0';

   249

   250

		/* skip comments and empty lines */

   251

		if (*s == '#' || *s == ';' || *s == '\0') {

   252

			uint ns = comment_size + (e - s + 1);

   253

			uint a = comment_alloc;

   254

			uint pos;

   255

			/* add to comment */

   256

			if (ns > a) {

   257

				a = max(a, 128U);

   258

				do a *= 2; while (a < ns);

   259

				comment = ReallocT(comment, comment_alloc = a);

   260

			}

   261

			pos = comment_size;

   262

			comment_size += (e - s + 1);

   263

			comment[pos + e - s] = '\n'; // comment newline

   264

			memcpy(comment + pos, s, e - s); // copy comment contents

   265

			continue;

   266

		}

   267

   268

		/* it's a group? */

   269

		if (s[0] == '[') {

   270

			if (e[-1] != ']') {

   271

				ShowInfoF("ini: invalid group name '%s'", buffer);

   272

			} else {

   273

				e--;

   274

			}

   275

			s++; // skip [

   276

			group = ini_group_alloc(ini, s, e - s);

   277

			if (comment_size) {

   278

				group->comment = (char*)pool_strdup(&ini->pool, comment, comment_size);

   279

				comment_size = 0;

   280

			}

   281

		} else if (group) {

   282

			/* find end of keyname */

   283

			if (*s == '\"') {

   284

				s++;

   285

				for (t = s; *t != '\0' && *t != '\"'; t++) {}

   286

				if (*t == '\"') *t = ' ';

   287

			} else {

   288

				for (t = s; *t != '\0' && *t != '=' && *t != '\t' && *t != ' '; t++) {}

   289

			}

   290

   291

			/* it's an item in an existing group */

   292

			item = ini_item_alloc(group, s, t-s);

   293

			if (comment_size) {

   294

				item->comment = (char*)pool_strdup(&ini->pool, comment, comment_size);

   295

				comment_size = 0;

   296

			}

   297

   298

			/* find start of parameter */

   299

			while (*t == '=' || *t == ' ' || *t == '\t') t++;

   300

   301

   302

			/* remove starting quotation marks */

   303

			if (*t == '\"') t++;

   304

			/* remove ending quotation marks */

   305

			e = t + strlen(t);

   306

			if (e > t && e[-1] == '\"') e--;

   307

			*e = '\0';

   308

   309

			item->value = (char*)pool_strdup(&ini->pool, t, e - t);

   310

		} else {

   311

			/* it's an orphan item */

   312

			ShowInfoF("ini: '%s' outside of group", buffer);

   313

		}

   314

	}

   315

   316

	if (comment_size > 0) {

   317

		ini->comment = (char*)pool_strdup(&ini->pool, comment, comment_size);

   318

		comment_size = 0;

   319

	}

   320

   321

	free(comment);

   322

	fclose(in);

   323

   324

	return ini;

   325

}

   326

   327

/** lookup a group or make a new one */

   328

static IniGroup *ini_getgroup(IniFile *ini, const char *name, size_t len = 0)

   329

{

   330

	IniGroup *group;

   331

   332

	if (len == 0) len = strlen(name);

   333

   334

	/* does it exist already? */

   335

	for (group = ini->group; group; group = group->next)

   336

		if (!memcmp(group->name, name, len) && group->name[len] == 0)

   337

			return group;

   338

   339

	/* otherwise make a new one */

   340

	group = ini_group_alloc(ini, name, len);

   341

	group->comment = (char*)pool_strdup(&ini->pool, "\n", 1);

   342

	return group;

   343

}

   344

   345

/** lookup an item or make a new one */

   346

static IniItem *ini_getitem(IniGroup *group, const char *name, bool create)

   347

{

   348

	IniItem *item;

   349

	size_t len = strlen(name);

   350

   351

	for (item = group->item; item; item = item->next)

   352

		if (strcmp(item->name, name) == 0) return item;

   353

   354

	if (!create) return NULL;

   355

   356

	/* otherwise make a new one */

   357

	return ini_item_alloc(group, name, len);

   358

}

   359

   360

/** save ini file from the "abstract" format. */

   361

static bool ini_save(const char *filename, IniFile *ini)

   362

{

   363

	FILE *f;

   364

	IniGroup *group;

   365

	IniItem *item;

   366

   367

	f = fopen(filename, "w");

   368

	if (f == NULL) return false;

   369

   370

	for (group = ini->group; group != NULL; group = group->next) {

   371

		if (group->comment) fputs(group->comment, f);

   372

		fprintf(f, "[%s]\n", group->name);

   373

		for (item = group->item; item != NULL; item = item->next) {

   374

			assert(item->value != NULL);

   375

			if (item->comment != NULL) fputs(item->comment, f);

   376

   377

			/* protect item->name with quotes if needed */

   378

			if (strchr(item->name, ' ') != NULL) {

   379

				fprintf(f, "\"%s\"", item->name);

   380

			} else {

   381

				fprintf(f, "%s", item->name);

   382

			}

   383

   384

			/* Don't give an equal sign to list items that don't have a parameter */

   385

			if (group->type == IGT_LIST && *item->value == '\0') {

   386

				fprintf(f, "\n");

   387

			} else {

   388

				fprintf(f, " = %s\n", item->value);

   389

			}

   390

		}

   391

	}

   392

	if (ini->comment) fputs(ini->comment, f);

   393

   394

	fclose(f);

   395

	return true;

   396

}

   397

   398

static void ini_free(IniFile *ini)

   399

{

   400

	pool_free(&ini->pool);

   401

}

   402

   403

/** Find the index value of a ONEofMANY type in a string seperated by |

   404

 * @param many full domain of values the ONEofMANY setting can have

   405

 * @param one the current value of the setting for which a value needs found

   406

 * @param onelen force calculation of the *one parameter

   407

 * @return the integer index of the full-list, or -1 if not found */

   408

static int lookup_oneofmany(const char *many, const char *one, size_t onelen = 0)

   409

{

   410

	const char *s;

   411

	int idx;

   412

   413

	if (onelen == 0) onelen = strlen(one);

   414

   415

	/* check if it's an integer */

   416

	if (*one >= '0' && *one <= '9')

   417

		return strtoul(one, NULL, 0);

   418

   419

	idx = 0;

   420

	for (;;) {

   421

		/* find end of item */

   422

		s = many;

   423

		while (*s != '|' && *s != 0) s++;

   424

		if ((size_t)(s - many) == onelen && !memcmp(one, many, onelen)) return idx;

   425

		if (*s == 0) return -1;

   426

		many = s + 1;

   427

		idx++;

   428

	}

   429

}

   430

   431

/** Find the set-integer value MANYofMANY type in a string

   432

 * @param many full domain of values the MANYofMANY setting can have

   433

 * @param str the current string value of the setting, each individual

   434

 * of seperated by a whitespace,tab or | character

   435

 * @return the 'fully' set integer, or -1 if a set is not found */

   436

static uint32 lookup_manyofmany(const char *many, const char *str)

   437

{

   438

	const char *s;

   439

	int r;

   440

	uint32 res = 0;

   441

   442

	for (;;) {

   443

		/* skip "whitespace" */

   444

		while (*str == ' ' || *str == '\t' || *str == '|') str++;

   445

		if (*str == 0) break;

   446

   447

		s = str;

   448

		while (*s != 0 && *s != ' ' && *s != '\t' && *s != '|') s++;

   449

   450

		r = lookup_oneofmany(many, str, s - str);

   451

		if (r == -1) return (uint32)-1;

   452

   453

		SetBit(res, r); // value found, set it

   454

		if (*s == 0) break;

   455

		str = s + 1;

   456

	}

   457

	return res;

   458

}

   459

   460

/** Parse an integerlist string and set each found value

   461

 * @param p the string to be parsed. Each element in the list is seperated by a

   462

 * comma or a space character

   463

 * @param items pointer to the integerlist-array that will be filled with values

   464

 * @param maxitems the maximum number of elements the integerlist-array has

   465

 * @return returns the number of items found, or -1 on an error */

   466

static int parse_intlist(const char *p, int *items, int maxitems)

   467

{

   468

	int n = 0, v;

   469

	char *end;

   470

   471

	for (;;) {

   472

		v = strtol(p, &end, 0);

   473

		if (p == end || n == maxitems) return -1;

   474

		p = end;

   475

		items[n++] = v;

   476

		if (*p == '\0') break;

   477

		if (*p != ',' && *p != ' ') return -1;

   478

		p++;

   479

	}

   480

   481

	return n;

   482

}

   483

   484

/** Load parsed string-values into an integer-array (intlist)

   485

 * @param str the string that contains the values (and will be parsed)

   486

 * @param array pointer to the integer-arrays that will be filled

   487

 * @param nelems the number of elements the array holds. Maximum is 64 elements

   488

 * @param type the type of elements the array holds (eg INT8, UINT16, etc.)

   489

 * @return return true on success and false on error */

   490

static bool load_intlist(const char *str, void *array, int nelems, VarType type)

   491

{

   492

	int items[64];

   493

	int i, nitems;

   494

   495

	if (str == NULL) {

   496

		memset(items, 0, sizeof(items));