source: trunk/source/objc-bridge/objc-support.lisp @ 10959

Last change on this file since 10959 was 10959, checked in by gb, 11 years ago

Replace uses of target::nil-value with (CCL::TARGET-NIL-VALUE) and
target::t-value with (CCL::TARGET-T-VALUE).

This was very slightly hard to bootstrap (the new backend-lowmem-bias
had to be in effect and typically 0), so I'll start checking in images
in a minute.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 19.0 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2
3(in-package "CCL")
4
5(eval-when (:compile-toplevel :load-toplevel :execute)
6  (require "BRIDGE"))
7
8(defun allocate-objc-object (class)
9  (#/alloc class))
10
11(defun conforms-to-protocol (thing protocol)
12  (#/conformsToProtocol: thing (objc-protocol-address protocol)))
13
14
15
16
17#+apple-objc
18(defun iterate-over-objc-classes (fn)
19  (let* ((n (#_objc_getClassList (%null-ptr) 0)))
20    (declare (fixnum n))
21    (%stack-block ((buffer (the fixnum (ash n target::word-shift))))
22      (#_objc_getClassList buffer n)
23      (do* ((i 0 (1+ i)))
24           ((= i n) (values))
25        (declare (fixnum i))
26        (funcall fn (paref buffer (:* :id) i))))))
27
28#+apple-objc
29(defun count-objc-classes ()
30  (#_objc_getClassList (%null-ptr) 0)) 
31
32#+gnu-objc
33(defun iterate-over-objc-classes (fn)
34  (rletZ ((enum-state :address))
35    (loop
36      (let* ((class (#_objc_next_class enum-state)))
37        (if (%null-ptr-p class)
38          (return)
39          (funcall fn class))))))
40
41#+gnu-objc
42(defun count-objc-classes ()
43  (let* ((n 0))
44    (declare (fixnum n))
45    (rletZ ((enum-state :address))
46      (if (%null-ptr-p (#_objc_next_class enum-state))
47        (return n)
48        (incf n)))))
49
50(defun %note-protocol (p)
51  (with-macptrs ((cname (objc-message-send p "name" :address)))
52    (let* ((namelen (%cstrlen cname))
53           (name (make-string namelen)))
54      (declare (dynamic-extent name))
55      (%str-from-ptr cname namelen name)
56      (let* ((proto (or (gethash name *objc-protocols*)
57                        (progn
58                          (setq name (subseq name 0))
59                          (setf (gethash name *objc-protocols*)
60                                (make-objc-protocol :name name))))))
61        (unless (objc-protocol-address proto)
62          (setf (objc-protocol-address proto) (%inc-ptr p 0)))
63        proto))))
64
65(defun note-class-protocols (class)
66  #-apple-objc-2.0
67  (do* ((protocols (pref class :objc_class.protocols)
68                   (pref protocols :objc_protocol_list.next)))
69       ((%null-ptr-p protocols))
70    (let* ((count (pref protocols :objc_protocol_list.count)))
71      (with-macptrs ((list (pref protocols :objc_protocol_list.list)))
72        (dotimes (i count)
73          (with-macptrs ((p (paref list (:* (:* (:struct :<P>rotocol))) i)))
74            (%note-protocol p))))))
75  #+apple-objc-2.0
76  (rlet ((p-out-count :int))
77    (with-macptrs ((protocols (#_class_copyProtocolList class p-out-count)))
78      (let* ((n (pref p-out-count :int)))
79        (dotimes (i n)
80          (with-macptrs ((p (paref protocols (:* (:* (:struct :<P>rotocol))) i)))
81            (%note-protocol p))))
82      (unless (%null-ptr-p protocols) (#_free protocols)))))
83           
84
85(defun map-objc-classes (&optional (lookup-in-database-p t))
86  (iterate-over-objc-classes
87   #'(lambda (class)
88       (note-class-protocols class)
89       (install-foreign-objc-class class lookup-in-database-p))))
90
91(let* ((nclasses 0))
92  (declare (fixnum nclasses))
93  (defun maybe-map-objc-classes (&optional use-db)
94    (let* ((new (count-objc-classes)))
95      (declare (fixnum new))
96    (unless (= nclasses new)
97      (setq nclasses new)
98      (map-objc-classes use-db)
99      t)))
100  (defun reset-objc-class-count ()
101    (setq nclasses 0)))
102
103(register-objc-class-decls)
104(maybe-map-objc-classes t)
105(register-objc-init-messages)
106
107#+gnu-objc
108(defun iterate-over-class-methods (class method-function)
109  (do* ((mlist (pref class :objc_class.methods)
110               (pref mlist :objc_method_list.method_next)))
111       ((%null-ptr-p mlist))
112    (do* ((n (pref mlist :objc_method_list.method_count))
113          (i 0 (1+ i))
114          (method (pref mlist :objc_method_list.method_list)
115                  (%incf-ptr method (record-length :objc_method))))
116         ((= i n))
117      (declare (fixnum i n))
118      (funcall method-function method class))))
119
120#+gnu-objc
121(progn
122  ;; Er, um ... this needs lots-o-work.
123  (let* ((objc-class-count 0))
124    (defun reset-objc-class-count () (setq objc-class-count 0))
125    (defun note-all-library-methods (method-function)
126      (do* ((i objc-class-count (1+ i))
127            (class (id->objc-class i) (id->objc-class i)))
128           ((eq class 0))
129        (iterate-over-class-methods class method-function)
130        (iterate-over-class-methods (id->objc-metaclass i) method-function))))
131  (def-ccl-pointers revive-objc-classes ()
132    (reset-objc-class-count)))
133
134(defun retain-obcj-object (x)
135  (objc-message-send x "retain"))
136
137
138#+apple-objc-2.0
139(progn
140(defun setup-objc-exception-globals ()
141  (flet ((set-global (offset name)
142           (setf (%get-ptr (%int-to-ptr (+ (target-nil-value) (%kernel-global-offset offset))))
143                 (foreign-symbol-address name))))
144    (set-global 'x86::objc-2-personality "___objc_personality_v0")
145    (set-global 'x86::objc-2-begin-catch "_objc_begin_catch")
146    (set-global 'x86::objc-2-end-catch "_objc_end_catch")
147    (set-global 'x86::unwind-resume "__Unwind_Resume")))
148
149
150(def-ccl-pointers setup-objc-exception-handling ()
151  (setup-objc-exception-globals))
152
153(setup-objc-exception-globals)
154)
155
156
157(defvar *condition-id-map* (make-id-map) "Map lisp conditions to small integers")
158
159;;; Encapsulate an NSException in a lisp condition.
160(define-condition ns-exception (error)
161  ((ns-exception :initarg :ns-exception :accessor ns-exception))
162  (:report (lambda (c s)
163             (format s "Objective-C runtime exception: ~&~a"
164                     (nsobject-description (ns-exception c))))))
165
166
167
168(defclass ns-lisp-exception (ns::ns-exception)
169    ((condition :initarg :condition :initform nil :reader ns-lisp-exception-condition))
170  (:metaclass ns::+ns-object))
171
172(objc:defmethod #/init ((self ns-lisp-exception))
173  (#/initWithName:reason:userInfo: self #@"lisp exception" #@"lisp exception" +null-ptr+))
174
175
176(defun recognize-objc-exception (x)
177  (if (typep x 'ns:ns-exception)
178    (ns-exception->lisp-condition x)))
179
180(pushnew 'recognize-objc-exception *foreign-error-condition-recognizers*)
181
182(defun %make-nsstring-from-utf8-c-string (s)
183  (#/initWithUTF8String: (#/alloc ns:ns-string) s))
184
185
186(defun retain-objc-instance (instance)
187  (#/retain instance))
188
189;;; May have to create/release autorelease pools before the bridge
190;;; is fully reinitialized, so use low-level OBJC-MESSAGE-SEND
191;;; and @class.
192(defun create-autorelease-pool ()
193  (objc-message-send
194   (objc-message-send (@class "NSAutoreleasePool") "alloc") "init"))
195
196(defun release-autorelease-pool (p)
197  (objc-message-send p "release" :void))
198
199
200#-ascii-only
201(defun lisp-string-from-nsstring (nsstring)
202  ;; The NSData object created here is autoreleased.
203  (let* ((data (#/dataUsingEncoding:allowLossyConversion:
204                nsstring
205                #+little-endian-target #x9c000100
206                #+big-endian-target #x98000100
207                nil)))
208    (unless (%null-ptr-p data)
209      (let* ((nbytes (#/length data))
210             (string (make-string (ash nbytes -2))))
211        ;; BLT the 4-byte code-points from the NSData object
212        ;; to the string, return the string.
213        (%copy-ptr-to-ivector (#/bytes data) 0 string 0 nbytes)))))
214       
215
216
217#+ascii-only
218(defun lisp-string-from-nsstring (nsstring)
219  (with-macptrs (cstring)
220    (%setf-macptr cstring
221                  (#/cStringUsingEncoding: nsstring #$NSASCIIStringEncoding))
222    (unless (%null-ptr-p cstring)
223      (%get-cstring cstring))))
224
225
226(objc:defmethod #/reason ((self ns-lisp-exception))
227  (with-slots (condition) self
228    (if condition
229      (%make-nsstring (format nil "~A" condition))
230      (call-next-method))))
231
232(objc:defmethod #/description ((self ns-lisp-exception))
233  (#/stringWithFormat: ns:ns-string #@"Lisp exception: %@" (#/reason self)))
234
235
236                     
237(defun ns-exception->lisp-condition (nsexception)
238  (if (typep nsexception 'ns-lisp-exception)
239    (ns-lisp-exception-condition nsexception)
240    (make-condition 'ns-exception :ns-exception nsexception)))
241
242
243(defmethod ns-exception ((c condition))
244  "Map a lisp condition object to an NSException.  Note that instances
245of the NS-EXCEPTION condition class implement this by accessing an
246instance variable."
247  ;;; Create an NSLispException with a lispid that encapsulates
248  ;;; this condition.
249
250  ;; (dbg (format nil "~a" c))
251  ;;(#_NSLog #@"Lisp exception: %@" :id (%make-nsstring (format nil "~a" c)))
252  (make-instance 'ns-lisp-exception :condition c))
253
254
255
256#+apple-objc
257(progn
258
259
260#+ppc-target
261(defun objc-callback-error-return (condition return-value-pointer return-address-pointer)
262  ;; On PPC, the "address" of an external entry point is always
263  ;; aligned on a 32-bit word boundary.  On PPC32, it can always
264  ;; be represented as a fixnum; on PPC64, it might be a pointer
265  ;; instead.
266  ;; Note that this clobbers the actual (foreign) return address,
267  ;; replacing it with the address of #__NSRaiseError.  Note also
268  ;; that storing the NSException object as the return value has
269  ;; the desired effect of causing #__NSRaiseError to be called
270  ;; with that NSException as its argument (because r3 is used both
271  ;; as the canonical return value register and used to pass the
272  ;; first argument on PPC.)
273  (process-debug-condition *current-process* condition (%get-frame-ptr))
274  (let* ((addr (%reference-external-entry-point (load-time-value (external "__NSRaiseError")))))
275    (if (typep addr 'fixnum)
276      (%set-object return-address-pointer 0 addr)
277      (setf (%get-ptr return-address-pointer 0) addr)))
278  (setf (%get-ptr return-value-pointer 0) (ns-exception condition))
279  nil)
280
281#+x8664-target
282(progn
283(defloadvar *x8664-objc-callback-error-return-trampoline*
284    (let* ((code-bytes '(#x48 #x89 #xc7      ; movq %rax %rdi
285                         #x66 #x48 #x0f #x7e #xc0 ; movd %xmm0,%rax
286                         #x52                ; pushq %rdx
287                         #xff #xe0))         ; jmp *rax
288           (nbytes (length code-bytes))
289           (ptr (%allocate-callback-pointer 16)))
290      (dotimes (i nbytes ptr)
291        (setf (%get-unsigned-byte ptr i) (pop code-bytes)))))
292
293(defun objc-callback-error-return (condition return-value-pointer return-address-pointer) 
294  ;; The callback glue reserves space for %rax at return-value-pointer-8,
295  ;; for %rdx at -16, for %xmm0 at -24.  Store NS-EXCEPTION in the
296  ;; %rax slot, the address of #_objc_exception_throw in the %rdx slot, the
297  ;; original return address in the %xmm0 slot, and force a return to
298  ;; the trampoline code above.
299  (process-debug-condition *current-process* condition (%get-frame-ptr))
300  (setf (%get-ptr return-value-pointer -8) (ns-exception condition)
301        (%get-ptr return-value-pointer -16) (%get-ptr return-address-pointer 0)
302        (%get-ptr return-address-pointer 0) *x8664-objc-callback-error-return-trampoline*)
303  ;; A foreign entry point is always an integer on x8664.
304  (let* ((addr (%reference-external-entry-point (load-time-value (external "_objc_exception_throw")))))
305    (if (< addr 0)                      ;unlikely
306      (setf (%%get-signed-longlong return-value-pointer -24) addr)
307      (setf (%%get-unsigned-longlong return-value-pointer -24) addr)))
308  nil)
309
310
311)
312
313#+x8632-target
314(progn
315
316(defloadvar *x8632-objc-callback-error-return-trampoline*
317    (let* ((code-bytes '(#x83 #xec #x10      ; subl $16,%esp
318                         #x89 #x04 #x24      ; movl %eax,(%esp)
319                         #x52                ; pushl %edx
320                         #xff #xe1))         ; jmp *ecx
321           (nbytes (length code-bytes))
322           (ptr (%allocate-callback-pointer 16)))
323      (dotimes (i nbytes ptr)
324        (setf (%get-unsigned-byte ptr i) (pop code-bytes)))))
325
326(defun objc-callback-error-return (condition return-value-pointer return-address-pointer)
327  (process-debug-condition *current-process* condition (%get-frame-ptr))
328  (let* ((addr (%reference-external-entry-point (load-time-value (external "__NSRaiseError")))))
329    (setf (%get-unsigned-long return-value-pointer -12 ) addr))
330  (setf (%get-ptr return-value-pointer -8) (ns-exception condition)
331        (%get-ptr return-value-pointer -4) (%get-ptr return-address-pointer)
332        (%get-ptr return-address-pointer) *x8632-objc-callback-error-return-trampoline*)
333  nil)
334)
335
336)
337
338
339
340(defun open-main-bundle ()
341  (#/mainBundle ns:ns-bundle))
342
343;;; Create a new immutable dictionary just like src, replacing the
344;;; value of each key in key-value-pairs with the corresponding value.
345(defun copy-dictionary (src &rest key-value-pairs)
346  (declare (dynamic-extent key-value-pairs))
347  ;(#_NSLog #@"src = %@" :id src)
348  (let* ((count (#/count src))
349         (enum (#/keyEnumerator src))
350         (keys (#/arrayWithCapacity: ns:ns-mutable-array count))
351         (values (#/arrayWithCapacity: ns:ns-mutable-array count)))
352    (loop
353        (let* ((nextkey (#/nextObject enum)))
354          (when (%null-ptr-p nextkey)
355            (return))
356          (do* ((kvps key-value-pairs (cddr kvps))
357                (newkey (car kvps) (car kvps))
358                (newval (cadr kvps) (cadr kvps)))
359               ((null kvps)
360                ;; Copy the key, value pair from the src dict
361                (#/addObject: keys nextkey)
362                (#/addObject: values (#/objectForKey: src nextkey)))
363            (when (#/isEqualToString: nextkey newkey)
364              (#/addObject: keys nextkey)
365              (#/addObject: values newval)
366              (return)))))
367    (make-instance 'ns:ns-dictionary
368                   :with-objects values
369                   :for-keys keys)))
370
371
372(defun nsobject-description (nsobject)
373  "Returns a lisp string that describes nsobject.  Note that some
374NSObjects describe themselves in more detail than others."
375  (with-autorelease-pool
376      (lisp-string-from-nsstring  (#/description nsobject))))
377
378
379
380
381;;; This can fail if the nsstring contains non-8-bit characters.
382(defun lisp-string-from-nsstring-substring (nsstring start length)
383  (%stack-block ((cstring (1+ length)))
384    (#/getCString:maxLength:range:remainingRange:
385       nsstring  cstring  length (ns:make-ns-range start length) +null-ptr+)
386    (%get-cstring cstring)))
387
388(def-standard-initial-binding *listener-autorelease-pool* nil)
389
390(setq *listener-autorelease-pool* (create-autorelease-pool))
391
392(define-toplevel-command :global rap () "Release and reestablish *LISTENER-AUTORELEASE-POOL*"
393  (when (eql *break-level* 0)
394    (without-interrupts
395     (when (boundp '*listener-autorelease-pool*)
396       (let* ((old *listener-autorelease-pool*))
397         (if old (release-autorelease-pool old))
398         (setq *listener-autorelease-pool* (create-autorelease-pool)))))))
399
400#+apple-objc
401(defun show-autorelease-pools ()
402  (objc-message-send (@class ns-autorelease-pool) "showPools" :void))
403
404#+gnu-objc
405(defun show-autorelease-pools ()
406  (do* ((current (objc-message-send (@class ns-autorelease-pool) "currentPool")
407                 (objc-message-send current "_parentAutoreleasePool"))
408        (i 0 (1+ i)))
409       ((%null-ptr-p current) (values))
410    (format t "~& ~d : ~a [~d]"
411            i
412            (nsobject-description current)
413            (pref current :<NSA>utorelease<P>ool._released_count))))
414
415(define-toplevel-command :global sap () "Log information about current thread's autorelease-pool(s) to C's standard error stream"
416  (show-autorelease-pools))
417
418(define-toplevel-command :global kap () "Release (but don't reestablish) *LISTENER-AUTORELEASE-POOL*"
419  (when (eql *break-level* 0)
420    (without-interrupts
421     (when (boundp '*listener-autorelease-pool*)
422       (let* ((p *listener-autorelease-pool*))
423         (setq *listener-autorelease-pool* nil)
424         (release-autorelease-pool p))))))
425
426;;; Use the interfaces for an add-on ObjC framework.  We need to
427;;; tell the bridge to reconsider what it knows about the type
428;;; signatures of ObjC messages, since the new headers may define
429;;; a method whose type signature differs from the message's existing
430;;; methods.  (This probably doesn't happen too often, but it's
431;;; possible that some SENDs that have already been compiled would
432;;; need to be recompiled with that augmented method type info, e.g.,
433;;; because ambiguity was introduced.)
434
435(defun augment-objc-interfaces (dirname)
436  (use-interface-dir dirname)
437  (register-objc-class-decls)
438  (update-objc-method-info))
439
440;;; A list of "standard" locations which are known to contain
441;;; framework bundles.  We should look in ~/Library/Frameworks/" first,
442;;; if it exists.
443(defparameter *standard-framework-directories*
444  (list #p"/Library/Frameworks/"
445        #p"/System/Library/Frameworks/"))
446
447
448
449;;; This has to run during application (re-)initializtion, so it
450;;; uses lower-level bridge features.
451(defun %reload-objc-framework (path)
452  (when (probe-file path)
453    (let* ((namestring (native-translated-namestring path)))
454      (with-cstrs ((cnamestring namestring))
455        (with-nsstr (nsnamestring cnamestring (length namestring))
456          (with-autorelease-pool
457              (let* ((bundle (objc-message-send (@class "NSBundle")
458                                                "bundleWithPath:"
459                                                :id nsnamestring :id)))
460                (unless (%null-ptr-p bundle)
461                  (objc-message-send bundle "load" :<BOOL>)))))))))
462
463
464(defun load-objc-extension-framework (name)
465  (let* ((dirs *standard-framework-directories*)
466         (home-frameworks (make-pathname :defaults nil
467                                         :directory
468                                         (append (pathname-directory
469                                                  (user-homedir-pathname))
470                                                 '("Library" "Frameworks"))))
471         (fname (list (format nil "~a.framework" name))))
472    (when (probe-file home-frameworks)
473      (pushnew home-frameworks dirs :test #'equalp))
474    (dolist (d dirs)
475      (let* ((path (probe-file (make-pathname :defaults nil
476                                              :directory (append (pathname-directory d)
477                                                                 fname)))))
478        (when path
479          (let* ((namestring (native-translated-namestring path)))
480            (with-cstrs ((cnamestring namestring))
481              (with-nsstr (nsnamestring cnamestring (length namestring))
482                (with-autorelease-pool
483                    (let* ((bundle (#/bundleWithPath: ns:ns-bundle nsnamestring))
484                           (winning (unless (%null-ptr-p bundle)
485                                      t)))
486                      (when winning
487                        (let* ((libpath (#/executablePath bundle)))
488                          (unless (%null-ptr-p libpath)
489                            (open-shared-library (lisp-string-from-nsstring
490                                                  libpath))))
491                        (#/load bundle)
492                        (pushnew path *extension-framework-paths*
493                                 :test #'equalp)
494                        (map-objc-classes)
495                        ;; Update info about init messages.
496                        (register-objc-init-messages))
497                      (return winning)))))))))))
498
499(defun objc:load-framework (framework-name interfaces-name)
500  (use-interface-dir interfaces-name)
501  (or (load-objc-extension-framework framework-name)
502      (error "Can't load ObjC framework ~s" framework-name))
503  (augment-objc-interfaces interfaces-name))
504
505                     
506(defmethod print-object ((p ns:protocol) stream)
507  (print-unreadable-object (p stream :type t)
508    (format stream "~a (#x~x)"
509            (%get-cstring (#/name p))
510            (%ptr-to-int p))))
511
512                                         
513(defmethod terminate ((instance objc:objc-object))
514  (objc-message-send instance "release"))
515
516
517(provide "OBJC-SUPPORT")
Note: See TracBrowser for help on using the repository browser.