1

#include "stdafx.h"

     2

#include "ttd.h"

     3

#include "airport.h"

     4

#include "depot.h"

     5

#include "table/strings.h"

     6

#include "vehicle.h"

     7

#include "waypoint.h"

     8

#include "command.h"

     9

#include "station.h"

    10

#include "player.h"

    11

#include "news.h"

    12

#include "saveload.h"

    13

    14

enum {

    15

	/* Max orders: 64000 (64 * 1000) */

    16

	ORDER_POOL_BLOCK_SIZE_BITS = 6,       /* In bits, so (1 << 6) == 64 */

    17

	ORDER_POOL_MAX_BLOCKS      = 1000,

    18

};

    19

    20

/**

    21

 * Called if a new block is added to the order-pool

    22

 */

    23

static void OrderPoolNewBlock(uint start_item)

    24

{

    25

	Order *order;

    26

    27

	FOR_ALL_ORDERS_FROM(order, start_item)

    28

		order->index = start_item++;

    29

}

    30

    31

/* Initialize the order-pool */

    32

MemoryPool _order_pool = { "Orders", ORDER_POOL_MAX_BLOCKS, ORDER_POOL_BLOCK_SIZE_BITS, sizeof(Order), &OrderPoolNewBlock, 0, 0, NULL };

    33

    34

/**

    35

 *

    36

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

    37

 *

    38

 */

    39

Order UnpackOldOrder(uint16 packed)

    40

{

    41

	Order order;

    42

	order.type    = (packed & 0x000F);

    43

	order.flags   = (packed & 0x00F0) >> 4;

    44

	order.station = (packed & 0xFF00) >> 8;

    45

	order.next    = NULL;

    46

    47

	// Sanity check

    48

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

    49

	if (order.type == OT_NOTHING && (order.flags != 0 || order.station != 0)) {

    50

		order.type = OT_DUMMY;

    51

		order.flags = 0;

    52

	}

    53

    54

	return order;

    55

}

    56

    57

/**

    58

 *

    59

 * Unpacks a order from savegames with version 4 and lower

    60

 *

    61

 */

    62

Order UnpackVersion4Order(uint16 packed)

    63

{

    64

	Order order;

    65

	order.type    = (packed & 0x000F);

    66

	order.flags   = (packed & 0x00F0) >> 4;

    67

	order.station = (packed & 0xFF00) >> 8;

    68

	order.next    = NULL;

    69

	return order;

    70

}

    71

    72

/**

    73

 *

    74

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

    75

 *

    76

 */

    77

void InvalidateVehicleOrder(const Vehicle *v)

    78

{

    79

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    80

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    81

}

    82

    83

/**

    84

 *

    85

 * Swap two orders

    86

 *

    87

 */

    88

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

    89

{

    90

	Order temp_order;

    91

    92

	temp_order = *order1;

    93

	AssignOrder(order1, *order2);

    94

	order1->next = order2->next;

    95

	AssignOrder(order2, temp_order);

    96

	order2->next = temp_order.next;

    97

}

    98

    99

/**

   100

 *

   101

 * Allocate a new order

   102

 *

   103

 * @return Order* if a free space is found, else NULL.

   104

 *

   105

 */

   106

static Order *AllocateOrder(void)

   107

{

   108

	Order *order;

   109

   110

	FOR_ALL_ORDERS(order) {

   111

		if (order->type == OT_NOTHING) {

   112

			uint index = order->index;

   113

   114

			memset(order, 0, sizeof(Order));

   115

			order->index = index;

   116

			order->next = NULL;

   117

   118

			return order;

   119

		}

   120

	}

   121

   122

	/* Check if we can add a block to the pool */

   123

	if (AddBlockToPool(&_order_pool))

   124

		return AllocateOrder();

   125

   126

	return NULL;

   127

}

   128

   129

/**

   130

 *

   131

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

   132

 *   This function makes sure that the index is maintained correctly

   133

 *

   134

 */

   135

