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

		char message[512];

    54

		if (c->error->custom_message == NULL) {

    55

			SetDParamStr(0, c->filename);

    56

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

    57

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

    58

				uint32 param = 0;

    59

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

    60

    61

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

    62

    63

				SetDParam(2 + i, param);

    64

			}

    65

    66

			GetString(message, c->error->message, lastof(message));

    67

		} else {

    68

			SetDParamStr(0, c->error->custom_message);

    69

			GetString(message, STR_JUST_RAW_STRING, lastof(message));

    70

		}

    71

    72

		SetDParamStr(0, message);

    73

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

    74

	}

    75

    76

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

    77

	if (c->filename != NULL) {

    78

		SetDParamStr(0, c->filename);

    79

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

    80

	}

    81

    82

	/* Prepare and draw GRF ID */

    83

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

    84

	SetDParamStr(0, buff);

    85

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

    86

    87

	/* Prepare and draw MD5 sum */

    88

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

    89

	SetDParamStr(0, buff);

    90

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

    91

    92

	/* Show GRF parameter list */

    93

	if (show_params) {

    94

		if (c->num_params > 0) {

    95

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

    96

			SetDParam(0, STR_JUST_RAW_STRING);

    97

			SetDParamStr(1, buff);

    98

		} else {

    99

			SetDParam(0, STR_01A9_NONE);

   100

		}

   101

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

   102

	}

   103

   104

	/* Show flags */

   105

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

   106

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

   107

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

   108

   109

	/* Draw GRF info if it exists */

   110

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

   111

		SetDParam(0, STR_JUST_RAW_STRING);

   112

		SetDParamStr(1, c->info);

   113

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

   114

	} else {

   115

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

   116

	}

   117

}

   118

   119

   120

/**

   121

 * Window for adding NewGRF files

   122

 */

   123

struct NewGRFAddWindow : public Window {

   124

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

   125

	enum AddNewGRFWindowWidgets {

   126

		ANGRFW_CLOSEBOX = 0,

   127

		ANGRFW_CAPTION,

   128

		ANGRFW_BACKGROUND,

   129

		ANGRFW_GRF_LIST,

   130

		ANGRFW_SCROLLBAR,

   131

		ANGRFW_GRF_INFO,

   132

		ANGRFW_ADD,

   133

		ANGRFW_RESCAN,

   134

		ANGRFW_RESIZE,

   135

	};

   136

   137

	GRFConfig **list;

   138

	const GRFConfig *sel;

   139

   140

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

   141

	{

   142

		this->list = list;

   143

		this->resize.step_height = 10;

   144

   145

		this->FindWindowPlacementAndResize(desc);

   146

	}

   147

   148

	virtual void OnPaint()

   149

	{

   150

		const GRFConfig *c;

   151

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

   152

		int n = 0;

   153

   154

		/* Count the number of GRFs */

   155

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

   156

   157

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

   158

		SetVScrollCount(this, n);

   159

   160

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

   161

		this->DrawWidgets();

   162

   163

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

   164

   165

		uint y = wl->top + 1;

   166

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

   167

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

   168

				bool h = c == this->sel;

   169

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

   170

   171

				/* Draw selection background */

   172

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

   173

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

   174

				y += 10;

   175

			}

   176

		}

   177

   178

		if (this->sel != NULL) {

   179

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

   180

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

   181

		}

   182

	}

   183

   184

	virtual void OnDoubleClick(Point pt, int widget)

   185

	{

   186

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

   187

	}

   188

   189

	virtual void OnClick(Point pt, int widget)

   190

	{

   191

		switch (widget) {

   192

			case ANGRFW_GRF_LIST: {

   193

				/* Get row... */

   194

				const GRFConfig *c;

   195

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

   196

   197

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

   198

				this->sel = c;

   199

				this->SetDirty();

   200

				break;

   201

			}

   202

   203

			case ANGRFW_ADD: // Add selection to list

   204

				if (this->sel != NULL) {

   205

					const GRFConfig *src = this->sel;

   206

					GRFConfig **list;

   207

   208

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

   209

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

   210

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

   211

							ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   212

							return;

   213

						}

   214

					}

   215

   216

					/* Copy GRF details from scanned list */

   217

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

   218

					*c = *src;

   219

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

   220

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

   221

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

   222

					c->next = NULL;

   223

   224

					/* Append GRF config to configuration list */

   225

					*list = c;

   226

   227

					DeleteWindowByClass(WC_SAVELOAD);

   228

					InvalidateWindowData(WC_GAME_OPTIONS, 0);

   229

				}

   230

				break;

   231

   232

			case ANGRFW_RESCAN: // Rescan list

   233

				this->sel = NULL;

   234

				ScanNewGRFFiles();

   235

				this->SetDirty();

   236

				break;

   237

		}

   238

	}

   239

};

   240

   241

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

   242

static const Widget _newgrf_add_dlg_widgets[] = {

   243

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

   244

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

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

{   WIDGETS_END },

   253

};

   254

   255

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

   256

static const WindowDesc _newgrf_add_dlg_desc = {

   257

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

   258

	WC_SAVELOAD, WC_NONE,

   259

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   260

	_newgrf_add_dlg_widgets,

   261

};

   262

   263

   264

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

   265

   266

/**

   267

 * Window for showing NewGRF files

   268

 */

   269

struct NewGRFWindow : public Window {

   270

	/* Names of the manage newgrfs window widgets */

   271

	enum ShowNewGRFStateWidgets {

   272

		SNGRFS_CLOSEBOX = 0,

   273

		SNGRFS_CAPTION,

   274

		SNGRFS_BACKGROUND,

   275

		SNGRFS_ADD,

   276

