source: trunk/source/examples/cocoa/easygui/views.lisp @ 12721

Last change on this file since 12721 was 12721, checked in by cater, 10 years ago

Extensive reorganisation, with unified handling of modifiers with keys and with mouse. Plenty still to do ...

File size: 69.9 KB
Line 
1(in-package :easygui)
2
3; ----------------------------------------------------------------------
4; This is the Clozure Common Lisp file named 'views.lisp', March 2009,
5; in the folder ccl/examples/cocoa/easygui/
6; It has been modified by AWSC (arthur.cater@ucd.ie), based upon
7; an earlier contribution by an unknown author,  borrowing also from
8; the 'Seuss.lisp' contribution of 'KD'.
9; Permission to use, further modify, disseminate, is hereby granted.
10; No warranty is expressed or implied.
11; Suggestions for - or accomplishment of - further improvement are welcome.
12; Accompanying documentation for this and related files will be written
13; and placed in ccl/examples/cocoa/easygui/documentation.txt
14; Testing has been only with Mac OS 10.5.6 on a 32 bit PPC
15; A demo of some capabilities is in 'easygui-demo-2.lisp'
16; ----------------------------------------------------------------------
17; It extends previous work in the following principal ways:
18; - windows, views and subviews may have nicknames
19; - checkboxes and radio-buttons are provided
20; - menus (pop-up, pull-down, contextual, and main-menu) are provided
21; - MCL-like coordinates (Y increases downward) may optionally be used
22;   for placing windows on the screen, placing subviews within windows,
23;   and graphics within drawing views.
24; - views can generally respond to mouse entry, exit, movement
25; - static text views can respond to mouse clicks
26; - text views can have colored text and colored background
27; - windows can decline to close, and/or invoke daemons upon closing.
28; - views and windows can have specific OBJC subclassed counterparts
29; - Shift, Command, Control and Option keys may be interrogated
30; ----------------------------------------------------------------------
31
32(defmacro running-on-this-thread ((&key (waitp t)) &rest body)
33;; The purpose of this trivial macro is to mark places where it is thought possible that
34;; it may be preferable to use running-on-main-thread.
35  (declare (ignore waitp))
36  `(progn ,@body))
37
38
39(defparameter *screen-flipped* nil
40"When NIL, window positions are taken as referring to their bottom left,
41as per Cocoa's native coordinate system.
42When non-NIL, window positions are taken to refer to their top left,
43as per - for instance - Digitool's MCL.
44The default orientation for graphics within a drawing view is set to
45correspond at the time of creation of that drawing view.")
46
47(defvar *cocoa-event* nil "Allows SHIFT-KEY-P & friends to operate on mouse clicks")
48
49(defvar *suppress-window-flushing* nil "
50When T, graphics output produced with calls to With-Focused-View will not be immediately
51flushed. This can reduce flicker and increase speed when there are many related uses of
52With-Focused-View. It is then necessary though to make sure that somebody somewhere
53calls Flush-Graphics at an appropriate time.
54The same effect can be obtained for an individual use of With-Focused-View by giving
55:WITHOUT-FLUSH as the first form in its body.")
56
57(defun ns-point-from-point (eg-point)  ;; probably belongs in new-cocoa-bindings.lisp
58  (ns:make-ns-point (point-x eg-point) (point-y eg-point)))
59
60(defmacro with-focused-view (cocoa-view &body forms)
61;; From KD's SEUSS.LISP but with added :WITHOUT-FLUSH syntax element
62;; If the first of forms is the keyword :WITHOUT-FLUSH, or if dynamically
63;; the value of *suppress-window-flushing* is non-NIL, then graphics output is not
64;; immediately flushed.
65  (let ((noflush (eq (first forms) ':without-flush)))
66    `(if (dcc (#/lockFocusIfCanDraw ,cocoa-view))
67       (unwind-protect
68           (progn ,@forms)
69         (dcc (#/unlockFocus ,cocoa-view))
70         ,(unless noflush
71            `(unless *suppress-window-flushing* (flush-graphics ,cocoa-view)))))))
72
73(defun flush-graphics (cocoa-view)
74  (running-on-this-thread ()
75    (dcc (#/flushGraphics (#/currentContext ns:ns-graphics-context)))
76    (dcc (#/flushWindow (#/window cocoa-view)))))
77
78(defun cocoa-null (ptr)
79  (equalp ptr ccl:+null-ptr+))
80
81
82
83
84;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
85;;; view protocol
86
87(defgeneric initialize-view (view)
88  (:documentation "Initializes the view with a cocoa object, sets it up
89according to initargs."))
90
91(defgeneric add-1-subview (view super-view)
92  (:documentation "Adds a subview to another view in the view hierarchy."))
93
94(defgeneric remove-1-subview (view super-view)
95  (:documentation "Removes a view from its superview, possibly deallocating it.
96To avoid deallocation, use RETAINING-OBJECTS"))
97
98;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
99;;; mixins
100;;;
101;;; Some view classes have an associated 'value', which can be accessed and set through
102;;; accessors STRING-VALUE-OF, INTEGER-VALUE-OF, FLOAT-VALUE-OF, DOUBLE-VALUE-OF
103;;; Such classes include STATIC-TEXT-VIEW, TEXT-INPUT-VIEW, PASSWORD-INPUT-VIEW, FORM-CELL-VIEW, SLIDER-VIEW
104;;;
105;;; Some view classes have an associated 'title', accessible and settable through VIEW-TEXT
106;;; Such classes include WINDOW, PUSH-BUTTON-VIEW, BOX-VIEW, RADIO-BUTTON-VIEW, CHECK-BOX-VIEW, MENU-VIEW, MENU-ITEM-VIEW
107;;;
108;;; Some view classes have an associated 'text', also accessible and settable through VIEW-TEXT
109;;; Such classes include STATIC-TEXT-VIEW, TEXT-INPUT-VIEW, PASSWORD-INPUT-VIEW, FORM-CELL-VIEW
110;;;
111;;; Most of those, apart from STATIC-TEXT-VIEW, may be manually 'editable'.
112;;;
113;;; Some view classes have an associated 'action'.
114;;; Such classes include PUSH-BUTTON-VIEW, SLIDER-VIEW, RADIO-BUTTON-VIEW, CHECK-BOX-VIEW, MENU-ITEM-VIEW
115;;;
116;;; Some view classes cannot ever have a contextual menu attached to them, even though their superview
117;;; and their subviews (if any) possibly do.
118;;; Such classes include PUSH-BUTTON-VIEW, RADIO-BUTTON-VIEW, CHECK-BOX-VIEW, MENU-VIEW, MENU-ITEM-VIEW
119;;; Perhaps these should be the same classes as those with actions.
120;;;
121;;; No view classes inherit from 'one-selection-mixin'
122;;; Apparently it was intended that TEXT-INPUT-VIEW might do so some day.
123;;;
124;;; Some view classes have a single 'content view'.
125;;; Such classes include WINDOW, BOX-VIEW.
126;;;
127;;; Some view classes inherit from 'background-coloring-mixin'
128;;; Such classes include STATIC-TEXT-VIEW ... for now
129;;;
130;;; Some view classes inherit from 'text-coloring-mixin'
131;;; Such classes include ...
132;;;
133;;; Some view classes inherit from 'fonting-mixin'
134;;; Such classes include ...
135;;;
136;;; Some view classes inherit from 'mouse-updownabout-mixin'
137;;; Such classes include ...
138;;;
139;;; Some view classes inherit from 'mouse-tracking-mixin'
140;;; Such classes include ...
141
142
143
144;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
145;;; Mixins dealing with text string and numeric equivalents
146
147(defclass value-mixin () ())
148
149(defclass string-value-mixin (value-mixin) ())
150
151(defclass numeric-value-mixin (value-mixin) ())
152
153(defclass view-text-mixin ()
154     ((text :initarg :text :initarg :dialog-item-text)))
155
156(defclass view-text-via-stringvalue-mixin (view-text-mixin string-value-mixin)
157     ())
158
159(defclass view-text-via-title-mixin (view-text-mixin)
160     ((text :initarg :title)))
161
162(macrolet ((def-type-accessor (class lisp-type cocoa-reader cocoa-writer
163                                     &key (new-value-form 'new-value) (return-value-converter 'identity))
164               (let ((name (intern (format nil "~A-VALUE-OF" lisp-type))))
165                 `(progn
166                    (defmethod ,name ((o ,class))
167                      (,return-value-converter (dcc (,cocoa-reader (cocoa-ref o)))))
168                    (defmethod (setf ,name) (new-value (o ,class))
169                      (dcc (,cocoa-writer (cocoa-ref o) ,new-value-form)))))))
170  (def-type-accessor string-value-mixin string   #/stringValue #/setStringValue:
171    :return-value-converter lisp-string-from-nsstring )
172  (def-type-accessor numeric-value-mixin integer #/intValue #/setIntValue:)
173  (def-type-accessor numeric-value-mixin float   #/floatValue #/setFloatValue:
174    :new-value-form (coerce new-value 'single-float))
175  (def-type-accessor numeric-value-mixin double  #/doubleValue #/setDoubleValue:
176    :new-value-form (coerce new-value 'double-float)))
177
178(defmethod view-text ((view view-text-via-stringvalue-mixin))
179  (string-value-of view))
180
181(defmethod view-text ((view view-text-via-title-mixin))
182  (lisp-string-from-nsstring (dcc (#/title (cocoa-ref view)))))
183
184(defmethod (setf view-text) (new-text (view view-text-via-stringvalue-mixin))
185  (setf (string-value-of view) (ccl::%make-nsstring new-text)))
186
187(defmethod (setf view-text) (new-text (view view-text-via-title-mixin))
188  (dcc (#/setTitle: (cocoa-ref view) (ccl::%make-nsstring new-text)))
189  new-text)
190
191(defmethod initialize-view :after ((view view-text-mixin))
192  (when (slot-boundp view 'text)
193    (setf (view-text view) (slot-value view 'text))))
194
195
196
197;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
198;;; Mixins dealing with mouse sensitivity (1)
199
200(defclass action-view-mixin ()
201  ((action :initarg :action)
202   (enabled :accessor dialog-item-enabled-p :initarg :dialog-item-enabled-p :initform t)))
203
204(defclass decline-menu-mixin () ())
205
206(defmethod set-dialog-item-enabled-p ((view action-view-mixin) value)
207  (unless (eq (not value) (not (dialog-item-enabled-p view)))
208    (setf (dialog-item-enabled-p view) value)
209    (dcc (#/setEnabled: (cocoa-ref view) (if value #$YES #$NO)))))
210
211(defmethod initialize-view :after ((view action-view-mixin))
212  (when (and (slot-boundp view 'action) (slot-value view 'action))
213    (setf (action view) (slot-value view 'action)))
214  (unless (dialog-item-enabled-p view)
215    (dcc (#/setEnabled: (cocoa-ref view) #$NO))))
216
217
218
219;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
220;;; Mixins dealing with text properties - font, foreground and background colors, editability
221
222(defclass text-coloring-mixin () ())
223
224(defclass text-fonting-mixin () ())
225
226(defclass editable-mixin () ())
227
228(defclass background-coloring-mixin ()
229  ((drawsbackground     :initform t :initarg :draws-background)))
230
231(defmethod initialize-view :after ((view background-coloring-mixin))
232  (dcc (#/setDrawsBackground: (cocoa-ref view) (slot-value view 'drawsbackground)))
233  (when (and (cocoa-ref view) (slot-boundp view 'background))
234      (dcc (#/setBackgroundColor: (cocoa-ref view) (slot-value view 'background)))))
235
236(defmethod editable-p ((view editable-mixin))
237  (dcc (#/isEditable (cocoa-ref view))))
238
239(defmethod (setf editable-p) (editable-p (view editable-mixin))
240  (check-type editable-p boolean)
241  (dcc (#/setEditable: (cocoa-ref view) editable-p))
242  editable-p)
243
244
245
246;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
247;;; Mixin dealing with selection: Possibly obsolete?
248
249(defclass one-selection-mixin () ())
250
251(defmethod (setf selection) (selection (view one-selection-mixin))
252  (dcc (#/setSelectedRange: (cocoa-ref view) (range-nsrange selection)))
253  selection)
254
255(defmethod selection ((view one-selection-mixin))
256  (let ((range (dcc (#/selectedRange (cocoa-ref view)))))
257    (if (= (ns:ns-range-location range) #$NSNotFound)
258        nil
259        (range (ns:ns-range-location range)
260               (ns:ns-range-length range)))))
261
262
263
264;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
265;;; Mixin for content views: window, box, perhaps others.
266
267(defclass content-view-mixin ()
268  ((content-view)
269   (flipped :initarg :flipped :initform *screen-flipped*)))
270
271(defmethod initialize-view :after ((view content-view-mixin))
272  (unless (slot-boundp view 'content-view)
273    (let ((containee (make-instance 'contained-view
274                       :cocoa-ref (dcc (#/contentView (cocoa-ref view)))
275                       :view-nick-name '%CONTENT-OF-CONTENT-VIEW%
276                       :flipped (slot-value view 'flipped))))
277      (setf (slot-value view 'content-view) containee
278            (slot-value containee 'parent) view))))
279
280(defmethod (setf content-view) (new-content-view (view content-view-mixin))
281  (setf (slot-value view 'content-view) new-content-view)
282  (dcc (#/setContentView: (cocoa-ref view) (cocoa-ref new-content-view)))
283  new-content-view)
284
285
286
287;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
288;;; Mixin for views that can respond to mouse entry, exit, and movement
289
290(defclass mouse-tracking-mixin ()
291  ((mouse-target :reader view-mouse-target :initform nil)
292   (mouse-enter :accessor view-mouse-enter :initarg :mouse-enter :initform nil)
293   (mouse-exit :accessor view-mouse-exit :initarg :mouse-exit :initform nil)
294   (mouse-move :accessor view-mouse-move :initarg :mouse-move :initform nil)))
295
296(defclass easygui-mouse-target (ns:ns-object)
297  ((view :initarg :view :reader mouse-target-view :initform nil))
298  (:metaclass ns:+ns-object))
299
300(defmethod initialize-view :after ((view mouse-tracking-mixin))
301  (let ((cocoaview (cocoa-ref view)))
302   (when cocoaview
303      (let ((target (make-instance 'easygui-mouse-target :view view)))
304        (setf (slot-value view 'mouse-target) target)
305        (dcc (#/retain target))
306        (dcc (#/addTrackingRect:owner:userData:assumeInside:
307         cocoaview
308         (dcc (#/bounds cocoaview))
309         target
310         ccl:+null-ptr+
311         #$NO))))))
312
313(objc:define-objc-method ((:void :mouse-entered (:id event)) easygui-mouse-target)
314  (let* ((view (mouse-target-view self))
315         (fn (view-mouse-enter view)))
316    (when fn (funcall fn view :event event :allow-other-keys t))))
317
318(objc:define-objc-method ((:void :mouse-exited (:id event)) easygui-mouse-target)
319  (let* ((view (mouse-target-view self))
320         (fn (view-mouse-exit view)))
321    (when fn (funcall fn view :event event :allow-other-keys t))))
322
323(objc:define-objc-method ((:void :mouse-move (:id event)) easygui-mouse-target)
324  (let* ((view (mouse-target-view self))
325         (fn (view-mouse-move view)))
326    (when fn (funcall fn view :event event :allow-other-keys t))))
327
328
329
330;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
331;;; Class for the sort of view that is contained by a content view.
332
333(defclass contained-view (view)
334  ((flipped :initarg :flipped)))
335
336(defmethod content-view ((view content-view-mixin))
337  (assert (eql (cocoa-ref (slot-value view 'content-view))
338               (dcc (#/contentView (cocoa-ref view)))))
339  (slot-value view 'content-view))
340
341;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
342;;; the actual views (when adding a new class,
343;;; consider *view-class-to-ns-class-map*):
344
345(defclass view (easy-cocoa-object)
346     ((position :initarg :position :reader view-position)
347      (size :initarg :size :reader view-size)
348      (frame-inited-p :initform nil)
349      (parent :reader view-container :initform nil)
350      (subviews :reader view-subviews :initarg :subviews :initform nil)
351      ;; When adding/removing multiple subviews, prevent multiple redraws.
352      ;; But - what code does those redraws?
353      (subviews-busy :accessor view-subviews-busy :initform nil)
354      (nickname :accessor view-nick-name :initarg :view-nick-name :initform nil)
355      (contextmenu :initarg :contextual-menu :initform nil)
356      (background :initarg :back-color :initform (#/whiteColor ns:ns-color))
357      (foreground :initarg :fore-color :initform (#/blackColor ns:ns-color))
358      (font :reader view-font :initarg :font :initarg :view-font :initform nil)
359      (specifically :reader view-specifically :initarg :specifically :initform nil)
360      ;; Next three not yet operative
361      (tip :initarg :tip :reader view-tip :initform nil)
362      (tiptag :initform nil)))
363
364(defclass window (content-view-mixin view-text-via-title-mixin view)
365     ((text :initarg :title :initform "" :reader window-title)
366      (zoomable-p :initarg :zoomable-p :initform t :reader window-zoomable-p)
367      (minimizable-p :initarg :minimizable-p :initform t
368                     :reader window-minimizable-p)
369      (resizable-p :initarg :resizable-p :initform t
370                   :reader window-resizable-p)
371      (closable-p :initarg :closable-p :initform t :reader window-closable-p)
372      (level :initarg :window-level :accessor window-level
373             :initform (dcc (#_CGWindowLevelForKey #$kCGNormalWindowLevelKey)))
374      (hidden :initarg :hidden :reader window-hidden :initform nil)
375      (window-needs-display-on-show :initform t)
376      (optimized :initarg :optimized :initform t) ; Set to NIL if you anticipate overlapping views in this window
377      (style :initarg :window-style :initform #$NSTitledWindowMask))
378  (:default-initargs :specifically 'cocoa-contained-view))
379
380;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
381;;;
382
383(defmethod clear-page ((view view))
384  (let* ((cview (cocoa-ref view))
385         (rect (dcc (#/bounds cview)))
386         (color (slot-value view 'background)))
387    (with-focused-view cview
388      (dcc (#/setFill color))
389      (dcc (#_NSRectFill rect)))))
390
391(defmethod clear-page ((window content-view-mixin))
392  (clear-page (content-view window)))
393
394;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
395;;;
396
397(defclass static-text-view (view view-text-via-stringvalue-mixin action-view-mixin text-coloring-mixin text-fonting-mixin background-coloring-mixin mouse-tracking-mixin)
398  ((mousedown           :initform nil :initarg :mouse-down    :accessor static-text-view-mouse-down)
399   (mouseup             :initform nil :initarg :mouse-up      :accessor static-text-view-mouse-up)
400   (mousedragged        :initform nil :initarg :mouse-dragged :accessor static-text-view-mouse-dragged)))
401
402(defclass text-input-view (view editable-mixin text-coloring-mixin text-fonting-mixin view-text-via-stringvalue-mixin
403                                ;; XXX: requires NSTextView, but this is an
404                                ;; NSTextField:
405                                #+not-yet one-selection-mixin
406                                mouse-tracking-mixin)
407     ((input-locked-p :initform nil :initarg :input-locked-p
408                      :reader text-input-locked-p)))
409
410(defclass password-input-view (text-input-view)
411     ())
412
413;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
414;;;
415
416(defclass push-button-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
417     ((default-button-p :initarg :default-button-p :initform nil
418                        :reader default-button-p)
419      (bezelstyle       :reader bezel-style        :initarg :bezel-style      :initform :rounded)))
420
421;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
422;;;
423
424(defclass form-view (view)
425     ((autosize-cells-p :initarg :autosize-cells-p :initform nil)
426      (interline-spacing :initarg :interline-spacing :initform 9)
427      ;; cell width
428      ))
429
430(defclass form-cell-view (view editable-mixin view-text-via-stringvalue-mixin)
431     ())
432
433;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
434;;;
435
436(defclass box-view (content-view-mixin view-text-via-title-mixin view) ())
437
438;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
439;;;
440
441(defclass drawing-view (view mouse-tracking-mixin)
442     (
443      ;; TODO: make this a mixin
444      (accept-key-events-p :initform nil :initarg :accept-key-events-p
445                           :accessor accept-key-events-p)
446      (flipped             :initform *screen-flipped* :initarg :flipped :reader flipped-p)
447      (mousedown           :initform nil :initarg :mouse-down    :accessor drawing-view-mouse-down)
448      (mouseup             :initform nil :initarg :mouse-up      :accessor drawing-view-mouse-up)
449      (mousedragged        :initform nil :initarg :mouse-dragged :accessor drawing-view-mouse-dragged)
450      (draw-fn             :initform nil :initarg :draw-fn :accessor draw-fn)))
451
452;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
453;;;
454
455(defclass slider-view (view numeric-value-mixin action-view-mixin)
456     ((max-value :initarg :max-value)
457      (min-value :initarg :min-value)
458      (tick-mark-count :initarg :tick-mark-count)
459      (tick-mark-values :initarg :tick-mark-values)
460      (discrete-tick-marks-p :initarg :discrete-tick-marks-p)))
461
462; ----------------------------------------------------------------------
463; Specialisations of ns-xxx classes always begin 'cocoa-'.
464; They allow such things as
465; - finding the easygui window associated with a ns-view & easygui::view
466; - flipped windows, flipped drawing-views
467; - clickable static text, editable text fields
468; - tooltips
469; ----------------------------------------------------------------------
470
471(defun calculate-ns-tooltip (cview)
472  ;; Returns a Lisp string to bhe used as a tooltip, or NIL.
473  ;; Easygu Views may or may not be created with a specific :TIP keyword argument.
474  ;; If there is none, there will be no tooltip displayed for the corresponding cocoa-view.
475  ;; Otherwise, if the argument is
476  ;;   - a string, that string is used
477  ;;   - a function, then if its return value is
478  ;;        - a string, that string is used
479  ;;        - NIL, a string informing that the tooltip is null and cocoa-describing the cocoa-view
480  ;;               (possibly useful for identifying this view if it turns up in errors or inspector)
481  ;;        - else a string naming the type of the result returned (possibly useful for debugging)
482  ;;   - the keyword :IDENTIFY, the cocoa-description of the cocoa-view
483  ;;   - anything else, a string informing what type the argument is.
484  (let* ((egview (when (slot-boundp cview 'easygui-view) (slot-value cview 'easygui-view)))
485         (tip (when egview (slot-value egview 'tip))))
486    (cond
487     ((stringp tip)
488      tip)
489     ((functionp tip)
490      (let ((it (funcall tip)))
491        (cond
492         ((stringp it)  it)
493         ((null it)     (format nil "Null tooltip for ~a" (lisp-string-from-nsstring (dcc (#/description cview)))))
494         (t (format nil "** Tooltip function returned non-string object of type ~s **" (type-of it))))))
495     ((eq tip :identify) (lisp-string-from-nsstring (dcc (#/description cview))))
496     ((null egview) 
497      (format nil "** Cocoa view ~s has no EasyGui-View **" cview))
498     ((null tip) (format nil "No tooltip for ~a" (lisp-string-from-nsstring (dcc (#/description cview)))))
499     (t (format nil "** Tip slot of Cocoa view ~s~%is of type ~s,~%not a string or a function or :IDENTIFY. **" cview tip)))))
500
501(defmacro define-tooltip-accessor (cocoa-class)
502  `(progn
503     (objc:defmethod #/view:stringForToolTip:point:userData:
504                     ((view ,cocoa-class)
505                      (tag :<NST>ool<T>ip<T>ag)
506                      (point :<NSP>oint)
507                      (userdata :id))
508       (declare (ignorable tag point userdata))
509       (ccl::%make-nsstring (or (calculate-ns-tooltip view) "")))
510     (objc:defmethod #/toolTip ((view ,cocoa-class))
511       (ccl::%make-nsstring (or (calculate-ns-tooltip view) "")))))
512
513(defclass cocoa-window (ns:ns-window)
514  ((easygui-window :reader easygui-window-of))
515  (:metaclass ns:+ns-object))
516
517(defmethod print-object ((object cocoa-window) stream)
518  (print-unreadable-object (object stream :type t :identity t)
519    (let ((egview (if (slot-boundp object 'easygui-window) (easygui-window-of object) nil)))
520      (format stream "[~:[~;~s~]]" egview (when egview (view-nick-name egview)))))
521  object)
522
523(defmethod easygui-window-of ((eview view))
524  (if (cocoa-ref eview) (easygui-window-of (cocoa-ref eview)) nil))
525
526(defmethod easygui-window-of ((nsview ns:ns-view))
527  (let ((nswindow (dcc (#/window nsview))))
528    (if (typep nswindow 'cocoa-window) (easygui-window-of nswindow) nil)))
529
530(defclass cocoa-extension-mixin ()
531  ((easygui-view :initarg :eg-view :reader easygui-view-of)))
532
533(defmethod print-object ((object cocoa-extension-mixin) stream)
534  (print-unreadable-object (object stream :type t :identity t)
535    (let ((egview (if (slot-boundp object 'easygui-view) (easygui-view-of object) nil)))
536      (format stream "[~:[~;~s~]]" egview (when egview (view-nick-name egview)))))
537  object)
538
539(defclass cocoa-text-field (cocoa-extension-mixin ns:ns-text-field) ()
540  (:metaclass ns:+ns-object))
541
542(define-tooltip-accessor cocoa-text-field)
543
544(defclass cocoa-mouseable-text-field (cocoa-text-field) ()
545  (:metaclass ns:+ns-object))
546
547(define-tooltip-accessor cocoa-mouseable-text-field)
548
549(defclass cocoa-contained-view (cocoa-extension-mixin ns:ns-view)
550  ((flipped :initarg :flipped :initform *screen-flipped*))
551  (:metaclass ns:+ns-object))
552
553(define-tooltip-accessor cocoa-contained-view)
554
555(defclass cocoa-secure-text-field (cocoa-extension-mixin ns:ns-secure-text-field) ()
556  (:metaclass ns:+ns-object))
557
558(define-tooltip-accessor cocoa-secure-text-field)
559
560(defclass cocoa-button (cocoa-extension-mixin ns:ns-button) ()
561  (:metaclass ns:+ns-object))
562
563(define-tooltip-accessor cocoa-button)
564
565(defclass cocoa-pop-up-button (cocoa-extension-mixin ns:ns-pop-up-button) ()
566  (:metaclass ns:+ns-object))
567
568(define-tooltip-accessor cocoa-pop-up-button)
569
570(defclass cocoa-menu-item (cocoa-extension-mixin ns:ns-menu-item) ()
571  (:metaclass ns:+ns-object))
572
573(define-tooltip-accessor cocoa-menu-item)
574
575(defclass cocoa-form (cocoa-extension-mixin ns:ns-form) ()
576  (:metaclass ns:+ns-object))
577
578(define-tooltip-accessor cocoa-form)
579
580(defclass cocoa-form-cell (cocoa-extension-mixin ns:ns-form-cell) ()
581  (:metaclass ns:+ns-object))
582
583(define-tooltip-accessor cocoa-form-cell)
584
585(defclass cocoa-box (cocoa-extension-mixin ns:ns-box) ()
586  (:metaclass ns:+ns-object))
587
588(define-tooltip-accessor cocoa-box)
589
590(defclass cocoa-drawing-view (cocoa-extension-mixin ns:ns-view)
591  ((flipped :initarg :flipped :initform *screen-flipped*))
592  (:metaclass ns:+ns-object))
593
594(define-tooltip-accessor cocoa-drawing-view)
595
596(defclass cocoa-slider (cocoa-extension-mixin ns:ns-slider) ()
597  (:metaclass ns:+ns-object))
598
599(define-tooltip-accessor cocoa-slider)
600
601(defparameter *view-class-to-ns-class-map*
602              '((static-text-view     . cocoa-mouseable-text-field)
603                (password-input-view  . cocoa-secure-text-field)
604                (text-input-view      . cocoa-text-field)
605                (push-button-view     . cocoa-button)
606                (check-box-view       . cocoa-button)
607                (radio-button-view    . cocoa-button)
608                (menu-view            . cocoa-pop-up-button)
609                (menu-item-view       . cocoa-menu-item)
610                (form-view            . cocoa-form)
611                (form-cell-view       . cocoa-form-cell)
612                (box-view             . cocoa-box)
613                (drawing-view         . cocoa-drawing-view)
614                (slider-view          . cocoa-slider)))
615
616;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
617;;; view initialization:
618
619(defmethod shared-initialize :around ((view view) new-slots &rest initargs)
620  (declare (ignore new-slots initargs))
621  (call-next-method)
622  (running-on-main-thread ()
623    (initialize-view view)))
624
625(defmethod initialize-view ((view view))
626  "Initializes the view using the class-to-ns-class map both as constraint
627on valid values of the :SPECIFICALLY initarg, and as source of default value.
628Also attaches contextual menu if there is one."
629  (when (slot-boundp view 'ref)
630    (return-from initialize-view nil))
631  (let ((ns-view-class (cdr (assoc (class-name (class-of view))
632                                   *view-class-to-ns-class-map*
633                                   :test #'subtypep)))
634        (specifically (view-specifically view))
635        cocoaview)
636    (when specifically
637      (cond
638       ((not (find-class specifically nil))
639        (cerror "Ignore ~a and use ~a default" "~a value for :SPECIFICALLY does not name a class" specifically ns-view-class))
640       ((or (null ns-view-class) (subtypep specifically ns-view-class))
641        (setf ns-view-class specifically))
642       (t (cerror "Ignore ~a and use ~a default" "~a value for :SPECIFICALLY is not a subclass of ~a" specifically ns-view-class))))
643    (if ns-view-class
644      (setf cocoaview
645            (cond
646              ((and (slot-boundp view 'position)
647                    (slot-boundp view 'size))
648               (setf (slot-value view 'frame-inited-p) t)
649               (make-instance ns-view-class
650                  :with-frame (with-slots (position size) view
651                                 (ns-rect-from-points position size))))
652              (t (make-instance ns-view-class)))
653            (cocoa-ref view) cocoaview)
654      (cerror "Continue with cocoa-ref unset" "No view class found for type ~a" (class-of view)))
655    (when (and cocoaview (slot-boundp view 'contextmenu))
656      (let ((menu (slot-value view 'contextmenu)))
657        (cond
658         ((null menu))
659         ((null ns-view-class))
660         ((typep menu 'menu-view)
661          (dcc (#/setMenu: cocoaview (slot-value menu 'ns-menu))))
662         (t (warn "Ignoring contextmenu value ~s for view ~s" menu view)))))
663   (when (and cocoaview
664              (slot-value view 'tip)
665              (dcc (#/respondsToSelector: cocoaview (\@selector #/bounds))))
666     (let ((bounds (#/bounds cocoaview)))
667       (setf (slot-value view 'tiptag)
668             (dcc (#/addToolTipRect:owner:userData: cocoaview bounds cocoaview ccl:+null-ptr+)))))))
669
670(defun screen-height nil
671  (running-on-this-thread ()
672    (ns:ns-rect-height (dcc (#/frame (#/objectAtIndex: (#/screens ns:ns-screen) 0))))))
673
674(defmethod view-content-rect ((view view) &optional hidden)
675  (if hidden
676    (ns:make-ns-rect 0 0 0 0)
677    (with-slots (position size) view
678      ;(if (slot-boundp view 'size)
679      ;  (format t "~&View ~s has size ~s~%" view size)
680      ;  (format t "~&View ~s has size unbound~%" view))
681      (let* ((height (if (slot-boundp view 'size) (point-y size) *window-size-default-y*))
682             (stated (if (slot-boundp view 'position) (point-y position) *window-position-default-y*))
683             (screentop (screen-height))  ;; TODO: dtrt for multiple screens
684             (bottom (if (and *screen-flipped* (typep view 'window))
685                       (- screentop height stated)
686                       stated)))
687        (ns:make-ns-rect
688         (if (slot-boundp view 'position) (point-x position) *window-position-default-x*)
689         bottom
690         (if (slot-boundp view 'size) (point-x size) *window-size-default-x*)
691         height)))))
692
693(defmethod initialize-view ((win window))
694  "Initialize size, title, flags."
695  (with-slots (level hidden optimized style flipped specifically) win
696    (unless (and (find-class specifically nil) (subtypep specifically 'cocoa-contained-view))
697      (cerror "Ignore ~a and create content view of type ~a"
698              "Value given for \":specifically\" is ~a which is not a subtype of ~a"
699              specifically 'cocoa-contained-view)
700      (setf specifically 'cocoa-contained-view))
701     (let* ((content-rect (view-content-rect win hidden))
702            (style-mask (logior ;; (flag-mask :zoomable-p (zoomable-p win))
703                         (flag-mask :resizable-p   (window-resizable-p win))
704                         (flag-mask :minimizable-p (window-minimizable-p win))
705                         (flag-mask :closable-p    (window-closable-p win))
706                         (if (or (window-resizable-p win) (window-minimizable-p win) (window-closable-p win))
707                           #$NSTitledWindowMask
708                           0)
709                         style))
710            (c-win
711             (make-instance 'cocoa-window
712               :with-content-rect content-rect
713               :style-mask style-mask
714               :backing #$NSBackingStoreBuffered ; TODO?
715               :defer t))
716            (containee (make-instance specifically)))
717       (setf (slot-value containee 'flipped) flipped)
718       (dcc (#/setFrame: containee content-rect))
719       (dcc (#/setContentView: c-win containee))
720       (dcc (#/setDelegate: c-win c-win))
721       (dcc (#/setBackgroundColor: c-win (slot-value win 'background)))
722       (dcc (#/setLevel: c-win level))
723       (when optimized (dcc (#/useOptimizedDrawing: c-win #$YES)))
724       (setf (cocoa-ref win) c-win)
725       (setf (slot-value c-win 'easygui-window) win)
726       (if hidden
727         (dcc (#/disableFlushWindow c-win))
728         (window-show win))
729       c-win)))
730
731(defmethod initialize-view :after ((view text-input-view))
732  (setf (editable-p view) (not (text-input-locked-p view)))
733  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
734
735(defmethod initialize-view :after ((view static-text-view))
736  (dcc (#/setEditable: (cocoa-ref view) nil))
737  (dcc (#/setBordered: (cocoa-ref view) nil))
738  (dcc (#/setBezeled: (cocoa-ref view) nil))
739  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
740
741(defparameter *bezelstyle-alist*
742  `((:round                    . #.#$NSRoundedBezelStyle)
743    (:square                   . #.#$NSRegularSquareBezelStyle)
744    (:regular-square           . #.#$NSRegularSquareBezelStyle)
745    (:thick-square             . #.#$NSThickSquareBezelStyle)
746    (:thicker-square           . #.#$NSThickerSquareBezelStyle)
747    (:disclosure               . #.#$NSDisclosureBezelStyle)
748    (:Shadowless-square        . #.#$NSShadowlessSquareBezelStyle)
749    (:circular                 . #.#$NSCircularBezelStyle)
750    (:textured-square          . #.#$NSTexturedSquareBezelStyle)
751    (:help-button              . #.#$NSHelpButtonBezelStyle)
752    (:small-square             . #.#$NSSmallSquareBezelStyle)
753    (:textured-rounded         . #.#$NSTexturedRoundedBezelStyle)
754    (:round-rect               . #.#$NSRoundRectBezelStyle)
755    (:recessed                 . #.#$NSRecessedBezelStyle)
756    (:rounded-disclosure       . #.#$NSRoundedDisclosureBezelStyle)))
757
758(defun bezel-style-lookup (key)
759  (rest (or (assoc key *bezelstyle-alist*) (first *bezelstyle-alist*))))
760
761(defmethod (setf bezel-style) (stylename (view push-button-view))
762  (setf (slot-value view 'bezelstyle) (if (assoc stylename *bezelstyle-alist*) stylename :round))
763  (dcc (#/setBezelStyle: (cocoa-ref view) (bezel-style-lookup (slot-value view 'bezelstyle))))
764  stylename)
765
766(defmethod initialize-view :after ((view push-button-view))
767  (dcc (#/setBezelStyle: (cocoa-ref view) (bezel-style-lookup (bezel-style view))))
768  (let ((default-button-p (slot-value view 'default-button-p)))
769    (typecase default-button-p
770      (cons
771       (dcc (#/setKeyEquivalent: (cocoa-ref view) 
772                                 (ccl::%make-nsstring (string (first default-button-p)))))
773       (dcc (#/setKeyEquivalentModifierMask:
774         (cocoa-ref view)
775         (apply #'logior (mapcar #'key-mask (cdr default-button-p))))))
776      (string
777       (dcc (#/setKeyEquivalent: (cocoa-ref view) (ccl::%make-nsstring default-button-p))))
778      (null)
779      (t
780       (dcc (#/setKeyEquivalent: (cocoa-ref view) (ccl::@ #.(string #\return)))))))
781  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
782
783(defmethod initialize-view :after ((view box-view))
784  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
785
786(defmethod initialize-view :after ((view form-view))
787  (when (slot-boundp view 'interline-spacing)
788    (dcc (#/setInterlineSpacing: (cocoa-ref view)
789                             (gui::cgfloat (slot-value view 'interline-spacing)))))
790  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
791
792(defmethod initialize-view :after ((view slider-view))
793  (with-slots (discrete-tick-marks-p tick-mark-count tick-mark-values min-value max-value) view
794     (cond ((and (slot-boundp view 'tick-mark-count)
795                 (slot-boundp view 'discrete-tick-marks-p)
796                 (slot-boundp view 'tick-mark-values)
797                 (/= (length tick-mark-values) tick-mark-count))
798            (error "Incompatible tick mark specification: ~A doesn't match ~
799                     count of ~A" tick-mark-count tick-mark-values))
800           ((or (not (slot-boundp view 'max-value))
801                (not (slot-boundp view 'min-value)))
802            (error "A slider view needs both :min-value and :max-value set.")))
803     (dcc (#/setMinValue: (cocoa-ref view) (float min-value (or 1.0d0 ns:+cgfloat-zero+))))
804     (dcc (#/setMaxValue: (cocoa-ref view) (float max-value (or 1.0d0 ns:+cgfloat-zero+))))
805     (when (slot-boundp view 'tick-mark-count)
806       (dcc (#/setNumberOfTickMarks: (cocoa-ref view) tick-mark-count))
807       (dcc (#/setAllowsTickMarkValuesOnly:
808             (cocoa-ref view) (not (not discrete-tick-marks-p))))))
809  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
810
811(defmethod initialize-view :after ((view text-coloring-mixin))
812  (dcc (#/setTextColor: (cocoa-ref view) (slot-value view 'foreground))))
813
814(defmethod initialize-view :after ((view text-fonting-mixin))
815  (when (slot-value view 'font)
816    (dcc (#/setFont: (cocoa-ref view) (slot-value view 'font)))))
817
818(defmethod (setf view-font) ((new ns:ns-font) (view view))
819  (setf (slot-value view 'font) new)
820  (dcc (#/setFont: (cocoa-ref view) new)))
821
822; ----------------------------------------------------------------------
823; Modifying position / size    of    view / window
824; ----------------------------------------------------------------------
825
826(defmethod (setf view-position) (point (self view))
827  (running-on-main-thread ()
828    (setf (slot-value self 'position) point)
829    (when (slot-value self 'frame-inited-p)
830      (dcc (#/setFrame: (cocoa-ref self) (view-content-rect self)))
831      (dcc (#/setNeedsDisplay (cocoa-ref self))))))
832
833(defmethod (setf view-position) (point (self window))
834  (running-on-main-thread ()
835    (setf (slot-value self 'position) point)
836    (unless (window-hidden self)
837      (let* ((contentrect (view-content-rect self nil))
838             (framerect (dcc (#/frameRectForContentRect: (cocoa-ref self) contentrect))))
839        (dcc (#/setFrame:display: (cocoa-ref self) framerect t))))))
840
841(defmethod (setf view-size) (point (self view))
842  (running-on-main-thread ()
843    (setf (slot-value self 'size) point)
844    (when (slot-value self 'frame-inited-p)
845      (dcc (#/setFrame: (cocoa-ref self) (view-content-rect self)))
846      (dcc (#/setNeedsDisplay (cocoa-ref self))))))
847
848(defmethod (setf view-size) (point (self window))
849  (running-on-main-thread ()
850    (setf (slot-value self 'size) point)
851    (unless (window-hidden self)
852      (let* ((contentrect (view-content-rect self nil))
853             (framerect (dcc (#/frameRectForContentRect: (cocoa-ref self) contentrect))))
854        (dcc (#/setFrame:display: (cocoa-ref self) framerect t))))))
855
856;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
857;;; view hierarchies:
858
859(defmethod set-needs-display ((view view) flag)
860  (running-on-this-thread ()
861    (dcc (#/setNeedsDisplay: (cocoa-ref view) flag))))
862
863(defmethod set-needs-display ((view content-view-mixin) flag)
864  (set-needs-display (content-view view) flag))
865
866(defmethod set-needs-display ((view window) flag)
867  (if (window-hidden view)
868    (setf (slot-value view 'window-needs-display-on-show) flag)
869    (set-needs-display (content-view view) flag)))
870
871(defmethod add-1-subview :around ((view view) (cw-view content-view-mixin))
872  (add-1-subview view (content-view cw-view)))
873
874(defmethod add-1-subview :around ((view view) (super-view view))
875  "Correctly initialize view positions"
876  (call-next-method)
877  (with-slots (position size frame-inited-p) view
878    (unless frame-inited-p
879      (setf frame-inited-p t)
880      (running-on-this-thread ()
881        (let ((cocoa-view (cocoa-ref view)))
882          (dcc (#/setFrameOrigin: cocoa-view (ns-point-from-point position)))
883          (if (slot-boundp view 'size)
884            (dcc (#/setFrameSize: cocoa-view (ns-point-from-point size)))
885            (dcc (#/sizeToFit cocoa-view))))))
886    (set-needs-display view t)
887    (unless (view-subviews-busy super-view) (set-needs-display super-view t))))
888
889(defmethod add-1-subview ((view view) (super-view view))
890  (running-on-this-thread ()
891    (setf (slot-value view 'parent) super-view)
892    (push view (slot-value super-view 'subviews))
893    (dcc (#/addSubview: (cocoa-ref super-view) (cocoa-ref view)))))
894
895(defun add-subviews (superview subview &rest subviews)
896  (setf (view-subviews-busy superview) t)
897  (add-1-subview subview superview)
898  (dolist (subview subviews)
899    (add-1-subview subview superview))
900  (set-needs-display superview t)
901  (setf (view-subviews-busy superview) nil)
902  superview)
903
904(defmethod remove-1-subview ((view view) (cw-view content-view-mixin))
905  (remove-1-subview view (content-view cw-view)))
906
907(defmethod remove-1-subview ((view view) (super-view view))
908  (assert (eql (cocoa-ref super-view) (dcc (#/superview (cocoa-ref view)))))
909  (assert (member view (view-subviews super-view)))
910  (assert (eq super-view (slot-value view 'parent)))
911  (maybe-invalidating-object (view)
912    (setf (slot-value super-view 'subviews) (delete view (slot-value super-view 'subviews)))
913    (setf (slot-value view 'parent) nil)
914    (running-on-this-thread ()
915      (dcc (#/removeFromSuperview (cocoa-ref view))))))
916
917(defun remove-subviews (superview subview &rest subviews)
918  (setf (view-subviews-busy superview) t)
919  (remove-1-subview subview superview)
920  (dolist (subview subviews)
921    (remove-1-subview subview superview))
922  (set-needs-display superview t)
923  (setf (view-subviews-busy superview) nil)
924  superview)
925
926(defmethod window-show ((window window))
927  (running-on-this-thread ()
928    (let ((cwin (cocoa-ref window)))
929      (when (window-hidden window)
930        (setf (slot-value window 'hidden) nil)
931        (let* ((contentrect (view-content-rect window nil))
932               (framerect (dcc (#/frameRectForContentRect: (cocoa-ref window) contentrect))))
933          (dcc (#/setFrame:display: (cocoa-ref window) framerect nil)))
934        (when (dcc (#/isMiniaturized cwin)) (dcc (#/deminiaturize: cwin cwin)))
935        (when (slot-value window 'window-needs-display-on-show)
936          (setf (slot-value window 'window-needs-display-on-show) nil)
937          (dcc (#/setNeedsDisplay: (cocoa-ref (content-view window)) t))))
938      (dcc (#/makeKeyAndOrderFront: cwin nil))
939      (when (dcc (#/isFlushWindowDisabled cwin))
940        (dcc (#/enableFlushWindow cwin))
941        (dcc (#/flushWindow cwin)))
942      window)))
943
944
945;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
946;;; Forms:
947
948(defmethod add-entry (entry (view form-view))
949  (make-instance 'form-cell-view
950     :cocoa-ref (dcc (#/addEntry: (cocoa-ref view) (ccl::%make-nsstring entry)))))
951
952(defun add-entries (view &rest entries)
953  (prog1 (mapcar (lambda (entry) (add-entry entry view)) entries)
954         (dcc (#/setAutosizesCells: (cocoa-ref view)
955                                    (slot-value view 'autosize-cells-p)))))
956
957(defmethod cell-count ((view form-view))
958  (dcc (#/numberOfRows (cocoa-ref view))))
959
960(defmethod nth-cell (index view)
961  (assert (< index (cell-count view)))
962  (let ((cocoa-cell (dcc (#/cellAtIndex: (cocoa-ref view) index))))
963    (when cocoa-cell
964      (make-instance 'form-cell-view :cocoa-ref cocoa-cell))))
965
966(defmethod (setf entry-text) (text view index)
967  (setf (view-text (nth-cell index view)) text))
968
969(defmethod entry-text (view index)
970  (view-text (nth-cell index view)))
971
972;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
973;;; Window closing
974         
975(defmethod window-may-close ((w window))
976"This generic is intended to allow applications to define :BEFORE and/or :AFTER methods
977invoked when windows are closed. The default primary method returns T to indicate that
978the window may close. If an overriding primary method returns NIL, the window will not
979close in response to user action but will still close if the application quits.
980(This is because window-may-close is called when the COCOA-WINDOW (specialised NS:NS-WINDOW)
981that is attached to an EASYGUI::WINDOW object receives a performClose: message, as when
982a user clicks the close button for example.)"
983  (declare (ignore w))
984  t)
985
986(defmethod perform-close ((w window))
987"This generic is intended to allow applications to mimic the user clicking a window's
988close button."
989  (running-on-this-thread ()
990    (dcc (#/performClose: (cocoa-ref w)  ccl:+null-ptr+))))
991
992(objc:define-objc-method ((:<BOOL> :window-should-close (:id sender)) cocoa-window)
993  (declare (ignore sender))  ; The cocoa-window has been set up as its own delegate. Naughty?
994  (if (window-may-close (easygui-window-of self)) #$YES #$NO))
995
996;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
997;;; Drawing:
998
999(defmethod clear-page ((cocoa-view cocoa-drawing-view))
1000  (let* ((view (easygui-view-of cocoa-view))
1001         (rect (dcc (#/bounds cocoa-view)))
1002         (color (slot-value view 'background)))
1003    (with-focused-view cocoa-view
1004      (dcc (#/setFill color))
1005      (dcc (#_NSRectFill rect)))))
1006         
1007(objc::defmethod (#/isFlipped :<BOOL>) ((self cocoa-drawing-view))
1008  (if (slot-value self 'flipped) #$YES #$NO))
1009
1010(objc::defmethod (#/isFlipped :<BOOL>) ((self cocoa-contained-view))
1011  (if (slot-value self 'flipped) #$YES #$NO))
1012
1013(defmethod initialize-view :after ((view drawing-view))
1014  (setf (slot-value (cocoa-ref view) 'flipped) (slot-value view 'flipped))
1015  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
1016
1017(objc:defmethod (#/drawRect: :void) ((self cocoa-drawing-view)
1018                                     (rect :<NSR>ect))
1019  (dcc (draw-view-rectangle (easygui-view-of self) (nsrect-rectangle rect))))
1020
1021(objc:defmethod (#/acceptsFirstReponder: :boolean) ((view cocoa-drawing-view))
1022  (accept-key-events-p (easygui-view-of view)))
1023
1024(defgeneric draw-view-rectangle (view rectangle)
1025  (:method ((view drawing-view) rectangle)
1026    (declare (ignorable view rectangle))
1027    (when (draw-fn view)
1028      (let ((cview (cocoa-ref view)))
1029        (with-focused-view cview (funcall (draw-fn view) view cview))))
1030    nil))
1031
1032(defmethod redisplay ((view drawing-view)
1033                      &key rect)
1034  (setf rect (if rect
1035                 (rectangle-nsrect rect)
1036                 (dcc (#/bounds (cocoa-ref view)))))
1037  (dcc (#/setNeedsDisplayInRect: (cocoa-ref view) rect)))
1038
1039(define-useful-mouse-event-handling-routines cocoa-drawing-view)
1040(define-useful-mouse-event-handling-routines cocoa-mouseable-text-field)
1041
1042;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1043;; Around methods for VIEW provide bindings for *modifier-key-pattern* for all kinds of views,
1044;; allowing for Shift-Key-P and friends.
1045;; Primary methods do nothing, but may be overridden by user code.
1046
1047;(defmethod mouse-down :around ((view view) &key cocoa-event location button click-count delta)
1048;  (declare (ignorable cocoa-event location button click-count delta))
1049;  (let ((*cocoa-event* cocoa-event)
1050;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1051;    (call-next-method)))
1052 
1053(defmethod mouse-down ((view view) &key cocoa-event location button click-count delta)
1054  (declare (ignorable view cocoa-event location button click-count delta))
1055  nil)
1056 
1057;(defmethod mouse-up :around ((view view) &key cocoa-event location button click-count delta)
1058;  (declare (ignorable cocoa-event location button click-count delta))
1059;  (let ((*cocoa-event* cocoa-event)
1060;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1061;    (call-next-method)))
1062 
1063(defmethod mouse-up ((view view) &key cocoa-event location button click-count delta)
1064  (declare (ignorable view cocoa-event location button click-count delta))
1065  nil)
1066
1067;(defmethod mouse-dragged :around ((view view) &key cocoa-event location button click-count delta)
1068;  (declare (ignorable cocoa-event location button click-count delta))
1069;  (let ((*cocoa-event* cocoa-event)
1070;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1071;    (call-next-method)))
1072 
1073(defmethod mouse-dragged ((view view) &key cocoa-event location button click-count delta)
1074  (declare (ignorable view cocoa-event location button click-count delta))
1075  nil)
1076 
1077;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1078;; Primary methods for DRAWING-VIEW. What now is the point?
1079
1080(defmethod mouse-down ((view drawing-view) &key cocoa-event location button click-count delta)
1081  (let ((mousefn (drawing-view-mouse-down view))
1082        (*cocoa-event* cocoa-event)
1083        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1084    (when mousefn
1085      (funcall mousefn view
1086               :location location
1087               :allow-other-keys t
1088               :button button
1089               :cocoa-event cocoa-event
1090               :click-count click-count
1091               :delta delta))))
1092
1093(defmethod mouse-up ((view drawing-view) &key cocoa-event location button click-count delta)
1094  (let ((mousefn (drawing-view-mouse-up view))
1095        (*cocoa-event* cocoa-event)
1096        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1097    (when mousefn
1098      (funcall mousefn view
1099               :location location
1100               :allow-other-keys t
1101               :button button
1102               :cocoa-event cocoa-event
1103               :click-count click-count
1104               :delta delta))))
1105
1106(defmethod mouse-dragged ((view drawing-view) &key cocoa-event location button click-count delta)
1107  (let ((mousefn (drawing-view-mouse-dragged view))
1108        (*cocoa-event* cocoa-event)
1109        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1110    (when mousefn
1111      (funcall mousefn view
1112               :location location
1113               :allow-other-keys t
1114               :button button
1115               :cocoa-event cocoa-event
1116               :click-count click-count
1117               :delta delta))))
1118
1119;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1120;; Primary methods for STATIC-TEXT-VIEW. What now is the point?
1121
1122(defmethod mouse-down ((view static-text-view) &key cocoa-event location button click-count delta)
1123  (let ((mousefn (static-text-view-mouse-down view))
1124        (*cocoa-event* cocoa-event)
1125        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1126    (when mousefn
1127      (funcall mousefn view
1128               :location location
1129               :allow-other-keys t
1130               :button button
1131               :cocoa-event cocoa-event
1132               :click-count click-count
1133               :delta delta))))
1134
1135(defmethod mouse-up ((view static-text-view) &key cocoa-event location button click-count delta)
1136  (let ((mousefn (static-text-view-mouse-up view))
1137        (*cocoa-event* cocoa-event)
1138        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1139    (when mousefn
1140      (funcall mousefn view
1141               :location location
1142               :allow-other-keys t
1143               :button button
1144               :cocoa-event cocoa-event
1145               :click-count click-count
1146               :delta delta))))
1147
1148(defmethod mouse-dragged ((view static-text-view) &key cocoa-event location button click-count delta)
1149  (let ((mousefn (static-text-view-mouse-dragged view))
1150        (*cocoa-event* cocoa-event)
1151        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1152    (when mousefn
1153      (funcall mousefn view
1154               :location location
1155               :allow-other-keys t
1156               :button button
1157               :cocoa-event cocoa-event
1158               :click-count click-count
1159               :delta delta))))
1160
1161; -------------------
1162(defmethod view-named (name (view view))
1163  (find name (view-subviews view) :key #'view-nick-name))
1164
1165(defmethod view-named (name (container content-view-mixin))
1166  (view-named name (content-view container)))
1167
1168(defmethod view-subviews ((w content-view-mixin))
1169  (view-subviews (content-view w)))
1170
1171; ----------------------
1172
1173(defmethod view-nickname-chain ((view view) &optional include-everything) "
1174Yields two values:
1175- a list of nicknames of containing views, starting with outermost container
1176- the view or window that contains the view with the first name in the list,
1177  or NIL if the first name belongs to a window.
1178If include-everything is NIL (the default), the list does not contain the
1179autogenerated name for content views of windows or boxes, and contains names
1180of views or windows that have non-NIL names. The second value may then be
1181a view or window that has no nickname of its own.
1182If include-everything is T, the list does contain the autogenerated name of
1183content views of windows or boxes, it does contain NIL for views named NIL,
1184and the second value will always be NIL."
1185  (do (chain
1186       nickname
1187       (outermost view (view-container outermost)))
1188      ((or (null outermost)
1189           (and (null (setf nickname (view-nick-name outermost)))
1190                (not include-everything)))               
1191       (values chain outermost))
1192    (when (or include-everything (not (eq nickname '%CONTENT-OF-CONTENT-VIEW%)))
1193      (push (view-nick-name outermost) chain))))
1194
1195; ----------------------
1196
1197(defclass check-box-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1198  ((checked :initarg :checked :initform nil)))
1199
1200(defmethod check-box-check ((self check-box-view) &optional perform)
1201  (running-on-this-thread ()
1202    (unless (eql (dcc (#/state (cocoa-ref self))) #$NSOnState)
1203      (if perform
1204        (dcc (#/performClick: (cocoa-ref self) nil))
1205        (dcc (#/setState: (cocoa-ref self) #$NSOnState)))
1206      t)))
1207
1208(defmethod initialize-view :after ((view check-box-view))
1209  (when (cocoa-ref view)
1210    (dcc (#/setButtonType: (cocoa-ref view) #$NSSwitchButton))
1211    (when (slot-value view 'checked) (check-box-check view))
1212    (setf (slot-value (cocoa-ref view) 'easygui-view) view)))
1213
1214(defmethod check-box-uncheck ((self check-box-view) &optional perform)
1215  (running-on-this-thread ()
1216    (unless (eql (dcc (#/state (cocoa-ref self))) #$NSOffState)
1217      (if perform
1218        (dcc (#/performClick: (cocoa-ref self) nil))
1219        (dcc (#/setState: (cocoa-ref self) #$NSOffState)))
1220      t)))
1221
1222(defmethod check-box-checked-p ((self check-box-view))
1223  (eql (dcc (#/state (cocoa-ref self))) #$NSOnState))
1224
1225(defmethod (setf check-box-checked-p) (new (self check-box-view))
1226  (if new
1227    (check-box-check self)
1228    (check-box-uncheck self))
1229  new)
1230
1231; -------------------------
1232(defclass radio-button-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1233  ((selected :initarg :selected :reader radio-button-selected-p :initform nil)
1234   (cluster  :initarg :cluster  :initform '#:default-cluster))
1235  (:default-initargs :action #'(lambda () nil)))
1236
1237(defun deselect-radio-button-cohorts (radio-button-view)
1238  (when (view-container radio-button-view)
1239    (dolist (sibling (view-subviews (view-container radio-button-view)))
1240      (when (and (not (eq sibling radio-button-view))
1241                 (typep sibling 'radio-button-view)
1242                 (eq (slot-value radio-button-view 'cluster) (slot-value sibling 'cluster))
1243                 (eql (dcc (#/state (cocoa-ref sibling))) #$NSOnState))
1244        (setf (slot-value sibling 'selected) nil)
1245        (dcc (#/setState: (cocoa-ref sibling) #$NSOffState))))))
1246 
1247(defmethod radio-button-select ((self radio-button-view) &optional perform)
1248  (running-on-this-thread ()
1249    (if perform
1250      (dcc (#/performClick: (cocoa-ref self) nil))
1251      (progn
1252        (deselect-radio-button-cohorts self)
1253        (setf (slot-value self 'selected) t)
1254        (dcc (#/setState: (cocoa-ref self) #$NSOnState))))))
1255
1256(defmethod initialize-view :after ((self radio-button-view))
1257  (when (cocoa-ref self)
1258    (dcc (#/setButtonType: (cocoa-ref self) #$NSRadioButton))
1259    (when (slot-value self 'selected) (radio-button-select self))
1260    (setf (slot-value (cocoa-ref self) 'easygui-view) self)))
1261
1262(defmethod radio-button-deselect ((self radio-button-view))
1263  (running-on-this-thread ()
1264    (dcc (#/setState: (cocoa-ref self) #$NSOffState))
1265    (prog1
1266      (radio-button-selected-p self)
1267      (setf (slot-value self 'selected) nil))))
1268
1269(defmethod (setf action) (handler (view radio-button-view))
1270  (call-next-method
1271   (lambda ()
1272     (deselect-radio-button-cohorts view)
1273     (setf (slot-value view 'selected) t)
1274     (funcall handler))
1275   view)
1276  handler)
1277
1278; ----------------------------------------------------------------------
1279; INVALIDATE-VIEW
1280; ----------------------------------------------------------------------
1281
1282(defmethod invalidate-view ((view view) &optional total)
1283  (declare (ignorable total))
1284  (let ((cview (cocoa-ref view)))
1285    (dcc (#/setNeedsDisplay: cview #$YES))))
1286
1287(defmethod invalidate-view ((window window) &optional total)
1288  (declare (ignorable total))
1289  (let* ((cocoaview (cocoa-ref window))
1290         (contentview (dcc (#/contentView cocoaview))))
1291    (dcc (#/setNeedsDisplay: contentview #$YES))))
1292
1293; ----------------------------------------------------------------------
1294; Methods to    GET- & SET-    FORE- & BACK-    COLOR
1295; ----------------------------------------------------------------------
1296
1297(defmethod set-fore-color ((view view) (color ns:ns-color))
1298  (setf (slot-value view 'foreground) color))
1299
1300(defmethod set-fore-color :before ((view view-text-via-stringvalue-mixin) (color ns:ns-color))
1301  (dcc (#/setTextColor: (cocoa-ref view) color)))
1302
1303(defmethod set-fore-color ((view cocoa-extension-mixin) (color ns:ns-color))
1304  (set-fore-color (easygui-view-of view) color))
1305
1306(defmethod set-back-color ((view view) (color ns:ns-color) &optional redisplay-p)
1307  (setf (slot-value view 'background) color)
1308  (when redisplay-p (invalidate-view view)))
1309
1310(defmethod set-back-color :after ((view static-text-view) (color ns:ns-color) &optional redisplay-p)
1311  (dcc (#/setBackgroundColor: (cocoa-ref view) color))
1312  (when redisplay-p (invalidate-view view)))
1313
1314(defmethod set-back-color ((view cocoa-extension-mixin) (color ns:ns-color) &optional redisplay-p)
1315  (set-back-color (easygui-view-of view) color redisplay-p))
1316
1317(defmethod get-fore-color ((view view))
1318  (slot-value view 'foreground))
1319
1320(defmethod get-fore-color ((view cocoa-extension-mixin))
1321  (get-fore-color (easygui-view-of view)))
1322
1323(defmethod get-back-color ((view view))
1324  (slot-value view 'background))
1325
1326(defmethod get-back-color ((view cocoa-extension-mixin))
1327  (get-back-color (easygui-view-of view)))
1328
1329; --------------------- Menus Begin ---------------------
1330
1331(defmethod view-text ((self ns:ns-menu))
1332  (lisp-string-from-nsstring (dcc (#/title self))))
1333
1334(defmethod (setf view-text) (new (self ns:ns-menu))
1335  (running-on-this-thread ()
1336    (dcc (#/setTitle: self (ccl::%make-nsstring new)))
1337    new))
1338
1339(defclass menu-view (view view-text-via-title-mixin decline-menu-mixin)
1340  ((selection   :initarg :selection   :reader menu-selection :initform nil)
1341   (menu-kind   :initarg :menu-kind   :reader menu-kind      :initform :pull-down-menu)
1342   (menu-items  :initarg :menu-items  :reader menu-items     :initform nil)
1343   ns-menu
1344   %result))
1345
1346(defclass menu-item-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1347  (parent-menu
1348   action
1349   submenu)
1350  (:default-initargs :action #'(lambda () nil)))
1351
1352;(defmethod (setf view-text) :after (new (menu menu-view))
1353;  (declare (ignorable new))
1354;  (dcc (#/setNeedsDisplay: (cocoa-ref menu) t)))
1355
1356(defmethod initialize-instance :after ((self menu-view) &rest args &key menu-items selection)
1357  (declare (ignorable args selection))
1358  (let ((ns-menu nil))
1359    (if (slot-boundp self 'ns-menu)
1360      (setf ns-menu (slot-value self 'ns-menu))
1361      (setf ns-menu (dcc (#/menu (cocoa-ref self)))
1362            (slot-value self 'ns-menu) ns-menu))
1363    ;(format t "~&Initializing menu ~a with ~a items~%" self (length menu-items))
1364    (dolist (item menu-items)
1365      ;(format t "~&Adding ~a to menu ~a~%" item self)
1366      (cond
1367       ((typep item 'menu-view)
1368        (let ((intermediary (make-instance 'menu-item-view
1369                              :title (view-text item))))
1370          (setf (slot-value intermediary 'submenu) item)
1371          (dcc (#/setSubmenu: (cocoa-ref intermediary) (slot-value item 'ns-menu)))
1372          (dcc (#/addItem: ns-menu (cocoa-ref intermediary)))))
1373       ((not (typep item 'menu-item-view))
1374        (warn "Ignoring so-called menu item ~s" item))
1375       ((slot-boundp item 'parent-menu)
1376        (warn "Ignoring menu item ~s, which is already an item in some menu" item))
1377       (t (let ((coco (cocoa-ref item)))
1378            (dcc (#/addItem: ns-menu coco))
1379            (setf (slot-value item 'parent-menu) self)))))))
1380
1381(defmethod (setf action) (new (menu-item menu-item-view))
1382  (call-next-method
1383   #'(lambda ()
1384       (if (slot-boundp menu-item 'parent-menu)
1385         (let ((parent (slot-value menu-item 'parent-menu)))
1386           (setf (slot-value parent 'selection) menu-item)
1387           (setf (slot-value parent '%result) (funcall new)))
1388         (funcall new)))
1389   menu-item)
1390  new)
1391
1392(defmethod set-menu-item-title ((menu-item menu-item-view) title)
1393  (running-on-this-thread ()
1394    (dcc (#/setTitle: (cocoa-ref menu-item) (ccl::%make-nsstring title)))))
1395
1396(defmethod set-menu-item-title ((menu-item ns:ns-menu-item) title)
1397  (running-on-this-thread ()
1398    (dcc (#/setTitle: menu-item (ccl::%make-nsstring title)))))
1399
1400; -------------------
1401(defclass pop-up-menu (menu-view)
1402  ()
1403  (:default-initargs :menu-kind :pop-up-menu))
1404
1405(defmethod initialize-instance :after ((self pop-up-menu) &rest args &key selection)
1406  (declare (ignorable args))
1407  (with-slots (ns-menu menu-items) self
1408    (setf (view-text self)
1409          (cond
1410           ((null menu-items)
1411            "<No Items>")
1412           ((null selection)
1413            (setf (slot-value self 'selection) (first menu-items))
1414            (view-text (first menu-items)))
1415           ((stringp selection)
1416            selection)
1417           ((member selection menu-items)
1418            (setf (slot-value self 'selection) selection)
1419            (view-text selection))
1420           (t "<Selection Invalid>"))))
1421  (setf (slot-value (cocoa-ref self) 'easygui-view) self))
1422
1423; ----------------------
1424(defclass pull-down-menu (menu-view)
1425  ()
1426  (:default-initargs :menu-kind :pull-down-menu))
1427
1428(defmethod initialize-instance :after ((self pull-down-menu) &rest args &key title)
1429  (declare (ignorable args))
1430  (running-on-this-thread ()
1431    (dcc (#/insertItemWithTitle:atIndex: (cocoa-ref self) (ccl::%make-nsstring (or title "<No Title>")) 0))))
1432
1433(defmethod initialize-view :after ((self pull-down-menu))
1434  (running-on-this-thread ()
1435    (when (cocoa-ref self)
1436      (dcc (#/setPullsDown: (cocoa-ref self) #$YES))
1437      (setf (slot-value (cocoa-ref self) 'easygui-view) self))))
1438
1439; -----------------------
1440(defclass contextual-menu (menu-view)
1441  ()
1442  (:default-initargs :menu-kind :contextual-menu))
1443
1444(defgeneric add-contextual-menu (container menu &optional subviews))
1445
1446(defmethod add-contextual-menu ((window window) (menu menu-view) &optional subviews)
1447  (add-contextual-menu (content-view window) menu subviews))
1448
1449(defmethod add-contextual-menu ((view view) (menu menu-view) &optional subviews)
1450  (running-on-this-thread ()
1451    (dcc (#/setMenu: (cocoa-ref view) (slot-value menu 'ns-menu)))
1452    (when subviews
1453      (dolist (sub (view-subviews view))
1454        (unless (or (not (cocoa-null (dcc (#/menu (cocoa-ref sub)))))
1455                    (typep sub 'decline-menu-mixin))
1456          (add-contextual-menu sub menu subviews))))))
1457
1458(defmethod add-contextual-menu ((view menu-view) (refusenik decline-menu-mixin) &optional subviews)
1459  (declare (ignore subviews))
1460  (error "Cannot add a contextual menu to a view of class ~s" (type-of refusenik)))
1461
1462; -------------------------
1463(defun application-object nil
1464  (dcc (#/sharedApplication ns:ns-application)))
1465
1466(defun application-main-menu nil
1467  (dcc (#/mainMenu (application-object))))
1468
1469(defgeneric navigate-menu (titles menu))
1470
1471(defmethod navigate-menu ((titles list) (menu menu-view))
1472;; Returns NIL if the path of titles leads nowhere, when no appropriately titled menu-item or submenu exists;
1473;; Returns a EasyGui MENU-ITEM if the path of titles leads to a leaf item;
1474;; Returns a EasyGui MENU-VIEW if the path of titles leads to a submenu.
1475  (cond
1476   ((null titles) menu)
1477   (t (let ((it (find (first titles) (menu-items menu) :test #'equalp :key #'view-text)))
1478        (when it (navigate-menu (rest titles) it))))))
1479
1480(defun navigate-native-menu (titles menu)
1481;; Returns a NIL or a NS:NS-MENU-ITEM or a NS:NS-MENU
1482;; Returns a NS:NS-MENU when the title path leads to a submenu,
1483;; Returns a NS;NS-MENU-ITEM when the title path leads to a leaf menu item,
1484;; Returns NIL when the title path leads nowhere.
1485  (running-on-this-thread ()
1486    (if (null titles)
1487      menu
1488      (do ((number (dcc (#/numberOfItems menu)))
1489           (index 0 (1+ index))
1490           item found)
1491          ((or found (>= index number))
1492           (cond
1493            ((or (null found) (null (rest titles))) found)
1494            ((null (dcc (#/hasSubmenu found))) nil)
1495            (t (navigate-native-menu (rest titles) (dcc (#/submenu found))))))
1496        (setf item (dcc (#/itemAtIndex: menu index)))
1497        (if (or (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title item))))
1498                ; The Apple menu item has title "" but its submenu has title "Apple", hence ...
1499                (and (dcc (#/hasSubmenu item))
1500                     (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title (dcc (#/submenu item))))))))
1501          (setf found item))))))
1502
1503(defmethod navigate-topbar ((titles list))
1504  (navigate-native-menu titles (application-main-menu)))
1505
1506(defun add-menu-item (menu titles &optional action)
1507;; Adds a chain of submenus and a final leaf item with the indicated action.
1508;; If the final leaf item already exists, its action will be changed. Perhaps this is too dangerous.
1509;; The Apple submenu may not be altered; the application's submenu cannot be found.
1510  (cond
1511   ((null titles)
1512    (cerror "Return NIL" "No title path supplied"))
1513   ((not (and (consp titles) (stringp (first titles))))
1514    (cerror "Return NIL, some empty submenus may have been created" "Title path is not a list of strings"))
1515   ((not (typep menu 'ns:ns-menu))
1516    (cerror "Return NIL" "Not a Cocoa menu: ~s" menu))
1517   (t (let* ((ns-title (ccl::%make-nsstring (first titles)))
1518             (item (dcc (#/itemWithTitle: menu ns-title)))
1519             (ns-nullstring (ccl::%make-nsstring "")))
1520        (flet ((linkup (leaf action) ;; Modelled on code in easygui/action-targets.lisp
1521                 (let ((target (make-instance 'generic-easygui-target :handler (or action #'(lambda () nil)) :shooter leaf)))
1522                   (dcc (#/setTarget: leaf target))
1523                   (dcc (#/setAction: leaf (\@selector #/activateAction))))))
1524          (cond
1525           ((equalp (first titles) "-")
1526            (if (rest titles)
1527              (cerror "Leave menu unchanged" "A menu separator (an item having title \"-\") may not have a submenu")
1528              (dcc (#/addItem: menu (dcc (#/separatorItem ns:ns-menu-item))))))
1529           ((cocoa-null item) ;; No such item, something must be added
1530            (if (rest titles)
1531              (let ((number (dcc (#/numberOfItems menu)))
1532                    (submenu (make-instance 'ns:ns-menu)))
1533                (running-on-this-thread ()
1534                  (dcc (#/addItemWithTitle:action:keyEquivalent: menu ns-title ccl:+null-ptr+ ns-nullstring))
1535                  (setf item (dcc (#/itemAtIndex: menu number))) ;; That's where it got put
1536                  (dcc (#/initWithTitle: submenu ns-title))
1537                  (dcc (#/setSubmenu: item submenu)))
1538                (add-menu-item submenu (rest titles) action))
1539              (let ((number (dcc (#/numberOfItems menu))))
1540                (running-on-this-thread ()
1541                  (dcc (#/addItemWithTitle:action:keyEquivalent: menu ns-title ccl:+null-ptr+ ns-nullstring))
1542                  (setf item (dcc (#/itemAtIndex: menu number))))
1543                (linkup item action))))
1544           ((and (null (rest titles)) (dcc (#/hasSubmenu item)))
1545            (cerror "Leave menu unchanged" "An Action may not be added to any item with a submenu"))
1546           ((and (rest titles) (dcc (#/hasSubmenu item)))
1547            (add-menu-item (dcc (#/submenu item)) (rest titles) action))
1548           ((rest titles)
1549            (cerror "Leave menu unchanged" "An existing menu item cannot be converted to have a submenu"))
1550           (t (linkup item action)))))))) ;; Change the action of an existing item: desirable, or dangerous?           
1551
1552(defun add-topbar-item (titles &optional action)
1553  (if (and (consp titles) (rest titles))
1554    (add-menu-item (application-main-menu) titles action)
1555    (cerror "Return NIL" "Title path must be a list with at least two elements: ~s" titles)))
1556
1557(defun remove-menu-item (menu titles retain-if-empty)
1558  (if (not (and (consp titles) (stringp (first titles))))
1559    (cerror "Return NIL" "Title path is not a list of strings")
1560    (do ((number (dcc (#/numberOfItems menu)))
1561         (index 0 (1+ index))
1562         item found)
1563        ((or found (>= index number))
1564         (when found
1565           (if (rest titles)
1566             (when (dcc (#/hasSubmenu found))
1567               (remove-menu-item (dcc (#/submenu found)) (rest titles) retain-if-empty)
1568               (unless (or retain-if-empty (> (dcc (#/numberOfItems (dcc (#/submenu found)))) 0))
1569                 (dcc (#/removeItem: menu found))))
1570             (dcc (#/removeItem: menu found)))))
1571      (setf item (dcc (#/itemAtIndex: menu index)))
1572      (when (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title item))))
1573        (setf found item)))))
1574
1575(defun remove-topbar-item (titles &key retain-if-empty)
1576  (when (and (consp titles)
1577             (not (member (first titles) '("" "Apple") :test #'equalp)))
1578    (remove-menu-item (application-main-menu) titles retain-if-empty)))
1579
1580(defun add-application-submenu (title &rest trees) "
1581Adds a menu to the topbar application-menu with the given title.
1582Its menu-items names are got from the CARs of the trees.
1583The CDRs of these trees may consist either of further trees, allowing arbitrarily
1584deep menu structures, or of a one-element list that is expected to be a parameterless
1585function to be used as the Action of a leaf menu item.
1586Example:
1587  (add-application-submenu \"Beeps\"
1588     '(\"Normal\" #'normal-beep)
1589     '(\"Stupid\" #'stupid-beep)
1590     '(\"Choose\" (\"Custom beep 1\" #'custom-beep-1-not-implemented)
1591                (\"Custom beep 2\" #'custom-beep-2-not-implemented)))
1592"
1593  (labels ((valid-tree (tree)
1594             (and (consp tree) (stringp (first tree))))
1595           (prepending (seq tree)
1596             (cond
1597              ((every #'valid-tree (rest tree))
1598               (dolist (subtree (rest tree))
1599                 (prepending (append seq (list (first subtree))) (rest subtree))))
1600              ((and (consp tree) (stringp (first tree)) (consp (rest tree)) (null (cddr tree)))
1601               (add-topbar-item (append seq (list (first tree))) (second tree)))
1602              (t (cerror "Ignore this tree" "Malformed tree ~s" tree)))))
1603    (if (every #'valid-tree trees)
1604      (dolist (subtree trees) (prepending (list title) subtree))
1605      (cerror "Return NIL" "Malformed top-level trees"))))
1606
1607; ---------------
1608; Keyboard input handling
1609
1610(defmethod view-key-event-handler ((view window) char)
1611  (declare (ignorable char))
1612  nil)
1613
1614(objc:define-objc-method ((:void :key-down (:id event)) cocoa-window)
1615  (let ((*cocoa-event* event)
1616        (*modifier-key-pattern* (#/modifierFlags event)))
1617    (view-key-event-handler
1618     (easygui-window-of self)
1619     (schar (lisp-string-from-nsstring (dcc (#/charactersIgnoringModifiers event))) 0))))
1620
1621(defun shift-key-p nil
1622  (not (zerop (logand *modifier-key-pattern* (key-mask :shift)))))
1623
1624(defun control-key-p nil
1625  (not (zerop (logand *modifier-key-pattern* (key-mask :control)))))
1626
1627(defun alt-key-p nil
1628  (not (zerop (logand *modifier-key-pattern* (key-mask :alt)))))
1629
1630(defun command-key-p nil
1631  (not (zerop (logand *modifier-key-pattern* (key-mask :command)))))
1632
1633(defmacro with-modifier-key-information (parameterless-function)
1634;; NOT TESTED YET!
1635"Wraps the function into a context where control-key-p &c will get their current values.
1636To be used primarily when placing a call to a function in another process."
1637  (let ((gvar (gensym)))
1638    `(let ((,gvar *modifier-key-pattern*))
1639       (function (lambda nil
1640                   (let ((*modifier-key-pattern* ,gvar))
1641                     (funcall ,parameterless-function)))))))
1642
1643(defun view-mouse-position (view)
1644  (let* ((w (cocoa-ref (easygui-window-of view)))
1645         (mouselocation (dcc (#/mouseLocationOutsideOfEventStream w)))
1646         (cview (if (typep view 'window) (content-view view) view))
1647         (nspt (dcc (#/convertPoint:fromView: (cocoa-ref cview) mouselocation NIL))))
1648    ;; todo: check point is inside bounds, lest negative coords
1649    (point (ns:ns-point-x nspt) (ns:ns-point-y nspt))))
Note: See TracBrowser for help on using the repository browser.