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

    33

#include "command.h"

    34

#include "console.h"

    35

#include "saveload.h"

    36

#include "npf.h"

    37

#include "yapf/yapf.h"

    38

#include "newgrf.h"

    39

#include "newgrf_config.h"

    40

#include "genworld.h"

    41

#include "date.h"

    42

#include "rail.h"

    43

#include "helpers.hpp"

    44

#include "news.h"

    45

#ifdef WITH_FREETYPE

    46

#include "gfx.h"

    47

#include "fontcache.h"

    48

#endif

    49

#include "spritecache.h"

    50

    51

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

    52

Patches _patches_newgame;

    53

    54

struct IniFile;

    55

struct IniItem;

    56

struct IniGroup;

    57

struct SettingsMemoryPool;

    58

    59

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

    60

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

    61

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

    62

    63

static void pool_init(SettingsMemoryPool **pool);

    64

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

    65

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

    66

static void pool_free(SettingsMemoryPool **pool);

    67

static bool IsSignedVarMemType(VarType vt);

    68

    69

struct SettingsMemoryPool {

    70

	uint pos,size;

    71

	SettingsMemoryPool *next;

    72

	byte mem[1];

    73

};

    74

    75

static SettingsMemoryPool *pool_new(uint minsize)

    76

{

    77

	SettingsMemoryPool *p;

    78

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

    79

    80

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

    81

	p->pos = 0;

    82

	p->size = minsize;

    83

	p->next = NULL;

    84

	return p;

    85

}

    86

    87

static void pool_init(SettingsMemoryPool **pool)

    88

{

    89

	*pool = pool_new(0);

    90

}

    91

    92

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

    93

{

    94

	uint pos;

    95

	SettingsMemoryPool *p = *pool;

    96

    97

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

    98

    99

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

   100

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

   101

		p = p->next;

   102

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

   103

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

   104

		SettingsMemoryPool *n = pool_new(size);

   105

		*pool = n;

   106

		n->next = p;

   107

		p = n;

   108

	}

   109

   110

	pos = p->pos;

   111

	p->pos += size;

   112

	return p->mem + pos;

   113

}

   114

   115

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

   116

{

   117

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

   118

	p[size] = 0;

   119

	memcpy(p, mem, size);

   120

	return p;

   121

}

   122

   123

static void pool_free(SettingsMemoryPool **pool)

   124

{

   125

	SettingsMemoryPool *p = *pool, *n;

   126

	*pool = NULL;

   127

	while (p) {

   128

		n = p->next;

   129

		free(p);

   130

		p = n;

   131

	}

   132

}

   133

   134

/** structs describing the ini format. */

   135

struct IniItem {

   136

	char *name;

   137

	char *value;

   138

	char *comment;

   139

	IniItem *next;

   140

};

   141

   142

struct IniGroup {

   143

	char *name;        ///< name of group

   144

	char *comment;     ///<comment for group

   145

	IniItem *item, **last_item;

   146

	IniGroup *next;

   147

	IniFile *ini;

   148

	IniGroupType type; ///< type of group

   149

};

   150

   151

struct IniFile {

   152

	SettingsMemoryPool *pool;

   153

	IniGroup *group, **last_group;

   154

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

   155

};

   156

   157

/** allocate an inifile object */

   158

static IniFile *ini_alloc()

   159

{

   160

	IniFile *ini;

   161

	SettingsMemoryPool *pool;

   162

	pool_init(&pool);

   163

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

   164

	ini->pool = pool;

   165

	ini->group = NULL;

   166

	ini->last_group = &ini->group;

   167

	ini->comment = NULL;

   168

	return ini;

   169

}

   170

   171

/** allocate an ini group object */

   172

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

   173

{

   174

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

   175

	grp->ini = ini;

   176

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

   177

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

   178

		grp->type = IGT_LIST;

   179

	} else {

   180

		grp->type = IGT_VARIABLES;

   181

	}

   182

	grp->next = NULL;

   183

	grp->item = NULL;

   184

	grp->comment = NULL;

   185

	grp->last_item = &grp->item;

   186

	*ini->last_group = grp;

   187

	ini->last_group = &grp->next;

   188

	return grp;

   189

}

   190

   191

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

   192

{

   193

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

   194

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

   195

	item->next = NULL;

   196

	item->comment = NULL;

   197

	item->value = NULL;

   198

	*group->last_item = item;

   199

	group->last_item = &item->next;

   200

	return item;

   201

}

   202

   203

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

   204

static IniFile *ini_load(const char *filename)

   205

