JoeNotCharles
commented
6 months ago Investigation Notes
Each of these 5 cases takes a different path through NSSEditor.build(), starting at nss.py:186:
186: compiled_bytes: bytes | None = compileScript(...)
187: print("compiling script from nsseditor")
188: if compiled_bytes is None:
189: print("user cancelled the compilation")
190: return None, b""
191:
192: msg = "Could not convert to bytes - nsseditor.build()"
193: raise ValueError(msg)The calling function is Editor.save(), starting at editor.py:246:
246: try:
247: data, data_ext = self.build()
248: if data is None: # nsseditor
249: return
... implementation of saving ...
264: except Exception as e:
... log exception to errorlog.txt ...
269: QMessageBox(QMessageBox.Critical, "Failed to write to file", str(universal_simplify_exception(e))).exec_()I'll trace through each case:
-
This is almost right, but the stdout is wrong. It's printing 'compiling script from nsseditor' after calling
compileScript(), so it prints it even though the user chose not to compile.As expected,
compileScript()returns None, and line 190 also returns None. The callingsave()function interprets that as "nothing to do" (editor.py:248). -
The stdout shows the compile succeeded (except, again, 'compiling script from nsseditor' is printed afterwards).
However since the return value isn't None, it's ignored on line 192 and instead a bogus
ValueErroris raised. This looks like a cut-and-paste error. -
This gave an error message, so it "works", even though the error was kind of generic.
At nss.py:186,
compileScript()is (correctly) raising an exception that it can't find the temp file nwnnsscomp.exe was supposed to write.It'd be nice to display the actual error message from nwnnsscomp.exe (which I see in errorlog.txt is in the
stderrvariable in_compile_windows()), but that's just a bonus. -
This was an exception deep in the built-in compiler that I didn't look into further. (I'm not even sure if the built-in compiler is expected to work on Windows. I suspect a character set or line ending issue or something.
nss.py and editor.py are working as designed here:
compileScript()propagates the exception from the compiler, and editor.py catches it and shows the message box. -
Working perfectly. (Except that printing
compiling script from nsseditoris still in the wrong place.) This time the exception from the compiler is correct, because the script actually did have an error, and it raised a good contextual error message which nss.py and editor.py handled perfectly. Yay!
My first attempt to fix this fixed case 2, but apparently broke case 3 or 5. I'll try again.
th3w1zard1
Tested at commit ebcd2176badfc2912fbbec52251abaecff3ddb37 on Windows:
Open any .nss file (I used
Vanilla_KOTOR_Script_Source\TSL\Vanilla\Modules\001EBO_Ebon_Hawk_(prologue_interior)\a_end_001.nss) and then use "Save As" and choose an output file with the .ncs file name.It should pop up a dialog to select a compiler, and then invoke the chosen compiler to save the script as an NCS.
There are 5 cases:
For case 2 and 5, I added a call
UndefinedFunction();to the start of the script, which should fail to compile since, you know, the function's undefined.Results
Failed to write to fileand message('ValueError', ''Could not convert to bytes - nsseditor.build()').stdout says:
errorlog.txt contains:
Failed to write to fileand message(FileNotFoundError', "Could not find temp compiled script at 'C:\\Users\\JoeNotCharles\\temp\\tempscript_089466.ncs'").stdout says:
errorlog.txt contains:
Failed to write to fileand message('error, 'argument out of range').stdout says:
errorlog.txt contains:
Failed to write to fileand message('CompileError', "Function 'UndefinedFunction' has not been defined.").stdout says:
errorlog.txt contains: