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

#include "ai/ai_event.h"

    19

    20

enum {

    21

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

    22

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

    23

	ORDER_POOL_MAX_BLOCKS      = 1000,

    24

};

    25

    26

/**

    27

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

    28

 */

    29

static void OrderPoolNewBlock(uint start_item)

    30

{

    31

	Order *order;

    32

    33

	FOR_ALL_ORDERS_FROM(order, start_item) order->index = start_item++;

    34

}

    35

    36

/* Initialize the order-pool */

    37

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

    38

    39

/**

    40

 *

    41

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

    42

 *

    43

 */

    44

Order UnpackOldOrder(uint16 packed)

    45

{

    46

	Order order;

    47

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

    48

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

    49

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

    50

	order.next    = NULL;

    51

    52

	// Sanity check

    53

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

    54

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

    55

		order.type = OT_DUMMY;

    56

		order.flags = 0;

    57

	}

    58

    59

	return order;

    60

}

    61

    62

/**

    63

 *

    64

 * Unpacks a order from savegames with version 4 and lower

    65

 *

    66

 */

    67

Order UnpackVersion4Order(uint16 packed)

    68

{

    69

	Order order;

    70

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

    71

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

    72

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

    73

	order.next    = NULL;

    74

	order.index   = 0; // avoid compiler warning

    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

	FOR_ALL_ORDERS(order) {

   117

		if (order->type == OT_NOTHING) {

   118

			uint index = order->index;

   119

   120

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

   121

			order->index = index;

   122

			order->next = NULL;

   123

   124

			return order;

   125

		}

   126

	}

   127

   128

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

   129

	if (AddBlockToPool(&_order_pool)) 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

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

   206

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

   207

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

   208

			switch (new_order.flags) {

   209

				case 0:

   210

				case OF_FULL_LOAD:

   211

				case OF_FULL_LOAD | OF_TRANSFER:

   212

				case OF_UNLOAD:

   213

				case OF_UNLOAD | OF_TRANSFER:

   214

				case OF_TRANSFER:

   215

					break;

   216

   217

				case OF_NON_STOP:

   218

				case OF_NON_STOP | OF_FULL_LOAD:

   219

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   220

				case OF_NON_STOP | OF_UNLOAD:

   221

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   222

				case OF_NON_STOP | OF_TRANSFER:

   223

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

   224

					break;

   225

   226

				default: return CMD_ERROR;

   227

			}

   228

			break;

   229

		}

   230

   231

		case OT_GOTO_DEPOT: {

   232

			if (v->type == VEH_Aircraft) {

   233

				const Station* st;

   234

   235

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

   236

				st = GetStation(new_order.station);

   237

   238

				if (!IsValidStation(st) ||

   239

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

   240

						!(st->facilities & FACIL_AIRPORT) ||

   241

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

   242

					return CMD_ERROR;

   243

				}

   244

			} else {

   245

				const Depot* dp;

   246

   247

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

   248

				dp = GetDepot(new_order.station);

   249

   250

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

   251

					return CMD_ERROR;

   252

   253

				switch (v->type) {

   254

					case VEH_Train:

   255

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

   256

						break;

   257

   258

					case VEH_Road:

   259

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

   260

						break;

   261

   262

					case VEH_Ship:

   263

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

   264

						break;

   265

   266

					default: return CMD_ERROR;

   267

				}

   268

			}

   269

   270

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

   271

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

   272

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

   273

			switch (new_order.flags) {

   274

				case OF_PART_OF_ORDERS:

   275

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   276

					break;

   277

   278

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   279

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   280

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

   281

					break;

   282

   283

				default: return CMD_ERROR;

   284

			}

   285

			break;

   286

		}

   287

   288

		case OT_GOTO_WAYPOINT: {

   289

			const Waypoint* wp;

   290

   291

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

   292

   293

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

   294

			wp = GetWaypoint(new_order.station);

   295

   296

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

   297

   298

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

   299

			 * [non-stop]

   300

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

   301

			switch (new_order.flags) {

   302

				case 0: break;

   303

   304

				case OF_NON_STOP:

   305

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

   306

					break;

   307

   308

				default: return CMD_ERROR;

   309

			}

   310

			break;

   311

		}

   312

   313

		default: return CMD_ERROR;

   314

	}

   315

   316

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

   317

   318

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   319

   320

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

   321

	 * handle any more then this.. */

   322

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

   323

   324

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

   325

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

   326

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

   327

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

   328

		&& !_patches.new_pathfinding_all) {

   329

   330

		int dist = DistanceManhattan(

   331

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

   332

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

   333

		);

   334

		if (dist >= 130)

   335

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   336

	}

   337

   338

	if (flags & DC_EXEC) {

   339

		Vehicle *u;

   340

		Order *new = AllocateOrder();

   341

		AssignOrder(new, new_order);

   342

   343

		/* Create new order and link in list */

   344

		if (v->orders == NULL) {

   345

			v->orders = new;

   346

		} else {

   347

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

   348

			    selected) */

   349

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

   350

   351

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

   352

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

   353

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

   354

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

   355

				    all vehicles */

   356

				SwapOrders(v->orders, new);

   357

				/* Now update the next pointers */

   358

				v->orders->next = new;

   359

			} else if (order == NULL) {

   360

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

   361

				order = GetLastVehicleOrder(v);

   362

				order->next = new;

   363

			} else {

   364

				/* Put the new order in between */

   365

				new->next = order->next;

   366

				order->next = new;

   367

			}

   368

		}

   369

   370

		u = GetFirstVehicleFromSharedList(v);

   371

		while (u != NULL) {

   372

			/* Increase amount of orders */

   373

			u->num_orders++;

   374

   375

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

   376

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

   377

   378

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

   379

   380

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

   381

			to update the selected order */

   382

			if (sel_ord <= u->cur_order_index) {

   383

				uint cur = u->cur_order_index + 1;

   384

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

   385

				if (cur < u->num_orders)

   386

					u->cur_order_index = cur;

   387

			}

   388

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

   389

			InvalidateVehicleOrder(u);

   390

			if (u->type == VEH_Train) u->u.rail.shortest_platform[1] = 0; // we changed the orders so we invalidate the station length collector

   391

   392

			u = u->next_shared;

   393

		}

   394

   395

		/* Make sure to rebuild the whole list */

   396

		RebuildVehicleLists();

   397

   399

	}

   400

   401

	return 0;

   402

}

   403

   404

