1

/* $Id$ */

     2

     3

/** @file station_gui.cpp The GUI for stations. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "gui.h"

     9

#include "window_gui.h"

    10

#include "textbuf_gui.h"

    11

#include "station_base.h"

    12

#include "player_func.h"

    13

#include "economy_func.h"

    14

#include "town.h"

    15

#include "command_func.h"

    16

#include "variables.h"

    17

#include "vehicle_gui.h"

    18

#include "cargotype.h"

    19

#include "station_gui.h"

    20

#include "station_func.h"

    21

#include "strings_func.h"

    22

#include "core/alloc_func.hpp"

    23

#include "window_func.h"

    24

#include "viewport_func.h"

    25

#include "gfx_func.h"

    26

#include "widgets/dropdown_func.h"

    27

#include "newgrf_cargo.h"

    28

#include "string_func.h"

    29

    30

#include "table/strings.h"

    31

#include "table/sprites.h"

    32

    33

typedef int CDECL StationSortListingTypeFunction(const void*, const void*);

    34

    35

static StationSortListingTypeFunction StationNameSorter;

    36

static StationSortListingTypeFunction StationTypeSorter;

    37

static StationSortListingTypeFunction StationWaitingSorter;

    38

static StationSortListingTypeFunction StationRatingMaxSorter;

    39

    40

bool _station_show_coverage;

    41

    42

/**

    43

 * Draw small boxes of cargo amount and ratings data at the given

    44

 * coordinates. If amount exceeds 576 units, it is shown 'full', same

    45

 * goes for the rating: at above 90% orso (224) it is also 'full'

    46

 *

    47

 * @param x coordinate to draw the box at

    48

 * @param y coordinate to draw the box at

    49

 * @param type Cargo type

    50

 * @param amount Cargo amount

    51

 * @param rating ratings data for that particular cargo

    52

 *

    53

 * @note Each cargo-bar is 16 pixels wide and 6 pixels high

    54

 * @note Each rating 14 pixels wide and 1 pixel high and is 1 pixel below the cargo-bar

    55

 */

    56

static void StationsWndShowStationRating(int x, int y, CargoID type, uint amount, byte rating)

    57

{

    58

	static const uint units_full  = 576; ///< number of units to show station as 'full'

    59

	static const uint rating_full = 224; ///< rating needed so it is shown as 'full'

    60

    61

	const CargoSpec *cs = GetCargo(type);

    62

	if (!cs->IsValid()) return;

    63

    64

	int colour = cs->rating_colour;

    65

	uint w = (minu(amount, units_full) + 5) / 36;

    66

    67

	/* Draw total cargo (limited) on station (fits into 16 pixels) */

    68

	if (w != 0) GfxFillRect(x, y, x + w - 1, y + 6, colour);

    69

    70

	/* Draw a one pixel-wide bar of additional cargo meter, useful

    71

	 * for stations with only a small amount (<=30) */

    72

	if (w == 0) {

    73

		uint rest = amount / 5;

    74

		if (rest != 0) {

    75

			w += x;

    76

			GfxFillRect(w, y + 6 - rest, w, y + 6, colour);

    77

		}

    78

	}

    79

    80

	DrawString(x + 1, y, cs->abbrev, TC_BLACK);

    81

    82

	/* Draw green/red ratings bar (fits into 14 pixels) */

    83

	y += 8;

    84

	GfxFillRect(x + 1, y, x + 14, y, 0xB8);

    85

	rating = minu(rating, rating_full) / 16;

    86

	if (rating != 0) GfxFillRect(x + 1, y, x + rating, y, 0xD0);

    87

}

    88

    89

const StringID _station_sort_listing[] = {

    90

	STR_SORT_BY_DROPDOWN_NAME,

    91

	STR_SORT_BY_FACILITY,

    92

	STR_SORT_BY_WAITING,

    93

	STR_SORT_BY_RATING_MAX,

    94

	INVALID_STRING_ID

    95

};

    96

    97

static char _bufcache[64];

    98

static const Station *_last_station;

    99

static int _internal_sort_order;

   100

   101

static int CDECL StationNameSorter(const void *a, const void *b)

   102

