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

    53

	// Sanity check

    54

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

    55

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

    56

		order.type = OT_DUMMY;

    57

		order.flags = 0;

    58

	}

    59

    60

	order.refit_cargo   = CT_INVALID;

    61

	order.refit_subtype = 0;

    62

    63

	return order;

    64

}

    65

    66

/**

    67

 *

    68

 * Unpacks a order from savegames with version 4 and lower

    69

 *

    70

 */

    71

static Order UnpackVersion4Order(uint16 packed)

    72

{

    73

	Order order;

    74

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

    75

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

    76

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

    77

	order.next  = NULL;

    78

	order.index = 0; // avoid compiler warning

    79

	order.refit_cargo   = CT_INVALID;

    80

	order.refit_subtype = 0;

    81

	return order;

    82

}

    83

    84

/**

    85

 *

    86

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

    87

 *

    88

 */

    89

void InvalidateVehicleOrder(const Vehicle *v)

    90

{

    91

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    92

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    93

}

    94

    95

/**

    96

 *

    97

 * Swap two orders

    98

 *

    99

 */

   100

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

   101

{

   102

	Order temp_order;

   103

   104

	temp_order = *order1;

   105

	AssignOrder(order1, *order2);

   106

	order1->next = order2->next;

   107

	AssignOrder(order2, temp_order);

   108

	order2->next = temp_order.next;

   109

}

   110

   111

/**

   112

 *

   113

 * Allocate a new order

   114

 *

   115

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

   116

 *

   117

 */

   118

static Order *AllocateOrder(void)

   119

{

   120

	Order *order;

   121

   122

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

   123

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

   124

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

   125

		if (!IsValidOrder(order)) {

   126

			OrderID index = order->index;

   127

   128

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

   129

			order->index = index;

   130

			order->next = NULL;

   131

   132

			return order;

   133

		}

   134

	}

   135

   136

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

   137

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

   138

   139

	return NULL;

   140

}

   141

   142

/**

   143

 *

   144

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

   145

 *   This function makes sure that the index is maintained correctly

   146

 *

   147

 */

   148

void AssignOrder(Order *order, Order data)

   149

{

   150

	order->type  = data.type;

   151

	order->flags = data.flags;

   152

	order->dest  = data.dest;

   153

   154

	order->refit_cargo   = CT_NO_REFIT;

   155

	order->refit_subtype = CT_NO_REFIT;

   156

}

   157

   158

   159

/**

   160

 * Delete all news items regarding defective orders about a vehicle

   161

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

   162

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

   163

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

   164

 */

   165

static void DeleteOrderWarnings(const Vehicle* v)

   166

{

   167

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

   168

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

   169

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

   170

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

   171

}

   172

   173

   174

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

   175

 * @param tile unused

   176

 * @param p1 various bitstuffed elements

   177

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

   178

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

   179

 *                        the order will be inserted before that one

   180

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

   181

 * @param p2 packed order to insert

   182

 */

   183

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

   184

