Merge pull request scp-fs2open#7117 from Goober5000/anchor_refactor

refactor ship anchors

Author: Goober5000

code/ai/aicode.cpp

@@ -14060,7 +14060,7 @@ void ai_bay_depart()
 
 	// check if parent ship valid; if not, abort depart
 	if (gameseq_get_state() != GS_STATE_LAB) {
-		auto anchor_ship_entry = ship_registry_get(Parse_names[Ships[Pl_objp->instance].departure_anchor]);
+		auto anchor_ship_entry = ship_registry_get(Ships[Pl_objp->instance].departure_anchor);
 		if (!anchor_ship_entry ||
 			!ship_useful_for_departure(anchor_ship_entry->shipnum, Ships[Pl_objp->instance].departure_path_mask)) {
 			mprintf(("Aborting bay departure!\n"));

code/mission/missionparse.cpp

@@ -25,6 +25,7 @@
 #include "sound/sound.h"
 #include "mission/mission_flags.h"
 #include "nebula/volumetrics.h"
+#include "ship/anchor_t.h"
 #include "stats/scoring.h"
 
 //WMC - This should be here
@@ -40,16 +41,11 @@ enum class DepartureLocation;
 
 #define DEFAULT_AMBIENT_LIGHT_LEVEL			0x00787878
 
-// arrival anchor types
-// mask should be high enough to avoid conflicting with ship anchors
-#define SPECIAL_ARRIVAL_ANCHOR_FLAG				0x1000
-#define SPECIAL_ARRIVAL_ANCHOR_PLAYER_FLAG		0x0100
-
 #define MIN_TARGET_ARRIVAL_DISTANCE             500.0f // float because that's how FRED does the math
 #define MIN_TARGET_ARRIVAL_MULTIPLIER           2.0f // minimum distance is 2 * target radius, but at least 500
 
-int get_special_anchor(const char *name);
-void check_anchor_for_hangar_bay(SCP_string &message, SCP_set<int> &anchor_shipnums_checked, int anchor_shipnum, const char *other_name, bool other_is_ship, bool is_arrival);
+anchor_t get_special_anchor(const char *name);
+void check_anchor_for_hangar_bay(SCP_string &message, SCP_set<anchor_t> &anchors_checked, anchor_t anchor, const char *other_name, bool other_is_ship, bool is_arrival);
 
 // MISSION_VERSION should be the earliest version of FSO that can load the current mission format without
 // requiring version-specific comments.  It should be updated whenever the format changes, but it should
@@ -102,19 +98,22 @@ inline const std::vector<std::pair<SCP_string, int>> Mission_event_teams_tvt = [
 }();
 
 // Goober5000
-typedef struct support_ship_info {
-	ArrivalLocation		arrival_location;				// arrival location
-	int		arrival_anchor;					// arrival anchor
-	DepartureLocation	departure_location;				// departure location
-	int		departure_anchor;				// departure anchor
-	float	max_hull_repair_val;			// % of a ship's hull that can be repaired -C
-	float	max_subsys_repair_val;			// same thing, except for subsystems -C
-	int		max_support_ships;				// max number of consecutive support ships
-	int		max_concurrent_ships;			// max number of concurrent support ships in mission per team
-	int		ship_class;						// ship class of support ship
-	int		tally;							// number of support ships so far
-	int		support_available_for_species;	// whether support is available for a given species (this is a bitfield)
-} support_ship_info;
+struct support_ship_info
+{
+	ArrivalLocation     arrival_location;   // arrival location
+	anchor_t            arrival_anchor;     // arrival anchor
+	DepartureLocation   departure_location; // departure location
+	anchor_t            departure_anchor;   // departure anchor
+	float   max_hull_repair_val;            // % of a ship's hull that can be repaired -C
+	float   max_subsys_repair_val;          // same thing, except for subsystems -C
+	int     max_support_ships;              // max number of consecutive support ships
+	int     max_concurrent_ships;           // max number of concurrent support ships in mission per team
+	int     ship_class;                     // ship class of support ship
+	int     tally;                          // number of support ships so far
+	int     support_available_for_species;  // whether support is available for a given species (this is a bitfield)
+
+	void reset();
+};
 
 // movie type defines
 // If you add one here, you must also add a description to missioncutscenedlg.cpp for FRED
@@ -446,13 +445,13 @@ class p_object
 
 	ArrivalLocation arrival_location = ArrivalLocation::AT_LOCATION;
 	int	arrival_distance = 0;					// used when arrival location is near or in front of some ship
-	int	arrival_anchor = -1;						// ship used for anchoring an arrival point
+	anchor_t arrival_anchor = anchor_t::invalid();	// ship registry entry used for anchoring an arrival point
 	int arrival_path_mask = 0;					// Goober5000
 	int	arrival_cue = -1;				//	Index in Sexp_nodes of this sexp.
 	int	arrival_delay = 0;
 
 	DepartureLocation departure_location = DepartureLocation::AT_LOCATION;
-	int	departure_anchor = -1;
+	anchor_t departure_anchor = anchor_t::invalid();
 	int departure_path_mask = 0;				// Goober5000
 	int	departure_cue = -1;			//	Index in Sexp_nodes of this sexp.
 	int	departure_delay = 0;

code/mission/missionparse.h

@@ -50,16 +50,36 @@ void stuff_special_arrival_anchor_name(char* buf, int anchor_num, bool retail_fo
 {
 	// filter out iff
 	int iff_index = anchor_num;
-	iff_index &= ~SPECIAL_ARRIVAL_ANCHOR_FLAG;
-	iff_index &= ~SPECIAL_ARRIVAL_ANCHOR_PLAYER_FLAG;
+	iff_index &= ~ANCHOR_SPECIAL_ARRIVAL;
+	iff_index &= ~ANCHOR_SPECIAL_ARRIVAL_PLAYER;
 
 	// filter players
-	int restrict_to_players = (anchor_num & SPECIAL_ARRIVAL_ANCHOR_PLAYER_FLAG);
+	int restrict_to_players = (anchor_num & ANCHOR_SPECIAL_ARRIVAL_PLAYER);
 
 	// get name
 	stuff_special_arrival_anchor_name(buf, iff_index, restrict_to_players, retail_format);
 }
 
+// Ship and wing arrival and departure anchors should always be ship registry entry indexes, except for a very brief window during mission parsing.
+// But FRED and QtFRED dialogs use ship indexes instead.  So, rather than refactor all the dialogs, this converts between the two.  If an anchor
+// is a valid ship registry index, the equivalent ship index is returned; otherwise the special value (-1 or a flag) is returned instead.
+int anchor_to_target(anchor_t anchor)
+{
+	auto anchor_entry = ship_registry_get(anchor);
+	return anchor_entry ? anchor_entry->shipnum : anchor.value();
+}
+
+// Ship and wing arrival and departure anchors should always be ship registry entry indexes, except for a very brief window during mission parsing.
+// But FRED and QtFRED dialogs use ship indexes instead.  So, rather than refactor all the dialogs, this converts between the two.  If a target
+// is a valid ship index, the equivalent ship registry index is returned; otherwise the special value (-1 or a flag) is returned instead.
+anchor_t target_to_anchor(int target)
+{
+	if (target >= 0 && target < MAX_SHIPS)
+		return anchor_t(ship_registry_get_index(Ships[target].ship_name));
+	else
+		return anchor_t(target);
+}
+
 void generate_weaponry_usage_list_team(int team, int* arr)
 {
 	int i;
@@ -112,4 +132,4 @@ void generate_weaponry_usage_list_wing(int wing_num, int* arr)
 			}
 		}
 	}
-}
+}

