1

#include "stdafx.h"

     2

#include "ttd.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;

    43

	order.type    = (packed & 0x000F);

    44

	order.flags   = (packed & 0x00F0) >> 4;

    45

	order.station = (packed & 0xFF00) >> 8;

    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;

    66

	order.type    = (packed & 0x000F);

    67

	order.flags   = (packed & 0x00F0) >> 4;

    68

	order.station = (packed & 0xFF00) >> 8;

    69

	order.next    = NULL;

    70

	return order;

    71

}

    72

    73

/**

    74

 *

    75

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

    76

 *

    77

 */

    78

void InvalidateVehicleOrder(const Vehicle *v)

    79

{

    80

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    81

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    82

}

    83

    84

/**

    85

 *

    86

 * Swap two orders

    87

 *

    88

 */

    89

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

    90

{

    91

	Order temp_order;

    92

    93

	temp_order = *order1;

    94

	AssignOrder(order1, *order2);

    95

	order1->next = order2->next;

    96

	AssignOrder(order2, temp_order);

    97

	order2->next = temp_order.next;

    98

}

    99

   100

/**

   101

 *

   102

 * Allocate a new order

   103

 *

   104

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

   105

 *

   106

 */

   107

static Order *AllocateOrder(void)

   108

{

   109

	Order *order;

   110

   111

	FOR_ALL_ORDERS(order) {

   112

		if (order->type == OT_NOTHING) {

   113

			uint index = order->index;

   114

   115

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

   116

			order->index = index;

   117

			order->next = NULL;

   118

   119

			return order;

   120

		}

   121

	}

   122

   123

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

   124

	if (AddBlockToPool(&_order_pool))

   125

		return AllocateOrder();

   126

   127

	return NULL;

   128

}

   129

   130

/**

   131

 *

   132

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

   133

 *   This function makes sure that the index is maintained correctly

   134

 *

   135

 */

   136

void AssignOrder(Order *order, Order data)

   137

{

   138

	order->type    = data.type;

   139

	order->flags   = data.flags;

   140

	order->station = data.station;

   141

}

   142

   143

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

   144

 * @param x,y unused

   145

 * @param p1 various bitstuffed elements

   146

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

   147

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

   148

 *                        the order will be inserted before that one (p1 & 0xFFFF0000)>>16

   149

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

   150

 * @param p2 packed order to insert

   151

 */

   152

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

   153

{

   154

	Vehicle *v;

   155

	VehicleID veh = p1 & 0xFFFF;

   156

	OrderID sel_ord = p1 >> 16;

   157

	Order new_order = UnpackOrder(p2);

   158

   159

	if (!IsVehicleIndex(veh)) return CMD_ERROR;

   160

	v = GetVehicle(veh);

   161

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

   162

   163

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

   164

	 * and has the correct flags if any */

   165

	switch (new_order.type) {

   166

		case OT_GOTO_STATION: {

   167

			const Station *st;

   168

   169

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

   170

			st = GetStation(new_order.station);

   171

   172

			if (!IsValidStation(st) ||

   173

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

   174

				return CMD_ERROR;

   175

			}

   176

   177

			switch (v->type) {

   178

				case VEH_Train:

   179

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

   180

					break;

   181

   182

				case VEH_Road:

   183

					if (v->cargo_type == CT_PASSENGERS) {

   184

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

   185

					} else {

   186

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

   187

					}

   188

					break;

   189

   190

				case VEH_Ship:

   191

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

   192

					break;

   193

   194

				case VEH_Aircraft:

   195

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

   196

					break;

   197

   198

				default: return CMD_ERROR;

   199

			}

   200

   201

			switch (new_order.flags) {

   202

				case 0:

   203

				case OF_FULL_LOAD:

   204

				case OF_UNLOAD:

   205

				case OF_NON_STOP:

   206

				case OF_NON_STOP | OF_FULL_LOAD:

   207

				case OF_NON_STOP | OF_UNLOAD:

   208

					break;

   209

   210

				default: return CMD_ERROR;

   211

			}

   212

			break;

   213

		}

   214

   215

		case OT_GOTO_DEPOT: {

   216

			if (v->type == VEH_Aircraft) {

   217

				const Station* st;

   218

   219

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

   220

				st = GetStation(new_order.station);

   221

   222

				if (!IsValidStation(st) ||

   223

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

   224

						!(st->facilities & FACIL_AIRPORT) ||

   225

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

   226

					return CMD_ERROR;

   227

				}

   228

			} else {

   229

				const Depot* dp;

   230

   231

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

   232

				dp = GetDepot(new_order.station);

   233

   234

				if (!IsValidDepot(dp) ||

   235

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

   236

					return CMD_ERROR;

   237

				}

   238

   239

				switch (v->type) {

   240

					case VEH_Train:

   241

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

   242

						break;

   243

   244

					case VEH_Road:

   245

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

   246

						break;

   247

   248

					case VEH_Ship:

   249

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

   250

						break;

   251

   252

					default: return CMD_ERROR;

   253

				}

   254

			}

   255

   256

			switch (new_order.flags) {

   257

				case OF_PART_OF_ORDERS:

   258

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   259

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   260

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   261

					break;

   262

   263

				default: return CMD_ERROR;

   264

			}

   265

			break;

   266

		}

   267

   268

		case OT_GOTO_WAYPOINT: {

   269

			const Waypoint* wp;

   270

   271

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

   272

   273

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

   274

			wp = GetWaypoint(new_order.station);

   275

   276

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

   277

   278

			switch (new_order.flags) {

   279

				case 0:

   280

				case OF_NON_STOP:

   281

					break;

   282

   283

				default: return CMD_ERROR;

   284

			}

   285

			break;

   286

		}

   287

   288

		default: return CMD_ERROR;

   289

	}

   290

   291

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

   292

   293

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   294

   295

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

   296

	 * handle any more then this.. */

   297

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

   298

   299

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

   300

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

   301

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

   302

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

   303

		&& !_patches.new_pathfinding_all) {

   304

   305

		int dist = DistanceManhattan(

   306

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

   307

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

   308

		);

   309

		if (dist >= 130)

   310

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   311

	}

   312

   313

	if (flags & DC_EXEC) {

   314

		Vehicle *u;

   315

		Order *new = AllocateOrder();

   316

		AssignOrder(new, new_order);

   317

   318

		/* Create new order and link in list */

   319

		if (v->orders == NULL) {

   320

			v->orders = new;

   321

		} else {

   322

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

   323

			    selected) */

   324

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

   325

   326

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

   327

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

   328

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

   329

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

   330

				    all vehicles */

   331

				SwapOrders(v->orders, new);

   332

				/* Now update the next pointers */

   333

				v->orders->next = new;

   334

			} else if (order == NULL) {

   335

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

   336

				order = GetLastVehicleOrder(v);

   337

				order->next = new;

   338

			} else {

   339

				/* Put the new order in between */

   340

				new->next = order->next;

   341

				order->next = new;

   342

			}

   343

		}

   344

   345

		u = GetFirstVehicleFromSharedList(v);

   346

		while (u != NULL) {

   347

			/* Increase amount of orders */

   348

			u->num_orders++;

   349

   350

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

   351

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

   352

   353

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

   354

   355

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

   356

			to update the selected order */

   357

			if (sel_ord <= u->cur_order_index) {

   358

				uint cur = u->cur_order_index + 1;

   359

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

   360

				if (cur < u->num_orders)

   361

					u->cur_order_index = cur;

   362

			}

   363

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

   364

			InvalidateVehicleOrder(u);

   365

   366

			u = u->next_shared;

   367

		}

   368

   369

		/* Make sure to rebuild the whole list */

   370

		RebuildVehicleLists();

   371

	}

   372

   373

	return 0;

   374

}

   375

   376

