3

#include "stdafx.h"

     4

#include "openttd.h"

     5

#include "airport.h"

     6

#include "depot.h"

     7

#include "functions.h"

     8

#include "table/strings.h"

     9

#include "vehicle.h"

    10

#include "waypoint.h"

    11

#include "command.h"

    12

#include "station.h"

    13

#include "player.h"

    14

#include "news.h"

    15

#include "saveload.h"

    16

#include "vehicle_gui.h"

    17

    18

enum {

    19

	/* Max orders: 64000 (64 * 1000) */

    20

	ORDER_POOL_BLOCK_SIZE_BITS = 6,       /* In bits, so (1 << 6) == 64 */

    21

	ORDER_POOL_MAX_BLOCKS      = 1000,

    22

};

    23

    24

/**

    25

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

    26

 */

    27

static void OrderPoolNewBlock(uint start_item)

    28

{

    29

	Order *order;

    30

    31

	FOR_ALL_ORDERS_FROM(order, start_item)

    32

		order->index = start_item++;

    33

}

    34

    35

/* Initialize the order-pool */

    36

MemoryPool _order_pool = { "Orders", ORDER_POOL_MAX_BLOCKS, ORDER_POOL_BLOCK_SIZE_BITS, sizeof(Order), &OrderPoolNewBlock, 0, 0, NULL };

    37

    38

/**

    39

 *

    40

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

    41

 *

    42

 */

    43

Order UnpackOldOrder(uint16 packed)

    44

{

    45

	Order order;

    46

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

    47

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

    48

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

    49

	order.next    = NULL;

    50

    51

	// Sanity check

    52

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

    53

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

    54

		order.type = OT_DUMMY;

    55

		order.flags = 0;

    56

	}

    57

    58

	return order;

    59

}

    60

    61

/**

    62

 *

    63

 * Unpacks a order from savegames with version 4 and lower

    64

 *

    65

 */

    66

Order UnpackVersion4Order(uint16 packed)

    67

{

    68

	Order order;

    69

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

    70

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

    71

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

    72

	order.next    = NULL;

    73

	order.index   = 0; // avoid compiler warning

    74

	return order;

    75

}

    76

    77

/**

    78

 *

    79

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

    80

 *

    81

 */

    82

void InvalidateVehicleOrder(const Vehicle *v)

    83

{

    84

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    85

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    86

}

    87

    88

/**

    89

 *

    90

 * Swap two orders

    91

 *

    92

 */

    93

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

    94

{

    95

	Order temp_order;

    96

    97

	temp_order = *order1;

    98

	AssignOrder(order1, *order2);

    99

	order1->next = order2->next;

   100

	AssignOrder(order2, temp_order);

   101

	order2->next = temp_order.next;

   102

}

   103

   104

/**

   105

 *

   106

 * Allocate a new order

   107

 *

   108

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

   109

 *

   110

 */

   111

static Order *AllocateOrder(void)

   112

{

   113

	Order *order;

   114

   115

	FOR_ALL_ORDERS(order) {

   116

		if (order->type == OT_NOTHING) {

   117

			uint index = order->index;

   118

   119

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

   120

			order->index = index;

   121

			order->next = NULL;

   122

   123

			return order;

   124

		}

   125

	}

   126

   127

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

   128

	if (AddBlockToPool(&_order_pool))

   129

		return AllocateOrder();

   130

   131

	return NULL;

   132

}

   133

   134

/**

   135

 *

   136

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

   137

 *   This function makes sure that the index is maintained correctly

   138

 *

   139

 */

   140

void AssignOrder(Order *order, Order data)

   141

{

   142

	order->type    = data.type;

   143

	order->flags   = data.flags;

   144

	order->station = data.station;

   145

}

   146

   147

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

   148

 * @param x,y unused

   149

 * @param p1 various bitstuffed elements

   150

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

   151

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

   152

 *                        the order will be inserted before that one

   153

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

   154

 * @param p2 packed order to insert

   155

 */

   156

