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_func.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

Patches _patches;

    69

Patches _patches_newgame;

    70

    71

struct IniFile;

    72

struct IniItem;

    73

struct IniGroup;

    74

struct SettingsMemoryPool;

    75

    76

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

    77

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

    78

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

    79

    80

static void pool_init(SettingsMemoryPool **pool);

    81

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

    82

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

    83

static void pool_free(SettingsMemoryPool **pool);

    84

static bool IsSignedVarMemType(VarType vt);

    85

    86

struct SettingsMemoryPool {

    87

	size_t pos, size;

    88

	SettingsMemoryPool *next;

    89

	byte mem[1];

    90

};

    91

    92

static SettingsMemoryPool *pool_new(size_t minsize)

    93

{

    94

	SettingsMemoryPool *p;

    95

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

    96

    97

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

    98

	p->pos = 0;

    99

	p->size = minsize;

   100

	p->next = NULL;

   101

	return p;

   102

}

   103

   104

static void pool_init(SettingsMemoryPool **pool)

   105

{

   106

	*pool = pool_new(0);

   107

}

   108

   109

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

   110

{

   111

	size_t pos;

   112

	SettingsMemoryPool *p = *pool;

   113

   114

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

   115

   116

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

   117

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

   118

		p = p->next;

   119

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

   120

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

   121

		SettingsMemoryPool *n = pool_new(size);

   122

		*pool = n;

   123

		n->next = p;

   124

		p = n;

   125

	}

   126

   127

	pos = p->pos;

   128

	p->pos += size;

   129

	return p->mem + pos;

   130

}

   131

   132

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

   133

{

   134

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

   135

	p[size] = 0;

   136

	memcpy(p, mem, size);

   137

	return p;

   138

}

   139

   140

static void pool_free(SettingsMemoryPool **pool)

   141

{

   142

	SettingsMemoryPool *p = *pool, *n;

   143

	*pool = NULL;

   144

	while (p) {

   145

		n = p->next;

   146

		free(p);

   147

		p = n;

   148

	}

   149

}

   150

   151

/** structs describing the ini format. */

   152

struct IniItem {

   153

	char *name;

   154

	char *value;

   155

	char *comment;

   156

	IniItem *next;

   157

};

   158

   159

struct IniGroup {

   160

	char *name;        ///< name of group

   161

	char *comment;     ///<comment for group

   162

	IniItem *item, **last_item;

   163

	IniGroup *next;

   164

	IniFile *ini;

   165

	IniGroupType type; ///< type of group

   166

};

   167

   168

struct IniFile {

   169

	SettingsMemoryPool *pool;

   170

	IniGroup *group, **last_group;

   171

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

   172

};

   173

   174

/** allocate an inifile object */

   175

static IniFile *ini_alloc()

   176

{

   177

	IniFile *ini;

   178

	SettingsMemoryPool *pool;

   179

	pool_init(&pool);

   180

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

   181

	ini->pool = pool;

   182

	ini->group = NULL;

   183

	ini->last_group = &ini->group;

   184

	ini->comment = NULL;

   185

	return ini;

   186

}

   187

   188

/** allocate an ini group object */

   189

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

   190

{

   191

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

   192

	grp->ini = ini;

   193

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

   194

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

   195

		grp->type = IGT_LIST;

   196

	} else {

   197

		grp->type = IGT_VARIABLES;

   198

	}

   199

	grp->next = NULL;

   200

	grp->item = NULL;

   201

	grp->comment = NULL;

   202

	grp->last_item = &grp->item;

   203

	*ini->last_group = grp;

   204

	ini->last_group = &grp->next;

   205

	return grp;

   206

}

   207

   208

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

   209

{

   210

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

   211

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

   212

	item->next = NULL;

   213

	item->comment = NULL;

   214

	item->value = NULL;

   215

	*group->last_item = item;

   216

	group->last_item = &item->next;

   217

	return item;

   218

}

   219

   220

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

   221

static IniFile *ini_load(const char *filename)

   222

