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"

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

#ifdef WITH_FREETYPE

    48

#include "fontcache.h"

    49

#endif

    50

#include "spritecache.h"

    51

#include "transparency.h"

    52

#include "textbuf_gui.h"

    53

#include "string_func.h"

    54

#include "gui.h"

    55

#include "town.h"

    56

#include "video/video_driver.hpp"

    57

#include "sound/sound_driver.hpp"

    58

#include "music/music_driver.hpp"

    59

#include "blitter/factory.hpp"

    60

    61

#include "table/strings.h"

    62

    63

GameOptions _opt;

    64

GameOptions _opt_newgame;

    65

GameOptions *_opt_ptr;

    66

Patches _patches;

    67

Patches _patches_newgame;

    68

    69

struct IniFile;

    70

struct IniItem;

    71

struct IniGroup;

    72

struct SettingsMemoryPool;

    73

    74

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

    75

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

    76

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

    77

    78

static void pool_init(SettingsMemoryPool **pool);

    79

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

    80

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

    81

static void pool_free(SettingsMemoryPool **pool);

    82

static bool IsSignedVarMemType(VarType vt);

    83

    84

struct SettingsMemoryPool {

    85

	uint pos,size;

    86

	SettingsMemoryPool *next;

    87

	byte mem[1];

    88

};

    89

    90

static SettingsMemoryPool *pool_new(uint minsize)

    91

{

    92

	SettingsMemoryPool *p;

    93

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

    94

    95

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

    96

	p->pos = 0;

    97

	p->size = minsize;

    98

	p->next = NULL;

    99

	return p;

   100

}

   101

   102

static void pool_init(SettingsMemoryPool **pool)

   103

{

   104

	*pool = pool_new(0);

   105

}

   106

   107

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

   108

{

   109

	uint pos;

   110

	SettingsMemoryPool *p = *pool;

   111

   112

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

   113

   114

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

   115

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

   116

		p = p->next;

   117

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

   118

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

   119

		SettingsMemoryPool *n = pool_new(size);

   120

		*pool = n;

   121

		n->next = p;

   122

		p = n;

   123

	}

   124

   125

	pos = p->pos;

   126

	p->pos += size;

   127

	return p->mem + pos;

   128

}

   129

   130

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

   131

{

   132

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

   133

	p[size] = 0;

   134

	memcpy(p, mem, size);

   135

	return p;

   136

}

   137

   138

static void pool_free(SettingsMemoryPool **pool)

   139

{

   140

	SettingsMemoryPool *p = *pool, *n;

   141

	*pool = NULL;

   142

	while (p) {

   143

		n = p->next;

   144

		free(p);

   145

		p = n;

   146

	}

   147

}

   148

   149

/** structs describing the ini format. */

   150

struct IniItem {

   151

	char *name;

   152

	char *value;

   153

	char *comment;

   154

	IniItem *next;

   155

};

   156

   157

struct IniGroup {

   158

	char *name;        ///< name of group

   159

	char *comment;     ///<comment for group

   160

	IniItem *item, **last_item;

   161

	IniGroup *next;

   162

	IniFile *ini;

   163

	IniGroupType type; ///< type of group

   164

};

   165

   166

struct IniFile {

   167

	SettingsMemoryPool *pool;

   168

	IniGroup *group, **last_group;

   169

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

   170

};

   171

   172

/** allocate an inifile object */

   173

static IniFile *ini_alloc()

   174

{

   175

	IniFile *ini;

   176

	SettingsMemoryPool *pool;

   177

	pool_init(&pool);

   178

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

   179

	ini->pool = pool;

   180

	ini->group = NULL;

   181

	ini->last_group = &ini->group;

   182

	ini->comment = NULL;

   183

	return ini;

   184

}

   185

   186

/** allocate an ini group object */

   187

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

   188

{

   189

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

   190

	grp->ini = ini;

   191

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

   192

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

   193

		grp->type = IGT_LIST;

   194

	} else {

   195

		grp->type = IGT_VARIABLES;

   196

	}

   197

	grp->next = NULL;

   198

	grp->item = NULL;

   199

	grp->comment = NULL;

   200

	grp->last_item = &grp->item;

   201

	*ini->last_group = grp;

   202

	ini->last_group = &grp->next;

   203

	return grp;

   204

}

   205

   206

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

   207

{

   208

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

   209

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

   210

	item->next = NULL;

   211

	item->comment = NULL;

   212

	item->value = NULL;

   213

	*group->last_item = item;

   214

	group->last_item = &item->next;

   215

	return item;

   216

}

   217

   218

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

   219

static IniFile *ini_load(const char *filename)

   220