int32 CmdInsertOrder(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   157

{

   158

	Vehicle *v;

   159

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

   160

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

   161

	Order new_order = UnpackOrder(p2);

   162

   163

	if (!IsVehicleIndex(veh)) return CMD_ERROR;

   164

	v = GetVehicle(veh);

   165

	if (v->type == 0 || !CheckOwnership(v->owner)) return CMD_ERROR;

   166

   167

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

   168

	 * and has the correct flags if any */

   169

	switch (new_order.type) {

   170

		case OT_GOTO_STATION: {

   171

			const Station *st;

   172

   173

			if (!IsStationIndex(new_order.station)) return CMD_ERROR;

   174

			st = GetStation(new_order.station);

   175

   176

			if (!IsValidStation(st) ||

   177

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

   178

				return CMD_ERROR;

   179

			}

   180

   181

			switch (v->type) {

   182

				case VEH_Train:

   183

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

   184

					break;

   185

   186

				case VEH_Road:

   187

					if (v->cargo_type == CT_PASSENGERS) {

   188

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

   189

					} else {

   190

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

   191

					}

   192

					break;

   193

   194

				case VEH_Ship:

   195

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

   196

					break;

   197

   198

				case VEH_Aircraft:

   199

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

   200

					break;

   201

   202

				default: return CMD_ERROR;

   203

			}

   204

   205

			switch (new_order.flags) {

   206

				case 0:

   207

				case OF_FULL_LOAD:

   208

				case OF_UNLOAD:

   209

				case OF_NON_STOP:

   210

				case OF_NON_STOP | OF_FULL_LOAD:

   211

				case OF_NON_STOP | OF_UNLOAD:

   212

					break;

   213

   214

				default: return CMD_ERROR;

   215

			}

   216

			break;

   217

		}

   218

   219

		case OT_GOTO_DEPOT: {

   220

			if (v->type == VEH_Aircraft) {

   221

				const Station* st;

   222

   223

				if (!IsStationIndex(new_order.station)) return CMD_ERROR;

   224

				st = GetStation(new_order.station);

   225

   226

				if (!IsValidStation(st) ||

   227

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

   228

						!(st->facilities & FACIL_AIRPORT) ||

   229

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

   230

					return CMD_ERROR;

   231

				}

   232

			} else {

   233

				const Depot* dp;

   234

   235

				if (!IsDepotIndex(new_order.station)) return CMD_ERROR;

   236

				dp = GetDepot(new_order.station);

   237

   238

				if (!IsValidDepot(dp) ||

   239

						!CheckOwnership(GetTileOwner(dp->xy))) {

   240

					return CMD_ERROR;

   241

				}

   242

   243

				switch (v->type) {

   244

					case VEH_Train:

   245

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

   246

						break;

   247

   248

					case VEH_Road:

   249

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

   250

						break;

   251

   252

					case VEH_Ship:

   253

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

   254

						break;

   255

   256

					default: return CMD_ERROR;

   257

				}

   258

			}

   259

   260

			switch (new_order.flags) {

   261

				case OF_PART_OF_ORDERS:

   262

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   263

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   264

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   265

					break;

   266

   267

				default: return CMD_ERROR;

   268

			}

   269

			break;

   270

		}

   271

   272

		case OT_GOTO_WAYPOINT: {

   273

			const Waypoint* wp;

   274

   275

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

   276

   277

			if (!IsWaypointIndex(new_order.station)) return CMD_ERROR;

   278

			wp = GetWaypoint(new_order.station);

   279

   280

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

   281

   282

			switch (new_order.flags) {

   283

				case 0:

   284

				case OF_NON_STOP:

   285

					break;

   286

   287

				default: return CMD_ERROR;

   288

			}

   289

			break;

   290

		}

   291

   292

		default: return CMD_ERROR;

   293

	}

   294

   295

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

   296

   297

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   298

   299

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

   300

	 * handle any more then this.. */

   301

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

   302

   303

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

   304

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

   305

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

   306

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

   307

		&& !_patches.new_pathfinding_all) {

   308

   309

		int dist = DistanceManhattan(

   310

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

   311

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

   312

		);

   313

		if (dist >= 130)

   314

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   315

	}

   316

   317

	if (flags & DC_EXEC) {

   318

		Vehicle *u;

   319

		Order *new = AllocateOrder();

   320

		AssignOrder(new, new_order);

   321

   322

		/* Create new order and link in list */

   323

		if (v->orders == NULL) {

   324

			v->orders = new;

   325

		} else {

   326

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

   327

			    selected) */

   328

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

   329

   330

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

   331

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

   332

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

   333

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

   334

				    all vehicles */

   335

				SwapOrders(v->orders, new);

   336

				/* Now update the next pointers */

   337

				v->orders->next = new;

   338

			} else if (order == NULL) {

   339

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

   340

				order = GetLastVehicleOrder(v);

   341

				order->next = new;

   342

			} else {

   343

				/* Put the new order in between */

   344

				new->next = order->next;

   345

				order->next = new;

   346

			}

   347

		}

   348

   349

		u = GetFirstVehicleFromSharedList(v);

   350

		while (u != NULL) {

   351

			/* Increase amount of orders */

   352

			u->num_orders++;

   353

   354

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

   355

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

   356

   357

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

   358

   359

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

   360

			to update the selected order */

   361

			if (sel_ord <= u->cur_order_index) {

   362

				uint cur = u->cur_order_index + 1;

   363

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

   364

				if (cur < u->num_orders)

   365

					u->cur_order_index = cur;

   366

			}

   367

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

   368

			InvalidateVehicleOrder(u);

   369

   370

			u = u->next_shared;

   371

		}

   372

   373

		/* Make sure to rebuild the whole list */

   374

		RebuildVehicleLists();

   375

	}

   376

   377

	return 0;

   378

}

   379

   380

