Merge pull request scp-fs2open#2003 from Goober5000/abort_processing_missions_which_failed_to_parse

cancel mission load when a syntax error is found

Author: asarium

code/mission/missionload.cpp

@@ -97,9 +97,8 @@ bool mission_is_ignored(const char *filename)
 // Mission_load takes no parameters.
 // It sets the following global variables
 //   Game_current_mission_filename
-
-// returns -1 if failed, 0 if successful
-int mission_load(const char* filename_ext)
+// returns true successful, false if failed
+bool mission_load(const char* filename_ext)
 {
 	TRACE_SCOPE(tracing::LoadMissionLoad);
 
@@ -120,7 +119,7 @@ int mission_load(const char* filename_ext)
 
 	if (mission_is_ignored(filename)) {
 		mprintf(("MISSION LOAD: Tried to load an ignored mission!  Aborting..."));
-		return -1;
+		return false;
 	}
 
 	strcat_s(filename, FS_MISSION_FILE_EXT);
@@ -131,8 +130,8 @@ int mission_load(const char* filename_ext)
 	// to choose the type of ship that he is to fly
 	// return value of 0 indicates success, other is failure.
 
-	if ( parse_main(filename) )
-		return -1;
+	if ( !parse_main(filename) )
+		return false;
 
 	if (Select_default_ship) {
 		int ret;
@@ -143,7 +142,8 @@ int mission_load(const char* filename_ext)
 	ml_update_recent_missions(filename_ext);  // update recently played missions list (save the csg later)
 
 	init_hud();
-	return 0;
+
+	return true;
 }
 
 //====================================

code/mission/missionload.h

@@ -27,7 +27,7 @@ extern SCP_vector<SCP_string> Ignored_missions;
 // It sets the following global variables:
 // Game_current_mission_filename
 
-int mission_load(const char* filename_ext);
+bool mission_load(const char* filename_ext);
 
 bool mission_is_ignored(const char *filename);
 

code/mission/missionparse.cpp

@@ -374,7 +374,7 @@ extern fix game_get_overall_frametime();	// for texture animation
 
 // local prototypes
 void parse_player_info2(mission *pm);
-void post_process_mission();
+bool post_process_mission();
 int allocate_subsys_status();
 void parse_common_object_data(p_object	*objp);
 void parse_asteroid_fields(mission *pm);
@@ -5598,7 +5598,7 @@ void parse_variables()
 	}
 }
 
-int parse_mission(mission *pm, int flags)
+bool parse_mission(mission *pm, int flags)
 {
 	int saved_warning_count = Global_warning_count;
 	int saved_error_count = Global_error_count;
@@ -5639,7 +5639,7 @@ int parse_mission(mission *pm, int flags)
 	Current_file_checksum = netmisc_calc_checksum(pm,MISSION_CHECKSUM_SIZE);
 
 	if (flags & MPF_ONLY_MISSION_INFO)
-		return 0;
+		return true;
 
 	parse_plot_info(pm);
 	parse_variables();
@@ -5666,7 +5666,7 @@ int parse_mission(mission *pm, int flags)
 		// if running on standalone server, just print to the log
 		if (Game_mode & GM_STANDALONE_SERVER) {
 			mprintf(("Warning!  Could not load %d ship classes!", Num_unknown_ship_classes));
-			return -2;
+			return false;
 		}
 		// don't do this in FRED; we will display a separate popup
 		else if (!Fred_running) {
@@ -5708,12 +5708,14 @@ int parse_mission(mission *pm, int flags)
 			// now display the popup
 			int popup_rval = popup(PF_TITLE_BIG | PF_TITLE_RED, 2, POPUP_NO, POPUP_YES, text);
 			if (popup_rval == 0) {
-				return -2;
+				return false;
 			}
 		}
 	}
 
-	post_process_mission();
+	if (!post_process_mission()) {
+		return false;
+	}
 
 	if ((saved_warning_count - Global_warning_count) > 10 || (saved_error_count - Global_error_count) > 0) {
 		char text[512];
@@ -5724,10 +5726,10 @@ int parse_mission(mission *pm, int flags)
 	log_printf(LOGFILE_EVENT_LOG, "Mission %s loaded.\n", pm->name); 
 
 	// success
-	return 0;
+	return true;
 }
 
