1

/* $Id$ */

     2

     3

/** @file settings.cpp

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

    26

#include "string.h"

    27

#include "variables.h"

    28

#include "network/network.h"

    30

#include "command_func.h"

    31

#include "console.h"

    32

#include "saveload.h"

    33

#include "npf.h"

    34

#include "yapf/yapf.h"

    35

#include "newgrf.h"

    36

#include "newgrf_config.h"

    37

#include "genworld.h"

    38

#include "rail.h"

    39

#include "train.h"

    40

#include "news.h"

    41

#include "window_func.h"

    42

#include "strings_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

#ifdef WITH_FREETYPE

    46

#include "fontcache.h"

    47

#endif

    48

#include "spritecache.h"

    49

#include "transparency.h"

    50

    55

Patches _patches_newgame;

    56

    57

struct IniFile;

    58

struct IniItem;

    59

struct IniGroup;

    60

struct SettingsMemoryPool;

    61

    62

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

    63

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

    64

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

    65

    66

static void pool_init(SettingsMemoryPool **pool);

    67

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

    68

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

    69

static void pool_free(SettingsMemoryPool **pool);

    70

static bool IsSignedVarMemType(VarType vt);

    71

    72

struct SettingsMemoryPool {

    73

	uint pos,size;

    74

	SettingsMemoryPool *next;

    75

	byte mem[1];

    76

};

    77

    78

static SettingsMemoryPool *pool_new(uint minsize)

    79

{

    80

	SettingsMemoryPool *p;

    81

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

    82

    83

	p = (SettingsMemoryPool*)MallocT<byte>(sizeof(SettingsMemoryPool) - 1 + minsize);

    84

	p->pos = 0;

    85

	p->size = minsize;

    86

	p->next = NULL;

    87

	return p;

    88

}

    89

    90

static void pool_init(SettingsMemoryPool **pool)

    91

{

    92

	*pool = pool_new(0);

    93

}

    94

    95

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

    96

{

    97

	uint pos;

    98

	SettingsMemoryPool *p = *pool;

    99

   100

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

   101

   102

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

   103

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

   104

		p = p->next;

   105

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

   106

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

   107

		SettingsMemoryPool *n = pool_new(size);

   108

		*pool = n;

   109

		n->next = p;

   110

		p = n;

   111

	}

   112

   113

	pos = p->pos;

   114

	p->pos += size;

   115

	return p->mem + pos;

   116

}

   117

   118

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

   119

{

   120

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

   121

	p[size] = 0;

   122

	memcpy(p, mem, size);

   123

	return p;

   124

}

   125

   126

static void pool_free(SettingsMemoryPool **pool)

   127

{

   128

	SettingsMemoryPool *p = *pool, *n;

   129

	*pool = NULL;

   130

	while (p) {

   131

		n = p->next;

   132

		free(p);

   133

		p = n;

   134

	}

   135

}

   136

   137

/** structs describing the ini format. */

   138

struct IniItem {

   139

	char *name;

   140

	char *value;

   141

	char *comment;

   142

	IniItem *next;

   143

};

   144

   145

struct IniGroup {

   146

	char *name;        ///< name of group

   147

	char *comment;     ///<comment for group

   148

	IniItem *item, **last_item;

   149

	IniGroup *next;

   150

	IniFile *ini;

   151

	IniGroupType type; ///< type of group

   152

};

   153

   154

struct IniFile {

   155

	SettingsMemoryPool *pool;

   156

	IniGroup *group, **last_group;

   157

	char *comment;     ///< last comment in file

   158

};

   159

   160

/** allocate an inifile object */

   161

static IniFile *ini_alloc()

   162

{

   163

	IniFile *ini;

   164

	SettingsMemoryPool *pool;

   165

	pool_init(&pool);

   166

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

   167

	ini->pool = pool;

   168

	ini->group = NULL;

   169

	ini->last_group = &ini->group;

   170

	ini->comment = NULL;

   171

	return ini;

   172

}

   173

   174

/** allocate an ini group object */

   175

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

   176

{

   177

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

   178

	grp->ini = ini;

   179

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

   180

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

   181

		grp->type = IGT_LIST;

   182

	} else {

   183

		grp->type = IGT_VARIABLES;

   184

	}

   185

	grp->next = NULL;

   186

	grp->item = NULL;

   187

	grp->comment = NULL;

   188

	grp->last_item = &grp->item;

   189

	*ini->last_group = grp;

   190

	ini->last_group = &grp->next;

   191

	return grp;

   192

}

   193

   194

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

   195

{

   196

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

   197

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

   198

	item->next = NULL;

   199

	item->comment = NULL;

   200

	item->value = NULL;

   201

	*group->last_item = item;

   202

	group->last_item = &item->next;

   203

	return item;

   204

}

   205

   206

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

   207

static IniFile *ini_load(const char *filename)

   208

