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

Last change on this file since 13908 was 13908, checked in by rme, 10 years ago

Avoid calling #_CGWindowLevel when #+cocotron (just use hardwired constant
instead).

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 #+cocotron 0
374                       #-cocotron (dcc (#_CGWindowLevelForKey #$kCGNormalWindowLevelKey)))
375      (hidden :initarg :hidden :reader window-hidden :initform nil)
376      (window-needs-display-on-show :initform t)
377      (optimized :initarg :optimized :initform t) ; Set to NIL if you anticipate overlapping views in this window
378      (style :initarg :window-style :initform #$NSTitledWindowMask))
379  (:default-initargs :specifically 'cocoa-contained-view))
380
381;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
382;;;
383
384(defmethod clear-page ((view view))
385  (let* ((cview (cocoa-ref view))
386         (rect (dcc (#/bounds cview)))
387         (color (slot-value view 'background)))
388    (with-focused-view cview
389      (dcc (#/setFill color))
390      (dcc (#_NSRectFill rect)))))
391
392(defmethod clear-page ((window content-view-mixin))
393  (clear-page (content-view window)))
394
395;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
396;;;
397
398(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)
399  ((mousedown           :initform nil :initarg :mouse-down    :accessor static-text-view-mouse-down)
400   (mouseup             :initform nil :initarg :mouse-up      :accessor static-text-view-mouse-up)
401   (mousedragged        :initform nil :initarg :mouse-dragged :accessor static-text-view-mouse-dragged)))
402
403(defclass text-input-view (view editable-mixin text-coloring-mixin text-fonting-mixin view-text-via-stringvalue-mixin
404                                ;; XXX: requires NSTextView, but this is an
405                                ;; NSTextField:
406                                #+not-yet one-selection-mixin
407                                mouse-tracking-mixin)
408     ((input-locked-p :initform nil :initarg :input-locked-p
409                      :reader text-input-locked-p)))
410
411(defclass password-input-view (text-input-view)
412     ())
413
414;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
415;;;
416
417(defclass push-button-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
418     ((default-button-p :initarg :default-button-p :initform nil
419                        :reader default-button-p)
420      (bezelstyle       :reader bezel-style        :initarg :bezel-style      :initform :rounded)))
421
422;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
423;;;
424
425(defclass form-view (view)
426     ((autosize-cells-p :initarg :autosize-cells-p :initform nil)
427      (interline-spacing :initarg :interline-spacing :initform 9)
428      ;; cell width
429      ))
430
431(defclass form-cell-view (view editable-mixin view-text-via-stringvalue-mixin)
432     ())
433
434;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
435;;;
436
437(defclass box-view (content-view-mixin view-text-via-title-mixin view) ())
438
439;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
440;;;
441
442(defclass drawing-view (view mouse-tracking-mixin)
443     (
444      ;; TODO: make this a mixin
445      (accept-key-events-p :initform nil :initarg :accept-key-events-p
446                           :accessor accept-key-events-p)
447      (flipped             :initform *screen-flipped* :initarg :flipped :reader flipped-p)
448      (mousedown           :initform nil :initarg :mouse-down    :accessor drawing-view-mouse-down)
449      (mouseup             :initform nil :initarg :mouse-up      :accessor drawing-view-mouse-up)
450      (mousedragged        :initform nil :initarg :mouse-dragged :accessor drawing-view-mouse-dragged)
451      (draw-fn             :initform nil :initarg :draw-fn :accessor draw-fn)))
452
453;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
454;;;
455
456(defclass slider-view (view numeric-value-mixin action-view-mixin)
457     ((max-value :initarg :max-value)
458      (min-value :initarg :min-value)
459      (tick-mark-count :initarg :tick-mark-count)
460      (tick-mark-values :initarg :tick-mark-values)
461      (discrete-tick-marks-p :initarg :discrete-tick-marks-p)))
462
463; ----------------------------------------------------------------------
464; Specialisations of ns-xxx classes always begin 'cocoa-'.
465; They allow such things as
466; - finding the easygui window associated with a ns-view & easygui::view
467; - flipped windows, flipped drawing-views
468; - clickable static text, editable text fields
469; - tooltips
470; ----------------------------------------------------------------------
471
472(defun calculate-ns-tooltip (cview)
473  ;; Returns a Lisp string to bhe used as a tooltip, or NIL.
474  ;; Easygu Views may or may not be created with a specific :TIP keyword argument.
475  ;; If there is none, there will be no tooltip displayed for the corresponding cocoa-view.
476  ;; Otherwise, if the argument is
477  ;;   - a string, that string is used
478  ;;   - a function, then if its return value is
479  ;;        - a string, that string is used
480  ;;        - NIL, a string informing that the tooltip is null and cocoa-describing the cocoa-view
481  ;;               (possibly useful for identifying this view if it turns up in errors or inspector)
482  ;;        - else a string naming the type of the result returned (possibly useful for debugging)
483  ;;   - the keyword :IDENTIFY, the cocoa-description of the cocoa-view
484  ;;   - anything else, a string informing what type the argument is.
485  (let* ((egview (when (slot-boundp cview 'easygui-view) (slot-value cview 'easygui-view)))
486         (tip (when egview (slot-value egview 'tip))))
487    (cond
488     ((stringp tip)
489      tip)
490     ((functionp tip)
491      (let ((it (funcall tip)))
492        (cond
493         ((stringp it)  it)
494         ((null it)     (format nil "Null tooltip for ~a" (lisp-string-from-nsstring (dcc (#/description cview)))))
495         (t (format nil "** Tooltip function returned non-string object of type ~s **" (type-of it))))))
496     ((eq tip :identify) (lisp-string-from-nsstring (dcc (#/description cview))))
497     ((null egview) 
498      (format nil "** Cocoa view ~s has no EasyGui-View **" cview))
499     ((null tip) (format nil "No tooltip for ~a" (lisp-string-from-nsstring (dcc (#/description cview)))))
500     (t (format nil "** Tip slot of Cocoa view ~s~%is of type ~s,~%not a string or a function or :IDENTIFY. **" cview tip)))))
501
502(defmacro define-tooltip-accessor (cocoa-class)
503  `(progn
504     (objc:defmethod #/view:stringForToolTip:point:userData:
505                     ((self ,cocoa-class)
506                      view
507                      (tag :<NST>ool<T>ip<T>ag)
508                      (point :<NSP>oint)
509                      (userdata :address))
510       (declare (ignorable tag point userdata))
511       (ccl::%make-nsstring (or (calculate-ns-tooltip view) "")))
512     (objc:defmethod #/toolTip ((view ,cocoa-class))
513       (ccl::%make-nsstring (or (calculate-ns-tooltip view) "")))))
514
515(defclass cocoa-window (ns:ns-window)
516  ((easygui-window :reader easygui-window-of))
517  (:metaclass ns:+ns-object))
518
519(defmethod print-object ((object cocoa-window) stream)
520  (print-unreadable-object (object stream :type t :identity t)
521    (let ((egview (if (slot-boundp object 'easygui-window) (easygui-window-of object) nil)))
522      (format stream "[~:[~;~s~]]" egview (when egview (view-nick-name egview)))))
523  object)
524
525(defmethod easygui-window-of ((eview view))
526  (if (cocoa-ref eview) (easygui-window-of (cocoa-ref eview)) nil))
527
528(defmethod easygui-window-of ((nsview ns:ns-view))
529  (let ((nswindow (dcc (#/window nsview))))
530    (if (typep nswindow 'cocoa-window) (easygui-window-of nswindow) nil)))
531
532(defclass cocoa-extension-mixin ()
533  ((easygui-view :initarg :eg-view :reader easygui-view-of)))
534
535(defmethod print-object ((object cocoa-extension-mixin) stream)
536  (print-unreadable-object (object stream :type t :identity t)
537    (let ((egview (if (slot-boundp object 'easygui-view) (easygui-view-of object) nil)))
538      (format stream "[~:[~;~s~]]" egview (when egview (view-nick-name egview)))))
539  object)
540
541(defclass cocoa-text-field (cocoa-extension-mixin ns:ns-text-field) ()
542  (:metaclass ns:+ns-object))
543
544(define-tooltip-accessor cocoa-text-field)
545
546(defclass cocoa-mouseable-text-field (cocoa-text-field) ()
547  (:metaclass ns:+ns-object))
548
549(define-tooltip-accessor cocoa-mouseable-text-field)
550
551(defclass cocoa-contained-view (cocoa-extension-mixin ns:ns-view)
552  ((flipped :initarg :flipped :initform *screen-flipped*))
553  (:metaclass ns:+ns-object))
554
555(define-tooltip-accessor cocoa-contained-view)
556
557(defclass cocoa-secure-text-field (cocoa-extension-mixin ns:ns-secure-text-field) ()
558  (:metaclass ns:+ns-object))
559
560(define-tooltip-accessor cocoa-secure-text-field)
561
562(defclass cocoa-button (cocoa-extension-mixin ns:ns-button) ()
563  (:metaclass ns:+ns-object))
564
565(define-tooltip-accessor cocoa-button)
566
567(defclass cocoa-pop-up-button (cocoa-extension-mixin ns:ns-pop-up-button) ()
568  (:metaclass ns:+ns-object))
569
570(define-tooltip-accessor cocoa-pop-up-button)
571
572(defclass cocoa-menu-item (cocoa-extension-mixin ns:ns-menu-item) ()
573  (:metaclass ns:+ns-object))
574
575(define-tooltip-accessor cocoa-menu-item)
576
577(defclass cocoa-form (cocoa-extension-mixin ns:ns-form) ()
578  (:metaclass ns:+ns-object))
579
580(define-tooltip-accessor cocoa-form)
581
582(defclass cocoa-form-cell (cocoa-extension-mixin ns:ns-form-cell) ()
583  (:metaclass ns:+ns-object))
584
585(define-tooltip-accessor cocoa-form-cell)
586
587(defclass cocoa-box (cocoa-extension-mixin ns:ns-box) ()
588  (:metaclass ns:+ns-object))
589
590(define-tooltip-accessor cocoa-box)
591
592(defclass cocoa-drawing-view (cocoa-extension-mixin ns:ns-view)
593  ((flipped :initarg :flipped :initform *screen-flipped*))
594  (:metaclass ns:+ns-object))
595
596(define-tooltip-accessor cocoa-drawing-view)
597
598(defclass cocoa-slider (cocoa-extension-mixin ns:ns-slider) ()
599  (:metaclass ns:+ns-object))
600
601(define-tooltip-accessor cocoa-slider)
602
603(defparameter *view-class-to-ns-class-map*
604              '((static-text-view     . cocoa-mouseable-text-field)
605                (password-input-view  . cocoa-secure-text-field)
606                (text-input-view      . cocoa-text-field)
607                (push-button-view     . cocoa-button)
608                (check-box-view       . cocoa-button)
609                (radio-button-view    . cocoa-button)
610                (menu-view            . cocoa-pop-up-button)
611                (menu-item-view       . cocoa-menu-item)
612                (form-view            . cocoa-form)
613                (form-cell-view       . cocoa-form-cell)
614                (box-view             . cocoa-box)
615                (drawing-view         . cocoa-drawing-view)
616                (slider-view          . cocoa-slider)))
617
618;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
619;;; view initialization:
620
621(defmethod shared-initialize :around ((view view) new-slots &rest initargs)
622  (declare (ignore new-slots initargs))
623  (call-next-method)
624  (running-on-main-thread ()
625    (initialize-view view)))
626
627(defmethod initialize-view ((view view))
628  "Initializes the view using the class-to-ns-class map both as constraint
629on valid values of the :SPECIFICALLY initarg, and as source of default value.
630Also attaches contextual menu if there is one."
631  (when (slot-boundp view 'ref)
632    (return-from initialize-view nil))
633  (let ((ns-view-class (cdr (assoc (class-name (class-of view))
634                                   *view-class-to-ns-class-map*
635                                   :test #'subtypep)))
636        (specifically (view-specifically view))
637        cocoaview)
638    (when specifically
639      (cond
640       ((not (find-class specifically nil))
641        (cerror "Ignore ~a and use ~a default" "~a value for :SPECIFICALLY does not name a class" specifically ns-view-class))
642       ((or (null ns-view-class) (subtypep specifically ns-view-class))
643        (setf ns-view-class specifically))
644       (t (cerror "Ignore ~a and use ~a default" "~a value for :SPECIFICALLY is not a subclass of ~a" specifically ns-view-class))))
645    (if ns-view-class
646      (setf cocoaview
647            (cond
648              ((and (slot-boundp view 'position)
649                    (slot-boundp view 'size))
650               (setf (slot-value view 'frame-inited-p) t)
651               (make-instance ns-view-class
652                  :with-frame (with-slots (position size) view
653                                 (ns-rect-from-points position size))))
654              (t (make-instance ns-view-class)))
655            (cocoa-ref view) cocoaview)
656      (cerror "Continue with cocoa-ref unset" "No view class found for type ~a" (class-of view)))
657    (when (and cocoaview (slot-boundp view 'contextmenu))
658      (let ((menu (slot-value view 'contextmenu)))
659        (cond
660         ((null menu))
661         ((null ns-view-class))
662         ((typep menu 'menu-view)
663          (dcc (#/setMenu: cocoaview (slot-value menu 'ns-menu))))
664         (t (warn "Ignoring contextmenu value ~s for view ~s" menu view)))))
665   (when (and cocoaview
666              (slot-value view 'tip)
667              (dcc (#/respondsToSelector: cocoaview (\@selector #/bounds))))
668     (let ((bounds (#/bounds cocoaview)))
669       (setf (slot-value view 'tiptag)
670             (dcc (#/addToolTipRect:owner:userData: cocoaview bounds cocoaview ccl:+null-ptr+)))))))
671
672(defun screen-height nil
673  (running-on-this-thread ()
674    (ns:ns-rect-height (dcc (#/frame (#/objectAtIndex: (#/screens ns:ns-screen) 0))))))
675
676(defmethod view-content-rect ((view view) &optional hidden)
677  (if hidden
678    (ns:make-ns-rect 0 0 0 0)
679    (with-slots (position size) view
680      ;(if (slot-boundp view 'size)
681      ;  (format t "~&View ~s has size ~s~%" view size)
682      ;  (format t "~&View ~s has size unbound~%" view))
683      (let* ((height (if (slot-boundp view 'size) (point-y size) *window-size-default-y*))
684             (stated (if (slot-boundp view 'position) (point-y position) *window-position-default-y*))
685             (screentop (screen-height))  ;; TODO: dtrt for multiple screens
686             (bottom (if (and *screen-flipped* (typep view 'window))
687                       (- screentop height stated)
688                       stated)))
689        (ns:make-ns-rect
690         (if (slot-boundp view 'position) (point-x position) *window-position-default-x*)
691         bottom
692         (if (slot-boundp view 'size) (point-x size) *window-size-default-x*)
693         height)))))
694
695(defmethod initialize-view ((win window))
696  "Initialize size, title, flags."
697  (with-slots (level hidden optimized style flipped specifically) win
698    (unless (and (find-class specifically nil) (subtypep specifically 'cocoa-contained-view))
699      (cerror "Ignore ~a and create content view of type ~a"
700              "Value given for \":specifically\" is ~a which is not a subtype of ~a"
701              specifically 'cocoa-contained-view)
702      (setf specifically 'cocoa-contained-view))
703     (let* ((content-rect (view-content-rect win hidden))
704            (style-mask (logior ;; (flag-mask :zoomable-p (zoomable-p win))
705                         (flag-mask :resizable-p   (window-resizable-p win))
706                         (flag-mask :minimizable-p (window-minimizable-p win))
707                         (flag-mask :closable-p    (window-closable-p win))
708                         (if (or (window-resizable-p win) (window-minimizable-p win) (window-closable-p win))
709                           #$NSTitledWindowMask
710                           0)
711                         style))
712            (c-win
713             (make-instance 'cocoa-window
714               :with-content-rect content-rect
715               :style-mask style-mask
716               :backing #$NSBackingStoreBuffered ; TODO?
717               :defer t))
718            (containee (make-instance specifically)))
719       (setf (slot-value containee 'flipped) flipped)
720       (dcc (#/setFrame: containee content-rect))
721       (dcc (#/setContentView: c-win containee))
722       (dcc (#/setDelegate: c-win c-win))
723       (dcc (#/setBackgroundColor: c-win (slot-value win 'background)))
724       (dcc (#/setLevel: c-win level))
725       (when optimized (dcc (#/useOptimizedDrawing: c-win #$YES)))
726       (setf (cocoa-ref win) c-win)
727       (setf (slot-value c-win 'easygui-window) win)
728       (if hidden
729         (dcc (#/disableFlushWindow c-win))
730         (window-show win))
731       c-win)))
732
733(defmethod initialize-view :after ((view text-input-view))
734  (setf (editable-p view) (not (text-input-locked-p view)))
735  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
736
737(defmethod initialize-view :after ((view static-text-view))
738  (dcc (#/setEditable: (cocoa-ref view) nil))
739  (dcc (#/setBordered: (cocoa-ref view) nil))
740  (dcc (#/setBezeled: (cocoa-ref view) nil))
741  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
742
743(defparameter *bezelstyle-alist*
744  `((:round                    . #.#$NSRoundedBezelStyle)
745    (:square                   . #.#$NSRegularSquareBezelStyle)
746    (:regular-square           . #.#$NSRegularSquareBezelStyle)
747    (:thick-square             . #.#$NSThickSquareBezelStyle)
748    (:thicker-square           . #.#$NSThickerSquareBezelStyle)
749    (:disclosure               . #.#$NSDisclosureBezelStyle)
750    (:Shadowless-square        . #.#$NSShadowlessSquareBezelStyle)
751    (:circular                 . #.#$NSCircularBezelStyle)
752    (:textured-square          . #.#$NSTexturedSquareBezelStyle)
753    (:help-button              . #.#$NSHelpButtonBezelStyle)
754    (:small-square             . #.#$NSSmallSquareBezelStyle)
755    (:textured-rounded         . #.#$NSTexturedRoundedBezelStyle)
756    (:round-rect               . #.#$NSRoundRectBezelStyle)
757    (:recessed                 . #.#$NSRecessedBezelStyle)
758    (:rounded-disclosure       . #.#$NSRoundedDisclosureBezelStyle)))
759
760(defun bezel-style-lookup (key)
761  (rest (or (assoc key *bezelstyle-alist*) (first *bezelstyle-alist*))))
762
763(defmethod (setf bezel-style) (stylename (view push-button-view))
764  (setf (slot-value view 'bezelstyle) (if (assoc stylename *bezelstyle-alist*) stylename :round))
765  (dcc (#/setBezelStyle: (cocoa-ref view) (bezel-style-lookup (slot-value view 'bezelstyle))))
766  stylename)
767
768(defmethod initialize-view :after ((view push-button-view))
769  (dcc (#/setBezelStyle: (cocoa-ref view) (bezel-style-lookup (bezel-style view))))
770  (let ((default-button-p (slot-value view 'default-button-p)))
771    (typecase default-button-p
772      (cons
773       (dcc (#/setKeyEquivalent: (cocoa-ref view) 
774                                 (ccl::%make-nsstring (string (first default-button-p)))))
775       (dcc (#/setKeyEquivalentModifierMask:
776         (cocoa-ref view)
777         (apply #'logior (mapcar #'key-mask (cdr default-button-p))))))
778      (string
779       (dcc (#/setKeyEquivalent: (cocoa-ref view) (ccl::%make-nsstring default-button-p))))
780      (null)
781      (t
782       (dcc (#/setKeyEquivalent: (cocoa-ref view) (ccl::@ #.(string #\return)))))))
783  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
784
785(defmethod initialize-view :after ((view box-view))
786  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
787
788(defmethod initialize-view :after ((view form-view))
789  (when (slot-boundp view 'interline-spacing)
790    (dcc (#/setInterlineSpacing: (cocoa-ref view)
791                             (gui::cgfloat (slot-value view 'interline-spacing)))))
792  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
793
794(defmethod initialize-view :after ((view slider-view))
795  (with-slots (discrete-tick-marks-p tick-mark-count tick-mark-values min-value max-value) view
796     (cond ((and (slot-boundp view 'tick-mark-count)
797                 (slot-boundp view 'discrete-tick-marks-p)
798                 (slot-boundp view 'tick-mark-values)
799                 (/= (length tick-mark-values) tick-mark-count))
800            (error "Incompatible tick mark specification: ~A doesn't match ~
801                     count of ~A" tick-mark-count tick-mark-values))
802           ((or (not (slot-boundp view 'max-value))
803                (not (slot-boundp view 'min-value)))
804            (error "A slider view needs both :min-value and :max-value set.")))
805     (dcc (#/setMinValue: (cocoa-ref view) (float min-value (or 1.0d0 ns:+cgfloat-zero+))))
806     (dcc (#/setMaxValue: (cocoa-ref view) (float max-value (or 1.0d0 ns:+cgfloat-zero+))))
807     (when (slot-boundp view 'tick-mark-count)
808       (dcc (#/setNumberOfTickMarks: (cocoa-ref view) tick-mark-count))
809       (dcc (#/setAllowsTickMarkValuesOnly:
810             (cocoa-ref view) (not (not discrete-tick-marks-p))))))
811  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
812
813(defmethod initialize-view :after ((view text-coloring-mixin))
814  (dcc (#/setTextColor: (cocoa-ref view) (slot-value view 'foreground))))
815
816(defmethod initialize-view :after ((view text-fonting-mixin))
817  (when (slot-value view 'font)
818    (dcc (#/setFont: (cocoa-ref view) (slot-value view 'font)))))
819
820(defmethod (setf view-font) ((new ns:ns-font) (view view))
821  (setf (slot-value view 'font) new)
822  (dcc (#/setFont: (cocoa-ref view) new)))
823
824; ----------------------------------------------------------------------
825; Modifying position / size    of    view / window
826; ----------------------------------------------------------------------
827
828(defmethod (setf view-position) (point (self view))
829  (running-on-main-thread ()
830    (setf (slot-value self 'position) point)
831    (when (slot-value self 'frame-inited-p)
832      (dcc (#/setFrame: (cocoa-ref self) (view-content-rect self)))
833      (dcc (#/setNeedsDisplay (cocoa-ref self))))))
834
835(defmethod (setf view-position) (point (self window))
836  (running-on-main-thread ()
837    (setf (slot-value self 'position) point)
838    (unless (window-hidden self)
839      (let* ((contentrect (view-content-rect self nil))
840             (framerect (dcc (#/frameRectForContentRect: (cocoa-ref self) contentrect))))
841        (dcc (#/setFrame:display: (cocoa-ref self) framerect t))))))
842
843(defmethod (setf view-size) (point (self view))
844  (running-on-main-thread ()
845    (setf (slot-value self 'size) point)
846    (when (slot-value self 'frame-inited-p)
847      (dcc (#/setFrame: (cocoa-ref self) (view-content-rect self)))
848      (dcc (#/setNeedsDisplay (cocoa-ref self))))))
849
850(defmethod (setf view-size) (point (self window))
851  (running-on-main-thread ()
852    (setf (slot-value self 'size) point)
853    (unless (window-hidden self)
854      (let* ((contentrect (view-content-rect self nil))
855             (framerect (dcc (#/frameRectForContentRect: (cocoa-ref self) contentrect))))
856        (dcc (#/setFrame:display: (cocoa-ref self) framerect t))))))
857
858;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
859;;; view hierarchies:
860
861(defmethod set-needs-display ((view view) flag)
862  (running-on-this-thread ()
863    (dcc (#/setNeedsDisplay: (cocoa-ref view) flag))))
864
865(defmethod set-needs-display ((view content-view-mixin) flag)
866  (set-needs-display (content-view view) flag))
867
868(defmethod set-needs-display ((view window) flag)
869  (if (window-hidden view)
870    (setf (slot-value view 'window-needs-display-on-show) flag)
871    (set-needs-display (content-view view) flag)))
872
873(defmethod add-1-subview :around ((view view) (cw-view content-view-mixin))
874  (add-1-subview view (content-view cw-view)))
875
876(defmethod add-1-subview :around ((view view) (super-view view))
877  "Correctly initialize view positions"
878  (call-next-method)
879  (with-slots (position size frame-inited-p) view
880    (unless frame-inited-p
881      (setf frame-inited-p t)
882      (running-on-this-thread ()
883        (let ((cocoa-view (cocoa-ref view)))
884          (dcc (#/setFrameOrigin: cocoa-view (ns-point-from-point position)))
885          (if (slot-boundp view 'size)
886            (dcc (#/setFrameSize: cocoa-view (ns-point-from-point size)))
887            (dcc (#/sizeToFit cocoa-view))))))
888    (set-needs-display view t)
889    (unless (view-subviews-busy super-view) (set-needs-display super-view t))))
890
891(defmethod add-1-subview ((view view) (super-view view))
892  (running-on-this-thread ()
893    (setf (slot-value view 'parent) super-view)
894    (push view (slot-value super-view 'subviews))
895    (dcc (#/addSubview: (cocoa-ref super-view) (cocoa-ref view)))))
896
897(defun add-subviews (superview subview &rest subviews)
898  (setf (view-subviews-busy superview) t)
899  (add-1-subview subview superview)
900  (dolist (subview subviews)
901    (add-1-subview subview superview))
902  (set-needs-display superview t)
903  (setf (view-subviews-busy superview) nil)
904  superview)
905
906(defmethod remove-1-subview ((view view) (cw-view content-view-mixin))
907  (remove-1-subview view (content-view cw-view)))
908
909(defmethod remove-1-subview ((view view) (super-view view))
910  (assert (eql (cocoa-ref super-view) (dcc (#/superview (cocoa-ref view)))))
911  (assert (member view (view-subviews super-view)))
912  (assert (eq super-view (slot-value view 'parent)))
913  (maybe-invalidating-object (view)
914    (setf (slot-value super-view 'subviews) (delete view (slot-value super-view 'subviews)))
915    (setf (slot-value view 'parent) nil)
916    (running-on-this-thread ()
917      (dcc (#/removeFromSuperview (cocoa-ref view))))))
918
919(defun remove-subviews (superview subview &rest subviews)
920  (setf (view-subviews-busy superview) t)
921  (remove-1-subview subview superview)
922  (dolist (subview subviews)
923    (remove-1-subview subview superview))
924  (set-needs-display superview t)
925  (setf (view-subviews-busy superview) nil)
926  superview)
927
928(defmethod window-show ((window window))
929  (running-on-this-thread ()
930    (let ((cwin (cocoa-ref window)))
931      (when (window-hidden window)
932        (setf (slot-value window 'hidden) nil)
933        (let* ((contentrect (view-content-rect window nil))
934               (framerect (dcc (#/frameRectForContentRect: (cocoa-ref window) contentrect))))
935          (dcc (#/setFrame:display: (cocoa-ref window) framerect nil)))
936        (when (dcc (#/isMiniaturized cwin)) (dcc (#/deminiaturize: cwin cwin)))
937        (when (slot-value window 'window-needs-display-on-show)
938          (setf (slot-value window 'window-needs-display-on-show) nil)
939          (dcc (#/setNeedsDisplay: (cocoa-ref (content-view window)) t))))
940      (dcc (#/makeKeyAndOrderFront: cwin nil))
941      (when (dcc (#/isFlushWindowDisabled cwin))
942        (dcc (#/enableFlushWindow cwin))
943        (dcc (#/flushWindow cwin)))
944      window)))
945
946
947;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
948;;; Forms:
949
950(defmethod add-entry (entry (view form-view))
951  (make-instance 'form-cell-view
952     :cocoa-ref (dcc (#/addEntry: (cocoa-ref view) (ccl::%make-nsstring entry)))))
953
954(defun add-entries (view &rest entries)
955  (prog1 (mapcar (lambda (entry) (add-entry entry view)) entries)
956         (dcc (#/setAutosizesCells: (cocoa-ref view)
957                                    (slot-value view 'autosize-cells-p)))))
958
959(defmethod cell-count ((view form-view))
960  (dcc (#/numberOfRows (cocoa-ref view))))
961
962(defmethod nth-cell (index view)
963  (assert (< index (cell-count view)))
964  (let ((cocoa-cell (dcc (#/cellAtIndex: (cocoa-ref view) index))))
965    (when cocoa-cell
966      (make-instance 'form-cell-view :cocoa-ref cocoa-cell))))
967
968(defmethod (setf entry-text) (text view index)
969  (setf (view-text (nth-cell index view)) text))
970
971(defmethod entry-text (view index)
972  (view-text (nth-cell index view)))
973
974;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
975;;; Window closing
976         
977(defmethod window-may-close ((w window))
978"This generic is intended to allow applications to define :BEFORE and/or :AFTER methods
979invoked when windows are closed. The default primary method returns T to indicate that
980the window may close. If an overriding primary method returns NIL, the window will not
981close in response to user action but will still close if the application quits.
982(This is because window-may-close is called when the COCOA-WINDOW (specialised NS:NS-WINDOW)
983that is attached to an EASYGUI::WINDOW object receives a performClose: message, as when
984a user clicks the close button for example.)"
985  (declare (ignore w))
986  t)
987
988(defmethod perform-close ((w window))
989"This generic is intended to allow applications to mimic the user clicking a window's
990close button."
991  (running-on-this-thread ()
992    (dcc (#/performClose: (cocoa-ref w)  ccl:+null-ptr+))))
993
994(objc:define-objc-method ((:<BOOL> :window-should-close (:id sender)) cocoa-window)
995  (declare (ignore sender))  ; The cocoa-window has been set up as its own delegate. Naughty?
996  (if (window-may-close (easygui-window-of self)) #$YES #$NO))
997
998;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
999;;; Drawing:
1000
1001(defmethod clear-page ((cocoa-view cocoa-drawing-view))
1002  (let* ((view (easygui-view-of cocoa-view))
1003         (rect (dcc (#/bounds cocoa-view)))
1004         (color (slot-value view 'background)))
1005    (with-focused-view cocoa-view
1006      (dcc (#/setFill color))
1007      (dcc (#_NSRectFill rect)))))
1008         
1009(objc::defmethod (#/isFlipped :<BOOL>) ((self cocoa-drawing-view))
1010  (if (slot-value self 'flipped) #$YES #$NO))
1011
1012(objc::defmethod (#/isFlipped :<BOOL>) ((self cocoa-contained-view))
1013  (if (slot-value self 'flipped) #$YES #$NO))
1014
1015(defmethod initialize-view :after ((view drawing-view))
1016  (setf (slot-value (cocoa-ref view) 'flipped) (slot-value view 'flipped))
1017  (setf (slot-value (cocoa-ref view) 'easygui-view) view))
1018
1019(objc:defmethod (#/drawRect: :void) ((self cocoa-drawing-view)
1020                                     (rect :<NSR>ect))
1021  (dcc (draw-view-rectangle (easygui-view-of self) (nsrect-rectangle rect))))
1022
1023(objc:defmethod (#/acceptsFirstReponder: :boolean) ((view cocoa-drawing-view))
1024  (accept-key-events-p (easygui-view-of view)))
1025
1026(defgeneric draw-view-rectangle (view rectangle)
1027  (:method ((view drawing-view) rectangle)
1028    (declare (ignorable view rectangle))
1029    (when (draw-fn view)
1030      (let ((cview (cocoa-ref view)))
1031        (with-focused-view cview (funcall (draw-fn view) view cview))))
1032    nil))
1033
1034(defmethod redisplay ((view drawing-view)
1035                      &key rect)
1036  (setf rect (if rect
1037                 (rectangle-nsrect rect)
1038                 (dcc (#/bounds (cocoa-ref view)))))
1039  (dcc (#/setNeedsDisplayInRect: (cocoa-ref view) rect)))
1040
1041(define-useful-mouse-event-handling-routines cocoa-drawing-view)
1042(define-useful-mouse-event-handling-routines cocoa-mouseable-text-field)
1043
1044;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1045;; Around methods for VIEW provide bindings for *modifier-key-pattern* for all kinds of views,
1046;; allowing for Shift-Key-P and friends.
1047;; Primary methods do nothing, but may be overridden by user code.
1048
1049;(defmethod mouse-down :around ((view view) &key cocoa-event location button click-count delta)
1050;  (declare (ignorable cocoa-event location button click-count delta))
1051;  (let ((*cocoa-event* cocoa-event)
1052;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1053;    (call-next-method)))
1054 
1055(defmethod mouse-down ((view view) &key cocoa-event location button click-count delta)
1056  (declare (ignorable view cocoa-event location button click-count delta))
1057  nil)
1058 
1059;(defmethod mouse-up :around ((view view) &key cocoa-event location button click-count delta)
1060;  (declare (ignorable cocoa-event location button click-count delta))
1061;  (let ((*cocoa-event* cocoa-event)
1062;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1063;    (call-next-method)))
1064 
1065(defmethod mouse-up ((view view) &key cocoa-event location button click-count delta)
1066  (declare (ignorable view cocoa-event location button click-count delta))
1067  nil)
1068
1069;(defmethod mouse-dragged :around ((view view) &key cocoa-event location button click-count delta)
1070;  (declare (ignorable cocoa-event location button click-count delta))
1071;  (let ((*cocoa-event* cocoa-event)
1072;        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1073;    (call-next-method)))
1074 
1075(defmethod mouse-dragged ((view view) &key cocoa-event location button click-count delta)
1076  (declare (ignorable view cocoa-event location button click-count delta))
1077  nil)
1078 
1079;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1080;; Primary methods for DRAWING-VIEW. What now is the point?
1081
1082(defmethod mouse-down ((view drawing-view) &key cocoa-event location button click-count delta)
1083  (let ((mousefn (drawing-view-mouse-down view))
1084        (*cocoa-event* cocoa-event)
1085        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1086    (when mousefn
1087      (funcall mousefn view
1088               :location location
1089               :allow-other-keys t
1090               :button button
1091               :cocoa-event cocoa-event
1092               :click-count click-count
1093               :delta delta))))
1094
1095(defmethod mouse-up ((view drawing-view) &key cocoa-event location button click-count delta)
1096  (let ((mousefn (drawing-view-mouse-up view))
1097        (*cocoa-event* cocoa-event)
1098        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1099    (when mousefn
1100      (funcall mousefn view
1101               :location location
1102               :allow-other-keys t
1103               :button button
1104               :cocoa-event cocoa-event
1105               :click-count click-count
1106               :delta delta))))
1107
1108(defmethod mouse-dragged ((view drawing-view) &key cocoa-event location button click-count delta)
1109  (let ((mousefn (drawing-view-mouse-dragged view))
1110        (*cocoa-event* cocoa-event)
1111        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1112    (when mousefn
1113      (funcall mousefn view
1114               :location location
1115               :allow-other-keys t
1116               :button button
1117               :cocoa-event cocoa-event
1118               :click-count click-count
1119               :delta delta))))
1120
1121;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
1122;; Primary methods for STATIC-TEXT-VIEW. What now is the point?
1123
1124(defmethod mouse-down ((view static-text-view) &key cocoa-event location button click-count delta)
1125  (let ((mousefn (static-text-view-mouse-down view))
1126        (*cocoa-event* cocoa-event)
1127        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1128    (when mousefn
1129      (funcall mousefn view
1130               :location location
1131               :allow-other-keys t
1132               :button button
1133               :cocoa-event cocoa-event
1134               :click-count click-count
1135               :delta delta))))
1136
1137(defmethod mouse-up ((view static-text-view) &key cocoa-event location button click-count delta)
1138  (let ((mousefn (static-text-view-mouse-up view))
1139        (*cocoa-event* cocoa-event)
1140        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1141    (when mousefn
1142      (funcall mousefn view
1143               :location location
1144               :allow-other-keys t
1145               :button button
1146               :cocoa-event cocoa-event
1147               :click-count click-count
1148               :delta delta))))
1149
1150(defmethod mouse-dragged ((view static-text-view) &key cocoa-event location button click-count delta)
1151  (let ((mousefn (static-text-view-mouse-dragged view))
1152        (*cocoa-event* cocoa-event)
1153        (*modifier-key-pattern* (dcc (#/modifierFlags cocoa-event))))
1154    (when mousefn
1155      (funcall mousefn view
1156               :location location
1157               :allow-other-keys t
1158               :button button
1159               :cocoa-event cocoa-event
1160               :click-count click-count
1161               :delta delta))))
1162
1163; -------------------
1164(defmethod view-named (name (view view))
1165  (find name (view-subviews view) :key #'view-nick-name))
1166
1167(defmethod view-named (name (container content-view-mixin))
1168  (view-named name (content-view container)))
1169
1170(defmethod view-subviews ((w content-view-mixin))
1171  (view-subviews (content-view w)))
1172
1173; ----------------------
1174
1175(defmethod view-nickname-chain ((view view) &optional include-everything) "
1176Yields two values:
1177- a list of nicknames of containing views, starting with outermost container
1178- the view or window that contains the view with the first name in the list,
1179  or NIL if the first name belongs to a window.
1180If include-everything is NIL (the default), the list does not contain the
1181autogenerated name for content views of windows or boxes, and contains names
1182of views or windows that have non-NIL names. The second value may then be
1183a view or window that has no nickname of its own.
1184If include-everything is T, the list does contain the autogenerated name of
1185content views of windows or boxes, it does contain NIL for views named NIL,
1186and the second value will always be NIL."
1187  (do (chain
1188       nickname
1189       (outermost view (view-container outermost)))
1190      ((or (null outermost)
1191           (and (null (setf nickname (view-nick-name outermost)))
1192                (not include-everything)))               
1193       (values chain outermost))
1194    (when (or include-everything (not (eq nickname '%CONTENT-OF-CONTENT-VIEW%)))
1195      (push (view-nick-name outermost) chain))))
1196
1197; ----------------------
1198
1199(defclass check-box-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1200  ((checked :initarg :checked :initform nil)))
1201
1202(defmethod check-box-check ((self check-box-view) &optional perform)
1203  (running-on-this-thread ()
1204    (unless (eql (dcc (#/state (cocoa-ref self))) #$NSOnState)
1205      (if perform
1206        (dcc (#/performClick: (cocoa-ref self) nil))
1207        (dcc (#/setState: (cocoa-ref self) #$NSOnState)))
1208      t)))
1209
1210(defmethod initialize-view :after ((view check-box-view))
1211  (when (cocoa-ref view)
1212    (dcc (#/setButtonType: (cocoa-ref view) #$NSSwitchButton))
1213    (when (slot-value view 'checked) (check-box-check view))
1214    (setf (slot-value (cocoa-ref view) 'easygui-view) view)))
1215
1216(defmethod check-box-uncheck ((self check-box-view) &optional perform)
1217  (running-on-this-thread ()
1218    (unless (eql (dcc (#/state (cocoa-ref self))) #$NSOffState)
1219      (if perform
1220        (dcc (#/performClick: (cocoa-ref self) nil))
1221        (dcc (#/setState: (cocoa-ref self) #$NSOffState)))
1222      t)))
1223
1224(defmethod check-box-checked-p ((self check-box-view))
1225  (eql (dcc (#/state (cocoa-ref self))) #$NSOnState))
1226
1227(defmethod (setf check-box-checked-p) (new (self check-box-view))
1228  (if new
1229    (check-box-check self)
1230    (check-box-uncheck self))
1231  new)
1232
1233; -------------------------
1234(defclass radio-button-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1235  ((selected :initarg :selected :reader radio-button-selected-p :initform nil)
1236   (cluster  :initarg :cluster  :initform '#:default-cluster))
1237  (:default-initargs :action #'(lambda () nil)))
1238
1239(defun deselect-radio-button-cohorts (radio-button-view)
1240  (when (view-container radio-button-view)
1241    (dolist (sibling (view-subviews (view-container radio-button-view)))
1242      (when (and (not (eq sibling radio-button-view))
1243                 (typep sibling 'radio-button-view)
1244                 (eq (slot-value radio-button-view 'cluster) (slot-value sibling 'cluster))
1245                 (eql (dcc (#/state (cocoa-ref sibling))) #$NSOnState))
1246        (setf (slot-value sibling 'selected) nil)
1247        (dcc (#/setState: (cocoa-ref sibling) #$NSOffState))))))
1248 
1249(defmethod radio-button-select ((self radio-button-view) &optional perform)
1250  (running-on-this-thread ()
1251    (if perform
1252      (dcc (#/performClick: (cocoa-ref self) nil))
1253      (progn
1254        (deselect-radio-button-cohorts self)
1255        (setf (slot-value self 'selected) t)
1256        (dcc (#/setState: (cocoa-ref self) #$NSOnState))))))
1257
1258(defmethod initialize-view :after ((self radio-button-view))
1259  (when (cocoa-ref self)
1260    (dcc (#/setButtonType: (cocoa-ref self) #$NSRadioButton))
1261    (when (slot-value self 'selected) (radio-button-select self))
1262    (setf (slot-value (cocoa-ref self) 'easygui-view) self)))
1263
1264(defmethod radio-button-deselect ((self radio-button-view))
1265  (running-on-this-thread ()
1266    (dcc (#/setState: (cocoa-ref self) #$NSOffState))
1267    (prog1
1268      (radio-button-selected-p self)
1269      (setf (slot-value self 'selected) nil))))
1270
1271(defmethod (setf action) (handler (view radio-button-view))
1272  (call-next-method
1273   (lambda ()
1274     (deselect-radio-button-cohorts view)
1275     (setf (slot-value view 'selected) t)
1276     (funcall handler))
1277   view)
1278  handler)
1279
1280; ----------------------------------------------------------------------
1281; INVALIDATE-VIEW
1282; ----------------------------------------------------------------------
1283
1284(defmethod invalidate-view ((view view) &optional total)
1285  (declare (ignorable total))
1286  (let ((cview (cocoa-ref view)))
1287    (dcc (#/setNeedsDisplay: cview #$YES))))
1288
1289(defmethod invalidate-view ((window window) &optional total)
1290  (declare (ignorable total))
1291  (let* ((cocoaview (cocoa-ref window))
1292         (contentview (dcc (#/contentView cocoaview))))
1293    (dcc (#/setNeedsDisplay: contentview #$YES))))
1294
1295; ----------------------------------------------------------------------
1296; Methods to    GET- & SET-    FORE- & BACK-    COLOR
1297; ----------------------------------------------------------------------
1298
1299(defmethod set-fore-color ((view view) (color ns:ns-color))
1300  (setf (slot-value view 'foreground) color))
1301
1302(defmethod set-fore-color :before ((view view-text-via-stringvalue-mixin) (color ns:ns-color))
1303  (dcc (#/setTextColor: (cocoa-ref view) color)))
1304
1305(defmethod set-fore-color ((view cocoa-extension-mixin) (color ns:ns-color))
1306  (set-fore-color (easygui-view-of view) color))
1307
1308(defmethod set-back-color ((view view) (color ns:ns-color) &optional redisplay-p)
1309  (setf (slot-value view 'background) color)
1310  (when redisplay-p (invalidate-view view)))
1311
1312(defmethod set-back-color :after ((view static-text-view) (color ns:ns-color) &optional redisplay-p)
1313  (dcc (#/setBackgroundColor: (cocoa-ref view) color))
1314  (when redisplay-p (invalidate-view view)))
1315
1316(defmethod set-back-color ((view cocoa-extension-mixin) (color ns:ns-color) &optional redisplay-p)
1317  (set-back-color (easygui-view-of view) color redisplay-p))
1318
1319(defmethod get-fore-color ((view view))
1320  (slot-value view 'foreground))
1321
1322(defmethod get-fore-color ((view cocoa-extension-mixin))
1323  (get-fore-color (easygui-view-of view)))
1324
1325(defmethod get-back-color ((view view))
1326  (slot-value view 'background))
1327
1328(defmethod get-back-color ((view cocoa-extension-mixin))
1329  (get-back-color (easygui-view-of view)))
1330
1331; --------------------- Menus Begin ---------------------
1332
1333(defmethod view-text ((self ns:ns-menu))
1334  (lisp-string-from-nsstring (dcc (#/title self))))
1335
1336(defmethod (setf view-text) (new (self ns:ns-menu))
1337  (running-on-this-thread ()
1338    (dcc (#/setTitle: self (ccl::%make-nsstring new)))
1339    new))
1340
1341(defclass menu-view (view view-text-via-title-mixin decline-menu-mixin)
1342  ((selection   :initarg :selection   :reader menu-selection :initform nil)
1343   (menu-kind   :initarg :menu-kind   :reader menu-kind      :initform :pull-down-menu)
1344   (menu-items  :initarg :menu-items  :reader menu-items     :initform nil)
1345   ns-menu
1346   %result))
1347
1348(defclass menu-item-view (view view-text-via-title-mixin action-view-mixin decline-menu-mixin)
1349  (parent-menu
1350   action
1351   submenu)
1352  (:default-initargs :action #'(lambda () nil)))
1353
1354;(defmethod (setf view-text) :after (new (menu menu-view))
1355;  (declare (ignorable new))
1356;  (dcc (#/setNeedsDisplay: (cocoa-ref menu) t)))
1357
1358(defmethod initialize-instance :after ((self menu-view) &rest args &key menu-items selection)
1359  (declare (ignorable args selection))
1360  (let ((ns-menu nil))
1361    (if (slot-boundp self 'ns-menu)
1362      (setf ns-menu (slot-value self 'ns-menu))
1363      (setf ns-menu (dcc (#/menu (cocoa-ref self)))
1364            (slot-value self 'ns-menu) ns-menu))
1365    ;(format t "~&Initializing menu ~a with ~a items~%" self (length menu-items))
1366    (dolist (item menu-items)
1367      ;(format t "~&Adding ~a to menu ~a~%" item self)
1368      (cond
1369       ((typep item 'menu-view)
1370        (let ((intermediary (make-instance 'menu-item-view
1371                              :title (view-text item))))
1372          (setf (slot-value intermediary 'submenu) item)
1373          (dcc (#/setSubmenu: (cocoa-ref intermediary) (slot-value item 'ns-menu)))
1374          (dcc (#/addItem: ns-menu (cocoa-ref intermediary)))))
1375       ((not (typep item 'menu-item-view))
1376        (warn "Ignoring so-called menu item ~s" item))
1377       ((slot-boundp item 'parent-menu)
1378        (warn "Ignoring menu item ~s, which is already an item in some menu" item))
1379       (t (let ((coco (cocoa-ref item)))
1380            (dcc (#/addItem: ns-menu coco))
1381            (setf (slot-value item 'parent-menu) self)))))))
1382
1383(defmethod (setf action) (new (menu-item menu-item-view))
1384  (call-next-method
1385   #'(lambda ()
1386       (if (slot-boundp menu-item 'parent-menu)
1387         (let ((parent (slot-value menu-item 'parent-menu)))
1388           (setf (slot-value parent 'selection) menu-item)
1389           (setf (slot-value parent '%result) (funcall new)))
1390         (funcall new)))
1391   menu-item)
1392  new)
1393
1394(defmethod set-menu-item-title ((menu-item menu-item-view) title)
1395  (running-on-this-thread ()
1396    (dcc (#/setTitle: (cocoa-ref menu-item) (ccl::%make-nsstring title)))))
1397
1398(defmethod set-menu-item-title ((menu-item ns:ns-menu-item) title)
1399  (running-on-this-thread ()
1400    (dcc (#/setTitle: menu-item (ccl::%make-nsstring title)))))
1401
1402; -------------------
1403(defclass pop-up-menu (menu-view)
1404  ()
1405  (:default-initargs :menu-kind :pop-up-menu))
1406
1407(defmethod initialize-instance :after ((self pop-up-menu) &rest args &key selection)
1408  (declare (ignorable args))
1409  (with-slots (ns-menu menu-items) self
1410    (setf (view-text self)
1411          (cond
1412           ((null menu-items)
1413            "<No Items>")
1414           ((null selection)
1415            (setf (slot-value self 'selection) (first menu-items))
1416            (view-text (first menu-items)))
1417           ((stringp selection)
1418            selection)
1419           ((member selection menu-items)
1420            (setf (slot-value self 'selection) selection)
1421            (view-text selection))
1422           (t "<Selection Invalid>"))))
1423  (setf (slot-value (cocoa-ref self) 'easygui-view) self))
1424
1425; ----------------------
1426(defclass pull-down-menu (menu-view)
1427  ()
1428  (:default-initargs :menu-kind :pull-down-menu))
1429
1430(defmethod initialize-instance :after ((self pull-down-menu) &rest args &key title)
1431  (declare (ignorable args))
1432  (running-on-this-thread ()
1433    (dcc (#/insertItemWithTitle:atIndex: (cocoa-ref self) (ccl::%make-nsstring (or title "<No Title>")) 0))))
1434
1435(defmethod initialize-view :after ((self pull-down-menu))
1436  (running-on-this-thread ()
1437    (when (cocoa-ref self)
1438      (dcc (#/setPullsDown: (cocoa-ref self) #$YES))
1439      (setf (slot-value (cocoa-ref self) 'easygui-view) self))))
1440
1441; -----------------------
1442(defclass contextual-menu (menu-view)
1443  ()
1444  (:default-initargs :menu-kind :contextual-menu))
1445
1446(defgeneric add-contextual-menu (container menu &optional subviews))
1447
1448(defmethod add-contextual-menu ((window window) (menu menu-view) &optional subviews)
1449  (add-contextual-menu (content-view window) menu subviews))
1450
1451(defmethod add-contextual-menu ((view view) (menu menu-view) &optional subviews)
1452  (running-on-this-thread ()
1453    (dcc (#/setMenu: (cocoa-ref view) (slot-value menu 'ns-menu)))
1454    (when subviews
1455      (dolist (sub (view-subviews view))
1456        (unless (or (not (cocoa-null (dcc (#/menu (cocoa-ref sub)))))
1457                    (typep sub 'decline-menu-mixin))
1458          (add-contextual-menu sub menu subviews))))))
1459
1460(defmethod add-contextual-menu ((view menu-view) (refusenik decline-menu-mixin) &optional subviews)
1461  (declare (ignore subviews))
1462  (error "Cannot add a contextual menu to a view of class ~s" (type-of refusenik)))
1463
1464; -------------------------
1465(defun application-object nil
1466  (dcc (#/sharedApplication ns:ns-application)))
1467
1468(defun application-main-menu nil
1469  (dcc (#/mainMenu (application-object))))
1470
1471(defgeneric navigate-menu (titles menu))
1472
1473(defmethod navigate-menu ((titles list) (menu menu-view))
1474;; Returns NIL if the path of titles leads nowhere, when no appropriately titled menu-item or submenu exists;
1475;; Returns a EasyGui MENU-ITEM if the path of titles leads to a leaf item;
1476;; Returns a EasyGui MENU-VIEW if the path of titles leads to a submenu.
1477  (cond
1478   ((null titles) menu)
1479   (t (let ((it (find (first titles) (menu-items menu) :test #'equalp :key #'view-text)))
1480        (when it (navigate-menu (rest titles) it))))))
1481
1482(defun navigate-native-menu (titles menu)
1483;; Returns a NIL or a NS:NS-MENU-ITEM or a NS:NS-MENU
1484;; Returns a NS:NS-MENU when the title path leads to a submenu,
1485;; Returns a NS;NS-MENU-ITEM when the title path leads to a leaf menu item,
1486;; Returns NIL when the title path leads nowhere.
1487  (running-on-this-thread ()
1488    (if (null titles)
1489      menu
1490      (do ((number (dcc (#/numberOfItems menu)))
1491           (index 0 (1+ index))
1492           item found)
1493          ((or found (>= index number))
1494           (cond
1495            ((or (null found) (null (rest titles))) found)
1496            ((null (dcc (#/hasSubmenu found))) nil)
1497            (t (navigate-native-menu (rest titles) (dcc (#/submenu found))))))
1498        (setf item (dcc (#/itemAtIndex: menu index)))
1499        (if (or (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title item))))
1500                ; The Apple menu item has title "" but its submenu has title "Apple", hence ...
1501                (and (dcc (#/hasSubmenu item))
1502                     (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title (dcc (#/submenu item))))))))
1503          (setf found item))))))
1504
1505(defmethod navigate-topbar ((titles list))
1506  (navigate-native-menu titles (application-main-menu)))
1507
1508(defun add-menu-item (menu titles &optional action)
1509;; Adds a chain of submenus and a final leaf item with the indicated action.
1510;; If the final leaf item already exists, its action will be changed. Perhaps this is too dangerous.
1511;; The Apple submenu may not be altered; the application's submenu cannot be found.
1512  (cond
1513   ((null titles)
1514    (cerror "Return NIL" "No title path supplied"))
1515   ((not (and (consp titles) (stringp (first titles))))
1516    (cerror "Return NIL, some empty submenus may have been created" "Title path is not a list of strings"))
1517   ((not (typep menu 'ns:ns-menu))
1518    (cerror "Return NIL" "Not a Cocoa menu: ~s" menu))
1519   (t (let* ((ns-title (ccl::%make-nsstring (first titles)))
1520             (item (dcc (#/itemWithTitle: menu ns-title)))
1521             (ns-nullstring (ccl::%make-nsstring "")))
1522        (flet ((linkup (leaf action) ;; Modelled on code in easygui/action-targets.lisp
1523                 (let ((target (make-instance 'generic-easygui-target :handler (or action #'(lambda () nil)) :shooter leaf)))
1524                   (dcc (#/setTarget: leaf target))
1525                   (dcc (#/setAction: leaf (\@selector #/activateAction))))))
1526          (cond
1527           ((equalp (first titles) "-")
1528            (if (rest titles)
1529              (cerror "Leave menu unchanged" "A menu separator (an item having title \"-\") may not have a submenu")
1530              (dcc (#/addItem: menu (dcc (#/separatorItem ns:ns-menu-item))))))
1531           ((cocoa-null item) ;; No such item, something must be added
1532            (if (rest titles)
1533              (let ((number (dcc (#/numberOfItems menu)))
1534                    (submenu (make-instance 'ns:ns-menu)))
1535                (running-on-this-thread ()
1536                  (dcc (#/addItemWithTitle:action:keyEquivalent: menu ns-title ccl:+null-ptr+ ns-nullstring))
1537                  (setf item (dcc (#/itemAtIndex: menu number))) ;; That's where it got put
1538                  (dcc (#/initWithTitle: submenu ns-title))
1539                  (dcc (#/setSubmenu: item submenu)))
1540                (add-menu-item submenu (rest titles) action))
1541              (let ((number (dcc (#/numberOfItems menu))))
1542                (running-on-this-thread ()
1543                  (dcc (#/addItemWithTitle:action:keyEquivalent: menu ns-title ccl:+null-ptr+ ns-nullstring))
1544                  (setf item (dcc (#/itemAtIndex: menu number))))
1545                (linkup item action))))
1546           ((and (null (rest titles)) (dcc (#/hasSubmenu item)))
1547            (cerror "Leave menu unchanged" "An Action may not be added to any item with a submenu"))
1548           ((and (rest titles) (dcc (#/hasSubmenu item)))
1549            (add-menu-item (dcc (#/submenu item)) (rest titles) action))
1550           ((rest titles)
1551            (cerror "Leave menu unchanged" "An existing menu item cannot be converted to have a submenu"))
1552           (t (linkup item action)))))))) ;; Change the action of an existing item: desirable, or dangerous?           
1553
1554(defun add-topbar-item (titles &optional action)
1555  (if (and (consp titles) (rest titles))
1556    (add-menu-item (application-main-menu) titles action)
1557    (cerror "Return NIL" "Title path must be a list with at least two elements: ~s" titles)))
1558
1559(defun remove-menu-item (menu titles retain-if-empty)
1560  (if (not (and (consp titles) (stringp (first titles))))
1561    (cerror "Return NIL" "Title path is not a list of strings")
1562    (do ((number (dcc (#/numberOfItems menu)))
1563         (index 0 (1+ index))
1564         item found)
1565        ((or found (>= index number))
1566         (when found
1567           (if (rest titles)
1568             (when (dcc (#/hasSubmenu found))
1569               (remove-menu-item (dcc (#/submenu found)) (rest titles) retain-if-empty)
1570               (unless (or retain-if-empty (> (dcc (#/numberOfItems (dcc (#/submenu found)))) 0))
1571                 (dcc (#/removeItem: menu found))))
1572             (dcc (#/removeItem: menu found)))))
1573      (setf item (dcc (#/itemAtIndex: menu index)))
1574      (when (equalp (first titles) (lisp-string-from-nsstring (dcc (#/title item))))
1575        (setf found item)))))
1576
1577(defun remove-topbar-item (titles &key retain-if-empty)
1578  (when (and (consp titles)
1579             (not (member (first titles) '("" "Apple") :test #'equalp)))
1580    (remove-menu-item (application-main-menu) titles retain-if-empty)))
1581
1582(defun add-application-submenu (title &rest trees) "
1583Adds a menu to the topbar application-menu with the given title.
1584Its menu-items names are got from the CARs of the trees.
1585The CDRs of these trees may consist either of further trees, allowing arbitrarily
1586deep menu structures, or of a one-element list that is expected to be a parameterless
1587function to be used as the Action of a leaf menu item.
1588Example:
1589  (add-application-submenu \"Beeps\"
1590     '(\"Normal\" #'normal-beep)
1591     '(\"Stupid\" #'stupid-beep)
1592     '(\"Choose\" (\"Custom beep 1\" #'custom-beep-1-not-implemented)
1593                (\"Custom beep 2\" #'custom-beep-2-not-implemented)))
1594"
1595  (labels ((valid-tree (tree)
1596             (and (consp tree) (stringp (first tree))))
1597           (prepending (seq tree)
1598             (cond
1599              ((every #'valid-tree (rest tree))
1600               (dolist (subtree (rest tree))
1601                 (prepending (append seq (list (first subtree))) (rest subtree))))
1602              ((and (consp tree) (stringp (first tree)) (consp (rest tree)) (null (cddr tree)))
1603               (add-topbar-item (append seq (list (first tree))) (second tree)))
1604              (t (cerror "Ignore this tree" "Malformed tree ~s" tree)))))
1605    (if (every #'valid-tree trees)
1606      (dolist (subtree trees) (prepending (list title) subtree))
1607      (cerror "Return NIL" "Malformed top-level trees"))))
1608
1609; ---------------
1610; Keyboard input handling
1611
1612(defmethod view-key-event-handler ((view window) char)
1613  (declare (ignorable char))
1614  nil)
1615
1616(objc:define-objc-method ((:void :key-down (:id event)) cocoa-window)
1617  (let ((*cocoa-event* event)
1618        (*modifier-key-pattern* (#/modifierFlags event)))
1619    (view-key-event-handler
1620     (easygui-window-of self)
1621     (schar (lisp-string-from-nsstring (dcc (#/charactersIgnoringModifiers event))) 0))))
1622
1623(defun shift-key-p nil
1624  (not (zerop (logand *modifier-key-pattern* (key-mask :shift)))))
1625
1626(defun control-key-p nil
1627  (not (zerop (logand *modifier-key-pattern* (key-mask :control)))))
1628
1629(defun alt-key-p nil
1630  (not (zerop (logand *modifier-key-pattern* (key-mask :alt)))))
1631
1632(defun command-key-p nil
1633  (not (zerop (logand *modifier-key-pattern* (key-mask :command)))))
1634
1635(defmacro with-modifier-key-information (parameterless-function)
1636;; NOT TESTED YET!
1637"Wraps the function into a context where control-key-p &c will get their current values.
1638To be used primarily when placing a call to a function in another process."
1639  (let ((gvar (gensym)))
1640    `(let ((,gvar *modifier-key-pattern*))
1641       (function (lambda nil
1642                   (let ((*modifier-key-pattern* ,gvar))
1643                     (funcall ,parameterless-function)))))))
1644
1645(defun view-mouse-position (view)
1646  (let* ((w (cocoa-ref (easygui-window-of view)))
1647         (mouselocation (dcc (#/mouseLocationOutsideOfEventStream w)))
1648         (cview (if (typep view 'window) (content-view view) view))
1649         (nspt (dcc (#/convertPoint:fromView: (cocoa-ref cview) mouselocation NIL))))
1650    ;; todo: check point is inside bounds, lest negative coords
1651    (point (ns:ns-point-x nspt) (ns:ns-point-y nspt))))
Note: See TracBrowser for help on using the repository browser.