Commit: f3bf16655b788f987b6ad638a5fc64ee58b5dbcf - mingw-get (git)

The MinGW.OSDN Installation Manager Tool

Commit MetaInfo

• Revision: f3bf16655b788f987b6ad638a5fc64ee58b5dbcf (tree)
• Zeit: 2012-12-19 20:03:06
• Autor: Keith Marshall <keithmarshall@user...>
• Commiter: Keith Marshall

Log Message

Improve progress reporting in "Apply Changes" dialogue.

Ändern Zusammenfassung

• modified: ChangeLog
• modified: src/guixmld.cpp
• modified: src/pkgexec.cpp
• add: src/pkgstat.h
• modified: src/pkgunst.cpp
• modified: src/sysroot.cpp
• modified: src/tarproc.cpp

Diff

--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,30 @@
[phone]  Keith Marshall  <[e-mail]>
+
+	Improve progress reporting in "Apply Changes" dialogue.
+
+	* src/pkgstat.h: New header file; it declares...
+	(pkgSpinWait): ...this new pure abstract base class; it specifies an
+	infrastructure for posting arbitrary text to dialogue controls.
+
+	* src/pkgexec.cpp (pkgSpinWait): Implement its static elements.
+	(pkgActionItem::Execute): Dispatch progress reports, handled by...
+	(pkgSpinWait::Report, pkgSpinWait::Indicator): ...these.
+
+	* src/guixmld.cpp (pkgDialogueSpinWait): New class; declare it and
+	implement locally.  It is derived from, and provides a listener for...
+	(pkgSpinWait): ...this abstract class.
+	(pkgApplyChanges): Use it.
+
+	* src/tarproc.cpp (pkgTarArchiveInstaller::ProcessDataStream): Call...
+	(pkgSpinWait::Report): ...this, to report extracted files.
+
+	* src/pkgunst.cpp (pkg_unst): Call...
+	(pkgSpinWait::Report): ...this, to report deleted files.
+
+	* src/sysroot.cpp (pkgXmlDocument::UpdateSystemMap): Call...
+	(pkgSpinWait::Report, pkgSpinWait::Indicator): ...these, to confirm
+	continuing database update activity.
+
 2012-12-18  Keith Marshall  <[e-mail]>
 
 	Update tab display on right-click in package list view.

--- a/src/guixmld.cpp
+++ b/src/guixmld.cpp
@@ -29,6 +29,7 @@
 #include "pkginet.h"
 #include "pkgkeys.h"
 #include "pkglist.h"
+#include "pkgstat.h"
 #include "pkgtask.h"
 
 #include <unistd.h>
@@ -304,13 +305,43 @@ inline void AppWindowMaker::ExecuteScheduledActions( void )
   pkgData->UpdateSystemMap();
 }
 
+class pkgDialogueSpinWait: public pkgSpinWait
+{
+  /* Derivative class for redirection of pkgSpinWait::Report()
+   * messages to a specified dialogue box text control.
+   */
+  public:
+    pkgDialogueSpinWait( HWND msg ): dlg( msg ){}
+
+  private:
+    virtual int DispatchReport( const char *, va_list );
+    HWND dlg;
+};
+
+int pkgDialogueSpinWait::DispatchReport( const char *fmt, va_list argv )
+{
+  /* Method to handle pkgSpinWait::Report() message redirection.
+   */
+  char buf[ 1 + vsnprintf( NULL, 0, fmt, argv ) ];
+  int count = vsnprintf( buf, sizeof( buf ), fmt, argv );
+  SendMessage( dlg, WM_SETTEXT, 0, (LPARAM)(buf) );
+  return count;
+}
+
 static void pkgApplyChanges( void *window )
 {
   /* Worker thread processing function, run while displaying the
    * IDD_APPLY_EXECUTE dialogue box, to apply scheduled changes.
    */
+  HWND msg = GetDlgItem( (HWND)(window), IDD_PROGRESS_MSG );
+  AppWindowMaker *app = GetAppWindow( GetParent( (HWND)(window) ) );
+
+  /* Set up progess reporting and diagnostic message display
+   * channels, and execute the scheduled actions.
+   */
+  pkgDialogueSpinWait stat( msg );
   dmh_setpty( GetDlgItem( (HWND)(window), IDD_DMH_CONSOLE ) );
-  GetAppWindow( GetParent( (HWND)(window) ))->ExecuteScheduledActions();
+  app->ExecuteScheduledActions();
   dmh_setpty( NULL );
 
   /* During processing, the user may have selected the option for
@@ -334,10 +365,9 @@ static void pkgApplyChanges( void *window )
 
     /* ...and notify the user that it must be clicked to continue.
      */
-    if( (dlg = GetDlgItem( (HWND)(window), IDD_PROGRESS_MSG )) != NULL )
-      SendMessage( dlg, WM_SETTEXT, 0,
-	  (LPARAM)("All changes have been successfully applied; you may close this dialogue.")
-	);
+    stat.Report( "All changes have been successfully applied;"
+	" you may now close this dialogue."
+      );
   }
 }
 

