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 "table/strings.h"

    10

#include "gui.h"

    11

#include "window_gui.h"

    12

#include "textbuf_gui.h"

    13

#include "station.h"

    14

#include "gfx.h"

    15

#include "player.h"

    17

#include "town.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

#include "station.h"

    28

#include "strings_func.h"

    29

    30

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

    31

    32

static StationSortListingTypeFunction StationNameSorter;

    33

static StationSortListingTypeFunction StationTypeSorter;

    34

static StationSortListingTypeFunction StationWaitingSorter;

    35

static StationSortListingTypeFunction StationRatingMaxSorter;

    36

    37

/**

    38

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

    39

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

    40

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

    41

 *

    42

 * @param x coordinate to draw the box at

    43

 * @param y coordinate to draw the box at

    44

 * @param type Cargo type

    45

 * @param amount Cargo amount

    46

 * @param rating ratings data for that particular cargo

    47

 *

    48

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

    49

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

    50

 */

    51

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

    52

{

    53

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

    54

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

    55

    56

	const CargoSpec *cs = GetCargo(type);

    57

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

    58

    59

	int colour = cs->rating_colour;

    60

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

    61

    62

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

    63

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

    64

    65

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

    66

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

    67

	if (w == 0) {

    68

		uint rest = amount / 5;

    69

		if (rest != 0) {

    70

			w += x;

    71

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

    72

		}

    73

	}

    74

    75

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

    76

    77

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

    78

	y += 8;

    79

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

    80

	rating = minu(rating, rating_full) / 16;

    81

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

    82

}

    83

    84

const StringID _station_sort_listing[] = {

    85

	STR_SORT_BY_DROPDOWN_NAME,

    86

	STR_SORT_BY_FACILITY,

    87

	STR_SORT_BY_WAITING,

    88

	STR_SORT_BY_RATING_MAX,

    89

	INVALID_STRING_ID

    90

};

    91

    92

static char _bufcache[64];

    93

static const Station* _last_station;

    94

static int _internal_sort_order;

    95

    96

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

    97

{

    98

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

    99

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

   100

	char buf1[64];

   101

	int r;

   102

   103

	SetDParam(0, st1->index);

   104

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

   105

   106

	if (st2 != _last_station) {

   107

		_last_station = st2;

   108

		SetDParam(0, st2->index);

   109

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

   110

	}

   111

   112

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

   113

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

   114

}

   115

   116

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

   117

{

   118

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

   119

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

   120

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

   121

}

   122

   123

static const uint32 _cargo_filter_max = ~0;

   124

static uint32 _cargo_filter = _cargo_filter_max;

   125

   126

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

   127

{

   128

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

   129

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

   130

	Money sum1 = 0, sum2 = 0;

   131

   132

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

   133

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

   134

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

   135

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

   136

	}

   137

   138

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

   139

}

   140

   141

/**

   142

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

   143

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

   144

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

   145

 * @return    The sort order

   146

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

   147

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

   148

 */

   149

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

   150

{

   151

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

   152

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

   153

	byte maxr1 = 0;

   154

	byte maxr2 = 0;

   155

   156

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

   157

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

   158

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

   159

	}

   160

   161

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

   162

}

   163

   164

/** Flags for station list */

   165

enum StationListFlags {

   166

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

   167

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

   168

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

   169

};

   170

   171

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   172

   173

/** Information about station list */

   174

struct plstations_d {

   175

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

   176

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

   177

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

   178

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

   179

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

   180

};

   181

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   182

   183

/**

   184

 * Set the 'SL_REBUILD' flag for all station lists

   185

 */

   186

void RebuildStationLists()

   187

{

   188

	Window* const *wz;

   189

   190

	FOR_ALL_WINDOWS(wz) {

   191

		Window *w = *wz;

   192

		if (w->window_class == WC_STATION_LIST) {

   193

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

   194

			SetWindowDirty(w);

   195

		}

   196

	}

   197

}

   198

   199

/**

   200

 * Set the 'SL_RESORT' flag for all station lists

   201

 */

   202

void ResortStationLists()

   203

{

   204

	Window* const *wz;

   205

   206

	FOR_ALL_WINDOWS(wz) {

   207

		Window *w = *wz;

   208

		if (w->window_class == WC_STATION_LIST) {

   209

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

   210

			SetWindowDirty(w);

   211

		}

   212

	}

   213

}

   214

   215

/**

   216

 * Rebuild station list if the SL_REBUILD flag is set

   217

 *

   218

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

   219

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

   220

 * @param facilities types of stations of interest

   221

 * @param cargo_filter bitmap of cargo types to include

   222

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

   223

 */

   224

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

   225

{

   226

	uint n = 0;

   227

	const Station *st;

   228

   229

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

   230

   231

	/* Create array for sorting */

   232

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

   233

   234

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

   235

   236

	FOR_ALL_STATIONS(st) {

   237

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

   238

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

   239

				int num_waiting_cargo = 0;

   240

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

   241

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

   242

						num_waiting_cargo++; //count number of waiting cargo

   243

						if (HasBit(cargo_filter, j)) {

   244

							station_sort[n++] = st;

   245

							break;

   246

						}

   247

					}

   248

				}

   249

				/* stations without waiting cargo */

   250

				if (num_waiting_cargo == 0 && include_empty) {

   251

					station_sort[n++] = st;

   252

				}

   253

			}

   254

		}

   255

	}

   256

   257

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

   258

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

   259

	sl->list_length = n;

   260

   261

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

   262

   263

	sl->flags &= ~SL_REBUILD;

   264

	sl->flags |= SL_RESORT;

   265

	free((void*)station_sort);

   266

}

   267

   268

   269

