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

    20

#include "cargotype.h"

    21

#include "station_gui.h"

    22

#include "station.h"

    23

#include "strings_func.h"

    24

#include "core/alloc_func.hpp"

    25

#include "window_func.h"

    26

    27

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

    28

    29

static StationSortListingTypeFunction StationNameSorter;

    30

static StationSortListingTypeFunction StationTypeSorter;

    31

static StationSortListingTypeFunction StationWaitingSorter;

    32

static StationSortListingTypeFunction StationRatingMaxSorter;

    33

    34

/**

    35

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

    36

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

    37

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

    38

 *

    39

 * @param x coordinate to draw the box at

    40

 * @param y coordinate to draw the box at

    41

 * @param type Cargo type

    42

 * @param amount Cargo amount

    43

 * @param rating ratings data for that particular cargo

    44

 *

    45

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

    46

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

    47

 */

    48

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

    49

{

    50

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

    51

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

    52

    53

	const CargoSpec *cs = GetCargo(type);

    54

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

    55

    56

	int colour = cs->rating_colour;

    57

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

    58

    59

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

    60

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

    61

    62

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

    63

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

    64

	if (w == 0) {

    65

		uint rest = amount / 5;

    66

		if (rest != 0) {

    67

			w += x;

    68

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

    69

		}

    70

	}

    71

    72

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

    73

    74

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

    75

	y += 8;

    76

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

    77

	rating = minu(rating, rating_full) / 16;

    78

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

    79

}

    80

    81

const StringID _station_sort_listing[] = {

    82

	STR_SORT_BY_DROPDOWN_NAME,

    83

	STR_SORT_BY_FACILITY,

    84

	STR_SORT_BY_WAITING,

    85

	STR_SORT_BY_RATING_MAX,

    86

	INVALID_STRING_ID

    87

};

    88

    89

static char _bufcache[64];

    90

static const Station* _last_station;

    91

static int _internal_sort_order;

    92

    93

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

    94

{

    95

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

    96

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

    97

	char buf1[64];

    98

	int r;

    99

   100

	SetDParam(0, st1->index);

   101

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

   102

   103

	if (st2 != _last_station) {

   104

		_last_station = st2;

   105

		SetDParam(0, st2->index);

   106

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

   107

	}

   108

   109

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

   110

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

   111

}

   112

   113

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

   114

{

   115

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

   116

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

   117

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

   118

}

   119

   120

static const uint32 _cargo_filter_max = ~0;

   121

static uint32 _cargo_filter = _cargo_filter_max;

   122

   123

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

   124

{

   125

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

   126

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

   127

	Money sum1 = 0, sum2 = 0;

   128

   129

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

   130

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

   131

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

   132

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

   133

	}

   134

   135

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

   136

}

   137

   138

/**

   139

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

   140

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

   141

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

   142

 * @return    The sort order

   143

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

   144

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

   145

 */

   146

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

   147

{

   148

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

   149

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

   150

	byte maxr1 = 0;

   151

	byte maxr2 = 0;

   152

   153

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

   154

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

   155

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

   156

	}

   157

   158

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

   159

}

   160

   161

/** Flags for station list */

   162

enum StationListFlags {

   163

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

   164

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

   165

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

   166

};

   167

   168

DECLARE_ENUM_AS_BIT_SET(StationListFlags);

   169

   170

/** Information about station list */

   171

struct plstations_d {

   172

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

   173

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

   174

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

   175

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

   176

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

   177

};

   178

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(plstations_d));

   179

   180

/**

   181

 * Set the 'SL_REBUILD' flag for all station lists

   182

 */

   183

void RebuildStationLists()

   184

{

   185

	Window* const *wz;

   186

   187

	FOR_ALL_WINDOWS(wz) {

   188

		Window *w = *wz;

   189

		if (w->window_class == WC_STATION_LIST) {

   190

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

   191

			SetWindowDirty(w);

   192

		}

   193

	}

   194

}

   195

   196

/**

   197

 * Set the 'SL_RESORT' flag for all station lists

   198

 */

   199

void ResortStationLists()

   200

{

   201

	Window* const *wz;

   202

   203

	FOR_ALL_WINDOWS(wz) {

   204

		Window *w = *wz;

   205

		if (w->window_class == WC_STATION_LIST) {

   206

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

   207

			SetWindowDirty(w);

   208

		}

   209

	}

   210

}

   211

   212

/**

   213

 * Rebuild station list if the SL_REBUILD flag is set

   214

 *

   215

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

   216

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

   217

 * @param facilities types of stations of interest

   218

 * @param cargo_filter bitmap of cargo types to include

   219

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

   220

 */

   221

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

   222

{

   223

	uint n = 0;

   224

	const Station *st;

   225

   226

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

   227

   228

	/* Create array for sorting */

   229

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

   230

   231

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

   232

   233

	FOR_ALL_STATIONS(st) {

   234

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

   235

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

   236

				int num_waiting_cargo = 0;

   237

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

   238

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

   239

						num_waiting_cargo++; //count number of waiting cargo

   240

						if (HasBit(cargo_filter, j)) {

   241

							station_sort[n++] = st;

   242

							break;

   243

						}

   244

					}

   245

				}

   246

				/* stations without waiting cargo */

   247

				if (num_waiting_cargo == 0 && include_empty) {

   248

					station_sort[n++] = st;

   249

				}

   250

			}

   251

		}

   252

	}

   253

   254

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

   255

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

   256

	sl->list_length = n;

   257

   258

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

   259

   260

	sl->flags &= ~SL_REBUILD;

   261

	sl->flags |= SL_RESORT;

   262

	free((void*)station_sort);

   263

}

   264

   265

   266

/**

   267

 * Sort station list if the SL_RESORT flag is set

   268

 *

   269

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

   270

 */

   271

static void SortStationsList(plstations_d *sl)

   272

{

   273

	static StationSortListingTypeFunction* const _station_sorter[] = {

   274

		&StationNameSorter,

   275

		&StationTypeSorter,

   276

		&StationWaitingSorter,

   277

		&StationRatingMaxSorter

   278

	};

   279

   280

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

   281

   282

	_internal_sort_order = sl->flags & SL_ORDER;

   283

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

   284

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

   285

   286

	sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   287

	sl->flags &= ~SL_RESORT;

   288

}

   289

   290

/**

   291

 * Fuction called when any WindowEvent occurs for PlayerStations window

   292

 *

   293

 * @param w pointer to the PlayerStations window

   294

 * @param e pointer to window event

   295

 */

   296

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

   297

{

   298

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

   299

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

   300

	static Listing station_sort = {0, 0};

   301

	static bool include_empty = true;

   302

   303

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

   304

   305

	switch (e->event) {

   306

		case WE_CREATE:

   307

			if (_cargo_filter == _cargo_filter_max) _cargo_filter = _cargo_mask;

   308

   309

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

   310

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

   311

			}

   312

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

   313

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

   314

			w->SetWidgetLoweredState(SLW_NOCARGOWAITING, include_empty);

   315

   316

			sl->sort_list = NULL;

   317

			sl->flags = SL_REBUILD;

   318

			sl->sort_type = station_sort.criteria;

   319

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

   320

   321

			/* set up resort timer */

   322

			sl->resort_timer = DAY_TICKS * PERIODIC_RESORT_DAYS;

   323

			break;

   324

   325

		case WE_PAINT: {

   326

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

   327

			SortStationsList(sl);

   328

   329

			SetVScrollCount(w, sl->list_length);

   330

   331

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

   332

			SetDParam(0, owner);

   333

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

   334

			DrawWindowWidgets(w);

   335

   336

			/* draw sorting criteria string */

   337

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

   338

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

   339

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

   340

   341

			int cg_ofst;

   342

			int x = 89;

   343

			int y = 14;

   344

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

   345

   346

			uint i = 0;

   347

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

   348

				const CargoSpec *cs = GetCargo(c);

   349

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

   350

   351

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

   352

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

   353

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

   354

				x += 14;

   355

				i++;

   356

			}

   357

   358

			x += 6;

   359

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

   360

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

   361

			x += 14;

   362

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

   363

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

   364

   365

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

   366

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

   367

   368

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

   369

				DrawString(xb, 40, STR_304A_NONE, TC_FROMSTRING);

   370

				return;

   371

			}

   372

   373

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

   374

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

   375

   376

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

   377

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

   378

				int x;

   379

   380

				assert(st->xy != 0);

   381

   382

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

   383

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

   384

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

   385

   386

				SetDParam(0, st->index);

   387

				SetDParam(1, st->facilities);

   388

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

   389

   390

				/* show cargo waiting and station ratings */

   391

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

   392

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

   393

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

   394

						x += 20;

   395

					}

   396

				}

   397

				y += 10;

   398

			}

   399

			break;

   400

		}

   401

   402

		case WE_CLICK:

   403

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

   404

				case SLW_LIST: {

   405

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

   406

   407

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

   408

   409

					id_v += w->vscroll.pos;

   410

   411

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

   412

   413

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

   414

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

   415

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

   416

					ScrollMainWindowToTile(st->xy);

   417

					break;

   418

				}

   419

   420

				case SLW_TRAIN:

   421

				case SLW_TRUCK:

   422

				case SLW_BUS:

   423

				case SLW_AIRPLANE:

   424

				case SLW_SHIP:

   425

					if (_ctrl_pressed) {

   426

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

   427

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

   428

					} else {

   429

						uint i;

   430

						FOR_EACH_SET_BIT(i, facilities) {

   431

							w->RaiseWidget(i + SLW_TRAIN);

   432

						}

   433

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

   434

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

   435

					}

   436

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

   437

					sl->flags |= SL_REBUILD;

   438

					SetWindowDirty(w);

   439

					break;

   440

   441

				case SLW_FACILALL:

   442

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

   443

						w->LowerWidget(i + SLW_TRAIN);

   444

					}

   445

					w->LowerWidget(SLW_FACILALL);

   446

   447

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

   448

					sl->flags |= SL_REBUILD;

   449

					SetWindowDirty(w);

   450

					break;

   451

   452

				case SLW_CARGOALL: {

   453

					uint i = 0;

   454

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

   455

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

   456

						w->LowerWidget(i + SLW_CARGOSTART);

   457

						i++;

   458

					}

   459

					w->LowerWidget(SLW_NOCARGOWAITING);

   460

					w->LowerWidget(SLW_CARGOALL);

   461

   462

					_cargo_filter = _cargo_mask;

   463

					include_empty = true;

   464

					sl->flags |= SL_REBUILD;

   465

					SetWindowDirty(w);

   466

					break;

   467

				}

   468

   469

				case SLW_SORTBY: // flip sorting method asc/desc

   470

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

   471

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

   472

					sl->flags |= SL_RESORT;

   473

					w->flags4 |= 5 << WF_TIMEOUT_SHL;

   474

					w->LowerWidget(SLW_SORTBY);

   475

					SetWindowDirty(w);

   476

					break;

   477

   478

				case SLW_SORTCRITERIA:

   479

				case SLW_SORTDROPBTN: // select sorting criteria dropdown menu

   480

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

   481

					break;