Added warning popups.

Author: MyNameIsTrez

ConversionRules/Warnings.json

@@ -0,0 +1,3 @@
+{
+	"PlaySound": "No longer supported. Create a SoundContainer with CreateSoundContainer in the appropriate Create function.",
+}

Python/convert.py

@@ -5,10 +5,16 @@
 
 from Python import shared_globals as cfg
 
-
 progress = 0
 total_progress = 0
+
+warnings_file_name = "Warnings.json"
+warnings_path = os.path.join("ConversionRules", warnings_file_name)
+warnings_available = os.path.isfile(warnings_path)
+
 conversion_rules = {}
+warning_rules = {}
+warnings = []
 
 
 # TODO: Move to shared_globals.py
@@ -25,20 +31,22 @@ def resource_path(relative_path):
 output_folder = ".." if getattr(sys, 'frozen', False) else "Output"
 
 
-def	load_conversion_rules():
+def	load_conversion_and_warning_rules():
 	json_parser = JsonComment(json)
 
 	json_files_found = 0
 	try:
 		for name in os.listdir("ConversionRules"):
-			if name.endswith(".json"):
-				path = os.path.join("ConversionRules", name)
-				with open(path) as f:
-					json_files_found += 1
-					conversion_rules.update(json_parser.load(f))
+			if name.endswith(".json") and name != warnings_file_name:
+				json_files_found += 1
+				with open(os.path.join("ConversionRules", name)) as f:
+					conversion_rules.update(json_parser.load(f)) 
+		if warnings_available:
+			with open(warnings_path) as f:
+				warning_rules.update(json_parser.load(f))
 	except:
 		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder wasn't found next to this executable. You can get the missing folder from the Legacy Mod Converter GitHub repo.", title="Missing ConversionRules folder", custom_text="Go to GitHub"))
-	
+
 	if json_files_found == 0:
 		check_github_button_clicked_and_exit(cfg.sg.Popup("The 'ConversionRules' folder didn't contain any JSON files. You can get the JSON files from the Legacy Mod Converter GitHub repo.", title="Missing JSON files", custom_text="Go to GitHub"))
 
@@ -51,147 +59,163 @@ def check_github_button_clicked_and_exit(clicked_github_button):
 
 
 def convert():
-	global progress, total_progress, output_folder
+	global progress, total_progress, output_folder, warnings
 
 	time_start = time.time()
 
-	input_folder = cfg.sg.user_settings_get_entry("input_folder")
+	input_folder_path = cfg.sg.user_settings_get_entry("input_folder")
+	true_input_folder_path = os.path.join(input_folder_path, os.pardir) # TODO: Better variable name.
 
-	unzip(input_folder)
+	unzip(input_folder_path)
 
-	total_progress = get_total_progress(input_folder)
+	total_progress = get_total_progress(input_folder_path)
 
-	for input_folder_path, input_subfolders, full_filename_list in os.walk(input_folder):
-		mod_subfolder = get_mod_subfolder(input_folder, input_folder_path)
+	for input_subfolder_path, input_subfolders, input_subfiles in os.walk(input_folder_path):
+		mod_subfolder = get_mod_subfolder(input_folder_path, input_subfolder_path, true_input_folder_path)
 		output_subfolder = os.path.join(output_folder, mod_subfolder)
 
 		try_print_mod_name(mod_subfolder)
-		create_folder(input_folder_path, output_subfolder)
-		process_file(full_filename_list, input_folder_path, output_subfolder)
+		create_folder(input_subfolder_path, output_subfolder)
+		process_file(input_subfiles, input_subfolder_path, output_subfolder, input_folder_path)
 
 	if cfg.sg.user_settings_get_entry("output_zips"):
-		create_zips(input_folder, output_folder)
+		create_zips(input_folder_path, output_folder)
+
+	if len(warnings) > 0:
+		warnings_popup()
 
 	progress = 0
 	total_progress = 0
+	warnings = []
 
 	elapsed = math.floor(time.time() - time_start)
 	if cfg.sg.user_settings_get_entry("play_finish_sound"):
 		playsound(finishSoundPath)
 	print("Finished in {} {}".format(elapsed, pluralize("second", elapsed)))
 
 
-def unzip(input_folder):
-	for f in os.listdir(input_folder):
-		zip_path = os.path.join(input_folder, f)
+def unzip(input_folder_path):
+	for f in os.listdir(input_folder_path):
+		zip_path = os.path.join(input_folder_path, f)
 		if zipfile.is_zipfile(zip_path):
 			with zipfile.ZipFile(zip_path) as item:
-				item.extractall(input_folder)
+				item.extractall(input_folder_path)
 			os.remove(zip_path)
 
 
-def get_total_progress(input_folder):
-	if input_folder.endswith(".rte"):
+def get_total_progress(input_folder_path):
+	if input_folder_path.endswith(".rte"):
 		mod_count = 1
 	else:
-		mod_count = len([name for name in os.listdir(input_folder) if os.path.isdir(os.path.join(input_folder, name))])
+		mod_count = len([name for name in os.listdir(input_folder_path) if os.path.isdir(os.path.join(input_folder_path, name))])
 
 	return mod_count * 2 if cfg.sg.user_settings_get_entry("output_zips") else mod_count
 
 
-def get_mod_subfolder(input_folder, input_folder_path):
-	if input_folder.endswith(".rte"):
-		return os.path.relpath(input_folder_path, os.path.join(input_folder, os.pardir))
+def get_mod_subfolder(input_folder_path, input_subfolder_path, true_input_folder_path):
+	if input_folder_path.endswith(".rte"):
+		return os.path.relpath(input_subfolder_path, true_input_folder_path)
 	else:
-		return os.path.relpath(input_folder_path, input_folder)
+		return os.path.relpath(input_subfolder_path, input_folder_path)
 
 
 def try_print_mod_name(mod_subfolder):
-	input_folder_path_tuple = pathlib.Path(mod_subfolder).parts
+	input_subfolder_path_tuple = pathlib.Path(mod_subfolder).parts
 
-	if len(input_folder_path_tuple) == 1:
-		print("Converting '{}'".format(input_folder_path_tuple[0]))
+	if len(input_subfolder_path_tuple) == 1:
+		print("Converting '{}'".format(input_subfolder_path_tuple[0]))
 		update_progress()
 
 
 def update_progress():
-	global progress, total_progress
+	global progress
 	progress += 1
 	cfg.progress_bar.UpdateBar(progress % total_progress, total_progress)
 
 
-def create_folder(input_folder_path, output_subfolder):
-	# Prevents putting the input_folder itself into the output_subfolder.
-	# if input_folder_path != cfg.sg.user_settings_get_entry("input_folder"):
-
+def create_folder(input_subfolder_path, output_subfolder):
 	try:
 		os.makedirs(output_subfolder)
 	except FileExistsError:
 		pass
 
 
-def process_file(full_filename_list, input_folder_path, output_subfolder):
-	for full_filename in full_filename_list:
+def process_file(input_subfiles, input_subfolder_path, output_subfolder, input_folder_path):
+	for full_filename in input_subfiles:
 		filename, file_extension = os.path.splitext(full_filename)
 
 		# The ".empty" file exists so otherwise empty folders can be added to Git.
 		if filename == ".empty":
 			continue
 
-		input_file_path  = os.path.join(input_folder_path, full_filename)
+		input_file_path  = os.path.join(input_subfolder_path, full_filename)
 		output_file_path = os.path.join(output_subfolder, full_filename)
 
 		if file_extension in (".ini", ".lua"):
-			create_converted_file(input_file_path, output_file_path)
+			create_converted_file(input_file_path, output_file_path, input_folder_path)
 		else:
 			shutil.copyfile(input_file_path, output_file_path)
 
 
-def create_converted_file(input_file_path, output_file_path):
+def create_converted_file(input_file_path, output_file_path, input_folder_path):
 	try:
 		with open(input_file_path, "r") as file_in:
 			with open(output_file_path, "w") as file_out:
-				all_lines = regex_replace(file_in.read())
-				for old_str, new_str in conversion_rules.items():
-					all_lines = all_lines.replace(old_str, new_str)
-				all_lines = regex_replace_bmps_and_wavs(all_lines)
-				file_out.write(all_lines)
+				all_lines_list = []
+				file_path = os.path.relpath(input_file_path, input_folder_path)
+
+				line_number = 0
+				for line in file_in:
+					line_number += 1
+					
+					line = regex_replace(line)
+					for old_str, new_str in conversion_rules.items():
+						line = line.replace(old_str, new_str)
+					all_lines_list.append(line)
+
+					if warnings_available:
+						for old_str, new_str in warning_rules.items():
+							if old_str in line:
+								warnings.append("'{}' line {}: {} -> {}".format(file_path, line_number, old_str, new_str))
+				
+				all_lines_str = "".join(all_lines_list)
+				file_out.write(regex_replace_bmps_and_wavs(all_lines_str))
 	except:
 		shutil.copyfile(input_file_path, output_file_path)
 
 
-def regex_replace(all_lines):
-	all_lines = simple_replace(all_lines, "Framerate = (.*)", "SpriteAnimMode = 7")
-	all_lines = simple_replace(all_lines, "\tPlayerCount = (.*)\n", "")
-	all_lines = simple_replace(all_lines, "\tTeamCount = (.*)\n", "")
+def regex_replace(line):
+	line = simple_replace(line, "Framerate = (.*)", "SpriteAnimMode = 7")
+	line = simple_replace(line, "\tPlayerCount = (.*)\n", "")
+	line = simple_replace(line, "\tTeamCount = (.*)\n", "")
 
