Merged ipython-frontend branch. All changes in IPython.frontend except for updates to IPython.kernel.engineservice.ThreadedEngineService and associated tests.

IPython/frontend/cocoa/cocoa_frontend.py

@@ -0,0 +1,425 b''
+# encoding: utf-8
+# -*- test-case-name: IPython.frontend.cocoa.tests.test_cocoa_frontend -*-
+
+"""PyObjC classes to provide a Cocoa frontend to the 
+IPython.kernel.engineservice.IEngineBase.
+
+To add an IPython interpreter to a cocoa app, instantiate an 
+IPythonCocoaController in a XIB and connect its textView outlet to an
+NSTextView instance in your UI. That's it.
+
+Author: Barry Wark
+"""
+
+__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 objc
+import uuid
+
+from Foundation import NSObject, NSMutableArray, NSMutableDictionary,\
+                        NSLog, NSNotificationCenter, NSMakeRange,\
+                        NSLocalizedString, NSIntersectionRange
+                        
+from AppKit import NSApplicationWillTerminateNotification, NSBeep,\
+                    NSTextView, NSRulerView, NSVerticalRuler
+
+from pprint import saferepr
+
+import IPython
+from IPython.kernel.engineservice import ThreadedEngineService
+from IPython.frontend.frontendbase import FrontEndBase
+
+from twisted.internet.threads import blockingCallFromThread
+from twisted.python.failure import Failure
+
+#------------------------------------------------------------------------------
+# Classes to implement the Cocoa frontend
+#------------------------------------------------------------------------------
+
+# TODO: 
+#   1. use MultiEngineClient and out-of-process engine rather than 
+#       ThreadedEngineService?
+#   2. integrate Xgrid launching of engines
+        
+    
+
+
+class IPythonCocoaController(NSObject, FrontEndBase):
+    userNS = objc.ivar() #mirror of engine.user_ns (key=>str(value))
+    waitingForEngine = objc.ivar().bool()
+    textView = objc.IBOutlet()
+    
+    def init(self):
+        self = super(IPythonCocoaController, self).init()
+        FrontEndBase.__init__(self, engine=ThreadedEngineService())
+        if(self != None):
+            self._common_init()
+        
+        return self
+    
+    def _common_init(self):
+        """_common_init"""
+        
+        self.userNS = NSMutableDictionary.dictionary()
+        self.waitingForEngine = False
+        
+        self.lines = {}
+        self.tabSpaces = 4
+        self.tabUsesSpaces = True
+        self.currentBlockID = self.next_block_ID()
+        self.blockRanges = {} # blockID=>NSRange
+    
+    
+    def awakeFromNib(self):
+        """awakeFromNib"""
+        
+        self._common_init()
+        
+        # Start the IPython engine
+        self.engine.startService()
+        NSLog('IPython engine started')
+        
+        # Register for app termination
+        nc = NSNotificationCenter.defaultCenter()
+        nc.addObserver_selector_name_object_(
+                                    self,
+                                    'appWillTerminate:',
+                                    NSApplicationWillTerminateNotification,
+                                    None)
+        
+        self.textView.setDelegate_(self)
+        self.textView.enclosingScrollView().setHasVerticalRuler_(True)
+        r = NSRulerView.alloc().initWithScrollView_orientation_(
+                                        self.textView.enclosingScrollView(),
+                                        NSVerticalRuler)
+        self.verticalRulerView = r
+        self.verticalRulerView.setClientView_(self.textView)
+        self._start_cli_banner()
+    
+    
+    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 execute(self, block, blockID=None):
+        self.waitingForEngine = True
+        self.willChangeValueForKey_('commandHistory')
+        d = super(IPythonCocoaController, self).execute(block, blockID)
+        d.addBoth(self._engine_done)
+        d.addCallback(self._update_user_ns)
+        
+        return d
+    
+        
+    def _engine_done(self, x):
+        self.waitingForEngine = False
+        self.didChangeValueForKey_('commandHistory')
+        return x
+    
+    def _update_user_ns(self, result):
+        """Update self.userNS from self.engine's namespace"""
+        d = self.engine.keys()
+        d.addCallback(self._get_engine_namespace_values_for_keys)
+        
+        return result
+    
+    
+    def _get_engine_namespace_values_for_keys(self, keys):
+        d = self.engine.pull(keys)
+        d.addCallback(self._store_engine_namespace_values, keys=keys)
+    
+    
+    def _store_engine_namespace_values(self, values, keys=[]):
+        assert(len(values) == len(keys))
+        self.willChangeValueForKey_('userNS')
+        for (k,v) in zip(keys,values):
+            self.userNS[k] = saferepr(v)
+        self.didChangeValueForKey_('userNS')
+    
+    
+    def update_cell_prompt(self, result):
+        if(isinstance(result, Failure)):
+            blockID = result.blockID
+        else:
+            blockID = result['blockID']
+        
+        
+        self.insert_text(self.input_prompt(result=result),
+                textRange=NSMakeRange(self.blockRanges[blockID].location,0),
+                scrollToVisible=False
+                )
+        
+        return result
+    
+    
+    def render_result(self, result):
+        blockID = result['blockID']
+        inputRange = self.blockRanges[blockID]
+        del self.blockRanges[blockID]
+        
+        #print inputRange,self.current_block_range()
+        self.insert_text('\n' +
+                self.output_prompt(result) +
+                result.get('display',{}).get('pprint','') +
+                '\n\n',
+                textRange=NSMakeRange(inputRange.location+inputRange.length,
+                                    0))
+        return result
+    
+        
+    def render_error(self, failure):
+        self.insert_text('\n\n'+str(failure)+'\n\n')
+        self.start_new_block()
+        return failure
+    
+    
+    def _start_cli_banner(self):
+        """Print banner"""
+        
+        banner = """IPython1 %s -- An enhanced Interactive Python.""" % \
+                    IPython.__version__
+        
+        self.insert_text(banner + '\n\n')
+    
+    
+    def start_new_block(self):
+        """"""
+        
+        self.currentBlockID = self.next_block_ID()
+    
+    
+    
+    def next_block_ID(self):
+        
+        return uuid.uuid4()
+    
+    def current_block_range(self):
+        return self.blockRanges.get(self.currentBlockID, 
+                        NSMakeRange(self.textView.textStorage().length(), 
+                        0))
+    
+    def current_block(self):
+        """The current block's text"""
+        
+        return self.text_for_range(self.current_block_range())
+    
+    def text_for_range(self, textRange):
+        """text_for_range"""
+        
+        ts = self.textView.textStorage()
+        return ts.string().substringWithRange_(textRange)
+    
+    def current_line(self):
+        block = self.text_for_range(self.current_block_range())
+        block = block.split('\n')
+        return block[-1]
+    
+    
+    def insert_text(self, string=None, textRange=None, scrollToVisible=True):
+        """Insert text into textView at textRange, updating blockRanges 
+        as necessary
+        """
+        
+        if(textRange == None):
+            #range for end of text
+            textRange = NSMakeRange(self.textView.textStorage().length(), 0) 
+        
+        for r in self.blockRanges.itervalues():
+            intersection = NSIntersectionRange(r,textRange)
+            if(intersection.length == 0): #ranges don't intersect
+                if r.location >= textRange.location:
+                    r.location += len(string)
+            else: #ranges intersect
+                if(r.location <= textRange.location):
+                    assert(intersection.length == textRange.length)
+                    r.length += textRange.length
+                else:
+                    r.location += intersection.length
+        
+        self.textView.replaceCharactersInRange_withString_(
+            textRange, string)
+        self.textView.setSelectedRange_(
+            NSMakeRange(textRange.location+len(string), 0))
+        if(scrollToVisible):
+            self.textView.scrollRangeToVisible_(textRange)
+        
+    
+    
+    
+    def replace_current_block_with_string(self, textView, string):
+        textView.replaceCharactersInRange_withString_(
+                                                self.current_block_range(),
+                                                string)
+        self.current_block_range().length = len(string)
+        r = NSMakeRange(textView.textStorage().length(), 0)
+        textView.scrollRangeToVisible_(r)
+        textView.setSelectedRange_(r)
+    
+    
+    def current_indent_string(self):
+        """returns string for indent or None if no indent"""
+        
+        if(len(self.current_block()) > 0):
+            lines = self.current_block().split('\n')
+            currentIndent = len(lines[-1]) - len(lines[-1])
+            if(currentIndent == 0):
+                currentIndent = self.tabSpaces
+        
+            if(self.tabUsesSpaces):
+                result = ' ' * currentIndent
+            else:
+                result = '\t' * (currentIndent/self.tabSpaces)
+        else:
+            result = None
+        
+        return result
+    
+    
+    # NSTextView delegate methods...
+    def textView_doCommandBySelector_(self, textView, selector):
+        assert(textView == self.textView)
+        NSLog("textView_doCommandBySelector_: "+selector)
+        
+        
+        if(selector == 'insertNewline:'):
+            indent = self.current_indent_string()
+            if(indent):
+                line = indent + self.current_line()
+            else:
+                line = self.current_line()
+            
+            if(self.is_complete(self.current_block())):
+                self.execute(self.current_block(),
+                                blockID=self.currentBlockID)
+                self.start_new_block()
+                
+                return True
+            
+            return False
+        
+        elif(selector == 'moveUp:'):
+            prevBlock = self.get_history_previous(self.current_block())
+            if(prevBlock != None):
+                self.replace_current_block_with_string(textView, prevBlock)
+            else:
+                NSBeep()
+            return True
+        
+        elif(selector == 'moveDown:'):
+            nextBlock = self.get_history_next()
+            if(nextBlock != None):
+                self.replace_current_block_with_string(textView, nextBlock)
+            else:
+                NSBeep()
+            return True
+        
+        elif(selector == 'moveToBeginningOfParagraph:'):
+            textView.setSelectedRange_(NSMakeRange(
+                                        self.current_block_range().location, 
+                                        0))
+            return True
+        elif(selector == 'moveToEndOfParagraph:'):
+            textView.setSelectedRange_(NSMakeRange(
+                                    self.current_block_range().location + \
+                                    self.current_block_range().length, 0))
+            return True
+        elif(selector == 'deleteToEndOfParagraph:'):
+            if(textView.selectedRange().location <= \
+                self.current_block_range().location):
+                # Intersect the selected range with the current line range
+                if(self.current_block_range().length < 0):
+                    self.blockRanges[self.currentBlockID].length = 0
+            
+                r = NSIntersectionRange(textView.rangesForUserTextChange()[0],
+                                        self.current_block_range())
+                
+                if(r.length > 0): #no intersection
+                    textView.setSelectedRange_(r)
+            
+            return False # don't actually handle the delete
+        
+        elif(selector == 'insertTab:'):
+            if(len(self.current_line().strip()) == 0): #only white space
+                return False
+            else:
+                self.textView.complete_(self)
+                return True
+        
+        elif(selector == 'deleteBackward:'):
+            #if we're at the beginning of the current block, ignore
+            if(textView.selectedRange().location == \
+                self.current_block_range().location):
+                return True
+            else:
+                self.current_block_range().length-=1
+                return False
+        return False
+    
+    
+    def textView_shouldChangeTextInRanges_replacementStrings_(self, 
+        textView, ranges, replacementStrings):
+        """
+        Delegate method for NSTextView.
+        
+        Refuse change text in ranges not at end, but make those changes at 
+        end.
+        """
+        
+        assert(len(ranges) == len(replacementStrings))
+        allow = True
+        for r,s in zip(ranges, replacementStrings):
+            r = r.rangeValue()
+            if(textView.textStorage().length() > 0 and
+                    r.location < self.current_block_range().location):
+                self.insert_text(s)
+                allow = False
+            
+            
+            self.blockRanges.setdefault(self.currentBlockID, 
+                                        self.current_block_range()).length +=\
+                                         len(s)
+        
+        return allow
+    
+    def textView_completions_forPartialWordRange_indexOfSelectedItem_(self, 
+        textView, words, charRange, index):
+        try:
+            ts = textView.textStorage()
+            token = ts.string().substringWithRange_(charRange)
+            completions = blockingCallFromThread(self.complete, token)
+        except:
+            completions = objc.nil
+            NSBeep()
+        
+        return (completions,0)
+    
+

