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

bool _station_show_coverage;

    34

    35

/**

    36

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

    37

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

    38

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

    39

 *

    40

 * @param x coordinate to draw the box at

    41

 * @param y coordinate to draw the box at

    42

 * @param type Cargo type

    43

 * @param amount Cargo amount

    44

 * @param rating ratings data for that particular cargo

    45

 *

    46

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

    47

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

    48

 */

    49

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

    50

{

    51

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

    52

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

    53

    54

	const CargoSpec *cs = GetCargo(type);

    55

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

    56

    57

	int colour = cs->rating_colour;

    58

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

    59

    60

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

    61

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

    62

    63

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

    64

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

    65

	if (w == 0) {

    66

		uint rest = amount / 5;

    67

		if (rest != 0) {

    68

			w += x;

    69

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

    70

		}

    71

	}

    72

    73

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

    74

    75

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

    76

	y += 8;

    77

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

    78

	rating = minu(rating, rating_full) / 16;

    79

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

    80

}

    81

    82

typedef GUIList<const Station*> GUIStationList;

    83

    84

/**

    85

 * The list of stations per player.

    86

 */

    87

class PlayerStationsWindow : public Window

    88

{

    89

protected:

    90

	/* Runtime saved values */

    91

	static Listing last_sorting;

    92

	static byte facilities;               // types of stations of interest

    93

	static bool include_empty;            // whether we should include stations without waiting cargo

    94

	static const uint32 cargo_filter_max;

    95

	static uint32 cargo_filter;           // bitmap of cargo types to include

    96

	static const Station *last_station;

    97

    98

	/* Constants for sorting stations */

    99

	static const StringID sorter_names[];

   100

	static GUIStationList::SortFunction *const sorter_funcs[];

   101

   102

	GUIStationList stations;

   103

   104

   105

	/**

   106

	 * (Re)Build station list

   107

	 *

   108

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

   109

	 */

   110

	void BuildStationsList(const PlayerID owner)

   111

	{

   112

		if (!this->stations.NeedRebuild()) return;

   113

   114

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

   115

   116

		this->stations.Clear();

   117

   118

		const Station *st;

   119

		FOR_ALL_STATIONS(st) {

   120

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

   121

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

   122

					int num_waiting_cargo = 0;

   123

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

   124

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

   125

							num_waiting_cargo++; // count number of waiting cargo

   126

							if (HasBit(this->cargo_filter, j)) {

   127

								*this->stations.Append() = st;

   128

								break;

   129

							}

   130

						}

   131

					}

   132

					/* stations without waiting cargo */

   133

					if (num_waiting_cargo == 0 && this->include_empty) {

   134

						*this->stations.Append() = st;

   135

					}

   136

				}

   137

			}

   138

		}

   139

   140

		this->stations.Compact();

   141

		this->stations.RebuildDone();

   142

	}

   143

   144

	/** Sort stations by their name */

   145

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

   146

	{

   147

		static char buf_cache[64];

   148

		char buf[64];

   149

   150

		SetDParam(0, (*a)->index);

   151

		GetString(buf, STR_STATION, lastof(buf));

   152

   153

		if (*b != last_station) {

   154

			last_station = *b;

   155

			SetDParam(0, (*b)->index);

   156

			GetString(buf_cache, STR_STATION, lastof(buf_cache));

   157

		}

   158

   159

		return strcmp(buf, buf_cache);

   160

	}

   161

   162

	/** Sort stations by their type */

   163

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

   164

	{

   165

		return (*a)->facilities - (*b)->facilities;

   166

	}

   167

   168

	/** Sort stations by their waiting cargo */

   169

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

   170

	{

   171

		Money sum1 = 0;

   172

		Money sum2 = 0;

   173

   174

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

   175

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

   176

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

   177

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

   178

		}

   179

   180

		return ClampToI32(sum1 - sum2);

   181

	}

   182

   183

	/** Sort stations by their rating */

   184

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

   185

	{

   186

		byte maxr1 = 0;

   187

		byte maxr2 = 0;

   188

   189

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

   190

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

   191

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

   192

		}

   193

   194

		return maxr1 - maxr2;

   195

	}

   196

   197

	/** Sort the stations list */

   198

	void SortStationsList()

   199

	{

   200

		if (!this->stations.Sort()) return;

   201

   202

		/* Reset name sorter sort cache */

   203

		this->last_station = NULL;

   204

   205

		/* Set the modified widget dirty */

   206

		this->InvalidateWidget(SLW_LIST);

   207

	}

   208

   209

public:

   210

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

   211

	{

   212

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

   213

		this->vscroll.cap = 12;

   214

		this->resize.step_height = 10;

   215

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

   216

   217

		/* Add cargo filter buttons */

   218

		uint num_active = 0;

   219

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

   220

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

   221

		}

   222

   223

		this->widget_count += num_active;

   224

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

   225

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

   226

   227

		uint i = 0;

   228

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

   229

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

   230

   231

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

   232

			wi->type     = WWT_PANEL;

   233

			wi->display_flags = RESIZE_NONE;

   234

			wi->color    = 14;

   235

			wi->left     = 89 + i * 14;

   236

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

   237

			wi->top      = 14;

   238

			wi->bottom   = 24;

   239

			wi->data     = 0;

   240

			wi->tooltips = STR_USE_CTRL_TO_SELECT_MORE;

   241

   242

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

   243

			i++;

   244

		}

   245

   246

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

   247

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

   248

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

   249

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

   250

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

   251

   252

		if (num_active > 15) {

   253

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

   254

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

   255

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

   256

		}

   257

   258

		if (this->cargo_filter == this->cargo_filter_max) this->cargo_filter = _cargo_mask;

   259

   260

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

   261

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

   262

		}

   263

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

   264

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

   265

		this->SetWidgetLoweredState(SLW_NOCARGOWAITING, this->include_empty);

   266

   267

		this->stations.SetListing(this->last_sorting);

   268

		this->stations.SetSortFuncs(this->sorter_funcs);

   269

		this->stations.ForceRebuild();

   270

		this->stations.NeedResort();

   271

		this->SortStationsList();

   272

   273

		this->widget[SLW_SORTDROPBTN].data = this->sorter_names[this->stations.SortType()];

   274

   275

		this->FindWindowPlacementAndResize(desc);

   276

	}

   277

   278

	~PlayerStationsWindow()

   279

	{

   280

		this->last_sorting = this->stations.GetListing();

   281

	}

   282

   283

	virtual void OnPaint()

   284

	{

   285

		const PlayerID owner = (PlayerID)this->window_number;

   286

   287

		this->BuildStationsList(owner);

   288

		this->SortStationsList();

   289

   290

		SetVScrollCount(this, this->stations.Length());

   291

   292

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

   293

		SetDParam(0, owner);

   294

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

   295

   296

		this->DrawWidgets();

   297

   298

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

   299

		this->DrawSortButtonState(SLW_SORTBY, this->stations.IsDescSortOrder() ? SBS_DOWN : SBS_UP);

   300

   301

		int cg_ofst;

   302

		int x = 89;

   303

		int y = 14;

   304

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

   305

   306

		uint i = 0;

   307

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

   308

			const CargoSpec *cs = GetCargo(c);

   309

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

   310

   311

			cg_ofst = HasBit(this->cargo_filter, c) ? 2 : 1;

   312

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

   313

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

   314

			x += 14;

   315

			i++;

   316

		}

   317

   318

		x += 6;

   319

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

   320

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

   321

		x += 14;

   322

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

   323

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

   324

   325

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

   326

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

   327

   328

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

   329

			DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   330

			return;

   331

		}

   332

   333

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

   334

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

   335

   336

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

   337

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

   338

			int x;

   339

   340

			assert(st->xy != 0);

   341

   342

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

   343

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

   344

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

   345

   346

			SetDParam(0, st->index);

   347

			SetDParam(1, st->facilities);

   348

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

   349

   350

			/* show cargo waiting and station ratings */

   351

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

   352

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

   353

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

   354

					x += 20;

   355

				}

   356

			}

   357

			y += 10;

   358

		}

   359

	}

   360

   361

	virtual void OnClick(Point pt, int widget)

   362

	{

   363

		switch (widget) {

   364

			case SLW_LIST: {

   365

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

   366

   367

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

   368

   369

				id_v += this->vscroll.pos;

   370

   371

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

   372

   373

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

   374

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

   375

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

   376

   377

				if (_ctrl_pressed) {

   378

					ShowExtraViewPortWindow(st->xy);

   379

				} else {

   380

					ScrollMainWindowToTile(st->xy);

   381

				}

   382

				break;

   383

			}

   384

   385

			case SLW_TRAIN:

   386

			case SLW_TRUCK:

   387

			case SLW_BUS:

   388

			case SLW_AIRPLANE:

   389

			case SLW_SHIP:

   390

				if (_ctrl_pressed) {

   391

					ToggleBit(this->facilities, widget - SLW_TRAIN);

   392

					this->ToggleWidgetLoweredState(widget);

   393

				} else {

   394

					uint i;

   395

					FOR_EACH_SET_BIT(i, this->facilities) {

   396

						this->RaiseWidget(i + SLW_TRAIN);

   397

					}

   398

					SetBit(this->facilities, widget - SLW_TRAIN);

   399

					this->LowerWidget(widget);

   400

				}

   401

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

   402

				this->stations.ForceRebuild();

   403

				this->SetDirty();

   404

				break;

   405

   406

			case SLW_FACILALL:

   407

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

   408

					this->LowerWidget(i + SLW_TRAIN);

   409

				}

   410

				this->LowerWidget(SLW_FACILALL);

   411

   412

				this->facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;

   413

				this->stations.ForceRebuild();

   414

				this->SetDirty();

   415

				break;

   416

   417

			case SLW_CARGOALL: {

   418

				uint i = 0;

   419

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

   420

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

   421

					this->LowerWidget(i + SLW_CARGOSTART);

   422

					i++;

   423

				}

   424

				this->LowerWidget(SLW_NOCARGOWAITING);

   425

				this->LowerWidget(SLW_CARGOALL);

   426

   427

				this->cargo_filter = _cargo_mask;

   428

				this->include_empty = true;

   429

				this->stations.ForceRebuild();

   430

				this->SetDirty();

   431

				break;

   432

			}

   433

   434

			case SLW_SORTBY: // flip sorting method asc/desc

   435

				this->stations.ToggleSortOrder();

   436

				this->flags4 |= 5 << WF_TIMEOUT_SHL;

   437

				this->LowerWidget(SLW_SORTBY);

   438

				this->SetDirty();

   439

				break;

   440

   441

			case SLW_SORTDROPBTN: // select sorting criteria dropdown menu

   442

				ShowDropDownMenu(this, this->sorter_names, this->stations.SortType(), SLW_SORTDROPBTN, 0, 0);

   443

				break;

   444

   445

			case SLW_NOCARGOWAITING:

   446

				if (_ctrl_pressed) {

   447

					this->include_empty = !this->include_empty;

   448

					this->ToggleWidgetLoweredState(SLW_NOCARGOWAITING);

   449

				} else {

   450

					for (uint i = SLW_CARGOSTART; i < this->widget_count; i++) {

   451

						this->RaiseWidget(i);

   452

					}

   453

   454

					this->cargo_filter = 0;

   455

					this->include_empty = true;

   456

   457

					this->LowerWidget(SLW_NOCARGOWAITING);

   458

				}

   459

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

   460

				this->stations.ForceRebuild();

   461

				this->SetDirty();

   462

				break;

   463

   464

			default:

   465

				if (widget >= SLW_CARGOSTART) { // change cargo_filter

   466

					/* Determine the selected cargo type */

   467

					CargoID c;

   468

					int i = 0;

   469

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

   470

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

   471

						if (widget - SLW_CARGOSTART == i) break;

   472

						i++;

   473

					}

   474

   475

					if (_ctrl_pressed) {

   476

						ToggleBit(this->cargo_filter, c);

   477

						this->ToggleWidgetLoweredState(widget);

   478

					} else {

   479

						for (uint i = SLW_CARGOSTART; i < this->widget_count; i++) {

   480

							this->RaiseWidget(i);

   481

						}

   482

						this->RaiseWidget(SLW_NOCARGOWAITING);

   483

   484

						this->cargo_filter = 0;

   485

						this->include_empty = false;

   486

   487

						SetBit(this->cargo_filter, c);

   488

						this->LowerWidget(widget);

   489