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

enum {

    19

	//Flags for stations:

    20

	OF_UNLOAD         = 0x2,

    21

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

    22

    23

	//Flags for depots:

    24

	OF_PART_OF_ORDERS	= 0x2,

    25

	OF_HALT_IN_DEPOT  = 0x4,

    26

    27

	//Common flags

    28

	OF_NON_STOP  = 0x8

    29

};

    30

    31

/* Order flags bits */

    32

enum {

    33

	OFB_UNLOAD         = 1,

    34

	OFB_FULL_LOAD      = 2,

    35

	OFB_PART_OF_ORDERS = 1,

    36

	OFB_HALT_IN_DEPOT  = 2,

    37

	OFB_NON_STOP       = 3

    38

};

    39

    40

/* Possible clone options */

    41

enum {

    42

	CO_SHARE   = 0,

    43

	CO_COPY    = 1,

    44

	CO_UNSHARE = 2

    45

};

    46

    47

/* Modes for the order checker */

    48

enum {

    49

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

    50

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

    51

};

    52

    53

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

    54

    - Load_ORDR, all the global orders

    55

    - Vehicle -> current_order

    56

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

    57

typedef struct Order {

    58

	uint8  type;

    59

	uint8  flags;

    60

	uint16 station;

    61

    62

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

    63

    64

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

    65

} Order;

    66

    67

typedef struct {

    68

	VehicleID clone;

    69

	byte orderindex;

    70

	Order order[41];

    71

	uint16 service_interval;

    72

	char name[32];

    73

} BackuppedOrders;

    74

    75

VARDEF TileIndex _backup_orders_tile;

    76

VARDEF BackuppedOrders _backup_orders_data[1];

    77

    78

extern MemoryPool _order_pool;

    79

    80

/**

    81

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

    82

 */

    83

static inline Order *GetOrder(uint index)

    84

{

    85

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

    86

}

    87

    88

/**

    89

 * Get the current size of the OrderPool

    90

 */

    91

static inline uint16 GetOrderPoolSize(void)

    92

{

    93

	return _order_pool.total_items;

    94

}

    95

    96

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

    97

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

    98

    99

   100

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

   101

   102

static inline bool HasOrderPoolFree(uint amount)

   103

{

   104

	const Order *order;

   105

   106

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

   107

	if (_order_pool.current_blocks < _order_pool.max_blocks)

   108

		return true;

   109

   110

	FOR_ALL_ORDERS(order)

   111

		if (order->type == OT_NOTHING)

   112

			if (--amount == 0)

   113

				return true;

   114

   115

	return false;

   116

}

   117

   118

static inline bool IsOrderPoolFull(void)

   119

{

   120

	return !HasOrderPoolFree(1);

   121

}

   122

   123

/* Pack and unpack routines */

   124

   125

static inline uint32 PackOrder(const Order *order)

   126

{

   127

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

   128

}

   129

   130

static inline Order UnpackOrder(uint32 packed)

   131

{

   132

	Order order;

   133

	order.type    = (packed & 0x000000FF);

   134

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

   135

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

   136

	order.next    = NULL;

   137

	return order;

   138

}

   139

   140

/* Functions */

   141

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

   142

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

   143

void DeleteDestinationFromVehicleOrder(Order dest);

   144

void InvalidateVehicleOrder(const Vehicle *v);

   145

bool VehicleHasDepotOrders(const Vehicle *v);

   146

bool CheckOrders(uint data_a, uint data_b);

   147

void DeleteVehicleOrders(Vehicle *v);

   148

bool IsOrderListShared(const Vehicle *v);

   149

void AssignOrder(Order *order, Order data);

   150

bool CheckForValidOrders(Vehicle *v);

   151

   152

Order UnpackVersion4Order(uint16 packed);

   153

Order UnpackOldOrder(uint16 packed);

   154

   155

#endif /* ORDER_H */