#@+leo-ver=5-thin
#@+node:ekr.20170428084207.29: * @file ../external/npyscreen/apNPSApplicationManaged.py
#!/usr/bin/env python
# encoding: utf-8
#@+others
#@+node:ekr.20170428084207.30: ** Declarations
"""
NPSAppManaged.py
"""
from . import apNPSApplication
# from . import fmForm
import weakref

#@+node:ekr.20170428084207.31: ** class NPSAppManaged
class NPSAppManaged(apNPSApplication.NPSApp):
    """This class is intended to make it easier to program applications with many screens:

    1. The programmer should not now select which 'Form' to display himself.  Instead, he should set the NEXT_ACTIVE_FORM class variable.
       See the registerForm method for details.

       Doing this will avoid accidentally exceeding the maximum recursion depth.  Forms themselves should be placed under the management
       of the class using the 'addForm' or 'addFormClass' method.

       NB.  * Applications should therefore use this mechanism in preference to calling the .edit() method of any form. *

    2. Forms that are managed by this class can access a proxy to the parent application through their ".parentApp" attribute, which is
       created by this class.

    3. a Optionally, Forms managed by this class may be given an .activate method, which will be called instead of their .edit loop

       b If not given an .activate method, any .afterEditing method which a form possesses will be called after .edit() has exited.
         3b is the preferred method to change NEXT_ACTIVE_FORM

    4. The method onInMainLoop is called after each screen has exited. This can be overridden.

    5. This method should be able to see which screen was last active using the self._LAST_NEXT_ACTIVE_FORM attribute, which is only set
       just before each screen is displayed.

    6. Unless you override the attribute STARTING_FORM, the first form to be called should be named 'MAIN'

    7. Do override the onStart and onCleanExit functions if you wish.

    """

    STARTING_FORM = "MAIN"

    #@+others
    #@+node:ekr.20170428084207.32: *3* __init__
    def __init__(self):
        super(NPSAppManaged, self).__init__()
        self._FORM_VISIT_LIST = []
        self.NEXT_ACTIVE_FORM = self.__class__.STARTING_FORM
        self._LAST_NEXT_ACTIVE_FORM = None
        self._Forms = {}

    #@+node:ekr.20170428084207.33: *3* addFormClass
    def addFormClass(self, f_id, FormClass, *args, **keywords):
        self._Forms[f_id] = [FormClass, args, keywords]

    #@+node:ekr.20170428084207.34: *3* addForm
    def addForm(self, f_id, FormClass, *args, **keywords):
        """Create a form of the given class. f_id should be a string which will uniquely identify the form. *args will be passed to the Form constructor.
        Forms created in this way are handled entirely by the NPSAppManaged class."""
        fm = FormClass( parentApp=self, *args, **keywords)
        self.registerForm(f_id, fm)
        return weakref.proxy(fm)

    #@+node:ekr.20170428084207.35: *3* registerForm
    def registerForm(self, f_id, fm):
        """f_id should be a string which should uniquely identify the form.  fm should be a Form."""
        fm.parentApp = weakref.proxy(self)
        self._Forms[f_id] = fm

    #@+node:ekr.20170428084207.36: *3* removeForm
    def removeForm(self, f_id):
        del self._Forms[f_id].parentApp
        del self._Forms[f_id]

    #@+node:ekr.20170428084207.37: *3* getForm
    def getForm(self, name):
        f = self._Forms[name]
        try:
            return weakref.proxy(f)
        except Exception:
            return f

    #@+node:ekr.20170428084207.38: *3* setNextForm
    def setNextForm(self, fmid):
        """Set the form that will be selected when the current one exits."""
        self.NEXT_ACTIVE_FORM = fmid

    #@+node:ekr.20170428084207.39: *3* NPSAppManaged.switchForm
    def switchForm(self, fmid):
        """Immediately switch to the form specified by fmid."""
        self._THISFORM.editing = False
        self.setNextForm(fmid)
        self.switchFormNow()

    #@+node:ekr.20170428084207.40: *3* NPSAppManaged.switchFormNow
    def switchFormNow(self):
        self._THISFORM.editing = False
        try:
            self._THISFORM._widgets__[self._THISFORM.editw].editing = False
        except (AttributeError, IndexError):
            pass
        # Following is necessary to stop two keypresses being needed for titlefields
        try:
            self._THISFORM._widgets__[self._THISFORM.editw].entry_widget.editing = False
        except (AttributeError, IndexError):
            pass

    #@+node:ekr.20170428084207.41: *3* removeLastFormFromHistory
    def removeLastFormFromHistory(self):
        self._FORM_VISIT_LIST.pop()
        self._FORM_VISIT_LIST.pop()

    #@+node:ekr.20170428084207.42: *3* switchFormPrevious
    def switchFormPrevious(self, backup=STARTING_FORM):
        self.setNextFormPrevious()
        self.switchFormNow()

    #@+node:ekr.20170428084207.43: *3* setNextFormPrevious
    def setNextFormPrevious(self, backup=STARTING_FORM):
        try:
            if self._THISFORM.FORM_NAME == self._FORM_VISIT_LIST[-1]:
                self._FORM_VISIT_LIST.pop() # Remove the current form. if it is at the end of the list
            if self._THISFORM.FORM_NAME == self.NEXT_ACTIVE_FORM:
                #take no action if it looks as if someone has already set the next form.
                self.setNextForm(self._FORM_VISIT_LIST.pop()) # Switch to the previous form if one exists
        except IndexError:
            self.setNextForm(backup)

    #@+node:ekr.20170428084207.44: *3* getHistory
    def getHistory(self):
        return self._FORM_VISIT_LIST


    #@+node:ekr.20170428084207.45: *3* resetHistory
    def resetHistory(self):
        self._FORM_VISIT_LIST = []



    #@+node:ekr.20170428084207.46: *3* main
    def main(self):
        """
        This function starts the application. It is usually called indirectly through the function .run().
        You should not override this function, but override the onInMainLoop, onStart and
        onCleanExit methods instead, if you need to modify the application's behaviour.

        When this method is called, it will activate the form named by the class variable STARTING_FORM.  By default this Form will be called
        'MAIN'.

        When that form exits (user selecting an ok button or the like), the form named by object variable NEXT_ACTIVE_FORM will be activated.

        If NEXT_ACTIVE_FORM is None, the main() loop will exit.

        The form selected will be edited using it's .edit() method UNLESS it has been provided with an .activate() method,
        in which case that method will be called instead.  This is done so that the same class of form can be made
        NPSAppManaged aware and have the normal non-NPSAppManaged edit loop.

        After a Form has been edited, if it has an .afterEditing method, this will be called, unless it was invoked with the activate() method.
        A similar .beforeEditing method will be called if it exists before editing the form.  Again, the presence of a .activate method
        will override this behaviour.

        Note that NEXT_ACTIVE_FORM is a string that is the name of the form that was specified when .addForm or .registerForm was called.
        """

        self.onStart()
        while self.NEXT_ACTIVE_FORM != "" and self.NEXT_ACTIVE_FORM != None:
            self._LAST_NEXT_ACTIVE_FORM = self._Forms[self.NEXT_ACTIVE_FORM]
            self.LAST_ACTIVE_FORM_NAME = self.NEXT_ACTIVE_FORM
            try:
                Fm, a, k = self._Forms[self.NEXT_ACTIVE_FORM]
                self._THISFORM = Fm( parentApp = self, *a, **k )
            except TypeError:
                self._THISFORM = self._Forms[self.NEXT_ACTIVE_FORM]
            self._THISFORM.FORM_NAME = self.NEXT_ACTIVE_FORM
            self.ACTIVE_FORM_NAME = self.NEXT_ACTIVE_FORM
            if len(self._FORM_VISIT_LIST) > 0:
                if self._FORM_VISIT_LIST[-1] != self.NEXT_ACTIVE_FORM:
                    self._FORM_VISIT_LIST.append(self.NEXT_ACTIVE_FORM)
            else:
                self._FORM_VISIT_LIST.append(self.NEXT_ACTIVE_FORM)
            #self._THISFORM._resize()
            if hasattr(self._THISFORM, "activate"):
                self._THISFORM._resize()
                self._THISFORM.activate()
            else:
                if hasattr(self._THISFORM, "beforeEditing"):
                    self._THISFORM.beforeEditing()
                self._THISFORM._resize()
                self._THISFORM.edit()
                if hasattr(self._THISFORM, "afterEditing"):
                    self._THISFORM.afterEditing()

            self.onInMainLoop()
        self.onCleanExit()

    #@+node:ekr.20170428084207.47: *3* onInMainLoop
    def onInMainLoop(self):
        """Called between each screen while the application is running. Not called before the first screen. Override at will"""

    #@+node:ekr.20170428084207.48: *3* onStart
    def onStart(self):
        """Override this method to perform any initialisation."""
        pass

    #@+node:ekr.20170428084207.49: *3* onCleanExit
    def onCleanExit(self):
        """Override this method to perform any cleanup when application is exiting without error."""


    #@-others
#@-others
#@@language python
#@@tabwidth -4
#@-leo
