1

/* $Id$ */

     2

     3

/** @file station_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "functions.h"

     9

#include "strings.h"

    10

#include "table/strings.h"

    11

#include "window.h"

    12

#include "gui.h"

    13

#include "station.h"

    14

#include "gfx.h"

    15

#include "player.h"

    16

#include "economy.h"

    17

#include "town.h"

    18

#include "command.h"

    19

#include "variables.h"

    20

#include "vehicle_gui.h"

    21

#include "date.h"

    22

#include "vehicle.h"

    23

#include "table/sprites.h"

    24

#include "helpers.hpp"

    25

#include "cargotype.h"

    26

#include "station_gui.h"

    27

    28

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

    29

    30

static StationSortListingTypeFunction StationNameSorter;

    31

static StationSortListingTypeFunction StationTypeSorter;

    32

static StationSortListingTypeFunction StationWaitingSorter;

    33

static StationSortListingTypeFunction StationRatingMaxSorter;

    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

const StringID _station_sort_listing[] = {

    83

	STR_SORT_BY_DROPDOWN_NAME,

    84

	STR_SORT_BY_FACILITY,

    85

	STR_SORT_BY_WAITING,

    86

	STR_SORT_BY_RATING_MAX,

    87

	INVALID_STRING_ID

    88

};

    89

    90

static char _bufcache[64];

    91

static const Station* _last_station;

    92

static int _internal_sort_order;

    93

    94

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

    95

{

    96

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

    97

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

    98

	char buf1[64];

    99

	int r;

   100

   101

	SetDParam(0, st1->index);

   102

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

   103

   104

	if (st2 != _last_station) {

   105

		_last_station = st2;

   106

		SetDParam(0, st2->index);

   107

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

   108

	}

   109

   110

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

   111

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

   112

}

   113

   114

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

   115

{

   116

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

   117

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

   118

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

   119

}

   120

   121

static const uint32 _cargo_filter_max = ~0;

   122

static uint32 _cargo_filter = _cargo_filter_max;

   123

   124

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

   125

{

   126

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

   127

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

   128

	Money sum1 = 0, sum2 = 0;

   129

   130

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

   131

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

   132

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

   133

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

   134

	}

   135

   136

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

   137

}

   138

   139

/**

   140

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

   141

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

   142

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

   143

 * @return    The sort order

   144

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

   145

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

   146

 */

   147

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

   148

{

   149

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

   150

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

   151

	byte maxr1 = 0;

   152

	byte maxr2 = 0;

   153

   154

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

   155

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

   156

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

   157

	}

   158

   159

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

   160

}

   161

   162

/** Flags for station list */

   163

enum StationListFlags {

   164

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

   165

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

   166

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

   167

};

   168

   169

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   170

   171

/** Information about station list */

   172

struct plstations_d {

   173

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

   174

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

   175

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

   176

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

   177

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

   178

};

   179

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   180

   181

/**

   182

 * Set the 'SL_REBUILD' flag for all station lists

   183

 */

   184

void RebuildStationLists()

   185

{

   186

	Window* const *wz;

   187

   188

	FOR_ALL_WINDOWS(wz) {

   189

		Window *w = *wz;

   190

		if (w->window_class == WC_STATION_LIST) {

   191

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

   192

			SetWindowDirty(w);

   193

		}

   194

	}

   195

}

   196

   197

/**

   198

 * Set the 'SL_RESORT' flag for all station lists

   199

 */

   200

void ResortStationLists()

   201

{

   202

	Window* const *wz;

   203

   204

	FOR_ALL_WINDOWS(wz) {

   205

		Window *w = *wz;

   206

		if (w->window_class == WC_STATION_LIST) {

   207

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

   208

			SetWindowDirty(w);

   209

		}

   210

	}

   211

}

   212

   213

/**

   214

 * Rebuild station list if the SL_REBUILD flag is set

   215

 *

   216

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

   217

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

   218

 * @param facilities types of stations of interest

   219

 * @param cargo_filter bitmap of cargo types to include

   220

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

   221

 */

   222

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

   223

{

   224

	uint n = 0;

   225

	const Station *st;

   226

   227

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

   228

   229

	/* Create array for sorting */

   230

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

   231

   232

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

   233

   234

	FOR_ALL_STATIONS(st) {

   235

		if (st->owner == owner) {

   236

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

   237

				int num_waiting_cargo = 0;

   238

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

   239

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

   240

						num_waiting_cargo++; //count number of waiting cargo

   241

						if (HasBit(cargo_filter, j)) {

   242

							station_sort[n++] = st;

   243

							break;

   244

						}

   245

					}

   246

				}

   247

				/* stations without waiting cargo */

   248

				if (num_waiting_cargo == 0 && include_empty) {

   249

					station_sort[n++] = st;

   250

				}

   251

			}

   252

		}

   253

	}

   254

   255

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

   256

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

   257

	sl->list_length = n;

   258

   259

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

   260

   261

	sl->flags &= ~SL_REBUILD;

   262

	sl->flags |= SL_RESORT;

   263

	free((void*)station_sort);

   264

}

   265

   266

   267

/**

   268

 * Sort station list if the SL_RESORT flag is set

   269

 *

   270

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

   271

 */

   272

static void SortStationsList(plstations_d *sl)

   273

