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

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

    33

	 * TODO - This is just a temporary stage, this will be removed. */

    34

	for (order = GetOrder(start_item); order != NULL; order = (order->index + 1 < GetOrderPoolSize()) ? GetOrder(order->index + 1) : NULL) order->index = start_item++;

    35

}

    36

    37

/* Initialize the order-pool */

    38

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

    39

    40

/**

    41

 *

    42

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

    43

 *

    44

 */

    45

Order UnpackOldOrder(uint16 packed)

    46

{

    47

	Order order;

    48

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

    49

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

    51

	order.next    = NULL;

    52

    53

	// Sanity check

    54

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

    56

		order.type = OT_DUMMY;

    57

		order.flags = 0;

    58

	}

    59

    60

	return order;

    61

}

    62

    63

/**

    64

 *

    65

 * Unpacks a order from savegames with version 4 and lower

    66

 *

    67

 */

    68

static Order UnpackVersion4Order(uint16 packed)

    69

{

    70

	Order order;

    71

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

    72

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

    74

	order.next    = NULL;

    75

	order.index   = 0; // avoid compiler warning

    76

	return order;

    77

}

    78

    79

/**

    80

 *

    81

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

    82

 *

    83

 */

    84

void InvalidateVehicleOrder(const Vehicle *v)

    85

{

    86

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    87

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    88

}

    89

    90

/**

    91

 *

    92

 * Swap two orders

    93

 *

    94

 */

    95

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

    96

{

    97

	Order temp_order;

    98

    99

	temp_order = *order1;

   100

	AssignOrder(order1, *order2);

   101

	order1->next = order2->next;

   102

	AssignOrder(order2, temp_order);

   103

	order2->next = temp_order.next;

   104

}

   105

   106

/**

   107

 *

   108

 * Allocate a new order

   109

 *

   110

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

   111

 *

   112

 */

   113

static Order *AllocateOrder(void)

   114

{

   115

	Order *order;

   116

   117

	/* We don't use FOR_ALL here, because FOR_ALL skips invalid items.

   118

	 * TODO - This is just a temporary stage, this will be removed. */

   119

	for (order = GetOrder(0); order != NULL; order = (order->index + 1 < GetOrderPoolSize()) ? GetOrder(order->index + 1) : NULL) {

   120

		if (!IsValidOrder(order)) {

   121

			uint index = order->index;

   122

   123

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

   124

			order->index = index;

   125

			order->next = NULL;

   126

   127

			return order;

   128

		}

   129

	}

   130

   131

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

   132

	if (AddBlockToPool(&_order_pool)) return AllocateOrder();

   133

   134

	return NULL;

   135

}

   136

   137

/**

   138

 *

   139

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

   140

 *   This function makes sure that the index is maintained correctly

   141

 *

   142

 */

   143

void AssignOrder(Order *order, Order data)

   144

{

   145

	order->type    = data.type;

   146

	order->flags   = data.flags;

   148

}

   149

   150

   151

/**

   152

 * Delete all news items regarding defective orders about a vehicle

   153

 * This could kill still valid warnings (for example about void order when just

   154

 * another order gets added), but assume the player will notice the problems,

   155

 * when (s)he's changing the orders.

   156

 */

   157

static void DeleteOrderWarnings(const Vehicle* v)

   158

{

   159

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_TOO_FEW_ORDERS  + (v->type - VEH_Train) * 4);

   160

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_VOID_ORDER      + (v->type - VEH_Train) * 4);

   161

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_DUPLICATE_ENTRY + (v->type - VEH_Train) * 4);

   162

	DeleteVehicleNews(v->index, STR_TRAIN_HAS_INVALID_ENTRY   + (v->type - VEH_Train) * 4);

   163

}

   164

   165

   166

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

   167

 * @param tile unused

   168

 * @param p1 various bitstuffed elements

   169

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

   170

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

   171

 *                        the order will be inserted before that one

   172

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

   173

 * @param p2 packed order to insert

   174

 */

   175

