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

    40

    41

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

    42

Patches _patches_newgame;

    43

    44

typedef struct IniFile IniFile;

    45

typedef struct IniItem IniItem;

    46

typedef struct IniGroup IniGroup;

    47

typedef struct SettingsMemoryPool SettingsMemoryPool;

    48

    49

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

    50

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

    51

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

    52

    53

static void pool_init(SettingsMemoryPool **pool);

    54

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

    55

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

    56

static void pool_free(SettingsMemoryPool **pool);

    57

static bool IsSignedVarMemType(VarType vt);

    58

    59

struct SettingsMemoryPool {

    60

	uint pos,size;

    61

	SettingsMemoryPool *next;

    62

	byte mem[1];

    63

};

    64

    65

static SettingsMemoryPool *pool_new(uint minsize)

    66

{

    67

	SettingsMemoryPool *p;

    68

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

    69

    70

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

    71

	p->pos = 0;

    72

	p->size = minsize;

    73

	p->next = NULL;

    74

	return p;

    75

}

    76

    77

static void pool_init(SettingsMemoryPool **pool)

    78

{

    79

	*pool = pool_new(0);

    80

}

    81

    82

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

    83

{

    84

	uint pos;

    85

	SettingsMemoryPool *p = *pool;

    86

    87

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

    88

    89

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

    90

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

    91

		p = p->next;

    92

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

    93

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

    94

		SettingsMemoryPool *n = pool_new(size);

    95

		*pool = n;

    96

		n->next = p;

    97

		p = n;

    98

	}

    99

   100

	pos = p->pos;

   101

	p->pos += size;

   102

	return p->mem + pos;

   103

}

   104

   105

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

   106

{

   107

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

   108

	p[size] = 0;

   109

	memcpy(p, mem, size);

   110

	return p;

   111

}

   112

   113

static void pool_free(SettingsMemoryPool **pool)

   114

{

   115

	SettingsMemoryPool *p = *pool, *n;

   116

	*pool = NULL;

   117

	while (p) {

   118

		n = p->next;

   119

		free(p);

   120

		p = n;

   121

	}

   122

}

   123

   124

// structs describing the ini format.

   125

struct IniItem {

   126

	char *name;

   127

	char *value;

   128

	char *comment;

   129

	IniItem *next;

   130

};

   131

   132

struct IniGroup {

   133

	char *name; // name of group

   134

	char *comment; //comment for group

   135

	IniItem *item, **last_item;

   136

	IniGroup *next;

   137

	IniFile *ini;

   138

	IniGroupType type; // type of group

   139

};

   140

   141

struct IniFile {

   142

	SettingsMemoryPool *pool;

   143

	IniGroup *group, **last_group;

   144

	char *comment; // last comment in file

   145

};

   146

   147

// allocate an inifile object

   148

static IniFile *ini_alloc(void)

   149

{

   150

	IniFile *ini;

   151

	SettingsMemoryPool *pool;

   152

	pool_init(&pool);

   153

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

   154

	ini->pool = pool;

   155

	ini->group = NULL;

   156

	ini->last_group = &ini->group;

   157

	ini->comment = NULL;

   158

	return ini;

   159

}

   160

   161

// allocate an ini group object

   162

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

   163

{

   164

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

   165

	grp->ini = ini;

   166

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

   167

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

   168

		grp->type = IGT_LIST;

   169

	} else {

   170

		grp->type = IGT_VARIABLES;

   171

	}

   172

	grp->next = NULL;

   173

	grp->item = NULL;

   174

	grp->comment = NULL;

   175

	grp->last_item = &grp->item;

   176

	*ini->last_group = grp;

   177

	ini->last_group = &grp->next;

   178

	return grp;

   179

}

   180

   181

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

   182

{

   183

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

   184

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

   185

	item->next = NULL;

   186

	item->comment = NULL;

   187

	item->value = NULL;

   188

	*group->last_item = item;

   189

	group->last_item = &item->next;

   190

	return item;

   191

}

   192

   193

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

   194

static IniFile *ini_load(const char *filename)

   195

{

   196

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

   197

	FILE *in;

   198

	IniFile *ini;

   199

	IniGroup *group = NULL;

   200

	IniItem *item;

   201

   202

	char *comment = NULL;

   203

	uint comment_size = 0;

   204

	uint comment_alloc = 0;

   205

   206

	ini = ini_alloc();

   207

   208

	in = fopen(filename, "r");

   209

	if (in == NULL) return ini;

   210

   211

	// for each line in the file

   212

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

   213

   214

		// trim whitespace from the left side

   215

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

   216

   217

		// trim whitespace from right side.

   218

		e = s + strlen(s);

   219

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

   220

		*e = '\0';

   221

   222

		// skip comments and empty lines

   223

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

   224

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

   225

			uint a = comment_alloc;

   226

			uint pos;

   227

			// add to comment

   228

			if (ns > a) {

   229

				a = max(a, 128);

   230

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

   231

				comment = realloc(comment, comment_alloc = a);

   232

			}

   233

			pos = comment_size;

   234

			comment_size += (e - s + 1);

   235

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

   236

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

   237

			continue;

   238

		}

   239

   240

		// it's a group?

   241

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

   242

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

   243

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

   244

			} else {

   245

				e--;

   246

			}

   247

			s++; // skip [

   248

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

   249

			if (comment_size) {

   250

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

   251

				comment_size = 0;

   252

			}

   253

		} else if (group) {

   254

			// find end of keyname

   255

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

   256

   257

			// it's an item in an existing group

   258

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

   259

			if (comment_size) {

   260

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

   261

				comment_size = 0;

   262

			}

   263

   264

			// find start of parameter

   265

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

   266

   267

   268

			// remove starting quotation marks

   269

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

   270

			// remove ending quotation marks

   271

			e = t + strlen(t);

   272

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

   273

			*e = '\0';

   274

   275

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

   276

		} else {

   277

			// it's an orphan item

   278

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

   279

		}

   280

	}

   281

   282

	if (comment_size > 0) {

   283

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

   284

		comment_size = 0;

   285

	}

   286

   287

	free(comment);

   288

	fclose(in);

   289

   290

	return ini;

   291

}

   292

   293