--- a/src/pkgexec.cpp
+++ b/src/pkgexec.cpp
@@ -4,7 +4,7 @@
  * $Id$
  *
  * Written by Keith Marshall <[e-mail]>
- * Copyright (C) 2009, 2010, 2011, 2012, MinGW Project
+ * Copyright (C) 2009, 2010, 2011, 2012, MinGW.org Project
  *
  *
  * Implementation of package management task scheduler and executive.
@@ -31,9 +31,45 @@
 #include "pkgkeys.h"
 #include "pkginfo.h"
 #include "pkgtask.h"
+#include "pkgstat.h"
 #include "pkgopts.h"
 #include "pkgproc.h"
 
+/* The following static member of the pkgSpinWait class provides
+ * the access hook through which the static core implementation of
+ * the base class methods may pass reports back to any derivative
+ * class object, while retaining the capability to issue reports
+ * even when no such object exists.
+ */
+pkgSpinWait *pkgSpinWait::referrer = NULL;
+
+int pkgSpinWait::Report( const char *fmt, ... )
+{
+  /* Also declared as static, this directs printf() style reports
+   * to any existing derivative class object, while behaving as a
+   * no-op in the absence of any such object.
+   */
+  int count = 0;
+  if( referrer != NULL )
+  {
+    va_list argv;
+    va_start( argv, fmt );
+    count = referrer->DispatchReport( fmt, argv );
+    va_end( argv );
+  }
+  return count;
+}
+
+int pkgSpinWait::Indicator( void )
+{
+  /* Once again, declared as static, this method provides a
+   * mechanism for spin-wait animation of any "%c" formatted
+   * field within a progress reporting message.
+   */
+  static const char *marker = "|/-\\";
+  return marker[ referrer->UpdateIndex() ];
+}
+
 EXTERN_C const char *action_name( unsigned long index )
 {
   /* Define the keywords used on the mingw-get command line,
@@ -432,8 +468,7 @@ int reinstall_action_scheduled( pkgActionItem *package )
 void pkgActionItem::Execute( bool with_download )
 {
   if( this != NULL )
-  {
-    pkgActionItem *current = this;
+  { pkgActionItem *current = this;
     bool init_rites_pending = true;
     while( current->prev != NULL ) current = current->prev;
 
@@ -570,6 +605,7 @@ void pkgActionItem::Execute( bool with_download )
 	}
 	/* Proceed to the next package, if any, with scheduled actions.
 	 */
+	pkgSpinWait::Report( "Processing... (%c)", pkgSpinWait::Indicator() );
 	current = current->next;
       }
     }

