gcode: Add minval/maxval/above/below options to get_X parsers

Add value checking to gcode parameter parsing code.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>

5 files changed, 53 insertions, 45 deletions

diff --git a/klippy/cartesian.py b/klippy/cartesian.py
index 0c1bf09d..155d9bf2 100644
--- a/klippy/cartesian.py
+++ b/klippy/cartesian.py
@@ -183,8 +183,6 @@ class CartKinematics:
     cmd_SET_DUAL_CARRIAGE_help = "Set which carriage is active"
     def cmd_SET_DUAL_CARRIAGE(self, params):
         gcode = self.printer.lookup_object('gcode')
-        carriage = gcode.get_int('CARRIAGE', params)
-        if carriage not in (0, 1):
-            raise gcode.error("Invalid carriage")
+        carriage = gcode.get_int('CARRIAGE', params, minval=0, maxval=1)
         self._activate_carriage(carriage)
         gcode.reset_last_position()
diff --git a/klippy/extras/output_pin.py b/klippy/extras/output_pin.py
index eda2ad2b..302e90e8 100644
--- a/klippy/extras/output_pin.py
+++ b/klippy/extras/output_pin.py
@@ -49,14 +49,13 @@ class PrinterOutputPin:
             return pin.cmd_SET_PIN(params)
         if self.is_static:
             raise self.gcode.error("Static pin can not be changed at run-time")
-        value = self.gcode.get_float('VALUE', params) / self.scale
+        value = self.gcode.get_float('VALUE', params, minval=0., maxval=1.)
+        value /= self.scale
         if value == self.last_value:
             return
         print_time = self.printer.lookup_object('toolhead').get_last_move_time()
         print_time = max(print_time, self.last_value_time + PIN_MIN_TIME)
         if self.is_pwm:
-            if value < 0. or value > 1.:
-                raise self.gcode.error("Invalid pin value")
             self.mcu_pin.set_pwm(print_time, value)
         else:
             if value not in [0., 1.]:
diff --git a/klippy/extras/virtual_sdcard.py b/klippy/extras/virtual_sdcard.py
index dd4b686d..1d0eaf15 100644
--- a/klippy/extras/virtual_sdcard.py
+++ b/klippy/extras/virtual_sdcard.py
@@ -102,7 +102,7 @@ class VirtualSD:
         # Set SD position
         if self.work_timer is not None:
             raise self.gcode.error("SD busy")
-        pos = self.gcode.get_int('S', params)
+        pos = self.gcode.get_int('S', params, minval=0)
         self.file_position = pos
     def cmd_M27(self, params):
         # Report SD print status
diff --git a/klippy/extruder.py b/klippy/extruder.py
index 59d8b36a..3e4934e8 100644
--- a/klippy/extruder.py
+++ b/klippy/extruder.py
@@ -228,16 +228,16 @@ class PrinterExtruder:
     def cmd_SET_PRESSURE_ADVANCE(self, params):
         self.printer.lookup_object('toolhead').get_last_move_time()
         gcode = self.printer.lookup_object('gcode')
-        if 'ADVANCE' in params:
-            v = gcode.get_float('ADVANCE', params)
-            self.pressure_advance = v if v > 0. else 0.
-        if 'ADVANCE_LOOKAHEAD_TIME' in params:
-            v = gcode.get_float('ADVANCE_LOOKAHEAD_TIME', params)
-            self.pressure_advance_lookahead_time = v if v > 0. else 0.
+        pressure_advance = gcode.get_float(
+            'ADVANCE', params, self.pressure_advance, minval=0.)
+        pressure_advance_lookahead_time = gcode.get_float(
+            'ADVANCE_LOOKAHEAD_TIME', params,
+            self.pressure_advance_lookahead_time, minval=0.)
+        self.pressure_advance = pressure_advance
+        self.pressure_advance_lookahead_time = pressure_advance_lookahead_time
         msg = ("pressure_advance: %.6f\n"
-               "pressure_advance_lookahead_time: %.6f\n" % (
-                self.pressure_advance,
-                self.pressure_advance_lookahead_time))
+               "pressure_advance_lookahead_time: %.6f" % (
+                   pressure_advance, pressure_advance_lookahead_time))
         self.printer.set_rollover_info(self.name, "%s: %s" % (self.name, msg))
         gcode.respond_info(msg)
 
diff --git a/klippy/gcode.py b/klippy/gcode.py
index 84a3ad88..3e48be4b 100644
--- a/klippy/gcode.py
+++ b/klippy/gcode.py
@@ -250,20 +250,38 @@ class GCodeParser:
         self.respond('!! %s' % (lines[0].strip(),))
     # Parameter parsing helpers
     class sentinel: pass
-    def get_str(self, name, params, default=sentinel, parser=str):
-        if name in params:
-            try:
-                return parser(params[name])
-            except:
-                raise error("Error on '%s': unable to parse %s" % (
-                    params['#original'], params[name]))
-        if default is not self.sentinel:
+    def get_str(self, name, params, default=sentinel, parser=str,
+                minval=None, maxval=None, above=None, below=None):
+        if name not in params:
+            if default is self.sentinel:
+                raise error("Error on '%s': missing %s" % (
+                    params['#original'], name))
             return default
