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

#include "settings_func.h"

    20

#include "widgets/dropdown_type.h"

    21

    22

#include "table/strings.h"

    23

#include "table/sprites.h"

    24

    25

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

    26

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

    27

 * comma or a space character

    28

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

    29

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

    30

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

    31

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

    32

{

    33

	int n = 0, v;

    34

	char *end;

    35

    36

	for (;;) {

    37

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

    38

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

    39

		p = end;

    40

		items[n++] = v;

    41

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

    42

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

    43

		p++;

    44

	}

    45

    46

	return n;

    47

}

    48

    49

    50

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

    51

{

    52

	char buff[256];

    53

    54

	if (c->error != NULL) {

    55

		char message[512];

    56

		SetDParamStr(0, c->error->custom_message); // is skipped by built-in messages

    57

		SetDParam   (1, STR_JUST_RAW_STRING);

    58

		SetDParamStr(2, c->filename);

    59

		SetDParam   (3, STR_JUST_RAW_STRING);

    60

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

    61

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

    62

			uint32 param = 0;

    63

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

    64

    65

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

    66

    67

			SetDParam(5 + i, param);

    68

		}

    69

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

    70

    71

		SetDParamStr(0, message);

    72

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

    73

	}

    74

    75

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

    76

	if (c->filename != NULL) {

    77

		SetDParamStr(0, c->filename);

    78

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

    79

	}

    80

    81

	/* Prepare and draw GRF ID */

    82

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

    83

	SetDParamStr(0, buff);

    84

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

    85

    86

	/* Prepare and draw MD5 sum */

    87

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

    88

	SetDParamStr(0, buff);

    89

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

    90

    91

	/* Show GRF parameter list */

    92

	if (show_params) {

    93

		if (c->num_params > 0) {

    94

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

    95

			SetDParam(0, STR_JUST_RAW_STRING);

    96

			SetDParamStr(1, buff);

    97

		} else {

    98

			SetDParam(0, STR_01A9_NONE);

    99

		}

   100

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

   101

   102

		/* Draw the palette of the NewGRF */

   103

		SetDParamStr(0, c->windows_paletted ? "Windows" : "DOS");

   104

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

   105

	}

   106

   107

	/* Show flags */

   108

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

   109

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

   110

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

   111

   112

	/* Draw GRF info if it exists */

   113

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

   114

		SetDParam(0, STR_JUST_RAW_STRING);

   115

		SetDParamStr(1, c->info);

   116

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

   117

	} else {

   118

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

   119

	}

   120

}

   121

   122

   123

/**

   124

 * Window for adding NewGRF files

   125

 */

   126

struct NewGRFAddWindow : public Window {

   127

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

   128

	enum AddNewGRFWindowWidgets {

   129

		ANGRFW_CLOSEBOX = 0,

   130

		ANGRFW_CAPTION,

   131

		ANGRFW_BACKGROUND,

   132

		ANGRFW_GRF_LIST,

   133

		ANGRFW_SCROLLBAR,

   134

		ANGRFW_GRF_INFO,

   135

		ANGRFW_ADD,

   136

		ANGRFW_RESCAN,

   137

		ANGRFW_RESIZE,

   138

	};

   139

   140

	GRFConfig **list;

   141

	const GRFConfig *sel;

   142

   143

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

   144

	{

   145

		this->list = list;

   146

		this->resize.step_height = 10;

   147

   148

		this->FindWindowPlacementAndResize(desc);

   149

	}

   150

   151

	virtual void OnPaint()

   152

	{

   153

		const GRFConfig *c;

   154

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

   155

		int n = 0;

   156

   157

		/* Count the number of GRFs */

   158

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

   159

   160

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

   161

		SetVScrollCount(this, n);

   162

   163

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

   164

		this->DrawWidgets();

   165

   166

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

   167

   168

		uint y = wl->top + 1;

   169

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

   170

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

   171

				bool h = c == this->sel;

   172

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

   173

   174

				/* Draw selection background */

   175

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

   176

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

   177

				y += 10;

   178

			}

