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

#ifdef WITH_FREETYPE

    48

#include "fontcache.h"

    49

#endif

    50

#include "spritecache.h"

    51

#include "transparency.h"

    52

#include "string_func.h"

    53

#include "gui.h"

    54

#include "town.h"

    55

#include "video/video_driver.hpp"

    56

#include "sound/sound_driver.hpp"

    57

#include "music/music_driver.hpp"

    58

#include "blitter/factory.hpp"

    59

    60

#include "table/strings.h"

    61

    62

GameOptions _opt;

    63

GameOptions _opt_newgame;

    64

GameOptions *_opt_ptr;

    65

Patches _patches;

    66

Patches _patches_newgame;

    67

    68

struct IniFile;

    69

struct IniItem;

    70

struct IniGroup;

    71

struct SettingsMemoryPool;

    72

    73

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

    74

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

    75

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

    76

    77

static void pool_init(SettingsMemoryPool **pool);

    78

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

    79

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

    80

static void pool_free(SettingsMemoryPool **pool);

    81

static bool IsSignedVarMemType(VarType vt);

    82

    83

struct SettingsMemoryPool {

    84

	uint pos,size;

    85

	SettingsMemoryPool *next;

    86

	byte mem[1];

    87

};

    88

    89

static SettingsMemoryPool *pool_new(uint minsize)

    90

{

    91

	SettingsMemoryPool *p;

    92

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

    93

    94

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

    95

	p->pos = 0;

    96

	p->size = minsize;

    97

	p->next = NULL;

    98

	return p;

    99

}

   100

   101

static void pool_init(SettingsMemoryPool **pool)

   102

{

   103

	*pool = pool_new(0);

   104

}

   105

   106

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

   107

{

   108

	uint pos;

   109

	SettingsMemoryPool *p = *pool;

   110

   111

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

   112

   113

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

   114

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

   115

		p = p->next;

   116

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

   117

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

   118

		SettingsMemoryPool *n = pool_new(size);

   119

		*pool = n;

   120

		n->next = p;

   121

		p = n;

   122

	}

   123

   124

	pos = p->pos;

   125

	p->pos += size;

   126

	return p->mem + pos;

   127

}

   128

   129

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

   130

{

   131

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

   132

	p[size] = 0;

   133

	memcpy(p, mem, size);

   134

	return p;

   135

}

   136

   137

static void pool_free(SettingsMemoryPool **pool)

   138

{

   139

	SettingsMemoryPool *p = *pool, *n;

   140

	*pool = NULL;

   141

	while (p) {

   142

		n = p->next;

   143

		free(p);

   144

		p = n;

   145

	}

   146

}

   147

   148

/** structs describing the ini format. */

   149

struct IniItem {

   150

	char *name;

   151

	char *value;

   152

	char *comment;

   153

	IniItem *next;

   154

};

   155

   156

struct IniGroup {

   157

	char *name;        ///< name of group

   158

	char *comment;     ///<comment for group

   159

	IniItem *item, **last_item;

   160

	IniGroup *next;

   161

	IniFile *ini;

   162

	IniGroupType type; ///< type of group

   163

};

   164

   165

struct IniFile {

   166

	SettingsMemoryPool *pool;

   167

	IniGroup *group, **last_group;

   168

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

   169

};

   170

   171

/** allocate an inifile object */

   172

static IniFile *ini_alloc()

   173

{

   174

	IniFile *ini;

   175

	SettingsMemoryPool *pool;

   176

	pool_init(&pool);

   177

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

   178

	ini->pool = pool;

   179

	ini->group = NULL;

   180

	ini->last_group = &ini->group;

   181

	ini->comment = NULL;

   182

	return ini;

   183

}

   184

   185

/** allocate an ini group object */

   186

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

   187

{

   188

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

   189

	grp->ini = ini;

   190

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

   191

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

   192

		grp->type = IGT_LIST;

   193

	} else {

   194

		grp->type = IGT_VARIABLES;

   195

	}

   196

	grp->next = NULL;

   197

	grp->item = NULL;

   198

	grp->comment = NULL;

   199

	grp->last_item = &grp->item;

   200

	*ini->last_group = grp;

   201

	ini->last_group = &grp->next;

   202

	return grp;

   203

}

   204

   205

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

   206

{

   207

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

   208

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

   209

	item->next = NULL;

   210

	item->comment = NULL;

   211

	item->value = NULL;

   212

	*group->last_item = item;

   213

	group->last_item = &item->next;

   214

	return item;

   215

}

   216

   217

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

   218

static IniFile *ini_load(const char *filename)

   219

