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

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

    57

			SetDParamStr(0, c->filename);

    58

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

    59

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

    60

				uint32 param = 0;

    61

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

    62

    63

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

    64

    65

				SetDParam(2 + i, param);

    66

			}

    67

    68

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

    69

		} else {

    70

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

    71

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

    72

		}

    73

    74

		SetDParamStr(0, message);

    75

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

    76

	}

    77

    78

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

    79

	if (c->filename != NULL) {

    80

		SetDParamStr(0, c->filename);

    81

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

    82

	}

    83

    84

	/* Prepare and draw GRF ID */

    85

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

    86

	SetDParamStr(0, buff);

    87

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

    88

    89

	/* Prepare and draw MD5 sum */

    90

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

    91

	SetDParamStr(0, buff);

    92

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

    93

    94

	/* Show GRF parameter list */

    95

	if (show_params) {

    96

		if (c->num_params > 0) {

    97

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

    98

			SetDParam(0, STR_JUST_RAW_STRING);

    99

			SetDParamStr(1, buff);

   100

		} else {

   101

			SetDParam(0, STR_01A9_NONE);

   102

		}

   103

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

   104

	}

   105

   106

	/* Show flags */

   107

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

   108

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

   109

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

   110

   111

	/* Draw GRF info if it exists */

   112

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

   113

		SetDParam(0, STR_JUST_RAW_STRING);

   114

		SetDParamStr(1, c->info);

   115

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

   116

	} else {

   117

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

   118

	}

   119

}

   120

   121

   122

/**

   123

 * Window for adding NewGRF files

   124

 */

   125

struct NewGRFAddWindow : public Window {

   126

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

   127

	enum AddNewGRFWindowWidgets {

   128

		ANGRFW_CLOSEBOX = 0,

   129

		ANGRFW_CAPTION,

   130

		ANGRFW_BACKGROUND,

   131

		ANGRFW_GRF_LIST,

   132

		ANGRFW_SCROLLBAR,

   133

		ANGRFW_GRF_INFO,

   134

		ANGRFW_ADD,

   135

		ANGRFW_RESCAN,

   136

		ANGRFW_RESIZE,

   137

	};

   138

   139

	GRFConfig **list;

   140

	const GRFConfig *sel;

   141

   142

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

   143

	{

   144

		this->list = list;

   145

		this->resize.step_height = 10;

   146

   147

		this->FindWindowPlacementAndResize(desc);

   148

	}

   149

   150

	virtual void OnPaint()

   151

	{

   152

		const GRFConfig *c;

   153

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

   154

		int n = 0;

   155

   156

		/* Count the number of GRFs */

   157

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

   158

   159

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

   160

		SetVScrollCount(this, n);

   161

   162

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

   163

		this->DrawWidgets();

   164

   165

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

   166

   167

		uint y = wl->top + 1;

   168

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

   169

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

   170

				bool h = c == this->sel;

   171

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

   172

   173

				/* Draw selection background */

   174

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

   175

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

   176

				y += 10;

   177

			}

   178

		}

   179

   180

		if (this->sel != NULL) {

   181

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

   182

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

   183

		}

   184

	}

   185

   186

	virtual void OnDoubleClick(Point pt, int widget)

   187

	{

   188

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

   189

	}

   190

   191

	virtual void OnClick(Point pt, int widget)

   192

	{

   193

		switch (widget) {

   194

			case ANGRFW_GRF_LIST: {

   195

				/* Get row... */

   196

				const GRFConfig *c;

   197

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

   198

   199

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

   200

				this->sel = c;

   201

				this->SetDirty();

   202

				break;

   203

			}

   204

   205

			case ANGRFW_ADD: // Add selection to list

   206

				if (this->sel != NULL) {

   207

					const GRFConfig *src = this->sel;

   208

					GRFConfig **list;

   209

   210

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

   211

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

   212

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

   213

							ShowErrorMessage(INVALID_STRING_ID, STR_NEWGRF_DUPLICATE_GRFID, 0, 0);

   214

							return;

   215

						}

   216

					}

   217

   218

					/* Copy GRF details from scanned list */

   219

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

   220

					*c = *src;

   221

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

   222

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

   223

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

   224

					c->next = NULL;

   225

   226

					/* Append GRF config to configuration list */

   227

					*list = c;

   228

   229

					DeleteWindowByClass(WC_SAVELOAD);

   230

					InvalidateWindowData(WC_GAME_OPTIONS, 0);

   231

				}

   232

				break;

   233

   234

			case ANGRFW_RESCAN: // Rescan list

   235

				this->sel = NULL;

   236

				ScanNewGRFFiles();

   237

				this->SetDirty();

   238

				break;

   239

		}

   240

	}

   241

};

   242

   243

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

   244

static const Widget _newgrf_add_dlg_widgets[] = {

   245

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

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

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

   254

{   WIDGETS_END },

   255

};

   256

   257

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

   258

static const WindowDesc _newgrf_add_dlg_desc = {

   259

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

   260

	WC_SAVELOAD, WC_NONE,

   261

	WDF_STD_TOOLTIPS | WDF_DEF_WIDGET | WDF_STD_BTN | WDF_UNCLICK_BUTTONS | WDF_RESIZABLE,

   262

	_newgrf_add_dlg_widgets,

   263

};

   264

   265

static GRFPresetList _grf_preset_list;

   266

   267

class DropDownListPresetItem : public DropDownListItem {

   268

public:

   269

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

   270

   271

	virtual ~DropDownListPresetItem() {}

   272

   273

	virtual StringID String() const

   274

	{

   275

		return STR_EMPTY;

   276

	}

   277

   278

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

   279

	{

   280

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

   281

	}

   282

};

   283

   284

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

   285

   286

/**

   287

 * Window for showing NewGRF files

   288

 */

   289

struct NewGRFWindow : public Window {

   290

	/* Names of the manage newgrfs window widgets */

   291

	enum ShowNewGRFStateWidgets {

   292

		SNGRFS_CLOSEBOX = 0,

   293

		SNGRFS_CAPTION,

   294

		SNGRFS_BACKGROUND1,

   295

		SNGRFS_PRESET_LIST,

   296

		SNGRFS_PRESET_SAVE,

   297

		SNGRFS_PRESET_DELETE,

   298

		SNGRFS_BACKGROUND2,

   299

		SNGRFS_ADD,

   300

		SNGRFS_REMOVE,

   301

		SNGRFS_MOVE_UP,

   302

		SNGRFS_MOVE_DOWN,

   303

		SNGRFS_FILE_LIST,

   304

		SNGRFS_SCROLLBAR,

   305

		SNGRFS_NEWGRF_INFO,

   306

		SNGRFS_SET_PARAMETERS,

   307

		SNGRFS_APPLY_CHANGES,

   308

		SNGRFS_RESIZE,

   309

	};

   310

   311

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

   312

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

   313

	GRFConfig *sel;        ///< selected grf item

   314

	bool editable;         ///< is the window editable

   315

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

   316

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

   317

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

   318

	int preset;            ///< selected preset

   319

   320

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

   321

	{

   322

		this->resize.step_height = 14;

   323

		this->sel         = NULL;

   324

		this->list        = NULL;

   325

		this->orig_list   = config;

   326

		this->editable    = editable;

   327

		this->execute     = exec_changes;

   328

		this->show_params = show_params;

   329

		this->preset      = -1;

   330

   331

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

   332

		GetGRFPresetList(&_grf_preset_list);

   333

   334

		this->FindWindowPlacementAndResize(desc);

   335

		this->SetupNewGRFWindow();

   336

	}

   337

   338

	~NewGRFWindow()

   339

	{

   340

		if (!this->execute) {

   341

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

   342

			ResetGRFConfig(false);

   343

			ReloadNewGRFData();

   344

		}

   345

   346

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

   347

		ClearGRFConfigList(&this->list);

   348

		_grf_preset_list.Clear();

   349

	}

   350

   351

	void SetupNewGRFWindow()

   352

	{

   353

		const GRFConfig *c;

   354

		int i;

   355

   356

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

   357

   358

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

   359

		SetVScrollCount(this, i);

   360

   361

		this->SetWidgetsDisabledState(!this->editable,

   362

			SNGRFS_PRESET_LIST,

   363

			SNGRFS_ADD,

   364

			SNGRFS_APPLY_CHANGES,

   365

			WIDGET_LIST_END

   366

		);

   367

	}

   368

   369

	virtual void OnPaint()

   370

	{

   371

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

   372

   373

		this->SetWidgetsDisabledState(disable_all,

   374

			SNGRFS_REMOVE,

   375

			SNGRFS_MOVE_UP,

   376

			SNGRFS_MOVE_DOWN,

   377

			WIDGET_LIST_END

   378

		);

   379

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

   380

   381

		if (!disable_all) {

   382

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

   383

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

   384

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

   385

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

   386

		}

   387

   388

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

   389

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

   390

		} else {

   391

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

   392

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

   393

		}

   394

   395

		this->DrawWidgets();

   396

   397

		/* Draw NewGRF list */

   398

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

   399

		int i = 0;

   400

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

   401

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

   402

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

   403

				SpriteID pal;

   404

				byte txtoffset;

   405

   406

				/* Pick a colour */

   407

				switch (c->status) {

   408

					case GCS_NOT_FOUND:

   409

					case GCS_DISABLED:

   410

						pal = PALETTE_TO_RED;

   411

						break;

   412

					case GCS_ACTIVATED:

   413

						pal = PALETTE_TO_GREEN;

   414

						break;

   415

					default:

   416

						pal = PALETTE_TO_BLUE;

   417

						break;

   418

				}

   419

   420

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

   421

				if (pal != PALETTE_TO_RED) {

   422

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

   423

						pal = PALETTE_TO_GREY;

   424

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

   425

						pal = PALETTE_TO_ORANGE;

   426

					}

   427

				}

   428

   429

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

   430

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

   431

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

   432

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

   433

				y += 14;

   434

			}

   435

		}

   436

   437

		if (this->sel != NULL) {

   438

			/* Draw NewGRF file info */

   439

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

   440

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

   441

		}

   442

	}

   443

   444

	virtual void OnClick(Point pt, int widget)

   445

	{

   446

		switch (widget) {

   447

			case SNGRFS_PRESET_LIST: {

   448

				DropDownList *list = new DropDownList();

   449

   450

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

   451

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

   452

   453

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

   454

					if (_grf_preset_list[i] != NULL) {

   455

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

   456

					}

   457

				}

   458

   459

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

   460

				break;

   461

			}

   462

   463

			case SNGRFS_PRESET_SAVE:

   464

				this->query_widget = widget;

   465

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

   466

				break;

   467

   468

			case SNGRFS_PRESET_DELETE:

   469

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

   470

   471

				DeleteGRFPresetFromConfig(_grf_preset_list[this->preset]);

   472

				GetGRFPresetList(&_grf_preset_list);

   473

				this->preset = -1;

   474

				this->SetDirty();

   475

				break;

   476

   477

			case SNGRFS_ADD: // Add GRF

   478

				DeleteWindowByClass(WC_SAVELOAD);

   479

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

   480

				break;

   481

   482

			case SNGRFS_REMOVE: { // Remove GRF

   483

				GRFConfig **pc, *c, *newsel;

   484

   485

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

   486

				newsel = this->sel->next;

   487

   488

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

   489

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

   490

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

   491

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

   492

   493

					if (c == this->sel) {

   494