   179

		}

   180

   181

		if (this->sel != NULL) {

   182

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

   183

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

   184

		}

   185

	}

   186

   187

	virtual void OnDoubleClick(Point pt, int widget)

   188

	{

   189

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

   190

	}

   191

   192

	virtual void OnClick(Point pt, int widget)

   193

	{

   194

		switch (widget) {

   195

			case ANGRFW_GRF_LIST: {

   196

				/* Get row... */

   197

				const GRFConfig *c;

   198

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

   199

   200

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

   201

				this->sel = c;

   202

				this->SetDirty();

   203

				break;

   204

			}

   205

   206

			case ANGRFW_ADD: // Add selection to list

   207

				if (this->sel != NULL) {

   208

					const GRFConfig *src = this->sel;

   209

					GRFConfig **list;

   210

   211

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

   212

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

   213

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

   214

							ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   215

							return;

   216

						}

   217

					}

   218

   219

					/* Copy GRF details from scanned list */

   220

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

   221

					*c = *src;

   222

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

   223

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

   224

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

   225

					c->next = NULL;

   226

   227

					/* Append GRF config to configuration list */

   228

					*list = c;

   229

   230

					DeleteWindowByClass(WC_SAVELOAD);

   231

					InvalidateWindowData(WC_GAME_OPTIONS, 0);

   232

				}

   233

				break;

   234

   235

			case ANGRFW_RESCAN: // Rescan list

   236

				this->sel = NULL;

   237

				ScanNewGRFFiles();

   238

				this->SetDirty();

   239

				break;

   240

		}

   241

	}

   242

};

   243

   244

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

   245

static const Widget _newgrf_add_dlg_widgets[] = {

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

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

   255

{   WIDGETS_END },

   256

};

   257

   258

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

   259

static const WindowDesc _newgrf_add_dlg_desc = {

   260

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

   261

	WC_SAVELOAD, WC_NONE,

   262

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   263

	_newgrf_add_dlg_widgets,

   264

};

   265

   266

static GRFPresetList _grf_preset_list;

   267

   268

class DropDownListPresetItem : public DropDownListItem {

   269

public:

   270

	DropDownListPresetItem(int result) : DropDownListItem(result, false) {}

   271

   272

	virtual ~DropDownListPresetItem() {}

   273

   274

	bool Selectable() const

   275

	{

   276

		return true;

   277

	}

   278

   279

	void Draw(int x, int y, uint width, uint height, bool sel, int bg_colour) const

   280

	{

   281

		DoDrawStringTruncated(_grf_preset_list[this->result], x + 2, y, sel ? TC_WHITE : TC_BLACK, x + width);

   282

	}

   283

};

   284

   285

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

   286

   287

/**

   288

 * Window for showing NewGRF files

   289

 */

   290

struct NewGRFWindow : public Window {

   291

	/* Names of the manage newgrfs window widgets */

   292

	enum ShowNewGRFStateWidgets {

   293

		SNGRFS_CLOSEBOX = 0,

   294

		SNGRFS_CAPTION,

   295

		SNGRFS_BACKGROUND1,

   296

		SNGRFS_PRESET_LIST,

   297

		SNGRFS_PRESET_SAVE,

   298

		SNGRFS_PRESET_DELETE,

   299

		SNGRFS_BACKGROUND2,

   300

		SNGRFS_ADD,

   301

		SNGRFS_REMOVE,

   302

		SNGRFS_MOVE_UP,

   303

		SNGRFS_MOVE_DOWN,

   304

		SNGRFS_FILE_LIST,

   305

		SNGRFS_SCROLLBAR,

   306

		SNGRFS_NEWGRF_INFO,

   307

		SNGRFS_SET_PARAMETERS,

   308

		SNGRFS_TOGGLE_PALETTE,

   309

		SNGRFS_APPLY_CHANGES,

   310

		SNGRFS_RESIZE,

   311

	};

   312

   313

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

   314

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

   315

	GRFConfig *sel;        ///< selected grf item

   316

	bool editable;         ///< is the window editable

   317

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

   318

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

   319

	int query_widget;      ///< widget that opened a query

   320

	int preset;            ///< selected preset

   321

   322

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

   323

	{

   324

		this->resize.step_height = 14;

   325

		this->sel         = NULL;

   326

		this->list        = NULL;

   327

		this->orig_list   = config;

   328

		this->editable    = editable;

   329

		this->execute     = exec_changes;

   330

		this->show_params = show_params;

   331

		this->preset      = -1;

   332

   333

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

   334

		GetGRFPresetList(&_grf_preset_list);

   335

   336

		this->FindWindowPlacementAndResize(desc);

   337

		this->SetupNewGRFWindow();

   338

	}

   339

   340

	~NewGRFWindow()

   341

	{

   342

		if (!this->execute) {

   343

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

   344

			ResetGRFConfig(false);

   345

			ReloadNewGRFData();

   346

		}

   347

   348

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

   349

		ClearGRFConfigList(&this->list);

   350

		_grf_preset_list.Clear();

   351

	}