-	all_lines = specific_replace(all_lines, regex_replace_particle, False, "ParticleNumberToAdd = (.*)\n\tAddParticles = (.*)\n\t\tCopyOf = (.*)\n", "AddGib = Gib\n\t\tGibParticle = {}\n\t\t\tCopyOf = {}\n\t\tCount = {}\n")
-	all_lines = specific_replace(all_lines, regex_replace_sound_priority, True, " Sound(((?! Sound).)*)Priority", " Sound{}// Priority")
-	all_lines = specific_replace(all_lines, regex_use_capture, False, "FundsOfTeam(.*) =", "Team{}Funds =")
-	# all_lines = specific_replace(all_lines, regex_replace_playsound, False, "", "")
+	line = specific_replace(line, regex_replace_particle, False, "ParticleNumberToAdd = (.*)\n\tAddParticles = (.*)\n\t\tCopyOf = (.*)\n", "AddGib = Gib\n\t\tGibParticle = {}\n\t\t\tCopyOf = {}\n\t\tCount = {}\n")
+	line = specific_replace(line, regex_replace_sound_priority, True, " Sound(((?! Sound).)*)Priority", " Sound{}// Priority")
+	line = specific_replace(line, regex_use_capture, False, "FundsOfTeam(.*) =", "Team{}Funds =")
+	# line = specific_replace(line, regex_replace_playsound, False, "", "")
 
-	return all_lines
+	return line
 
 
-def simple_replace(all_lines, pattern, replacement):
-	matches = re.findall(pattern, all_lines)
+def simple_replace(line, pattern, replacement):
+	matches = re.findall(pattern, line)
 	if len(matches) > 0:
-		return re.sub(pattern, replacement, all_lines)
-	return all_lines
+		return re.sub(pattern, replacement, line)
+	return line
 
 
-def specific_replace(all_lines, fn, dotall, pattern, replacement):
-	# TODO: Refactor so .findall can take dotall as an argument directly.
+def specific_replace(line, fn, dotall, pattern, replacement):
+	# TODO: Refactor so .findall takes re.DOTALL as an argument directly.
 	if dotall:
-		matches = re.findall(pattern, all_lines, re.DOTALL)
+		matches = re.findall(pattern, line, re.DOTALL)
 	else:
-		matches = re.findall(pattern, all_lines)
+		matches = re.findall(pattern, line)
 	if len(matches) > 0:
-		return fn(all_lines, pattern, replacement, matches)
-	return all_lines
+		return fn(line, pattern, replacement, matches)
+	return line
 
 
-def regex_replace_particle(all_lines, pattern, replacement, matches):
+def regex_replace_particle(line, pattern, replacement, matches):
 	# matches == [(4, "foo", "bar"), (2, "baz", "bee")]
 	new = [item for tup in matches for item in tup]
 	# new == [4, "foo", "bar", 2, "baz", "bee"]
@@ -201,46 +225,46 @@ def regex_replace_particle(all_lines, pattern, replacement, matches):
 	new[1::3], new[2::3], new[0::3]
 
 	# new == ["foo", "bar", 4, "baz", "bee", 2]
-	return re.sub(pattern, replacement, all_lines).format(*new)
+	return re.sub(pattern, replacement, line).format(*new)
 
 
-def regex_replace_sound_priority(all_lines, pattern, replacement, matches):
+def regex_replace_sound_priority(line, pattern, replacement, matches):
 	# TODO: This pattern returns two items in each tuple, while we only need the first. Create a better pattern.
 	# https://stackoverflow.com/a/406408/13279557
 	# https://regex101.com/r/NdKaWs/2
 
 	# matches == [(4, "foo"), (2, "bar")]
 	new = [item for tup in matches for item in tup][::2]
 	# new == [4, 2]
-	return re.sub(pattern, replacement, all_lines, flags=re.DOTALL).format(*new)
+	return re.sub(pattern, replacement, line, flags=re.DOTALL).format(*new)
 
 
-def regex_use_capture(all_lines, pattern, replacement, matches):
-	return re.sub(pattern, replacement, all_lines).format(*matches)
+def regex_use_capture(line, pattern, replacement, matches):
+	return re.sub(pattern, replacement, line).format(*matches)
 
 
-# def regex_replace_playsound(all_lines, pattern, replacement, matches):
-# 	return all_lines
+# def regex_replace_playsound(line, pattern, replacement, matches):
+# 	return line
 # 	# TODO:
 # 	# AudioMan:PlaySound("ModName.rte/Folder/SoundName.wav", SceneMan:TargetDistanceScalar(self.Pos), false, true, -1)
 # 	# to
 #	# AudioMan:PlaySound("ModName.rte/Folder/SoundName.wav", self.Pos)	-- Cut everything and leave the thing inside the brackets after SceneMan:TargetDistanceScalar
 
 
