1

/* $Id$ */

     2

     3

/** @file ai_order.cpp Implementation of AIOrder. */

     4

     5

#include "ai_order.hpp"

     6

#include "ai_map.hpp"

     7

#include "ai_vehicle.hpp"

     8

#include "../../command_type.h"

     9

#include "../../vehicle_base.h"

    10

#include "../../depot.h"

    11

#include "../../landscape.h"

    12

#include "../../rail_map.h"

    13

#include "../../road_map.h"

    14

#include "../../station_map.h"

    15

#include "../../water_map.h"

    16

#include "../../waypoint.h"

    17

    18

/**

    19

 * Gets the order type given a tile

    20

 * @param t the tile to get the order from

    21

 * @return the order type, or OT_END when there is no order

    22

 */

    23

static OrderType GetOrderTypeByTile(TileIndex t)

    24

{

    25

	if (!::IsValidTile(t)) return OT_END;

    26

    27

	switch (::GetTileType(t)) {

    28

		default: break;

    29

		case MP_STATION: return OT_GOTO_STATION; break;

    30

		case MP_WATER:   if (::IsShipDepot(t)) return OT_GOTO_DEPOT; break;

    31

		case MP_ROAD:    if (::GetRoadTileType(t) == ROAD_TILE_DEPOT) return OT_GOTO_DEPOT; break;

    32

		case MP_RAILWAY:

    33

			switch (::GetRailTileType(t)) {

    34

				case RAIL_TILE_DEPOT:    return OT_GOTO_DEPOT;

    35

				case RAIL_TILE_WAYPOINT: return OT_GOTO_WAYPOINT;

    36

				default: break;

    37

			}

    38

			break;

    39

	}

    40

    41

	return OT_END;

    42

}

    43

    44

/* static */ bool AIOrder::IsValidVehicleOrder(VehicleID vehicle_id, uint32 order_id)

    45

{

    46

	return AIVehicle::IsValidVehicle(vehicle_id) && order_id < ::GetVehicle(vehicle_id)->num_orders;

    47

}

    48

    49

/* static */ bool AIOrder::AreOrderFlagsValid(TileIndex destination, AIOrderFlags order_flags)

    50

{

    51

	switch (::GetOrderTypeByTile(destination)) {

    52

		case OT_GOTO_DEPOT:    return (order_flags & ~(AIOF_NON_STOP | AIOF_SERVICE_IF_NEEDED)) == 0;

    53

		case OT_GOTO_STATION:  return (order_flags & ~(AIOF_NON_STOP | AIOF_TRANSFER | AIOF_UNLOAD | AIOF_FULL_LOAD)) == 0 && ((order_flags & AIOF_UNLOAD) == 0 || (order_flags & AIOF_FULL_LOAD) == 0);

    54

		case OT_GOTO_WAYPOINT: return (order_flags & ~(AIOF_NON_STOP)) == 0;

    55

		default:               return false;

    56

	}

    57

}

    58

    59

/* static */ int32 AIOrder::GetNumberOfOrders(VehicleID vehicle_id)

    60

{

    61

	return AIVehicle::IsValidVehicle(vehicle_id) ? ::GetVehicle(vehicle_id)->num_orders : -1;

    62

}

    63

    64

/* static */ TileIndex AIOrder::GetOrderDestination(VehicleID vehicle_id, uint32 order_id)

    65

{

    66

	if (!IsValidVehicleOrder(vehicle_id, order_id)) return INVALID_TILE;

    67

    68

	Order *order = ::GetVehicle(vehicle_id)->orders;

    69

	for (uint i = 0; i < order_id; i++) order = order->next;

    70

    71

	switch (order->GetType()) {

    72

		case OT_GOTO_DEPOT:    return ::GetDepot(order->GetDestination())->xy;

    73

		case OT_GOTO_STATION:  return ::GetStation(order->GetDestination())->xy;

    74

		case OT_GOTO_WAYPOINT: return ::GetWaypoint(order->GetDestination())->xy;

    75

		default:               return INVALID_TILE;

    76

	}

    77

}

    78

    79

/* static */ AIOrder::AIOrderFlags AIOrder::GetOrderFlags(VehicleID vehicle_id, uint32 order_id)

    80

{

    81

	if (!IsValidVehicleOrder(vehicle_id, order_id)) return AIOF_INVALID;

    82

    83

	Order *order = ::GetVehicle(vehicle_id)->orders;

    84

	for (uint i = 0; i < order_id; i++) order = order->next;

    85

    86

	AIOrderFlags order_flags= AIOF_NONE;

    88

	switch (order->GetType()) {

    89

		case OT_GOTO_DEPOT:

    91

			break;

    92

    93

		case OT_GOTO_STATION:

    97

			break;

    98

    99

		default: break;

   100

	}

   101

   102

	return order_flags;

   103

}

   104

   105

/* static */ bool AIOrder::AppendOrder(VehicleID vehicle_id, TileIndex destination, AIOrderFlags order_flags)

   106

{

   107

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));

   108

	return InsertOrder(vehicle_id, ::GetVehicle(vehicle_id)->num_orders, destination, order_flags);

   109

}

   110

   111

/* static */ bool AIOrder::InsertOrder(VehicleID vehicle_id, uint32 order_id, TileIndex destination, AIOrder::AIOrderFlags order_flags)

   112

{

   113

	/* IsValidVehicleOrder is not good enough because it does not allow appending. */

   114

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));

   115

	EnforcePrecondition(false, order_id <= ::GetVehicle(vehicle_id)->num_orders);

   116

	EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));

   117

   118

	Order order;

   119

	switch (::GetOrderTypeByTile(destination)) {

   120

		case OT_GOTO_DEPOT:

   123

			break;

   124

   125

		case OT_GOTO_STATION:

   126

			order.MakeGoToStation(::GetStationIndex(destination));

   129

			break;

   130

   131

		case OT_GOTO_WAYPOINT:

   132

			order.MakeGoToWaypoint(::GetWaypointIndex(destination));

   133

			break;

   134

   135

		default:

   136

			return false;

   137

	}

   138

   140

   141

	return AIObject::DoCommand(0, vehicle_id | (order_id << 16), order.Pack(), CMD_INSERT_ORDER);

   142

}

   143

   144

/* static */ bool AIOrder::RemoveOrder(VehicleID vehicle_id, uint32 order_id)

   145

{

   146

	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id));

   147

   148

	return AIObject::DoCommand(0, vehicle_id, order_id, CMD_DELETE_ORDER);

   149

}

   150

   151

/* static */ bool AIOrder::ChangeOrder(VehicleID vehicle_id, uint32 order_id, AIOrder::AIOrderFlags order_flags)

   152

{

   153

	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id));

   154

	EnforcePrecondition(false, AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_id), order_flags));

   155

   156

	for (;;) {

   157

		/* Loop as long as there is a difference between the requested and

   158

		 * the current orders of the vehicle. */

   159

		AIOrderFlags current = GetOrderFlags(vehicle_id, order_id);

   160

		AIOrderFlags diff = current ^ order_flags;

   161

		if (diff == 0) return true;

   162

   163

		bool res = AIObject::DoCommand(0, vehicle_id | (order_id << 16), FIND_FIRST_BIT(diff), CMD_MODIFY_ORDER);

   164

		if (!res) return false;

   165

	}

   166

}

   167

   168

/* static */ bool AIOrder::MoveOrder(VehicleID vehicle_id, uint32 order_id_move, uint32 order_id_target)

   169

{

   170

	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id_move));

   171

	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id_target));

   172

   173

	return AIObject::DoCommand(0, vehicle_id, order_id_move | (order_id_target << 16), CMD_MOVE_ORDER);

   174

}

   175

   176

/* static */ bool AIOrder::CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)

   177

{

   178

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));

   179

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(main_vehicle_id));

   180

   181

	return AIObject::DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_COPY, CMD_CLONE_ORDER);

   182

}

   183

   184

/* static */ bool AIOrder::ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)

   185

{

   186

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));

   187

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(main_vehicle_id));

   188

   189

	return AIObject::DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_SHARE, CMD_CLONE_ORDER);

   190

}

   191

   192

/* static */ bool AIOrder::UnshareOrders(VehicleID vehicle_id)

   193

{

   194

	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));

   195

   196

	return AIObject::DoCommand(0, vehicle_id, CO_UNSHARE, CMD_CLONE_ORDER);

   197

}