##// END OF EJS Templates
Made sigint_timer and got_kbdint module globals
Siyu Zhang -
Show More
@@ -1,174 +1,181 b''
1 1 # -*- coding: utf-8 -*-
2 2 """
3 3 Qt4's inputhook support function
4 4
5 5 Author: Christian Boos
6 6 """
7 7
8 8 #-----------------------------------------------------------------------------
9 9 # Copyright (C) 2011 The IPython Development Team
10 10 #
11 11 # Distributed under the terms of the BSD License. The full license is in
12 12 # the file COPYING, distributed as part of this software.
13 13 #-----------------------------------------------------------------------------
14 14
15 15 #-----------------------------------------------------------------------------
16 16 # Imports
17 17 #-----------------------------------------------------------------------------
18 18
19 19 import os
20 20 import signal
21 21 import time
22 22 import threading
23 23
24 24 from IPython.core.interactiveshell import InteractiveShell
25 25 from IPython.external.qt_for_kernel import QtCore, QtGui
26 26 from IPython.lib.inputhook import allow_CTRL_C, ignore_CTRL_C, stdin_ready
27 27
28 28 #-----------------------------------------------------------------------------
29 # Module Globals
30 #-----------------------------------------------------------------------------
31
32 got_kbdint = False
33 sigint_timer = None
34
35 #-----------------------------------------------------------------------------
29 36 # Code
30 37 #-----------------------------------------------------------------------------
31 38
32 39 def create_inputhook_qt4(mgr, app=None):
33 40 """Create an input hook for running the Qt4 application event loop.
34 41
35 42 Parameters
36 43 ----------
37 44 mgr : an InputHookManager
38 45
39 46 app : Qt Application, optional.
40 47 Running application to use. If not given, we probe Qt for an
41 48 existing application object, and create a new one if none is found.
42 49
43 50 Returns
44 51 -------
45 52 A pair consisting of a Qt Application (either the one given or the
46 53 one found or created) and a inputhook.
47 54
48 55 Notes
49 56 -----
50 57 We use a custom input hook instead of PyQt4's default one, as it
51 58 interacts better with the readline packages (issue #481).
52 59
53 60 The inputhook function works in tandem with a 'pre_prompt_hook'
54 61 which automatically restores the hook as an inputhook in case the
55 62 latter has been temporarily disabled after having intercepted a
56 63 KeyboardInterrupt.
57 64 """
58 65
59 66 if app is None:
60 67 app = QtCore.QCoreApplication.instance()
61 68 if app is None:
62 69 app = QtGui.QApplication([" "])
63 70
64 71 # Re-use previously created inputhook if any
65 72 ip = InteractiveShell.instance()
66 73 if hasattr(ip, '_inputhook_qt4'):
67 74 return app, ip._inputhook_qt4
68 75
69 76 # Otherwise create the inputhook_qt4/preprompthook_qt4 pair of
70 77 # hooks (they both share the got_kbdint flag)
71 78
72 got_kbdint = [False]
73
74 sigint_timer = [None]
75
76 79 def inputhook_qt4():
77 80 """PyOS_InputHook python hook for Qt4.
78 81
79 82 Process pending Qt events and if there's no pending keyboard
80 83 input, spend a short slice of time (50ms) running the Qt event
81 84 loop.
82 85
83 86 As a Python ctypes callback can't raise an exception, we catch
84 87 the KeyboardInterrupt and temporarily deactivate the hook,
85 88 which will let a *second* CTRL+C be processed normally and go
86 89 back to a clean prompt line.
87 90 """
88 91 try:
89 92 allow_CTRL_C()
90 93 app = QtCore.QCoreApplication.instance()
91 94 if not app: # shouldn't happen, but safer if it happens anyway...
92 95 return 0
93 96 app.processEvents(QtCore.QEventLoop.AllEvents, 300)
94 97 if not stdin_ready():
95 98 # Generally a program would run QCoreApplication::exec()
96 99 # from main() to enter and process the Qt event loop until
97 100 # quit() or exit() is called and the program terminates.
98 101 #
99 102 # For our input hook integration, we need to repeatedly
100 103 # enter and process the Qt event loop for only a short
101 104 # amount of time (say 50ms) to ensure that Python stays
102 105 # responsive to other user inputs.
103 106 #
104 107 # A naive approach would be to repeatedly call
105 108 # QCoreApplication::exec(), using a timer to quit after a
106 109 # short amount of time. Unfortunately, QCoreApplication
107 110 # emits an aboutToQuit signal before stopping, which has
108 111 # the undesirable effect of closing all modal windows.
109 112 #
110 113 # To work around this problem, we instead create a
111 114 # QEventLoop and call QEventLoop::exec(). Other than
112 115 # setting some state variables which do not seem to be
113 116 # used anywhere, the only thing QCoreApplication adds is
114 117 # the aboutToQuit signal which is precisely what we are
115 118 # trying to avoid.
116 119 timer = QtCore.QTimer()
117 120 event_loop = QtCore.QEventLoop()
118 121 timer.timeout.connect(event_loop.quit)
119 122 while not stdin_ready():
120 123 timer.start(50)
121 124 event_loop.exec_()
122 125 timer.stop()
123 126 except KeyboardInterrupt:
127 global got_kbdint, sigint_timer
128
124 129 ignore_CTRL_C()
125 got_kbdint[0] = True
130 got_kbdint = True
126 131 mgr.clear_inputhook()
127 132
128 133 # This generates a second SIGINT so the user doesn't have to
129 134 # press CTRL+C twice to get a clean prompt.
130 135 #
131 136 # Since we can't catch the resulting KeyboardInterrupt here
132 137 # (because this is a ctypes callback), we use a timer to
133 138 # generate the SIGINT after we leave this callback.
134 139 #
135 140 # Unfortunately this doesn't work on Windows (SIGINT kills
136 141 # Python and CTRL_C_EVENT doesn't work).
137 142 if(os.name == 'posix'):
138 143 pid = os.getpid()
139 if(not sigint_timer[0]):
140 sigint_timer[0] = threading.Timer(.01, os.kill,
144 if(not sigint_timer):
145 sigint_timer = threading.Timer(.01, os.kill,
141 146 args=[pid, signal.SIGINT] )
142 sigint_timer[0].start()
147 sigint_timer.start()
143 148 else:
144 149 print("\nKeyboardInterrupt - Ctrl-C again for new prompt")
145 150
146 151
147 152 except: # NO exceptions are allowed to escape from a ctypes callback
148 153 ignore_CTRL_C()
149 154 from traceback import print_exc
150 155 print_exc()
151 156 print("Got exception from inputhook_qt4, unregistering.")
152 157 mgr.clear_inputhook()
153 158 finally:
154 159 allow_CTRL_C()
155 160 return 0
156 161
157 162 def preprompthook_qt4(ishell):
158 163 """'pre_prompt_hook' used to restore the Qt4 input hook
159 164
160 165 (in case the latter was temporarily deactivated after a
161 166 CTRL+C)
162 167 """
163 if(sigint_timer[0]):
164 sigint_timer[0].cancel()
165 sigint_timer[0] = None
168 global got_kbdint, sigint_timer
169
170 if(sigint_timer):
171 sigint_timer.cancel()
172 sigint_timer = None
166 173
167 if got_kbdint[0]:
174 if got_kbdint:
168 175 mgr.set_inputhook(inputhook_qt4)
169 got_kbdint[0] = False
176 got_kbdint = False
170 177
171 178 ip._inputhook_qt4 = inputhook_qt4
172 179 ip.set_hook('pre_prompt_hook', preprompthook_qt4)
173 180
174 181 return app, inputhook_qt4
General Comments 0
You need to be logged in to leave comments. Login now