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

    40

#include "date.h"

    41

    42

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

    43

Patches _patches_newgame;

    44

    45

typedef struct IniFile IniFile;

    46

typedef struct IniItem IniItem;

    47

typedef struct IniGroup IniGroup;

    48

typedef struct SettingsMemoryPool SettingsMemoryPool;

    49

    50

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

    51

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

    52

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

    53

    54

static void pool_init(SettingsMemoryPool **pool);

    55

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

    56

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

    57

static void pool_free(SettingsMemoryPool **pool);

    58

static bool IsSignedVarMemType(VarType vt);

    59

    60

struct SettingsMemoryPool {

    61

	uint pos,size;

    62

	SettingsMemoryPool *next;

    63

	byte mem[1];

    64

};

    65

    66

static SettingsMemoryPool *pool_new(uint minsize)

    67

{

    68

	SettingsMemoryPool *p;

    69

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

    70

    71

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

    72

	p->pos = 0;

    73

	p->size = minsize;

    74

	p->next = NULL;

    75

	return p;

    76

}

    77

    78

static void pool_init(SettingsMemoryPool **pool)

    79

{

    80

	*pool = pool_new(0);

    81

}

    82

    83

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

    84

{

    85

	uint pos;

    86

	SettingsMemoryPool *p = *pool;

    87

    88

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

    89

    90

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

    91

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

    92

		p = p->next;

    93

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

    94

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

    95

		SettingsMemoryPool *n = pool_new(size);

    96

		*pool = n;

    97

		n->next = p;

    98

		p = n;

    99

	}

   100

   101

	pos = p->pos;

   102

	p->pos += size;

   103

	return p->mem + pos;

   104

}

   105

   106

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

   107

{

   108

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

   109

	p[size] = 0;

   110

	memcpy(p, mem, size);

   111

	return p;

   112

}

   113

   114

static void pool_free(SettingsMemoryPool **pool)

   115

{

   116

	SettingsMemoryPool *p = *pool, *n;

   117

	*pool = NULL;

   118

	while (p) {

   119

		n = p->next;

   120

		free(p);

   121

		p = n;

   122

	}

   123

}

   124

   125

// structs describing the ini format.

   126

struct IniItem {

   127

	char *name;

   128

	char *value;

   129

	char *comment;

   130

	IniItem *next;

   131

};

   132

   133

struct IniGroup {

   134

	char *name; // name of group

   135

	char *comment; //comment for group

   136

	IniItem *item, **last_item;

   137

	IniGroup *next;

   138

	IniFile *ini;

   139

	IniGroupType type; // type of group

   140

};

   141

   142

struct IniFile {

   143

	SettingsMemoryPool *pool;

   144

	IniGroup *group, **last_group;

   145

	char *comment; // last comment in file

   146

};

   147

   148

// allocate an inifile object

   149

static IniFile *ini_alloc(void)

   150

{

   151

	IniFile *ini;

   152

	SettingsMemoryPool *pool;

   153

	pool_init(&pool);

   154

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

   155

	ini->pool = pool;

   156

	ini->group = NULL;

   157

	ini->last_group = &ini->group;

   158

	ini->comment = NULL;

   159

	return ini;

   160

}

   161

   162

// allocate an ini group object

   163

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

   164

{

   165

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

   166

	grp->ini = ini;

   167

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

   168

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

   169

		grp->type = IGT_LIST;

   170

	} else {

   171

		grp->type = IGT_VARIABLES;

   172

	}

   173

	grp->next = NULL;

   174

	grp->item = NULL;

   175

	grp->comment = NULL;

   176

	grp->last_item = &grp->item;

   177

	*ini->last_group = grp;

   178

	ini->last_group = &grp->next;

   179

	return grp;

   180

}

   181

   182

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

   183

{

   184

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

   185

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

   186

	item->next = NULL;

   187

	item->comment = NULL;

   188

	item->value = NULL;

   189

	*group->last_item = item;

   190

	group->last_item = &item->next;

   191

	return item;

   192

}

   193

   194

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

   195

static IniFile *ini_load(const char *filename)

   196

{

   197

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

   198

	FILE *in;

   199

	IniFile *ini;

   200

	IniGroup *group = NULL;

   201

	IniItem *item;

   202

   203

	char *comment = NULL;

   204

	uint comment_size = 0;

   205

	uint comment_alloc = 0;

   206

   207

	ini = ini_alloc();

   208

   209

	in = fopen(filename, "r");

   210

	if (in == NULL) return ini;

   211

   212

	// for each line in the file

   213

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

   214

   215

		// trim whitespace from the left side

   216

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

   217

   218

		// trim whitespace from right side.

   219

		e = s + strlen(s);

   220

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

   221

		*e = '\0';

   222

   223

		// skip comments and empty lines

   224

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

   225

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

   226

			uint a = comment_alloc;

   227

			uint pos;

   228

			// add to comment

   229

			if (ns > a) {

   230

				a = max(a, 128);

   231

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

   232

				comment = realloc(comment, comment_alloc = a);

   233

			}

   234

			pos = comment_size;

   235

			comment_size += (e - s + 1);

   236

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

   237

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

   238

			continue;

   239

		}

   240

   241

		// it's a group?

   242

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

   243

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

   244

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

   245

			} else {

   246

				e--;

   247

			}

   248

			s++; // skip [

   249

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

   250

			if (comment_size) {

   251

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

   252

				comment_size = 0;

   253

			}

   254

		} else if (group) {

   255

			// find end of keyname

   256

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

   257

   258

			// it's an item in an existing group

   259

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

   260

			if (comment_size) {

   261

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

   262

				comment_size = 0;

   263

			}

   264

   265

			// find start of parameter

   266

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

   267

   268

   269

			// remove starting quotation marks

   270

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

   271

			// remove ending quotation marks

   272

			e = t + strlen(t);

   273

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

   274

			*e = '\0';

   275

   276

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

   277

		} else {

   278

			// it's an orphan item

   279

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

   280

		}

   281

	}

   282

   283

	if (comment_size > 0) {

   284

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

   285

		comment_size = 0;

   286

	}

   287

   288

	free(comment);

   289

	fclose(in);

   290

   291

	return ini;

   292

}

   293

   294

