1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "functions.h"

     6

#include "variables.h"

     7

#include "gfx.h"

     8

#include "gui.h"

     9

#include "window.h"

    10

#include "table/strings.h"

    11

#include "table/sprites.h"

    12

#include "newgrf.h"

    13

#include "newgrf_config.h"

    14

    15

    16

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

    17

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

    18

 * comma or a space character

    19

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

    20

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

    21

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

    22

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

    23

{

    24

	int n = 0, v;

    25

	char *end;

    26

    27

	for (;;) {

    28

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

    29

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

    30

		p = end;

    31

		items[n++] = v;

    32

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

    33

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

    34

		p++;

    35

	}

    36

    37

	return n;

    38

}

    39

    40

    41

static void ShowNewGRFInfo(const GRFConfig *c, uint x, uint y, uint w, bool show_params)

    42

{

    43

	char buff[256];

    44

    45

	/* Draw filename or not if it is not known (GRF sent over internet) */

    46

	if (c->filename != NULL) {

    47

		SetDParamStr(0, c->filename);

    48

		y += DrawStringMultiLine(x, y, STR_NEWGRF_FILENAME, w);

    49

	}

    50

    51

	/* Prepare and draw GRF ID */

    52

	snprintf(buff, lengthof(buff), "%08X", (uint32)BSWAP32(c->grfid));

    53

	SetDParamStr(0, buff);

    54

	y += DrawStringMultiLine(x, y, STR_NEWGRF_GRF_ID, w);

    55

    56

	/* Prepare and draw MD5 sum */

    57

	md5sumToString(buff, lastof(buff), c->md5sum);

    58

	SetDParamStr(0, buff);

    59

	y += DrawStringMultiLine(x, y, STR_NEWGRF_MD5SUM, w);

    60

    61

	/* Show GRF parameter list */

    62

	if (show_params) {

    63

		if (c->num_params > 0) {

    64

			GRFBuildParamList(buff, c, lastof(buff));

    65

			SetDParamStr(0, buff);

    66

		} else {

    67

			SetDParam(0, STR_01A9_NONE);

    68

		}

    69

		y += DrawStringMultiLine(x, y, STR_NEWGRF_PARAMETER, w);

    70

	}

    71

    72

	/* Show flags */

    73

	if (HASBIT(c->flags, GCF_NOT_FOUND))  y += DrawStringMultiLine(x, y, STR_NEWGRF_NOT_FOUND, w);

    74

	if (HASBIT(c->flags, GCF_DISABLED))   y += DrawStringMultiLine(x, y, STR_NEWGRF_DISABLED, w);

    75

	if (HASBIT(c->flags, GCF_COMPATIBLE)) y += DrawStringMultiLine(x, y, STR_NEWGRF_COMPATIBLE_LOADED, w);

    76

    77

	/* Draw GRF info if it exists */

    78

	if (c->info != NULL && strlen(c->info) != 0) {

    79

		SetDParamStr(0, c->info);

    80

		y += DrawStringMultiLine(x, y, STR_02BD, w);

    81

	} else {

    82

		y += DrawStringMultiLine(x, y, STR_NEWGRF_NO_INFO, w);

    83

	}

    84

}

    85

    86

    87

/* Dialogue for adding NewGRF files to the selection */

    88

typedef struct newgrf_add_d {

    89

	GRFConfig **list;

    90

	const GRFConfig *sel;

    91

} newgrf_add_d;

    92

    93

    94

static void NewGRFAddDlgWndProc(Window *w, WindowEvent *e)

    95

