1

/* $Id$ */

     2

     3

/** @file newgrf_gui.cpp GUI to change NewGRF settings. */

     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

#include "gamelog.h"

    19

    20

#include "table/strings.h"

    21

#include "table/sprites.h"

    22

    23

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

    24

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

    25

 * comma or a space character

    26

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

    27

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

    28

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

    29

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

    30

{

    31

	int n = 0, v;

    32

	char *end;

    33

    34

	for (;;) {

    35

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

    36

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

    37

		p = end;

    38

		items[n++] = v;

    39

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

    40

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

    41

		p++;

    42

	}

    43

    44

	return n;

    45

}

    46

    47

    48

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

    49

{

    50

	char buff[256];

    51

    52

	if (c->error != NULL) {

    53

		SetDParamStr(0, c->filename);

    54

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

    55

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

    56

			uint32 param = 0;

    57

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

    58

    59

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

    60

    61

			SetDParam(2 + i, param);

    62

		}

    63

    64

		char message[512];

    65

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

    66

    67

		SetDParamStr(0, message);

    68

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

    69

	}

    70

    71

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

    72

	if (c->filename != NULL) {

    73

		SetDParamStr(0, c->filename);

    74

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

    75

	}

    76

    77

	/* Prepare and draw GRF ID */

    78

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

    79

	SetDParamStr(0, buff);

    80

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

    81

    82

	/* Prepare and draw MD5 sum */

    83

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

    84

	SetDParamStr(0, buff);

    85

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

    86

    87

	/* Show GRF parameter list */

    88

	if (show_params) {

    89

		if (c->num_params > 0) {

    90

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

    91

			SetDParamStr(0, buff);

    92

		} else {

    93

			SetDParam(0, STR_01A9_NONE);

    94

		}

    95

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

    96

	}

    97

    98

	/* Show flags */

    99

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

   100

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

   101

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

   102

   103

	/* Draw GRF info if it exists */

   104

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

   105

		SetDParamStr(0, c->info);

   106

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

   107

	} else {

   108

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

   109

	}

   110

}

   111

   112

   113

/**

   114

 * Window for adding NewGRF files

   115

 */

   116

struct NewGRFAddWindow : public Window {

   117

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

   118

	enum AddNewGRFWindowWidgets {

   119

		ANGRFW_CLOSEBOX = 0,

   120

		ANGRFW_CAPTION,

   121

		ANGRFW_BACKGROUND,

   122

		ANGRFW_GRF_LIST,

   123

		ANGRFW_SCROLLBAR,

   124

		ANGRFW_GRF_INFO,

   125

		ANGRFW_ADD,

   126

		ANGRFW_RESCAN,

   127

		ANGRFW_RESIZE,

   128

	};

   129

   130

	GRFConfig **list;

   131

	const GRFConfig *sel;

   132

   133

	NewGRFAddWindow(const WindowDesc *desc, GRFConfig **list) : Window(desc, 0)

   134

	{

   135

		this->list = list;

   136

		this->resize.step_height = 10;

   137

   138

		this->FindWindowPlacementAndResize(desc);

   139

	}

   140

   141

	virtual void OnPaint()

   142

	{

   143

		const GRFConfig *c;

   144

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

   145

		int n = 0;

   146

   147

		/* Count the number of GRFs */

   148

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

   149

   150

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

   151

		SetVScrollCount(this, n);

   152

   153

		this->SetWidgetDisabledState(ANGRFW_ADD, this->sel == NULL || this->sel->IsOpenTTDBaseGRF());

   154

		this->DrawWidgets();

   155

   156

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

   157

   158

		uint y = wl->top + 1;

   159

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

   160

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

   161

				bool h = c == this->sel;

   162

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

   163

   164

				/* Draw selection background */

   165

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

   166

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

   167

				y += 10;

   168

			}

