summaryrefslogtreecommitdiff
path: root/Lisp/utilities.lisp
blob: a1b3c4eb3c74a1d17b7426c83f917d216c0c00f7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
;;;; Objective-CL, an Objective-C bridge for Common Lisp.
;;;; Copyright (C) 2007  Matthias Andreas Benkard.
;;;;
;;;; This program is free software: you can redistribute it and/or
;;;; modify it under the terms of the GNU General Public License as
;;;; published by the Free Software Foundation, either version 3 of the
;;;; License, or (at your option) any later version.
;;;;
;;;; This program is distributed in the hope that it will be useful, but
;;;; WITHOUT ANY WARRANTY; without even the implied warranty of
;;;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
;;;; General Public License for more details.
;;;;
;;;; You should have received a copy of the GNU General Public License
;;;; along with this program.  If not, see
;;;; <http://www.gnu.org/licenses/>.

(in-package #:mulk.objective-cl)


(defgeneric objc-eql (x y)
  (:documentation "Test whether two references point to the same object.

## Arguments and Values:

*x* --- an **object**.

*y* --- an **object**.

Returns: *the-same-p* --- a **generalized boolean**.


## Description:

If at least one of the **object**s *x* and *y* is not an Objective-C
instance wrapper, __objc-eql__ behaves the same as __eql__.

For Objective-C instance wrappers, __objc-eql__ compares the pointers
represented by these instances.  If the pointers are _pointer-eq_ (see
the [CFFI manual][] for details), __objc-eql__ returns **true**.
Otherwise, it returns **false**.


## Examples:

    (objc-eql (find-objc-class 'ns-string)
              (find-objc-class 'ns-string))
     ;=> T

    (objc-eql (find-objc-class 'ns-string)
              (find-objc-class 'ns-object))
     ;=> NIL

    (setq greeting1 (invoke (find-objc-class 'ns-string)
                            :string-with-u-t-f-8-string \"Mulk.\"))
     ;=> #<GSCBufferString `Mulk.' {8109A38}>

    (setq greeting2 (invoke (find-objc-class 'ns-string)
                            :string-with-u-t-f-8-string \"Mulk.\"))
     ;=> #<GSCBufferString `Mulk.' {8109DB0}>

    (objc-equal greeting1 greeting2)
     ;=> T

    (objc-eql greeting1 greeting2)
     ;=> NIL

    (objc-equal greeting1 greeting1)
     ;=> T

    (objc-eql greeting1 greeting1)
     ;=> T


## See Also:

  __objc-equal__

[CFFI manual]: http://common-lisp.net/project/cffi/manual/html_node/index.html"))


(defgeneric objc-equal (x y)
  (:documentation "Test whether two objects are equal.

## Arguments and Values:

*x* --- an **object**.

*y* --- an **object**.

Returns: *equal-p* --- a **generalized boolean**.


## Description:

If at least one of the **object**s *x* and *y* is not an Objective-C
instance wrapper, __objc-equal__ behaves the same as __equal__.

For Objective-C instance wrappers, __objc-equal__ behaves the same as
`(or (objc-eql x y) (invoke x :is-equal y) (invoke y :is-equal x))`,
except that it converts the return values of the invocations into
**generalized boolean**s before evaluating said expression.  (Please
note that, as there is no way to distinguish methods that return
booleans from those that return numbers in the Objective-C runtime, the
invocations will return numbers.)


## Examples:

    (objc-equal (find-objc-class 'ns-string)
                (find-objc-class 'ns-string))
     ;=> T

    (objc-equal (find-objc-class 'ns-string)
                (find-objc-class 'ns-object))
     ;=> NIL

    (setq greeting1 (invoke (find-objc-class 'ns-string)
                            :string-with-u-t-f-8-string \"Mulk.\"))
     ;=> #<GSCBufferString `Mulk.' {8109A38}>

    (setq greeting2 (invoke (find-objc-class 'ns-string)
                            :string-with-u-t-f-8-string \"Mulk.\"))
     ;=> #<GSCBufferString `Mulk.' {8109DB0}>

    (objc-equal greeting1 greeting2)
     ;=> T

    (objc-eql greeting1 greeting2)
     ;=> NIL

    (objc-equal greeting1 greeting1)
     ;=> T

    (objc-eql greeting1 greeting1)
     ;=> T


## See Also:

  __objc-eql__, __invoke__"))


(defun truep (b)
  (or (eq b t)
      (and (numberp b)
           (not (eql b +no+)))))


(defun id-eql (x y)
  (pointer-eq (pointer-to x) (pointer-to y)))


(defun id-equal (x y)
  ;; Note that we have to use INVOKE rather than PRIMITIVE-INVOKE here,
  ;; because we don't know wheter BOOL == char.  We don't even know
  ;; whether the typespec "c" indicates a char or an int, for that
  ;; matter (it only does so on NeXT/x86, but neither on GNUstep nor on
  ;; NeXT/ppc32).
  (or (id-eql x y)
      (truep (if (typep x '(or id objc-class exception))
                 (invoke x :is-equal y)
                 (progn
                   (assert (typep y '(or id objc-class exception)))
                   (invoke y :is-equal x))))))


(defun objc-typep (x class-designator)
  (objc-eql (object-get-class x)
            (etypecase x
              (class x)
              (id (object-get-class x))
              ((or string symbol) (find-objc-class class-designator t)))))


(defmethod objc-eql (x y)
  (cl:eql x y))

(defmethod objc-eql ((x id) y)
  (id-eql x y))

(defmethod objc-eql (x (y id))
  (id-eql x y))

(defmethod objc-eql ((x objc-class) y)
  (id-eql x y))

(defmethod objc-eql (x (y objc-class))
  (id-eql x y))

(defmethod objc-eql ((x exception) y)
  (id-eql x y))

(defmethod objc-eql (x (y exception))
  (id-eql x y))

(defmethod objc-eql ((x selector) (y selector))
  (eql (selector-name x) (selector-name y)))

(defmethod objc-eql ((x selector) (y string))
  (eql (selector-name x) y))

(defmethod objc-eql ((x string) (y selector))
  (eql x (selector-name y)))


(defmethod objc-equal (x y)
  (cl:equal x y))

(defmethod objc-equal ((x id) y)
  (id-equal x y))

(defmethod objc-equal (x (y id))
  (id-equal x y))

(defmethod objc-equal ((x objc-class) y)
  (id-equal x y))

(defmethod objc-equal (x (y objc-class))
  (id-equal x y))

(defmethod objc-equal ((x exception) y)
  (id-equal x y))

(defmethod objc-equal (x (y exception))
  (id-equal x y))

(defmethod objc-equal ((x selector) (y selector))
  (equal (selector-name x) (selector-name y)))

(defmethod objc-equal ((x selector) (y string))
  (equal (selector-name x) y))

(defmethod objc-equal ((x string) (y selector))
  (equal x (selector-name y)))


;;; (@* "Object Representation")
(defmethod print-object ((object id) stream)
  (with-slots (pointer) object
    (if (cffi:pointer-eq pointer (pointer-to +nil+))
        (format stream "#.~S" '+nil+)
        (print-unreadable-object (object stream)
          (format stream "~A `~A' {~X}"
                  (objc-class-name (primitive-invoke object "class" 'id))
                  (primitive-invoke (primitive-invoke object "description" 'id)
                                    "UTF8String" :string)
                  (cffi:pointer-address pointer))))))


(defmethod print-object ((class objc-class) stream)
  (print-unreadable-object (class stream)
    (with-slots (pointer) class
      (format stream "~S ~A {~X}"
              (type-of class)
              (objc-class-name class)
              (cffi:pointer-address pointer)))))


(defmethod print-object ((meta-class objc-meta-class) stream)
  (print-unreadable-object (meta-class stream)
    (with-slots (meta-class-for-class pointer) meta-class
      (format stream "~S ~A {~X}"
              (type-of meta-class)
              (objc-class-name meta-class-for-class)
              (cffi:pointer-address pointer)))))


(defmethod print-object ((selector selector) stream)
  (print-unreadable-object (selector stream)
    (format stream "~S `~A'"
            (type-of selector)
            (selector-name selector))))


(defmethod print-object ((exception exception) stream)
  (print-unreadable-object (exception stream)
    (format stream "~S ~A {~X}"
            (type-of exception)
            (primitive-invoke (primitive-invoke exception "name" 'id)
                              "UTF8String" :string)
            (primitive-invoke exception "hash" :unsigned-int))))


;;; (@* "Structure and Union Definition")
(defun make-objc-struct/union-definer (type name-and-options c-names
                                       doc-and-slots)
  (let ((struct-name (ctypecase name-and-options
                       (list (first name-and-options))
                       (symbol name-and-options)))
        (slots (typecase (first doc-and-slots)
                 (string (rest doc-and-slots))
                 (t doc-and-slots))))
    `(progn
       ,(if (eq type :struct)
            `(defcstruct ,name-and-options ,@doc-and-slots)
            `(defcunion ,name-and-options ,@doc-and-slots))
       ,@(mapcar #'(lambda (slot)
                     (let ((slot-name (first slot)))
                       `(defun ,(intern (concatenate 'string
                                                     (symbol-name struct-name)
                                                     "-"
                                                     (symbol-name slot-name))
                                        (symbol-package slot-name))
                            (struct)
                          (check-type struct ,(if (eq type :struct)
                                                  `(or c-pointer
                                                       opaque-struct
                                                       tagged-struct)
                                                  `(or c-pointer
                                                       opaque-union
                                                       tagged-union)))
                          (when (typep struct ,(if (eq type :struct)
                                                   `'tagged-struct
                                                   `'tagged-union))
                            (assert (member (struct-name struct)
                                            ',c-names
                                            :test #'string=)))
                          (cffi:foreign-slot-value struct
                                                   ',struct-name
                                                   ',slot-name))))
                 slots))))

(defmacro define-objc-struct (name-and-options c-names &rest doc-and-slots)
  "Like CFFI:DEFCSTRUCT except that it provides accessors that check
their arguments according to their struct names."
  (make-objc-struct/union-definer :struct name-and-options c-names doc-and-slots))

(defmacro define-objc-union (name-and-options c-names &rest doc-and-slots)
  "Like CFFI:DEFCUNION except that it provides accessors that check
their arguments according to their struct names."
  (make-objc-struct/union-definer :union name-and-options c-names doc-and-slots))