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

    40

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

    41

Patches _patches_newgame;

    42

    43

typedef struct IniFile IniFile;

    44

typedef struct IniItem IniItem;

    45

typedef struct IniGroup IniGroup;

    46

typedef struct SettingsMemoryPool SettingsMemoryPool;

    47

    48

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

    49

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

    50

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

    51

    52

static void pool_init(SettingsMemoryPool **pool);

    53

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

    54

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

    55

static void pool_free(SettingsMemoryPool **pool);

    56

static bool IsSignedVarMemType(VarType vt);

    57

    58

struct SettingsMemoryPool {

    59

	uint pos,size;

    60

	SettingsMemoryPool *next;

    61

	byte mem[1];

    62

};

    63

    64

static SettingsMemoryPool *pool_new(uint minsize)

    65

{

    66

	SettingsMemoryPool *p;

    67

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

    68

    69

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

    70

	p->pos = 0;

    71

	p->size = minsize;

    72

	p->next = NULL;

    73

	return p;

    74

}

    75

    76

static void pool_init(SettingsMemoryPool **pool)

    77

{

    78

	*pool = pool_new(0);

    79

}

    80

    81

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

    82

{

    83

	uint pos;

    84

	SettingsMemoryPool *p = *pool;

    85

    86

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

    87

    88

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

    89

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

    90

		p = p->next;

    91

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

    92

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

    93

		SettingsMemoryPool *n = pool_new(size);

    94

		*pool = n;

    95

		n->next = p;

    96

		p = n;

    97

	}

    98

    99

	pos = p->pos;

   100

	p->pos += size;

   101

	return p->mem + pos;

   102

}

   103

   104

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

   105

{

   106

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

   107

	p[size] = 0;

   108

	memcpy(p, mem, size);

   109

	return p;

   110

}

   111

   112

static void pool_free(SettingsMemoryPool **pool)

   113

{

   114

	SettingsMemoryPool *p = *pool, *n;

   115

	*pool = NULL;

   116

	while (p) {

   117

		n = p->next;

   118

		free(p);

   119

		p = n;

   120

	}

   121

}

   122

   123

// structs describing the ini format.

   124

struct IniItem {

   125

	char *name;

   126

	char *value;

   127

	char *comment;

   128

	IniItem *next;

   129

};

   130

   131

struct IniGroup {

   132

	char *name; // name of group

   133

	char *comment; //comment for group

   134

	IniItem *item, **last_item;

   135

	IniGroup *next;

   136

	IniFile *ini;

   137

	IniGroupType type; // type of group

   138

};

   139

   140

struct IniFile {

   141

	SettingsMemoryPool *pool;

   142

	IniGroup *group, **last_group;

   143

	char *comment; // last comment in file

   144

};

   145

   146

// allocate an inifile object

   147

static IniFile *ini_alloc(void)

   148

{

   149

	IniFile *ini;

   150

	SettingsMemoryPool *pool;

   151

	pool_init(&pool);

   152

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

   153

	ini->pool = pool;

   154

	ini->group = NULL;

   155

	ini->last_group = &ini->group;

   156

	ini->comment = NULL;

   157

	return ini;

   158

}

   159

   160

// allocate an ini group object

   161

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

   162

{

   163

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

   164

	grp->ini = ini;

   165

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

   166

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

   167

		grp->type = IGT_LIST;

   168

	} else {

   169

		grp->type = IGT_VARIABLES;

   170

	}

   171

	grp->next = NULL;

   172

	grp->item = NULL;

   173

	grp->comment = NULL;

   174

	grp->last_item = &grp->item;

   175

	*ini->last_group = grp;

   176

	ini->last_group = &grp->next;

   177

	return grp;

   178

}

   179

   180

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

   181

{

   182

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

   183

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

   184

	item->next = NULL;

   185

	item->comment = NULL;

   186

	item->value = NULL;

   187

	*group->last_item = item;

   188

	group->last_item = &item->next;

   189

	return item;

   190

}

   191

   192

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

   193

static IniFile *ini_load(const char *filename)

   194

{

   195

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

   196

	FILE *in;

   197

	IniFile *ini;

   198

	IniGroup *group = NULL;

   199

	IniItem *item;

   200

   201

	char *comment = NULL;

   202

	uint comment_size = 0;

   203

	uint comment_alloc = 0;

   204

   205

	ini = ini_alloc();

   206

   207

	in = fopen(filename, "r");

   208

	if (in == NULL) return ini;

   209

   210

	// for each line in the file

   211

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

   212

   213

		// trim whitespace from the left side

   214

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

   215

   216

		// trim whitespace from right side.

   217

		e = s + strlen(s);

   218

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

   219

		*e = '\0';

   220

   221

		// skip comments and empty lines

   222

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

   223

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

   224

			uint a = comment_alloc;

   225

			uint pos;

   226

			// add to comment

   227

			if (ns > a) {

   228

				a = max(a, 128);

   229

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

   230

				comment = realloc(comment, comment_alloc = a);

   231

			}

   232

			pos = comment_size;

   233

			comment_size += (e - s + 1);

   234

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

   235

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

   236

			continue;

   237

		}

   238

   239

		// it's a group?

   240

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

   241

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

   242

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

   243

			else

   244

				e--;

   245

			s++; // skip [

   246

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

   247

			if (comment_size) {

   248

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

   249

				comment_size = 0;

   250

			}

   251

		} else if (group) {

   252

			// find end of keyname

   253

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

   254

   255

			// it's an item in an existing group

   256

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

   257

			if (comment_size) {

   258

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

   259

				comment_size = 0;

   260

			}

   261

   262

			// find start of parameter

   263

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

   264

   265

   266

			// remove starting quotation marks

   267

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

   268

			// remove ending quotation marks

   269

			e = t + strlen(t);

   270

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

   271

			*e = '\0';

   272

   273

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

   274

		} else {

   275

			// it's an orphan item

   276

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

   277

		}

   278

	}

   279

   280

	if (comment_size > 0) {

   281

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

   282

		comment_size = 0;

   283

	}

   284

   285

	free(comment);

   286

	fclose(in);

   287

   288

	return ini;

   289

}

   290

   291

