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

enum {

    20

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

    21

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

    22

	ORDER_POOL_MAX_BLOCKS      = 1000,

    23

};

    24

    25

/**

    26

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

    27

 */

    28

static void OrderPoolNewBlock(uint start_item)

    29

{

    30

	Order *order;

    31

    32

	FOR_ALL_ORDERS_FROM(order, start_item) 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

static 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)) return AllocateOrder();

   129

   130

	return NULL;

   131

}

   132

   133

/**

   134

 *

   135

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

   136

 *   This function makes sure that the index is maintained correctly

   137

 *

   138

 */

   139

void AssignOrder(Order *order, Order data)

   140

{

   141

	order->type    = data.type;

   142

	order->flags   = data.flags;

   143

	order->station = data.station;

   144

}

   145

   146

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

   147

 * @param x,y unused

   148

 * @param p1 various bitstuffed elements

   149

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

   150

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

   151

 *                        the order will be inserted before that one

   152

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

   153

 * @param p2 packed order to insert

   154

 */

   155

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

   156

{

   157

	Vehicle *v;

   158

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

   159

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

   160

	Order new_order = UnpackOrder(p2);

   161

   162

	if (!IsVehicleIndex(veh)) return CMD_ERROR;

   163

	v = GetVehicle(veh);

   164

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

   165

   166

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

   167

	 * and has the correct flags if any */

   168

	switch (new_order.type) {

   169

		case OT_GOTO_STATION: {

   170

			const Station *st;

   171

   172

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

   173

			st = GetStation(new_order.station);

   174

   175

			if (!IsValidStation(st) ||

   176

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

   177

				return CMD_ERROR;

   178

			}

   179

   180

			switch (v->type) {

   181

				case VEH_Train:

   182

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

   183

					break;

   184

   185

				case VEH_Road:

   186

					if (v->cargo_type == CT_PASSENGERS) {

   187

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

   188

					} else {

   189

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

   190

					}

   191

					break;

   192

   193

				case VEH_Ship:

   194

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

   195

					break;

   196

   197

				case VEH_Aircraft:

   198

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

   199

					break;

   200

   201

				default: return CMD_ERROR;

   202

			}

   203

   204

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

   205

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

   206

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

   207

			switch (new_order.flags) {

   208

				case 0:

   209

				case OF_FULL_LOAD:

   210

				case OF_FULL_LOAD | OF_TRANSFER:

   211

				case OF_UNLOAD:

   212

				case OF_UNLOAD | OF_TRANSFER:

   213

				case OF_TRANSFER:

   214

					break;

   215

   216

				case OF_NON_STOP:

   217

				case OF_NON_STOP | OF_FULL_LOAD:

   218

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   219

				case OF_NON_STOP | OF_UNLOAD:

   220

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   221

				case OF_NON_STOP | OF_TRANSFER:

   222

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

   223

					break;

   224

   225

				default: return CMD_ERROR;

   226

			}

   227

			break;

   228

		}

   229

   230

		case OT_GOTO_DEPOT: {

   231

			if (v->type == VEH_Aircraft) {

   232

				const Station* st;

   233

   234

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

   235

				st = GetStation(new_order.station);

   236

   237

				if (!IsValidStation(st) ||

   238

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

   239

						!(st->facilities & FACIL_AIRPORT) ||

   240

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

   241

					return CMD_ERROR;

   242

				}

   243

			} else {

   244

				const Depot* dp;

   245

   246

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

   247

				dp = GetDepot(new_order.station);

   248

   249

				if (!IsValidDepot(dp) || !CheckOwnership(GetTileOwner(dp->xy)))

   250

					return CMD_ERROR;

   251

   252

				switch (v->type) {

   253

					case VEH_Train:

   254

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

   255

						break;

   256

   257

					case VEH_Road:

   258

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

   259

						break;

   260

   261

					case VEH_Ship:

   262

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

   263

						break;

   264

   265

					default: return CMD_ERROR;

   266

				}

   267

			}

   268

   269

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

   270

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

   271

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

   272

			switch (new_order.flags) {

   273

				case OF_PART_OF_ORDERS:

   274

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   275

					break;

   276

   277

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   278

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   279

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

   280

					break;

   281

   282

				default: return CMD_ERROR;

   283

			}

   284

			break;

   285

		}

   286

   287

		case OT_GOTO_WAYPOINT: {

   288

			const Waypoint* wp;

   289

   290

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

   291

   292

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

   293

			wp = GetWaypoint(new_order.station);

   294

   295

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

   296

   297

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

   298

			 * [non-stop]

   299

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

   300

			switch (new_order.flags) {

   301

				case 0: break;

   302

   303

				case OF_NON_STOP:

   304

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

   305

					break;

   306

   307

				default: return CMD_ERROR;

   308

			}

   309

			break;

   310

		}

   311

   312

		default: return CMD_ERROR;

   313

	}

   314

   315

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

   316

   317

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   318

   319

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

   320

	 * handle any more then this.. */

   321

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

   322

   323

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

   324

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

   325

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

   326

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

   327

		&& !_patches.new_pathfinding_all) {

   328

   329

		int dist = DistanceManhattan(

   330

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

   331

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

   332

		);

   333

		if (dist >= 130)

   334

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   335

	}

   336

   337

	if (flags & DC_EXEC) {

   338

		Vehicle *u;

   339

		Order *new = AllocateOrder();

   340

		AssignOrder(new, new_order);

   341

   342

		/* Create new order and link in list */

   343

		if (v->orders == NULL) {

   344

			v->orders = new;

   345

		} else {

   346

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

   347

			    selected) */

   348

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

   349

   350

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

   351

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

   352

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

   353

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

   354

				    all vehicles */

   355

				SwapOrders(v->orders, new);

   356

				/* Now update the next pointers */

   357

				v->orders->next = new;

   358

			} else if (order == NULL) {

   359

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

   360

				order = GetLastVehicleOrder(v);

   361

				order->next = new;

   362

			} else {

   363

				/* Put the new order in between */

   364

				new->next = order->next;

   365

				order->next = new;

   366

			}

   367

		}

   368

   369

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

   370

			/* Increase amount of orders */

   371

			u->num_orders++;

   372

   373

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

   374

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

   375

   376

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

   377

   378

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

   379

			to update the selected order */

   380

			if (sel_ord <= u->cur_order_index) {

   381

				uint cur = u->cur_order_index + 1;

   382

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

   383

				if (cur < u->num_orders)

   384

					u->cur_order_index = cur;

   385

			}

   386

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

   387

			InvalidateVehicleOrder(u);

   388

		}

   389

   390

		/* Make sure to rebuild the whole list */

   391

		RebuildVehicleLists();

   392

	}

   393

   394

	return 0;

   395

}

   396

   397

