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

    38

    39

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

    40

Patches _patches_newgame;

    41

    42

typedef struct IniFile IniFile;

    43

typedef struct IniItem IniItem;

    44

typedef struct IniGroup IniGroup;

    45

typedef struct SettingsMemoryPool SettingsMemoryPool;

    46

    47

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

    48

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

    49

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

    50

    51

static void pool_init(SettingsMemoryPool **pool);

    52

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

    53

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

    54

static void pool_free(SettingsMemoryPool **pool);

    55

    56

struct SettingsMemoryPool {

    57

	uint pos,size;

    58

	SettingsMemoryPool *next;

    59

	byte mem[1];

    60

};

    61

    62

static SettingsMemoryPool *pool_new(uint minsize)

    63

{

    64

	SettingsMemoryPool *p;

    65

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

    66

    67

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

    68

	p->pos = 0;

    69

	p->size = minsize;

    70

	p->next = NULL;

    71

	return p;

    72

}

    73

    74

static void pool_init(SettingsMemoryPool **pool)

    75

{

    76

	*pool = pool_new(0);

    77

}

    78

    79

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

    80

{

    81

	uint pos;

    82

	SettingsMemoryPool *p = *pool;

    83

    84

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

    85

    86

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

    87

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

    88

		p = p->next;

    89

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

    90

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

    91

		SettingsMemoryPool *n = pool_new(size);

    92

		*pool = n;

    93

		n->next = p;

    94

		p = n;

    95

	}

    96

    97

	pos = p->pos;

    98

	p->pos += size;

    99

	return p->mem + pos;

   100

}

   101

   102

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

   103

{

   104

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

   105

	p[size] = 0;

   106

	memcpy(p, mem, size);

   107

	return p;

   108

}

   109

   110

static void pool_free(SettingsMemoryPool **pool)

   111

{

   112

	SettingsMemoryPool *p = *pool, *n;

   113

	*pool = NULL;

   114

	while (p) {

   115

		n = p->next;

   116

		free(p);

   117

		p = n;

   118

	}

   119

}

   120

   121

// structs describing the ini format.

   122

struct IniItem {

   123

	char *name;

   124

	char *value;

   125

	char *comment;

   126

	IniItem *next;

   127

};

   128

   129

struct IniGroup {

   130

	char *name; // name of group

   131

	char *comment; //comment for group

   132

	IniItem *item, **last_item;

   133

	IniGroup *next;

   134

	IniFile *ini;

   135

	IniGroupType type; // type of group

   136

};

   137

   138

struct IniFile {

   139

	SettingsMemoryPool *pool;

   140

	IniGroup *group, **last_group;

   141

	char *comment; // last comment in file

   142

};

   143

   144

// allocate an inifile object

   145

static IniFile *ini_alloc(void)

   146

{

   147

	IniFile *ini;

   148

	SettingsMemoryPool *pool;

   149

	pool_init(&pool);

   150

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

   151

	ini->pool = pool;

   152

	ini->group = NULL;

   153

	ini->last_group = &ini->group;

   154

	ini->comment = NULL;

   155

	return ini;

   156

}

   157

   158

// allocate an ini group object

   159

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

   160

{

   161

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

   162

	grp->ini = ini;

   163

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

   164

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

   165

		grp->type = IGT_LIST;

   166

	} else {

   167

		grp->type = IGT_VARIABLES;

   168

	}

   169

	grp->next = NULL;

   170

	grp->item = NULL;

   171

	grp->comment = NULL;

   172

	grp->last_item = &grp->item;

   173

	*ini->last_group = grp;

   174

	ini->last_group = &grp->next;

   175

	return grp;

   176

}

   177

   178

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

   179

{

   180

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

   181

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

   182

	item->next = NULL;

   183

	item->comment = NULL;

   184

	item->value = NULL;

   185

	*group->last_item = item;

   186

	group->last_item = &item->next;

   187

	return item;

   188

}

   189

   190

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

   191

static IniFile *ini_load(const char *filename)

   192

{

   193

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

   194

	FILE *in;

   195

	IniFile *ini;

   196

	IniGroup *group = NULL;

   197

	IniItem *item;

   198

   199

	char *comment = NULL;

   200

	uint comment_size = 0;

   201

	uint comment_alloc = 0;

   202

   203

	ini = ini_alloc();

   204

   205

	in = fopen(filename, "r");

   206

	if (in == NULL) return ini;

   207

   208

	// for each line in the file

   209

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

   210

   211

		// trim whitespace from the left side

   212

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

   213

   214

		// trim whitespace from right side.

   215

		e = s + strlen(s);

   216

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

   217

		*e = '\0';

   218

   219

		// skip comments and empty lines

   220

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

   221

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

   222

			uint a = comment_alloc;

   223

			uint pos;

   224

			// add to comment

   225

			if (ns > a) {

   226

				a = max(a, 128);

   227

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

   228

				comment = realloc(comment, comment_alloc = a);

   229

			}

   230

			pos = comment_size;

   231

			comment_size += (e - s + 1);

   232

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

   233

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

   234

			continue;

   235

		}

   236

   237

		// it's a group?

   238

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

   239

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

   240

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

   241

			else

   242

				e--;

   243

			s++; // skip [

   244

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

   245

			if (comment_size) {

   246

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

   247

				comment_size = 0;

   248

			}

   249

		} else if (group) {

   250

			// find end of keyname

   251

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

   252

   253

			// it's an item in an existing group

   254

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

   255

			if (comment_size) {

   256

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

   257

				comment_size = 0;

   258

			}

   259

   260

			// find start of parameter

   261

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

   262

   263

   264

			// remove starting quotation marks

   265

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

   266

			// remove ending quotation marks

   267

			e = t + strlen(t);

   268

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

   269

			*e = '\0';

   270

   271

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

   272

		} else {

   273

			// it's an orphan item

   274

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

   275

		}

   276

	}

   277

   278

	if (comment_size > 0) {

   279

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

   280

		comment_size = 0;

   281

	}

   282

   283

	free(comment);

   284

	fclose(in);

   285

   286

	return ini;

   287

}

   288

   289