{

    96

	switch (e->event) {

    97

		case WE_PAINT: {

    98

			const GRFConfig *c;

    99

			int y;

   100

			int n = 0;

   101

   102

			/* Count the number of GRFs */

   103

			for (c = _all_grfs; c != NULL; c = c->next) n++;

   104

   105

			w->vscroll.cap = (w->widget[3].bottom - w->widget[3].top) / 10;

   106

			SetVScrollCount(w, n);

   107

   108

			SetWindowWidgetDisabledState(w, 6, WP(w, newgrf_add_d).sel == NULL);

   109

			DrawWindowWidgets(w);

   110

   111

			GfxFillRect(w->widget[3].left + 1, w->widget[3].top + 1, w->widget[3].right, w->widget[3].bottom, 0xD7);

   112

   113

			n = 0;

   114

			y = w->widget[3].top + 1;

   115

   116

			for (c = _all_grfs; c != NULL; c = c->next) {

   117

				if (n >= w->vscroll.pos && n < w->vscroll.pos + w->vscroll.cap) {

   118

					bool h = c == WP(w, newgrf_add_d).sel;

   119

					const char *text = (c->name != NULL && strlen(c->name) != 0) ? c->name : c->filename;

   120

   121

					/* Draw selection background */

   122

					if (h) GfxFillRect(3, y, w->width - 15, y + 9, 156);

   123

					DoDrawStringTruncated(text, 4, y, h ? 0xC : 0x6, w->width - 18);

   124

					y += 10;

   125

				}

   126

				n++;

   127

			}

   128

   129

			if (WP(w, newgrf_add_d).sel != NULL) {

   130

				const Widget *wi = &w->widget[5];

   131

				ShowNewGRFInfo(WP(w, newgrf_add_d).sel, wi->left + 2, wi->top + 2, wi->right - wi->left - 2, false);

   132

			}

   133

			break;

   134

		}

   135

   136

		case WE_CLICK:

   137

			switch (e->we.click.widget) {

   138

				case 3: {

   139

					// Get row...

   140

					const GRFConfig *c;

   141

					uint i = (e->we.click.pt.y - w->widget[3].top) / 10 + w->vscroll.pos;

   142

   143

					for (c = _all_grfs; c != NULL && i > 0; c = c->next, i--);

   144

					WP(w, newgrf_add_d).sel = c;

   145

					SetWindowDirty(w);

   146

					break;

   147

				}

   148

   149

				case 6: /* Add selection to list */

   150

					if (WP(w, newgrf_add_d).sel != NULL) {

   151

						const GRFConfig *src = WP(w, newgrf_add_d).sel;

   152

						GRFConfig **list, *c;

   153

   154

						/* Find last entry in the list, checking for duplicate grfid on the way */

   155

						for (list = WP(w, newgrf_add_d).list; *list != NULL; list = &(*list)->next) {

   156

							if ((*list)->grfid == src->grfid) {

   157

								ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   158

								return;

   159

							}

   160

						}

   161

   162

						/* Copy GRF details from scanned list */

   163

						c = calloc(1, sizeof(*c));

   164

						*c = *src;

   165

						c->filename = strdup(src->filename);

   166

						if (src->name != NULL) c->name = strdup(src->name);

   167

						if (src->info != NULL) c->info = strdup(src->info);

   168

						c->next = NULL;

   169

   170

						/* Append GRF config to configuration list */

   171

						*list = c;

   172

   173

						DeleteWindowByClass(WC_SAVELOAD);

   174

						InvalidateWindowData(WC_GAME_OPTIONS, 0);

   175

					}

   176

					break;

   177

   178

				case 7: /* Rescan list */

   179

					WP(w, newgrf_add_d).sel = NULL;

   180

					ScanNewGRFFiles();

   181

					SetWindowDirty(w);

   182

					break;

   183

			}

   184

			break;

   185

	}

   186

}

   187

   188

   189

