1

/* $Id$ */

     2

     3

/** @file order.h */

     4

     5

#ifndef ORDER_H

     6

#define ORDER_H

     7

     8

#include "macros.h"

     9

#include "pool.h"

    10

    11

enum {

    12

	INVALID_ORDER = 0xFFFF,

    13

};

    14

    15

/* Order types */

    16

enum OrderTypes {

    17

	OT_NOTHING       = 0,

    18

	OT_GOTO_STATION  = 1,

    19

	OT_GOTO_DEPOT    = 2,

    20

	OT_LOADING       = 3,

    21

	OT_LEAVESTATION  = 4,

    22

	OT_DUMMY         = 5,

    23

	OT_GOTO_WAYPOINT = 6,

    24

};

    25

/* It needs to be 8bits, because we save and load it as such */

    26

typedef uint8 OrderType;

    27

    28

/* Order flags -- please use OFB instead OF and use HASBIT/SETBIT/CLEARBIT */

    29

    30

/** Order flag masks - these are for direct bit operations */

    31

enum OrderFlagMasks {

    32

	//Flags for stations:

    33

	/** vehicle will transfer cargo (i. e. not deliver to nearby industry/town even if accepted there) */

    34

	OF_TRANSFER           = 0x1,

    35

	/** If OF_TRANSFER is not set, drop any cargo loaded. If accepted, deliver, otherwise cargo remains at the station.

    36

      * No new cargo is loaded onto the vehicle whatsoever */

    37

	OF_UNLOAD             = 0x2,

    38

	/** Wait for full load of all vehicles, or of at least one cargo type, depending on patch setting

    39

	  * @todo make this two different flags */

    40

	OF_FULL_LOAD          = 0x4,

    41

    42

	//Flags for depots:

    43

	/** The current depot-order was initiated because it was in the vehicle's order list */

    44

	OF_PART_OF_ORDERS     = 0x2,

    45

	/** if OF_PART_OF_ORDERS is not set, this will cause the vehicle to be stopped in the depot */

    46

	OF_HALT_IN_DEPOT      = 0x4,

    47

	/** if OF_PART_OF_ORDERS is set, this will cause the order only be come active if the vehicle needs servicing */

    48

	OF_SERVICE_IF_NEEDED  = 0x4, //used when OF_PART_OF_ORDERS is set.

    49

    50

	//Common flags

    51

	/** This causes the vehicle not to stop at intermediate OR the destination station (depending on patch settings)

    52

	  * @todo make this two different flags */

    53

	OF_NON_STOP           = 0x8

    54

};

    55

    56

/** Order flags bits - these are for the *BIT macros

    57

 * for descrption of flags, see OrderFlagMasks

    58

 * @see OrderFlagMasks

    59

 */

    60

enum {

    61

	OFB_TRANSFER          = 0,

    62

	OFB_UNLOAD            = 1,

    63

	OFB_FULL_LOAD         = 2,

    64

	OFB_PART_OF_ORDERS    = 1,

    65

	OFB_HALT_IN_DEPOT     = 2,

    66

	OFB_SERVICE_IF_NEEDED = 2,

    67

	OFB_NON_STOP          = 3

    68

};

    69

    70

    71

/* Possible clone options */

    72

enum {

    73

	CO_SHARE   = 0,

    74

	CO_COPY    = 1,

    75

	CO_UNSHARE = 2

    76

};

    77

    78

/* If you change this, keep in mind that it is saved on 3 places:

    79

 * - Load_ORDR, all the global orders

    80

 * - Vehicle -> current_order

    81

 * - REF_SHEDULE (all REFs are currently limited to 16 bits!!)

    82

 */

    83

typedef struct Order {

    84

	OrderType type;

    85

	uint8  flags;

    86

	DestinationID dest;   ///< The destionation of the order.

    87

    88

	struct Order *next;   ///< Pointer to next order. If NULL, end of list

    89

    90

	OrderID index;         ///< Index of the order, is not saved or anything, just for reference

    91

} Order;

    92

    93

#define MAX_BACKUP_ORDER_COUNT 40

    94

    95

