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);

    50

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

    51

	order.next    = NULL;

    52

    57

	// Sanity check

    58

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

    59

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

    60

		order.type = OT_DUMMY;

    61

		order.flags = 0;

    62

	}

    63

    64

	return order;

    65

}

    66

    67

/**

    68

 *

    69

 * Unpacks a order from savegames with version 4 and lower

    70

 *

    71

 */

    72

static Order UnpackVersion4Order(uint16 packed)

    73

{

    74

	Order order;

    75

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

    76

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

    77

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

    78

	order.next  = NULL;

    79

	order.index = 0; // avoid compiler warning

    81

	order.refit_subtype = 0;

    82

	return order;

    83

}

    84

    85

/**

    86

 *

    87

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

    88

 *

    89

 */

    90

void InvalidateVehicleOrder(const Vehicle *v)

    91

{

    92

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    93

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    94

}

    95

    96

/**

    97

 *

    98

 * Swap two orders

    99

 *

   100

 */

   101

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

   102

{

   103

	Order temp_order;

   104

   105

	temp_order = *order1;

   106

	AssignOrder(order1, *order2);

   107

	order1->next = order2->next;

   108

	AssignOrder(order2, temp_order);

   109

	order2->next = temp_order.next;

   110

}

   111

   112

/**

   113

 *

   114

 * Allocate a new order

   115

 *

   116

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

   117

 *

   118

 */

   119

static Order *AllocateOrder(void)

   120

{

   121

	Order *order;

   122

   123

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

   124

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

   125

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

   126

		if (!IsValidOrder(order)) {

   127

			OrderID index = order->index;

   128

   129

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

   130

			order->index = index;

   131

			order->next = NULL;

   134

   135

			return order;

   136

		}

   137

	}

   138

   139

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

   140

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

   141

   142

	return NULL;

   143

}

   144

   145

/**

   146

 *

   147

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

   148

 *   This function makes sure that the index is maintained correctly

   149

 *

   150

 */

   151

void AssignOrder(Order *order, Order data)

   152

{

   153

	order->type  = data.type;

   154

	order->flags = data.flags;

   155

	order->dest  = data.dest;

   156

   159

}

   160

   161

   162

/**

   163

 * Delete all news items regarding defective orders about a vehicle

   164

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

   165

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

   166

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

   167

 */

   168

static void DeleteOrderWarnings(const Vehicle* v)

   169

{

   170

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

   171

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

   172

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

   173

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

   174

}

   175

   176

   177

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

   178

 * @param tile unused

   179

 * @param p1 various bitstuffed elements

   180

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

   181

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

   182

 *                        the order will be inserted before that one

   183

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

   184

 * @param p2 packed order to insert

   185

 */

   186

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

   187