{

   221

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

   222

	FILE *in;

   223

	IniFile *ini;

   224

	IniGroup *group = NULL;

   225

	IniItem *item;

   226

   227

	char *comment = NULL;

   228

	uint comment_size = 0;

   229

	uint comment_alloc = 0;

   230

   231

	ini = ini_alloc();

   232

   233

	in = fopen(filename, "r");

   234

	if (in == NULL) return ini;

   235

   236

	/* for each line in the file */

   237

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

   238

   239

		/* trim whitespace from the left side */

   240

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

   241

   242

		/* trim whitespace from right side. */

   243

		e = s + strlen(s);

   244

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

   245

		*e = '\0';

   246

   247

		/* skip comments and empty lines */

   248

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

   249

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

   250

			uint a = comment_alloc;

   251

			uint pos;

   252

			/* add to comment */

   253

			if (ns > a) {

   254

				a = max(a, 128U);

   255

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

   256

				comment = ReallocT(comment, comment_alloc = a);

   257

			}

   258

			pos = comment_size;

   259

			comment_size += (e - s + 1);

   260

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

   261

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

   262

			continue;

   263

		}

   264

   265

		/* it's a group? */

   266

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

   267

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

   268

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

   269

			} else {

   270

				e--;

   271

			}

   272

			s++; // skip [

   273

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

   274

			if (comment_size) {

   275

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

   276

				comment_size = 0;

   277

			}

   278

		} else if (group) {

   279

			/* find end of keyname */

   280

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

   281

				s++;

   282

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

   283

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

   284

			} else {

   285

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

   286

			}

   287

   288

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

   289

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

   290

			if (comment_size) {

   291

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

   292

				comment_size = 0;

   293

			}

   294

   295

			/* find start of parameter */

   296

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

   297

   298

   299

			/* remove starting quotation marks */

   300

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

   301

			/* remove ending quotation marks */

   302

			e = t + strlen(t);

   303

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

   304

			*e = '\0';

   305

   306

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

   307

		} else {

   308

			/* it's an orphan item */

   309

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

   310

		}

   311

	}

   312

   313

	if (comment_size > 0) {

   314

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

   315

		comment_size = 0;

   316

	}

   317

   318

	free(comment);

   319

	fclose(in);

   320

   321

	return ini;

   322

}

   323

   324

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

   325

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

   326

{

   327

	IniGroup *group;

   328

   329

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

   330

   331

	/* does it exist already? */

   332

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

   333

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

   334

			return group;

   335

   336

	/* otherwise make a new one */

   337

	group = ini_group_alloc(ini, name, len);

   338

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

   339

	return group;

   340

}

   341

   342

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

   343

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

   344

{

   345

	IniItem *item;

   346

	uint len = strlen(name);

   347

   348

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

   349

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

   350

   351

	if (!create) return NULL;

   352

   353

	/* otherwise make a new one */

   354

	return ini_item_alloc(group, name, len);

   355

}

   356

   357

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

   358

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

   359

{

   360

	FILE *f;

   361

	IniGroup *group;

   362

	IniItem *item;

   363

   364

	f = fopen(filename, "w");

   365

	if (f == NULL) return false;

   366

   367

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

   368

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

   369

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

   370

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

   371

			assert(item->value != NULL);

   372

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

   373

   374

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

   375

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

   376

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

   377

			} else {

   378

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

   379

			}

   380

   381

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

   382

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

   383

				fprintf(f, "\n");

   384

			} else {

   385

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

   386

			}

   387

		}

   388

	}

   389

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

   390

   391

	fclose(f);

   392

	return true;

   393

}

   394

   395

static void ini_free(IniFile *ini)

   396

{

   397

	pool_free(&ini->pool);

   398

}

   399

   400

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

   401

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

   402

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

   403

 * @param onelen force calculation of the *one parameter

   404

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

   405

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

   406

{

   407

	const char *s;

   408

	int idx;

   409

   410

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

   411

   412

	/* check if it's an integer */

   413

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

   414

		return strtoul(one, NULL, 0);

   415

   416

	idx = 0;

   417

	for (;;) {

   418

		/* find end of item */

   419

		s = many;

   420

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

   421

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

   422

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

   423

		many = s + 1;

   424

		idx++;

   425

	}

   426

}

   427

   428

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

   429

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

   430

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

   431

 * of seperated by a whitespace,tab or | character

   432

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

   433

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

   434

{

   435

	const char *s;

   436

	int r;

   437

	uint32 res = 0;

   438

   439

	for (;;) {

   440

		/* skip "whitespace" */

   441

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

   442

		if (*str == 0) break;

   443

   444

		s = str;

   445

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

   446

   447

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

   448

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

   449

   450

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

   451

		if (*s == 0) break;

   452

		str = s + 1;

   453

	}

   454

	return res;

   455

}

   456

   457

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

   458

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

   459

 * comma or a space character

   460

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

   461

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

   462

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

   463

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

   464

{

   465

	int n = 0, v;

   466

	char *end;

   467

   468

	for (;;) {

   469

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

   470

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

   471

		p = end;

   472

		items[n++] = v;

   473

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

   474

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

   475

		p++;

   476

	}

   477

   478

	return n;

   479

}

   480

   481

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

   482

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

   483

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

   484

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

   485

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

   486

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

   487

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

   488

{

   489

	int items[64];

   490

	int i, nitems;

   491

   492

	if (str == NULL) {

   493

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

   494

		nitems = nelems;

   495

	} else {

   496

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

   497

		if (nitems != nelems) return false;

   498

	}

   499