{

   185

	Vehicle *v;

   186

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

   187

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

   188

	Order new_order = UnpackOrder(p2);

   189

   190

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   191

   192

	v = GetVehicle(veh);

   193

   194

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

   195

   196

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

   197

	 * and has the correct flags if any */

   198

	switch (new_order.type) {

   199

		case OT_GOTO_STATION: {

   200

			const Station *st;

   201

   202

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

   203

			st = GetStation(new_order.dest);

   204

   205

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

   206

				return CMD_ERROR;

   207

			}

   208

   209

			switch (v->type) {

   210

				case VEH_Train:

   211

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

   212

					break;

   213

   214

				case VEH_Road:

   215

					if (v->cargo_type == CT_PASSENGERS) {

   216

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

   217

					} else {

   218

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

   219

					}

   220

					break;

   221

   222

				case VEH_Ship:

   223

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

   224

					break;

   225

   226

				case VEH_Aircraft:

   227

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

   228

					break;

   229

   230

				default: return CMD_ERROR;

   231

			}

   232

   233

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

   234

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

   235

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

   236

			switch (new_order.flags) {

   237

				case 0:

   238

				case OF_FULL_LOAD:

   239

				case OF_FULL_LOAD | OF_TRANSFER:

   240

				case OF_UNLOAD:

   241

				case OF_UNLOAD | OF_TRANSFER:

   242

				case OF_TRANSFER:

   243

					break;

   244

   245

				case OF_NON_STOP:

   246

				case OF_NON_STOP | OF_FULL_LOAD:

   247

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   248

				case OF_NON_STOP | OF_UNLOAD:

   249

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   250

				case OF_NON_STOP | OF_TRANSFER:

   251

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

   252

					break;

   253

   254

				default: return CMD_ERROR;

   255

			}

   256

			break;

   257

		}

   258

   259

		case OT_GOTO_DEPOT: {

   260

			if (v->type == VEH_Aircraft) {

   261

				const Station* st;

   262

   263

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

   264

				st = GetStation(new_order.dest);

   265

   266

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

   267

						!(st->facilities & FACIL_AIRPORT) ||

   268

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

   269

					return CMD_ERROR;

   270

				}

   271

			} else {

   272

				const Depot* dp;

   273

   274

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

   275

				dp = GetDepot(new_order.dest);

   276

   277

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

   278

   279

				switch (v->type) {

   280

					case VEH_Train:

   281

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

   282

						break;

   283

   284

					case VEH_Road:

   285

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

   286

						break;

   287

   288

					case VEH_Ship:

   289

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

   290

						break;

   291

   292

					default: return CMD_ERROR;

   293

				}

   294

			}

   295

   296

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

   297

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

   298

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

   299

			switch (new_order.flags) {

   300

				case OF_PART_OF_ORDERS:

   301

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   302

					break;

   303

   304

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   305

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   306

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

   307

					break;

   308

   309

				default: return CMD_ERROR;

   310

			}

   311

			break;

   312

		}

   313

   314

		case OT_GOTO_WAYPOINT: {

   315

			const Waypoint* wp;

   316

   317

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

   318

   319

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

   320

			wp = GetWaypoint(new_order.dest);

   321

   322

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

   323

   324

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

   325

			 * [non-stop]

   326

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

   327

			switch (new_order.flags) {

   328

				case 0: break;

   329

   330

				case OF_NON_STOP:

   331

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

   332

					break;

   333

   334

				default: return CMD_ERROR;

   335

			}

   336

			break;

   337

		}

   338

   339

		default: return CMD_ERROR;

   340

	}

   341

   342

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

   343

   344

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   345

   346

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

   347

	 * handle any more then this.. */

   348

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

   349

   350

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

   351

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

   352

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

   353

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

   354

		&& !_patches.new_pathfinding_all) {

   355

   356

		int dist = DistanceManhattan(

   357

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

   358

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

   359

		);

   360

		if (dist >= 130)

   361

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   362

	}

   363

   364

	if (flags & DC_EXEC) {

   365

		Vehicle *u;

   366

		Order *new = AllocateOrder();

   367

		AssignOrder(new, new_order);

   368

   369

		/* Create new order and link in list */

   370

		if (v->orders == NULL) {

   371

			v->orders = new;

   372

		} else {

   373

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

   374

			    selected) */

   375

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

   376

   377

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

   378

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

   379

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

   380

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

   381

				    all vehicles */

   382

				SwapOrders(v->orders, new);

   383

				/* Now update the next pointers */

   384

				v->orders->next = new;

   385

			} else if (order == NULL) {

   386

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

   387

				order = GetLastVehicleOrder(v);

   388

				order->next = new;

   389

			} else {

   390

				/* Put the new order in between */

   391

				new->next = order->next;

   392

				order->next = new;

   393

			}

   394

		}

   395

   396

		u = GetFirstVehicleFromSharedList(v);

   397

		DeleteOrderWarnings(u);

   398

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

   399

			/* Increase amount of orders */

   400

			u->num_orders++;

   401

   402

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

   403

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

   404

   405

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

   406

   407

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

   408

			to update the selected order */

   409

			if (sel_ord <= u->cur_order_index) {

   410

				uint cur = u->cur_order_index + 1;

   411

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

   412

				if (cur < u->num_orders)

   413

					u->cur_order_index = cur;

   414

			}

   415

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

   416

			InvalidateVehicleOrder(u);

   417

		}

   418

   419

		/* Make sure to rebuild the whole list */

   420

		RebuildVehicleLists();

   421

	}

   422

   423

	return 0;

   424

}

   425

   426

/** Declone an order-list

   427

 * @param *dst delete the orders of this vehicle

   428

 * @param flags execution flags

   429

 */

   430

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   431

{

   432

	if (flags & DC_EXEC) {

   433

		DeleteVehicleOrders(dst);

   434

		InvalidateVehicleOrder(dst);

   435

		RebuildVehicleLists();

   436

	}

   437

	return 0;

   438

}

   439

   440

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

   441

 * @param tile unused

   442

 * @param p1 the ID of the vehicle

   443

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

   444

 */

   445

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

   446

{

   447

	Vehicle *v, *u;

   448

	VehicleID veh_id = p1;

   449

	VehicleOrderID sel_ord = p2;

   450

	Order *order;

   451

   452

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   453

   454

	v = GetVehicle(veh_id);

   455

   456

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

   457

   458

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

   459

	if (sel_ord >= v->num_orders)

   460

		return DecloneOrder(v, flags);

   461

   462

	order = GetVehicleOrder(v, sel_ord);

   463

	if (order == NULL) return CMD_ERROR;

   464

   465

	if (flags & DC_EXEC) {

   466

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

   467

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

   468

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

   469

				    Because we can have shared order, we copy the data

   470

				    from the next item over the deleted */

   471

				order = GetVehicleOrder(v, sel_ord + 1);

   472

				SwapOrders(v->orders, order);

   473

			} else {

   474

				/* Last item, so clean the list */

   475

				v->orders = NULL;

   476

			}

   477

		} else {

   478

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

   479

		}

   480

   481

		/* Give the item free */

   482

		order->type = OT_NOTHING;

   483

		order->next = NULL;

   484

   485

		u = GetFirstVehicleFromSharedList(v);

   486

		DeleteOrderWarnings(u);