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

    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

   118

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

   119

enum AddNewGRFWindowWidgets {

   120

	ANGRFW_CLOSEBOX = 0,

   121

	ANGRFW_CAPTION,

   122

	ANGRFW_BACKGROUND,

   123

	ANGRFW_GRF_LIST,

   124

	ANGRFW_SCROLLBAR,

   125

	ANGRFW_GRF_INFO,

   126

	ANGRFW_ADD,

   127

	ANGRFW_RESCAN,

   128

	ANGRFW_RESIZE,

   129

};

   130

   131

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

   132

{

   133

	switch (e->event) {

   134

		case WE_PAINT: {

   135

			const GRFConfig *c;

   136

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

   137

			int n = 0;

   138

   139

			/* Count the number of GRFs */

   140

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

   141

   142

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

   143

			SetVScrollCount(w, n);

   144

   145

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

   146

			DrawWindowWidgets(w);

   147

   148

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

   149

   150

			uint y = wl->top + 1;

   151

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

   152

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

   153

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

   154

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

   155

   156

					/* Draw selection background */

   157

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

   158

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

   159

					y += 10;

   160

				}

   161

			}

   162

   163

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

   164

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

   165

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

   166

			}

   167

			break;

   168

		}

   169

   170

		case WE_DOUBLE_CLICK:

   171

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

   172

			e->we.click.widget = ANGRFW_ADD;

   173

			/* Fall through */

   174

   175

		case WE_CLICK:

   176

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

   177

				case ANGRFW_GRF_LIST: {

   178

					/* Get row... */

   179

					const GRFConfig *c;

   180

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

   181

   182

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

   183

					WP(w, newgrf_add_d).sel = c;

   184

					SetWindowDirty(w);

   185

					break;

   186

				}

   187

   188

				case ANGRFW_ADD: // Add selection to list

   189

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

   190

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

   191

						GRFConfig **list;

   192

   193

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

   194

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

   195

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

   196

								ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   197

								return;

   198

							}

   199

						}

   200

   201

						/* Copy GRF details from scanned list */

   202

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

   203

						*c = *src;

   204

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

   205

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

   206

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

   207

						c->next = NULL;

   208

   209

						/* Append GRF config to configuration list */

   210

						*list = c;

   211

   212

						DeleteWindowByClass(WC_SAVELOAD);

   213

						InvalidateWindowData(WC_GAME_OPTIONS, 0);

   214

					}

   215

					break;

   216

   217

				case ANGRFW_RESCAN: // Rescan list

   218

					WP(w, newgrf_add_d).sel = NULL;

   219

					ScanNewGRFFiles();

   220

					SetWindowDirty(w);

   221

					break;

   222

			}

   223

			break;

   224

	}

   225

}

   226

   227

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

   228

static const Widget _newgrf_add_dlg_widgets[] = {

   229

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

   230

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

   231

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

   232

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

   233

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

   234

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

   235

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

   236

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

   237

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

   238

{   WIDGETS_END },

   239

};

   240

   241

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

   242

static const WindowDesc _newgrf_add_dlg_desc = {

   243

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

   244

	WC_SAVELOAD, WC_NONE,

   245

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   246

	_newgrf_add_dlg_widgets,

   247

	NewGRFAddDlgWndProc,

   248

};

   249

   250

   251

/* 'NewGRF Settings' dialogue */

   252

struct newgrf_d {

   253

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

   254

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

   255

	GRFConfig *sel;        ///< selected grf item

   256

	bool editable;         ///< is the window editable

   257

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

   258

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

   259

};

   260

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(newgrf_d));

   261

   262

   263

/* Names of the manage newgrfs window widgets */

   264

enum ShowNewGRFStateWidgets {

   265

	SNGRFS_CLOSEBOX = 0,

   266

	SNGRFS_CAPTION,

   267

	SNGRFS_BACKGROUND,

   268

	SNGRFS_ADD,

   269

	SNGRFS_REMOVE,

   270

	SNGRFS_MOVE_UP,

   271

	SNGRFS_MOVE_DOWN,

   272

	SNGRFS_FILE_LIST,

   273

	SNGRFS_SCROLLBAR,

   274

	SNGRFS_NEWGRF_INFO,

   275

	SNGRFS_SET_PARAMETERS,

   276

	SNGRFS_APPLY_CHANGES,

   277

	SNGRFS_RESIZE,

   278

};

   279

   280

static void SetupNewGRFState(Window *w)

   281

{

   282

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

   283

   284

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

   285

	w->SetWidgetsDisabledState(disable_all,

   286

		SNGRFS_REMOVE,

   287

		SNGRFS_MOVE_UP,

   288

		SNGRFS_MOVE_DOWN,

   289

		WIDGET_LIST_END

   290

	);

   291

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

   292

   293

	if (!disable_all) {

   294

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

   295

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

   296

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

   297

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

   298

	}

   299

}

   300

   301

   302

static void SetupNewGRFWindow(Window *w)

   303

{

   304

	const GRFConfig *c;

   305

	int i;

   306

   307

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

   308

   309

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

   310

	SetVScrollCount(w, i);

   311

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

   312

}

   313

   314

   315

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

   316

 * @param w Window which is calling this callback

   317

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

   318

 */

   319

static void NewGRFConfirmationCallback(Window *w, bool confirmed)

   320

{

   321

	if (confirmed) {

   322

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

   323

		GRFConfig *c;

   324

		int i = 0;

   325

   326

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

   327

		ReloadNewGRFData();

   328

   329

		/* Show new, updated list */

   330

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

   331

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

   332

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

   333

		nd->sel = c;

   334

   335

		SetWindowDirty(w);

   336

	}

   337

}

   338

   339

   340

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

   341

{

   342

	switch (e->event) {

   343

		case WE_PAINT: {

   344

			const GRFConfig *c;

   345

			int i, y;

   346

   347

			SetupNewGRFState(w);

   348

   349

			DrawWindowWidgets(w);

   350

   351

			/* Draw NewGRF list */

   352

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

   353

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

   354

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

   355

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

   356

					SpriteID pal;

   357

					byte txtoffset;

   358

   359

					/* Pick a colour */

   360

					switch (c->status) {

   361

						case GCS_NOT_FOUND:

   362

						case GCS_DISABLED:

   363

							pal = PALETTE_TO_RED;

   364

							break;

   365

						case GCS_ACTIVATED:

   366

							pal = PALETTE_TO_GREEN;

   367

							break;

   368

						default:

   369

							pal = PALETTE_TO_BLUE;

   370

							break;

   371

					}

   372

   373

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

   374

					if (pal != PALETTE_TO_RED) {

   375

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

   376

							pal = PALETTE_TO_GREY;

   377

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

   378

							pal = PALETTE_TO_ORANGE;

   379

						}

   380

					}

   381

   382

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

   383

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

   384

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

   385

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

   386

					y += 14;

   387

				}

   388

			}

   389

   390

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

   391

				/* Draw NewGRF file info */

   392

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

   393

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

   394

			}

   395

   396

			break;

   397

		}

   398

   399

		case WE_INVALIDATE_DATA:

   400

			SetupNewGRFWindow(w);

   401

			break;

   402

   403

		case WE_CLICK:

   404

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

   405

				case SNGRFS_ADD: { // Add GRF

   406

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

   407

					Window *w;

   408

   409

					DeleteWindowByClass(WC_SAVELOAD);

   410

					w = AllocateWindowDesc(&_newgrf_add_dlg_desc);

   411

					w->resize.step_height = 10;

   412

   413

					WP(w, newgrf_add_d).list = list;

   414

					break;

   415

				}

   416

   417

				case SNGRFS_REMOVE: { // Remove GRF

   418

					GRFConfig **pc, *c, *newsel;

   419

   420

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

   421

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

   422

   423

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

   424

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

   425

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

   426

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

   427

   428

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

   429

							*pc = c->next;

   430

							free(c);

   431

							break;

   432

						}

   433

					}

   434

   435

					WP(w, newgrf_d).sel = newsel;

   436

					SetupNewGRFWindow(w);

   437

					SetWindowDirty(w);

   438

					break;

   439

				}

   440

   441

				case SNGRFS_MOVE_UP: { // Move GRF up

   442

					GRFConfig **pc, *c;

   443

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

   444

   445

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

   446

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

   447

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

   448

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

   449

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

   450

							break;

   451

						}

   452

					}

   453

					SetWindowDirty(w);

   454

					break;

   455

				}

   456

   457

				case SNGRFS_MOVE_DOWN: { // Move GRF down

   458

					GRFConfig **pc, *c;

   459

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

   460

   461

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

   462

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

   463

							*pc = c->next;

   464

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

   465

							(*pc)->next = c;

   466

							break;

   467

						}

   468

					}

   469

					SetWindowDirty(w);

   470

					break;

   471

				}

   472

   473

				case SNGRFS_FILE_LIST: { // Select a GRF

   474

					GRFConfig *c;

   475

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

   476

   477

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

   478

					WP(w, newgrf_d).sel = c;

   479

   480

					SetWindowDirty(w);

   481

					break;

   482

				}

   483

   484

				case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   485

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

   486

						ShowQuery(

   487

							STR_POPUP_CAUTION_CAPTION,

   488

							STR_NEWGRF_CONFIRMATION_TEXT,

   489

							w,

   490

							NewGRFConfirmationCallback

   491

						);

   492

					} else {

   493

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

   494

						ResetGRFConfig(false);

   495

						ReloadNewGRFData();

   496

					}

   497

					break;

   498

   499

				case SNGRFS_SET_PARAMETERS: { // Edit parameters

   500

					char buff[512];