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

    10

#include "table/strings.h"

    11

#include "gui.h"

    12

#include "window_gui.h"

    13

#include "station.h"

    14

#include "town.h"

    15

#include "command_func.h"

    16

#include "viewport.h"

    17

#include "depot.h"

    18

#include "waypoint.h"

    19

#include "train.h"

    20

#include "water_map.h"

    21

#include "vehicle_gui.h"

    22

#include "timetable.h"

    23

#include "cargotype.h"

    24

#include "order.h"

    25

#include "strings_func.h"

    26

#include "window_func.h"

    28

    29

enum OrderWindowWidgets {

    30

	ORDER_WIDGET_CLOSEBOX = 0,

    31

	ORDER_WIDGET_CAPTION,

    32

	ORDER_WIDGET_TIMETABLE_VIEW,

    33

	ORDER_WIDGET_ORDER_LIST,

    34

	ORDER_WIDGET_SCROLLBAR,

    35

	ORDER_WIDGET_SKIP,

    36

	ORDER_WIDGET_DELETE,

    37

	ORDER_WIDGET_NON_STOP,

    38

	ORDER_WIDGET_GOTO,

    39

	ORDER_WIDGET_FULL_LOAD,

    40

	ORDER_WIDGET_UNLOAD,

    41

	ORDER_WIDGET_REFIT,

    42

	ORDER_WIDGET_TRANSFER,

    43

	ORDER_WIDGET_SHARED_ORDER_LIST,

    44

	ORDER_WIDGET_RESIZE_BAR,

    45

	ORDER_WIDGET_RESIZE,

    46

};

    47

    48

/**

    49

 * Return the memorised selected order.

    50

 *

    51

 * @param w current window

    52

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

    53

 *  else return the number of orders

    54

 */

    55

static int OrderGetSel(const Window *w)

    56

{

    57

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

    58

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

    59

    60

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

    61

}

    62

    63

/**

    64

 * Calculate the selected order.

    65

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

    66

 *  the position of the scrollbar.

    67

 *

    68

 * @param w current window

    69

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

    70

 * @param v current vehicle

    71

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

    72

 *  an invalid one has been selected.

    73

 */

    74

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

    75

{

    76

	/*

    77

	 * Calculation description:

    78

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

    79

	 * 10 = order text hight

    80

	 */

    81

	int sel = (y - 15) / 10;

    82

    83

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

    84

    85

	sel += w->vscroll.pos;

    86

    87

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

    88

}

    89

    90

static StringID StationOrderStrings[] = {

    91

	STR_8806_GO_TO,

    92

	STR_8807_GO_TO_TRANSFER,

    93

	STR_8808_GO_TO_UNLOAD,

    94

	STR_8809_GO_TO_TRANSFER_UNLOAD,

    95

	STR_880A_GO_TO_LOAD,

    96

	STR_880B_GO_TO_TRANSFER_LOAD,

    97

	STR_NULL,

    98

	STR_NULL,

    99

	STR_880C_GO_NON_STOP_TO,

   100

	STR_880D_GO_TO_NON_STOP_TRANSFER,

   101

	STR_880E_GO_NON_STOP_TO_UNLOAD,

   102

	STR_880F_GO_TO_NON_STOP_TRANSFER_UNLOAD,

   103

	STR_8810_GO_NON_STOP_TO_LOAD,

   104

	STR_8811_GO_TO_NON_STOP_TRANSFER_LOAD,

   105

	STR_NULL

   106

};

   107

   108

static void DrawOrdersWindow(Window *w)

   109

{

   110

	const Vehicle *v;

   111

	const Order *order;

   112

	StringID str;

   113

	int sel;

   114

	int y, i;

   115

	bool shared_orders;

   116

   117

	v = GetVehicle(w->window_number);

   118

   119

	shared_orders = IsOrderListShared(v);

   120

   121

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

   122

   123

	sel = OrderGetSel(w);

   124

	SetDParam(2, STR_8827_FULL_LOAD);

   125

   126

	order = GetVehicleOrder(v, sel);

   127

   128

	if (v->owner == _local_player) {

   129

		/* skip */

   130

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

   131

   132

		/* delete */

   133

		w->SetWidgetDisabledState(ORDER_WIDGET_DELETE,

   134

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

   135

   136

		/* non-stop only for trains */

   137

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

   138

		w->SetWidgetDisabledState(ORDER_WIDGET_FULL_LOAD, order == NULL); // full load

   139

		w->SetWidgetDisabledState(ORDER_WIDGET_UNLOAD,    order == NULL); // unload

   140

		w->SetWidgetDisabledState(ORDER_WIDGET_TRANSFER,  order == NULL); // transfer

   141

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

   142

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

   143

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

   144

		w->HideWidget(ORDER_WIDGET_REFIT); // Refit

   145

	} else {

   146

		w->DisableWidget(ORDER_WIDGET_TRANSFER);

   147

	}

   148

   149

	w->ShowWidget(ORDER_WIDGET_UNLOAD); // Unload

   150

   151

	if (order != NULL) {

   152

		switch (order->type) {

   153

			case OT_GOTO_STATION:

   154

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

   155

				/* Fall-through */

   156

   157

			case OT_GOTO_WAYPOINT:

   158

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   159

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   160

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   161

				break;

   162

   163

			case OT_GOTO_DEPOT:

   164

				w->DisableWidget(ORDER_WIDGET_TRANSFER);

   165

   166

				/* Remove unload and replace it with refit */

   167

				w->HideWidget(ORDER_WIDGET_UNLOAD);

   168

				w->ShowWidget(ORDER_WIDGET_REFIT);

   169

				SetDParam(2,STR_SERVICE);

   170

				break;

   171

   172

			default: // every other orders

   173

				w->DisableWidget(ORDER_WIDGET_NON_STOP);

   174

				w->DisableWidget(ORDER_WIDGET_FULL_LOAD);

   175

				w->DisableWidget(ORDER_WIDGET_UNLOAD);

   176

		}

   177

	}

   178

   179

	SetDParam(0, v->index);

   180

	DrawWindowWidgets(w);

   181

   182

	y = 15;

   183

   184

	i = w->vscroll.pos;

   185

	order = GetVehicleOrder(v, i);

   186

	while (order != NULL) {

   187

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

   188

		SetDParam(3, STR_EMPTY);

   189

   190

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

   191

			SetDParam(1, 6);

   192

   193

			switch (order->type) {

   194

				case OT_DUMMY:

   195

					SetDParam(1, STR_INVALID_ORDER);

   196

					SetDParam(2, order->dest);

   197

					break;

   198

   199

				case OT_GOTO_STATION:

   200

					SetDParam(1, StationOrderStrings[order->flags]);

   201

					SetDParam(2, order->dest);

   202

					break;

   203

   204

				case OT_GOTO_DEPOT: {

   205

					StringID s = STR_NULL;

   206

   207

					if (v->type == VEH_AIRCRAFT) {

   208

						s = STR_GO_TO_AIRPORT_HANGAR;

   209

						SetDParam(2, order->dest);

   210

					} else {

   211

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

   212

   213

						switch (v->type) {

   214

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

   215

							case VEH_ROAD:  s = STR_9038_GO_TO_ROADVEH_DEPOT; break;

   216

							case VEH_SHIP:  s = STR_GO_TO_SHIP_DEPOT; break;

   217

							default: break;

   218

						}

   219

					}

   220

   221

					if (order->flags & OF_FULL_LOAD) s++; /* service at */

   222

   223

					SetDParam(1, s);

   224

					if (order->refit_cargo < NUM_CARGO) {

   225

						SetDParam(3, STR_REFIT_ORDER);

   226

						SetDParam(4, GetCargo(order->refit_cargo)->name);

   227

					} else {

   228

						SetDParam(3, STR_EMPTY);

   229

					}

   230

					break;

   231

				}

   232

   233

				case OT_GOTO_WAYPOINT:

   234

					SetDParam(1, (order->flags & OF_NON_STOP) ? STR_GO_NON_STOP_TO_WAYPOINT : STR_GO_TO_WAYPOINT);

   235

					SetDParam(2, order->dest);

   236

					break;

   237

   238

				default: break;

   239

			}

   240

   241

			SetDParam(0, i + 1);

   242

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

   243

   244

			y += 10;

   245

		}

   246

   247

		i++;

   248

		order = order->next;

   249

	}

   250

   251

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

   252

		str = shared_orders ? STR_END_OF_SHARED_ORDERS : STR_882A_END_OF_ORDERS;

   253

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

   254

	}

   255

}

   256

   257

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

   258

