- self.instance won't be deleted but cleared - fix for VariableText
[enigma2.git] / components.py
index 7c7932316f0feddcf36c13ed9f718e997ef56a5d..9513516dfb1e64ee7f03a55df2f16c8fd7cad678 100644 (file)
@@ -1,5 +1,6 @@
 from enigma import *
 import time
+import sys
 
 # some helper classes first:
 class HTMLComponent:
@@ -20,60 +21,131 @@ class HTMLSkin:
                return res
 
 class GUISkin:
-       data = { }
+       def __init__(self):
+               pass
+       
        def createGUIScreen(self, parent):
                for (name, val) in self.items():
-                       self.data[name] = { }
-                       val.GUIcreate(self.data[name], parent, None)
+                       if isinstance(val, GUIComponent):
+                               val.GUIcreate(parent, None)
+       
+       def deleteGUIScreen(self):
+               for (name, val) in self.items():
+                       if isinstance(val, GUIComponent):
+                               val.GUIdelete()
+                       try:
+                               val.fix()
+                       except:
+                               pass
+                       
+                       # DIESER KOMMENTAR IST NUTZLOS UND MITTLERWEILE VERALTET! (glaub ich)
+                       # BITTE NICHT LESEN!
+                       # note: you'll probably run into this assert. if this happens, don't panic!
+                       # yes, it's evil. I told you that programming in python is just fun, and 
+                       # suddently, you have to care about things you don't even know.
+                       #
+                       # but calm down, the solution is easy, at least on paper:
+                       #
+                       # Each Component, which is a GUIComponent, owns references to each
+                       # instantiated eWidget (namely in screen.data[name]["instance"], in case
+                       # you care.)
+                       # on deleteGUIscreen, all eWidget *must* (!) be deleted (otherwise,
+                       # well, problems appear. I don't want to go into details too much,
+                       # but this would be a memory leak anyway.)
+                       # The assert beyond checks for that. It asserts that the corresponding
+                       # eWidget is about to be removed (i.e., that the refcount becomes 0 after
+                       # running deleteGUIscreen).
+                       # (You might wonder why the refcount is checked for 2 and not for 1 or 0 -
+                       # one reference is still hold by the local variable 'w', another one is
+                       # hold be the function argument to sys.getrefcount itself. So only if it's
+                       # 2 at this point, the object will be destroyed after leaving deleteGUIscreen.)
+                       #
+                       # Now, how to fix this problem? You're holding a reference somewhere. (References
+                       # can only be hold from Python, as eWidget itself isn't related to the c++
+                       # way of having refcounted objects. So it must be in python.)
+                       #
+                       # It could be possible that you're calling deleteGUIscreen trough a call of
+                       # a PSignal. For example, you could try to call screen.doClose() in response
+                       # to a Button::click. This will fail. (It wouldn't work anyway, as you would
+                       # remove a dialog while running it. It never worked - enigma1 just set a 
+                       # per-mainloop variable on eWidget::close() to leave the exec()...)
+                       # That's why Session supports delayed closes. Just call Session.close() and
+                       # it will work.
+                       #
+                       # Another reason is that you just stored the data["instance"] somewhere. or
+                       # added it into a notifier list and didn't removed it.
+                       #
+                       # If you can't help yourself, just ask me. I'll be glad to help you out.
+                       # Sorry for not keeping this code foolproof. I really wanted to archive
+                       # that, but here I failed miserably. All I could do was to add this assert.
+#                      assert sys.getrefcount(w) == 2, "too many refs hold to " + str(w)
+       
+       def close(self):
+               self.deleteGUIScreen()
 
 class GUIComponent:
        """ GUI component """
 
        def __init__(self):
-               self.notifier = [ ]
+               pass
+               
+       def execBegin(self):
+               pass
        
-       def GUIcreate(self, priv, parent, skindata):
-               i = self.GUIcreateInstance(self, parent, skindata)
-               priv["instance"] = i
-               self.notifier.append(i)
-               if self.notifierAdded:
-                       self.notifierAdded(i)
+       def execEnd(self):
+               pass
 
 class VariableText:
        """VariableText can be used for components which have a variable text, based on any widget with setText call"""
        
        def __init__(self):
                self.message = ""
+               self.instance = None
        
-       def notifierAdded(self, notifier):
-               notifier.setText(self.message)
-
        def setText(self, text):
-               if self.message != text:
-                       self.message = text
-                       for x in self.notifier:
-                               x.setText(self.message)
+               self.message = text
+               if self.instance:
+                       self.instance.setText(self.message)
 
        def getText(self):
                return self.message