/** Declone an order-list

   377

 * @param *dst delete the orders of this vehicle

   378

 * @param flags execution flags

   379

 */

   380

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   381

{

   382

	if (flags & DC_EXEC) {

   383

		/* Delete orders from vehicle */

   384

		DeleteVehicleOrders(dst);

   385

   386

		InvalidateVehicleOrder(dst);

   387

		RebuildVehicleLists();

   388

	}

   389

	return 0;

   390

}

   391

   392

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

   393

 * @param x,y unused

   394

 * @param p1 the ID of the vehicle

   395

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

   396

 */

   397

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

   398

{

   399

	Vehicle *v, *u;

   400

	VehicleID veh_id = p1;

   401

	OrderID sel_ord = p2;

   402

	Order *order;

   403

   404

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   405

	v = GetVehicle(veh_id);

   406

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

   407

   408

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

   409

	if (sel_ord >= v->num_orders)

   410

		return DecloneOrder(v, flags);

   411

   412

	order = GetVehicleOrder(v, sel_ord);

   413

	if (order == NULL) return CMD_ERROR;

   414

   415

	if (flags & DC_EXEC) {

   416

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

   417

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

   418

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

   419

				    Because we can have shared order, we copy the data

   420

				    from the next item over the deleted */

   421

				order = GetVehicleOrder(v, sel_ord + 1);

   422

				SwapOrders(v->orders, order);

   423

			} else {

   424

				/* Last item, so clean the list */

   425

				v->orders = NULL;

   426

			}

   427

		} else {

   428

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

   429

		}

   430

   431

		/* Give the item free */

   432

		order->type = OT_NOTHING;

   433

		order->next = NULL;

   434

   435

		u = GetFirstVehicleFromSharedList(v);

   436

		while (u != NULL) {

   437

			u->num_orders--;

   438

   439

			if (sel_ord < u->cur_order_index)

   440

				u->cur_order_index--;

   441

   442

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

   443

			 * also set their orders to NULL */

   444

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

   445

   446

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

   447

   448

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

   449

			 * on his order list or not */

   450

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

   451

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

   452

				u->current_order.flags = 0;

   453

			}

   454

   455

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

   456

			InvalidateVehicleOrder(u);

   457

   458

			u = u->next_shared;

   459

		}

   460

   461

		RebuildVehicleLists();

   462

	}

   463

   464

	return 0;

   465

}

   466

   467

/** Goto next order of order-list.

   468

 * @param x,y unused

   469

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

   470

 * @param p2 unused

   471

 */

   472

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

   473

{

   474

	Vehicle *v;

   475

	VehicleID veh_id = p1;

   476

   477

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   478

	v = GetVehicle(veh_id);

   479

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

   480

   481

	if (flags & DC_EXEC) {

   482

		/* Goto next order */

   483

		OrderID b = v->cur_order_index + 1;

   484

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

   485

   486

		v->cur_order_index = b;

   487

   488

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

   489

   490

		if (v->type == VEH_Road) ClearSlot(v, v->u.road.slot);