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

Last change on this file since 12313 was 12313, checked in by gb, 10 years ago

NSObjects that have slot vectors are initialized, even if they're
subclasses of CF-bridged classes.
If printing an uninitialized NSObject, show that fact in the printed
representation.

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