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

    50

OrderNonStopFlags Order::GetNonStopType() const

    51

{

    52

	if (_patches.new_nonstop) {

    53

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

    54

	}

    55

    56

	return (this->flags & 0x08) ? ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS : ONSF_STOP_EVERYWHERE;

    57

}

    58

    59

void Order::Free()

    60

{

    61

	this->type  = OT_NOTHING;

    62

	this->flags = 0;

    63

	this->dest  = 0;

    64

	this->next  = NULL;

    65

}

    66

    67

void Order::MakeGoToStation(StationID destination)

    68

{

    69

	this->type = OT_GOTO_STATION;

    70

	this->flags = 0;

    71

	this->dest = destination;

    72

}

    73

    74

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

    75

{

    76

	this->type = OT_GOTO_DEPOT;

    77

	this->flags = 0;

    78

	this->SetDepotOrderType(order);

    79

	if (!(order & ODTFB_PART_OF_ORDERS)) {

    80

		this->SetNonStopType(ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS);

    81

	}

    82

	this->dest = destination;

    83

	this->SetRefit(cargo, subtype);

    84

}

    85

    86

void Order::MakeGoToWaypoint(WaypointID destination)

    87

{

    88

	this->type = OT_GOTO_WAYPOINT;

    89

	this->flags = 0;

    90

	this->dest = destination;

    91

}

    92

    93

void Order::MakeLoading(bool ordered)

    94

{

    95

	this->type = OT_LOADING;

    96

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

    97

}

    98

    99

void Order::MakeLeaveStation()

   100

{

   101

	this->type = OT_LEAVESTATION;

   102

	this->flags = 0;

   103

}

   104

   105

void Order::MakeDummy()

   106

{

   107

	this->type = OT_DUMMY;

   108

	this->flags = 0;

   109

}

   110

   111

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

   112

{

   113

	this->refit_cargo = cargo;

   114

	this->refit_subtype = subtype;

   115

}

   116

   117

void Order::FreeChain()

   118

{

   119

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

   120

	delete this;

   121

}

   122

   123

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

   124

{

   125

	return

   126

			this->type  == other.type &&

   127

			this->flags == other.flags &&

   128

			this->dest  == other.dest;

   129

}

   130

   131

static bool HasOrderPoolFree(uint amount)

   132

{

   133

	const Order *order;

   134

   135

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

   136

	if (_Order_pool.CanAllocateMoreBlocks()) return true;

   137

   138

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

   139

   140

	return false;

   141

}

   142

   143

uint32 Order::Pack() const

   144

{

   145

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

   146

}

   147

   148

Order::Order(uint32 packed)

   149

{

   150

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

   151

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

   152

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

   153

	this->next    = NULL;

   154

	this->refit_cargo   = CT_NO_REFIT;

   155

	this->refit_subtype = 0;

   156

	this->wait_time     = 0;

   157

	this->travel_time   = 0;

   158

}

   159

   160

/**

   161

 *

   162

 * Unpacks a order from savegames with version 4 and lower

   163

 *

   164

 */

   165

static Order UnpackVersion4Order(uint16 packed)

   166

{

   167

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

   168

}

   169

   170

/**

   171

 *

   172

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

   173

 *

   174

 */

   175

Order UnpackOldOrder(uint16 packed)

   176

{

   177

	Order order = UnpackVersion4Order(packed);

   178

   179

	/*

   180

	 * Sanity check

   181

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

   182

	 */

   183

	if (!order.IsValid() && (order.GetLoadType() != 0 || order.GetUnloadType() != 0 || order.GetDestination() != 0)) {

   184

		order.MakeDummy();

   185

	}

   186

   187

	return order;

   188

}

   189

   190

/**

   191

 *

   192

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

   193

 *

   194

 */

   195

void InvalidateVehicleOrder(const Vehicle *v)

   196

{

   197

	InvalidateWindow(WC_VEHICLE_VIEW,      v->index);

   198

	InvalidateWindow(WC_VEHICLE_ORDERS,    v->index);

   199

	InvalidateWindow(WC_VEHICLE_TIMETABLE, v->index);

   200

}

   201

   202

/**

   203

 *

   204

 * Swap two orders

   205

 *

   206

 */

   207

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

   208

{

   209

	Order temp_order;

   210

   211

	temp_order = *order1;

   212

	order1->AssignOrder(*order2);

   213

	order1->next = order2->next;

   214

	order2->AssignOrder(temp_order);

   215

	order2->next = temp_order.next;

   216

}

   217

   218

/**

   219

 *

   220

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

   221

 *   This function makes sure that the index is maintained correctly

   222

 *

   223

 */

   224

void Order::AssignOrder(const Order &other)

   225

{

   226

	this->type  = other.type;

   227

	this->flags = other.flags;

   228

	this->dest  = other.dest;

   229

   230

	this->refit_cargo   = other.refit_cargo;

   231

	this->refit_subtype = other.refit_subtype;

   232

   233

	this->wait_time   = other.wait_time;

   234

	this->travel_time = other.travel_time;

   235

}

   236

   237

   238

/**

   239

 * Delete all news items regarding defective orders about a vehicle

   240

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

   241

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

   242

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

   243

 */

   244

static void DeleteOrderWarnings(const Vehicle* v)

   245

{

   246

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

   247

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

   248

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

   249

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

   250

}

   251

   252

   253

static TileIndex GetOrderLocation(const Order& o)

   254

