1

#ifndef ORDER_H

     2

#define ORDER_H

     3

     4

#include "pool.h"

     5

     6

/* Order types */

     7

enum {

     8

	OT_NOTHING       = 0,

     9

	OT_GOTO_STATION  = 1,

    10

	OT_GOTO_DEPOT    = 2,

    11

	OT_LOADING       = 3,

    12

	OT_LEAVESTATION  = 4,

    13

	OT_DUMMY         = 5,

    14

	OT_GOTO_WAYPOINT = 6

    15

};

    16

    17

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

    18

    19

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

    20

enum {

    21

	//Flags for stations:

    22

	OF_TRANSFER       = 0x1,

    23

	OF_UNLOAD         = 0x2,

    24

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

    25

    26

	//Flags for depots:

    27

	OF_PART_OF_ORDERS	= 0x2,

    28

	OF_HALT_IN_DEPOT  = 0x4,

    29

    30

	//Common flags

    31

	OF_NON_STOP  = 0x8

    32

};

    33

    34

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

    35

enum {

    36

	OFB_TRANSFER       = 0,

    37

	OFB_UNLOAD         = 1,

    38

	OFB_FULL_LOAD      = 2,

    39

	OFB_PART_OF_ORDERS = 1,

    40

	OFB_HALT_IN_DEPOT  = 2,

    41

	OFB_NON_STOP       = 3

    42

};

    43

    44

    45

/* Possible clone options */

    46

enum {

    47

	CO_SHARE   = 0,

    48

	CO_COPY    = 1,

    49

	CO_UNSHARE = 2

    50

};

    51

    52

/* Modes for the order checker */

    53

enum {

    54

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

    55

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

    56

};

    57

    58

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

    59

    - Load_ORDR, all the global orders

    60

    - Vehicle -> current_order

    61

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

    62

typedef struct Order {

    63

	uint8  type;

    64

	uint8  flags;

    65

	uint16 station;

    66

    67

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

    68

    69

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

    70

} Order;

    71

    72

typedef struct {

    73

	VehicleID clone;

    74

	OrderID orderindex;

    75

	Order order[41];

    76

	uint16 service_interval;

    77

	char name[32];

    78

} BackuppedOrders;

    79

    80

VARDEF TileIndex _backup_orders_tile;

    81

VARDEF BackuppedOrders _backup_orders_data[1];

    82

    83

extern MemoryPool _order_pool;

    84

    85

/**

    86

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

    87

 */

    88

static inline Order *GetOrder(uint index)

    89

{

    90

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

    91

}

    92

    93

/**

    94

 * Get the current size of the OrderPool

    95

 */

    96

static inline uint16 GetOrderPoolSize(void)

    97

{

    98

	return _order_pool.total_items;

    99

}

   100

   101

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

   102

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

   103

   104

   105

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

   106

   107

static inline bool HasOrderPoolFree(uint amount)

   108

{

   109

	const Order *order;

   110

   111

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

   112

	if (_order_pool.current_blocks < _order_pool.max_blocks)

   113

		return true;

   114

   115

	FOR_ALL_ORDERS(order)

   116

		if (order->type == OT_NOTHING)

   117

			if (--amount == 0)

   118

				return true;

   119

   120

	return false;

   121

}

   122

   123

static inline bool IsOrderPoolFull(void)

   124

{

   125

	return !HasOrderPoolFree(1);

   126

}

   127

   128

/* Pack and unpack routines */

   129

   130

static inline uint32 PackOrder(const Order *order)

   131

{

   132

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

   133

}

   134

   135

static inline Order UnpackOrder(uint32 packed)

   136

{

   137

	Order order;

   141

	order.next    = NULL;

   142

	order.index   = 0; // avoid compiler warning

   143

	return order;

   144

}

   145

   146

/* Functions */

   147

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

   148

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

   149

void DeleteDestinationFromVehicleOrder(Order dest);

   150

void InvalidateVehicleOrder(const Vehicle *v);

   151

bool VehicleHasDepotOrders(const Vehicle *v);

   152

bool CheckOrders(uint data_a, uint data_b);

   153

void DeleteVehicleOrders(Vehicle *v);

   154

bool IsOrderListShared(const Vehicle *v);

   155

void AssignOrder(Order *order, Order data);

   156

bool CheckForValidOrders(Vehicle *v);

   157

   158

Order UnpackVersion4Order(uint16 packed);

   159

Order UnpackOldOrder(uint16 packed);

   160

   161

#endif /* ORDER_H */