-void post_process_mission()
+bool post_process_mission()
 {
 	int			i;
 	int			indices[MAX_SHIPS], objnum;
@@ -5840,21 +5842,18 @@ void post_process_mission()
 
 			// entering this if statement will result in program termination!!!!!
 			// print out an error based on the return value from check_sexp_syntax()
+			// G5K: now entering this statement simply aborts the mission load
 			if ( result ) {
 				SCP_string sexp_str;
 				SCP_string error_msg;
 
 				convert_sexp_to_string(sexp_str, i, SEXP_ERROR_CHECK_MODE);
 				truncate_message_lines(sexp_str, 30);
 				sprintf(error_msg, "%s.\n\nIn sexpression: %s\n(Error appears to be: %s)", sexp_error_message(result), sexp_str.c_str(), Sexp_nodes[bad_node].text);
+				Warning(LOCATION, "%s", error_msg.c_str());
 
-				if (!Fred_running) {
-					nprintf(("Error", "%s", error_msg.c_str()));
-					Error(LOCATION, "%s", error_msg.c_str());
-				} else {
-					nprintf(("Warning", "%s", error_msg.c_str()));
-					Warning(LOCATION, "%s", error_msg.c_str());
-				}
+				// syntax errors are unrecoverable, so abort
+				return false;
 			}
 		}
 	}
@@ -5958,6 +5957,9 @@ void post_process_mission()
 		mission_hotkey_reset_saved();
 	}
 	Last_file_checksum = Current_file_checksum;
+
+	// success
+	return true;
 }
 
 int get_mission_info(const char *filename, mission *mission_p, bool basic)
@@ -6026,9 +6028,10 @@ void parse_init(bool basic)
 // mai parse routine for parsing a mission.  The default parameter flags tells us which information
 // to get when parsing the mission.  0 means get everything (default).  Other flags just gets us basic
 // info such as game type, number of players etc.
-int parse_main(const char *mission_name, int flags)
+bool parse_main(const char *mission_name, int flags)
 {
-	int rval, i;
+	int i;
+	bool rval;
 
 	// reset parse error stuff
 	Num_unknown_ship_classes = 0;
@@ -6057,7 +6060,7 @@ int parse_main(const char *mission_name, int flags)
 				Current_file_length = -1;
 				Current_file_checksum = 0;
 
-				rval = -1;
+				rval = false;
 				break;
 			}
 
@@ -6083,7 +6086,7 @@ int parse_main(const char *mission_name, int flags)
 		catch (const parse::ParseException& e)
 		{
 			mprintf(("MISSIONS: Unable to parse '%s'!  Error message = %s.\n", mission_name, e.what()));
-			rval = 1;
+			rval = false;
 			break;
 		}
 	} while (0);

code/mission/missionparse.h

@@ -479,7 +479,7 @@ extern p_object *Arriving_support_ship;
 extern char Neb2_texture_name[MAX_FILENAME_LEN];
 
 
-int parse_main(const char *mission_name, int flags = 0);
+bool parse_main(const char *mission_name, int flags = 0);
 p_object *mission_parse_get_arrival_ship(ushort net_signature);
 p_object *mission_parse_get_arrival_ship(const char *name);
 p_object *mission_parse_get_parse_object(ushort net_signature);

code/scripting/api/libs/mission.cpp

