source: trunk/source/objc-bridge/objc-runtime.lisp @ 13551

Last change on this file since 13551 was 13551, checked in by rme, 9 years ago

Delete function run-in-cocoa-process-and-wait. (The function
call-in-initial-process is a slightly elaborated version of it.)

In load-cocoa-framework: use call-in-initial-process.

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