/** Declone an order-list

   405

 * @param *dst delete the orders of this vehicle

   406

 * @param flags execution flags

   407

 */

   408

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   409

{

   410

	if (flags & DC_EXEC) {

   411

		DeleteVehicleOrders(dst);

   412

		InvalidateVehicleOrder(dst);

   413

		RebuildVehicleLists();

   414

	}

   415

	return 0;

   416

}

   417

   418

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

   419

 * @param x,y unused

   420

 * @param p1 the ID of the vehicle

   421

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

   422

 */

   423

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

   424

{

   425

	Vehicle *v, *u;

   426

	VehicleID veh_id = p1;

   427

	OrderID sel_ord = p2;

   428

	Order *order;

   429

   430

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   431

	v = GetVehicle(veh_id);

   432

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

   433

   434

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

   435

	if (sel_ord >= v->num_orders)

   436

		return DecloneOrder(v, flags);

   437

   438

	order = GetVehicleOrder(v, sel_ord);

   439

	if (order == NULL) return CMD_ERROR;

   440

   441

	if (flags & DC_EXEC) {

   442

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

   443

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

   444

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

   445

				    Because we can have shared order, we copy the data

   446

				    from the next item over the deleted */

   447

				order = GetVehicleOrder(v, sel_ord + 1);

   448

				SwapOrders(v->orders, order);

   449

			} else {

   450

				/* Last item, so clean the list */

   451

				v->orders = NULL;

   452

			}

   453

		} else {

   454

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

   455

		}

   456

   457

		/* Give the item free */

   458

		order->type = OT_NOTHING;

   459

		order->next = NULL;

   460

   461

		u = GetFirstVehicleFromSharedList(v);

   462

		while (u != NULL) {

   463

			u->num_orders--;

   464

   465

			if (sel_ord < u->cur_order_index)

   466

				u->cur_order_index--;

   467

   468

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

   469

			 * also set their orders to NULL */

   470

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

   471

   472

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

   473

   474

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

   475

			 * on his order list or not */

   476

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

   477

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

   478

				u->current_order.flags = 0;

   479

			}

   480

   481

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

   482

			InvalidateVehicleOrder(u);

   483

   484

			u = u->next_shared;

   485

		}

   486

   487

		RebuildVehicleLists();