1

/* $Id$ */

     2

     3

/** @file newgrf_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "variables.h"

     8

#include "gui.h"

     9

#include "window_gui.h"

    10

#include "textbuf_gui.h"

    11

#include "newgrf.h"

    12

#include "newgrf_config.h"

    13

#include "strings_func.h"

    14

#include "window_func.h"

    15

#include "core/alloc_func.hpp"

    16

#include "string_func.h"

    17

#include "gfx_func.h"

    18

    19

#include "table/strings.h"

    20

#include "table/sprites.h"

    21

    22

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

    23

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

    24

 * comma or a space character

    25

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

    26

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

    27

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

    28

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

    29

{

    30

	int n = 0, v;

    31

	char *end;

    32

    33

	for (;;) {

    34

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

    35

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

    36

		p = end;

    37

		items[n++] = v;

    38

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

    39

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

    40

		p++;

    41

	}

    42

    43

	return n;

    44

}

    45

    46

    47

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

    48

{

    49

	char buff[256];

    50

    51

	if (c->error != NULL) {

    52

		SetDParamStr(0, c->filename);

    53

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

    54

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

    55

			uint32 param = 0;

    56

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

    57

    58

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

    59

    60

			SetDParam(2 + i, param);

    61

		}

    62

    63

		char message[512];

    64

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

    65

    66

		SetDParamStr(0, message);

    67

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

    68

	}

    69

    70

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

    71

	if (c->filename != NULL) {

    72

		SetDParamStr(0, c->filename);

    73

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

    74

	}

    75

    76

	/* Prepare and draw GRF ID */

    77

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

    78

	SetDParamStr(0, buff);

    79

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

    80

    81

	/* Prepare and draw MD5 sum */

    82

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

    83

	SetDParamStr(0, buff);

    84

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

    85

    86

	/* Show GRF parameter list */

    87

	if (show_params) {

    88

		if (c->num_params > 0) {

    89

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

    90

			SetDParamStr(0, buff);

    91

		} else {

    92

			SetDParam(0, STR_01A9_NONE);

    93

		}

    94

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

    95

	}

    96

    97

	/* Show flags */

    98

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

    99

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

   100

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

   101

   102

	/* Draw GRF info if it exists */

   103

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

   104

		SetDParamStr(0, c->info);

   105

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

   106

	} else {

   107

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

   108

	}

   109

}

   110

   111

   112

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

   113

struct newgrf_add_d {

   114

	GRFConfig **list;

   115

	const GRFConfig *sel;

   116

};

   117

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(newgrf_add_d));

   118

   119

/* Names of the add a newgrf window widgets */

   120

enum AddNewGRFWindowWidgets {

   121

	ANGRFW_CLOSEBOX = 0,

   122

	ANGRFW_CAPTION,

   123

	ANGRFW_BACKGROUND,

   124

	ANGRFW_GRF_LIST,

   125

	ANGRFW_SCROLLBAR,

   126

	ANGRFW_GRF_INFO,

   127

	ANGRFW_ADD,

   128

	ANGRFW_RESCAN,

   129

	ANGRFW_RESIZE,

   130

};

   131

   132

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

   133

{

   134

	switch (e->event) {

   135

		case WE_PAINT: {

   136

			const GRFConfig *c;

   137

			const Widget *wl = &w->widget[ANGRFW_GRF_LIST];

   138

			int n = 0;

   139

   140

			/* Count the number of GRFs */

   141

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

   142

   143

			w->vscroll.cap = (wl->bottom - wl->top) / 10;

   144

			SetVScrollCount(w, n);

   145

   146

			w->SetWidgetDisabledState(ANGRFW_ADD, WP(w, newgrf_add_d).sel == NULL || WP(w, newgrf_add_d).sel->IsOpenTTDBaseGRF());

   147

			DrawWindowWidgets(w);

   148

   149

			GfxFillRect(wl->left + 1, wl->top + 1, wl->right, wl->bottom, 0xD7);

   150

   151

			uint y = wl->top + 1;

   152

			for (c = _all_grfs, n = 0; c != NULL && n < (w->vscroll.pos + w->vscroll.cap); c = c->next, n++) {

   153

				if (n >= w->vscroll.pos) {

   154

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

   155

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

   156

   157

					/* Draw selection background */

   158

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

   159

					DoDrawStringTruncated(text, 4, y, h ? TC_WHITE : TC_ORANGE, w->width - 18);

   160

					y += 10;

   161

				}

   162

			}

   163

   164

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

   165

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

   166

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

   167

			}

   168

			break;

   169

		}

   170

   171

		case WE_DOUBLE_CLICK:

   172

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

   173

			e->we.click.widget = ANGRFW_ADD;

   174

			/* Fall through */

   175

   176

		case WE_CLICK:

   177

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

   178

				case ANGRFW_GRF_LIST: {

   179

					/* Get row... */

   180

					const GRFConfig *c;

   181

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

   182

   183

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

   184

					WP(w, newgrf_add_d).sel = c;

   185

					SetWindowDirty(w);

   186

					break;

   187

				}

   188

   189

				case ANGRFW_ADD: // Add selection to list

   190

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

   191

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

   192

						GRFConfig **list;

   193

   194

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

   195

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

   196

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

   197

								ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   198

								return;

   199

							}

   200

						}

   201

   202

						/* Copy GRF details from scanned list */

   203

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

   204

						*c = *src;

   205

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

   206

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

   207

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

   208

						c->next = NULL;

   209

   210

						/* Append GRF config to configuration list */

   211

						*list = c;

   212

   213

						DeleteWindowByClass(WC_SAVELOAD);

   214

						InvalidateWindowData(WC_GAME_OPTIONS, 0);

   215

					}

   216

					break;

   217

   218

				case ANGRFW_RESCAN: // Rescan list

   219

					WP(w, newgrf_add_d).sel = NULL;

   220

					ScanNewGRFFiles();

   221

					SetWindowDirty(w);

   222

					break;

   223

			}

   224

			break;

   225

	}

   226

}

   227

   228

