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

    29

#include "settings_internal.h"

    30

#include "command_func.h"

    31

#include "console_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"

    63

#include "gamelog.h"

    64

#include "station_func.h"

    65

#include "settings_func.h"

    66

    67

#include "table/strings.h"

    68

    69

ClientSettings _settings_client;

    70

GameSettings _settings_game;

    71

GameSettings _settings_newgame;

    72

    73

struct IniFile;

    74

struct IniItem;

    75

struct IniGroup;

    76

struct SettingsMemoryPool;

    77

    78

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

    79

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

    80

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

    81

    82

static void pool_init(SettingsMemoryPool **pool);

    83

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

    84

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

    85

static void pool_free(SettingsMemoryPool **pool);

    86

static bool IsSignedVarMemType(VarType vt);

    87

    88

struct SettingsMemoryPool {

    89

	size_t pos, size;

    90

	SettingsMemoryPool *next;

    91

	byte mem[1];

    92

};

    93

    94

static SettingsMemoryPool *pool_new(size_t minsize)

    95

{

    96

	SettingsMemoryPool *p;

    97

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

    98

    99

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

   100

	p->pos = 0;

   101

	p->size = minsize;

   102

	p->next = NULL;

   103

	return p;

   104

}

   105

   106

static void pool_init(SettingsMemoryPool **pool)

   107

{

   108

	*pool = pool_new(0);

   109

}

   110

   111

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

   112

{

   113

	size_t pos;

   114

	SettingsMemoryPool *p = *pool;

   115

   116

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

   117

   118

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

   119

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

   120

		p = p->next;

   121

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

   122

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

   123

		SettingsMemoryPool *n = pool_new(size);

   124

		*pool = n;

   125

		n->next = p;

   126

		p = n;

   127

	}

   128

   129

	pos = p->pos;

   130

	p->pos += size;

   131

	return p->mem + pos;

   132

}

   133

   134

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

   135

{

   136

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

   137

	p[size] = 0;

   138

	memcpy(p, mem, size);

   139

	return p;

   140

}

   141

   142

static void pool_free(SettingsMemoryPool **pool)

   143

{

   144

	SettingsMemoryPool *p = *pool, *n;

   145

	*pool = NULL;

   146

	while (p) {

   147

		n = p->next;

   148

		free(p);

   149

		p = n;

   150

	}

   151

}

   152

   153

/** structs describing the ini format. */

   154

struct IniItem {

   155

	char *name;

   156

	char *value;

   157

	char *comment;

   158

	IniItem *next;

   159

};

   160

   161

struct IniGroup {

   162

	char *name;        ///< name of group

   163

	char *comment;     ///<comment for group

   164

	IniItem *item, **last_item;

   165

	IniGroup *next;

   166

	IniFile *ini;

   167

	IniGroupType type; ///< type of group

   168

};

   169

   170

struct IniFile {

   171

	SettingsMemoryPool *pool;

   172

	IniGroup *group, **last_group;

   173

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

   174

};

   175

   176

/** allocate an inifile object */

   177

static IniFile *ini_alloc()

   178

{

   179

	IniFile *ini;

   180

	SettingsMemoryPool *pool;

   181

	pool_init(&pool);

   182

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

   183

	ini->pool = pool;

   184

	ini->group = NULL;

   185

	ini->last_group = &ini->group;

   186

	ini->comment = NULL;

   187

	return ini;

   188

}

   189

   190

/** allocate an ini group object */

   191

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

   192

{

   193

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

   194

	grp->ini = ini;

   195

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

   196

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

   197

		grp->type = IGT_LIST;

   198

	} else {

   199

		grp->type = IGT_VARIABLES;

   200

	}

   201

	grp->next = NULL;

   202

	grp->item = NULL;

   203

	grp->comment = NULL;

   204

	grp->last_item = &grp->item;

   205

	*ini->last_group = grp;

   206

	ini->last_group = &grp->next;

   207

	return grp;

   208

}

   209

   210

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

   211

{

   212

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

   213

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

   214

	item->next = NULL;

   215

	item->comment = NULL;

   216

	item->value = NULL;

   217

	*group->last_item = item;

   218

	group->last_item = &item->next;

   219

	return item;

   220

}

   221

   222

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

   223

static IniFile *ini_load(const char *filename)

   224