// lookup a group or make a new one

   292

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

   293

{

   294

	IniGroup *group;

   295

   296

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

   297

   298

	// does it exist already?

   299

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

   300

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

   301

			return group;

   302

   303

	// otherwise make a new one

   304

	group = ini_group_alloc(ini, name, len);

   305

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

   306

	return group;

   307

}

   308

   309

// lookup an item or make a new one

   310

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

   311

{

   312

	IniItem *item;

   313

	uint len = strlen(name);

   314

   315

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

   316

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

   317

   318

	if (!create) return NULL;

   319

   320

	// otherwise make a new one

   321

	return ini_item_alloc(group, name, len);

   322

}

   323

   324

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

   325

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

   326

{

   327

	FILE *f;

   328

	IniGroup *group;

   329

	IniItem *item;

   330

   331

	f = fopen(filename, "w");

   332

	if (f == NULL) return false;

   333

   334

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

   335

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

   336

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

   337

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

   338

			assert(item->value != NULL);

   339

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

   340

   341

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

   342

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

   343

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

   344

			} else

   345

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

   346

		}

   347

	}

   348

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

   349

   350

	fclose(f);

   351

	return true;

   352

}

   353

   354

static void ini_free(IniFile *ini)

   355

{

   356

	pool_free(&ini->pool);

   357

}

   358

   359

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

   360

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

   361

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

   362

 * @param onelen force calculation of the *one parameter

   363

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

   364

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

   365

{

   366

	const char *s;

   367

	int idx;

   368

   369

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

   370

   371

	// check if it's an integer

   372

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

   373

		return strtoul(one, NULL, 0);

   374

   375

	idx = 0;

   376

	for (;;) {

   377

		// find end of item

   378

		s = many;

   379

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

   380

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

   381

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

   382

		many = s + 1;

   383

		idx++;

   384

	}

   385

}

   386

   387

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

   388

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

   389

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

   390

 * of seperated by a whitespace\tab or | character

   391

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

   392

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

   393

{

   394

	const char *s;

   395

	int r;

   396

	uint32 res = 0;

   397

   398

	for (;;) {

   399

		// skip "whitespace"

   400

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

   401

		if (*str == 0) break;

   402

   403

		s = str;

   404

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

   405

   406

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

   407

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

   408

   409

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

   410

		if (*s == 0) break;

   411

		str = s + 1;

   412

	}

   413

	return res;

   414

}

   415

   416

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

   417

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

   418

 * comma or a space character

   419

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

   420

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

   421

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

   422

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

   423

{

   424

	int n = 0, v;

   425

	char *end;

   426

   427

	for (;;) {

   428

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

   429

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

   430

		p = end;

   431

		items[n++] = v;

   432

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

   433

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

   434

		p++;

   435

	}

   436

   437

	return n;

   438

}

   439

   440

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

   441

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

   442

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

   443

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

   444

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

   445

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

   446

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

   447

{

   448

	int items[64];

   449

	int i, nitems;

   450

   451

	if (str == NULL) {

   452

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

   453

		nitems = nelems;

   454

	} else {

   455

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

   456

		if (nitems != nelems) return false;

   457

	}

   458

   459

	switch (type) {

   460

	case SLE_VAR_BL:

   461

	case SLE_VAR_I8:

   462

	case SLE_VAR_U8:

   463

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

   464

		break;

   465

	case SLE_VAR_I16:

   466

	case SLE_VAR_U16:

   467

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

   468

		break;

   469

	case SLE_VAR_I32:

   470

	case SLE_VAR_U32:

   471

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

   472

		break;

   473

	default: NOT_REACHED();

   474

	}

   475

   476

	return true;

   477

}

   478

   479

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

   480

 * is seperated by a comma or a space character

   481

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

   482

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

   483

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

   484

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

   485

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

   486

{

   487

	int i, v = 0;

   488

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

   489

   490

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

   491

		switch (type) {

   492

		case SLE_VAR_BL:

   493

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

   494

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

   495

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

   496

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

   497

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

   498

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

   499

		default: NOT_REACHED();

   500

		}

   501

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

   502

	}

   503

}

   504

   505

/** Convert a ONEofMANY structure to a string representation.

   506

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

   507

 * @param many the full-domain string of possible values