Merge pull request #1154 from z64555/cleanup/dock_swabber

Fixes two crashes in red-alert missions, cleans up and refactors some of the docking code

Author: z64555

code/missionui/redalert.cpp

@@ -29,6 +29,8 @@
 #include "missionui/redalert.h"
 #include "mod_table/mod_table.h"
 #include "model/model.h"
+#include "object/deadobjectdock.h"
+#include "object/objectdock.h"
 #include "ship/ship.h"
 #include "sound/audiostr.h"
 #include "sound/fsspeech.h"
@@ -776,23 +778,26 @@ void red_alert_store_wingman_status()
 }
 
 // Delete a ship in a red alert mission (since it must have died/departed in the previous mission)
-void red_alert_delete_ship(ship *shipp, int ship_state)
+void red_alert_delete_ship(int shipnum, int ship_state)
 {
-	if ( (shipp->wing_status_wing_index >= 0) && (shipp->wing_status_wing_pos >= 0) ) {
-		if (ship_state == RED_ALERT_DESTROYED_SHIP_CLASS) {
-		hud_set_wingman_status_dead(shipp->wing_status_wing_index, shipp->wing_status_wing_pos);
-		} else if (ship_state == RED_ALERT_PLAYER_DEL_SHIP_CLASS) {
-			hud_set_wingman_status_none(shipp->wing_status_wing_index, shipp->wing_status_wing_pos);
-		} else {
-			Error(LOCATION, "Red Alert: asked to delete ship (%s) with invalid ship state (%d)", shipp->ship_name, ship_state);
-		}
-	}
+	ship* shipp = &Ships[shipnum];
+	int cleanup_mode;	// See ship.h for cleanup mode defines. SHIP_VANISHED etc.
 
-	ship_add_exited_ship( shipp, Ship::Exit_Flags::Player_deleted );
-	obj_delete(shipp->objnum);
-	if ( shipp->wingnum >= 0 ) {
-		ship_wing_cleanup( SHIP_INDEX(shipp), &Wings[shipp->wingnum] );
+	switch (ship_state) {
+	case RED_ALERT_DESTROYED_SHIP_CLASS:
+		cleanup_mode = SHIP_DESTROYED_REDALERT;
+		break;
+	case RED_ALERT_PLAYER_DEL_SHIP_CLASS:
+		cleanup_mode = SHIP_DEPARTED_REDALERT;
+		break;
+	default:
+		Assertion(false, "Red-alert: Unknown delete state '%i'\n", ship_state);
+		cleanup_mode = SHIP_VANISHED;
+		break;
 	}
+
+	Objects[shipp->objnum].flags.set(Object::Object_Flags::Should_be_dead);
+	ship_cleanup(shipnum, cleanup_mode);
 }
 
 // just mark the parse object as never going to arrive
@@ -896,7 +901,7 @@ void red_alert_bash_wingman_status()
 		if ( !ship_data_restored ) {
 			// we need to be a little tricky here because deletion invalidates the ship_obj
 			ship_obj *next_so = GET_NEXT(so);
-			red_alert_delete_ship(shipp, ship_state);
+			red_alert_delete_ship(ship_objp->instance, ship_state);
 			so = next_so;
 		} else {
 			so = GET_NEXT(so);

code/object/deadobjectdock.cpp

@@ -23,6 +23,8 @@ dock_instance *dead_dock_find_instance(object *objp, int dockpoint);
 
 object *dock_get_first_dead_docked_object(object *objp)
 {
+	Assert(objp != NULL);
+
 	// are we docked?
 	if (!object_is_dead_docked(objp))
 		return NULL;
@@ -32,6 +34,9 @@ object *dock_get_first_dead_docked_object(object *objp)
 
 int dock_find_dead_dockpoint_used_by_object(object *objp, object *other_objp)
 {
+	Assert(objp != NULL);
+	Assert(other_objp != NULL);
+
 	dock_instance *result = dead_dock_find_instance(objp, other_objp);
 
 	if (result == NULL)
@@ -43,6 +48,9 @@ int dock_find_dead_dockpoint_used_by_object(object *objp, object *other_objp)
 // dock management functions -------------------------------------------------------------------------------------
 void dock_dead_dock_objects(object *objp1, int dockpoint1, object *objp2, int dockpoint2)
 {
+	Assert(objp1 != NULL);
+	Assert(objp2 != NULL);
+
 #ifndef NDEBUG
 	if ((dead_dock_find_instance(objp1, objp2) != NULL) || (dead_dock_find_instance(objp2, objp1) != NULL))
 	{
@@ -62,18 +70,26 @@ void dock_dead_dock_objects(object *objp1, int dockpoint1, object *objp2, int do
 
 void dock_dead_undock_objects(object *objp1, object *objp2)
 {
-#ifndef NDEBUG
-	if ((dead_dock_find_instance(objp1, objp2) == NULL) || (dead_dock_find_instance(objp2, objp1) == NULL))
-	{
-		Error(LOCATION, "Trying to undock an object that isn't docked!\n");
-	}
-#endif
+	Assert(objp1 != NULL);
+	Assert(objp2 != NULL);
 
 	// remove objects from each others' dock lists
 	dead_dock_remove_instance(objp1, objp2);
 	dead_dock_remove_instance(objp2, objp1);
 }
 
+void dock_dead_undock_all(object *objp)
+{
+	Assert(objp != NULL);
+
+	while (object_is_dead_docked(objp))
+	{
+		object* dockee = dock_get_first_dead_docked_object(objp);
+
+		dock_dead_undock_objects(objp, dockee);
+	}
+}
+
 void dead_dock_add_instance(object *objp, int dockpoint, object *other_objp)
 {
 	dock_instance *item;
@@ -128,11 +144,18 @@ void dead_dock_remove_instance(object *objp, object *other_objp)
 		// delete it
 		vm_free(ptr);
 	}
+	else
+	{
+		// Trigger assertion. We can recover from this, thankfully
+		Assertion(false, "Tried to undock an object that isn't dead docked!\n");
+	}
 }
 
 // just free the list without worrying about undocking anything
 void dock_free_dead_dock_list(object *objp)
 {
+	Assert(objp != NULL);
+
 	while (objp->dead_dock_list != NULL)
 	{
 		dock_instance *ptr = objp->dead_dock_list;

code/object/deadobjectdock.h

@@ -25,6 +25,12 @@ void dock_dead_dock_objects(object *objp1, int dockpoint1, object *objp2, int do
 // remove objp1 and objp2 from each others' dock lists; currently called by do_dying_undock_physics and ship_cleanup
 void dock_dead_undock_objects(object *objp1, object *objp2);
 
+/**
+ * @brief Undocks all dead docks.
+ * @note This is a slow method. Use dock_free_dead_dock_list() when doing object cleanup
+ */
+void dock_dead_undock_all(object *objp);
+
 // free the entire dock list without undocking anything; should only be used on object cleanup
 void dock_free_dead_dock_list(object *objp);
 

code/object/object.h

@@ -304,9 +304,37 @@ void obj_client_post_interpolate();
 // move an observer object in multiplayer
 void obj_observer_move(float frame_time);
 
-// Goober5000
+/**
+ * @brief Checks if the given object is docked with anyone.
+ *
+ * @returns Nonzero if docked, or
+ * @returns 0 if not docked
+ *
+ * @author Goober5000
+ */
 int object_is_docked(object *objp);
+
+/**
+ * @brief Checks if the given object is dead-docked with anyone.
+ *
+ * @returns Nonzero if docked, or
+ * @returns 0 if not docked
+ *
+ * @details An object is "dead-docked" when it is dying and still has objects docked to it. The dead_dock list is
+ *   populated when the object dies, and is used later on to jettison and maybe damage the docked objects.
+ *
+ * @author Goober5000
+ */
 int object_is_dead_docked(object *objp);
+
+/**
+ * @brief Moves a docked object to keep up with the parent object as it moves
+ *
+ * @param[in,out] objp The docked object
+ * @param[in]     parent_objp The object that it's docked to
+ *
+ * @author Goober5000
+ */
 void obj_move_one_docked_object(object *objp, object *parent_objp);
 
 //WMC

code/object/objectdock.cpp

@@ -46,6 +46,8 @@ int dock_count_instances(object *objp);
 
 object *dock_get_first_docked_object(object *objp)
 {
+	Assert(objp != NULL);
+
 	// are we docked?
 	if (!object_is_docked(objp))
 		return NULL;
@@ -55,6 +57,8 @@ object *dock_get_first_docked_object(object *objp)
 
 bool dock_check_docked_one_on_one(object *objp)
 {
+	Assert(objp != NULL);
+
 	// we must be docked
 	if (!object_is_docked(objp))
 		return false;
@@ -76,11 +80,14 @@ bool dock_check_docked_one_on_one(object *objp)
 
 int dock_count_direct_docked_objects(object *objp)
 {
+	Assert(objp != NULL);
 	return dock_count_instances(objp);
 }
 
 int dock_count_total_docked_objects(object *objp)
 {
+	Assert(objp != NULL);
+
 	dock_function_info dfi;
 
 	dock_evaluate_all_docked_objects(objp, &dfi, dock_count_total_docked_objects_helper);
@@ -90,11 +97,17 @@ int dock_count_total_docked_objects(object *objp)
 
 bool dock_check_find_direct_docked_object(object *objp, object *other_objp)
 {
+	Assert(objp != NULL);
+	Assert(other_objp != NULL);
+
 	return (dock_find_instance(objp, other_objp) != NULL);
 }
 
 bool dock_check_find_docked_object(object *objp, object *other_objp)
 {
+	Assert(objp != NULL);
+	Assert(other_objp != NULL);
+
 	dock_function_info dfi;
 	dfi.parameter_variables.objp_value = other_objp;
 
@@ -105,6 +118,8 @@ bool dock_check_find_docked_object(object *objp, object *other_objp)
 
 object *dock_find_object_at_dockpoint(object *objp, int dockpoint)
 {
+	Assert(objp != NULL);
+
 	dock_instance *result = dock_find_instance(objp, dockpoint);
 
 	if (result == NULL)
@@ -115,6 +130,9 @@ object *dock_find_object_at_dockpoint(object *objp, int dockpoint)
 
 int dock_find_dockpoint_used_by_object(object *objp, object *other_objp)
 {
+	Assert(objp != NULL);
+	Assert(other_objp != NULL);
+
 	dock_instance *result = dock_find_instance(objp, other_objp);
 
 	if (result == NULL)
@@ -125,6 +143,9 @@ int dock_find_dockpoint_used_by_object(object *objp, object *other_objp)
 
 void dock_calc_docked_center(vec3d *dest, object *objp)
 {
+	Assert(dest != NULL);
+	Assert(objp != NULL);
+
 	vm_vec_zero(dest);
 
 	dock_function_info dfi;
@@ -138,6 +159,9 @@ void dock_calc_docked_center(vec3d *dest, object *objp)
 
 void dock_calc_docked_center_of_mass(vec3d *dest, object *objp)
 {
+	Assert(dest != NULL);
+	Assert(objp != NULL);
+
 	vm_vec_zero(dest);
 
 	dock_function_info dfi;
@@ -151,6 +175,8 @@ void dock_calc_docked_center_of_mass(vec3d *dest, object *objp)
 
 float dock_calc_total_docked_mass(object *objp)
 {
+	Assert(objp != NULL);
+
 	dock_function_info dfi;
 
 	dock_evaluate_all_docked_objects(objp, &dfi, dock_calc_total_docked_mass_helper);
@@ -160,6 +186,8 @@ float dock_calc_total_docked_mass(object *objp)
 
 float dock_calc_max_cross_sectional_radius_perpendicular_to_axis(object *objp, axis_type axis)
 {
+	Assert(objp != NULL);
+
 	vec3d local_line_end;
 	vec3d *world_line_start, world_line_end;
 	dock_function_info dfi;
@@ -210,6 +238,8 @@ float dock_calc_max_cross_sectional_radius_perpendicular_to_axis(object *objp, a
 
 float dock_calc_max_semilatus_rectum_parallel_to_axis(object *objp, axis_type axis)
 {
+	Assert(objp != NULL);
+
 	vec3d local_line_end;
 	vec3d *world_line_start, world_line_end;
 	dock_function_info dfi;
@@ -260,6 +290,8 @@ float dock_calc_max_semilatus_rectum_parallel_to_axis(object *objp, axis_type ax
 
 float dock_calc_docked_fspeed(object *objp)
 {
+	Assert(objp != NULL);
+
 	// *sigh*... the docked fspeed is simply the max fspeed of all docked objects
 	dock_function_info dfi;
 	dock_evaluate_all_docked_objects(objp, &dfi, dock_find_max_fspeed_helper);
@@ -268,6 +300,8 @@ float dock_calc_docked_fspeed(object *objp)
 
 float dock_calc_docked_speed(object *objp)
 {
+	Assert(objp != NULL);
+
 	// ditto with speed
 	dock_function_info dfi;
 	dock_evaluate_all_docked_objects(objp, &dfi, dock_find_max_speed_helper);
@@ -370,6 +404,8 @@ void dock_evaluate_tree(object *objp, dock_function_info *infop, void (*function
 
 void dock_move_docked_objects(object *objp)
 {
+	Assert(objp != NULL);
+
 	if ((objp->type != OBJ_SHIP) && (objp->type != OBJ_START))
 		return;
 
@@ -601,6 +637,9 @@ void dock_find_max_speed_helper(object *objp, dock_function_info *infop)
 // dock management functions -------------------------------------------------------------------------------------
 void dock_dock_objects(object *objp1, int dockpoint1, object *objp2, int dockpoint2)
 {
+	Assert(objp1 != NULL);
+	Assert(objp2 != NULL);
+
 #ifndef NDEBUG
 	if ((dock_find_instance(objp1, objp2) != NULL) || (dock_find_instance(objp2, objp1) != NULL))
 	{
@@ -620,18 +659,26 @@ void dock_dock_objects(object *objp1, int dockpoint1, object *objp2, int dockpoi
 
 void dock_undock_objects(object *objp1, object *objp2)
 {
-#ifndef NDEBUG
-	if ((dock_find_instance(objp1, objp2) == NULL) || (dock_find_instance(objp2, objp1) == NULL))
-	{
-		Error(LOCATION, "Trying to undock an object that isn't docked!\n");
-	}
-#endif
+	Assert(objp1 != NULL);
+	Assert(objp2 != NULL);
 
 	// remove objects from each others' dock lists
 	dock_remove_instance(objp1, objp2);
 	dock_remove_instance(objp2, objp1);
 }
 
+void dock_undock_all(object *objp)
+{
+	Assert(objp != NULL);
+
+	while (object_is_docked(objp))
+	{
+		object* dockee = dock_get_first_docked_object(objp);
+
+		dock_undock_objects(objp, dockee);
+	}
+}
+
 // dock list functions -------------------------------------------------------------------------------------------
 bool dock_check_assume_hub()
 {
@@ -719,11 +766,18 @@ void dock_remove_instance(object *objp, object *other_objp)
 		// delete it
 		vm_free(ptr);
 	}
+	else
+	{
+		// Trigger an assertion, we can recover from this one, thankfully.
+		Assertion(false, "Tried to undock an object that isn't docked!\n");
+	}
 }
 
 // just free the list without worrying about undocking anything
 void dock_free_dock_list(object *objp)
 {
+	Assert(objp != NULL);
+
 	while (objp->dock_list != NULL)
 	{
 		dock_instance *ptr = objp->dock_list;