/**

   270

 * Sort station list if the SL_RESORT flag is set

   271

 *

   272

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

   273

 */

   274

static void SortStationsList(plstations_d *sl)

   275

{

   276

	static StationSortListingTypeFunction* const _station_sorter[] = {

   277

		&StationNameSorter,

   278

		&StationTypeSorter,

   279

		&StationWaitingSorter,

   280

		&StationRatingMaxSorter

   281

	};

   282

   283

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

   284

   285

	_internal_sort_order = sl->flags & SL_ORDER;

   286

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

   287

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

   288

   289

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   290

	sl->flags &= ~SL_RESORT;

   291

}

   292

   293

/**

   294

 * Fuction called when any WindowEvent occurs for PlayerStations window

   295

 *

   296

 * @param w pointer to the PlayerStations window

   297

 * @param e pointer to window event

   298

 */

   299

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

   300

{

   301

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

   302

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

   303

	static Listing station_sort = {0, 0};

   304

	static bool include_empty = true;

   305

   306

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

   307

   308

	switch (e->event) {

   309

		case WE_CREATE:

   310

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   311

   312

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

   313

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

   314

			}

   315

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

   316

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

   317

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   318

   319

			sl->sort_list = NULL;

   320

			sl->flags = SL_REBUILD;

   321

			sl->sort_type = station_sort.criteria;

   322

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

   323

   324

			/* set up resort timer */

   325

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   326

			break;

   327

   328

		case WE_PAINT: {

   329

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

   330

			SortStationsList(sl);

   331

   332

			SetVScrollCount(w, sl->list_length);

   333

   334

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

   335

			SetDParam(0, owner);

   336

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

   337

			DrawWindowWidgets(w);

   338

   339

			/* draw sorting criteria string */

   340

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

   341

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

   342

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

   343

   344

			int cg_ofst;

   345

			int x = 89;

   346

			int y = 14;

   347

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

   348

   349

			uint i = 0;

   350

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

   351

				const CargoSpec *cs = GetCargo(c);

   352

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

   353

   354

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

   355

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

   356

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

   357

				x += 14;

   358

				i++;

   359

			}

   360

   361

			x += 6;

   362

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

   363

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

   364

			x += 14;

   365

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

   366

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

   367

   368

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

   369

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

   370

   371

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

   372

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   373

				return;

   374

			}

   375

   376

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

   377

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

   378

   379

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

   380

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

   381

				int x;

   382

   383

				assert(st->xy != 0);

   384

   385

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

   386

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

   387

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

   388

   389

				SetDParam(0, st->index);

   390

				SetDParam(1, st->facilities);

   391

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

   392

   393

				/* show cargo waiting and station ratings */

   394

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

   395

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

   396

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

   397

						x += 20;

   398

					}

   399

				}

   400

				y += 10;

   401

			}

   402

			break;

   403

		}

   404

   405

		case WE_CLICK:

   406

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

   407

				case SLW_LIST: {

   408

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

   409

   410

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

   411

   412

					id_v += w->vscroll.pos;

   413

   414

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

   415

   416

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

   417

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

   418

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

   419

					ScrollMainWindowToTile(st->xy);

   420

					break;

   421

				}

   422

   423

				case SLW_TRAIN:

   424

				case SLW_TRUCK:

   425

				case SLW_BUS:

   426

				case SLW_AIRPLANE:

   427

				case SLW_SHIP:

   428

					if (_ctrl_pressed) {

   429

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

   430

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

   431

					} else {

   432

						uint i;

   433

						FOR_EACH_SET_BIT(i, facilities) {

   434

							w->RaiseWidget(i + SLW_TRAIN);

   435

						}

   436

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

   437

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

   438

					}

   439

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

   440

					sl->flags |= SL_REBUILD;

   441

					SetWindowDirty(w);

   442

					break;

   443

   444

				case SLW_FACILALL:

   445

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

   446

						w->LowerWidget(i + SLW_TRAIN);

   447

					}

   448

					w->LowerWidget(SLW_FACILALL);

   449

   450

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

   451

					sl->flags |= SL_REBUILD;

   452

					SetWindowDirty(w);

   453

					break;

   454

   455

				case SLW_CARGOALL: {

   456

					uint i = 0;

   457

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

   458

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

   459

						w->LowerWidget(i + SLW_CARGOSTART);

   460

						i++;

   461

					}

   462

					w->LowerWidget(SLW_NOCARGOWAITING);

   463

					w->LowerWidget(SLW_CARGOALL);

   464

   465

					_cargo_filter = _cargo_mask;

   466

					include_empty = true;

   467

					sl->flags |= SL_REBUILD;

   468

					SetWindowDirty(w);

   469

					break;

   470

				}

   471

   472

				case SLW_SORTBY: // flip sorting method asc/desc

   473

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

   474

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

   475

					sl->flags |= SL_RESORT;

   476

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   477

					w->LowerWidget(SLW_SORTBY);

   478

					SetWindowDirty(w);

   479

					break;

   480

   481

				case SLW_SORTCRITERIA: