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_UNLOAD         = 0x2,

    23

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

    24

    25

	//Flags for depots:

    26

	OF_PART_OF_ORDERS	= 0x2,

    27

	OF_HALT_IN_DEPOT  = 0x4,

    28

    29

	//Common flags

    30

	OF_NON_STOP  = 0x8

    31

};

    32

    33

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

    34

enum {

    35

	OFB_UNLOAD         = 1,

    36

	OFB_FULL_LOAD      = 2,

    37

	OFB_PART_OF_ORDERS = 1,

    38

	OFB_HALT_IN_DEPOT  = 2,

    39

	OFB_NON_STOP       = 3

    40

};

    41

    42

    43

/* Possible clone options */

    44

enum {

    45

	CO_SHARE   = 0,

    46

	CO_COPY    = 1,

    47

	CO_UNSHARE = 2

    48

};

    49

    50

/* Modes for the order checker */

    51

enum {

    52

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

    53

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

    54

};

    55

    56

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

    57

    - Load_ORDR, all the global orders

    58

    - Vehicle -> current_order

    59

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

    60

typedef struct Order {

    61

	uint8  type;

    62

	uint8  flags;

    63

	uint16 station;

    64

    65

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

    66

    67

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

    68

} Order;

    69

    70

typedef struct {

    71

	VehicleID clone;

    72

	byte orderindex;

    73

	Order order[41];

    74

	uint16 service_interval;

    75

	char name[32];

    76

} BackuppedOrders;

    77

    78

VARDEF TileIndex _backup_orders_tile;

    79

VARDEF BackuppedOrders _backup_orders_data[1];

    80

    81

extern MemoryPool _order_pool;

    82

    83

/**

    84

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

    85

 */

    86

static inline Order *GetOrder(uint index)

    87

{

    88

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

    89

}

    90

    91

/**

    92

 * Get the current size of the OrderPool

    93

 */

    94

static inline uint16 GetOrderPoolSize(void)

    95

{

    96

	return _order_pool.total_items;

    97

}

    98

    99

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

   100

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

   101

   102

   103

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

   104

   105

static inline bool HasOrderPoolFree(uint amount)

   106

{

   107

	const Order *order;

   108

   109

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

   110

	if (_order_pool.current_blocks < _order_pool.max_blocks)

   111

		return true;

   112

   113

	FOR_ALL_ORDERS(order)

   114

		if (order->type == OT_NOTHING)

   115

			if (--amount == 0)

   116

				return true;

   117

   118

	return false;

   119

}

   120

   121

static inline bool IsOrderPoolFull(void)

   122

{

   123

	return !HasOrderPoolFree(1);

   124

}

   125

   126

/* Pack and unpack routines */

   127

   128

static inline uint32 PackOrder(const Order *order)

   129

{

   130

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

   131

}

   132

   133

static inline Order UnpackOrder(uint32 packed)

   134

{

   135

	Order order;

   136

	order.type    = (packed & 0x000000FF);

   137

	order.flags   = (packed & 0x0000FF00) >> 8;

   138

	order.station = (packed & 0xFFFF0000) >> 16;

   139

	order.next    = NULL;

   140

	return order;

   141

}

   142

   143

/* Functions */

   144

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

   145

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

   146

void DeleteDestinationFromVehicleOrder(Order dest);

   147

void InvalidateVehicleOrder(const Vehicle *v);

   148

bool VehicleHasDepotOrders(const Vehicle *v);

   149

bool CheckOrders(uint data_a, uint data_b);

   150

void DeleteVehicleOrders(Vehicle *v);

   151

bool IsOrderListShared(const Vehicle *v);

   152

void AssignOrder(Order *order, Order data);

   153

bool CheckForValidOrders(Vehicle *v);

   154

   155

Order UnpackVersion4Order(uint16 packed);

   156

Order UnpackOldOrder(uint16 packed);

   157

   158

#endif /* ORDER_H */