/** Declone an order-list

   381

 * @param *dst delete the orders of this vehicle

   382

 * @param flags execution flags

   383

 */

   384

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   385

{

   386

	if (flags & DC_EXEC) {

   387

		/* Delete orders from vehicle */

   388

		DeleteVehicleOrders(dst);

   389

   390

		InvalidateVehicleOrder(dst);

   391

		RebuildVehicleLists();

   392

	}

   393

	return 0;

   394

}

   395

   396

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

   397

 * @param x,y unused

   398

 * @param p1 the ID of the vehicle

   399

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

   400

 */

   401

int32 CmdDeleteOrder(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   402

{

   403

	Vehicle *v, *u;

   404

	VehicleID veh_id = p1;

   405

	OrderID sel_ord = p2;

   406

	Order *order;

   407

   408

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   409

	v = GetVehicle(veh_id);

   410

	if (v->type == 0 || !CheckOwnership(v->owner)) return CMD_ERROR;

   411

   412

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

   413

	if (sel_ord >= v->num_orders)

   414

		return DecloneOrder(v, flags);

   415

   416

	order = GetVehicleOrder(v, sel_ord);

   417

	if (order == NULL) return CMD_ERROR;

   418

   419

	if (flags & DC_EXEC) {

   420

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

   421

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

   422

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

   423

				    Because we can have shared order, we copy the data

   424

				    from the next item over the deleted */

   425

				order = GetVehicleOrder(v, sel_ord + 1);

   426

				SwapOrders(v->orders, order);

   427

			} else {

   428

				/* Last item, so clean the list */

   429

				v->orders = NULL;

   430

			}

   431

		} else {

   432

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

   433

		}

   434

   435

		/* Give the item free */

   436

		order->type = OT_NOTHING;

   437

		order->next = NULL;

   438

   439

		u = GetFirstVehicleFromSharedList(v);

   440

		while (u != NULL) {

   441

			u->num_orders--;

   442

   443

			if (sel_ord < u->cur_order_index)

   444

				u->cur_order_index--;

   445

   446

			/* If we removed the last order, make sure the shared vehicles

   447

			 * also set their orders to NULL */

   448

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

   449

   450

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

   451

   452

			/* NON-stop flag is misused to see if a train is in a station that is

   453

			 * on his order list or not */

   454

			if (sel_ord == u->cur_order_index && u->current_order.type == OT_LOADING &&

   455

					HASBIT(u->current_order.flags, OFB_NON_STOP)) {

   456

				u->current_order.flags = 0;

   457

			}

   458

   459

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

   460

			InvalidateVehicleOrder(u);

   461

   462

			u = u->next_shared;

   463

		}

   464

   465

		RebuildVehicleLists();

   466

	}

   467

   468

	return 0;

   469

}

   470

   471

/** Goto next order of order-list.

   472

 * @param x,y unused

   473

 * @param p1 The ID of the vehicle which order is skipped

   474

 * @param p2 unused

   475

 */

   476

int32 CmdSkipOrder(int x, int y, uint32 flags, uint32 p1, uint32 p2)

   477

{

   478

	Vehicle *v;

   479

	VehicleID veh_id = p1;

   480

   481

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   482

	v = GetVehicle(veh_id);

   483

	if (v->type == 0 || !CheckOwnership(v->owner)) return CMD_ERROR;

   484

   485

	if (flags & DC_EXEC) {

   486

		/* Goto next order */

   487

		OrderID b = v->cur_order_index + 1;

   488

		if (b >= v->num_orders) b = 0;

   489