IPython/frontend/cocoa/examples/IPython1Sandbox/IPython1Sandbox.xcodeproj/project.pbxproj

@@ -0,0 +1,293 b''
+// !$*UTF8*$!
+{
+	archiveVersion = 1;
+	classes = {
+	};
+	objectVersion = 44;
+	objects = {
+
+/* Begin PBXBuildFile section */
+		77631A270C06C501005415CB /* Python.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 77631A260C06C501005415CB /* Python.framework */; };
+		77631A3F0C0748CF005415CB /* main.py in Resources */ = {isa = PBXBuildFile; fileRef = 77631A3E0C0748CF005415CB /* main.py */; };
+		7790198F0C07548A00326F66 /* IPython1SandboxAppDelegate.py in Resources */ = {isa = PBXBuildFile; fileRef = 7790198E0C07548A00326F66 /* IPython1SandboxAppDelegate.py */; };
+		77C8C1F90C07829500965286 /* MainMenu.xib in Resources */ = {isa = PBXBuildFile; fileRef = 77C8C1F70C07829500965286 /* MainMenu.xib */; };
+		8D11072B0486CEB800E47090 /* InfoPlist.strings in Resources */ = {isa = PBXBuildFile; fileRef = 089C165CFE840E0CC02AAC07 /* InfoPlist.strings */; };
+		8D11072D0486CEB800E47090 /* main.m in Sources */ = {isa = PBXBuildFile; fileRef = 29B97316FDCFA39411CA2CEA /* main.m */; settings = {ATTRIBUTES = (); }; };
+		8D11072F0486CEB800E47090 /* Cocoa.framework in Frameworks */ = {isa = PBXBuildFile; fileRef = 1058C7A1FEA54F0111CA2CBB /* Cocoa.framework */; };
+/* End PBXBuildFile section */
+
+/* Begin PBXFileReference section */
+		089C165DFE840E0CC02AAC07 /* English */ = {isa = PBXFileReference; fileEncoding = 10; lastKnownFileType = text.plist.strings; name = English; path = English.lproj/InfoPlist.strings; sourceTree = "<group>"; };
+		1058C7A1FEA54F0111CA2CBB /* Cocoa.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Cocoa.framework; path = /System/Library/Frameworks/Cocoa.framework; sourceTree = "<absolute>"; };
+		13E42FB307B3F0F600E4EEF1 /* CoreData.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = CoreData.framework; path = /System/Library/Frameworks/CoreData.framework; sourceTree = "<absolute>"; };
+		29B97316FDCFA39411CA2CEA /* main.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = main.m; sourceTree = "<group>"; };
+		29B97324FDCFA39411CA2CEA /* AppKit.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = AppKit.framework; path = /System/Library/Frameworks/AppKit.framework; sourceTree = "<absolute>"; };
+		29B97325FDCFA39411CA2CEA /* Foundation.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Foundation.framework; path = /System/Library/Frameworks/Foundation.framework; sourceTree = "<absolute>"; };
+		32CA4F630368D1EE00C91783 /* IPython1Sandbox_Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = IPython1Sandbox_Prefix.pch; sourceTree = "<group>"; };
+		4CA32F870D8879B100311764 /* IPythonCocoaController Tests-Info.plist */ = {isa = PBXFileReference; lastKnownFileType = text.plist.xml; path = "IPythonCocoaController Tests-Info.plist"; sourceTree = "<group>"; };
+		77631A260C06C501005415CB /* Python.framework */ = {isa = PBXFileReference; lastKnownFileType = wrapper.framework; name = Python.framework; path = /System/Library/Frameworks/Python.framework; sourceTree = "<absolute>"; };
+		77631A3E0C0748CF005415CB /* main.py */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.python; path = main.py; sourceTree = "<group>"; };
+		7790198E0C07548A00326F66 /* IPython1SandboxAppDelegate.py */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.script.python; path = IPython1SandboxAppDelegate.py; sourceTree = "<group>"; };
+		77C8C1F80C07829500965286 /* English */ = {isa = PBXFileReference; lastKnownFileType = file.xib; name = English; path = English.lproj/MainMenu.xib; sourceTree = "<group>"; };
+		8D1107310486CEB800E47090 /* Info.plist */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.plist.xml; path = Info.plist; sourceTree = "<group>"; };
+		8D1107320486CEB800E47090 /* IPython1Sandbox.app */ = {isa = PBXFileReference; explicitFileType = wrapper.application; includeInIndex = 0; path = IPython1Sandbox.app; sourceTree = BUILT_PRODUCTS_DIR; };
+/* End PBXFileReference section */
+
+/* Begin PBXFrameworksBuildPhase section */
+		8D11072E0486CEB800E47090 /* Frameworks */ = {
+			isa = PBXFrameworksBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				8D11072F0486CEB800E47090 /* Cocoa.framework in Frameworks */,
+				77631A270C06C501005415CB /* Python.framework in Frameworks */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXFrameworksBuildPhase section */
+
+/* Begin PBXGroup section */
+		080E96DDFE201D6D7F000001 /* Classes */ = {
+			isa = PBXGroup;
+			children = (
+				7790198E0C07548A00326F66 /* IPython1SandboxAppDelegate.py */,
+			);
+			name = Classes;
+			sourceTree = "<group>";
+		};
+		1058C7A0FEA54F0111CA2CBB /* Linked Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+				77631A260C06C501005415CB /* Python.framework */,
+				1058C7A1FEA54F0111CA2CBB /* Cocoa.framework */,
+			);
+			name = "Linked Frameworks";
+			sourceTree = "<group>";
+		};
+		1058C7A2FEA54F0111CA2CBB /* Other Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+				29B97324FDCFA39411CA2CEA /* AppKit.framework */,
+				13E42FB307B3F0F600E4EEF1 /* CoreData.framework */,
+				29B97325FDCFA39411CA2CEA /* Foundation.framework */,
+			);
+			name = "Other Frameworks";
+			sourceTree = "<group>";
+		};
+		19C28FACFE9D520D11CA2CBB /* Products */ = {
+			isa = PBXGroup;
+			children = (
+				8D1107320486CEB800E47090 /* IPython1Sandbox.app */,
+			);
+			name = Products;
+			sourceTree = "<group>";
+		};
+		29B97314FDCFA39411CA2CEA /* IPython1Sandbox */ = {
+			isa = PBXGroup;
+			children = (
+				080E96DDFE201D6D7F000001 /* Classes */,
+				29B97315FDCFA39411CA2CEA /* Other Sources */,
+				29B97317FDCFA39411CA2CEA /* Resources */,
+				29B97323FDCFA39411CA2CEA /* Frameworks */,
+				19C28FACFE9D520D11CA2CBB /* Products */,
+				4CA32F870D8879B100311764 /* IPythonCocoaController Tests-Info.plist */,
+			);
+			name = IPython1Sandbox;
+			sourceTree = "<group>";
+		};
+		29B97315FDCFA39411CA2CEA /* Other Sources */ = {
+			isa = PBXGroup;
+			children = (
+				32CA4F630368D1EE00C91783 /* IPython1Sandbox_Prefix.pch */,
+				29B97316FDCFA39411CA2CEA /* main.m */,
+				77631A3E0C0748CF005415CB /* main.py */,
+			);
+			name = "Other Sources";
+			sourceTree = "<group>";
+		};
+		29B97317FDCFA39411CA2CEA /* Resources */ = {
+			isa = PBXGroup;
+			children = (
+				77C8C1F70C07829500965286 /* MainMenu.xib */,
+				8D1107310486CEB800E47090 /* Info.plist */,
+				089C165CFE840E0CC02AAC07 /* InfoPlist.strings */,
+			);
+			name = Resources;
+			sourceTree = "<group>";
+		};
+		29B97323FDCFA39411CA2CEA /* Frameworks */ = {
+			isa = PBXGroup;
+			children = (
+				1058C7A0FEA54F0111CA2CBB /* Linked Frameworks */,
+				1058C7A2FEA54F0111CA2CBB /* Other Frameworks */,
+			);
+			name = Frameworks;
+			sourceTree = "<group>";
+		};
+/* End PBXGroup section */
+
+/* Begin PBXNativeTarget section */
+		8D1107260486CEB800E47090 /* IPython1Sandbox */ = {
+			isa = PBXNativeTarget;
+			buildConfigurationList = C01FCF4A08A954540054247B /* Build configuration list for PBXNativeTarget "IPython1Sandbox" */;
+			buildPhases = (
+				8D1107290486CEB800E47090 /* Resources */,
+				8D11072C0486CEB800E47090 /* Sources */,
+				8D11072E0486CEB800E47090 /* Frameworks */,
+			);
+			buildRules = (
+			);
+			dependencies = (
+			);
+			name = IPython1Sandbox;
+			productInstallPath = "$(HOME)/Applications";
+			productName = IPython1Sandbox;
+			productReference = 8D1107320486CEB800E47090 /* IPython1Sandbox.app */;
+			productType = "com.apple.product-type.application";
+		};
+/* End PBXNativeTarget section */
+
+/* Begin PBXProject section */
+		29B97313FDCFA39411CA2CEA /* Project object */ = {
+			isa = PBXProject;
+			buildConfigurationList = C01FCF4E08A954540054247B /* Build configuration list for PBXProject "IPython1Sandbox" */;
+			compatibilityVersion = "Xcode 3.0";
+			hasScannedForEncodings = 1;
+			mainGroup = 29B97314FDCFA39411CA2CEA /* IPython1Sandbox */;
+			projectDirPath = "";
+			projectRoot = "";
+			targets = (
+				8D1107260486CEB800E47090 /* IPython1Sandbox */,
+			);
+		};
+/* End PBXProject section */
+
+/* Begin PBXResourcesBuildPhase section */
+		8D1107290486CEB800E47090 /* Resources */ = {
+			isa = PBXResourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				8D11072B0486CEB800E47090 /* InfoPlist.strings in Resources */,
+				77631A3F0C0748CF005415CB /* main.py in Resources */,
+				7790198F0C07548A00326F66 /* IPython1SandboxAppDelegate.py in Resources */,
+				77C8C1F90C07829500965286 /* MainMenu.xib in Resources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXResourcesBuildPhase section */
+
+/* Begin PBXSourcesBuildPhase section */
+		8D11072C0486CEB800E47090 /* Sources */ = {
+			isa = PBXSourcesBuildPhase;
+			buildActionMask = 2147483647;
+			files = (
+				8D11072D0486CEB800E47090 /* main.m in Sources */,
+			);
+			runOnlyForDeploymentPostprocessing = 0;
+		};
+/* End PBXSourcesBuildPhase section */
+
+/* Begin PBXVariantGroup section */
+		089C165CFE840E0CC02AAC07 /* InfoPlist.strings */ = {
+			isa = PBXVariantGroup;
+			children = (
+				089C165DFE840E0CC02AAC07 /* English */,
+			);
+			name = InfoPlist.strings;
+			sourceTree = "<group>";
+		};
+		77C8C1F70C07829500965286 /* MainMenu.xib */ = {
+			isa = PBXVariantGroup;
+			children = (
+				77C8C1F80C07829500965286 /* English */,
+			);
+			name = MainMenu.xib;
+			sourceTree = "<group>";
+		};
+/* End PBXVariantGroup section */
+
+/* Begin XCBuildConfiguration section */
+		C01FCF4B08A954540054247B /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				COPY_PHASE_STRIP = NO;
+				CURRENT_PROJECT_VERSION = 1;
+				GCC_DYNAMIC_NO_PIC = NO;
+				GCC_ENABLE_FIX_AND_CONTINUE = YES;
+				GCC_MODEL_TUNING = G5;
+				GCC_OPTIMIZATION_LEVEL = 0;
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = IPython1Sandbox_Prefix.pch;
+				INFOPLIST_FILE = Info.plist;
+				INSTALL_PATH = "$(HOME)/Applications";
+				PRODUCT_NAME = IPython1Sandbox;
+				VERSIONING_SYSTEM = "apple-generic";
+				WRAPPER_EXTENSION = app;
+				ZERO_LINK = YES;
+			};
+			name = Debug;
+		};
+		C01FCF4C08A954540054247B /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				CURRENT_PROJECT_VERSION = 1;
+				DEBUG_INFORMATION_FORMAT = "dwarf-with-dsym";
+				GCC_MODEL_TUNING = G5;
+				GCC_PRECOMPILE_PREFIX_HEADER = YES;
+				GCC_PREFIX_HEADER = IPython1Sandbox_Prefix.pch;
+				INFOPLIST_FILE = Info.plist;
+				INSTALL_PATH = "$(HOME)/Applications";
+				PRODUCT_NAME = IPython1Sandbox;
+				VERSIONING_SYSTEM = "apple-generic";
+				WRAPPER_EXTENSION = app;
+			};
+			name = Release;
+		};
+		C01FCF4F08A954540054247B /* Debug */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				PREBINDING = NO;
+				SDKROOT = "$(DEVELOPER_SDK_DIR)/MacOSX10.5.sdk";
+			};
+			name = Debug;
+		};
+		C01FCF5008A954540054247B /* Release */ = {
+			isa = XCBuildConfiguration;
+			buildSettings = {
+				ARCHS = (
+					ppc,
+					i386,
+				);
+				GCC_WARN_ABOUT_RETURN_TYPE = YES;
+				GCC_WARN_UNUSED_VARIABLE = YES;
+				PREBINDING = NO;
+				SDKROOT = "$(DEVELOPER_SDK_DIR)/MacOSX10.5.sdk";
+			};
+			name = Release;
+		};
+/* End XCBuildConfiguration section */
+
+/* Begin XCConfigurationList section */
+		C01FCF4A08A954540054247B /* Build configuration list for PBXNativeTarget "IPython1Sandbox" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				C01FCF4B08A954540054247B /* Debug */,
+				C01FCF4C08A954540054247B /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+		C01FCF4E08A954540054247B /* Build configuration list for PBXProject "IPython1Sandbox" */ = {
+			isa = XCConfigurationList;
+			buildConfigurations = (
+				C01FCF4F08A954540054247B /* Debug */,
+				C01FCF5008A954540054247B /* Release */,
+			);
+			defaultConfigurationIsVisible = 0;
+			defaultConfigurationName = Release;
+		};
+/* End XCConfigurationList section */
+	};
+	rootObject = 29B97313FDCFA39411CA2CEA /* Project object */;
+}

