1

/* $Id$ */

     2

     3

/** @file

     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

#ifdef WITH_FREETYPE

    45

#include "gfx.h"

    46

#include "fontcache.h"

    47

#endif

    48

    49

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

    50

Patches _patches_newgame;

    51

    52

typedef struct IniFile IniFile;

    53

typedef struct IniItem IniItem;

    54

typedef struct IniGroup IniGroup;

    55

typedef struct SettingsMemoryPool SettingsMemoryPool;

    56

    57

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

    58

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

    59

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

    60

    61

static void pool_init(SettingsMemoryPool **pool);

    62

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

    63

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

    64

static void pool_free(SettingsMemoryPool **pool);

    65

static bool IsSignedVarMemType(VarType vt);

    66

    67

struct SettingsMemoryPool {

    68

	uint pos,size;

    69

	SettingsMemoryPool *next;

    70

	byte mem[1];

    71

};

    72

    73

static SettingsMemoryPool *pool_new(uint minsize)

    74

{

    75

	SettingsMemoryPool *p;

    76

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

    77

    78

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

    79

	p->pos = 0;

    80

	p->size = minsize;

    81

	p->next = NULL;

    82

	return p;

    83

}

    84

    85

static void pool_init(SettingsMemoryPool **pool)

    86

{

    87

	*pool = pool_new(0);

    88

}

    89

    90

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

    91

{

    92

	uint pos;

    93

	SettingsMemoryPool *p = *pool;

    94

    95

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

    96

    97

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

    98

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

    99

		p = p->next;

   100

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

   101

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

   102

		SettingsMemoryPool *n = pool_new(size);

   103

		*pool = n;

   104

		n->next = p;

   105

		p = n;

   106

	}

   107

   108

	pos = p->pos;

   109

	p->pos += size;

   110

	return p->mem + pos;

   111

}

   112

   113

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

   114

{

   115

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

   116

	p[size] = 0;

   117

	memcpy(p, mem, size);

   118

	return p;

   119

}

   120

   121

static void pool_free(SettingsMemoryPool **pool)

   122

{

   123

	SettingsMemoryPool *p = *pool, *n;

   124

	*pool = NULL;

   125

	while (p) {

   126

		n = p->next;

   127

		free(p);

   128

		p = n;

   129

	}

   130

}

   131

   132

// structs describing the ini format.

   133

struct IniItem {

   134

	char *name;

   135

	char *value;

   136

	char *comment;

   137

	IniItem *next;

   138

};

   139

   140

struct IniGroup {

   141

	char *name; // name of group

   142

	char *comment; //comment for group

   143

	IniItem *item, **last_item;

   144

	IniGroup *next;

   145

	IniFile *ini;

   146

	IniGroupType type; // type of group

   147

};

   148

   149

struct IniFile {

   150

	SettingsMemoryPool *pool;

   151

	IniGroup *group, **last_group;

   152

	char *comment; // last comment in file

   153

};

   154

   155

// allocate an inifile object

   156

static IniFile *ini_alloc(void)

   157

{

   158

	IniFile *ini;

   159

	SettingsMemoryPool *pool;

   160

	pool_init(&pool);

   161

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

   162

	ini->pool = pool;

   163

	ini->group = NULL;

   164

	ini->last_group = &ini->group;

   165

	ini->comment = NULL;

   166

	return ini;

   167

}

   168

   169

// allocate an ini group object

   170

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

   171

{

   172

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

   173

	grp->ini = ini;

   174

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

   175

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

   176

		grp->type = IGT_LIST;

   177

	} else {

   178

		grp->type = IGT_VARIABLES;

   179

	}

   180

	grp->next = NULL;

   181

	grp->item = NULL;

   182

	grp->comment = NULL;

   183

	grp->last_item = &grp->item;

   184

	*ini->last_group = grp;

   185

	ini->last_group = &grp->next;

   186

	return grp;

   187

}

   188

   189

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

   190

{

   191

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

   192

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

   193

	item->next = NULL;

   194

	item->comment = NULL;

   195

	item->value = NULL;

   196

	*group->last_item = item;

   197

	group->last_item = &item->next;

   198

	return item;

   199

}

   200

   201

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

   202

static IniFile *ini_load(const char *filename)

   203

{

   204

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

   205

	FILE *in;

   206

	IniFile *ini;

   207

	IniGroup *group = NULL;

   208

	IniItem *item;

   209

   210

	char *comment = NULL;

   211

	uint comment_size = 0;

   212

	uint comment_alloc = 0;

   213

   214

	ini = ini_alloc();

   215

   216

	in = fopen(filename, "r");

   217

	if (in == NULL) return ini;

   218

   219

	// for each line in the file

   220

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

   221

   222

		// trim whitespace from the left side

   223

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

   224

   225

		// trim whitespace from right side.

   226

		e = s + strlen(s);

   227

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

   228

		*e = '\0';

   229

   230

		// skip comments and empty lines

   231

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

   232

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

   233

			uint a = comment_alloc;

   234

			uint pos;

   235

			// add to comment

   236

			if (ns > a) {

   237

				a = max(a, 128);

   238

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

   239

				ReallocT(&comment, comment_alloc = a);

   240

			}

   241

			pos = comment_size;

   242

			comment_size += (e - s + 1);

   243

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

   244

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

   245

			continue;

   246

		}

   247

   248

		// it's a group?

   249

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

   250

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

   251

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

   252

			} else {

   253

				e--;

   254

			}

   255

			s++; // skip [

   256

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

   257

			if (comment_size) {

   258

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

   259

				comment_size = 0;

   260

			}

   261

		} else if (group) {

   262

			// find end of keyname

   263

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

   264

   265

			// it's an item in an existing group

   266

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

   267

			if (comment_size) {

   268

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

   269

				comment_size = 0;

   270

			}

   271

   272

			// find start of parameter

   273

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

   274

   275

   276

			// remove starting quotation marks

   277

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

   278

			// remove ending quotation marks

   279

			e = t + strlen(t);

   280

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

   281

			*e = '\0';

   282

   283

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

   284

		} else {

   285

			// it's an orphan item

   286

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

   287

		}

   288

	}

   289

   290

	if (comment_size > 0) {

   291

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

   292

		comment_size = 0;

   293

	}

   294

   295

	free(comment);

   296

	fclose(in);

   297

   298

	return ini;

   299

}

   300

   301

// lookup a group or make a new one

   302

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

   303

{

   304

	IniGroup *group;

   305

   306

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

   307

   308

	// does it exist already?

   309

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

   310

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

   311

			return group;

   312

   313

	// otherwise make a new one

   314

	group = ini_group_alloc(ini, name, len);

   315

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

   316

	return group;

   317

}

   318

   319

// lookup an item or make a new one

   320

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

   321

{

   322

	IniItem *item;

   323

	uint len = strlen(name);

   324

   325

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

   326

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

   327

   328

	if (!create) return NULL;

   329

   330

	// otherwise make a new one

   331

	return ini_item_alloc(group, name, len);

   332

}

   333

   334

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

   335

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

   336

{

   337

	FILE *f;

   338

	IniGroup *group;

   339

	IniItem *item;

   340

   341

	f = fopen(filename, "w");

   342

	if (f == NULL) return false;

   343

   344

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

   345

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

   346

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

   347

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

   348

			assert(item->value != NULL);

   349

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

   350

   351

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

   352

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

   353

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

   354

			} else {

   355

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

   356

			}

   357

		}

   358

	}

   359

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

   360

   361

	fclose(f);

   362

	return true;

   363

}

   364

   365

static void ini_free(IniFile *ini)

   366

{

   367

	pool_free(&ini->pool);

   368

}

   369

   370

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

   371

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

   372

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

   373

 * @param onelen force calculation of the *one parameter

   374

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

   375

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

   376

{

   377

	const char *s;

   378

	int idx;

   379

   380

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

   381

   382

	// check if it's an integer

   383

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

   384

		return strtoul(one, NULL, 0);

   385

   386

	idx = 0;

   387

	for (;;) {

   388

		// find end of item

   389

		s = many;

   390

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

   391

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

   392

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

   393

		many = s + 1;

   394

		idx++;

   395

	}

   396

}

   397

   398

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

   399

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

   400

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

   401

 * of seperated by a whitespace\tab or | character

   402

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

   403

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

   404

{

   405

	const char *s;

   406

	int r;

   407

	uint32 res = 0;

   408

   409

	for (;;) {

   410

		// skip "whitespace"

   411

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

   412

		if (*str == 0) break;

   413

   414

		s = str;

   415

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

   416

   417

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

   418

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

   419

   420

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

   421

		if (*s == 0) break;

   422

		str = s + 1;

   423

	}

   424

	return res;

   425

}

   426

   427

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

   428

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

   429

 * comma or a space character

   430

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

   431

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

   432

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

   433

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

   434

{

   435

	int n = 0, v;

   436

	char *end;

   437

   438

	for (;;) {

   439

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

   440

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

   441

		p = end;

   442

		items[n++] = v;

   443

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

   444

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

   445

		p++;

   446

	}

   447

   448

	return n;

   449

}

   450

   451

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

   452

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

   453

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

   454

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

   455

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

   456

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

   457

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

   458

{

   459

	int items[64];

   460

	int i, nitems;

   461

   462

	if (str == NULL) {

   463

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

   464

		nitems = nelems;

   465

	} else {

   466

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

   467

		if (nitems != nelems) return false;

   468

	}

   469

   470

	switch (type) {

   471

	case SLE_VAR_BL:

   472

	case SLE_VAR_I8:

   473

	case SLE_VAR_U8:

   474

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

   475

		break;

   476

	case SLE_VAR_I16:

   477

	case SLE_VAR_U16:

   478

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

   479

		break;

   480

	case SLE_VAR_I32:

   481

	case SLE_VAR_U32:

   482

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

   483

		break;

   484

	default: NOT_REACHED();

   485

	}

   486

   487

	return true;

   488

}

   489

   490

/** Convert an integer-array (intlist) to a string representation. Each value

   491

 * is seperated by a comma or a space character

   492

 * @param buf output buffer where the string-representation will be stored

   493

 * @param array pointer to the integer-arrays that is read from

   494

 * @param nelems the number of elements the array holds.

   495

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

   496

static void make_intlist(char *buf, const void *array, int nelems, VarType type)

   497

{

   498

	int i, v = 0;

   499

	const byte *p = (const byte*)array;

   500

   501

	for (i = 0; i != nelems; i++) {

   502

		switch (type) {

   503

		case SLE_VAR_BL:

   504

		case SLE_VAR_I8:  v = *(int8*)p;   p += 1; break;