source: branches/objc-gf/ccl/examples/objc-runtime.lisp @ 6130

Last change on this file since 6130 was 6130, checked in by gb, 13 years ago

Use MAKE-INSTANCE vice MAKE-OBJC-INSTANCE in example code.
Try to avoid SLET, SEND, DEFINE-OBJC-METHOD.
Demo IDE "works" (modulo backtrace) on x86-64 Leopard, bridge
still needs work on PPC.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 95.5 KB
Line 
1;;;-*-Mode: LISP; Package: CCL -*-
2;;;
3;;;   Copyright (C) 2002-2003 Clozure Associates
4;;;   This file is part of OpenMCL. 
5;;;
6;;;   OpenMCL is licensed under the terms of the Lisp Lesser GNU Public
7;;;   License , known as the LLGPL and distributed with OpenMCL as the
8;;;   file "LICENSE".  The LLGPL consists of a preamble and the LGPL,
9;;;   which is distributed with OpenMCL as the file "LGPL".  Where these
10;;;   conflict, the preamble takes precedence. 
11;;;
12;;;   OpenMCL is referenced in the preamble as the "LIBRARY."
13;;;
14;;;   The LLGPL is also available online at
15;;;   http://opensource.franz.com/preamble.html
16
17
18(in-package "CCL")
19
20
21;;; Utilities for interacting with the Apple/GNU Objective-C runtime
22;;; systems.
23
24(eval-when (:compile-toplevel :load-toplevel :execute)
25  #+darwin-target (pushnew :apple-objc *features*)
26  #+(and darwin-target 64-bit-target) (pushnew :apple-objc-2.0 *features*)
27  #-darwin-target (pushnew :gnu-objc *features*))
28
29
30(eval-when (:compile-toplevel :load-toplevel :execute)
31  (set-dispatch-macro-character
32   #\#
33   #\@
34   (nfunction
35    |objc-#@-reader|
36    (lambda (stream subchar numarg)
37      (declare (ignore subchar numarg))
38      (let* ((string (read stream)))
39        (unless *read-suppress*
40          (check-type string string)
41          `(@ ,string)))))))
42
43(eval-when (:compile-toplevel :execute)
44  #+apple-objc
45  (progn
46    (use-interface-dir :cocoa)
47    (use-interface-dir :carbon))        ; need :carbon for things in this file
48  #+gnu-objc
49  (use-interface-dir :gnustep))
50
51
52
53(eval-when (:compile-toplevel :load-toplevel :execute)
54  (require "OBJC-PACKAGE")
55  (require "SPLAY-TREE")
56  (require "NAME-TRANSLATION")
57  (require "OBJC-CLOS"))
58
59(defloadvar *NSApp* nil )
60
61;;; Apple ObjC 2.0 provides (#_objc_getProtocol name).  In other
62;;; runtimes, there doesn't seem to be any way to find a Protocol
63;;; object given its name.  We need to be able to ask at runtime
64;;; whether a given object conforms to a protocol in order to
65;;; know when a protocol method is ambiguous, at least when the
66;;; message contains ambiguous methods and some methods are protocol
67;;; methods
68(defloadvar *objc-protocols* (make-hash-table :test #'equal))
69
70(defstruct objc-protocol
71  name
72  address)
73
74(defun lookup-objc-protocol (name)
75  (values (gethash name *objc-protocols*)))
76
77(defun ensure-objc-classptr-resolved (classptr)
78  #+apple-objc (declare (ignore classptr))
79  #+gnu-objc
80  (unless (logtest #$_CLS_RESOLV (pref classptr :objc_class.info))
81    (external-call "__objc_resolve_class_links" :void)))
82
83
84
85(defstruct private-objc-class-info
86  name
87  declared-ancestor)
88
89(defun compute-objc-direct-slots-from-info (info class)
90  (let* ((ns-package (find-package "NS")))
91    (mapcar #'(lambda (field)
92                (let* ((name (compute-lisp-name (unescape-foreign-name
93                                                 (foreign-record-field-name
94                                                  field))
95                                                ns-package))
96
97                       (type (foreign-record-field-type field))
98                       (offset (progn
99                                    (ensure-foreign-type-bits type)
100                                    (foreign-record-field-offset field))))
101                  (make-instance 'foreign-direct-slot-definition
102                                 :initfunction #'false
103                                 :initform nil
104                                 :name name
105                                 :foreign-type type
106                                 :class class
107                                 :bit-offset offset
108                                 :allocation :instance)))
109            (db-objc-class-info-ivars info))))
110
111
112(defun %ptr< (x y)
113  (< (the (unsigned-byte #+64-bit-target 64 #+32-bit-target 32)
114       (%ptr-to-int x))
115     (the (unsigned-byte #+64-bit-target 64 #+32-bit-target 32)
116       (%ptr-to-int Y))))
117
118(let* ((objc-class-map (make-splay-tree #'%ptr-eql #'%ptr<))
119       (objc-metaclass-map (make-splay-tree #'%ptr-eql #'%ptr<))
120       ;;; These are NOT lisp classes; we mostly want to keep track
121       ;;; of them so that we can pretend that instances of them
122       ;;; are instances of some known (declared) superclass.
123       (private-objc-classes (make-splay-tree #'%ptr-eql #'%ptr<))
124       (objc-class-lock (make-lock))
125       (next-objc-class-id 0)
126       (next-objc-metaclass-id 0)
127       (class-table-size 1024)
128       (c (make-array class-table-size))
129       (m (make-array class-table-size))
130       (cw (make-array 1024 :initial-element nil))
131       (mw (make-array 1024 :initial-element nil))
132       (csv (make-array 1024))
133       (msv (make-array 1024))
134       (class-id->metaclass-id (make-array 1024 :initial-element nil))
135       (class-foreign-names (make-array 1024))
136       (metaclass-foreign-names (make-array 1024))
137       )
138
139  (flet ((grow-vectors ()
140           (let* ((old-size class-table-size)
141                  (new-size (* 2 old-size)))
142             (declare (fixnum old-size new-size))
143             (macrolet ((extend (v)
144                              `(setq ,v (%extend-vector old-size ,v new-size))))
145                   (extend c)
146                   (extend m)
147                   (extend cw)
148                   (extend mw)
149                   (fill cw nil :start old-size :end new-size)
150                   (fill mw nil :start old-size :end new-size)
151                   (extend csv)
152                   (extend msv)
153                   (extend class-id->metaclass-id)
154                   (fill class-id->metaclass-id nil :start old-size :end new-size)
155                   (extend class-foreign-names)
156                   (extend metaclass-foreign-names))
157             (setq class-table-size new-size))))
158    (flet ((assign-next-class-id ()
159             (let* ((id next-objc-class-id))
160               (if (= (incf next-objc-class-id) class-table-size)
161                 (grow-vectors))
162               id))
163           (assign-next-metaclass-id ()
164             (let* ((id next-objc-metaclass-id))
165               (if (= (incf next-objc-metaclass-id) class-table-size)
166                 (grow-vectors))
167               id)))
168      (defun id->objc-class (i)
169        (svref c i))
170      (defun (setf id->objc-class) (new i)
171        (setf (svref c i) new))
172      (defun id->objc-metaclass (i)
173        (svref m i))
174      (defun (setf id->objc-metaclass) (new i)
175        (setf (svref m i) new))
176      (defun id->objc-class-wrapper (i)
177        (svref cw i))
178      (defun (setf id->objc-class-wrapper) (new i)
179        (setf (svref cw i) new))
180      (defun id->objc-metaclass-wrapper (i)
181        (svref mw i))
182      (defun (setf id->objc-metaclass-wrapper) (new i)
183        (setf (svref mw i) new))
184      (defun id->objc-class-slots-vector (i)
185        (svref csv i))
186      (defun (setf id->objc-class-slots-vector) (new i)
187        (setf (svref csv i) new))
188      (defun id->objc-metaclass-slots-vector (i)
189        (svref msv i))
190      (defun (setf id->objc-metaclass-slots-vector) (new i)
191        (setf (svref msv i) new))
192      (defun objc-class-id-foreign-name (i)
193        (svref class-foreign-names i))
194      (defun (setf objc-class-id-foreign-name) (new i)
195        (setf (svref class-foreign-names i) new))
196      (defun objc-metaclass-id-foreign-name (i)
197        (svref metaclass-foreign-names i))
198      (defun (setf objc-metaclass-id-foreign-name) (new i)
199        (setf (svref metaclass-foreign-names i) new))
200      (defun %clear-objc-class-maps ()
201        (with-lock-grabbed (objc-class-lock)
202          (setf (splay-tree-root objc-class-map) nil
203                (splay-tree-root objc-metaclass-map) nil
204                (splay-tree-root private-objc-classes) nil
205                (splay-tree-count objc-class-map) 0
206                (splay-tree-count objc-metaclass-map) 0
207                (splay-tree-count private-objc-classes) 0)))
208      (flet ((install-objc-metaclass (meta)
209               (or (splay-tree-get objc-metaclass-map meta)
210                   (let* ((id (assign-next-metaclass-id))
211                          (meta (%inc-ptr meta 0)))
212                     (splay-tree-put objc-metaclass-map meta id)
213                     (setf (svref m id) meta
214                           (svref msv id)
215                           (make-objc-metaclass-slots-vector meta))
216                     id))))
217        (defun register-objc-class (class)
218          "ensure that the class is mapped to a small integer and associate a slots-vector with it."
219          (with-lock-grabbed (objc-class-lock)
220            (ensure-objc-classptr-resolved class)
221            (or (splay-tree-get objc-class-map class)
222                (let* ((id (assign-next-class-id))
223                       (class (%inc-ptr class 0))
224                       (meta (pref class #+apple-objc :objc_class.isa #+gnu-objc :objc_class.class_pointer)))
225                  (splay-tree-put objc-class-map class id)
226                  (setf (svref c id) class
227                        (svref csv id)
228                        (make-objc-class-slots-vector class)
229                        (svref class-id->metaclass-id id)
230                        (install-objc-metaclass meta))
231                  id)))))
232      (defun objc-class-id (class)
233        (with-lock-grabbed (objc-class-lock)
234          (splay-tree-get objc-class-map class)))
235      (defun objc-metaclass-id (meta)
236        (with-lock-grabbed (objc-class-lock)
237          (splay-tree-get objc-metaclass-map meta)))
238      (defun objc-class-id->objc-metaclass-id (class-id)
239        (svref class-id->metaclass-id class-id))
240      (defun objc-class-id->objc-metaclass (class-id)
241        (svref m (svref class-id->metaclass-id class-id)))
242      (defun objc-class-map () objc-class-map)
243      (defun %objc-class-count () next-objc-class-id)
244      (defun objc-metaclass-map () objc-metaclass-map)
245      (defun %objc-metaclass-count () next-objc-metaclass-id)
246      (defun %register-private-objc-class (c name)
247        (splay-tree-put private-objc-classes c (make-private-objc-class-info :name name)))
248      (defun %get-private-objc-class (c)
249        (splay-tree-get private-objc-classes c))
250      (defun (setf %get-private-objc-class) (public c)
251        (let* ((node (binary-tree-get private-objc-classes c)))
252          (if node
253            (setf (tree-node-value node) public)
254            (error "Private class ~s not found" c))))
255      (defun private-objc-classes ()
256        private-objc-classes))))
257
258(pushnew #'%clear-objc-class-maps *save-exit-functions* :test #'eq
259         :key #'function-name)
260
261(defun do-all-objc-classes (f)
262  (map-splay-tree (objc-class-map) #'(lambda (id)
263                                       (funcall f (id->objc-class id)))))
264
265(defun canonicalize-registered-class (c)
266  (let* ((id (objc-class-id c)))
267    (if id
268      (id->objc-class id)
269      (error "Class ~S isn't recognized." c))))
270
271(defun canonicalize-registered-metaclass (m)
272  (let* ((id (objc-metaclass-id m)))
273    (if id
274      (id->objc-metaclass id)
275      (error "Class ~S isn't recognized." m))))
276
277(defun canonicalize-registered-class-or-metaclass (x)
278  (if (%objc-metaclass-p x)
279    (canonicalize-registered-metaclass x)
280    (canonicalize-registered-class x)))
281
282
283;;; Open shared libs.
284#+darwin-target
285(progn
286(defloadvar *cocoa-event-process* *initial-process*)
287
288
289(defun current-ns-thread ()
290  (with-cstrs ((class-name "NSThread")
291               (message-selector-name "currentThread"))
292    (let* ((nsthread-class (#_objc_lookUpClass class-name))
293           (message-selector (#_sel_getUid message-selector-name)))
294      (#_objc_msgSend nsthread-class message-selector)
295      nil)))
296 
297(defun create-void-nsthread ()
298  ;; Create an NSThread which does nothing but exit.
299  ;; This'll help to convince the AppKit that we're
300  ;; multitheaded.  (A lot of other things, including
301  ;; the ObjC runtime, seem to have already noticed.)
302  (with-cstrs ((thread-class-name "NSThread")
303               (pool-class-name "NSAutoreleasePool")
304               (thread-message-selector-name "detachNewThreadSelector:toTarget:withObject:")
305               (exit-selector-name "exit")
306               (alloc-selector-name "alloc")
307               (init-selector-name "init")
308               (release-selector-name "release"))
309    (let* ((nsthread-class (#_objc_lookUpClass thread-class-name))
310           (pool-class (#_objc_lookUpClass pool-class-name))
311           (thread-message-selector (#_sel_getUid thread-message-selector-name))
312           (exit-selector (#_sel_getUid exit-selector-name))
313           (alloc-selector (#_sel_getUid alloc-selector-name))
314           (init-selector (#_sel_getUid init-selector-name))
315           (release-selector (#_sel_getUid release-selector-name))
316           (pool (#_objc_msgSend
317                  (#_objc_msgSend pool-class
318                                  alloc-selector)
319                  init-selector)))
320      (unwind-protect
321           (#_objc_msgSend nsthread-class thread-message-selector
322                           :address exit-selector
323                           :address nsthread-class
324                           :address (%null-ptr))
325        (#_objc_msgSend pool release-selector))
326      nil)))
327
328(defun run-in-cocoa-process-and-wait  (f)
329  (let* ((process *cocoa-event-process*)
330         (success (cons nil nil))
331         (done (make-semaphore)))
332    (process-interrupt process #'(lambda ()
333                                   (unwind-protect
334                                        (progn
335                                          (setf (car success) (funcall f)))
336                                     (signal-semaphore done))))
337    (wait-on-semaphore done)
338    (car success)))
339
340
341(def-ccl-pointers cocoa-framework ()
342  (run-in-cocoa-process-and-wait
343   #'(lambda ()
344       ;; We need to load and "initialize" the CoreFoundation library
345       ;; in the thread that's going to process events.  Looking up a
346       ;; symbol in the library should cause it to be initialized
347       (open-shared-library "/System/Library/Frameworks/Cocoa.framework/Cocoa")
348       ;(#_GetCurrentEventQueue)
349       (current-ns-thread)
350       (create-void-nsthread))))
351
352
353(defun find-cfstring-sections ()
354  (warn "~s is obsolete" 'find-cfstring-sections))
355
356)
357
358#+gnu-objc
359(progn
360(defparameter *gnustep-system-root* "/usr/GNUstep/" "The root of all evil.")
361(defparameter *gnustep-libraries-pathname*
362  (merge-pathnames "System/Library/Libraries/" *gnustep-system-root*))
363
364(defloadvar *pending-loaded-classes* ())
365
366(defcallback register-class-callback (:address class :address category :void)
367  (let* ((id (map-objc-class class)))
368    (unless (%null-ptr-p category)
369      (let* ((cell (or (assoc id *pending-loaded-classes*)
370                       (let* ((c (list id)))
371                         (push c *pending-loaded-classes*)
372                         c))))
373        (push (%inc-ptr category 0) (cdr cell))))))
374
375;;; Shouldn't really be GNU-objc-specific.
376
377(defun get-c-format-string (c-format-ptr c-arg-ptr)
378  (do* ((n 128))
379       ()
380    (declare (fixnum n))
381    (%stack-block ((buf n))
382      (let* ((m (#_vsnprintf buf n c-format-ptr c-arg-ptr)))
383        (declare (fixnum m))
384        (cond ((< m 0) (return nil))
385              ((< m n) (return (%get-cstring buf)))
386              (t (setq n m)))))))
387
388
389
390(defun init-gnustep-framework ()
391  (or (getenv "GNUSTEP_SYSTEM_ROOT")
392      (setenv "GNUSTEP_SYSTEM_ROOT" *gnustep-system-root*))
393  (open-shared-library "libobjc.so.1")
394  (setf (%get-ptr (foreign-symbol-address "_objc_load_callback"))
395        register-class-callback)
396  (open-shared-library (namestring (merge-pathnames "libgnustep-base.so"
397                                                    *gnustep-libraries-pathname*)))
398  (open-shared-library (namestring (merge-pathnames "libgnustep-gui.so"
399                                                    *gnustep-libraries-pathname*))))
400
401(def-ccl-pointers gnustep-framework ()
402  (init-gnustep-framework))
403)
404
405(defun get-appkit-version ()
406  #+apple-objc
407  #&NSAppKitVersionNumber
408  #+gnu-objc
409  (get-foundation-version))
410
411(defun get-foundation-version ()
412  #&NSFoundationVersionNumber
413  #+gnu-objc (%get-cstring (foreign-symbol-address "gnustep_base_version")))
414
415(defparameter *appkit-library-version-number* (get-appkit-version))
416(defparameter *foundation-library-version-number* (get-foundation-version))
417
418(defparameter *extension-framework-paths* ())
419
420;;; An instance of NSConstantString (which is a subclass of NSString)
421;;; consists of a pointer to the NSConstantString class (which the
422;;; global "_NSConstantStringClassReference" conveniently refers to), a
423;;; pointer to an array of 8-bit characters (doesn't have to be #\Nul
424;;; terminated, but doesn't hurt) and the length of that string (not
425;;; counting any #\Nul.)
426;;; The global reference to the "NSConstantString" class allows us to
427;;; make instances of NSConstantString, ala the @"foo" construct in
428;;; ObjC.  Sure it's ugly, but it seems to be exactly what the ObjC
429;;; compiler does.
430
431
432(defloadvar *NSConstantString-class*
433  (with-cstrs ((name "NSConstantString"))
434    #+apple-objc (#_objc_lookUpClass name)
435    #+gnu-objc (#_objc_lookup_class name)))
436
437
438
439
440#+apple-objc
441(progn
442;;; NSException-handling stuff.
443;;; First, we have to jump through some hoops so that #_longjmp can
444;;; jump through some hoops (a jmp_buf) and wind up throwing to a
445;;; lisp catch tag.
446
447;;; These constants (offsets in the jmp_buf structure) come from
448;;; the _setjmp.h header file in the Darwin LibC source.
449
450#+ppc32-target
451(progn
452(defconstant JMP-lr #x54 "link register (return address) offset in jmp_buf")
453#|(defconstant JMP-ctr #x5c "count register jmp_buf offset")|#
454(defconstant JMP-sp 0 "stack pointer offset in jmp_buf")
455(defconstant JMP-r14 12 "offset of r14 (which we clobber) in jmp_buf")
456(defconstant JMP-r15 16 "offset of r14 (which we also clobber) in jmp_buf"))
457
458#+ppc64-target
459(progn
460(defconstant JMP-lr #xa8 "link register (return address) offset in jmp_buf")
461#|(defconstant JMP-ctr #x5c "count register jmp_buf offset")|#
462(defconstant JMP-sp 0 "stack pointer offset in jmp_buf")
463(defconstant JMP-r13 #x10 "offset of r13 (which we preserve) in jmp_buf")
464(defconstant JMP-r14 #x18 "offset of r14 (which we clobber) in jmp_buf")
465(defconstant JMP-r15 #x20 "offset of r15 (which we also clobber) in jmp_buf"))
466
467;;; These constants also come from Libc sources.  Hey, who needs
468;;; header files ?
469#+x8664-target
470(progn
471(defconstant JB-RBX 0)
472(defconstant JB-RBP 8)
473(defconstant JB-RSP 16)
474(defconstant JB-R12 24)
475(defconstant JB-R13 32)
476(defconstant JB-R14 40)
477(defconstant JB-R15 48)
478(defconstant JB-RIP 56)
479(defconstant JB-RFLAGS 64)
480(defconstant JB-MXCSR 72)
481(defconstant JB-FPCONTROL 76)
482(defconstant JB-MASK 80)
483)
484
485
486 
487
488;;; A malloc'ed pointer to thre words of machine code.  The first
489;;; instruction copies the address of the trampoline callback from r14
490;;; to the count register.  The second instruction (rather obviously)
491;;; copies r15 to r4.  A C function passes its second argument in r4,
492;;; but since r4 isn't saved in a jmp_buf, we have to do this copy.
493;;; The second instruction just jumps to the address in the count
494;;; register, which is where we really wanted to go in the first
495;;; place.
496
497#+ppc-target
498(macrolet ((ppc-lap-word (instruction-form)
499             (uvref (uvref (compile nil
500                                    `(lambda (&lap 0)
501                                      (ppc-lap-function () ((?? 0))
502                                       ,instruction-form)))
503                           0) #+ppc64-target 1 #+ppc32-target 0)))
504  (defloadvar *setjmp-catch-lr-code*
505      (let* ((p (malloc 12)))
506        (setf (%get-unsigned-long p 0) (ppc-lap-word (mtctr 14))
507              (%get-unsigned-long p 4) (ppc-lap-word (mr 4 15))
508              (%get-unsigned-long p 8) (ppc-lap-word (bctr)))
509        ;;; Force this code out of the data cache and into memory, so
510        ;;; that it'll get loaded into the icache.
511        (ff-call (%kernel-import #.target::kernel-import-makedataexecutable) 
512                 :address p 
513                 :unsigned-fullword 12
514                 :void)
515        p)))
516
517#+x8664-target
518(defloadvar *setjmp-catch-rip-code*
519    (let* ((code-bytes '(#x4c #x89 #xe6     ; movq %r12, %rsi
520                         #xff #xd3))        ; call *%rbx
521           (nbytes (length code-bytes))
522           (p (malloc nbytes)))
523      (dotimes (i nbytes p)
524        (setf (%get-unsigned-byte p i) (pop code-bytes)))))
525         
526
527;;; Catch frames are allocated on a stack, so it's OK to pass their
528;;; addresses around to foreign code.
529(defcallback throw-to-catch-frame (:signed-fullword value
530                                   :address frame
531                                   :void)
532  (throw (%get-object frame target::catch-frame.catch-tag) value))
533
534;;; Initialize a jmp_buf so that when it's #_longjmp-ed to, it'll
535;;; wind up calling THROW-TO-CATCH-FRAME with the specified catch
536;;; frame as its second argument.  The C frame used here is just
537;;; an empty C stack frame from which the callback will be called.
538
539#+ppc-target
540(defun %associate-jmp-buf-with-catch-frame (jmp-buf catch-frame c-frame)
541  (%set-object jmp-buf JMP-sp c-frame)
542  (%set-object jmp-buf JMP-r15 catch-frame)
543  #+ppc64-target
544  (%set-object jmp-buf JMP-r13 (%get-os-context))
545  (setf (%get-ptr jmp-buf JMP-lr) *setjmp-catch-lr-code*
546        (%get-ptr jmp-buf JMP-r14) throw-to-catch-frame)
547  t)
548
549#+x8664-target
550(defun %associate-jmp-buf-with-catch-frame (jmp-buf catch-frame c-frame)
551  (setf (%get-ptr jmp-buf JB-rbx) throw-to-catch-frame
552        (%get-ptr jmp-buf JB-rip) *setjmp-catch-rip-code*)
553  (setf (%get-unsigned-long jmp-buf JB-mxcsr) #x1f80
554        (%get-unsigned-long jmp-buf JB-fpcontrol) #x37f)
555  (%set-object jmp-buf JB-RSP c-frame)
556  (%set-object jmp-buf JB-RBP c-frame)
557  (%set-object jmp-buf JB-r12 catch-frame)
558  t)
559
560
561)
562
563;;; When starting up an image that's had ObjC classes in it, all of
564;;; those canonical classes (and metaclasses) will have had their type
565;;; changed (by SAVE-APPLICATION) to, CCL::DEAD-MACPTR and the addresses
566;;; of those classes may be bogus.  The splay trees (objc-class/metaclass-map)
567;;; should be empty.
568;;; For each class that -had- had an assigned ID, determine its ObjC
569;;; class name, and ask ObjC where (if anywhere) the class is now.
570;;; If we get a non-null answer, revive the class pointer and set its
571;;; address appropriately, then add an entry to the splay tree; this
572;;; means that classes that existed on both sides of SAVE-APPLICATION
573;;; will retain the same ID.
574
575(defun revive-objc-classes ()
576  ;; We need to do some things so that we can use (@class ...)
577  ;; and (@selector ...) early.
578  (invalidate-objc-class-descriptors)
579  (clear-objc-selectors)
580  ;; Ensure that any addon frameworks are loaded.
581  (dolist (path *extension-framework-paths*)
582    (%reload-objc-framework path))
583  ;; Make a first pass over the class and metaclass tables;
584  ;; resolving those foreign classes that existed in the old
585  ;; image and still exist in the new.
586  (let* ((class-map (objc-class-map))
587         (metaclass-map (objc-metaclass-map))
588         (nclasses (%objc-class-count)))
589    (dotimes (i nclasses)
590      (let* ((c (id->objc-class i))
591             (meta-id (objc-class-id->objc-metaclass-id i))
592             (m (id->objc-metaclass meta-id)))
593        (%revive-macptr c)
594        (%revive-macptr m)
595        (unless (splay-tree-get class-map c)
596          (%set-pointer-to-objc-class-address (objc-class-id-foreign-name i) c)
597          ;; If the class is valid and the metaclass is still a
598          ;; unmapped, set the metaclass pointer's address and map it.
599          (unless (%null-ptr-p c)
600            (splay-tree-put class-map c i)
601            (unless (splay-tree-get metaclass-map m)
602              (%setf-macptr m (pref c #+apple-objc :objc_class.isa
603                                      #+gnu-objc :objc_class.class_pointer))
604              (splay-tree-put metaclass-map m meta-id))))))
605    ;; Second pass: install class objects for user-defined classes,
606    ;; assuming the superclasses are already "revived".  If the
607    ;; superclass is itself user-defined, it'll appear first in the
608    ;; class table; that's an artifact of the current implementation.
609    (dotimes (i nclasses)
610      (let* ((c (id->objc-class i)))
611        (when (and (%null-ptr-p c)
612                   (not (slot-value c 'foreign)))
613          (let* ((super (dolist (s (class-direct-superclasses c)
614                                 (error "No ObjC superclass of ~s" c))
615                          (when (objc-class-p s) (return s))))
616                 (meta-id (objc-class-id->objc-metaclass-id i))
617                 (m (id->objc-metaclass meta-id)))
618            (let* ((class (make-objc-class-pair super (make-cstring (objc-class-id-foreign-name i))))
619                   (meta (pref class #+apple-objc :objc_class.isa
620                               #+gnu-objc :objc-class.class_pointer)))
621            (unless (splay-tree-get metaclass-map m)
622              (%revive-macptr m)
623              (%setf-macptr m meta)
624              (splay-tree-put metaclass-map m meta-id))
625            (%setf-macptr c class))
626            #+apple-objc-2.0
627            (%add-objc-class c)
628            #-apple-objc-2.0
629            (multiple-value-bind (ivars instance-size)
630                (%make-objc-ivars c)
631              (%add-objc-class c ivars instance-size)
632              (splay-tree-put class-map c i))))))
633    ;; Finally, iterate over all classes in the runtime world.
634    ;; Register any class that's not found in the class map
635    ;; as a "private" ObjC class.
636    ;; Iterate over all classes in the runtime.  Those that
637    ;; aren't already registered will get identified as
638    ;; "private" (undeclared) ObjC classes.
639    ;; Note that this means that if an application bundle
640    ;; was saved on (for instance) Panther and Tiger interfaces
641    ;; were used, and then the application is run on Tiger, any
642    ;; Tiger-specific classes will not be magically integrated
643    ;; into CLOS in the running application.
644    ;; A development envronment might want to provide such a
645    ;; mechanism; it would need access to Panther class
646    ;; declarations, and - in the general case - a standalone
647    ;; application doesn't necessarily have access to the
648    ;; interface database.
649    (map-objc-classes nil)
650    ))
651
652(pushnew #'revive-objc-classes *lisp-system-pointer-functions*
653         :test #'eq
654         :key #'function-name)
655   
656
657(defun %objc-class-instance-size (c)
658  #+apple-objc-2.0
659  (#_class_getInstanceSize c)
660  #-apple-objc-2.0
661  (pref c :objc_class.instance_size))
662
663(defun find-named-objc-superclass (class string)
664  (unless (or (null string) (%null-ptr-p class))
665    (with-macptrs ((name #+apple-objc-2.0 (#_class_getName class)
666                         #-apple-objc-2.0 (pref class :objc_class.name)))
667      (or
668       (dotimes (i (length string) class)
669         (let* ((b (%get-unsigned-byte name i)))
670           (unless (eq b (char-code (schar string i)))
671             (return))))
672       (find-named-objc-superclass #+apple-objc-2.0 (#_class_getSuperclass class)
673                                   #-apple-objc-2.0 (pref class :objc_class.super_class)
674                                   string)))))
675
676(defun install-foreign-objc-class (class &optional (use-db t))
677  (let* ((id (objc-class-id class)))
678    (unless id
679      (let* ((name (%get-cstring #+apple-objc-2.0 (#_class_getName class)
680                                 #-apple-objc-2.0 (pref class :objc_class.name)))
681             (decl (get-objc-class-decl name use-db)))
682        (if (null decl)
683          (or (%get-private-objc-class class)
684              (%register-private-objc-class class name))
685          (progn
686            (setq id (register-objc-class class)
687                  class (id->objc-class id))
688            ;; If not mapped, map the superclass (if there is one.)
689            (let* ((super (find-named-objc-superclass
690                           #+apple-objc-2.0
691                           (#_class_getSuperclass class)
692                           #-apple-objc-2.0
693                           (pref class :objc_class.super_class)
694                           (db-objc-class-info-superclass-name decl))))
695              (unless (null super)
696                (install-foreign-objc-class super))
697              (let* ((class-name 
698                      (objc-to-lisp-classname
699                       name
700                       "NS"))
701                     (meta-id
702                      (objc-class-id->objc-metaclass-id id)) 
703                     (meta (id->objc-metaclass meta-id)))
704                ;; Metaclass may already be initialized.  It'll have a
705                ;; class wrapper if so.
706                (unless (id->objc-metaclass-wrapper meta-id)
707                  (let* ((meta-foreign-name
708                          (%get-cstring
709                           #+apple-objc-2.0
710                           (#_class_getName meta)
711                           #-apple-objc-2.0
712                           (pref meta :objc_class.name)))
713                         (meta-name
714                          (intern
715                           (concatenate 'string
716                                        "+"
717                                        (string
718                                         (objc-to-lisp-classname
719                                          meta-foreign-name
720                                          "NS")))
721                           "NS"))
722                         (meta-super
723                          (if super (pref super #+apple-objc :objc_class.isa
724                                          #+gnu-objc :objc_class.class_pointer))))
725                    ;; It's important (here and when initializing the
726                    ;; class below) to use the "canonical"
727                    ;; (registered) version of the class, since some
728                    ;; things in CLOS assume EQness.  We probably
729                    ;; don't want to violate that assumption; it'll be
730                    ;; easier to revive a saved image if we don't have
731                    ;; a lot of EQL-but-not-EQ class pointers to deal
732                    ;; with.
733                    (initialize-instance
734                     meta
735                     :name meta-name
736                     :direct-superclasses
737                     (list
738                      (if (or (null meta-super)
739                              (not (%objc-metaclass-p meta-super)))
740                        (find-class 'objc:objc-class)
741                        (canonicalize-registered-metaclass meta-super)))
742                     :peer class
743                     :foreign t)
744                    (setf (objc-metaclass-id-foreign-name meta-id)
745                          meta-foreign-name)
746                    (setf (find-class meta-name) meta)
747                    (%defglobal meta-name meta)))
748                (setf (slot-value class 'direct-slots)
749                      (compute-objc-direct-slots-from-info decl class))
750                (initialize-instance
751                 class
752                 :name class-name
753                 :direct-superclasses
754                 (list
755                  (if (null super)
756                    (find-class 'objc:objc-object)
757                    (canonicalize-registered-class super)))
758                 :peer meta
759                 :foreign t)
760                (setf (objc-class-id-foreign-name id)
761                      name)
762                (setf (find-class class-name) class)
763                (%defglobal class-name class)
764                class))))))))
765                               
766
767
768;;; Execute the body with the variable NSSTR bound to a
769;;; stack-allocated NSConstantString instance (made from
770;;; *NSConstantString-class*, CSTRING and LEN).
771(defmacro with-nsstr ((nsstr cstring len) &body body)
772  #+apple-objc
773  `(rlet ((,nsstr :<NSC>onstant<S>tring
774           :isa *NSConstantString-class*
775           :bytes ,cstring
776           :num<B>ytes ,len))
777      ,@body)
778  #+gnu-objc
779  `(rlet ((,nsstr :<NXC>onstant<S>tring
780           :isa *NSConstantString-class*
781           :c_string ,cstring
782           :len ,len))
783    ,@body))
784
785;;; Make a persistent (heap-allocated) NSConstantString.
786
787(defun %make-constant-nsstring (string)
788  "Make a persistent (heap-allocated) NSConstantString from the
789argument lisp string."
790  #+apple-objc
791  (make-record :<NSC>onstant<S>tring
792               :isa *NSConstantString-Class*
793               :bytes (make-cstring string)
794               :num<B>ytes (length string))
795  #+gnu-objc
796  (make-record :<NXC>onstant<S>tring
797               :isa *NSConstantString-Class*
798               :c_string (make-cstring string)
799               :len (length string))
800  )
801
802;;; Class declarations
803(defparameter *objc-class-declarations* (make-hash-table :test #'equal))
804
805(defun get-objc-class-decl (class-name &optional (use-db t))
806  (or (gethash class-name *objc-class-declarations*)
807      (and use-db
808           (let* ((decl (%find-objc-class-info class-name)))
809             (when decl
810               (setf (gethash class-name *objc-class-declarations*) decl))))))
811
812(defun %ensure-class-declaration (name super-name)
813  (unless (get-objc-class-decl name)
814    (setf (gethash name *objc-class-declarations*)
815          (make-db-objc-class-info :class-name (string name)
816                                   :superclass-name (string super-name))))
817  name)
818
819;;; It's hard (and questionable) to allow ivars here.
820(defmacro declare-objc-class (name super-name)
821  `(%ensure-class-declaration ',name ',super-name))
822
823;;; Intern NSConstantString instances.
824(defvar *objc-constant-strings* (make-hash-table :test #'equal))
825
826(defstruct objc-constant-string
827  string
828  nsstringptr)
829
830(defun ns-constant-string (string)
831  (or (gethash string *objc-constant-strings*)
832      (setf (gethash string *objc-constant-strings*)
833            (make-objc-constant-string :string string
834                                       :nsstringptr (%make-constant-nsstring string)))))
835
836(def-ccl-pointers objc-strings ()
837  (maphash #'(lambda (string cached)
838               (setf (objc-constant-string-nsstringptr cached)
839                     (%make-constant-nsstring string)))
840           *objc-constant-strings*))
841
842(defmethod make-load-form ((s objc-constant-string) &optional env)
843  (declare (ignore env))
844  `(ns-constant-string ,(objc-constant-string-string s)))
845
846(defmacro @ (string)
847  `(objc-constant-string-nsstringptr ,(ns-constant-string string)))
848
849#+gnu-objc
850(progn
851  (defcallback lisp-objc-error-handler (:id receiver :int errcode (:* :char) format :address argptr :<BOOL>)
852    (let* ((message (get-c-format-string format argptr)))
853      (error "ObjC runtime error ~d, receiver ~s :~& ~a"
854             errcode receiver message))
855    #$YES)
856
857  (def-ccl-pointers install-lisp-objc-error-handler ()
858    (#_objc_set_error_handler lisp-objc-error-handler)))
859
860
861
862
863
864;;; Registering named objc classes.
865
866
867(defun objc-class-name-string (name)
868  (etypecase name
869    (symbol (lisp-to-objc-classname name))
870    (string name)))
871
872;;; We'd presumably cache this result somewhere, so we'd only do the
873;;; lookup once per session (in general.)
874(defun lookup-objc-class (name &optional error-p)
875  (with-cstrs ((cstr (objc-class-name-string name)))
876    (let* ((p (#+apple-objc #_objc_lookUpClass
877               #+gnu-objc #_objc_lookup_class
878               cstr)))
879      (if (%null-ptr-p p)
880        (if error-p
881          (error "ObjC class ~a not found" name))
882        p))))
883
884(defun %set-pointer-to-objc-class-address (class-name-string ptr)
885  (with-cstrs ((cstr class-name-string))
886    (%setf-macptr ptr
887                  (#+apple-objc #_objc_lookUpClass
888                   #+gnu-objc #_objc_lookup_class
889                   cstr)))
890  nil)
891   
892                 
893
894(defvar *objc-class-descriptors* (make-hash-table :test #'equal))
895
896
897(defstruct objc-class-descriptor
898  name
899  classptr)
900
901(defun invalidate-objc-class-descriptors ()
902  (maphash #'(lambda (name descriptor)
903               (declare (ignore name))
904               (setf (objc-class-descriptor-classptr descriptor) nil))
905           *objc-class-descriptors*))
906
907(defun %objc-class-classptr (class-descriptor &optional (error-p t))
908  (or (objc-class-descriptor-classptr class-descriptor)
909      (setf (objc-class-descriptor-classptr class-descriptor)
910            (lookup-objc-class (objc-class-descriptor-name class-descriptor)
911                               error-p))))
912
913(defun load-objc-class-descriptor (name)
914  (let* ((descriptor (or (gethash name *objc-class-descriptors*)
915                         (setf (gethash name *objc-class-descriptors*)
916                               (make-objc-class-descriptor  :name name)))))
917    (%objc-class-classptr descriptor nil)
918    descriptor))
919
920(defmacro objc-class-descriptor (name)
921  `(load-objc-class-descriptor ,name))
922
923(defmethod make-load-form ((o objc-class-descriptor) &optional env)
924  (declare (ignore env))
925  `(load-objc-class-descriptor ,(objc-class-descriptor-name o)))
926
927(defmacro @class (name)
928  (let* ((name (objc-class-name-string name)))
929    `(the (@metaclass ,name) (%objc-class-classptr ,(objc-class-descriptor name)))))
930
931;;; This isn't quite the inverse operation of LOOKUP-OBJC-CLASS: it
932;;; returns a simple C string.  and can be applied to a class or any
933;;; instance (returning the class name.)
934(defun objc-class-name (object)
935  #+apple-objc
936  (with-macptrs (p)
937    (%setf-macptr p (#_object_getClassName object))
938    (unless (%null-ptr-p p)
939      (%get-cstring p)))
940  #+gnu-objc
941  (unless (%null-ptr-p object)
942    (with-macptrs ((parent (pref object :objc_object.class_pointer)))
943      (unless (%null-ptr-p parent)
944        (if (logtest (pref parent :objc_class.info) #$_CLS_CLASS)
945          (%get-cstring (pref parent :objc_class.name))
946          (%get-cstring (pref object :objc_class.name)))))))
947
948
949;;; Likewise, we want to cache the selectors ("SEL"s) which identify
950;;; method names.  They can vary from session to session, but within
951;;; a session, all methods with a given name (e.g, "init") will be
952;;; represented by the same SEL.
953(defun get-selector-for (method-name &optional error)
954  (with-cstrs ((cmethod-name method-name))
955    (let* ((p (#+apple-objc #_sel_getUid
956               #+gnu-objc #_sel_get_uid
957               cmethod-name)))
958      (if (%null-ptr-p p)
959        (if error
960          (error "Can't find ObjC selector for ~a" method-name))
961        p))))
962
963(defvar *objc-selectors* (make-hash-table :test #'equal))
964
965(defstruct objc-selector
966  name
967  %sel)
968
969(defun %get-SELECTOR (selector &optional (error-p t))
970  (or (objc-selector-%sel selector)
971      (setf (objc-selector-%sel selector)
972            (get-selector-for (objc-selector-name selector) error-p))))
973
974(defun clear-objc-selectors ()
975  (maphash #'(lambda (name sel)
976               (declare (ignore name))
977               (setf (objc-selector-%sel sel) nil))
978           *objc-selectors*))
979
980;;; Find or create a SELECTOR; don't bother resolving it.
981(defun ensure-objc-selector (name)
982  (setq name (string name))
983  (or (gethash name *objc-selectors*)
984      (setf (gethash name *objc-selectors*)
985            (make-objc-selector :name name))))
986
987(defun load-objc-selector (name)
988  (let* ((selector (ensure-objc-selector name)))
989    (%get-SELECTOR selector nil)
990    selector))
991
992(defmacro @SELECTOR (name)
993  `(%get-selector ,(load-objc-selector name)))
994
995(defmethod make-load-form ((s objc-selector) &optional env)
996  (declare (ignore env))
997  `(load-objc-selector ,(objc-selector-name s)))
998
999
1000;;; Convert a Lisp object X to a desired foreign type FTYPE
1001;;; The following conversions are currently done:
1002;;;   - T/NIL => #$YES/#$NO
1003;;;   - NIL => (%null-ptr)
1004;;;   - Lisp string => NSString
1005;;;   - Lisp numbers  => SINGLE-FLOAT when possible
1006
1007(defun coerce-to-bool (x)
1008  (let ((x-temp (gensym)))
1009    `(let ((,x-temp ,x))
1010       (if (or (eq ,x-temp 0) (null ,x-temp))
1011         #.#$NO
1012         #.#$YES))))
1013
1014(declaim (inline %coerce-to-bool))
1015(defun %coerce-to-bool (x)
1016  (if (and x (not (eql x 0)))
1017    #$YES
1018    #$NO))
1019
1020(defun coerce-to-address (x)
1021  (let ((x-temp (gensym)))
1022    `(let ((,x-temp ,x))
1023       (cond ((null ,x-temp) +null-ptr+)
1024             ((stringp ,x-temp) (%make-nsstring ,x-temp))
1025             (t ,x-temp)))))
1026
1027;;; This is generally a bad idea; it forces us to
1028;;; box intermediate pointer arguments in order
1029;;; to typecase on them, and it's not clear to
1030;;; me that it offers much in the way of additional
1031;;; expressiveness.
1032(declaim (inline %coerce-to-address))
1033(defun %coerce-to-address (x)
1034  (etypecase x
1035    (macptr x)
1036    (string (%make-nsstring x))         ; does this ever get released ?
1037    (null (%null-ptr))))
1038
1039(defun coerce-to-foreign-type (x ftype)
1040   (cond ((and (constantp x) (constantp ftype))
1041          (case ftype
1042            (:id (if (null x) `(%null-ptr) (coerce-to-address x)))
1043            (:<BOOL> (coerce-to-bool (eval x)))
1044            (t x)))
1045         ((constantp ftype)
1046          (case ftype
1047            (:id `(%coerce-to-address ,x))
1048            (:<BOOL> `(%coerce-to-bool ,x))
1049            (t x)))
1050         (t `(case ,(if (atom ftype) ftype)
1051               (:id (%coerce-to-address ,x))
1052               (:<BOOL> (%coerce-to-bool ,x))
1053               (t ,x)))))
1054
1055(defun objc-arg-coerce (typespec arg)
1056  (case typespec
1057    (:<BOOL> `(%coerce-to-bool ,arg))
1058    (:id `(%coerce-to-address ,arg))
1059    (t arg)))
1060
1061
1062;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1063;;;;                       Boolean Return Hackery                           ;;;;
1064;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1065
1066;;; Convert a foreign object X to T or NIL
1067
1068(defun coerce-from-bool (x)
1069  (cond
1070   ((eq x #$NO) nil)
1071   ((eq x #$YES) t)
1072   (t (error "Cannot coerce ~S to T or NIL" x))))
1073
1074(defun objc-result-coerce (type result)
1075  (cond ((eq type :<BOOL>)
1076         `(coerce-from-bool ,result))
1077        (t result)))
1078
1079;;; Add a faster way to get the message from a SEL by taking advantage of the
1080;;; fact that a selector is really just a canonicalized, interned C string
1081;;; containing the message.  (This is an admitted modularity violation;
1082;;; there's a more portable but slower way to do this if we ever need to.)
1083
1084
1085(defun lisp-string-from-sel (sel)
1086  (%get-cstring
1087   #+apple-objc sel
1088   #+gnu-objc (#_sel_get_name sel)))
1089
1090;;; #_objc_msgSend takes two required arguments (the receiving object
1091;;; and the method selector) and 0 or more additional arguments;
1092;;; there'd have to be some macrology to handle common cases, since we
1093;;; want the compiler to see all of the args in a foreign call.
1094
1095;;; I don't remmber what the second half of the above comment might
1096;;; have been talking about.
1097
1098(defmacro objc-message-send (receiver selector-name &rest argspecs)
1099  (when (evenp (length argspecs))
1100    (setq argspecs (append argspecs '(:id))))
1101  #+apple-objc
1102  (funcall (ftd-ff-call-expand-function *target-ftd*)
1103           `(%ff-call (%reference-external-entry-point (load-time-value (external "_objc_msgSend"))))
1104           `(:address ,receiver :<SEL> (@selector ,selector-name) ,@argspecs)
1105           :arg-coerce 'objc-arg-coerce
1106           :result-coerce 'objc-result-coerce) 
1107  #+gnu-objc
1108    (let* ((r (gensym))
1109         (s (gensym))
1110         (imp (gensym)))
1111    `(with-macptrs ((,r ,receiver)
1112                    (,s (@selector ,selector-name))
1113                    (,imp (external-call "objc_msg_lookup"
1114                                        :id ,r
1115                                        :<SEL> ,s
1116                                        :<IMP>)))
1117      (funcall (ftd-ff-call-expand-function *target-ftd*)
1118       `(%ff-call ,imp)
1119       `(:address ,receiver :<SEL> (@selector ,selector-name) ,@argspecs)
1120       :arg-coerce 'objc-arg-coerce
1121       :result-coerce 'objc-result-coerce))))
1122
1123(defmacro objc-message-send-with-selector (receiver selector &rest argspecs)
1124  (when (evenp (length argspecs))
1125    (setq argspecs (append argspecs '(:id))))
1126  #+apple-objc
1127  (funcall (ftd-ff-call-expand-function *target-ftd*)
1128           `(%ff-call (%reference-external-entry-point (load-time-value (external "_objc_msgSend"))))
1129           `(:address ,receiver :<SEL> (%get-selector ,selector) ,@argspecs)
1130           :arg-coerce 'objc-arg-coerce
1131           :result-coerce 'objc-result-coerce) 
1132  #+gnu-objc
1133    (let* ((r (gensym))
1134         (s (gensym))
1135         (imp (gensym)))
1136    `(with-macptrs ((,r ,receiver)
1137                    (,s (%get-selector ,selector))
1138                    (,imp (external-call "objc_msg_lookup"
1139                                        :id ,r
1140                                        :<SEL> ,s
1141                                        :<IMP>)))
1142      (funcall (ftd-ff-call-expand-function *target-ftd*)
1143       `(%ff-call ,imp)
1144       `(:address ,receiver :<SEL> ,s ,@argspecs)
1145       :arg-coerce 'objc-arg-coerce
1146       :result-coerce 'objc-result-coerce))))
1147
1148;;; A method that returns a structure does so by platform-dependent
1149;;; means.  One of those means (which is fairly common) is to pass a
1150;;; pointer to an instance of a structure type as a first argument to
1151;;; the method implementation function (thereby making SELF the second
1152;;; argument, etc.), but whether or not it's actually done that way
1153;;; depends on the platform and on the structure type.  The special
1154;;; variable CCL::*TARGET-FTD* holds a structure (of type
1155;;; CCL::FOREIGN-TYPE-DATA) which describes some static attributes of
1156;;; the foreign type system on the target platform and contains some
1157;;; functions which can determine dynamic ABI attributes.  One such
1158;;; function can be used to determine whether or not the "invisible
1159;;; first arg" convention is used to return structures of a given
1160;;; foreign type; another function in *TARGET-FTD* can be used to
1161;;; construct a foreign function call form that handles
1162;;; structure-return and structure-types-as-arguments details.  In the
1163;;; Apple ObjC runtime, #_objc_msgSend_stret must be used if the
1164;;; invisible-first-argument convention is used to return a structure
1165;;; and must NOT be used otherwise. (The Darwin ppc64 and all
1166;;; supported x86-64 ABIs often use more complicated structure return
1167;;; conventions than ppc32 Darwin or ppc Linux.)  We should use
1168;;; OBJC-MESSAGE-SEND-STRET to send any message that returns a
1169;;; structure or union, regardless of how that structure return is
1170;;; actually implemented.
1171
1172(defmacro objc-message-send-stret (structptr receiver selector-name &rest argspecs)
1173    #+apple-objc
1174    (let* ((return-typespec (car (last argspecs)))
1175           (entry-name (if (funcall (ftd-ff-call-struct-return-by-implicit-arg-function *target-ftd*) return-typespec)
1176                         "_objc_msgSend_stret"
1177                         "_objc_msgSend")))
1178      (funcall (ftd-ff-call-expand-function *target-ftd*)
1179               `(%ff-call (%reference-external-entry-point (load-time-value (external ,entry-name))))
1180        `(,structptr :address ,receiver :<SEL> (@selector ,selector-name) ,@argspecs)
1181               :arg-coerce 'objc-arg-coerce
1182               :result-coerce 'objc-result-coerce))
1183    #+gnu-objc
1184    (let* ((r (gensym))
1185         (s (gensym))
1186         (imp (gensym)))
1187    `(with-macptrs ((,r ,receiver)
1188                    (,s (@selector ,selector-name))
1189                    (,imp (external-call "objc_msg_lookup"
1190                                         :id ,r
1191                                         :<SEL> ,s
1192                                         :<IMP>)))
1193      ,      (funcall (ftd-ff-call-expand-function *target-ftd*)
1194               `(%ff-call ,imp)
1195              `(,structptr :address ,receiver :<SEL> ,s ,@argspecs)
1196               :arg-coerce 'objc-arg-coerce
1197               :result-coerce 'objc-result-coerce))))
1198
1199(defmacro objc-message-send-stret-with-selector (structptr receiver selector &rest argspecs)
1200    #+apple-objc
1201    (let* ((return-typespec (car (last argspecs)))
1202           (entry-name (if (funcall (ftd-ff-call-struct-return-by-implicit-arg-function *target-ftd*) return-typespec)
1203                         "_objc_msgSend_stret"
1204                         "_objc_msgSend")))
1205      (funcall (ftd-ff-call-expand-function *target-ftd*)
1206               `(%ff-call (%reference-external-entry-point (load-time-value (external ,entry-name))))
1207        `(,structptr :address ,receiver :<SEL> (%get-selector ,selector) ,@argspecs)
1208               :arg-coerce 'objc-arg-coerce
1209               :result-coerce 'objc-result-coerce))
1210    #+gnu-objc
1211    (let* ((r (gensym))
1212         (s (gensym))
1213         (imp (gensym)))
1214    `(with-macptrs ((,r ,receiver)
1215                    (,s (%get-selector ,selector))
1216                    (,imp (external-call "objc_msg_lookup"
1217                                         :id ,r
1218                                         :<SEL> ,s
1219                                         :<IMP>)))
1220      ,      (funcall (ftd-ff-call-expand-function *target-ftd*)
1221               `(%ff-call ,imp)
1222              `(,structptr :address ,receiver :<SEL> ,s ,@argspecs)
1223               :arg-coerce 'objc-arg-coerce
1224               :result-coerce 'objc-result-coerce))))
1225
1226;;; #_objc_msgSendSuper is similar to #_objc_msgSend; its first argument
1227;;; is a pointer to a structure of type objc_super {self,  the defining
1228;;; class's superclass}.  It only makes sense to use this inside an
1229;;; objc method.
1230(defmacro objc-message-send-super (super selector-name &rest argspecs)
1231  (when (evenp (length argspecs))
1232    (setq argspecs (append argspecs '(:id))))
1233  #+apple-objc
1234  (funcall (ftd-ff-call-expand-function *target-ftd*)
1235           `(%ff-call (%reference-external-entry-point (load-time-value (external "_objc_msgSendSuper"))))
1236           `(:address ,super :<SEL> (@selector ,selector-name) ,@argspecs)
1237           :arg-coerce 'objc-arg-coerce
1238           :result-coerce 'objc-result-coerce)
1239  #+gnu-objc
1240  (let* ((sup (gensym))
1241         (sel (gensym))
1242         (imp (gensym)))
1243    `(with-macptrs ((,sup ,super)
1244                    (,sel (@selector ,selector-name))
1245                    (,imp (external-call "objc_msg_lookup_super"
1246                                         :<S>uper_t ,sup
1247                                         :<SEL> ,sel
1248                                         :<IMP>)))
1249  (funcall (ftd-ff-call-expand-function *target-ftd*)
1250   `(%ff-call ,imp)
1251   `(:id (pref ,sup :<S>uper.self)
1252     :<SEL> ,sel
1253     ,@argspecs)))))
1254
1255(defmacro objc-message-send-super-with-selector (super selector &rest argspecs)
1256  (when (evenp (length argspecs))
1257    (setq argspecs (append argspecs '(:id))))
1258  #+apple-objc
1259  (funcall (ftd-ff-call-expand-function *target-ftd*)
1260           `(%ff-call (%reference-external-entry-point (load-time-value (external "_objc_msgSendSuper"))))
1261           `(:address ,super :<SEL> ,selector ,@argspecs)
1262           :arg-coerce 'objc-arg-coerce
1263           :result-coerce 'objc-result-coerce)
1264  #+gnu-objc
1265  (let* ((sup (gensym))
1266         (sel (gensym))
1267         (imp (gensym)))
1268    `(with-macptrs ((,sup ,super)
1269                    (,sel ,selector)
1270                    (,imp (external-call "objc_msg_lookup_super"
1271                                         :<S>uper_t ,sup
1272                                         :<SEL> ,sel
1273                                         :<IMP>)))
1274  (funcall (ftd-ff-call-expand-function *target-ftd*)
1275   `(%ff-call ,imp)
1276   `(:id (pref ,sup :<S>uper.self)
1277     :<SEL> ,sel
1278     ,@argspecs)))))
1279
1280;;; Send to superclass method, returning a structure. See above.
1281(defmacro objc-message-send-super-stret
1282    (structptr super selector-name &rest argspecs)
1283  #+apple-objc
1284    (let* ((return-typespec (car (last argspecs)))
1285           (entry-name (if (funcall (ftd-ff-call-struct-return-by-implicit-arg-function *target-ftd*) return-typespec)
1286                         "_objc_msgSendSuper_stret"
1287                         "_objc_msgSendSuper")))
1288      (funcall (ftd-ff-call-expand-function *target-ftd*)
1289               `(%ff-call (%reference-external-entry-point (load-time-value (external ,entry-name))))
1290               `(,structptr :address ,super :<SEL> (@selector ,selector-name) ,@argspecs)
1291               :arg-coerce 'objc-arg-coerce
1292               :result-coerce 'objc-result-coerce))
1293  #+gnu-objc
1294  (let* ((sup (gensym))
1295         (sel (gensym))
1296         (imp (gensym)))
1297    `(with-macptrs ((,sup ,super)
1298                    (,sel (@selector ,selector-name))
1299                    (,imp (external-call "objc_msg_lookup_super"
1300                                         :<S>uper_t ,sup
1301                                         :<SEL> ,sel
1302                                         :<IMP>)))
1303      (funcall (ftd-ff-call-expand-function *target-ftd*)
1304       `(%ff-call ,imp)
1305       ,structptr
1306       :id (pref ,sup :<S>uper.self)
1307       :<SEL> ,sel
1308       ,@argspecs))))
1309
1310(defmacro objc-message-send-super-stret-with-selector
1311    (structptr super selector &rest argspecs)
1312  #+apple-objc
1313    (let* ((return-typespec (car (last argspecs)))
1314           (entry-name (if (funcall (ftd-ff-call-struct-return-by-implicit-arg-function *target-ftd*) return-typespec)
1315                         "_objc_msgSendSuper_stret"
1316                         "_objc_msgSendSuper")))
1317      (funcall (ftd-ff-call-expand-function *target-ftd*)
1318               `(%ff-call (%reference-external-entry-point (load-time-value (external ,entry-name))))
1319               `(,structptr :address ,super :<SEL> (%get-selector ,selector) ,@argspecs)
1320               :arg-coerce 'objc-arg-coerce
1321               :result-coerce 'objc-result-coerce))
1322  #+gnu-objc
1323  (let* ((sup (gensym))
1324         (sel (gensym))
1325         (imp (gensym)))
1326    `(with-macptrs ((,sup ,super)
1327                    (,sel (%get-selector ,selector))
1328                    (,imp (external-call "objc_msg_lookup_super"
1329                                         :<S>uper_t ,sup
1330                                         :<SEL> ,sel
1331                                         :<IMP>)))
1332      (funcall (ftd-ff-call-expand-function *target-ftd*)
1333       `(%ff-call ,imp)
1334       ,structptr
1335       :id (pref ,sup :<S>uper.self)
1336       :<SEL> ,sel
1337       ,@argspecs))))
1338
1339(defun message-send-form-for-call (receiver selector args super-p struct-return-var)
1340  (if struct-return-var
1341    (if super-p
1342      `(objc-message-send-super-stret-with-selector ,struct-return-var ,receiver ,selector ,@args)
1343      `(objc-message-send-stret-with-selector ,struct-return-var ,receiver ,selector ,@args))
1344    (if super-p
1345      `(objc-message-send-super-with-selector ,receiver ,selector ,@args)
1346      `(objc-message-send-with-selector ,receiver ,selector ,@args))))
1347
1348
1349#+(and apple-objc x8664-target)
1350(defun %process-varargs-list (gpr-pointer fpr-pointer stack-pointer ngprs nfprs nstackargs arglist)
1351  (dolist (arg-temp arglist)
1352    (typecase arg-temp
1353      ((signed-byte 64)
1354       (if (< ngprs 6)
1355         (progn
1356           (setf (paref gpr-pointer (:* (:signed 64)) ngprs) arg-temp)
1357           (incf ngprs))
1358         (progn
1359           (setf (paref stack-pointer (:* (:signed 64)) nstackargs) arg-temp)
1360           (incf nstackargs))))
1361      ((unsigned-byte 64)
1362       (if (< ngprs 6)
1363         (progn
1364           (setf (paref gpr-pointer (:* (:unsigned 64)) ngprs) arg-temp)
1365           (incf ngprs))
1366         (progn
1367           (setf (paref stack-pointer (:* (:unsigned 64)) nstackargs) arg-temp)
1368           (incf nstackargs))))
1369      (macptr
1370       (if (< ngprs 6)
1371         (progn
1372           (setf (paref gpr-pointer (:* :address) ngprs) arg-temp)
1373           (incf ngprs))
1374         (progn
1375           (setf (paref stack-pointer (:* :address) nstackargs) arg-temp)
1376           (incf nstackargs))))
1377      (single-float
1378       (if (< nfprs 8)
1379         (progn
1380           (setf (%get-single-float fpr-pointer (* nfprs 16))
1381                 arg-temp)
1382           (incf nfprs))
1383         (progn
1384           (setf (paref stack-pointer (:* :float) (* 2 nstackargs)) arg-temp)
1385           (incf nstackargs))))
1386      (double-float
1387       (if (< nfprs 8)
1388         (progn
1389           (setf (%get-double-float fpr-pointer (* nfprs 16))
1390                 arg-temp)
1391           (incf nfprs))
1392         (progn
1393           (setf (paref stack-pointer (:* :double) nstackargs)
1394                 arg-temp)
1395           (incf nstackargs)))))))
1396                         
1397#+apple-objc
1398(eval-when (:compile-toplevel :execute)
1399  #+x8664-target
1400  (%def-foreign-type :<MARG> (foreign-pointer-type-to (parse-foreign-type :x86_64_marg_list))))
1401
1402 
1403(defun %compile-varargs-send-function-for-signature (sig)
1404  (declare (ignorable sig super-p))
1405  #+(and apple-objc x8664-target)
1406  (let* ((return-type-spec (car sig))
1407         (arg-type-specs (butlast (cdr sig)))
1408         (args (objc-gen-message-arglist (length arg-type-specs)))
1409         (receiver (gensym))
1410         (selector (gensym))
1411         (rest-arg (gensym))
1412         (arg-temp (gensym))
1413         (marg-ptr (gensym))
1414         (regparams (gensym))
1415         (stackparams (gensym))
1416         (selptr (gensym))
1417         (gpr-total (gensym))
1418         (fpr-total (gensym))
1419         (stack-total (gensym))
1420         (n-static-gprs 2)              ;receiver, selptr
1421         (n-static-fprs 0)
1422         (n-static-stack-args 0))
1423    (collect ((static-arg-forms))
1424      (static-arg-forms `(setf (paref ,regparams (:* address) 0) ,receiver))
1425      (static-arg-forms `(setf (paref ,regparams (:* address) 1) ,selptr))
1426      (do* ((args args (cdr args))
1427            (arg-type-specs arg-type-specs (cdr arg-type-specs)))
1428           ((null args))
1429        (let* ((arg (car args))
1430               (spec (car arg-type-specs))
1431               (static-arg-type (parse-foreign-type spec))
1432               (gpr-base (if (< n-static-gprs 6) regparams stackparams))
1433               (fpr-base (if (< n-static-fprs 8) marg-ptr stackparams))
1434               (gpr-offset (if (< n-static-gprs 6) n-static-gprs n-static-stack-args))
1435               (fpr-offset (if (< n-static-fprs 8)
1436                             (* 16 n-static-fprs)
1437                             (* 8 n-static-stack-args))))
1438          (etypecase static-arg-type
1439            (foreign-integer-type
1440             (if (eq spec :<BOOL>)
1441               (setq arg `(%coerce-to-bool ,arg)))
1442             (static-arg-forms
1443              `(setf (paref ,gpr-base (:* (
1444                                           ,(if (foreign-integer-type-signed static-arg-type)
1445                                                :signed
1446                                                :unsigned)
1447                                           ,(foreign-integer-type-bits static-arg-type))) ,gpr-offset)
1448                ,arg))
1449             (if (< n-static-gprs 6)
1450               (incf n-static-gprs)
1451               (incf n-static-stack-args)))
1452            (foreign-single-float-type
1453             (if (eq fpr-base stackparams)
1454               (setq fpr-offset (* 2 fpr-offset)))
1455             (static-arg-forms
1456              `(setf (%get-single-float ,fpr-base ,fpr-offset) ,arg))
1457             (if (< n-static-fprs 8)
1458               (incf n-static-fprs)
1459               (incf n-static-stack-args)))
1460            (foreign-double-float-type
1461             (static-arg-forms
1462              `(setf (%get-double-float ,fpr-base ,fpr-offset) ,arg))
1463             (if (< n-static-fprs 8)
1464               (incf n-static-fprs)
1465               (incf n-static-stack-args)))
1466            (foreign-pointer-type
1467             (static-arg-forms
1468              `(setf (paref ,gpr-base (:* address) ,gpr-offset) ,arg))
1469             (if (< n-static-gprs 6)
1470               (incf n-static-gprs)
1471               (incf n-static-stack-args))))))
1472      (compile
1473       nil
1474       `(lambda (,receiver ,selector ,@args &rest ,rest-arg)
1475         (declare (dynamic-extent ,rest-arg))
1476         (let* ((,selptr (%get-selector ,selector))
1477                (,gpr-total ,n-static-gprs)
1478                (,fpr-total ,n-static-fprs)
1479                (,stack-total ,n-static-stack-args))
1480           (dolist (,arg-temp ,rest-arg)
1481             (if (or (typep ,arg-temp 'double-float)
1482                     (typep ,arg-temp 'single-float))
1483               (if (< ,fpr-total 8)
1484                 (incf ,fpr-total)
1485                 (incf ,stack-total))
1486               (if (< ,gpr-total 6)
1487                 (incf ,gpr-total)
1488                 (incf ,stack-total))))
1489           (%stack-block ((,marg-ptr (+ ,(%foreign-type-or-record-size
1490                                          :<MARG> :bytes)
1491                                        (* 8 ,stack-total))))
1492             
1493             (setf (pref ,marg-ptr :<MARG>.rax) ,stack-total)
1494             (with-macptrs ((,regparams (pref ,marg-ptr :<MARG>.reg<P>arams)) 
1495                            (,stackparams (pref ,marg-ptr :<MARG>.stack<P>arams)))
1496               (progn ,@(static-arg-forms))
1497               (%process-varargs-list ,regparams ,marg-ptr ,stackparams ,n-static-gprs ,n-static-fprs ,n-static-stack-args ,rest-arg)
1498               (external-call "_objc_msgSendv"
1499                              :address ,receiver
1500                              :address ,selptr
1501                              :size_t (+ 48 (* 8 ,stack-total))
1502                              :address ,marg-ptr
1503                              ,return-type-spec))))))))
1504  #-(and apple-objc x8664-target)
1505  (warn "Varargs function for signature ~s NYI" sig)
1506  )
1507
1508
1509(defun %compile-send-function-for-signature (sig &optional super-p)
1510  (let* ((return-type-spec (car sig))
1511         (arg-type-specs (cdr sig)))
1512    (if (eq (car (last arg-type-specs)) :void)
1513      (%compile-varargs-send-function-for-signature sig)
1514      (let* ((args (objc-gen-message-arglist (length arg-type-specs)))
1515             (struct-return-var nil)
1516             (receiver (gensym))
1517             (selector (gensym)))
1518        (collect ((call)
1519                  (lets))
1520          (let* ((result-type (parse-foreign-type return-type-spec)))
1521            (when (typep result-type 'foreign-record-type)
1522              (setq struct-return-var (gensym))
1523              (lets `(,struct-return-var (make-gcable-record ,return-type-spec))))
1524
1525            (do ((args args (cdr args))
1526                 (spec (pop arg-type-specs) (pop arg-type-specs)))
1527                ((null args) (call return-type-spec))
1528              (let* ((arg (car args)))
1529                 (call spec)
1530                 (case spec
1531                   (:<BOOL> (call `(%coerce-to-bool ,arg)))
1532                   (:id (call `(%coerce-to-address ,arg)))
1533                   (t
1534                    (call arg)))))
1535            (let* ((call (call))
1536                   (lets (lets))
1537                   (body (message-send-form-for-call receiver selector call super-p struct-return-var)))
1538              (if struct-return-var
1539                (setq body `(progn ,body ,struct-return-var)))
1540              (if lets
1541                (setq body `(let* ,lets
1542                             ,body)))
1543              (compile nil
1544                       `(lambda (,receiver ,selector ,@args)
1545                         ,body)))))))))
1546
1547(defun compile-send-function-for-signature (sig)
1548  (%compile-send-function-for-signature sig nil))
1549                           
1550                   
1551
1552
1553;;; The first 8 words of non-fp arguments get passed in R3-R10
1554#+ppc-target
1555(defvar *objc-gpr-offsets*
1556  #+32-bit-target
1557  #(4 8 12 16 20 24 28 32)
1558  #+64-bit-target
1559  #(8 16 24 32 40 48 56 64)
1560  )
1561
1562
1563
1564;;; The first 13 fp arguments get passed in F1-F13 (and also "consume"
1565;;; a GPR or two.)  It's certainly possible for an FP arg and a non-
1566;;; FP arg to share the same "offset", and parameter offsets aren't
1567;;; strictly increasing.
1568#+ppc-target
1569(defvar *objc-fpr-offsets*
1570  #+32-bit-target
1571  #(36 44 52 60  68  76  84  92 100 108 116 124 132)
1572  #+64-bit-target
1573  #(68 76 84 92 100 108 116 124 132 140 148 156 164))
1574
1575;;; Just to make things even more confusing: once we've filled in the
1576;;; first 8 words of the parameter area, args that aren't passed in
1577;;; FP-regs get assigned offsets starting at 32.  That almost makes
1578;;; sense (even though it conflicts with the last offset in
1579;;; *objc-gpr-offsets* (assigned to R10), but we then have to add
1580;;; this constant to the memory offset.
1581(defconstant objc-forwarding-stack-offset 8)
1582
1583(defvar *objc-id-type* (parse-foreign-type :id))
1584(defvar *objc-sel-type* (parse-foreign-type :<SEL>))
1585(defvar *objc-char-type* (parse-foreign-type :char))
1586
1587(defun encode-objc-type (type &optional for-ivar)
1588  (if (or (eq type *objc-id-type*)
1589          (foreign-type-= type *objc-id-type*))
1590    "@"
1591    (if (or (eq type *objc-sel-type*)
1592            (foreign-type-= type *objc-sel-type*))
1593      ":"
1594      (if (eq (foreign-type-class type) 'root)
1595        "v"
1596        (typecase type
1597          (foreign-pointer-type
1598           (let* ((target (foreign-pointer-type-to type)))
1599             (if (or (eq target *objc-char-type*)
1600                     (foreign-type-= target *objc-char-type*))
1601               "*"
1602               (format nil "^~a" (encode-objc-type target)))))
1603          (foreign-double-float-type "d")
1604          (foreign-single-float-type "f")
1605          (foreign-integer-type
1606           (let* ((signed (foreign-integer-type-signed type))
1607                  (bits (foreign-integer-type-bits type)))
1608             (if (eq (foreign-integer-type-alignment type) 1)
1609               (format nil "b~d" bits)
1610               (cond ((= bits 8)
1611                      (if signed "c" "C"))
1612                     ((= bits 16)
1613                      (if signed "s" "S"))
1614                     ((= bits 32)
1615                      ;; Should be some way of noting "longness".
1616                      (if signed "i" "I"))
1617                     ((= bits 64)
1618                      (if signed "q" "Q"))))))
1619          (foreign-record-type
1620           (ensure-foreign-type-bits type)
1621           (let* ((name (unescape-foreign-name
1622                         (or (foreign-record-type-name type) "?")))
1623                  (kind (foreign-record-type-kind type))
1624                  (fields (foreign-record-type-fields type)))
1625             (with-output-to-string (s)
1626                                    (format s "~c~a=" (if (eq kind :struct) #\{ #\() name)
1627                                    (dolist (f fields (format s "~a" (if (eq kind :struct) #\} #\))))
1628                                      (when for-ivar
1629                                        (format s "\"~a\""
1630                                                (unescape-foreign-name
1631                                                 (or (foreign-record-field-name f) "")))
1632                                        (format s "~a" (encode-objc-type
1633                                                        (foreign-record-field-type f))))))))
1634          (foreign-array-type
1635           (ensure-foreign-type-bits type)
1636           (let* ((dims (foreign-array-type-dimensions type))
1637                  (element-type (foreign-array-type-element-type type)))
1638             (if dims (format nil "[~d~a]"
1639                              (car dims)
1640                              (encode-objc-type element-type))
1641               (if (or (eq element-type *objc-char-type*)
1642                       (foreign-type-= element-type *objc-char-type*))
1643                 "*"
1644                 (format nil "^~a" (encode-objc-type element-type))))))
1645          (t (break "type = ~s" type)))))))
1646
1647#+ppc-target
1648(defun encode-objc-method-arglist (arglist result-spec)
1649  (let* ((gprs-used 0)
1650         (fprs-used 0)
1651         (arg-info
1652          (flet ((current-memory-arg-offset ()
1653                   (+ 32 (* 4 (- gprs-used 8))
1654                      objc-forwarding-stack-offset)))
1655            (flet ((current-gpr-arg-offset ()
1656                     (if (< gprs-used 8)
1657                       (svref *objc-gpr-offsets* gprs-used)
1658                       (current-memory-arg-offset)))
1659                   (current-fpr-arg-offset ()
1660                     (if (< fprs-used 13)
1661                       (svref *objc-fpr-offsets* fprs-used)
1662                       (current-memory-arg-offset))))
1663              (let* ((result nil))
1664                (dolist (argspec arglist (nreverse result))
1665                  (let* ((arg (parse-foreign-type argspec))
1666                         (offset 0)
1667                         (size 0))
1668                    (typecase arg
1669                      (foreign-double-float-type
1670                       (setq size 8 offset (current-fpr-arg-offset))
1671                       (incf fprs-used)
1672                       (incf gprs-used 2))
1673                      (foreign-single-float-type
1674                       (setq size target::node-size offset (current-fpr-arg-offset))
1675                       (incf fprs-used)
1676                       (incf gprs-used 1))
1677                      (foreign-pointer-type
1678                       (setq size target::node-size offset (current-gpr-arg-offset))
1679                       (incf gprs-used))
1680                      (foreign-integer-type
1681                       (let* ((bits (foreign-type-bits arg)))
1682                         (setq size (ceiling bits 8)
1683                               offset (current-gpr-arg-offset))
1684                         (incf gprs-used (ceiling bits target::nbits-in-word))))
1685                      ((or foreign-record-type foreign-array-type)
1686                       (let* ((bits (ensure-foreign-type-bits arg)))
1687                         (setq size (ceiling bits 8)
1688                               offset (current-gpr-arg-offset))
1689                         (incf gprs-used (ceiling bits target::nbits-in-word))))
1690                      (t (break "argspec = ~s, arg = ~s" argspec arg)))
1691                    (push (list (encode-objc-type arg) offset size) result))))))))
1692    (declare (fixnum gprs-used fprs-used))
1693    (let* ((max-parm-end
1694            (- (apply #'max (mapcar #'(lambda (i) (+ (cadr i) (caddr i)))
1695                                    arg-info))
1696               objc-forwarding-stack-offset)))
1697      (format nil "~a~d~:{~a~d~}"
1698              (encode-objc-type
1699               (parse-foreign-type result-spec))
1700              max-parm-end
1701              arg-info))))
1702
1703#+x8664-target
1704(defun encode-objc-method-arglist (arglist result-spec)
1705  (let* ((offset 0)
1706         (arg-info
1707          (let* ((result nil))
1708                (dolist (argspec arglist (nreverse result))
1709                  (let* ((arg (parse-foreign-type argspec))
1710                         (delta 8))
1711                    (typecase arg
1712                      (foreign-double-float-type)
1713                      (foreign-single-float-type)
1714                      ((or foreign-pointer-type foreign-array-type))
1715                      (foreign-integer-type)
1716                      (foreign-record-type
1717                       (let* ((bits (ensure-foreign-type-bits arg)))
1718                         (setq delta (ceiling bits 8))))
1719                      (t (break "argspec = ~s, arg = ~s" argspec arg)))
1720                    (push (list (encode-objc-type arg) offset) result)
1721                    (setq offset (* 8 (ceiling (+ offset delta) 8))))))))
1722    (let* ((max-parm-end offset))
1723      (format nil "~a~d~:{~a~d~}"
1724              (encode-objc-type
1725               (parse-foreign-type result-spec))
1726              max-parm-end
1727              arg-info))))
1728
1729;;; In Apple Objc, a class's methods are stored in a (-1)-terminated
1730;;; vector of method lists.  In GNU ObjC, method lists are linked
1731;;; together.
1732(defun %make-method-vector ()
1733  #+apple-objc
1734  (let* ((method-vector (malloc 16)))
1735    (setf (%get-signed-long method-vector 0) 0
1736          (%get-signed-long method-vector 4) 0
1737          (%get-signed-long method-vector 8) 0
1738          (%get-signed-long method-vector 12) -1)
1739    method-vector))
1740
1741
1742;;; Make a meta-class object (with no instance variables or class
1743;;; methods.)
1744#-apple-objc-2.0
1745(defun %make-basic-meta-class (nameptr superptr rootptr)
1746  #+apple-objc
1747  (let* ((method-vector (%make-method-vector)))
1748    (make-record :objc_class
1749                 :isa (pref rootptr :objc_class.isa)
1750                 :super_class (pref superptr :objc_class.isa)
1751                 :name nameptr
1752                 :version 0
1753                 :info #$CLS_META
1754                 :instance_size 0
1755                 :ivars (%null-ptr)
1756                 :method<L>ists method-vector
1757                 :cache (%null-ptr)
1758                 :protocols (%null-ptr)))
1759  #+gnu-objc
1760  (make-record :objc_class
1761               :class_pointer (pref rootptr :objc_class.class_pointer)
1762               :super_class (pref superptr :objc_class.class_pointer)
1763               :name nameptr
1764               :version 0
1765               :info #$_CLS_META
1766               :instance_size 0
1767               :ivars (%null-ptr)
1768               :methods (%null-ptr)
1769               :dtable (%null-ptr)
1770               :subclass_list (%null-ptr)
1771               :sibling_class (%null-ptr)
1772               :protocols (%null-ptr)
1773               :gc_object_type (%null-ptr)))
1774
1775#-apple-objc-2.0
1776(defun %make-class-object (metaptr superptr nameptr ivars instance-size)
1777  #+apple-objc
1778  (let* ((method-vector (%make-method-vector)))
1779    (make-record :objc_class
1780                 :isa metaptr
1781                 :super_class superptr
1782                 :name nameptr
1783                 :version 0
1784                 :info #$CLS_CLASS
1785                 :instance_size instance-size
1786                 :ivars ivars
1787                 :method<L>ists method-vector
1788                 :cache (%null-ptr)
1789                 :protocols (%null-ptr)))
1790  #+gnu-objc
1791  (make-record :objc_class
1792                 :class_pointer metaptr
1793                 :super_class superptr
1794                 :name nameptr
1795                 :version 0
1796                 :info #$_CLS_CLASS
1797                 :instance_size instance-size
1798                 :ivars ivars
1799                 :methods (%null-ptr)
1800                 :dtable (%null-ptr)
1801                 :protocols (%null-ptr)))
1802
1803(defun make-objc-class-pair (superptr nameptr)
1804  #+apple-objc-2.0
1805  (#_objc_allocateClassPair superptr nameptr 0)
1806  #-apple-objc-2.0
1807  (%make-class-object
1808   (%make-basic-meta-class nameptr superptr (@class "NSObject"))
1809   superptr
1810   nameptr
1811   (%null-ptr)
1812   0))
1813
1814(defun superclass-instance-size (class)
1815  (with-macptrs ((super #+apple-objc-2.0 (#_class_getSuperclass class)
1816                        #-apple-objc-2.0 (pref class :objc_class.super_class)))
1817    (if (%null-ptr-p super)
1818      0
1819      (%objc-class-instance-size super))))
1820
1821       
1822
1823
1824#+gnu-objc
1825(progn
1826(defloadvar *gnu-objc-runtime-mutex*
1827    (%get-ptr (foreign-symbol-address "__objc_runtime_mutex")))
1828(defmacro with-gnu-objc-mutex-locked ((mutex) &body body)
1829  (let* ((mname (gensym)))
1830    `(let ((,mname ,mutex))
1831      (unwind-protect
1832           (progn
1833             (external-call "objc_mutex_lock" :address ,mname :void)
1834             ,@body)
1835        (external-call "objc_mutex_lock" :address ,mname :void)))))
1836)
1837
1838(defun %objc-metaclass-p (class)
1839  #+apple-objc-2.0 (not (eql #$NO (#_class_isMetaClass class)))
1840  #-apple-objc-2.0
1841  (logtest (pref class :objc_class.info)
1842           #+apple-objc #$CLS_META
1843           #+gnu-objc #$_CLS_META))
1844
1845;; No way to tell in Objc-2.0.  Does anything care ?
1846#-apple-objc-2.0
1847(defun %objc-class-posing-p (class)
1848  (logtest (pref class :objc_class.info)
1849           #+apple-objc #$CLS_POSING
1850           #+gnu-objc #$_CLS_POSING))
1851
1852
1853
1854
1855;;; Create (malloc) class and metaclass objects with the specified
1856;;; name (string) and superclass name.  Initialize the metaclass
1857;;; instance, but don't install the class in the ObjC runtime system
1858;;; (yet): we don't know anything about its ivars and don't know
1859;;; how big instances will be yet.
1860;;; If an ObjC class with this name already exists, we're very
1861;;; confused; check for that case and error out if it occurs.
1862(defun %allocate-objc-class (name superptr)
1863  (let* ((class-name (compute-objc-classname name)))
1864    (if (lookup-objc-class class-name nil)
1865      (error "An Objective C class with name ~s already exists." class-name))
1866    (let* ((nameptr (make-cstring class-name))
1867           (id (register-objc-class
1868                (make-objc-class-pair superptr nameptr)
1869))
1870           (meta-id (objc-class-id->objc-metaclass-id id))
1871           (meta (id->objc-metaclass meta-id))
1872           (class (id->objc-class id))
1873           (meta-name (intern (format nil "+~a" name)
1874                              (symbol-package name)))
1875           (meta-super (canonicalize-registered-metaclass
1876                        #+apple-objc-2.0
1877                        (#_class_getSuperclass meta)
1878                        #-apple-objc-2.0
1879                        (pref meta :objc_class.super_class))))
1880      (initialize-instance meta
1881                         :name meta-name
1882                         :direct-superclasses (list meta-super))
1883      (setf (objc-class-id-foreign-name id) class-name
1884            (objc-metaclass-id-foreign-name meta-id) class-name
1885            (find-class meta-name) meta)
1886      (%defglobal name class)
1887      (%defglobal meta-name meta)
1888    class)))
1889
1890;;; Set up the class's ivar_list and instance_size fields, then
1891;;; add the class to the ObjC runtime.
1892#-apple-objc-2.0
1893(defun %add-objc-class (class ivars instance-size)
1894  (setf
1895   (pref class :objc_class.ivars) ivars
1896   (pref class :objc_class.instance_size) instance-size)
1897  #+apple-objc
1898  (#_objc_addClass class)
1899  #+gnu-objc
1900  ;; Why would anyone want to create a class without creating a Module ?
1901  ;; Rather than ask that vexing question, let's create a Module with
1902  ;; one class in it and use #___objc_exec_class to add the Module.
1903  ;; (I mean "... to add the class", of course.
1904  ;; It appears that we have to heap allocate the module, symtab, and
1905  ;; module name: the GNU ObjC runtime wants to add the module to a list
1906  ;; that it subsequently ignores.
1907  (let* ((name (make-cstring "Phony Module"))
1908         (symtab (malloc (+ (record-length :objc_symtab) (record-length (:* :void)))))
1909         (m (make-record :objc_module
1910                         :version 8 #|OBJC_VERSION|#
1911                         :size (record-length :<M>odule)
1912                         :name name
1913                         :symtab symtab)))
1914    (setf (%get-ptr symtab (record-length :objc_symtab)) (%null-ptr))
1915    (setf (pref symtab :objc_symtab.sel_ref_cnt) 0
1916          (pref symtab :objc_symtab.refs) (%null-ptr)
1917          (pref symtab :objc_symtab.cls_def_cnt) 1
1918          (pref symtab :objc_symtab.cat_def_cnt) 0
1919          (%get-ptr (pref symtab :objc_symtab.defs)) class
1920          (pref class :objc_class.info) (logior #$_CLS_RESOLV (pref class :objc_class.info)))
1921    (#___objc_exec_class m)))
1922
1923#+apple-objc-2.0
1924(defun %add-objc-class (class)
1925  (#_objc_registerClassPair class))
1926
1927
1928
1929
1930
1931
1932
1933(let* ((objc-gen-message-args (make-array 10 :fill-pointer 0 :adjustable t)))
1934  (defun %objc-gen-message-arg (n)
1935    (let* ((len (length objc-gen-message-args)))
1936      (do* ((i len (1+ i)))
1937           ((> i n) (aref objc-gen-message-args n))
1938        (vector-push-extend (intern (format nil "ARG~d" i)) objc-gen-message-args)))))
1939
1940(defun objc-gen-message-arglist (n)
1941  (collect ((args))
1942    (dotimes (i n (args)) (args (%objc-gen-message-arg i)))))
1943
1944
1945
1946;;; Call get-objc-message-info for all known init messages.  (A
1947;;; message is an "init message" if it starts with the string "init",
1948;;; and has at least one declared method that returns :ID and is not a
1949;;; protocol method.
1950(defun register-objc-init-messages ()
1951  (do-interface-dirs (d)
1952    (dolist (init (cdb-enumerate-keys (db-objc-methods d)
1953                                      #'(lambda (string)
1954                                          (string= string "init" :end1 (min (length string) 4)))))
1955      (get-objc-message-info init))))
1956
1957   
1958(defvar *objc-init-messages-for-init-keywords* (make-hash-table :test #'equal)
1959  "Maps from lists of init keywords to dispatch-functions for init messages")
1960
1961
1962
1963(defun send-objc-init-message (instance init-keywords args)
1964  (let* ((info (gethash init-keywords *objc-init-messages-for-init-keywords*)))
1965    (unless info
1966      (let* ((name (lisp-to-objc-init init-keywords))
1967             (name-info (get-objc-message-info name nil)))
1968        (unless name-info
1969          (error "Unknown ObjC init message: ~s" name))
1970        (setf (gethash init-keywords *objc-init-messages-for-init-keywords*)
1971              (setq info name-info))))
1972    (apply (objc-message-info-lisp-name info) instance args)))
1973                   
1974
1975 
1976
1977                 
1978
1979;;; Return the "canonical" version of P iff it's a known ObjC class
1980(defun objc-class-p (p)
1981  (if (typep p 'macptr)
1982    (let* ((id (objc-class-id p)))
1983      (if id (id->objc-class id)))))
1984
1985;;; Return the canonical version of P iff it's a known ObjC metaclass
1986(defun objc-metaclass-p (p)
1987  (if (typep p 'macptr)
1988    (let* ((id (objc-metaclass-id p)))
1989      (if id (id->objc-metaclass id)))))
1990
1991;;; If P is an ObjC instance, return a pointer to its class.
1992;;; This assumes that all instances are allocated via something that's
1993;;; ultimately malloc-based.
1994(defun objc-instance-p (p)
1995  (when (typep p 'macptr)
1996    (let* ((idx (%objc-instance-class-index p)))
1997      (if idx (id->objc-class  idx)))))
1998
1999
2000
2001
2002(defun objc-private-class-id (classptr)
2003  (let* ((info (%get-private-objc-class classptr)))
2004    (when info
2005      (or (private-objc-class-info-declared-ancestor info)
2006          (with-macptrs ((super #+apple-objc-2.0 (#_class_getSuperclass classptr)
2007                                #-apple-objc-2.0 (pref classptr :objc_class.super_class)))
2008            (loop
2009              (when (%null-ptr-p super)
2010                (return))
2011              (let* ((id (objc-class-id super)))
2012                (if id
2013                  (return (setf (private-objc-class-info-declared-ancestor info)
2014                                id))
2015                  (%setf-macptr super #+apple-objc-2.0 (#_class_getSuperclass super)
2016                                #-apple-objc-2.0 (pref super :objc_class.super_class))))))))))
2017
2018(defun objc-class-or-private-class-id (classptr)
2019  (or (objc-class-id classptr)
2020      (objc-private-class-id classptr)))
2021
2022
2023(defun %objc-instance-class-index (p)
2024  (unless (%null-ptr-p p)
2025    (if (with-macptrs (q)
2026          (safe-get-ptr p q)
2027          (not (%null-ptr-p q)))
2028      (with-macptrs ((parent #+apple-objc (pref p :objc_object.isa)
2029                             #+gnu-objc (pref p :objc_object.class_pointer)))
2030        (or
2031         (objc-class-id parent)
2032         (objc-private-class-id parent))))))
2033
2034
2035;;; If an instance, return (values :INSTANCE <class>)
2036;;; If a class, return (values :CLASS <class>).
2037;;; If a metaclass, return (values :METACLASS <metaclass>).
2038;;; Else return (values NIL NIL).
2039(defun objc-object-p (p)
2040  (let* ((instance-p (objc-instance-p p)))
2041    (if instance-p
2042      (values :instance instance-p)
2043      (let* ((class-p (objc-class-p p)))
2044        (if class-p
2045          (values :class class-p)
2046          (let* ((metaclass-p (objc-metaclass-p p)))
2047            (if metaclass-p
2048              (values :metaclass metaclass-p)
2049              (values nil nil))))))))
2050
2051       
2052
2053
2054
2055;;; If the class contains an mlist that contains a method that
2056;;; matches (is EQL to) the selector, remove the mlist and
2057;;; set its IMP; return the containing mlist.
2058;;; If the class doesn't contain any matching mlist, create
2059;;; an mlist with one method slot, initialize the method, and
2060;;; return the new mlist.  Doing it this way ensures
2061;;; that the objc runtime will invalidate any cached references
2062;;; to the old IMP, at least as far as objc method dispatch is
2063;;; concerned.
2064#-apple-objc-2.0
2065(defun %mlist-containing (classptr selector typestring imp)
2066  #-apple-objc (declare (ignore classptr selector typestring imp))
2067  #+apple-objc
2068  (%stack-block ((iter 4))
2069    (setf (%get-ptr iter) (%null-ptr))
2070    (loop
2071        (let* ((mlist (#_class_nextMethodList classptr iter)))
2072          (when (%null-ptr-p mlist)
2073            (let* ((mlist (make-record :objc_method_list
2074                                       :method_count 1))
2075                   (method (pref mlist :objc_method_list.method_list)))
2076              (setf (pref method :objc_method.method_name) selector
2077                    (pref method :objc_method.method_types)
2078                    (make-cstring typestring)
2079                    (pref method :objc_method.method_imp) imp)
2080              (return mlist)))
2081          (do* ((n (pref mlist :objc_method_list.method_count))
2082                (i 0 (1+ i))
2083                (method (pref mlist :objc_method_list.method_list)
2084                        (%incf-ptr method (record-length :objc_method))))
2085               ((= i n))
2086            (declare (fixnum i n))
2087            (when (eql selector (pref method :objc_method.method_name))
2088              (#_class_removeMethods classptr mlist)
2089              (setf (pref method :objc_method.method_imp) imp)
2090              (return-from %mlist-containing mlist)))))))
2091             
2092
2093(defun %add-objc-method (classptr selector typestring imp)
2094  #+apple-objc-2.0
2095  (with-cstrs ((typestring typestring))
2096    (or (not (eql #$NO (#_class_addMethod classptr selector imp typestring)))
2097        (let* ((m (if (objc-metaclass-p classptr)
2098                    (#_class_getClassMethod classptr selector)
2099                    (#_class_getInstanceMethod classptr selector))))
2100          (if (not (%null-ptr-p m))
2101            (#_method_setImplementation m imp)
2102            (error "Can't add ~s method to class ~s" selector typestring)))))
2103  #-apple-objc-2.0
2104  (progn
2105    #+apple-objc
2106    (#_class_addMethods classptr
2107                        (%mlist-containing classptr selector typestring imp))
2108    #+gnu-objc
2109  ;;; We have to do this ourselves, and have to do it with the runtime
2110  ;;; mutex held.
2111    (with-gnu-objc-mutex-locked (*gnu-objc-runtime-mutex*)
2112      (let* ((ctypestring (make-cstring typestring))
2113             (new-mlist nil))
2114        (with-macptrs ((method (external-call "search_for_method_in_list"
2115                                              :address (pref classptr :objc_class.methods)
2116                                              :address selector
2117                                              :address)))
2118          (when (%null-ptr-p method)
2119            (setq new-mlist (make-record :objc_method_list :method_count 1))
2120            (%setf-macptr method (pref new-mlist :objc_method_list.method_list)))
2121          (setf (pref method :objc_method.method_name) selector
2122                (pref method :objc_method.method_types) ctypestring
2123                (pref method :objc_method.method_imp) imp)
2124          (if new-mlist
2125            (external-call "GSObjCAddMethods"
2126                           :address classptr
2127                           :address new-mlist
2128                           :void)
2129            (external-call "__objc_update_dispatch_table_for_class"
2130                           :address classptr
2131                           :void)))))))
2132
2133(defvar *lisp-objc-methods* (make-hash-table :test #'eq))
2134
2135(defstruct lisp-objc-method
2136  class-descriptor
2137  sel
2138  typestring
2139  class-p                               ;t for class methods
2140  imp                                   ; callback ptr
2141  )
2142
2143(defun %add-lisp-objc-method (m)
2144  (let* ((class (%objc-class-classptr (lisp-objc-method-class-descriptor m)))
2145         (sel (%get-selector (lisp-objc-method-sel m)))
2146         (typestring (lisp-objc-method-typestring m))
2147         (imp (lisp-objc-method-imp m)))
2148    (%add-objc-method
2149     (if (lisp-objc-method-class-p m)
2150       (pref class #+apple-objc :objc_class.isa #+gnu-objc :objc_class.class_pointer)
2151       class)
2152     sel
2153     typestring
2154     imp)))
2155
2156(def-ccl-pointers add-objc-methods ()
2157  (maphash #'(lambda (impname m)
2158               (declare (ignore impname))
2159               (%add-lisp-objc-method m))
2160           *lisp-objc-methods*))
2161
2162(defun %define-lisp-objc-method (impname classname selname typestring imp
2163                                         &optional class-p)
2164  (%add-lisp-objc-method
2165   (setf (gethash impname *lisp-objc-methods*)
2166         (make-lisp-objc-method
2167          :class-descriptor (load-objc-class-descriptor classname)
2168          :sel (load-objc-selector selname)
2169          :typestring typestring
2170          :imp imp
2171          :class-p class-p)))
2172  impname)
2173   
2174
2175
2176
2177
2178;;; If any of the argspecs denote a value of type :<BOOL>, push an
2179;;; appropriate SETQ on the front of the body.  (Order doesn't matter.)
2180(defun coerce-foreign-boolean-args (argspecs body)
2181  (do* ((argspecs argspecs (cddr argspecs))
2182        (type (car argspecs) (car argspecs))
2183        (var (cadr argspecs) (cadr argspecs)))
2184       ((null argspecs) body)
2185    (when (eq type :<BOOL>)
2186      (push `(setq ,var (not (eql ,var 0))) body))))
2187     
2188(defun lisp-boolean->foreign-boolean (form)
2189  (let* ((val (gensym)))
2190    `((let* ((,val (progn ,@form)))
2191        (if (and ,val (not (eql 0 ,val))) 1 0)))))
2192
2193;;; Return, as multiple values:
2194;;;  the selector name, as a string
2195;;;  the ObjC class name, as a string
2196;;;  the foreign result type
2197;;;  the foreign argument type/argument list
2198;;;  the body
2199;;;  a string which encodes the foreign result and argument types
2200(defun parse-objc-method (selector-arg class-arg body)
2201  (let* ((class-name (objc-class-name-string class-arg))
2202         (selector-form selector-arg)
2203         (selector nil)
2204         (argspecs nil)
2205         (resulttype nil)
2206         (struct-return nil))
2207    (flet ((bad-selector (why) (error "Can't parse method selector ~s : ~a"
2208                                   selector-arg why)))
2209      (typecase selector-form
2210        (string
2211         (let* ((specs (pop body)))
2212             (setq selector selector-form)
2213             (if (evenp (length specs))
2214               (setq argspecs specs resulttype :id)
2215               (setq resulttype (car (last specs))
2216                     argspecs (butlast specs)))))
2217        (cons                           ;sic
2218         (setq resulttype (pop selector-form))
2219         (unless (consp selector-form)
2220           (bad-selector "selector-form not a cons"))
2221         (ccl::collect ((components)
2222                         (specs))
2223           ;; At this point, selector-form should be either a list of
2224           ;; a single symbol (a lispified version of the selector name
2225           ;; of a selector that takes no arguments) or a list of keyword/
2226           ;; variable pairs.  Each keyword is a lispified component of
2227           ;; the selector name; each "variable" is either a symbol
2228           ;; or a list of the form (<foreign-type> <symbol>), where
2229           ;; an atomic variable is shorthand for (:id <symbol>).
2230           (if (and (null (cdr selector-form))
2231                    (car selector-form)
2232                    (typep (car selector-form) 'symbol)
2233                    (not (typep (car selector-form) 'keyword)))
2234             (components (car selector-form))
2235             (progn
2236               (unless (evenp (length selector-form))
2237                 (bad-selector "Odd length"))
2238               (do* ((s selector-form (cddr s))
2239                     (comp (car s) (car s))
2240                     (var (cadr s) (cadr s)))
2241                    ((null s))
2242                 (unless (typep comp 'keyword) (bad-selector "not a keyword"))
2243                 (components comp)
2244                 (cond ((atom var)
2245                        (unless (and var (symbolp var))
2246                          (bad-selector "not a non-null symbol"))
2247                        (specs :id)
2248                        (specs var))
2249                       ((and (consp (cdr var))
2250                             (null (cddr var))
2251                             (cadr var)
2252                             (symbolp (cadr var)))
2253                        (specs (car var))
2254                        (specs (cadr var)))
2255                       (t (bad-selector "bad variable/type clause"))))))
2256           (setq argspecs (specs)
2257                 selector (lisp-to-objc-message (components)))))
2258        (t (bad-selector "general failure")))
2259      ;; If the result type is of the form (:STRUCT <typespec> <name>),
2260      ;; make <name> be the first argument.
2261      (when (and (consp resulttype)
2262                 (eq (car resulttype) :struct))
2263        (destructuring-bind (typespec name) (cdr resulttype)
2264          (let* ((rtype (%foreign-type-or-record typespec)))
2265            (if (and (typep name 'symbol)
2266                     (typep rtype 'foreign-record-type))
2267              (setq struct-return name
2268                    resulttype (unparse-foreign-type rtype))
2269              (bad-selector "Bad struct return type")))))
2270      (values selector
2271              class-name
2272              resulttype
2273              argspecs
2274              body
2275              (do* ((argtypes ())
2276                    (argspecs argspecs (cddr argspecs)))
2277                   ((null argspecs) (encode-objc-method-arglist
2278                                     `(:id :<sel> ,@(nreverse argtypes))
2279                                     resulttype))
2280                (push (car argspecs) argtypes))
2281              struct-return))))
2282
2283(defun objc-method-definition-form (class-p selector-arg class-arg body env)
2284  (multiple-value-bind (selector-name
2285                        class-name
2286                        resulttype
2287                        argspecs
2288                        body
2289                        typestring
2290                        struct-return)
2291      (parse-objc-method selector-arg class-arg body)
2292    (%declare-objc-method selector-name
2293                          class-name
2294                          class-p
2295                          (concise-foreign-type resulttype)
2296                          (collect ((argtypes))
2297                            (do* ((argspecs argspecs (cddr argspecs)))
2298                                 ((null argspecs) (mapcar #'concise-foreign-type (argtypes)))
2299                              (argtypes (car argspecs)))))
2300    (let* ((self (intern "SELF")))
2301      (multiple-value-bind (body decls) (parse-body body env)
2302        (unless class-p
2303          (push `(%set-objc-instance-type ,self) body))
2304        (setq body (coerce-foreign-boolean-args argspecs body))
2305        (if (eq resulttype :<BOOL>)
2306          (setq body (lisp-boolean->foreign-boolean body)))
2307        (let* ((impname (intern (format nil "~c[~a ~a]"
2308                                        (if class-p #\+ #\-)
2309                                        class-name
2310                                        selector-name)))
2311               (_cmd (intern "_CMD"))
2312               (super (gensym "SUPER"))
2313               (params `(:id ,self :<sel> ,_cmd)))
2314          (when struct-return
2315            (push struct-return params))
2316          (setq params (nconc params argspecs))
2317          `(progn
2318            (defcallback ,impname
2319                (:without-interrupts nil
2320                 #+(and openmcl-native-threads apple-objc) :error-return
2321                 #+(and openmcl-native-threads apple-objc)  (condition objc-callback-error-return) ,@params ,resulttype)
2322              (declare (ignorable ,_cmd))
2323              ,@decls
2324              (rlet ((,super :objc_super
2325                       #+apple-objc :receiver #+gnu-objc :self ,self
2326                       #+apple-objc-2.0 :super_class #-apple-objc-2.0 :class
2327                       ,@(if class-p
2328                             #+apple-objc-2.0
2329                             `((external-call "_class_getSuperclass"
2330                                :address (pref (@class ,class-name) :objc_class.isa) :address))
2331                             #-apple-objc-2.0
2332                             `((pref
2333                                (pref (@class ,class-name)
2334                                 #+apple-objc :objc_class.isa
2335                                 #+gnu-objc :objc_class.class_pointer)
2336                                :objc_class.super_class))
2337                             #+apple-objc-2.0
2338                             `((external-call "_class_getSuperclass"
2339                                :address (@class ,class-name) :address))
2340                             #-apple-objc-2.0
2341                             `((pref (@class ,class-name) :objc_class.super_class)))))
2342                (macrolet ((send-super (msg &rest args &environment env) 
2343                             (make-optimized-send nil msg args env nil ',super ,class-name))
2344                           (send-super/stret (s msg &rest args &environment env) 
2345                             (make-optimized-send nil msg args env s ',super ,class-name)))
2346                  ,@body)))
2347            (%define-lisp-objc-method
2348             ',impname
2349             ,class-name
2350             ,selector-name
2351             ,typestring
2352             ,impname
2353             ,class-p)))))))
2354
2355(defmacro define-objc-method ((selector-arg class-arg)
2356                              &body body &environment env)
2357  (objc-method-definition-form nil selector-arg class-arg body env))
2358
2359(defmacro define-objc-class-method ((selector-arg class-arg)
2360                                     &body body &environment env)
2361  (objc-method-definition-form t selector-arg class-arg body env))
2362
2363
2364
2365
2366
2367(defmacro objc:defmethod (name (self-arg &rest other-args) &body body &environment env)
2368  (collect ((arglist)
2369            (arg-names)
2370            (arg-types)
2371            (bool-args)
2372            (type-assertions))
2373    (let* ((result-type nil)
2374           (selector nil)
2375           (cmd (intern "_CMD"))
2376           (class-p nil)
2377           (objc-class-name nil))
2378      (if (atom name)
2379        (setq selector (string name) result-type :id)
2380        (setq selector (string (car name)) result-type (concise-foreign-type (or (cadr name) :id))))
2381      (destructuring-bind (self-name lisp-class-name) self-arg
2382        (arg-names self-name)
2383        (arg-types :id)
2384        ;; Hack-o-rama
2385        (let* ((lisp-class-name (string lisp-class-name)))
2386          (if (eq (schar lisp-class-name 0) #\+)
2387            (setq class-p t lisp-class-name (subseq lisp-class-name 1)))
2388          (setq objc-class-name (lisp-to-objc-classname lisp-class-name)))
2389        (arg-types :<SEL>)
2390        (arg-names cmd)
2391        (dolist (arg other-args)
2392          (if (atom arg)
2393            (progn
2394              (arg-types :id)
2395              (arg-names arg))
2396            (destructuring-bind (arg-name arg-type) arg
2397              (let* ((concise-type (concise-foreign-type arg-type)))
2398                (unless (eq concise-type :id)
2399                  (let* ((ftype (parse-foreign-type concise-type)))
2400                    (if (typep ftype 'foreign-pointer-type)
2401                      (setq ftype (foreign-pointer-type-to ftype)))
2402                    (if (and (typep ftype 'foreign-record-type)
2403                             (foreign-record-type-name ftype))
2404                      (type-assertions `(%set-macptr-type ,arg-name
2405                                         (foreign-type-ordinal (load-time-value (%foreign-type-or-record ,(foreign-record-type-name ftype)))))))))
2406                (arg-types concise-type)
2407                (arg-names arg-name)))))
2408        (let* ((arg-names (arg-names))
2409               (arg-types (arg-types)))
2410          (do* ((names arg-names)
2411                (types arg-types))
2412               ((null types) (arglist result-type))
2413            (let* ((name (pop names))
2414                   (type (pop types)))
2415              (arglist type)
2416              (arglist name)
2417              (if (eq type :<BOOL>)
2418                (bool-args `(setq ,name (not (eql ,name 0)))))))
2419          (let* ((impname (intern (format nil "~c[~a ~a]"
2420                                          (if class-p #\+ #\-)
2421                                          objc-class-name
2422                                          selector)))
2423                 (typestring (encode-objc-method-arglist arg-types result-type))
2424                 (signature (cons result-type (cddr arg-types))))
2425            (multiple-value-bind (body decls) (parse-body body env)
2426             
2427              (setq body `((progn ,@(bool-args) ,@(type-assertions) ,@body)))
2428              (if (eq result-type :<BOOL>)
2429                (setq body `((%coerce-to-bool ,@body))))
2430              (setq body `((flet ((call-next-method (&rest args)
2431                                  (declare (dynamic-extent args))
2432                                  (apply (function ,(if class-p
2433                                                        '%call-next-objc-class-method
2434                                                        '%call-next-objc-method))
2435                                         ,self-name
2436                                         (@class ,objc-class-name)
2437                                         (@selector ,selector)
2438                                         ',signature
2439                                         args)))
2440                                 (declare (inline call-next-method))
2441                                 ,@body)))
2442              `(progn
2443                (%declare-objc-method
2444                 ',selector
2445                 ',objc-class-name
2446                 ,class-p
2447                 ',result-type
2448                 ',(cddr arg-types))
2449                (defcallback ,impname ( :error-return (condition objc-callback-error-return) ,@(arglist))
2450                  (declare (ignorable ,self-name ,cmd)
2451                           (unsettable ,self-name))
2452                  ,@decls
2453                  ,@body)
2454                (%define-lisp-objc-method
2455                 ',impname
2456                 ,objc-class-name
2457                 ,selector
2458                 ,typestring
2459                 ,impname
2460                 ,class-p)))))))))
2461
2462     
2463           
2464 
2465
2466(defun class-get-instance-method (class sel)
2467  #+apple-objc (#_class_getInstanceMethod class sel)
2468  #+gnu-objc (#_class_get_instance_method class sel))
2469
2470(defun class-get-class-method (class sel)
2471  #+apple-objc (#_class_getClassMethod class sel)
2472  #+gnu-objc   (#_class_get_class_method class sel))
2473
2474(defun method-get-number-of-arguments (m)
2475  #+apple-objc (#_method_getNumberOfArguments m)
2476  #+gnu-objc (#_method_get_number_of_arguments m))
2477
2478#+(and apple-objc (not apple-objc-2.0))
2479(progn
2480(defloadvar *original-deallocate-hook*
2481        #&_dealloc)
2482
2483(defcallback deallocate-nsobject (:address obj :int)
2484  (unless (%null-ptr-p obj)
2485    (remhash obj *objc-object-slot-vectors*))
2486  (ff-call *original-deallocate-hook* :address obj :int))
2487
2488(defun install-lisp-deallocate-hook ()
2489  (setf #&_dealloc deallocate-nsobject))
2490
2491#+later
2492(def-ccl-pointers install-deallocate-hook ()
2493  (install-lisp-deallocate-hook))
2494
2495(defun uninstall-lisp-deallocate-hook ()
2496  (clrhash *objc-object-slot-vectors*)
2497  (setf #&_dealloc *original-deallocate-hook*))
2498
2499(pushnew #'uninstall-lisp-deallocate-hook *save-exit-functions* :test #'eq
2500         :key #'function-name)
2501)
2502
2503 
2504
2505
2506
2507(defloadvar *nsstring-newline* #@"
2508")
2509
2510
2511;;; Execute BODY with an autorelease pool
2512
2513(defmacro with-autorelease-pool (&body body)
2514  (let ((pool-temp (gensym)))
2515    `(let ((,pool-temp (create-autorelease-pool)))
2516      (unwind-protect
2517           (progn ,@body)
2518        (release-autorelease-pool ,pool-temp)))))
2519
2520(defun %make-nsstring (string)
2521  (with-cstrs ((s string))
2522    (%make-nsstring-from-c-string s)))
2523
2524#+apple-objc-2.0
2525;;; This isn't defined in headers; it's sort of considered a built-in
2526;;; type by the ObjC frontend.  (See also the ObjC runtime source.)
2527(eval-when (:compile_toplevel :execute)
2528  (def-foreign-type nil
2529      (:struct :_objc_exception_data
2530        (:buf :jmp_buf)
2531        (:pointers (:array :address 4)))))
2532
2533
2534#+apple-objc-2.0
2535(defmacro with-ns-exceptions-as-errors (&body body)
2536  (let* ((data (gensym))
2537         (cframe (gensym)))
2538    `(rletZ ((,data :_objc_exception_data))
2539      (unwind-protect
2540           (progn
2541             (#_objc_exception_try_enter ,data)
2542             (catch ,data
2543               (with-c-frame ,cframe
2544                 (%associate-jmp-buf-with-catch-frame
2545                  ,data
2546                  (%fixnum-ref (%current-tcr) target::tcr.catch-top)
2547                  ,cframe)
2548                 (progn
2549                   ,@body))))
2550        (check-ns-exception ,data)))))
2551                 
2552             
2553   
2554#-apple-objc-2.0
2555(defmacro with-ns-exceptions-as-errors (&body body)
2556  #+apple-objc
2557  (let* ((nshandler (gensym))
2558         (cframe (gensym)))
2559    `(rletZ ((,nshandler :<NSH>andler2))
2560      (unwind-protect
2561           (progn
2562             (external-call "__NSAddHandler2" :address ,nshandler :void)
2563             (catch ,nshandler
2564               (with-c-frame ,cframe
2565                 (%associate-jmp-buf-with-catch-frame
2566                  ,nshandler
2567                  (%fixnum-ref (%current-tcr) target::tcr.catch-top)
2568                  ,cframe)
2569                 (progn
2570                   ,@body))))
2571        (check-ns-exception ,nshandler))))
2572  #+gnu-objc
2573  `(progn ,@body)
2574  )
2575
2576#+apple-objc-2.0
2577(defun check-ns-exception (data)
2578  (with-macptrs ((exception (#_objc_exception_extract data)))
2579    (if (%null-ptr-p exception)
2580      (#_objc_exception_try_exit data)
2581      (error (ns-exception->lisp-condition (%inc-ptr exception 0))))))
2582
2583#+(and apple-objc (not apple-objc-2.0))
2584(defun check-ns-exception (nshandler)
2585  (with-macptrs ((exception (external-call "__NSExceptionObjectFromHandler2"
2586                                           :address nshandler
2587                                           :address)))
2588    (if (%null-ptr-p exception)
2589      (external-call "__NSRemoveHandler2" :address nshandler :void)
2590      (error (ns-exception->lisp-condition (%inc-ptr exception 0))))))
2591
2592
2593
2594
Note: See TracBrowser for help on using the repository browser.