IPython/frontend/cocoa/examples/IPython1Sandbox/IPython1SandboxAppDelegate.py

@@ -0,0 +1,39 b''
+#
+#  IPython1SandboxAppDelegate.py
+#  IPython1Sandbox
+#
+#  Created by Barry Wark on 3/4/08.
+#  Copyright __MyCompanyName__ 2008. All rights reserved.
+#
+
+from Foundation import NSObject, NSPredicate
+import objc
+import threading
+
+from PyObjCTools import AppHelper
+
+from twisted.internet import reactor
+
+class IPython1SandboxAppDelegate(NSObject):
+    ipythonController = objc.IBOutlet()
+    
+    def applicationShouldTerminate_(self, sender):
+        if reactor.running:
+            reactor.addSystemEventTrigger(
+                'after', 'shutdown', AppHelper.stopEventLoop)
+            reactor.stop()
+            return False
+        return True
+    
+    
+    def applicationDidFinishLaunching_(self, sender):
+        reactor.interleave(AppHelper.callAfter)
+        assert(reactor.running)
+    
+    
+    def workspaceFilterPredicate(self):
+        return NSPredicate.predicateWithFormat_("NOT (self.value BEGINSWITH '<')")
+
+
+    
+

IPython/frontend/cocoa/examples/IPython1Sandbox/IPython1Sandbox_Prefix.pch

