GUI: restore the Pause Menu after closing the Settings Menu

[SmallJoker]

Because it is more intuitive this way.

When closing the in-game Settings menu, the Pause menu will be shown again.
The GUIModalMenu code is responsible for handling overlaid formspec "layers". C++ GUI implementations (e.g. GUIPasswordChange) do support this well. The Lua side of the Main Menu has its own layer code, which works the same way. However, when entering the Settings menu (Lua formspec) though the Pause menu (C++), there is no way back.
This PR fixes that by allowing to overlay any kind of showPauseMenuFormSpec formspecs (until they get closed explicitly).

To do

This PR is Ready for Review.

How to test

1. Open the in-game Settings menu
2. Open the key change menu
3. Close the key change menu
4. You must see the Settings menu (already works in master because the C++ GUIKeyChangeMenu does not depend on m_formspec)
5. Close the Settings menu
6. You must see the Pause menu (new since this PR)

Also open and close some random formspecs to ensure it's not causing side-effects.

[grorp]

When I saw this PR, I was initially going to comment something along the lines of

I don't think closing the settings menu should get you back to the "main" pause menu. This would make the settings menu inconsistent with the other sub-menus implemented in C++.

Also, it would introduce an extra click/tap/keypress/swipe for users who want to go back to their game. There is rarely a need to go back to the "main" pause menu after adjusting settings (you'd have to happen to want e.g. to change your server password and your settings at exactly the same time).

However, I now found out that, as implied in the PR description...

The GUIModalMenu code is responsible for handling overlaid formspec "layers". C++ GUI implementations (e.g. GUIPasswordChange) do support this well.

... closing C++ sub-menus actually gets you back to the "main" pause menu on 5.12.0-dev. This is actually a recent regression caused by 2c50066:

The button_exit[]s were replaced by regular button[]s, to avoid a very short unpause when you click the btn_settings (probably because it uses ClientEvent stuff).

This can easily be fixed by only applying that workaround to the settings button, where it is actually necessary, and reverting it for the other buttons.

[SmallJoker]

This can easily be fixed by only applying that workaround to the settings button, where it is actually necessary, and reverting it for the other buttons

It seems this is a subjective matter because I would prefer to always return to the pause menu before explicitly closing it. This is also done similarly in other games - difference being that these layers of menus (/formspecs) are yet not visually represented in Luanti.

[grorp]

Yeah, this seems like a matter of preference. I suppose either behavior is objectively fine as long as it's consistent between all the sub-menus (C++ and Lua).
On 5.11.0 and before it was still consistent. In 5.12.0-dev it's inconsistent. This PR would make it consistent again, but with the opposite behavior.

If you want to continue with this, you should also update the buttons that are currently labeled "Exit" to say "Back" instead:

luanti/builtin/common/settings/dlg_settings.lua

Lines 530 to 532 in db15bc6

	("button[0,%f;%f,0.8;back;%s]"):format(
	tabsize.height + 0.2, back_w,
	INIT == "pause_menu" and fgettext("Exit") or fgettext("Back")),

luanti/src/gui/guiVolumeChange.cpp

Lines 79 to 80 in db15bc6

	GUIButton::addButton(Environment, rect, m_tsrc, this, ID_soundExitButton,
	wstrgettext("Exit").c_str());

[grorp]

This appears to work. Fine by me.

The code (and changes to it) around managing GUIFormspecMenu instances & references to them is messy though. To truly understand it, I'd have to spend more time looking at it than I'm currently willing to invest. You seem to have built some understanding of how it works, I would be happy if you were able to refactor it at some point.