Optimizes dock_undock_objects() and dock_dead_undock_objects() methods by removing their dock pair check, because the same check is done in the remove_instance subroutines.

z64555 · z64555 · commit 95315d7f8aa1 · 2017-02-01T01:35:45.000-06:00
* Adds a warning for debug users when an unknown ship_state is passed to red_alert_delete.
* Removes commented-out code
* Doxy's ship_cleanup()

*Conform to each file's style.

*Extend ship_cleanup to better handle red-alert deletion.
*Also treat cleanup_mode as a flagset, instead of an enum as it was previously.
diff --git a/code/missionui/redalert.cpp b/code/missionui/redalert.cpp
@@ -781,43 +781,25 @@ void red_alert_store_wingman_status()
 void red_alert_delete_ship(int shipnum, int ship_state)
 {
 	ship* shipp = &Ships[shipnum];
-	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);
-		}
-	}
 
-	// If this ship is docked with anybody, undock them all before deleting
-	dock_undock_all(&Objects[shipp->objnum]);
-	dock_dead_undock_all(&Objects[shipp->objnum]);
-
-	int cleanup_mode;	// See ship.h for cleanup mode defines (SHIP_VANISHED)
+	int cleanup_mode = SHIP_REDALERT;	// See ship.h for cleanup mode defines
 	switch (ship_state) {
 	case RED_ALERT_DESTROYED_SHIP_CLASS:
-		cleanup_mode = SHIP_DESTROYED;
+		cleanup_mode |= SHIP_DESTROYED;
 		break;
 	case RED_ALERT_PLAYER_DEL_SHIP_CLASS:
-		cleanup_mode = SHIP_DEPARTED;
+		cleanup_mode |= SHIP_DEPARTED;
 		break;
 	default:
-		cleanup_mode = SHIP_VANISHED;
+#ifdef DEBUG
+		Warning(LOCATION, "Red-alert: Unknown delete state, assuming vanished.");
+#endif
+		cleanup_mode |= SHIP_VANISHED;
 		break;
 	}
 
 	Objects[shipp->objnum].flags.set(Object::Object_Flags::Should_be_dead);
 	ship_cleanup(shipnum, cleanup_mode);
-	/*
-	ship_add_exited_ship( shipp, exit_flag );
-
-	obj_delete(shipp->objnum);
-	if ( shipp->wingnum >= 0 ) {
-		ship_wing_cleanup( SHIP_INDEX(shipp), &Wings[shipp->wingnum] );
-	}
-	*/
 }
 
 // just mark the parse object as never going to arrive
diff --git a/code/object/deadobjectdock.cpp b/code/object/deadobjectdock.cpp
@@ -73,22 +73,17 @@ void dock_dead_undock_objects(object *objp1, object *objp2)
 	Assert(objp1 != NULL);
 	Assert(objp2 != NULL);
 
-#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
-
 	// 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) {
+void dock_dead_undock_all(object *objp)
+{
 	Assert(objp != NULL);
 
-	while (object_is_dead_docked(objp)) {
+	while (object_is_dead_docked(objp))
+	{
 		object* dockee = dock_get_first_dead_docked_object(objp);
 
 		dock_dead_undock_objects(objp, dockee);
@@ -149,6 +144,16 @@ void dead_dock_remove_instance(object *objp, object *other_objp)
 		// delete it
 		vm_free(ptr);
 	}
+	else
+	{
+		// Raise an error if we're in a release build.
+		// Raise a warning if we're in a debug build, the user may be doing something silly
+#ifndef NDEBUG
+		Error(LOCATION, "Tried to undock an object that isn't docked!\n");
+#else
+		Warning(LOCATION, "Tried to undock an object that isn't docked! Proceed with caution!\n");
+#endif
+	}
 }
 
 // just free the list without worrying about undocking anything
diff --git a/code/object/objectdock.cpp b/code/object/objectdock.cpp
@@ -662,22 +662,17 @@ void dock_undock_objects(object *objp1, object *objp2)
 	Assert(objp1 != NULL);
 	Assert(objp2 != NULL);
 
-#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
-
 	// remove objects from each others' dock lists
 	dock_remove_instance(objp1, objp2);
 	dock_remove_instance(objp2, objp1);
 }
 
