1

/* $Id$ */

     2

     3

/** @file order_gui.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "road_map.h"

     8

#include "station_map.h"

     9

#include "gui.h"

    10

#include "window_gui.h"

    11

#include "station_base.h"

    12

#include "town.h"

    13

#include "command_func.h"

    14

#include "viewport_func.h"

    15

#include "gfx_func.h"

    16

#include "depot.h"

    17

#include "waypoint.h"

    18

#include "train.h"

    19

#include "water_map.h"

    20

#include "vehicle_gui.h"

    21

#include "timetable.h"

    22

#include "cargotype.h"

    23

#include "strings_func.h"

    24

#include "window_func.h"

    25

#include "vehicle_func.h"

    26

#include "settings_type.h"

    27

#include "player_func.h"

    28

#include "newgrf_cargo.h"

    29

#include "widgets/dropdown_func.h"

    30

#include "textbuf_gui.h"

    31

#include "string_func.h"

    32

    33

#include "table/sprites.h"

    34

#include "table/strings.h"

    35

    36

enum OrderWindowWidgets {

    37

	ORDER_WIDGET_CLOSEBOX = 0,

    38

	ORDER_WIDGET_CAPTION,

    39

	ORDER_WIDGET_TIMETABLE_VIEW,

    40

	ORDER_WIDGET_ORDER_LIST,

    41

	ORDER_WIDGET_SCROLLBAR,

    42

	ORDER_WIDGET_SKIP,

    43

	ORDER_WIDGET_DELETE,

    44

	ORDER_WIDGET_NON_STOP,

    45

	ORDER_WIDGET_GOTO,

    46

	ORDER_WIDGET_GOTO_DROPDOWN,

    47

	ORDER_WIDGET_FULL_LOAD,

    48

	ORDER_WIDGET_UNLOAD,

    49

	ORDER_WIDGET_REFIT,

    50

	ORDER_WIDGET_SERVICE,

    51

	ORDER_WIDGET_COND_VARIABLE,

    52

	ORDER_WIDGET_COND_COMPARATOR,

    53

	ORDER_WIDGET_COND_VALUE,

    54

	ORDER_WIDGET_RESIZE_BAR,

    55

	ORDER_WIDGET_SHARED_ORDER_LIST,

    56

	ORDER_WIDGET_RESIZE,

    57

};

    58

    59

/** Under what reason are we using the PlaceObject functionality? */

    60

enum OrderPlaceObjectState {

    61

	OPOS_GOTO,

    62

	OPOS_CONDITIONAL,

    63

};

    64

    65

struct order_d {

    66

	int sel;

    67

	OrderPlaceObjectState goto_type;

    68

};

    69

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(order_d));

    70

    71

/**

    72

 * Return the memorised selected order.

    73

 *

    74

 * @param w current window

    75

 * @return the memorised order if it is a vaild one

    76

 *  else return the number of orders

    77

 */

    78

static int OrderGetSel(const Window *w)

    79

{

    80

	const Vehicle *v = GetVehicle(w->window_number);

    81

	int num = WP(w, order_d).sel;

    82

    83

	return (num >= 0 && num < v->num_orders) ? num : v->num_orders;

    84

}

    85

    86

/**

    87

 * Calculate the selected order.

    88

 * The calculation is based on the relative (to the window) y click position and

    89

 *  the position of the scrollbar.

    90

 *

    91

 * @param w current window

    92

 * @param y Y-value of the click relative to the window origin

    93

 * @param v current vehicle

    94

 * @return the new selected order if the order is valid else return that

    95

 *  an invalid one has been selected.

    96

 */

    97

static int GetOrderFromOrderWndPt(Window *w, int y, const Vehicle *v)

    98

{

    99

	/*

   100

	 * Calculation description:

   101

	 * 15 = 14 (w->widget[ORDER_WIDGET_ORDER_LIST].top) + 1 (frame-line)

   102

	 * 10 = order text hight

   103

	 */

   104

	int sel = (y - w->widget[ORDER_WIDGET_ORDER_LIST].top - 1) / 10;

   105

   106

	if ((uint)sel >= w->vscroll.cap) return INVALID_ORDER;

   107

   108

	sel += w->vscroll.pos;

   109

   110

	return (sel <= v->num_orders && sel >= 0) ? sel : INVALID_ORDER;

   111

}

   112

   113

/** Order load types that could be given to station orders. */

   114

static const StringID _station_load_types[][5] = {

   115

	{

   116

		STR_EMPTY,

   117

		INVALID_STRING_ID,

   118

		STR_ORDER_FULL_LOAD,

   119

		STR_ORDER_FULL_LOAD_ANY,

   120

		STR_ORDER_NO_LOAD,

   121

	}, {

   122

		STR_ORDER_UNLOAD,

   123

		INVALID_STRING_ID,

   124

		STR_ORDER_UNLOAD_FULL_LOAD,

   125

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

   126

		STR_ORDER_UNLOAD_NO_LOAD,

   127

	}, {

   128

		STR_ORDER_TRANSFER,

   129

		INVALID_STRING_ID,

   130

		STR_ORDER_TRANSFER_FULL_LOAD,

   131

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   132

		STR_ORDER_TRANSFER_NO_LOAD,

   133

	}, {

   134

		/* Unload and transfer do not work together. */

   135

		INVALID_STRING_ID,

   136

		INVALID_STRING_ID,

   137

		INVALID_STRING_ID,

   138

		INVALID_STRING_ID,

   139

	}, {

   140

		STR_ORDER_NO_UNLOAD,

   141

		INVALID_STRING_ID,

   142

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

   143

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

   144

		INVALID_STRING_ID,

   145

	}

   146

};

   147

   148

static const StringID _order_non_stop_drowdown[] = {

   149

	STR_ORDER_GO_TO,

   150

	STR_ORDER_GO_NON_STOP_TO,

   151

	STR_ORDER_GO_VIA,

   152

	STR_ORDER_GO_NON_STOP_VIA,

   153

	INVALID_STRING_ID

   154

};

   155

   156

static const StringID _order_full_load_drowdown[] = {

   157

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   158

	STR_EMPTY,

   159

	STR_ORDER_DROP_FULL_LOAD_ALL,

   160

	STR_ORDER_DROP_FULL_LOAD_ANY,

   161

	STR_ORDER_DROP_NO_LOADING,

   162

	INVALID_STRING_ID

   163

};

   164

   165

static const StringID _order_unload_drowdown[] = {

   166

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   167

	STR_ORDER_DROP_UNLOAD,

   168

	STR_ORDER_DROP_TRANSFER,

   169

	STR_EMPTY,

   170

	STR_ORDER_DROP_NO_UNLOADING,

   171

	INVALID_STRING_ID

   172

};

   173

   174

static const StringID _order_goto_dropdown[] = {

   175

	STR_ORDER_GO_TO,

   176

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   177

	STR_ORDER_CONDITIONAL,

   178

	INVALID_STRING_ID

   179

};

   180

   181

static const StringID _order_goto_dropdown_aircraft[] = {

   182

	STR_ORDER_GO_TO,

   183

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   184

	STR_ORDER_CONDITIONAL,

   185

	INVALID_STRING_ID

   186

};

   187

   188

static const StringID _order_conditional_variable[] = {

   189

	STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE,

   190

	STR_ORDER_CONDITIONAL_RELIABILITY,

   191

	STR_ORDER_CONDITIONAL_MAX_SPEED,

   192

	STR_ORDER_CONDITIONAL_AGE,

   193

	STR_ORDER_CONDITIONAL_REQUIRES_SERVICE,

   194

	STR_ORDER_CONDITIONAL_UNCONDITIONALLY,

   195

	INVALID_STRING_ID,

   196

};

   197

   198

static const StringID _order_conditional_condition[] = {

   199

	STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS,

   200

	STR_ORDER_CONDITIONAL_COMPARATOR_NOT_EQUALS,

   201

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_THAN,

   202

	STR_ORDER_CONDITIONAL_COMPARATOR_LESS_EQUALS,

   203

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_THAN,

   204

	STR_ORDER_CONDITIONAL_COMPARATOR_MORE_EQUALS,

   205

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_TRUE,

   206

	STR_ORDER_CONDITIONAL_COMPARATOR_IS_FALSE,

   207

	INVALID_STRING_ID,

   208

};

   209

   210

extern uint ConvertSpeedToDisplaySpeed(uint speed);

   211

extern uint ConvertDisplaySpeedToSpeed(uint speed);

   212

   213

   214

static void DrawOrdersWindow(Window *w)

   215

{

   216

	const Vehicle *v = GetVehicle(w->window_number);

   217

	bool shared_orders = v->IsOrderListShared();

   218

   219

	SetVScrollCount(w, v->num_orders + 1);

   220

   221

	int sel = OrderGetSel(w);

   222

	const Order *order = GetVehicleOrder(v, sel);

   223

   224

	if (v->owner == _local_player) {

   225

		/* Set the strings for the dropdown boxes. */

   226

		w->widget[ORDER_WIDGET_NON_STOP].data        = _order_non_stop_drowdown[order == NULL ? 0 : order->GetNonStopType()];

   227

		w->widget[ORDER_WIDGET_FULL_LOAD].data       = _order_full_load_drowdown[order == NULL ? 0 : order->GetLoadType()];

   228

		w->widget[ORDER_WIDGET_UNLOAD].data          = _order_unload_drowdown[order == NULL ? 0 : order->GetUnloadType()];

   229

		w->widget[ORDER_WIDGET_COND_VARIABLE].data   = _order_conditional_variable[order == NULL ? 0 : order->GetConditionVariable()];

   230

		w->widget[ORDER_WIDGET_COND_COMPARATOR].data = _order_conditional_condition[order == NULL ? 0 : order->GetConditionComparator()];

   231

   232

		/* skip */

   233

		w->SetWidgetDisabledState(ORDER_WIDGET_SKIP, v->num_orders <= 1);

   234

   235

		/* delete */

   236

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   237

				(uint)v->num_orders + ((shared_orders || v->num_orders != 0) ? 1 : 0) <= (uint)WP(w, order_d).sel);

   238

   239

		/* non-stop only for trains */

   240

		w->SetWidgetDisabledState(ORDER_WIDGET_NON_STOP,  v->type != VEH_TRAIN || order == NULL);

   241

		w->SetWidgetDisabledState(ORDER_WIDGET_FULL_LOAD, order == NULL || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // full load

   242

		w->SetWidgetDisabledState(ORDER_WIDGET_UNLOAD,    order == NULL || (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) != 0); // unload

   243

		/* Disable list of vehicles with the same shared orders if there is no list */

   244

		w->SetWidgetDisabledState(ORDER_WIDGET_SHARED_ORDER_LIST, !shared_orders || v->orders == NULL);

   245

		w->SetWidgetDisabledState(ORDER_WIDGET_REFIT,     order == NULL); // Refit

   246

		w->SetWidgetDisabledState(ORDER_WIDGET_SERVICE,   order == NULL); // Refit

   247

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   248

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   249

   250

		w->HideWidget(ORDER_WIDGET_COND_VARIABLE);

   251

		w->HideWidget(ORDER_WIDGET_COND_COMPARATOR);

   252

		w->HideWidget(ORDER_WIDGET_COND_VALUE);

   253

	}

   254

   255

	w->ShowWidget(ORDER_WIDGET_NON_STOP);

   256

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   257

	w->ShowWidget(ORDER_WIDGET_FULL_LOAD);

   258

   259

	if (order != NULL) {

   260

		switch (order->GetType()) {

   261

			case OT_GOTO_STATION:

   262

				if (!GetStation(order->GetDestination())->IsBuoy()) break;

   263

				/* Fall-through */

   264

   265

			case OT_GOTO_WAYPOINT:

   266

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   267

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   268

				break;

   269

   270

			case OT_GOTO_DEPOT:

   271

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   272

   273

				/* Remove unload and replace it with refit */

   274

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   275

				w->ShowWidget(ORDER_WIDGET_REFIT);

   276

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   277

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   278

				break;

   279

   280

			case OT_CONDITIONAL: {

   281

				w->HideWidget(ORDER_WIDGET_NON_STOP);

   282

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   283

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   284

				w->ShowWidget(ORDER_WIDGET_COND_VARIABLE);

   285

				w->ShowWidget(ORDER_WIDGET_COND_COMPARATOR);

   286

				w->ShowWidget(ORDER_WIDGET_COND_VALUE);

   287

   288

				OrderConditionVariable ocv = order->GetConditionVariable();

   289

				w->SetWidgetDisabledState(ORDER_WIDGET_COND_COMPARATOR, ocv == OCV_UNCONDITIONALLY);

   290

				w->SetWidgetDisabledState(ORDER_WIDGET_COND_VALUE, ocv == OCV_REQUIRES_SERVICE || ocv == OCV_UNCONDITIONALLY);

   291

   292

				uint value = order->GetConditionValue();

   293

				if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);

   294

				SetDParam(1, value);

   295

			} break;

   296

   297

			default: // every other orders

   298

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   299

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   300

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   301

		}

   302

	}

   303

   304

	SetDParam(0, v->index);

   305

	DrawWindowWidgets(w);

   306

   307

	int y = 15;

   308

   309

	int i = w->vscroll.pos;

   310

	order = GetVehicleOrder(v, i);

   311

	StringID str;

   312

	while (order != NULL) {

   313

		str = (v->cur_order_index == i) ? STR_8805 : STR_8804;

   314

		SetDParam(6, STR_EMPTY);

   315

   316

		if (i - w->vscroll.pos < w->vscroll.cap) {

   317

			switch (order->GetType()) {

   318

				case OT_DUMMY:

   319

					SetDParam(1, STR_INVALID_ORDER);

   320

					SetDParam(2, order->GetDestination());

   321

					break;

   322

   323

				case OT_GOTO_STATION: {

   324

					OrderLoadFlags load = order->GetLoadType();

   325

					OrderUnloadFlags unload = order->GetUnloadType();

   326

   327

					SetDParam(1, STR_GO_TO_STATION);

   328

					SetDParam(2, STR_ORDER_GO_TO + (v->type == VEH_TRAIN ? order->GetNonStopType() : 0));

   329

					SetDParam(3, order->GetDestination());

   330

					SetDParam(4, (order->GetNonStopType() & ONSF_NO_STOP_AT_DESTINATION_STATION) ? STR_EMPTY : _station_load_types[unload][load]);

   331

				} break;

   332

   333

				case OT_GOTO_DEPOT:

   334

					if (v->type == VEH_AIRCRAFT) {

   335

						if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) {

   336

							SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   337

							SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   338

						} else {

   339

							SetDParam(1, STR_GO_TO_HANGAR);

   340

							SetDParam(3, order->GetDestination());

   341

						}

   342

						SetDParam(4, STR_EMPTY);

   343

					} else {

   344

						if (order->GetDepotActionType() & ODATFB_NEAREST_DEPOT) {

   345

							SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   346

							SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   347

						} else {

   348

							SetDParam(1, STR_GO_TO_DEPOT);

   349

							SetDParam(3, GetDepot(order->GetDestination())->town_index);

   350

						}

   351

   352

						switch (v->type) {

   353

							case VEH_TRAIN: SetDParam(4, STR_ORDER_TRAIN_DEPOT); break;

   354

							case VEH_ROAD:  SetDParam(4, STR_ORDER_ROAD_DEPOT); break;

   355

							case VEH_SHIP:  SetDParam(4, STR_ORDER_SHIP_DEPOT); break;

   356

							default: NOT_REACHED();

   357

						}

   358

					}

   359

   360

					if (order->GetDepotOrderType() & ODTFB_SERVICE) {

   361

						SetDParam(2, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_SERVICE_NON_STOP_AT : STR_ORDER_SERVICE_AT);

   362

					} else {

   363

						SetDParam(2, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_ORDER_GO_NON_STOP_TO : STR_ORDER_GO_TO);

   364

					}

   365

   366

					if (order->IsRefit()) {

   367

						SetDParam(6, STR_REFIT_ORDER);

   368

						SetDParam(7, GetCargo(order->GetRefitCargo())->name);

   369

					}

   370

					break;

   371

   372

				case OT_GOTO_WAYPOINT:

   373

					SetDParam(1, (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_GO_NON_STOP_TO_WAYPOINT : STR_GO_TO_WAYPOINT);

   374

					SetDParam(2, order->GetDestination());

   375

					break;

   376

   377

				case OT_CONDITIONAL:

   378

					SetDParam(2, order->GetConditionSkipToOrder() + 1);

   379

					if (order->GetConditionVariable() == OCV_UNCONDITIONALLY) {

   380

						SetDParam(1, STR_CONDITIONAL_UNCONDITIONAL);

   381

					} else {

   382

						OrderConditionComparator occ = order->GetConditionComparator();

   383

						SetDParam(1, (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) ? STR_CONDITIONAL_TRUE_FALSE : STR_CONDITIONAL_NUM);

   384

						SetDParam(3, STR_ORDER_CONDITIONAL_LOAD_PERCENTAGE + order->GetConditionVariable());

   385

						SetDParam(4, STR_ORDER_CONDITIONAL_COMPARATOR_EQUALS + occ);

   386

   387

						uint value = order->GetConditionValue();

   388

						if (order->GetConditionVariable() == OCV_MAX_SPEED) value = ConvertSpeedToDisplaySpeed(value);

   389

						SetDParam(5, value);

   390

					}

   391

					break;

   392

   393

				default: NOT_REACHED();

   394

			}

   395

   396

			SetDParam(0, i + 1);

   397

			DrawString(2, y, str, (i == WP(w, order_d).sel) ? TC_WHITE : TC_BLACK);

   398

   399

			y += 10;

   400

		}

   401

   402

		i++;

   403

		order = order->next;

   404

	}

   405

   406

	if (i - w->vscroll.pos < w->vscroll.cap) {

   407

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   408

		DrawString(2, y, str, (i == WP(w, order_d).sel) ? TC_WHITE : TC_BLACK);

   409

	}

   410

}

   411

   412

static Order GetOrderCmdFromTile(const Vehicle *v, TileIndex tile)

   413

{

   414

	Order order;

   415

	order.next  = NULL;

   416

	order.index = 0;

   417

   418

	/* check depot first */

   419

	if (_patches.gotodepot) {

   420

		switch (GetTileType(tile)) {

   421

			case MP_RAILWAY:

   422

				if (v->type == VEH_TRAIN && IsTileOwner(tile, _local_player)) {

   423

					if (IsRailDepot(tile)) {

   424

						order.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   426

						return order;

   427

					}

   428

				}

   429

				break;

   430

   431

			case MP_ROAD:

   432

				if (IsRoadDepot(tile) && v->type == VEH_ROAD && IsTileOwner(tile, _local_player)) {

   433

					order.MakeGoToDepot(GetDepotByTile(tile)->index, ODTFB_PART_OF_ORDERS);

   434

					return order;

   435

				}

   436

				break;

   437

   438

			case MP_STATION:

   439

				if (v->type != VEH_AIRCRAFT) break;

   440

				if (IsHangar(tile) && IsTileOwner(tile, _local_player)) {

   441

					order.MakeGoToDepot(GetStationIndex(tile), ODTFB_PART_OF_ORDERS);

   442

					return order;

   443

				}

   444

				break;

   445

   446

			case MP_WATER:

   447

				if (v->type != VEH_SHIP) break;

   448

				if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   449

						IsTileOwner(tile, _local_player)) {

   450

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   451

   452

					order.MakeGoToDepot(GetDepotByTile(tile < tile2 ? tile : tile2)->index, ODTFB_PART_OF_ORDERS);

   453

					return order;

   454

				}

   455

   456

			default:

   457

				break;

   458

		}

   459

	}

   460

   461

	/* check waypoint */

   462

	if (IsTileType(tile, MP_RAILWAY) &&

   463

			v->type == VEH_TRAIN &&

   464

			IsTileOwner(tile, _local_player) &&

   465

			IsRailWaypoint(tile)) {

   466

		order.MakeGoToWaypoint(GetWaypointByTile(tile)->index);

   468

		return order;

   469

	}

   470

   471

	if (IsTileType(tile, MP_STATION)) {

   472

		StationID st_index = GetStationIndex(tile);

   473

		const Station *st = GetStation(st_index);

   474

   475

		if (st->owner == _current_player || st->owner == OWNER_NONE) {

   476

			byte facil;

   477

			(facil = FACIL_DOCK, v->type == VEH_SHIP) ||

   478

			(facil = FACIL_TRAIN, v->type == VEH_TRAIN) ||

   479

			(facil = FACIL_AIRPORT, v->type == VEH_AIRCRAFT) ||

   480

			(facil = FACIL_BUS_STOP, v->type == VEH_ROAD && IsCargoInClass(v->cargo_type, CC_PASSENGERS)) ||

   481

			(facil = FACIL_TRUCK_STOP, 1);

   482

			if (st->facilities & facil) {

   483

				order.MakeGoToStation(st_index);

   484

				if (_patches.new_nonstop && v->type == VEH_TRAIN) order.SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);