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"

    32

#include "settings_internal.h"

    33

#include "command_func.h"

    34

#include "console_func.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 "rail.h"

    42

#include "train.h"

    43

#include "news_func.h"

    44

#include "window_func.h"

    45

#include "strings_func.h"

    46

#include "vehicle_func.h"

    47

#include "sound_func.h"

    48

#include "core/alloc_func.hpp"

    49

#include "player_func.h"

    50

#include "rev.h"

    51

#ifdef WITH_FREETYPE

    52

#include "fontcache.h"

    53

#endif

    54

#include "spritecache.h"

    55

#include "transparency.h"

    56

#include "textbuf_gui.h"

    57

#include "string_func.h"

    58

#include "rail_gui.h"

    59

#include "elrail_func.h"

    60

#include "gui.h"

    61

#include "town.h"

    62

#include "video/video_driver.hpp"

    63

#include "sound/sound_driver.hpp"

    64

#include "music/music_driver.hpp"

    65

#include "blitter/factory.hpp"

    66

#include "station_func.h"

    67

    68

#include "table/strings.h"

    69

    70

ClientSettings _settings_client;

    71

GameSettings _settings_game;

    72

GameSettings _settings_newgame;

    73

    74

struct IniFile;

    75

struct IniItem;

    76

struct IniGroup;

    77

struct SettingsMemoryPool;

    78

    79

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

    80

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

    81

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

    82

    83

static void pool_init(SettingsMemoryPool **pool);

    84

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

    85

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

    86

static void pool_free(SettingsMemoryPool **pool);

    87

static bool IsSignedVarMemType(VarType vt);

    88

    89

struct SettingsMemoryPool {

    90

	size_t pos, size;

    91

	SettingsMemoryPool *next;

    92

	byte mem[1];

    93

};

    94

    95

static SettingsMemoryPool *pool_new(size_t minsize)

    96

{

    97

	SettingsMemoryPool *p;

    98

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

    99

   100

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

   101

	p->pos = 0;

   102

	p->size = minsize;

   103

	p->next = NULL;

   104

	return p;

   105

}

   106

   107

static void pool_init(SettingsMemoryPool **pool)

   108

{

   109

	*pool = pool_new(0);

   110

}

   111

   112

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

   113

{

   114

	size_t pos;

   115

	SettingsMemoryPool *p = *pool;

   116

   117

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

   118

   119

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

   120

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

   121

		p = p->next;

   122

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

   123

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

   124

		SettingsMemoryPool *n = pool_new(size);

   125

		*pool = n;

   126

		n->next = p;

   127

		p = n;

   128

	}

   129

   130

	pos = p->pos;

   131

	p->pos += size;

   132

	return p->mem + pos;

   133

}

   134

   135

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

   136

{

   137

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

   138

	p[size] = 0;

   139

	memcpy(p, mem, size);

   140

	return p;

   141

}

   142

   143

static void pool_free(SettingsMemoryPool **pool)

   144

{

   145

	SettingsMemoryPool *p = *pool, *n;

   146

	*pool = NULL;

   147

	while (p) {

   148

		n = p->next;

   149

		free(p);

   150

		p = n;

   151

	}

   152

}

   153

   154

/** structs describing the ini format. */

   155

struct IniItem {

   156

	char *name;

   157

	char *value;

   158

	char *comment;

   159

	IniItem *next;

   160

};

   161

   162

struct IniGroup {

   163

	char *name;        ///< name of group

   164

	char *comment;     ///<comment for group

   165

	IniItem *item, **last_item;

   166

	IniGroup *next;

   167

	IniFile *ini;

   168

	IniGroupType type; ///< type of group

   169

};

   170

   171

struct IniFile {

   172

	SettingsMemoryPool *pool;

   173

	IniGroup *group, **last_group;

   174

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

   175

};

   176

   177

/** allocate an inifile object */

   178

static IniFile *ini_alloc()

   179

{

   180

	IniFile *ini;

   181

	SettingsMemoryPool *pool;

   182

	pool_init(&pool);

   183

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

   184

	ini->pool = pool;

   185

	ini->group = NULL;

   186

	ini->last_group = &ini->group;

   187

	ini->comment = NULL;

   188

	return ini;

   189

}

   190

   191

/** allocate an ini group object */

   192

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

   193

{

   194

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

   195

	grp->ini = ini;

   196

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

   197

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

   198

		grp->type = IGT_LIST;

   199

	} else {

   200

		grp->type = IGT_VARIABLES;

   201

	}

   202

	grp->next = NULL;

   203

	grp->item = NULL;

   204

	grp->comment = NULL;

   205

	grp->last_item = &grp->item;

   206

	*ini->last_group = grp;

   207

	ini->last_group = &grp->next;

   208

	return grp;

   209

}

   210

   211

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

   212

{

   213

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

   214

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

   215

	item->next = NULL;

   216

	item->comment = NULL;

   217

	item->value = NULL;

   218

	*group->last_item = item;

   219

	group->last_item = &item->next;

   220

	return item;

   221

}

   222

   223

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

   224

static IniFile *ini_load(const char *filename)

   225

