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 "functions.h"

    26

#include "macros.h"

    27

#include "screenshot.h"

    28

#include "sound.h"

    29

#include "string.h"

    30

#include "variables.h"

    31

#include "network/network.h"

    32

#include "strings.h"

    33

#include "settings.h"

    34

#include "command.h"

    35

#include "console.h"

    36

#include "saveload.h"

    37

#include "npf.h"

    38

#include "yapf/yapf.h"

    39

#include "newgrf.h"

    40

#include "newgrf_config.h"

    41

#include "genworld.h"

    42

#include "date.h"

    43

#include "rail.h"

    44

#include "helpers.hpp"

    45

#include "news.h"

    46

#ifdef WITH_FREETYPE

    47

#include "gfx.h"

    48

#include "fontcache.h"

    49

#endif

    50

#include "spritecache.h"

    51

    52

/** The patch values that are used for new games and/or modified in config file */

    53

Patches _patches_newgame;

    54

    55

struct IniFile;

    56

struct IniItem;

    57

struct IniGroup;

    58

struct SettingsMemoryPool;

    59

    60

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

    61

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

    62

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

    63

    64

static void pool_init(SettingsMemoryPool **pool);

    65

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

    66

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

    67

static void pool_free(SettingsMemoryPool **pool);

    68

static bool IsSignedVarMemType(VarType vt);

    69

    70

struct SettingsMemoryPool {

    71

	uint pos,size;

    72

	SettingsMemoryPool *next;

    73

	byte mem[1];

    74

};

    75

    76

static SettingsMemoryPool *pool_new(uint minsize)

    77

{

    78

	SettingsMemoryPool *p;

    79

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

    80

    81

	p = (SettingsMemoryPool*)malloc(sizeof(SettingsMemoryPool) - 1 + minsize);

    82

	p->pos = 0;

    83

	p->size = minsize;

    84

	p->next = NULL;

    85

	return p;

    86

}

    87

    88

static void pool_init(SettingsMemoryPool **pool)

    89

{

    90

	*pool = pool_new(0);

    91

}

    92

    93

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

    94

{

    95

	uint pos;

    96

	SettingsMemoryPool *p = *pool;

    97

    98

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

    99

   100

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

   101

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

   102

		p = p->next;

   103

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

   104

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

   105

		SettingsMemoryPool *n = pool_new(size);

   106

		*pool = n;

   107

		n->next = p;

   108

		p = n;

   109

	}

   110

   111

	pos = p->pos;

   112

	p->pos += size;

   113

	return p->mem + pos;

   114

}

   115

   116

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

   117

{

   118

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

   119

	p[size] = 0;

   120

	memcpy(p, mem, size);

   121

	return p;

   122

}

   123

   124

static void pool_free(SettingsMemoryPool **pool)

   125

{

   126

	SettingsMemoryPool *p = *pool, *n;

   127

	*pool = NULL;

   128

	while (p) {

   129

		n = p->next;

   130

		free(p);

   131

		p = n;

   132

	}

   133

}

   134

   135

/** structs describing the ini format. */

   136

struct IniItem {

   137

	char *name;

   138

	char *value;

   139

	char *comment;

   140

	IniItem *next;

   141

};

   142

   143

struct IniGroup {

   144

	char *name;        ///< name of group

   145

	char *comment;     ///<comment for group

   146

	IniItem *item, **last_item;

   147

	IniGroup *next;

   148

	IniFile *ini;

   149

	IniGroupType type; ///< type of group

   150

};

   151

   152

struct IniFile {

   153

	SettingsMemoryPool *pool;

   154

	IniGroup *group, **last_group;

   155

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

   156

};

   157

   158

/** allocate an inifile object */

   159

static IniFile *ini_alloc()

   160

{

   161

	IniFile *ini;

   162

	SettingsMemoryPool *pool;

   163

	pool_init(&pool);

   164

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

   165

	ini->pool = pool;

   166

	ini->group = NULL;

   167

	ini->last_group = &ini->group;

   168

	ini->comment = NULL;

   169

	return ini;

   170

}

   171

   172

/** allocate an ini group object */

   173

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

   174

{

   175

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

   176

	grp->ini = ini;

   177

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

   178

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

   179

		grp->type = IGT_LIST;

   180

	} else {

   181

		grp->type = IGT_VARIABLES;

   182

	}

   183

	grp->next = NULL;

   184

	grp->item = NULL;

   185

	grp->comment = NULL;

   186

	grp->last_item = &grp->item;

   187

	*ini->last_group = grp;

   188

	ini->last_group = &grp->next;

   189

	return grp;

   190

}

   191

   192

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

   193

{

   194

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

   195

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

   196

	item->next = NULL;

   197

	item->comment = NULL;

   198

	item->value = NULL;

   199

	*group->last_item = item;

   200

	group->last_item = &item->next;

   201

	return item;

   202

}

   203

   204

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

   205

static IniFile *ini_load(const char *filename)

   206

