1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "currency.h"

     6

#include "functions.h"

     7

#include "macros.h"

     8

#include "screenshot.h"

     9

#include "sound.h"

    10

#include "string.h"

    11

#include "variables.h"

    12

#include "network.h"

    13

#include "settings.h"

    14

#include "command.h"

    15

#include "console.h"

    16

#include "saveload.h"

    17

    18

/** The patch values that are used for new games and/or modified in config file */

    19

Patches _patches_newgame;

    20

    21

typedef struct IniFile IniFile;

    22

typedef struct IniItem IniItem;

    23

typedef struct IniGroup IniGroup;

    24

typedef struct SettingsMemoryPool SettingsMemoryPool;

    25

    26

static void pool_init(SettingsMemoryPool **pool);

    27

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

    28

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

    29

static void pool_free(SettingsMemoryPool **pool);

    30

    31

struct SettingsMemoryPool {

    32

	uint pos,size;

    33

	SettingsMemoryPool *next;

    34

	byte mem[1];

    35

};

    36

    37

static SettingsMemoryPool *pool_new(uint minsize)

    38

{

    39

	SettingsMemoryPool *p;

    40

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

    41

    42

	p = malloc(sizeof(SettingsMemoryPool) - 1 + minsize);

    43

	p->pos = 0;

    44

	p->size = minsize;

    45

	p->next = NULL;

    46

	return p;

    47

}

    48

    49

static void pool_init(SettingsMemoryPool **pool)

    50

{

    51

	*pool = pool_new(0);

    52

}

    53

    54

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

    55

{

    56

	uint pos;

    57

	SettingsMemoryPool *p = *pool;

    58

    59

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

    60

    61

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

    62

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

    63

		p = p->next;

    64

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

    65

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

    66

		SettingsMemoryPool *n = pool_new(size);

    67

		*pool = n;

    68

		n->next = p;

    69

		p = n;

    70

	}

    71

    72

	pos = p->pos;

    73

	p->pos += size;

    74

	return p->mem + pos;

    75

}

    76

    77

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

    78

{

    79

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

    80

	p[size] = 0;

    81

	memcpy(p, mem, size);

    82

	return p;

    83

}

    84

    85

static void pool_free(SettingsMemoryPool **pool)

    86

{

    87

	SettingsMemoryPool *p = *pool, *n;

    88

	*pool = NULL;

    89

	while (p) {

    90

		n = p->next;

    91

		free(p);

    92

		p = n;

    93

	}

    94

}

    95

    96

// structs describing the ini format.

    97

struct IniItem {

    98

	char *name;

    99

	char *value;

   100

	char *comment;

   101

	IniItem *next;

   102

};

   103

   104

struct IniGroup {

   105

	char *name; // name of group

   106

	char *comment; //comment for group

   107

	IniItem *item, **last_item;

   108

	IniGroup *next;

   109

	IniFile *ini;

   110

	IniGroupType type; // type of group

   111

};

   112

   113

struct IniFile {

   114

	SettingsMemoryPool *pool;

   115

	IniGroup *group, **last_group;

   116

	char *comment; // last comment in file

   117

};

   118

   119

// allocate an inifile object

   120

static IniFile *ini_alloc(void)

   121

{

   122

	IniFile *ini;

   123

	SettingsMemoryPool *pool;

   124

	pool_init(&pool);

   125

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

   126

	ini->pool = pool;

   127

	ini->group = NULL;

   128

	ini->last_group = &ini->group;

   129

	ini->comment = NULL;

   130

	return ini;

   131

}

   132

   133

// allocate an ini group object

   134

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

   135

{

   136

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

   137

	grp->ini = ini;

   138

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

   139

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

   140

		grp->type = IGT_LIST;

   141

	} else {

   142

		grp->type = IGT_VARIABLES;

   143

	}

   144

	grp->next = NULL;

   145

	grp->item = NULL;

   146

	grp->comment = NULL;

   147

	grp->last_item = &grp->item;

   148

	*ini->last_group = grp;

   149

	ini->last_group = &grp->next;

   150

	return grp;

   151

}

   152

   153

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

   154

{

   155

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

   156

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

   157

	item->next = NULL;

   158

	item->comment = NULL;

   159

	item->value = NULL;

   160

	*group->last_item = item;

   161

	group->last_item = &item->next;

   162

	return item;

   163

}

   164

   165

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

   166

