macOS filesystems can be case insensitive, editor should also warn like Windows on case mismatch

[thorlucas]

I found an irritating bug that took a long time to track down. I was able to make a minimal reproducible project. The project would work when launching in Godot but crash immediately when launching on the exported Mac app.

Suppose we have a script like this:

# res://base/Bar.gd

extends Node

and another file

# res://Foo.gd

extends 'res://Base/Bar.gd'

Notice the capitalization mistake? Neither did I. Godot, I guess, will ignore capitalization in directories. The project runs just fine. It throws no errors. But when exporting to Mac, it will not launch. Caused me a lot of frustration.

Suggestions for a fix: make Godot case-sensitive with directories. Or at least throw a warning when capitalization does not match.

Edit: these tests were done on macOS.

[akien-mga]

It's not Godot ignoring case, it's Windows (which is why our issue template asks you for your OS... please don't make us guess it).

Or at least throw a warning when capitalization does not match.

It should already do that normally.

[thorlucas]

My bad @akien-mga. I’m on macOS. Which is why it’s so bizarre that this works when running within Godot but crashes the exported app.

I got no sort of warning in the Godot debugger about capitalization. It works flawlessly.

[akien-mga]

Yeah the warning was only implemented for Windows, as macOS is supposed to be case sensitive. Is your macOS partition configured to be case insensitive?

[thorlucas]

@akien-mga So bizarre! Been using macOS for many years and have never noticed that the default configuration for APFS is case-insensitive. What I don't understand is why this would then not work on the exported app.

Considering that this is the case, I think the warning should also be implemented on macOS to avoid this sort of confusion.

Thanks!

[thorlucas]

"APFS [...] is available in case-sensitive and case-insensitive variants on macOS, with case-insensitive being the default." According to Apple's developer website

[akien-mga]

Indeed, something similar to this should be implemented in drivers/unix/file_access_unix.cpp (but only for #ifdef OSX_ENABLED):

godot/drivers/windows/file_access_windows.cpp

Lines 90 to 110 in b902a2f

	#ifdef TOOLS_ENABLED
	// Windows is case insensitive, but all other platforms are sensitive to it
	// To ease cross-platform development, we issue a warning if users try to access
	// a file using the wrong case (which *works* on Windows, but won't on other
	// platforms).
	if (p_mode_flags == READ) {
	WIN32_FIND_DATAW d = { 0 };
	HANDLE f = FindFirstFileW(path.c_str(), &d);
	if (f) {
	String fname = d.cFileName;
	if (fname != String()) {
	String base_file = path.get_file();
	if (base_file != fname && base_file.findn(fname) == 0) {
	WARN_PRINTS("Case mismatch opening requested file '" + base_file + "', stored as '" + fname + "' in the filesystem. This file will not open when exported to other case-sensitive platforms.");
	}
	}
	FindClose(f);
	}
	}
	#endif

[Kanabenki]

I implemented the warning, but I don't have a mac right now to check if it works properly. I will test on one this afternoon and make a PR if it works as intended.