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

    29

#include "table/strings.h"

    30

#include "table/sprites.h"

    31

    32

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

    33

    34

static StationSortListingTypeFunction StationNameSorter;

    35

static StationSortListingTypeFunction StationTypeSorter;

    36

static StationSortListingTypeFunction StationWaitingSorter;

    37

static StationSortListingTypeFunction StationRatingMaxSorter;

    38

    39

bool _station_show_coverage;

    40

    41

/**

    42

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

    43

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

    44

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

    45

 *

    46

 * @param x coordinate to draw the box at

    47

 * @param y coordinate to draw the box at

    48

 * @param type Cargo type

    49

 * @param amount Cargo amount

    50

 * @param rating ratings data for that particular cargo

    51

 *

    52

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

    53

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

    54

 */

    55

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

    56

{

    57

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

    58

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

    59

    60

	const CargoSpec *cs = GetCargo(type);

    61

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

    62

    63

	int colour = cs->rating_colour;

    64

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

    65

    66

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

    67

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

    68

    69

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

    70

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

    71

	if (w == 0) {

    72

		uint rest = amount / 5;

    73

		if (rest != 0) {

    74

			w += x;

    75

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

    76

		}

    77

	}

    78

    79

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

    80

    81

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

    82

	y += 8;

    83

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

    84

	rating = minu(rating, rating_full) / 16;

    85

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

    86

}

    87

    88

const StringID _station_sort_listing[] = {

    89

	STR_SORT_BY_DROPDOWN_NAME,

    90

	STR_SORT_BY_FACILITY,

    91

	STR_SORT_BY_WAITING,

    92

	STR_SORT_BY_RATING_MAX,

    93

	INVALID_STRING_ID

    94

};

    95

    96

static char _bufcache[64];

    97

static const Station *_last_station;

    98

static int _internal_sort_order;

    99

   100

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

   101

{

   102

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

   103

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

   104

	char buf1[64];

   105

   106

	SetDParam(0, st1->index);

   107

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

   108

   109

	if (st2 != _last_station) {

   110

		_last_station = st2;

   111

		SetDParam(0, st2->index);

   112

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

   113

	}

   114

   115

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

   116

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

   117

}

   118

   119

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

   120

{

   121

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

   122

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

   123

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

   124

}

   125

   126

static const uint32 _cargo_filter_max = UINT32_MAX;

   127

static uint32 _cargo_filter = _cargo_filter_max;

   128

   129

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

   130

{

   131

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

   132

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

   133

	Money sum1 = 0, sum2 = 0;

   134

   135

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

   136

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

   137

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

   138

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

   139

	}

   140

   141

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

   142

}

   143

   144

/**

   145

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

   146

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

   147

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

   148

 * @return    The sort order

   149

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

   150

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

   151

 */

   152

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

   153

{

   154

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

   155

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

   156

	byte maxr1 = 0;

   157

	byte maxr2 = 0;

   158

   159

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

   160

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

   161

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

   162

	}

   163

   164

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

   165

}

   166

   167

/** Flags for station list */

   168

enum StationListFlags {

   169

	SL_ORDER   = 1 << 0, ///< Order - ascending (=0), descending (=1)

   170

	SL_RESORT  = 1 << 1, ///< Resort the list

   171

	SL_REBUILD = 1 << 2, ///< Rebuild the list

   172

};

   173

   174

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   175

   176

/** Information about station list */

   177

struct plstations_d {

   178

	const Station **sort_list; ///< Pointer to list of stations

   179

	uint16 list_length;        ///< Number of stations in list

   180

	uint16 resort_timer;       ///< Tick counter to resort the list

   181

	byte sort_type;            ///< Sort type - name, waiting, ...

   182

	byte flags;                ///< Flags - SL_ORDER, SL_RESORT, SL_REBUILD

   183

};

   184

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   185

   186

/**

   187

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

   188

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

   189

 */

   190

static void SetStationListsFlag(StationListFlags sl_flag)

   191

{

   192

	Window *const *wz;

   193

   194

	FOR_ALL_WINDOWS(wz) {

   195

		Window *w = *wz;

   196

		if (w->window_class == WC_STATION_LIST) {

   197

			WP(w, plstations_d).flags |= sl_flag;

   199

		}

   200

	}

   201

}

   202

   203

/**

   204

 * Set the 'SL_REBUILD' flag for all station lists

   205

 */

   206

void RebuildStationLists()

   207

{

   208

	SetStationListsFlag(SL_REBUILD);

   209

}

   210

   211

/**

   212

 * Set the 'SL_RESORT' flag for all station lists

   213

 */

   214

void ResortStationLists()

   215

{

   216

	SetStationListsFlag(SL_RESORT);

   217

}

   218

   219

/**

   220

 * Rebuild station list if the SL_REBUILD flag is set

   221

 *

   222

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

   223

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

   224

 * @param facilities types of stations of interest

   225

 * @param cargo_filter bitmap of cargo types to include

   226

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

   227

 */

   228

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

   229

{

   230

	uint n = 0;

   231

	const Station *st;

   232

   233

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

   234

   235

	/* Create array for sorting */

   236

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

   237

   238

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

   239

   240

	FOR_ALL_STATIONS(st) {

   241

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

   242

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

   243

				int num_waiting_cargo = 0;

   244

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

   245

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

   246

						num_waiting_cargo++; //count number of waiting cargo

   247

						if (HasBit(cargo_filter, j)) {

   248

							station_sort[n++] = st;

   249

							break;

   250

						}

   251

					}

   252

				}

   253

				/* stations without waiting cargo */

   254

				if (num_waiting_cargo == 0 && include_empty) {

   255

					station_sort[n++] = st;

   256

				}

   257

			}

   258

		}

   259

	}

   260

   261

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

   262

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

   263

	sl->list_length = n;

   264

   265

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

   266

   267

	sl->flags &= ~SL_REBUILD;

   268

	sl->flags |= SL_RESORT;

   269

	free((void*)station_sort);

   270

}

   271

   272

   273

