1

/* $Id$ */

     2

     3

/** @file newgrf_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "functions.h"

     8

#include "variables.h"

     9

#include "gfx.h"

    10

#include "gui.h"

    11

#include "window.h"

    12

#include "table/strings.h"

    13

#include "table/sprites.h"

    14

#include "newgrf.h"

    15

#include "newgrf_config.h"

    16

#include "strings.h"

    17

#include "helpers.hpp"

    18

    19

    20

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

    21

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

    22

 * comma or a space character

    23

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

    24

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

    25

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

    26

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

    27

{

    28

	int n = 0, v;

    29

	char *end;

    30

    31

	for (;;) {

    32

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

    33

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

    34

		p = end;

    35

		items[n++] = v;

    36

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

    37

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

    38

		p++;

    39

	}

    40

    41

	return n;

    42

}

    43

    44

    45

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

    46

{

    47

	char buff[256];

    48

    49

	if (c->error != NULL) {

    50

		SetDParamStr(0, c->filename);

    51

		SetDParamStr(1, c->error->data);

    52

		for (uint i = 0; i < c->error->num_params; i++) {

    53

			uint32 param = 0;

    54

			byte param_number = c->error->param_number[i];

    55

    56

			if (param_number < c->num_params) param = c->param[param_number];

    57

    58

			SetDParam(2 + i, param);

    59

		}

    60

    61

		char message[512];

    62

		GetString(message, c->error->custom_message != NULL ? BindCString(c->error->custom_message) : c->error->message, lastof(message));

    63

    64

		SetDParamStr(0, message);

    65

		y += DrawStringMultiLine(x, y, c->error->severity, w, bottom - y);

    66

	}

    67

    68

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

    69

	if (c->filename != NULL) {

    70

		SetDParamStr(0, c->filename);

    71

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

    72

	}

    73

    74

	/* Prepare and draw GRF ID */

    75

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

    76

	SetDParamStr(0, buff);

    77

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

    78

    79

	/* Prepare and draw MD5 sum */

    80

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

    81

	SetDParamStr(0, buff);

    82

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

    83

    84

	/* Show GRF parameter list */

    85

	if (show_params) {

    86

		if (c->num_params > 0) {

    87

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

    88

			SetDParamStr(0, buff);

    89

		} else {

    90

			SetDParam(0, STR_01A9_NONE);

    91

		}

    92

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

    93

	}

    94

    95

	/* Show flags */

    96

	if (c->status == GCS_NOT_FOUND)        y += DrawStringMultiLine(x, y, STR_NEWGRF_NOT_FOUND, w, bottom - y);

    97

	if (c->status == GCS_DISABLED)         y += DrawStringMultiLine(x, y, STR_NEWGRF_DISABLED, w, bottom - y);

    98

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

    99

   100

	/* Draw GRF info if it exists */

   101

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

   102

		SetDParamStr(0, c->info);

   103

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

   104

	} else {

   105

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

   106

	}

   107

}

   108

   109

   110

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

   111

struct newgrf_add_d {

   112

	GRFConfig **list;

   113

	const GRFConfig *sel;

   114

};

   115

   116

   117

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

   118

{

   119

	switch (e->event) {

   120

		case WE_PAINT: {

   121

			const GRFConfig *c;

   122

			int y;

   123

			int n = 0;

   124

   125

			/* Count the number of GRFs */

   126

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

   127

   128

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

   129

			SetVScrollCount(w, n);

   130

   131

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

   132

			DrawWindowWidgets(w);

   133

   134

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

   135

   136

			n = 0;

   137

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

   138

   139

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

   140

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

   141

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

   142

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

   143

   144

					/* Draw selection background */

   145

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

   146

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

   147

					y += 10;

   148

				}

   149

				n++;

   150

			}

   151

   152

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

   153

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

   154

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

   155

			}

   156

			break;

   157

		}

   158

   159

		case WE_DOUBLE_CLICK:

   160

			if (e->we.click.widget != 3) break;

   161

			e->we.click.widget = 6;

   162

			/* Fall through */

   163

   164

		case WE_CLICK:

   165

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

   166

				case 3: {

   167

					/* Get row... */

   168

					const GRFConfig *c;

   169

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

   170

   171

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

   172

					WP(w, newgrf_add_d).sel = c;

   173

					SetWindowDirty(w);

   174

					break;

   175

				}

   176

   177

				case 6: // Add selection to list

   178

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

   179

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

   180

						GRFConfig **list;

   181

   182

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

   183

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

   184

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

   185

								ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   186

								return;

   187

							}

   188

						}

   189

   190

						/* Copy GRF details from scanned list */

   191

						GRFConfig *c = CallocT<GRFConfig>(1);

   192

						*c = *src;

   193

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

   194

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

   195

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

   196

						c->next = NULL;

   197

   198

						/* Append GRF config to configuration list */

   199

						*list = c;

   200

   201

						DeleteWindowByClass(WC_SAVELOAD);

   202

						InvalidateWindowData(WC_GAME_OPTIONS, 0);

   203

					}

   204

					break;

   205

   206

				case 7: // Rescan list

   207

					WP(w, newgrf_add_d).sel = NULL;

   208

					ScanNewGRFFiles();

   209

					SetWindowDirty(w);

   210

					break;

   211

			}

   212

			break;

   213

	}

   214

}

   215

   216

   217

