(svn r9794) -Codechange: refactor the question whether a vehicle can be loaded into LoadUnloadVehicle instead of duplicating it for each vehicle.

7 files changed, 82 insertions, 87 deletions

diff --git a/src/aircraft_cmd.cpp b/src/aircraft_cmd.cpp
index 35fe61395..76a524d4b 100644
--- a/src/aircraft_cmd.cpp
+++ b/src/aircraft_cmd.cpp
@@ -1421,10 +1421,7 @@ static void HandleAircraftLoading(Vehicle *v, int mode)
 			if (mode != 0) return;
 			if (--v->load_unload_time_rem != 0) return;
 
-			if (CanFillVehicle(v)) {
-				LoadUnloadVehicle(v);
-				return;
-			}
+			if (LoadUnloadVehicle(v)) return;
 
 			Order b = v->current_order;
 			v->LeaveStation();
diff --git a/src/economy.cpp b/src/economy.cpp
index 159685c48..433dd64e5 100644
--- a/src/economy.cpp
+++ b/src/economy.cpp
@@ -1378,6 +1378,73 @@ static bool LoadWait(const Vehicle* v, const Vehicle* u)
 	return false;
 }
 
+static bool CanFillVehicle_FullLoadAny(Vehicle *v)
+{
+	uint32 full = 0, not_full = 0;
+	const GoodsEntry *ge = GetStation(v->last_station_visited)->goods;
+
+	/* special handling of aircraft */
+
+	/* if the aircraft carries passengers and is NOT full, then
+	 *continue loading, no matter how much mail is in */
+	if (v->type == VEH_AIRCRAFT &&
+			IsCargoInClass(v->cargo_type, CC_PASSENGERS) &&
+			v->cargo_cap != v->cargo_count) {
+		return true;
+	}
+
+	/* patch should return "true" to continue loading, i.e. when there is no cargo type that is fully loaded. */
+	do {
+		/* Should never happen, but just in case future additions change this */
+		assert(v->cargo_type<32);
+
+		if (v->cargo_cap != 0) {
+			uint32 mask = 1 << v->cargo_type;
+
+			if (!HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) && v->cargo_cap == v->cargo_count) {
+				full |= mask;
+			} else if (GB(ge[v->cargo_type].waiting_acceptance, 0, 12) > 0 ||
+					(HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) && (ge[v->cargo_type].waiting_acceptance & 0x8000))) {
+				/* If there is any cargo waiting, or this vehicle is still unloading
+				 * and the station accepts the cargo, don't leave the station. */
+				return true;
+			} else {
+				not_full |= mask;
+			}
+		}
+	} while ((v = v->next) != NULL);
+
+	/* continue loading if there is a non full cargo type and no cargo type that is full */
+	return not_full && (full & ~not_full) == 0;
+}
+
+
+static bool CanFillVehicle(Vehicle *front_v)
+{
+	TileIndex tile = front_v->tile;
+
+	assert(IsTileType(tile, MP_STATION) ||
+			(front_v->type == VEH_SHIP && (
+				IsTileType(TILE_ADDXY(tile,  1,  0), MP_STATION) ||
+				IsTileType(TILE_ADDXY(tile, -1,  0), MP_STATION) ||
+				IsTileType(TILE_ADDXY(tile,  0,  1), MP_STATION) ||
+				IsTileType(TILE_ADDXY(tile,  0, -1), MP_STATION) ||
+				IsTileType(TILE_ADDXY(tile, -2,  0), MP_STATION)
+			)));
+
+	bool full_load = HASBIT(front_v->current_order.flags, OFB_FULL_LOAD);
+
+	/* If patch is active, use alternative CanFillVehicle-function */
+	if (_patches.full_load_any && full_load) return CanFillVehicle_FullLoadAny(front_v);
+
+	Vehicle *v = front_v;
+	do {
+		if (HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) || (full_load && v->cargo_count != v->cargo_cap)) return true;
+	} while ((v = v->next) != NULL);
+
+	return !HASBIT(front_v->vehicle_flags, VF_LOADING_FINISHED);
+}
+
 /**
  * Performs the vehicle payment _and_ marks the vehicle to be unloaded.
  * @param front_v the vehicle to be unloaded
@@ -1477,8 +1544,15 @@ void VehiclePayment(Vehicle *front_v)
 	_current_player = old_player;
 }
 
-int LoadUnloadVehicle(Vehicle *v)
+/**
+ * Loads/unload the vehicle if possible.
+ * @param v the vehicle to be (un)loaded
+ * @return true if something was (un)loaded. False if the train is ready to leave.
+ */
+bool LoadUnloadVehicle(Vehicle *v)
 {
+	if (!CanFillVehicle(v)) return false;
+
 	int unloading_time = 20;
 	Vehicle *u = v;
 	int result = 0;
@@ -1689,7 +1763,7 @@ int LoadUnloadVehicle(Vehicle *v)
 		if (result & 2) InvalidateWindow(WC_STATION_VIEW, last_visited);
 	}
 
-	return result;
+	return true;
 }
 
 void PlayersMonthlyLoop()
diff --git a/src/roadveh_cmd.cpp b/src/roadveh_cmd.cpp
index c11e9c530..43664a6ff 100644
--- a/src/roadveh_cmd.cpp
+++ b/src/roadveh_cmd.cpp
@@ -761,10 +761,7 @@ static void HandleRoadVehLoading(Vehicle *v)
 
 			if (--v->load_unload_time_rem != 0) return;
 
-			if (CanFillVehicle(v)) {
-				LoadUnloadVehicle(v);
-				return;
-			}
+			if (LoadUnloadVehicle(v)) return;
 
 			b = v->current_order;
 			v->LeaveStation();