@@ -0,0 +1,7 b''
+//
+// Prefix header for all source files of the 'IPython1Sandbox' target in the 'IPython1Sandbox' project
+//
+
+#ifdef __OBJC__
+    #import <Cocoa/Cocoa.h>
+#endif

IPython/frontend/cocoa/examples/IPython1Sandbox/IPythonCocoaController Tests-Info.plist

@@ -0,0 +1,20 b''
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIdentifier</key>
+	<string>com.yourcompany.IPythonCocoaController Tests</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundlePackageType</key>
+	<string>BNDL</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+</dict>
+</plist>

IPython/frontend/cocoa/examples/IPython1Sandbox/Info.plist

@@ -0,0 +1,30 b''
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>CFBundleDevelopmentRegion</key>
+	<string>English</string>
+	<key>CFBundleExecutable</key>
+	<string>${EXECUTABLE_NAME}</string>
+	<key>CFBundleIconFile</key>
+	<string></string>
+	<key>CFBundleIdentifier</key>
+	<string>com.yourcompany.IPython1Sandbox</string>
+	<key>CFBundleInfoDictionaryVersion</key>
+	<string>6.0</string>
+	<key>CFBundleName</key>
+	<string>${PRODUCT_NAME}</string>
+	<key>CFBundlePackageType</key>
+	<string>APPL</string>
+	<key>CFBundleShortVersionString</key>
+	<string>0.1</string>
+	<key>CFBundleSignature</key>
+	<string>????</string>
+	<key>CFBundleVersion</key>
+	<string>1.0</string>
+	<key>NSMainNibFile</key>
+	<string>MainMenu</string>
+	<key>NSPrincipalClass</key>
+	<string>NSApplication</string>
+</dict>
+</plist>