/* Widget definition for the add a newgrf window */

   229

static const Widget _newgrf_add_dlg_widgets[] = {

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

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

   239

{   WIDGETS_END },

   240

};

   241

   242

/* Window definition for the add a newgrf window */

   243

static const WindowDesc _newgrf_add_dlg_desc = {

   244

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

   245

	WC_SAVELOAD, WC_NONE,

   246

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   247

	_newgrf_add_dlg_widgets,

   248

	NewGRFAddDlgWndProc,

   249

};

   250

   251

   252

/* 'NewGRF Settings' dialogue */

   253

struct newgrf_d {

   254

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

   255

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

   256

	GRFConfig *sel;        ///< selected grf item

   257

	bool editable;         ///< is the window editable

   258

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

   259

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

   260

};

   261

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(newgrf_d));

   262

   263

   264

/* Names of the manage newgrfs window widgets */

   265

enum ShowNewGRFStateWidgets {

   266

	SNGRFS_CLOSEBOX = 0,

   267

	SNGRFS_CAPTION,

   268

	SNGRFS_BACKGROUND,

   269

	SNGRFS_ADD,

   270

	SNGRFS_REMOVE,

   271

	SNGRFS_MOVE_UP,

   272

	SNGRFS_MOVE_DOWN,

   273

	SNGRFS_FILE_LIST,

   274

	SNGRFS_SCROLLBAR,

   275

	SNGRFS_NEWGRF_INFO,

   276

	SNGRFS_SET_PARAMETERS,

   277

	SNGRFS_APPLY_CHANGES,

   278

	SNGRFS_RESIZE,

   279

};

   280

   281

static void SetupNewGRFState(Window *w)

   282

{

   283

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

   284

   285

	w->SetWidgetDisabledState(SNGRFS_ADD, !WP(w, newgrf_d).editable);

   286

	w->SetWidgetsDisabledState(disable_all,

   287

		SNGRFS_REMOVE,

   288

		SNGRFS_MOVE_UP,

   289

		SNGRFS_MOVE_DOWN,

   290

		WIDGET_LIST_END

   291

	);

   292

	w->SetWidgetDisabledState(SNGRFS_SET_PARAMETERS, !WP(w, newgrf_d).show_params || disable_all);

   293

   294

	if (!disable_all) {

   295

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

   296

		if (WP(w, newgrf_d).sel == *WP(w, newgrf_d).list) w->DisableWidget(SNGRFS_MOVE_UP);

   297

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

   298

		if (WP(w, newgrf_d).sel->IsOpenTTDBaseGRF()) w->DisableWidget(SNGRFS_REMOVE);

   299

	}

   300

}

   301

   302

   303

static void SetupNewGRFWindow(Window *w)

   304

{

   305

	const GRFConfig *c;

   306

	int i;

   307

   308

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

   309

   310

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

   311

	SetVScrollCount(w, i);

   312

	w->SetWidgetDisabledState(SNGRFS_APPLY_CHANGES, !WP(w, newgrf_d).editable);

   313

}

   314

   315

   316

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

   317

 * @param w Window which is calling this callback

   318

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

   319

 */

   320

static void NewGRFConfirmationCallback(Window *w, bool confirmed)

   321

