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

    27

#include "network/network.h"

    28

#include "network/network_internal.h"

    29

#include "settings_internal.h"

    30

#include "command_func.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_func.h"

    41

#include "window_func.h"

    42

#include "strings_func.h"

    43

#include "vehicle_func.h"

    44

#include "sound_func.h"

    45

#include "core/alloc_func.hpp"

    46

#include "player_func.h"

    47

#include "rev.h"

    48

#ifdef WITH_FREETYPE

    49

#include "fontcache.h"

    50

#endif

    51

#include "spritecache.h"

    52

#include "transparency.h"

    53

#include "textbuf_gui.h"

    54

#include "string_func.h"

    55

#include "rail_gui.h"

    56

#include "elrail_func.h"

    57

#include "gui.h"

    58

#include "town.h"

    59

#include "video/video_driver.hpp"

    60

#include "sound/sound_driver.hpp"

    61

#include "music/music_driver.hpp"

    62

#include "blitter/factory.hpp"

    64

    65

#include "table/strings.h"

    66

    69

    70

struct IniFile;

    71

struct IniItem;

    72

struct IniGroup;

    73

struct SettingsMemoryPool;

    74

    75

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

    76

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

    77

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

    78

    79

static void pool_init(SettingsMemoryPool **pool);

    80

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

    81

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

    82

static void pool_free(SettingsMemoryPool **pool);

    83

static bool IsSignedVarMemType(VarType vt);

    84

    85

struct SettingsMemoryPool {

    86

	size_t pos, size;

    87

	SettingsMemoryPool *next;

    88

	byte mem[1];

    89

};

    90

    91

static SettingsMemoryPool *pool_new(size_t minsize)

    92

{

    93

	SettingsMemoryPool *p;

    94

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

    95

    96

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

    97

	p->pos = 0;

    98

	p->size = minsize;

    99

	p->next = NULL;

   100

	return p;

   101

}

   102

   103

static void pool_init(SettingsMemoryPool **pool)

   104

{

   105

	*pool = pool_new(0);

   106

}

   107

   108

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

   109

{

   110

	size_t pos;

   111

	SettingsMemoryPool *p = *pool;

   112

   113

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

   114

   115

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

   116

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

   117

		p = p->next;

   118

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

   119

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

   120

		SettingsMemoryPool *n = pool_new(size);

   121

		*pool = n;

   122

		n->next = p;

   123

		p = n;

   124

	}

   125

   126

	pos = p->pos;

   127

	p->pos += size;

   128

	return p->mem + pos;

   129

}

   130

   131

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

   132

{

   133

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

   134

	p[size] = 0;

   135

	memcpy(p, mem, size);

   136

	return p;

   137

}

   138

   139

static void pool_free(SettingsMemoryPool **pool)

   140

{

   141

	SettingsMemoryPool *p = *pool, *n;

   142

	*pool = NULL;

   143

	while (p) {

   144

		n = p->next;

   145

		free(p);

   146

		p = n;

   147

	}

   148

}

   149

   150

/** structs describing the ini format. */

   151

struct IniItem {

   152

	char *name;

   153

	char *value;

   154

	char *comment;

   155

	IniItem *next;

   156

};

   157

   158

struct IniGroup {

   159

	char *name;        ///< name of group

   160

	char *comment;     ///<comment for group

   161

	IniItem *item, **last_item;

   162

	IniGroup *next;

   163

	IniFile *ini;

   164

	IniGroupType type; ///< type of group

   165

};

   166

   167

struct IniFile {

   168

	SettingsMemoryPool *pool;

   169

	IniGroup *group, **last_group;

   170

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

   171

};

   172

   173

/** allocate an inifile object */

   174

static IniFile *ini_alloc()

   175

{

   176

	IniFile *ini;

   177

	SettingsMemoryPool *pool;

   178

	pool_init(&pool);

   179

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

   180

	ini->pool = pool;

   181

	ini->group = NULL;

   182

	ini->last_group = &ini->group;

   183

	ini->comment = NULL;

   184

	return ini;

   185

}

   186

   187

/** allocate an ini group object */

   188

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

   189

{

   190

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

   191

	grp->ini = ini;

   192

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

   193

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

   194

		grp->type = IGT_LIST;

   195

	} else {

   196

		grp->type = IGT_VARIABLES;

   197

	}

   198

	grp->next = NULL;

   199

	grp->item = NULL;

   200

	grp->comment = NULL;

   201

	grp->last_item = &grp->item;

   202

	*ini->last_group = grp;

   203

	ini->last_group = &grp->next;

   204

	return grp;

   205

}

   206

   207

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

   208

{

   209

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

   210

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

   211

	item->next = NULL;

   212

	item->comment = NULL;

   213

	item->value = NULL;

   214

	*group->last_item = item;

   215

	group->last_item = &item->next;

   216

	return item;

   217

}

   218

   219

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

   220

static IniFile *ini_load(const char *filename)

   221

