1

/* $Id$ */

     2

     3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "order.h"

     6

#include "airport.h"

     7

#include "depot.h"

     8

#include "functions.h"

     9

#include "table/strings.h"

    10

#include "vehicle.h"

    11

#include "waypoint.h"

    12

#include "command.h"

    13

#include "station.h"

    14

#include "player.h"

    15

#include "news.h"

    16

#include "saveload.h"

    17

#include "vehicle_gui.h"

    18

    19

/**

    20

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

    21

 */

    22

static void OrderPoolNewBlock(uint start_item)

    23

{

    24

	Order *order;

    25

    26

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

    27

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

    28

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

    29

}

    30

    31

DEFINE_OLD_POOL(Order, Order, OrderPoolNewBlock, NULL)

    32

    33

/**

    34

 *

    35

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

    36

 *

    37

 */

    38

Order UnpackOldOrder(uint16 packed)

    39

{

    40

	Order order;

    41

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

    42

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

    43

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

    44

	order.next    = NULL;

    45

    46

	order.refit_cargo   = CT_NO_REFIT;

    47

	order.refit_subtype = 0;

    48

	order.index = 0; // avoid compiler warning

    49

    50

	// Sanity check

    51

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

    52

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

    53

		order.type = OT_DUMMY;

    54

		order.flags = 0;

    55

	}

    56

    57

	return order;

    58

}

    59

    60

/**

    61

 *

    62

 * Unpacks a order from savegames with version 4 and lower

    63

 *

    64

 */

    65

static Order UnpackVersion4Order(uint16 packed)

    66

{

    67

	Order order;

    68

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

    69

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

    70

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

    71

	order.next  = NULL;

    72

	order.index = 0; // avoid compiler warning

    73

	order.refit_cargo   = CT_NO_REFIT;

    74

	order.refit_subtype = 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

}

    88

    89

/**

    90

 *

    91

 * Swap two orders

    92

 *

    93

 */

    94

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

    95

{

    96

	Order temp_order;

    97

    98

	temp_order = *order1;

    99

	AssignOrder(order1, *order2);

   100

	order1->next = order2->next;

   101

	AssignOrder(order2, temp_order);

   102

	order2->next = temp_order.next;

   103

}

   104

   105

/**

   106

 *

   107

 * Allocate a new order

   108

 *

   109

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

   110

 *

   111

 */

   112

static Order *AllocateOrder(void)

   113

{

   114

	Order *order;

   115

   116

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

   117

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

   118

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

   119

		if (!IsValidOrder(order)) {

   120

			OrderID index = order->index;

   121

   122

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

   123

			order->index = index;

   124

			order->next = NULL;

   125

			order->refit_cargo   = CT_NO_REFIT;

   126

			order->refit_subtype = 0;

   127

   128

			return order;

   129

		}

   130

	}

   131

   132

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

   133

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

   134

   135

	return NULL;

   136

}

   137

   138

/**

   139

 *

   140

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

   141

 *   This function makes sure that the index is maintained correctly

   142

 *

   143

 */

   144

void AssignOrder(Order *order, Order data)

   145

{

   146

	order->type  = data.type;

   147

	order->flags = data.flags;

   148

	order->dest  = data.dest;

   149

   150

	order->refit_cargo   = data.refit_cargo;

   151

	order->refit_subtype = data.refit_subtype;

   152

}

   153

   154

   155

/**

   156

 * Delete all news items regarding defective orders about a vehicle

   157

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

   158

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

   159

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

   160

 */

   161

static void DeleteOrderWarnings(const Vehicle* v)

   162

{

   163

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

   164

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

   165

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

   166

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

   167

}

   168

   169

   170

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

   171

 * @param tile unused

   172

 * @param p1 various bitstuffed elements

   173

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

   174

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

   175

 *                        the order will be inserted before that one

   176

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

   177

 * @param p2 packed order to insert

   178

 */

   179

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

   180

