1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order_base.h"

     8

#include "order_func.h"

     9

#include "airport.h"

    10

#include "depot.h"

    11

#include "waypoint.h"

    12

#include "command_func.h"

    13

#include "player_func.h"

    14

#include "news_func.h"

    15

#include "saveload.h"

    16

#include "vehicle_gui.h"

    17

#include "cargotype.h"

    18

#include "aircraft.h"

    19

#include "strings_func.h"

    20

#include "core/alloc_func.hpp"

    21

#include "functions.h"

    22

#include "window_func.h"

    23

#include "settings_type.h"

    24

#include "string_func.h"

    25

#include "newgrf_cargo.h"

    26

#include "timetable.h"

    27

#include "vehicle_func.h"

    28

    29

#include "table/strings.h"

    30

    31

/* DestinationID must be at least as large as every these below, because it can

    32

 * be any of them

    33

 */

    34

assert_compile(sizeof(DestinationID) >= sizeof(DepotID));

    35

assert_compile(sizeof(DestinationID) >= sizeof(WaypointID));

    36

assert_compile(sizeof(DestinationID) >= sizeof(StationID));

    37

    38

TileIndex _backup_orders_tile;

    39

BackuppedOrders _backup_orders_data;

    40

    41

DEFINE_OLD_POOL_GENERIC(Order, Order)

    42

    43

/**

    44

 *

    45

 * Unpacks a order from savegames made with TTD(Patch)

    46

 *

    47

 */

    48

Order UnpackOldOrder(uint16 packed)

    49

{

    50

	Order order;

    51

	order.type    = (OrderType)GB(packed, 0, 4);

    52

	order.flags   = GB(packed, 4, 4);

    53

	order.dest    = GB(packed, 8, 8);

    54

	order.next    = NULL;

    55

    56

	order.refit_cargo   = CT_NO_REFIT;

    57

	order.refit_subtype = 0;

    58

	order.wait_time     = 0;

    59

	order.travel_time   = 0;

    60

	order.index = 0; // avoid compiler warning

    61

    62

	// Sanity check

    63

	// TTD stores invalid orders as OT_NOTHING with non-zero flags/station

    64

	if (!order.IsValid() && (order.flags != 0 || order.dest != 0)) {

    65

		order.type = OT_DUMMY;

    66

		order.flags = 0;

    67

	}

    68

    69

	return order;

    70

}

    71

    72

/**

    73

 *

    74

 * Unpacks a order from savegames with version 4 and lower

    75

 *

    76

 */

    77

static Order UnpackVersion4Order(uint16 packed)

    78

{

    79

	Order order;

    80

	order.type  = (OrderType)GB(packed, 0, 4);

    81

	order.flags = GB(packed, 4, 4);

    82

	order.dest  = GB(packed, 8, 8);

    83

	order.next  = NULL;

    84

	order.index = 0; // avoid compiler warning

    85

	order.refit_cargo   = CT_NO_REFIT;

    86

	order.refit_subtype = 0;

    87

	order.wait_time     = 0;

    88

	order.travel_time   = 0;

    89

	return order;

    90

}

    91

    92

/**

    93

 *

    94

 * Updates the widgets of a vehicle which contains the order-data

    95

 *

    96

 */

    97

void InvalidateVehicleOrder(const Vehicle *v)

    98

{

    99

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   100

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   101

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   102

}

   103

   104

/**

   105

 *

   106

 * Swap two orders

   107

 *

   108

 */

   109

static void SwapOrders(Order *order1, Order *order2)

   110

{

   111

	Order temp_order;

   112

   113

	temp_order = *order1;

   114

	AssignOrder(order1, *order2);

   115

	order1->next = order2->next;

   116

	AssignOrder(order2, temp_order);

   117

	order2->next = temp_order.next;

   118

}

   119

   120

/**

   121

 *

   122

 * Assign data to an order (from an other order)

   123

 *   This function makes sure that the index is maintained correctly

   124

 *

   125

 */

   126

void AssignOrder(Order *order, Order data)

   127

{

   128

	order->type  = data.type;

   129

	order->flags = data.flags;

   130

	order->dest  = data.dest;

   131

   132

	order->refit_cargo   = data.refit_cargo;

   133

	order->refit_subtype = data.refit_subtype;

   134

   135

	order->wait_time   = data.wait_time;

   136

	order->travel_time = data.travel_time;

   137

}

   138

   139

   140

