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

    27

enum StationListWidgets {

    28

	STATIONLIST_WIDGET_CLOSEBOX = 0,

    29

	STATIONLIST_WIDGET_LIST = 3,

    30

	STATIONLIST_WIDGET_TRAIN =6,

    31

	STATIONLIST_WIDGET_TRUCK,

    32

	STATIONLIST_WIDGET_BUS,

    33

	STATIONLIST_WIDGET_AIRPLANE,

    34

	STATIONLIST_WIDGET_SHIP,

    35

	STATIONLIST_WIDGET_CARGOSTART = 20,

    36

	STATIONLIST_WIDGET_NOCARGOWAITING = 12,

    37

	STATIONLIST_WIDGET_FACILALL = 14,

    38

	STATIONLIST_WIDGET_CARGOALL,

    39

	STATIONLIST_WIDGET_SORTBY,

    40

	STATIONLIST_WIDGET_SORTCRITERIA,

    41

	STATIONLIST_WIDGET_SORTDROPBTN,

    42

};

    43

    44

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

    45

    46

static StationSortListingTypeFunction StationNameSorter;

    47

static StationSortListingTypeFunction StationTypeSorter;

    48

static StationSortListingTypeFunction StationWaitingSorter;

    49

static StationSortListingTypeFunction StationRatingMaxSorter;

    50

    51

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

    52

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

    53

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

    54

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

    55

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

    56

 * @param x coordinate to draw the box at

    57

 * @param y coordinate to draw the box at

    58

 * @param type Cargo type

    59

 * @param amount Cargo amount

    60

 * @param rating ratings data for that particular cargo */

    61

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

    62

{

    63

	const CargoSpec *cs = GetCargo(type);

    64

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

    65

    66

	int colour = cs->rating_colour;

    67

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

    68

    69

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

    70

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

    71

    72

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

    73

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

    74

	if (w == 0) {

    75

		uint rest = amount / 5;

    76

		if (rest != 0) {

    77

			w += x;

    78

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

    79

		}

    80

	}

    81

    82

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

    83

    84

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

    85

	y += 8;

    86

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

    87

	rating = minu(rating,  224) / 16;

    88

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

    89

}

    90

    91

const StringID _station_sort_listing[] = {

    92

	STR_SORT_BY_DROPDOWN_NAME,

    93

	STR_SORT_BY_FACILITY,

    94

	STR_SORT_BY_WAITING,

    95

	STR_SORT_BY_RATING_MAX,

    96

	INVALID_STRING_ID

    97

};

    98

    99

static char _bufcache[64];

   100

static const Station* _last_station;

   101

static int _internal_sort_order;

   102

   103

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

   104

{

   105

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

   106

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

   107

	char buf1[64];

   108

	int r;

   109

   110

	SetDParam(0, st1->index);

   111

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

   112

   113

	if (st2 != _last_station) {

   114

		_last_station = st2;

   115

		SetDParam(0, st2->index);

   116

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

   117

	}

   118

   119

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

   120

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

   121

}

   122

   123

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

   124

{

   125

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

   126

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

   127

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

   128

}

   129

   130

static const uint32 _cargo_filter_max = ~0;

   131

static uint32 _cargo_filter = _cargo_filter_max;

   132

   133

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

   134

{

   135

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

   136

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

   137

	Money sum1 = 0, sum2 = 0;

   138

   139

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

   140

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

   141

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

   142

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

   143

	}

   144

   145

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

   146

}

   147

   148

/**

   149

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

   150

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

   151

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

   152

 * @return    The sort order

   153

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

   154

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

   155

 */

   156

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

   157

{

   158

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

   159

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

   160

	byte maxr1 = 0;

   161

	byte maxr2 = 0;

   162

   163

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

   164

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

   165

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

   166

	}

   167

   168

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

   169

}

   170

   171

enum StationListFlags {

   172

	SL_ORDER   = 0x01,

   173

	SL_RESORT  = 0x02,

   174

	SL_REBUILD = 0x04,

   175

};

   176

   177

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   178

   179

struct plstations_d {

   180

	const Station** sort_list;

   181

	uint16 list_length;

   182

	byte sort_type;

   183

	StationListFlags flags;

   184

	uint16 resort_timer;  //was byte refresh_counter;

   185

};

   186

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   187

   188

void RebuildStationLists()

   189

