Firmware updater: Make the GUI less scary

4 files changed, 128 insertions, 36 deletions

diff --git a/xs/src/avrdude/avrdude-slic3r.cpp b/xs/src/avrdude/avrdude-slic3r.cpp
index d47469e84..8e00c73dc 100644
--- a/xs/src/avrdude/avrdude-slic3r.cpp
+++ b/xs/src/avrdude/avrdude-slic3r.cpp
@@ -8,37 +8,67 @@ extern "C" {
 
 namespace Slic3r {
 
-namespace AvrDude {
-
-
 // Used by our custom code in avrdude to receive messages that avrdude normally outputs on stdout (see avrdude_message())
 static void avrdude_message_handler_closure(const char *msg, unsigned size, void *user_p)
 {
-	auto *message_fn = reinterpret_cast<MessageFn*>(user_p);
+	auto *message_fn = reinterpret_cast<AvrDude::MessageFn*>(user_p);
 	(*message_fn)(msg, size);
 }
 
-int main(std::vector<std::string> args, std::string sys_config, MessageFn message_fn)
+// Used by our custom code in avrdude to report progress in the GUI
+static void avrdude_progress_handler_closure(const char *task, unsigned progress, void *user_p)
+{
+	auto *progress_fn = reinterpret_cast<AvrDude::ProgressFn*>(user_p);
+	(*progress_fn)(task, progress);
+}
+
+
+AvrDude::AvrDude() {}
+AvrDude::~AvrDude() {}
+
+AvrDude& AvrDude::sys_config(std::string sys_config)
+{
+	m_sys_config = std::move(sys_config);
+	return *this;
+}
+
+AvrDude& AvrDude::on_message(MessageFn fn)
+{
+	m_message_fn = std::move(fn);
+	return *this;
+}
+
+AvrDude& AvrDude::on_progress(MessageFn fn)
+{
+	m_progress_fn = std::move(fn);
+	return *this;
+}
+
+int AvrDude::run(std::vector<std::string> args)
 {
 	std::vector<char *> c_args {{ const_cast<char*>(PACKAGE_NAME) }};
 	for (const auto &arg : args) {
 		c_args.push_back(const_cast<char*>(arg.data()));
 	}
 
-	::avrdude_message_handler_set(avrdude_message_handler_closure, reinterpret_cast<void*>(&message_fn));
-	const auto res = ::avrdude_main(static_cast<int>(c_args.size()), c_args.data(), sys_config.c_str());
+	if (m_message_fn) {
+		::avrdude_message_handler_set(avrdude_message_handler_closure, reinterpret_cast<void*>(&m_message_fn));
+	} else {
+		::avrdude_message_handler_set(nullptr, nullptr);
+	}
+	
+	if (m_progress_fn) {
+		::avrdude_progress_handler_set(avrdude_progress_handler_closure, reinterpret_cast<void*>(&m_progress_fn));
+	} else {
+		::avrdude_progress_handler_set(nullptr, nullptr);
+	}
+	
+	const auto res = ::avrdude_main(static_cast<int>(c_args.size()), c_args.data(), m_sys_config.c_str());
+	
 	::avrdude_message_handler_set(nullptr, nullptr);
+	::avrdude_progress_handler_set(nullptr, nullptr);
 	return res;
 }
 
-int main(std::vector<std::string> args, std::string sys_config, std::ostream &os)
-{
-	return main(std::move(args), std::move(sys_config), std::move([&os](const char *msg, unsigned /* size */) {
-		os << msg;
-	}));
-}
-
-
-}
 
 }
diff --git a/xs/src/avrdude/avrdude-slic3r.hpp b/xs/src/avrdude/avrdude-slic3r.hpp
index b6143b508..ecae654b2 100644
--- a/xs/src/avrdude/avrdude-slic3r.hpp
+++ b/xs/src/avrdude/avrdude-slic3r.hpp
@@ -8,12 +8,34 @@
 
 namespace Slic3r {
 
-namespace AvrDude {
+class AvrDude
+{
+public:
 	typedef std::function<void(const char * /* msg */, unsigned /* size */)> MessageFn;
+	typedef std::function<void(const char * /* task */, unsigned /* progress */)> ProgressFn;
+
+	AvrDude();
+	AvrDude(AvrDude &&) = delete;
+	AvrDude(const AvrDude &) = delete;
+	AvrDude &operator=(AvrDude &&) = delete;
+	AvrDude &operator=(const AvrDude &) = delete;
+	~AvrDude();
+
+	// Set location of avrdude's main configuration file
+	AvrDude& sys_config(std::string sys_config);
+	// Set message output callback
+	AvrDude& on_message(MessageFn fn);
+	// Set progress report callback
+	// Progress is reported per each task (reading / writing), progress is reported in percents.
+	AvrDude& on_progress(MessageFn fn);
+	
+	int run(std::vector<std::string> args);
+private:
+	std::string m_sys_config;
+	MessageFn   m_message_fn;
+	ProgressFn  m_progress_fn;
+};
 
-	int main(std::vector<std::string> args, std::string sys_config, MessageFn message_fn);
-	int main(std::vector<std::string> args, std::string sys_config, std::ostream &os);
-}
 
 }
 
diff --git a/xs/src/avrdude/avrdude.h b/xs/src/avrdude/avrdude.h
index 7763d1464..794169921 100644
--- a/xs/src/avrdude/avrdude.h
+++ b/xs/src/avrdude/avrdude.h
@@ -29,9 +29,15 @@ extern int verbose;		/* verbosity level (-v, -vv, ...) */
 extern int quell_progress;	/* quiteness level (-q, -qq) */
 
 typedef void (*avrdude_message_handler_t)(const char *msg, unsigned size, void *user_p);
-avrdude_message_handler_t avrdude_message_handler_set(avrdude_message_handler_t newhandler, void *user_p);
+void avrdude_message_handler_set(avrdude_message_handler_t newhandler, void *user_p);
 int avrdude_message(const int msglvl, const char *format, ...);
 
+// Progress reporting callback
+// `progress` is in range 0 ~ 100 percent
+typedef void (*avrdude_progress_handler_t)(const char *task, unsigned progress, void *user_p);
+void avrdude_progress_handler_set(avrdude_progress_handler_t newhandler, void *user_p);
+void avrdude_progress_external(const char *task, unsigned progress);
+
 #define MSG_INFO    (0) /* no -v option, can be supressed with -qq */
 #define MSG_NOTICE  (1) /* displayed with -v */
 #define MSG_NOTICE2 (2) /* displayed with -vv, used rarely */
diff --git a/xs/src/avrdude/main.c b/xs/src/avrdude/main.c
index 02feb079b..727166ec1 100644
--- a/xs/src/avrdude/main.c
+++ b/xs/src/avrdude/main.c
@@ -68,26 +68,24 @@ char msgbuffer[MSGBUFFER_SIZE];
 
 static void avrdude_message_handler_null(const char *msg, unsigned size, void *user_p)
 {
+    // Output to stderr by default
     (void)size;
+    (void)user_p;
     fputs(msg, stderr);
 }
 
 static void *avrdude_message_handler_user_p = NULL;
 static avrdude_message_handler_t avrdude_message_handler = avrdude_message_handler_null;
 
-avrdude_message_handler_t avrdude_message_handler_set(avrdude_message_handler_t newhandler, void *user_p)
+void avrdude_message_handler_set(avrdude_message_handler_t newhandler, void *user_p)
 {
-    avrdude_message_handler_t previous = avrdude_message_handler == avrdude_message_handler_null ? NULL : avrdude_message_handler;
-
     if (newhandler != NULL) {
         avrdude_message_handler = newhandler;
         avrdude_message_handler_user_p = user_p;
     } else {
-        avrdude_message_handler = NULL;
+        avrdude_message_handler = avrdude_message_handler_null;
         avrdude_message_handler_user_p = NULL;
     }
-
-    return previous;
 }
 
 int avrdude_message(const int msglvl, const char *format, ...)
@@ -117,6 +115,34 @@ int avrdude_message(const int msglvl, const char *format, ...)
 }
 
 
