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

    29

#include "table/strings.h"

    30

    31

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

    32

 * be any of them

    33

 */

    34

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

    35

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

    36

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

    37

    38

TileIndex _backup_orders_tile;

    39

BackuppedOrders _backup_orders_data;

    40

    41

DEFINE_OLD_POOL_GENERIC(Order, Order)

    42

    43

void Order::Free()

    44

{

    45

	this->type  = OT_NOTHING;

    46

	this->flags = 0;

    47

	this->dest  = 0;

    48

	this->next  = NULL;

    49

}

    50

    51

void Order::MakeGoToStation(StationID destination)

    52

{

    53

	this->type = OT_GOTO_STATION;

    54

	this->flags = 0;

    55

	this->dest = destination;

    56

}

    57

    58

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

    59

{

    60

	this->type = OT_GOTO_DEPOT;

    61

	this->flags = order ? OFB_PART_OF_ORDERS : OFB_NON_STOP;

    62

	this->dest = destination;

    63

	this->SetRefit(cargo, subtype);

    64

}

    65

    66

void Order::MakeGoToWaypoint(WaypointID destination)

    67

{

    68

	this->type = OT_GOTO_WAYPOINT;

    69

	this->flags = 0;

    70

	this->dest = destination;

    71

}

    72

    73

void Order::MakeLoading()

    74

{

    75

	this->type = OT_LOADING;

    76

}

    77

    78

void Order::MakeLeaveStation()

    79

{

    80

	this->type = OT_LEAVESTATION;

    81

	this->flags = 0;

    82

}

    83

    84

void Order::MakeDummy()

    85

{

    86

	this->type = OT_DUMMY;

    87

	this->flags = 0;

    88

}

    89

    90

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

    91

{

    92

	this->refit_cargo = cargo;

    93

	this->refit_subtype = subtype;

    94

}

    95

    96

void Order::FreeChain()

    97

{

    98

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

    99

	delete this;

   100

}

   101

   102

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

   103

{

   104

	return

   105

			this->type  == other.type &&

   106

			this->flags == other.flags &&

   107

			this->dest  == other.dest;

   108

}

   109

   110

static bool HasOrderPoolFree(uint amount)

   111

{

   112

	const Order *order;

   113

   114

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

   115

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   116

   117

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

   118

   119

	return false;

   120

}

   121

   122

uint32 Order::Pack() const

   123

{

   124

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

   125

}

   126

   127

Order::Order(uint32 packed)

   128

{

   129

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

   130

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

   131

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

   132

	this->next    = NULL;

   133

	this->index   = 0; // avoid compiler warning

   134

	this->refit_cargo   = CT_NO_REFIT;

   135

	this->refit_subtype = 0;

   136

	this->wait_time     = 0;

   137

	this->travel_time   = 0;

   138

}

   139

   140

/**

   141

 *

   142

 * Unpacks a order from savegames with version 4 and lower

   143

 *

   144

 */

   145

static Order UnpackVersion4Order(uint16 packed)

   146

{

   147

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

   148

}

   149

   150

/**

   151

 *

   152

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

   153

 *

   154

 */

   155

Order UnpackOldOrder(uint16 packed)

   156

{

   157

	Order order = UnpackVersion4Order(packed);

   158

   159

	/*

   160

	 * Sanity check

   161

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

   162

	 */

   164

		order.MakeDummy();

   165

	}

   166

   167

	return order;

   168

}

   169

   170

/**

   171

 *

   172

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

   173

 *

   174

 */

   175

void InvalidateVehicleOrder(const Vehicle *v)

   176

{

   177

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   178

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   179

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   180

}

   181

   182

/**

   183

 *

   184

 * Swap two orders

   185

 *

   186

 */

   187

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

   188

{

   189

	Order temp_order;

   190

   191

	temp_order = *order1;

   192

	order1->AssignOrder(*order2);

   193

	order1->next = order2->next;

   194

	order2->AssignOrder(temp_order);

   195

	order2->next = temp_order.next;

   196

}

   197

   198

/**

   199

 *

   200

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

   201

 *   This function makes sure that the index is maintained correctly

   202

 *

   203

 */

   204

void Order::AssignOrder(const Order &other)

   205

{

   206

	this->type  = other.type;

   207

	this->flags = other.flags;

   208

	this->dest  = other.dest;

   209

   210

	this->refit_cargo   = other.refit_cargo;

   211

	this->refit_subtype = other.refit_subtype;

   212

   213

	this->wait_time   = other.wait_time;

   214

	this->travel_time = other.travel_time;

   215

}

   216

   217

   218

/**

   219

 * Delete all news items regarding defective orders about a vehicle

   220

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

   221

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

   222

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

   223

 */

   224

static void DeleteOrderWarnings(const Vehicle* v)

   225

{

   226

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

   227

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

   228

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

   229

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

   230

}

   231

   232

   233

static TileIndex GetOrderLocation(const Order& o)

   234

{

   235

	switch (o.GetType()) {

   236

		default: NOT_REACHED();

   239

	}

   240

}

   241

   242

   243

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

   244

 * @param tile unused

   245

 * @param flags operation to perform

   246

 * @param p1 various bitstuffed elements

   247

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

   248

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

   249

 *                        the order will be inserted before that one

   250

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

   251

 * @param p2 packed order to insert

   252

 */

   253

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

   254