IPython/frontend/cocoa/examples/IPython1Sandbox/main.m

@@ -0,0 +1,49 b''
+//
+//  main.m
+//  IPython1Sandbox
+//
+//  Created by Barry Wark on 3/4/08.
+//  Copyright __MyCompanyName__ 2008. All rights reserved.
+//
+
+#import <Python/Python.h>
+#import <Cocoa/Cocoa.h>
+
+int main(int argc, char *argv[])
+{
+    NSAutoreleasePool *pool = [[NSAutoreleasePool alloc] init];
+    
+    NSBundle *mainBundle = [NSBundle mainBundle];
+    NSString *resourcePath = [mainBundle resourcePath];
+    NSArray *pythonPathArray = [NSArray arrayWithObjects: resourcePath, [resourcePath stringByAppendingPathComponent:@"PyObjC"], nil];
+    
+    setenv("PYTHONPATH", [[pythonPathArray componentsJoinedByString:@":"] UTF8String], 1);
+    
+    NSArray *possibleMainExtensions = [NSArray arrayWithObjects: @"py", @"pyc", @"pyo", nil];
+    NSString *mainFilePath = nil;
+    
+    for (NSString *possibleMainExtension in possibleMainExtensions) {
+        mainFilePath = [mainBundle pathForResource: @"main" ofType: possibleMainExtension];
+        if ( mainFilePath != nil ) break;
+    }
+    
+	if ( !mainFilePath ) {
+        [NSException raise: NSInternalInconsistencyException format: @"%s:%d main() Failed to find the Main.{py,pyc,pyo} file in the application wrapper's Resources directory.", __FILE__, __LINE__];
+    }
+    
+    Py_SetProgramName("/usr/bin/python");
+    Py_Initialize();
+    PySys_SetArgv(argc, (char **)argv);
+    
+    const char *mainFilePathPtr = [mainFilePath UTF8String];
+    FILE *mainFile = fopen(mainFilePathPtr, "r");
+    int result = PyRun_SimpleFile(mainFile, (char *)[[mainFilePath lastPathComponent] UTF8String]);
+    
+    if ( result != 0 )
+        [NSException raise: NSInternalInconsistencyException
+                    format: @"%s:%d main() PyRun_SimpleFile failed with file '%@'.  See console for errors.", __FILE__, __LINE__, mainFilePath];
+    
+    [pool drain];
+    
+    return result;
+}

IPython/frontend/cocoa/examples/IPython1Sandbox/main.py

@@ -0,0 +1,24 b''
+#
+#  main.py
+#  IPython1Sandbox
+#
+#  Created by Barry Wark on 3/4/08.
+#  Copyright __MyCompanyName__ 2008. All rights reserved.
+#
+
+#import modules required by application
+import objc
+import Foundation
+import AppKit
+
+from PyObjCTools import AppHelper
+
+from twisted.internet import _threadedselect
+reactor = _threadedselect.install()
+
+# import modules containing classes required to start application and load MainMenu.nib
+import IPython1SandboxAppDelegate
+import IPython.frontend.cocoa.cocoa_frontend
+
+# pass control to AppKit
+AppHelper.runEventLoop()

IPython/frontend/cocoa/tests/_trial_temp/test.log