{

   103

	const Station *st1 = *(const Station**)a;

   104

	const Station *st2 = *(const Station**)b;

   105

	char buf1[64];

   106

   107

	SetDParam(0, st1->index);

   108

	GetString(buf1, STR_STATION, lastof(buf1));

   109

   110

	if (st2 != _last_station) {

   111

		_last_station = st2;

   112

		SetDParam(0, st2->index);

   113

		GetString(_bufcache, STR_STATION, lastof(_bufcache));

   114

	}

   115

   116

	int r = strcmp(buf1, _bufcache); // sort by name

   117

	return (_internal_sort_order & 1) ? -r : r;

   118

}

   119

   120

static int CDECL StationTypeSorter(const void *a, const void *b)

   121

{

   122

	const Station *st1 = *(const Station**)a;

   123

	const Station *st2 = *(const Station**)b;

   124

	return (_internal_sort_order & 1) ? st2->facilities - st1->facilities : st1->facilities - st2->facilities;

   125

}

   126

   127

static const uint32 _cargo_filter_max = UINT32_MAX;

   128

static uint32 _cargo_filter = _cargo_filter_max;

   129

   130

static int CDECL StationWaitingSorter(const void *a, const void *b)

   131

{

   132

	const Station *st1 = *(const Station**)a;

   133

	const Station *st2 = *(const Station**)b;

   134

	Money sum1 = 0, sum2 = 0;

   135

   136

	for (CargoID j = 0; j < NUM_CARGO; j++) {

   137

		if (!HasBit(_cargo_filter, j)) continue;

   138

		if (!st1->goods[j].cargo.Empty()) sum1 += GetTransportedGoodsIncome(st1->goods[j].cargo.Count(), 20, 50, j);

   139

		if (!st2->goods[j].cargo.Empty()) sum2 += GetTransportedGoodsIncome(st2->goods[j].cargo.Count(), 20, 50, j);

   140

	}

   141

   142

	return (_internal_sort_order & 1) ? ClampToI32(sum2 - sum1) : ClampToI32(sum1 - sum2);

   143

}

   144

   145

/**

   146

 * qsort-compatible version of sorting two stations by maximum rating

   147

 * @param a   First object to be sorted, must be of type (const Station *)

   148

 * @param b   Second object to be sorted, must be of type (const Station *)

   149

 * @return    The sort order

   150

 * @retval >0 a should come before b in the list

   151

 * @retval <0 b should come before a in the list

   152

 */

   153

static int CDECL StationRatingMaxSorter(const void *a, const void *b)

   154

{

   155

	const Station *st1 = *(const Station**)a;

   156

	const Station *st2 = *(const Station**)b;

   157

	byte maxr1 = 0;

   158

	byte maxr2 = 0;

   159

   160

	for (CargoID j = 0; j < NUM_CARGO; j++) {

   161

		if (HasBit(st1->goods[j].acceptance_pickup, GoodsEntry::PICKUP)) maxr1 = max(maxr1, st1->goods[j].rating);

   162

		if (HasBit(st2->goods[j].acceptance_pickup, GoodsEntry::PICKUP)) maxr2 = max(maxr2, st2->goods[j].rating);

   163

	}

   164

   165

	return (_internal_sort_order & 1) ? maxr2 - maxr1 : maxr1 - maxr2;

   166

}

   167

   168

typedef GUIList<const Station*> GUIStationList;

   169

   170

/**

   171

 * Set the station sort flag for all station-list windows.

   172

 * @param sl_flag Sort list flag to set for all station-list windows

   173

 */

   174

static void SetStationListsFlag(SortListFlags sl_flag)

   175

{

   176

	Window *const *wz;

   177

   178

	FOR_ALL_WINDOWS(wz) {

   179

		Window *w = *wz;

   180

		if (w->window_class == WC_STATION_LIST) {

   181

			dynamic_cast<GUIStationList*>(w)->flags |= sl_flag;

   182

			w->SetDirty();

   183

		}

   184

	}

   185

}

   186

   187

/**

   188

 * Set the 'VL_REBUILD' flag for all station lists

   189

 */

   190

void RebuildStationLists()

   191

{

   192

	SetStationListsFlag(VL_REBUILD);

   193

}

   194

   195

