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

#include "helpers.hpp"

    44

#include "news.h"

    45

#ifdef WITH_FREETYPE

    46

#include "gfx.h"

    47

#include "fontcache.h"

    48

#endif

    49

    50

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

    51

Patches _patches_newgame;

    52

    53

struct IniFile;

    54

struct IniItem;

    55

struct IniGroup;

    56

struct SettingsMemoryPool;

    57

    58

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

    59

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

    60

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

    61

    62

static void pool_init(SettingsMemoryPool **pool);

    63

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

    64

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

    65

static void pool_free(SettingsMemoryPool **pool);

    66

static bool IsSignedVarMemType(VarType vt);

    67

    68

struct SettingsMemoryPool {

    69

	uint pos,size;

    70

	SettingsMemoryPool *next;

    71

	byte mem[1];

    72

};

    73

    74

static SettingsMemoryPool *pool_new(uint minsize)

    75

{

    76

	SettingsMemoryPool *p;

    77

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

    78

    79

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

    80

	p->pos = 0;

    81

	p->size = minsize;

    82

	p->next = NULL;

    83

	return p;

    84

}

    85

    86

static void pool_init(SettingsMemoryPool **pool)

    87

{

    88

	*pool = pool_new(0);

    89

}

    90

    91

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

    92

{

    93

	uint pos;

    94

	SettingsMemoryPool *p = *pool;

    95

    96

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

    97

    98

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

    99

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

   100

		p = p->next;

   101

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

   102

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

   103

		SettingsMemoryPool *n = pool_new(size);

   104

		*pool = n;

   105

		n->next = p;

   106

		p = n;

   107

	}

   108

   109

	pos = p->pos;

   110

	p->pos += size;

   111

	return p->mem + pos;

   112

}

   113

   114

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

   115

{

   116

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

   117

	p[size] = 0;

   118

	memcpy(p, mem, size);

   119

	return p;

   120

}

   121

   122

static void pool_free(SettingsMemoryPool **pool)

   123

{

   124

	SettingsMemoryPool *p = *pool, *n;

   125

	*pool = NULL;

   126

	while (p) {

   127

		n = p->next;

   128

		free(p);

   129

		p = n;

   130

	}

   131

}

   132

   133

// structs describing the ini format.

   134

struct IniItem {

   135

	char *name;

   136

	char *value;

   137

	char *comment;

   138

	IniItem *next;

   139

};

   140

   141

struct IniGroup {

   142

	char *name; // name of group

   143

	char *comment; //comment for group

   144

	IniItem *item, **last_item;

   145

	IniGroup *next;

   146

	IniFile *ini;

   147

	IniGroupType type; // type of group

   148

};

   149

   150

struct IniFile {

   151

	SettingsMemoryPool *pool;

   152

	IniGroup *group, **last_group;

   153

	char *comment; // last comment in file

   154

};

   155

   156

// allocate an inifile object

   157

static IniFile *ini_alloc()

   158

{

   159

	IniFile *ini;

   160

	SettingsMemoryPool *pool;

   161

	pool_init(&pool);

   162

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

   163

	ini->pool = pool;

   164

	ini->group = NULL;

   165

	ini->last_group = &ini->group;

   166

	ini->comment = NULL;

   167

	return ini;

   168

}

   169

   170

// allocate an ini group object

   171

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

   172

{

   173

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

   174

	grp->ini = ini;

   175

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

   176

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

   177

		grp->type = IGT_LIST;

   178

	} else {

   179

		grp->type = IGT_VARIABLES;

   180

	}

   181

	grp->next = NULL;

   182

	grp->item = NULL;

   183

	grp->comment = NULL;

   184

	grp->last_item = &grp->item;

   185

	*ini->last_group = grp;

   186

	ini->last_group = &grp->next;

   187

	return grp;

   188

}

   189

   190

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

   191

{

   192

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

   193

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

   194

	item->next = NULL;

   195

	item->comment = NULL;

   196

	item->value = NULL;

   197

	*group->last_item = item;

   198

	group->last_item = &item->next;

   199

	return item;

   200

}

   201

   202

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

   203

static IniFile *ini_load(const char *filename)

   204

