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.wait_time     = 0;

    52

	order.travel_time   = 0;

    53

	order.index = 0; // avoid compiler warning

    54

    55

	// Sanity check

    56

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

    57

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

    58

		order.type = OT_DUMMY;

    59

		order.flags = 0;

    60

	}

    61

    62

	return order;

    63

}

    64

    65

/**

    66

 *

    67

 * Unpacks a order from savegames with version 4 and lower

    68

 *

    69

 */

    70

static Order UnpackVersion4Order(uint16 packed)

    71

{

    72

	Order order;

    73

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

    74

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

    75

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

    76

	order.next  = NULL;

    77

	order.index = 0; // avoid compiler warning

    78

	order.refit_cargo   = CT_NO_REFIT;

    79

	order.refit_subtype = 0;

    80

	order.wait_time     = 0;

    81

	order.travel_time   = 0;

    82

	return order;

    83

}

    84

    85

/**

    86

 *

    87

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

    88

 *

    89

 */

    90

void InvalidateVehicleOrder(const Vehicle *v)

    91

{

    92

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

    93

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

    94

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

    95

}

    96

    97

/**

    98

 *

    99

 * Swap two orders

   100

 *

   101

 */

   102

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

   103

{

   104

	Order temp_order;

   105

   106

	temp_order = *order1;

   107

	AssignOrder(order1, *order2);

   108

	order1->next = order2->next;

   109

	AssignOrder(order2, temp_order);

   110

	order2->next = temp_order.next;

   111

}

   112

   113

/**

   114

 *

   115

 * Allocate a new order

   116

 *

   117

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

   118

 *

   119

 */

   120

static Order *AllocateOrder()

   121

{

   122

	Order *order;

   123

   124

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

   125

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

   126

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

   127

		if (!order->IsValid()) {

   128

			OrderID index = order->index;

   129

   130

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

   131

			order->index = index;

   132

			order->next = NULL;

   133

			order->refit_cargo   = CT_NO_REFIT;

   134

			order->refit_subtype = 0;

   135

			order->wait_time     = 0;

   136

			order->travel_time   = 0;

   137

   138

			return order;

   139

		}

   140

	}

   141

   142

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

   143

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

   144

   145

	return NULL;

   146

}

   147

   148

/**

   149

 *

   150

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

   151

 *   This function makes sure that the index is maintained correctly

   152

 *

   153

 */

   154

void AssignOrder(Order *order, Order data)

   155

{

   156

	order->type  = data.type;

   157

	order->flags = data.flags;

   158

	order->dest  = data.dest;

   159

   160

	order->refit_cargo   = data.refit_cargo;

   161

	order->refit_subtype = data.refit_subtype;

   162

   163

	order->wait_time   = data.wait_time;

   164

	order->travel_time = data.travel_time;

   165

}

   166

   167

   168

/**

   169

 * Delete all news items regarding defective orders about a vehicle

   170

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

   171

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

   172

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

   173

 */

   174

static void DeleteOrderWarnings(const Vehicle* v)

   175

{

   176

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

   177

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

   178

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

   179

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

   180

}

   181

   182

   183

static TileIndex GetOrderLocation(const Order& o)

   184

{

   185

	switch (o.type) {

   186

		default: NOT_REACHED();

   187

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

   188

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

   189

	}

   190

}

   191

   192

   193

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

   194

 * @param tile unused

   195

 * @param flags operation to perform

   196

 * @param p1 various bitstuffed elements

   197

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

   198

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

   199

 *                        the order will be inserted before that one

   200

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

   201

 * @param p2 packed order to insert

   202

 */

   203

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

   204