/**

   141

 * Delete all news items regarding defective orders about a vehicle

   142

 * This could kill still valid warnings (for example about void order when just

   143

 * another order gets added), but assume the player will notice the problems,

   144

 * when (s)he's changing the orders.

   145

 */

   146

static void DeleteOrderWarnings(const Vehicle* v)

   147

{

   148

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_TOO_FEW_ORDERS  + v->type * 4);

   149

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_VOID_ORDER      + v->type * 4);

   150

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_DUPLICATE_ENTRY + v->type * 4);

   151

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_INVALID_ENTRY   + v->type * 4);

   152

}

   153

   154

   155

static TileIndex GetOrderLocation(const Order& o)

   156

{

   157

	switch (o.type) {

   158

		default: NOT_REACHED();

   159

		case OT_GOTO_STATION: return GetStation(o.dest)->xy;

   160

		case OT_GOTO_DEPOT:   return GetDepot(o.dest)->xy;

   161

	}

   162

}

   163

   164

   165

/** Add an order to the orderlist of a vehicle.

   166

 * @param tile unused

   167

 * @param flags operation to perform

   168

 * @param p1 various bitstuffed elements

   169

 * - p1 = (bit  0 - 15) - ID of the vehicle

   170

 * - p1 = (bit 16 - 31) - the selected order (if any). If the last order is given,

   171

 *                        the order will be inserted before that one

   172

 *                        only the first 8 bits used currently (bit 16 - 23) (max 255)

   173

 * @param p2 packed order to insert

   174

 */

   175

