1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order.h"

     8

#include "airport.h"

     9

#include "vehicle.h"

    10

#include "depot.h"

    11

#include "functions.h"

    12

#include "table/strings.h"

    13

#include "waypoint.h"

    14

#include "command.h"

    15

#include "station.h"

    16

#include "player.h"

    17

#include "news.h"

    18

#include "saveload.h"

    19

#include "vehicle_gui.h"

    20

#include "cargotype.h"

    21

    22

/**

    23

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

    24

 */

    25

static void OrderPoolNewBlock(uint start_item)

    26

{

    27

	Order *order;

    28

    29

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

    30

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

    31

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

    32

}

    33

    34

DEFINE_OLD_POOL(Order, Order, OrderPoolNewBlock, NULL)

    35

    36

/**

    37

 *

    38

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

    39

 *

    40

 */

    41

Order UnpackOldOrder(uint16 packed)

    42

{

    43

	Order order;

    44

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

    45

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

    46

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

    47

	order.next    = NULL;

    48

    49

	order.refit_cargo   = CT_NO_REFIT;

    50

	order.refit_subtype = 0;

    51

	order.index = 0; // avoid compiler warning

    52

    53

	// Sanity check

    54

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

    55

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

    56

		order.type = OT_DUMMY;

    57

		order.flags = 0;

    58

	}

    59

    60

	return order;

    61

}

    62

    63

/**

    64

 *

    65

 * Unpacks a order from savegames with version 4 and lower

    66

 *

    67

 */

    68

static Order UnpackVersion4Order(uint16 packed)

    69

{

    70

	Order order;

    71

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

    72

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

    73

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

    74

	order.next  = NULL;

    75

	order.index = 0; // avoid compiler warning

    76

	order.refit_cargo   = CT_NO_REFIT;

    77

	order.refit_subtype = 0;

    78

	return order;

    79

}

    80

    81

/**

    82

 *

    83

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

    84

 *

    85

 */

    86

void InvalidateVehicleOrder(const Vehicle *v)

    87

{

    88

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    89

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    90

}

    91

    92

/**

    93

 *

    94

 * Swap two orders

    95

 *

    96

 */

    97

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

    98

{

    99

	Order temp_order;

   100

   101

	temp_order = *order1;

   102

	AssignOrder(order1, *order2);

   103

	order1->next = order2->next;

   104

	AssignOrder(order2, temp_order);

   105

	order2->next = temp_order.next;

   106

}

   107

   108

/**

   109

 *

   110

 * Allocate a new order

   111

 *

   112

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

   113

 *

   114

 */

   115

static Order *AllocateOrder()

   116

{

   117

	Order *order;

   118

   119

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

   120

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

   121

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

   122

		if (!order->IsValid()) {

   123

			OrderID index = order->index;

   124

   125

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

   126

			order->index = index;

   127

			order->next = NULL;

   128

			order->refit_cargo   = CT_NO_REFIT;

   129

			order->refit_subtype = 0;

   130

   131

			return order;

   132

		}

   133

	}

   134

   135

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

   136

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

   137

   138

	return NULL;

   139

}

   140

   141

/**

   142

 *

   143

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

   144

 *   This function makes sure that the index is maintained correctly

   145

 *

   146

 */

   147

void AssignOrder(Order *order, Order data)

   148

{

   149

	order->type  = data.type;

   150

	order->flags = data.flags;

   151

	order->dest  = data.dest;

   152

   153

	order->refit_cargo   = data.refit_cargo;

   154

	order->refit_subtype = data.refit_subtype;

   155

}

   156

   157

   158

/**

   159

 * Delete all news items regarding defective orders about a vehicle

   160

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

   161

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

   162

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

   163

 */

   164

static void DeleteOrderWarnings(const Vehicle* v)

   165

{

   166

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

   167

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

   168

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

   169

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

   170

}

   171

   172

   173

static TileIndex GetOrderLocation(const Order& o)

   174

