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

    31

#include "table/sprites.h"

    32

#include "table/strings.h"

    33

    34

enum OrderWindowWidgets {

    35

	ORDER_WIDGET_CLOSEBOX = 0,

    36

	ORDER_WIDGET_CAPTION,

    37

	ORDER_WIDGET_TIMETABLE_VIEW,

    38

	ORDER_WIDGET_ORDER_LIST,

    39

	ORDER_WIDGET_SCROLLBAR,

    40

	ORDER_WIDGET_SKIP,

    41

	ORDER_WIDGET_DELETE,

    42

	ORDER_WIDGET_NON_STOP,

    43

	ORDER_WIDGET_GOTO,

    44

	ORDER_WIDGET_GOTO_DROPDOWN,

    45

	ORDER_WIDGET_FULL_LOAD,

    46

	ORDER_WIDGET_UNLOAD,

    47

	ORDER_WIDGET_REFIT,

    48

	ORDER_WIDGET_SERVICE,

    49

	ORDER_WIDGET_RESIZE_BAR,

    50

	ORDER_WIDGET_SHARED_ORDER_LIST,

    51

	ORDER_WIDGET_RESIZE,

    52

};

    53

    54

struct order_d {

    55

	int sel;

    56

};

    57

assert_compile(WINDOW_CUSTOM_SIZE >= sizeof(order_d));

    58

    59

/**

    60

 * Return the memorised selected order.

    61

 *

    62

 * @param w current window

    63

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

    64

 *  else return the number of orders

    65

 */

    66

static int OrderGetSel(const Window *w)

    67

{

    68

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

    69

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

    70

    71

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

    72

}

    73

    74

/**

    75

 * Calculate the selected order.

    76

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

    77

 *  the position of the scrollbar.

    78

 *

    79

 * @param w current window

    80

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

    81

 * @param v current vehicle

    82

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

    83

 *  an invalid one has been selected.

    84

 */

    85

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

    86

{

    87

	/*

    88

	 * Calculation description:

    89

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

    90

	 * 10 = order text hight

    91

	 */

    92

	int sel = (y - 15) / 10;

    93

    94

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

    95

    96

	sel += w->vscroll.pos;

    97

    98

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

    99

}

   100

   101

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

   102

static const StringID _station_load_types[][5] = {

   103

	{

   104

		STR_EMPTY,

   105

		INVALID_STRING_ID,

   106

		STR_ORDER_FULL_LOAD,

   107

		STR_ORDER_FULL_LOAD_ANY,

   108

		STR_ORDER_NO_LOAD,

   109

	}, {

   110

		STR_ORDER_UNLOAD,

   111

		INVALID_STRING_ID,

   112

		STR_ORDER_UNLOAD_FULL_LOAD,

   113

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

   114

		STR_ORDER_UNLOAD_NO_LOAD,

   115

	}, {

   116

		STR_ORDER_TRANSFER,

   117

		INVALID_STRING_ID,

   118

		STR_ORDER_TRANSFER_FULL_LOAD,

   119

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   120

		STR_ORDER_TRANSFER_NO_LOAD,

   121

	}, {

   122

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

   123

		INVALID_STRING_ID,

   124

		INVALID_STRING_ID,

   125

		INVALID_STRING_ID,

   126

		INVALID_STRING_ID,

   127

	}, {

   128

		STR_ORDER_NO_UNLOAD,

   129

		INVALID_STRING_ID,

   130

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

   131

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

   132

		INVALID_STRING_ID,

   133

	}

   134

};

   135

   136

static const StringID _order_non_stop_drowdown[] = {

   137

	STR_ORDER_GO_TO,

   138

	STR_ORDER_GO_NON_STOP_TO,

   139

	STR_ORDER_GO_VIA,

   140

	STR_ORDER_GO_NON_STOP_VIA,

   141

	INVALID_STRING_ID

   142

};

   143

   144

static const StringID _order_full_load_drowdown[] = {

   145

	STR_ORDER_DROP_LOAD_IF_POSSIBLE,

   146

	STR_EMPTY,

   147

	STR_ORDER_DROP_FULL_LOAD_ALL,

   148

	STR_ORDER_DROP_FULL_LOAD_ANY,

   149

	STR_ORDER_DROP_NO_LOADING,

   150

	INVALID_STRING_ID

   151

};

   152

   153

static const StringID _order_unload_drowdown[] = {

   154

	STR_ORDER_DROP_UNLOAD_IF_ACCEPTED,

   155

	STR_ORDER_DROP_UNLOAD,

   156

	STR_ORDER_DROP_TRANSFER,

   157

	STR_EMPTY,

   158

	STR_ORDER_DROP_NO_UNLOADING,

   159

	INVALID_STRING_ID

   160

};

   161

   162

static const StringID _order_goto_dropdown[] = {

   163

	STR_ORDER_GO_TO,

   164

	STR_ORDER_GO_TO_NEAREST_DEPOT,

   165

	INVALID_STRING_ID

   166

};

   167

   168

static const StringID _order_goto_dropdown_aircraft[] = {

   169

	STR_ORDER_GO_TO,

   170

	STR_ORDER_GO_TO_NEAREST_HANGAR,

   171

	INVALID_STRING_ID

   172

};

   173

   174

static void DrawOrdersWindow(Window *w)

   175

{

   176

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

   177

	bool shared_orders = v->IsOrderListShared();

   178

   179

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

   180

   181

	int sel = OrderGetSel(w);

   182

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

   183

   184

	if (v->owner == _local_player) {

   185

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

   186

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

   187

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

   188

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

   189

   190

		/* skip */

   191

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

   192

   193

		/* delete */

   194

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   195

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

   196

   197

		/* non-stop only for trains */

   198

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

   199

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

   200

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

   201

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

   202

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

   203

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

   204

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

   205

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   206

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   207

	} else {

   208

		w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   209

	}

   210

   211

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   212

	w->ShowWidget(ORDER_WIDGET_FULL_LOAD);

   213

   214

	if (order != NULL) {

   215

		switch (order->GetType()) {

   216

			case OT_GOTO_STATION:

   217

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

   218

				/* Fall-through */

   219

   220

			case OT_GOTO_WAYPOINT:

   221

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   222

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   223

				break;

   224

   225

			case OT_GOTO_DEPOT:

   226

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   227

   228

				/* Remove unload and replace it with refit */

   229

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   230

				w->ShowWidget(ORDER_WIDGET_REFIT);

   231

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   232

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   233

				break;

   234

   235

			default: // every other orders

   236

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   237

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   238

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   239

		}

   240

	}

   241

   242

	SetDParam(0, v->index);

   243

	DrawWindowWidgets(w);

   244

   245

	int y = 15;

   246

   247

	int i = w->vscroll.pos;

   248

	order = GetVehicleOrder(v, i);

   249

	StringID str;

   250

	while (order != NULL) {

   251

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

   252

		SetDParam(5, STR_EMPTY);

   253

   254

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

   255

			switch (order->GetType()) {

   256

				case OT_DUMMY:

   257

					SetDParam(1, STR_INVALID_ORDER);

   258

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

   259

					break;

   260

   261

				case OT_GOTO_STATION: {

   262

					OrderLoadFlags load = order->GetLoadType();

   263

					OrderUnloadFlags unload = order->GetUnloadType();

   264

   265

					SetDParam(1, STR_GO_TO_STATION);

   266

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

   267

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

   268

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

   269

				} break;

   270

   271

				case OT_GOTO_DEPOT:

   272

					if (v->type == VEH_AIRCRAFT) {

   273

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

   274

							SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   275

							SetDParam(3, STR_ORDER_NEAREST_HANGAR);

   276

						} else {

   277

							SetDParam(1, STR_GO_TO_HANGAR);

   278

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

   279

						}

   280

						SetDParam(4, STR_EMPTY);

   281

					} else {

   282

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

   283

							SetDParam(1, STR_GO_TO_NEAREST_DEPOT);

   284

							SetDParam(3, STR_ORDER_NEAREST_DEPOT);

   285

						} else {

   286

							SetDParam(1, STR_GO_TO_DEPOT);

   287

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

   288

						}

   289

   290

						switch (v->type) {

   291

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

   292

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

   293

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

   294

							default: NOT_REACHED();

   295

						}

   296

					}

   297

   298

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

   299

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

   300

					} else {

   301

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

   302

					}

   303

   304

					if (order->IsRefit()) {

   305

						SetDParam(5, STR_REFIT_ORDER);

   306

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

   307

					}

   308

					break;

   309

   310

				case OT_GOTO_WAYPOINT:

   311

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

   312

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

   313

					break;

   314

   315

				default: NOT_REACHED();

   316

			}

   317

   318

			SetDParam(0, i + 1);

   319

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

   320

   321

			y += 10;

   322

		}

   323

   324

		i++;

   325

		order = order->next;

   326

	}

   327

   328

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

   329

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   330

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

   331

	}

   332

}

   333

   334

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

   335

{

   336

	Order order;

   337

	order.next  = NULL;

   338

	order.index = 0;

   339

   340

	/* check depot first */

   341

	if (_patches.gotodepot) {

   342

		switch (GetTileType(tile)) {

   343

			case MP_RAILWAY:

   344

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

   345

					if (IsRailDepot(tile)) {

   346

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

   347

						return order;

   348

					}

   349

				}

   350

				break;

   351

   352

			case MP_ROAD:

   353

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

   354

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

   355

					return order;

   356

				}

   357

				break;

   358

   359

			case MP_STATION:

   360

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

   361

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

   362

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

   363

					return order;

   364

				}

   365

				break;

   366

   367

			case MP_WATER:

   368

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

   369

				if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   370

						IsTileOwner(tile, _local_player)) {

   371

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   372

   373

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

   374

					return order;

   375

				}

   376

   377

			default:

   378

				break;

   379

		}

   380

	}

   381

   382

	/* check waypoint */

   383

	if (IsTileType(tile, MP_RAILWAY) &&

   384

			v->type == VEH_TRAIN &&

   385

			IsTileOwner(tile, _local_player) &&

   386

			IsRailWaypoint(tile)) {

   387

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

   388

		return order;

   389

	}

   390

   391

	if (IsTileType(tile, MP_STATION)) {

   392

		StationID st_index = GetStationIndex(tile);

   393

		const Station *st = GetStation(st_index);

   394

   395

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

   396

			byte facil;

   397

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

   398

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

   399

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

   400

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

   401

			(facil = FACIL_TRUCK_STOP, 1);

   402

			if (st->facilities & facil) {

   403

				order.MakeGoToStation(st_index);

   404

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

   405

				return order;

   406

			}

   407

		}

   408

	}

   409

   410

	/* not found */

   411

	order.Free();

   412

	return order;

   413

}

   414

   415

static bool HandleOrderVehClick(const Vehicle *v, const Vehicle *u, Window *w)

   416

{

   417

	if (u->type != v->type) return false;

   418

   419

	if (!u->IsPrimaryVehicle()) {

   420

		u = u->First();

   421

		if (!u->IsPrimaryVehicle()) return false;

   422

	}

   423

   424

	/* v is vehicle getting orders. Only copy/clone orders if vehicle doesn't have any orders yet

   425

	 * obviously if you press CTRL on a non-empty orders vehicle you know what you are doing */

   426

	if (v->num_orders != 0 && _ctrl_pressed == 0) return false;

   427

   428

	if (DoCommandP(v->tile, v->index | (u->index << 16), _ctrl_pressed ? CO_SHARE : CO_COPY, NULL,

   429

		_ctrl_pressed ? CMD_CLONE_ORDER | CMD_MSG(STR_CANT_SHARE_ORDER_LIST) : CMD_CLONE_ORDER | CMD_MSG(STR_CANT_COPY_ORDER_LIST))) {

   430

		WP(w, order_d).sel = -1;

   431

		ResetObjectToPlace();

   432

	}

   433

   434

	return true;

   435

}

   436

   437

static void OrdersPlaceObj(const Vehicle *v, TileIndex tile, Window *w)

   438

{

   439

	/* check if we're clicking on a vehicle first.. clone orders in that case. */

   440

	const Vehicle *u = CheckMouseOverVehicle();

   441

	if (u != NULL && HandleOrderVehClick(v, u, w)) return;

   442

   443

	const Order cmd = GetOrderCmdFromTile(v, tile);

   444

	if (!cmd.IsValid()) return;

   445

   446

	if (DoCommandP(v->tile, v->index + (OrderGetSel(w) << 16), cmd.Pack(), NULL, CMD_INSERT_ORDER | CMD_MSG(STR_8833_CAN_T_INSERT_NEW_ORDER))) {

   447

		if (WP(w, order_d).sel != -1) WP(w,order_d).sel++;

   448

		ResetObjectToPlace();

   449

	}

   450

}

   451

   452

/**

   453

 * Handle the click on the goto button.

   454

 *

   455

 * @param w current window

   456

 * @param v current vehicle

   457

 */

   458

static void OrderClick_Goto(Window *w, const Vehicle *v, int i)

   459

{

   460

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   461

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   462

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   463

		_place_clicked_vehicle = NULL;

   464

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   465

	} else {

   466

		ResetObjectToPlace();

   467

	}

   468

}

   469

   470

/**

   471

 * Handle the click on the full load button.

   472

 *

   473

 * @param w current window

   474

 * @param v current vehicle

   475

 * @param load_type the way to load.

   476

 */

   477

static void OrderClick_FullLoad(Window *w, const Vehicle *v, int load_type)

   478

{

   479

	VehicleOrderID sel_ord = OrderGetSel(w);

   480

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

   481

   482

	if (order->GetLoadType() == load_type) return;

   483

   484

	if (load_type < 0) {

   485

		switch (order->GetLoadType()) {