Merge pull request #7080 from Goober5000/patch_cancel_future_waves

patch cancel-future-waves to handle absent waves

Author: Goober5000

code/parse/sexp.cpp

@@ -15480,10 +15480,16 @@ void sexp_self_destruct(int node)
 
 void sexp_cancel_future_waves(int node)
 {
-	for (int n = node; n != -1; n = CDR(n))	{
+	for (int n = node; n != -1; n = CDR(n))
+	{
 		auto wingp = eval_wing(n);
-		if (wingp) {
+		if (wingp)
+		{
+			// prevent any more waves from arriving by marking this as the last wave
 			wingp->num_waves = wingp->current_wave;
+
+			// we might need to clean up this wing if there are no ships currently in the mission
+			wing_maybe_cleanup(wingp);
 		}
 	}
 }
@@ -40094,11 +40100,13 @@ SCP_vector<sexp_help_struct> Sexp_help = {
 	},
 
 	{ OP_CANCEL_FUTURE_WAVES, "cancel-future-waves\r\n"
-		"\tCancel all waves of a wing which have not yet arrived. Waves that have arrived already are not affected. is-destroyed-delay, ship-type-destroyed, and similar operators behave as though the cancelled waves do not exist.\r\n\r\nIf this operator is called on a wing which has not arrived, the wing will never arrive, exactly as if its arrival cue were set to false. That wing is not marked as destroyed.\r\n\r\n"
+		"\tCancel all waves of a wing which have not yet arrived. Waves that have arrived already are not affected. The is-destroyed-delay, "
+		"ship-type-destroyed, and similar operators behave as though the cancelled waves do not exist.\r\n\r\nIf this operator is called on a wing "
+		"which has not arrived, the wing will never arrive, exactly as if its arrival cue were set to false; and that wing is not marked as destroyed. "
+		"Otherwise, wings will be marked as destroyed or departed in the same manner as they would have been if they were truly on the last wave.\r\n\r\n"
 		"Takes 1 or more arguments...\r\n"
 		"\tAll:\tThe name of a wing to cancel." },
 
-
 	{ OP_SHIP_VISIBLE, "ship-visible\r\n"
 		"\tCauses the ships listed in this sexpression to be visible with player sensors.\r\n\r\n"
 		"Takes 1 or more arguments...\r\n"

code/ship/ship.cpp

@@ -8909,6 +8909,43 @@ void ship_wing_cleanup( int shipnum, wing *wingp )
 			wingp->special_ship_ship_info_index = Ships[wingp->ship_index[0]].ship_info_index;
 	}
 
+	wing_maybe_cleanup(wingp, team);
+}
+
+// Assume the team of the wing is the same as the team of the most recently exited ship from that wing.
+// Returns -1 if no ship from that wing has exited.
+int wing_determine_team(const wing *wingp)
+{
+	int wingnum = WING_INDEX(wingp);
+	int team = -1;
+	fix latest_exit_time = -1;
+
+	// Grab the team from the most recent ship in this wing to have exited the mission.  If there are no exited ships from this wing,
+	// that means they all vanished.  In that case we must return -1, but it doesn't matter for logging because vanished wings aren't logged.
+	for (const auto &entry : Ships_exited)
+	{
+		if ((entry.wingnum == wingnum) && (entry.time > latest_exit_time))
+		{
+			latest_exit_time = entry.time;
+			team = entry.team;
+		}
+	}
+
+	return team;
+}
+
+/**
+ * This was originally part of ::ship_wing_cleanup, but it can now be called separately.  It sets various flags and mission log entries
+ * associated with a wing no longer being in a mission.
+ * 
+ * The team parameter is used for logging.  If it is not supplied (i.e. is not >= 0), it will be derived using wing_determine_team().
+ */
+void wing_maybe_cleanup( wing *wingp, int team )
+{
+	// not if the wing is already gone or has not yet arrived
+	if (wingp->flags[Ship::Wing_Flags::Gone] || wingp->total_arrived_count == 0)
+		return;
+
 	// if the current count is 0, check to see if the wing departed or was destroyed.
 	if (wingp->current_count == 0)
 	{
@@ -8933,15 +8970,15 @@ void ship_wing_cleanup( int shipnum, wing *wingp )
 				// first, be sure to mark a wing destroyed event if all members of wing were destroyed and on
 				// the last wave.  This circumvents a problem where the wing could be marked as departed and
 				// destroyed if the last ships were destroyed after the wing's departure cue became true.
-				mission_log_add_entry(LOG_WING_DESTROYED, wingp->name, NULL, team);
+				mission_log_add_entry(LOG_WING_DESTROYED, wingp->name, nullptr, team >= 0 ? team : wing_determine_team(wingp));
 			}
 			// if some ships escaped, log it as departed
 			else if (wingp->total_vanished != wingp->total_arrived_count)
 			{
 				// if the wing wasn't destroyed, and it is departing, then mark it as departed -- in this
 				// case, there had better be ships in this wing with departure entries in the log file.  The
 				// logfile code checks for this case.  
-				mission_log_add_entry(LOG_WING_DEPARTED, wingp->name, NULL, team);
+				mission_log_add_entry(LOG_WING_DEPARTED, wingp->name, nullptr, team >= 0 ? team : wing_determine_team(wingp));
 			}
 
 #ifndef NDEBUG

code/ship/ship.h

@@ -1826,6 +1826,7 @@ extern void ship_subsys_set_disrupted(ship_subsys *ss, int time);
 extern int	ship_do_rearm_frame( object *objp, float frametime );
 extern float ship_calculate_rearm_duration( object *objp );
 extern void	ship_wing_cleanup( int shipnum, wing *wingp );
+extern void wing_maybe_cleanup( wing *wingp, int team = -1 );
 
 extern int ship_find_repair_ship( object *requester_obj, object **ship_we_found = NULL );
 extern void ship_close();	// called in game_shutdown() to free malloced memory