/** Declone an order-list

   398

 * @param *dst delete the orders of this vehicle

   399

 * @param flags execution flags

   400

 */

   401

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   402

{

   403

	if (flags & DC_EXEC) {

   404

		DeleteVehicleOrders(dst);

   405

		InvalidateVehicleOrder(dst);

   406

		RebuildVehicleLists();

   407

	}

   408

	return 0;

   409

}

   410

   411

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

   412

 * @param x,y unused

   413

 * @param p1 the ID of the vehicle

   414

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

   415

 */

   416

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

   417

{

   418

	Vehicle *v, *u;

   419

	VehicleID veh_id = p1;

   420

	OrderID sel_ord = p2;

   421

	Order *order;

   422

   423

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   424

	v = GetVehicle(veh_id);

   425

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

   426

   427

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

   428

	if (sel_ord >= v->num_orders)

   429

		return DecloneOrder(v, flags);

   430

   431

	order = GetVehicleOrder(v, sel_ord);

   432

	if (order == NULL) return CMD_ERROR;

   433

   434

	if (flags & DC_EXEC) {

   435

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

   436

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

   437

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

   438

				    Because we can have shared order, we copy the data

   439

				    from the next item over the deleted */

   440

				order = GetVehicleOrder(v, sel_ord + 1);

   441

				SwapOrders(v->orders, order);

   442

			} else {

   443

				/* Last item, so clean the list */

   444

				v->orders = NULL;

   445

			}

   446

		} else {

   447

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

   448

		}

   449

   450

		/* Give the item free */

   451

		order->type = OT_NOTHING;

   452

		order->next = NULL;

   453

   454

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

   455

			u->num_orders--;

   456

   457

			if (sel_ord < u->cur_order_index)

   458

				u->cur_order_index--;

   459

   460

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

   461

			 * also set their orders to NULL */

   462

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

   463

   464

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

   465

   466

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

   467

			 * on his order list or not */

   468

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

   469

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

   470

				u->current_order.flags = 0;

   471

			}

   472

   473

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

   474

			InvalidateVehicleOrder(u);

   475

		}

   476

   477

		RebuildVehicleLists();

   478

	}

   479

   480

	return 0;

   481

}

   482

   483

/** Goto next order of order-list.

   484

 * @param x,y unused

   485

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

   486

 * @param p2 unused

   487

 */