// lookup a group or make a new one

   295

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

   296

{

   297

	IniGroup *group;

   298

   299

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

   300

   301

	// does it exist already?

   302

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

   303

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

   304

			return group;

   305

   306

	// otherwise make a new one

   307

	group = ini_group_alloc(ini, name, len);

   308

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

   309

	return group;

   310

}

   311

   312

// lookup an item or make a new one

   313

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

   314

{

   315

	IniItem *item;

   316

	uint len = strlen(name);

   317

   318

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

   319

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

   320

   321

	if (!create) return NULL;

   322

   323

	// otherwise make a new one

   324

	return ini_item_alloc(group, name, len);

   325

}

   326

   327

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

   328

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

   329

{

   330

	FILE *f;

   331

	IniGroup *group;

   332

	IniItem *item;

   333

   334

	f = fopen(filename, "w");

   335

	if (f == NULL) return false;

   336

   337

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

   338

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

   339

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

   340

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

   341

			assert(item->value != NULL);

   342

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

   343

   344

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

   345

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

   346

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

   347

			} else {

   348

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

   349

			}

   350

		}

   351

	}

   352

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

   353

   354

	fclose(f);

   355

	return true;

   356

}

   357

   358

static void ini_free(IniFile *ini)

   359

{

   360

	pool_free(&ini->pool);

   361

}

   362

   363

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

   364

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

   365

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

   366

 * @param onelen force calculation of the *one parameter

   367

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

   368

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

   369

{

   370

	const char *s;

   371

	int idx;

   372

   373

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

   374

   375

	// check if it's an integer

   376

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

   377

		return strtoul(one, NULL, 0);

   378

   379

	idx = 0;

   380

	for (;;) {

   381

		// find end of item

   382

		s = many;

   383

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

   384

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

   385

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

   386

		many = s + 1;

   387

		idx++;

   388

	}

   389

}

   390

   391

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

   392

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

   393

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

   394

 * of seperated by a whitespace\tab or | character

   395

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

   396

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

   397

{

   398

	const char *s;

   399

	int r;

   400

	uint32 res = 0;

   401

   402

	for (;;) {

   403

		// skip "whitespace"

   404

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

   405

		if (*str == 0) break;

   406

   407

		s = str;

   408

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

   409

   410

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

   411

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

   412

   413

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

   414

		if (*s == 0) break;

   415

		str = s + 1;

   416

	}

   417

	return res;

   418

}

   419

   420

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

   421

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

   422

 * comma or a space character

   423

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

   424

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

   425

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

   426

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

   427

{

   428

	int n = 0, v;

   429

	char *end;

   430

   431

	for (;;) {

   432

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

   433

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

   434

		p = end;

   435

		items[n++] = v;

   436

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

   437

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

   438

		p++;

   439

	}

   440

   441

	return n;

   442

}

   443

   444

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

   445

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

   446

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

   447

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

   448

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

   449

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

   450

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

   451

{

   452

	int items[64];

   453

	int i, nitems;

   454

   455

	if (str == NULL) {

   456

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

   457

		nitems = nelems;

   458

	} else {

   459

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

   460

		if (nitems != nelems) return false;

   461

	}

   462

   463

	switch (type) {

   464

	case SLE_VAR_BL:

   465

	case SLE_VAR_I8:

   466

	case SLE_VAR_U8:

   467

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

   468

		break;

   469

	case SLE_VAR_I16:

   470

	case SLE_VAR_U16:

   471

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

   472

		break;

   473

	case SLE_VAR_I32:

   474

	case SLE_VAR_U32:

   475

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

   476

		break;

   477

	default: NOT_REACHED();

   478

	}

   479

   480

	return true;

   481

}

   482

   483

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

   484

 * is seperated by a comma or a space character

   485

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

   486

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

   487

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

   488

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

   489

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

   490

{

   491

	int i, v = 0;

   492

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

   493

   494

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

   495

		switch (type) {

   496

		case SLE_VAR_BL:

   497

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

   498

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

   499

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

   500

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

   501

		case SLE_VAR_I32: v = *(int32*)p;  p += 4; break;

   502

		case SLE_VAR_U32: v = *(uint32*)p; p += 4; break;

   503

		default: NOT_REACHED();

   504

		}

   505

		buf += sprintf(buf, (i == 0) ? "%d" : ",%d", v);

   506

	}