   169

		}

   170

   171

		if (this->sel != NULL) {

   172

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

   173

			ShowNewGRFInfo(this->sel, wi->left + 2, wi->top + 2, wi->right - wi->left - 2, wi->bottom, false);

   174

		}

   175

	}

   176

   177

	virtual void OnDoubleClick(Point pt, int widget)

   178

	{

   179

		if (widget == ANGRFW_GRF_LIST) this->OnClick(pt, ANGRFW_ADD);

   180

	}

   181

   182

	virtual void OnClick(Point pt, int widget)

   183

	{

   184

		switch (widget) {

   185

			case ANGRFW_GRF_LIST: {

   186

				/* Get row... */

   187

				const GRFConfig *c;

   188

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

   189

   190

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

   191

				this->sel = c;

   192

				this->SetDirty();

   193

				break;

   194

			}

   195

   196

			case ANGRFW_ADD: // Add selection to list

   197

				if (this->sel != NULL) {

   198

					const GRFConfig *src = this->sel;

   199

					GRFConfig **list;

   200

   201

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

   202

					for (list = this->list; *list != NULL; list = &(*list)->next) {

   203

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

   204

							ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   205

							return;

   206

						}

   207

					}

   208

   209

					/* Copy GRF details from scanned list */

   210

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

   211

					*c = *src;

   212

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

   213

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

   214

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

   215

					c->next = NULL;

   216

   217

					/* Append GRF config to configuration list */

   218

					*list = c;

   219

   220

					DeleteWindowByClass(WC_SAVELOAD);

   221

					InvalidateWindowData(WC_GAME_OPTIONS, 0);

   222

				}

   223

				break;

   224

   225

			case ANGRFW_RESCAN: // Rescan list

   226

				this->sel = NULL;

   227

				ScanNewGRFFiles();

   228

				this->SetDirty();

   229

				break;

   230

		}

   231

	}

   232

};

   233

   234

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

   235

static const Widget _newgrf_add_dlg_widgets[] = {

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

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

   245

{   WIDGETS_END },

   246

};

   247

   248

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

   249

static const WindowDesc _newgrf_add_dlg_desc = {

   250

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

   251

	WC_SAVELOAD, WC_NONE,

   252

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   253

	_newgrf_add_dlg_widgets,

   254

};

   255

   256

   257

static void NewGRFConfirmationCallback(Window *w, bool confirmed);

   258

   259

/**

   260

 * Window for showing NewGRF files

   261

 */

   262

struct NewGRFWindow : public Window {

   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

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

   281

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

   282

	GRFConfig *sel;        ///< selected grf item

   283

	bool editable;         ///< is the window editable

   284

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

   285

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

   286

   287

	NewGRFWindow(const WindowDesc *desc, bool editable, bool show_params, bool exec_changes, GRFConfig **config) : Window(desc, 0)

   288

	{

   289

		this->resize.step_height = 14;

   290

		this->sel         = NULL;

   291

		this->list        = NULL;

   292

		this->orig_list   = config;

   293

		this->editable    = editable;

   294

		this->execute     = exec_changes;

   295

		this->show_params = show_params;

   296

   297

		CopyGRFConfigList(&this->list, *config, false);

   298

   299

		this->FindWindowPlacementAndResize(desc);

   300

		this->SetupNewGRFWindow();

   301

	}

   302

   303

	~NewGRFWindow()

   304

	{

   305

		if (!this->execute) {

   306

			CopyGRFConfigList(this->orig_list, this->list, true);

   307

			ResetGRFConfig(false);

   308

			ReloadNewGRFData();

   309

		}

   310

   311

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

   312

		ClearGRFConfigList(&this->list);

   313

	}

   314

   315

	void SetupNewGRFWindow()

   316

	{

   317

		const GRFConfig *c;

   318

		int i;

   319

   320

		for (c = this->list, i = 0; c != NULL; c = c->next, i++) {}

   321

   322

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

   323

		SetVScrollCount(this, i);

   324

   325

		this->SetWidgetDisabledState(SNGRFS_ADD, !this->editable);

   326

		this->SetWidgetDisabledState(SNGRFS_APPLY_CHANGES, !this->editable);

   327

	}

   328

   329

	virtual void OnPaint()

   330

