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

    45

#include "helpers.hpp"

    46

#include "news.h"

    47

#ifdef WITH_FREETYPE

    48

#include "gfx.h"

    49

#include "fontcache.h"

    50

#endif

    51

#include "spritecache.h"

    52

    53

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

    54

Patches _patches_newgame;

    55

    56

struct IniFile;

    57

struct IniItem;

    58

struct IniGroup;

    59

struct SettingsMemoryPool;

    60

    61

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

    62

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

    63

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

    64

    65

static void pool_init(SettingsMemoryPool **pool);

    66

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

    67

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

    68

static void pool_free(SettingsMemoryPool **pool);

    69

static bool IsSignedVarMemType(VarType vt);

    70

    71

struct SettingsMemoryPool {

    72

	uint pos,size;

    73

	SettingsMemoryPool *next;

    74

	byte mem[1];

    75

};

    76

    77

static SettingsMemoryPool *pool_new(uint minsize)

    78

{

    79

	SettingsMemoryPool *p;

    80

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

    81

    82

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

    83

	p->pos = 0;

    84

	p->size = minsize;

    85

	p->next = NULL;

    86

	return p;

    87

}

    88

    89

static void pool_init(SettingsMemoryPool **pool)

    90

{

    91

	*pool = pool_new(0);

    92

}

    93

    94

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

    95

{

    96

	uint pos;

    97

	SettingsMemoryPool *p = *pool;

    98

    99

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

   100

   101

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

   102

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

   103

		p = p->next;

   104

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

   105

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

   106

		SettingsMemoryPool *n = pool_new(size);

   107

		*pool = n;

   108

		n->next = p;

   109

		p = n;

   110

	}

   111

   112

	pos = p->pos;

   113

	p->pos += size;

   114

	return p->mem + pos;

   115

}

   116

   117

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

   118

{

   119

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

   120

	p[size] = 0;

   121

	memcpy(p, mem, size);

   122

	return p;

   123

}

   124

   125

static void pool_free(SettingsMemoryPool **pool)

   126

{

   127

	SettingsMemoryPool *p = *pool, *n;

   128

	*pool = NULL;

   129

	while (p) {

   130

		n = p->next;

   131

		free(p);

   132

		p = n;

   133

	}

   134

}

   135

   136

/** structs describing the ini format. */

   137

struct IniItem {

   138

	char *name;

   139

	char *value;

   140

	char *comment;

   141

	IniItem *next;

   142

};

   143

   144

struct IniGroup {

   145

	char *name;        ///< name of group

   146

	char *comment;     ///<comment for group

   147

	IniItem *item, **last_item;

   148

	IniGroup *next;

   149

	IniFile *ini;

   150

	IniGroupType type; ///< type of group

   151

};

   152

   153

struct IniFile {

   154

	SettingsMemoryPool *pool;

   155

	IniGroup *group, **last_group;

   156

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

   157

};

   158

   159

/** allocate an inifile object */

   160

static IniFile *ini_alloc()

   161

{

   162

	IniFile *ini;

   163

	SettingsMemoryPool *pool;

   164

	pool_init(&pool);

   165

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

   166

	ini->pool = pool;

   167

	ini->group = NULL;

   168

	ini->last_group = &ini->group;

   169

	ini->comment = NULL;

   170

	return ini;

   171

}

   172

   173

/** allocate an ini group object */

   174

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

   175

{

   176

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

   177

	grp->ini = ini;

   178

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

   179

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

   180

		grp->type = IGT_LIST;

   181

	} else {

   182

		grp->type = IGT_VARIABLES;

   183

	}

   184

	grp->next = NULL;

   185

	grp->item = NULL;

   186

	grp->comment = NULL;

   187

	grp->last_item = &grp->item;

   188

	*ini->last_group = grp;

   189

	ini->last_group = &grp->next;

   190

	return grp;

   191

}

   192

   193

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

   194

{

   195

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

   196

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

   197

	item->next = NULL;

   198

	item->comment = NULL;

   199

	item->value = NULL;

   200

	*group->last_item = item;

   201

	group->last_item = &item->next;

   202

	return item;

   203

}

   204

   205

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

   206

static IniFile *ini_load(const char *filename)

   207

