9

#include "saveload.h"

    11

/**

    12

 *

    13

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

    14

 *

    16

Order UnpackOldOrder(uint16 packed)

    18

	Order order;

    19

	order.type    = (packed & 0x000F);

    20

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

    21

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

    22

	order.next    = NULL;

    24

	// Sanity check

    25

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

    26

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

    27

		order.type = OT_DUMMY;

    28

		order.flags = 0;

    29

	}

    31

	return order;

    32

}

    33

    34

/**

    35

 *

    36

 * Unpacks a order from savegames with version 4 and lower

    37

 *

    38

 */

    39

Order UnpackVersion4Order(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

	return order;

    47

}

    48

    49

/**

    50

 *

    51

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

    52

 *

    53

 */

    54

void InvalidateVehicleOrder(const Vehicle *v)

    55

{

    56

	InvalidateWindow(WC_VEHICLE_VIEW,   v->index);

    57

	InvalidateWindow(WC_VEHICLE_ORDERS, v->index);

    58

}

    59

    60

/**

    61

 *

    62

 * Swap two orders

    63

 *

    64

 */

    65

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

    66

{

    67

	Order temp_order;

    68

    69

	temp_order = *order1;

    70

	*order1 = *order2;

    71

	*order2 = temp_order;

    72

}

    73

    74

/**

    75

 *

    76

 * Allocate a new order

    77

 *

    78

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

    79

 *

    80

 */

    81

static Order *AllocateOrder()

    82

{

    83

	Order *order;

    84

    85

	FOR_ALL_ORDERS(order) {

    86

		if (order->type == OT_NOTHING) {

    87

			uint index = order->index;

    88

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

    89

			order->index = index;

    90

			return order;

    91

		}

    92

	}

    93

    94

	return NULL;

    95

}

    96

    97

/**

    98

 *

    99

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

   100

 *   This function makes sure that the index is maintained correctly

   101

 *

   102

 */

   103

void AssignOrder(Order *order, Order data)

   104

{

   105

	order->type    = data.type;

   106

	order->flags   = data.flags;

   107

	order->station = data.station;

   108

}

   109

   110

/**

   111

 *

   112

 * Add an order to the orderlist of a vehicle

   113

 *

   114

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

   115

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

   116

 * @param packed_order Packed order to insert

   117

 *

   118

 */

   119

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

   120