{

   175

	switch (o.type) {

   176

		default: NOT_REACHED();

   177

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

   178

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

   179

	}

   180

}

   181

   182

   183

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

   184

 * @param tile unused

   185

 * @param flags operation to perform

   186

 * @param p1 various bitstuffed elements

   187

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

   188

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

   189

 *                        the order will be inserted before that one

   190

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

   191

 * @param p2 packed order to insert

   192

 */

   194

{

   195

	Vehicle *v;

   196

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

   197

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

   198

	Order new_order = UnpackOrder(p2);

   199

   200

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   201

   202

	v = GetVehicle(veh);

   203

   204

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

   205

   206

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

   207

	 * and has the correct flags if any */

   208

	switch (new_order.type) {

   209

		case OT_GOTO_STATION: {

   210

			const Station *st;

   211

   212

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

   213

			st = GetStation(new_order.dest);

   214

   215

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

   216

				return CMD_ERROR;

   217

			}

   218

   219

			switch (v->type) {

   220

				case VEH_TRAIN:

   221

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

   222

					break;

   223

   224

				case VEH_ROAD:

   225

					if (IsCargoInClass(v->cargo_type, CC_PASSENGERS)) {

   226

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

   227

					} else {

   228

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

   229

					}

   230

					break;

   231

   232

				case VEH_SHIP:

   233

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

   234

					break;

   235

   236

				case VEH_AIRCRAFT:

   237

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

   238

					break;

   239

   240

				default: return CMD_ERROR;

   241

			}

   242

   243

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

   244

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

   245

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

   246

			switch (new_order.flags) {

   247

				case 0:

   248

				case OF_FULL_LOAD:

   249

				case OF_FULL_LOAD | OF_TRANSFER:

   250

				case OF_UNLOAD:

   251

				case OF_UNLOAD | OF_TRANSFER:

   252

				case OF_TRANSFER:

   253

					break;

   254

   255

				case OF_NON_STOP:

   256

				case OF_NON_STOP | OF_FULL_LOAD:

   257

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   258

				case OF_NON_STOP | OF_UNLOAD:

   259

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   260

				case OF_NON_STOP | OF_TRANSFER:

   261

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

   262

					break;

   263

   264

				default: return CMD_ERROR;

   265

			}

   266

			break;

   267

		}

   268

   269

		case OT_GOTO_DEPOT: {

   270

			if (v->type == VEH_AIRCRAFT) {

   271

				const Station* st;

   272

   273

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

   274

				st = GetStation(new_order.dest);

   275

   276

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

   277

						!(st->facilities & FACIL_AIRPORT) ||

   278

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

   279

					return CMD_ERROR;

   280

				}

   281

			} else {

   282

				const Depot* dp;

   283

   284

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

   285

				dp = GetDepot(new_order.dest);

   286

   287

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

   288

   289

				switch (v->type) {

   290

					case VEH_TRAIN:

   291

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

   292

						break;

   293

   294

					case VEH_ROAD:

   295

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

   296

						break;

   297

   298

					case VEH_SHIP:

   299

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

   300

						break;

   301

   302

					default: return CMD_ERROR;

   303

				}

   304

			}

   305

   306

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

   307

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

   308

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

   309

			switch (new_order.flags) {

   310

				case OF_PART_OF_ORDERS:

   311

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   312

					break;

   313

   314

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   315

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   316

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

   317

					break;

   318

   319

				default: return CMD_ERROR;

   320

			}

   321

			break;

   322

		}

   323

   324

		case OT_GOTO_WAYPOINT: {

   325

			const Waypoint* wp;

   326

   327

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

   328

   329

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

   330

			wp = GetWaypoint(new_order.dest);

   331

   332

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

   333

   334

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

   335

			 * [non-stop]

   336

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

   337

			switch (new_order.flags) {

   338

				case 0: break;

   339

   340

				case OF_NON_STOP:

   341

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

   342

					break;

   343

   344

				default: return CMD_ERROR;

   345

			}

   346

			break;

   347

		}

   348

   349

		default: return CMD_ERROR;

   350

	}

   351

   352

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

   353

   354

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

   355

   356

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

   357

	 * handle any more then this.. */

   358

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

   359

   360

	if (v->type == VEH_SHIP &&

   361

			IsHumanPlayer(v->owner) &&

   362

			!_patches.new_pathfinding_all) {

   363

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

   364

		const Order *prev = NULL;

   365

		uint n = 0;

   366

   367

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

   368

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

   369

		 * finds the last order in the list. */

   370

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

   371

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

   372

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

   373

		}

   374

		if (prev != NULL) {

   375

			uint dist = DistanceManhattan(

   376

				GetOrderLocation(*prev),

   377

				GetOrderLocation(new_order)

   378

			);

   379

			if (dist >= 130) {

   380

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   381

			}

   382

		}

   383

	}

   384

   385

	if (flags & DC_EXEC) {

   386

		Vehicle *u;

   387

		Order *new_o = AllocateOrder();

   388

		AssignOrder(new_o, new_order);

   389

   390

		/* Create new order and link in list */

   391

		if (v->orders == NULL) {

   392

			v->orders = new_o;

   393

		} else {

   394

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

   395

			    selected) */

   396

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

   397

   398

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

   399

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

   400

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

   401

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

   402

				    all vehicles */

   403

				SwapOrders(v->orders, new_o);

   404

				/* Now update the next pointers */

   405

				v->orders->next = new_o;

   406

			} else if (order == NULL) {

   407

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

   408

				order = GetLastVehicleOrder(v);

   409

				order->next = new_o;

   410

			} else {

   411

				/* Put the new order in between */

   412

				new_o->next = order->next;

   413

				order->next = new_o;

   414

			}

   415

		}

   416

   417

		u = GetFirstVehicleFromSharedList(v);

   418

		DeleteOrderWarnings(u);

   419

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

   420

			/* Increase amount of orders */

   421

			u->num_orders++;

   422

   423

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

   424

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

   425

   426

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

   427

   428

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

   429

			to update the selected order */

   430

			if (sel_ord <= u->cur_order_index) {

   431

				uint cur = u->cur_order_index + 1;

   432

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

   433

				if (cur < u->num_orders)

   434

					u->cur_order_index = cur;

   435

			}

   436

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

   437

			InvalidateVehicleOrder(u);

   438

		}

   439

   440

		/* Make sure to rebuild the whole list */

   441

		RebuildVehicleLists();

   442

	}

   443

   444

	return 0;

   445

}

   446

   447

