From e271521c39b6b48ed49018fc05af9eaee0dabeff Mon Sep 17 00:00:00 2001
From: Scott Lahteine <github@thinkyhead.com>
Date: Mon, 22 May 2017 11:42:17 -0500
Subject: [PATCH] Single user_canceled function in G26

---
 Marlin/G26_Mesh_Validation_Tool.cpp | 66 ++++++++++++-----------------
 Marlin/ultralcd.cpp                 |  6 +--
 2 files changed, 30 insertions(+), 42 deletions(-)

diff --git a/Marlin/G26_Mesh_Validation_Tool.cpp b/Marlin/G26_Mesh_Validation_Tool.cpp
index ff329bf161..847e516f41 100644
--- a/Marlin/G26_Mesh_Validation_Tool.cpp
+++ b/Marlin/G26_Mesh_Validation_Tool.cpp
@@ -186,6 +186,30 @@
     feedrate_mm_s = save_feedrate;  // restore global feed rate
   }
 
+  /**
+   * Detect ubl_lcd_clicked, debounce it, and return true for cancel
+   */
+  bool user_canceled() {
+    if (!ubl_lcd_clicked()) return false;
+    safe_delay(10);                       // Wait for click to settle
+
+    #if ENABLED(ULTRA_LCD)
+      lcd_setstatuspgm(PSTR("Mesh Validation Stopped."), 99);
+      lcd_quick_feedback();
+    #endif
+    lcd_reset_alert_level();
+
+    while (!ubl_lcd_clicked()) idle();    // Wait for button release
+
+    // If the button is suddenly pressed again,
+    // ask the user to resolve the issue
+    lcd_setstatuspgm(PSTR("Release button"), 99); // will never appear...
+    while (ubl_lcd_clicked()) idle();             // unless this loop happens
+    lcd_setstatuspgm(PSTR(""));
+
+    return true;
+  }
+
   /**
    * G26: Mesh Validation Pattern generation.
    *
@@ -300,25 +324,7 @@
 
         for (tmp = start_angle; tmp < end_angle - 0.1; tmp += 30.0) {
 
-          // this sequence to detect an ubl_lcd_clicked() debounce it and leave if it is
-          // a Press and Hold is repeated in a lot of places (including ubl_G29.cpp).   This
-          // should be redone and compressed.
-          if (ubl_lcd_clicked()) {              // Check if the user wants to stop the Mesh Validation
-            #if ENABLED(ULTRA_LCD)
-              lcd_setstatuspgm(PSTR("Mesh Validation Stopped."), 99);
-              lcd_quick_feedback();
-            #endif
-            while (!ubl_lcd_clicked()) {         // Wait until the user is done pressing the
-              idle();                            // Encoder Wheel if that is why we are leaving
-              lcd_reset_alert_level();
-              lcd_setstatuspgm(PSTR(""));
-            }
-            while (ubl_lcd_clicked()) {          // Wait until the user is done pressing the
-              idle();                            // Encoder Wheel if that is why we are leaving
-              lcd_setstatuspgm(PSTR("Unpress Wheel"), 99);
-            }
-            goto LEAVE;
-          }
+          if (user_canceled()) goto LEAVE;              // Check if the user wants to stop the Mesh Validation
 
           int tmp_div_30 = tmp / 30.0;
           if (tmp_div_30 < 0) tmp_div_30 += 360 / 30;
@@ -436,28 +442,10 @@
     for (uint8_t i = 0; i < GRID_MAX_POINTS_X; i++) {
       for (uint8_t j = 0; j < GRID_MAX_POINTS_Y; j++) {
 
-        // this sequence to detect an ubl_lcd_clicked() debounce it and leave if it is
-        // a Press and Hold is repeated in a lot of places (including ubl_G29.cpp).   This
-        // should be redone and compressed.
-        if (ubl_lcd_clicked()) {              // Check if the user wants to stop the Mesh Validation
-          #if ENABLED(ULTRA_LCD)
-            lcd_setstatuspgm(PSTR("Mesh Validation Stopped."), 99);
-            lcd_quick_feedback();
-          #endif
-          while (!ubl_lcd_clicked()) {         // Wait until the user is done pressing the
-            idle();                            // Encoder Wheel if that is why we are leaving
-            lcd_reset_alert_level();
-            lcd_setstatuspgm(PSTR(""));
-          }
-          while (ubl_lcd_clicked()) {          // Wait until the user is done pressing the
-            idle();                            // Encoder Wheel if that is why we are leaving
-            lcd_setstatuspgm(PSTR("Unpress Wheel"), 99);
-          }
-          return true;
-        }
+        if (user_canceled()) return true;     // Check if the user wants to stop the Mesh Validation
 
         if (i < GRID_MAX_POINTS_X) { // We can't connect to anything to the right than GRID_MAX_POINTS_X.
-                                         // This is already a half circle because we are at the edge of the bed.
+                                     // This is already a half circle because we are at the edge of the bed.
 
           if (is_bit_set(circle_flags, i, j) && is_bit_set(circle_flags, i + 1, j)) { // check if we can do a line to the left
             if (!is_bit_set(horizontal_mesh_line_flags, i, j)) {
diff --git a/Marlin/ultralcd.cpp b/Marlin/ultralcd.cpp
index aa71187396..dd15902381 100644
--- a/Marlin/ultralcd.cpp
+++ b/Marlin/ultralcd.cpp
@@ -1480,7 +1480,7 @@ void kill_screen(const char* lcd_msg) {
     void _lcd_level_bed_get_z() {
       ENCODER_DIRECTION_NORMAL();
 
-      // Encoder wheel adjusts the Z position
+      // Encoder knob or keypad buttons adjust the Z position
       if (encoderPosition) {
         refresh_cmd_timeout();
         current_position[Z_AXIS] += float((int32_t)encoderPosition) * (MBL_Z_STEP);
@@ -4202,9 +4202,9 @@ void lcd_reset_alert_level() { lcd_status_message_level = 0; }
       }
       #if ENABLED(AUTO_BED_LEVELING_UBL)
         if (ubl.has_control_of_lcd_panel) {
-          ubl.encoder_diff = encoderDiff;    // Make the encoder's rotation available to G29's Mesh Editor
+          ubl.encoder_diff = encoderDiff;   // Make the encoder's rotation available to G29's Mesh Editor
           encoderDiff = 0;                  // We are going to lie to the LCD Panel and claim the encoder
-                                            // wheel has not turned.
+                                            // knob has not turned.
         }
       #endif
       lastEncoderBits = enc;