1

#include "stdafx.h"

     2

#include "openttd.h"

     3

#include "airport.h"

     4

#include "depot.h"

     5

#include "table/strings.h"

     6

#include "vehicle.h"

     7

#include "waypoint.h"

     8

#include "command.h"

     9

#include "station.h"

    10

#include "player.h"

    11

#include "news.h"

    12

#include "saveload.h"

    13

#include "vehicle_gui.h"

    14

    15

enum {

    16

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

    17

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

    18

	ORDER_POOL_MAX_BLOCKS      = 1000,

    19

};

    20

    21

/**

    22

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

    23

 */

    24

static void OrderPoolNewBlock(uint start_item)

    25

{

    26

	Order *order;

    27

    28

	FOR_ALL_ORDERS_FROM(order, start_item)

    29

		order->index = start_item++;

    30

}

    31

    32

/* Initialize the order-pool */

    33

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

    34

    35

/**

    36

 *

    37

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

    38

 *

    39

 */

    40

Order UnpackOldOrder(uint16 packed)

    41

{

    42

	Order order;

    46

	order.next    = NULL;

    47

    48

	// Sanity check

    49

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

    50

	if (order.type == OT_NOTHING && (order.flags != 0 || order.station != 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

Order UnpackVersion4Order(uint16 packed)

    64

{

    65

	Order order;

    69

	order.next    = NULL;

    70

	order.index   = 0; // avoid compiler warning

    71

	return order;

    72

}

    73

    74

/**

    75

 *

    76

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

    77

 *

    78

 */

    79

void InvalidateVehicleOrder(const Vehicle *v)

    80

{

    81

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    82

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    83

}

    84

    85

/**

    86

 *

    87

 * Swap two orders

    88

 *

    89

 */

    90

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

    91

{

    92

	Order temp_order;

    93

    94

	temp_order = *order1;

    95

	AssignOrder(order1, *order2);

    96

	order1->next = order2->next;

    97

	AssignOrder(order2, temp_order);

    98

	order2->next = temp_order.next;

    99

}

   100

   101

/**

   102

 *

   103

 * Allocate a new order

   104

 *

   105

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

   106

 *

   107

 */

   108

static Order *AllocateOrder(void)

   109

{

   110

	Order *order;

   111

   112

	FOR_ALL_ORDERS(order) {

   113

		if (order->type == OT_NOTHING) {

   114

			uint index = order->index;

   115

   116

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

   117

			order->index = index;

   118

			order->next = NULL;

   119

   120

			return order;

   121

		}

   122

	}

   123

   124

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

   125

	if (AddBlockToPool(&_order_pool))

   126

		return AllocateOrder();

   127

   128

	return NULL;

   129

}

   130

   131

/**

   132

 *

   133

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

   134

 *   This function makes sure that the index is maintained correctly

   135

 *

   136

 */

   137

void AssignOrder(Order *order, Order data)

   138

{

   139

	order->type    = data.type;

   140

	order->flags   = data.flags;

   141

	order->station = data.station;

   142

}

   143

   144

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

   145

 * @param x,y unused

   146

 * @param p1 various bitstuffed elements

   148

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

   151

 * @param p2 packed order to insert

   152

 */

   153

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

   154

{

   155

	Vehicle *v;

   158

	Order new_order = UnpackOrder(p2);

   159

   160

	if (!IsVehicleIndex(veh)) return CMD_ERROR;

   161

	v = GetVehicle(veh);

   162

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

   163

   164

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

   165

	 * and has the correct flags if any */

   166

	switch (new_order.type) {

   167

		case OT_GOTO_STATION: {

   168

			const Station *st;

   169

   170

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

   171

			st = GetStation(new_order.station);

   172

   173

			if (!IsValidStation(st) ||

   174

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

   175

				return CMD_ERROR;

   176

			}

   177

   178

			switch (v->type) {

   179

				case VEH_Train:

   180

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

   181

					break;

   182

   183

				case VEH_Road:

   184

					if (v->cargo_type == CT_PASSENGERS) {

   185

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

   186

					} else {

   187

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

   188

					}

   189

					break;

   190

   191

				case VEH_Ship:

   192

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

   193

					break;

   194

   195

				case VEH_Aircraft:

   196

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

   197

					break;

   198

   199

				default: return CMD_ERROR;

   200

			}

   201

   202

			switch (new_order.flags) {

   203

				case 0:

   204

				case OF_FULL_LOAD:

   205

				case OF_UNLOAD:

   206

				case OF_NON_STOP:

   207

				case OF_NON_STOP | OF_FULL_LOAD:

   208

				case OF_NON_STOP | OF_UNLOAD:

   209

					break;

   210

   211

				default: return CMD_ERROR;

   212

			}

   213

			break;

   214

		}

   215

   216

		case OT_GOTO_DEPOT: {

   217

			if (v->type == VEH_Aircraft) {

   218

				const Station* st;

   219

   220

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

   221

				st = GetStation(new_order.station);

   222

   223

				if (!IsValidStation(st) ||

   224

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

   225

						!(st->facilities & FACIL_AIRPORT) ||

   226

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

   227

					return CMD_ERROR;

   228

				}

   229

			} else {

   230

				const Depot* dp;

   231

   232

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

   233

				dp = GetDepot(new_order.station);

   234

   235

				if (!IsValidDepot(dp) ||

   236

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

   237

					return CMD_ERROR;

   238

				}

   239

   240

				switch (v->type) {

   241

					case VEH_Train:

   242

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

   243

						break;

   244

   245

					case VEH_Road:

   246

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

   247

						break;

   248

   249

					case VEH_Ship:

   250

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

   251

						break;

   252

   253

					default: return CMD_ERROR;

   254

				}

   255

			}

   256

   257

			switch (new_order.flags) {

   258

				case OF_PART_OF_ORDERS:

   259

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   260

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   261

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   262

					break;

   263

   264

				default: return CMD_ERROR;

   265

			}

   266

			break;

   267

		}

   268

   269

		case OT_GOTO_WAYPOINT: {

   270

			const Waypoint* wp;

   271

   272

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

   273

   274

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

   275

			wp = GetWaypoint(new_order.station);

   276

   277

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

   278

   279

			switch (new_order.flags) {

   280

				case 0:

   281

				case OF_NON_STOP:

   282

					break;

   283

   284

				default: return CMD_ERROR;

   285

			}

   286

			break;

   287

		}

   288

   289

		default: return CMD_ERROR;

   290

	}

   291

   292

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

   293

   294

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   295

   296

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

   297

	 * handle any more then this.. */

   298

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

   299

   300

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

   301

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

   302

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

   303

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

   304

		&& !_patches.new_pathfinding_all) {

   305

   306

		int dist = DistanceManhattan(

   307

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

   308

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

   309

		);

   310

		if (dist >= 130)

   311

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   312

	}

   313

   314

	if (flags & DC_EXEC) {

   315

		Vehicle *u;

   316

		Order *new = AllocateOrder();

   317

		AssignOrder(new, new_order);

   318

   319

		/* Create new order and link in list */

   320

		if (v->orders == NULL) {

   321

			v->orders = new;

   322

		} else {

   323

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

   324

			    selected) */

   325

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

   326

   327

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

   328

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

   329

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

   330

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

   331

				    all vehicles */

   332

				SwapOrders(v->orders, new);

   333

				/* Now update the next pointers */

   334

				v->orders->next = new;

   335

			} else if (order == NULL) {

   336

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

   337

				order = GetLastVehicleOrder(v);

   338

				order->next = new;

   339

			} else {

   340

				/* Put the new order in between */

   341

				new->next = order->next;

   342

				order->next = new;

   343

			}

   344

		}

   345

   346

		u = GetFirstVehicleFromSharedList(v);

   347

		while (u != NULL) {

   348

			/* Increase amount of orders */

   349

			u->num_orders++;

   350

   351

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

   352

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

   353

   354

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

   355

   356

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

   357

			to update the selected order */

   358

			if (sel_ord <= u->cur_order_index) {

   359

				uint cur = u->cur_order_index + 1;

   360

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

   361

				if (cur < u->num_orders)

   362

					u->cur_order_index = cur;

   363

			}

   364

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

   365

			InvalidateVehicleOrder(u);

   366

   367

			u = u->next_shared;

   368

		}

   369

   370

		/* Make sure to rebuild the whole list */

   371

		RebuildVehicleLists();

   372

	}

   373

   374

	return 0;

   375

}

   376

   377