{

   223

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

   224

	FILE *in;

   225

	IniFile *ini;

   226

	IniGroup *group = NULL;

   227

	IniItem *item;

   228

   229

	char *comment = NULL;

   230

	uint comment_size = 0;

   231

	uint comment_alloc = 0;

   232

   233

	ini = ini_alloc();

   234

   235

	in = fopen(filename, "r");

   236

	if (in == NULL) return ini;

   237

   238

	/* for each line in the file */

   239

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

   240

   241

		/* trim whitespace from the left side */

   242

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

   243

   244

		/* trim whitespace from right side. */

   245

		e = s + strlen(s);

   246

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

   247

		*e = '\0';

   248

   249

		/* skip comments and empty lines */

   250

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

   251

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

   252

			uint a = comment_alloc;

   253

			uint pos;

   254

			/* add to comment */

   255

			if (ns > a) {

   256

				a = max(a, 128U);

   257

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

   258

				comment = ReallocT(comment, comment_alloc = a);

   259

			}

   260

			pos = comment_size;

   261

			comment_size += (e - s + 1);

   262

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

   263

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

   264

			continue;

   265

		}

   266

   267

		/* it's a group? */

   268

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

   269

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

   270

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

   271

			} else {

   272

				e--;

   273

			}

   274

			s++; // skip [

   275

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

   276

			if (comment_size) {

   277

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

   278

				comment_size = 0;

   279

			}

   280

		} else if (group) {

   281

			/* find end of keyname */

   282

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

   283

				s++;

   284

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

   285

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

   286

			} else {

   287

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

   288

			}

   289

   290

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

   291

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

   292

			if (comment_size) {

   293

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

   294

				comment_size = 0;

   295

			}

   296

   297

			/* find start of parameter */

   298

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

   299

   300

   301

			/* remove starting quotation marks */

   302

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

   303

			/* remove ending quotation marks */

   304

			e = t + strlen(t);

   305

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

   306

			*e = '\0';

   307

   308

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

   309

		} else {

   310

			/* it's an orphan item */

   311

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

   312

		}

   313

	}

   314

   315

	if (comment_size > 0) {

   316

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

   317

		comment_size = 0;

   318

	}

   319

   320

	free(comment);

   321

	fclose(in);

   322

   323

	return ini;

   324

}

   325

   326

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

   327

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

   328

{

   329

	IniGroup *group;

   330

   331

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

   332

   333

	/* does it exist already? */

   336

			return group;

   339

   340

	/* otherwise make a new one */

   341

	group = ini_group_alloc(ini, name, len);

   342

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

   343

	return group;

   344

}

   345

   346

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

   347

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

   348

{

   349

	IniItem *item;

   350

	size_t len = strlen(name);

   351

   353

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

   355

   356

	if (!create) return NULL;

   357

   358

	/* otherwise make a new one */

   359

	return ini_item_alloc(group, name, len);

   360

}

   361

   362

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

   363

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

   364

{

   365

	FILE *f;

   366

	IniGroup *group;

   367

	IniItem *item;

   368

   369

	f = fopen(filename, "w");

   370

	if (f == NULL) return false;

   371

   372

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

   373

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

   374

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

   375

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

   376

			assert(item->value != NULL);

   377

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

   378

   379

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

   380

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

   381

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

   382

			} else {

   383

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

   384

			}

   385

   386

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

   387

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

   388

				fprintf(f, "\n");

   389

			} else {

   390

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

   391

			}

   392

		}

   393

	}

   394

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

   395

   396

	fclose(f);

   397

	return true;

   398

}

   399

   400

static void ini_free(IniFile *ini)

   401

{

   402

	pool_free(&ini->pool);

   403

}

   404

   405

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

   406

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

   407

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

   408

 * @param onelen force calculation of the *one parameter

   409

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

   410

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

   411

{

   412

	const char *s;

   413

	int idx;

   414

   415

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

   416

   417

	/* check if it's an integer */

   418

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

   419

		return strtoul(one, NULL, 0);

   420

   421

	idx = 0;

   422

	for (;;) {

   423

		/* find end of item */

   424

		s = many;

   425

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

   426

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

   427

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

   428

		many = s + 1;

   429

		idx++;

   430

	}

   431

}

   432

   433

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

   434

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

   435

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

   436

 * of seperated by a whitespace,tab or | character

   437

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

   438

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

   439

{

   440

	const char *s;

   441

	int r;

   442

	uint32 res = 0;

   443

   444

	for (;;) {

   445

		/* skip "whitespace" */

   446

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

   447

		if (*str == 0) break;

   448

   449

		s = str;

   450

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

   451

   452

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

   453

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

   454

   455

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

   456

		if (*s == 0) break;

   457

		str = s + 1;

   458

	}

   459

	return res;

   460

}

   461

   462

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

   463

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

   464

 * comma or a space character

   465

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

   466

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

   467

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

   468

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

   469

{

   470

	int n = 0, v;

   471

	char *end;

   472

   473

	for (;;) {

   474

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

   475

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

   476

		p = end;

   477

		items[n++] = v;

   478

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

   479

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

   480

		p++;

   481

	}

   482

   483

	return n;

   484

}

   485

   486

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

   487

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

   488

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

   489

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

   490

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

   491

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

   492

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

   493

{

   494

	int items[64];

   495

	int i, nitems;

   496