@@ -0,0 +1,27 b''
[phone]:06:49-0700 [-] Log opened.
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerCompletesToken <--
[phone]:06:49-0700 [-] Unhandled error in Deferred:
[phone]:06:49-0700 [-] Unhandled Error
+	Traceback (most recent call last):
+	  File "/Library/Python/2.5/site-packages/Twisted-2.5.0_rUnknown-py2.5-macosx-10.3-i386.egg/twisted/internet/utils.py", line 144, in runWithWarningsSuppressed
+	    result = f(*a, **kw)
+	  File "/Users/barry/Desktop/ipython1-cocoa/ipython1/frontend/cocoa/tests/test_cocoa_frontend.py", line 94, in testControllerCompletesToken
+	    self.controller.executeRequest([code]).addCallback(testCompletes)
+	  File "/Library/Python/2.5/site-packages/Twisted-2.5.0_rUnknown-py2.5-macosx-10.3-i386.egg/twisted/internet/defer.py", line 196, in addCallback
+	    callbackKeywords=kw)
+	  File "/Library/Python/2.5/site-packages/Twisted-2.5.0_rUnknown-py2.5-macosx-10.3-i386.egg/twisted/internet/defer.py", line 187, in addCallbacks
+	    self._runCallbacks()
+	--- <exception caught here> ---
+	  File "/Library/Python/2.5/site-packages/Twisted-2.5.0_rUnknown-py2.5-macosx-10.3-i386.egg/twisted/internet/defer.py", line 325, in _runCallbacks
+	    self.result = callback(self.result, *args, **kw)
+	  File "/Users/barry/Desktop/ipython1-cocoa/ipython1/frontend/cocoa/tests/test_cocoa_frontend.py", line 89, in testCompletes
+	    self.assert_("longNameVariable" in result)
+	  File "/Library/Python/2.5/site-packages/Twisted-2.5.0_rUnknown-py2.5-macosx-10.3-i386.egg/twisted/trial/unittest.py", line 136, in failUnless
+	    raise self.failureException(msg)
+	twisted.trial.unittest.FailTest: None
+	
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerExecutesCode <--
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerInstantiatesIEngineInteractive <--
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerMirrorsUserNSWithValuesAsStrings <--
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerRaisesCompilerErrorForIllegalCode <--
[phone]:06:49-0700 [-] --> ipython1.frontend.cocoa.tests.test_cocoa_frontend.TestIPythonCocoaControler.testControllerReturnsNoneForIncompleteCode <--

IPython/frontend/cocoa/tests/test_cocoa_frontend.py

@@ -0,0 +1,72 b''
+# encoding: utf-8
+"""This file contains unittests for the 
+IPython.frontend.cocoa.cocoa_frontend module.
+"""
+__docformat__ = "restructuredtext en"
+                                                                            
+#---------------------------------------------------------------------------
+#       Copyright (C) 2005  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                                                                   
+#---------------------------------------------------------------------------
+from IPython.kernel.core.interpreter import Interpreter                     
+import IPython.kernel.engineservice as es
+from IPython.testing.util import DeferredTestCase
+from twisted.internet.defer import succeed
+from IPython.frontend.cocoa.cocoa_frontend import IPythonCocoaController
+                                                    
+from Foundation import NSMakeRect
+from AppKit import NSTextView, NSScrollView                                                
+
+class TestIPythonCocoaControler(DeferredTestCase):
+    """Tests for IPythonCocoaController"""
+    
+    def setUp(self):
+        self.controller = IPythonCocoaController.alloc().init()
+        self.engine = es.EngineService()
+        self.engine.startService()
+    
+    
+    def tearDown(self):
+        self.controller = None
+        self.engine.stopService()
+    
+    def testControllerExecutesCode(self):
+        code ="""5+5"""
+        expected = Interpreter().execute(code)
+        del expected['number']
+        def removeNumberAndID(result):
+            del result['number']
+            del result['id']
+            return result
+        self.assertDeferredEquals(
+            self.controller.execute(code).addCallback(removeNumberAndID), 
+            expected)
+    
+    def testControllerMirrorsUserNSWithValuesAsStrings(self):
+        code = """userns1=1;userns2=2"""
+        def testControllerUserNS(result):
+            self.assertEquals(self.controller.userNS['userns1'], 1)
+            self.assertEquals(self.controller.userNS['userns2'], 2)
+        
+        self.controller.execute(code).addCallback(testControllerUserNS)
+    
+    
+    def testControllerInstantiatesIEngine(self):
+        self.assert_(es.IEngineBase.providedBy(self.controller.engine))
+    
+    def testControllerCompletesToken(self):
+        code = """longNameVariable=10"""
+        def testCompletes(result):
+            self.assert_("longNameVariable" in result)
+        
+        def testCompleteToken(result):
+            self.controller.complete("longNa").addCallback(testCompletes)
+        
+        self.controller.execute(code).addCallback(testCompletes)
+    

IPython/frontend/frontendbase.py

