Merge pull request #7105 from Jjagg/exit-cancel

Support canceling game exit

MonoGame.Framework/ExitingEventArgs.cs

@@ -0,0 +1,15 @@
+using System;
+
+namespace Microsoft.Xna.Framework
+{
+ /// <summary>
+ /// Event arguments for <see cref="Game.Exiting"/>.
+ /// </summary>
+ public class ExitingEventArgs : EventArgs
+ {
+ /// <summary>
+ /// Set to <c>true</c> to cancel closing the game.
+ /// </summary>
+ public bool Cancel { get; set; }
+ }
+}

MonoGame.Framework/Game.cs

@@ -86,7 +86,7 @@ public Game()
  PlatformConstruct();
 
  }
-
+
  /// <summary/>
  ~Game()
  {
@@ -101,15 +101,15 @@ internal void Log(string Message)
 
  #region IDisposable Implementation
 
- private bool _isDisposed;
+ private bool _isDisposed;
  /// <inheritdoc cref="IDisposable.Dispose()"/>
  public void Dispose()
  {
  Dispose(true);
  GC.SuppressFinalize(this);
  EventHelpers.Raise(this, Disposed, EventArgs.Empty);
  }
-
+
  /// <summary/>
  protected virtual void Dispose(bool disposing)
  {
@@ -195,9 +195,9 @@ public GameComponentCollection Components
  {
  get { return _components; }
  }
-
- /// <summary>
- /// Gets or sets time to sleep between frames when the game is not active
+
+ /// <summary>
+ /// Gets or sets time to sleep between frames when the game is not active
  /// </summary>
  public TimeSpan InactiveSleepTime
  {
@@ -380,7 +380,7 @@ internal bool Initialized
  /// <summary>
  /// Raised when this game is exiting.
  /// </summary>
- public event EventHandler<EventArgs> Exiting;
+ public event EventHandler<ExitingEventArgs> Exiting;
 
 #if WINDOWS_UAP
  [CLSCompliant(false)]
@@ -408,11 +408,11 @@ public void Exit()
  /// </summary>
  public void ResetElapsedTime()
  {
- Platform.ResetElapsedTime();
- if (_gameTimer != null)
- {
- _gameTimer.Reset();
- _gameTimer.Start();
+ Platform.ResetElapsedTime();
+ if (_gameTimer != null)
+ {
+ _gameTimer.Reset();
+ _gameTimer.Start();
  }
 
  _accumulatedElapsedTime = TimeSpan.Zero;
@@ -495,8 +495,6 @@ public void Run(GameRunBehavior runBehavior)
  DoUpdate(new GameTime());
 
  Platform.RunLoop();
- EndRun();
- DoExiting();
  break;
  default:
  throw new ArgumentException(string.Format(
@@ -540,11 +538,11 @@ public void Tick()
 #endif
  }
 
- // Advance the accumulated elapsed time.
- if (_gameTimer == null)
- {
- _gameTimer = new Stopwatch();
- _gameTimer.Start();
+ // Advance the accumulated elapsed time.
+ if (_gameTimer == null)
+ {
+ _gameTimer = new Stopwatch();
+ _gameTimer.Start();
  }
  var currentTicks = _gameTimer.Elapsed.Ticks;
  _accumulatedElapsedTime += TimeSpan.FromTicks(currentTicks - _previousTicks);
@@ -631,8 +629,18 @@ public void Tick()
 
  if (_shouldExit)
  {
- Platform.Exit();
- _shouldExit = false; //prevents perpetual exiting on platforms supporting resume.
+ var exitingEventArgs = new ExitingEventArgs();
+
+ OnExiting(this, exitingEventArgs);
+
+ if (!exitingEventArgs.Cancel)
+ {
+ Platform.Exit();
+ EndRun();
+ UnloadContent();
+ }
+
+ _shouldExit = false;
  }
  }
 
@@ -743,7 +751,7 @@ protected virtual void Update(GameTime gameTime)
  /// </summary>
  /// <param name="sender">This <see cref="Game"/>.</param>
  /// <param name="args">The arguments to the <see cref="Exiting"/> event.</param>
- protected virtual void OnExiting(object sender, EventArgs args)
+ protected virtual void OnExiting(object sender, ExitingEventArgs args)
  {
  EventHelpers.Raise(sender, Exiting, args);
  }
@@ -795,8 +803,6 @@ private void Platform_AsyncRunLoopEnded(object sender, EventArgs e)
 
  var platform = (GamePlatform)sender;
  platform.AsyncRunLoopEnded -= Platform_AsyncRunLoopEnded;
- EndRun();
- DoExiting();
  }
 
  #endregion Event Handlers
@@ -871,12 +877,6 @@ internal void DoInitialize()
  _components.ComponentRemoved += Components_ComponentRemoved;
  }
 
- internal void DoExiting()
- {
- OnExiting(this, EventArgs.Empty);
- UnloadContent();
- }
-
  #endregion Internal Methods
 
  internal GraphicsDeviceManager graphicsDeviceManager

MonoGame.Framework/Platform/SDL/SDLGamePlatform.cs

@@ -123,7 +123,7 @@ private void SdlRunLoop()
  switch (ev.Type)
  {
  case Sdl.EventType.Quit:
- _isExiting++;
+ Game.Exit();
  break;
  case Sdl.EventType.JoyDeviceAdded:
  Joystick.AddDevices();
@@ -241,7 +241,7 @@ private void SdlRunLoop()
  _view.Moved();
  break;
  case Sdl.Window.EventId.Close:
- _isExiting++;
+ Game.Exit();
  break;
  }
  break;

MonoGame.Framework/Platform/Windows/WinFormsGameWindow.cs

@@ -162,6 +162,7 @@ internal WinFormsGameWindow(WinFormsGamePlatform platform)
  _resizeTickTimer = new System.Timers.Timer(1) { SynchronizingObject = Form, AutoReset = false };
  _resizeTickTimer.Elapsed += OnResizeTick;
 
+ Form.FormClosing += OnFormClosing;
  Form.Activated += OnActivated;
  Form.Deactivate += OnDeactivate;
  Form.Resize += OnResize;
@@ -237,6 +238,12 @@ private void UnregisterFromAllWindows()
  }
  }
 
+ private void OnFormClosing(object sender, FormClosingEventArgs e)
+ {
+ e.Cancel = true;
+ _platform.Game.Exit();
+ }
+
  private void OnActivated(object sender, EventArgs eventArgs)
  {
  _platform.IsActive = true;

Tests/Framework/GameTest.cs

@@ -279,7 +279,7 @@ private class CountCallsGame : Game
 
  protected override void OnActivated(object sender, EventArgs args) { ActivatedCount++; base.OnActivated(sender, args); }
  protected override void OnDeactivated(object sender, EventArgs args) { DeactivatedCount++; base.OnDeactivated(sender, args); }
- protected override void OnExiting(object sender, EventArgs args) { ExitingCount++; base.OnExiting(sender, args); }
+ protected override void OnExiting(object sender, ExitingEventArgs args) { ExitingCount++; base.OnExiting(sender, args); }
  protected override void Dispose(bool disposing) { DisposeCount++; base.Dispose(disposing); }
  }