1

/* $Id$ */

     2

     3

/** @file station_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "debug.h"

     8

#include "table/strings.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "textbuf_gui.h"

    12

#include "station.h"

    13

#include "player.h"

    14

#include "economy_func.h"

    15

#include "town.h"

    16

#include "command_func.h"

    17

#include "variables.h"

    18

#include "vehicle_gui.h"

    19

#include "date.h"

    20

#include "vehicle.h"

    21

#include "table/sprites.h"

    22

#include "cargotype.h"

    23

#include "station_gui.h"

    24

#include "station.h"

    25

#include "strings_func.h"

    26

#include "core/alloc_func.hpp"

    28

    29

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

    30

    31

static StationSortListingTypeFunction StationNameSorter;

    32

static StationSortListingTypeFunction StationTypeSorter;

    33

static StationSortListingTypeFunction StationWaitingSorter;

    34

static StationSortListingTypeFunction StationRatingMaxSorter;

    35

    36

/**

    37

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

    38

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

    39

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

    40

 *

    41

 * @param x coordinate to draw the box at

    42

 * @param y coordinate to draw the box at

    43

 * @param type Cargo type

    44

 * @param amount Cargo amount

    45

 * @param rating ratings data for that particular cargo

    46

 *

    47

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

    48

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

    49

 */

    50

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

    51

{

    52

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

    53

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

    54

    55

	const CargoSpec *cs = GetCargo(type);

    56

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

    57

    58

	int colour = cs->rating_colour;

    59

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

    60

    61

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

    62

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

    63

    64

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

    65

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

    66

	if (w == 0) {

    67

		uint rest = amount / 5;

    68

		if (rest != 0) {

    69

			w += x;

    70

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

    71

		}

    72

	}

    73

    74

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

    75

    76

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

    77

	y += 8;

    78

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

    79

	rating = minu(rating, rating_full) / 16;

    80

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

    81

}

    82

    83

const StringID _station_sort_listing[] = {

    84

	STR_SORT_BY_DROPDOWN_NAME,

    85

	STR_SORT_BY_FACILITY,

    86

	STR_SORT_BY_WAITING,

    87

	STR_SORT_BY_RATING_MAX,

    88

	INVALID_STRING_ID

    89

};

    90

    91

static char _bufcache[64];

    92

static const Station* _last_station;

    93

static int _internal_sort_order;

    94

    95

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

    96

{

    97

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

    98

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

    99

	char buf1[64];

   100

	int r;

   101

   102

	SetDParam(0, st1->index);

   103

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

   104

   105

	if (st2 != _last_station) {

   106

		_last_station = st2;

   107

		SetDParam(0, st2->index);

   108

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

   109

	}

   110

   111

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

   112

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

   113

}

   114

   115

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

   116

{

   117

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

   118

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

   119

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

   120

}

   121

   122

static const uint32 _cargo_filter_max = ~0;

   123

static uint32 _cargo_filter = _cargo_filter_max;

   124

   125

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

   126

{

   127

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

   128

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

   129

	Money sum1 = 0, sum2 = 0;

   130

   131

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

   132

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

   133

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

   134

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

   135

	}

   136

   137

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

   138

}

   139

   140

/**

   141

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

   142

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

   143

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

   144

 * @return    The sort order

   145

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

   146

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

   147

 */

   148

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

   149

{

   150

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

   151

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

   152

	byte maxr1 = 0;

   153

	byte maxr2 = 0;

   154

   155

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

   156

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

   157

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

   158

	}

   159

   160

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

   161

}

   162

   163

/** Flags for station list */

   164

enum StationListFlags {

   165

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

   166

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

   167

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

   168

};

   169

   170

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   171

   172

/** Information about station list */

   173

struct plstations_d {

   174

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

   175

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

   176

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

   177

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

   178

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

   179

};

   180

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   181

   182

/**

   183

 * Set the 'SL_REBUILD' flag for all station lists

   184

 */

   185

void RebuildStationLists()

   186

{

   187

	Window* const *wz;

   188

   189

	FOR_ALL_WINDOWS(wz) {

   190

		Window *w = *wz;

   191

		if (w->window_class == WC_STATION_LIST) {

   192

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

   193

			SetWindowDirty(w);

   194

		}

   195

	}

   196

}

   197

   198

/**

   199

 * Set the 'SL_RESORT' flag for all station lists

   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

/**

   215

 * Rebuild station list if the SL_REBUILD flag is set

   216

 *

   217

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

   218

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

   219

 * @param facilities types of stations of interest

   220

 * @param cargo_filter bitmap of cargo types to include

   221

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

   222

 */

   223

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

   224

{

   225

	uint n = 0;

   226

	const Station *st;

   227

   228

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

   229

   230

	/* Create array for sorting */

   231

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

   232

   233

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

   234

   235

	FOR_ALL_STATIONS(st) {

   236

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

   237

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

   238

				int num_waiting_cargo = 0;

   239

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

   240

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

   241

						num_waiting_cargo++; //count number of waiting cargo

   242

						if (HasBit(cargo_filter, j)) {

   243

							station_sort[n++] = st;

   244

							break;

   245

						}

   246

					}

   247

				}

   248

				/* stations without waiting cargo */

   249

				if (num_waiting_cargo == 0 && include_empty) {

   250

					station_sort[n++] = st;

   251

				}

   252

			}

   253

		}

   254

	}

   255

   256

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

   257

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

   258

	sl->list_length = n;

   259

   260

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

   261

   262

	sl->flags &= ~SL_REBUILD;

   263

	sl->flags |= SL_RESORT;

   264

	free((void*)station_sort);

   265

}

   266

   267

   268