static IniFile *ini_load(const char *filename)

   167

{

   168

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

   169

	FILE *in;

   170

	IniFile *ini;

   171

	IniGroup *group = NULL;

   172

	IniItem *item;

   173

   174

	char *comment = NULL;

   175

	uint comment_size = 0;

   176

	uint comment_alloc = 0;

   177

   178

	ini = ini_alloc();

   179

   180

	in = fopen(filename, "r");

   181

	if (in == NULL) return ini;

   182

   183

	// for each line in the file

   184

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

   185

   186

		// trim whitespace from the left side

   187

		for (s = buffer; s[0] == ' ' || s[0] == '\t'; s++);

   188

   189

		// trim whitespace from right side.

   190

		e = s + strlen(s);

   191

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

   192

		*e = 0;

   193

   194

		// skip comments and empty lines

   195

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

   196

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

   197

			uint a = comment_alloc;

   198

			uint pos;

   199

			// add to comment

   200

			if (ns > a) {

   201

				a = max(a, 128);

   202

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

   203

				comment = realloc(comment, comment_alloc = a);

   204

			}

   205

			pos = comment_size;

   206

			comment_size += (e - s + 1);

   207

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

   208

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

   209

			continue;

   210

		}

   211

   212

		// it's a group?

   213

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

   214

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

   215

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

   216

			else

   217

				e--;

   218

			s++; // skip [

   219

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

   220

			if (comment_size) {

   221

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

   222

				comment_size = 0;

   223

			}

   224

		} else if (group) {

   225

			// find end of keyname

   226

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

   227

   228

			// it's an item in an existing group

   229

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

   230

			if (comment_size) {

   231

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

   232

				comment_size = 0;

   233

			}

   234

   235

			// for list items, the name and value are the same:

   236

			if (group->type == IGT_LIST) {

   237

				item->value = item->name;

   238

				continue;

   239

			}

   240

   241

			// find start of parameter

   242

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

   243

   244

   245

			// remove starting quotation marks

   246

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

   247

			// remove ending quotation marks

   248

			e = t + strlen(t);

   249

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

   250

			*e = 0;

   251

   252

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

   253

		} else {

   254

			// it's an orphan item

   255

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

   256

		}

   257

	}

   258

   259

	if (comment_size) {

   260

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

   261

		comment_size = 0;

   262

	}

   263

   264

	free(comment);

   265

	fclose(in);

   266

   267

	return ini;

   268

}

   269

   270

// lookup a group or make a new one

   271

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

   272

{

   273

	IniGroup *group;

   274

   275

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

   276

   277

	// does it exist already?

   278

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

   279

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

   280

			return group;

   281

   282

	// otherwise make a new one

   283

	group = ini_group_alloc(ini, name, len);

   284

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

   285

	return group;

   286

}

   287

   288

// lookup an item or make a new one

   289

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

   290

{

   291

	IniItem *item;

   292

	uint len = strlen(name);

   293

   294

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

   295

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

   296

   297

	if (!create) return NULL;

   298

   299

	// otherwise make a new one

   300

	return ini_item_alloc(group, name, len);

   301

}

   302

   303

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

   304

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

   305

{

   306

	FILE *f;

   307

	IniGroup *group;

   308

	IniItem *item;

   309

   310

	f = fopen(filename, "w");

   311

	if (f == NULL) return false;

   312

   313

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

   314

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

   315

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

   316

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

   317

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

   318

			if (group->type == IGT_LIST)

   319

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

   320

			else

   321

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

   322

		}

   323

	}

   324

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

   325

   326

	fclose(f);

   327

	return true;

   328

}

   329

   330

static void ini_free(IniFile *ini)

   331

{

   332

	pool_free(&ini->pool);

   333

}

   334

   335

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

   336

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

   337

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

   338

 * @param onelen force calculation of the *one parameter

   339

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

   340

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

   341

{

   342

	const char *s;

   343

	int idx;

   344

   345

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

   346

   347

	// check if it's an integer

   348

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

   349

		return strtoul(one, NULL, 0);

   350

   351

	idx = 0;

   352

	for (;;) {

   353

		// find end of item

   354

		s = many;

   355

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

   356

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

   357

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

   358

		many = s + 1;

   359

		idx++;

   360

	}

   361

}

   362

   363

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

   364

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

   365

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

   366

 * of seperated by a whitespace\tab or | character

   367

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

   368

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

   369

{

   370

	const char *s;

   371

	int r;

   372

	uint32 res = 0;

   373

   374

	for (;;) {

   375

		// skip "whitespace"

   376

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

   377

		if (*str == 0) break;

   378

   379

		s = str;

   380

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

   381

   382

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

   383

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

   384

   385

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

   386

		if (*s == 0) break;

   387

		str = s + 1;

   388

	}

   389

	return res;

   390

}

   391

   392

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

   393

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

   394

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

   395

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

   396

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

   397

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

   398

{

   399

	int n = 0, v;

   400

	char *end;

   401

   402

	for (;;) {

   403

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

   404

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

   405

		p = end;

   406

		items[n++] = v;

   407

		if (*p == 0) break;

   408

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

   409

		p++;

   410

	}

   411

   412

	return n;

   413

}

   414

   415

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

   416

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

   417

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

   418

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

   419

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

   420

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

   421

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

   422

{

   423

	int items[64];

   424

	int i, nitems;

   425

   426

	if (str == NULL) {

   427

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

   428

		nitems = nelems;

   429

	} else {

   430

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

   431

		if (nitems != nelems) return false;

   432

	}

   433

   434

	switch (type) {

   435

	case SLE_VAR_BL:

   436

	case SLE_VAR_I8:

   437

	case SLE_VAR_U8:

   438

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

   439

		break;

   440

	case SLE_VAR_I16:

   441

	case SLE_VAR_U16:

   442

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

   443

		break;

   444

	case SLE_VAR_I32:

   445

	case SLE_VAR_U32:

   446

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

   447

		break;

   448

	default: NOT_REACHED();

   449

	}

   450

   451

	return true;

   452

}

   453

   454

/* Convert an integer-array (intlist) to a string representation. Each value

   455

 * is seperated by a comma

   456

 * @param buf output buffer where the string-representation will be stored

   457

 * @param array pointer to the integer-arrays that is read from

   458

 * @param nelems the number of elements the array holds.

   459

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

   460

static void make_intlist(char *buf, const void *array, int nelems, VarType type)

   461

{

   462

	int i, v = 0;

   463

	const byte *p = (const byte*)array;

   464

   465

	for (i = 0; i != nelems; i++) {

   466

		switch (type) {

   467

		case SLE_VAR_BL:

   468

		case SLE_VAR_I8:  v = *(int8*)p;   p += 1; break;

   469

		case SLE_VAR_U8:  v = *(byte*)p;   p += 1; break;

   470

		case SLE_VAR_I16: v = *(int16*)p;  p += 2; break;

   471

		case SLE_VAR_U16: v = *(uint16*)p; p += 2; break;

   472

		case SLE_VAR_I32: v = *(int32*)p;  p += 4; break;

   473

		case SLE_VAR_U32: v = *(uint32*)p; p += 4; break;

   474

		default: NOT_REACHED();

   475

		}

   476

		buf += sprintf(buf, (i == 0) ? "%d" : ",%d", v);

   477

	}

   478

}

   479

   480

/* Convert a ONEofMANY structure to a string representation.

   481

 * @param buf output buffer where the string-representation will be stored

   482

 * @param many the full-domain string of possible values

   483

 * @param id the value of the variable and whose string-representation must be found */

   484

static void make_oneofmany(char *buf, const char *many, int id)

   485

{

   486

	int orig_id = id;

   487

   488

	// Look for the id'th element

   489

	while (--id >= 0) {

   490

		for (; *many != '|'; many++) {

   491

			if (*many == '\0') { // not found

   492

				sprintf(buf, "%d", orig_id);

   493

				return;

   494

			}

   495

		}

   496

		many++; // pass the |-character

   497

	}

   498

   499

	// copy string until next item (|) or the end of the list if this is the last one

   500

	while (*many != '\0' && *many != '|') *buf++ = *many++;

   501

	*buf = '\0';

   502

}

   503

   504

/* Convert a MANYofMANY structure to a string representation.

   505

 * @param buf output buffer where the string-representation will be stored

   506

 * @param many the full-domain string of possible values

   507

 * @param x the value of the variable and whose string-representation must

   508

 *        be found in the bitmasked many string */