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, 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

uint32 Order::Pack() const

   125

{

   126

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

   127

}

   128

   129

Order::Order(uint32 packed)

   130

{

   131

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

   132

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

   133

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

   134

	this->next    = NULL;

   135

	this->refit_cargo   = CT_NO_REFIT;

   136

	this->refit_subtype = 0;

   137

	this->wait_time     = 0;

   138

	this->travel_time   = 0;

   139

}

   140

   141

void Order::ConvertFromOldSavegame()

   142

{

   143

	uint8 old_flags = this->flags;

   144

	this->flags = 0;

   145

   146

	/* First handle non-stop */

   147

	if (_settings_client.gui.sg_new_nonstop) {

   148

		/* OFB_NON_STOP */

   149

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

   150

	} else {

   151

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

   152

	}

   153

   154

	switch (this->GetType()) {

   155

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

   156

		case OT_GOTO_DEPOT: case OT_GOTO_STATION: case OT_LOADING: break;

   157

		default: return;

   158

	}

   159

   160

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

   161

		/* Then the load flags */

   162

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

   163

			this->SetLoadType(OLFB_NO_LOAD);

   164

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

   165

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   166

		} else {

   167

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

   168

		}

   169

   170

		/* Finally fix the unload flags */

   171

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

   172

			this->SetUnloadType(OUFB_TRANSFER);

   173

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

   174

			this->SetUnloadType(OUFB_UNLOAD);

   175

		} else {

   176

			this->SetUnloadType(OUF_UNLOAD_IF_POSSIBLE);

   177

		}

   178

	} else {

   179

		/* Then the depot action flags */

   180

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

   181

   182

		/* Finally fix the depot type flags */

   183

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

   184

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

   185

		this->SetDepotOrderType((OrderDepotTypeFlags)t);

   186

	}

   187

}

   188

   189

/**

   190

 *

   191

 * Unpacks a order from savegames with version 4 and lower

   192

 *

   193

 */

   194

static Order UnpackVersion4Order(uint16 packed)

   195

{

   196

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

   197

}

   198

   199

/**

   200

 *

   201

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

   202

 *

   203

 */

   204

Order UnpackOldOrder(uint16 packed)

   205

{

   206

	Order order = UnpackVersion4Order(packed);

   207

   208

	/*

   209

	 * Sanity check

   210

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

   211

	 */

   212

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

   213

   214

	return order;

   215

}

   216

   217

/**

   218

 *

   219

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

   220

 *

   221

 */

   222

void InvalidateVehicleOrder(const Vehicle *v, int data)

   223

{

   224

	InvalidateWindow(WC_VEHICLE_VIEW, v->index);

   225

   226

	if (data != 0) {

   227

		/* Calls SetDirty() too */

   228

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

   229

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

   230

		return;

   231

	}

   232

   233

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   234

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   235

}

   236

   237

/**

   238

 *

   239

 * Swap two orders

   240

 *

   241

 */

   242

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

   243

{

   244

	Order temp_order;

   245

   246

	temp_order = *order1;

   247

	order1->AssignOrder(*order2);

   248

	order1->next = order2->next;

   249

	order2->AssignOrder(temp_order);

   250

	order2->next = temp_order.next;

   251

}

   252

   253

/**

   254

 *

   255

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

   256

 *   This function makes sure that the index is maintained correctly

   257

 *

   258

 */

   259

void Order::AssignOrder(const Order &other)

   260

{

   261

	this->type  = other.type;

   262

	this->flags = other.flags;

   263

	this->dest  = other.dest;

   264

   265

	this->refit_cargo   = other.refit_cargo;

   266

	this->refit_subtype = other.refit_subtype;

   267

   268

	this->wait_time   = other.wait_time;

   269

	this->travel_time = other.travel_time;

   270

}

   271

   272

   273

/**

   274

 * Delete all news items regarding defective orders about a vehicle

   275

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

   276

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

   277

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

   278

 */

   279

static void DeleteOrderWarnings(const Vehicle* v)

   280

{

   281

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

   282

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

   283

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

   284

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

   285

}

   286

   287

   288

static TileIndex GetOrderLocation(const Order& o)

   289