{

   181

	Vehicle *v;

   182

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

   183

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

   184

	Order new_order = UnpackOrder(p2);

   185

   186

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   187

   188

	v = GetVehicle(veh);

   189

   190

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

   191

   192

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

   193

	 * and has the correct flags if any */

   194

	switch (new_order.type) {

   195

		case OT_GOTO_STATION: {

   196

			const Station *st;

   197

   198

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

   199

			st = GetStation(new_order.dest);

   200

   201

			if (st->airport_type != AT_OILRIG && !IsBuoy(st) && !CheckOwnership(st->owner)) {

   202

				return CMD_ERROR;

   203

			}

   204

   205

			switch (v->type) {

   206

				case VEH_Train:

   207

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

   208

					break;

   209

   210

				case VEH_Road:

   211

					if (v->cargo_type == CT_PASSENGERS) {

   212

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

   213

					} else {

   214

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

   215

					}

   216

					break;

   217

   218

				case VEH_Ship:

   219

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

   220

					break;

   221

   222

				case VEH_Aircraft:

   223

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

   224

					break;

   225

   226

				default: return CMD_ERROR;

   227

			}

   228

   229

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

   230

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

   231

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

   232

			switch (new_order.flags) {

   233

				case 0:

   234

				case OF_FULL_LOAD:

   235

				case OF_FULL_LOAD | OF_TRANSFER:

   236

				case OF_UNLOAD:

   237

				case OF_UNLOAD | OF_TRANSFER:

   238

				case OF_TRANSFER:

   239

					break;

   240

   241

				case OF_NON_STOP:

   242

				case OF_NON_STOP | OF_FULL_LOAD:

   243

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   244

				case OF_NON_STOP | OF_UNLOAD:

   245

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   246

				case OF_NON_STOP | OF_TRANSFER:

   247

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

   248

					break;

   249

   250

				default: return CMD_ERROR;

   251

			}

   252

			break;

   253

		}

   254

   255

		case OT_GOTO_DEPOT: {

   256

			if (v->type == VEH_Aircraft) {

   257

				const Station* st;

   258

   259

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

   260

				st = GetStation(new_order.dest);

   261

   262

				if ((st->airport_type != AT_OILRIG && !CheckOwnership(st->owner)) ||

   263

						!(st->facilities & FACIL_AIRPORT) ||

   264

						GetAirport(st->airport_type)->nof_depots == 0) {

   265

					return CMD_ERROR;

   266

				}

   267

			} else {

   268

				const Depot* dp;

   269

   270

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

   271

				dp = GetDepot(new_order.dest);

   272

   273

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

   274

   275

				switch (v->type) {

   276

					case VEH_Train:

   277

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

   278

						break;

   279

   280

					case VEH_Road:

   281

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

   282

						break;

   283

   284

					case VEH_Ship:

   285

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

   286

						break;

   287

   288

					default: return CMD_ERROR;

   289

				}

   290

			}

   291

   292

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

   293

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

   294

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

   295

			switch (new_order.flags) {

   296

				case OF_PART_OF_ORDERS:

   297

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   298

					break;

   299

   300

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   301

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   302

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

   303

					break;

   304

   305

				default: return CMD_ERROR;

   306

			}

   307

			break;

   308

		}

   309

   310

		case OT_GOTO_WAYPOINT: {

   311

			const Waypoint* wp;

   312

   313

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

   314

   315

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

   316

			wp = GetWaypoint(new_order.dest);

   317

   318

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

   319

   320

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

   321

			 * [non-stop]

   322

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

   323

			switch (new_order.flags) {

   324

				case 0: break;

   325

   326

				case OF_NON_STOP:

   327

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

   328

					break;

   329

   330

				default: return CMD_ERROR;

   331

			}

   332

			break;

   333

		}

   334

   335

		default: return CMD_ERROR;

   336

	}

   337

   338

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

   339

   340

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   341

   342

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

   343

	 * handle any more then this.. */

   344

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

   345

   346

	/* For ships, make sure that the station is not too far away from the

   347

	 * previous destination, for human players with new pathfinding disabled */

   348

	if (v->type == VEH_Ship && IsHumanPlayer(v->owner) &&

   349

		sel_ord != 0 && GetVehicleOrder(v, sel_ord - 1)->type == OT_GOTO_STATION

   350

		&& !_patches.new_pathfinding_all) {

   351

   352

		int dist = DistanceManhattan(

   353

			GetStation(GetVehicleOrder(v, sel_ord - 1)->dest)->xy,

   354

			GetStation(new_order.dest)->xy // XXX type != OT_GOTO_STATION?

   355

		);

   356

		if (dist >= 130)

   357

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   358

	}

   359

   360

	if (flags & DC_EXEC) {

   361

		Vehicle *u;

   362

		Order *new = AllocateOrder();

   363

		AssignOrder(new, new_order);

   364

   365

		/* Create new order and link in list */

   366

		if (v->orders == NULL) {

   367

			v->orders = new;

   368

		} else {

   369

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

   370

			    selected) */

   371

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

   372

   373

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

   374

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

   375

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

   376

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

   377

				    all vehicles */

   378

				SwapOrders(v->orders, new);

   379

				/* Now update the next pointers */

   380

				v->orders->next = new;

   381

			} else if (order == NULL) {

   382

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

   383

				order = GetLastVehicleOrder(v);

   384

				order->next = new;

   385

			} else {

   386

				/* Put the new order in between */

   387

				new->next = order->next;

   388

				order->next = new;

   389

			}

   390

		}

   391

   392

		u = GetFirstVehicleFromSharedList(v);

   393

		DeleteOrderWarnings(u);

   394

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

   395

			/* Increase amount of orders */

   396

			u->num_orders++;

   397

   398

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

   399

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

   400

   401

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

   402

   403

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

   404

			to update the selected order */

   405

			if (sel_ord <= u->cur_order_index) {

   406

				uint cur = u->cur_order_index + 1;

   407

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

   408

				if (cur < u->num_orders)

   409

					u->cur_order_index = cur;

   410

			}

   411

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

   412

			InvalidateVehicleOrder(u);

   413

		}

   414

   415

		/* Make sure to rebuild the whole list */

   416

		RebuildVehicleLists();

   417

	}

   418

   419

	return 0;

   420

}

   421

   422