static const Widget _newgrf_add_dlg_widgets[] = {

   190

{   WWT_CLOSEBOX,    RESIZE_NONE, 14,   0,  10,   0,  13, STR_00C5,                STR_018B_CLOSE_WINDOW },

   191

{    WWT_CAPTION,   RESIZE_RIGHT, 14,  11, 306,   0,  13, STR_NEWGRF_ADD_CAPTION,  STR_018C_WINDOW_TITLE_DRAG_THIS },

   192

   193

/* List of files */

   194

{      WWT_PANEL,      RESIZE_RB, 14,   0, 294,  14, 221, 0x0,                     STR_NULL },

   195

{      WWT_INSET,      RESIZE_RB, 14,   2, 292,  16, 219, 0x0,                     STR_NULL },

   196

{  WWT_SCROLLBAR,     RESIZE_LRB, 14, 295, 306,  14, 221, 0x0,                     STR_NULL },

   197

   198

/* NewGRF file info */

   199

{      WWT_PANEL,     RESIZE_RTB, 14,   0, 306, 222, 324, 0x0,                     STR_NULL },

   200

   201

{ WWT_PUSHTXTBTN,     RESIZE_RTB, 14,   0, 146, 325, 336, STR_NEWGRF_ADD_FILE,     STR_NEWGRF_ADD_FILE_TIP },

   202

{ WWT_PUSHTXTBTN,    RESIZE_LRTB, 14, 147, 294, 325, 336, STR_NEWGRF_RESCAN_FILES, STR_NEWGRF_RESCAN_FILES_TIP },

   203

{  WWT_RESIZEBOX,    RESIZE_LRTB, 14, 295, 306, 325, 336, 0x0,                     STR_RESIZE_BUTTON },

   204

{   WIDGETS_END },

   205

};

   206

   207

   208

static const WindowDesc _newgrf_add_dlg_desc = {

   209

	WDP_CENTER, WDP_CENTER, 307, 337,

   210

	WC_SAVELOAD, 0,

   211

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   212

	_newgrf_add_dlg_widgets,

   213

	NewGRFAddDlgWndProc,

   214

};

   215

   216

   217

/* 'NewGRF Settings' dialogue */

   218

typedef struct newgrf_d {

   219

	GRFConfig **orig_list; ///< grf list the window is shown with

   220

	GRFConfig **list;      ///< temporary grf list to which changes are made

   221

	GRFConfig *sel;        ///< selected grf item

   222

	bool editable;         ///< is the window editable

   223

	bool show_params;      ///< are the grf-parameters shown in the info-panel

   224

	bool execute;          ///< on pressing 'apply changes' are grf changes applied immediately, or only list is updated

   225

} newgrf_d;

   226

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(newgrf_d));

   227

   228

   229

enum ShowNewGRFStateWidgets {

   230

	SNGRFS_ADD = 3,

   231

	SNGRFS_REMOVE,

   232

	SNGRFS_MOVE_UP,

   233

	SNGRFS_MOVE_DOWN,

   234

	SNGRFS_FILE_LIST = 7,

   235

	SNGRFS_NEWGRF_INFO = 9,

   236

	SNGRFS_SET_PARAMETERS,

   237

	SNGRFS_APPLY_CHANGES,

   238

};

   239

   240

   241

static void SetupNewGRFState(Window *w)

   242

{

   243

	bool disable_all = WP(w, newgrf_d).sel == NULL || !WP(w, newgrf_d).editable;

   244

   245

	SetWindowWidgetDisabledState(w, 3, !WP(w, newgrf_d).editable);

   246

	SetWindowWidgetsDisabledState(w, disable_all,

   247

		SNGRFS_REMOVE,

   248

		SNGRFS_MOVE_UP,

   249

		SNGRFS_MOVE_DOWN,

   250

		WIDGET_LIST_END

   251

	);

   252

	SetWindowWidgetDisabledState(w, SNGRFS_SET_PARAMETERS, !WP(w, newgrf_d).show_params || disable_all);

   253

   254

	if (!disable_all) {

   255

		/* All widgets are now enabled, so disable widgets we can't use */

   256

		if (WP(w, newgrf_d).sel == *WP(w, newgrf_d).list) DisableWindowWidget(w, SNGRFS_MOVE_UP);

   257

		if (WP(w, newgrf_d).sel->next == NULL) DisableWindowWidget(w, SNGRFS_MOVE_DOWN);

   258

	}

   259

}

   260

   261

   262

static void SetupNewGRFWindow(Window *w)

   263

{

   264

	const GRFConfig *c;

   265

	int i;

   266

   267

	for (c = *WP(w, newgrf_d).list, i = 0; c != NULL; c = c->next, i++);

   268

   269

	w->vscroll.cap = (w->widget[SNGRFS_FILE_LIST].bottom - w->widget[SNGRFS_FILE_LIST].top) / 14 + 1;

   270

	SetVScrollCount(w, i);

   271

	SetWindowWidgetDisabledState(w, SNGRFS_APPLY_CHANGES, !WP(w, newgrf_d).editable);

   272

}

   273

   274

   275