		SNGRFS_REMOVE,

   277

		SNGRFS_MOVE_UP,

   278

		SNGRFS_MOVE_DOWN,

   279

		SNGRFS_FILE_LIST,

   280

		SNGRFS_SCROLLBAR,

   281

		SNGRFS_NEWGRF_INFO,

   282

		SNGRFS_SET_PARAMETERS,

   283

		SNGRFS_APPLY_CHANGES,

   284

		SNGRFS_RESIZE,

   285

	};

   286

   287

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

   288

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

   289

	GRFConfig *sel;        ///< selected grf item

   290

	bool editable;         ///< is the window editable

   291

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

   292

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

   293

   294

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

   295

	{

   296

		this->resize.step_height = 14;

   297

		this->sel         = NULL;

   298

		this->list        = NULL;

   299

		this->orig_list   = config;

   300

		this->editable    = editable;

   301

		this->execute     = exec_changes;

   302

		this->show_params = show_params;

   303

   304

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

   305

   306

		this->FindWindowPlacementAndResize(desc);

   307

		this->SetupNewGRFWindow();

   308

	}

   309

   310

	~NewGRFWindow()

   311

	{

   312

		if (!this->execute) {

   313

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

   314

			ResetGRFConfig(false);

   315

			ReloadNewGRFData();

   316

		}

   317

   318

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

   319

		ClearGRFConfigList(&this->list);

   320

	}

   321

   322

	void SetupNewGRFWindow()

   323

	{

   324

		const GRFConfig *c;

   325

		int i;

   326

   327

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

   328

   329

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

   330

		SetVScrollCount(this, i);

   331

   332

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

   333

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

   334

	}

   335

   336

	virtual void OnPaint()

   337

	{

   338

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

   339

   340

		this->SetWidgetsDisabledState(disable_all,

   341

			SNGRFS_REMOVE,

   342

			SNGRFS_MOVE_UP,

   343

			SNGRFS_MOVE_DOWN,

   344

			WIDGET_LIST_END

   345

		);

   346

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

   347

   348

		if (!disable_all) {

   349

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

   350

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

   351

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

   352

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

   353

		}

   354

   355

		this->DrawWidgets();

   356

   357

		/* Draw NewGRF list */

   358

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

   359

		int i = 0;

   360

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

   361

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

   362

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

   363

				SpriteID pal;

   364

				byte txtoffset;

   365

   366

				/* Pick a colour */

   367

				switch (c->status) {

   368

					case GCS_NOT_FOUND:

   369

					case GCS_DISABLED:

   370

						pal = PALETTE_TO_RED;

   371

						break;

   372

					case GCS_ACTIVATED:

   373

						pal = PALETTE_TO_GREEN;

   374

						break;

   375

					default:

   376

						pal = PALETTE_TO_BLUE;

   377

						break;

   378

				}

   379

   380

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

   381

				if (pal != PALETTE_TO_RED) {

   382

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

   383

						pal = PALETTE_TO_GREY;

   384

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

   385

						pal = PALETTE_TO_ORANGE;

   386

					}

   387

				}

   388

   389

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

   390

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

   391

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

   392

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

   393

				y += 14;

   394

			}

   395

		}

   396

   397

		if (this->sel != NULL) {

   398

			/* Draw NewGRF file info */

   399

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

   400

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

   401

		}

   402

	}

   403

   404

	virtual void OnClick(Point pt, int widget)

   405

	{

   406

		switch (widget) {

   407

			case SNGRFS_ADD: // Add GRF

   408

				DeleteWindowByClass(WC_SAVELOAD);

   409

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

   410

				break;

   411

   412

			case SNGRFS_REMOVE: { // Remove GRF

   413

				GRFConfig **pc, *c, *newsel;

   414

   415

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

   416

				newsel = this->sel->next;

   417

   418

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

   419

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

   420

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

   421

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

   422

   423

					if (c == this->sel) {

   424

						*pc = c->next;

   425

						free(c);

   426

						break;

   427

					}

   428

				}

   429

   430

				this->sel = newsel;

   431

				this->SetupNewGRFWindow();

   432

				this->SetDirty();

   433

				break;

   434

			}

   435

   436

			case SNGRFS_MOVE_UP: { // Move GRF up

   437

				GRFConfig **pc, *c;

   438

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

   439

   440

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

   441

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

   442

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

   443

						this->sel->next = c;

   444

						*pc = this->sel;

   445

						break;

   446

					}

   447

				}

   448

				this->SetDirty();

   449

				break;

   450

			}

   451

   452

			case SNGRFS_MOVE_DOWN: { // Move GRF down

   453

				GRFConfig **pc, *c;

   454

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

   455

   456

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

   457

					if (c == this->sel) {

   458

						*pc = c->next;

   459

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

   460

						(*pc)->next = c;

   461

						break;

   462

					}

   463

				}

   464

				this->SetDirty();

   465

				break;

   466

			}

   467

   468

			case SNGRFS_FILE_LIST: { // Select a GRF

   469

				GRFConfig *c;

   470

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

   471

   472

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

   473

				this->sel = c;

   474

   475

				this->SetDirty();

   476

				break;

   477

			}

   478

   479

			case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   480

				if (this->execute) {

   481

					ShowQuery(

   482

						STR_POPUP_CAUTION_CAPTION,

   483

						STR_NEWGRF_CONFIRMATION_TEXT,

   484

						this,

   485

						NewGRFConfirmationCallback

   486

					);

   487

				} else {

   488

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

   489

					ResetGRFConfig(false);

   490

					ReloadNewGRFData();

   491

				}

   492

				break;

   493

   494

			case SNGRFS_SET_PARAMETERS: { // Edit parameters