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"

    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

/** Flags for station list */

   169

enum StationListFlags {

   170

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

   171

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

   172

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

   173

};

   174

   175

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   176

   177

/** Information about station list */

   178

struct plstations_d {

   179

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

   180

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

   181

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

   182

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

   183

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

   184

};

   185

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   186

   187

/**

   188

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

   189

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

   190

 */

   191

static void SetStationListsFlag(StationListFlags sl_flag)

   192

{

   193

	Window *const *wz;

   194

   195

	FOR_ALL_WINDOWS(wz) {

   196

		Window *w = *wz;

   197

		if (w->window_class == WC_STATION_LIST) {

   198

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

   199

			w->SetDirty();

   200

		}

   201

	}

   202

}

   203

   204

/**

   205

 * Set the 'SL_REBUILD' flag for all station lists

   206

 */

   207

void RebuildStationLists()

   208

{

   209

	SetStationListsFlag(SL_REBUILD);

   210

}

   211

   212

/**

   213

 * Set the 'SL_RESORT' flag for all station lists

   214

 */

   215

void ResortStationLists()

   216

{

   217

	SetStationListsFlag(SL_RESORT);

   218

}

   219

   220

/**

   221

 * Rebuild station list if the SL_REBUILD flag is set

   222

 *

   223

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

   224

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

   225

 * @param facilities types of stations of interest

   226

 * @param cargo_filter bitmap of cargo types to include

   227

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

   228

 */

   229

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

   230

{

   231

	uint n = 0;

   232

	const Station *st;

   233

   234

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

   235

   236

	/* Create array for sorting */

   237

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

   238

   239

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

   240

   241

	FOR_ALL_STATIONS(st) {

   242

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

   243

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

   244

				int num_waiting_cargo = 0;

   245

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

   246

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

   247

						num_waiting_cargo++; //count number of waiting cargo

   248

						if (HasBit(cargo_filter, j)) {

   249

							station_sort[n++] = st;

   250

							break;

   251

						}

   252

					}

   253

				}

   254

				/* stations without waiting cargo */

   255

				if (num_waiting_cargo == 0 && include_empty) {

   256

					station_sort[n++] = st;

   257

				}

   258

			}

   259

		}

   260

	}

   261

   262

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

   263

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

   264

	sl->list_length = n;

   265

   266

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

   267

   268

	sl->flags &= ~SL_REBUILD;

   269

	sl->flags |= SL_RESORT;

   270

	free((void*)station_sort);

   271

}

   272

   273

   274

/**

   275

 * Sort station list if the SL_RESORT flag is set

   276

 *

   277

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

   278

 */

   279

static void SortStationsList(plstations_d *sl)

   280

{

   281

	static StationSortListingTypeFunction *const _station_sorter[] = {

   282

		&StationNameSorter,

   283

		&StationTypeSorter,

   284

		&StationWaitingSorter,

   285

		&StationRatingMaxSorter

   286

	};

   287

   288

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

   289

   290

	_internal_sort_order = sl->flags & SL_ORDER;

   291

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

   292

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

   293

   294

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   295

	sl->flags &= ~SL_RESORT;

   296

}

   297

   298

/**

   299

 * Fuction called when any WindowEvent occurs for PlayerStations window

   300

 *

   301

 * @param w pointer to the PlayerStations window

   302

 * @param e pointer to window event

   303

 */

   304

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

   305

{

   306

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

   307

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

   308

	static Listing station_sort = {0, 0};

   309

	static bool include_empty = true;

   310

   311

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

   312

   313

	switch (e->event) {

   314

		case WE_CREATE:

   315

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   316

   317

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

   318

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

   319

			}

   320

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

   321

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

   322

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   323

   324

			sl->sort_list = NULL;

   325

			sl->flags = SL_REBUILD;

   326

			sl->sort_type = station_sort.criteria;

   327

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

   328

   329

			/* set up resort timer */

   330

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   331

			break;

   332

   333

		case WE_PAINT: {

   334

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

   335

			SortStationsList(sl);

   336

   337

			SetVScrollCount(w, sl->list_length);

   338

   339

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

   340

			SetDParam(0, owner);

   341

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

   342

   343

			/* Set text of sort by dropdown */

   344

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

   345

   346

			DrawWindowWidgets(w);

   347

   348

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

   349

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

   350

   351

			int cg_ofst;

   352

			int x = 89;

   353

			int y = 14;

   354

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

   355

   356

			uint i = 0;

   357

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

   358

				const CargoSpec *cs = GetCargo(c);

   359

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

   360

   361

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

   362

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

   363

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

   364

				x += 14;

   365

				i++;

   366

			}

   367

   368

			x += 6;

   369

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

   370

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

   371

			x += 14;

   372

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

   373

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

   374

   375

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

   376

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

   377

   378

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

   379

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   380

				return;

   381

			}

   382

   383

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

   384

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

   385

   386

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

   387

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

   388

				int x;

   389

   390

				assert(st->xy != 0);

   391

   392

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

   393

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

   394

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

   395

   396

				SetDParam(0, st->index);

   397

				SetDParam(1, st->facilities);

   398

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

   399

   400

				/* show cargo waiting and station ratings */

   401

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

   402

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

   403

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

   404

						x += 20;

   405

					}

   406

				}

   407

				y += 10;

   408

			}

   409

			break;

   410

		}

   411

   412

		case WE_CLICK:

   413

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

   414

				case SLW_LIST: {

   415

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

   416

   417

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

   418

   419

					id_v += w->vscroll.pos;

   420

   421

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

   422

   423

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

   424

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

   425

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

   426

   427

					if (_ctrl_pressed) {

   428

						ShowExtraViewPortWindow(st->xy);

   429

					} else {

   430

						ScrollMainWindowToTile(st->xy);

   431

					}

   432

					break;

   433

				}

   434

   435

				case SLW_TRAIN:

   436

				case SLW_TRUCK:

   437

				case SLW_BUS:

   438

				case SLW_AIRPLANE:

   439

				case SLW_SHIP:

   440

					if (_ctrl_pressed) {

   441

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

   442

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

   443

					} else {

   444

						uint i;

   445

						FOR_EACH_SET_BIT(i, facilities) {

   446

							w->RaiseWidget(i + SLW_TRAIN);

   447

						}

   448

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

   449

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

   450

					}

   451

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

   452

					sl->flags |= SL_REBUILD;

   453

					w->SetDirty();

   454

					break;

   455

   456

				case SLW_FACILALL:

   457

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

   458

						w->LowerWidget(i + SLW_TRAIN);

   459

					}

   460

					w->LowerWidget(SLW_FACILALL);

   461

   462

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

   463

					sl->flags |= SL_REBUILD;

   464

					w->SetDirty();

   465

					break;

   466

   467

				case SLW_CARGOALL: {

   468

					uint i = 0;

   469

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

   470

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

   471

						w->LowerWidget(i + SLW_CARGOSTART);

   472

						i++;

   473

					}

   474

					w->LowerWidget(SLW_NOCARGOWAITING);

   475

					w->LowerWidget(SLW_CARGOALL);

   476

   477

					_cargo_filter = _cargo_mask;

   478

					include_empty = true;

   479

					sl->flags |= SL_REBUILD;

   480

					w->SetDirty();

   481

					break;