{

   225

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

   226

	FILE *in;

   227

	IniFile *ini;

   228

	IniGroup *group = NULL;

   229

	IniItem *item;

   230

   231

	char *comment = NULL;

   232

	uint comment_size = 0;

   233

	uint comment_alloc = 0;

   234

   235

	ini = ini_alloc();

   236

   237

	in = fopen(filename, "r");

   238

	if (in == NULL) return ini;

   239

   240

	/* for each line in the file */

   241

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

   242

   243

		/* trim whitespace from the left side */

   244

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

   245

   246

		/* trim whitespace from right side. */

   247

		e = s + strlen(s);

   248

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

   249

		*e = '\0';

   250

   251

		/* skip comments and empty lines */

   252

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

   253

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

   254

			uint a = comment_alloc;

   255

			uint pos;

   256

			/* add to comment */

   257

			if (ns > a) {

   258

				a = max(a, 128U);

   259

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

   260

				comment = ReallocT(comment, comment_alloc = a);

   261

			}

   262

			pos = comment_size;

   263

			comment_size += (e - s + 1);

   264

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

   265

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

   266

			continue;

   267

		}

   268

   269

		/* it's a group? */

   270

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

   271

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

   272

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

   273

			} else {

   274

				e--;

   275

			}

   276

			s++; // skip [

   277

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

   278

			if (comment_size) {

   279

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

   280

				comment_size = 0;

   281

			}

   282

		} else if (group) {

   283

			/* find end of keyname */

   284

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

   285

				s++;

   286

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

   287

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

   288

			} else {

   289

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

   290

			}

   291

   292

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

   293

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

   294

			if (comment_size) {

   295

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

   296

				comment_size = 0;

   297

			}

   298

   299

			/* find start of parameter */

   300

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

   301

   302

   303

			/* remove starting quotation marks */

   304

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

   305

			/* remove ending quotation marks */

   306

			e = t + strlen(t);

   307

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

   308

			*e = '\0';

   309

   310

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

   311

		} else {

   312

			/* it's an orphan item */

   313

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

   314

		}

   315

	}

   316

   317

	if (comment_size > 0) {

   318

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

   319

		comment_size = 0;

   320

	}

   321

   322

	free(comment);

   323

	fclose(in);

   324

   325

	return ini;

   326

}

   327

   328

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

   329

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

   330

{

   331

	IniGroup *group;

   332

   333

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

   334

   335

	/* does it exist already? */

   336

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

   337

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

   338

			return group;

   339

		}

   340

	}

   341

   342

	/* otherwise make a new one */

   343

	group = ini_group_alloc(ini, name, len);

   344

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

   345

	return group;

   346

}

   347

   348

static void ini_removegroup(IniFile *ini, const char *name)

   349

{

   350

	size_t len = strlen(name);

   351

	IniGroup *prev = NULL;

   352

	IniGroup *group;

   353

   354

	/* does it exist already? */

   355

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

   356

		if (memcmp(group->name, name, len) == 0) {

   357

			break;

   358

		}

   359

	}

   360

   361

	if (group == NULL) return;

   362

   363

	if (prev != NULL) {

   364

		prev->next = prev->next->next;

   365

	} else {

   366

		ini->group = ini->group->next;

   367

	}

   368

}

   369

   370

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

   371

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

   372

{

   373

	IniItem *item;

   374

	size_t len = strlen(name);

   375

   376

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

   377

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

   378

	}

   379

   380

	if (!create) return NULL;

   381

   382

	/* otherwise make a new one */

   383

	return ini_item_alloc(group, name, len);

   384

}

   385

   386

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

   387

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

   388

{

   389

	FILE *f;

   390

	IniGroup *group;

   391

	IniItem *item;

   392

   393

	f = fopen(filename, "w");

   394

	if (f == NULL) return false;

   395

   396

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

   397

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

   398

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

   399

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

   400

			assert(item->value != NULL);

   401

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

   402

   403

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

   404

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

   405

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

   406

			} else {

   407

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

   408

			}

   409

   410

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

   411

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

   412

				fprintf(f, "\n");

   413

			} else {

   414

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

   415

			}

   416

		}

   417

	}

   418

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

   419

   420

	fclose(f);

   421

	return true;

   422

}

   423

   424

static void ini_free(IniFile *ini)

   425

{

   426

	pool_free(&ini->pool);

   427

}

   428

   429

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

   430

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

   431

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

   432

 * @param onelen force calculation of the *one parameter

   433

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

   434

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

   435

{

   436

	const char *s;

   437

	int idx;

   438

   439

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

   440

   441

	/* check if it's an integer */

   442

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

   443

		return strtoul(one, NULL, 0);

   444

   445

	idx = 0;

   446

	for (;;) {

   447

		/* find end of item */

   448

		s = many;

   449

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

   450

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

   451

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

   452

		many = s + 1;

   453

		idx++;

   454

	}

   455

}

   456

   457

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

   458

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

   459

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

   460

 * of seperated by a whitespace,tab or | character

   461

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

   462

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

   463

{

   464

	const char *s;

   465

	int r;

   466

	uint32 res = 0;

   467

   468

	for (;;) {

   469

		/* skip "whitespace" */

   470

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

   471

		if (*str == 0) break;

   472

   473

		s = str;

   474

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

   475

   476

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

   477

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

   478

   479

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

   480

		if (*s == 0) break;

   481

		str = s + 1;

   482

	}

   483

	return res;

   484

}

   485

   486

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

   487

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

   488

 * comma or a space character

   489

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

   490

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

   491

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

   492

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

   493

{

   494

	int n = 0, v;

   495

	char *end;

   496