{

   121

	Vehicle *v      = GetVehicle(veh_sel & 0xFFFF);

   122

	int sel         = veh_sel >> 16;

   123

	Order new_order = UnpackOrder(packed_order);

   124

   125

	if (sel > v->num_orders)

   126

		return_cmd_error(STR_EMPTY);

   127

   128

	if (IsOrderPoolFull())

   129

		return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   130

   131

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

   132

	    handle any more then this.. */

   133

	if (v->num_orders >= 40)

   134

		return_cmd_error(STR_8832_TOO_MANY_ORDERS);

   135

   136

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

   138

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

   141

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

   149

		Order *new;

   152

		new = AllocateOrder();

   153

		AssignOrder(new, new_order);

   155

		/* Create new order and link in list */

   156

		if (v->orders == NULL) {

   157

			v->orders = new;

   158

		} else {

   159

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

   160

			    selected) */

   161

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

   163

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

   164

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

   165

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

   166

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

   167

				    all vehicles */

   168

				SwapOrders(v->orders, new);

   169

				/* Now update the next pointers */

   170

				v->orders->next = new;

   171

			} else if (order == NULL) {

   172

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

   173

				order = GetLastVehicleOrder(v);

   174

				order->next = new;

   175

			} else {

   176

				/* Put the new order in between */

   177

				new->next = order->next;

   178

				order->next = new;

   182

		u = GetFirstVehicleFromSharedList(v);

   183

		while (u != NULL) {

   184

			/* Increase amount of orders */

   185

			u->num_orders++;

   186

   187

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

   188

			if (u->orders == NULL)

   189

				u->orders = v->orders;

   190

   191

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

   192

   193

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

   194

			to update the selected order */

   195

			if (sel <= u->cur_order_index) {

   196

				uint cur = u->cur_order_index + 1;

   197

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

   198

				if (cur < u->num_orders)

   199

					u->cur_order_index = cur;

   200

			}

   201

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

   202

			InvalidateVehicleOrder(u);

   203

   204

			u = u->next_shared;

   205

		}

   206

   207

		/* Make sure to rebuild the whole list */

   214

/**

   215

 *

   216

 * Declone an order-list

   217

 *

   218

 */

   222

		/* Delete orders from vehicle */

   223

		DeleteVehicleOrders(dst);

   225

		InvalidateVehicleOrder(dst);

   231

/**

   232

 *

   233

 * Delete an order from the orderlist of a vehicle

   234

 *

   235

 * @param vehicle_id The ID of the vehicle

   236

 * @param selected   The order to delete

   237

 *

   239

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

   241

	Vehicle *v = GetVehicle(vehicle_id), *u;

   242

	uint sel   = selected;

   243

	Order *order;

   245

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

   247

   248

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

   252

	order = GetVehicleOrder(v, sel);

   253

	if (order == NULL)

   254

		return CMD_ERROR;

   256

	if (flags & DC_EXEC) {

   257

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

   258

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

   259

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

   260

				    Because we can have shared order, we copy the data

   261

				    from the next item over the deleted */

   262

				order = GetVehicleOrder(v, sel + 1);

   263

				SwapOrders(v->orders, order);

   264

			} else {

   265

				/* Last item, so clean the list */

   266

				v->orders = NULL;

   267

			}

   268

		} else {

   269

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

   270

		}

   272

		/* Give the item free */

   273

		order->type = OT_NOTHING;

   275

		u = GetFirstVehicleFromSharedList(v);

   276

		while (u != NULL) {

   277

			u->num_orders--;

   278

   279

			if (sel < u->cur_order_index)

   280

				u->cur_order_index--;

   281

   282

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

   283

			    also set their orders to NULL */

   284

			if (v->orders == NULL)

   285

				u->orders = NULL;

   286

   287

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

   288

   289

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

   290

			    on his order list or not */

   291

			if (sel == u->cur_order_index &&

   292

					u->current_order.type == OT_LOADING &&

   293

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

   294

				u->current_order.flags = 0;

   296

   297

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

   298

			InvalidateVehicleOrder(u);

   299

   300

			u = u->next_shared;

   309

/**

   310

 *

   311

 * Goto next order of order-list

   312

 *

   313

 * @param vehicle_id The ID of the vehicle

   314

 *

   315

 */

   316

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

   318

	Vehicle *v = GetVehicle(vehicle_id);

   321

		/* Goto next order */

   324

			if (b >= v->num_orders)

   325

				b = 0;

   326

   333

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

   334

		    on his order list or not */

   336

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

   340

		InvalidateVehicleOrder(v);

   343

	/* We have an aircraft/ship, they have a mini-schedule, so update them all */

   350

   351

/**

   352

 *

   353

 * Add an order to the orderlist of a vehicle

   354

 *

   355

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

   356

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

   357

 * @param mode         Mode to change the order to

   358

 *

   360

int32 CmdModifyOrder(int x, int y, uint32 flags, uint32 veh_sel, uint32 mode)

   362

	Vehicle *v = GetVehicle(veh_sel & 0xFFFF);

   363

	byte sel = veh_sel >> 16;

   364

	Order *order;

   366

	/* Is it a valid order? */

   370

	order = GetVehicleOrder(v, sel);

   371

	if (order->type != OT_GOTO_STATION &&

   372

			(order->type != OT_GOTO_DEPOT || mode == OFB_UNLOAD) &&

   373

			(order->type != OT_GOTO_WAYPOINT || mode != OFB_NON_STOP))

   377

		switch (mode) {

   378

		case OFB_FULL_LOAD:

   379

			TOGGLEBIT(order->flags, OFB_FULL_LOAD);

   380

			if (order->type != OT_GOTO_DEPOT)

   381

				CLRBIT(order->flags, OFB_UNLOAD);

   383

		case OFB_UNLOAD:

   384

			TOGGLEBIT(order->flags, OFB_UNLOAD);

   385

			CLRBIT(order->flags, OFB_FULL_LOAD);

   387

		case OFB_NON_STOP:

   388

			TOGGLEBIT(order->flags, OFB_NON_STOP);

   392

		/* Update the windows, also for vehicles that share the same order list */

   393

		{

   394

			Vehicle *u = GetFirstVehicleFromSharedList(v);

   395

			while (u != NULL) {

   396

				InvalidateVehicleOrder(u);

   397

				u = u->next_shared;

   398

			}

   405

/**

   406

 *

   407

 * Clone/share/copy an order-list of an other vehicle

   408

 *

   409

 * @param veh1_veh2 First 16 bits are of destination vehicle, last 16 of source vehicle

   410

 * @param mode      Mode of cloning (CO_SHARE, CO_COPY, CO_UNSHARE)

   411

 *

   412

 */

   413

int32 CmdCloneOrder(int x, int y, uint32 flags, uint32 veh1_veh2, uint32 mode)

   414

{

   415

	Vehicle *dst = GetVehicle(veh1_veh2 & 0xFFFF);

   417

	if (dst->type == 0 || dst->owner != _current_player)

   420

	switch(mode) {

   421

		case CO_SHARE: {

   422

			Vehicle *src = GetVehicle(veh1_veh2 >> 16);

   424

			/* Sanity checks */

   425

			if (src->type == 0 || src->owner != _current_player || dst->type != src->type || dst == src)

   426

				return CMD_ERROR;

   428

			/* Trucks can't share orders with busses (and visa versa) */

   429

			if (src->type == VEH_Road) {

   430

				if (src->cargo_type != dst->cargo_type && (src->cargo_type == CT_PASSENGERS || dst->cargo_type == CT_PASSENGERS))

   431

					return CMD_ERROR;

   432

			}

   434

			/* Is the vehicle already in the shared list? */

   435

			{

   436

				Vehicle *u = GetFirstVehicleFromSharedList(src);

   437

				while (u != NULL) {

   438

					if (u == dst)

   440

					u = u->next_shared;

   444

			if (flags & DC_EXEC) {

   445

				/* If the destination vehicle had a OrderList, destroy it */

   446

				DeleteVehicleOrders(dst);

   448

				dst->orders = src->orders;

   449

				dst->num_orders = src->num_orders;

   451

				/* Link this vehicle in the shared-list */

   452

				dst->next_shared = src->next_shared;

   453

				dst->prev_shared = src;

   454

				if (src->next_shared != NULL)

   455

					src->next_shared->prev_shared = dst;

   456

				src->next_shared = dst;

   458

				InvalidateVehicleOrder(dst);

   459

				InvalidateVehicleOrder(src);

   460

   461

				RebuildVehicleLists();

   462

			}

   463

		} break;

   464

   465

		case CO_COPY: {

   466

			Vehicle *src = GetVehicle(veh1_veh2 >> 16);

   467

			int delta;

   468

   469

			/* Sanity checks */

   470

			if (src->type == 0 || src->owner != _current_player || dst->type != src->type || dst == src)

   471

				return CMD_ERROR;

   472

   473

			/* Trucks can't copy all the orders from busses (and visa versa) */

   474

			if (src->type == VEH_Road) {

   475

				const Order *order;

   476

				TileIndex required_dst;

   477

   478

				FOR_VEHICLE_ORDERS(src, order) {

   479

					if (order->type == OT_GOTO_STATION) {

   480

						const Station *st = GetStation(order->station);

   481

						required_dst = (dst->cargo_type == CT_PASSENGERS) ? st->bus_tile : st->lorry_tile;

   482

						/* This station has not the correct road-bay, so we can't copy! */

   483

						if (!required_dst)

   484

							return CMD_ERROR;

   485

					}

   486

				}

   487

			}

   488

   489

			/* make sure there are orders available */

   490

			delta = IsOrderListShared(dst) ? src->num_orders + 1 : src->num_orders - dst->num_orders;

   491

			if (!HasOrderPoolFree(delta))

   492

				return_cmd_error(STR_8831_NO_MORE_SPACE_FOR_ORDERS);

   493

   494