/**

   274

 * Sort station list if the SL_RESORT flag is set

   275

 *

   276

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

   277

 */

   278

static void SortStationsList(plstations_d *sl)

   279

{

   280

	static StationSortListingTypeFunction *const _station_sorter[] = {

   281

		&StationNameSorter,

   282

		&StationTypeSorter,

   283

		&StationWaitingSorter,

   284

		&StationRatingMaxSorter

   285

	};

   286

   287

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

   288

   289

	_internal_sort_order = sl->flags & SL_ORDER;

   290

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

   291

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

   292

   293

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   294

	sl->flags &= ~SL_RESORT;

   295

}

   296

   297

/**

   298

 * Fuction called when any WindowEvent occurs for PlayerStations window

   299

 *

   300

 * @param w pointer to the PlayerStations window

   301

 * @param e pointer to window event

   302

 */

   303

static void PlayerStationsWndProc(Window *w, WindowEvent *e)

   304

{

   305

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

   306

	static byte facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;

   307

	static Listing station_sort = {0, 0};

   308

	static bool include_empty = true;

   309

   310

	plstations_d *sl = &WP(w, plstations_d);

   311

   312

	switch (e->event) {

   313

		case WE_CREATE:

   314

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   315

   316

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

   317

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

   318

			}

   319

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

   320

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

   321

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   322

   323

			sl->sort_list = NULL;

   324

			sl->flags = SL_REBUILD;

   325

			sl->sort_type = station_sort.criteria;

   326

			if (station_sort.order) sl->flags |= SL_ORDER;

   327

   328

			/* set up resort timer */

   329

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   330

			break;

   331

   332

		case WE_PAINT: {

   333

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

   334

			SortStationsList(sl);

   335

   336

			SetVScrollCount(w, sl->list_length);

   337

   338

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

   339

			SetDParam(0, owner);

   340

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

   341

   342

			/* Set text of sort by dropdown */

   343

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

   344

   345

			DrawWindowWidgets(w);

   346

   347

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

   348

			DrawSortButtonState(w, SLW_SORTBY, sl->flags & SL_ORDER ? SBS_DOWN : SBS_UP);

   349

   350

			int cg_ofst;

   351

			int x = 89;

   352

			int y = 14;

   353

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

   354

   355

			uint i = 0;

   356

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

   357

				const CargoSpec *cs = GetCargo(c);

   358

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

   359

   360

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

   361

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

   362

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

   363

				x += 14;

   364

				i++;

   365

			}

   366

   367

			x += 6;

   368

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

   369

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

   370

			x += 14;

   371

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

   372

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

   373

   374

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

   375

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

   376

   377

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

   378

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   379

				return;

   380

			}

   381

   382

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

   383

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

   384

   385

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

   386

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

   387

				int x;

   388

   389

				assert(st->xy != 0);

   390

   391

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

   392

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

   393

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

   394

   395

				SetDParam(0, st->index);

   396

				SetDParam(1, st->facilities);

   397

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

   398

   399

				/* show cargo waiting and station ratings */

   400

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

   401

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

   402

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

   403

						x += 20;

   404

					}

   405

				}

   406

				y += 10;

   407

			}

   408

			break;

   409

		}

   410

   411

		case WE_CLICK:

   412

			switch (e->we.click.widget) {

   413

				case SLW_LIST: {

   414

					uint32 id_v = (e->we.click.pt.y - 41) / 10;

   415

   416

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

   417

   418

					id_v += w->vscroll.pos;

   419

   420

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

   421

   422

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

   423

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

   424

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

   425

   426

					if (_ctrl_pressed) {

   427

						ShowExtraViewPortWindow(st->xy);

   428

					} else {

   429

						ScrollMainWindowToTile(st->xy);

   430

					}

   431

					break;

   432

				}

   433

   434

				case SLW_TRAIN:

   435

				case SLW_TRUCK:

   436

				case SLW_BUS:

   437

				case SLW_AIRPLANE:

   438

				case SLW_SHIP:

   439

					if (_ctrl_pressed) {

   440

						ToggleBit(facilities, e->we.click.widget - SLW_TRAIN);

   441

						w->ToggleWidgetLoweredState(e->we.click.widget);

   442

					} else {

   443

						uint i;

   444

						FOR_EACH_SET_BIT(i, facilities) {

   445

							w->RaiseWidget(i + SLW_TRAIN);

   446

						}

   447

						SetBit(facilities, e->we.click.widget - SLW_TRAIN);

   448

						w->LowerWidget(e->we.click.widget);

   449

					}

   450

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

   451

					sl->flags |= SL_REBUILD;

   453

					break;

   454

   455

				case SLW_FACILALL:

   456

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

   457

						w->LowerWidget(i + SLW_TRAIN);

   458

					}

   459

					w->LowerWidget(SLW_FACILALL);

   460

   461

					facilities = FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK;

   462

					sl->flags |= SL_REBUILD;

   464

					break;

   465

   466

				case SLW_CARGOALL: {

   467

					uint i = 0;

   468

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

   469

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

   470

						w->LowerWidget(i + SLW_CARGOSTART);

   471

						i++;

   472

					}

   473

					w->LowerWidget(SLW_NOCARGOWAITING);

   474

					w->LowerWidget(SLW_CARGOALL);

   475

   476

					_cargo_filter = _cargo_mask;

   477

					include_empty = true;

   478

					sl->flags |= SL_REBUILD;

   480

					break;

   481

				}