/** Callback function for the newgrf 'apply changes' confirmation window

   276

 * @param yes_clicked boolean value, true when yes was clicked, false otherwise */

   277

static void NewGRFConfirmationCallback(bool yes_clicked)

   278

{

   279

	if (yes_clicked) {

   280

		Window *w = FindWindowById(WC_GAME_OPTIONS, 0);

   281

		newgrf_d *nd = &WP(w, newgrf_d);

   282

		GRFConfig *c;

   283

		int i = 0;

   284

   285

		CopyGRFConfigList(nd->orig_list, *nd->list);

   286

		ReloadNewGRFData();

   287

   288

		/* Show new, updated list */

   289

		for (c = *nd->list; c != NULL && c != nd->sel; c = c->next, i++);

   290

		CopyGRFConfigList(nd->list, *nd->orig_list);

   291

		for (c = *nd->list; c != NULL && i > 0; c = c->next, i--);

   292

		nd->sel = c;

   293

   294

		SetWindowDirty(w);

   295

	}

   296

}

   297

   298

   299

static void NewGRFWndProc(Window *w, WindowEvent *e)

   300

{

   301

	switch (e->event) {

   302

		case WE_PAINT: {

   303

			const GRFConfig *c;

   304

			int i, y;

   305

   306

			SetupNewGRFState(w);

   307

   308

			DrawWindowWidgets(w);

   309

   310

			/* Draw NewGRF list */

   311

			y = w->widget[SNGRFS_FILE_LIST].top;

   312

			for (c = *WP(w, newgrf_d).list, i = 0; c != NULL; c = c->next, i++) {

   313

				if (i >= w->vscroll.pos && i < w->vscroll.pos + w->vscroll.cap) {

   314

					const char *text = (c->name != NULL && strlen(c->name) != 0) ? c->name : c->filename;

   315

					PalSpriteID pal;

   316

   317

					/* Pick a colour */

   318

					if (HASBIT(c->flags, GCF_NOT_FOUND) || HASBIT(c->flags, GCF_DISABLED)) {

   319

						pal = PALETTE_TO_RED;

   320

					} else if (HASBIT(c->flags, GCF_STATIC)) {

   321

						pal = PALETTE_TO_GREY;

   322

					} else if (HASBIT(c->flags, GCF_COMPATIBLE)) {

   323

						pal = PALETTE_TO_ORANGE;

   324

					} else if (HASBIT(c->flags, GCF_ACTIVATED)) {

   325

						pal = PALETTE_TO_GREEN;

   326

					} else {

   327

						pal = PALETTE_TO_BLUE;

   328

					}

   329

   330

					DrawSprite(SPRITE_PALETTE(SPR_SQUARE | pal), 5, y + 2);

   331

					DoDrawString(text, 25, y + 3, WP(w, newgrf_d).sel == c ? 0xC : 0x10);

   332

					y += 14;

   333

				}

   334

			}

   335

   336

			if (WP(w, newgrf_d).sel != NULL) {

   337

				/* Draw NewGRF file info */

   338

				const Widget *wi = &w->widget[SNGRFS_NEWGRF_INFO];

   339

				ShowNewGRFInfo(WP(w, newgrf_d).sel, wi->left + 2, wi->top + 2, wi->right - wi->left - 2, WP(w, newgrf_d).show_params);

   340

			}

   341

   342

			break;

   343

		}

   344

   345

		case WE_INVALIDATE_DATA:

   346

			SetupNewGRFWindow(w);

   347

			break;

   348

   349

		case WE_CLICK:

   350

			switch (e->we.click.widget) {

   351

				case SNGRFS_ADD: { /* Add GRF */

   352

					GRFConfig **list = WP(w, newgrf_d).list;

   353

					Window *w;

   354

   355

					DeleteWindowByClass(WC_SAVELOAD);

   356

					w = AllocateWindowDesc(&_newgrf_add_dlg_desc);

   357

					w->resize.step_height = 10;

   358

   359

					WP(w, newgrf_add_d).list = list;

   360

					break;

   361

				}

   362

   363

				case SNGRFS_REMOVE: { /* Remove GRF */

   364

					GRFConfig **pc, *c, *newsel;

   365

   366

					/* Choose the next GRF file to be the selected file */

   367

					newsel = WP(w, newgrf_d).sel->next;

   368

   369

					for (pc = WP(w, newgrf_d).list; (c = *pc) != NULL; pc = &c->next) {

   370

						/* If the new selection is empty (i.e. we're deleting the last item

   371

						 * in the list, pick the file just before the selected file */

   372

						if (newsel == NULL && c->next == WP(w, newgrf_d).sel) newsel = c;

   373

   374

						if (c == WP(w, newgrf_d).sel) {

   375

							*pc = c->next;

   376

							free(c);

   377

							break;

   378

						}

   379

					}

   380

   381

					WP(w, newgrf_d).sel = newsel;

   382

					SetupNewGRFWindow(w);

   383

					SetWindowDirty(w);

   384

					break;

   385

				}

   386

   387

				case SNGRFS_MOVE_UP: { /* Move GRF up */

   388

					GRFConfig **pc, *c;

   389

					if (WP(w, newgrf_d).sel == NULL) break;

   390

   391

					for (pc = WP(w, newgrf_d).list; (c = *pc) != NULL; pc = &c->next) {

   392

						if (c->next == WP(w, newgrf_d).sel) {

   393

							c->next = WP(w, newgrf_d).sel->next;

   394

							WP(w, newgrf_d).sel->next = c;

   395

							*pc = WP(w, newgrf_d).sel;

   396

							break;

   397

						}

   398

					}

   399

					SetWindowDirty(w);

   400

					break;

   401

				}

   402

   403

				case SNGRFS_MOVE_DOWN: { /* Move GRF down */

   404

					GRFConfig **pc, *c;

   405

					if (WP(w, newgrf_d).sel == NULL) break;

   406

   407

					for (pc = WP(w, newgrf_d).list; (c = *pc) != NULL; pc = &c->next) {

   408

						if (c == WP(w, newgrf_d).sel) {

   409

							*pc = c->next;

   410

							c->next = c->next->next;

   411

							(*pc)->next = c;

   412

							break;

   413

						}

   414

					}

   415

					SetWindowDirty(w);

   416

					break;

   417

				}

   418

   419

				case SNGRFS_FILE_LIST: { /* Select a GRF */

   420

					GRFConfig *c;

   421

					uint i = (e->we.click.pt.y - w->widget[SNGRFS_FILE_LIST].top) / 14 + w->vscroll.pos;

   422

   423

					for (c = *WP(w, newgrf_d).list; c != NULL && i > 0; c = c->next, i--);

   424

					WP(w, newgrf_d).sel = c;

   425

   426

					SetWindowDirty(w);

   427

					break;

   428

				}

   429

   430

				case SNGRFS_APPLY_CHANGES: /* Apply changes made to GRF list */

   431

					if (WP(w, newgrf_d).execute) {

   432

						ShowQuery(

   433

							STR_POPUP_CAUTION_CAPTION,

   434

							STR_NEWGRF_CONFIRMATION_TEXT,

   435

							NewGRFConfirmationCallback,

   436

							w->window_class,

   437

							w->window_number

   438

						);

   439

					} else {

   440

						CopyGRFConfigList(WP(w, newgrf_d).orig_list, *WP(w, newgrf_d).list);

   441

					}

   442

					break;

   443

   444

				case SNGRFS_SET_PARAMETERS: { /* Edit parameters */

   445

					char buff[512];

   446

					if (WP(w, newgrf_d).sel == NULL) break;

   447

   448

					GRFBuildParamList(buff, WP(w, newgrf_d).sel, lastof(buff));

   449

					ShowQueryString(BindCString(buff), STR_NEWGRF_PARAMETER_QUERY, 63, 250, w->window_class, w->window_number, CS_ALPHANUMERAL);

   450

					break;

   451

				}

   452

			}

   453

			break;

   454

   455

		case WE_ON_EDIT_TEXT:

   456

			if (e->we.edittext.str != NULL) {

   457

				/* Parse our new "int list" */

   458

				GRFConfig *c = WP(w, newgrf_d).sel;

   459

				c->num_params = parse_intlist(e->we.edittext.str, (int*)c->param, lengthof(c->param));

   460

   461

				/* parse_intlist returns -1 on error */

   462

				if (c->num_params == (byte)-1) c->num_params = 0;

   463

			}

   464

			SetWindowDirty(w);

   465

			break;

   466

   467

		case WE_DESTROY:

   468

			if (!WP(w, newgrf_d).execute) {

   469

				CopyGRFConfigList(WP(w, newgrf_d).orig_list, *WP(w, newgrf_d).list);

   470

			}

   471

			/* Remove the temporary copy of grf-list used in window */

   472

			ClearGRFConfigList(WP(w, newgrf_d).list);

   473

			break;

   474

   475

		case WE_RESIZE:

   476

			w->vscroll.cap += e->we.sizing.diff.y / 14;

   477

			w->widget[SNGRFS_FILE_LIST].data = (w->vscroll.cap << 8) + 1;

   478

			break;

   479

	}

   480

}

   481

   482

   483