{

   205

	Vehicle *v;

   206

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

   207

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

   208

	Order new_order = UnpackOrder(p2);

   209

   210

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   211

   212

	v = GetVehicle(veh);

   213

   214

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

   215

   216

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

   217

	 * and has the correct flags if any */

   218

	switch (new_order.type) {

   219

		case OT_GOTO_STATION: {

   220

			const Station *st;

   221

   222

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

   223

			st = GetStation(new_order.dest);

   224

   225

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

   226

				return CMD_ERROR;

   227

			}

   228

   229

			switch (v->type) {

   230

				case VEH_TRAIN:

   231

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

   232

					break;

   233

   234

				case VEH_ROAD:

   235

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

   236

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

   237

					} else {

   238

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

   239

					}

   240

					break;

   241

   242

				case VEH_SHIP:

   243

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

   244

					break;

   245

   246

				case VEH_AIRCRAFT:

   247

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

   248

					break;

   249

   250

				default: return CMD_ERROR;

   251

			}

   252

   253

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

   254

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

   255

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

   256

			switch (new_order.flags) {

   257

				case 0:

   258

				case OF_FULL_LOAD:

   259

				case OF_FULL_LOAD | OF_TRANSFER:

   260

				case OF_UNLOAD:

   261

				case OF_UNLOAD | OF_TRANSFER:

   262

				case OF_TRANSFER:

   263

					break;

   264

   265

				case OF_NON_STOP:

   266

				case OF_NON_STOP | OF_FULL_LOAD:

   267

				case OF_NON_STOP | OF_FULL_LOAD | OF_TRANSFER:

   268

				case OF_NON_STOP | OF_UNLOAD:

   269

				case OF_NON_STOP | OF_UNLOAD | OF_TRANSFER:

   270

				case OF_NON_STOP | OF_TRANSFER:

   271

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

   272

					break;

   273

   274

				default: return CMD_ERROR;

   275

			}

   276

			break;

   277

		}

   278

   279

		case OT_GOTO_DEPOT: {

   280

			if (v->type == VEH_AIRCRAFT) {

   281

				const Station* st;

   282

   283

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

   284

				st = GetStation(new_order.dest);

   285

   286

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

   287

						!(st->facilities & FACIL_AIRPORT) ||

   288

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

   289

					return CMD_ERROR;

   290

				}

   291

			} else {

   292

				const Depot* dp;

   293

   294

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

   295

				dp = GetDepot(new_order.dest);

   296

   297

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

   298

   299

				switch (v->type) {

   300

					case VEH_TRAIN:

   301

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

   302

						break;

   303

   304

					case VEH_ROAD:

   305

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

   306

						break;

   307

   308

					case VEH_SHIP:

   309

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

   310

						break;

   311

   312

					default: return CMD_ERROR;

   313

				}

   314

			}

   315

   316

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

   317

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

   318

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

   319

			switch (new_order.flags) {

   320

				case OF_PART_OF_ORDERS:

   321

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   322

					break;

   323

   324

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   325

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   326

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

   327

					break;

   328

   329

				default: return CMD_ERROR;

   330

			}

   331

			break;

   332

		}

   333

   334

		case OT_GOTO_WAYPOINT: {

   335

			const Waypoint* wp;

   336

   337

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

   338

   339

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

   340

			wp = GetWaypoint(new_order.dest);

   341

   342

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

   343

   344

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

   345

			 * [non-stop]

   346

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

   347

			switch (new_order.flags) {

   348

				case 0: break;

   349

   350

				case OF_NON_STOP:

   351

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

   352

					break;

   353

   354

				default: return CMD_ERROR;

   355

			}

   356

			break;

   357

		}

   358

   359

		default: return CMD_ERROR;

   360

	}

   361

   362

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

   363

   364

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

   365

   366

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

   367

	 * handle any more then this.. */

   368

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

   369

   370

	if (v->type == VEH_SHIP &&

   371

			IsHumanPlayer(v->owner) &&

   372

			!_patches.new_pathfinding_all) {

   373

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

   374

		const Order *prev = NULL;

   375

		uint n = 0;

   376

   377

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

   378

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

   379

		 * finds the last order in the list. */

   380

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

   381

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

   382

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

   383

		}

   384

		if (prev != NULL) {

   385

			uint dist = DistanceManhattan(

   386

				GetOrderLocation(*prev),

   387

				GetOrderLocation(new_order)

   388

			);

   389

			if (dist >= 130) {

   390

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   391

			}

   392

		}

   393

	}

   394

   395

	if (flags & DC_EXEC) {

   396

		Vehicle *u;

   397

		Order *new_o = AllocateOrder();

   398

		AssignOrder(new_o, new_order);

   399

   400

		/* Create new order and link in list */

   401

		if (v->orders == NULL) {

   402

			v->orders = new_o;

   403

		} else {

   404

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

   405

			    selected) */

   406

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

   407

   408

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

   409

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

   410

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

   411

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

   412

				    all vehicles */

   413

				SwapOrders(v->orders, new_o);

   414

				/* Now update the next pointers */

   415

				v->orders->next = new_o;

   416

			} else if (order == NULL) {

   417

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

   418

				order = GetLastVehicleOrder(v);

   419

				order->next = new_o;

   420

			} else {

   421

				/* Put the new order in between */

   422

				new_o->next = order->next;

   423

				order->next = new_o;

   424

			}

   425

		}

   426

   427

		u = GetFirstVehicleFromSharedList(v);

   428

		DeleteOrderWarnings(u);

   429

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

   430

			/* Increase amount of orders */

   431

			u->num_orders++;

   432

   433

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

   434

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

   435

   436

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

   437

   438

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

   439

			to update the selected order */

   440

			if (sel_ord <= u->cur_order_index) {

   441

				uint cur = u->cur_order_index + 1;

   442

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

   443

				if (cur < u->num_orders)

   444

					u->cur_order_index = cur;

   445

			}

   446

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

   447

			InvalidateVehicleOrder(u);

   448

		}

   449

   450

		/* Make sure to rebuild the whole list */

   451

		RebuildVehicleLists();

   452

	}

   453

   454

	return CommandCost();

   455

}

   456

   457

/** Declone an order-list

   458

 * @param *dst delete the orders of this vehicle

   459

 * @param flags execution flags

   460

 */

   461

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   462

{

   463

	if (flags & DC_EXEC) {

   464

		DeleteVehicleOrders(dst);

   465

		InvalidateVehicleOrder(dst);

   466

		RebuildVehicleLists();

   467

	}

   468

	return CommandCost();

   469

}

   470

   471

/**

   472

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

   473

 *  orders.

   474

 */

   475

static void RemoveSharedOrderVehicleList(Vehicle *v)

   476

{

   477

	assert(v->orders != NULL);

   478

	WindowClass window_class = WC_NONE;

   479

   480

	switch (v->type) {

   481

		default: NOT_REACHED();

   482

		case VEH_TRAIN:    window_class = WC_TRAINS_LIST;   break;

   483

		case VEH_ROAD:     window_class = WC_ROADVEH_LIST;  break;

   484