@@ -995,7 +995,7 @@ ADE_FUNC(loadMission, l_Mission, "Mission name", "Loads a mission", "boolean", "
 	get_mission_info(s, &The_mission, false);
 	game_level_init();
 
-	if(mission_load(s) == -1)
+	if(!mission_load(s))
 		return ADE_RETURN_FALSE;
 
 	game_post_level_init();

fred2/freddoc.cpp

@@ -100,9 +100,10 @@ void CFREDDoc::AssertValid() const {
 }
 #endif //_DEBUG
 
-int CFREDDoc::autoload() {
+bool CFREDDoc::autoload() {
 	char name[256], backup_name[256];
-	int i, r;
+	int i;
+	bool r;
 	FILE *fp;
 
 	cf_create_default_path_string(name, sizeof(name) - 1, CF_TYPE_MISSIONS);
@@ -217,7 +218,7 @@ void CFREDDoc::editor_init_mission() {
 	recreate_dialogs();
 }
 
-int CFREDDoc::load_mission(char *pathname, int flags) {
+bool CFREDDoc::load_mission(char *pathname, int flags) {
 	// make sure we're in the correct working directory!!!!!!
 	chdir(Fred_base_dir);
 
@@ -234,7 +235,7 @@ int CFREDDoc::load_mission(char *pathname, int flags) {
 
 	clear_mission();
 
-	if (parse_main(pathname, flags)) {
+	if (!parse_main(pathname, flags)) {
 		if (flags & MPF_IMPORT_FSM) {
 			sprintf(name, "Unable to import the file \"%s\".", pathname);
 			Fred_view_wnd->MessageBox(name);
@@ -243,7 +244,7 @@ int CFREDDoc::load_mission(char *pathname, int flags) {
 			Fred_view_wnd->MessageBox(name);
 		}
 		create_new_mission();
-		return -1;
+		return false;
 	}
 
 	if ((Num_unknown_ship_classes > 0) || (Num_unknown_weapon_classes > 0) || (Num_unknown_loadout_classes > 0)) {
@@ -360,7 +361,7 @@ int CFREDDoc::load_mission(char *pathname, int flags) {
 
 	recreate_dialogs();
 
-	return 0;
+	return true;
 }
 
 void CFREDDoc::OnDuplicate() {
@@ -514,7 +515,7 @@ void CFREDDoc::OnFileImportFSM() {
 		strcpy_s(fs1_path, fs1_path_mfc);
 
 		// load mission into memory
-		if (load_mission(fs1_path, MPF_IMPORT_FSM))
+		if (!load_mission(fs1_path, MPF_IMPORT_FSM))
 			continue;
 
 		// get filename
@@ -597,7 +598,7 @@ BOOL CFREDDoc::OnOpenDocument(LPCTSTR pathname) {
 	//		unlink(name);
 	//	}
 
-	if (load_mission(mission_pathname)) {
+	if (!load_mission(mission_pathname)) {
 		*Mission_filename = 0;
 		return FALSE;
 	}
@@ -653,7 +654,7 @@ BOOL CFREDDoc::OnSaveDocument(LPCTSTR pathname) {
 	}
 
 	SetModifiedFlag(FALSE);
-	if (load_mission((char *) pathname))
+	if (!load_mission((char *) pathname))
 		Error(LOCATION, "Failed attempting to reload mission after saving.  Report this bug now!");
 
 	if (Briefing_dialog) {

fred2/freddoc.h

@@ -38,18 +38,17 @@ class CFREDDoc : public CDocument
 	 *
 	 * @returns The file index of the loaded Undo item
 	 */
-	int autoload();
+	bool autoload();
 
 	/**
 	 * @brief Read in a new mission file from disk
 	 *
 	 * @param[in] pathname The full filepath name of the file to open
 	 * @param[in] flags
 	 *
-	 * @returns File index of the loaded file, or
-	 * @returns 0 if unable to load
+	 * @returns true on success, false on failure
 	 */
-	int load_mission(char *pathname, int flags = 0);
+	bool load_mission(char *pathname, int flags = 0);
 
 	/**
 	 * @brief Pushes an Undo item onto the stack

fred2/fredstubs.cpp

@@ -178,7 +178,7 @@ void game_set_view_clip(){}
 int Warpout_forced = 0;
 float Warpout_time;
 vec3d Dead_player_last_vel;
-int game_start_mission(){return 0;}
+bool game_start_mission() {return false;}
 int Game_weapons_tbl_valid;
 int Game_ships_tbl_valid;
 void game_level_close(){}

freespace2/freespace.cpp

@@ -1399,7 +1399,7 @@ void game_post_level_init()
 /**
  * Tells the server to load the mission and initialize structures
  */
-int game_start_mission()
+bool game_start_mission()
 {
 	mprintf(( "=================== STARTING LEVEL LOAD ==================\n" ));
 
@@ -1424,7 +1424,7 @@ int game_start_mission()
 
 	game_busy( NOX("** starting mission_load() **") );
 	load_mission_load = (uint) time(NULL);
-	if (mission_load(Game_current_mission_filename)) {
+	if ( !mission_load(Game_current_mission_filename) ) {
 		if ( !(Game_mode & GM_MULTIPLAYER) ) {
 			popup(PF_BODY_BIG | PF_USE_AFFIRMATIVE_ICON, 1, POPUP_OK, XSTR( "Attempt to load the mission failed", 169));
 			gameseq_post_event(GS_EVENT_MAIN_MENU);
@@ -1438,7 +1438,7 @@ int game_start_mission()
 
 		game_level_close();
 
-		return 0;
+		return false;
 	}
 	load_mission_load = (uint) (time(NULL) - load_mission_load);
 
@@ -1463,7 +1463,7 @@ int game_start_mission()
 	int e1 __UNUSED = timer_get_milliseconds();
 
 	mprintf(("Level load took %f seconds.\n", (e1 - s1) / 1000.0f ));
-	return 1;
+	return true;
 }
 
 int Interface_framerate = 0;

freespace2/freespace.h

@@ -93,7 +93,7 @@ typedef struct fs_builtin_mission {
 // mission management -------------------------------------------------
 
 // loads in the currently selected mission
-int game_start_mission();		
+bool game_start_mission();		
 
 // shutdown a mission
 void game_level_close();