{

   255

	Vehicle *v;

   256

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

   257

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

   258

	Order new_order(p2);

   259

   260

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   261

   262

	v = GetVehicle(veh);

   263

   264

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

   265

   266

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

   267

	 * and has the correct flags if any */

   268

	switch (new_order.GetType()) {

   269

		case OT_GOTO_STATION: {

   271

   273

   274

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

   275

				return CMD_ERROR;

   276

			}

   277

   278

			switch (v->type) {

   279

				case VEH_TRAIN:

   280

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

   281

					break;

   282

   283

				case VEH_ROAD:

   284

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

   285

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

   286

					} else {

   287

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

   288

					}

   289

					break;

   290

   291

				case VEH_SHIP:

   292

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

   293

					break;

   294

   295

				case VEH_AIRCRAFT:

   296

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

   297

						return CMD_ERROR;

   298

					}

   299

					break;

   300

   301

				default: return CMD_ERROR;

   302

			}

   303

   304

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

   305

			 * [full-load | unload] [+ transfer] [+ non-stop]

   306

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

   307

			switch (new_order.flags) {

   308

				case 0:

   309

				case OFB_FULL_LOAD:

   310

				case OFB_FULL_LOAD | OFB_TRANSFER:

   311

				case OFB_UNLOAD:

   312

				case OFB_UNLOAD | OFB_TRANSFER:

   313

				case OFB_TRANSFER:

   314

					break;

   315

   316

				case OFB_NON_STOP:

   317

				case OFB_NON_STOP | OFB_FULL_LOAD:

   318

				case OFB_NON_STOP | OFB_FULL_LOAD | OFB_TRANSFER:

   319

				case OFB_NON_STOP | OFB_UNLOAD:

   320

				case OFB_NON_STOP | OFB_UNLOAD | OFB_TRANSFER:

   321

				case OFB_NON_STOP | OFB_TRANSFER:

   322

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

   323

					break;

   324

   325

				default: return CMD_ERROR;

   326

			}

   327

			break;

   328

		}

   329

   330

		case OT_GOTO_DEPOT: {

   331

			if (v->type == VEH_AIRCRAFT) {

   333

   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 {

   344

   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

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

   367

			 * order [+ halt] [+ non-stop]

   368

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

   369

			switch (new_order.flags) {

   370

				case OFB_PART_OF_ORDERS:

   371

				case OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   372

					break;

   373

   374

				case OFB_NON_STOP | OFB_PART_OF_ORDERS:

   375

				case OFB_NON_STOP | OFB_PART_OF_ORDERS | OFB_HALT_IN_DEPOT:

   376

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

   377

					break;

   378

   379

				default: return CMD_ERROR;

   380

			}

   381

			break;

   382

		}

   383

   384

		case OT_GOTO_WAYPOINT: {

   385

   386

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

   387

   390

   391

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

   392

   393

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

   394

			 * [non-stop]

   395

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

   396

			switch (new_order.flags) {

   397

				case 0: break;

   398

   399

				case OFB_NON_STOP:

   400

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

   401

					break;

   402

   403

				default: return CMD_ERROR;

   404

			}

   405

			break;

   406

		}

   407

   408

		default: return CMD_ERROR;

   409

	}

   410

   411

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

   412

   413

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

   414

   415

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

   416

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

   417

		const Order *prev = NULL;

   418

		uint n = 0;

   419

   420

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

   421

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

   422

		 * finds the last order in the list. */

   423

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

   424

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

   425

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

   426

		}

   427

		if (prev != NULL) {

   428

			uint dist = DistanceManhattan(

   429

				GetOrderLocation(*prev),

   430

				GetOrderLocation(new_order)

   431

			);

   432

			if (dist >= 130) {

   433

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   434

			}

   435

		}

   436

	}

   437

   438

	if (flags & DC_EXEC) {

   439

		Vehicle *u;

   440

		Order *new_o = new Order();

   441

		new_o->AssignOrder(new_order);

   442

   443

		/* Create new order and link in list */

   444

		if (v->orders == NULL) {

   445

			v->orders = new_o;

   446

		} else {

   447

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

   448

			    selected) */

   449

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

   450

   451

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

   452

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

   453

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

   454

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

   455

				    all vehicles */

   456

				SwapOrders(v->orders, new_o);

   457

				/* Now update the next pointers */

   458

				v->orders->next = new_o;

   459

			} else if (order == NULL) {

   460

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

   461

				order = GetLastVehicleOrder(v);

   462

				order->next = new_o;

   463

			} else {

   464

				/* Put the new order in between */

   465

				new_o->next = order->next;

   466

				order->next = new_o;

   467

			}

   468

		}

   469

   470

		u = GetFirstVehicleFromSharedList(v);

   471

		DeleteOrderWarnings(u);

   472

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

   473

			/* Increase amount of orders */

   474

			u->num_orders++;

   475

   476

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

   477

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

   478

   479

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

   480

   481

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

   482

			to update the selected order */

   483

			if (sel_ord <= u->cur_order_index) {

   484

				uint cur = u->cur_order_index + 1;