{

   205

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

   206

	FILE *in;

   207

	IniFile *ini;

   208

	IniGroup *group = NULL;

   209

	IniItem *item;

   210

   211

	char *comment = NULL;

   212

	uint comment_size = 0;

   213

	uint comment_alloc = 0;

   214

   215

	ini = ini_alloc();

   216

   217

	in = fopen(filename, "r");

   218

	if (in == NULL) return ini;

   219

   220

	// for each line in the file

   221

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

   222

   223

		// trim whitespace from the left side

   224

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

   225

   226

		// trim whitespace from right side.

   227

		e = s + strlen(s);

   228

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

   229

		*e = '\0';

   230

   231

		// skip comments and empty lines

   232

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

   233

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

   234

			uint a = comment_alloc;

   235

			uint pos;

   236

			// add to comment

   237

			if (ns > a) {

   238

				a = max(a, 128U);

   239

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

   240

				comment = ReallocT(comment, comment_alloc = a);

   241

			}

   242

			pos = comment_size;

   243

			comment_size += (e - s + 1);

   244

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

   245

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

   246

			continue;

   247

		}

   248

   249

		// it's a group?

   250

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

   251

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

   252

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

   253

			} else {

   254

				e--;

   255

			}

   256

			s++; // skip [

   257

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

   258

			if (comment_size) {

   259

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

   260

				comment_size = 0;

   261

			}

   262

		} else if (group) {

   263

			// find end of keyname

   264

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

   265

   266

			// it's an item in an existing group

   267

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

   268

			if (comment_size) {

   269

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

   270

				comment_size = 0;

   271

			}

   272

   273

			// find start of parameter

   274

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

   275

   276

   277

			// remove starting quotation marks

   278

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

   279

			// remove ending quotation marks

   280

			e = t + strlen(t);

   281

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

   282

			*e = '\0';

   283

   284

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

   285

		} else {

   286

			// it's an orphan item

   287

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

   288

		}

   289

	}

   290

   291

	if (comment_size > 0) {

   292

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

   293

		comment_size = 0;

   294

	}

   295

   296

	free(comment);

   297

	fclose(in);

   298

   299

	return ini;

   300

}

   301

   302

// lookup a group or make a new one

   303

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

   304

{

   305

	IniGroup *group;

   306

   307

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

   308

   309

	// does it exist already?

   310

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

   311

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

   312

			return group;

   313

   314

	// otherwise make a new one

   315

	group = ini_group_alloc(ini, name, len);

   316

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

   317

	return group;

   318

}

   319

   320

// lookup an item or make a new one

   321

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

   322

{

   323

	IniItem *item;

   324

	uint len = strlen(name);

   325

   326

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

   327

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

   328

   329

	if (!create) return NULL;

   330

   331

	// otherwise make a new one

   332

	return ini_item_alloc(group, name, len);

   333

}

   334

   335

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

   336

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

   337

{

   338

	FILE *f;

   339

	IniGroup *group;

   340

	IniItem *item;

   341

   342

	f = fopen(filename, "w");

   343

	if (f == NULL) return false;

   344

   345

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

   346

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

   347

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

   348

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

   349

			assert(item->value != NULL);

   350

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

   351

   352

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

   353

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

   354

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

   355

			} else {

   356

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

   357

			}

   358

		}

   359

	}

   360

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

   361

   362

	fclose(f);

   363

	return true;

   364

}

   365

   366

static void ini_free(IniFile *ini)

   367

{

   368

	pool_free(&ini->pool);

   369

}

   370

   371

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

   372

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

   373

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

   374

 * @param onelen force calculation of the *one parameter

   375

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

   376

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

   377

{

   378

	const char *s;

   379

	int idx;

   380

   381

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

   382

   383

	// check if it's an integer

   384

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

   385

		return strtoul(one, NULL, 0);

   386

   387

	idx = 0;

   388

	for (;;) {

   389

		// find end of item

   390

		s = many;

   391

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

   392

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

   393

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

   394

		many = s + 1;

   395

		idx++;

   396

	}

   397

}

   398

   399

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

   400

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

   401

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

   402

 * of seperated by a whitespace\tab or | character

   403

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

   404

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

   405

{

   406

	const char *s;

   407

	int r;

   408

	uint32 res = 0;

   409

   410

	for (;;) {

   411

		// skip "whitespace"

   412

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

   413

		if (*str == 0) break;

   414

   415

		s = str;

   416

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

   417

   418

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

   419

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

   420

   421

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

   422

		if (*s == 0) break;

   423

		str = s + 1;

   424

	}

   425

	return res;

   426

}

   427

   428

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

   429

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

   430

 * comma or a space character

   431

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

   432

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

   433

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

   434

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

   435

{

   436

	int n = 0, v;

   437

	char *end;

   438

   439

	for (;;) {

   440

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

   441

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

   442

		p = end;

   443

		items[n++] = v;

   444

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

   445

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

   446

		p++;

   447

	}

   448

   449

	return n;

   450

}

   451

   452

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

   453

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

   454

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

   455

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

   456

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

   457

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

   458

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

   459

{

   460

	int items[64];

   461

	int i, nitems;

   462

   463

	if (str == NULL) {

   464

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

   465

		nitems = nelems;

   466

	} else {

   467

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

   468

		if (nitems != nelems) return false;

   469

	}

   470

   471

	switch (type) {

   472

	case SLE_VAR_BL:

   473

	case SLE_VAR_I8:

   474

	case SLE_VAR_U8:

   475

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

   476

		break;

   477

	case SLE_VAR_I16:

   478

	case SLE_VAR_U16:

   479

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

   480

		break;

   481

	case SLE_VAR_I32:

   482

	case SLE_VAR_U32:

   483

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

   484

		break;

   485

	default: NOT_REACHED();

   486

	}

   487

   488

	return true;

   489

}

   490

   491

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

   492

 * is seperated by a comma or a space character

   493

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

   494

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

   495

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

   496

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

   497

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

   498

{

   499

	int i, v = 0;

   500

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

   501

   502

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

   503

		switch (type) {