diff --git a/src/ship_cmd.cpp b/src/ship_cmd.cpp
index 0e75f6718..77244bfb6 100644
--- a/src/ship_cmd.cpp
+++ b/src/ship_cmd.cpp
@@ -306,10 +306,8 @@ static void HandleShipLoading(Vehicle *v)
 		case OT_LOADING: {
 			if (--v->load_unload_time_rem != 0) return;
 
-			if (CanFillVehicle(v)) {
-				LoadUnloadVehicle(v);
-				return;
-			}
+			if (LoadUnloadVehicle(v)) return;
+
 			PlayShipSound(v);
 
 			Order b = v->current_order;
diff --git a/src/train_cmd.cpp b/src/train_cmd.cpp
index c63ba7b79..c156b7aec 100644
--- a/src/train_cmd.cpp
+++ b/src/train_cmd.cpp
@@ -2537,10 +2537,7 @@ static void HandleTrainLoading(Vehicle *v, bool mode)
 
 			if (--v->load_unload_time_rem) return;
 
-			if (CanFillVehicle(v)) {
-				LoadUnloadVehicle(v);
-				return;
-			}
+			if (LoadUnloadVehicle(v)) return;
 
 			TrainPlayLeaveStationSound(v);
 
diff --git a/src/vehicle.cpp b/src/vehicle.cpp
index 60896198c..f8c233184 100644
--- a/src/vehicle.cpp
+++ b/src/vehicle.cpp
@@ -701,73 +701,6 @@ void CallVehicleTicks()
 	}
 }
 
-static bool CanFillVehicle_FullLoadAny(Vehicle *v)
-{
-	uint32 full = 0, not_full = 0;
-	const GoodsEntry *ge = GetStation(v->last_station_visited)->goods;
-
-	/* special handling of aircraft */
-
-	/* if the aircraft carries passengers and is NOT full, then
-	 *continue loading, no matter how much mail is in */
-	if (v->type == VEH_AIRCRAFT &&
-			IsCargoInClass(v->cargo_type, CC_PASSENGERS) &&
-			v->cargo_cap != v->cargo_count) {
-		return true;
-	}
-
-	/* patch should return "true" to continue loading, i.e. when there is no cargo type that is fully loaded. */
-	do {
-		/* Should never happen, but just in case future additions change this */
-		assert(v->cargo_type<32);
-
-		if (v->cargo_cap != 0) {
-			uint32 mask = 1 << v->cargo_type;
-
-			if (!HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) && v->cargo_cap == v->cargo_count) {
-				full |= mask;
-			} else if (GB(ge[v->cargo_type].waiting_acceptance, 0, 12) > 0 ||
-					(HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) && (ge[v->cargo_type].waiting_acceptance & 0x8000))) {
-				/* If there is any cargo waiting, or this vehicle is still unloading
-				 * and the station accepts the cargo, don't leave the station. */
-				return true;
-			} else {
-				not_full |= mask;
-			}
-		}
-	} while ((v = v->next) != NULL);
-
-	/* continue loading if there is a non full cargo type and no cargo type that is full */
-	return not_full && (full & ~not_full) == 0;
-}
-
-
-bool CanFillVehicle(Vehicle *front_v)
-{
-	TileIndex tile = front_v->tile;
-
-	assert(IsTileType(tile, MP_STATION) ||
-			(front_v->type == VEH_SHIP && (
-				IsTileType(TILE_ADDXY(tile,  1,  0), MP_STATION) ||
-				IsTileType(TILE_ADDXY(tile, -1,  0), MP_STATION) ||
-				IsTileType(TILE_ADDXY(tile,  0,  1), MP_STATION) ||
-				IsTileType(TILE_ADDXY(tile,  0, -1), MP_STATION) ||
-				IsTileType(TILE_ADDXY(tile, -2,  0), MP_STATION)
-			)));
-
-	bool full_load = HASBIT(front_v->current_order.flags, OFB_FULL_LOAD);
-
-	/* If patch is active, use alternative CanFillVehicle-function */
-	if (_patches.full_load_any && full_load) return CanFillVehicle_FullLoadAny(front_v);
-
-	Vehicle *v = front_v;
-	do {
-		if (HASBIT(v->vehicle_flags, VF_CARGO_UNLOADING) || (full_load && v->cargo_count != v->cargo_cap)) return true;
-	} while ((v = v->next) != NULL);
-
-	return !HASBIT(front_v->vehicle_flags, VF_LOADING_FINISHED);
-}
-
 /** Check if a given engine type can be refitted to a given cargo
  * @param engine_type Engine type to check
  * @param cid_to check refit to this cargo-type
diff --git a/src/vehicle.h b/src/vehicle.h
index 62fb935b2..9143d5c87 100644
--- a/src/vehicle.h
+++ b/src/vehicle.h
@@ -467,7 +467,6 @@ void InitializeTrains();
 byte VehicleRandomBits();
 void ResetVehiclePosHash();
 
-bool CanFillVehicle(Vehicle *v);
 bool CanRefitTo(EngineID engine_type, CargoID cid_to);
 CargoID FindFirstRefittableCargo(EngineID engine_type);
 int32 GetRefitCost(EngineID engine_type);
@@ -507,7 +506,7 @@ void ShowAircraftViewWindow(const Vehicle* v);
 
 UnitID GetFreeUnitNumber(byte type);
 
-int LoadUnloadVehicle(Vehicle *v);
+bool LoadUnloadVehicle(Vehicle *v);
 
 void TrainConsistChanged(Vehicle *v);
 void TrainPowerChanged(Vehicle *v);