@@ -0,0 +1,352 b''
+# encoding: utf-8
+# -*- test-case-name: IPython.frontend.tests.test_frontendbase -*-
+"""
+frontendbase provides an interface and base class for GUI frontends for 
+IPython.kernel/IPython.kernel.core.
+
+Frontend implementations will likely want to subclass FrontEndBase. 
+
+Author: Barry Wark
+"""
+__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 string
+import uuid
+import _ast
+
+import zope.interface as zi
+
+from IPython.kernel.core.history import FrontEndHistory
+from IPython.kernel.core.util import Bunch
+from IPython.kernel.engineservice import IEngineCore
+
+from twisted.python.failure import Failure
+
+##############################################################################
+# TEMPORARY!!! fake configuration, while we decide whether to use tconfig or
+# not
+
+rc = Bunch()
+rc.prompt_in1 = r'In [$number]:  '
+rc.prompt_in2 = r'...'
+rc.prompt_out = r'Out [$number]:  '
+
+##############################################################################
+
+class IFrontEndFactory(zi.Interface):
+    """Factory interface for frontends."""
+    
+    def __call__(engine=None, history=None):
+        """
+        Parameters:
+        interpreter : IPython.kernel.engineservice.IEngineCore
+        """
+        
+        pass
+
+
+
+class IFrontEnd(zi.Interface):
+    """Interface for frontends. All methods return t.i.d.Deferred"""
+    
+    zi.Attribute("input_prompt_template", "string.Template instance\
+                substituteable with execute result.")
+    zi.Attribute("output_prompt_template", "string.Template instance\
+                substituteable with execute result.")
+    zi.Attribute("continuation_prompt_template", "string.Template instance\
+                substituteable with execute result.")
+    
+    def update_cell_prompt(self, result):
+        """Subclass may override to update the input prompt for a block. 
+        Since this method will be called as a 
+        twisted.internet.defer.Deferred's callback,
+        implementations should return result when finished.
+        
+        NB: result is a failure if the execute returned a failre. 
+        To get the blockID, you should do something like::
+            if(isinstance(result, twisted.python.failure.Failure)):
+                blockID = result.blockID
+            else:
+                blockID = result['blockID']
+        """
+        
+        pass
+    
+    def render_result(self, result):
+        """Render the result of an execute call. Implementors may choose the
+         method of rendering.
+        For example, a notebook-style frontend might render a Chaco plot 
+        inline.
+        
+        Parameters:
+            result : dict (result of IEngineBase.execute )
+        
+        Result:
+            Output of frontend rendering
+        """
+        
+        pass
+    
+    def render_error(self, failure):
+        """Subclasses must override to render the failure. Since this method 
+        ill be called as a twisted.internet.defer.Deferred's callback, 
+        implementations should return result when finished.
+        """
+        
+        pass
+    
+    
+    def input_prompt(result={}):
+        """Returns the input prompt by subsituting into 
+        self.input_prompt_template
+        """
+        pass
+    
+    def output_prompt(result):
+        """Returns the output prompt by subsituting into 
+        self.output_prompt_template
+        """
+        
+        pass
+    
+    def continuation_prompt():
+        """Returns the continuation prompt by subsituting into 
+        self.continuation_prompt_template
+        """
+        
+        pass
+    
+    def is_complete(block):
+        """Returns True if block is complete, False otherwise."""
+        
+        pass
+    
+    def compile_ast(block):
+        """Compiles block to an _ast.AST"""
+        
+        pass
+    
+    
+    def get_history_previous(currentBlock):
+        """Returns the block previous in  the history. Saves currentBlock if
+        the history_cursor is currently at the end of the input history"""
+        pass
+    
+    def get_history_next():
+        """Returns the next block in the history."""
+        
+        pass
+    
+
+class FrontEndBase(object):
+    """
+    FrontEndBase manages the state tasks for a CLI frontend:
+        - Input and output history management
+        - Input/continuation and output prompt generation
+        
+    Some issues (due to possibly unavailable engine):
+        - How do we get the current cell number for the engine?
+        - How do we handle completions?
+    """
+    
+    zi.implements(IFrontEnd)
+    zi.classProvides(IFrontEndFactory)
+    
+    history_cursor = 0
+    
+    current_indent_level = 0
+    
+    
+    input_prompt_template = string.Template(rc.prompt_in1)
+    output_prompt_template = string.Template(rc.prompt_out)
+    continuation_prompt_template = string.Template(rc.prompt_in2)
+    
+    def __init__(self, engine=None, history=None):
+        assert(engine==None or IEngineCore.providedBy(engine))
+        self.engine = IEngineCore(engine)
+        if history is None:
+                self.history = FrontEndHistory(input_cache=[''])
+        else:
+            self.history = history
+        
+    
+    def input_prompt(self, result={}):
+        """Returns the current input prompt
+        
+        It would be great to use ipython1.core.prompts.Prompt1 here
+        """
+        
+        result.setdefault('number','')
+        
+        return self.input_prompt_template.safe_substitute(result)
+    
+    
+    def continuation_prompt(self):
+        """Returns the current continuation prompt"""
+        
+        return self.continuation_prompt_template.safe_substitute()
+    
+    def output_prompt(self, result):
+        """Returns the output prompt for result"""
+        
+        return self.output_prompt_template.safe_substitute(result)
+    
+    
+    def is_complete(self, block):
+        """Determine if block is complete.
+        
+        Parameters
+        block : string
+        
+        Result 
+        True if block can be sent to the engine without compile errors.
+        False otherwise.
+        """
+        
+        try:
+            ast = self.compile_ast(block)
+        except:
+            return False
+        
+        lines = block.split('\n')
+        return (len(lines)==1 or str(lines[-1])=='')
+    
+    
+    def compile_ast(self, block):
+        """Compile block to an AST
+        
+        Parameters:
+            block : str
+        
+        Result:
+            AST
+        
+        Throws:
+            Exception if block cannot be compiled
+        """
+        
+        return compile(block, "<string>", "exec", _ast.PyCF_ONLY_AST)
+    
+    
+    def execute(self, block, blockID=None):
+        """Execute the block and return result.
+        
+        Parameters:
+            block : {str, AST}
+            blockID : any
+                Caller may provide an ID to identify this block. 
+                result['blockID'] := blockID
+        
+        Result:
+            Deferred result of self.interpreter.execute
+        """
+        
+        if(not self.is_complete(block)):
+            return Failure(Exception("Block is not compilable"))
+        
+        if(blockID == None):
+            blockID = uuid.uuid4() #random UUID
+        
+        d = self.engine.execute(block)
+        d.addCallback(self._add_history, block=block)
+        d.addBoth(self._add_block_id, blockID)
+        d.addBoth(self.update_cell_prompt)
+        d.addCallbacks(self.render_result, errback=self.render_error)
+        
+        return d
+    
+    
+    def _add_block_id(self, result, blockID):
+        """Add the blockID to result or failure. Unfortunatley, we have to 
+        treat failures differently than result dicts.
+        """
+        
+        if(isinstance(result, Failure)):
+            result.blockID = blockID
+        else:
+            result['blockID'] = blockID
+        
+        return result
+    
+    def _add_history(self, result, block=None):
+        """Add block to the history"""
+        
+        assert(block != None)
+        self.history.add_items([block])
+        self.history_cursor += 1
+        
+        return result
+    
+    
+    def get_history_previous(self, currentBlock):
+        """ Returns previous history string and decrement history cursor.
+        """
+        command = self.history.get_history_item(self.history_cursor - 1)
+        
+        if command is not None:
+            if(self.history_cursor == len(self.history.input_cache)):
+                self.history.input_cache[self.history_cursor] = currentBlock
+            self.history_cursor -= 1
+        return command
+    
+    
+    def get_history_next(self):
+        """ Returns next history string and increment history cursor.
+        """
+        command = self.history.get_history_item(self.history_cursor+1)
+        
+        if command is not None:
+            self.history_cursor += 1
+        return command
+    
+    ###
+    # Subclasses probably want to override these methods...
+    ###
+    
+    def update_cell_prompt(self, result):
+        """Subclass may override to update the input prompt for a block. 
+        Since this method will be called as a 
+        twisted.internet.defer.Deferred's callback, implementations should 
+        return result when finished.
+        
+        NB: result is a failure if the execute returned a failre. 
+        To get the blockID, you should do something like::
+            if(isinstance(result, twisted.python.failure.Failure)):
+                blockID = result.blockID
+            else:
+                blockID = result['blockID']
+            
+        
+        """
+        
+        return result
+    
+    
+    def render_result(self, result):
+        """Subclasses must override to render result. Since this method will
+        be called as a twisted.internet.defer.Deferred's callback, 
+        implementations should return result when finished.
+        """
+        
+        return result
+    
+    
+    def render_error(self, failure):
+        """Subclasses must override to render the failure. Since this method 
+        will be called as a twisted.internet.defer.Deferred's callback, 
+        implementations should return result when finished."""
+        
+        return failure
+    
+
+