static const Widget _newgrf_widgets[] = {

   484

{   WWT_CLOSEBOX,  RESIZE_NONE, 10,   0,  10,   0,  13, STR_00C5,                    STR_018B_CLOSE_WINDOW },

   485

{    WWT_CAPTION, RESIZE_RIGHT, 10,  11, 299,   0,  13, STR_NEWGRF_SETTINGS_CAPTION, STR_018C_WINDOW_TITLE_DRAG_THIS },

   486

   487

/* NewGRF file Add, Remove, Move up, Move down */

   488

{      WWT_PANEL, RESIZE_RIGHT, 10,   0, 299,  14,  29, STR_NULL,                    STR_NULL },

   489

{ WWT_PUSHTXTBTN,  RESIZE_NONE,  3,  10,  79,  16,  27, STR_NEWGRF_ADD,              STR_NEWGRF_ADD_TIP },

   490

{ WWT_PUSHTXTBTN,  RESIZE_NONE,  3,  80, 149,  16,  27, STR_NEWGRF_REMOVE,           STR_NEWGRF_REMOVE_TIP },

   491

{ WWT_PUSHTXTBTN,  RESIZE_NONE,  3, 150, 219,  16,  27, STR_NEWGRF_MOVEUP,           STR_NEWGRF_MOVEUP_TIP },

   492

{ WWT_PUSHTXTBTN,  RESIZE_NONE,  3, 220, 289,  16,  27, STR_NEWGRF_MOVEDOWN,         STR_NEWGRF_MOVEDOWN_TIP },

   493

   494

/* NewGRF file list */

   495

{     WWT_MATRIX,    RESIZE_RB, 10,   0, 287,  30,  99, 0x501,                       STR_NEWGRF_FILE_TIP },

   496

{  WWT_SCROLLBAR,   RESIZE_LRB, 10, 288, 299,  30,  99, 0x0,                         STR_0190_SCROLL_BAR_SCROLLS_LIST },

   497

   498

/* NewGRF file info */

   499

{      WWT_PANEL,   RESIZE_RTB, 10,   0, 299, 100, 212, STR_NULL,                    STR_NULL },

   500

   501

/* Edit parameter and apply changes button... */

   502

{ WWT_PUSHTXTBTN,    RESIZE_TB, 10,   0, 143, 213, 224, STR_NEWGRF_SET_PARAMETERS,   STR_NULL },

   503

{ WWT_PUSHTXTBTN,   RESIZE_RTB, 10, 144, 287, 213, 224, STR_NEWGRF_APPLY_CHANGES,    STR_NULL },

   504

   505

{  WWT_RESIZEBOX,  RESIZE_LRTB, 10, 288, 299, 213, 224, 0x0,                         STR_RESIZE_BUTTON },

   506

   507

{ WIDGETS_END },

   508

};

   509

   510

   511

static const WindowDesc _newgrf_desc = {

   512

	WDP_CENTER, WDP_CENTER, 300, 225,

   513

	WC_GAME_OPTIONS, 0,