{

   322

	if (confirmed) {

   323

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

   324

		GRFConfig *c;

   325

		int i = 0;

   326

   327

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

   328

		ReloadNewGRFData();

   329

   330

		/* Show new, updated list */

   331

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

   332

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

   333

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

   334

		nd->sel = c;

   335

   336

		SetWindowDirty(w);

   337

	}

   338

}

   339

   340

   341

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

   342

{

   343

	switch (e->event) {

   344

		case WE_PAINT: {

   345

			const GRFConfig *c;

   346

			int i, y;

   347

   348

			SetupNewGRFState(w);

   349

   350

			DrawWindowWidgets(w);

   351

   352

			/* Draw NewGRF list */

   353

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

   354

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

   355

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

   356

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

   357

					SpriteID pal;

   358

					byte txtoffset;

   359

   360

					/* Pick a colour */

   361

					switch (c->status) {

   362

						case GCS_NOT_FOUND:

   363

						case GCS_DISABLED:

   364

							pal = PALETTE_TO_RED;

   365

							break;

   366

						case GCS_ACTIVATED:

   367

							pal = PALETTE_TO_GREEN;

   368

							break;

   369

						default:

   370

							pal = PALETTE_TO_BLUE;

   371

							break;

   372

					}

   373

   374

					/* Do not show a "not-failure" colour when it actually failed to load */

   375

					if (pal != PALETTE_TO_RED) {

   376

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

   377

							pal = PALETTE_TO_GREY;

   378

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

   379

							pal = PALETTE_TO_ORANGE;

   380

						}

   381

					}

   382

   383

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

   384

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

   385

					txtoffset = c->error != NULL ? 35 : 25;

   386

					DoDrawStringTruncated(text, txtoffset, y + 3, WP(w, newgrf_d).sel == c ? TC_WHITE : TC_BLACK, w->width - txtoffset - 10);

   387

					y += 14;

   388

				}

   389

			}

   390

   391

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

   392

				/* Draw NewGRF file info */

   393

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

   394

				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);

   395

			}

   396

   397

			break;

   398

		}

   399

   400

		case WE_INVALIDATE_DATA:

   401

			SetupNewGRFWindow(w);

   402

			break;

   403

   404

		case WE_CLICK:

   405

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

   406

				case SNGRFS_ADD: { // Add GRF

   407

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

   408

					Window *w;

   409

   410

					DeleteWindowByClass(WC_SAVELOAD);

   411

					w = AllocateWindowDesc(&_newgrf_add_dlg_desc);

   412

					w->resize.step_height = 10;

   413

   414

					WP(w, newgrf_add_d).list = list;

   415

					break;

   416

				}

   417

   418

				case SNGRFS_REMOVE: { // Remove GRF

   419

					GRFConfig **pc, *c, *newsel;

   420

   421

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

   422

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

   423

   424

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

   425

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

   426

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

   427

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

   428

   429

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

   430

							*pc = c->next;

   431

							free(c);

   432

							break;

   433

						}

   434

					}

   435

   436

					WP(w, newgrf_d).sel = newsel;

   437

					SetupNewGRFWindow(w);

   438

					SetWindowDirty(w);

   439

					break;

   440

				}

   441

   442

				case SNGRFS_MOVE_UP: { // Move GRF up

   443

					GRFConfig **pc, *c;

   444

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

   445

   446

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

   447

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

   448

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

   449

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

   450

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

   451

							break;

   452

						}

   453

					}

   454

					SetWindowDirty(w);

   455

					break;

   456

				}

   457

   458

				case SNGRFS_MOVE_DOWN: { // Move GRF down

   459

					GRFConfig **pc, *c;

   460

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

   461

   462

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

   463

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

   464

							*pc = c->next;

   465

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

   466

							(*pc)->next = c;

   467

							break;

   468

						}

   469

					}

   470

					SetWindowDirty(w);

   471

					break;

   472

				}

   473

   474

				case SNGRFS_FILE_LIST: { // Select a GRF

   475

					GRFConfig *c;

   476

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

   477

   478

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

   479

					WP(w, newgrf_d).sel = c;

   480

   481

					SetWindowDirty(w);

   482

					break;

   483

				}

   484

   485

				case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   486

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

   487

						ShowQuery(

   488

							STR_POPUP_CAUTION_CAPTION,

   489

							STR_NEWGRF_CONFIRMATION_TEXT,

   490

							w,

   491

							NewGRFConfirmationCallback

   492

						);

   493

					} else {

   494

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

   495

						ResetGRFConfig(false);

   496

						ReloadNewGRFData();

   497

					}

   498

					break;

   499