1

/* $Id$ */

     2

     3

/** @file order_cmd.cpp Handling of orders. */

     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 "order_base.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

#include "depot_base.h"

    30

    31

#include "table/strings.h"

    32

    33

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

    34

 * be any of them

    35

 */

    36

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

    37

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

    38

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

    39

    40

TileIndex _backup_orders_tile;

    41

BackuppedOrders _backup_orders_data;

    42

    43

DEFINE_OLD_POOL_GENERIC(Order, Order);

    44

    45

void Order::Free()

    46

{

    47

	this->type  = OT_NOTHING;

    48

	this->flags = 0;

    49

	this->dest  = 0;

    50

	this->next  = NULL;

    51

}

    52

    53

void Order::MakeGoToStation(StationID destination)

    54

{

    55

	this->type = OT_GOTO_STATION;

    56

	this->flags = 0;

    57

	this->dest = destination;

    58

}

    59

    60

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

    61

{

    62

	this->type = OT_GOTO_DEPOT;

    63

	this->flags = 0;

    64

	this->SetDepotOrderType(order);

    65

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    66

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    67

	}

    68

	this->dest = destination;

    69

	this->SetRefit(cargo, subtype);

    70

}

    71

    72

void Order::MakeGoToWaypoint(WaypointID destination)

    73

{

    74

	this->type = OT_GOTO_WAYPOINT;

    75

	this->flags = 0;

    76

	this->dest = destination;

    77

}

    78

    79

void Order::MakeLoading(bool ordered)

    80

{

    81

	this->type = OT_LOADING;

    82

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

    83

}

    84

    85

void Order::MakeLeaveStation()

    86

{

    87

	this->type = OT_LEAVESTATION;

    88

	this->flags = 0;

    89

}

    90

    91

void Order::MakeDummy()

    92

{

    93

	this->type = OT_DUMMY;

    94

	this->flags = 0;

    95

}

    96

    97

void Order::MakeConditional(VehicleOrderID order)

    98

{

    99

	this->type = OT_CONDITIONAL;

   100

	this->flags = order;

   101

	this->dest = 0;

   102

}

   103

   104

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

   105

{

   106

	this->refit_cargo = cargo;

   107

	this->refit_subtype = subtype;

   108

}

   109

   110

void Order::FreeChain()

   111

{

   112

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

   113

	delete this;

   114

}

   115

   116

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

   117

{

   118

	return

   119

			this->type  == other.type &&

   120

			this->flags == other.flags &&

   121

			this->dest  == other.dest;

   122

}

   123

   124

static bool HasOrderPoolFree(uint amount)

   125

{

   126

	const Order *order;

   127

   128

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

   129

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   130

   131

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

   132

   133

	return false;

   134

}

   135

   136

uint32 Order::Pack() const

   137

{

   138

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

   139

}

   140

   141

Order::Order(uint32 packed)

   142

{

   143

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

   144

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

   145

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

   146

	this->next    = NULL;

   147

	this->refit_cargo   = CT_NO_REFIT;

   148

	this->refit_subtype = 0;

   149

	this->wait_time     = 0;

   150

	this->travel_time   = 0;

   151

}

   152

   153

void Order::ConvertFromOldSavegame()

   154

