1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "order_base.h"

     8

#include "order_func.h"

     9

#include "airport.h"

    10

#include "depot.h"

    11

#include "waypoint.h"

    12

#include "command_func.h"

    13

#include "player_func.h"

    14

#include "news_func.h"

    15

#include "saveload.h"

    16

#include "vehicle_gui.h"

    17

#include "cargotype.h"

    18

#include "aircraft.h"

    19

#include "strings_func.h"

    20

#include "core/alloc_func.hpp"

    21

#include "functions.h"

    22

#include "window_func.h"

    23

#include "settings_type.h"

    24

#include "string_func.h"

    25

#include "newgrf_cargo.h"

    26

#include "timetable.h"

    27

#include "vehicle_func.h"

    28

#include "oldpool_func.h"

    29

    30

#include "table/strings.h"

    31

    32

/* DestinationID must be at least as large as every these below, because it can

    33

 * be any of them

    34

 */

    35

assert_compile(sizeof(DestinationID) >= sizeof(DepotID));

    36

assert_compile(sizeof(DestinationID) >= sizeof(WaypointID));

    37

assert_compile(sizeof(DestinationID) >= sizeof(StationID));

    38

    39

TileIndex _backup_orders_tile;

    40

BackuppedOrders _backup_orders_data;

    41

    42

DEFINE_OLD_POOL_GENERIC(Order, Order);

    43

    44

OrderNonStopFlags Order::GetNonStopType() const

    45

{

    46

	if (_patches.new_nonstop || this->IsType(OT_GOTO_DEPOT)) {

    47

		return (this->flags & 0x08) ? ONSF_NO_STOP_AT_ANY_STATION : ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS;

    48

	}

    49

    50

	return (this->flags & 0x08) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE;

    51

}

    52

    53

void Order::Free()

    54

{

    55

	this->type  = OT_NOTHING;

    56

	this->flags = 0;

    57

	this->dest  = 0;

    58

	this->next  = NULL;

    59

}

    60

    61

void Order::MakeGoToStation(StationID destination)

    62

{

    63

	this->type = OT_GOTO_STATION;

    64

	this->flags = 0;

    65

	this->dest = destination;

    66

}

    67

    68

void Order::MakeGoToDepot(DepotID destination, OrderDepotTypeFlags order, CargoID cargo, byte subtype)

    69

{

    70

	this->type = OT_GOTO_DEPOT;

    71

	this->flags = 0;

    72

	this->SetDepotOrderType(order);

    73

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    74

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    75

	}

    76

	this->dest = destination;

    77

	this->SetRefit(cargo, subtype);

    78

}

    79

    80

void Order::MakeGoToWaypoint(WaypointID destination)

    81

{

    82

	this->type = OT_GOTO_WAYPOINT;

    83

	this->flags = 0;

    84

	this->dest = destination;

    85

}

    86

    87

void Order::MakeLoading(bool ordered)

    88

{

    89

	this->type = OT_LOADING;

    90

	if (!ordered) this->flags = 0;

    91

}

    92

    93

void Order::MakeLeaveStation()

    94

{

    95

	this->type = OT_LEAVESTATION;

    96

	this->flags = 0;

    97

}

    98

    99

void Order::MakeDummy()

   100

{

   101

	this->type = OT_DUMMY;

   102

	this->flags = 0;

   103

}

   104

   105

void Order::SetRefit(CargoID cargo, byte subtype)

   106

{

   107

	this->refit_cargo = cargo;

   108

	this->refit_subtype = subtype;

   109

}

   110

   111

void Order::FreeChain()

   112

{

   113

	if (next != NULL) next->FreeChain();

   114

	delete this;

   115

}

   116

   117

bool Order::Equals(const Order &other) const

   118

{

   119

	return

   120

			this->type  == other.type &&

   121

			this->flags == other.flags &&

   122

			this->dest  == other.dest;

   123

}

   124

   125

static bool HasOrderPoolFree(uint amount)

   126

{

   127

	const Order *order;

   128

   129

	/* There is always room if not all blocks in the pool are reserved */

   130

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   131

   132

	FOR_ALL_ORDERS(order) if (!order->IsValid() && --amount == 0) return true;

   133

   134

	return false;

   135

}

   136

   137

uint32 Order::Pack() const

   138

{

   139

	return this->dest << 16 | this->flags << 8 | this->type;

   140

}

   141

   142

Order::Order(uint32 packed)

   143

