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

    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

/**

   113

 * Window for adding NewGRF files

   114

 */

   115

struct NewGRFAddWindow : public Window {

   116

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

   117

	enum AddNewGRFWindowWidgets {

   118

		ANGRFW_CLOSEBOX = 0,

   119

		ANGRFW_CAPTION,

   120

		ANGRFW_BACKGROUND,

   121

		ANGRFW_GRF_LIST,

   122

		ANGRFW_SCROLLBAR,

   123

		ANGRFW_GRF_INFO,

   124

		ANGRFW_ADD,

   125

		ANGRFW_RESCAN,

   126

		ANGRFW_RESIZE,

   127

	};

   128

   129

	GRFConfig **list;

   130

	const GRFConfig *sel;

   131

   132

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

   133

	{

   134

		this->list = list;

   135

		this->resize.step_height = 10;

   136

   137

		this->FindWindowPlacementAndResize(desc);

   138

	}

   139

   140

	virtual void OnPaint()

   141

	{

   142

		const GRFConfig *c;

   143

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

   144

		int n = 0;

   145

   146

		/* Count the number of GRFs */

   147

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

   148

   149

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

   150

		SetVScrollCount(this, n);

   151

   152

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

   153

		this->DrawWidgets();

   154

   155

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

   156

   157

		uint y = wl->top + 1;

   158

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

   159

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

   160

				bool h = c == this->sel;

   161

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

   162

   163

				/* Draw selection background */

   164

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

   165

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

   166

				y += 10;

   167

			}

   168

		}

   169

   170

		if (this->sel != NULL) {

   171

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

   172

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

   173

		}

   174

	}

   175

   176

	virtual void OnDoubleClick(Point pt, int widget)

   177

	{

   178

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

   179

	}

   180

   181

	virtual void OnClick(Point pt, int widget)

   182

	{

   183

		switch (widget) {

   184

			case ANGRFW_GRF_LIST: {

   185

				/* Get row... */

   186

				const GRFConfig *c;

   187

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

   188

   189

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

   190

				this->sel = c;

   191

				this->SetDirty();

   192

				break;

   193

			}

   194

   195

			case ANGRFW_ADD: // Add selection to list

   196

				if (this->sel != NULL) {

   197

					const GRFConfig *src = this->sel;

   198

					GRFConfig **list;

   199

   200

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

   201

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

   202

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

   203

							ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   204

							return;

   205

						}

   206

					}

   207

   208

					/* Copy GRF details from scanned list */

   209

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

   210

					*c = *src;

   211

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

   212

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

   213

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

   214

					c->next = NULL;

   215

   216

					/* Append GRF config to configuration list */

   217

					*list = c;

   218

   219

					DeleteWindowByClass(WC_SAVELOAD);

   220

					InvalidateWindowData(WC_GAME_OPTIONS, 0);

   221

				}

   222

				break;

   223

   224

			case ANGRFW_RESCAN: // Rescan list

   225

				this->sel = NULL;

   226

				ScanNewGRFFiles();

   227

				this->SetDirty();

   228

				break;

   229

		}

   230

	}

   231

};

   232

   233

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

   234

static const Widget _newgrf_add_dlg_widgets[] = {

   235

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

   236

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

   237

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

   238

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

   239

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

   240

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

   241

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

   242

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

   243

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

   244

{   WIDGETS_END },

   245

};

   246

   247

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

   248

static const WindowDesc _newgrf_add_dlg_desc = {

   249

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

   250

	WC_SAVELOAD, WC_NONE,

   251

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   252

	_newgrf_add_dlg_widgets,

   253

};

   254

   255

   256

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

   257

   258

/**

   259

 * Window for showing NewGRF files

   260

 */

   261

struct NewGRFWindow : public Window {

   262

	/* Names of the manage newgrfs window widgets */

   263

	enum ShowNewGRFStateWidgets {

   264

		SNGRFS_CLOSEBOX = 0,

   265

		SNGRFS_CAPTION,

   266

		SNGRFS_BACKGROUND,

   267

		SNGRFS_ADD,

   268

		SNGRFS_REMOVE,

   269

		SNGRFS_MOVE_UP,

   270

		SNGRFS_MOVE_DOWN,

   271

		SNGRFS_FILE_LIST,

   272

		SNGRFS_SCROLLBAR,

   273

		SNGRFS_NEWGRF_INFO,

   274

		SNGRFS_SET_PARAMETERS,

   275

		SNGRFS_APPLY_CHANGES,

   276

		SNGRFS_RESIZE,

   277

	};

   278

   279

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

   280

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

   281

	GRFConfig *sel;        ///< selected grf item

   282

	bool editable;         ///< is the window editable

   283

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

   284

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

   285

   286

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

   287

	{

   288

		this->resize.step_height = 14;

   289

		this->sel         = NULL;

   290

		this->list        = NULL;

   291

		this->orig_list   = config;

   292

		this->editable    = editable;

   293

		this->execute     = exec_changes;

   294

		this->show_params = show_params;

   295

   296

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

   297

   298

		this->FindWindowPlacementAndResize(desc);

   299

		this->SetupNewGRFWindow();

   300

	}

