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"

    19

    20

/**

    21

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

    22

 */

    23

static void OrderPoolNewBlock(uint start_item)

    24

{

    25

	Order *order;

    26

    27

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

    28

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

    29

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

    30

}

    31

    32

DEFINE_OLD_POOL(Order, Order, OrderPoolNewBlock, NULL)

    33

    34

/**

    35

 *

    36

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

    37

 *

    38

 */

    39

Order UnpackOldOrder(uint16 packed)

    40

{

    41

	Order order;

    42

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

    43

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

    44

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

    45

	order.next    = NULL;

    46

    47

	order.refit_cargo   = CT_NO_REFIT;

    48

	order.refit_subtype = 0;

    49

	order.index = 0; // avoid compiler warning

    50

    51

	// Sanity check

    52

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

    53

	if (!order.IsValid() && (order.flags != 0 || order.dest != 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  = (OrderType)GB(packed, 0, 4);

    70

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

    71

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

    72

	order.next  = NULL;

    73

	order.index = 0; // avoid compiler warning

    74

	order.refit_cargo   = CT_NO_REFIT;

    75

	order.refit_subtype = 0;

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

   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 + 1U < GetOrderPoolSize()) ? GetOrder(order->index + 1U) : NULL) {

   120

		if (!order->IsValid()) {

   121

			OrderID index = order->index;

   122

   123

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

   124

			order->index = index;

   125

			order->next = NULL;

   126

			order->refit_cargo   = CT_NO_REFIT;

   127

			order->refit_subtype = 0;

   128

   129

			return order;

   130

		}

   131

	}

   132

   133

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

   134

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

   135

   136

	return NULL;

   137

}

   138

   139

/**

   140

 *

   141

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

   142

 *   This function makes sure that the index is maintained correctly

   143

 *

   144

 */

   145

void AssignOrder(Order *order, Order data)

   146

{

   147

	order->type  = data.type;

   148

	order->flags = data.flags;

   149

	order->dest  = data.dest;

   150

   151

	order->refit_cargo   = data.refit_cargo;

   152

	order->refit_subtype = data.refit_subtype;

   153

}

   154

   155

   156

/**

   157

 * Delete all news items regarding defective orders about a vehicle

   158

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

   159

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

   160

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

   161

 */

   162

static void DeleteOrderWarnings(const Vehicle* v)

   163

{

   164

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

   165

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

   166

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

   167

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

   168

}

   169

   170

   171

static TileIndex GetOrderLocation(const Order& o)

   172

{

   173

	switch (o.type) {

   174

		default: NOT_REACHED();

   175

		case OT_GOTO_STATION: return GetStation(o.dest)->xy;

   176

		case OT_GOTO_DEPOT:   return GetDepot(o.dest)->xy;

   177

	}

   178

}

   179

   180

   181

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

   182

 * @param tile unused

   183

 * @param p1 various bitstuffed elements

   184

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

   185

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

   186

 *                        the order will be inserted before that one

   187

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

   188

 * @param p2 packed order to insert

   189

 */

   190

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

   191

{

   192

	Vehicle *v;

   193

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

   194

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

   195

	Order new_order = UnpackOrder(p2);

   196

   197

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   198

   199

	v = GetVehicle(veh);

   200

   201

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

   202

   203

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

   204

	 * and has the correct flags if any */

   205

	switch (new_order.type) {

   206

		case OT_GOTO_STATION: {

   207

			const Station *st;

   208

   209

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

   210

			st = GetStation(new_order.dest);

   211

   212

			if (st->owner != OWNER_NONE && !CheckOwnership(st->owner)) {

   213

				return CMD_ERROR;

   214

			}

   215

   216

			switch (v->type) {

   217

				case VEH_TRAIN:

   218

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

   219

					break;

   220

   221

				case VEH_ROAD:

   223

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

   224

					} else {

   225

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

   226

					}

   227

					break;

   228

   229

				case VEH_SHIP:

   230

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

   231

					break;

   232

   233

				case VEH_AIRCRAFT:

   234

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

   235

					break;

   236

   237

				default: return CMD_ERROR;

   238

			}

   239

   240

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

   241

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

   242

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

   243

			switch (new_order.flags) {

   244

				case 0:

   245

				case OF_FULL_LOAD:

   246

				case OF_FULL_LOAD | OF_TRANSFER:

   247

				case OF_UNLOAD:

   248

				case OF_UNLOAD | OF_TRANSFER:

   249

				case OF_TRANSFER:

   250

					break;

   251

   252

				case OF_NON_STOP:

   253

				case OF_NON_STOP | OF_FULL_LOAD:

   254

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   255

				case OF_NON_STOP | OF_UNLOAD:

   256

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   257

				case OF_NON_STOP | OF_TRANSFER:

   258

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

   259

					break;

   260

   261

				default: return CMD_ERROR;

   262

			}

   263

			break;

   264

		}

   265

   266

		case OT_GOTO_DEPOT: {

   267

			if (v->type == VEH_AIRCRAFT) {

   268

				const Station* st;

   269

   270

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

   271

				st = GetStation(new_order.dest);

   272

   273

				if (!CheckOwnership(st->owner) ||

   274

						!(st->facilities & FACIL_AIRPORT) ||

   275

						st->Airport()->nof_depots == 0) {

   276

					return CMD_ERROR;

   277

				}

   278

			} else {

   279

				const Depot* dp;

   280

   281

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

   282

				dp = GetDepot(new_order.dest);

   283

   284

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

   285

   286

				switch (v->type) {

   287

					case VEH_TRAIN:

   288

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

   289

						break;

   290

   291

					case VEH_ROAD:

   292

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

   293

						break;

   294

   295

					case VEH_SHIP:

   296

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

   297

						break;

   298

   299

					default: return CMD_ERROR;

   300

				}

   301

			}

   302

   303

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

   304

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

   305

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

   306

			switch (new_order.flags) {

   307

				case OF_PART_OF_ORDERS:

   308

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   309

					break;

   310

   311

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   312

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   313

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

   314

					break;

   315

   316

				default: return CMD_ERROR;

   317

			}

   318

			break;

   319

		}

   320

   321

		case OT_GOTO_WAYPOINT: {

   322

			const Waypoint* wp;

   323

   324

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

   325

   326

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

   327

			wp = GetWaypoint(new_order.dest);

   328

   329

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

   330

   331

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

   332

			 * [non-stop]

   333

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

   334

			switch (new_order.flags) {

   335

				case 0: break;

   336

   337

				case OF_NON_STOP:

   338

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

   339

					break;

   340

   341

				default: return CMD_ERROR;

   342

			}

   343

			break;

   344

		}

   345

   346

		default: return CMD_ERROR;

   347

	}

   348

   349

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

   350

   351

	if (!HasOrderPoolFree(1)) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   352

   353

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

   354

	 * handle any more then this.. */

   355

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

   356

   357

	if (v->type == VEH_SHIP &&

   358

			IsHumanPlayer(v->owner) &&

   359

			!_patches.new_pathfinding_all) {

   360

		// Make sure the new destination is not too far away from the previous

   361

		const Order *prev = NULL;

   362

		uint n = 0;

   363

   364

		/* Find the last goto station or depot order before the insert location.

   365

		 * If the order is to be inserted at the beginning of the order list this

   366

		 * finds the last order in the list. */

   367

		for (const Order *o = v->orders; o != NULL; o = o->next) {

   368

			if (o->type == OT_GOTO_STATION || o->type == OT_GOTO_DEPOT) prev = o;

   369

			if (++n == sel_ord && prev != NULL) break;

   370

		}

   371

		if (prev != NULL) {

   372

			uint dist = DistanceManhattan(

   373

				GetOrderLocation(*prev),

   374

				GetOrderLocation(new_order)

   375

			);

   376

			if (dist >= 130) {

   377

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   378

			}

   379

		}

   380

	}

   381

   382

	if (flags & DC_EXEC) {

   383

		Vehicle *u;

   384

		Order *new_o = AllocateOrder();

   385

		AssignOrder(new_o, new_order);

   386

   387

		/* Create new order and link in list */

   388

		if (v->orders == NULL) {

   389

			v->orders = new_o;

   390

		} else {

   391

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

   392

			    selected) */

   393

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

   394

   395

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

   396

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

   397

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

   398

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

   399

				    all vehicles */

   400

				SwapOrders(v->orders, new_o);

   401

				/* Now update the next pointers */

   402

				v->orders->next = new_o;

   403

			} else if (order == NULL) {

   404

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

   405

				order = GetLastVehicleOrder(v);

   406

				order->next = new_o;

   407

			} else {

   408

				/* Put the new order in between */

   409

				new_o->next = order->next;

   410

				order->next = new_o;

   411

			}

   412

		}

   413

   414

		u = GetFirstVehicleFromSharedList(v);

   415

		DeleteOrderWarnings(u);

   416

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

   417

			/* Increase amount of orders */

   418

			u->num_orders++;

   419

   420

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

   421

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

   422

   423

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

   424

   425

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

   426

			to update the selected order */

   427

			if (sel_ord <= u->cur_order_index) {

   428

				uint cur = u->cur_order_index + 1;

   429

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

   430

				if (cur < u->num_orders)

   431

					u->cur_order_index = cur;

   432

			}

   433

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

   434

			InvalidateVehicleOrder(u);

   435

		}

   436

   437

		/* Make sure to rebuild the whole list */

   438

		RebuildVehicleLists();

   439

	}

   440

   441

	return 0;

   442

}

   443

   444

/** Declone an order-list

   445

 * @param *dst delete the orders of this vehicle

   446

 * @param flags execution flags

   447

 */

   448

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   449

{

   450

	if (flags & DC_EXEC) {

   451

		DeleteVehicleOrders(dst);

   452

		InvalidateVehicleOrder(dst);

   453

		RebuildVehicleLists();

   454

	}

   455

	return 0;

   456

}

   457

   458

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

   459

 * @param tile unused

   460

 * @param p1 the ID of the vehicle

   461

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

   462

 */

   463

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

   464

{

   465

	Vehicle *v, *u;

   466

	VehicleID veh_id = p1;

   467

	VehicleOrderID sel_ord = p2;

   468

	Order *order;

   469

   470

	if (!IsValidVehicleID(veh_id)) return CMD_ERROR;

   471

   472

	v = GetVehicle(veh_id);

   473

   474

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

   475

   476

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

   477

	if (sel_ord >= v->num_orders)

   478

		return DecloneOrder(v, flags);

   479

   480

	order = GetVehicleOrder(v, sel_ord);

   481

	if (order == NULL) return CMD_ERROR;

   482

   483

	if (flags & DC_EXEC) {

   484