Update wx frontend.

IPython/frontend/wx/wx_frontend.py

@@ -0,0 +1,207 b''
+# encoding: utf-8 -*- test-case-name:
+# FIXME: Need to add tests.
+# ipython1.frontend.cocoa.tests.test_cocoa_frontend -*-
+
+"""Classes to provide a Wx frontend to the
+ipython1.kernel.engineservice.EngineService.
+
+"""
+
+__docformat__ = "restructuredtext en"
+
+#-------------------------------------------------------------------------------
+#       Copyright (C) 2008  The IPython Development Team
+#
+#  Distributed under the terms of the BSD License.  The full license is in
+#  the file COPYING, distributed as part of this software.
+#-------------------------------------------------------------------------------
+
+#-------------------------------------------------------------------------------
+# Imports
+#-------------------------------------------------------------------------------
+
+
+import wx
+from console_widget import ConsoleWidget
+import re
+
+import IPython
+from IPython.kernel.engineservice import EngineService
+from IPython.frontend.frontendbase import FrontEndBase
+
+#-------------------------------------------------------------------------------
+# Classes to implement the Wx frontend
+#-------------------------------------------------------------------------------
+
+   
+
+
+class IPythonWxController(FrontEndBase, ConsoleWidget):
+
+    output_prompt = \
+    '\n\x01\x1b[0;31m\x02Out[\x01\x1b[1;31m\x02%i\x01\x1b[0;31m\x02]: \x01\x1b[0m\x02'
+  
+    # Are we entering multi line input?
+    multi_line_input = False
+
+    # The added tab stop to the string. It may, for instance, come from 
+    # copy and pasting something with tabs.
+    tab_stop = 0
+    # FIXME: We still have to deal with this.
+
+    #--------------------------------------------------------------------------
+    # Public API
+    #--------------------------------------------------------------------------
+ 
+    def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition,
+                 size=wx.DefaultSize, style=wx.CLIP_CHILDREN,
+                 *args, **kwds):
+        """ Create Shell instance.
+        """
+        ConsoleWidget.__init__(self, parent, id, pos, size, style)
+        FrontEndBase.__init__(self, engine=EngineService(),
+                                    )
+
+        # FIXME: Something is wrong with the history, I instanciate it
+        # with an empty cache, but this is not the way to do.
+        self.lines = {}
+
+        # Start the IPython engine
+        self.engine.startService()
+        
+        # Capture Character keys
+        self.Bind(wx.EVT_KEY_DOWN, self._on_key_down)
+       
+        #FIXME: print banner.
+        banner = """IPython1 %s -- An enhanced Interactive Python.""" \
+                            % IPython.__version__
+    
+    
+    def appWillTerminate_(self, notification):
+        """appWillTerminate"""
+        
+        self.engine.stopService()
+    
+    
+    def complete(self, token):
+        """Complete token in engine's user_ns
+        
+        Parameters
+        ----------
+        token : string
+        
+        Result
+        ------
+        Deferred result of 
+        IPython.kernel.engineservice.IEngineBase.complete
+        """
+        
+        return self.engine.complete(token)
+    
+    
+    def render_result(self, result):
+        if 'stdout' in result and result['stdout']:
+            self.write('\n' + result['stdout'])
+        if 'display' in result and result['display']:
+            self.write("%s%s\n" % ( 
+                            self.output_prompt % result['number'],
+                            result['display']['pprint']
+                            ) )
+    
+        
+    def render_error(self, failure):
+        self.insert_text('\n\n'+str(failure)+'\n\n')
+        return failure
+    
+    
+    #--------------------------------------------------------------------------
+    # Private API
+    #--------------------------------------------------------------------------
+ 
+
+    def _on_key_down(self, event, skip=True):
+        """ Capture the character events, let the parent
+            widget handle them, and put our logic afterward.
+        """
+        current_line_number = self.GetCurrentLine()
+        # Capture enter
+        if event.KeyCode in (13, wx.WXK_NUMPAD_ENTER) and \
+                event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN):
+            self._on_enter()
+        # Up history
+        elif event.KeyCode == wx.WXK_UP and (
+                ( current_line_number == self.current_prompt_line and
+                    event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN) ) 
+                or event.ControlDown() ):
+            new_buffer = self.get_history_previous(
+                                        self.get_current_edit_buffer())
+            if new_buffer is not None:
+                self.replace_current_edit_buffer(new_buffer)
+        # Down history
+        elif event.KeyCode == wx.WXK_DOWN and (
+                ( current_line_number == self.LineCount -1 and
+                    event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN) ) 
+                or event.ControlDown() ):
+            new_buffer = self.get_history_next()
+            if new_buffer is not None:
+                self.replace_current_edit_buffer(new_buffer)
+        else:
+            ConsoleWidget._on_key_down(self, event, skip=True)
+
+
+    def _on_enter(self):
+        """ Called when the return key is pressed in a line editing
+            buffer.
+        """
+        current_buffer = self.get_current_edit_buffer()
+        current_buffer = current_buffer.replace('\r\n', '\n')
+        current_buffer = current_buffer.replace('\t', 4*' ')
+        cleaned_buffer = '\n'.join(l.rstrip() 
+                        for l in current_buffer.split('\n'))
+        if (    not self.multi_line_input
+                or re.findall(r"\n[\t ]*$", cleaned_buffer)):
+            if self.is_complete(cleaned_buffer):
+                self._add_history(None, cleaned_buffer.rstrip())
+                result = self.engine.shell.execute(cleaned_buffer)
+                self.render_result(result)
+                self.new_prompt(self.prompt % (result['number'] + 1))
+                self.multi_line_input = False
+            else:
+                if self.multi_line_input:
+                    self.write('\n' + self._get_indent_string(current_buffer))
+                else:
+                    self.multi_line_input = True
+                    self.write('\n\t')
+        else:
+            self.write('\n'+self._get_indent_string(current_buffer))
+
+
+    def _get_indent_string(self, string):
+        string = string.split('\n')[-1]
+        indent_chars = len(string) - len(string.lstrip())
+        indent_string = '\t'*(indent_chars // 4) + \
+                            ' '*(indent_chars % 4)
+
+        return indent_string
+ 
+        
+
+if __name__ == '__main__':
+    class MainWindow(wx.Frame):
+        def __init__(self, parent, id, title):
+            wx.Frame.__init__(self, parent, id, title, size=(300,250))
+            self._sizer = wx.BoxSizer(wx.VERTICAL)
+            self.shell = IPythonWxController(self)
+            self._sizer.Add(self.shell, 1, wx.EXPAND)
+            self.SetSizer(self._sizer)
+            self.SetAutoLayout(1)
+            self.Show(True)
+
+    app = wx.PySimpleApp()
+    frame = MainWindow(None, wx.ID_ANY, 'Ipython')
+    frame.shell.SetFocus()
+    frame.SetSize((660, 460))
+    self = frame.shell
+
+    app.MainLoop()
+

IPython/frontend/wx/console_widget.py

@@ -22,21 +22,59 b' __docformat__ = "restructuredtext en"'
 import wx
 import wx.stc  as  stc
 
+from wx.py import editwindow
+
 import re
 
 # FIXME: Need to provide an API for non user-generated display on the
 # screen: this should not be editable by the user.
 
+if wx.Platform == '__WXMSW__':
+    _DEFAULT_SIZE = 80
+else:
+    _DEFAULT_SIZE = 10
+
+_DEFAULT_STYLE = {
+    'stdout'      : 'fore:#0000FF',
+    'stderr'      : 'fore:#007f00',
+    'trace'       : 'fore:#FF0000',
+
+    'default'     : 'size:%d' % _DEFAULT_SIZE,
+    'bracegood'   : 'fore:#FFFFFF,back:#0000FF,bold',
+    'bracebad'    : 'fore:#000000,back:#FF0000,bold',
+
+    # properties for the various Python lexer styles
+    'comment'     : 'fore:#007F00',
+    'number'      : 'fore:#007F7F',
+    'string'      : 'fore:#7F007F,italic',
+    'char'        : 'fore:#7F007F,italic',
+    'keyword'     : 'fore:#00007F,bold',
+    'triple'      : 'fore:#7F0000',
+    'tripledouble': 'fore:#7F0000',
+    'class'       : 'fore:#0000FF,bold,underline',
+    'def'         : 'fore:#007F7F,bold',
+    'operator'    : 'bold',
+
+    }
+
+# new style numbers
+_STDOUT_STYLE = 15
+_STDERR_STYLE = 16
+_TRACE_STYLE  = 17
+
+
 #-------------------------------------------------------------------------------
 # The console widget class
 #-------------------------------------------------------------------------------
-class ConsoleWidget(stc.StyledTextCtrl):
+class ConsoleWidget(editwindow.EditWindow):
     """ Specialized styled text control view for console-like workflow.
 
         This widget is mainly interested in dealing with the prompt and
         keeping the cursor inside the editing line.
     """
 
+    style = _DEFAULT_STYLE.copy()
+
     # Translation table from ANSI escape sequences to color. Override
     # this to specify your colors.
     ANSI_STYLES = {'0;30': [0, 'BLACK'],            '0;31': [1, 'RED'],
@@ -57,6 +95,97 b' class ConsoleWidget(stc.StyledTextCtrl):'
     # Public API
     #--------------------------------------------------------------------------
     
+    def __init__(self, parent, id=wx.ID_ANY, pos=wx.DefaultPosition, 
+                        size=wx.DefaultSize, style=0, 
+                        autocomplete_mode='IPYTHON'):
+        """ Autocomplete_mode: Can be 'IPYTHON' or 'STC'
+            'IPYTHON' show autocompletion the ipython way
+            'STC" show it scintilla text control way
+        """
+        editwindow.EditWindow.__init__(self, parent, id, pos, size, style)
+        self.configure_scintilla()
+
+        # FIXME: we need to retrieve this from the interpreter.
+        self.prompt = \
+            '\n\x01\x1b[0;34m\x02In [\x01\x1b[1;34m\x02%i\x01\x1b[0;34m\x02]: \x01\x1b[0m\x02'
+        self.new_prompt(self.prompt % 1)
+
+        self.autocomplete_mode = autocomplete_mode
+        
+        self.Bind(wx.EVT_KEY_DOWN, self._on_key_down)
+    
+
+    def configure_scintilla(self):
+        # Ctrl"+" or Ctrl "-" can be used to zoomin/zoomout the text inside 
+        # the widget
+        self.CmdKeyAssign(ord('+'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN)
+        self.CmdKeyAssign(ord('-'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT)
+        # Also allow Ctrl Shift "=" for poor non US keyboard users. 
+        self.CmdKeyAssign(ord('='), stc.STC_SCMOD_CTRL|stc.STC_SCMOD_SHIFT, 
+                                            stc.STC_CMD_ZOOMIN)
+        
+        self.CmdKeyAssign(stc.STC_KEY_PRIOR, stc.STC_SCMOD_SHIFT,
+                                            stc.STC_CMD_PAGEUP)
+
+        self.CmdKeyAssign(stc.STC_KEY_NEXT, stc.STC_SCMOD_SHIFT,
+                                            stc.STC_CMD_PAGEDOWN)
+
+        # Keys: we need to clear some of the keys the that don't play
+        # well with a console.
+        self.CmdKeyClear(ord('D'), stc.STC_SCMOD_CTRL)
+        self.CmdKeyClear(ord('L'), stc.STC_SCMOD_CTRL)
+        self.CmdKeyClear(ord('T'), stc.STC_SCMOD_CTRL)
+
+
+        self.SetEOLMode(stc.STC_EOL_CRLF)
+        self.SetWrapMode(stc.STC_WRAP_CHAR)
+        self.SetWrapMode(stc.STC_WRAP_WORD)
+        self.SetBufferedDraw(True)
+        self.SetUseAntiAliasing(True)
+        self.SetLayoutCache(stc.STC_CACHE_PAGE)
+        self.SetUndoCollection(False)
+        self.SetUseTabs(True)
+        self.SetIndent(4)
+        self.SetTabWidth(4)
+
+        self.EnsureCaretVisible()
+        
+        self.SetMargins(3, 3) #text is moved away from border with 3px
+        # Suppressing Scintilla margins
+        self.SetMarginWidth(0, 0)
+        self.SetMarginWidth(1, 0)
+        self.SetMarginWidth(2, 0)
+
+        self._apply_style()
+        
+        self.color_pat = re.compile('\x01?\x1b\[(.*?)m\x02?')
+
+        #self.SetEdgeMode(stc.STC_EDGE_LINE)
+        #self.SetEdgeColumn(80)
+
+        # styles
+        p = self.style
+        self.StyleSetSpec(stc.STC_STYLE_DEFAULT, p['default'])
+        self.StyleClearAll()
+        self.StyleSetSpec(_STDOUT_STYLE, p['stdout'])
+        self.StyleSetSpec(_STDERR_STYLE, p['stderr'])
+        self.StyleSetSpec(_TRACE_STYLE, p['trace'])
+
+        self.StyleSetSpec(stc.STC_STYLE_BRACELIGHT, p['bracegood'])
+        self.StyleSetSpec(stc.STC_STYLE_BRACEBAD, p['bracebad'])
+        self.StyleSetSpec(stc.STC_P_COMMENTLINE, p['comment'])
+        self.StyleSetSpec(stc.STC_P_NUMBER, p['number'])
+        self.StyleSetSpec(stc.STC_P_STRING, p['string'])
+        self.StyleSetSpec(stc.STC_P_CHARACTER, p['char'])
+        self.StyleSetSpec(stc.STC_P_WORD, p['keyword'])
+        self.StyleSetSpec(stc.STC_P_TRIPLE, p['triple'])
+        self.StyleSetSpec(stc.STC_P_TRIPLEDOUBLE, p['tripledouble'])
+        self.StyleSetSpec(stc.STC_P_CLASSNAME, p['class'])
+        self.StyleSetSpec(stc.STC_P_DEFNAME, p['def'])
+        self.StyleSetSpec(stc.STC_P_OPERATOR, p['operator'])
+        self.StyleSetSpec(stc.STC_P_COMMENTBLOCK, p['comment'])
+
+
     def write(self, text):
         """ Write given text to buffer, while translating the ansi escape
             sequences.
@@ -94,10 +223,6 b' class ConsoleWidget(stc.StyledTextCtrl):'
         self.current_prompt_pos = self.GetLength()
         self.current_prompt_line = self.GetCurrentLine()
         
-        autoindent = self.indent * ' '
-        autoindent = autoindent.replace('    ','\t')
-        self.write(autoindent)
-
         
     def replace_current_edit_buffer(self, text):
         """ Replace currently entered command line with given text.
@@ -118,96 +243,10 b' class ConsoleWidget(stc.StyledTextCtrl):'
     # Private API
     #--------------------------------------------------------------------------
     
-    def __init__(self, parent, pos=wx.DefaultPosition, ID=-1, 
-                        size=wx.DefaultSize, style=0, 
-                        autocomplete_mode='IPYTHON'):
-        """ Autocomplete_mode: Can be 'IPYTHON' or 'STC'
-            'IPYTHON' show autocompletion the ipython way
-            'STC" show it scintilla text control way
-        """
-        stc.StyledTextCtrl.__init__(self, parent, ID, pos, size, style)
-
-        #------ Scintilla configuration -----------------------------------
-        
-        # Ctrl"+" or Ctrl "-" can be used to zoomin/zoomout the text inside 
-        # the widget
-        self.CmdKeyAssign(ord('+'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMIN)
-        self.CmdKeyAssign(ord('-'), stc.STC_SCMOD_CTRL, stc.STC_CMD_ZOOMOUT)
-        # Also allow Ctrl Shift "=" for poor non US keyboard users. 
-        self.CmdKeyAssign(ord('='), stc.STC_SCMOD_CTRL|stc.STC_SCMOD_SHIFT, 
-                                            stc.STC_CMD_ZOOMIN)
-
-        self.SetEOLMode(stc.STC_EOL_CRLF)
-        self.SetWrapMode(stc.STC_WRAP_CHAR)
-        self.SetWrapMode(stc.STC_WRAP_WORD)
-        self.SetBufferedDraw(True)
-        self.SetUseAntiAliasing(True)
-        self.SetLayoutCache(stc.STC_CACHE_PAGE)
-        self.SetUndoCollection(False)
-        self.SetUseTabs(True)
-        self.SetIndent(4)
-        self.SetTabWidth(4)
-
-        self.EnsureCaretVisible()
-        
-        self.SetMargins(3, 3) #text is moved away from border with 3px
-        # Suppressing Scintilla margins
-        self.SetMarginWidth(0, 0)
-        self.SetMarginWidth(1, 0)
-        self.SetMarginWidth(2, 0)
-
-        self._apply_style()
-        
-        self.indent = 0
-        self.color_pat = re.compile('\x01?\x1b\[(.*?)m\x02?')
-        
-        # FIXME: we need to retrieve this from the interpreter.
-        self.prompt = \
-            '\n\x01\x1b[0;34m\x02In [\x01\x1b[1;34m\x026\x01\x1b[0;34m\x02]: \x01\x1b[0m\x02'
-        self.new_prompt(self.prompt)
-
-        self.autocomplete_mode = autocomplete_mode
-        
-        self.Bind(wx.EVT_KEY_DOWN, self._onKeypress)
-    
-    
     def _apply_style(self):
         """ Applies the colors for the different text elements and the
             carret.
         """
-        # FIXME: We need to do something for the fonts, but this is
-        # clearly not the right option.
-        #we define platform specific fonts
-#        if wx.Platform == '__WXMSW__':
-#            faces = { 'times': 'Times New Roman',
-#                      'mono' : 'Courier New',
-#                      'helv' : 'Arial',
-#                      'other': 'Comic Sans MS',
-#                      'size' : 10,
-#                      'size2': 8,
-#                     }
-#        elif wx.Platform == '__WXMAC__':
-#            faces = { 'times': 'Times New Roman',
-#                      'mono' : 'Monaco',
-#                      'helv' : 'Arial',
-#                      'other': 'Comic Sans MS',
-#                      'size' : 10,
-#                      'size2': 8,
-#                     }
-#        else:
-#            faces = { 'times': 'Times',
-#                      'mono' : 'Courier',
-#                      'helv' : 'Helvetica',
-#                      'other': 'new century schoolbook',
-#                      'size' : 10,
-#                      'size2': 8,
-#                     }
-#        self.StyleSetSpec(stc.STC_STYLE_DEFAULT, 
-#                          "fore:%s,back:%s,size:%d,face:%s" 
-#                                    % (self.ANSI_STYLES['0;30'][1],
-#                          self.background_color,
-#                          faces['size'], faces['mono']))
-
         self.SetCaretForeground(self.carret_color)
 
         self.StyleClearAll()
@@ -220,7 +259,7 b' class ConsoleWidget(stc.StyledTextCtrl):'
             self.StyleSetSpec(style[0], "bold,fore:%s" % style[1])
 
 
-     def removeFromTo(self, from_pos, to_pos):
+    def removeFromTo(self, from_pos, to_pos):
         if from_pos < to_pos:
             self.SetSelection(from_pos, to_pos)
             self.DeleteBack()
@@ -266,8 +305,13 b' class ConsoleWidget(stc.StyledTextCtrl):'
                 last_word = last_word.split(breaker)[-1]
             self.AutoCompShow(len(last_word), " ".join(possibilities))
 
+    
+    def scroll_to_bottom(self):
+        maxrange = self.GetScrollRange(wx.VERTICAL)
+        self.ScrollLines(maxrange)
+
 
-    def _onKeypress(self, event, skip=True):
+    def _on_key_down(self, event, skip=True):
         """ Key press callback used for correcting behavior for 
             console-like interfaces: the cursor is constraint to be after
             the last prompt.
@@ -275,20 +319,25 b' class ConsoleWidget(stc.StyledTextCtrl):'
             Return True if event as been catched.
         """
         catched = False
+        if event.KeyCode == ord('L') and event.ControlDown() :
+            skip = False
+            catched = True
+            self.scroll_to_bottom()
+
         if self.AutoCompActive():
             event.Skip()
         else:
-            if event.GetKeyCode() == wx.WXK_HOME:
+            if event.KeyCode == wx.WXK_HOME:
                 if event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN):
                     self.GotoPos(self.current_prompt_pos)
                     catched = True
 
-                elif event.Modifiers == wx.MOD_SHIFT:
+                elif event.Modifiers in  (wx.MOD_SHIFT, wx.MOD_WIN) :
                     self.selectFromTo(self.current_prompt_pos, 
                                                         self.GetCurrentPos())
                     catched = True
 
-            elif event.GetKeyCode() == wx.WXK_UP:
+            elif event.KeyCode == wx.WXK_UP:
                 if self.GetCurrentLine() > self.current_prompt_line:
                     if self.GetCurrentLine() == self.current_prompt_line + 1 \
                             and self.GetColumn(self.GetCurrentPos()) < \
@@ -298,7 +347,7 b' class ConsoleWidget(stc.StyledTextCtrl):'
                         event.Skip()
                 catched = True
 
-            elif event.GetKeyCode() in (wx.WXK_LEFT, wx.WXK_BACK):
+            elif event.KeyCode in (wx.WXK_LEFT, wx.WXK_BACK):
                 if self.GetCurrentPos() > self.current_prompt_pos:
                     event.Skip()
                 catched = True
@@ -306,7 +355,7 b' class ConsoleWidget(stc.StyledTextCtrl):'
             if skip and not catched:
                 event.Skip()
 
-            if event.GetKeyCode() not in (wx.WXK_PAGEUP, wx.WXK_PAGEDOWN)\
+            if event.KeyCode not in (wx.WXK_PAGEUP, wx.WXK_PAGEDOWN)\
                     and event.Modifiers in (wx.MOD_NONE, wx.MOD_WIN,
                                                             wx.MOD_SHIFT):
                 # If cursor is outside the editing region, put it back.
@@ -316,37 +365,6 b' class ConsoleWidget(stc.StyledTextCtrl):'
         return catched
 
 
-    def OnUpdateUI(self, evt):
-        # check for matching braces
-        braceAtCaret = -1
-        braceOpposite = -1
-        charBefore = None
-        caretPos = self.GetCurrentPos()
-
-        if caretPos > 0:
-            charBefore = self.GetCharAt(caretPos - 1)
-            styleBefore = self.GetStyleAt(caretPos - 1)
-
-        # check before
-        if charBefore and chr(charBefore) in "[]{}()" and styleBefore == stc.STC_P_OPERATOR:
-            braceAtCaret = caretPos - 1
-
-        # check after
-        if braceAtCaret < 0:
-            charAfter = self.GetCharAt(caretPos)
-            styleAfter = self.GetStyleAt(caretPos)
-
-            if charAfter and chr(charAfter) in "[]{}()" and styleAfter == stc.STC_P_OPERATOR:
-                braceAtCaret = caretPos
-
-        if braceAtCaret >= 0:
-            braceOpposite = self.BraceMatch(braceAtCaret)
-
-        if braceAtCaret != -1  and braceOpposite == -1:
-            self.BraceBadLight(braceAtCaret)
-        else:
-            self.BraceHighlight(braceAtCaret, braceOpposite)
-
 
 if __name__ == '__main__':
     # Some simple code to test the console widget.