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

/**

    20

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

    21

 */

    22

static void OrderPoolNewBlock(uint start_item)

    23

{

    24

	Order *order;

    25

    26

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

    27

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

    28

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

    29

}

    30

    31

DEFINE_OLD_POOL(Order, Order, OrderPoolNewBlock, NULL)

    32

    33

/**

    34

 *

    35

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

    36

 *

    37

 */

    38

Order UnpackOldOrder(uint16 packed)

    39

{

    40

	Order order;

    41

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

    42

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

    43

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

    44

	order.next    = NULL;

    45

    46

	order.refit_cargo   = CT_NO_REFIT;

    47

	order.refit_subtype = 0;

    48

	order.index = 0; // avoid compiler warning

    49

    50

	// Sanity check

    51

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

    52

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

    53

		order.type = OT_DUMMY;

    54

		order.flags = 0;

    55

	}

    56

    57

	return order;

    58

}

    59

    60

/**

    61

 *

    62

 * Unpacks a order from savegames with version 4 and lower

    63

 *

    64

 */

    65

static Order UnpackVersion4Order(uint16 packed)

    66

{

    67

	Order order;

    68

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

    69

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

    70

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

    71

	order.next  = NULL;

    72

	order.index = 0; // avoid compiler warning

    73

	order.refit_cargo   = CT_NO_REFIT;

    74

	order.refit_subtype = 0;

    75

	return order;

    76

}

    77

    78

/**

    79

 *

    80

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

    81

 *

    82

 */

    83

void InvalidateVehicleOrder(const Vehicle *v)

    84

{

    85

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    86

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    87

}

    88

    89

/**

    90

 *

    91

 * Swap two orders

    92

 *

    93

 */

    94

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

    95

{

    96

	Order temp_order;

    97

    98

	temp_order = *order1;

    99

	AssignOrder(order1, *order2);

   100

	order1->next = order2->next;

   101

	AssignOrder(order2, temp_order);

   102

	order2->next = temp_order.next;

   103

}

   104

   105

/**

   106

 *

   107

 * Allocate a new order

   108

 *

   109

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

   110

 *

   111

 */

   112

static Order *AllocateOrder(void)

   113

{

   114

	Order *order;

   115

   116

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

   117

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

   118

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

   119

		if (!IsValidOrder(order)) {

   120

			OrderID index = order->index;

   121

   122

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

   123

			order->index = index;

   124

			order->next = NULL;

   125

			order->refit_cargo   = CT_NO_REFIT;

   126

			order->refit_subtype = 0;

   127

   128

			return order;

   129

		}

   130

	}

   131

   132

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

   133

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

   134

   135

	return NULL;

   136

}

   137

   138

/**

   139

 *

   140

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

   141

 *   This function makes sure that the index is maintained correctly

   142

 *

   143

 */

   144

void AssignOrder(Order *order, Order data)

   145

{

   146

	order->type  = data.type;

   147

	order->flags = data.flags;

   148

	order->dest  = data.dest;

   149

   150

	order->refit_cargo   = data.refit_cargo;

   151

	order->refit_subtype = data.refit_subtype;

   152

}

   153

   154

   155

/**

   156

 * Delete all news items regarding defective orders about a vehicle

   157

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

   158

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

   159

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

   160

 */

   161

static void DeleteOrderWarnings(const Vehicle* v)

   162

{

   163

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

   164

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

   165

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

   166

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

   167

}

   168

   169

   170

static TileIndex GetOrderLocation(const Order *o)

   171

{

   172

	switch (o->type) {

   173

		default: NOT_REACHED();

   174

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

   175

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

   176

	}

   177

}

   178

   179

   180

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

   181

 * @param tile unused

   182

 * @param p1 various bitstuffed elements

   183

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

   184

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

   185

 *                        the order will be inserted before that one

   186

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

   187

 * @param p2 packed order to insert

   188

 */

   189

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

   190

{

   191

	Vehicle *v;

   192

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

   193

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

   194

	Order new_order = UnpackOrder(p2);

   195

   196

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   197

   198

	v = GetVehicle(veh);

   199

   200

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

   201

   202

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

   203

	 * and has the correct flags if any */

   204

	switch (new_order.type) {

   205

		case OT_GOTO_STATION: {

   206

			const Station *st;

   207

   208

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

   209

			st = GetStation(new_order.dest);

   210

   211

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

   212

				return CMD_ERROR;

   213

			}

   214

   215

			switch (v->type) {

   216

				case VEH_Train:

   217

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

   218

					break;

   219

   220

				case VEH_Road:

   221

					if (v->cargo_type == CT_PASSENGERS) {

   222

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

   223

					} else {

   224

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

   225

					}

   226

					break;

   227

   228

				case VEH_Ship:

   229

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

   230

					break;

   231

   232

				case VEH_Aircraft:

   233

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

   234

					break;

   235

   236

				default: return CMD_ERROR;

   237

			}

   238

   239

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

   240

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

   241

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

   242

			switch (new_order.flags) {

   243

				case 0:

   244

				case OF_FULL_LOAD:

   245

				case OF_FULL_LOAD | OF_TRANSFER:

   246

				case OF_UNLOAD:

   247

				case OF_UNLOAD | OF_TRANSFER:

   248

				case OF_TRANSFER:

   249

					break;

   250

   251

				case OF_NON_STOP:

   252

				case OF_NON_STOP | OF_FULL_LOAD:

   253

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   254

				case OF_NON_STOP | OF_UNLOAD:

   255

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   256

				case OF_NON_STOP | OF_TRANSFER:

   257

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

   258

					break;

   259

   260

				default: return CMD_ERROR;

   261

			}

   262

			break;

   263

		}

   264

   265

		case OT_GOTO_DEPOT: {

   266

			if (v->type == VEH_Aircraft) {

   267

				const Station* st;

   268

   269

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

   270

				st = GetStation(new_order.dest);

   271

   272

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

   273

						!(st->facilities & FACIL_AIRPORT) ||

   274

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

   275

					return CMD_ERROR;

   276

				}

   277

			} else {

   278

				const Depot* dp;

   279

   280

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

   281

				dp = GetDepot(new_order.dest);

   282

   283

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

   284

   285

				switch (v->type) {

   286

					case VEH_Train:

   287

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

   288

						break;

   289

   290

					case VEH_Road:

   291

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

   292

						break;

   293

   294

					case VEH_Ship:

   295

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

   296

						break;

   297

   298

					default: return CMD_ERROR;

   299

				}

   300

			}

   301

   302

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

   303

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

   304

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

   305

			switch (new_order.flags) {

   306

				case OF_PART_OF_ORDERS:

   307

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   308

					break;

   309

   310

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   311

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   312

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

   313

					break;

   314

   315

				default: return CMD_ERROR;

   316

			}

   317

			break;

   318

		}

   319

   320

		case OT_GOTO_WAYPOINT: {

   321

			const Waypoint* wp;

   322

   323

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

   324

   325

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

   326

			wp = GetWaypoint(new_order.dest);

   327

   328

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

   329

   330

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

   331

			 * [non-stop]

   332

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

   333

			switch (new_order.flags) {

   334

				case 0: break;

   335

   336

				case OF_NON_STOP:

   337

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

   338

					break;

   339

   340

				default: return CMD_ERROR;

   341

			}

   342

			break;

   343

		}

   344

   345

		default: return CMD_ERROR;

   346

	}

   347

   348

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

   349

   350

	if (IsOrderPoolFull()) return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   351

   352

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

   353

	 * handle any more then this.. */

   354

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

   355

   356

	if (v->type == VEH_Ship &&

   357

			IsHumanPlayer(v->owner) &&

   358

			!_patches.new_pathfinding_all) {

   359

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

   360

		const Order *prev = NULL;

   361

		const Order *o;

   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 (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 = AllocateOrder();

   385

		AssignOrder(new, new_order);

   386

   387

		/* Create new order and link in list */

   388

		if (v->orders == NULL) {

   389

			v->orders = new;

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

   401

				/* Now update the next pointers */

   402

				v->orders->next = new;

   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;

   407

			} else {

   408

				/* Put the new order in between */

   409

				new->next = order->next;

   410

				order->next = new;

   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

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

   485

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

   486

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