// lookup a group or make a new one

   294

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

   295

{

   296

	IniGroup *group;

   297

   298

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

   299

   300

	// does it exist already?

   301

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

   302

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

   303

			return group;

   304

   305

	// otherwise make a new one

   306

	group = ini_group_alloc(ini, name, len);

   307

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

   308

	return group;

   309

}

   310

   311

// lookup an item or make a new one

   312

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

   313

{

   314

	IniItem *item;

   315

	uint len = strlen(name);

   316

   317

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

   318

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

   319

   320

	if (!create) return NULL;

   321

   322

	// otherwise make a new one

   323

	return ini_item_alloc(group, name, len);

   324

}

   325

   326

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

   327

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

   328

{

   329

	FILE *f;

   330

	IniGroup *group;

   331

	IniItem *item;

   332

   333

	f = fopen(filename, "w");

   334

	if (f == NULL) return false;

   335

   336

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

   337

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

   338

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

   339

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

   340

			assert(item->value != NULL);

   341

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

   342

   343

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

   344

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

   345

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

   346

			} else {

   347

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

   348

			}

   349

		}

   350

	}

   351

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

   352

   353

	fclose(f);

   354

	return true;

   355

}

   356

   357

static void ini_free(IniFile *ini)

   358

{

   359

	pool_free(&ini->pool);

   360

}

   361

   362

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

   363

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

   364

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

   365

 * @param onelen force calculation of the *one parameter

   366

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

   367

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

   368

{

   369

	const char *s;

   370

	int idx;

   371

   372

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

   373

   374

	// check if it's an integer

   375

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

   376

		return strtoul(one, NULL, 0);

   377

   378

	idx = 0;

   379

	for (;;) {

   380

		// find end of item

   381

		s = many;

   382

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

   383

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

   384

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

   385

		many = s + 1;

   386

		idx++;

   387

	}

   388

}

   389

   390

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

   391

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

   392

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

   393

 * of seperated by a whitespace\tab or | character

   394

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

   395

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

   396

{

   397

	const char *s;

   398

	int r;

   399

	uint32 res = 0;

   400

   401

	for (;;) {

   402

		// skip "whitespace"

   403

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

   404

		if (*str == 0) break;

   405

   406

		s = str;

   407

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

   408

   409

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

   410

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

   411

   412

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

   413

		if (*s == 0) break;

   414

		str = s + 1;

   415

	}

   416

	return res;

   417

}

   418

   419

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

   420

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

   421

 * comma or a space character

   422

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

   423

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

   424

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

   425

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

   426

{

   427

	int n = 0, v;

   428

	char *end;

   429

   430

	for (;;) {

   431

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

   432

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

   433

		p = end;

   434

		items[n++] = v;

   435

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

   436

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

   437

		p++;

   438

	}

   439

   440

	return n;

   441

}

   442

   443

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

   444

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

   445

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

   446

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

   447

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

   448

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

   449

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

   450

{

   451

	int items[64];

   452

	int i, nitems;

   453

   454

	if (str == NULL) {

   455

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

   456

		nitems = nelems;

   457

	} else {

   458

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

   459

		if (nitems != nelems) return false;

   460

	}

   461

   462

	switch (type) {

   463

	case SLE_VAR_BL:

   464

	case SLE_VAR_I8:

   465

	case SLE_VAR_U8:

   466

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

   467

		break;

   468

	case SLE_VAR_I16:

   469

	case SLE_VAR_U16:

   470

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

   471

		break;

   472

	case SLE_VAR_I32:

   473

	case SLE_VAR_U32:

   474

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

   475

		break;

   476

	default: NOT_REACHED();

   477

	}

   478

   479

	return true;

   480

}

   481

   482

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

   483

 * is seperated by a comma or a space character

   484

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

   485

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

   486

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

   487

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

   488

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

   489

{

   490

	int i, v = 0;

   491

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

   492

   493

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

   494

		switch (type) {

   495

		case SLE_VAR_BL:

   496

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

   497

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

   498

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

   499

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

   500

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

   501

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

   502

		default: NOT_REACHED();

   503

		}

   504

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

   505

	}

   506

}

   507