{

   209

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

   210

	FILE *in;

   211

	IniFile *ini;

   212

	IniGroup *group = NULL;

   213

	IniItem *item;

   214

   215

	char *comment = NULL;

   216

	uint comment_size = 0;

   217

	uint comment_alloc = 0;

   218

   219

	ini = ini_alloc();

   220

   221

	in = fopen(filename, "r");

   222

	if (in == NULL) return ini;

   223

   224

	/* for each line in the file */

   225

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

   226

   227

		/* trim whitespace from the left side */

   228

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

   229

   230

		/* trim whitespace from right side. */

   231

		e = s + strlen(s);

   232

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

   233

		*e = '\0';

   234

   235

		/* skip comments and empty lines */

   236

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

   237

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

   238

			uint a = comment_alloc;

   239

			uint pos;

   240

			/* add to comment */

   241

			if (ns > a) {

   242

				a = max(a, 128U);

   243

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

   244

				comment = ReallocT(comment, comment_alloc = a);

   245

			}

   246

			pos = comment_size;

   247

			comment_size += (e - s + 1);

   248

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

   249

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

   250

			continue;

   251

		}

   252

   253

		/* it's a group? */

   254

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

   255

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

   256

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

   257

			} else {

   258

				e--;

   259

			}

   260

			s++; // skip [

   261

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

   262

			if (comment_size) {

   263

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

   264

				comment_size = 0;

   265

			}

   266

		} else if (group) {

   267

			/* find end of keyname */

   268

			if (*s == '\"') {

   269

				s++;

   270

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

   271

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

   272

			} else {

   273

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

   274

			}

   275

   276

			/* it's an item in an existing group */

   277

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

   278

			if (comment_size) {

   279

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

   280

				comment_size = 0;

   281

			}

   282

   283

			/* find start of parameter */

   284

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

   285

   286

   287

			/* remove starting quotation marks */

   288

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

   289

			/* remove ending quotation marks */

   290

			e = t + strlen(t);

   291

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

   292

			*e = '\0';

   293

   294

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

   295

		} else {

   296

			/* it's an orphan item */

   297

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

   298

		}

   299

	}

   300

   301

	if (comment_size > 0) {

   302

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

   303

		comment_size = 0;

   304

	}

   305

   306

	free(comment);

   307

	fclose(in);

   308

   309

	return ini;

   310

}

   311

   312

/** lookup a group or make a new one */

   313

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

   314

{

   315

	IniGroup *group;

   316

   317

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

   318

   319

	/* does it exist already? */

   320

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

   321

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

   322

			return group;

   323

   324

	/* otherwise make a new one */

   325

	group = ini_group_alloc(ini, name, len);

   326

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

   327

	return group;

   328

}

   329

   330

/** lookup an item or make a new one */

   331

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

   332

{

   333

	IniItem *item;

   334

	uint len = strlen(name);

   335

   336

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

   337

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

   338

   339

	if (!create) return NULL;

   340

   341

	/* otherwise make a new one */

   342

	return ini_item_alloc(group, name, len);

   343

}

   344

   345

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

   346

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

   347

{

   348

	FILE *f;

   349

	IniGroup *group;

   350

	IniItem *item;

   351

   352

	f = fopen(filename, "w");

   353

	if (f == NULL) return false;

   354

   355

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

   356

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

   357

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

   358

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

   359

			assert(item->value != NULL);

   360

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

   361

   362

			/* protect item->name with quotes if needed */

   363

			if (strchr(item->name, ' ') != NULL) {

   364

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

   365

			} else {

   366

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

   367

			}

   368

   369

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

   370

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

   371

				fprintf(f, "\n");

   372

			} else {

   373

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

   374

			}

   375

		}

   376

	}

   377

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

   378

   379

	fclose(f);

   380

	return true;

   381

}

   382

   383

static void ini_free(IniFile *ini)

   384

{

   385

	pool_free(&ini->pool);

   386

}

   387

   388

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

   389

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

   390

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

   391

 * @param onelen force calculation of the *one parameter

   392

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

   393

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

   394

{

   395

	const char *s;

   396

	int idx;

   397

   398

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

   399

   400

	/* check if it's an integer */

   401

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

   402

		return strtoul(one, NULL, 0);

   403

   404

	idx = 0;

   405

	for (;;) {

   406

		/* find end of item */

   407

		s = many;

   408

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

   409

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

   410

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

   411

		many = s + 1;

   412

		idx++;

   413

	}

   414

}

   415

   416

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

   417

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

   418

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

   419

 * of seperated by a whitespace,tab or | character

   420

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

   421

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

   422

{

   423

	const char *s;

   424

	int r;

   425

	uint32 res = 0;

   426

   427

	for (;;) {

   428

		/* skip "whitespace" */

   429

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

   430

		if (*str == 0) break;

   431

   432

		s = str;

   433

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

   434

   435

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

   436

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

   437

   438

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

   439

		if (*s == 0) break;

   440

		str = s + 1;

   441

	}

   442

	return res;

   443

}

   444

   445

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

   446

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

   447

 * comma or a space character

   448

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

   449

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

   450

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

   451

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

   452

{

   453

	int n = 0, v;

   454

	char *end;

   455

   456

	for (;;) {

   457

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

   458

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

   459

		p = end;

   460

		items[n++] = v;

   461

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

   462

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

   463

		p++;

   464

	}

   465

   466

	return n;

   467

}

   468

   469

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

   470

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

   471

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

   472

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

   473

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

   474

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

   475

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

   476

{

   477

	int items[64];

   478

	int i, nitems;

   479

   480

	if (str == NULL) {

   481

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

   482

		nitems = nelems;

   483

	} else {

   484

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

   485

		if (nitems != nelems) return false;

   486

	}

   487

   488

	switch (type) {

   489

	case SLE_VAR_BL:

   490

	case SLE_VAR_I8:

   491

	case SLE_VAR_U8:

   492

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

   493

		break;

   494

	case SLE_VAR_I16:

   495

	case SLE_VAR_U16:

   496

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

   497

		break;

   498

	case SLE_VAR_I32:

   499