##// END OF EJS Templates
Backport PR #12804: Add explicit argtype counting, required for osx-arm64.
Matthias Bussonnier -
Show More
@@ -1,137 +1,157 b''
1 """Inputhook for OS X
1 """Inputhook for OS X
2
2
3 Calls NSApp / CoreFoundation APIs via ctypes.
3 Calls NSApp / CoreFoundation APIs via ctypes.
4 """
4 """
5
5
6 # obj-c boilerplate from appnope, used under BSD 2-clause
6 # obj-c boilerplate from appnope, used under BSD 2-clause
7
7
8 import ctypes
8 import ctypes
9 import ctypes.util
9 import ctypes.util
10 from threading import Event
10 from threading import Event
11
11
12 objc = ctypes.cdll.LoadLibrary(ctypes.util.find_library('objc'))
12 objc = ctypes.cdll.LoadLibrary(ctypes.util.find_library('objc'))
13
13
14 void_p = ctypes.c_void_p
14 void_p = ctypes.c_void_p
15
15
16 objc.objc_getClass.restype = void_p
16 objc.objc_getClass.restype = void_p
17 objc.sel_registerName.restype = void_p
17 objc.sel_registerName.restype = void_p
18 objc.objc_msgSend.restype = void_p
18 objc.objc_msgSend.restype = void_p
19 objc.objc_msgSend.argtypes = [void_p, void_p]
19 objc.objc_msgSend.argtypes = [void_p, void_p]
20
20
21 msg = objc.objc_msgSend
21 msg = objc.objc_msgSend
22
22
23 def _utf8(s):
23 def _utf8(s):
24 """ensure utf8 bytes"""
24 """ensure utf8 bytes"""
25 if not isinstance(s, bytes):
25 if not isinstance(s, bytes):
26 s = s.encode('utf8')
26 s = s.encode('utf8')
27 return s
27 return s
28
28
29 def n(name):
29 def n(name):
30 """create a selector name (for ObjC methods)"""
30 """create a selector name (for ObjC methods)"""
31 return objc.sel_registerName(_utf8(name))
31 return objc.sel_registerName(_utf8(name))
32
32
33 def C(classname):
33 def C(classname):
34 """get an ObjC Class by name"""
34 """get an ObjC Class by name"""
35 return objc.objc_getClass(_utf8(classname))
35 return objc.objc_getClass(_utf8(classname))
36
36
37 # end obj-c boilerplate from appnope
37 # end obj-c boilerplate from appnope
38
38
39 # CoreFoundation C-API calls we will use:
39 # CoreFoundation C-API calls we will use:
40 CoreFoundation = ctypes.cdll.LoadLibrary(ctypes.util.find_library('CoreFoundation'))
40 CoreFoundation = ctypes.cdll.LoadLibrary(ctypes.util.find_library('CoreFoundation'))
41
41
42 CFFileDescriptorCreate = CoreFoundation.CFFileDescriptorCreate
42 CFFileDescriptorCreate = CoreFoundation.CFFileDescriptorCreate
43 CFFileDescriptorCreate.restype = void_p
43 CFFileDescriptorCreate.restype = void_p
44 CFFileDescriptorCreate.argtypes = [void_p, ctypes.c_int, ctypes.c_bool, void_p]
44 CFFileDescriptorCreate.argtypes = [void_p, ctypes.c_int, ctypes.c_bool, void_p]
45
45
46 CFFileDescriptorGetNativeDescriptor = CoreFoundation.CFFileDescriptorGetNativeDescriptor
46 CFFileDescriptorGetNativeDescriptor = CoreFoundation.CFFileDescriptorGetNativeDescriptor
47 CFFileDescriptorGetNativeDescriptor.restype = ctypes.c_int
47 CFFileDescriptorGetNativeDescriptor.restype = ctypes.c_int
48 CFFileDescriptorGetNativeDescriptor.argtypes = [void_p]
48 CFFileDescriptorGetNativeDescriptor.argtypes = [void_p]
49
49
50 CFFileDescriptorEnableCallBacks = CoreFoundation.CFFileDescriptorEnableCallBacks
50 CFFileDescriptorEnableCallBacks = CoreFoundation.CFFileDescriptorEnableCallBacks
51 CFFileDescriptorEnableCallBacks.restype = None
51 CFFileDescriptorEnableCallBacks.restype = None
52 CFFileDescriptorEnableCallBacks.argtypes = [void_p, ctypes.c_ulong]
52 CFFileDescriptorEnableCallBacks.argtypes = [void_p, ctypes.c_ulong]
53
53
54 CFFileDescriptorCreateRunLoopSource = CoreFoundation.CFFileDescriptorCreateRunLoopSource
54 CFFileDescriptorCreateRunLoopSource = CoreFoundation.CFFileDescriptorCreateRunLoopSource
55 CFFileDescriptorCreateRunLoopSource.restype = void_p
55 CFFileDescriptorCreateRunLoopSource.restype = void_p
56 CFFileDescriptorCreateRunLoopSource.argtypes = [void_p, void_p, void_p]
56 CFFileDescriptorCreateRunLoopSource.argtypes = [void_p, void_p, void_p]
57
57
58 CFRunLoopGetCurrent = CoreFoundation.CFRunLoopGetCurrent
58 CFRunLoopGetCurrent = CoreFoundation.CFRunLoopGetCurrent
59 CFRunLoopGetCurrent.restype = void_p
59 CFRunLoopGetCurrent.restype = void_p
60
60
61 CFRunLoopAddSource = CoreFoundation.CFRunLoopAddSource
61 CFRunLoopAddSource = CoreFoundation.CFRunLoopAddSource
62 CFRunLoopAddSource.restype = None
62 CFRunLoopAddSource.restype = None
63 CFRunLoopAddSource.argtypes = [void_p, void_p, void_p]
63 CFRunLoopAddSource.argtypes = [void_p, void_p, void_p]
64
64
65 CFRelease = CoreFoundation.CFRelease
65 CFRelease = CoreFoundation.CFRelease
66 CFRelease.restype = None
66 CFRelease.restype = None
67 CFRelease.argtypes = [void_p]
67 CFRelease.argtypes = [void_p]
68
68
69 CFFileDescriptorInvalidate = CoreFoundation.CFFileDescriptorInvalidate
69 CFFileDescriptorInvalidate = CoreFoundation.CFFileDescriptorInvalidate
70 CFFileDescriptorInvalidate.restype = None
70 CFFileDescriptorInvalidate.restype = None
71 CFFileDescriptorInvalidate.argtypes = [void_p]
71 CFFileDescriptorInvalidate.argtypes = [void_p]
72
72
73 # From CFFileDescriptor.h
73 # From CFFileDescriptor.h
74 kCFFileDescriptorReadCallBack = 1
74 kCFFileDescriptorReadCallBack = 1
75 kCFRunLoopCommonModes = void_p.in_dll(CoreFoundation, 'kCFRunLoopCommonModes')
75 kCFRunLoopCommonModes = void_p.in_dll(CoreFoundation, 'kCFRunLoopCommonModes')
76
76
77
77
78 def _NSApp():
78 def _NSApp():
79 """Return the global NSApplication instance (NSApp)"""
79 """Return the global NSApplication instance (NSApp)"""
80 objc.objc_msgSend.argtypes = [void_p, void_p]
80 return msg(C('NSApplication'), n('sharedApplication'))
81 return msg(C('NSApplication'), n('sharedApplication'))
81
82
82
83
83 def _wake(NSApp):
84 def _wake(NSApp):
84 """Wake the Application"""
85 """Wake the Application"""
85 event = msg(C('NSEvent'),
86 objc.objc_msgSend.argtypes = [
86 n('otherEventWithType:location:modifierFlags:'
87 void_p,
87 'timestamp:windowNumber:context:subtype:data1:data2:'),
88 void_p,
89 void_p,
90 void_p,
91 void_p,
92 void_p,
93 void_p,
94 void_p,
95 void_p,
96 void_p,
97 void_p,
98 ]
99 event = msg(
100 C("NSEvent"),
101 n(
102 "otherEventWithType:location:modifierFlags:"
103 "timestamp:windowNumber:context:subtype:data1:data2:"
104 ),
88 15, # Type
105 15, # Type
89 0, # location
106 0, # location
90 0, # flags
107 0, # flags
91 0, # timestamp
108 0, # timestamp
92 0, # window
109 0, # window
93 None, # context
110 None, # context
94 0, # subtype
111 0, # subtype
95 0, # data1
112 0, # data1
96 0, # data2
113 0, # data2
97 )
114 )
115 objc.objc_msgSend.argtypes = [void_p, void_p, void_p, void_p]
98 msg(NSApp, n('postEvent:atStart:'), void_p(event), True)
116 msg(NSApp, n('postEvent:atStart:'), void_p(event), True)
99
117
100
118
101 _triggered = Event()
119 _triggered = Event()
102
120
103 def _input_callback(fdref, flags, info):
121 def _input_callback(fdref, flags, info):
104 """Callback to fire when there's input to be read"""
122 """Callback to fire when there's input to be read"""
105 _triggered.set()
123 _triggered.set()
106 CFFileDescriptorInvalidate(fdref)
124 CFFileDescriptorInvalidate(fdref)
107 CFRelease(fdref)
125 CFRelease(fdref)
108 NSApp = _NSApp()
126 NSApp = _NSApp()
127 objc.objc_msgSend.argtypes = [void_p, void_p, void_p]
109 msg(NSApp, n('stop:'), NSApp)
128 msg(NSApp, n('stop:'), NSApp)
110 _wake(NSApp)
129 _wake(NSApp)
111
130
112 _c_callback_func_type = ctypes.CFUNCTYPE(None, void_p, void_p, void_p)
131 _c_callback_func_type = ctypes.CFUNCTYPE(None, void_p, void_p, void_p)
113 _c_input_callback = _c_callback_func_type(_input_callback)
132 _c_input_callback = _c_callback_func_type(_input_callback)
114
133
115
134
116 def _stop_on_read(fd):
135 def _stop_on_read(fd):
117 """Register callback to stop eventloop when there's data on fd"""
136 """Register callback to stop eventloop when there's data on fd"""
118 _triggered.clear()
137 _triggered.clear()
119 fdref = CFFileDescriptorCreate(None, fd, False, _c_input_callback, None)
138 fdref = CFFileDescriptorCreate(None, fd, False, _c_input_callback, None)
120 CFFileDescriptorEnableCallBacks(fdref, kCFFileDescriptorReadCallBack)
139 CFFileDescriptorEnableCallBacks(fdref, kCFFileDescriptorReadCallBack)
121 source = CFFileDescriptorCreateRunLoopSource(None, fdref, 0)
140 source = CFFileDescriptorCreateRunLoopSource(None, fdref, 0)
122 loop = CFRunLoopGetCurrent()
141 loop = CFRunLoopGetCurrent()
123 CFRunLoopAddSource(loop, source, kCFRunLoopCommonModes)
142 CFRunLoopAddSource(loop, source, kCFRunLoopCommonModes)
124 CFRelease(source)
143 CFRelease(source)
125
144
126
145
127 def inputhook(context):
146 def inputhook(context):
128 """Inputhook for Cocoa (NSApp)"""
147 """Inputhook for Cocoa (NSApp)"""
129 NSApp = _NSApp()
148 NSApp = _NSApp()
130 _stop_on_read(context.fileno())
149 _stop_on_read(context.fileno())
150 objc.objc_msgSend.argtypes = [void_p, void_p]
131 msg(NSApp, n('run'))
151 msg(NSApp, n('run'))
132 if not _triggered.is_set():
152 if not _triggered.is_set():
133 # app closed without firing callback,
153 # app closed without firing callback,
134 # probably due to last window being closed.
154 # probably due to last window being closed.
135 # Run the loop manually in this case,
155 # Run the loop manually in this case,
136 # since there may be events still to process (#9734)
156 # since there may be events still to process (#9734)
137 CoreFoundation.CFRunLoopRun()
157 CoreFoundation.CFRunLoopRun()
General Comments 0
You need to be logged in to leave comments. Login now