{

   255

	switch (o.GetType()) {

   256

		default: NOT_REACHED();

   257

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

   258

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

   259

	}

   260

}

   261

   262

   263

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

   264

 * @param tile unused

   265

 * @param flags operation to perform

   266

 * @param p1 various bitstuffed elements

   267

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

   268

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

   269

 *                        the order will be inserted before that one

   270

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

   271

 * @param p2 packed order to insert

   272

 */

   273

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

   274

{

   275

	Vehicle *v;

   276

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

   277

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

   278

	Order new_order(p2);

   279

   280

	if (!IsValidVehicleID(veh)) return CMD_ERROR;

   281

   282

	v = GetVehicle(veh);

   283

   284

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

   285

   286

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

   287

	 * and has the correct flags if any */

   288

	switch (new_order.GetType()) {

   289

		case OT_GOTO_STATION: {

   290

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

   291

   292

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

   293

   294

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

   295

				return CMD_ERROR;

   296

			}

   297

   298

			switch (v->type) {

   299

				case VEH_TRAIN:

   300

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

   301

					break;

   302

   303

				case VEH_ROAD:

   304

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

   305

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

   306

					} else {

   307

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

   308

					}

   309

					break;

   310

   311

				case VEH_SHIP:

   312

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

   313

					break;

   314

   315

				case VEH_AIRCRAFT:

   316

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

   317

						return CMD_ERROR;

   318

					}

   319

					break;

   320

   321

				default: return CMD_ERROR;

   322

			}

   323

   324

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

   325

			// TODO: implement properly once savegame bump is done. if ((new_order.GetNonStopType() & ONSF_NO_STOP_AT_INTERMEDIATE_STATIONS) != 0 && v->type != VEH_TRAIN) return CMD_ERROR;

   326

   327

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

   328

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

   329

   330

			/* Filter invalid load/unload types. */

   335

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

   336

			break;

   337

		}

   338

   339

		case OT_GOTO_DEPOT: {

   340

			if (v->type == VEH_AIRCRAFT) {

   341

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

   342

   343

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

   344

   345

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

   346

						!(st->facilities & FACIL_AIRPORT) ||

   347

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

   348

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

   349

					return CMD_ERROR;

   350

				}

   351

			} else {

   352

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

   353

   354

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

   355

   356

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

   357

   358

				switch (v->type) {

   359

					case VEH_TRAIN:

   360

						if (!IsTileDepotType(dp->xy, TRANSPORT_RAIL)) return CMD_ERROR;

   361

						break;

   362

   363

					case VEH_ROAD:

   364

						if (!IsTileDepotType(dp->xy, TRANSPORT_ROAD)) return CMD_ERROR;

   365

						break;

   366

   367

					case VEH_SHIP:

   368

						if (!IsTileDepotType(dp->xy, TRANSPORT_WATER)) return CMD_ERROR;

   369

						break;

   370

   371

					default: return CMD_ERROR;

   372

				}

   373

			}

   374

   375

			// TODO: implement properly once savegame bump is done. if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   376

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

   377

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

   378

			break;

   379

		}

   380

   381

		case OT_GOTO_WAYPOINT: {

   382

   383

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

   384

   385

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

   386

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

   387

   388

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

   389

   390

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

   391

			 * [non-stop]

   392

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

   393

			// TODO: implement properly once savegame bump is done. if (new_order.GetNonStopType() != ONSF_STOP_EVERYWHERE && v->type != VEH_TRAIN) return CMD_ERROR;

   394

   395

			break;

   396

		}

   397

   398

		default: return CMD_ERROR;

   399

	}

   400

   401

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

   402

   403

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

   404

   405

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

   406

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

   407

		const Order *prev = NULL;

   408

		uint n = 0;

   409

   410

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

   411

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

   412

		 * finds the last order in the list. */

   413

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

   414

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

   415

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

   416

		}

   417

		if (prev != NULL) {

   418

			uint dist = DistanceManhattan(

   419

				GetOrderLocation(*prev),

   420

				GetOrderLocation(new_order)

   421

			);

   422

			if (dist >= 130) {

   423

				return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   424

			}

   425

		}

   426

	}

   427

   428

	if (flags & DC_EXEC) {

   429

		Vehicle *u;

   430

		Order *new_o = new Order();

   431

		new_o->AssignOrder(new_order);

   432

   433

		/* Create new order and link in list */

   434

		if (v->orders == NULL) {

   435

			v->orders = new_o;

   436

		} else {

   437

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

   438

			    selected) */

   439

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

   440

   441

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

   442

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

   443

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

   444

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

   445

				    all vehicles */

   446

				SwapOrders(v->orders, new_o);

   447

				/* Now update the next pointers */

   448

				v->orders->next = new_o;

   449

			} else if (order == NULL) {

   450

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

   451

				order = GetLastVehicleOrder(v);

   452

				order->next = new_o;

   453

			} else {

   454

				/* Put the new order in between */

   455

				new_o->next = order->next;

   456

				order->next = new_o;

   457

			}

   458

		}

   459

   460

		u = GetFirstVehicleFromSharedList(v);

   461

		DeleteOrderWarnings(u);

   462

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

   463

			/* Increase amount of orders */

   464

			u->num_orders++;

   465

   466

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

   467

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

   468

   469

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

   470

   471

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

   472

			to update the selected order */

   473

			if (sel_ord <= u->cur_order_index) {

   474

				uint cur = u->cur_order_index + 1;

   475

				/* Check if we don't go out of bound */

   476

				if (cur < u->num_orders)

   477

					u->cur_order_index = cur;

   478

			}

   479

			/* Update any possible open window of the vehicle */

   480

			InvalidateVehicleOrder(u);

   481

		}

   482

   483

		/* Make sure to rebuild the whole list */

   484

		RebuildVehicleLists();