{

   274

	static StationSortListingTypeFunction* const _station_sorter[] = {

   275

		&StationNameSorter,

   276

		&StationTypeSorter,

   277

		&StationWaitingSorter,

   278

		&StationRatingMaxSorter

   279

	};

   280

   281

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

   282

   283

	_internal_sort_order = sl->flags & SL_ORDER;

   284

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

   285

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

   286

   287

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   288

	sl->flags &= ~SL_RESORT;

   289

}

   290

   291

/**

   292

 * Fuction called when any WindowEvent occurs for PlayerStations window

   293

 *

   294

 * @param w pointer to the PlayerStations window

   295

 * @param e pointer to window event

   296

 */

   297

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

   298

{

   299

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

   300

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

   301

	static Listing station_sort = {0, 0};

   302

	static bool include_empty = true;

   303

   304

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

   305

   306

	switch (e->event) {

   307

		case WE_CREATE:

   308

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   309

   310

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

   311

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

   312

			}

   313

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

   314

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

   315

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   316

   317

			sl->sort_list = NULL;

   318

			sl->flags = SL_REBUILD;

   319

			sl->sort_type = station_sort.criteria;

   320

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

   321

   322

			/* set up resort timer */

   323

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   324

			break;

   325

   326

		case WE_PAINT: {

   327

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

   328

			SortStationsList(sl);

   329

   330

			SetVScrollCount(w, sl->list_length);

   331

   332

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

   333

			SetDParam(0, owner);

   334

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

   335

			DrawWindowWidgets(w);

   336

   337

			/* draw sorting criteria string */

   338

			DrawString(85, 26, _station_sort_listing[sl->sort_type], TC_BLACK);

   339

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

   340

			DoDrawString(sl->flags & SL_ORDER ? DOWNARROW : UPARROW, 69, 26, TC_BLACK);

   341

   342

			int cg_ofst;

   343

			int x = 89;

   344

			int y = 14;

   345

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

   346

   347

			uint i = 0;

   348

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

   349

				const CargoSpec *cs = GetCargo(c);

   350

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

   351

   352

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

   353

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

   354

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

   355

				x += 14;

   356

				i++;

   357

			}

   358

   359

			x += 6;

   360

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

   361

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

   362

			x += 14;

   363

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

   364

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

   365

   366

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

   367

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

   368

   369

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

   370

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   371

				return;

   372

			}

   373

   374

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

   375

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

   376

   377

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

   378

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

   379

				int x;

   380

   381

				assert(st->xy != 0);

   382

				assert(st->owner == owner);

   383

   384

				SetDParam(0, st->index);

   385

				SetDParam(1, st->facilities);

   386

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

   387

   388

				/* show cargo waiting and station ratings */

   389

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

   390

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

   391

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

   392

						x += 20;

   393

					}

   394

				}

   395

				y += 10;

   396

			}

   397

			break;

   398

		}

   399

   400

		case WE_CLICK:

   401

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

   402

				case SLW_LIST: {

   403

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

   404

   405

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

   406

   407

					id_v += w->vscroll.pos;

   408

   409

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

   410

   411

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

   412

					assert(st->owner == owner);

   413

					ScrollMainWindowToTile(st->xy);

   414

					break;

   415

				}

   416

   417

				case SLW_TRAIN:

   418

				case SLW_TRUCK:

   419

				case SLW_BUS:

   420

				case SLW_AIRPLANE:

   421

				case SLW_SHIP:

   422

					if (_ctrl_pressed) {

   423

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

   424

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

   425

					} else {

   426

						uint i;

   427

						FOR_EACH_SET_BIT(i, facilities) {

   428

							w->RaiseWidget(i + SLW_TRAIN);

   429

						}

   430

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

   431

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

   432

					}

   433

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

   434

					sl->flags |= SL_REBUILD;

   435

					SetWindowDirty(w);

   436

					break;

   437

   438

				case SLW_FACILALL:

   439

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

   440

						w->LowerWidget(i + SLW_TRAIN);

   441

					}

   442

					w->LowerWidget(SLW_FACILALL);

   443

   444

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

   445

					sl->flags |= SL_REBUILD;

   446

					SetWindowDirty(w);

   447

					break;

   448

   449

				case SLW_CARGOALL: {

   450

					uint i = 0;

   451

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

   452

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

   453

						w->LowerWidget(i + SLW_CARGOSTART);

   454

						i++;

   455

					}

   456

					w->LowerWidget(SLW_NOCARGOWAITING);

   457

					w->LowerWidget(SLW_CARGOALL);

   458

   459

					_cargo_filter = _cargo_mask;

   460

					include_empty = true;

   461

					sl->flags |= SL_REBUILD;

   462

					SetWindowDirty(w);

   463

					break;

   464

				}

   465

   466

				case SLW_SORTBY: // flip sorting method asc/desc

   467

					sl->flags ^= SL_ORDER; //DESC-flag

   468

					station_sort.order = HasBit(sl->flags, 0);

   469

					sl->flags |= SL_RESORT;

   470

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   471

					w->LowerWidget(SLW_SORTBY);

   472

					SetWindowDirty(w);

   473

					break;

   474

   475

				case SLW_SORTCRITERIA:

   476

				case SLW_SORTDROPBTN: // select sorting criteria dropdown menu

   477

					ShowDropDownMenu(w, _station_sort_listing, sl->sort_type, SLW_SORTDROPBTN, 0, 0);

   478

					break;

   479

   480

				case SLW_NOCARGOWAITING:

   481

					if (_ctrl_pressed) {

   482

						include_empty = !include_empty;