1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order.h"

     8

#include "airport.h"

     9

#include "depot.h"

    10

#include "table/strings.h"

    11

#include "waypoint.h"

    13

#include "station.h"

    14

#include "player.h"

    15

#include "news.h"

    16

#include "saveload.h"

    17

#include "vehicle_gui.h"

    18

#include "cargotype.h"

    19

#include "aircraft.h"

    26

    27

DEFINE_OLD_POOL_GENERIC(Order, Order)

    28

    29

/**

    30

 *

    31

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

    32

 *

    33

 */

    34

Order UnpackOldOrder(uint16 packed)

    35

{

    36

	Order order;

    37

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

    38

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

    39

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

    40

	order.next    = NULL;

    41

    42

	order.refit_cargo   = CT_NO_REFIT;

    43

	order.refit_subtype = 0;

    44

	order.wait_time     = 0;

    45

	order.travel_time   = 0;

    46

	order.index = 0; // avoid compiler warning

    47

    48

	// Sanity check

    49

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

    50

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

    51

		order.type = OT_DUMMY;

    52

		order.flags = 0;

    53

	}

    54

    55

	return order;

    56

}

    57

    58

/**

    59

 *

    60

 * Unpacks a order from savegames with version 4 and lower

    61

 *

    62

 */

    63

static Order UnpackVersion4Order(uint16 packed)

    64

{

    65

	Order order;

    66

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

    67

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

    68

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

    69

	order.next  = NULL;

    70

	order.index = 0; // avoid compiler warning

    71

	order.refit_cargo   = CT_NO_REFIT;

    72

	order.refit_subtype = 0;

    73

	order.wait_time     = 0;

    74

	order.travel_time   = 0;

    75

	return order;

    76

}

    77

    78

/**

    79

 *

    80

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

    81

 *

    82

 */

    83

void InvalidateVehicleOrder(const Vehicle *v)

    84

{

    85

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

    86

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

    87

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    88

}

    89

    90

/**

    91

 *

    92

 * Swap two orders

    93

 *

    94

 */

    95

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

    96

{

    97

	Order temp_order;

    98

    99

	temp_order = *order1;

   100

	AssignOrder(order1, *order2);

   101

	order1->next = order2->next;

   102

	AssignOrder(order2, temp_order);

   103

	order2->next = temp_order.next;

   104

}

   105

   106

/**

   107

 *

   108

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

   109

 *   This function makes sure that the index is maintained correctly

   110

 *

   111

 */

   112

void AssignOrder(Order *order, Order data)

   113

{

   114

	order->type  = data.type;

   115

	order->flags = data.flags;

   116

	order->dest  = data.dest;

   117

   118

	order->refit_cargo   = data.refit_cargo;

   119

	order->refit_subtype = data.refit_subtype;

   120

   121

	order->wait_time   = data.wait_time;

   122

	order->travel_time = data.travel_time;

   123

}

   124

   125

   126

/**

   127

 * Delete all news items regarding defective orders about a vehicle

   128

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

   129

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

   130

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

   131

 */

   132

static void DeleteOrderWarnings(const Vehicle* v)

   133

{

   134

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

   135

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

   136

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

   137

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

   138

}

   139

   140

   141

static TileIndex GetOrderLocation(const Order& o)

   142

{

   143

	switch (o.type) {

   144

		default: NOT_REACHED();

   145

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

   146

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

   147

	}

   148

}

   149

   150

   151

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

   152

 * @param tile unused

   153

 * @param flags operation to perform

   154

 * @param p1 various bitstuffed elements

   155

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

   156

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

   157

 *                        the order will be inserted before that one

   158

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

   159

 * @param p2 packed order to insert

   160

 */

   161

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

   162

