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 "company_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, OrderDepotActionFlags action, CargoID cargo, byte subtype)

    61

{

    62

	this->type = OT_GOTO_DEPOT;

    63

	this->SetDepotOrderType(order);

    64

	this->SetDepotActionType(action);

    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

	/* In case of go to nearest depot orders we need "only" compare the flags

   119

	 * with the other and not the nearest depot order bit or the actual

   120

	 * destination because those get clear/filled in during the order

   121

	 * evaluation. If we do not do this the order will continuously be seen as

   122

	 * a different order and it will try to find a "nearest depot" every tick. */

   123

	if ((this->type == OT_GOTO_DEPOT && this->type == other.type) &&

   124

			((this->GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0 ||

   125

			 (other.GetDepotActionType() & ODATFB_NEAREST_DEPOT) != 0)) {

   126

		return

   127

			this->GetDepotOrderType() == other.GetDepotOrderType() &&

   128

			(this->GetDepotActionType() & ~ODATFB_NEAREST_DEPOT) == (other.GetDepotActionType() & ~ODATFB_NEAREST_DEPOT);

   129

	}

   130

   131

	return

   132

			this->type  == other.type &&

   133

			this->flags == other.flags &&

   134

			this->dest  == other.dest;

   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

void Order::ConvertFromOldSavegame()

   155

{

   156

	uint8 old_flags = this->flags;

   157

	this->flags = 0;

   158

   159

	/* First handle non-stop */

   160

	if (_settings_client.gui.sg_new_nonstop) {

   161

		/* OFB_NON_STOP */

   162

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

   163

	} else {

   164

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

   165

	}

   166

   167

	switch (this->GetType()) {

   168

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

   169

		case OT_GOTO_DEPOT: case OT_GOTO_STATION: case OT_LOADING: break;

   170

		default: return;

   171

	}

   172

   173

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

   174

		/* Then the load flags */

   175

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

   176

			this->SetLoadType(OLFB_NO_LOAD);

   177

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

   178

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   179

		} else {

   180

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

   181

		}

   182

   183

		/* Finally fix the unload flags */

   184

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

   185

			this->SetUnloadType(OUFB_TRANSFER);

   186

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

   187

			this->SetUnloadType(OUFB_UNLOAD);

   188

		} else {

   189

			this->SetUnloadType(OUF_UNLOAD_IF_POSSIBLE);

   190

		}

   191

	} else {

   192

		/* Then the depot action flags */

   193

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

   194

   195

		/* Finally fix the depot type flags */

   196

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

   197

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

   198

		this->SetDepotOrderType((OrderDepotTypeFlags)t);

   199

	}

   200

}

   201

   202

/**

   203

 *

   204

 * Unpacks a order from savegames with version 4 and lower

   205

 *

   206

 */

   207

static Order UnpackVersion4Order(uint16 packed)

   208

{

   209

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

   210

}

   211

   212

/**

   213

 *

   214

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

   215

 *

   216

 */

   217

Order UnpackOldOrder(uint16 packed)

   218

{

   219

	Order order = UnpackVersion4Order(packed);

   220

   221

	/*

   222

	 * Sanity check

   223

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

   224

	 */

   225

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

   226

   227

	return order;

   228

}

   229

   230

/**

   231

 *

   232

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

   233

 *

   234

 */

   235

void InvalidateVehicleOrder(const Vehicle *v, int data)

   236

{

   237

	InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   238

   239

	if (data != 0) {

   240

		/* Calls SetDirty() too */

   241

		InvalidateWindowData(WC_VEHICLE_ORDERS,    v->index, data);

   242

		InvalidateWindowData(WC_VEHICLE_TIMETABLE, v->index, data);

   243

		return;

   244

	}

   245

   246

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   247

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   248

}

   249

   250

/**

   251

 *

   252

 * Swap two orders

   253

 *

   254

 */

   255

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

   256

{

   257

	Order temp_order;

   258

   259

	temp_order = *order1;

   260

	order1->AssignOrder(*order2);

   261

	order1->next = order2->next;

   262

	order2->AssignOrder(temp_order);

   263

	order2->next = temp_order.next;

   264

}

   265

   266

/**

   267

 *

   268

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

   269

 *   This function makes sure that the index is maintained correctly

   270

 *

   271

 */

   272

void Order::AssignOrder(const Order &other)

   273

{

   274

	this->type  = other.type;

   275

	this->flags = other.flags;

   276

	this->dest  = other.dest;

   277

   278

	this->refit_cargo   = other.refit_cargo;

   279

	this->refit_subtype = other.refit_subtype;

   280

   281

	this->wait_time   = other.wait_time;

   282

	this->travel_time = other.travel_time;

   283

}

   284

   285

   286