{

   226

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

   227

	FILE *in;

   228

	IniFile *ini;

   229

	IniGroup *group = NULL;

   230

	IniItem *item;

   231

   232

	char *comment = NULL;

   233

	uint comment_size = 0;

   234

	uint comment_alloc = 0;

   235

   236

	ini = ini_alloc();

   237

   238

	in = fopen(filename, "r");

   239

	if (in == NULL) return ini;

   240

   241

	/* for each line in the file */

   242

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

   243

   244

		/* trim whitespace from the left side */

   245

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

   246

   247

		/* trim whitespace from right side. */

   248

		e = s + strlen(s);

   249

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

   250

		*e = '\0';

   251

   252

		/* skip comments and empty lines */

   253

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

   254

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

   255

			uint a = comment_alloc;

   256

			uint pos;

   257

			/* add to comment */

   258

			if (ns > a) {

   259

				a = max(a, 128U);

   260

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

   261

				comment = ReallocT(comment, comment_alloc = a);

   262

			}

   263

			pos = comment_size;

   264

			comment_size += (e - s + 1);

   265

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

   266

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

   267

			continue;

   268

		}

   269

   270

		/* it's a group? */

   271

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

   272

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

   273

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

   274

			} else {

   275

				e--;

   276

			}

   277

			s++; // skip [

   278

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

   279

			if (comment_size) {

   280

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

   281

				comment_size = 0;

   282

			}

   283

		} else if (group) {

   284

			/* find end of keyname */

   285

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

   286

				s++;

   287

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

   288

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

   289

			} else {

   290

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

   291

			}

   292

   293

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

   294

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

   295

			if (comment_size) {

   296

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

   297

				comment_size = 0;

   298

			}

   299

   300

			/* find start of parameter */

   301

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

   302

   303

   304

			/* remove starting quotation marks */

   305

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

   306

			/* remove ending quotation marks */

   307

			e = t + strlen(t);

   308

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

   309

			*e = '\0';

   310

   311

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

   312

		} else {

   313

			/* it's an orphan item */

   314

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

   315

		}

   316

	}

   317

   318

	if (comment_size > 0) {

   319

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

   320

		comment_size = 0;

   321

	}

   322

   323

	free(comment);

   324

	fclose(in);

   325

   326

	return ini;

   327

}

   328

   329

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

   330

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

   331

{

   332

	IniGroup *group;

   333

   334

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

   335

   336

	/* does it exist already? */

   337

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

   338

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

   339

			return group;

   340

		}

   341

	}

   342

   343

	/* otherwise make a new one */

   344

	group = ini_group_alloc(ini, name, len);

   345

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

   346

	return group;

   347

}

   348

   349

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

   350

{

   351

	size_t len = strlen(name);

   352

	IniGroup *prev = NULL;

   353

	IniGroup *group;

   354

   355

	/* does it exist already? */

   356

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

   357

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

   358

			break;

   359

		}

   360

	}

   361

   362

	if (group == NULL) return;

   363

   364

	if (prev != NULL) {

   365

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

   366

	} else {

   367

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

   368

	}

   369

}

   370

   371

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

   372

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

   373

{

   374

	IniItem *item;

   375

	size_t len = strlen(name);

   376

   377

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

   378

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

   379

	}

   380

   381

	if (!create) return NULL;

   382

   383

	/* otherwise make a new one */

   384

	return ini_item_alloc(group, name, len);

   385

}

   386

   387

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

   388

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

   389

{

   390

	FILE *f;

   391

	IniGroup *group;

   392

	IniItem *item;

   393

   394

	f = fopen(filename, "w");

   395

	if (f == NULL) return false;

   396

   397

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

   398

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

   399

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

   400

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

   401

			assert(item->value != NULL);

   402

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

   403

   404

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

   405

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

   406

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

   407

			} else {

   408

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

   409

			}

   410

   411

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

   412

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

   413

				fprintf(f, "\n");

   414

			} else {

   415

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

   416

			}

   417

		}

   418

	}

   419

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

   420

   421

	fclose(f);

   422

	return true;

   423

}

   424

   425

static void ini_free(IniFile *ini)

   426

{

   427

	pool_free(&ini->pool);

   428

}

   429

   430

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

   431

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

   432

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

   433

 * @param onelen force calculation of the *one parameter

   434

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

   435

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

   436

{

   437

	const char *s;

   438

	int idx;

   439

   440

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

   441

   442

	/* check if it's an integer */

   443

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

   444

		return strtoul(one, NULL, 0);

   445

   446

	idx = 0;

   447

	for (;;) {

   448

		/* find end of item */

   449

		s = many;

   450

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

   451

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

   452

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

   453

		many = s + 1;

   454

		idx++;

   455

	}

   456

}

   457

   458

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

   459

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

   460

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

   461

 * of seperated by a whitespace,tab or | character

   462

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

   463

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

   464

{

   465

	const char *s;

   466

	int r;

   467

	uint32 res = 0;

   468

   469

	for (;;) {

   470

		/* skip "whitespace" */

   471

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

   472

		if (*str == 0) break;

   473

   474

		s = str;

   475

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

   476

   477

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

   478

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

   479

   480

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

   481

		if (*s == 0) break;

   482

		str = s + 1;

   483

	}

   484

	return res;

   485

}

   486

   487

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

   488

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

   489

 * comma or a space character

   490

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

   491

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

   492

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

   493

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

   494

{

   495

	int n = 0, v;

   496