+       
+       def GUIcreate(self, parent, skindata):
+               self.instance = self.createWidget(parent, skindata)
+               self.instance.setText(self.message)
+       
+       def GUIdelete(self):
+               self.removeWidget(self.instance)
+               self.instance = None
+       
+       def removeWidget(self, instance):
+               pass
 
 class VariableValue:
        """VariableValue can be used for components which have a variable value (like eSlider), based on any widget with setValue call"""
        
        def __init__(self):
                self.value = 0
+               self.instance = None
        
-       def notifierAdded(self, notifier):
-               notifier.setValue(self.value)
-
        def setValue(self, value):
-               if self.value != value:
-                       self.value = value
-                       for x in self.notifier:
-                               x.setValue(self.value)
+               self.value = value
+               if self.instance:
+                       self.instance.setValue(self.value)
 
        def getValue(self):
                return self.value
+               
+       def GUIcreate(self, parent, skindata):
+               self.instance = self.createWidget(parent, skindata)
+               self.instance.setValue(self.value)
+       
+       def GUIdelete(self):
+               self.removeWidget(self.instance)
+               self.instance = None
+       
+       def removeWidget(self, instance):
+               pass
 
 # now some "real" components:
 
@@ -82,50 +154,74 @@ class Clock(HTMLComponent, GUIComponent, VariableText):
                VariableText.__init__(self)
                GUIComponent.__init__(self)
                self.doClock()
+               
+               self.clockTimer = eTimer()
+               self.clockTimer.timeout.get().append(self.doClock)
+               self.clockTimer.start(1000)
 
 # "funktionalitaet"    
        def doClock(self):
-               self.setText("clock: " + time.asctime())
+               t = time.localtime()
+               self.setText("%2d:%02d:%02d" % (t[3], t[4], t[5]))
 
 # realisierung als GUI
-       def GUIcreateInstance(self, priv, parent, skindata):
-               g = eLabel(parent)
-               return g
+       def createWidget(self, parent, skindata):
+               return eLabel(parent)
+
+       def removeWidget(self, w):
+               del self.clockTimer
 
 # ...und als HTML:
        def produceHTML(self):
                return self.getText()
-
+               
 class Button(HTMLComponent, GUIComponent, VariableText):
-       def __init__(self, text=""):
+       def __init__(self, text="", onClick = [ ]):
                GUIComponent.__init__(self)
                VariableText.__init__(self)
                self.setText(text)
-               self.onClick = [ ]
+               self.onClick = onClick
        
-       def clicked(self):
+       def push(self):
                for x in self.onClick:
                        x()
                return 0
-
-       def GUIcreate(self, priv, parent, skindata):
-               GUIComponent.GUIcreate(self, priv,parent, skindata)
-               priv["instance"].selected.get().append(self.clicked)
        
-       def click(self):
-               for x in self.onClick:
-                       x()
+       def disable(self):
+#              self.instance.hide()
+               pass
+       
+       def enable(self):
+#              self.instance.show()
+               pass
 
-# html:        
+# html:
        def produceHTML(self):
                return "<input type=\"submit\" text=\"" + self.getText() + "\">\n"
 
 # GUI:
-       def GUIcreateInstance(self, priv, parent, skindata):
+       def createWidget(self, parent, skindata):
                g = eButton(parent)
-#              g.clicked = [ self.click ]
+               g.selected.get().append(self.push)
                return g
 
+       def removeWidget(self, w):
+               w.selected.get().remove(self.push)
+
+class Label(HTMLComponent, GUIComponent, VariableText):
+       def __init__(self, text=""):
+               GUIComponent.__init__(self)
+               VariableText.__init__(self)
+               self.setText(text)
+       
+# html:        
+       def produceHTML(self):
+               return self.getText()
+
+# GUI:
+       def createWidget(self, parent, skindata):
+               return eLabel(parent)
+       
 class Header(HTMLComponent, GUIComponent, VariableText):
 
        def __init__(self, message):
@@ -136,9 +232,8 @@ class Header(HTMLComponent, GUIComponent, VariableText):
        def produceHTML(self):
                return "<h2>" + self.getText() + "</h2>\n"
 
-       def GUIcreateInstance(self, priv, parent, skindata):
+       def createWidget(self, parent, skindata):
                g = eLabel(parent)
-               g.setText(self.message)
                return g
 
 class VolumeBar(HTMLComponent, GUIComponent, VariableValue):
@@ -147,8 +242,291 @@ class VolumeBar(HTMLComponent, GUIComponent, VariableValue):
                GUIComponent.__init__(self)
                VariableValue.__init__(self)
 
