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

void Order::Free()

    45

{

    46

	this->type  = OT_NOTHING;

    47

	this->flags = 0;

    48

	this->dest  = 0;

    49

	this->next  = NULL;

    50

}

    51

    52

void Order::MakeGoToStation(StationID destination)

    53

{

    54

	this->type = OT_GOTO_STATION;

    55

	this->flags = 0;

    56

	this->dest = destination;

    57

}

    58

    59

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

    60

{

    61

	this->type = OT_GOTO_DEPOT;

    62

	this->flags = 0;

    63

	this->SetDepotOrderType(order);

    64

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    65

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    66

	}

    67

	this->dest = destination;

    68

	this->SetRefit(cargo, subtype);

    69

}

    70

    71

void Order::MakeGoToWaypoint(WaypointID destination)

    72

{

    73

	this->type = OT_GOTO_WAYPOINT;

    74

	this->flags = 0;

    75

	this->dest = destination;

    76

}

    77

    78

void Order::MakeLoading(bool ordered)

    79

{

    80

	this->type = OT_LOADING;

    81

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

    82

}

    83

    84

void Order::MakeLeaveStation()

    85

{

    86

	this->type = OT_LEAVESTATION;

    87

	this->flags = 0;

    88

}

    89

    90

void Order::MakeDummy()

    91

{

    92

	this->type = OT_DUMMY;

    93

	this->flags = 0;

    94

}

    95

    96

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

    97

{

    98

	this->refit_cargo = cargo;

    99

	this->refit_subtype = subtype;

   100

}

   101

   102

void Order::FreeChain()

   103

{

   104

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

   105

	delete this;

   106

}

   107

   108

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

   109

{

   110

	return

   111

			this->type  == other.type &&

   112

			this->flags == other.flags &&

   113

			this->dest  == other.dest;

   114

}

   115

   116

static bool HasOrderPoolFree(uint amount)

   117

{

   118

	const Order *order;

   119

   120

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

   121

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   122

   123

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

   124

   125

	return false;

   126

}

   127

   128

uint32 Order::Pack() const

   129

{

   130

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

   131

}

   132

   133

Order::Order(uint32 packed)

   134

{

   135

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

   136

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

   137

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

   138

	this->next    = NULL;

   139

	this->refit_cargo   = CT_NO_REFIT;

   140

	this->refit_subtype = 0;

   141

	this->wait_time     = 0;

   142

	this->travel_time   = 0;

   143

}

   144

   145

void Order::ConvertFromOldSavegame()

   146

{

   147

	/* First handle non-stop, because those bits are going to be reused. */

   148

	if (_patches.sg_new_nonstop) {

   149

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

   150

	} else {

   151

		this->SetNonStopType((this->flags & 0x08) ? 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

	/* Then the load/depot action flags because those bits are going to be reused too

   161

	 * and they reuse the non-stop bits. */

   162

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

   163

		if ((this->flags & 4) == 0) {

   164

			this->SetLoadType(OLF_LOAD_IF_POSSIBLE);

   165

		} else {

   166

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

   167

		}

   168

	} else {

   169

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

   170

	}

   171

   172

	/* Finally fix the unload/depot type flags. */

   173

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

   174

		uint t = ((this->flags & 1) == 0) ? OUF_UNLOAD_IF_POSSIBLE : OUFB_TRANSFER;

   175

		if ((this->flags & 2) != 0) t |= OUFB_UNLOAD;

   176

		this->SetUnloadType((OrderUnloadFlags)t);

   177

   178

		if ((this->GetUnloadType() & (OUFB_UNLOAD | OUFB_TRANSFER)) == (OUFB_UNLOAD | OUFB_TRANSFER)) {

   179

			this->SetUnloadType(OUFB_TRANSFER);

   180

			this->SetLoadType(OLFB_NO_LOAD);

   181

		}

   182

	} else {

   183

		uint t = ((this->flags & 6) == 6) ? ODTFB_SERVICE : ODTF_MANUAL;

   184

		if ((this->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() && (order.GetLoadType() != 0 || order.GetUnloadType() != 0 || order.GetDestination() != 0)) {

   213

		order.MakeDummy();

   214

	}

   215

   216

	return order;

   217

}

   218

   219

/**

   220

 *

   221

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

   222

 *

   223

 */

   224

void InvalidateVehicleOrder(const Vehicle *v)

   225

{

   226

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   227

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   228

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   229

}

   230

   231

/**

   232

 *

   233

 * Swap two orders

   234

 *

   235

 */

   236

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

   237

{

   238

	Order temp_order;

   239

   240

	temp_order = *order1;

   241

	order1->AssignOrder(*order2);

   242

	order1->next = order2->next;

   243

	order2->AssignOrder(temp_order);

   244

	order2->next = temp_order.next;

   245

}

   246

   247

/**

   248

 *

   249

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

   250

 *   This function makes sure that the index is maintained correctly

   251

 *

   252

 */

   253

void Order::AssignOrder(const Order &other)

   254

{

   255

	this->type  = other.type;

   256

	this->flags = other.flags;

   257

	this->dest  = other.dest;

   258

   259

	this->refit_cargo   = other.refit_cargo;

   260

	this->refit_subtype = other.refit_subtype;

   261

   262

	this->wait_time   = other.wait_time;

   263

	this->travel_time = other.travel_time;

   264

}

   265

   266

   267

/**

   268

 * Delete all news items regarding defective orders about a vehicle

   269

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

   270

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

   271

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

   272

 */

   273

static void DeleteOrderWarnings(const Vehicle* v)

   274

{

   275

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

   276

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

   277

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

   278

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

   279

}

   280

   281

   282

static TileIndex GetOrderLocation(const Order& o)

   283

{

   284

	switch (o.GetType()) {

   285

		default: NOT_REACHED();

   286

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

   287

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

   288

	}

   289

}

   290

   291

   292

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

   293

 * @param tile unused

   294

 * @param flags operation to perform

   295

 * @param p1 various bitstuffed elements

   296

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

   297

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

   298

 *                        the order will be inserted before that one

   299

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

   300

 * @param p2 packed order to insert

   301

 */

   302

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

   303

{

   304

	Vehicle *v;

   305

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

   306

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

   307

	Order new_order(p2);

   308

   309

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   310

   311

	v = GetVehicle(veh);

   312

   313

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

   314

   315

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

   316

	 * and has the correct flags if any */

   317

	switch (new_order.GetType()) {

   318

		case OT_GOTO_STATION: {

   319

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

   320

   321

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

   322

   323

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

   324

				return CMD_ERROR;

   325

			}

   326

   327

			switch (v->type) {

   328

				case VEH_TRAIN:

   329

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

   330

					break;

   331

   332

				case VEH_ROAD:

   333

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

   334

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

   335

					} else {

   336

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

   337

					}

   338

					break;

   339

   340

				case VEH_SHIP:

   341

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

   342

					break;

   343

   344

				case VEH_AIRCRAFT:

   345

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

   346

						return CMD_ERROR;

   347

					}

   348

					break;

   349

   350

				default: return CMD_ERROR;

   351

			}

   352

   353

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

   354

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

   355

   356

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

   357

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

   358

   359

			/* Filter invalid load/unload types. */

   360

			switch (new_order.GetLoadType()) {

   361

				case OLF_LOAD_IF_POSSIBLE: case OLFB_FULL_LOAD: case OLF_FULL_LOAD_ANY: break;

   362

				default: return CMD_ERROR;

   363

			}

   364

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

   365

			break;

   366

		}

   367

   368

		case OT_GOTO_DEPOT: {

   372

   403

				}

   404

			} else {

   406

			}

   407

   408

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

   409

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

   411

			break;

   412

		}

   413

   414

		case OT_GOTO_WAYPOINT: {

   415

   416

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

   417

   418

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

   419

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

   420

   421

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

   422

   423

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

   424

			 * [non-stop]

   425

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

   426

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

   427

			break;

   428

		}

   429

   430

		default: return CMD_ERROR;

   431

	}

   432

   433

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

   434

   435

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

   436

   437

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

   438

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

   439

		const Order *prev = NULL;

   440

		uint n = 0;

   441

   442

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

   443

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

   444

		 * finds the last order in the list. */

   445

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

   446

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

   447

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

   448

		}

   449

		if (prev != NULL) {

   450

			uint dist = DistanceManhattan(

   451

				GetOrderLocation(*prev),

   452

				GetOrderLocation(new_order)

   453

			);

   454

			if (dist >= 130) {

   455

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   456

			}

   457

		}

   458

	}

   459

   460

	if (flags & DC_EXEC) {

   461

		Vehicle *u;

   462

		Order *new_o = new Order();

   463

		new_o->AssignOrder(new_order);

   464

   465

		/* Create new order and link in list */

   466

		if (v->orders == NULL) {

   467

			v->orders = new_o;

   468

		} else {

   469

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

   470

			    selected) */

   471

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

   472

   473

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

   474

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

   475

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

   476

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

   477

				    all vehicles */

   478

				SwapOrders(v->orders, new_o);

   479

				/* Now update the next pointers */

   480

				v->orders->next = new_o;

   481

			} else if (order == NULL) {

   482

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

   483

				order = GetLastVehicleOrder(v);

   484

				order->next = new_o;

   485

			} else {