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

#ifdef WITH_FREETYPE

    44

#include "gfx.h"

    45

#include "fontcache.h"

    46

#endif

    47

    48

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

    49

Patches _patches_newgame;

    50

    51

typedef struct IniFile IniFile;

    52

typedef struct IniItem IniItem;

    53

typedef struct IniGroup IniGroup;

    54

typedef struct SettingsMemoryPool SettingsMemoryPool;

    55

    56

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

    57

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

    58

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

    59

    60

static void pool_init(SettingsMemoryPool **pool);

    61

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

    62

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

    63

static void pool_free(SettingsMemoryPool **pool);

    64

static bool IsSignedVarMemType(VarType vt);

    65

    66

struct SettingsMemoryPool {

    67

	uint pos,size;

    68

	SettingsMemoryPool *next;

    69

	byte mem[1];

    70

};

    71

    72

static SettingsMemoryPool *pool_new(uint minsize)

    73

{

    74

	SettingsMemoryPool *p;

    75

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

    76

    77

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

    78

	p->pos = 0;

    79

	p->size = minsize;

    80

	p->next = NULL;

    81

	return p;

    82

}

    83

    84

static void pool_init(SettingsMemoryPool **pool)

    85

{

    86

	*pool = pool_new(0);

    87

}

    88

    89

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

    90

{

    91

	uint pos;

    92

	SettingsMemoryPool *p = *pool;

    93

    94

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

    95

    96

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

    97

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

    98

		p = p->next;

    99

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

   100

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

   101

		SettingsMemoryPool *n = pool_new(size);

   102

		*pool = n;

   103

		n->next = p;

   104

		p = n;

   105

	}

   106

   107

	pos = p->pos;

   108

	p->pos += size;

   109

	return p->mem + pos;

   110

}

   111

   112

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

   113

{

   114

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

   115

	p[size] = 0;

   116

	memcpy(p, mem, size);

   117

	return p;

   118

}

   119

   120

static void pool_free(SettingsMemoryPool **pool)

   121

{

   122

	SettingsMemoryPool *p = *pool, *n;

   123

	*pool = NULL;

   124

	while (p) {

   125

		n = p->next;

   126

		free(p);

   127

		p = n;

   128

	}

   129

}

   130

   131

// structs describing the ini format.

   132

struct IniItem {

   133

	char *name;

   134

	char *value;

   135

	char *comment;

   136

	IniItem *next;

   137

};

   138

   139

struct IniGroup {

   140

	char *name; // name of group

   141

	char *comment; //comment for group

   142

	IniItem *item, **last_item;

   143

	IniGroup *next;

   144

	IniFile *ini;

   145

	IniGroupType type; // type of group

   146

};

   147

   148

struct IniFile {

   149

	SettingsMemoryPool *pool;

   150

	IniGroup *group, **last_group;

   151

	char *comment; // last comment in file

   152

};

   153

   154

// allocate an inifile object

   155

static IniFile *ini_alloc(void)

   156

{

   157

	IniFile *ini;

   158

	SettingsMemoryPool *pool;

   159

	pool_init(&pool);

   160

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

   161

	ini->pool = pool;

   162

	ini->group = NULL;

   163

	ini->last_group = &ini->group;

   164

	ini->comment = NULL;

   165

	return ini;

   166

}

   167

   168

// allocate an ini group object

   169

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

   170

{

   171

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

   172

	grp->ini = ini;

   173

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

   174

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

   175

		grp->type = IGT_LIST;

   176

	} else {

   177

		grp->type = IGT_VARIABLES;

   178

	}

   179

	grp->next = NULL;

   180

	grp->item = NULL;

   181

	grp->comment = NULL;

   182

	grp->last_item = &grp->item;

   183

	*ini->last_group = grp;

   184

	ini->last_group = &grp->next;

   185

	return grp;

   186

}

   187

   188

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

   189

{

   190

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

   191

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

   192

	item->next = NULL;

   193

	item->comment = NULL;

   194

	item->value = NULL;

   195

	*group->last_item = item;

   196

	group->last_item = &item->next;

   197

	return item;

   198

}

   199

   200

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

   201

static IniFile *ini_load(const char *filename)

   202

{

   203

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

   204

	FILE *in;

   205

	IniFile *ini;

   206

	IniGroup *group = NULL;

   207

	IniItem *item;

   208

   209

	char *comment = NULL;

   210

	uint comment_size = 0;

   211

	uint comment_alloc = 0;

   212

   213

	ini = ini_alloc();

   214

   215

	in = fopen(filename, "r");

   216

	if (in == NULL) return ini;

   217

   218

	// for each line in the file

   219

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

   220

   221

		// trim whitespace from the left side

   222

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

   223

   224

		// trim whitespace from right side.

   225

		e = s + strlen(s);

   226

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

   227

		*e = '\0';

   228

   229

		// skip comments and empty lines

   230

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

   231

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

   232

			uint a = comment_alloc;

   233

			uint pos;

   234

			// add to comment

   235

			if (ns > a) {

   236

				a = max(a, 128);

   237

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

   238

				comment = realloc(comment, comment_alloc = a);

   239

			}

   240

			pos = comment_size;

   241

			comment_size += (e - s + 1);

   242

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

   243

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

   244

			continue;

   245

		}

   246

   247

		// it's a group?

   248

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

   249

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

   250

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

   251

			} else {

   252

				e--;

   253

			}

   254

			s++; // skip [

   255

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

   256

			if (comment_size) {

   257

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

   258

				comment_size = 0;

   259

			}

   260

		} else if (group) {

   261

			// find end of keyname

   262

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

   263

   264

			// it's an item in an existing group

   265

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

   266

			if (comment_size) {

   267

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

   268

				comment_size = 0;

   269

			}

   270

   271

			// find start of parameter

   272

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

   273

   274

   275

			// remove starting quotation marks

   276

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

   277

			// remove ending quotation marks

   278

			e = t + strlen(t);

   279

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

   280

			*e = '\0';

   281

   282

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

   283

		} else {

   284

			// it's an orphan item

   285

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

   286

		}

   287

	}

   288

   289

	if (comment_size > 0) {

   290

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

   291

		comment_size = 0;

   292

	}

   293

   294

	free(comment);

   295

	fclose(in);

   296

   297

	return ini;

   298

}

   299

   300

// lookup a group or make a new one

   301

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

   302

{

   303

	IniGroup *group;

   304

   305

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

   306

   307

	// does it exist already?

   308

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

   309

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

   310

			return group;

   311

   312

	// otherwise make a new one

   313

	group = ini_group_alloc(ini, name, len);

   314

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

   315

	return group;

   316

}

   317

   318

// lookup an item or make a new one

   319

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

   320

{

   321

	IniItem *item;

   322

	uint len = strlen(name);

   323

   324

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

   325

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

   326

   327

	if (!create) return NULL;

   328

   329

	// otherwise make a new one

   330

	return ini_item_alloc(group, name, len);

   331

}

   332

   333

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

   334

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

   335

{

   336

	FILE *f;

   337

	IniGroup *group;

   338

	IniItem *item;

   339

   340

	f = fopen(filename, "w");

   341

	if (f == NULL) return false;

   342

   343

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

   344

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

   345

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

   346

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

   347

			assert(item->value != NULL);

   348

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

   349

   350

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

   351

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

   352

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

   353

			} else {

   354

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

   355

			}

   356

		}

   357

	}

   358

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

   359

   360

	fclose(f);

   361

	return true;

   362

}

   363

   364

static void ini_free(IniFile *ini)

   365

{

   366

	pool_free(&ini->pool);

   367

}

   368

   369

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

   370

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

   371

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

   372

 * @param onelen force calculation of the *one parameter

   373

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

   374

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

   375

{

   376

	const char *s;

   377

	int idx;

   378

   379

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

   380

   381

	// check if it's an integer

   382

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

   383

		return strtoul(one, NULL, 0);

   384

   385

	idx = 0;

   386

	for (;;) {

   387

		// find end of item

   388

		s = many;

   389

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

   390

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

   391

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

   392

		many = s + 1;

   393

		idx++;

   394

	}

   395

}

   396

   397

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

   398

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

   399

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

   400

 * of seperated by a whitespace\tab or | character

   401

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

   402

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

   403

{

   404

	const char *s;

   405

	int r;

   406

	uint32 res = 0;

   407

   408

	for (;;) {

   409

		// skip "whitespace"

   410

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

   411

		if (*str == 0) break;

   412

   413

		s = str;

   414

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

   415

   416

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

   417

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

   418

   419

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

   420

		if (*s == 0) break;

   421

		str = s + 1;

   422

	}

   423

	return res;

   424

}

   425

   426

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

   427

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

   428

 * comma or a space character

   429

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

   430

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

   431

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

   432

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

   433

{

   434

	int n = 0, v;

   435

	char *end;

   436

   437

	for (;;) {

   438

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

   439

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

   440

		p = end;

   441

		items[n++] = v;

   442

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

   443

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

   444

		p++;

   445

	}

   446

   447

	return n;

   448

}

   449

   450

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

   451

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

   452

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

   453

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

   454

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

   455

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

   456

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

   457

{

   458

	int items[64];

   459

	int i, nitems;

   460

   461

	if (str == NULL) {

   462

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

   463

		nitems = nelems;

   464

	} else {

   465

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

   466

		if (nitems != nelems) return false;

   467

	}

   468

   469

	switch (type) {

   470

	case SLE_VAR_BL:

   471

	case SLE_VAR_I8:

   472

	case SLE_VAR_U8:

   473

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

   474

		break;

   475

	case SLE_VAR_I16:

   476

	case SLE_VAR_U16:

   477

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

   478

		break;

   479

	case SLE_VAR_I32:

   480

	case SLE_VAR_U32:

   481

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

   482

		break;

   483

	default: NOT_REACHED();

   484

	}

   485

   486

	return true;

   487

}

   488

   489

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

   490

 * is seperated by a comma or a space character

   491

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

   492

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

   493

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

   494

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

   495

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

   496

{

   497

	int i, v = 0;

   498

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

   499

   500

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

   501

		switch (type) {

   502

		case SLE_VAR_BL:

   503

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

   504

		case SLE_VAR_U8:  v = *(byte*)p;   p += 1; break;

   505

		case SLE_VAR_I16: v = *(int16*)p;  p += 2; break;

   506

		case SLE_VAR_U16: v = *(uint16*)p; p += 2; break;