[GEN][ZH] Refactor implemention for Shell recreation on Display Resolution change

[xezon]

With this change the Options Menu no longer closes when the Display Resolution is changed.

This change refactors the way the Shell recreation is implemented. It now recreates the window stack with the previous state, instead of recreating it manually by pushing the "Menus/MainMenu.wnd".

The initial motivation here was to try make the Display Resolution change also work in-game, but that will require a lot more work on top of this. So this change only makes improvements towards changing the resolution in the Main Menu as per the original restrictions.

User facing nothing changes.

TODO

• Replicate in Generals

[Polypheides]

I'll try to ask this question more clearly.

By default, pressing the ACCEPT button closes the options menu. Example video:

With this change, the ACCEPT button now keeps the options menu open. Example video:

Given this new behavior, would it make sense to rename the ACCEPT and CANCEL buttons to APPLY and CLOSE?

[xezon]

ACCEPT does not close the Options Menu.

[Caball009]

I noticed this was also in the original code, but is there a way to reset TheShell instead of delete and new?

Shell has a reset function, does that do the equivalent? It seems like it does:

Reset the shell system to a clean state just as though init had just been called and ready to re-use

[xezon]

Tested that. It works.

I think this then also means we can move most of the code of shell::recreateShell into a new function in Shell.

[xezon]

I was wrong. When I tested I did not update generalszh.exe. The Shell::reset function does not do what we need and using it breaks the menus on resolution change. I think it was meant to be used for non resolution change reset.

I did a refactor anyway and moved some of the code into the Shell class. The new function will now reconstruct the Shell from within. I also improved the conditioning for the main menu button transition, to only trigger it if the Main Menu is actually in the Screen stack and not hidden (which is always the case in the Menu, but would be relevant if we wanted to recreate the UI in-game, where the Main Menu is hidden).

[xezon]

By default, pressing the ACCEPT button closes the options menu.

Right. I was totally confused here with what I was doing. This change was bogus.

I have now thrown out all the junk that changed the Options Menu ACCEPT button behaviour. It now functions the same way as it did originally. It now is a Refactor towards making the Resolution change work in-game in a future change.

This change should be correct now.

[roossienb]

I don't understand what this PR wants to be.

• It fixes spelling errors in comments, removes tabs and add/removes blank lines in some locations, but not in others.
• It adds the const keyword to some functions but not others.
• It refactors the construction and deconstruction
• It add new functionality through recreateWindowLayouts.

[roossienb]

There are many other missing or multiple line breaks and random tabs. Why not fix those?

[xezon]

Right. I reverted all now unnecessary changes to this file.

[xezon]

• It fixes spelling errors in comments, removes tabs and add/removes blank lines in some locations, but not in others.

These were remnants of earlier changes. I reverted this now.

• It adds the const keyword to some functions but not others.

This is sort of required as part of this refactor.

void Shell::recreateWindowLayouts( void )
{
...
  const WindowLayout* layout = getScreenLayout(screenIndex);
  ScreenInfo& screenInfo = screenStackInfos[screenIndex];
  screenInfo.filename = layout->getFilename(); // this would fail to compile if the function was not const
  screenInfo.isHidden = layout->isHidden(); // this would fail to compile if the function was not const

• It refactors the construction and deconstruction

This is required as part of this refactor. These are called in constructor + destructor, and also in recreateWindowLayouts.

• It add new functionality through recreateWindowLayouts.

This is required as part of this refactor.

[xezon]

Rebased.