{

   207

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

   208

	FILE *in;

   209

	IniFile *ini;

   210

	IniGroup *group = NULL;

   211

	IniItem *item;

   212

   213

	char *comment = NULL;

   214

	uint comment_size = 0;

   215

	uint comment_alloc = 0;

   216

   217

	ini = ini_alloc();

   218

   219

	in = fopen(filename, "r");

   220

	if (in == NULL) return ini;

   221

   222

	/* for each line in the file */

   223

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

   224

   225

		/* trim whitespace from the left side */

   226

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

   227

   228

		/* trim whitespace from right side. */

   229

		e = s + strlen(s);

   230

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

   231

		*e = '\0';

   232

   233

		/* skip comments and empty lines */

   234

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

   235

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

   236

			uint a = comment_alloc;

   237

			uint pos;

   238

			/* add to comment */

   239

			if (ns > a) {

   240

				a = max(a, 128U);

   241

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

   242

				comment = ReallocT(comment, comment_alloc = a);

   243

			}

   244

			pos = comment_size;

   245

			comment_size += (e - s + 1);

   246

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

   247

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

   248

			continue;

   249

		}

   250

   251

		/* it's a group? */

   252

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

   253

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

   254

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

   255

			} else {

   256

				e--;

   257

			}

   258

			s++; // skip [

   259

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

   260

			if (comment_size) {

   261

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

   262

				comment_size = 0;

   263

			}

   264

		} else if (group) {

   265

			/* find end of keyname */

   266

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

   267

				s++;

   268

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

   269

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

   270

			} else {

   271

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

   272

			}

   273

   274

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

   275

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

   276

			if (comment_size) {

   277

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

   278

				comment_size = 0;

   279

			}

   280

   281

			/* find start of parameter */

   282

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

   283

   284

   285

			/* remove starting quotation marks */

   286

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

   287

			/* remove ending quotation marks */

   288

			e = t + strlen(t);

   289

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

   290

			*e = '\0';

   291

   292

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

   293

		} else {

   294

			/* it's an orphan item */

   295

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

   296

		}

   297

	}

   298

   299

	if (comment_size > 0) {

   300

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

   301

		comment_size = 0;

   302

	}

   303

   304

	free(comment);

   305

	fclose(in);

   306

   307

	return ini;

   308

}

   309

   310

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

   311

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

   312

{

   313

	IniGroup *group;

   314

   315

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

   316

   317

	/* does it exist already? */

   318

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

   319

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

   320

			return group;

   321

   322

	/* otherwise make a new one */

   323

	group = ini_group_alloc(ini, name, len);

   324

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

   325

	return group;

   326

}

   327

   328

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

   329

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

   330

{

   331

	IniItem *item;

   332

	uint len = strlen(name);

   333

   334

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

   335

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

   336

   337

	if (!create) return NULL;

   338

   339

	/* otherwise make a new one */

   340

	return ini_item_alloc(group, name, len);

   341

}

   342

   343

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

   344

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

   345

{

   346

	FILE *f;

   347

	IniGroup *group;

   348

	IniItem *item;

   349

   350

	f = fopen(filename, "w");

   351

	if (f == NULL) return false;

   352

   353

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

   354

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

   355

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

   356

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

   357

			assert(item->value != NULL);

   358

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

   359

   360

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

   361

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

   362

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

   363

			} else {

   364

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

   365

			}

   366

   367

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

   368

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

   369

				fprintf(f, "\n");

   370

			} else {

   371

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

   372

			}

   373

		}

   374

	}

   375

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

   376

   377

	fclose(f);

   378

	return true;

   379

}

   380

   381

static void ini_free(IniFile *ini)

   382

{

   383

	pool_free(&ini->pool);

   384

}

   385

   386

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

   387

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

   388

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

   389

 * @param onelen force calculation of the *one parameter

   390

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

   391

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

   392

{

   393

	const char *s;

   394

	int idx;

   395

   396

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

   397

   398

	/* check if it's an integer */

   399

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

   400

		return strtoul(one, NULL, 0);

   401

   402

	idx = 0;

   403

	for (;;) {

   404

		/* find end of item */

   405

		s = many;

   406

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

   407

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

   408

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

   409

		many = s + 1;

   410

		idx++;

   411

	}

   412

}

   413

   414

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

   415

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

   416

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

   417

 * of seperated by a whitespace,tab or | character

   418

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

   419

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

   420

{

   421

	const char *s;

   422

	int r;

   423

	uint32 res = 0;

   424

   425

	for (;;) {

   426

		/* skip "whitespace" */

   427

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

   428

		if (*str == 0) break;

   429

   430

		s = str;

   431

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

   432

   433

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

   434

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

   435

   436

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

   437

		if (*s == 0) break;

   438

		str = s + 1;

   439

	}

   440

	return res;

   441

}

   442

   443

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

   444

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

   445

 * comma or a space character

   446

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

   447

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

   448

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

   449

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

   450

{

   451

	int n = 0, v;

   452

	char *end;

   453

   454

	for (;;) {

   455

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

   456

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

   457

		p = end;

   458

		items[n++] = v;

   459

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

   460

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

   461

		p++;

   462

	}

   463

   464

	return n;

   465

}

   466

   467

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

   468

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

   469

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

   470

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

   471

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

   472

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

   473

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

   474

{

   475

	int items[64];

   476

	int i, nitems;

   477

   478

	if (str == NULL) {

   479

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

   480

		nitems = nelems;

   481

	} else {

   482

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

   483

		if (nitems != nelems) return false;

   484

	}

   485

   486

	switch (type) {

   487

	case SLE_VAR_BL:

   488

	case SLE_VAR_I8:

   489

	case SLE_VAR_U8:

   490

		for (i = 0; i != nitems; i++) ((byte*)array)[i] = items[i];

   491

		break;

   492

	case SLE_VAR_I16:

   493

	case SLE_VAR_U16:

   494

		for (i = 0; i != nitems; i++) ((uint16*)array)[i] = items[i];

   495

		break;

   496

	case SLE_VAR_I32:

   497

	case SLE_VAR_U32:

   498

		for (i = 0; i != nitems; i++) ((uint32*)array)[i] = items[i];

   499