rubidium@9500: /* $Id$ */
rubidium@9500: 
truebrain@9833: /** @file ai_order.cpp Implementation of AIOrder. */
rubidium@9500: 
rubidium@9500: #include "ai_order.hpp"
rubidium@9500: #include "ai_map.hpp"
rubidium@9500: #include "ai_vehicle.hpp"
truebrain@10339: #include "../../openttd.h"
rubidium@9723: #include "../../vehicle_base.h"
rubidium@10249: #include "../../depot_base.h"
rubidium@9599: #include "../../landscape.h"
rubidium@9500: #include "../../rail_map.h"
rubidium@9500: #include "../../road_map.h"
rubidium@9500: #include "../../station_map.h"
rubidium@9500: #include "../../water_map.h"
rubidium@9500: #include "../../waypoint.h"
rubidium@9500: 
rubidium@9500: /**
rubidium@9500:  * Gets the order type given a tile
rubidium@9500:  * @param t the tile to get the order from
rubidium@9500:  * @return the order type, or OT_END when there is no order
rubidium@9500:  */
rubidium@9500: static OrderType GetOrderTypeByTile(TileIndex t)
rubidium@9500: {
rubidium@9500: 	if (!::IsValidTile(t)) return OT_END;
rubidium@9500: 
rubidium@9500: 	switch (::GetTileType(t)) {
rubidium@9500: 		default: break;
rubidium@9500: 		case MP_STATION: return OT_GOTO_STATION; break;
rubidium@9500: 		case MP_WATER:   if (::IsShipDepot(t)) return OT_GOTO_DEPOT; break;
rubidium@9694: 		case MP_ROAD:    if (::GetRoadTileType(t) == ROAD_TILE_DEPOT) return OT_GOTO_DEPOT; break;
rubidium@9500: 		case MP_RAILWAY:
rubidium@9500: 			switch (::GetRailTileType(t)) {
rubidium@9500: 				case RAIL_TILE_DEPOT:    return OT_GOTO_DEPOT;
rubidium@9500: 				case RAIL_TILE_WAYPOINT: return OT_GOTO_WAYPOINT;
rubidium@9500: 				default: break;
rubidium@9500: 			}
rubidium@9500: 			break;
rubidium@9500: 	}
rubidium@9500: 
rubidium@9500: 	return OT_END;
rubidium@9500: }
rubidium@9500: 
rubidium@9500: /* static */ bool AIOrder::IsValidVehicleOrder(VehicleID vehicle_id, uint32 order_id)
rubidium@9500: {
rubidium@9500: 	return AIVehicle::IsValidVehicle(vehicle_id) && order_id < ::GetVehicle(vehicle_id)->num_orders;
rubidium@9500: }
rubidium@9500: 
rubidium@9500: /* static */ bool AIOrder::AreOrderFlagsValid(TileIndex destination, AIOrderFlags order_flags)
rubidium@9500: {
rubidium@9500: 	switch (::GetOrderTypeByTile(destination)) {
rubidium@10146: 		case OT_GOTO_STATION:
rubidium@10146: 			return ((order_flags & ~(AIOF_NON_STOP_FLAGS | AIOF_UNLOAD_FLAGS | AIOF_LOAD_FLAGS)) == 0) &&
rubidium@10146: 					/* Test the different mutual exclusive flags. */
rubidium@10146: 					(((order_flags & AIOF_TRANSFER)      == 0) || ((order_flags & AIOF_UNLOAD)    == 0)) &&
rubidium@10146: 					(((order_flags & AIOF_TRANSFER)      == 0) || ((order_flags & AIOF_NO_UNLOAD) == 0)) &&
rubidium@10146: 					(((order_flags & AIOF_UNLOAD)        == 0) || ((order_flags & AIOF_NO_UNLOAD) == 0)) &&
rubidium@10146: 					(((order_flags & AIOF_UNLOAD)        == 0) || ((order_flags & AIOF_NO_UNLOAD) == 0)) &&
rubidium@10146: 					(((order_flags & AIOF_NO_UNLOAD)     == 0) || ((order_flags & AIOF_NO_LOAD)   == 0)) &&
rubidium@10146: 					(((order_flags & AIOF_FULL_LOAD_ANY) == 0) || ((order_flags & AIOF_NO_LOAD)   == 0));
rubidium@10146: 
rubidium@10146: 		case OT_GOTO_DEPOT:    return (order_flags & ~(AIOF_NON_STOP_FLAGS | AIOF_SERVICE_IF_NEEDED)) == 0;
rubidium@10146: 		case OT_GOTO_WAYPOINT: return (order_flags & ~(AIOF_NON_STOP_FLAGS)) == 0;
rubidium@9500: 		default:               return false;
rubidium@9500: 	}
rubidium@9500: }
rubidium@9500: 
truebrain@10844: /* static */ int32 AIOrder::GetOrderCount(VehicleID vehicle_id)
rubidium@9500: {
rubidium@9500: 	return AIVehicle::IsValidVehicle(vehicle_id) ? ::GetVehicle(vehicle_id)->num_orders : -1;
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ TileIndex AIOrder::GetOrderDestination(VehicleID vehicle_id, uint32 order_id)
rubidium@9500: {
truebrain@9736: 	if (!IsValidVehicleOrder(vehicle_id, order_id)) return INVALID_TILE;
rubidium@9500: 
rubidium@9500: 	Order *order = ::GetVehicle(vehicle_id)->orders;
rubidium@9500: 	for (uint i = 0; i < order_id; i++) order = order->next;
rubidium@9500: 
rubidium@9869: 	switch (order->GetType()) {
rubidium@9869: 		case OT_GOTO_DEPOT:    return ::GetDepot(order->GetDestination())->xy;
rubidium@9869: 		case OT_GOTO_STATION:  return ::GetStation(order->GetDestination())->xy;
rubidium@9869: 		case OT_GOTO_WAYPOINT: return ::GetWaypoint(order->GetDestination())->xy;
rubidium@9500: 		default:               return INVALID_TILE;
rubidium@9500: 	}
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ AIOrder::AIOrderFlags AIOrder::GetOrderFlags(VehicleID vehicle_id, uint32 order_id)
rubidium@9500: {
truebrain@9736: 	if (!IsValidVehicleOrder(vehicle_id, order_id)) return AIOF_INVALID;
rubidium@9500: 
rubidium@9500: 	Order *order = ::GetVehicle(vehicle_id)->orders;
rubidium@9500: 	for (uint i = 0; i < order_id; i++) order = order->next;
rubidium@9500: 
rubidium@10146: 	AIOrderFlags order_flags = AIOF_NONE;
rubidium@10146: 	order_flags |= (AIOrderFlags)order->GetNonStopType();
rubidium@9869: 	switch (order->GetType()) {
rubidium@9869: 		case OT_GOTO_DEPOT:
rubidium@10142: 			if (order->GetDepotOrderType() & ODTFB_SERVICE) order_flags |= AIOF_SERVICE_IF_NEEDED;
rubidium@9869: 			break;
rubidium@9869: 
rubidium@9869: 		case OT_GOTO_STATION:
rubidium@10146: 			order_flags |= (AIOrderFlags)(order->GetLoadType()   << 5);
rubidium@10146: 			order_flags |= (AIOrderFlags)(order->GetUnloadType() << 2);
rubidium@9869: 			break;
rubidium@9869: 
rubidium@9869: 		default: break;
rubidium@9869: 	}
rubidium@9869: 
rubidium@9869: 	return order_flags;
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::AppendOrder(VehicleID vehicle_id, TileIndex destination, AIOrderFlags order_flags)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));
truebrain@9737: 	return InsertOrder(vehicle_id, ::GetVehicle(vehicle_id)->num_orders, destination, order_flags);
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::InsertOrder(VehicleID vehicle_id, uint32 order_id, TileIndex destination, AIOrder::AIOrderFlags order_flags)
rubidium@9500: {
rubidium@9534: 	/* IsValidVehicleOrder is not good enough because it does not allow appending. */
rubidium@10093: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));
truebrain@10095: 	EnforcePrecondition(false, order_id <= ::GetVehicle(vehicle_id)->num_orders);
rubidium@10093: 	EnforcePrecondition(false, AreOrderFlagsValid(destination, order_flags));
rubidium@9500: 
rubidium@9500: 	Order order;
rubidium@9869: 	switch (::GetOrderTypeByTile(destination)) {
rubidium@9869: 		case OT_GOTO_DEPOT:
rubidium@10146: 			order.MakeGoToDepot(::GetDepotByTile(destination)->index, (OrderDepotTypeFlags)(ODTFB_PART_OF_ORDERS | ((order_flags & AIOF_SERVICE_IF_NEEDED) ? ODTFB_SERVICE : 0)));
rubidium@9869: 			break;
rubidium@9869: 
rubidium@9869: 		case OT_GOTO_STATION:
rubidium@9869: 			order.MakeGoToStation(::GetStationIndex(destination));
rubidium@10146: 			order.SetLoadType((OrderLoadFlags)GB(order_flags, 5, 3));
rubidium@10146: 			order.SetUnloadType((OrderUnloadFlags)GB(order_flags, 2, 3));
rubidium@9869: 			break;
rubidium@9869: 
rubidium@9869: 		case OT_GOTO_WAYPOINT:
rubidium@9869: 			order.MakeGoToWaypoint(::GetWaypointIndex(destination));
rubidium@9869: 			break;
rubidium@9869: 
rubidium@9869: 		default:
rubidium@9869: 			return false;
rubidium@9500: 	}
rubidium@9500: 
rubidium@10146: 	order.SetNonStopType((OrderNonStopFlags)GB(order_flags, 0, 2));
rubidium@9869: 
rubidium@9869: 	return AIObject::DoCommand(0, vehicle_id | (order_id << 16), order.Pack(), CMD_INSERT_ORDER);
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::RemoveOrder(VehicleID vehicle_id, uint32 order_id)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id));
rubidium@9500: 
truebrain@9737: 	return AIObject::DoCommand(0, vehicle_id, order_id, CMD_DELETE_ORDER);
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::ChangeOrder(VehicleID vehicle_id, uint32 order_id, AIOrder::AIOrderFlags order_flags)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id));
rubidium@10093: 	EnforcePrecondition(false, AreOrderFlagsValid(GetOrderDestination(vehicle_id, order_id), order_flags));
rubidium@9500: 
rubidium@10146: 	Order *order = ::GetVehicle(vehicle_id)->orders;
rubidium@10146: 	for (uint i = 0; i < order_id; i++) order = order->next;
rubidium@9548: 
rubidium@10146: 	AIOrderFlags current = GetOrderFlags(vehicle_id, order_id);
rubidium@10146: 
rubidium@10146: 	if ((current & AIOF_NON_STOP_FLAGS) != (order_flags & AIOF_NON_STOP_FLAGS)) {
rubidium@10146: 		bool res = AIObject::DoCommand(0, vehicle_id | (order_id << 16), (order_flags & AIOF_NON_STOP_FLAGS) << 4 | MOF_NON_STOP, CMD_MODIFY_ORDER);
rubidium@9548: 		if (!res) return false;
rubidium@9548: 	}
rubidium@10146: 
rubidium@10146: 	switch (order->GetType()) {
rubidium@10146: 		case OT_GOTO_DEPOT:
rubidium@10146: 			if ((current & AIOF_SERVICE_IF_NEEDED) != (order_flags & AIOF_SERVICE_IF_NEEDED)) {
rubidium@10146: 				bool res = AIObject::DoCommand(0, vehicle_id | (order_id << 16), MOF_DEPOT_ACTION, CMD_MODIFY_ORDER);
rubidium@10146: 				if (!res) return false;
rubidium@10146: 			}
rubidium@10146: 			break;
rubidium@10146: 
rubidium@10146: 		case OT_GOTO_STATION:
rubidium@10146: 			if ((current & AIOF_UNLOAD_FLAGS) != (order_flags & AIOF_UNLOAD_FLAGS)) {
rubidium@10146: 				bool res = AIObject::DoCommand(0, vehicle_id | (order_id << 16), (order_flags & AIOF_UNLOAD_FLAGS) << 2 | MOF_UNLOAD, CMD_MODIFY_ORDER);
rubidium@10146: 				if (!res) return false;
rubidium@10146: 			}
rubidium@10146: 			if ((current & AIOF_LOAD_FLAGS) != (order_flags & AIOF_LOAD_FLAGS)) {
rubidium@10146: 				bool res = AIObject::DoCommand(0, vehicle_id | (order_id << 16), (order_flags & AIOF_LOAD_FLAGS) >> 1 | MOF_LOAD, CMD_MODIFY_ORDER);
rubidium@10146: 				if (!res) return false;
rubidium@10146: 			}
rubidium@10146: 			break;
rubidium@10146: 
rubidium@10146: 		default: break;
rubidium@10146: 	}
rubidium@10146: 
rubidium@10146: 	assert(GetOrderFlags(vehicle_id, order_id) == order_flags);
rubidium@10146: 
rubidium@10146: 	return true;
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::MoveOrder(VehicleID vehicle_id, uint32 order_id_move, uint32 order_id_target)
truelight@9707: {
rubidium@10093: 	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id_move));
truebrain@10095: 	EnforcePrecondition(false, IsValidVehicleOrder(vehicle_id, order_id_target));
truelight@9707: 
truebrain@9737: 	return AIObject::DoCommand(0, vehicle_id, order_id_move | (order_id_target << 16), CMD_MOVE_ORDER);
truelight@9707: }
truelight@9707: 
truebrain@9737: /* static */ bool AIOrder::CopyOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));
truebrain@10095: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(main_vehicle_id));
rubidium@9500: 
truebrain@9737: 	return AIObject::DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_COPY, CMD_CLONE_ORDER);
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::ShareOrders(VehicleID vehicle_id, VehicleID main_vehicle_id)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));
truebrain@10095: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(main_vehicle_id));
rubidium@9500: 
truebrain@9737: 	return AIObject::DoCommand(0, vehicle_id | (main_vehicle_id << 16), CO_SHARE, CMD_CLONE_ORDER);
rubidium@9500: }
rubidium@9500: 
truebrain@9737: /* static */ bool AIOrder::UnshareOrders(VehicleID vehicle_id)
rubidium@9500: {
rubidium@10093: 	EnforcePrecondition(false, AIVehicle::IsValidVehicle(vehicle_id));
rubidium@9500: 
truebrain@9737: 	return AIObject::DoCommand(0, vehicle_id, CO_UNSHARE, CMD_CLONE_ORDER);
rubidium@9500: }