🚸 Restore Object Cancel info on Power-Loss Recovery (#27501)

thinkyhead · web-flow · commit 3b7aadb3597f · 2024-10-28T11:17:40.000-05:00
* 🎨 Shorten feature includes
* 🚸 Save Canceled Objects with Power Loss data
diff --git a/Marlin/src/feature/cancel_object.cpp b/Marlin/src/feature/cancel_object.cpp
@@ -30,53 +30,50 @@
 
 CancelObject cancelable;
 
-int8_t CancelObject::object_count, // = 0
-       CancelObject::active_object = -1;
-uint32_t CancelObject::canceled; // = 0x0000
-bool CancelObject::skipping; // = false
+cancel_state_t CancelObject::state;
 
 void CancelObject::set_active_object(const int8_t obj) {
-  active_object = obj;
+  state.active_object = obj;
   if (WITHIN(obj, 0, 31)) {
-    if (obj >= object_count) object_count = obj + 1;
-    skipping = TEST(canceled, obj);
+    if (obj >= state.object_count) state.object_count = obj + 1;
+    state.skipping = TEST(state.canceled, obj);
   }
   else
-    skipping = false;
+    state.skipping = false;
 
   #if ALL(HAS_STATUS_MESSAGE, CANCEL_OBJECTS_REPORTING)
-    if (active_object >= 0)
-      ui.set_status(MString<30>(GET_TEXT_F(MSG_PRINTING_OBJECT), ' ', active_object));
+    if (state.active_object >= 0)
+      ui.set_status(MString<30>(GET_TEXT_F(MSG_PRINTING_OBJECT), ' ', state.active_object));
     else
       ui.reset_status();
   #endif
 }
 
 void CancelObject::cancel_object(const int8_t obj) {
   if (WITHIN(obj, 0, 31)) {
-    SBI(canceled, obj);
-    if (obj == active_object) skipping = true;
+    SBI(state.canceled, obj);
+    if (obj == state.active_object) state.skipping = true;
   }
 }
 
 void CancelObject::uncancel_object(const int8_t obj) {
   if (WITHIN(obj, 0, 31)) {
-    CBI(canceled, obj);
-    if (obj == active_object) skipping = false;
+    CBI(state.canceled, obj);
+    if (obj == state.active_object) state.skipping = false;
   }
 }
 
 void CancelObject::report() {
-  if (active_object >= 0)
-    SERIAL_ECHO_MSG("Active Object: ", active_object);
+  if (state.active_object >= 0)
+    SERIAL_ECHO_MSG("Active Object: ", state.active_object);
 
-  if (canceled) {
-    SERIAL_ECHO_START();
-    SERIAL_ECHOPGM("Canceled:");
-    for (int i = 0; i < object_count; i++)
-      if (TEST(canceled, i)) { SERIAL_CHAR(' '); SERIAL_ECHO(i); }
-    SERIAL_EOL();
-  }
+  if (state.canceled == 0x0000) return;
+
+  SERIAL_ECHO_START();
+  SERIAL_ECHOPGM("Canceled:");
+  for (int i = 0; i < state.object_count; i++)
+    if (TEST(state.canceled, i)) { SERIAL_CHAR(' '); SERIAL_ECHO(i); }
+  SERIAL_EOL();
 }
 
 #endif // CANCEL_OBJECTS
diff --git a/Marlin/src/feature/cancel_object.h b/Marlin/src/feature/cancel_object.h
@@ -23,19 +23,23 @@
 
 #include <stdint.h>
 
+typedef struct CancelState {
+  bool skipping = false;
+  int8_t object_count = 0, active_object = 0;
+  uint32_t canceled = 0x0000;
+} cancel_state_t;
+
 class CancelObject {
 public:
-  static bool skipping;
-  static int8_t object_count, active_object;
-  static uint32_t canceled;
-  static void set_active_object(const int8_t obj);
+  static cancel_state_t state;
+  static void set_active_object(const int8_t obj=state.active_object);
   static void cancel_object(const int8_t obj);
   static void uncancel_object(const int8_t obj);
   static void report();
-  static bool is_canceled(const int8_t obj) { return TEST(canceled, obj); }
+  static bool is_canceled(const int8_t obj) { return TEST(state.canceled, obj); }
   static void clear_active_object() { set_active_object(-1); }
-  static void cancel_active_object() { cancel_object(active_object); }
-  static void reset() { canceled = 0x0000; object_count = 0; clear_active_object(); }
+  static void cancel_active_object() { cancel_object(state.active_object); }
+  static void reset() { state.canceled = 0x0000; state.object_count = 0; clear_active_object(); }
 };
 
 extern CancelObject cancelable;
diff --git a/Marlin/src/feature/encoder_i2c.cpp b/Marlin/src/feature/encoder_i2c.cpp
@@ -36,7 +36,7 @@
 #include "../module/stepper.h"
 #include "../gcode/parser.h"
 
-#include "../feature/babystep.h"
+#include "babystep.h"
 
 #include <Wire.h>
 
diff --git a/Marlin/src/feature/leds/leds.cpp b/Marlin/src/feature/leds/leds.cpp
@@ -31,7 +31,7 @@
 #include "leds.h"
 
 #if ANY(CASE_LIGHT_USE_RGB_LED, CASE_LIGHT_USE_NEOPIXEL)
-  #include "../../feature/caselight.h"
+  #include "../caselight.h"
 #endif
 
 #if ENABLED(LED_COLOR_PRESETS)
diff --git a/Marlin/src/feature/mmu/mmu2.cpp b/Marlin/src/feature/mmu/mmu2.cpp
@@ -43,7 +43,7 @@ MMU2 mmu2;
 #include "../../MarlinCore.h"
 
 #if ENABLED(HOST_PROMPT_SUPPORT)
-  #include "../../feature/host_actions.h"
+  #include "../host_actions.h"
 #endif
 
 #if ENABLED(EXTENSIBLE_UI)
diff --git a/Marlin/src/feature/mmu3/mmu3_fsensor.cpp b/Marlin/src/feature/mmu3/mmu3_fsensor.cpp
@@ -28,7 +28,7 @@
 
 #if HAS_PRUSA_MMU3
 
-#include "../../feature/runout.h"
+#include "../runout.h"
 #include "mmu3_fsensor.h"
 
 namespace MMU3 {
diff --git a/Marlin/src/feature/mmu3/mmu3_marlin1.cpp b/Marlin/src/feature/mmu3/mmu3_marlin1.cpp
@@ -34,7 +34,7 @@
 #include "../../module/planner.h"
 #include "../../module/temperature.h"
 
-#include "../../feature/pause.h"
+#include "../pause.h"
 #include "../../libs/nozzle.h"
 #include "mmu3_marlin.h"
 
diff --git a/Marlin/src/feature/mmu3/mmu3_reporting.cpp b/Marlin/src/feature/mmu3/mmu3_reporting.cpp
@@ -43,7 +43,7 @@
 
 #include "../../core/language.h"
 #include "../../gcode/gcode.h"
-#include "../../feature/host_actions.h"
+#include "../host_actions.h"
 #include "../../lcd/marlinui.h"
 #include "../../lcd/menu/menu.h"
 #include "../../lcd/menu/menu_item.h"
diff --git a/Marlin/src/feature/powerloss.cpp b/Marlin/src/feature/powerloss.cpp
@@ -215,6 +215,7 @@ void PrintJobRecovery::save(const bool force/*=false*/, const float zraise/*=POW
     info.zraise = zraise;
     info.flag.raised = raised;                      // Was Z raised before power-off?
 
+    TERN_(CANCEL_OBJECTS, info.cancel_state = cancelable.state);
     TERN_(GCODE_REPEAT_MARKERS, info.stored_repeat = repeat);
     TERN_(HAS_HOME_OFFSET, info.home_offset = home_offset);
     TERN_(HAS_WORKSPACE_OFFSET, info.workspace_offset = workspace_offset);
@@ -575,6 +576,11 @@ void PrintJobRecovery::resume() {
   // Restore E position with G92.9
   PROCESS_SUBCOMMANDS_NOW(TS(F("G92.9E"), p_float_t(resume_pos.e, 3)));
 
+  #if ENABLED(CANCEL_OBJECTS)
+    cancelable.state = info.cancel_state;
+    cancelable.set_active_object(); // Sets the status message
+  #endif
+
   TERN_(GCODE_REPEAT_MARKERS, repeat = info.stored_repeat);
   TERN_(HAS_HOME_OFFSET, home_offset = info.home_offset);
   TERN_(HAS_WORKSPACE_OFFSET, workspace_offset = info.workspace_offset);
@@ -613,6 +619,14 @@ void PrintJobRecovery::resume() {
 
         DEBUG_ECHOLNPGM("zraise: ", info.zraise, " ", info.flag.raised ? "(before)" : "");
 
+        #if ENABLED(CANCEL_OBJECTS)
+          const cancel_state_t cs = info.cancel_state;
+          DEBUG_ECHOPGM("Canceled:");
+          for (int i = 0; i < cs.object_count; i++)
+            if (TEST(cs.canceled, i)) { DEBUG_CHAR(' '); DEBUG_ECHO(i); }
+          DEBUG_EOL();
+        #endif
+
         #if ENABLED(GCODE_REPEAT_MARKERS)
           const uint8_t ind = info.stored_repeat.count();
           DEBUG_ECHOLNPGM("repeat markers: ", ind);
diff --git a/Marlin/src/feature/powerloss.h b/Marlin/src/feature/powerloss.h
@@ -30,12 +30,16 @@
 
 #include "../inc/MarlinConfig.h"
 
+#if ENABLED(CANCEL_OBJECTS)
+  #include "cancel_object.h"
+#endif
+
 #if ENABLED(GCODE_REPEAT_MARKERS)
-  #include "../feature/repeat.h"
+  #include "repeat.h"
 #endif
 
 #if ENABLED(MIXING_EXTRUDER)
-  #include "../feature/mixing.h"
+  #include "mixing.h"
 #endif
 
 #if !defined(POWER_LOSS_STATE) && PIN_EXISTS(POWER_LOSS)
@@ -64,6 +68,11 @@ typedef struct {
 
   float zraise;
 
+  // Canceled objects
+  #if ENABLED(CANCEL_OBJECTS)
+    cancel_state_t cancel_state;
+  #endif
+
   // Repeat information
   #if ENABLED(GCODE_REPEAT_MARKERS)
     Repeat stored_repeat;
diff --git a/Marlin/src/feature/runout.cpp b/Marlin/src/feature/runout.cpp
@@ -59,7 +59,7 @@ bool FilamentMonitorBase::enabled = true,
 // Filament Runout event handler
 //
 #include "../MarlinCore.h"
-#include "../feature/pause.h"
+#include "pause.h"
 #include "../gcode/queue.h"
 
 #if ENABLED(HOST_ACTION_COMMANDS)
diff --git a/Marlin/src/feature/runout.h b/Marlin/src/feature/runout.h
@@ -30,7 +30,7 @@
 #include "../module/planner.h"
 #include "../module/stepper.h" // for block_t
 #include "../gcode/queue.h"
-#include "../feature/pause.h" // for did_pause_print
+#include "pause.h" // for did_pause_print
 #include "../MarlinCore.h" // for printingIsActive()
 
 #include "../inc/MarlinConfig.h"
diff --git a/Marlin/src/feature/spindle_laser.cpp b/Marlin/src/feature/spindle_laser.cpp
@@ -35,7 +35,7 @@
 #endif
 
 #if ENABLED(I2C_AMMETER)
-  #include "../feature/ammeter.h"
+  #include "ammeter.h"
 #endif
 
 SpindleLaser cutter;
diff --git a/Marlin/src/gcode/bedlevel/G26.cpp b/Marlin/src/gcode/bedlevel/G26.cpp
@@ -102,7 +102,7 @@
 #define G26_OK false
 #define G26_ERR true
 
-#include "../../gcode/gcode.h"
+#include "../gcode.h"
 #include "../../feature/bedlevel/bedlevel.h"
 
 #include "../../MarlinCore.h"
diff --git a/Marlin/src/gcode/feature/cancel/M486.cpp b/Marlin/src/gcode/feature/cancel/M486.cpp
@@ -41,7 +41,7 @@ void GcodeSuite::M486() {
 
   if (parser.seen('T')) {
     cancelable.reset();
-    cancelable.object_count = parser.intval('T', 1);
+    cancelable.state.object_count = parser.intval('T', 1);
   }
 
   if (parser.seenval('S'))
diff --git a/Marlin/src/gcode/gcode.cpp b/Marlin/src/gcode/gcode.cpp
@@ -165,7 +165,7 @@ void GcodeSuite::get_destination_from_command() {
   xyze_bool_t seen{false};
 
   #if ENABLED(CANCEL_OBJECTS)
-    const bool &skip_move = cancelable.skipping;
+    const bool &skip_move = cancelable.state.skipping;
   #else
     constexpr bool skip_move = false;
   #endif
diff --git a/Marlin/src/lcd/menu/menu_cancelobject.cpp b/Marlin/src/lcd/menu/menu_cancelobject.cpp
@@ -53,13 +53,13 @@ static void lcd_cancel_object_confirm() {
 }
 
 void menu_cancelobject() {
-  const int8_t ao = cancelable.active_object;
+  const int8_t ao = cancelable.state.active_object;
 
   START_MENU();
   BACK_ITEM(MSG_MAIN_MENU);
 
   // Draw cancelable items in a loop
-  for (int8_t i = -1; i < cancelable.object_count; i++) {
+  for (int8_t i = -1; i < cancelable.state.object_count; i++) {
     if (i == ao) continue;                                          // Active is drawn on -1 index
     const int8_t j = i < 0 ? ao : i;                                // Active or index item
     if (!cancelable.is_canceled(j)) {                               // Not canceled already?
diff --git a/Marlin/src/module/planner.cpp b/Marlin/src/module/planner.cpp
@@ -2867,7 +2867,7 @@ bool Planner::buffer_segment(const abce_pos_t &abce
 
   #if HAS_EXTRUDERS
     // DRYRUN prevents E moves from taking place
-    if (DEBUGGING(DRYRUN) || TERN0(CANCEL_OBJECTS, cancelable.skipping)) {
+    if (DEBUGGING(DRYRUN) || TERN0(CANCEL_OBJECTS, cancelable.state.skipping)) {
       position.e = target.e;
       TERN_(HAS_POSITION_FLOAT, position_float.e = abce.e);
     }
diff --git a/buildroot/tests/DUE b/buildroot/tests/DUE
@@ -48,5 +48,5 @@ exec_test $1 $2 "RADDS with ABL (Bilinear), Triple Z Axis, Z_STEPPER_AUTO_ALIGN,
 #
 restore_configs
 opt_set MOTHERBOARD BOARD_RAMPS4DUE_EEF LCD_LANGUAGE fi EXTRUDERS 2 TEMP_SENSOR_BED 0 NUM_SERVOS 1
-opt_enable SWITCHING_EXTRUDER ULTIMAKERCONTROLLER BEEP_ON_FEEDRATE_CHANGE POWER_LOSS_RECOVERY
-exec_test $1 $2 "RAMPS4DUE_EEF with SWITCHING_EXTRUDER, POWER_LOSS_RECOVERY" "$3"
+opt_enable SWITCHING_EXTRUDER ULTIMAKERCONTROLLER BEEP_ON_FEEDRATE_CHANGE CANCEL_OBJECTS POWER_LOSS_RECOVERY
+exec_test $1 $2 "RAMPS4DUE_EEF with SWITCHING_EXTRUDER, CANCEL_OBJECTS, POWER_LOSS_RECOVERY" "$3"
