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_FULL_LOAD,

    45

	ORDER_WIDGET_UNLOAD,

    46

	ORDER_WIDGET_REFIT,

    47

	ORDER_WIDGET_SERVICE,

    48

	ORDER_WIDGET_RESIZE_BAR,

    49

	ORDER_WIDGET_SHARED_ORDER_LIST,

    50

	ORDER_WIDGET_RESIZE,

    51

};

    52

    53

/**

    54

 * Return the memorised selected order.

    55

 *

    56

 * @param w current window

    57

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

    58

 *  else return the number of orders

    59

 */

    60

static int OrderGetSel(const Window *w)

    61

{

    62

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

    63

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

    64

    65

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

    66

}

    67

    68

/**

    69

 * Calculate the selected order.

    70

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

    71

 *  the position of the scrollbar.

    72

 *

    73

 * @param w current window

    74

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

    75

 * @param v current vehicle

    76

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

    77

 *  an invalid one has been selected.

    78

 */

    79

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

    80

{

    81

	/*

    82

	 * Calculation description:

    83

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

    84

	 * 10 = order text hight

    85

	 */

    86

	int sel = (y - 15) / 10;

    87

    88

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

    89

    90

	sel += w->vscroll.pos;

    91

    92

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

    93

}

    94

    95

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

    96

static const StringID _station_load_types[][5] = {

    97

	{

    98

		STR_EMPTY,

    99

		INVALID_STRING_ID,

   100

		STR_ORDER_FULL_LOAD,

   101

		STR_ORDER_FULL_LOAD_ANY,

   102

		STR_ORDER_NO_LOAD,

   103

	}, {

   104

		STR_ORDER_UNLOAD,

   105

		INVALID_STRING_ID,

   106

		STR_ORDER_UNLOAD_FULL_LOAD,

   107

		STR_ORDER_UNLOAD_FULL_LOAD_ANY,

   108

		STR_ORDER_UNLOAD_NO_LOAD,

   109

	}, {

   110

		STR_ORDER_TRANSFER,

   111

		INVALID_STRING_ID,

   112

		STR_ORDER_TRANSFER_FULL_LOAD,

   113

		STR_ORDER_TRANSFER_FULL_LOAD_ANY,

   114

		STR_ORDER_TRANSFER_NO_LOAD,

   115

	}, {

   116

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

   117

		INVALID_STRING_ID,

   118

		INVALID_STRING_ID,

   119

		INVALID_STRING_ID,

   120

		INVALID_STRING_ID,

   121

	}, {

   122

		STR_ORDER_NO_UNLOAD,

   123

		INVALID_STRING_ID,

   124

		STR_ORDER_NO_UNLOAD_FULL_LOAD,

   125

		STR_ORDER_NO_UNLOAD_FULL_LOAD_ANY,

   126

		INVALID_STRING_ID,

   127

	}

   128

};

   129

   130

static void DrawOrdersWindow(Window *w)

   131

{

   132

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

   133

	bool shared_orders = v->IsOrderListShared();

   134

   135

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

   136

   137

	int sel = OrderGetSel(w);

   138

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

   139

   140

	if (v->owner == _local_player) {

   141

		/* skip */

   142

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

   143

   144

		/* delete */

   145

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   146

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

   147

   148

		/* non-stop only for trains */

   149

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

   150

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

   151

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

   152

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

   153

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

   154

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

   155

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

   156

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   157

		w->HideWidget(ORDER_WIDGET_SERVICE); // Service

   158

	} else {

   159

		w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   160

	}

   161

   162

	w->ShowWidget(ORDER_WIDGET_UNLOAD);

   163

	w->ShowWidget(ORDER_WIDGET_FULL_LOAD);

   164

   165

	if (order != NULL) {

   166

		switch (order->GetType()) {

   167

			case OT_GOTO_STATION:

   168

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

   169

				/* Fall-through */

   170

   171

			case OT_GOTO_WAYPOINT:

   172

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   173

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   174

				break;

   175

   176

			case OT_GOTO_DEPOT:

   177

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   178

   179

				/* Remove unload and replace it with refit */

   180

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   181

				w->ShowWidget(ORDER_WIDGET_REFIT);

   182

				w->HideWidget(ORDER_WIDGET_FULL_LOAD);

   183

				w->ShowWidget(ORDER_WIDGET_SERVICE);

   184

				break;

   185

   186

			default: // every other orders

   187

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   188

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   189

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   190

		}

   191

	}

   192

   193

	SetDParam(0, v->index);

   194

	DrawWindowWidgets(w);

   195

   196

	int y = 15;

   197

   198

	int i = w->vscroll.pos;

   199

	order = GetVehicleOrder(v, i);

   200

	StringID str;

   201

	while (order != NULL) {

   202

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

   203

		SetDParam(5, STR_EMPTY);

   204

   205

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

   206

			SetDParam(1, 6);

   207

   208

			switch (order->GetType()) {

   209

				case OT_DUMMY:

   210

					SetDParam(1, STR_INVALID_ORDER);

   211

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

   212

					break;

   213

   214

				case OT_GOTO_STATION: {

   215

					OrderLoadFlags load = order->GetLoadType();

   216

					OrderUnloadFlags unload = order->GetUnloadType();

   217

   218

					SetDParam(1, STR_GO_TO_STATION);

   219

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

   220

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

   221

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

   222

				} break;

   223

   224

				case OT_GOTO_DEPOT: {

   225

					StringID s = STR_NULL;

   226

   227

					if (v->type == VEH_AIRCRAFT) {

   228

						s = STR_GO_TO_AIRPORT_HANGAR;

   229

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

   230

					} else {

   231

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

   232

   233

						switch (v->type) {

   234

							case VEH_TRAIN: s = (order->GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) ? STR_880F_GO_NON_STOP_TO_TRAIN_DEPOT : STR_GO_TO_TRAIN_DEPOT; break;

   235

							case VEH_ROAD:  s = STR_GO_TO_ROADVEH_DEPOT; break;

   236

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   237

							default: break;

   238

						}

   239

					}

   240

   241

					if (order->GetDepotOrderType() & ODTFB_SERVICE) s++; // service at

   242

   243

					SetDParam(1, s);

   244

					if (order->IsRefit()) {

   245

						SetDParam(5, STR_REFIT_ORDER);

   246

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

   247

					}

   248

					break;

   249

				}

   250

   251

				case OT_GOTO_WAYPOINT:

   252

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

   253

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

   254

					break;

   255

   256

				default: break;

   257

			}

   258

   259

			SetDParam(0, i + 1);

   260

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

   261

   262

			y += 10;

   263

		}

   264

   265

		i++;

   266

		order = order->next;

   267

	}

   268

   269

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

   270

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   271

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

   272

	}

   273

}

   274

   275

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

   276

{

   277

	Order order;

   278

	order.next  = NULL;

   279

	order.index = 0;

   280

   281

	/* check depot first */

   282

	if (_patches.gotodepot) {

   283

		switch (GetTileType(tile)) {

   284

			case MP_RAILWAY:

   285

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

   286

					if (IsRailDepot(tile)) {

   287

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

   288

						return order;

   289

					}

   290

				}

   291

				break;

   292

   293

			case MP_ROAD:

   294

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

   295

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

   296

					return order;

   297

				}

   298

				break;

   299

   300

			case MP_STATION:

   301

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

   302

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

   303

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

   304

					return order;

   305

				}

   306

				break;

   307

   308

			case MP_WATER:

   309

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

   310

				if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   311

						IsTileOwner(tile, _local_player)) {

   312

					TileIndex tile2 = GetOtherShipDepotTile(tile);

   313

   314

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

   315

					return order;

   316

				}

   317

   318

			default:

   319

				break;

   320

		}

   321

	}

   322

   323

	/* check waypoint */

   324

	if (IsTileType(tile, MP_RAILWAY) &&

   325

			v->type == VEH_TRAIN &&

   326

			IsTileOwner(tile, _local_player) &&

   327

			IsRailWaypoint(tile)) {

   328

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

   329

		return order;

   330

	}

   331

   332

	if (IsTileType(tile, MP_STATION)) {

   333

		StationID st_index = GetStationIndex(tile);

   334

		const Station *st = GetStation(st_index);

   335

   336

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

   337

			byte facil;

   338

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

   339

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

   340

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

   341

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

   342

			(facil = FACIL_TRUCK_STOP, 1);

   343

			if (st->facilities & facil) {

   344

				order.MakeGoToStation(st_index);

   345

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

   346

				return order;

   347

			}

   348

		}

   349

	}

   350

   351

	/* not found */

   352

	order.Free();

   353

	return order;

   354

}

   355

   356

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

   357

{

   358

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

   359

   360

	if (!u->IsPrimaryVehicle()) {

   361

		u = u->First();

   362

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

   363

	}

   364

   365

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

   366

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

   367

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

   368

   369

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

   370

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

   371

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

   372

		ResetObjectToPlace();

   373

	}

   374

   375

	return true;

   376

}

   377

   378

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

   379

{

   380

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

   381

	const Vehicle *u = CheckMouseOverVehicle();

   382

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

   383

   384

	const Order cmd = GetOrderCmdFromTile(v, tile);

   385

	if (!cmd.IsValid()) return;

   386

   387

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

   388

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

   389

		ResetObjectToPlace();

   390

	}

   391

}

   392

   393

/**

   394

 * Handle the click on the goto button.

   395

 *

   396

 * @param w current window

   397

 * @param v current vehicle

   398

 */

   399

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

   400

{

   401

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   402

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   403

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   404

		_place_clicked_vehicle = NULL;

   405

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   406

	} else {

   407

		ResetObjectToPlace();

   408

	}

   409

}

   410

   411

/**

   412

 * Handle the click on the full load button.

   413

 *

   414

 * @param w current window

   415

 * @param v current vehicle

   416

 * @param load_type the way to load.

   417

 */

   418

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

   419

{

   420

	VehicleOrderID sel_ord = OrderGetSel(w);

   421

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

   422

   423

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

   424

   425

	if (load_type < 0) {

   426

		switch (order->GetLoadType()) {

   427

			case OLF_LOAD_IF_POSSIBLE: load_type = OLFB_FULL_LOAD;       break;

   428

			case OLFB_FULL_LOAD:       load_type = OLF_FULL_LOAD_ANY;    break;

   429

			case OLF_FULL_LOAD_ANY:    load_type = OLFB_NO_LOAD;         break;

   430

			case OLFB_NO_LOAD:         load_type = OLF_LOAD_IF_POSSIBLE; break;

   431

			default: NOT_REACHED();

   432

		}

   433

	}

   434

	DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_LOAD | (load_type << 2), NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   435

}

   436

   437

/**

   438

 * Handle the click on the service.

   439

 *

   440

 * @param w current window

   441

 * @param v current vehicle

   442

 */

   443

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

   444

{

   445

	DoCommandP(v->tile, v->index + (OrderGetSel(w) << 16), MOF_DEPOT_ACTION, NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   446

}

   447

   448

/**

   449

 * Handle the click on the unload button.

   450

 *

   451

 * @param w current window

   452

 * @param v current vehicle

   453

 */

   454

static void OrderClick_Unload(Window *w, const Vehicle *v, int unload_type)

   455

{

   456

	VehicleOrderID sel_ord = OrderGetSel(w);

   457

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

   458

   459

	if (order->GetUnloadType() == unload_type) return;

   460

   461

	if (unload_type < 0) {

   462

		switch (order->GetUnloadType()) {

   463

			case OUF_UNLOAD_IF_POSSIBLE: unload_type = OUFB_UNLOAD;            break;

   464

			case OUFB_UNLOAD:            unload_type = OUFB_TRANSFER;          break;

   465

			case OUFB_TRANSFER:          unload_type = OUFB_NO_UNLOAD;         break;

   466

			case OUFB_NO_UNLOAD:         unload_type = OUF_UNLOAD_IF_POSSIBLE; break;

   467

			default: NOT_REACHED();

   468

		}

   469

	}

   470

   471

	DoCommandP(v->tile, v->index + (sel_ord << 16), MOF_UNLOAD | (unload_type << 2), NULL, CMD_MODIFY_ORDER | CMD_MSG(STR_8835_CAN_T_MODIFY_THIS_ORDER));

   472

}

   473

   474

/**

   475

 * Handle the click on the nonstop button.

   476

 *

   477

 * @param w current window

   478

 * @param v current vehicle

   479

 * @param non_stop what non-stop type to use; -1 to use the 'next' one.

   480

 */

   481

static void OrderClick_Nonstop(Window *w, const Vehicle *v, int non_stop)

   482

{

   483

	VehicleOrderID sel_ord = OrderGetSel(w);

   484