static const Widget _newgrf_add_dlg_widgets[] = {

   218

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

   219

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

   220

   221

/* List of files */

   222

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

   223

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

   224

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

   225

   226

/* NewGRF file info */

   227

{      WWT_PANEL,     RESIZE_RTB, 14,   0, 306, 122, 224, 0x0,                     STR_NULL },

   228

   229

{ WWT_PUSHTXTBTN,     RESIZE_RTB, 14,   0, 146, 225, 236, STR_NEWGRF_ADD_FILE,     STR_NEWGRF_ADD_FILE_TIP },

   230

{ WWT_PUSHTXTBTN,    RESIZE_LRTB, 14, 147, 294, 225, 236, STR_NEWGRF_RESCAN_FILES, STR_NEWGRF_RESCAN_FILES_TIP },

   231

{  WWT_RESIZEBOX,    RESIZE_LRTB, 14, 295, 306, 225, 236, 0x0,                     STR_RESIZE_BUTTON },

   232

{   WIDGETS_END },

   233

};

   234

   235

   236

static const WindowDesc _newgrf_add_dlg_desc = {

   237

	WDP_CENTER, WDP_CENTER, 307, 237, 307, 337,

   238

	WC_SAVELOAD, WC_NONE,

   239

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   240

	_newgrf_add_dlg_widgets,

   241

	NewGRFAddDlgWndProc,

   242

};

   243

   244

   245

/* 'NewGRF Settings' dialogue */

   246

struct newgrf_d {

   247

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

   248

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

   249

	GRFConfig *sel;        ///< selected grf item

   250

	bool editable;         ///< is the window editable

   251

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

   252

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

   253

};

   254

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(newgrf_d));

   255

   256

   257

enum ShowNewGRFStateWidgets {

   258

	SNGRFS_ADD = 3,

   259

	SNGRFS_REMOVE,

   260

	SNGRFS_MOVE_UP,

   261

	SNGRFS_MOVE_DOWN,

   262

	SNGRFS_FILE_LIST = 7,

   263

	SNGRFS_NEWGRF_INFO = 9,

   264

	SNGRFS_SET_PARAMETERS,

   265

	SNGRFS_APPLY_CHANGES,

   266

};

   267

   268

   269

static void SetupNewGRFState(Window *w)

   270

{

   271

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

   272

   273

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

   274

	SetWindowWidgetsDisabledState(w, disable_all,

   275

		SNGRFS_REMOVE,

   276

		SNGRFS_MOVE_UP,

   277

		SNGRFS_MOVE_DOWN,

   278

		WIDGET_LIST_END

   279

	);

   280

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

   281

   282

	if (!disable_all) {

   283

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

   284

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

   285

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

   286

	}

   287

}

   288

   289

   290

static void SetupNewGRFWindow(Window *w)

   291

{

   292

	const GRFConfig *c;

   293

	int i;

   294

   295

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

   296

   297

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

   298

	SetVScrollCount(w, i);

   299

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

   300

}

   301

   302

   303

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

   304

 * @param w Window which is calling this callback

   305

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

   306

 */

   307

static void NewGRFConfirmationCallback(Window *w, bool confirmed)

   308

{

   309

	if (confirmed) {

   310

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

   311

		GRFConfig *c;

   312

		int i = 0;

   313

   314

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

   315

		ReloadNewGRFData();

   316

   317

		/* Show new, updated list */

   318

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

   319

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

   320

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

   321

		nd->sel = c;

   322

   323

		SetWindowDirty(w);

   324

	}

   325

}

   326

   327

   328

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

   329

{

   330

	switch (e->event) {

   331

		case WE_PAINT: {

   332

			const GRFConfig *c;

   333

			int i, y;

   334

   335

			SetupNewGRFState(w);

   336

   337

			DrawWindowWidgets(w);

   338

   339

			/* Draw NewGRF list */

   340

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

   341

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

   342

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

   343

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

   344

					SpriteID pal;

   345

   346

					/* Pick a colour */

   347

					switch (c->status) {

   348

						case GCS_NOT_FOUND:

   349

						case GCS_DISABLED:

   350

							pal = PALETTE_TO_RED;

   351

							break;

   352

						case GCS_ACTIVATED:

   353

							pal = PALETTE_TO_GREEN;

   354

							break;

   355

						default:

   356

							pal = PALETTE_TO_BLUE;

   357

							break;

   358

					}

   359

   360

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

   361

						pal = PALETTE_TO_GREY;

   362

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

   363

						pal = PALETTE_TO_ORANGE;

   364

					}

   365

   366

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

   367

					if (c->error != NULL) DrawSprite(SPR_WARNING_SIGN, 0, 20, y + 2);

   368

					DoDrawString(text, c->error != NULL ? 35 : 25, y + 3, WP(w, newgrf_d).sel == c ? 0xC : 0x10);

   369

					y += 14;

   370

				}

   371

			}

   372

   373

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

   374

				/* Draw NewGRF file info */

   375

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

   376

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

   377

			}

   378

   379

			break;

   380

		}

   381

   382

		case WE_INVALIDATE_DATA:

   383

			SetupNewGRFWindow(w);

   384

			break;

   385

   386

		case WE_CLICK:

   387

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

   388

				case SNGRFS_ADD: { // Add GRF

   389

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

   390

					Window *w;

   391

   392

					DeleteWindowByClass(WC_SAVELOAD);

   393

					w = AllocateWindowDesc(&_newgrf_add_dlg_desc);

   394

					w->resize.step_height = 10;

   395

   396

					WP(w, newgrf_add_d).list = list;

   397

					break;

   398

				}

   399

   400

				case SNGRFS_REMOVE: { // Remove GRF

   401

					GRFConfig **pc, *c, *newsel;

   402

   403

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

   404

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

   405

   406

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

   407

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

   408

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

   409

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

   410

   411

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

   412

							*pc = c->next;

   413

							free(c);

   414

							break;

   415

						}

   416

					}

   417

   418

					WP(w, newgrf_d).sel = newsel;

   419

					SetupNewGRFWindow(w);

   420

					SetWindowDirty(w);

   421

					break;

   422

				}

   423

   424

				case SNGRFS_MOVE_UP: { // Move GRF up

   425

					GRFConfig **pc, *c;

   426

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

   427

   428

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

   429

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

   430

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

   431

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

   432

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

   433

							break;

   434

						}

   435

					}

   436

					SetWindowDirty(w);

   437

					break;

   438

				}

   439

   440

				case SNGRFS_MOVE_DOWN: { // Move GRF down

   441

					GRFConfig **pc, *c;

   442

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

   443

   444

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

   445

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

   446

							*pc = c->next;

   447

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

   448

							(*pc)->next = c;

   449

							break;

   450

						}

   451

					}

   452

					SetWindowDirty(w);

   453

					break;

   454

				}

   455

   456

				case SNGRFS_FILE_LIST: { // Select a GRF

   457

					GRFConfig *c;

   458

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

   459

   460

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

   461

					WP(w, newgrf_d).sel = c;

   462

   463

					SetWindowDirty(w);

   464

					break;

   465

				}

   466

   467

				case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   468

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

   469

						ShowQuery(

   470

							STR_POPUP_CAUTION_CAPTION,

   471

							STR_NEWGRF_CONFIRMATION_TEXT,

   472

							w,

   473

							NewGRFConfirmationCallback

   474

						);

   475

					} else {

   476

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

   477

						ResetGRFConfig(false);

   478

						ReloadNewGRFData();

   479

					}

   480

					break;

   481

   482

				case SNGRFS_SET_PARAMETERS: { // Edit parameters

   483

					char buff[512];

   484

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

   485

   486

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

   487

					ShowQueryString(BindCString(buff), STR_NEWGRF_PARAMETER_QUERY, 63, 250, w, CS_ALPHANUMERAL);

   488

					break;

   489

				}

   490

			}

   491

			break;

   492

   493

		case WE_ON_EDIT_TEXT:

   494

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

   495

				/* Parse our new "int list" */

   496

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

   497

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

   498

   499

				/* parse_intlist returns -1 on error */

   500

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

   501

			}

   502

			SetWindowDirty(w);

   503

			break;

   504

   505

		case WE_DESTROY: