Commit: 39d47c8ed1fbe042072a3ba1e37d8681a4d4c4fd - mingw-get (git)

The MinGW.org Installation Manager Tool

Commit MetaInfo

• Revision: 39d47c8ed1fbe042072a3ba1e37d8681a4d4c4fd (tree)
• Time: 2013-07-30 18:22:31
• Author: Keith Marshall <keithmarshall@user...>
• Commiter: Keith Marshall

Log Message

Avoid discarding pending changes when catalogue is updated.

Change Summary

• modified: ChangeLog
• modified: src/guiexec.cpp
• modified: src/guimain.h
• modified: src/guimain.rc
• modified: src/pkgdata.cpp

Incremental Difference

--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,23 @@
[phone]  Keith Marshall  <[e-mail]>
+
+	Avoid discarding pending changes when catalogue is updated.
+
+	* src/guimain.h (IDD_CONFIRMATION): New manifest constant; define it.
+	(AppWindowMaker::ConfirmActionDialogue): New static method; declare it.
+	(AppWindowMaker::ConfirmActionRequest): New method; declare it.
+
+	* src/guimain.rc (IDD_CONFIRMATION): Implement new dialogue template.
+
+	* src/guiexec.cpp (pkgConfirmAction, pkgConfirmActionClient): New
+	static variables; they are used as pseudo-arguments, together with...
+	(DIALOGUE_DISPATCH, DIALOGUE_RESPONSE, DIALOGUE_CHKSTATE): ...these
+	new macros; define them; they facilitate the implementation of...
+	(AppWindowMaker::ConfirmActionDialogue): ...this; implement it.
+	(AppWindowMaker::ConfirmActionRequest): Implement it; use it...
+	(AppWindowMaker::OnCommand) [IDM_REPO_UPDATE]: ...here, and...
+
+	* src/pkgdata.cpp (AppWindowMaker::OnClose): ...here.
+
 2013-07-26  Keith Marshall  <[e-mail]>
 
 	Make a minor GUI layout adjustment.

--- a/src/guiexec.cpp
+++ b/src/guiexec.cpp
@@ -34,6 +34,7 @@
 
 #include <unistd.h>
 #include <wtkexcept.h>
+#include <wtkalign.h>
 
 /* The DMH sub-system provides the following function, but it does not
  * declare the prototype; (this is to obviate any automatic requirement
@@ -567,6 +568,145 @@ int AppWindowMaker::Invoked( void )
   return WTK::MainWindowMaker::Invoked();
 }
 
+/* The following static entities are provided to facilitate the
+ * implementation of the "discard changes" confirmation dialogue.
+ */
+static const char *pkgConfirmAction = NULL;
+static AppWindowMaker *pkgConfirmActionClient = NULL;
+
+static void dlgReplaceText( HWND dlg, ... )
+{
+  /* Local helper routine, used by AppWindowMaker::ConfirmActionDialogue(),
+   * to substitute the designated action description into the format strings,
+   * as specified within the dialogue box template.
+   *
+   * First step is to copy the format specification from the dialogue item.
+   */
+  int len = 1 + SendMessage( dlg, WM_GETTEXTLENGTH, 0, 0 );
+  char fmt[len]; SendMessage( dlg, WM_GETTEXT, len, (LPARAM)(fmt) );
+
+  /* Having established the format, we allocate a sufficient buffer, in
+   * which we prepare the formatted text...
+   */
+  va_list argv; va_start( argv, dlg );
+  char text[1 + vsnprintf( NULL, 0, fmt, argv )];
+  vsnprintf( text, sizeof( text ), fmt, argv );
+  va_end( argv );
+
+  /* ...which we then copy back to the active dialogue item.
+   */
+  SendMessage( dlg, WM_SETTEXT, 0, (LPARAM)(text) );
+}
+
+int CALLBACK AppWindowMaker::ConfirmActionDialogue
+( HWND dlg, unsigned int msg, WPARAM wparam, LPARAM lparam )
+#define DIALOGUE_CHKSTATE pkgConfirmActionClient->EnumerateActions
+#define DIALOGUE_DISPATCH pkgConfirmActionClient->DispatchDialogueThread
+#define DIALOGUE_RESPONSE pkgConfirmActionClient->DialogueResponse
+{
+  /* Call back handler for the messages generated by the "discard changes"
+   * confirmation dialogue.
+   */
+  switch( msg )
+  { case WM_INITDIALOG:
+      /* When the confirmation dialogue is invoked, we centre it within
+       * its owner window, and replace the format specification strings
+       * from its text controls with their formatted equivalents.
+       */
+      WTK::AlignWindow( dlg, WTK_ALIGN_CENTRED );
+      dlgReplaceText( GetDlgItem( dlg, IDD_PROGRESS_MSG ), pkgConfirmAction );
+      dlgReplaceText( GetDlgItem( dlg, IDD_PROGRESS_TXT ), pkgConfirmAction,
+	  pkgConfirmAction
+	);
+      return TRUE;
+
+    case WM_COMMAND:
+      /* Process the messages from the dialogue's three command buttons:
+       */
+      switch( msg = LOWORD( wparam ) )
+      {
+	case IDIGNORE:
+	  /* Sent when the user selects the "Discard Changes" option,
+	   * we return "IDOK" to confirm that the action should be
+	   * progressed, ignoring any uncommitted changes.
+	   */
+	  EndDialog( dlg, IDOK );
+	  return TRUE;
+
+	case IDOK:
+	  /* Sent when the user selects the "Review Changes" option; we
+	   * shelve the active dialogue, and delegate the decision as to
+	   * whether to proceed to the "Apply Changes" dialogue.
+	   */
+	  ShowWindow( dlg, SW_HIDE );
+	  switch( DIALOGUE_RESPONSE( IDD_APPLY_APPROVE, pkgApplyApproved ) )
+	  {
+	    case ID_DEFER:
+	      /* Handle a "Defer" request from the "Apply Changes"
+	       * dialogue as equivalent to our own "Cancel Request"
+	       * option.
+	       */
+	      msg = IDCANCEL;
+	      break;
+
+	    case ID_APPLY:
+	      /* When "Apply" confirmation is forthcoming, we proceed to
+	       * download any required packages, and invoke the scheduled
+	       * remove, upgrade, or install actions.
+	       */
+	      DIALOGUE_DISPATCH( IDD_APPLY_DOWNLOAD, pkgInvokeDownload );
+	      DIALOGUE_DISPATCH( IDD_APPLY_EXECUTE, pkgApplyChanges );
+
+	      /* Ensure that all "Apply" actions completed successfully...
+	       */
+	      if( DIALOGUE_CHKSTATE( ACTION_UNSUCCESSFUL ) > 0 )
+		/*
+		 * ...otherwise, cancel the ensuing action, so that the
+		 * user may have an opportunity to remedy the problem.
+		 */
+		msg = IDCANCEL;
+	  }
+	  /* Regardless of the outcome from the "Review Changes" activity,
+	   * simply fall through to terminate the dialogue appropriately.
+	   */
+	case IDCANCEL:
+	  /* Sent when the user selects the "Cancel Request" option; we
+	   * simply allow the message ID to propagate back to the caller,
+	   * as the response code.
+	   */
+	  EndDialog( dlg, msg );
+	  return TRUE;
+      }
+  }
+  /* We don't handle any other message; if any is received, mark it as
+   * "unhandled", and pass it on to the default dialogue handler.
+   */
+  return FALSE;
+}
+
+bool AppWindowMaker::ConfirmActionRequest( const char *desc )
+{
+  /* Helper to confirm user's intent to proceed, when a request
+   * to update the catalogue, or to quit, would result in pending
+   * installation actions being discarded.
+   *
+   * We begin by saving reference data to be passed to the static
+   * dialogue handler method...
+   */
+  pkgConfirmAction = desc;
+  pkgConfirmActionClient = this;
+
+  /* ...prior to checking for pending actions, and invoking the
+   * dialogue procedure when appropriate, or simply allowing the
+   * action to proceed, otherwise.
+   */
+  return (pkgData->Schedule()->EnumeratePendingActions() > 0)
+    ? DialogBox( AppInstance, MAKEINTRESOURCE( IDD_CONFIRMATION ),
+	AppWindow, ConfirmActionDialogue
+      ) == IDOK
+    : true;
+}
+
 long AppWindowMaker::OnCommand( WPARAM cmd )
 #define ACTION_PRESERVE_FAILED (ACTION_DOWNLOAD_FAILED | ACTION_APPLY_FAILED)
 {
@@ -623,8 +763,15 @@ long AppWindowMaker::OnCommand( WPARAM cmd )
        * dialogue, from which a background thread is invoked to download
        * fresh copies of the package catalogue files from the remote
        * repository, and consolidate them into the local catalogue.
+       *
+       * Note that this activity will cause any pending installation
+       * actions to be discarded; seek confirmation of user's intent
+       * to proceed, when this situation prevails.
        */
-      DispatchDialogueThread( IDD_REPO_UPDATE, pkgInvokeUpdate );
+      if( ConfirmActionRequest( "update the catalogue" ) )
+      { DispatchDialogueThread( IDD_REPO_UPDATE, pkgInvokeUpdate );
+	UpdatePackageMenuBindings();
+      }
       break;
 
     case IDM_REPO_MARK_UPGRADES:

--- a/src/guimain.h
+++ b/src/guimain.h
@@ -97,6 +97,7 @@
 #define IDD_PROGRESS_MAX		 616
 #define IDD_PROGRESS_PCT		 617
 #define IDD_PROGRESS_TXT		 618
+#define IDD_CONFIRMATION		 619
 
 #define IDD_APPLY_APPROVE		 630
 #define IDD_APPLY_DOWNLOAD		 631
@@ -218,6 +219,8 @@ class AppWindowMaker: public WTK::MainWindowMaker
     HWND PackageListView;
     void InitPackageListView( void );
     void UpdatePackageMenuBindings( void );
+    bool ConfirmActionRequest( const char * );
+    static int CALLBACK ConfirmActionDialogue( HWND, unsigned, WPARAM, LPARAM );
     void Schedule( unsigned long, const char * = NULL, const char * = NULL );
     inline void MarkSchedule( pkgActionItem * );
     void SelectPackageAction( unsigned );

--- a/src/guimain.rc
+++ b/src/guimain.rc
@@ -175,6 +175,27 @@ BEGIN
   LTEXT 				"", IDD_PROGRESS_MSG, 7, 6, 256, 12
 END
 
+IDD_CONFIRMATION DIALOG DISCARDABLE	10, 20, 270, 115
+CAPTION 				"Action Requires Confirmation"
+STYLE					DS_MODALFRAME | DS_SETFONT | WS_POPUP | WS_CAPTION | WS_DLGFRAME
+FONT					10, "Verdana"
+BEGIN
+  ICON					IDI_WARNING, IDI_WARNING, 15, 16, 0, 0
+  LTEXT 				"You have marked packages for installation, upgrade, or " \
+					"removal, but you have not yet committed these changes; " \
+					"if you %s without committing these changes, they will "  \
+					"be discarded, and you may need to reschedule them.", \
+					IDD_PROGRESS_MSG, 42, 10, 219, 35
+  LTEXT 				"You are advised to review your marked changes, before you " \
+					"%s; (you may select the ""Review Changes"" option button " \
+					"below), or alternatively, you may simply discard the changes, " \
+					"unseen, or you may cancel this request to %s.", \
+					IDD_PROGRESS_TXT, 9, 50, 260, 35
+  DEFPUSHBUTTON 			"Review Changes", IDOK, 10, 91, 76, 13, WS_GROUP | WS_TABSTOP
+  PUSHBUTTON				"Discard Changes", IDIGNORE, 97, 91, 76, 13, WS_TABSTOP
+  PUSHBUTTON				"Cancel Request", IDCANCEL, 184, 91, 76, 13, WS_TABSTOP
+END
+
 /* Template for dialogue requesting user confirmation of intent
  * to proceed with scheduled change actions.
  */

--- a/src/pkgdata.cpp
+++ b/src/pkgdata.cpp
@@ -1483,15 +1483,7 @@ long AppWindowMaker::OnClose()
    * option for the termination request, so that the user
    * has an opportunity to complete such actions.
    */
-  if( (pkgData->Schedule()->EnumeratePendingActions() > 0)
-  &&  (MessageBox( AppWindow,
-	"You have marked changes which have not been applied;\n"
-	"these will be lost, if you quit without applying them.\n\n"
-	"Are you sure you want to discard these marked changes?",
-	"Discard Marked Changes?", MB_YESNO | MB_ICONWARNING
-      ) == IDNO)
-    ) return 0;
-  return -1;
+  return ConfirmActionRequest( "quit" ) ? -1 : 0;
 }
 
 /* $RCSfile$: end of file */