code/missioneditor/common.cpp

@@ -1,6 +1,7 @@
 #pragma once
 #include "globalincs/globals.h"
 #include "mission/missionmessage.h"
+#include "ship/anchor_t.h"
 
 // Voice acting manager
 #define INVALID_MESSAGE ((MMessage*)SIZE_MAX) // was originally SIZE_T_MAX but that wasn't available outside fred. May need more research.
@@ -31,6 +32,10 @@ void stuff_special_arrival_anchor_name(char* buf, int iff_index, int restrict_to
 
 void stuff_special_arrival_anchor_name(char* buf, int anchor_num, bool retail_format);
 
+int anchor_to_target(anchor_t anchor);
+
+anchor_t target_to_anchor(int target);
+
 void generate_weaponry_usage_list_team(int team, int* arr);
 
-void generate_weaponry_usage_list_wing(int wing_num, int* arr);
+void generate_weaponry_usage_list_wing(int wing_num, int* arr);

code/missioneditor/common.h

@@ -3555,33 +3555,31 @@ int Fred_mission_save::save_objects()
 				fout("\n$Arrival Anchor:");
 			}
 
-			z = shipp->arrival_anchor;
+			z = shipp->arrival_anchor.value();
 			if (z < 0) {
 				fout(" <error>");
-			} else if (z & SPECIAL_ARRIVAL_ANCHOR_FLAG) {
+			} else if (z & ANCHOR_SPECIAL_ARRIVAL) {
 				// get name
 				char tmp[NAME_LENGTH + 15];
 				stuff_special_arrival_anchor_name(tmp, z, save_config.save_format == MissionFormat::RETAIL);
 
 				// save it
 				fout(" %s", tmp);
 			} else {
-				fout(" %s", Ships[z].ship_name);
+				auto anchor_entry = ship_registry_get(z);
+				fout(" %s", anchor_entry ? anchor_entry->name : "<error>");
 			}
 		}
 
 		// Goober5000
 		if (save_config.save_format != MissionFormat::RETAIL) {
 			if ((shipp->arrival_location == ArrivalLocation::FROM_DOCK_BAY) && (shipp->arrival_path_mask > 0)) {
-				int anchor_shipnum;
-				polymodel* pm;
-
-				anchor_shipnum = shipp->arrival_anchor;
-				Assert(anchor_shipnum >= 0 && anchor_shipnum < MAX_SHIPS);
+				auto anchor_entry = ship_registry_get(shipp->arrival_anchor);
+				Assertion(anchor_entry, "Could not find arrival anchor for ship %s!", shipp->ship_name);
+				auto pm = model_get(anchor_entry->sip()->model_num);
 
 				fout("\n+Arrival Paths: ( ");
 
-				pm = model_get(Ship_info[Ships[anchor_shipnum].ship_info_index].model_num);
 				for (auto n = 0; n < pm->ship_bay->num_paths; n++) {
 					if (shipp->arrival_path_mask & (1 << n)) {
 						fout("\"%s\" ", pm->paths[pm->ship_bay->path_indexes[n]].name);
@@ -3618,24 +3616,19 @@ int Fred_mission_save::save_objects()
 			required_string_fred("$Departure Anchor:");
 			parse_comments();
 
-			if (shipp->departure_anchor >= 0)
-				fout(" %s", Ships[shipp->departure_anchor].ship_name);
-			else
-				fout(" <error>");
+			auto anchor_entry = ship_registry_get(shipp->departure_anchor);
+			fout(" %s", anchor_entry ? anchor_entry->name : "<error>");
 		}
 
 		// Goober5000
 		if (save_config.save_format != MissionFormat::RETAIL) {
 			if ((shipp->departure_location == DepartureLocation::TO_DOCK_BAY) && (shipp->departure_path_mask > 0)) {
-				int anchor_shipnum;
-				polymodel* pm;
-
-				anchor_shipnum = shipp->departure_anchor;
-				Assert(anchor_shipnum >= 0 && anchor_shipnum < MAX_SHIPS);
+				auto anchor_entry = ship_registry_get(shipp->departure_anchor);
+				Assertion(anchor_entry, "Could not find departure anchor for ship %s!", shipp->ship_name);
+				auto pm = model_get(anchor_entry->sip()->model_num);
 
 				fout("\n+Departure Paths: ( ");
 
-				pm = model_get(Ship_info[Ships[anchor_shipnum].ship_info_index].model_num);
 				for (auto n = 0; n < pm->ship_bay->num_paths; n++) {
 					if (shipp->departure_path_mask & (1 << n)) {
 						fout("\"%s\" ", pm->paths[pm->ship_bay->path_indexes[n]].name);
@@ -4932,33 +4925,31 @@ int Fred_mission_save::save_wings()
 			else
 				fout("\n$Arrival Anchor:");
 
-			int z = w.arrival_anchor;
+			int z = w.arrival_anchor.value();
 			if (z < 0) {
 				fout(" <error>");
-			} else if (z & SPECIAL_ARRIVAL_ANCHOR_FLAG) {
+			} else if (z & ANCHOR_SPECIAL_ARRIVAL) {
 				// get name
 				char tmp[NAME_LENGTH + 15];
 				stuff_special_arrival_anchor_name(tmp, z, save_config.save_format == MissionFormat::RETAIL);
 
 				// save it
 				fout(" %s", tmp);
 			} else {
-				fout(" %s", Ships[z].ship_name);
+				auto anchor_entry = ship_registry_get(z);
+				fout(" %s", anchor_entry ? anchor_entry->name : "<error>");
 			}
 		}
 
 		// Goober5000
 		if (save_config.save_format != MissionFormat::RETAIL) {
 			if ((w.arrival_location == ArrivalLocation::FROM_DOCK_BAY) && (w.arrival_path_mask > 0)) {
-				int anchor_shipnum;
-				polymodel* pm;
-
-				anchor_shipnum = w.arrival_anchor;
-				Assert(anchor_shipnum >= 0 && anchor_shipnum < MAX_SHIPS);
+				auto anchor_entry = ship_registry_get(w.arrival_anchor);
+				Assertion(anchor_entry, "Could not find arrival anchor for wing %s!", w.name);
+				auto pm = model_get(anchor_entry->sip()->model_num);
 
 				fout("\n+Arrival Paths: ( ");
 
-				pm = model_get(Ship_info[Ships[anchor_shipnum].ship_info_index].model_num);
 				for (auto n = 0; n < pm->ship_bay->num_paths; n++) {
 					if (w.arrival_path_mask & (1 << n)) {
 						fout("\"%s\" ", pm->paths[pm->ship_bay->path_indexes[n]].name);
@@ -4991,24 +4982,19 @@ int Fred_mission_save::save_wings()
 			required_string_fred("$Departure Anchor:");
 			parse_comments();
 
-			if (w.departure_anchor >= 0)
-				fout(" %s", Ships[w.departure_anchor].ship_name);
-			else
-				fout(" <error>");
+			auto anchor_entry = ship_registry_get(w.departure_anchor);
+			fout(" %s", anchor_entry ? anchor_entry->name : "<error>");
 		}
 
 		// Goober5000
 		if (save_config.save_format != MissionFormat::RETAIL) {
 			if ((w.departure_location == DepartureLocation::TO_DOCK_BAY) && (w.departure_path_mask > 0)) {
-				int anchor_shipnum;
-				polymodel* pm;
-
-				anchor_shipnum = w.departure_anchor;
-				Assert(anchor_shipnum >= 0 && anchor_shipnum < MAX_SHIPS);
+				auto anchor_entry = ship_registry_get(w.departure_anchor);
+				Assertion(anchor_entry, "Could not find departure anchor for wing %s!", w.name);
+				auto pm = model_get(anchor_entry->sip()->model_num);
 
 				fout("\n+Departure Paths: ( ");
 
-				pm = model_get(Ship_info[Ships[anchor_shipnum].ship_info_index].model_num);
 				for (auto n = 0; n < pm->ship_bay->num_paths; n++) {
 					if (w.departure_path_mask & (1 << n)) {
 						fout("\"%s\" ", pm->paths[pm->ship_bay->path_indexes[n]].name);

code/missioneditor/missionsave.cpp

@@ -2981,7 +2981,7 @@ int check_sexp_syntax(int node, int return_type, int recursive, int *bad_node, s
 					int valid = 0;
 
 					// <any friendly>, etc.
-					if (get_special_anchor(CTEXT(node)) >= 0)
+					if (get_special_anchor(CTEXT(node)).isValid())
 					{
 						valid = 1;
 					}
@@ -23594,8 +23594,8 @@ void sexp_set_support_ship(int n)
 	}
 	else
 	{
-		// find or create the anchor
-		The_mission.support_ships.arrival_anchor = get_parse_name_index(CTEXT(n));
+		// find the anchor
+		The_mission.support_ships.arrival_anchor = anchor_t(ship_registry_get_index(CTEXT(n)));
 	}
 
 	// get departure location
@@ -23620,8 +23620,8 @@ void sexp_set_support_ship(int n)
 	}
 	else
 	{
-		// find or create the anchor
-		The_mission.support_ships.departure_anchor = get_parse_name_index(CTEXT(n));
+		// find the anchor
+		The_mission.support_ships.departure_anchor = anchor_t(ship_registry_get_index(CTEXT(n)));
 	}
 
 	// get ship class
@@ -23662,7 +23662,7 @@ void sexp_set_support_ship(int n)
 // Goober5000 - set stuff for arriving ships or wings
 void sexp_set_arrival_info(int node)
 {
-	int arrival_anchor, arrival_mask, arrival_distance, arrival_delay, n = node;
+	int arrival_mask, arrival_distance, arrival_delay, n = node;
 	bool show_warp, adjust_warp_when_docked, is_nan, is_nan_forever;
 	object_ship_wing_point_team oswpt;
 
@@ -23683,16 +23683,16 @@ void sexp_set_arrival_info(int node)
 	n = CDR(n);
 
 	// get arrival anchor
-	arrival_anchor = -1;
+	anchor_t arrival_anchor;
 	if ((n < 0) || !stricmp(CTEXT(n), "<no anchor>"))
 	{
 		// if no anchor, set arrival location to hyperspace
 		arrival_location = ArrivalLocation::AT_LOCATION;
 	}
 	else
 	{
-		// find or create the anchor
-		arrival_anchor = get_parse_name_index(CTEXT(n));
+		// find the anchor
+		arrival_anchor = anchor_t(ship_registry_get_index(CTEXT(n)));
 	}
 	n = CDR(n);
 
@@ -23762,7 +23762,7 @@ void sexp_set_arrival_info(int node)
 // Goober5000 - set stuff for departing ships or wings
 void sexp_set_departure_info(int node)
 {
-	int departure_anchor, departure_mask, departure_delay, n = node;
+	int departure_mask, departure_delay, n = node;
 	bool show_warp, adjust_warp_when_docked, is_nan, is_nan_forever;
 	object_ship_wing_point_team oswpt;
 
@@ -23783,16 +23783,16 @@ void sexp_set_departure_info(int node)
 	n = CDR(n);
 
 	// get departure anchor
-	departure_anchor = -1;
+	anchor_t departure_anchor;
 	if ((n < 0) || !stricmp(CTEXT(n), "<no anchor>"))
 	{
 		// if no anchor, set departure location to hyperspace
 		departure_location = DepartureLocation::AT_LOCATION;
 	}
 	else
 	{
-		// find or create the anchor
-		departure_anchor = get_parse_name_index(CTEXT(n));
+		// find the anchor
+		departure_anchor = anchor_t(ship_registry_get_index(CTEXT(n)));
 	}
 	n = CDR(n);