   301

   302

	~NewGRFWindow()

   303

	{

   304

		if (!this->execute) {

   305

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

   306

			ResetGRFConfig(false);

   307

			ReloadNewGRFData();

   308

		}

   309

   310

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

   311

		ClearGRFConfigList(&this->list);

   312

	}

   313

   314

	void SetupNewGRFWindow()

   315

	{

   316

		const GRFConfig *c;

   317

		int i;

   318

   319

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

   320

   321

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

   322

		SetVScrollCount(this, i);

   323

   324

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

   325

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

   326

	}

   327

   328

	virtual void OnPaint()

   329

	{

   330

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

   331

   332

		this->SetWidgetsDisabledState(disable_all,

   333

			SNGRFS_REMOVE,

   334

			SNGRFS_MOVE_UP,

   335

			SNGRFS_MOVE_DOWN,

   336

			WIDGET_LIST_END

   337

		);

   338

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

   339

   340

		if (!disable_all) {

   341

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

   342

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

   343

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

   344

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

   345

		}

   346

   347

		this->DrawWidgets();

   348

   349

		/* Draw NewGRF list */

   350

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

   351

		int i = 0;

   352

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

   353

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

   354

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

   355

				SpriteID pal;

   356

				byte txtoffset;

   357

   358

				/* Pick a colour */

   359

				switch (c->status) {

   360

					case GCS_NOT_FOUND:

   361

					case GCS_DISABLED:

   362

						pal = PALETTE_TO_RED;

   363

						break;

   364

					case GCS_ACTIVATED:

   365

						pal = PALETTE_TO_GREEN;

   366

						break;

   367

					default:

   368

						pal = PALETTE_TO_BLUE;

   369

						break;

   370

				}

   371

   372

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

   373

				if (pal != PALETTE_TO_RED) {

   374

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

   375

						pal = PALETTE_TO_GREY;

   376

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

   377

						pal = PALETTE_TO_ORANGE;

   378

					}

   379

				}

   380

   381

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

   382

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

   383

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

   384

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

   385

				y += 14;

   386

			}

   387

		}

   388

   389

		if (this->sel != NULL) {

   390

			/* Draw NewGRF file info */

   391

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

   392

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

   393

		}

   394

	}

   395

   396

	virtual void OnClick(Point pt, int widget)

   397

	{

   398

		switch (widget) {

   399

			case SNGRFS_ADD: // Add GRF

   400

				DeleteWindowByClass(WC_SAVELOAD);

   401

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

   402

				break;

   403

   404

			case SNGRFS_REMOVE: { // Remove GRF

   405

				GRFConfig **pc, *c, *newsel;

   406

   407

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

   408

				newsel = this->sel->next;

   409

   410

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

   411

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

   412

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

   413

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

   414

   415

					if (c == this->sel) {

   416

						*pc = c->next;

   417

						free(c);

   418

						break;

   419

					}

   420

				}

   421

   422

				this->sel = newsel;

   423

				this->SetupNewGRFWindow();

   424

				this->SetDirty();

   425

				break;

   426

			}

   427

   428

			case SNGRFS_MOVE_UP: { // Move GRF up

   429

				GRFConfig **pc, *c;

   430

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

   431

   432

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

   433

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

   434

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

   435

						this->sel->next = c;

   436

						*pc = this->sel;

   437

						break;

   438

					}

   439

				}

   440

				this->SetDirty();

   441

				break;

   442

			}

   443

   444

			case SNGRFS_MOVE_DOWN: { // Move GRF down

   445

				GRFConfig **pc, *c;

   446

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

   447

   448

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

   449

					if (c == this->sel) {

   450

						*pc = c->next;

   451

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

   452

						(*pc)->next = c;

   453

						break;

   454

					}

   455

				}

   456

				this->SetDirty();

   457

				break;

   458

			}

   459

   460

			case SNGRFS_FILE_LIST: { // Select a GRF

   461

				GRFConfig *c;

   462

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

   463

   464

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

   465

				this->sel = c;

   466

   467

				this->SetDirty();

   468

				break;

   469

			}

   470

   471

			case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   472

				if (this->execute) {

   473

					ShowQuery(

   474

						STR_POPUP_CAUTION_CAPTION,

   475

						STR_NEWGRF_CONFIRMATION_TEXT,

   476

						this,

   477

						NewGRFConfirmationCallback

   478

					);

   479

				} else {

   480

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

   481

					ResetGRFConfig(false);

   482

					ReloadNewGRFData();

   483

				}

   484

				break;

   485

   486

			case SNGRFS_SET_PARAMETERS: { // Edit parameters

   487

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

   488

   489

				char buff[512];

   490

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

   491

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

   492

				break;

   493

			}

   494

		}

   495

	}