{

   222

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

   223

	FILE *in;

   224

	IniFile *ini;

   225

	IniGroup *group = NULL;

   226

	IniItem *item;

   227

   228

	char *comment = NULL;

   229

	uint comment_size = 0;

   230

	uint comment_alloc = 0;

   231

   232

	ini = ini_alloc();

   233

   234

	in = fopen(filename, "r");

   235

	if (in == NULL) return ini;

   236

   237

	/* for each line in the file */

   238

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

   239

   240

		/* trim whitespace from the left side */

   241

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

   242

   243

		/* trim whitespace from right side. */

   244

		e = s + strlen(s);

   245

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

   246

		*e = '\0';

   247

   248

		/* skip comments and empty lines */

   249

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

   250

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

   251

			uint a = comment_alloc;

   252

			uint pos;

   253

			/* add to comment */

   254

			if (ns > a) {

   255

				a = max(a, 128U);

   256

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

   257

				comment = ReallocT(comment, comment_alloc = a);

   258

			}

   259

			pos = comment_size;

   260

			comment_size += (e - s + 1);

   261

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

   262

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

   263

			continue;

   264

		}

   265

   266

		/* it's a group? */

   267

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

   268

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

   269

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

   270

			} else {

   271

				e--;

   272

			}

   273

			s++; // skip [

   274

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

   275

			if (comment_size) {

   276

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

   277

				comment_size = 0;

   278

			}

   279

		} else if (group) {

   280

			/* find end of keyname */

   281

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

   282

				s++;

   283

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

   284

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

   285

			} else {

   286

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

   287

			}

   288

   289

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

   290

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

   291

			if (comment_size) {

   292

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

   293

				comment_size = 0;

   294

			}

   295

   296

			/* find start of parameter */

   297

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

   298

   299

   300

			/* remove starting quotation marks */

   301

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

   302

			/* remove ending quotation marks */

   303

			e = t + strlen(t);

   304

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

   305

			*e = '\0';

   306

   307

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

   308

		} else {

   309

			/* it's an orphan item */

   310

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

   311

		}

   312

	}

   313

   314

	if (comment_size > 0) {

   315

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

   316

		comment_size = 0;

   317

	}

   318

   319

	free(comment);

   320

	fclose(in);

   321

   322

	return ini;

   323

}

   324

   325

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

   326

static IniGroup *ini_getgroup(IniFile *ini, const char *name, size_t len = 0)

   327

{

   328

	IniGroup *group;

   329

   330

	if (len == 0) len = strlen(name);

   331

   332

	/* does it exist already? */

   335

			return group;

   338

   339

	/* otherwise make a new one */

   340

	group = ini_group_alloc(ini, name, len);

   341

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

   342

	return group;

   343

}

   344

   367

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

   368

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

   369

{

   370

	IniItem *item;

   371

	size_t len = strlen(name);

   372

   374

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

   376

   377

	if (!create) return NULL;

   378

   379

	/* otherwise make a new one */

   380

	return ini_item_alloc(group, name, len);

   381

}

   382

   383

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

   384

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

   385

{

   386

	FILE *f;

   387

	IniGroup *group;

   388

	IniItem *item;

   389

   390

	f = fopen(filename, "w");

   391

	if (f == NULL) return false;

   392

   393

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

   394

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

   395

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

   396

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

   397

			assert(item->value != NULL);

   398

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

   399

   400

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

   401

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

   402

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

   403

			} else {

   404

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

   405

			}

   406

   407

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

   408

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

   409

				fprintf(f, "\n");

   410

			} else {

   411

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

   412

			}

   413

		}

   414

	}

   415

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

   416

   417

	fclose(f);

   418

	return true;

   419

}

   420

   421

static void ini_free(IniFile *ini)

   422

{

   423

	pool_free(&ini->pool);

   424

}

   425

   426

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

   427

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

   428

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

   429

 * @param onelen force calculation of the *one parameter

   430

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

   431

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

   432

{

   433

	const char *s;

   434

	int idx;

   435

   436

	if (onelen == 0) onelen = strlen(one);

   437

   438

	/* check if it's an integer */

   439

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

   440

		return strtoul(one, NULL, 0);

   441

   442

	idx = 0;

   443

	for (;;) {

   444

		/* find end of item */

   445

		s = many;

   446

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

   447

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

   448

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

   449

		many = s + 1;

   450

		idx++;

   451

	}

   452

}

   453

   454

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

   455

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

   456

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

   457

 * of seperated by a whitespace,tab or | character

   458

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

   459

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

   460

{

   461

	const char *s;

   462

	int r;

   463

	uint32 res = 0;

   464

   465

	for (;;) {

   466

		/* skip "whitespace" */

   467

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

   468

		if (*str == 0) break;

   469

   470

		s = str;

   471

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

   472

   473

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

   474

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

   475

   476

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

   477

		if (*s == 0) break;

   478

		str = s + 1;

   479

	}

   480

	return res;

   481

}

   482

   483

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

   484

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

   485

 * comma or a space character

   486

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

   487

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

   488

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

   489

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

   490

{

   491

	int n = 0, v;

   492

	char *end;

   493

   494

	for (;;) {

   495

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

   496

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