-void dock_undock_all(object *objp) {
+void dock_undock_all(object *objp)
+{
 	Assert(objp != NULL);
 
-	while (object_is_docked(objp)) {
+	while (object_is_docked(objp))
+	{
 		object* dockee = dock_get_first_docked_object(objp);
 
 		dock_undock_objects(objp, dockee);
@@ -771,6 +766,16 @@ void dock_remove_instance(object *objp, object *other_objp)
 		// delete it
 		vm_free(ptr);
 	}
+	else
+	{
+		// Raise an error if we're in a release build.
+		// Raise a warning if we're in a debug build, the user may be doing something silly
+#ifndef NDEBUG
+		Error(LOCATION, "Tried to undock an object that isn't docked!\n");
+#else
+		Warning(LOCATION, "Tried to undock an object that isn't docked! Proceed with caution!\n");
+#endif
+	}
 }
 
 // just free the list without worrying about undocking anything
diff --git a/code/ship/ship.cpp b/code/ship/ship.cpp
@@ -7389,22 +7389,29 @@ void ship_destroy_instantly(object *ship_objp, int shipnum)
 void ship_cleanup(int shipnum, int cleanup_mode)
 {
 	Assert(shipnum >= 0 && shipnum < MAX_SHIPS);
-	Assert(cleanup_mode == SHIP_DESTROYED || cleanup_mode == SHIP_DEPARTED || cleanup_mode == SHIP_VANISHED);
+	Assert(cleanup_mode & (SHIP_DESTROYED | SHIP_DEPARTED | SHIP_VANISHED));
 	Assert(Objects[Ships[shipnum].objnum].type == OBJ_SHIP);
 	Assert(Objects[Ships[shipnum].objnum].flags[Object::Object_Flags::Should_be_dead]);
 
 	ship *shipp = &Ships[shipnum];
 	object *objp = &Objects[shipp->objnum];
 
 	// add the information to the exited ship list
-	if (cleanup_mode == SHIP_DESTROYED) {
-		ship_add_exited_ship(shipp, Ship::Exit_Flags::Destroyed);
+	if (!(cleanup_mode & SHIP_REDALERT)) {
+		if (cleanup_mode & SHIP_DESTROYED) {
+			ship_add_exited_ship(shipp, Ship::Exit_Flags::Destroyed);
+		} else {
+			// (cleanup_mode & (SHIP_DEPARTED | SHIP_VANISHED)
+			ship_add_exited_ship(shipp, Ship::Exit_Flags::Departed);
+		}
 	} else {
-		ship_add_exited_ship(shipp, Ship::Exit_Flags::Departed);
+		// (cleanup_mode & SHIP_REDALERT)
+		// Ship was removed in previous mission. Mark as "player deleted" for this mission
+		ship_add_exited_ship(shipp, Ship::Exit_Flags::Player_deleted);
 	}
 
 	// record kill?
-	if (cleanup_mode == SHIP_DESTROYED) {
+	if (!(cleanup_mode & SHIP_REDALERT) && (cleanup_mode & SHIP_DESTROYED)) {
 		// determine if we need to count this ship as a kill in counting number of kills per ship type
 		// look at the ignore flag for the ship (if not in a wing), or the ignore flag for the wing
 		// (if the ship is in a wing), and add to the kill count if the flags are not set
@@ -7417,8 +7424,8 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 	}
 
 	// add mission log entry?
-	// (vanished ships have no log, and destroyed ships are logged in ship_hit_kill)
-	if (cleanup_mode == SHIP_DEPARTED) {
+	// (vanished ships and red-alert deleted ships have no log, and destroyed ships are logged in ship_hit_kill)
+	if (!(cleanup_mode & SHIP_REDALERT) && (cleanup_mode & SHIP_DEPARTED)) {
 		// see if this ship departed within the radius of a jump node -- if so, put the node name into
 		// the secondary mission log field
 		CJumpNode *jnp = jumpnode_get_which_in(objp);
@@ -7430,20 +7437,27 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 
 #ifndef NDEBUG
 	// add a debug log entry
-	if (cleanup_mode == SHIP_DESTROYED) {
-		nprintf(("Alan", "SHIP DESTROYED: %s\n", shipp->ship_name));
-	} else if (cleanup_mode == SHIP_DEPARTED) {
-		nprintf(("Alan", "SHIP DEPARTED: %s\n", shipp->ship_name));
+	if (cleanup_mode & SHIP_DESTROYED) {
+		nprintf(("Alan", "SHIP DESTROYED: %s", shipp->ship_name));
+	} else if (cleanup_mode & SHIP_DEPARTED) {
+		nprintf(("Alan", "SHIP DEPARTED: %s", shipp->ship_name));
 	} else {
-		nprintf(("Alan", "SHIP VANISHED: %s\n", shipp->ship_name));
+		nprintf(("Alan", "SHIP VANISHED: %s", shipp->ship_name));
+	}
+
+	// if it was removed via red_alert_delete_ship, log it as such
+	if (cleanup_mode & SHIP_REDALERT) {
+		nprintf(("Alan", "(RED-ALERT)\n"));
+	} else {
+		nprintf(("Alan", "\n"));
 	}
 #endif
 
 	// update wingman status gauge
 	if ( (shipp->wing_status_wing_index >= 0) && (shipp->wing_status_wing_pos >= 0) ) {
-		if (cleanup_mode == SHIP_DESTROYED) {
+		if (cleanup_mode & SHIP_DESTROYED) {
 			hud_set_wingman_status_dead(shipp->wing_status_wing_index, shipp->wing_status_wing_pos);
-		} else if (cleanup_mode == SHIP_DEPARTED) {
+		} else if ((cleanup_mode & SHIP_DEPARTED) && !(cleanup_mode & SHIP_REDALERT)){
 			hud_set_wingman_status_departed(shipp->wing_status_wing_index, shipp->wing_status_wing_pos);
 		} else {
 			hud_set_wingman_status_none(shipp->wing_status_wing_index, shipp->wing_status_wing_pos);
@@ -7454,9 +7468,9 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 	if ( shipp->wingnum != -1 ) {
 		wing *wingp = &Wings[shipp->wingnum];
 
-		if (cleanup_mode == SHIP_DESTROYED) {
+		if (cleanup_mode & SHIP_DESTROYED) {
 			wingp->total_destroyed++;
-		} else if (cleanup_mode == SHIP_DEPARTED) {
+		} else if (cleanup_mode & SHIP_DEPARTED) {
 			wingp->total_departed++;
 		} else {
 			wingp->total_vanished++;
@@ -7467,7 +7481,7 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 
 	// Note, this call to ai_ship_destroy must come after ship_wing_cleanup for guarded wings to
 	// properly note the destruction of a ship in their wing.
-	if (cleanup_mode == SHIP_DESTROYED) {
+	if (cleanup_mode & SHIP_DESTROYED) {
 		ai_ship_destroy(shipnum, Ship::Exit_Flags::Destroyed);	// Do AI stuff for destruction of ship.
 	} else {
 		ai_ship_destroy(shipnum, Ship::Exit_Flags::Departed);		// should still do AI cleanup after ship has departed
@@ -7476,11 +7490,9 @@ void ship_cleanup(int shipnum, int cleanup_mode)
 	// Goober5000 - lastly, clear out the dead-docked list, per Mantis #2294
 	// (for exploding ships, this list should have already been cleared by now, via
 	// do_dying_undock_physics, except in the case of the destroy-instantly sexp)
-	while (object_is_dead_docked(objp))
-	{
-		object *docked_objp = dock_get_first_dead_docked_object(objp);
-		dock_dead_undock_objects(objp, docked_objp);
-	}
+	// z64555 - Also clear out the docked list, since a red-alert-carry ship could be docked with somebody
+	dock_undock_all(objp);
+	dock_dead_undock_all(objp);
 }
 
 /**
diff --git a/code/ship/ship.h b/code/ship/ship.h
@@ -1376,8 +1376,22 @@ extern int ship_get_num_ships();
 #define SHIP_DEPARTED_WARP		(1<<2)
 #define SHIP_DEPARTED_BAY		(1<<3)
 #define SHIP_DEPARTED			( SHIP_DEPARTED_BAY | SHIP_DEPARTED_WARP )
-// Goober5000
+#define SHIP_REDALERT			(1<<4)
+
+/**
+ * @brief Deletes and de-inits a ship.
+ *
+ * @param[in] shipnum      Index of this ship in Ships[]
+ * @param[in] cleanup_mode Flags describing how this ship is to be removed. See SHIP_VANISHED, SHIP_DESTROYED, etc.
+ *
+ * @details This is the deconstructor of a ship, it does all the necassary processes to remove the ship from the Ships
+ *   array, and frees the slot for use by others. De-init of its Objects[] slot is handled elsewhere.
+ *
+ * @author Goober5000
+ */
 extern void ship_cleanup(int shipnum, int cleanup_mode);
+
+// Goober5000
 extern void ship_destroy_instantly(object *ship_obj, int shipnum);
 extern void ship_actually_depart(int shipnum, int method = SHIP_DEPARTED_WARP);
 