{

   188

	Vehicle *v;

   189

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

   190

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

   191

	Order new_order = UnpackOrder(p2);

   192

   193

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   194

   195

	v = GetVehicle(veh);

   196

   197

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

   198

   199

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

   200

	 * and has the correct flags if any */

   201

	switch (new_order.type) {

   202

		case OT_GOTO_STATION: {

   203

			const Station *st;

   204

   205

			if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   206

			st = GetStation(new_order.dest);

   207

   208

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

   209

				return CMD_ERROR;

   210

			}

   211

   212

			switch (v->type) {

   213

				case VEH_Train:

   214

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

   215

					break;

   216

   217

				case VEH_Road:

   218

					if (v->cargo_type == CT_PASSENGERS) {

   219

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

   220

					} else {

   221

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

   222

					}

   223

					break;

   224

   225

				case VEH_Ship:

   226

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

   227

					break;

   228

   229

				case VEH_Aircraft:

   230

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

   231

					break;

   232

   233

				default: return CMD_ERROR;

   234

			}

   235

   236

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

   237

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

   238

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

   239

			switch (new_order.flags) {

   240

				case 0:

   241

				case OF_FULL_LOAD:

   242

				case OF_FULL_LOAD | OF_TRANSFER:

   243

				case OF_UNLOAD:

   244

				case OF_UNLOAD | OF_TRANSFER:

   245

				case OF_TRANSFER:

   246

					break;

   247

   248

				case OF_NON_STOP:

   249

				case OF_NON_STOP | OF_FULL_LOAD:

   250

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   251

				case OF_NON_STOP | OF_UNLOAD:

   252

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   253

				case OF_NON_STOP | OF_TRANSFER:

   254

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

   255

					break;

   256

   257

				default: return CMD_ERROR;

   258

			}

   259

			break;

   260

		}

   261

   262

		case OT_GOTO_DEPOT: {

   263

			if (v->type == VEH_Aircraft) {

   264

				const Station* st;

   265

   266

				if (!IsValidStationID(new_order.dest)) return CMD_ERROR;

   267

				st = GetStation(new_order.dest);

   268

   269

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

   270

						!(st->facilities & FACIL_AIRPORT) ||

   271

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

   272

					return CMD_ERROR;

   273

				}

   274

			} else {

   275

				const Depot* dp;

   276

   277

				if (!IsValidDepotID(new_order.dest)) return CMD_ERROR;

   278

				dp = GetDepot(new_order.dest);

   279

   280

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

   281

   282

				switch (v->type) {

   283

					case VEH_Train:

   284

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

   285

						break;

   286

   287

					case VEH_Road:

   288

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

   289

						break;

   290

   291

					case VEH_Ship:

   292

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

   293

						break;

   294

   295

					default: return CMD_ERROR;

   296

				}

   297

			}

   298

   299

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

   300

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

   301

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

   302

			switch (new_order.flags) {

   303

				case OF_PART_OF_ORDERS:

   304

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   305

					break;

   306

   307

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   308

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   309

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

   310

					break;

   311

   312

				default: return CMD_ERROR;

   313

			}

   314

			break;

   315

		}

   316

   317

		case OT_GOTO_WAYPOINT: {

   318

			const Waypoint* wp;

   319

   320

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

   321

   322

			if (!IsValidWaypointID(new_order.dest)) return CMD_ERROR;

   323

			wp = GetWaypoint(new_order.dest);

   324

   325

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

   326

   327

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

   328

			 * [non-stop]

   329

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

   330

			switch (new_order.flags) {

   331

				case 0: break;

   332

   333

				case OF_NON_STOP:

   334

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

   335

					break;

   336

   337

				default: return CMD_ERROR;

   338

			}

   339

			break;

   340

		}

   341

   342

		default: return CMD_ERROR;

   343

	}

   344

   345

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

   346

   347

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   348

   349

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

   350

	 * handle any more then this.. */

   351

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

   352

   353

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

   354

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

   355

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

   356

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

   357

		&& !_patches.new_pathfinding_all) {

   358

   359

		int dist = DistanceManhattan(

   360

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

   361

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

   362

		);

   363

		if (dist >= 130)

   364

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   365

	}

   366

   367

	if (flags & DC_EXEC) {

   368

		Vehicle *u;

   369

		Order *new = AllocateOrder();

   370

		AssignOrder(new, new_order);

   371

   372

		/* Create new order and link in list */

   373

		if (v->orders == NULL) {

   374

			v->orders = new;

   375

		} else {

   376

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

   377

			    selected) */

   378

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

   379

   380

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

   381

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

   382

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

   383

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

   384

				    all vehicles */

   385

				SwapOrders(v->orders, new);

   386

				/* Now update the next pointers */

   387

				v->orders->next = new;

   388

			} else if (order == NULL) {

   389

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

   390

				order = GetLastVehicleOrder(v);

   391

				order->next = new;

   392

			} else {

   393

				/* Put the new order in between */

   394

				new->next = order->next;

   395

				order->next = new;

   396

			}

   397

		}

   398

   399

		u = GetFirstVehicleFromSharedList(v);

   400

		DeleteOrderWarnings(u);

   401

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

   402

			/* Increase amount of orders */

   403

			u->num_orders++;

   404

   405

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

   406

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

   407

   408

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

   409

   410

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

   411

			to update the selected order */

   412

			if (sel_ord <= u->cur_order_index) {

   413

				uint cur = u->cur_order_index + 1;

   414

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

   415

				if (cur < u->num_orders)

   416

					u->cur_order_index = cur;

   417

			}

   418

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

   419

			InvalidateVehicleOrder(u);

   420

		}

   421

   422

		/* Make sure to rebuild the whole list */

   423

		RebuildVehicleLists();

   424

	}

   425

   426

	return 0;

   427

}

   428

   429

/** Declone an order-list

   430

 * @param *dst delete the orders of this vehicle

   431

 * @param flags execution flags

   432

 */

   433

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   434

{

   435

	if (flags & DC_EXEC) {

   436

		DeleteVehicleOrders(dst);

   437

		InvalidateVehicleOrder(dst);

   438

		RebuildVehicleLists();

   439

	}

   440

	return 0;

   441

}

   442

   443

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

   444

 * @param tile unused

   445

 * @param p1 the ID of the vehicle

   446

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

   447

 */

   448

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

   449

{

   450

	Vehicle *v, *u;

   451

	VehicleID veh_id = p1;

   452

	VehicleOrderID sel_ord = p2;

   453

	Order *order;

   454

   455

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   456

   457

	v = GetVehicle(veh_id);

   458

   459

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

   460

   461

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

   462

	if (sel_ord >= v->num_orders)

   463

		return DecloneOrder(v, flags);

   464

   465

	order = GetVehicleOrder(v, sel_ord);

   466

	if (order == NULL) return CMD_ERROR;

   467

   468

	if (flags & DC_EXEC) {

   469

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

   470

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

   471

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

   472

				    Because we can have shared order, we copy the data

   473

				    from the next item over the deleted */

   474

				order = GetVehicleOrder(v, sel_ord + 1);

   475

				SwapOrders(v->orders, order);

   476

			} else {

   477

				/* Last item, so clean the list */

   478

				v->orders = NULL;

   479

			}

   480

		} else {

   481

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

   482

		}

   483

   484

		/* Give the item free */

   485

		order->type = OT_NOTHING;

   486

		order->next = NULL;