{

   144

	this->type    = (OrderType)GB(packed,  0,  8);

   145

	this->flags   = GB(packed,  8,  8);

   146

	this->dest    = GB(packed, 16, 16);

   147

	this->next    = NULL;

   148

	this->refit_cargo   = CT_NO_REFIT;

   149

	this->refit_subtype = 0;

   150

	this->wait_time     = 0;

   151

	this->travel_time   = 0;

   152

}

   153

   154

/**

   155

 *

   156

 * Unpacks a order from savegames with version 4 and lower

   157

 *

   158

 */

   159

static Order UnpackVersion4Order(uint16 packed)

   160

{

   161

	return Order(GB(packed, 8, 8) << 16 | GB(packed, 4, 4) << 8 | GB(packed, 0, 4));

   162

}

   163

   164

/**

   165

 *

   166

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

   167

 *

   168

 */

   169

Order UnpackOldOrder(uint16 packed)

   170

{

   171

	Order order = UnpackVersion4Order(packed);

   172

   173

	/*

   174

	 * Sanity check

   175

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

   176

	 */

   177

	if (!order.IsValid() && (order.GetLoadType() != 0 || order.GetUnloadType() != 0 || order.GetDestination() != 0)) {

   178

		order.MakeDummy();

   179

	}

   180

   181

	return order;

   182

}

   183

   184

/**

   185

 *

   186

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

   187

 *

   188

 */

   189

void InvalidateVehicleOrder(const Vehicle *v)

   190

{

   191

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   192

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   193

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   194

}

   195

   196

/**

   197

 *

   198

 * Swap two orders

   199

 *

   200

 */

   201

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

   202

{

   203

	Order temp_order;

   204

   205

	temp_order = *order1;

   206

	order1->AssignOrder(*order2);

   207

	order1->next = order2->next;

   208

	order2->AssignOrder(temp_order);

   209

	order2->next = temp_order.next;

   210

}

   211

   212

/**

   213

 *

   214

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

   215

 *   This function makes sure that the index is maintained correctly

   216

 *

   217

 */

   218

void Order::AssignOrder(const Order &other)

   219

{

   220

	this->type  = other.type;

   221

	this->flags = other.flags;

   222

	this->dest  = other.dest;

   223

   224

	this->refit_cargo   = other.refit_cargo;

   225

	this->refit_subtype = other.refit_subtype;

   226

   227

	this->wait_time   = other.wait_time;

   228

	this->travel_time = other.travel_time;

   229

}

   230

   231

   232

/**

   233

 * Delete all news items regarding defective orders about a vehicle

   234

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

   235

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

   236

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

   237

 */

   238

static void DeleteOrderWarnings(const Vehicle* v)

   239

{

   240

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

   241

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

   242

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

   243

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

   244

}

   245

   246

   247

static TileIndex GetOrderLocation(const Order& o)

   248

{

   249

	switch (o.GetType()) {

   250

		default: NOT_REACHED();

   251

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

   252

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

   253

	}

   254

}

   255

   256

   257

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

   258

 * @param tile unused

   259

 * @param flags operation to perform

   260

 * @param p1 various bitstuffed elements

   261

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

   262

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

   263

 *                        the order will be inserted before that one

   264

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

   265

 * @param p2 packed order to insert

   266

 */

   267

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

   268