+static void avrdude_progress_handler_null(const char *task, unsigned progress, void *user_p)
+{
+    // By default do nothing
+    (void)task;
+    (void)progress;
+    (void)user_p;
+}
+
+static void *avrdude_progress_handler_user_p = NULL;
+static avrdude_progress_handler_t avrdude_progress_handler = avrdude_progress_handler_null;
+
+void avrdude_progress_handler_set(avrdude_progress_handler_t newhandler, void *user_p)
+{
+    if (newhandler != NULL) {
+        avrdude_progress_handler = newhandler;
+        avrdude_progress_handler_user_p = user_p;
+    } else {
+        avrdude_progress_handler = avrdude_progress_handler_null;
+        avrdude_progress_handler_user_p = NULL;
+    }
+}
+
+void avrdude_progress_external(const char *task, unsigned progress)
+{
+    avrdude_progress_handler(task, progress, avrdude_progress_handler_user_p);
+}
+
+
 struct list_walk_cookie
 {
     FILE *f;
@@ -176,7 +202,7 @@ static void usage(void)
  "  -Y <number>                Initialize erase cycle # in EEPROM.\n"
  "  -v                         Verbose output. -v -v for more.\n"
  "  -q                         Quell progress output. -q -q for less.\n"
- "  -l logfile                 Use logfile rather than stderr for diagnostics.\n"
+//  "  -l logfile                 Use logfile rather than stderr for diagnostics.\n"
  "  -?                         Display this usage.\n"
  "\navrdude version %s, URL: <http://savannah.nongnu.org/projects/avrdude/>\n"
           ,progname, version);