/** Declone an order-list

   378

 * @param *dst delete the orders of this vehicle

   379

 * @param flags execution flags

   380

 */

   381

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   382

{

   383

	if (flags & DC_EXEC) {

   384

		/* Delete orders from vehicle */

   385

		DeleteVehicleOrders(dst);

   386

   387

		InvalidateVehicleOrder(dst);

   388

		RebuildVehicleLists();

   389

	}

   390

	return 0;

   391

}

   392

   393

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

   394

 * @param x,y unused

   395

 * @param p1 the ID of the vehicle

   396

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

   397

 */

   398

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

   399

{

   400

	Vehicle *v, *u;

   401

	VehicleID veh_id = p1;

   402

	OrderID sel_ord = p2;

   403

	Order *order;

   404

   405

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   406

	v = GetVehicle(veh_id);

   407

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

   408

   409

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

   410

	if (sel_ord >= v->num_orders)

   411

		return DecloneOrder(v, flags);

   412

   413

	order = GetVehicleOrder(v, sel_ord);

   414

	if (order == NULL) return CMD_ERROR;

   415

   416

	if (flags & DC_EXEC) {

   417

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

   418

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

   419

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

   420

				    Because we can have shared order, we copy the data

   421

				    from the next item over the deleted */

   422

				order = GetVehicleOrder(v, sel_ord + 1);

   423

				SwapOrders(v->orders, order);

   424

			} else {

   425

				/* Last item, so clean the list */

   426

				v->orders = NULL;

   427

			}

   428

		} else {

   429

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

   430

		}

   431

   432

		/* Give the item free */

   433

		order->type = OT_NOTHING;

   434

		order->next = NULL;

   435

   436

		u = GetFirstVehicleFromSharedList(v);

   437

		while (u != NULL) {

   438

			u->num_orders--;

   439

   440

			if (sel_ord < u->cur_order_index)

   441

				u->cur_order_index--;

   442

   443

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

   444

			 * also set their orders to NULL */

   445

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

   446

   447

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

   448

   449

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

   450

			 * on his order list or not */

   451

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

   452

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

   453

				u->current_order.flags = 0;

   454

			}

   455

   456

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

   457

			InvalidateVehicleOrder(u);

   458

   459

			u = u->next_shared;

   460

		}

   461

   462

		RebuildVehicleLists();

   463

	}

   464

   465

	return 0;

   466

}

   467

   468

/** Goto next order of order-list.

   469

 * @param x,y unused

   470

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

   471

 * @param p2 unused

   472

 */

   473

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

   474

{

   475

	Vehicle *v;

   476

	VehicleID veh_id = p1;

   477

   478

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   479

	v = GetVehicle(veh_id);

   480

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

   481

   482

	if (flags & DC_EXEC) {

   483

		/* Goto next order */

   484

		OrderID b = v->cur_order_index + 1;

   485

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

   486

   487

		v->cur_order_index = b;

   488

   489

		if (v->type == VEH_Train) v->u.rail.days_since_order_progr = 0;