/**

   196

 * Set the 'VL_RESORT' flag for all station lists

   197

 */

   198

void ResortStationLists()

   199

{

   200

	SetStationListsFlag(VL_RESORT);

   201

}

   202

   203

/**

   204

 * Rebuild station list if the VL_REBUILD flag is set

   205

 *

   206

 * @param sl pointer to plstations_d (station list and flags)

   207

 * @param owner player whose stations are to be in list

   208

 * @param facilities types of stations of interest

   209

 * @param cargo_filter bitmap of cargo types to include

   210

 * @param include_empty whether we should include stations without waiting cargo

   211

 */

   212

static void BuildStationsList(GUIStationList *sl, PlayerID owner, byte facilities, uint32 cargo_filter, bool include_empty)

   213

{

   214

	uint n = 0;

   215

	const Station *st;

   216

   217

	if (!(sl->flags & VL_REBUILD)) return;

   218

   219

	/* Create array for sorting */

   220

	const Station **station_sort = MallocT<const Station*>(GetMaxStationIndex() + 1);

   221

   222

	DEBUG(misc, 3, "Building station list for player %d", owner);

   223

   224

	FOR_ALL_STATIONS(st) {

   225

		if (st->owner == owner || (st->owner == OWNER_NONE && !st->IsBuoy() && HasStationInUse(st->index, owner))) {

   226

			if (facilities & st->facilities) { //only stations with selected facilities

   227

				int num_waiting_cargo = 0;

   228

				for (CargoID j = 0; j < NUM_CARGO; j++) {

   229

					if (!st->goods[j].cargo.Empty()) {

   230

						num_waiting_cargo++; //count number of waiting cargo

   231

						if (HasBit(cargo_filter, j)) {

   232

							station_sort[n++] = st;

   233

							break;

   234

						}

   235

					}

   236

				}

   237

				/* stations without waiting cargo */

   238

				if (num_waiting_cargo == 0 && include_empty) {

   239

					station_sort[n++] = st;

   240

				}

   241

			}

   242

		}

   243

	}

   244

   245

	free((void*)sl->sort_list);

   246

	sl->sort_list = MallocT<const Station*>(n);

   247

	sl->list_length = n;

   248

   249

	for (uint i = 0; i < n; ++i) sl->sort_list[i] = station_sort[i];

   250

   251

	sl->flags &= ~VL_REBUILD;

   252

	sl->flags |= VL_RESORT;

   253

	free((void*)station_sort);

   254

}

   255

   256

   257

/**

   258

 * Sort station list if the VL_RESORT flag is set

   259

 *

   260

 * @param sl pointer to plstations_d (station list and flags)

   261

 */

   262

static void SortStationsList(GUIStationList *sl)

   263

{

   264

	static StationSortListingTypeFunction *const _station_sorter[] = {

   265

		&StationNameSorter,

   266

		&StationTypeSorter,

   267

		&StationWaitingSorter,

   268

		&StationRatingMaxSorter

   269

	};

   270

   271

	if (!(sl->flags & VL_RESORT)) return;

   272

   273

	_internal_sort_order = sl->flags & VL_DESC;

   274

	_last_station = NULL; // used for "cache" in namesorting

   275

	qsort((void*)sl->sort_list, sl->list_length, sizeof(sl->sort_list[0]), _station_sorter[sl->sort_type]);

   276

   277

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   278

	sl->flags &= ~VL_RESORT;

   279

}

   280

   281

/**

   282

 * The list of stations per player.

   283

 */

   284

struct PlayerStationsWindow : public Window, public GUIStationList

   285

{

   286

	static Listing station_sort;

   287

	static byte facilities;

   288

	static bool include_empty;

   289

   290

	PlayerStationsWindow(const WindowDesc *desc, WindowNumber window_number) : Window(desc, window_number)

   291

	{

   292

		this->caption_color = (byte)this->window_number;

   293

		this->vscroll.cap = 12;

   294

		this->resize.step_height = 10;

   295

		this->resize.height = this->height - 10 * 7; // minimum if 5 in the list

   296

   297

		/* Add cargo filter buttons */

   298

		uint num_active = 0;

   299

		for (CargoID c = 0; c < NUM_CARGO; c++) {

   300

			if (GetCargo(c)->IsValid()) num_active++;

   301

		}

   302

   303

		this->widget_count += num_active;

   304

		this->widget = ReallocT(this->widget, this->widget_count + 1);

   305

		this->widget[this->widget_count].type = WWT_LAST;

   306

   307

		uint i = 0;

   308

		for (CargoID c = 0; c < NUM_CARGO; c++) {

   309

			if (!GetCargo(c)->IsValid()) continue;

   310

   311

			Widget *wi = &this->widget[SLW_CARGOSTART + i];

   312

			wi->type     = WWT_PANEL;

   313

			wi->display_flags = RESIZE_NONE;

   314

			wi->color    = 14;

   315

			wi->left     = 89 + i * 14;

   316

			wi->right    = wi->left + 13;

   317

			wi->top      = 14;

   318

			wi->bottom   = 24;

   319

			wi->data     = 0;

   320

			wi->tooltips = STR_USE_CTRL_TO_SELECT_MORE;

   321

   322

			if (HasBit(_cargo_filter, c)) this->LowerWidget(SLW_CARGOSTART + i);

   323

			i++;

   324

		}

   325

   326

		this->widget[SLW_NOCARGOWAITING].left += num_active * 14;

   327

		this->widget[SLW_NOCARGOWAITING].right += num_active * 14;

   328

		this->widget[SLW_CARGOALL].left += num_active * 14;

   329

		this->widget[SLW_CARGOALL].right += num_active * 14;

   330

		this->widget[SLW_PAN_RIGHT].left += num_active * 14;

   331

   332

		if (num_active > 15) {

   333

			/* Resize and fix the minimum width, if necessary */

   334

			ResizeWindow(this, (num_active - 15) * 14, 0);

   335

			this->resize.width = this->width;

   336

		}

   337

   338

		if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   339

   340

		for (uint i = 0; i < 5; i++) {

   341

			if (HasBit(facilities, i)) this->LowerWidget(i + SLW_TRAIN);

   342

		}

   343

		this->SetWidgetLoweredState(SLW_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   344

		this->SetWidgetLoweredState(SLW_CARGOALL, _cargo_filter == _cargo_mask && include_empty);

   345

		this->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   346

   347

		this->sort_list = NULL;

   348

		this->flags = VL_REBUILD;

   349

		this->sort_type = station_sort.criteria;

   350

		if (station_sort.order) this->flags |= VL_DESC;

   351

   352

		/* set up resort timer */

   353

		this->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   354

	}

   355

   356

	virtual void OnPaint()

   357

	{

   358

		PlayerID owner = (PlayerID)this->window_number;

   359

   360

		BuildStationsList(this, owner, facilities, _cargo_filter, include_empty);

   361

		SortStationsList(this);

   362

   363

		SetVScrollCount(this, this->list_length);

   364

   365

		/* draw widgets, with player's name in the caption */

   366

		SetDParam(0, owner);

   367

		SetDParam(1, this->vscroll.count);

   368

   369

		/* Set text of sort by dropdown */

   370

		this->widget[SLW_SORTDROPBTN].data = _station_sort_listing[this->sort_type];

   371

   372

		this->DrawWidgets();

   373

   374

		/* draw arrow pointing up/down for ascending/descending sorting */

   375

		this->DrawSortButtonState(SLW_SORTBY, this->flags & VL_DESC ? SBS_DOWN : SBS_UP);

   376

   377

		int cg_ofst;

   378

		int x = 89;

   379

		int y = 14;

   380

		int xb = 2; ///< offset from left of widget

   381

   382

		uint i = 0;

   383

		for (CargoID c = 0; c < NUM_CARGO; c++) {

   384

			const CargoSpec *cs = GetCargo(c);

   385

			if (!cs->IsValid()) continue;

   386

   387

			cg_ofst = HasBit(_cargo_filter, c) ? 2 : 1;

   388

			GfxFillRect(x + cg_ofst, y + cg_ofst, x + cg_ofst + 10 , y + cg_ofst + 7, cs->rating_colour);

   389

			DrawStringCentered(x + 6 + cg_ofst, y + cg_ofst, cs->abbrev, TC_BLACK);

   390

			x += 14;

   391

			i++;

   392

		}

   393

   394

		x += 6;

   395

		cg_ofst = this->IsWidgetLowered(SLW_NOCARGOWAITING) ? 2 : 1;

   396

		DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_NONE, TC_BLACK);

   397

		x += 14;

   398

		cg_ofst = this->IsWidgetLowered(SLW_CARGOALL) ? 2 : 1;

   399

		DrawStringCentered(x + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, TC_BLACK);

   400

   401

		cg_ofst = this->IsWidgetLowered(SLW_FACILALL) ? 2 : 1;

   402

		DrawString(71 + cg_ofst, y + cg_ofst, STR_ABBREV_ALL, TC_BLACK);

   403

   404

		if (this->vscroll.count == 0) { // player has no stations

   405

			DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   406

			return;

   407

		}

   408

   409

		int max = min(this->vscroll.pos + this->vscroll.cap, this->list_length);

   410

		y = 40; // start of the list-widget

   411

   412

		for (int i = this->vscroll.pos; i < max; ++i) { // do until max number of stations of owner

   413

			const Station *st = this->sort_list[i];

   414

			int x;

   415

   416

			assert(st->xy != 0);

   417

   418

			/* Do not do the complex check HasStationInUse here, it may be even false

   419

				* when the order had been removed and the station list hasn't been removed yet */

   420

			assert(st->owner == owner || (st->owner == OWNER_NONE && !st->IsBuoy()));

   421

   422

			SetDParam(0, st->index);

   423

			SetDParam(1, st->facilities);

   424

			x = DrawString(xb, y, STR_3049_0, TC_FROMSTRING) + 5;

   425

   426

			/* show cargo waiting and station ratings */

   427

			for (CargoID j = 0; j < NUM_CARGO; j++) {

   428

				if (!st->goods[j].cargo.Empty()) {

   429

					StationsWndShowStationRating(x, y, j, st->goods[j].cargo.Count(), st->goods[j].rating);

   430

					x += 20;

   431

				}

   432

			}

   433

			y += 10;

   434

		}

   435

	}

   436

   437

	virtual void OnClick(Point pt, int widget)

   438

	{

   439

		switch (widget) {

   440

			case SLW_LIST: {

   441

				uint32 id_v = (pt.y - 41) / 10;

   442

   443

				if (id_v >= this->vscroll.cap) return; // click out of bounds

   444

   445

				id_v += this->vscroll.pos;

   446

   447

				if (id_v >= this->list_length) return; // click out of list bound

   448

   449

				const Station *st = this->sort_list[id_v];

   450

				/* do not check HasStationInUse - it is slow and may be invalid */

   451

				assert(st->owner == (PlayerID)this->window_number || (st->owner == OWNER_NONE && !st->IsBuoy()));

   452

   453

				if (_ctrl_pressed) {

   454

					ShowExtraViewPortWindow(st->xy);

   455

				} else {

   456

					ScrollMainWindowToTile(st->xy);

   457

				}

   458

				break;

   459

			}

   460

   461

			case SLW_TRAIN:

   462

			case SLW_TRUCK:

   463

			case SLW_BUS:

   464

			case SLW_AIRPLANE:

   465

			case SLW_SHIP:

   466

				if (_ctrl_pressed) {

   467

					ToggleBit(facilities, widget - SLW_TRAIN);

   468

					this->ToggleWidgetLoweredState(widget);

   469

				} else {

   470

					uint i;

   471

					FOR_EACH_SET_BIT(i, facilities) {

   472

						this->RaiseWidget(i + SLW_TRAIN);

   473

					}

   474

					SetBit(facilities, widget - SLW_TRAIN);

   475

					this->LowerWidget(widget);

   476

				}

   477

				this->SetWidgetLoweredState(SLW_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   478

				this->flags |= VL_REBUILD;

   479

				this->SetDirty();

   480

				break;

   481

   482

			case SLW_FACILALL:

   483

				for (uint i = 0; i < 5; i++) {

   484

					this->LowerWidget(i + SLW_TRAIN);

   485

				}

   486

				this->LowerWidget(SLW_FACILALL);