-        raise error("Error on '%s': missing %s" % (params['#original'], name))
-    def get_int(self, name, params, default=sentinel):
-        return self.get_str(name, params, default, parser=int)
-    def get_float(self, name, params, default=sentinel):
-        return self.get_str(name, params, default, parser=float)
+        try:
+            value = parser(params[name])
+        except:
+            raise error("Error on '%s': unable to parse %s" % (
+                params['#original'], params[name]))
+        if minval is not None and value < minval:
+            raise self.error("Error on '%s': %s must have minimum of %s" % (
+                params['#original'], name, minval))
+        if maxval is not None and value > maxval:
+            raise self.error("Error on '%s': %s must have maximum of %s" % (
+                params['#original'], name, maxval))
+        if above is not None and value <= above:
+            raise self.error("Error on '%s': %s must be above %s" % (
+                params['#original'], name, above))
+        if below is not None and value >= below:
+            raise self.error("Error on '%s': %s must be below %s" % (
+                params['#original'], name, below))
+        return value
+    def get_int(self, name, params, default=sentinel, minval=None, maxval=None):
+        return self.get_str(name, params, default, parser=int,
+                            minval=minval, maxval=maxval)
+    def get_float(self, name, params, default=sentinel,
+                  minval=None, maxval=None, above=None, below=None):
+        return self.get_str(name, params, default, parser=float, minval=minval,
+                            maxval=maxval, above=above, below=below)
     extended_r = re.compile(
         r'^\s*(?:N[0-9]+\s*)?'
         r'(?P<cmd>[a-zA-Z_][a-zA-Z_]+)(?:\s+|$)'
@@ -310,9 +328,9 @@ class GCodeParser:
         if is_bed:
             heater = self.heaters[-1]
         elif 'T' in params:
-            heater_index = self.get_int('T', params)
-            if heater_index >= 0 and heater_index < len(self.heaters) - 1:
-                heater = self.heaters[heater_index]
+            index = self.get_int(
+                'T', params, minval=0, maxval=len(self.heaters)-2)
+            heater = self.heaters[index]
         elif self.extruder is not None:
             heater = self.extruder.get_heater()
         if heater is None:
@@ -349,11 +367,8 @@ class GCodeParser:
         self.respond_info('Unknown command:"%s"' % (cmd,))
     def cmd_Tn(self, params):
         # Select Tool
-        index = self.get_int('T', params)
         extruders = extruder.get_printer_extruders(self.printer)
-        if self.extruder is None or index < 0 or index >= len(extruders):
-            self.respond_error("Extruder %d not configured" % (index,))
-            return
+        index = self.get_int('T', params, minval=0, maxval=len(extruders)-1)
         e = extruders[index]
         if self.extruder is e:
             return
@@ -409,9 +424,9 @@ class GCodeParser:
     def cmd_G4(self, params):
         # Dwell
         if 'S' in params:
-            delay = self.get_float('S', params)
+            delay = self.get_float('S', params, minval=0.)
         else:
-            delay = self.get_float('P', params, 0.) / 1000.
+            delay = self.get_float('P', params, 0., minval=0.) / 1000.
         self.toolhead.dwell(delay)
     def cmd_G28(self, params):
         # Move to origin
@@ -472,15 +487,11 @@ class GCodeParser:
         self.respond("X:%.3f Y:%.3f Z:%.3f E:%.3f" % tuple(p))
     def cmd_M220(self, params):
         # Set speed factor override percentage
-        value = self.get_float('S', params, 100.) / (60. * 100.)
-        if value <= 0.:
-            raise error("Invalid factor in '%s'" % (params['#original'],))
+        value = self.get_float('S', params, 100., above=0.) / (60. * 100.)
         self.speed_factor = value
     def cmd_M221(self, params):
         # Set extrude factor override percentage
-        new_extrude_factor = self.get_float('S', params, 100.) / 100.
-        if new_extrude_factor <= 0.:
-            raise error("Invalid factor in '%s'" % (params['#original'],))
+        new_extrude_factor = self.get_float('S', params, 100., above=0.) / 100.
         last_e_pos = self.last_position[3]
         e_value = (last_e_pos - self.base_position[3]) / self.extrude_factor
         self.base_position[3] = last_e_pos - e_value * new_extrude_factor
@@ -523,7 +534,7 @@ class GCodeParser:
         self.set_temp(params, is_bed=True, wait=True)
     def cmd_M106(self, params):
         # Set fan speed
-        self.set_fan_speed(self.get_float('S', params, 255.) / 255.)
+        self.set_fan_speed(self.get_float('S', params, 255., minval=0.) / 255.)
     def cmd_M107(self, params):
         # Turn fan off
         self.set_fan_speed(0.)