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, NULL, 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

   147

/**

   148

 * Delete all news items regarding defective orders about a vehicle

   149

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

   150

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

   151

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

   152

 */

   153

static void DeleteOrderWarnings(const Vehicle* v)

   154

{

   155

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

   156

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

   157

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

   158

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

   159

}

   160

   161

   162

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

   163

 * @param tile unused

   164

 * @param p1 various bitstuffed elements

   165

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

   166

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

   167

 *                        the order will be inserted before that one

   168

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

   169

 * @param p2 packed order to insert

   170

 */

   171

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

   172

{

   173

	Vehicle *v;

   174

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

   175

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

   176

	Order new_order = UnpackOrder(p2);

   177

   178

	if (!IsVehicleIndex(veh)) return CMD_ERROR;

   179

	v = GetVehicle(veh);

   180

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

   181

   182

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

   183

	 * and has the correct flags if any */

   184

	switch (new_order.type) {

   185

		case OT_GOTO_STATION: {

   186

			const Station *st;

   187

   188

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

   189

			st = GetStation(new_order.station);

   190

   191

			if (!IsValidStation(st) ||

   192

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

   193

				return CMD_ERROR;

   194

			}

   195

   196

			switch (v->type) {

   197

				case VEH_Train:

   198

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

   199

					break;

   200

   201

				case VEH_Road:

   202

					if (v->cargo_type == CT_PASSENGERS) {

   203

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

   204

					} else {

   205

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

   206

					}

   207

					break;

   208

   209

				case VEH_Ship:

   210

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

   211

					break;

   212

   213

				case VEH_Aircraft:

   214

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

   215

					break;

   216

   217

				default: return CMD_ERROR;

   218

			}

   219

   220

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

   221

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

   222

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

   223

			switch (new_order.flags) {

   224

				case 0:

   225

				case OF_FULL_LOAD:

   226

				case OF_FULL_LOAD | OF_TRANSFER:

   227

				case OF_UNLOAD:

   228

				case OF_UNLOAD | OF_TRANSFER:

   229

				case OF_TRANSFER:

   230

					break;

   231

   232

				case OF_NON_STOP:

   233

				case OF_NON_STOP | OF_FULL_LOAD:

   234

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   235

				case OF_NON_STOP | OF_UNLOAD:

   236

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   237

				case OF_NON_STOP | OF_TRANSFER:

   238

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

   239

					break;

   240

   241

				default: return CMD_ERROR;

   242

			}

   243

			break;

   244

		}

   245

   246

		case OT_GOTO_DEPOT: {

   247

			if (v->type == VEH_Aircraft) {

   248

				const Station* st;

   249

   250

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

   251

				st = GetStation(new_order.station);

   252

   253

				if (!IsValidStation(st) ||

   254

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

   255

						!(st->facilities & FACIL_AIRPORT) ||

   256

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

   257

					return CMD_ERROR;

   258

				}

   259

			} else {

   260

				const Depot* dp;

   261

   262

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

   263

				dp = GetDepot(new_order.station);

   264

   265

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

   266

					return CMD_ERROR;

   267

   268

				switch (v->type) {

   269

					case VEH_Train:

   270

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

   271

						break;

   272

   273

					case VEH_Road:

   274

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

   275

						break;

   276

   277

					case VEH_Ship:

   278

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

   279

						break;

   280

   281

					default: return CMD_ERROR;

   282

				}

   283

			}

   284

   285

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

   286

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

   287

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

   288

			switch (new_order.flags) {

   289

				case OF_PART_OF_ORDERS:

   290

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   291

					break;

   292

   293

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   294

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   295

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

   296

					break;

   297

   298

				default: return CMD_ERROR;

   299

			}

   300

			break;

   301

		}

   302

   303

		case OT_GOTO_WAYPOINT: {

   304

			const Waypoint* wp;

   305

   306

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

   307

   308

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

   309

			wp = GetWaypoint(new_order.station);

   310

   311

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

   312

   313

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

   314

			 * [non-stop]

   315

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

   316

			switch (new_order.flags) {

   317

				case 0: break;

   318

   319

				case OF_NON_STOP:

   320

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

   321

					break;

   322

   323

				default: return CMD_ERROR;

   324

			}

   325

			break;

   326

		}

   327

   328

		default: return CMD_ERROR;

   329

	}

   330

   331

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

   332

   333

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   334

   335

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

   336

	 * handle any more then this.. */

   337

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

   338

   339

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

   340

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

   341

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

   342

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

   343

		&& !_patches.new_pathfinding_all) {

   344

   345

		int dist = DistanceManhattan(

   346

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

   347

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

   348

		);

   349

		if (dist >= 130)

   350

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   351

	}

   352

   353

	if (flags & DC_EXEC) {

   354

		Vehicle *u;

   355

		Order *new = AllocateOrder();

   356

		AssignOrder(new, new_order);

   357

   358

		/* Create new order and link in list */

   359

		if (v->orders == NULL) {

   360

			v->orders = new;

   361

		} else {

   362

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

   363

			    selected) */

   364

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

   365

   366

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

   367

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

   368

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

   369

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

   370

				    all vehicles */

   371

				SwapOrders(v->orders, new);

   372

				/* Now update the next pointers */

   373

				v->orders->next = new;

   374

			} else if (order == NULL) {

   375

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

   376

				order = GetLastVehicleOrder(v);

   377

				order->next = new;

   378

			} else {

   379

				/* Put the new order in between */

   380

				new->next = order->next;

   381

				order->next = new;

   382

			}

   383

		}

   384

   385

		u = GetFirstVehicleFromSharedList(v);

   386

		DeleteOrderWarnings(u);

   387

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

   388

			/* Increase amount of orders */

   389

			u->num_orders++;

   390

   391

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

   392

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

   393

   394

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

   395

   396

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

   397

			to update the selected order */

   398

			if (sel_ord <= u->cur_order_index) {

   399

				uint cur = u->cur_order_index + 1;

   400

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

   401

				if (cur < u->num_orders)

   402

					u->cur_order_index = cur;

   403

			}

   404

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

   405

			InvalidateVehicleOrder(u);

   406

		}

   407

   408

		/* Make sure to rebuild the whole list */

   409

		RebuildVehicleLists();

   410

	}

   411

   412

	return 0;

   413

}

   414

   415

/** Declone an order-list

   416

 * @param *dst delete the orders of this vehicle

   417

 * @param flags execution flags

   418

 */

   419

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   420

{

   421

	if (flags & DC_EXEC) {

   422

		DeleteVehicleOrders(dst);

   423

		InvalidateVehicleOrder(dst);

   424

		RebuildVehicleLists();

   425

	}

   426

	return 0;

   427

}

   428

   429

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

   430

 * @param tile unused

   431

 * @param p1 the ID of the vehicle

   432

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

   433

 */

   434

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

   435

{

   436

	Vehicle *v, *u;

   437

	VehicleID veh_id = p1;

   438

	OrderID sel_ord = p2;

   439

	Order *order;

   440

   441

	if (!IsVehicleIndex(veh_id)) return CMD_ERROR;

   442

	v = GetVehicle(veh_id);

   443

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

   444

   445

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

   446

	if (sel_ord >= v->num_orders)

   447

		return DecloneOrder(v, flags);

   448

   449

	order = GetVehicleOrder(v, sel_ord);

   450

	if (order == NULL) return CMD_ERROR;

   451

   452

	if (flags & DC_EXEC) {

   453

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

   454

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

   455

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

   456

				    Because we can have shared order, we copy the data

   457

				    from the next item over the deleted */

   458

				order = GetVehicleOrder(v, sel_ord + 1);

   459

				SwapOrders(v->orders, order);

   460

			} else {

   461

				/* Last item, so clean the list */

   462

				v->orders = NULL;

   463

			}

   464

		} else {

   465

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

   466

		}

   467

   468

		/* Give the item free */

   469

		order->type = OT_NOTHING;

   470

		order->next = NULL;

   471

   472

		u = GetFirstVehicleFromSharedList(v);

   473

		DeleteOrderWarnings(u);

   474

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

   475

			u->num_orders--;

   476

   477

			if (sel_ord < u->cur_order_index)

   478

				u->cur_order_index--;

   479

   480

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

   481

			 * also set their orders to NULL */

   482

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

   483

   484

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

   485

   486

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

   487

			 * on his order list or not */