1

#ifndef ORDER_H

     2

#define ORDER_H

     3

     5

#include "pool.h"

     6

     7

/* Order types */

     8

enum {

     9

	OT_NOTHING       = 0,

    10

	OT_GOTO_STATION  = 1,

    11

	OT_GOTO_DEPOT    = 2,

    12

	OT_LOADING       = 3,

    13

	OT_LEAVESTATION  = 4,

    14

	OT_DUMMY         = 5,

    15

	OT_GOTO_WAYPOINT = 6

    16

};

    17

    18

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

    19

    20

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

    21

enum {

    22

	//Flags for stations:

    23

	OF_TRANSFER       = 0x1,

    24

	OF_UNLOAD         = 0x2,

    25

	OF_FULL_LOAD      = 0x4, // Also used when to force an aircraft into a depot

    26

    27

	//Flags for depots:

    28

	OF_PART_OF_ORDERS	= 0x2,

    29

	OF_HALT_IN_DEPOT  = 0x4,

    30

    31

	//Common flags

    32

	OF_NON_STOP  = 0x8

    33

};

    34

    35

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

    36

enum {

    37

	OFB_TRANSFER       = 0,

    38

	OFB_UNLOAD         = 1,

    39

	OFB_FULL_LOAD      = 2,

    40

	OFB_PART_OF_ORDERS = 1,

    41

	OFB_HALT_IN_DEPOT  = 2,

    42

	OFB_NON_STOP       = 3

    43

};

    44

    45

    46

/* Possible clone options */

    47

enum {

    48

	CO_SHARE   = 0,

    49

	CO_COPY    = 1,

    50

	CO_UNSHARE = 2

    51

};

    52

    53

/* Modes for the order checker */

    54

enum {

    55

	OC_INIT     = 0, //the order checker can initialize a news message

    56

	OC_VALIDATE = 1, //the order checker validates a news message

    57

};

    58

    59

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

    60

    - Load_ORDR, all the global orders

    61

    - Vehicle -> current_order

    62

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

    63

typedef struct Order {

    64

	uint8  type;

    65

	uint8  flags;

    66

	uint16 station;

    67

    68

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

    69

    70

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

    71

} Order;

    72

    73

typedef struct {

    74

	VehicleID clone;

    75

	OrderID orderindex;

    76

	Order order[41];

    77

	uint16 service_interval;

    78

	char name[32];

    79

} BackuppedOrders;

    80

    81

VARDEF TileIndex _backup_orders_tile;

    82

VARDEF BackuppedOrders _backup_orders_data[1];

    83

    84

extern MemoryPool _order_pool;

    85

    86

/**

    87

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

    88

 */

    89

static inline Order *GetOrder(uint index)

    90

{

    91

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

    92

}

    93

    94

/**

    95

 * Get the current size of the OrderPool

    96

 */

    97

static inline uint16 GetOrderPoolSize(void)

    98

{

    99

	return _order_pool.total_items;

   100

}

   101

   102

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

   103

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

   104

   105

   106

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

   107

   108

static inline bool HasOrderPoolFree(uint amount)

   109

{

   110

	const Order *order;

   111

   112

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

   113

	if (_order_pool.current_blocks < _order_pool.max_blocks)

   114

		return true;

   115

   116

	FOR_ALL_ORDERS(order)

   117

		if (order->type == OT_NOTHING)

   118

			if (--amount == 0)

   119

				return true;

   120

   121

	return false;

   122

}

   123

   124

static inline bool IsOrderPoolFull(void)

   125

{

   126

	return !HasOrderPoolFree(1);

   127

}

   128

   129

/* Pack and unpack routines */

   130

   131

static inline uint32 PackOrder(const Order *order)

   132

{

   133

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

   134

}

   135

   136

static inline Order UnpackOrder(uint32 packed)

   137

{

   138

	Order order;

   139

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

   140

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

   141

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

   142

	order.next    = NULL;

   143

	order.index   = 0; // avoid compiler warning

   144

	return order;

   145

}

   146

   147

/* Functions */

   148

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

   149

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

   150

void DeleteDestinationFromVehicleOrder(Order dest);

   151

void InvalidateVehicleOrder(const Vehicle *v);

   152

bool VehicleHasDepotOrders(const Vehicle *v);

   153

bool CheckOrders(uint data_a, uint data_b);

   154

void DeleteVehicleOrders(Vehicle *v);

   155

bool IsOrderListShared(const Vehicle *v);

   156

void AssignOrder(Order *order, Order data);

   157

bool CheckForValidOrders(Vehicle *v);

   158

   159

Order UnpackVersion4Order(uint16 packed);

   160

Order UnpackOldOrder(uint16 packed);

   161

   162

#endif /* ORDER_H */