@@ -222,6 +248,7 @@ static void update_progress_no_tty (int percent, double etime, char *hdr)
 {
   static int done = 0;
   static int last = 0;
+  static char *header = NULL;
   int cnt = (percent>>1)*2;
 
   // setvbuf(stderr, (char*)NULL, _IONBF, 0);
@@ -230,16 +257,23 @@ static void update_progress_no_tty (int percent, double etime, char *hdr)
     avrdude_message(MSG_INFO, "\n%s | ", hdr);
     last = 0;
     done = 0;
+    header = hdr;
+    avrdude_progress_external(header, 0);
   }
   else {
     while ((cnt > last) && (done == 0)) {
       avrdude_message(MSG_INFO, "#");
       cnt -=  2;
     }
+
+    if (done == 0) {
+      avrdude_progress_external(header, percent > 99 ? 99 : percent);
+    }
   }
 
   if ((percent == 100) && (done == 0)) {
     avrdude_message(MSG_INFO, " | 100%% %0.2fs\n\n", etime);
+    avrdude_progress_external(header, 100);
     last = 0;
     done = 1;
   }
@@ -386,7 +420,7 @@ int avrdude_main(int argc, char * argv [], const char *sys_config)
   int     silentsafe;  /* Don't ask about fuses, 1=silent, 0=normal */
   int     init_ok;     /* Device initialization worked well */
   int     is_open;     /* Device open succeeded */
-  char  * logfile;     /* Use logfile rather than stderr for diagnostics */
+  // char  * logfile;     /* Use logfile rather than stderr for diagnostics */
   enum updateflags uflags = UF_AUTO_ERASE; /* Flags for do_op() */
   unsigned char safemode_lfuse = 0xff;
   unsigned char safemode_hfuse = 0xff;
@@ -396,9 +430,9 @@ int avrdude_main(int argc, char * argv [], const char *sys_config)
   char * safemode_response;
   int fuses_specified = 0;
   int fuses_updated = 0;
-#if !defined(WIN32NATIVE)
-  char  * homedir;
-#endif
+// #if !defined(WIN32NATIVE)
+//   char  * homedir;
+// #endif
 
   /*
    * Set line buffering for file descriptors so we see stdout and stderr
@@ -465,7 +499,7 @@ int avrdude_main(int argc, char * argv [], const char *sys_config)
   safemode      = 1;       /* Safemode on by default */
   silentsafe    = 0;       /* Ask by default */
   is_open       = 0;
-  logfile       = NULL;
+  // logfile       = NULL;
 
 // #if defined(WIN32NATIVE)
 
@@ -611,9 +645,9 @@ int avrdude_main(int argc, char * argv [], const char *sys_config)
         ovsigck = 1;
         break;
 
-      case 'l':
-	logfile = optarg;
-	break;
+  //     case 'l':
+	// logfile = optarg;
+	// break;
 
       case 'n':
         uflags |= UF_NOWRITE;