   352

   353

	void SetupNewGRFWindow()

   354

	{

   355

		const GRFConfig *c;

   356

		int i;

   357

   358

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

   359

   360

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

   361

		SetVScrollCount(this, i);

   362

   363

		this->SetWidgetsDisabledState(!this->editable,

   364

			SNGRFS_PRESET_LIST,

   365

			SNGRFS_ADD,

   366

			SNGRFS_APPLY_CHANGES,

   367

			SNGRFS_TOGGLE_PALETTE,

   368

			WIDGET_LIST_END

   369

		);

   370

	}

   371

   372

	virtual void OnPaint()

   373

	{

   374

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

   375

   376

		this->SetWidgetsDisabledState(disable_all,

   377

			SNGRFS_REMOVE,

   378

			SNGRFS_MOVE_UP,

   379

			SNGRFS_MOVE_DOWN,

   380

			WIDGET_LIST_END

   381

		);

   382

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

   383

		this->SetWidgetDisabledState(SNGRFS_TOGGLE_PALETTE, disable_all);

   384

   385

		if (!disable_all) {

   386

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

   387

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

   388

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

   389

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

   390

		}

   391

   392

		if (this->preset == -1) {

   393

			this->widget[SNGRFS_PRESET_LIST].data = STR_02BF_CUSTOM;

   394

		} else {

   395

			SetDParamStr(0, _grf_preset_list[this->preset]);

   396

			this->widget[SNGRFS_PRESET_LIST].data = STR_JUST_RAW_STRING;

   397

		}

   398

   399

		this->DrawWidgets();

   400

   401

		/* Draw NewGRF list */

   402

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

   403

		int i = 0;

   404

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

   405

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

   406

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

   407

				SpriteID pal;

   408

				byte txtoffset;

   409

   410

				/* Pick a colour */

   411

				switch (c->status) {

   412

					case GCS_NOT_FOUND:

   413

					case GCS_DISABLED:

   414

						pal = PALETTE_TO_RED;

   415

						break;

   416

					case GCS_ACTIVATED:

   417

						pal = PALETTE_TO_GREEN;

   418

						break;

   419

					default:

   420

						pal = PALETTE_TO_BLUE;

   421

						break;

   422

				}

   423

   424

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

   425

				if (pal != PALETTE_TO_RED) {

   426

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

   427

						pal = PALETTE_TO_GREY;

   428

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

   429

						pal = PALETTE_TO_ORANGE;

   430

					}

   431

				}

   432

   433

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

   434

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

   435

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

   436

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

   437

				y += 14;

   438

			}

   439

		}

   440

   441

		if (this->sel != NULL) {

   442

			/* Draw NewGRF file info */

   443

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

   444

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

   445

		}

   446

	}

   447

   448

	virtual void OnClick(Point pt, int widget)

   449

	{

   450

		switch (widget) {

   451

			case SNGRFS_PRESET_LIST: {

   452

				DropDownList *list = new DropDownList();

   453

   454

				/* Add 'None' option for clearing list */

   455

				list->push_back(new DropDownListStringItem(STR_NONE, -1, false));

   456

   457

				for (uint i = 0; i < _grf_preset_list.Length(); i++) {

   458

					if (_grf_preset_list[i] != NULL) {

   459

						list->push_back(new DropDownListPresetItem(i));

   460

					}

   461

				}

   462

   463

				ShowDropDownList(this, list, this->preset, SNGRFS_PRESET_LIST);

   464

				break;

   465

			}

   466

   467

			case SNGRFS_PRESET_SAVE:

   468

				this->query_widget = widget;

   469

				ShowQueryString(STR_EMPTY, STR_NEWGRF_PRESET_SAVE_QUERY, 32, 100, this, CS_ALPHANUMERAL, QSF_NONE);

   470

				break;

   471

   472

			case SNGRFS_PRESET_DELETE:

   473

				if (this->preset == -1) return;

   474

   475

				DeleteGRFPresetFromConfig(_grf_preset_list[this->preset]);

   476

				GetGRFPresetList(&_grf_preset_list);

   477

				this->preset = -1;

   478

				this->SetDirty();

   479

				break;

   480

   481

			case SNGRFS_ADD: // Add GRF

   482

				DeleteWindowByClass(WC_SAVELOAD);

   483

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

   484

				break;

   485

   486

			case SNGRFS_REMOVE: { // Remove GRF

   487

				GRFConfig **pc, *c, *newsel;

   488

   489

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

   490

				newsel = this->sel->next;

   491

   492

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