/**

   269

 * Sort station list if the SL_RESORT flag is set

   270

 *

   271

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

   272

 */

   273

static void SortStationsList(plstations_d *sl)

   274

{

   275

	static StationSortListingTypeFunction* const _station_sorter[] = {

   276

		&StationNameSorter,

   277

		&StationTypeSorter,

   278

		&StationWaitingSorter,

   279

		&StationRatingMaxSorter

   280

	};

   281

   282

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

   283

   284

	_internal_sort_order = sl->flags & SL_ORDER;

   285

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

   286

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

   287

   288

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   289

	sl->flags &= ~SL_RESORT;

   290

}

   291

   292

/**

   293

 * Fuction called when any WindowEvent occurs for PlayerStations window

   294

 *

   295

 * @param w pointer to the PlayerStations window

   296

 * @param e pointer to window event

   297

 */

   298

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

   299

{

   300

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

   301

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

   302

	static Listing station_sort = {0, 0};

   303

	static bool include_empty = true;

   304

   305

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

   306

   307

	switch (e->event) {

   308

		case WE_CREATE:

   309

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   310

   311

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

   312

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

   313

			}

   314

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

   315

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

   316

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   317

   318

			sl->sort_list = NULL;

   319

			sl->flags = SL_REBUILD;

   320

			sl->sort_type = station_sort.criteria;

   321

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

   322

   323

			/* set up resort timer */

   324

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   325

			break;

   326

   327

		case WE_PAINT: {

   328

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

   329

			SortStationsList(sl);

   330

   331

			SetVScrollCount(w, sl->list_length);

   332

   333

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

   334

			SetDParam(0, owner);

   335

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

   336

			DrawWindowWidgets(w);

   337

   338

			/* draw sorting criteria string */

   339

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

   340

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

   341

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

   342

   343

			int cg_ofst;

   344

			int x = 89;

   345

			int y = 14;

   346

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

   347

   348

			uint i = 0;

   349

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

   350

				const CargoSpec *cs = GetCargo(c);

   351

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

   352

   353

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

   354

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

   355

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

   356

				x += 14;

   357

				i++;

   358

			}

   359

   360

			x += 6;

   361

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

   362

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

   363

			x += 14;

   364

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

   365

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

   366

   367

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

   368

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

   369

   370

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

   371

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   372

				return;

   373

			}

   374

   375

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

   376

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

   377

   378

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

   379

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

   380

				int x;

   381

   382

				assert(st->xy != 0);

   383

   384

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

   385

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

   386

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

   387

   388

				SetDParam(0, st->index);

   389

				SetDParam(1, st->facilities);

   390

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

   391

   392

				/* show cargo waiting and station ratings */

   393

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

   394

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

   395

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

   396

						x += 20;

   397

					}

   398

				}

   399

				y += 10;

   400

			}

   401

			break;

   402

		}

   403

   404

		case WE_CLICK:

   405

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

   406

				case SLW_LIST: {

   407

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

   408

   409

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

   410

   411

					id_v += w->vscroll.pos;

   412

   413

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

   414

   415

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

   416

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

   417

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

   418

					ScrollMainWindowToTile(st->xy);

   419

					break;

   420

				}

   421

   422

				case SLW_TRAIN:

   423

				case SLW_TRUCK:

   424

				case SLW_BUS:

   425

				case SLW_AIRPLANE:

   426

				case SLW_SHIP:

   427

					if (_ctrl_pressed) {

   428

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

   429

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

   430

					} else {

   431

						uint i;

   432

						FOR_EACH_SET_BIT(i, facilities) {

   433

							w->RaiseWidget(i + SLW_TRAIN);

   434

						}

   435

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

   436

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

   437

					}

   438

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

   439

					sl->flags |= SL_REBUILD;

   440

					SetWindowDirty(w);

   441

					break;

   442

   443

				case SLW_FACILALL:

   444

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

   445

						w->LowerWidget(i + SLW_TRAIN);

   446

					}

   447

					w->LowerWidget(SLW_FACILALL);

   448

   449

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

   450

					sl->flags |= SL_REBUILD;

   451

					SetWindowDirty(w);

   452

					break;

   453

   454

				case SLW_CARGOALL: {

   455

					uint i = 0;

   456

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

   457

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

   458

						w->LowerWidget(i + SLW_CARGOSTART);

   459

						i++;

   460

					}

   461

					w->LowerWidget(SLW_NOCARGOWAITING);

   462

					w->LowerWidget(SLW_CARGOALL);

   463

   464

					_cargo_filter = _cargo_mask;

   465

					include_empty = true;

   466

					sl->flags |= SL_REBUILD;

   467

					SetWindowDirty(w);

   468

					break;

   469

				}

   470

   471

				case SLW_SORTBY: // flip sorting method asc/desc

   472

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

   473

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

   474

					sl->flags |= SL_RESORT;

   475

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   476

					w->LowerWidget(SLW_SORTBY);

   477

					SetWindowDirty(w);

   478

					break;

   479

   480

				case SLW_SORTCRITERIA:

   481

				case SLW_SORTDROPBTN: // select sorting criteria dropdown menu