{

   155

	uint8 old_flags = this->flags;

   156

	this->flags = 0;

   157

   158

	/* First handle non-stop */

   159

	if (_settings_client.gui.sg_new_nonstop) {

   160

		/* OFB_NON_STOP */

   161

		this->SetNonStopType((old_flags & 8) ? ONSF_NO_STOP_AT_ANY_STATION : ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

   162

	} else {

   163

		this->SetNonStopType((old_flags & 8) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE);

   164

	}

   165

   166

	switch (this->GetType()) {

   167

		/* Only a few types need the other savegame conversions. */

   168

		case OT_GOTO_DEPOT: case OT_GOTO_STATION: case OT_LOADING: break;

   169

		default: return;

   170

	}

   171

   172

	if (this->GetType() != OT_GOTO_DEPOT) {

   173

		/* Then the load flags */

   174

		if ((old_flags & 2) != 0) { // OFB_UNLOAD

   175

			this->SetLoadType(OLFB_NO_LOAD);

   176

		} else if ((old_flags & 4) == 0) { // !OFB_FULL_LOAD

   177

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   178

		} else {

   179

			this->SetLoadType(_settings_client.gui.sg_full_load_any ? OLF_FULL_LOAD_ANY : OLFB_FULL_LOAD);

   180

		}

   181

   182

		/* Finally fix the unload flags */

   183

		if ((old_flags & 1) != 0) { // OFB_TRANSFER

   184

			this->SetUnloadType(OUFB_TRANSFER);

   185

		} else if ((old_flags & 2) != 0) { // OFB_UNLOAD

   186

			this->SetUnloadType(OUFB_UNLOAD);

   187

		} else {

   188

			this->SetUnloadType(OUF_UNLOAD_IF_POSSIBLE);

   189

		}

   190

	} else {

   191

		/* Then the depot action flags */

   192

		this->SetDepotActionType(((old_flags & 6) == 4) ? ODATFB_HALT : ODATF_SERVICE_ONLY);

   193

   194

		/* Finally fix the depot type flags */

   195

		uint t = ((old_flags & 6) == 6) ? ODTFB_SERVICE : ODTF_MANUAL;

   196

		if ((old_flags & 2) != 0) t |= ODTFB_PART_OF_ORDERS;

   197

		this->SetDepotOrderType((OrderDepotTypeFlags)t);

   198

	}

   199

}

   200

   201

/**

   202

 *

   203

 * Unpacks a order from savegames with version 4 and lower

   204

 *

   205

 */

   206

static Order UnpackVersion4Order(uint16 packed)

   207

{

   208

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

   209

}

   210

   211

/**

   212

 *

   213

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

   214

 *

   215

 */

   216

Order UnpackOldOrder(uint16 packed)

   217

{

   218

	Order order = UnpackVersion4Order(packed);

   219

   220

	/*

   221

	 * Sanity check

   222

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

   223

	 */

   224

	if (!order.IsValid() && packed != 0) order.MakeDummy();

   225

   226

	return order;

   227

}

   228

   229

/**

   230

 *

   231

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

   232

 *

   233

 */

   234

void InvalidateVehicleOrder(const Vehicle *v)

   235

{

   236

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   237

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   238

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   239

}

   240

   241

/**

   242

 *

   243

 * Swap two orders

   244

 *

   245

 */

   246

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

   247

{

   248

	Order temp_order;

   249

   250

	temp_order = *order1;

   251

	order1->AssignOrder(*order2);

   252

	order1->next = order2->next;

   253

	order2->AssignOrder(temp_order);

   254

	order2->next = temp_order.next;

   255

}

   256

   257

/**

   258

 *

   259

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

   260

 *   This function makes sure that the index is maintained correctly

   261

 *

   262

 */

   263

void Order::AssignOrder(const Order &other)

   264

{

   265

	this->type  = other.type;

   266

	this->flags = other.flags;

   267

	this->dest  = other.dest;

   268

   269

	this->refit_cargo   = other.refit_cargo;

   270

	this->refit_subtype = other.refit_subtype;

   271

   272

	this->wait_time   = other.wait_time;

   273

	this->travel_time = other.travel_time;

   274

}

   275

   276

   277

/**

   278

 * Delete all news items regarding defective orders about a vehicle

   279

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

   280

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

   281

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

   282

 */

   283

static void DeleteOrderWarnings(const Vehicle* v)

   284

{

   285

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

   286

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

   287

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

   288

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

   289

}

   290

   291

   292

static TileIndex GetOrderLocation(const Order& o)

   293

{

   294

	switch (o.GetType()) {

   295

		default: NOT_REACHED();

   296

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

   297

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

   298

	}

   299

}

   300

   301

static uint GetOrderDistance(const Order *prev, const Order *cur, const Vehicle *v, int conditional_depth = 0)

   302

{

   303

	if (cur->IsType(OT_CONDITIONAL)) {

   304

		if (conditional_depth > v->num_orders) return 0;

   305

   306

		conditional_depth++;

   311

	}

   312

   313

	return DistanceManhattan(GetOrderLocation(*prev), GetOrderLocation(*cur));

   314

}

   315

   316

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

   317

 * @param tile unused

   318

 * @param flags operation to perform

   319

 * @param p1 various bitstuffed elements

   320

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

   321

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

   322

 *                        the order will be inserted before that one

   323

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

   324

 * @param p2 packed order to insert

   325

 */

   326

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

   327

{

   328

	Vehicle *v;

   329

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

   330

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

   331

	Order new_order(p2);

   332

   333

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   334

   335

	v = GetVehicle(veh);

   336

   337

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

   338

   339

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

   340

	 * and has the correct flags if any */

   341

	switch (new_order.GetType()) {

   342

		case OT_GOTO_STATION: {

   343

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

   344

   345

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

   346

   347

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

   348

				return CMD_ERROR;

   349

			}

   350

   351

			switch (v->type) {

   352

				case VEH_TRAIN:

   353

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

   354

					break;

   355

   356

				case VEH_ROAD:

   357

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

   358

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

   359

					} else {

   360

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

   361

					}

   362

					break;

   363

   364

				case VEH_SHIP:

   365

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

   366

					break;

   367

   368

				case VEH_AIRCRAFT:

   369

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

   370

						return CMD_ERROR;

   371

					}

   372

					break;

   373

   374

				default: return CMD_ERROR;

   375

			}

   376

   377

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

   378

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

   379

   380

			/* No load and no unload are mutual exclusive. */

   381

			if ((new_order.GetLoadType() & OLFB_NO_LOAD) && (new_order.GetUnloadType() & OUFB_NO_UNLOAD)) return CMD_ERROR;

   382

   383

			/* Filter invalid load/unload types. */

   384

			switch (new_order.GetLoadType()) {

   385

				case OLF_LOAD_IF_POSSIBLE: case OLFB_FULL_LOAD: case OLF_FULL_LOAD_ANY: case OLFB_NO_LOAD: break;

   386

				default: return CMD_ERROR;

   387

			}

   388

			switch (new_order.GetUnloadType()) {

   389

				case OUF_UNLOAD_IF_POSSIBLE: case OUFB_UNLOAD: case OUFB_TRANSFER: case OUFB_NO_UNLOAD: break;

   390

				default: return CMD_ERROR;

   391

			}

   392

			break;

   393

		}

   394

   395

		case OT_GOTO_DEPOT: {

   396

			if (new_order.GetDepotActionType() != ODATFB_NEAREST_DEPOT) {

   397

				if (v->type == VEH_AIRCRAFT) {

   398

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

   399

   400

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

   401

   402

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

   403

							!(st->facilities & FACIL_AIRPORT) ||

   404

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

   405

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

   406

						return CMD_ERROR;

   407

					}

   408

				} else {

   409

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

   410

   411

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

   412

   413

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

   414

   415

					switch (v->type) {

   416

						case VEH_TRAIN:

   417

							if (!IsRailDepotTile(dp->xy)) return CMD_ERROR;

   418

							break;

   419

   420

						case VEH_ROAD:

   421

							if (!IsRoadDepotTile(dp->xy)) return CMD_ERROR;

   422

							break;

   423

   424

						case VEH_SHIP:

   425

							if (!IsShipDepotTile(dp->xy)) return CMD_ERROR;

   426

							break;

   427

   428

						default: return CMD_ERROR;

   429

					}

   430

				}

   431

			} else {

   432

				if (!IsPlayerBuildableVehicleType(v)) return CMD_ERROR;

   433

			}

   434

   435

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

   436

			if (new_order.GetDepotOrderType() & ~(ODTFB_PART_OF_ORDERS | ((new_order.GetDepotOrderType() & ODTFB_PART_OF_ORDERS) != 0 ? ODTFB_SERVICE : 0))) return CMD_ERROR;

   437

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

   438

			break;

   439

		}

   440

   441

		case OT_GOTO_WAYPOINT: {

   442

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

   443

   444

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

   445

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

   446

   447

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

   448

   449

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

   450

			 * [non-stop]

   451

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

   452

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

   453

			break;

   454

		}

   455

   456

		case OT_CONDITIONAL: {

   457

			VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();

   458

			if (skip_to != 0 && skip_to >= v->num_orders) return CMD_ERROR; // Always allow jumping to the first (even when there is no order).

   459

			if (new_order.GetConditionVariable() > OCV_END) return CMD_ERROR;

   460

   461

			OrderConditionComparator occ = new_order.GetConditionComparator();

   462

			if (occ > OCC_END) return CMD_ERROR;

   463

			switch (new_order.GetConditionVariable()) {

   464

				case OCV_REQUIRES_SERVICE:

   465

					if (occ != OCC_IS_TRUE && occ != OCC_IS_FALSE) return CMD_ERROR;

   466

					break;

   467

   468

				case OCV_UNCONDITIONALLY:

   469

					if (occ != OCC_EQUALS) return CMD_ERROR;

   470

					if (new_order.GetConditionValue() != 0) return CMD_ERROR;

   471

					break;

   472

   473

				case OCV_LOAD_PERCENTAGE:

   474

				case OCV_RELIABILITY:

   475

					if (new_order.GetConditionValue() > 100) return CMD_ERROR;

   476

					/* FALL THROUGH */

   477

				default:

   478

					if (occ == OCC_IS_TRUE || occ == OCC_IS_FALSE) return CMD_ERROR;

   479

					break;

   480

			}

   481

		} break;

   482

   483

		default: return CMD_ERROR;