{

   290

	switch (o.GetType()) {

   291

		default: NOT_REACHED();

   292

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

   293

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

   294

	}

   295

}

   296

   297

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

   298

{

   299

	if (cur->IsType(OT_CONDITIONAL)) {

   300

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

   301

   302

		conditional_depth++;

   303

   304

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

   305

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

   306

		return max(dist1, dist2);

   307

	}

   308

   309

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

   310

}

   311

   312

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

   313

 * @param tile unused

   314

 * @param flags operation to perform

   315

 * @param p1 various bitstuffed elements

   316

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

   317

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

   318

 *                        the order will be inserted before that one

   319

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

   320

 * @param p2 packed order to insert

   321

 */

   322

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

   323

{

   324

	Vehicle *v;

   325

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

   326

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

   327

	Order new_order(p2);

   328

   329

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   330

   331

	v = GetVehicle(veh);

   332

   333

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

   334

   335

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

   336

	 * and has the correct flags if any */

   337

	switch (new_order.GetType()) {

   338

		case OT_GOTO_STATION: {

   339

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

   340

   341

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

   342

   343

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

   344

				return CMD_ERROR;

   345

			}

   346

   347

			switch (v->type) {

   348

				case VEH_TRAIN:

   349

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

   350

					break;

   351

   352

				case VEH_ROAD:

   353

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

   354

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

   355

					} else {

   356

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

   357

					}

   358

					break;

   359

   360

				case VEH_SHIP:

   361

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

   362

					break;

   363

   364

				case VEH_AIRCRAFT:

   365

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

   366

						return CMD_ERROR;

   367

					}

   368

					break;

   369

   370

				default: return CMD_ERROR;

   371

			}

   372

   373

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

   374

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

   375

   376

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

   377

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

   378

   379

			/* Filter invalid load/unload types. */

   380

			switch (new_order.GetLoadType()) {

   381

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

   382

				default: return CMD_ERROR;

   383

			}

   384

			switch (new_order.GetUnloadType()) {

   385

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

   386

				default: return CMD_ERROR;

   387

			}

   388

			break;

   389

		}

   390

   391

		case OT_GOTO_DEPOT: {

   392

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

   393

				if (v->type == VEH_AIRCRAFT) {

   394

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

   395

   396

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

   397

   398

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

   399

							!(st->facilities & FACIL_AIRPORT) ||

   400

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

   401

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

   402

						return CMD_ERROR;

   403

					}

   404

				} else {

   405

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

   406

   407

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

   408

   409

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

   410

   411

					switch (v->type) {

   412

						case VEH_TRAIN:

   413

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

   414

							break;

   415

   416

						case VEH_ROAD:

   417

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

   418

							break;

   419

   420

						case VEH_SHIP:

   421

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

   422

							break;

   423

   424

						default: return CMD_ERROR;

   425

					}

   426

				}

   427

			} else {

   428

				if (!IsCompanyBuildableVehicleType(v)) return CMD_ERROR;

   429

			}

   430

   431

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

   432

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

   433

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

   434

			break;

   435

		}

   436

   437

		case OT_GOTO_WAYPOINT: {

   438

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

   439

   440

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

   441

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

   442

   443

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

   444

   445

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

   446

			 * [non-stop]

   447

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

   448

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

   449

			break;

   450

		}

   451

   452

		case OT_CONDITIONAL: {

   453

			VehicleOrderID skip_to = new_order.GetConditionSkipToOrder();

   454

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

   455

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

   456

   457

			OrderConditionComparator occ = new_order.GetConditionComparator();

   458

			if (occ > OCC_END) return CMD_ERROR;

   459

			switch (new_order.GetConditionVariable()) {

   460

				case OCV_REQUIRES_SERVICE:

   461

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

   462

					break;

   463

   464

				case OCV_UNCONDITIONALLY:

   465

					if (occ != OCC_EQUALS) return CMD_ERROR;

   466

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

   467

					break;

   468

   469

				case OCV_LOAD_PERCENTAGE:

   470

				case OCV_RELIABILITY:

   471

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

   472

					/* FALL THROUGH */

   473

				default:

   474

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

   475

					break;

   476

			}

   477

		} break;

   478

   479

		default: return CMD_ERROR;

   480

	}

   481

   482

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

   483