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) 

   156

            if (!HasBit(c->flags, GCF_CACHE))

   157

                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 (!HasBit(c->flags, GCF_CACHE) && 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, 14,   0,  10,   0,  13, STR_00C5,                STR_018B_CLOSE_WINDOW },           // ANGRFW_CLOSEBOX

   246

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

   247

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

   248

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

   249

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

   250

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

   251

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

   252

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

   253

{  WWT_RESIZEBOX,    RESIZE_LRTB, 14, 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

   266

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

   267

   268

/**

   269

 * Window for showing NewGRF files

   270

 */

   271

struct NewGRFWindow : public Window {

   272

	/* Names of the manage newgrfs window widgets */

   273

	enum ShowNewGRFStateWidgets {

   274

		SNGRFS_CLOSEBOX = 0,

   275

		SNGRFS_CAPTION,

   276

		SNGRFS_BACKGROUND,

   277

		SNGRFS_ADD,

   278

		SNGRFS_REMOVE,

   279

		SNGRFS_MOVE_UP,

   280

		SNGRFS_MOVE_DOWN,

   281

		SNGRFS_FILE_LIST,

   282

		SNGRFS_SCROLLBAR,

   283

		SNGRFS_NEWGRF_INFO,

   284

		SNGRFS_SET_PARAMETERS,

   285

		SNGRFS_APPLY_CHANGES,

   286

		SNGRFS_RESIZE,

   287

	};

   288

   289

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

   290

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

   291

	GRFConfig *sel;        ///< selected grf item

   292

	bool editable;         ///< is the window editable

   293

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

   294

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

   295

   296

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

   297

	{

   298

		this->resize.step_height = 14;

   299

		this->sel         = NULL;

   300

		this->list        = NULL;

   301

		this->orig_list   = config;

   302

		this->editable    = editable;

   303

		this->execute     = exec_changes;

   304

		this->show_params = show_params;

   305

   306

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

   307

   308

		this->FindWindowPlacementAndResize(desc);

   309

		this->SetupNewGRFWindow();

   310

	}

   311

   312

	~NewGRFWindow()

   313

	{

   314

		if (!this->execute) {

   315

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

   316

			ResetGRFConfig(false);

   317

			ReloadNewGRFData();

   318

		}

   319

   320

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

   321

		ClearGRFConfigList(&this->list);

   322

	}

   323

   324

	void SetupNewGRFWindow()

   325

	{

   326

		const GRFConfig *c;

   327

		int i;

   328

   329

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

   330

   331

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

   332

		SetVScrollCount(this, i);

   333

   334

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

   335

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

   336

	}

   337

   338

	virtual void OnPaint()

   339

	{

   340

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

   341

   342

		this->SetWidgetsDisabledState(disable_all,

   343

			SNGRFS_REMOVE,

   344

			SNGRFS_MOVE_UP,

   345

			SNGRFS_MOVE_DOWN,

   346

			WIDGET_LIST_END

   347

		);

   348

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

   349

   350

		if (!disable_all) {

   351

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

   352

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

   353

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

   354

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

   355

		}

   356

   357

		this->DrawWidgets();

   358

   359

		/* Draw NewGRF list */

   360

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

   361

		int i = 0;

   362

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

   363

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

   364

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

   365

				SpriteID pal;

   366

				byte txtoffset;

   367

   368

				/* Pick a colour */

   369

				switch (c->status) {

   370

					case GCS_NOT_FOUND:

   371

					case GCS_DISABLED:

   372

						pal = PALETTE_TO_RED;

   373

						break;

   374

					case GCS_ACTIVATED:

   375

						pal = PALETTE_TO_GREEN;

   376

						break;

   377

					default:

   378

						pal = PALETTE_TO_BLUE;

   379

						break;

   380

				}

   381

   382

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

   383

				if (pal != PALETTE_TO_RED) {

   384

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

   385

						pal = PALETTE_TO_GREY;

   386

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

   387

						pal = PALETTE_TO_ORANGE;

   388

					}

   389

				}

   390

   391

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

   392

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

   393

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

   394

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

   395

				y += 14;

   396

			}

   397

		}

   398

   399

		if (this->sel != NULL) {

   400

			/* Draw NewGRF file info */

   401

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

   402

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

   403

		}

   404

	}

   405

   406

	virtual void OnClick(Point pt, int widget)

   407

	{

   408

		switch (widget) {

   409

			case SNGRFS_ADD: // Add GRF

   410

				DeleteWindowByClass(WC_SAVELOAD);

   411

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

   412

				break;

   413

   414

			case SNGRFS_REMOVE: { // Remove GRF

   415

				GRFConfig **pc, *c, *newsel;

   416

   417

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

   418

				newsel = this->sel->next;

   419

   420

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

   421

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

   422

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

   423

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

   424

   425

					if (c == this->sel) {

   426

						*pc = c->next;

   427

						free(c);

   428

						break;

   429

					}

   430

				}

   431

   432

				this->sel = newsel;

   433

				this->SetupNewGRFWindow();

   434

				this->SetDirty();

   435

				break;

   436

			}

   437

   438

			case SNGRFS_MOVE_UP: { // Move GRF up

   439

				GRFConfig **pc, *c;

   440

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

   441

   442

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

   443

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

   444

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

   445

						this->sel->next = c;

   446

						*pc = this->sel;

   447

						break;

   448

					}

   449

				}

   450

				this->SetDirty();

   451

				break;

   452

			}

   453

   454

			case SNGRFS_MOVE_DOWN: { // Move GRF down

   455

				GRFConfig **pc, *c;

   456

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

   457

   458

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

   459

					if (c == this->sel) {

   460

						*pc = c->next;

   461

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

   462

						(*pc)->next = c;

   463

						break;

   464

					}

   465

				}

   466

				this->SetDirty();

   467

				break;

   468

			}

   469

   470

			case SNGRFS_FILE_LIST: { // Select a GRF

   471

				GRFConfig *c;

   472

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

   473

   474

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

   475

				this->sel = c;

   476

   477

				this->SetDirty();

   478

				break;

   479

			}

   480

   481

			case SNGRFS_APPLY_CHANGES: // Apply changes made to GRF list

   482

				if (this->execute) {

   483

					ShowQuery(

   484

						STR_POPUP_CAUTION_CAPTION,

   485

						STR_NEWGRF_CONFIRMATION_TEXT,

   486

						this,

   487

						NewGRFConfirmationCallback

   488

					);

   489

				} else {

   490

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

   491

					ResetGRFConfig(false);

   492

					ReloadNewGRFData();

   493

				}

   494

				break;