{

   206

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

   207

	FILE *in;

   208

	IniFile *ini;

   209

	IniGroup *group = NULL;

   210

	IniItem *item;

   211

   212

	char *comment = NULL;

   213

	uint comment_size = 0;

   214

	uint comment_alloc = 0;

   215

   216

	ini = ini_alloc();

   217

   218

	in = fopen(filename, "r");

   219

	if (in == NULL) return ini;

   220

   221

	/* for each line in the file */

   222

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

   223

   224

		/* trim whitespace from the left side */

   225

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

   226

   227

		/* trim whitespace from right side. */

   228

		e = s + strlen(s);

   229

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

   230

		*e = '\0';

   231

   232

		/* skip comments and empty lines */

   233

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

   234

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

   235

			uint a = comment_alloc;

   236

			uint pos;

   237

			/* add to comment */

   238

			if (ns > a) {

   239

				a = max(a, 128U);

   240

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

   241

				comment = ReallocT(comment, comment_alloc = a);

   242

			}

   243

			pos = comment_size;

   244

			comment_size += (e - s + 1);

   245

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

   246

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

   247

			continue;

   248

		}

   249

   250

		/* it's a group? */

   251

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

   252

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

   253

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

   254

			} else {

   255

				e--;

   256

			}

   257

			s++; // skip [

   258

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

   259

			if (comment_size) {

   260

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

   261

				comment_size = 0;

   262

			}

   263

		} else if (group) {

   264

			/* find end of keyname */

   265

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

   266

				s++;

   267

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

   268

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

   269

			} else {

   270

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

   271

			}

   272

   273

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

   274

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

   275

			if (comment_size) {

   276

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

   277

				comment_size = 0;

   278

			}

   279

   280

			/* find start of parameter */

   281

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

   282

   283

   284

			/* remove starting quotation marks */

   285

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

   286

			/* remove ending quotation marks */

   287

			e = t + strlen(t);

   288

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

   289

			*e = '\0';

   290

   291

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

   292

		} else {

   293

			/* it's an orphan item */

   294

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

   295

		}

   296

	}

   297

   298

	if (comment_size > 0) {

   299

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

   300

		comment_size = 0;

   301

	}

   302

   303

	free(comment);

   304

	fclose(in);

   305

   306

	return ini;

   307

}

   308

   309

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

   310

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

   311

{

   312

	IniGroup *group;

   313

   314

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

   315

   316

	/* does it exist already? */

   317

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

   318

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

   319

			return group;

   320

   321

	/* otherwise make a new one */

   322

	group = ini_group_alloc(ini, name, len);

   323

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

   324

	return group;

   325

}

   326

   327

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

   328

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

   329

{

   330

	IniItem *item;

   331

	uint len = strlen(name);

   332

   333

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

   334

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

   335

   336

	if (!create) return NULL;

   337

   338

	/* otherwise make a new one */

   339

	return ini_item_alloc(group, name, len);

   340

}

   341

   342

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

   343

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

   344

{

   345

	FILE *f;

   346

	IniGroup *group;

   347

	IniItem *item;

   348

   349

	f = fopen(filename, "w");

   350

	if (f == NULL) return false;

   351

   352

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

   353

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

   354

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

   355

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

   356

			assert(item->value != NULL);

   357

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

   358

   359

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

   360

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

   361

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

   362

			} else {

   363

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

   364

			}

   365

   366

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

   367

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

   368

				fprintf(f, "\n");

   369

			} else {

   370

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

   371

			}

   372

		}

   373

	}

   374

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

   375

   376

	fclose(f);

   377

	return true;

   378

}

   379

   380

static void ini_free(IniFile *ini)

   381

{

   382

	pool_free(&ini->pool);

   383

}

   384

   385

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

   386

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

   387

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

   388

 * @param onelen force calculation of the *one parameter

   389

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

   390

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

   391

{

   392

	const char *s;

   393

	int idx;

   394

   395

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

   396

   397

	/* check if it's an integer */

   398

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

   399

		return strtoul(one, NULL, 0);

   400

   401

	idx = 0;

   402

	for (;;) {

   403

		/* find end of item */

   404

		s = many;

   405

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

   406

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

   407

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

   408

		many = s + 1;

   409

		idx++;

   410

	}

   411

}

   412

   413

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

   414

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

   415

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

   416

 * of seperated by a whitespace,tab or | character

   417

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

   418

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

   419

{

   420

	const char *s;

   421

	int r;

   422

	uint32 res = 0;

   423

   424

	for (;;) {

   425

		/* skip "whitespace" */

   426

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

   427

		if (*str == 0) break;

   428

   429

		s = str;

   430

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

   431

   432

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

   433

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

   434

   435

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

   436

		if (*s == 0) break;

   437

		str = s + 1;

   438

	}

   439

	return res;

   440

}

   441

   442

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

   443

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

   444

 * comma or a space character

   445

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

   446

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

   447

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

   448

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

   449

{

   450

	int n = 0, v;

   451

	char *end;

   452

   453

	for (;;) {

   454

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

   455

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

   456

		p = end;

   457

		items[n++] = v;

   458

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

   459

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

   460

		p++;

   461

	}

   462

   463

	return n;

   464

}

   465

   466

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

   467

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

   468

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

   469

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

   470

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

   471

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

   472

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

   473

{

   474

	int items[64];

   475

	int i, nitems;

   476

   477

	if (str == NULL) {

   478

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

   479

		nitems = nelems;

   480

	} else {

   481

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

   482

		if (nitems != nelems) return false;

   483

	}

   484

   485

	switch (type) {

   486

	case SLE_VAR_BL:

   487

	case SLE_VAR_I8:

   488

	case SLE_VAR_U8:

   489

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

   490

		break;

   491

	case SLE_VAR_I16:

   492

	case SLE_VAR_U16:

   493

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

   494

		break;

   495

	case SLE_VAR_I32:

   496

	case SLE_VAR_U32:

   497

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

   498

		break;

   499

	default: NOT_REACHED();