{

   208

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

   209

	FILE *in;

   210

	IniFile *ini;

   211

	IniGroup *group = NULL;

   212

	IniItem *item;

   213

   214

	char *comment = NULL;

   215

	uint comment_size = 0;

   216

	uint comment_alloc = 0;

   217

   218

	ini = ini_alloc();

   219

   220

	in = fopen(filename, "r");

   221

	if (in == NULL) return ini;

   222

   223

	/* for each line in the file */

   224

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

   225

   226

		/* trim whitespace from the left side */

   227

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

   228

   229

		/* trim whitespace from right side. */

   230

		e = s + strlen(s);

   231

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

   232

		*e = '\0';

   233

   234

		/* skip comments and empty lines */

   235

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

   236

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

   237

			uint a = comment_alloc;

   238

			uint pos;

   239

			/* add to comment */

   240

			if (ns > a) {

   241

				a = max(a, 128U);

   242

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

   243

				comment = ReallocT(comment, comment_alloc = a);

   244

			}

   245

			pos = comment_size;

   246

			comment_size += (e - s + 1);

   247

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

   248

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

   249

			continue;

   250

		}

   251

   252

		/* it's a group? */

   253

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

   254

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

   255

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

   256

			} else {

   257

				e--;

   258

			}

   259

			s++; // skip [

   260

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

   261

			if (comment_size) {

   262

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

   263

				comment_size = 0;

   264

			}

   265

		} else if (group) {

   266

			/* find end of keyname */

   267

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

   268

				s++;

   269

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

   270

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

   271

			} else {

   272

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

   273

			}

   274

   275

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

   276

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

   277

			if (comment_size) {

   278

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

   279

				comment_size = 0;

   280

			}

   281

   282

			/* find start of parameter */

   283

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

   284

   285

   286

			/* remove starting quotation marks */

   287

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

   288

			/* remove ending quotation marks */

   289

			e = t + strlen(t);

   290

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

   291

			*e = '\0';

   292

   293

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

   294

		} else {

   295

			/* it's an orphan item */

   296

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

   297

		}

   298

	}

   299

   300

	if (comment_size > 0) {

   301

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

   302

		comment_size = 0;

   303

	}

   304

   305

	free(comment);

   306

	fclose(in);

   307

   308

	return ini;

   309

}

   310

   311

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

   312

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

   313

{

   314

	IniGroup *group;

   315

   316

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

   317

   318

	/* does it exist already? */

   319

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

   320

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

   321

			return group;

   322

   323

	/* otherwise make a new one */

   324

	group = ini_group_alloc(ini, name, len);

   325

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

   326

	return group;

   327

}

   328

   329

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

   330

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

   331

{

   332

	IniItem *item;

   333

	uint len = strlen(name);

   334

   335

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

   336

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

   337

   338

	if (!create) return NULL;

   339

   340

	/* otherwise make a new one */

   341

	return ini_item_alloc(group, name, len);

   342

}

   343

   344

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

   345

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

   346

{

   347

	FILE *f;

   348

	IniGroup *group;

   349

	IniItem *item;

   350

   351

	f = fopen(filename, "w");

   352

	if (f == NULL) return false;

   353

   354

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

   355

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

   356

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

   357

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

   358

			assert(item->value != NULL);

   359

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

   360

   361

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

   362

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

   363

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

   364

			} else {

   365

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

   366

			}

   367

   368

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

   369

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

   370

				fprintf(f, "\n");

   371

			} else {

   372

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

   373

			}

   374

		}

   375

	}

   376

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

   377

   378

	fclose(f);

   379

	return true;

   380

}

   381

   382

static void ini_free(IniFile *ini)

   383

{

   384

	pool_free(&ini->pool);

   385

}

   386

   387

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

   388

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

   389

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

   390

 * @param onelen force calculation of the *one parameter

   391

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

   392

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

   393

{

   394

	const char *s;

   395

	int idx;

   396

   397

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

   398

   399

	/* check if it's an integer */

   400

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

   401

		return strtoul(one, NULL, 0);

   402

   403

	idx = 0;

   404

	for (;;) {

   405

		/* find end of item */

   406

		s = many;

   407

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

   408

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

   409

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

   410

		many = s + 1;

   411

		idx++;

   412

	}

   413

}

   414

   415

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

   416

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

   417

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

   418

 * of seperated by a whitespace,tab or | character

   419

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

   420

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

   421

{

   422

	const char *s;

   423

	int r;

   424

	uint32 res = 0;

   425

   426

	for (;;) {

   427

		/* skip "whitespace" */

   428

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

   429

		if (*str == 0) break;

   430

   431

		s = str;

   432

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

   433

   434

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

   435

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

   436

   437

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

   438

		if (*s == 0) break;

   439

		str = s + 1;

   440

	}

   441

	return res;

   442

}

   443

   444

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

   445

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

   446

 * comma or a space character

   447

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

   448

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

   449

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

   450

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

   451

{

   452

	int n = 0, v;

   453

	char *end;

   454

   455

	for (;;) {

   456

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

   457

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

   458

		p = end;

   459

		items[n++] = v;

   460

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

   461

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

   462

		p++;

   463

	}

   464

   465

	return n;

   466

}

   467

   468

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

   469

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

   470

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

   471

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

   472

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

   473

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

   474

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

   475

{

   476

	int items[64];

   477

	int i, nitems;

   478

   479

	if (str == NULL) {

   480

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

   481

		nitems = nelems;

   482

	} else {

   483

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

   484

		if (nitems != nelems) return false;

   485

	}

   486

   487

	switch (type) {

   488

	case SLE_VAR_BL:

   489

	case SLE_VAR_I8:

   490

	case SLE_VAR_U8:

   491

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

   492

		break;

   493

	case SLE_VAR_I16:

   494

	case SLE_VAR_U16:

   495

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

   496

		break;

   497

	case SLE_VAR_I32:

   498

	case SLE_VAR_U32:

   499

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