int32 CmdInsertOrder(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   176

{

   177

	Vehicle *v;

   178

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

   179

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

   180

	Order new_order = UnpackOrder(p2);

   181

   182

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   183

   184

	v = GetVehicle(veh);

   185

   186

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   187

   188

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

   189

	 * and has the correct flags if any */

   190

	switch (new_order.type) {

   191

		case OT_GOTO_STATION: {

   192

			const Station *st;

   193

   196

   197

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

   198

				return CMD_ERROR;

   199

			}

   200

   201

			switch (v->type) {

   202

				case VEH_Train:

   203

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

   204

					break;

   205

   206

				case VEH_Road:

   207

					if (v->cargo_type == CT_PASSENGERS) {

   208

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

   209

					} else {

   210

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

   211

					}

   212

					break;

   213

   214

				case VEH_Ship:

   215

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

   216

					break;

   217

   218

				case VEH_Aircraft:

   219

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

   220

					break;

   221

   222

				default: return CMD_ERROR;

   223

			}

   224

   225

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

   226

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

   227

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

   228

			switch (new_order.flags) {

   229

				case 0:

   230

				case OF_FULL_LOAD:

   231

				case OF_FULL_LOAD | OF_TRANSFER:

   232

				case OF_UNLOAD:

   233

				case OF_UNLOAD | OF_TRANSFER:

   234

				case OF_TRANSFER:

   235

					break;

   236

   237

				case OF_NON_STOP:

   238

				case OF_NON_STOP | OF_FULL_LOAD:

   239

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   240

				case OF_NON_STOP | OF_UNLOAD:

   241

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   242

				case OF_NON_STOP | OF_TRANSFER:

   243

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

   244

					break;

   245

   246

				default: return CMD_ERROR;

   247

			}

   248

			break;

   249

		}

   250

   251

		case OT_GOTO_DEPOT: {

   252

			if (v->type == VEH_Aircraft) {

   253

				const Station* st;

   254

   257

   258

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

   259

						!(st->facilities & FACIL_AIRPORT) ||

   260

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

   261

					return CMD_ERROR;

   262

				}

   263

			} else {

   264

				const Depot* dp;

   265

   268

   269

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

   270

   271

				switch (v->type) {

   272

					case VEH_Train:

   273

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

   274

						break;

   275

   276

					case VEH_Road:

   277

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

   278

						break;

   279

   280

					case VEH_Ship:

   281

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

   282

						break;

   283

   284

					default: return CMD_ERROR;

   285

				}

   286

			}

   287

   288

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

   289

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

   290

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

   291

			switch (new_order.flags) {

   292

				case OF_PART_OF_ORDERS:

   293

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   294

					break;

   295

   296

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   297

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   298

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

   299

					break;

   300

   301

				default: return CMD_ERROR;

   302

			}

   303

			break;

   304

		}

   305

   306

		case OT_GOTO_WAYPOINT: {

   307

			const Waypoint* wp;

   308

   309

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

   310

   313

   314

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

   315

   316

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

   317

			 * [non-stop]

   318

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

   319

			switch (new_order.flags) {

   320

				case 0: break;

   321

   322

				case OF_NON_STOP:

   323

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

   324

					break;

   325

   326

				default: return CMD_ERROR;

   327

			}

   328

			break;

   329

		}

   330

   331

		default: return CMD_ERROR;

   332

	}

   333

   334

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

   335

   336

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   337

   338

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

   339

	 * handle any more then this.. */

   340

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

   341

   342

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

   343

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

   344

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

   345

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

   346

		&& !_patches.new_pathfinding_all) {

   347

   348

		int dist = DistanceManhattan(

   351

		);

   352

		if (dist >= 130)

   353

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   354

	}

   355

   356

	if (flags & DC_EXEC) {

   357

		Vehicle *u;

   358

		Order *new = AllocateOrder();

   359

		AssignOrder(new, new_order);

   360

   361

		/* Create new order and link in list */

   362

		if (v->orders == NULL) {

   363

			v->orders = new;

   364

		} else {

   365

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

   366

			    selected) */

   367

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

   368

   369

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

   370

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

   371

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

   372

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

   373

				    all vehicles */

   374

				SwapOrders(v->orders, new);

   375

				/* Now update the next pointers */

   376

				v->orders->next = new;

   377

			} else if (order == NULL) {

   378

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

   379

				order = GetLastVehicleOrder(v);

   380

				order->next = new;

   381

			} else {

   382

				/* Put the new order in between */

   383

				new->next = order->next;

   384

				order->next = new;

   385

			}

   386

		}

   387

   388

		u = GetFirstVehicleFromSharedList(v);

   389

		DeleteOrderWarnings(u);

   390

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

   391

			/* Increase amount of orders */

   392

			u->num_orders++;

   393

   394

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

   395

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

   396

   397

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

   398

   399

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

   400

			to update the selected order */

   401

			if (sel_ord <= u->cur_order_index) {

   402

				uint cur = u->cur_order_index + 1;

   403

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

   404

				if (cur < u->num_orders)

   405

					u->cur_order_index = cur;

   406

			}

   407

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

   408

			InvalidateVehicleOrder(u);

   409

		}

   410

   411

		/* Make sure to rebuild the whole list */

   412

		RebuildVehicleLists();

   413

	}

   414

   415

	return 0;

   416

}

   417

   418

/** Declone an order-list

   419

 * @param *dst delete the orders of this vehicle

   420

 * @param flags execution flags

   421

 */

   422

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   423

{

   424

	if (flags & DC_EXEC) {

   425

		DeleteVehicleOrders(dst);

   426

		InvalidateVehicleOrder(dst);

   427

		RebuildVehicleLists();

   428

	}

   429

	return 0;

   430

}

   431

   432

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

   433

 * @param tile unused

   434

 * @param p1 the ID of the vehicle

   435

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

   436

 */

   437

int32 CmdDeleteOrder(TileIndex tile, uint32 flags, uint32 p1, uint32 p2)

   438

{

   439

	Vehicle *v, *u;

   440

	VehicleID veh_id = p1;

   441

	OrderID sel_ord = p2;

   442

	Order *order;

   443

   444

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   445

   446

	v = GetVehicle(veh_id);

   447

   448

	if (!CheckOwnership(v->owner)) return CMD_ERROR;

   449

   450

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

   451

	if (sel_ord >= v->num_orders)

   452

		return DecloneOrder(v, flags);

   453

   454

	order = GetVehicleOrder(v, sel_ord);

   455

	if (order == NULL) return CMD_ERROR;

   456

   457

	if (flags & DC_EXEC) {

   458

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

   459

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

   460

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

   461

				    Because we can have shared order, we copy the data

   462

				    from the next item over the deleted */

   463

				order = GetVehicleOrder(v, sel_ord + 1);

   464

				SwapOrders(v->orders, order);

   465

			} else {

   466

				/* Last item, so clean the list */

   467

				v->orders = NULL;

   468

			}

   469

		} else {

   470

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

   471

		}

   472

   473

		/* Give the item free */

   474

		order->type = OT_NOTHING;

   475

		order->next = NULL;

   476

   477

		u = GetFirstVehicleFromSharedList(v);

   478

		DeleteOrderWarnings(u);

   479

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

   480

			u->num_orders--;

   481

   482

			if (sel_ord < u->cur_order_index)

   483

				u->cur_order_index--;

   484

   485

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

   486

			 * also set their orders to NULL */