added exercise.py

1 files changed, 89 insertions, 0 deletions

diff --git a/ReckonPrimer.activity/exercise.py b/ReckonPrimer.activity/exercise.py
new file mode 100755
index 0000000..e343cf8
--- /dev/null
+++ b/ReckonPrimer.activity/exercise.py
@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+from functions import contain, collect_digits, make_line, make_input
+from functions import make_line_remainder, make_input_remainder
+
+class Exercise:
+    """This is the base class for the individual exercises.
+    An exercise is characterized by a topic. A topic determines the 
+    fields of the settings self._sett and public methods of Exercise.
+    The values of self._sett may vary from exercise to exercise.
+    """
+    def __init__(self):
+        """ An Exercise has a title, i.e. short textual description,
+        set by the author for display in the Collection. """
+        self._title = None
+        """ An Exercise has a detailed textual description
+        set by the author. """
+        self._description = None
+        """ An Exercise is characterized by an icon set by the author. """
+        self._icon = None
+        """ An Exercise stores data on evaluation, i.e. on how often the
+        Exercise has been done, what errors have been made TODO """
+        self._eval = None
+        """ The settings determine the generation of calculations.
+        The fields of the settings are determined by self._sett['topic'];
+        the values of the settings are different for different Exercises.
+        self._sett['calclines'] determines the # of lines in a calculation."""
+        self._sett = None
+        """ Calculations are generated according to the settings. """
+        self._calcs = None
+        """ An Exercise needs the Display for updating the settings"""
+        self._display = None
+
+    def get_topic(self):
+        """The topic is preliminarily used to identify an exercise."""
+        return (self._sett)['topic']
+
+    def get_setting(self):
+        return self._sett
+        
+    def update_setting(self, sett):
+        """ Update the settings and generate calculations accordingly. """
+        self._sett = sett
+        self._calcs = self._generate_calcs()
+
+    def get_calcs(self):
+        """ Get all calculations generated by the current settings. """
+        return self._calcs
+
+    def get_next_calc(self):
+        """ Get the next calculation from the Exercise.
+        TODO.WN091123: handle exception after last exercise. """
+        return (self._calcs).pop()
+    
+    def count(self):
+        """ Return the number of calculations generated by
+        the current settings """
+        return len(self._calcs)
+
+    def format_addsub_simp(self, (calc, linepos)):
+        """ Prepare the representation of a calculation for Display
+        on 1 line. Used within several subclasses. """
+        #@print('in Display.format_addsub_simp: calc=', (calc, linepos))#@
+        _ccs = collect_digits(calc)
+        #print('in Exercise.format_addsub_simp: _ccs=',_ccs )
+        _l0 = make_line(_ccs, linepos)
+        _ip = make_input(_ccs, linepos)
+        #@print('in Display.format_addsub_simp: return=', ([_l0], _ip)) #@
+        return ([_l0], _ip)
+#return ([[' ', '1', '0', ' ', '-', ' ', '7', ' ', '=', ' ', '_', ' ']], [(0, 10, '3', ' 10 - 7 = _ ', ' 10 - 7 = 3 ', [' ', '1', '0', ' ', '-', ' ', '7', ' ', '=', ' ', '3', ' '])])
+
+    #===== methods of subclasses different for topic-specific settings
+    def format(self, calc):
+        """ Prepare the representation of a calculation for Display.
+        This method is public for eventual use on calculations
+        coming through the net (TODO cooperative games, etc)"""
+        pass
+
+    def _generate_calcs(self):
+        """ Generate calculations according to topic-specific settings.
+        Called on each call of update_setting"""
+        pass
+
+    def define_buttons(self):
+        """ Define buttons for update settings. """
+        pass
+
+    def set_buttons(self, sett):
+        """ Display buttons according to the current setting. """
+        pass