{

   220

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

   221

	FILE *in;

   222

	IniFile *ini;

   223

	IniGroup *group = NULL;

   224

	IniItem *item;

   225

   226

	char *comment = NULL;

   227

	uint comment_size = 0;

   228

	uint comment_alloc = 0;

   229

   230

	ini = ini_alloc();

   231

   232

	in = fopen(filename, "r");

   233

	if (in == NULL) return ini;

   234

   235

	/* for each line in the file */

   236

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

   237

   238

		/* trim whitespace from the left side */

   239

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

   240

   241

		/* trim whitespace from right side. */

   242

		e = s + strlen(s);

   243

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

   244

		*e = '\0';

   245

   246

		/* skip comments and empty lines */

   247

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

   248

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

   249

			uint a = comment_alloc;

   250

			uint pos;

   251

			/* add to comment */

   252

			if (ns > a) {

   253

				a = max(a, 128U);

   254

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

   255

				comment = ReallocT(comment, comment_alloc = a);

   256

			}

   257

			pos = comment_size;

   258

			comment_size += (e - s + 1);

   259

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

   260

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

   261

			continue;

   262

		}

   263

   264

		/* it's a group? */

   265

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

   266

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

   267

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

   268

			} else {

   269

				e--;

   270

			}

   271

			s++; // skip [

   272

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

   273

			if (comment_size) {

   274

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

   275

				comment_size = 0;

   276

			}

   277

		} else if (group) {

   278

			/* find end of keyname */

   279

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

   280

				s++;

   281

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

   282

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

   283

			} else {

   284

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

   285

			}

   286

   287

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

   288

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

   289

			if (comment_size) {

   290

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

   291

				comment_size = 0;

   292

			}

   293

   294

			/* find start of parameter */

   295

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

   296

   297

   298

			/* remove starting quotation marks */

   299

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

   300

			/* remove ending quotation marks */

   301

			e = t + strlen(t);

   302

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

   303

			*e = '\0';

   304

   305

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

   306

		} else {

   307

			/* it's an orphan item */

   308

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

   309

		}

   310

	}

   311

   312

	if (comment_size > 0) {

   313

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

   314

		comment_size = 0;

   315

	}

   316

   317

	free(comment);

   318

	fclose(in);

   319

   320

	return ini;

   321

}

   322

   323

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

   324

static IniGroup *ini_getgroup(IniFile *ini, const char *name, int len)

   325

{

   326

	IniGroup *group;

   327

   328

	if (len == -1) len = strlen(name);

   329

   330

	/* does it exist already? */

   331

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

   332

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

   333

			return group;

   334

   335

	/* otherwise make a new one */

   336

	group = ini_group_alloc(ini, name, len);

   337

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

   338

	return group;

   339

}

   340

   341

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

   342

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

   343

{

   344

	IniItem *item;

   345

	uint len = strlen(name);

   346

   347

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

   348

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

   349

   350

	if (!create) return NULL;

   351

   352

	/* otherwise make a new one */

   353

	return ini_item_alloc(group, name, len);

   354

}

   355

   356

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

   357

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

   358

{

   359

	FILE *f;

   360

	IniGroup *group;

   361

	IniItem *item;

   362

   363

	f = fopen(filename, "w");

   364

	if (f == NULL) return false;

   365

   366

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

   367

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

   368

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

   369

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

   370

			assert(item->value != NULL);

   371

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

   372

   373

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

   374

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

   375

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

   376

			} else {

   377

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

   378

			}

   379

   380

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

   381

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

   382

				fprintf(f, "\n");

   383

			} else {

   384

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

   385

			}

   386

		}

   387

	}

   388

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

   389

   390

	fclose(f);

   391

	return true;

   392

}

   393

   394

static void ini_free(IniFile *ini)

   395

{

   396

	pool_free(&ini->pool);

   397

}

   398

   399

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

   400

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

   401

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

   402

 * @param onelen force calculation of the *one parameter

   403

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

   404

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

   405

{

   406

	const char *s;

   407

	int idx;

   408

   409

	if (onelen == -1) onelen = strlen(one);

   410

   411

	/* check if it's an integer */

   412

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

   413

		return strtoul(one, NULL, 0);

   414

   415

	idx = 0;

   416

	for (;;) {

   417

		/* find end of item */

   418

		s = many;

   419

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

   420

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

   421

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

   422

		many = s + 1;

   423

		idx++;

   424

	}

   425

}

   426

   427

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

   428

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

   429

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

   430

 * of seperated by a whitespace,tab or | character

   431

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

   432

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

   433

{

   434

	const char *s;

   435

	int r;

   436

	uint32 res = 0;

   437

   438

	for (;;) {

   439

		/* skip "whitespace" */

   440

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

   441

		if (*str == 0) break;

   442

   443

		s = str;

   444

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

   445

   446

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

   447

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

   448

   449

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

   450

		if (*s == 0) break;

   451

		str = s + 1;

   452

	}

   453

	return res;

   454

}

   455

   456

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

   457

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

   458

 * comma or a space character

   459

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

   460

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

   461

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

   462

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

   463

{

   464

	int n = 0, v;

   465

	char *end;

   466

   467

	for (;;) {

   468

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

   469

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

   470

		p = end;

   471

		items[n++] = v;

   472

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

   473

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

   474

		p++;

   475

	}

   476

   477

	return n;

   478

}

   479

   480

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

   481

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

   482

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

   483

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

   484

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

   485

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

   486

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

   487

{

   488

	int items[64];

   489

	int i, nitems;

   490

   491

	if (str == NULL) {

   492

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

   493

		nitems = nelems;

   494

	} else {

   495

		nitems = parse_intlist(str, items, lengthof(items));

   496

		if (nitems != nelems) return false;

   497

	}

   498