{

   163

	Vehicle *v;

   164

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

   165

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

   166

	Order new_order = UnpackOrder(p2);

   167

   168

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   169

   170

	v = GetVehicle(veh);

   171

   172

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

   173

   174

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

   175

	 * and has the correct flags if any */

   176

	switch (new_order.type) {

   177

		case OT_GOTO_STATION: {

   178

			const Station *st;

   179

   180

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

   181

			st = GetStation(new_order.dest);

   182

   183

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

   184

				return CMD_ERROR;

   185

			}

   186

   187

			switch (v->type) {

   188

				case VEH_TRAIN:

   189

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

   190

					break;

   191

   192

				case VEH_ROAD:

   193

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

   194

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

   195

					} else {

   196

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

   197

					}

   198

					break;

   199

   200

				case VEH_SHIP:

   201

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

   202

					break;

   203

   204

				case VEH_AIRCRAFT:

   205

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

   206

						return CMD_ERROR;

   207

					}

   208

					break;

   209

   210

				default: return CMD_ERROR;

   211

			}

   212

   213

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

   214

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

   215

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

   216

			switch (new_order.flags) {

   217

				case 0:

   218

				case OF_FULL_LOAD:

   219

				case OF_FULL_LOAD | OF_TRANSFER:

   220

				case OF_UNLOAD:

   221

				case OF_UNLOAD | OF_TRANSFER:

   222

				case OF_TRANSFER:

   223

					break;

   224

   225

				case OF_NON_STOP:

   226

				case OF_NON_STOP | OF_FULL_LOAD:

   227

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   228

				case OF_NON_STOP | OF_UNLOAD:

   229

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   230

				case OF_NON_STOP | OF_TRANSFER:

   231

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

   232

					break;

   233

   234

				default: return CMD_ERROR;

   235

			}

   236

			break;

   237

		}

   238

   239

		case OT_GOTO_DEPOT: {

   240

			if (v->type == VEH_AIRCRAFT) {

   241

				const Station* st;

   242

   243

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

   244

				st = GetStation(new_order.dest);

   245

   246

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

   247

						!(st->facilities & FACIL_AIRPORT) ||

   248

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

   249

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

   250

					return CMD_ERROR;

   251

				}

   252

			} else {

   253

				const Depot* dp;

   254

   255

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

   256

				dp = GetDepot(new_order.dest);

   257

   258

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

   259

   260

				switch (v->type) {

   261

					case VEH_TRAIN:

   262

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

   263

						break;

   264

   265

					case VEH_ROAD:

   266

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

   267

						break;

   268

   269

					case VEH_SHIP:

   270

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

   271

						break;

   272

   273

					default: return CMD_ERROR;

   274

				}

   275

			}

   276

   277

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

   278

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

   279

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

   280

			switch (new_order.flags) {

   281

				case OF_PART_OF_ORDERS:

   282

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   283

					break;

   284

   285

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   286

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   287

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

   288

					break;

   289

   290

				default: return CMD_ERROR;

   291

			}

   292

			break;

   293

		}

   294

   295

		case OT_GOTO_WAYPOINT: {

   296

			const Waypoint* wp;

   297

   298

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

   299

   300

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

   301

			wp = GetWaypoint(new_order.dest);

   302

   303

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

   304

   305

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

   306

			 * [non-stop]

   307

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

   308

			switch (new_order.flags) {

   309

				case 0: break;

   310

   311

				case OF_NON_STOP:

   312

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

   313

					break;

   314

   315

				default: return CMD_ERROR;

   316

			}

   317

			break;

   318

		}

   319

   320

		default: return CMD_ERROR;

   321

	}

   322

   323

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

   324

   325

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

   326

   327

	if (v->type == VEH_SHIP &&

   328

			IsHumanPlayer(v->owner) &&

   329

			!_patches.new_pathfinding_all) {

   330

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

   331

		const Order *prev = NULL;

   332

		uint n = 0;

   333

   334

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

   335

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

   336

		 * finds the last order in the list. */

   337

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

   338

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

   339

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

   340

		}

   341

		if (prev != NULL) {

   342

			uint dist = DistanceManhattan(

   343

				GetOrderLocation(*prev),

   344

				GetOrderLocation(new_order)

   345

			);

   346

			if (dist >= 130) {

   347

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   348

			}

   349

		}

   350

	}

   351

   352

	if (flags & DC_EXEC) {

   353

		Vehicle *u;

   354

		Order *new_o = new Order();

   355

		AssignOrder(new_o, new_order);

   356

   357

		/* Create new order and link in list */

   358

		if (v->orders == NULL) {

   359

			v->orders = new_o;

   360

		} else {

   361

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

   362

			    selected) */

   363

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

   364

   365

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

   366

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

   367

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

   368

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

   369

				    all vehicles */

   370

				SwapOrders(v->orders, new_o);

   371

				/* Now update the next pointers */

   372

				v->orders->next = new_o;

   373

			} else if (order == NULL) {

   374

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

   375

				order = GetLastVehicleOrder(v);

   376

				order->next = new_o;

   377

			} else {

   378

				/* Put the new order in between */

   379

				new_o->next = order->next;

   380

				order->next = new_o;

   381

			}

   382

		}

   383

   384

		u = GetFirstVehicleFromSharedList(v);

   385

		DeleteOrderWarnings(u);

   386

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

   387

			/* Increase amount of orders */

   388

			u->num_orders++;

   389

   390

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

   391

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

   392

   393

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

   394

   395

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

   396

			to update the selected order */

   397

			if (sel_ord <= u->cur_order_index) {

   398

				uint cur = u->cur_order_index + 1;

   399

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

   400

				if (cur < u->num_orders)

   401

					u->cur_order_index = cur;

   402

			}

   403

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

   404

			InvalidateVehicleOrder(u);

   405

		}

   406

   407

		/* Make sure to rebuild the whole list */

   408

		RebuildVehicleLists();

   409

	}

   410

   411

	return CommandCost();

   412

}

   413

   414