void AssignOrder(Order *order, Order data)

   136

{

   137

	order->type    = data.type;

   138

	order->flags   = data.flags;

   139

	order->station = data.station;

   140

}

   141

   142

/**

   143

 *

   144

 * Add an order to the orderlist of a vehicle

   145

 *

   146

 * @param veh_sel      First 16 bits are the ID of the vehicle. The next 16 are the selected order (if any)

   147

 *                       If the lastone is given, order will be inserted above thatone

   148

 * @param packed_order Packed order to insert

   149

 *

   150

 */

   151

int32 CmdInsertOrder(int x, int y, uint32 flags, uint32 veh_sel, uint32 packed_order)

   152

{

   153

	Vehicle *v;

   154

	int sel         = veh_sel >> 16;

   155

	Order new_order = UnpackOrder(packed_order);

   156

   157

	if (!IsVehicleIndex(veh_sel & 0xFFFF)) return CMD_ERROR;

   158

	v = GetVehicle(veh_sel & 0xFFFF);

   159

	if (v->type == 0 || !CheckOwnership(v->owner)) return CMD_ERROR;

   160

   161

	switch (new_order.type) {

   162

		case OT_GOTO_STATION: {

   163

			const Station* st;

   164

   165

			if (!IsStationIndex(new_order.station)) return CMD_ERROR;

   166

			st = GetStation(new_order.station);

   167

   168

			if (!IsValidStation(st) ||

   170

				return CMD_ERROR;

   171

			}

   172

   173

			switch (v->type) {

   174

				case VEH_Train:

   175

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

   176

					break;

   177

   178

				case VEH_Road:

   179

					if (v->cargo_type == CT_PASSENGERS) {

   180

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

   181

					} else {

   182

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

   183

					}

   184

					break;

   185

   186

				case VEH_Ship:

   187

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

   188

					break;

   189

   190

				case VEH_Aircraft:

   191

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

   192

					break;

   193

   194

				default:

   195

					return CMD_ERROR;

   196

			}

   197

   198

			switch (new_order.flags) {

   199

				case 0:

   200

				case OF_FULL_LOAD:

   201

				case OF_UNLOAD:

   202

				case OF_NON_STOP:

   203

				case OF_NON_STOP | OF_FULL_LOAD:

   204

				case OF_NON_STOP | OF_UNLOAD:

   205

					break;

   206

   207

				default:

   208

					return CMD_ERROR;

   209

			}

   210

			break;

   211

		}

   212

   213

		case OT_GOTO_DEPOT: {

   214

			if (v->type == VEH_Aircraft) {

   215

				const Station* st;

   216

   217

				if (!IsStationIndex(new_order.station)) return CMD_ERROR;

   218

				st = GetStation(new_order.station);

   219

   220

				if (!IsValidStation(st) ||

   221

						(st->airport_type != AT_OILRIG && !CheckOwnership(st->owner)) ||

   222

						!(st->facilities & FACIL_AIRPORT) ||

   223

						GetAirport(st->airport_type)->nof_depots == 0) {

   224

					return CMD_ERROR;

   225

				}

   226

			} else {

   227

				const Depot* dp;

   228

   229

				if (!IsDepotIndex(new_order.station)) return CMD_ERROR;

   230

				dp = GetDepot(new_order.station);

   231

   232

				if (!IsValidDepot(dp) ||

   233

						!CheckOwnership(GetTileOwner(dp->xy))) {

   234

					return CMD_ERROR;

   235

				}

   236

   237

				switch (v->type) {

   238

					case VEH_Train:

   239

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

   240

						break;

   241

   242

					case VEH_Road:

   243

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

   244

						break;

   245

   246

					case VEH_Ship:

   247

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

   248

						break;

   249

   250

					default:

   251

						return CMD_ERROR;

   252

				}

   253

			}

   254

   255

			switch (new_order.flags) {

   256

				case OF_PART_OF_ORDERS:

   257

				case OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   258

				case OF_NON_STOP | OF_PART_OF_ORDERS:

   259

				case OF_NON_STOP | OF_PART_OF_ORDERS | OF_HALT_IN_DEPOT:

   260

					break;

   261

   262

				default:

   263

					return CMD_ERROR;

   264

			}

   265

			break;

   266

		}

   267

   268

		case OT_GOTO_WAYPOINT: {

   269

			const Waypoint* wp;

   270

   271

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

   272

   273

			if (!IsWaypointIndex(new_order.station)) return CMD_ERROR;

   274

			wp = GetWaypoint(new_order.station);

   275

   276

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

   277

   278

			switch (new_order.flags) {

   279

				case 0:

   280

				case OF_NON_STOP:

   281

					break;

   282

   283

				default:

   284

					return CMD_ERROR;

   285

			}

   286

			break;

   287

		}

   288

   289

		default:

   290

			return CMD_ERROR;

   291

	}

   292

   293

	if (sel > v->num_orders)

   294

		return_cmd_error(STR_EMPTY);

   295

   296

	if (IsOrderPoolFull())

   297

		return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   298

   299

	/* XXX - This limit is only here because the backuppedorders can't

   300

	    handle any more then this.. */

   301

	if (v->num_orders >= 40)

   302

		return_cmd_error(STR_8832_TOO_MANY_ORDERS);

   303

   304

	/* For ships, make sure that the station is not too far away from the

   305

	 * previous destination, for human players with new pathfinding disabled */

   306

	if (v->type == VEH_Ship && IS_HUMAN_PLAYER(v->owner) &&

   307

		sel != 0 && GetVehicleOrder(v, sel - 1)->type == OT_GOTO_STATION

   308

		&& !_patches.new_pathfinding_all) {

   309

   310

		int dist = DistanceManhattan(

   311

			GetStation(GetVehicleOrder(v, sel - 1)->station)->xy,

   312

			GetStation(new_order.station)->xy // XXX type != OT_GOTO_STATION?

   313

		);

   314

		if (dist >= 130)

   315

			return_cmd_error(STR_0210_TOO_FAR_FROM_PREVIOUS_DESTINATIO);

   316

	}

   317

   318

	if (flags & DC_EXEC) {

   319

		Order *new;

   320

		Vehicle *u;

   321

   322

		new = AllocateOrder();

   323

		AssignOrder(new, new_order);

   324

   325

		/* Create new order and link in list */

   326

		if (v->orders == NULL) {

   327

			v->orders = new;

   328

		} else {

   329

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

   330

			    selected) */

   331

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

   332

   333

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

   334

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

   335

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

   336

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

   337

				    all vehicles */

   338

				SwapOrders(v->orders, new);

   339

				/* Now update the next pointers */

   340

				v->orders->next = new;

   341

			} else if (order == NULL) {

   342

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

   343

				order = GetLastVehicleOrder(v);

   344

				order->next = new;

   345

			} else {

   346

				/* Put the new order in between */

   347

				new->next = order->next;

   348

				order->next = new;

   349

			}

   350

		}

   351

   352

		u = GetFirstVehicleFromSharedList(v);

   353

		while (u != NULL) {

   354

			/* Increase amount of orders */

   355

			u->num_orders++;

   356

   357

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

   358

			if (u->orders == NULL)

   359

				u->orders = v->orders;

   360

   361

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

   362

   363

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

   364

			to update the selected order */

   365

			if (sel <= u->cur_order_index) {

   366

				uint cur = u->cur_order_index + 1;

   367

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

   368

				if (cur < u->num_orders)

   369

					u->cur_order_index = cur;

   370

			}

   371

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

   372

			InvalidateVehicleOrder(u);

   373

   374

			u = u->next_shared;

   375

		}

   376

   377

		/* Make sure to rebuild the whole list */

   378

		RebuildVehicleLists();

   379

	}

   380

   381

	return 0;

   382

}

   383

   384