	{

   331

		bool disable_all = this->sel == NULL || !this->editable;

   332

   333

		this->SetWidgetsDisabledState(disable_all,

   334

			SNGRFS_REMOVE,

   335

			SNGRFS_MOVE_UP,

   336

			SNGRFS_MOVE_DOWN,

   337

			WIDGET_LIST_END

   338

		);

   339

		this->SetWidgetDisabledState(SNGRFS_SET_PARAMETERS, !this->show_params || disable_all);

   340

   341

		if (!disable_all) {

   342

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

   343

			if (this->sel == this->list)       this->DisableWidget(SNGRFS_MOVE_UP);

   344

			if (this->sel->next == NULL)       this->DisableWidget(SNGRFS_MOVE_DOWN);

   345

			if (this->sel->IsOpenTTDBaseGRF()) this->DisableWidget(SNGRFS_REMOVE);

   346

		}

   347

   348

		this->DrawWidgets();

   349

   350

		/* Draw NewGRF list */

   351

		int y = this->widget[SNGRFS_FILE_LIST].top;

   352

		int i = 0;

   353

		for (const GRFConfig *c = this->list; c != NULL; c = c->next, i++) {

   354

			if (i >= this->vscroll.pos && i < this->vscroll.pos + this->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, this->sel == c ? TC_WHITE : TC_BLACK, this->width - txtoffset - 10);

   386

				y += 14;

   387

			}

   388

		}

   389

   390

		if (this->sel != NULL) {

   391

			/* Draw NewGRF file info */

   392

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

   393

			ShowNewGRFInfo(this->sel, wi->left + 2, wi->top + 2, wi->right - wi->left - 2, wi->bottom, this->show_params);

   394

		}

   395

	}

   396

   397

	virtual void OnClick(Point pt, int widget)

   398

	{

   399

		switch (widget) {

   400

			case SNGRFS_ADD: // Add GRF

   401

				DeleteWindowByClass(WC_SAVELOAD);

   402

				new NewGRFAddWindow(&_newgrf_add_dlg_desc, &this->list);

   403

				break;

   404

   405

			case SNGRFS_REMOVE: { // Remove GRF

   406

				GRFConfig **pc, *c, *newsel;

   407

   408

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

   409

				newsel = this->sel->next;

   410

   411

				for (pc = &this->list; (c = *pc) != NULL; pc = &c->next) {

   412

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

   413

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

   414

					if (newsel == NULL && c->next == this->sel) newsel = c;

   415

   416

					if (c == this->sel) {

   417

						*pc = c->next;

   418

						free(c);

   419

						break;

   420

					}

   421

				}

   422

   423

				this->sel = newsel;

   424

				this->SetupNewGRFWindow();

   425

				this->SetDirty();

   426

				break;

   427

			}

   428

   429

			case SNGRFS_MOVE_UP: { // Move GRF up

   430

				GRFConfig **pc, *c;

   431

				if (this->sel == NULL) break;

   432

   433

				for (pc = &this->list; (c = *pc) != NULL; pc = &c->next) {

   434

					if (c->next == this->sel) {

   435

						c->next = this->sel->next;

   436

						this->sel->next = c;

   437

						*pc = this->sel;

   438

						break;

   439

					}

   440

				}

   441

				this->SetDirty();

   442

				break;

   443

			}

   444

   445

			case SNGRFS_MOVE_DOWN: { // Move GRF down

   446

				GRFConfig **pc, *c;

   447

				if (this->sel == NULL) break;

   448

   449

				for (pc = &this->list; (c = *pc) != NULL; pc = &c->next) {

   450

					if (c == this->sel) {

   451

						*pc = c->next;

   452

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

   453

						(*pc)->next = c;

   454

						break;

   455

					}

   456

				}

   457

				this->SetDirty();

   458

				break;

   459

			}

   460

   461

			case SNGRFS_FILE_LIST: { // Select a GRF

   462

				GRFConfig *c;

   463

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

   464

   465

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

   466

				this->sel = c;

   467

   468

				this->SetDirty();

   469

				break;

   470

			}

   471

   472

			case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   473

				if (this->execute) {

   474

					ShowQuery(

   475

						STR_POPUP_CAUTION_CAPTION,

   476

						STR_NEWGRF_CONFIRMATION_TEXT,

   477

						this,

   478

						NewGRFConfirmationCallback

   479

					);

   480

				} else {

   481

					CopyGRFConfigList(this->orig_list, this->list, true);

   482

					ResetGRFConfig(false);

   483

					ReloadNewGRFData();

   484

				}

   485

				break;

   486

   487

			case SNGRFS_SET_PARAMETERS: { // Edit parameters

   488

				if (this->sel == NULL) break;

   489

   490

				char buff[512];

   491

				GRFBuildParamList(buff, this->sel, lastof(buff));

   492

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

   493

				break;

   494

			}

   495

		}