typedef struct {

    96

	VehicleID clone;

    97

	VehicleOrderID orderindex;

    98

	Order order[MAX_BACKUP_ORDER_COUNT + 1];

    99

	uint16 service_interval;

   100

	char name[32];

   101

} BackuppedOrders;

   102

   103

VARDEF TileIndex _backup_orders_tile;

   104

VARDEF BackuppedOrders _backup_orders_data[1];

   105

   106

extern MemoryPool _order_pool;

   107

   108

/**

   109

 * Get the pointer to the order with index 'index'

   110

 */

   111

static inline Order *GetOrder(OrderID index)

   112

{

   113

	return (Order*)GetItemFromPool(&_order_pool, index);

   114

}

   115

   116

/**

   117

 * Get the current size of the OrderPool

   118

 */

   119

static inline uint16 GetOrderPoolSize(void)

   120

{

   121

	return _order_pool.total_items;

   122

}

   123

   124

static inline VehicleOrderID GetOrderArraySize(void)

   125

{

   126

	/* TODO - This isn't the real content of the function, but

   127

	 *  with the new pool-system this will be replaced with one that

   128

	 *  _really_ returns the highest index + 1. Now it just returns

   129

	 *  the next safe value we are sure about everything is below.

   130

	 */

   131

	return GetOrderPoolSize();

   132

}

   133

   134

/**

   135

 * Check if a Order really exists.

   136

 */

   137

static inline bool IsValidOrder(const Order *o)

   138

{

   139

	return o->type != OT_NOTHING;

   140

}

   141

   142

static inline void DeleteOrder(Order *o)

   143

{

   144

	o->type = OT_NOTHING;

   145

	o->next = NULL;

   146

}

   147

   148

#define FOR_ALL_ORDERS_FROM(order, start) for (order = GetOrder(start); order != NULL; order = (order->index + 1 < GetOrderPoolSize()) ? GetOrder(order->index + 1) : NULL) if (IsValidOrder(order))

   149

#define FOR_ALL_ORDERS(order) FOR_ALL_ORDERS_FROM(order, 0)

   150

   151

   152

#define FOR_VEHICLE_ORDERS(v, order) for (order = v->orders; order != NULL; order = order->next)

   153

   154

static inline bool HasOrderPoolFree(uint amount)

   155

{

   156

	const Order *order;

   157

   158

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

   159

	if (_order_pool.current_blocks < _order_pool.max_blocks)

   160

		return true;

   161

   162

	FOR_ALL_ORDERS(order)

   163

		if (order->type == OT_NOTHING)

   164

			if (--amount == 0)

   165

				return true;

   166

   167

	return false;

   168

}

   169

   170

static inline bool IsOrderPoolFull(void)

   171

{

   172

	return !HasOrderPoolFree(1);

   173

}

   174

   175

/* Pack and unpack routines */

   176

   177

static inline uint32 PackOrder(const Order *order)

   178

{

   179

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

   180

}

   181

   182

static inline Order UnpackOrder(uint32 packed)

   183

{

   184

	Order order;

   185

	order.type    = (OrderType)GB(packed,  0,  8);

   186

	order.flags   = GB(packed,  8,  8);

   187

	order.dest    = GB(packed, 16, 16);

   188

	order.next    = NULL;

   189

	order.index   = 0; // avoid compiler warning

   190

	return order;

   191

}

   192

   193

/* Functions */

   194

void BackupVehicleOrders(const Vehicle *v, BackuppedOrders *order);

   195

void RestoreVehicleOrders(const Vehicle* v, const BackuppedOrders* order);

   196

void RemoveOrderFromAllVehicles(OrderType type, DestinationID destination);

   197

void InvalidateVehicleOrder(const Vehicle *v);

   198

bool VehicleHasDepotOrders(const Vehicle *v);

   199

void CheckOrders(const Vehicle*);

   200

void DeleteVehicleOrders(Vehicle *v);

   201

bool IsOrderListShared(const Vehicle *v);

   202

void AssignOrder(Order *order, Order data);

   203

bool CheckForValidOrders(const Vehicle* v);

   204

   205

Order UnpackOldOrder(uint16 packed);

   206

   207

#endif /* ORDER_H */