-def regex_replace_bmps_and_wavs(all_lines):
-	all_lines = specific_replace(all_lines, regex_use_capture, False, "Base\.rte(.*?)\.bmp", "Base.rte{}.png")
-	all_lines = specific_replace(all_lines, regex_use_capture, False, "base\.rte(.*?)\.bmp", "Base.rte{}.png")
-	all_lines = specific_replace(all_lines, regex_use_capture, False, "Base\.rte(.*?)\.wav", "Base.rte{}.flac")
-	all_lines = specific_replace(all_lines, regex_use_capture, False, "base\.rte(.*?)\.wav", "Base.rte{}.flac")
-	return all_lines
+def regex_replace_bmps_and_wavs(line):
+	line = specific_replace(line, regex_use_capture, False, "Base\.rte(.*?)\.bmp", "Base.rte{}.png")
+	line = specific_replace(line, regex_use_capture, False, "base\.rte(.*?)\.bmp", "Base.rte{}.png")
+	line = specific_replace(line, regex_use_capture, False, "Base\.rte(.*?)\.wav", "Base.rte{}.flac")
+	line = specific_replace(line, regex_use_capture, False, "base\.rte(.*?)\.wav", "Base.rte{}.flac")
+	return line
 
 
-def create_zips(input_folder, output_folder):
-	if input_folder.endswith(".rte"):
-		create_single_zip(Path(input_folder).name, output_folder)
+def create_zips(input_folder_path, output_folder):
+	if input_folder_path.endswith(".rte"):
+		create_single_zip(Path(input_folder_path).name, output_folder)
 	else:
 		# TODO: Move check if it's a directory out of this loop. 
-		folder_names = [f for f in os.listdir(cfg.sg.user_settings_get_entry("input_folder")) if os.path.isdir(os.path.join(output_folder, f))]
+		folder_names = [f for f in os.listdir(input_folder_path) if os.path.isdir(os.path.join(output_folder, f))]
 		for mod_name in folder_names:
 			create_single_zip(mod_name, output_folder)
 
@@ -253,5 +277,12 @@ def create_single_zip(mod_name, output_folder):
 	update_progress()
 
 
+def warnings_popup():
+	if warnings_available:
+		w = max(30, len(max(warnings, key=len)))
+		h = min(50, len(warnings)) + 1 # + 1 necessary because popup_scrolled adds an extra line
+		cfg.sg.popup_scrolled("\n".join(warnings), title="Lines needing manual replacing", size=(w, h), button_color=cfg.sg.theme_button_color(), background_color=cfg.sg.theme_background_color())
+
+
 def pluralize(word, count):
 	return word + "s" if count != 1 else word

Python/gui.py

@@ -23,6 +23,7 @@ def init_window_theme():
 	sg.theme("DarkGrey14")
 	sg.theme_input_background_color(path_set_color)
 	sg.theme_progress_bar_color((progress_bar_color, sg.theme_progress_bar_color()[1]))
+	sg.theme_button_color((sg.theme_text_color(), "#2a3948"))
 
 
 def init_window():
@@ -54,6 +55,7 @@ def init_window():
 
 	play_finish_sound_setting = sg.user_settings_get_entry("play_finish_sound")
 	sg.user_settings_set_entry("play_finish_sound", True if play_finish_sound_setting == None else play_finish_sound_setting)
+	# print(sg.DEFAULT_FONT)
 
 	options_column = [
 		[sg.Frame(layout=[
@@ -84,9 +86,9 @@ def init_window():
 	]
 
 	cfg.sg = sg
-	convert.load_conversion_rules()
+	convert.load_conversion_and_warning_rules()
 
-	window = sg.Window("Legacy Mod Converter - v1.0", layout, icon=resource_path("Media/cclmc-icon.ico"), button_color=(sg.theme_text_color(), "#2a3948"))
+	window = sg.Window("Legacy Mod Converter - v1.0", layout, icon=resource_path("Media/cclmc-icon.ico"))
 	cfg.progress_bar = window["-PROGRESS BAR-"]
 
 	return window
@@ -109,9 +111,9 @@ def run_window(window):
 				window[event](background_color = sg.theme_input_background_color())
 
 		elif event == "-OUTPUT ZIPS-":
-			sg.user_settings_set_entry("output_zips", values["-OUTPUT ZIPS-"])
+			sg.user_settings_set_entry("output_zips", values[event])
 		elif event == "-PLAY FINISH SOUND-":
-			sg.user_settings_set_entry("play_finish_sound", values["-PLAY FINISH SOUND-"])
+			sg.user_settings_set_entry("play_finish_sound", values[event])
 
 		elif event == "-CONVERT-":
 			if sg.user_settings_get_entry("input_folder") not in (None, ""):