MacOS confirm quit, consuming meta key (RSCPlus#210)

Author: conker-rsc

src/Client/ConfigWindow.java

@@ -243,6 +243,7 @@ public class ConfigWindow {
   private JCheckBox generalPanelLogTimestampsCheckbox;
   private JCheckBox generalPanelLogForceLevelCheckbox;
   private JCheckBox generalPanelPrefersXdgOpenCheckbox;
+  private JCheckBox generalPanelMacOSConfirmQuitCheckBox;
   private JCheckBox generalPanelLogForceTimestampsCheckbox;
   private JCheckBox generalPanelDisableNatureRuneAlchCheckbox;
   private JCheckBox generalPanelCommandPatchQuestCheckbox;
@@ -1795,6 +1796,15 @@ public void stateChanged(ChangeEvent e) {
     generalPanelPrefersXdgOpenCheckbox.setToolTipText(
         "Does nothing on Windows or Mac, may improve URL opening experience on Linux");
 
+    if (Util.isMacOS()) {
+      generalPanelMacOSConfirmQuitCheckBox =
+          addCheckbox("Ask for confirmation when pressing cmd-Q on macOS", generalPanel);
+      generalPanelMacOSConfirmQuitCheckBox.setToolTipText(
+          "Prevents the application from immediately closing with cmd-Q by asking for confirmation");
+      SearchUtils.addSearchMetadata(
+          generalPanelMacOSConfirmQuitCheckBox, "command", "quit", "exit", "imac", "darwin");
+    }
+
     generalPanelAutoScreenshotCheckbox =
         addCheckbox("Take a screenshot when you level up or complete a quest", generalPanel);
     generalPanelAutoScreenshotCheckbox.setToolTipText(
@@ -6285,6 +6295,10 @@ private void executeSynchronizeGuiValues() {
     generalPanelLimitRanFPSSpinner.setValue(
         Settings.RAN_EFFECT_TARGET_FPS.get(Settings.currentProfile));
     generalPanelLimitFPSSpinner.setValue(Settings.FPS_LIMIT.get(Settings.currentProfile));
+    if (Util.isMacOS()) {
+      generalPanelMacOSConfirmQuitCheckBox.setSelected(
+          Settings.MACOS_CONFIRM_QUIT.get(Settings.currentProfile));
+    }
     generalPanelAutoScreenshotCheckbox.setSelected(
         Settings.AUTO_SCREENSHOT.get(Settings.currentProfile));
     generalPanelPerCharScreenshotCheckbox.setSelected(
@@ -6826,6 +6840,10 @@ private void saveSettings() {
         Settings.currentProfile, generalPanelShiftScrollCameraRotationCheckbox.isSelected());
     Settings.TRACKPAD_ROTATION_SENSITIVITY.put(
         Settings.currentProfile, generalPanelTrackpadRotationSlider.getValue());
+    if (Util.isMacOS()) {
+      Settings.MACOS_CONFIRM_QUIT.put(
+          Settings.currentProfile, generalPanelMacOSConfirmQuitCheckBox.isSelected());
+    }
     Settings.AUTO_SCREENSHOT.put(
         Settings.currentProfile, generalPanelAutoScreenshotCheckbox.isSelected());
     Settings.PER_CHAR_SCREENSHOTS.put(

src/Client/Settings.java

@@ -151,6 +151,7 @@ public class Settings {
   public static HashMap<String, RanOverrideEffectType> CUSTOM_RAN_CHAT_EFFECT =
       new HashMap<String, RanOverrideEffectType>();
   public static HashMap<String, Integer> RAN_EFFECT_TARGET_FPS = new HashMap<String, Integer>();
+  public static HashMap<String, Boolean> MACOS_CONFIRM_QUIT = new HashMap<String, Boolean>();
   public static HashMap<String, Boolean> AUTO_SCREENSHOT = new HashMap<String, Boolean>();
   public static HashMap<String, Boolean> PER_CHAR_SCREENSHOTS = new HashMap<String, Boolean>();
   public static HashMap<String, String> SCREENSHOTS_STORAGE_PATH = new HashMap<String, String>();
@@ -965,6 +966,8 @@ public static void definePresets(Properties props) {
     VIEW_DISTANCE.put("all", 20000);
     VIEW_DISTANCE.put("custom", getPropInt(props, "view_distance", VIEW_DISTANCE.get("default")));
 
+    defineStaticPreset(MACOS_CONFIRM_QUIT, getPropBoolean(props, "macos_confirm_quit", true));
+
     AUTO_SCREENSHOT.put("vanilla", true);
     AUTO_SCREENSHOT.put("vanilla_resizable", true);
     AUTO_SCREENSHOT.put("lite", true);
@@ -3754,6 +3757,7 @@ public static synchronized void save(String preset) {
           "custom_ran_chat_effect", Integer.toString(CUSTOM_RAN_CHAT_EFFECT.get(preset).id()));
       props.setProperty(
           "ran_effect_target_fps", Integer.toString(RAN_EFFECT_TARGET_FPS.get(preset)));
+      props.setProperty("macos_confirm_quit", Boolean.toString(MACOS_CONFIRM_QUIT.get(preset)));
       props.setProperty("auto_screenshot", Boolean.toString(AUTO_SCREENSHOT.get(preset)));
       props.setProperty("per_char_screenshots", Boolean.toString(PER_CHAR_SCREENSHOTS.get(preset)));
       props.setProperty("screenshots_storage_path", SCREENSHOTS_STORAGE_PATH.get(preset));

src/Game/KeyboardHandler.java

@@ -21,6 +21,7 @@
 import Client.KeybindSet;
 import Client.KeybindSet.KeyModifier;
 import Client.Settings;
+import Client.Util;
 import java.awt.event.KeyEvent;
 import java.awt.event.KeyListener;
 import java.util.ArrayList;
@@ -103,6 +104,11 @@ public void keyPressed(KeyEvent e) {
         }
       }
 
+      // Handle ⌘ modifier on macOS
+    } else if (e.isMetaDown() && Util.isMacOS()) {
+      // Not supported for keybinds, so always consume
+      e.consume();
+
       // Handle all other keys
     } else {
       for (KeybindSet kbs : keybindSetList) {

src/Game/MacOSHandler.java

@@ -20,13 +20,17 @@
 
 import Client.ConfigWindow;
 import Client.Launcher;
+import Client.Settings;
+import Client.Util;
 import com.apple.eawt.AboutHandler;
 import com.apple.eawt.AppEvent;
 import com.apple.eawt.Application;
 import com.apple.eawt.QuitHandler;
 import com.apple.eawt.QuitResponse;
 import java.awt.event.WindowEvent;
 import javax.swing.JFrame;
+import javax.swing.JOptionPane;
+import javax.swing.JPanel;
 
 /** macOS-specific application handling */
 public class MacOSHandler implements QuitHandler, AboutHandler {
@@ -67,6 +71,27 @@ public void handleAbout(AppEvent.AboutEvent aboutEvent) {
   @Override
   public void handleQuitRequestWith(AppEvent.QuitEvent quitEvent, QuitResponse quitResponse) {
     // Used to handle the macOS ⌘Q event, to replicate the same behavior as closing the window
+    if (Settings.MACOS_CONFIRM_QUIT.get(Settings.currentProfile)) {
+      final Object[] options = {"Yes", "No"};
+      JPanel confirmQuitPanel =
+          Util.createOptionMessagePanel("Really quit " + Launcher.binaryPrefix + "RSCPlus?");
+      int choice =
+          JOptionPane.showOptionDialog(
+              Launcher.getInstance(),
+              confirmQuitPanel, // message
+              "Confirm Quit", // title
+              JOptionPane.YES_NO_OPTION,
+              JOptionPane.QUESTION_MESSAGE,
+              null,
+              options,
+              options[1]);
+
+      if (choice == JOptionPane.CLOSED_OPTION || choice == JOptionPane.NO_OPTION) {
+        quitResponse.cancelQuit();
+        return;
+      }
+    }
+
     gameFrame.dispatchEvent(new WindowEvent(gameFrame, WindowEvent.WINDOW_CLOSING));
   }
 }