-       def GUIcreateInstance(self, priv, parent, skindata):
+       def createWidget(self, parent, skindata):
+               g = eSlider(parent)
+               g.setRange(0, 100)
+               return g
+               
+# a general purpose progress bar
+class ProgressBar(HTMLComponent, GUIComponent, VariableValue):
+       def __init__(self):
+               GUIComponent.__init__(self)
+               VariableValue.__init__(self)
+
+       def createWidget(self, parent, skindata):
                g = eSlider(parent)
                g.setRange(0, 100)
                return g
+       
+class MenuList(HTMLComponent, GUIComponent):
+       def __init__(self, list):
+               GUIComponent.__init__(self)
+               self.l = eListboxPythonStringContent()
+               self.l.setList(list)
+       
+       def getCurrent(self):
+               return self.l.getCurrentSelection()
+       
+       def GUIcreate(self, parent, skindata):
+               self.instance = eListbox(parent)
+               self.instance.setContent(self.l)
+       
+       def GUIdelete(self):
+               self.instance.setContent(None)
+               self.instance = None
+
+
+#  temp stuff :)
+class configBoolean:
+       def __init__(self, reg):
+               self.reg = reg
+               self.val = 0
+       
+       def toggle(self):
+               self.val += 1
+               self.val %= 3
+       
+       def __str__(self):
+               return ("NO", "YES", "MAYBE")[self.val]
+
+class configValue:
+       def __init__(self, obj):
+               self.obj = obj
+               
+       def __str__(self):
+               return self.obj
+
+def configEntry(obj):
+       # das hier ist ein zugriff auf die registry...
+       if obj == "HKEY_LOCAL_ENIGMA/IMPORTANT/USER_ANNOYING_STUFF/SDTV/FLASHES/GREEN":
+               return ("SDTV green flashes", configBoolean(obj))
+       elif obj == "HKEY_LOCAL_ENIGMA/IMPORTANT/USER_ANNOYING_STUFF/HDTV/FLASHES/GREEN":
+               return ("HDTV reen flashes", configBoolean(obj))
+       else:
+               return ("invalid", "")
+
+class ConfigList(HTMLComponent, GUIComponent):
+       def __init__(self, list):
+               GUIComponent.__init__(self)
+               self.l = eListboxPythonConfigContent()
+               self.l.setList(list)
+               self.l.setSeperation(100)
+       
+       def toggle(self):
+               selection = self.getCurrent()
+               selection[1].toggle()
+               self.invalidateCurrent()
+       
+       def getCurrent(self):
+               return self.l.getCurrentSelection()
+       
+       def invalidateCurrent(self):
+               self.l.invalidateEntry(self.l.getCurrentSelectionIndex())
+       
+       def GUIcreate(self, parent, skindata):
+               self.instance = eListbox(parent)
+               self.instance.setContent(self.l)
+       
+       def GUIdelete(self):
+               self.instance.setContent(None)
+               self.instance = None
+
+class ServiceList(HTMLComponent, GUIComponent):
+       def __init__(self):
+               GUIComponent.__init__(self)
+               self.l = eListboxServiceContent()
+               
+       def getCurrent(self):
+               r = eServiceReference()
+               self.l.getCurrent(r)
+               return r
+               
+       def moveUp(self):
+               self.instance.moveSelection(self.instance.moveUp)
+
+       def moveDown(self):
+               self.instance.moveSelection(self.instance.moveDown)
+
+       def GUIcreate(self, parent, skindata):
+               self.instance = eListbox(parent)
+               self.instance.setContent(self.l)
+       
+       def GUIdelete(self):
+               self.instance = None
+
+       def setRoot(self, root):
+               self.l.setRoot(root)
+               
+               # mark stuff
+       def clearMarked(self):
+               self.l.clearMarked()
+       
+       def isMarked(self, ref):
+               return self.l.isMarked(ref)
+
+       def addMarked(self, ref):
+               self.l.addMarked(ref)
+       
+       def removeMarked(self, ref):
+               self.l.removeMarked(ref)
+
+class ServiceScan:
+       
+       Idle = 1
+       Running = 2
+       Done = 3
+       Error = 4
+       
+       Errors = { 
+               0: "error starting scanning",
+               1: "error while scanning",
+               2: "no resource manager",
+               3: "no channel list"
+               }
+       
+       def scanStatusChanged(self):
+               if self.state == self.Running:
+                       self.progressbar.setValue(self.scan.getProgress())
+                       if self.scan.isDone():
+                               errcode = self.scan.getError()
+                               
+                               if errcode == 0:
+                                       self.state = self.Done
+                               else:
+                                       self.state = self.Error
+                                       self.errorcode = errcode
+                       else:
+                               self.text.setText("scan in progress - %d %% done!\n%d services found!" % (self.scan.getProgress(), self.scan.getNumServices()))
+               
+               if self.state == self.Done:
+                       self.text.setText("scan done!")
+               
+               if self.state == self.Error:
+                       self.text.setText("ERROR - failed to scan (%s)!" % (self.Errors[self.errorcode]) )
+       
+       def __init__(self, progressbar, text):
+               self.progressbar = progressbar
+               self.text = text
+               self.scan = eComponentScan()
+               self.state = self.Idle
+               self.scanStatusChanged()
+               
+       def execBegin(self):
+               self.scan.statusChanged.get().append(self.scanStatusChanged)
+               self.state = self.Running
+               err = self.scan.start()
+               if err:
+                       self.state = self.Error
+                       self.errorcode = 0
+
+               self.scanStatusChanged()
+       
+       def execEnd(self):
+               self.scan.statusChanged.get().remove(self.scanStatusChanged)
+               if not self.isDone():
+                       print "*** warning *** scan was not finished!"
+
+       def isDone(self):
+               print "state is %d " % (self.state)
+               return self.state == self.Done or self.state == self.Error
+       
+class ActionMap:
+       def __init__(self, contexts = [ ], actions = { }, prio=0):
+               self.actions = actions
+               self.contexts = contexts
+               self.prio = prio
+               self.p = eActionMapPtr()
+               eActionMap.getInstance(self.p)
+
+       def execBegin(self):
+               for ctx in self.contexts:
+                       self.p.bindAction(ctx, self.prio, self.action)
+       
+       def execEnd(self):
+               for ctx in self.contexts:
+                       self.p.unbindAction(ctx, self.action)
+       
+       def action(self, context, action):
+               print " ".join(("action -> ", context, action))
+               if self.actions.has_key(action):
+                       self.actions[action]()
+               else:
+                       print "unknown action %s/%s! typo in keymap?" % (context, action)
+
+class PerServiceDisplay(GUIComponent, VariableText):
+       """Mixin for building components which display something which changes on navigation events, for example "service name" """
+       
+       def __init__(self, navcore, eventmap):
+               GUIComponent.__init__(self)
+               VariableText.__init__(self)
+               self.eventmap = eventmap
+               navcore.m_event.get().append(self.event)
+               self.navcore = navcore
+
+               # start with stopped state, so simulate that
+               self.event(pNavigation.evStopService)
+
+       def event(self, ev):
+               # loop up if we need to handle this event
+               if self.eventmap.has_key(ev):
+                       # call handler
+                       self.eventmap[ev]()
+       
+       def createWidget(self, parent, skindata):
+               # by default, we use a label to display our data.
+               g = eLabel(parent)
+               return g
+
+class EventInfo(PerServiceDisplay):
+       Now = 0
+       Next = 1
+       Now_Duration = 2
+       Next_Duration = 3
+       
+       def __init__(self, navcore, now_or_next):
+               # listen to evUpdatedEventInfo and evStopService
+               # note that evStopService will be called once to establish a known state
+               self.now_or_next = now_or_next
+               PerServiceDisplay.__init__(self, navcore, 
+                       { 
+                               pNavigation.evUpdatedEventInfo: self.ourEvent, 
+                               pNavigation.evStopService: self.stopEvent 
+                       })
+
+       def ourEvent(self):
+               info = iServiceInformationPtr()
+               service = iPlayableServicePtr()
+               
+               if not self.navcore.getCurrentService(service):
+                       if not service.info(info):
+                               ev = eServiceEventPtr()
+                               if info.getEvent(ev, self.now_or_next & 1) == 0:
+                                       if self.now_or_next & 2:
+                                               self.setText("%d min" % (ev.m_duration / 60))
+                                       else:
+                                               self.setText(ev.m_event_name)
+               print "new event info in EventInfo! yeah!"
+
+       def stopEvent(self):
+               self.setText(
+                       ("waiting for event data...", "", "--:--",  "--:--")[self.now_or_next]);
+
+class ServiceName(PerServiceDisplay):
+       def __init__(self, navcore):
+               PerServiceDisplay.__init__(self, navcore,
+                       {
+                               pNavigation.evNewService: self.newService,
+                               pNavigation.evStopService: self.stopEvent
+                       })
+
+       def newService(self):
+               info = iServiceInformationPtr()
+               service = iPlayableServicePtr()
+               
+               if not self.navcore.getCurrentService(service):
+                       if not service.info(info):
+                               self.setText("no name known, but it should be here :)")
+       
+       def stopEvent(self):
+                       self.setText("");