/** Declone an order-list

   423

 * @param *dst delete the orders of this vehicle

   424

 * @param flags execution flags

   425

 */

   426

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   427

{

   428

	if (flags & DC_EXEC) {

   429

		DeleteVehicleOrders(dst);

   430

		InvalidateVehicleOrder(dst);

   431

		RebuildVehicleLists();

   432

	}

   433

	return 0;

   434

}

   435

   436

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

   437

 * @param tile unused

   438

 * @param p1 the ID of the vehicle

   439

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

   440

 */

   441

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

   442

{

   443

	Vehicle *v, *u;

   444

	VehicleID veh_id = p1;

   445

	VehicleOrderID sel_ord = p2;

   446

	Order *order;

   447

   448

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   449

   450

	v = GetVehicle(veh_id);

   451

   452

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

   453

   454

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

   455

	if (sel_ord >= v->num_orders)

   456

		return DecloneOrder(v, flags);

   457

   458

	order = GetVehicleOrder(v, sel_ord);

   459

	if (order == NULL) return CMD_ERROR;

   460

   461

	if (flags & DC_EXEC) {

   462

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

   463

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

   464

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

   465

				    Because we can have shared order, we copy the data

   466

				    from the next item over the deleted */

   467

				order = GetVehicleOrder(v, sel_ord + 1);

   468

				SwapOrders(v->orders, order);

   469

			} else {

   470

				/* Last item, so clean the list */

   471

				v->orders = NULL;

   472

			}

   473

		} else {

   474

			GetVehicleOrder(v, sel_ord - 1)->next = order->next;

   475

		}

   476

   477

		/* Give the item free */

   478

		order->type = OT_NOTHING;

   479

		order->next = NULL;

   480

   481

		u = GetFirstVehicleFromSharedList(v);

   482

		DeleteOrderWarnings(u);

   483

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

   484

			u->num_orders--;

   485

   486