{

   259

	Order order;

   260

	order.next  = NULL;

   261

	order.index = 0;

   262

	order.refit_cargo   = CT_INVALID;

   263

	order.refit_subtype = 0;

   264

   265

	// check depot first

   266

	if (_patches.gotodepot) {

   267

		switch (GetTileType(tile)) {

   268

		case MP_RAILWAY:

   269

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

   270

				if (IsRailDepot(tile)) {

   271

					order.type = OT_GOTO_DEPOT;

   272

					order.flags = OF_PART_OF_ORDERS;

   273

					order.dest = GetDepotByTile(tile)->index;

   274

					return order;

   275

				}

   276

			}

   277

			break;

   278

   279

		case MP_ROAD:

   280

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

   281

				order.type = OT_GOTO_DEPOT;

   282

				order.flags = OF_PART_OF_ORDERS;

   283

				order.dest = GetDepotByTile(tile)->index;

   284

				return order;

   285

			}

   286

			break;

   287

   288

		case MP_STATION:

   289

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

   290

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

   291

				order.type = OT_GOTO_DEPOT;

   292

				order.flags = OF_PART_OF_ORDERS;

   293

				order.dest = GetStationIndex(tile);

   294

				return order;

   295

			}

   296

			break;

   297

   298

		case MP_WATER:

   299

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

   300

			if (IsTileDepotType(tile, TRANSPORT_WATER) &&

   301

					IsTileOwner(tile, _local_player)) {

   302

				TileIndex tile2 = GetOtherShipDepotTile(tile);

   303

   304

				order.type = OT_GOTO_DEPOT;

   305

				order.flags = OF_PART_OF_ORDERS;

   306

				order.dest = GetDepotByTile(tile < tile2 ? tile : tile2)->index;

   307

				return order;

   308

			}

   309

   310

			default:

   311

				break;

   312

		}

   313

	}

   314

   315

	// check waypoint

   316

	if (IsTileType(tile, MP_RAILWAY) &&

   317

			v->type == VEH_TRAIN &&

   318

			IsTileOwner(tile, _local_player) &&

   319

			IsRailWaypoint(tile)) {

   320

		order.type = OT_GOTO_WAYPOINT;

   321

		order.flags = 0;

   322

		order.dest = GetWaypointByTile(tile)->index;

   323

		return order;

   324

	}

   325

   326

	if (IsTileType(tile, MP_STATION)) {

   327

		StationID st_index = GetStationIndex(tile);

   328

		const Station *st = GetStation(st_index);

   329

   330

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

   331

			byte facil;

   332

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

   333

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

   334

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

   335

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

   336

			(facil=FACIL_TRUCK_STOP, 1);

   337

			if (st->facilities & facil) {

   338

				order.type = OT_GOTO_STATION;

   339

				order.flags = 0;

   340

				order.dest = st_index;

   341

				return order;

   342

			}

   343

		}

   344

	}

   345

   346

	// not found

   347

	order.Free();

   348

	order.dest = INVALID_STATION;

   349

	return order;

   350

}

   351

   352

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

   353