{

   190

	Window* const *wz;

   191

   192

	FOR_ALL_WINDOWS(wz) {

   193

		Window *w = *wz;

   194

		if (w->window_class == WC_STATION_LIST) {

   195

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

   196

			SetWindowDirty(w);

   197

		}

   198

	}

   199

}

   200

   201

void ResortStationLists()

   202

{

   203

	Window* const *wz;

   204

   205

	FOR_ALL_WINDOWS(wz) {

   206

		Window *w = *wz;

   207

		if (w->window_class == WC_STATION_LIST) {

   208

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

   209

			SetWindowDirty(w);

   210

		}

   211

	}

   212

}

   213

   214

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

   215

{

   216

	uint n = 0;

   217

	const Station *st;

   218

   219

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

   220

   221

	/* Create array for sorting */

   222

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

   223

	if (station_sort == NULL) error("Could not allocate memory for the station-sorting-list");

   224

   225

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

   226

   227

	FOR_ALL_STATIONS(st) {

   228

		if (st->owner == owner) {

   229

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

   230

				int num_waiting_cargo = 0;

   231

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

   232

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

   233

						num_waiting_cargo++; //count number of waiting cargo

   234

						if (HasBit(cargo_filter, j)) {

   235

							station_sort[n++] = st;

   236

							break;

   237

						}

   238

					}

   239

				}

   240

				/* stations without waiting cargo */

   241

				if (num_waiting_cargo == 0 && include_empty) {

   242

					station_sort[n++] = st;

   243

				}

   244

			}

   245

		}

   246

	}

   247

   248

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

   249

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

   250

	if (n != 0 && sl->sort_list == NULL) error("Could not allocate memory for the station-sorting-list");

   251

	sl->list_length = n;

   252

   253

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

   254

   255

	sl->flags &= ~SL_REBUILD;

   256

	sl->flags |= SL_RESORT;

   257

	free((void*)station_sort);

   258

}

   259

   260

static void SortStationsList(plstations_d *sl)

   261

{

   262

	static StationSortListingTypeFunction* const _station_sorter[] = {

   263

		&StationNameSorter,

   264

		&StationTypeSorter,

   265

		&StationWaitingSorter,

   266

		&StationRatingMaxSorter

   267

	};

   268

   269

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

   270

   271

	_internal_sort_order = sl->flags & SL_ORDER;

   272

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

   273

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

   274

   275

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   276

	sl->flags &= ~SL_RESORT;

   277

}

   278

   279

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

   280