/** Declone an order-list

   448

 * @param *dst delete the orders of this vehicle

   449

 * @param flags execution flags

   450

 */

   452

{

   453

	if (flags & DC_EXEC) {

   454

		DeleteVehicleOrders(dst);

   455

		InvalidateVehicleOrder(dst);

   456

		RebuildVehicleLists();

   457

	}

   458

	return 0;

   459

}

   460

   461

/**

   462

 * Remove the VehicleList that shows all the vehicles with the same shared

   463

 *  orders.

   464

 */

   465

static void RemoveSharedOrderVehicleList(Vehicle *v)

   466

{

   467

	assert(v->orders != NULL);

   468

	WindowClass window_class = WC_NONE;

   469

   470

	switch (v->type) {

   471

		default: NOT_REACHED();

   472

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   473

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   474

		case VEH_SHIP:     window_class = WC_SHIPS_LIST;    break;

   475

		case VEH_AIRCRAFT: window_class = WC_AIRCRAFT_LIST; break;

   476

	}

   477

	DeleteWindowById(window_class, (v->orders->index << 16) | (v->type << 11) | VLW_SHARED_ORDERS | v->owner);

   478

}

   479

   480

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

   481

 * @param tile unused

   482

 * @param flags operation to perform

   483

 * @param p1 the ID of the vehicle

   484

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