// lookup a group or make a new one

   290

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

   291

{

   292

	IniGroup *group;

   293

   294

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

   295

   296

	// does it exist already?

   297

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

   298

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

   299

			return group;

   300

   301

	// otherwise make a new one

   302

	group = ini_group_alloc(ini, name, len);

   303

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

   304

	return group;

   305

}

   306

   307

// lookup an item or make a new one

   308

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

   309

{

   310

	IniItem *item;

   311

	uint len = strlen(name);

   312

   313

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

   314

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

   315

   316

	if (!create) return NULL;

   317

   318

	// otherwise make a new one

   319

	return ini_item_alloc(group, name, len);

   320

}

   321

   322

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

   323

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

   324

{

   325

	FILE *f;

   326

	IniGroup *group;

   327

	IniItem *item;

   328

   329

	f = fopen(filename, "w");

   330

	if (f == NULL) return false;

   331

   332

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

   333

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

   334

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

   335

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

   336

			assert(item->value != NULL);

   337

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

   338

   339

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

   340

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

   341

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

   342

			} else

   343

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

   344

		}

   345

	}

   346

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

   347

   348

	fclose(f);

   349

	return true;

   350

}

   351

   352

static void ini_free(IniFile *ini)

   353

{

   354

	pool_free(&ini->pool);

   355

}

   356

   357

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

   358

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

   359

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

   360

 * @param onelen force calculation of the *one parameter

   361

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

   362

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

   363

{

   364

	const char *s;

   365

	int idx;

   366

   367

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

   368

   369

	// check if it's an integer

   370

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

   371

		return strtoul(one, NULL, 0);

   372

   373

	idx = 0;

   374

	for (;;) {

   375

		// find end of item

   376

		s = many;

   377

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

   378

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

   379

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

   380

		many = s + 1;

   381

		idx++;

   382

	}

   383

}

   384

   385

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

   386

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

   387

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

   388

 * of seperated by a whitespace\tab or | character

   389

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

   390

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

   391

{

   392

	const char *s;

   393

	int r;

   394

	uint32 res = 0;

   395

   396

	for (;;) {

   397

		// skip "whitespace"

   398

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

   399

		if (*str == 0) break;

   400

   401

		s = str;

   402

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

   403

   404

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

   405

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

   406

   407

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

   408

		if (*s == 0) break;

   409

		str = s + 1;

   410

	}

   411

	return res;

   412

}

   413

   414

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

   415

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

   416

 * comma or a space character

   417

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

   418

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

   419

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

   420

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

   421

{

   422

	int n = 0, v;

   423

	char *end;

   424

   425

	for (;;) {

   426

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

   427

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

   428

		p = end;

   429

		items[n++] = v;

   430

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

   431

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

   432

		p++;

   433

	}

   434

   435

	return n;

   436

}

   437

   438

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

   439

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

   440

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

   441

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

   442

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

   443

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

   444

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

   445

{

   446

	int items[64];

   447

	int i, nitems;

   448

   449

	if (str == NULL) {

   450

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

   451

		nitems = nelems;

   452

	} else {

   453

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

   454

		if (nitems != nelems) return false;

   455

	}

   456

   457

	switch (type) {

   458

	case SLE_VAR_BL:

   459

	case SLE_VAR_I8:

   460

	case SLE_VAR_U8:

   461

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

   462

		break;

   463

	case SLE_VAR_I16:

   464

	case SLE_VAR_U16:

   465

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

   466

		break;

   467

	case SLE_VAR_I32:

   468

	case SLE_VAR_U32:

   469

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

   470

		break;

   471

	default: NOT_REACHED();

   472

	}

   473

   474

	return true;

   475

}

   476

   477

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

   478

 * is seperated by a comma or a space character

   479

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

   480

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

   481

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

   482

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

   483

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

   484

{

   485

	int i, v = 0;

   486

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

   487

   488

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

   489

		switch (type) {

   490

		case SLE_VAR_BL:

   491

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

   492

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

   493

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

   494

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

   495

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

   496

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

   497

		default: NOT_REACHED();

   498

		}

   499

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

   500

	}

   501

}

   502

   503

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

   504

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

   505

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

   506

 * @param id the value of the variable and whose string-representation must be found */

   507

static void make_oneofmany(char *buf, const char *many, int id)