{

   281

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

   282

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

   283

	static Listing station_sort = {0, 0};

   284

	static bool include_empty = true;

   285

   286

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

   287

   288

	switch (e->event) {

   289

		case WE_CREATE: /* set up resort timer */

   290

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   291

   292

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

   293

				if (HasBit(facilities, i)) LowerWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   294

			}

   295

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   296

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_CARGOALL, _cargo_filter == _cargo_mask && include_empty);

   297

			SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_NOCARGOWAITING, include_empty);

   298

   299

			sl->sort_list = NULL;

   300

			sl->flags = SL_REBUILD;

   301

			sl->sort_type = station_sort.criteria;

   302

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

   303

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   304

			break;

   305

   306

		case WE_PAINT: {

   307

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

   308

			SortStationsList(sl);

   309

   310

			SetVScrollCount(w, sl->list_length);

   311

   312

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

   313

			SetDParam(0, owner);

   314

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

   315

			DrawWindowWidgets(w);

   316

   317

			/* draw sorting criteria string */

   318

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

   319

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

   320

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

   321

   322

			int cg_ofst;

   323

			int x = 89;

   324

			int y = 14;

   325

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

   326

   327

			uint i = 0;

   328

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

   329

				const CargoSpec *cs = GetCargo(c);

   330

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

   331

   332

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

   333

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

   334

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

   335

				x += 14;

   336

				i++;

   337

			}

   338

   339

			x += 6;

   340

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_NOCARGOWAITING) ? 2 : 1;

   341

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

   342

			x += 14;

   343

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_CARGOALL) ? 2 : 1;

   344

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

   345

   346

			cg_ofst = IsWindowWidgetLowered(w, STATIONLIST_WIDGET_FACILALL) ? 2 : 1;

   347

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

   348

   349

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

   350

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   351

				return;

   352

			}

   353

   354

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

   355

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

   356

   357

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

   358

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

   359

				int x;

   360

   361

				assert(st->xy != 0);

   362

				assert(st->owner == owner);

   363

   364

				SetDParam(0, st->index);

   365

				SetDParam(1, st->facilities);

   366

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

   367

   368

				/* show cargo waiting and station ratings */

   369

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

   370

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

   371

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

   372

						x += 20;

   373

					}

   374

				}

   375

				y += 10;

   376

			}

   377

			break;

   378

		}

   379

   380

		case WE_CLICK:

   381

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

   382

				case STATIONLIST_WIDGET_LIST: {

   383

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

   384

   385

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

   386

   387

					id_v += w->vscroll.pos;

   388

   389

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

   390

   391

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

   392

					assert(st->owner == owner);

   393

					ScrollMainWindowToTile(st->xy);

   394

					break;

   395

				}

   396

   397

				case STATIONLIST_WIDGET_TRAIN:

   398

				case STATIONLIST_WIDGET_TRUCK:

   399

				case STATIONLIST_WIDGET_BUS:

   400

				case STATIONLIST_WIDGET_AIRPLANE:

   401

				case STATIONLIST_WIDGET_SHIP:

   402

					if (_ctrl_pressed) {

   404

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

   405

					} else {

   406

						for (uint i = 0; facilities != 0; i++, facilities >>= 1) {

   407

							if (HasBit(facilities, 0)) RaiseWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   408

						}

   409

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

   410

						LowerWindowWidget(w, e->we.click.widget);

   411

					}

   412

					SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_FACILALL, facilities == (FACIL_TRAIN | FACIL_TRUCK_STOP | FACIL_BUS_STOP | FACIL_AIRPORT | FACIL_DOCK));

   413

					sl->flags |= SL_REBUILD;

   414

					SetWindowDirty(w);

   415

					break;

   416

   417

				case STATIONLIST_WIDGET_FACILALL:

   418

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

   419

						LowerWindowWidget(w, i + STATIONLIST_WIDGET_TRAIN);

   420

					}

   421

					LowerWindowWidget(w, STATIONLIST_WIDGET_FACILALL);

   422

   423

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

   424

					sl->flags |= SL_REBUILD;

   425

					SetWindowDirty(w);

   426

					break;

   427

   428

				case STATIONLIST_WIDGET_CARGOALL: {

   429

					uint i = 0;

   430

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

   431

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

   432

						LowerWindowWidget(w, i + STATIONLIST_WIDGET_CARGOSTART);

   433

						i++;

   434

					}

   435

					LowerWindowWidget(w, STATIONLIST_WIDGET_NOCARGOWAITING);

   436

					LowerWindowWidget(w, STATIONLIST_WIDGET_CARGOALL);

   437

   438

					_cargo_filter = _cargo_mask;

   439

					include_empty = true;

   440

					sl->flags |= SL_REBUILD;

   441

					SetWindowDirty(w);

   442

					break;

   443

				}

   444

   445

				case STATIONLIST_WIDGET_SORTBY: /*flip sorting method asc/desc*/

   446

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

   447

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

   448

					sl->flags |= SL_RESORT;

   449

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   450

					LowerWindowWidget(w, STATIONLIST_WIDGET_SORTBY);

   451

					SetWindowDirty(w);

   452

					break;

   453

   454

				case STATIONLIST_WIDGET_SORTCRITERIA:

   455

				case STATIONLIST_WIDGET_SORTDROPBTN: /* select sorting criteria dropdown menu */

   456

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

   457

					break;

   458

   459

				case STATIONLIST_WIDGET_NOCARGOWAITING:

   460

					if (_ctrl_pressed) {

   461

						include_empty = !include_empty;

   462

						ToggleWidgetLoweredState(w, STATIONLIST_WIDGET_NOCARGOWAITING);

   463

					} else {

   464

						for (uint i = STATIONLIST_WIDGET_CARGOSTART; i < w->widget_count; i++) {

   465

							RaiseWindowWidget(w, i);

   466

						}

   467

   468

						_cargo_filter = 0;

   469

						include_empty = true;

   470

   471

						LowerWindowWidget(w, STATIONLIST_WIDGET_NOCARGOWAITING);

   472

					}

   473

					sl->flags |= SL_REBUILD;

   474

					SetWindowWidgetLoweredState(w, STATIONLIST_WIDGET_CARGOALL, _cargo_filter == _cargo_mask && include_empty);

   475

					SetWindowDirty(w);

   476

					break;

   477

   478

				default:

   479

					if (e->we.click.widget >= STATIONLIST_WIDGET_CARGOSTART) { //change cargo_filter

   480

						/* Determine the selected cargo type */

   481

						CargoID c;

   482

						int i = 0;

   483

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

   484

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