IPython/frontend/tests/test_frontendbase.py

@@ -0,0 +1,151 b''
+# encoding: utf-8
+
+"""This file contains unittests for the frontendbase module."""
+
+__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 unittest
+from IPython.frontend import frontendbase
+from IPython.kernel.engineservice import EngineService
+
+class FrontEndCallbackChecker(frontendbase.FrontEndBase):
+    """FrontEndBase subclass for checking callbacks"""
+    def __init__(self, engine=None, history=None):
+        super(FrontEndCallbackChecker, self).__init__(engine=engine, 
+                                                    history=history)
+        self.updateCalled = False
+        self.renderResultCalled = False
+        self.renderErrorCalled = False
+    
+    def update_cell_prompt(self, result):
+        self.updateCalled = True
+        return result
+    
+    def render_result(self, result):
+        self.renderResultCalled = True
+        return result
+    
+    
+    def render_error(self, failure):
+        self.renderErrorCalled = True
+        return failure
+    
+
+
+    
+class TestFrontendBase(unittest.TestCase):
+    def setUp(self):
+        """Setup the EngineService and FrontEndBase"""
+        
+        self.fb = FrontEndCallbackChecker(engine=EngineService())
+    
+    
+    def test_implements_IFrontEnd(self):
+        assert(frontendbase.IFrontEnd.implementedBy(
+                                                frontendbase.FrontEndBase))
+    
+    
+    def test_is_complete_returns_False_for_incomplete_block(self):
+        """"""
+        
+        block = """def test(a):"""
+        
+        assert(self.fb.is_complete(block) == False)
+    
+    def test_is_complete_returns_True_for_complete_block(self):
+        """"""
+        
+        block = """def test(a): pass"""
+            
+        assert(self.fb.is_complete(block))
+        
+        block = """a=3"""
+        
+        assert(self.fb.is_complete(block))
+    
+    
+    def test_blockID_added_to_result(self):
+        block = """3+3"""
+        
+        d = self.fb.execute(block, blockID='TEST_ID')
+        
+        d.addCallback(self.checkBlockID, expected='TEST_ID')
+    
+    def test_blockID_added_to_failure(self):
+        block = "raise  Exception()"
+        
+        d = self.fb.execute(block,blockID='TEST_ID')
+        d.addErrback(self.checkFailureID, expected='TEST_ID')
+    
+    def checkBlockID(self, result, expected=""):
+        assert(result['blockID'] == expected)
+    
+    
+    def checkFailureID(self, failure, expected=""):
+        assert(failure.blockID == expected)
+    
+    
+    def test_callbacks_added_to_execute(self):
+        """test that
+        update_cell_prompt
+        render_result
+        
+        are added to execute request
+        """
+        
+        d = self.fb.execute("10+10")
+        d.addCallback(self.checkCallbacks)
+    
+    
+    def checkCallbacks(self, result):
+        assert(self.fb.updateCalled)
+        assert(self.fb.renderResultCalled)
+    
+    
+    def test_error_callback_added_to_execute(self):
+        """test that render_error called on execution error"""
+        
+        d = self.fb.execute("raise Exception()")
+        d.addCallback(self.checkRenderError)
+    
+    def checkRenderError(self, result):
+        assert(self.fb.renderErrorCalled)
+    
+    def test_history_returns_expected_block(self):
+        """Make sure history browsing doesn't fail"""
+        
+        blocks = ["a=1","a=2","a=3"]
+        for b in blocks:
+            d = self.fb.execute(b)
+        
+        # d is now the deferred for the last executed block
+        d.addCallback(self.historyTests, blocks)
+        
+    
+    def historyTests(self, result, blocks):
+        """historyTests"""
+        
+        assert(len(blocks) >= 3)
+        assert(self.fb.get_history_previous("") == blocks[-2])
+        assert(self.fb.get_history_previous("") == blocks[-3])
+        assert(self.fb.get_history_next() == blocks[-2])
+    
+    
+    def test_history_returns_none_at_startup(self):
+        """test_history_returns_none_at_startup"""
+        
+        assert(self.fb.get_history_previous("")==None)
+        assert(self.fb.get_history_next()==None)
+    
+    

IPython/kernel/engineservice.py

@@ -847,18 +847,30 b' class Command(object):'
         self.deferred.errback(reason)
 
 class ThreadedEngineService(EngineService):
+    """An EngineService subclass that defers execute commands to a separate 
+    thread.
+    
+    ThreadedEngineService uses twisted.internet.threads.deferToThread to 
+    defer execute requests to a separate thread. GUI frontends may want to 
+    use ThreadedEngineService as the engine in an 
+    IPython.frontend.frontendbase.FrontEndBase subclass to prevent
+    block execution from blocking the GUI thread.
+    """
     
     zi.implements(IEngineBase)
 
     def __init__(self, shellClass=Interpreter, mpi=None):
         EngineService.__init__(self, shellClass, mpi)
+    
+    
+    def execute(self, lines):
         # Only import this if we are going to use this class
         from twisted.internet import threads
         
-    def execute(self, lines):
-        msg = """engine: %r
-method: execute(lines)
-lines = %s""" % (self.id, lines)
-        d = threads.deferToThread(self.executeAndRaise, msg, self.shell.execute, lines)
+        msg = {'engineid':self.id,
+               'method':'execute',
+               'args':[lines]}
+        
+        d = threads.deferToThread(self.shell.execute, lines)
         d.addCallback(self.addIDToResult)
         return d

IPython/kernel/tests/test_engineservice.py

@@ -48,6 +48,18 b' else:'
     
         def tearDown(self):
             return self.engine.stopService()
+    
+    class ThreadedEngineServiceTest(DeferredTestCase,
+                                 IEngineCoreTestCase, 
+                                 IEngineSerializedTestCase,
+                                 IEnginePropertiesTestCase):
+    
+        def setUp(self):
+            self.engine = es.ThreadedEngineService()
+            self.engine.startService()
+    
+        def tearDown(self):
+            return self.engine.stopService()
 
     class QueuedEngineServiceTest(DeferredTestCase,
                                   IEngineCoreTestCase,