/**

   385

 *

   386

 * Declone an order-list

   387

 *

   388

 */

   389

static int32 DecloneOrder(Vehicle *dst, uint32 flags)

   390

{

   391

	if (flags & DC_EXEC) {

   392

		/* Delete orders from vehicle */

   393

		DeleteVehicleOrders(dst);

   394

   395

		InvalidateVehicleOrder(dst);

   396

		RebuildVehicleLists();

   397

	}

   398

	return 0;

   399

}

   400

   401

/**

   402

 *

   403

 * Delete an order from the orderlist of a vehicle

   404

 *

   405

 * @param vehicle_id The ID of the vehicle

   406

 * @param selected   The order to delete

   407

 *

   408

 */

   409

int32 CmdDeleteOrder(int x, int y, uint32 flags, uint32 vehicle_id, uint32 selected)

   410

{

   411

	Vehicle *v;

   412

	Vehicle *u;

   413

	uint sel   = selected;

   414

	Order *order;

   415

   416

	if (!IsVehicleIndex(vehicle_id)) return CMD_ERROR;

   417

	v = GetVehicle(vehicle_id);

   418

	if (v->type == 0 || !CheckOwnership(v->owner)) return CMD_ERROR;

   419

   420

	/* XXX -- Why is this here? :s */

   421

	_error_message = STR_EMPTY;

   422

   423

	/* If we did not select an order, we maybe want to de-clone the orders */

   424

	if (sel >= v->num_orders)

   425

		return DecloneOrder(v, flags);

   426

   427

	order = GetVehicleOrder(v, sel);

   428

	if (order == NULL)

   429

		return CMD_ERROR;

   430

   431

	if (flags & DC_EXEC) {

   432

		if (GetVehicleOrder(v, sel - 1) == NULL) {

   433

			if (GetVehicleOrder(v, sel + 1) != NULL) {

   434

				/* First item, but not the last, so we need to alter v->orders

   435

				    Because we can have shared order, we copy the data

   436

				    from the next item over the deleted */

   437

				order = GetVehicleOrder(v, sel + 1);

   438

				SwapOrders(v->orders, order);

   439

			} else {

   440

				/* Last item, so clean the list */

   441

				v->orders = NULL;

   442

			}

   443

		} else {

   444

			GetVehicleOrder(v, sel - 1)->next = order->next;

   445

		}

   446

   447

		/* Give the item free */

   448

		order->type = OT_NOTHING;

   449

		order->next = NULL;

   450

   451

		u = GetFirstVehicleFromSharedList(v);

   452

		while (u != NULL) {

   453

			u->num_orders--;

   454

   455

			if (sel < u->cur_order_index)

   456

				u->cur_order_index--;

   457

   458

			/* If we removed the last order, make sure the shared vehicles

   459

			    also set their orders to NULL */

   460

			if (v->orders == NULL)

   461

				u->orders = NULL;

   462

   463

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

   464

   465

			/* NON-stop flag is misused to see if a train is in a station that is

   466

			    on his order list or not */

   467

			if (sel == u->cur_order_index &&

   468

					u->current_order.type == OT_LOADING &&

   469

					HASBIT(u->current_order.flags, OFB_NON_STOP)) {

   470

				u->current_order.flags = 0;

   471

			}

   472

   473

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

   474

			InvalidateVehicleOrder(u);

   475

   476

			u = u->next_shared;

   477

		}

   478

   479

		RebuildVehicleLists();

   480

	}

   481

   482

	return 0;

   483

}

   484

   485

/**

   486

 *

   487

 * Goto next order of order-list

   488

 *

   489

 * @param vehicle_id The ID of the vehicle

   490

 *

   491

 */

   492

int32 CmdSkipOrder(int x, int y, uint32 flags, uint32 vehicle_id, uint32 not_used)

   493

{