CommandCost CmdInsertOrder(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   176

{

   177

	Vehicle *v;

   178

	VehicleID veh   = GB(p1,  0, 16);

   179

	VehicleOrderID sel_ord = GB(p1, 16, 16);

   180

	Order new_order = UnpackOrder(p2);

   181

   182

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   183

   184

	v = GetVehicle(veh);

   185

   186

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   187

   188

	/* Check if the inserted order is to the correct destination (owner, type),

   189

	 * and has the correct flags if any */

   190

	switch (new_order.type) {

   191

		case OT_GOTO_STATION: {

   192

			const Station *st;

   193

   194

			if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   195

			st = GetStation(new_order.dest);

   196

   197

			if (st->owner != OWNER_NONE && !CheckOwnership(st->owner)) {

   198

				return CMD_ERROR;

   199

			}

   200

   201

			switch (v->type) {

   202

				case VEH_TRAIN:

   203

					if (!(st->facilities & FACIL_TRAIN)) return CMD_ERROR;

   204

					break;

   205

   206

				case VEH_ROAD:

   207

					if (IsCargoInClass(v->cargo_type, CC_PASSENGERS)) {

   208

						if (!(st->facilities & FACIL_BUS_STOP)) return CMD_ERROR;

   209

					} else {

   210

						if (!(st->facilities & FACIL_TRUCK_STOP)) return CMD_ERROR;

   211

					}

   212

					break;

   213

   214

				case VEH_SHIP:

   215

					if (!(st->facilities & FACIL_DOCK)) return CMD_ERROR;

   216

					break;

   217

   218

				case VEH_AIRCRAFT:

   219

					if (!(st->facilities & FACIL_AIRPORT) || !CanAircraftUseStation(v->engine_type, st)) {

   220

						return CMD_ERROR;

   221

					}

   222

					break;

   223

   224

				default: return CMD_ERROR;

   225

			}

   226

   227

			/* Order flags can be any of the following for stations:

   228

			 * [full-load | unload] [+ transfer] [+ non-stop]

   229

			 * non-stop orders (if any) are only valid for trains */

   230

			switch (new_order.flags) {

   231

				case 0:

   232

				case OFB_FULL_LOAD:

   233

				case OFB_FULL_LOAD | OFB_TRANSFER:

   234

				case OFB_UNLOAD:

   235

				case OFB_UNLOAD | OFB_TRANSFER:

   236

				case OFB_TRANSFER:

   237

					break;

   238

   239

				case OFB_NON_STOP:

   240

				case OFB_NON_STOP | OFB_FULL_LOAD:

   241

				case OFB_NON_STOP | OFB_FULL_LOAD | OFB_TRANSFER:

   242

				case OFB_NON_STOP | OFB_UNLOAD:

   243

				case OFB_NON_STOP | OFB_UNLOAD | OFB_TRANSFER:

   244

				case OFB_NON_STOP | OFB_TRANSFER:

   245

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   246

					break;

   247

   248

				default: return CMD_ERROR;

   249

			}

   250

			break;

   251

		}

   252

   253

		case OT_GOTO_DEPOT: {

   254

			if (v->type == VEH_AIRCRAFT) {

   255

				const Station* st;

   256

   257

				if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   258

				st = GetStation(new_order.dest);

   259

   260

				if (!CheckOwnership(st->owner) ||

   261

						!(st->facilities & FACIL_AIRPORT) ||

   262

						st->Airport()->nof_depots == 0 ||

   263

						!CanAircraftUseStation(v->engine_type, st)) {

   264

					return CMD_ERROR;

   265

				}

   266

			} else {

   267

				const Depot* dp;

   268

   269

				if (!IsValidDepotID(new_order.dest)) return CMD_ERROR;

   270

				dp = GetDepot(new_order.dest);

   271

   272

				if (!CheckOwnership(GetTileOwner(dp->xy))) return CMD_ERROR;

   273

   274

				switch (v->type) {

   275

					case VEH_TRAIN:

   276

						if (!IsTileDepotType(dp->xy, TRANSPORT_RAIL)) return CMD_ERROR;

   277

						break;

   278

   279

					case VEH_ROAD:

   280

						if (!IsTileDepotType(dp->xy, TRANSPORT_ROAD)) return CMD_ERROR;

   281

						break;

   282

   283

					case VEH_SHIP:

   284

						if (!IsTileDepotType(dp->xy, TRANSPORT_WATER)) return CMD_ERROR;

   285

						break;

   286

   287

					default: return CMD_ERROR;

   288

				}

   289

			}

   290

   291

			/* Order flags can be any of the following for depots:

   292

			 * order [+ halt] [+ non-stop]

   293

			 * non-stop orders (if any) are only valid for trains */

   294

			switch (new_order.flags) {

   295

				case OFB_PART_OF_ORDERS:

   296

				case OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   297

					break;

   298

   299

				case OFB_NON_STOP | OFB_PART_OF_ORDERS:

   300

				case OFB_NON_STOP | OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   301

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   302

					break;

   303

   304

				default: return CMD_ERROR;

   305

			}

   306

			break;

   307

		}

   308

   309

		case OT_GOTO_WAYPOINT: {

   310

			const Waypoint* wp;

   311

   312

			if (v->type != VEH_TRAIN) return CMD_ERROR;

   313

   314

			if (!IsValidWaypointID(new_order.dest)) return CMD_ERROR;

   315

			wp = GetWaypoint(new_order.dest);

   316

   317

			if (!CheckOwnership(GetTileOwner(wp->xy))) return CMD_ERROR;

   318

   319

			/* Order flags can be any of the following for waypoints:

   320

			 * [non-stop]

   321

			 * non-stop orders (if any) are only valid for trains */

   322

			switch (new_order.flags) {

   323

				case 0: break;

   324

   325

				case OFB_NON_STOP:

   326

					if (v->type != VEH_TRAIN) return CMD_ERROR;

   327

					break;

   328

   329

				default: return CMD_ERROR;

   330

			}

   331

			break;

   332

		}

   333

   334

		default: return CMD_ERROR;

   335

	}

   336

   337

	if (sel_ord > v->num_orders) return CMD_ERROR;

   338

   339

	if (!HasOrderPoolFree(1)) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   340

   341

	if (v->type == VEH_SHIP && IsHumanPlayer(v->owner) && _patches.pathfinder_for_ships != VPF_NPF) {

   342

		/* Make sure the new destination is not too far away from the previous */

   343

		const Order *prev = NULL;

   344

		uint n = 0;

   345

   346

		/* Find the last goto station or depot order before the insert location.

   347

		 * If the order is to be inserted at the beginning of the order list this

   348

		 * finds the last order in the list. */

   349

		for (const Order *o = v->orders; o != NULL; o = o->next) {

   350

			if (o->type == OT_GOTO_STATION || o->type == OT_GOTO_DEPOT) prev = o;

   351

			if (++n == sel_ord && prev != NULL) break;

   352

		}

   353

		if (prev != NULL) {

   354

			uint dist = DistanceManhattan(

   355

				GetOrderLocation(*prev),

   356

				GetOrderLocation(new_order)

   357

			);

   358

			if (dist >= 130) {

   359

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   360

			}

   361

		}

   362

	}

   363

   364

	if (flags & DC_EXEC) {

   365

		Vehicle *u;

   366

		Order *new_o = new Order();

   367

		AssignOrder(new_o, new_order);

   368

   369

		/* Create new order and link in list */

   370

		if (v->orders == NULL) {

   371

			v->orders = new_o;

   372

		} else {

   373

			/* Try to get the previous item (we are inserting above the

   374

			    selected) */

   375

			Order *order = GetVehicleOrder(v, sel_ord - 1);

   376

   377

			if (order == NULL && GetVehicleOrder(v, sel_ord) != NULL) {

   378

				/* There is no previous item, so we are altering v->orders itself

   379

				    But because the orders can be shared, we copy the info over

   380

				    the v->orders, so we don't have to change the pointers of

   381

				    all vehicles */

   382

				SwapOrders(v->orders, new_o);

   383

				/* Now update the next pointers */

   384

				v->orders->next = new_o;

   385

			} else if (order == NULL) {

   386

				/* 'sel' is a non-existing order, add him to the end */

   387

				order = GetLastVehicleOrder(v);

   388

				order->next = new_o;

   389

			} else {

   390

				/* Put the new order in between */

   391

				new_o->next = order->next;

   392

				order->next = new_o;

   393

			}

   394

		}

   395

   396

		u = GetFirstVehicleFromSharedList(v);

   397

		DeleteOrderWarnings(u);

   398

		for (; u != NULL; u = u->next_shared) {

   399

			/* Increase amount of orders */

   400

			u->num_orders++;

   401

   402

			/* If the orderlist was empty, assign it */

   403

			if (u->orders == NULL) u->orders = v->orders;

   404

   405

			assert(v->orders == u->orders);

   406

   407

			/* If there is added an order before the current one, we need

   408

			to update the selected order */

   409

			if (sel_ord <= u->cur_order_index) {

   410

				uint cur = u->cur_order_index + 1;

   411

				/* Check if we don't go out of bound */

   412

				if (cur < u->num_orders)

   413

					u->cur_order_index = cur;

   414

			}

   415

			/* Update any possible open window of the vehicle */

   416

			InvalidateVehicleOrder(u);

   417

		}

   418

   419

		/* Make sure to rebuild the whole list */

   420

		RebuildVehicleLists();

   421

	}

   422

   423

	return CommandCost();

   424

}

   425

   426

/** Declone an order-list

   427

 * @param *dst delete the orders of this vehicle

   428

 * @param flags execution flags

   429

 */

   430

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   431

{

   432

	if (flags & DC_EXEC) {

   433

		DeleteVehicleOrders(dst);

   434

		InvalidateVehicleOrder(dst);

   435

		RebuildVehicleLists();

   436

	}

   437

	return CommandCost();

   438

}

   439

   440

/**

   441

 * Remove the VehicleList that shows all the vehicles with the same shared

   442

 *  orders.

   443

 */

   444

static void RemoveSharedOrderVehicleList(Vehicle *v)

   445

{

   446

	assert(v->orders != NULL);

   447

	WindowClass window_class = WC_NONE;

   448

   449

	switch (v->type) {

   450

		default: NOT_REACHED();

   451

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   452

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   453

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   454

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   455

	}

   456

	DeleteWindowById(window_class, (v->orders->index << 16) | (v->type << 11) | VLW_SHARED_ORDERS | v->owner);

   457

}

   458

   459

/** Delete an order from the orderlist of a vehicle.

   460

 * @param tile unused

   461

 * @param flags operation to perform

   462

 * @param p1 the ID of the vehicle

   463

 * @param p2 the order to delete (max 255)

   464

 */

   465

CommandCost CmdDeleteOrder(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   466

{

   467

	Vehicle *v, *u;

   468

	VehicleID veh_id = p1;

   469

	VehicleOrderID sel_ord = p2;

   470

	Order *order;

   471

   472

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   473

   474

	v = GetVehicle(veh_id);

   475

   476

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   477

   478

	/* If we did not select an order, we maybe want to de-clone the orders */

   479

	if (sel_ord >= v->num_orders)

   480

		return DecloneOrder(v, flags);

   481

   482

	order = GetVehicleOrder(v, sel_ord);

   483

	if (order == NULL) return CMD_ERROR;

   484