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 "functions.h"

    11

#include "table/strings.h"

    12

#include "vehicle.h"

    13

#include "waypoint.h"

    14

#include "command.h"

    15

#include "station.h"

    16

#include "player.h"

    17

#include "news.h"

    18

#include "saveload.h"

    19

#include "vehicle_gui.h"

    20

#include "cargotype.h"

    21

    22

/**

    23

 * Called if a new block is added to the order-pool

    24

 */

    25

static void OrderPoolNewBlock(uint start_item)

    26

{

    27

	Order *order;

    28

    29

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    30

	 * TODO - This is just a temporary stage, this will be removed. */

    31

	for (order = GetOrder(start_item); order != NULL; order = (order->index + 1U < GetOrderPoolSize()) ? GetOrder(order->index + 1U) : NULL) order->index = start_item++;

    32

}

    33

    34

DEFINE_OLD_POOL(Order, Order, OrderPoolNewBlock, NULL)

    35

    36

/**

    37

 *

    38

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

    39

 *

    40

 */

    41

Order UnpackOldOrder(uint16 packed)

    42

{

    43

	Order order;

    44

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

    45

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

    46

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

    47

	order.next    = NULL;

    48

    49

	order.refit_cargo   = CT_NO_REFIT;

    50

	order.refit_subtype = 0;

    51

	order.index = 0; // avoid compiler warning

    52

    53

	// Sanity check

    54

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

    55

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

    56

		order.type = OT_DUMMY;

    57

		order.flags = 0;

    58

	}

    59

    60

	return order;

    61

}

    62

    63

/**

    64

 *

    65

 * Unpacks a order from savegames with version 4 and lower

    66

 *

    67

 */

    68

static Order UnpackVersion4Order(uint16 packed)

    69

{

    70

	Order order;

    71

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

    72

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

    73

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

    74

	order.next  = NULL;

    75

	order.index = 0; // avoid compiler warning

    76

	order.refit_cargo   = CT_NO_REFIT;

    77

	order.refit_subtype = 0;

    78

	return order;

    79

}

    80

    81

/**

    82

 *

    83

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

    84

 *

    85

 */

    86

void InvalidateVehicleOrder(const Vehicle *v)

    87

{

    88

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    89

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    90

}

    91

    92

/**

    93

 *

    94

 * Swap two orders

    95

 *

    96

 */

    97

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

    98

{

    99

	Order temp_order;

   100

   101

	temp_order = *order1;

   102

	AssignOrder(order1, *order2);

   103

	order1->next = order2->next;

   104

	AssignOrder(order2, temp_order);

   105

	order2->next = temp_order.next;

   106

}

   107

   108

/**

   109

 *

   110

 * Allocate a new order

   111

 *

   112

 * @return Order* if a free space is found, else NULL.

   113

 *

   114

 */

   115

static Order *AllocateOrder()

   116

{

   117

	Order *order;

   118

   119

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   120

	 * TODO - This is just a temporary stage, this will be removed. */

   121

	for (order = GetOrder(0); order != NULL; order = (order->index + 1U < GetOrderPoolSize()) ? GetOrder(order->index + 1U) : NULL) {

   122

		if (!order->IsValid()) {

   123

			OrderID index = order->index;

   124

   125

			memset(order, 0, sizeof(*order));

   126

			order->index = index;

   127

			order->next = NULL;

   128

			order->refit_cargo   = CT_NO_REFIT;

   129

			order->refit_subtype = 0;

   130

   131

			return order;

   132

		}

   133

	}

   134

   135

	/* Check if we can add a block to the pool */

   136

	if (AddBlockToPool(&_Order_pool)) return AllocateOrder();

   137

   138

	return NULL;

   139

}

   140

   141

/**

   142

 *

   143

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

   144

 *   This function makes sure that the index is maintained correctly

   145

 *

   146

 */

   147

void AssignOrder(Order *order, Order data)

   148

{

   149

	order->type  = data.type;

   150

	order->flags = data.flags;

   151

	order->dest  = data.dest;

   152

   153

	order->refit_cargo   = data.refit_cargo;

   154

	order->refit_subtype = data.refit_subtype;

   155

}

   156

   157

   158

/**

   159

 * Delete all news items regarding defective orders about a vehicle

   160

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

   161

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

   162

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

   163

 */

   164

static void DeleteOrderWarnings(const Vehicle* v)

   165

{

   166

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

   167

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

   168

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

   169

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

   170

}

   171

   172

   173

static TileIndex GetOrderLocation(const Order& o)

   174

{

   175

	switch (o.type) {

   176

		default: NOT_REACHED();

   177

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

   178

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

   179

	}

   180

}

   181

   182

   183

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

   184

 * @param tile unused

   185

 * @param p1 various bitstuffed elements

   186

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

   187

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

   188

 *                        the order will be inserted before that one

   189

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

   190

 * @param p2 packed order to insert

   191

 */

   192

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

   193

{

   194

	Vehicle *v;

   195

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

   196

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

   197

	Order new_order = UnpackOrder(p2);

   198

   199

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   200

   201

	v = GetVehicle(veh);

   202

   203

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

   204

   205

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

   206

	 * and has the correct flags if any */

   207

	switch (new_order.type) {

   208

		case OT_GOTO_STATION: {

   209

			const Station *st;

   210

   211

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

   212

			st = GetStation(new_order.dest);

   213

   214

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

   215

				return CMD_ERROR;

   216

			}

   217

   218

			switch (v->type) {

   219

				case VEH_TRAIN:

   220

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

   221

					break;

   222

   223

				case VEH_ROAD:

   224

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

   225

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

   226

					} else {

   227

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

   228

					}

   229

					break;

   230

   231

				case VEH_SHIP:

   232

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

   233

					break;

   234

   235

				case VEH_AIRCRAFT:

   236

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

   237

					break;

   238

   239

				default: return CMD_ERROR;

   240

			}

   241

   242

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

   243

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

   244

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

   245

			switch (new_order.flags) {

   246

				case 0:

   247

				case OF_FULL_LOAD:

   248

				case OF_FULL_LOAD | OF_TRANSFER:

   249

				case OF_UNLOAD:

   250

				case OF_UNLOAD | OF_TRANSFER:

   251

				case OF_TRANSFER:

   252

					break;

   253

   254

				case OF_NON_STOP:

   255

				case OF_NON_STOP | OF_FULL_LOAD:

   256

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   257

				case OF_NON_STOP | OF_UNLOAD:

   258

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   259

				case OF_NON_STOP | OF_TRANSFER:

   260

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

   261

					break;

   262

   263

				default: return CMD_ERROR;

   264

			}

   265

			break;

   266

		}

   267

   268

		case OT_GOTO_DEPOT: {

   269

			if (v->type == VEH_AIRCRAFT) {

   270

				const Station* st;

   271

   272

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

   273

				st = GetStation(new_order.dest);

   274

   275

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

   276

						!(st->facilities & FACIL_AIRPORT) ||

   277

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

   278

					return CMD_ERROR;

   279

				}

   280

			} else {

   281

				const Depot* dp;

   282

   283

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

   284

				dp = GetDepot(new_order.dest);

   285

   286

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

   287

   288

				switch (v->type) {

   289

					case VEH_TRAIN:

   290

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

   291

						break;

   292

   293

					case VEH_ROAD:

   294

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

   295

						break;

   296

   297

					case VEH_SHIP:

   298

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

   299

						break;

   300

   301

					default: return CMD_ERROR;

   302

				}

   303

			}

   304

   305

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

   306

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

   307

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

   308

			switch (new_order.flags) {

   309

				case OF_PART_OF_ORDERS:

   310

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   311

					break;

   312

   313

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   314

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   315

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

   316

					break;

   317

   318

				default: return CMD_ERROR;

   319

			}

   320

			break;

   321

		}

   322

   323

		case OT_GOTO_WAYPOINT: {

   324

			const Waypoint* wp;

   325

   326

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

   327

   328

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

   329

			wp = GetWaypoint(new_order.dest);

   330

   331

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

   332

   333

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

   334

			 * [non-stop]

   335

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

   336

			switch (new_order.flags) {

   337

				case 0: break;

   338

   339

				case OF_NON_STOP:

   340

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

   341

					break;

   342

   343

				default: return CMD_ERROR;

   344

			}

   345

			break;

   346

		}

   347

   348

		default: return CMD_ERROR;

   349

	}

   350

   351

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

   352

   353

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

   354

   355

	/* XXX - This limit is only here because the backuppedorders can't

   356

	 * handle any more then this.. */

   357

	if (v->num_orders >= MAX_BACKUP_ORDER_COUNT) return_cmd_error(STR_8832_TOO_MANY_ORDERS);

   358

   359

	if (v->type == VEH_SHIP &&

   360

			IsHumanPlayer(v->owner) &&

   361

			!_patches.new_pathfinding_all) {

   362

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

   363

		const Order *prev = NULL;

   364

		uint n = 0;

   365

   366

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

   367

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

   368

		 * finds the last order in the list. */

   369

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

   370

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

   371

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

   372

		}

   373

		if (prev != NULL) {

   374

			uint dist = DistanceManhattan(

   375

				GetOrderLocation(*prev),

   376

				GetOrderLocation(new_order)

   377

			);

   378

			if (dist >= 130) {

   379

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   380

			}

   381

		}

   382

	}

   383

   384

	if (flags & DC_EXEC) {

   385

		Vehicle *u;

   386

		Order *new_o = AllocateOrder();

   387

		AssignOrder(new_o, new_order);

   388

   389

		/* Create new order and link in list */

   390

		if (v->orders == NULL) {

   391

			v->orders = new_o;

   392

		} else {

   393

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

   394

			    selected) */

   395

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

   396

   397

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

   398

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

   399

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

   400

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

   401

				    all vehicles */

   402

				SwapOrders(v->orders, new_o);

   403

				/* Now update the next pointers */

   404

				v->orders->next = new_o;

   405

			} else if (order == NULL) {

   406

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

   407

				order = GetLastVehicleOrder(v);

   408

				order->next = new_o;

   409

			} else {

   410

				/* Put the new order in between */

   411

				new_o->next = order->next;

   412

				order->next = new_o;

   413

			}

   414

		}

   415

   416

		u = GetFirstVehicleFromSharedList(v);

   417

		DeleteOrderWarnings(u);

   418

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

   419

			/* Increase amount of orders */

   420

			u->num_orders++;

   421

   422

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

   423

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

   424

   425

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

   426

   427

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

   428

			to update the selected order */

   429

			if (sel_ord <= u->cur_order_index) {

   430

				uint cur = u->cur_order_index + 1;

   431

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

   432

				if (cur < u->num_orders)

   433

					u->cur_order_index = cur;

   434

			}

   435

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

   436

			InvalidateVehicleOrder(u);

   437

		}

   438

   439

		/* Make sure to rebuild the whole list */

   440

		RebuildVehicleLists();

   441

	}

   442

   443

	return 0;

   444

}

   445

   446

/** Declone an order-list

   447

 * @param *dst delete the orders of this vehicle

   448

 * @param flags execution flags

   449

 */

   450

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   451

{

   452

	if (flags & DC_EXEC) {

   453

		DeleteVehicleOrders(dst);

   454

		InvalidateVehicleOrder(dst);

   455

		RebuildVehicleLists();

   456

	}

   457

	return 0;

   458

}

   459

   460

/**

   461

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

   462

 *  orders.

   463

 */

   464

static void RemoveSharedOrderVehicleList(Vehicle *v)

   465

{

   467

	WindowClass window_class = WC_NONE;

   468

   469

	switch (v->type) {

   470

		default: NOT_REACHED();

   471

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   472

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   473

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   474

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   475

	}

   476

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

   477

}

   478

   479

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

   480

 * @param tile unused

   481

 * @param p1 the ID of the vehicle

   482

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

   483

 */

   484

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