--- /dev/null
+++ b/src/pkgstat.h
@@ -0,0 +1,55 @@
+#ifndef PKGSTAT_H
+/*
+ * pkgstat.h
+ *
+ * $Id$
+ *
+ * Written by Keith Marshall <[e-mail]>
+ * Copyright (C) 2012, MinGW.org Project
+ *
+ *
+ * Public declaration of the pkgSpinWait class, which provides an
+ * infrastructure for reporting status of long-running activities.
+ *
+ *
+ * This is free software.  Permission is granted to copy, modify and
+ * redistribute this software, under the provisions of the GNU General
+ * Public License, Version 3, (or, at your option, any later version),
+ * as published by the Free Software Foundation; see the file COPYING
+ * for licensing details.
+ *
+ * Note, in particular, that this software is provided "as is", in the
+ * hope that it may prove useful, but WITHOUT WARRANTY OF ANY KIND; not
+ * even an implied WARRANTY OF MERCHANTABILITY, nor of FITNESS FOR ANY
+ * PARTICULAR PURPOSE.  Under no circumstances will the author, or the
+ * MinGW Project, accept liability for any damages, however caused,
+ * arising from the use of this software.
+ *
+ */
+#define PKGSTAT_H  1
+
+# include <stdarg.h>
+
+class pkgSpinWait
+{
+  /* An abstract base class, providing a facility for passing
+   * progress messages from mingw-get worker thread processing
+   * functions, to the GUI's dialogue boxes; the dialogue box
+   * initialisation function must create a derivative of this
+   * object class, providing the DispatchReport() method, to
+   * update message text within the dialogue box, using a
+   * vprintf() style of message formatting.
+   */
+  public:
+    static int Report( const char *, ... );
+    static int Indicator( void );
+
+  protected:
+    static pkgSpinWait *referrer; int index;
+    pkgSpinWait( void ): index( 0 ){ referrer = this; }
+    int UpdateIndex(){ return this ? index = (1 + index) % 4 : 0; }
+    virtual int DispatchReport( const char *, va_list ) = 0;
+    ~pkgSpinWait(){ referrer = NULL; }
+};
+
+#endif /* PKGSTAT_H: $RCSfile$: end of file */

--- a/src/pkgunst.cpp
+++ b/src/pkgunst.cpp
@@ -4,7 +4,7 @@
  * $Id$
  *
  * Written by Keith Marshall <[e-mail]>
- * Copyright (C) 2011, 2012, MinGW Project
+ * Copyright (C) 2011, 2012, MinGW.org Project
  *
  *
  * Implementation of the primary package removal methods.
@@ -37,6 +37,7 @@
 #include "pkgkeys.h"
 #include "pkgproc.h"
 #include "pkgtask.h"
+#include "pkgstat.h"
 
 #include "mkpath.h"
 
@@ -286,6 +287,7 @@ int pkg_unlink( const char *sysroot, const char *pathname )
     char filepath[ mkpath( NULL, sysroot, pathname, NULL ) ];
     mkpath( filepath, sysroot, pathname, NULL );
 
+    pkgSpinWait::Report( "Deleting %s", pathname );
     DEBUG_INVOKE_IF( DEBUG_REQUEST( DEBUG_TRACE_TRANSACTIONS ),
 	dmh_printf( "  %s: unlink file\n", filepath )
       );

--- a/src/sysroot.cpp
+++ b/src/sysroot.cpp
@@ -4,7 +4,7 @@
  * $Id$
  *
  * Written by Keith Marshall <[e-mail]>
- * Copyright (C) 2010, 2011, 2012, MinGW Project
+ * Copyright (C) 2010, 2011, 2012, MinGW.org Project
  *
  *
  * Implementation of the system map loader, sysroot management and
@@ -42,6 +42,7 @@
 #include "mkpath.h"
 
 #include "pkgbase.h"
+#include "pkgstat.h"
 #include "pkgkeys.h"
 
 #include "debug.h"
@@ -425,7 +426,9 @@ void pkgXmlDocument::UpdateSystemMap()
   pkgXmlNode *entry = GetRoot()->FindFirstAssociate( sysroot_key );
 
   while( entry != NULL )
-  {
+  { pkgSpinWait::Report( "Updating system map... (%c)",
+	pkgSpinWait::Indicator()
+      );
     /* We found a sysroot record...
      * evaluate and clear its 'modified' attribute...
      */

--- a/src/tarproc.cpp
+++ b/src/tarproc.cpp
@@ -4,7 +4,7 @@
  * $Id$
  *
  * Written by Keith Marshall <[e-mail]>
- * Copyright (C) 2009, 2010, 2011, MinGW Project
+ * Copyright (C) 2009, 2010, 2011, 2012, MinGW.org Project
  *
  *
  * Implementation of package archive processing methods, for reading
@@ -43,6 +43,7 @@
 #include "pkginfo.h"
 #include "pkgkeys.h"
 #include "pkgproc.h"
+#include "pkgstat.h"
 
 /*******************
  *
@@ -664,6 +665,7 @@ int pkgTarArchiveInstaller::ProcessDataStream( const char *pathname )
   /* Extract file data from the archive, and copy it to the
    * associated target file stream, if any.
    */
+  pkgSpinWait::Report( "Extracting %s", pathname + sysroot_len );
   if( DEBUG_REQUEST( DEBUG_SUPPRESS_INSTALLATION ) )
   {
     /* Debugging stub...