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

    15

typedef struct IniFile IniFile;

    16

typedef struct IniItem IniItem;

    17

typedef struct IniGroup IniGroup;

    18

typedef struct SettingsMemoryPool SettingsMemoryPool;

    19

    20

static void pool_init(SettingsMemoryPool **pool);

    21

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

    22

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

    23

static void pool_free(SettingsMemoryPool **pool);

    24

    25

struct SettingsMemoryPool {

    26

	uint pos,size;

    27

	SettingsMemoryPool *next;

    28

	byte mem[1];

    29

};

    30

    31

static SettingsMemoryPool *pool_new(uint minsize)

    32

{

    33

	SettingsMemoryPool *p;

    34

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

    35

    36

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

    37

	p->pos = 0;

    38

	p->size = minsize;

    39

	p->next = NULL;

    40

	return p;

    41

}

    42

    43

static void pool_init(SettingsMemoryPool **pool)

    44

{

    45

	*pool = pool_new(0);

    46

}

    47

    48

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

    49

{

    50

	uint pos;

    51

	SettingsMemoryPool *p = *pool;

    52

    53

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

    54

    55

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

    56

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

    57

		p = p->next;

    58

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

    59

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

    60

		SettingsMemoryPool *n = pool_new(size);

    61

		*pool = n;

    62

		n->next = p;

    63

		p = n;

    64

	}

    65

    66

	pos = p->pos;

    67

	p->pos += size;

    68

	return p->mem + pos;

    69

}

    70

    71

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

    72

{

    73

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

    74

	p[size] = 0;

    75

	memcpy(p, mem, size);

    76

	return p;

    77

}

    78

    79

static void pool_free(SettingsMemoryPool **pool)

    80

{

    81

	SettingsMemoryPool *p = *pool, *n;

    82

	*pool = NULL;

    83

	while (p) {

    84

		n = p->next;

    85

		free(p);

    86

		p = n;

    87

	}

    88

}

    89

    90

// structs describing the ini format.

    91

struct IniItem {

    92

	char *name;

    93

	char *value;

    94

	char *comment;

    95

	IniItem *next;

    96

};

    97

    98

struct IniGroup {

    99

	char *name; // name of group

   100

	char *comment; //comment for group

   101

	IniItem *item, **last_item;

   102

	IniGroup *next;

   103

	IniFile *ini;

   104

	IniGroupType type; // type of group

   105

};

   106

   107

struct IniFile {

   108

	SettingsMemoryPool *pool;

   109

	IniGroup *group, **last_group;

   110

	char *comment; // last comment in file

   111

};

   112

   113

// allocate an inifile object

   114

static IniFile *ini_alloc(void)

   115

{

   116

	IniFile *ini;

   117

	SettingsMemoryPool *pool;

   118

	pool_init(&pool);

   119

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

   120

	ini->pool = pool;

   121

	ini->group = NULL;

   122

	ini->last_group = &ini->group;

   123

	ini->comment = NULL;

   124

	return ini;

   125

}

   126

   127

// allocate an ini group object

   128

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

   129

{

   130

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

   131

	grp->ini = ini;

   132

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

   133

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

   134

		grp->type = IGT_LIST;

   135

	} else {

   136

		grp->type = IGT_VARIABLES;

   137

	}

   138

	grp->next = NULL;

   139

	grp->item = NULL;

   140

	grp->comment = NULL;

   141

	grp->last_item = &grp->item;

   142

	*ini->last_group = grp;

   143

	ini->last_group = &grp->next;

   144

	return grp;

   145

}

   146

   147

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

   148

{

   149

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

   150

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

   151

	item->next = NULL;

   152

	item->comment = NULL;

   153

	item->value = NULL;

   154

	*group->last_item = item;

   155

	group->last_item = &item->next;

   156

	return item;

   157

}

   158

   159

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

   160

static IniFile *ini_load(const char *filename)

   161

{

   162

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

   163

	FILE *in;

   164

	IniFile *ini;

   165

	IniGroup *group = NULL;

   166

	IniItem *item;

   167

   168

	char *comment = NULL;

   169

	uint comment_size = 0;

   170

	uint comment_alloc = 0;

   171

   172

	ini = ini_alloc();

   173

   174

	in = fopen(filename, "r");

   175

	if (in == NULL) return ini;

   176

   177

	// for each line in the file

   178

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

   179

   180

		// trim whitespace from the left side

   181

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

   182

   183

		// trim whitespace from right side.

   184

		e = s + strlen(s);

   185

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

   186

		*e = 0;

   187

   188

		// skip comments and empty lines

   189

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

   190

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

   191

			uint a = comment_alloc;

   192

			uint pos;

   193

			// add to comment

   194

			if (ns > a) {

   195

				a = max(a, 128);

   196

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

   197

				comment = realloc(comment, comment_alloc = a);

   198

			}

   199

			pos = comment_size;

   200

			comment_size += (e - s + 1);

   201

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

   202

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

   203

			continue;

   204

		}

   205

   206

		// it's a group?

   207

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

   208

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

   209

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

   210

			else

   211

				e--;

   212

			s++; // skip [

   213

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

   214

			if (comment_size) {

   215

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

   216

				comment_size = 0;

   217

			}

   218

		} else if (group) {

   219

			// find end of keyname

   220

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

   221

   222

			// it's an item in an existing group

   223

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

   224

			if (comment_size) {

   225

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

   226

				comment_size = 0;

   227

			}

   228

   229

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

   230

			if (group->type == IGT_LIST) {

   231

				item->value = item->name;

   232

				continue;

   233

			}

   234

   235

			// find start of parameter

   236

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

   237

   238

   239

			// remove starting quotation marks

   240

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

   241

			// remove ending quotation marks

   242

			e = t + strlen(t);

   243

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

   244

			*e = 0;

   245

   246

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

   247

		} else {

   248

			// it's an orphan item

   249

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

   250

		}

   251

	}

   252

   253

	if (comment_size) {

   254

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

   255

		comment_size = 0;

   256

	}

   257

   258

	free(comment);

   259

	fclose(in);

   260

   261

	return ini;

   262

}

   263

   264

// lookup a group or make a new one

   265

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

   266

{

   267

	IniGroup *group;

   268

   269

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

   270

   271

	// does it exist already?

   272

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

   273

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

   274

			return group;

   275

   276

	// otherwise make a new one

   277

	group = ini_group_alloc(ini, name, len);

   278

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

   279

	return group;

   280

}

   281

   282

// lookup an item or make a new one

   283

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

   284

{

   285

	IniItem *item;

   286

	uint len = strlen(name);

   287

   288

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

   289

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

   290

   291

	if (!create) return NULL;

   292

   293

	// otherwise make a new one

   294

	return ini_item_alloc(group, name, len);

   295

}

   296

   297

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

   298

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

   299

{

   300

	FILE *f;

   301

	IniGroup *group;

   302

	IniItem *item;

   303

   304

	f = fopen(filename, "w");

   305

	if (f == NULL) return false;

   306

   307

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

   308

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

   309

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

   310

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

   311

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

   312

			if (group->type == IGT_LIST)

   313

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

   314

			else

   315

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

   316

		}

   317

	}

   318

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

   319

   320

	fclose(f);

   321

	return true;

   322

}

   323

   324

static void ini_free(IniFile *ini)

   325

{

   326

	pool_free(&ini->pool);

   327

}

   328

   329

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

   330

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

   331

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

   332

 * @param onelen force calculation of the *one parameter

   333

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

   334

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

   335

{

   336

	const char *s;

   337

	int idx;

   338

   339

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

   340

   341

	// check if it's an integer

   342

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

   343

		return strtoul(one, NULL, 0);

   344

   345

	idx = 0;

   346

	for (;;) {

   347

		// find end of item

   348

		s = many;

   349

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

   350

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

   351

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

   352

		many = s + 1;

   353

		idx++;

   354

	}

   355

}

   356

   357

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

   358

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

   359

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

   360

 * of seperated by a whitespace\tab or | character

   361

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

   362

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

   363

{

   364

	const char *s;

   365

	int r;

   366

	uint32 res = 0;

   367

   368

	for (;;) {

   369

		// skip "whitespace"

   370

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

   371

		if (*str == 0) break;

   372

   373

		s = str;

   374

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

   375

   376

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

   377

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

   378

   379

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

   380

		if (*s == 0) break;

   381

		str = s + 1;

   382

	}

   383

	return res;

   384

}

   385

   386

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

   387

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

   388

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

   389

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

   390

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

   391

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

   392

{

   393

	int n = 0, v;

   394

	char *end;

   395

   396

	for (;;) {

   397

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

   398

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

   399

		p = end;

   400

		items[n++] = v;

   401

		if (*p == 0) break;

   402

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

   403

		p++;

   404

	}

   405

   406

	return n;

   407

}

   408

   409

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

   410

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

   411

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

   412

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

   413

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

   414

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

   415

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

   416

{

   417

	int items[64];

   418

	int i, nitems;

   419

   420

	if (str == NULL) {

   421

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

   422

		nitems = nelems;

   423

	} else {

   424

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

   425

		if (nitems != nelems) return false;

   426

	}

   427

   428

	switch (type) {

   429

	case SDT_INT8:

   430

	case SDT_UINT8:

   431

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

   432

		break;

   433

	case SDT_INT16:

   434

	case SDT_UINT16:

   435

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

   436

		break;

   437

	case SDT_INT32:

   438

	case SDT_UINT32:

   439

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

   440

		break;

   441

	default: NOT_REACHED();

   442

	}

   443

   444

	return true;

   445

}

   446

   447

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

   448

 * is seperated by a comma

   449

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

   450

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

   451

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

   452

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

   453

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

   454

{

   455

	int i, v = 0;

   456

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

   457

   458

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

   459

		switch (type) {

   460

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

   461

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

   462

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

   463

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

   464

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

   465

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

   466

		default: NOT_REACHED();

   467

		}

   468

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

   469

	}

   470

}

   471

   472

/* Convert a ONEofMANY structure to a string representation.

   473

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

   474

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

   475

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

   476

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

   477

{

   478

	int orig_id = id;

   479

   480

	// Look for the id'th element

   481

	while (--id >= 0) {

   482

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

   483

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

   484

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

   485

				return;

   486

			}

   487

		}

   488

		many++; // pass the |-character

   489

	}

   490

   491

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

   492

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

   493

	*buf = '\0';

   494

}

   495

   496

/* Convert a MANYofMANY structure to a string representation.

   497

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

   498

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

   499

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

   500

 *        be found in the bitmasked many string */

   501

static void make_manyofmany(char *buf, const char *many, uint32 x)

   502

{

   503

	const char *start;

   504

	int i = 0;

   505

	bool init = true;

   506

   507

	for (; x != 0; x >>= 1, i++) {

   508

		start = many;

   509

		while (*many != 0 && *many != '|') many++; // advance to the next element