{

   354

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

   355

   356

	if (!u->IsPrimaryVehicle()) {

   357

		u = u->First();

   358

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

   359

	}

   360

   361

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

   362

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

   363

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

   364

   365

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

   366

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

   367

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

   368

		ResetObjectToPlace();

   369

	}

   370

   371

	return true;

   372

}

   373

   374

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

   375

{

   376

	Order cmd;

   377

	const Vehicle *u;

   378

   379

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

   380

	u = CheckMouseOverVehicle();

   381

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

   382

   383

	cmd = GetOrderCmdFromTile(v, tile);

   384

	if (!cmd.IsValid()) return;

   385

   386

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

   387

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

   388

		ResetObjectToPlace();

   389

	}

   390

}

   391

   392

/**

   393

 * Handle the click on the goto button.

   394

 *

   395

 * @param w current window

   396

 * @param v current vehicle

   397

 */

   398

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

   399

{

   400

	w->InvalidateWidget(ORDER_WIDGET_GOTO);

   401

	w->ToggleWidgetLoweredState(ORDER_WIDGET_GOTO);

   402

	if (w->IsWidgetLowered(ORDER_WIDGET_GOTO)) {

   403

		_place_clicked_vehicle = NULL;

   404

		SetObjectToPlaceWnd(ANIMCURSOR_PICKSTATION, PAL_NONE, VHM_RECT, w);

   405

	} else {

   406

		ResetObjectToPlace();

   407

	}

   408

}

   409

   410

/**

   411

 * Handle the click on the full load button.

   412

 *

   413

 * @param w current window

   414

 * @param v current vehicle

   415

 */

   416

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

   417

{

   418

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

   419

}

   420

   421

/**

   422

 * Handle the click on the unload button.

   423

 *

   424

 * @param w current window

   425

 * @param v current vehicle

   426

 */

   427

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

   428

{

   429

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

   430

}

   431

   432

/**

   433

 * Handle the click on the nonstop button.

   434

 *

   435

 * @param w current window

   436

 * @param v current vehicle

   437

 */

   438

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

   439

{

   440

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

   441

}

   442

   443

/**

   444

 * Handle the click on the transfer button.

   445

 *

   446

 * @param w current window

   447

 * @param v current vehicle

   448

 */

   449

static void OrderClick_Transfer(Window* w, const Vehicle* v)

   450

{

   451

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

   452

}

   453

   454

/**

   455

 * Handle the click on the skip button.

   456

 * If ctrl is pressed skip to selected order.

   457

 *  Else skip to current order + 1

   458

 *

   459

 * @param w current window

   460

 * @param v current vehicle

   461

 */

   462

static void OrderClick_Skip(Window *w, const Vehicle *v)

   463

{

   464

	/* Don't skip when there's nothing to skip */

   465

	if (_ctrl_pressed && v->cur_order_index == OrderGetSel(w)) return;

   466

   467

	DoCommandP(v->tile, v->index, _ctrl_pressed ? OrderGetSel(w) : ((v->cur_order_index + 1) % v->num_orders),

   468

			NULL, CMD_SKIP_TO_ORDER | CMD_MSG(_ctrl_pressed ? STR_CAN_T_SKIP_TO_ORDER : STR_CAN_T_SKIP_ORDER));

   469

}

   470

   471

/**

   472

 * Handle the click on the unload button.

   473

 *

   474

 * @param w current window

   475

 * @param v current vehicle

   476

 */

   477

static void OrderClick_Delete(Window *w, const Vehicle *v)

   478

{

   479

	DoCommandP(v->tile, v->index, OrderGetSel(w), NULL, CMD_DELETE_ORDER | CMD_MSG(STR_8834_CAN_T_DELETE_THIS_ORDER));

   480

}

   481

   482

/**

   483

 * Handle the click on the refit button.

   484

 * If ctrl is pressed cancel refitting.

   485

 *  Else show the refit window.