{

   269

	Vehicle *v;

   270

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

   271

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

   272

	Order new_order(p2);

   273

   274

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   275

   276

	v = GetVehicle(veh);

   277

   278

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

   279

   280

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

   281

	 * and has the correct flags if any */

   282

	switch (new_order.GetType()) {

   283

		case OT_GOTO_STATION: {

   284

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

   285

   286

			const Station *st = GetStation(new_order.GetDestination());

   287

   288

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

   289

				return CMD_ERROR;

   290

			}

   291

   292

			switch (v->type) {

   293

				case VEH_TRAIN:

   294

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

   295

					break;

   296

   297

				case VEH_ROAD:

   298

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

   299

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

   300

					} else {

   301

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

   302

					}

   303

					break;

   304

   305

				case VEH_SHIP:

   306

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

   307

					break;

   308

   309

				case VEH_AIRCRAFT:

   310

					if (!(st->facilities & FACIL_AIRPORT) || !CanAircraftUseStation(v->engine_type, st)) {

   311

						return CMD_ERROR;

   312

					}

   313

					break;

   314

   315

				default: return CMD_ERROR;

   316

			}

   317

   318

			/* Non stop not allowed for non-trains. */

   319

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   320

   321

			/* Full load and unload are mutual exclusive. */

   322

			if ((new_order.GetLoadType() & OLFB_FULL_LOAD) && (new_order.GetUnloadType() & OUFB_UNLOAD)) return CMD_ERROR;

   323

   324

			/* Filter invalid load/unload types. */

   325

			if (new_order.GetLoadType() & ~OLFB_FULL_LOAD) return CMD_ERROR;

   326

			if (new_order.GetUnloadType() & ~(OUFB_UNLOAD | OUFB_TRANSFER)) return CMD_ERROR;

   327

			break;

   328

		}

   329

   330

		case OT_GOTO_DEPOT: {

   331

			if (v->type == VEH_AIRCRAFT) {

   332

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

   333

   334

				const Station *st = GetStation(new_order.GetDestination());

   335

   336

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

   337

						!(st->facilities & FACIL_AIRPORT) ||

   338

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

   339

						!CanAircraftUseStation(v->engine_type, st)) {

   340

					return CMD_ERROR;

   341

				}

   342

			} else {

   343

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

   344

   345

				const Depot *dp = GetDepot(new_order.GetDestination());

   346

   347

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

   348

   349

				switch (v->type) {

   350

					case VEH_TRAIN:

   351

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

   352

						break;

   353

   354

					case VEH_ROAD:

   355

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

   356

						break;

   357

   358

					case VEH_SHIP:

   359

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

   360

						break;

   361

   362

					default: return CMD_ERROR;

   363

				}

   364

			}

   365

   366

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   367

			if (new_order.GetDepotOrderType() & ~ODTFB_PART_OF_ORDERS) return CMD_ERROR;

   368

			if (new_order.GetDepotActionType() & ~ODATFB_HALT) return CMD_ERROR;

   369

			break;

   370

		}

   371

   372

		case OT_GOTO_WAYPOINT: {

   373

   374

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

   375

   376

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

   377

			const Waypoint *wp = GetWaypoint(new_order.GetDestination());

   378

   379

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

   380

   381

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

   382

			 * [non-stop]

   383

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

   384

			if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   385

		}

   386

   387

		default: return CMD_ERROR;

   388

	}

   389

   390

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

   391

   392

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

   393

   394

	if (v->type == VEH_SHIP && IsHumanPlayer(v->owner) && _patches.pathfinder_for_ships != VPF_NPF) {

   395

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

   396

		const Order *prev = NULL;

   397

		uint n = 0;

   398

   399

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

   400

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

   401

		 * finds the last order in the list. */

   402

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

   403

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

   404

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

   405

		}

   406

		if (prev != NULL) {

   407

			uint dist = DistanceManhattan(

   408

				GetOrderLocation(*prev),

   409

				GetOrderLocation(new_order)

   410

			);

   411

			if (dist >= 130) {

   412

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   413

			}

   414

		}

   415

	}

   416

   417

	if (flags & DC_EXEC) {

   418

		Vehicle *u;

   419

		Order *new_o = new Order();

   420

		new_o->AssignOrder(new_order);

   421

   422

		/* Create new order and link in list */

   423

		if (v->orders == NULL) {

   424

			v->orders = new_o;

   425

		} else {

   426

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

   427

			    selected) */

   428

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

   429

   430

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

   431

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

   432

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

   433

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

   434

				    all vehicles */

   435

				SwapOrders(v->orders, new_o);

   436

				/* Now update the next pointers */

   437

				v->orders->next = new_o;

   438

			} else if (order == NULL) {

   439

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

   440

				order = GetLastVehicleOrder(v);

   441

				order->next = new_o;

   442

			} else {

   443

				/* Put the new order in between */

   444

				new_o->next = order->next;

   445

				order->next = new_o;

   446

			}

   447

		}

   448

   449

		u = GetFirstVehicleFromSharedList(v);

   450

		DeleteOrderWarnings(u);

   451

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

   452

			/* Increase amount of orders */

   453

			u->num_orders++;

   454

   455

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

   456

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

   457

   458

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

   459

   460

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

   461

			to update the selected order */

   462

			if (sel_ord <= u->cur_order_index) {

   463

				uint cur = u->cur_order_index + 1;

   464

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

   465

				if (cur < u->num_orders)

   466

					u->cur_order_index = cur;

   467

			}

   468

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

   469

			InvalidateVehicleOrder(u);

   470

		}

   471

   472

		/* Make sure to rebuild the whole list */

   473

		RebuildVehicleLists();

   474

	}

   475

   476

	return CommandCost();

   477

}

   478

   479

/** Declone an order-list

   480

 * @param *dst delete the orders of this vehicle

   481

 * @param flags execution flags

   482

 */

   483

static CommandCost DecloneOrder(Vehicle *dst, uint32 flags)

   484

{