Patch #57 to count and remove bad indexes.

Adds a new integer selection_errors attribute to all player objects
that represents the number of selections with detectable errors per
player. This can be compared to the len(player.selections.keys())
to get a rough idea of how flawed the selection stats might be.

Author: GraylinKim

sc2reader/plugins/replay.py

@@ -98,11 +98,13 @@ def SelectionTracker(replay):
 
     for person in replay.people:
         # TODO: A more robust person interface might be nice
+        person.selection_errors = 0
         person.selection = GameState(PlayerSelection())
         for event in filter(efilter, person.events):
             if replay.opt.debug:
                 logger.debug("Event bytes: "+event.bytes.encode("hex"))
 
+            error = False
             selection = person.selection[event.frame]
 
             if isinstance(event, SetToHotkeyEvent):
@@ -111,21 +113,25 @@ def SelectionTracker(replay):
                 logger.info("[{0}] {1} set hotkey {2} to current selection".format(Length(seconds=event.second),person.name,event.hotkey))
 
             elif isinstance(event, AddToHotkeyEvent):
-                selection[event.hotkey].deselect(*event.deselect)
+                error = not selection[event.hotkey].deselect(*event.deselect)
                 selection[event.hotkey].select(selection[0x0A].objects)
                 logger.info("[{0}] {1} added current selection to hotkey {2}".format(Length(seconds=event.second),person.name,event.hotkey))
 
             elif isinstance(event, GetFromHotkeyEvent):
                 # For some reason they leave the hotkey buffer unmodified so make a copy
                 selection[0x0A] = selection[event.hotkey].copy()
-                selection[0x0A].deselect(*event.deselect)
+                error = not selection[0x0A].deselect(*event.deselect)
                 logger.info("[{0}] {1} retrieved hotkey {2}, {3} units: {4}".format(Length(seconds=event.second),person.name,event.hotkey,len(selection[0x0A].objects),selection[0x0A]))
 
             elif isinstance(event, SelectionEvent):
-                selection[0x0A].deselect(*event.deselect)
+                error = not selection[0x0A].deselect(*event.deselect)
                 selection[0x0A].select(event.objects)
                 logger.info("[{0}] {1} selected {2} units: {3}".format(Length(seconds=event.second),person.name,len(selection[0x0A].objects),selection[0x0A]))
 
             # TODO: The event level interface here should be improved
             #       Possibly use 'added' and 'removed' unit lists as well
             event.selected = selection[0x0A].objects
+            if error:
+                person.selection_errors += 1
+                if replay.opt.debug:
+                    logger.warn("Error detected in deselection mode {}.".format(event.deselect[0]))

sc2reader/plugins/utils.py

@@ -69,22 +69,34 @@ def select(self, new_objects):
         self.objects = sorted(new_set,key=lambda obj: obj.id)
 
     def deselect(self, mode, data):
+        """Returns false if there was a data error when deselecting"""
+        size = len(self.objects)
+
         if mode == 0x01:
             """ Deselect objects according to deselect mask """
             mask = data
-            if len(mask) < len(self.objects):
+            if len(mask) < size:
                 # pad to the right
                 mask = mask+[False,]*(len(self.objects)-len(mask))
+
             self.logger.debug("Deselection Mask: {0}".format(mask))
             self.objects = [ obj for (slct, obj) in filter(lambda (slct, obj): not slct, zip(mask, self.objects)) ]
+            return len(mask) <= size
 
         elif mode == 0x02:
             """ Deselect objects according to indexes """
-            self.objects = [ self.objects[i] for i in range(len(self.objects)) if i not in data ]
+            clean_data = filter(lambda i: i < size, data)
+            self.objects = [ self.objects[i] for i in range(len(self.objects)) if i not in clean_data ]
+            return len(clean_data) == len(data)
 
         elif mode == 0x03:
             """ Deselect objects according to indexes """
-            self.objects = [ self.objects[i] for i in data ]
+            clean_data = filter(lambda i: i < size, data)
+            self.objects = [ self.objects[i] for i in clean_data ]
+            return len(clean_data) == len(data)
+
+        else:
+            return True
 
     def __str__(self):
         return ', '.join(str(obj) for obj in self.objects)