/** Declone an order-list

   415

 * @param *dst delete the orders of this vehicle

   416

 * @param flags execution flags

   417

 */

   418

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   419

{

   420

	if (flags & DC_EXEC) {

   421

		DeleteVehicleOrders(dst);

   422

		InvalidateVehicleOrder(dst);

   423

		RebuildVehicleLists();

   424

	}

   425

	return CommandCost();

   426

}

   427

   428

/**

   429

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

   430

 *  orders.

   431

 */

   432

static void RemoveSharedOrderVehicleList(Vehicle *v)

   433

{

   434

	assert(v->orders != NULL);

   435

	WindowClass window_class = WC_NONE;

   436

   437

	switch (v->type) {

   438

		default: NOT_REACHED();

   439

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   440

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   441

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   442

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   443

	}

   444

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

   445

}

   446

   447

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

   448

 * @param tile unused

   449

 * @param flags operation to perform

   450

 * @param p1 the ID of the vehicle

   451

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

   452

 */

   453

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

   454

{

   455

	Vehicle *v, *u;

   456

	VehicleID veh_id = p1;

   457

	VehicleOrderID sel_ord = p2;

   458

	Order *order;

   459

   460

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   461

   462

	v = GetVehicle(veh_id);

   463

   464

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

   465

   466

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

   467

	if (sel_ord >= v->num_orders)

   468

		return DecloneOrder(v, flags);

   469

   470

	order = GetVehicleOrder(v, sel_ord);

   471

	if (order == NULL) return CMD_ERROR;

   472

   473

	if (flags & DC_EXEC) {

   474

		if (GetVehicleOrder(v, sel_ord - 1) == NULL) {

   475

			if (GetVehicleOrder(v, sel_ord + 1) != NULL) {

   476

				/* First item, but not the last, so we need to alter v->orders

   477

				    Because we can have shared order, we copy the data

   478

				    from the next item over the deleted */

   479

				order = GetVehicleOrder(v, sel_ord + 1);

   480

				SwapOrders(v->orders, order);

   481

			} else {

   482

				/* XXX -- The system currently can't handle a shared-order vehicle list

   483

				 *  open when there aren't any orders in the list, so close the window

   484