QtFRED Generalized Mission/Campaign Save

code/mission/missioncampaign.cpp

@@ -504,7 +504,7 @@ int mission_campaign_load(const char* filename, const char* full_path, player* p
 			Error(LOCATION, "Unknown campaign type %s!", type);
 
 		if (optional_string("+Description:"))
-			Campaign.desc = stuff_and_malloc_string(F_MULTITEXT, NULL);
+			stuff_string(Campaign.description, F_MULTITEXT);
 
 		// if the type is multiplayer -- get the number of players
 		if ( Campaign.type != CAMPAIGN_TYPE_SINGLE) {
@@ -1204,10 +1204,7 @@ void mission_campaign_clear()
 {
 	int i;
 
-	if (Campaign.desc != NULL) {
-		vm_free(Campaign.desc);
-		Campaign.desc = NULL;
-	}
+	Campaign.description.clear();
 
 	// be sure to remove all old malloced strings of Mission_names
 	// we must also free any goal stuff that was from a previous campaign

code/mission/missioncampaign.h

@@ -116,7 +116,7 @@ class campaign
 public:
 	char	name[NAME_LENGTH];						// name of the campaign
 	char	filename[CF_MAX_PATHNAME_LENGTH];			// filename the campaign info is in
-	char	*desc;									// description of campaign
+	SCP_string description;                         // unlimited length description of campaign
 	int		type;									// type of campaign
 	int		flags;									// flags - Goober5000
 	int		num_missions;							// number of missions in the campaign
@@ -139,7 +139,7 @@ class campaign
 	SCP_map<SCP_string, SCP_string> custom_data;        // Custom data for the campaign
 
 	campaign()
-		: desc(nullptr), num_missions(0)
+		: num_missions(0)
 	{
 		name[0] = 0;
 		filename[0] = 0;

code/missioneditor/campaignsave.cpp

@@ -0,0 +1,317 @@
+#include "campaignsave.h"
+
+#include "globalincs/linklist.h"
+#include "globalincs/version.h"
+
+#include "mission/missioncampaign.h"
+#include "parse/parselo.h"
+
+#include <freespace.h>
+
+// Bodies copied from the old implementations in missionsave.cpp,
+// unchanged except for the new class name and include.
+int Fred_campaign_save::save_campaign_file(const char* pathname, const SCP_vector<campaign_link>& links)
+{
+	// This is original FRED code. These were moved to the call sites as the data should be fully
+	// prepared before calling this function.
+	// TODO check QtFRED's tree is sorted and saved before calling this function.
+	// Campaign_tree_formp->save_tree(); // flush all changes so they get saved.
+	// Campaign_tree_viewp->sort_elements();
+
+	reset_parse();
+	raw_ptr = Parse_text_raw;
+	fred_parse_flag = 0;
+
+	pathname = cf_add_ext(pathname, FS_CAMPAIGN_FILE_EXT);
+	fp = cfopen(pathname, "wt", CF_TYPE_MISSIONS);
+	if (!fp) {
+		nprintf(("Error", "Can't open campaign file to save.\n"));
+		return -1;
+	}
+
+	required_string_fred("$Name:");
+	parse_comments(0);
+	fout_ext(" ", "%s", Campaign.name);
+
+	// TODO make type an enum to clean this up
+	Assert((Campaign.type >= 0) && (Campaign.type < MAX_CAMPAIGN_TYPES));
+	required_string_fred("$Type:");
+	parse_comments();
+	fout(" %s", campaign_types[Campaign.type]);
+
+	// XSTR
+	if (!Campaign.description.empty()) {
+		required_string_fred("+Description:");
+		parse_comments();
+		fout_ext("\n", "%s", Campaign.description.c_str());
+		fout("\n$end_multi_text");
+	}
+
+	if (Campaign.type != CAMPAIGN_TYPE_SINGLE) {
+		required_string_fred("+Num Players:");
+		parse_comments();
+		fout(" %d", Campaign.num_players);
+	}
+
+	// campaign flags - Goober5000
+	if (save_config.save_format != MissionFormat::RETAIL) {
+		optional_string_fred("$Flags:");
+		parse_comments();
+		fout(" %d\n", Campaign.flags);
+	}
+
+	if (save_config.save_format != MissionFormat::RETAIL && !Campaign.custom_data.empty()) {
+		if (optional_string_fred("$begin_custom_data_map")) {
+			parse_comments(2);
+		} else {
+			fout("\n$begin_custom_data_map");
+		}
+
+		for (const auto& pair : Campaign.custom_data) {
+			fout("\n   +Val: %s %s", pair.first.c_str(), pair.second.c_str());
+		}
+
+		if (optional_string_fred("$end_custom_data_map")) {
+			parse_comments();
+		} else {
+			fout("\n$end_custom_data_map");
+		}
+	}
+
+	// write out the ships and weapons which the player can start the campaign with
+	optional_string_fred("+Starting Ships: (");
+	parse_comments(2);
+	for (int i = 0; i < ship_info_size(); i++) {
+		if (Campaign.ships_allowed[i])
+			fout(" \"%s\" ", Ship_info[i].name);
+	}
+	fout(")\n");
+
+	optional_string_fred("+Starting Weapons: (");
+	parse_comments();
+	for (int i = 0; i < weapon_info_size(); i++) {
+		if (Campaign.weapons_allowed[i])
+			fout(" \"%s\" ", Weapon_info[i].name);
+	}
+	fout(")\n");
+
+	fred_parse_flag = 0;
+	for (int i = 0; i < Campaign.num_missions; i++) {
+		// Expect to get Campaign.missions ordered from FRED
+		cmission& cm = Campaign.missions[i];
+
+		required_string_either_fred("$Mission:", "#End");
+		required_string_fred("$Mission:");
+		parse_comments(2);
+		fout(" %s", cm.name);
+
+		if (strlen(cm.briefing_cutscene)) {
+			if (optional_string_fred("+Briefing Cutscene:", "$Mission"))
+				parse_comments();
+			else
+				fout("\n+Briefing Cutscene:");
+
+			fout(" %s", cm.briefing_cutscene);
+		}
+
+		required_string_fred("+Flags:", "$Mission:");
+		parse_comments();
+
+		// don't save any internal flags
+		auto flags_to_save = cm.flags & CMISSION_EXTERNAL_FLAG_MASK;
+
+		// Goober5000
+		if (save_config.save_format != MissionFormat::RETAIL) {
+			// don't save Bastion flag
+			fout(" %d", flags_to_save & ~CMISSION_FLAG_BASTION);
+
+			// new main hall stuff
+			if (optional_string_fred("+Main Hall:", "$Mission:"))
+				parse_comments();
+			else
+				fout("\n+Main Hall:");
+
+			fout(" %s", cm.main_hall.c_str());
+		} else {
+			// save Bastion flag properly
+			fout(" %d", flags_to_save | ((!cm.main_hall.empty()) ? CMISSION_FLAG_BASTION : 0));
+		}
+
+		if (!cm.substitute_main_hall.empty()) {
+			fso_comment_push(";;FSO 3.7.2;;");
+			if (optional_string_fred("+Substitute Main Hall:")) {
+				parse_comments(1);
+				fout(" %s", cm.substitute_main_hall.c_str());
+			} else {
+				fout_version("\n+Substitute Main Hall: %s", cm.substitute_main_hall.c_str());
+			}
+			fso_comment_pop();
+		} else {
+			bypass_comment(";;FSO 3.7.2;; +Substitute Main Hall:");
+		}
+
+		if (cm.debrief_persona_index > 0) {
+			fso_comment_push(";;FSO 3.6.8;;");
+			if (optional_string_fred("+Debriefing Persona Index:")) {
+				parse_comments(1);
+				fout(" %d", cm.debrief_persona_index);
+			} else {
+				fout_version("\n+Debriefing Persona Index: %d", cm.debrief_persona_index);
+			}
+			fso_comment_pop();
+		} else {
+			bypass_comment(";;FSO 3.6.8;; +Debriefing Persona Index:");
+		}
+
+		// save campaign link sexp
+		bool mission_loop = false;
+		bool mission_fork = false;
+		int flag = 0;
+		for (auto& link : links) {
+			if (link.from == i) {
+				if (!flag) {
+					if (optional_string_fred("+Formula:", "$Mission:"))
+						parse_comments();
+					else
+						fout("\n+Formula:");
+
+					fout(" ( cond\n");
+					flag = 1;
+				}
+
+				if (link.is_mission_loop) {
+					mission_loop = true;
+				} else if (link.is_mission_fork && (save_config.save_format != MissionFormat::RETAIL)) {
+					mission_fork = true;
+				} else {
+					save_campaign_sexp(link.sexp, link.to);
+				}
+			}
+		}
+
+		if (flag) {
+			fout(")");
+		}
+
+		// now save campaign loop sexp
+		if (mission_loop || mission_fork) {
+			if (mission_loop)
+				required_string_fred("\n+Mission Loop:");
+			else
+				required_string_fred("\n+Mission Fork:");
+			parse_comments();
+
+			int num_mission_special = 0;
+			for (auto& link : links) {
+				if ((link.from == i) && (link.is_mission_loop || link.is_mission_fork)) {
+
+					num_mission_special++;
+
+					if ((num_mission_special == 1) && link.mission_branch_txt) {
+						if (mission_loop)
+							required_string_fred("+Mission Loop Text:");
+						else
+							required_string_fred("+Mission Fork Text:");
+						parse_comments();
+						fout_ext("\n", "%s", link.mission_branch_txt);
+						fout("\n$end_multi_text");
+					}
+
+					if ((num_mission_special == 1) && link.mission_branch_brief_anim) {
+						if (mission_loop)
+							required_string_fred("+Mission Loop Brief Anim:");
+						else
+							required_string_fred("+Mission Fork Brief Anim:");
+						parse_comments();
+						fout_ext("\n", "%s", link.mission_branch_brief_anim);
+						fout("\n$end_multi_text");
+					}
+
+					if ((num_mission_special == 1) && link.mission_branch_brief_sound) {
+						if (mission_loop)
+							required_string_fred("+Mission Loop Brief Sound:");
+						else
+							required_string_fred("+Mission Fork Brief Sound:");
+						parse_comments();
+						fout_ext("\n", "%s", link.mission_branch_brief_sound);
+						fout("\n$end_multi_text");
+					}
+
+					if (num_mission_special == 1) {
+						// write out mission loop formula
+						fout("\n+Formula:");
+						fout(" ( cond\n");
+						save_campaign_sexp(link.sexp, link.to);
+						fout(")");
+					}
+					if (mission_fork) {
+						fout("Option: ", Campaign.missions[link.to].name);
+					}
+				}
+			}
+			if (mission_loop && num_mission_special > 1) {
+				char buffer[1024];
+				sprintf(buffer,
+					"Multiple branching loop error from mission %s\nEdit campaign for *at most* 1 loop from each "
+					"mission.",
+					cm.name);
+				Message(os::dialogs::MESSAGEBOX_ERROR, buffer);
+			}
+		}
+
+		if (optional_string_fred("+Level:", "$Mission:")) {
+			parse_comments();
+		} else {
+			fout("\n\n+Level:");
+		}
+
+		fout(" %d", cm.level);
+
+		if (optional_string_fred("+Position:", "$Mission:")) {
+			parse_comments();
+		} else {
+			fout("\n+Position:");
+		}
+
+		fout(" %d", cm.pos);
+
+		fso_comment_pop();
+	}
+
+	required_string_fred("#End");
+	parse_comments(2);
+	token_found = nullptr;
+	parse_comments();
+	fout("\n");
+
+	cfclose(fp);
+	fso_comment_pop(true);
+
+	// Mission editor should run the error checker *before* calling the save function
+	Assertion(!err, "Nothing in here should have a side effect to raise the mission error saving flag.");
+
+	return err;
+}
+
+void Fred_campaign_save::save_campaign_sexp(int node, int link_num)
+{
+	SCP_string sexp_out;
+	Assert(node >= 0);
+
+	// if the link num is -1, then this is a end-of-campaign location
+	if (link_num != -1) {
+		if (build_sexp_string(sexp_out, node, 2, SEXP_SAVE_MODE)) {
+			fout("   (\n      %s\n      ( next-mission \"%s\" )\n   )\n",
+				sexp_out.c_str(),
+				Campaign.missions[link_num].name);
+		} else {
+			fout("   ( %s( next-mission \"%s\" ) )\n", sexp_out.c_str(), Campaign.missions[link_num].name);
+		}
+	} else {
+		if (build_sexp_string(sexp_out, node, 2, SEXP_SAVE_MODE)) {
+			fout("   (\n      %s\n      ( end-of-campaign )\n   )\n", sexp_out.c_str());
+		} else {
+			fout("   ( %s( end-of-campaign ) )\n", sexp_out.c_str());
+		}
+	}
+}

code/missioneditor/campaignsave.h

@@ -0,0 +1,40 @@
+#pragma once
+#include "missionsave.h"
+
+typedef struct campaign_link {
+	int from;                         // index of source mission
+	int to;                           // index of mission link leads to
+	int sexp;                         // sexp index of condition that allows this branch
+	int node;                         // node tracker when link is in sexp tree window
+	bool is_mission_loop;             // whether link leads to mission loop
+	bool is_mission_fork;             // whether link leads to mission fork
+	char* mission_branch_txt;         // text describing mission loop
+	char* mission_branch_brief_anim;  // filename of anim to play in the brief
+	char* mission_branch_brief_sound; // filename of anim to play in the brief
+} campaign_link;
+
+class Fred_campaign_save : public Fred_mission_save {
+  public:
+	/**
+	 * @brief Saves the campaign file to the given full pathname
+	 *
+	 * @param[in] pathname The full pathname to save to
+	 *
+	 * @details Returns the value of CFred_mission_save::err, which is:
+	 *
+	 * @returns 0 for no error, or
+	 * @returns A negative value if an error occurred
+	 *
+	 * @see save_mission_internal()
+	 */
+	int save_campaign_file(const char* pathname, const SCP_vector<campaign_link>& links);
+
+  private:
+	/**
+	 * @brief Save the campaign sexp to file
+	 *
+	 * @param[in] node Index of the sexp node
+	 * @param[in] link Mission index of the next mission. Is -1 if this is the last link
+	 */
+	void save_campaign_sexp(int node, int link_num);
+};