/**

   287

 * Delete all news items regarding defective orders about a vehicle

   288

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

   289

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

   290

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

   291

 */

   292

static void DeleteOrderWarnings(const Vehicle* v)

   293

{

   294

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

   295

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

   296

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

   297

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

   298

}

   299

   300

   301

static TileIndex GetOrderLocation(const Order& o)

   302

{

   303

	switch (o.GetType()) {

   304

		default: NOT_REACHED();

   305

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

   306

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

   307

	}

   308

}

   309

   310

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

   311

{

   312

	if (cur->IsType(OT_CONDITIONAL)) {

   313

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

   314

   315

		conditional_depth++;

   316

   317

		int dist1 = GetOrderDistance(prev, GetVehicleOrder(v, cur->GetConditionSkipToOrder()), v, conditional_depth);

   318

		int dist2 = GetOrderDistance(prev, cur->next == NULL ? v->orders : cur->next, v, conditional_depth);

   319

		return max(dist1, dist2);

   320

	}

   321

   322

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

   323

}

   324

   325

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

   326

 * @param tile unused

   327

 * @param flags operation to perform

   328

 * @param p1 various bitstuffed elements

   329

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

   330

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

   331

 *                        the order will be inserted before that one

   332

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

   333

 * @param p2 packed order to insert

   334

 */

   335

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

   336

{

   337

	Vehicle *v;

   338

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

   339

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

   340

	Order new_order(p2);

   341

   342

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   343

   344

	v = GetVehicle(veh);

   345

   346

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

   347

   348

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

   349

	 * and has the correct flags if any */

   350

	switch (new_order.GetType()) {

   351

		case OT_GOTO_STATION: {

   352

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

   353

   354

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

   355

   356

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

   357

				return CMD_ERROR;

   358

			}

   359

   360

			switch (v->type) {

   361

				case VEH_TRAIN:

   362

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

   363

					break;

   364

   365

				case VEH_ROAD:

   366

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

   367

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

   368

					} else {

   369

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

   370

					}

   371

					break;

   372

   373

				case VEH_SHIP:

   374

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

   375

					break;

   376

   377

				case VEH_AIRCRAFT:

   378

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

   379

						return CMD_ERROR;

   380

					}

   381

					break;

   382

   383

				default: return CMD_ERROR;

   384

			}

   385

   386

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

   387

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

   388

   389

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

   390

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

   391

   392

			/* Filter invalid load/unload types. */

   393

			switch (new_order.GetLoadType()) {

   394

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

   395

				default: return CMD_ERROR;

   396

			}

   397

			switch (new_order.GetUnloadType()) {

   398

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

   399

				default: return CMD_ERROR;

   400

			}

   401

			break;

   402

		}

   403

   404

		case OT_GOTO_DEPOT: {

   405

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

   406

				if (v->type == VEH_AIRCRAFT) {

   407

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

   408

   409

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

   410

   411

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

   412

							!(st->facilities & FACIL_AIRPORT) ||

   413

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

   414

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

   415

						return CMD_ERROR;

   416

					}

   417

				} else {

   418

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

   419

   420

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

   421

   422

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

   423

   424

					switch (v->type) {

   425

						case VEH_TRAIN:

   426

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

   427

							break;

   428

   429

						case VEH_ROAD:

   430

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

   431

							break;

   432

   433

						case VEH_SHIP:

   434

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

   435

							break;

   436

   437

						default: return CMD_ERROR;

   438

					}

   439

				}

   440

			} else {

   441

				if (!IsCompanyBuildableVehicleType(v)) return CMD_ERROR;

   442

			}

   443

   444

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

   445

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

   446

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

   447

			break;

   448

		}

   449

   450

		case OT_GOTO_WAYPOINT: {

   451

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

   452

   453

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

   454

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

   455

   456

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

   457

   458

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

   459

			 * [non-stop]

   460

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

   461

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

   462

			break;

   463

		}

   464

   465

		case OT_CONDITIONAL: {

   466

			VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();

   467

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

   468

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

   469

   470

			OrderConditionComparator occ = new_order.GetConditionComparator();

   471

			if (occ > OCC_END) return CMD_ERROR;

   472

			switch (new_order.GetConditionVariable()) {

   473

				case OCV_REQUIRES_SERVICE:

   474

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

   475

					break;

   476

   477

				case OCV_UNCONDITIONALLY:

   478

					if (occ != OCC_EQUALS) return CMD_ERROR;

   479

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

   480

					break;

   481

   482

				case OCV_LOAD_PERCENTAGE:

   483

				case OCV_RELIABILITY: