source: trunk/source/cocoa-ide/cocoa-editor.lisp @ 14363

Last change on this file since 14363 was 14363, checked in by gb, 9 years ago

Don't do PERFORM-EDIT-CHANGE-NOTIFICATION (call the #/noteHemlock...
method directly) if running in the event thread, since (a) it's not
necessary and (b) we don't want the event thread to wait on a lock.
(We especially don't want the event thread to wait on a lock that may
be held by another thread that's waiting for the event thread to
perform an invocation ...)

Make sure that the #/noteHemlock... methods are named in a way that
reflects the fact that they may get an "extra" argument; make sure
that the global NSInvocation object that we use has a signature that
reflects the fact that that argument's used.

(Other than that, this was fine ...)

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 150.4 KB
Line 
1;;;-*-Mode: LISP; Package: GUI -*-
2;;;
3;;;   Copyright (C) 2007 Clozure Associates
4
5(in-package "GUI")
6
7;;; In the double-float case, this is probably way too small.
8;;; Traditionally, it's (approximately) the point at which
9;;; a single-float stops being able to accurately represent
10;;; integral values.
11(eval-when (:compile-toplevel :load-toplevel :execute)
12  (defconstant large-number-for-text (cgfloat 1.0f7)))
13
14;;; Compensates for the fact that Cocotron uses Mac font metrics and assumes
15;;; the default Macintosh DPI (72) vs. that of Windows (96).
16(defun font-size-kludge (size)
17  #-cocotron size
18  #+cocotron (* size (/ 96.0 72.0)))
19   
20(def-cocoa-default *editor-font* :font #'(lambda ()
21                                           (#/fontWithName:size:
22                                            ns:ns-font
23                                            #+darwin-target
24                                            #@"Monaco"
25                                            #-darwin-target
26                                            #@"Courier New"
27                                            (font-size-kludge 10.0)))
28                   "Default font for editor windows")
29
30(def-cocoa-default *editor-rows* :int 24 "Initial height of editor windows, in characters")
31(def-cocoa-default *editor-columns* :int 80 "Initial width of editor windows, in characters")
32
33(def-cocoa-default *editor-background-color* :color '(1.0 1.0 1.0 1.0) "Editor background color")
34(def-cocoa-default *wrap-lines-to-window* :bool nil
35                   "Soft wrap lines to window width")
36
37(def-cocoa-default *use-screen-fonts* :bool t "Use bitmap screen fonts when available")
38
39(def-cocoa-default *option-is-meta* :bool t "Use option key as meta?")
40
41(defgeneric hemlock-view (ns-object))
42
43(defmethod hemlock-view ((unknown t))
44  nil)
45
46(defgeneric hemlock-buffer (ns-object))
47
48(defmethod hemlock-buffer ((unknown t))
49  (let ((view (hemlock-view unknown)))
50    (when view (hi::hemlock-view-buffer view))))
51
52(defmacro nsstring-encoding-to-nsinteger (n)
53  (ccl::target-word-size-case
54   (32 `(ccl::u32->s32 ,n))
55   (64 n)))
56
57(defmacro nsinteger-to-nsstring-encoding (n)
58  (ccl::target-word-size-case
59   (32 `(ccl::s32->u32 ,n))
60   (64 n)))
61
62;;; Create a paragraph style, mostly so that we can set tabs reasonably.
63(defun rme-create-paragraph-style (font line-break-mode)
64  (let* ((p (make-instance 'ns:ns-mutable-paragraph-style))
65         (charwidth (fround (nth-value 1 (size-of-char-in-font font)))))
66    (#/setLineBreakMode: p
67                         (ecase line-break-mode
68                           (:char #$NSLineBreakByCharWrapping)
69                           (:word #$NSLineBreakByWordWrapping)
70                           ;; This doesn't seem to work too well.
71                           ((nil) #$NSLineBreakByClipping)))
72    ;; Clear existing tab stops.
73    (#/setTabStops: p (#/array ns:ns-array))
74    ;; And set the "default tab interval".
75    (#/setDefaultTabInterval: p (* *tab-width* charwidth))
76    p))
77
78(defun rme-create-text-attributes (&key (font *editor-font*)
79                                   (line-break-mode :char)
80                                   (color nil)
81                                   (obliqueness nil)
82                                   (stroke-width nil))
83  (let* ((dict (make-instance 'ns:ns-mutable-dictionary :with-capacity 5)))
84    (#/setObject:forKey: dict (rme-create-paragraph-style font line-break-mode)
85                         #&NSParagraphStyleAttributeName)
86    (#/setObject:forKey: dict font #&NSFontAttributeName)
87    (when color
88      (#/setObject:forKey: dict color #&NSForegroundColorAttributeName))
89    (when stroke-width
90      (#/setObject:forKey: dict (#/numberWithFloat: ns:ns-number stroke-width)
91                           #&NSStrokeWidthAttributeName))
92    (when obliqueness
93      (#/setObject:forKey: dict (#/numberWithFloat: ns:ns-number obliqueness)
94                           #&NSObliquenessAttributeName))
95    dict))
96
97(defun rme-make-editor-style-map ()
98  (let* ((font *editor-font*)
99         (fm (#/sharedFontManager ns:ns-font-manager))
100         (bold-font (#/convertFont:toHaveTrait: fm font #$NSBoldFontMask))
101         (oblique-font (#/convertFont:toHaveTrait: fm font #$NSItalicFontMask))
102         (bold-oblique-font (#/convertFont:toHaveTrait:
103                             fm font (logior #$NSItalicFontMask
104                                             #$NSBoldFontMask)))
105         (colors (vector (#/blackColor ns:ns-color)))
106         (fonts (vector font bold-font oblique-font bold-oblique-font))
107         (styles (make-instance 'ns:ns-mutable-array)))
108    (dotimes (c (length colors))
109      (dotimes (i 4)
110        (let* ((mask (logand i 3))
111               (f (svref fonts mask)))
112          (#/addObject: styles 
113                        (rme-create-text-attributes :font f
114                                                    :color (svref colors c)
115                                                    :obliqueness
116                                                    (if (logbitp 1 i)
117                                                      (when (eql f font)
118                                                        0.15f0))
119                                                    :stroke-width
120                                                    (if (logbitp 0 i)
121                                                      (when (eql f font)
122                                                        -10.0f0)))))))
123    styles))
124
125(defun make-editor-style-map ()
126  (rme-make-editor-style-map))
127
128#+nil
129(defun make-editor-style-map ()
130  (let* ((font-name *default-font-name*)
131         (font-size *default-font-size*)
132         (font (default-font :name font-name :size font-size))
133         (bold-font (let* ((f (default-font :name font-name :size font-size :attributes '(:bold))))
134                      (unless (eql f font) f)))
135         (oblique-font (let* ((f (default-font :name font-name :size font-size :attributes '(:italic))))
136                      (unless (eql f font) f)))
137         (bold-oblique-font (let* ((f (default-font :name font-name :size font-size :attributes '(:bold :italic))))
138                      (unless (eql f font) f)))
139         (color-class (find-class 'ns:ns-color))
140         (colors (vector (#/blackColor color-class)))
141         (styles (make-instance 'ns:ns-mutable-array
142                                :with-capacity (the fixnum (* 4 (length colors)))))
143         (bold-stroke-width -10.0f0)
144         (fonts (vector font (or bold-font font) (or oblique-font font) (or bold-oblique-font font)))
145         (real-fonts (vector font bold-font oblique-font bold-oblique-font))
146         (s 0))
147    (declare (dynamic-extent fonts real-fonts colors))
148    (dotimes (c (length colors))
149      (dotimes (i 4)
150        (let* ((mask (logand i 3)))
151          (#/addObject: styles
152                        (create-text-attributes :font (svref fonts mask)
153                                                :color (svref colors c)
154                                                :obliqueness
155                                                (if (logbitp 1 i)
156                                                  (unless (svref real-fonts mask)
157                                                    0.15f0))
158                                                :stroke-width
159                                                (if (logbitp 0 i)
160                                                  (unless (svref real-fonts mask)
161                                                    bold-stroke-width)))))
162        (incf s)))
163    (#/retain styles)))
164
165(defun make-hemlock-buffer (&rest args)
166  (let* ((buf (apply #'hi::make-buffer args)))
167    (assert buf)
168    buf))
169
170;;; Define some key event modifiers and keysym codes
171
172(hi:define-modifier-bit #$NSShiftKeyMask "Shift")
173(hi:define-modifier-bit #$NSControlKeyMask "Control")
174(hi:define-modifier-bit #$NSAlternateKeyMask "Meta")
175(hi:define-modifier-bit #$NSAlphaShiftKeyMask "Lock")
176
177(hi:define-keysym-code :F1 #$NSF1FunctionKey)
178(hi:define-keysym-code :F2 #$NSF2FunctionKey)
179(hi:define-keysym-code :F3 #$NSF3FunctionKey)
180(hi:define-keysym-code :F4 #$NSF4FunctionKey)
181(hi:define-keysym-code :F5 #$NSF5FunctionKey)
182(hi:define-keysym-code :F6 #$NSF6FunctionKey)
183(hi:define-keysym-code :F7 #$NSF7FunctionKey)
184(hi:define-keysym-code :F8 #$NSF8FunctionKey)
185(hi:define-keysym-code :F9 #$NSF9FunctionKey)
186(hi:define-keysym-code :F10 #$NSF10FunctionKey)
187(hi:define-keysym-code :F11 #$NSF11FunctionKey)
188(hi:define-keysym-code :F12 #$NSF12FunctionKey)
189(hi:define-keysym-code :F13 #$NSF13FunctionKey)
190(hi:define-keysym-code :F14 #$NSF14FunctionKey)
191(hi:define-keysym-code :F15 #$NSF15FunctionKey)
192(hi:define-keysym-code :F16 #$NSF16FunctionKey)
193(hi:define-keysym-code :F17 #$NSF17FunctionKey)
194(hi:define-keysym-code :F18 #$NSF18FunctionKey)
195(hi:define-keysym-code :F19 #$NSF19FunctionKey)
196(hi:define-keysym-code :F20 #$NSF20FunctionKey)
197(hi:define-keysym-code :F21 #$NSF21FunctionKey)
198(hi:define-keysym-code :F22 #$NSF22FunctionKey)
199(hi:define-keysym-code :F23 #$NSF23FunctionKey)
200(hi:define-keysym-code :F24 #$NSF24FunctionKey)
201(hi:define-keysym-code :F25 #$NSF25FunctionKey)
202(hi:define-keysym-code :F26 #$NSF26FunctionKey)
203(hi:define-keysym-code :F27 #$NSF27FunctionKey)
204(hi:define-keysym-code :F28 #$NSF28FunctionKey)
205(hi:define-keysym-code :F29 #$NSF29FunctionKey)
206(hi:define-keysym-code :F30 #$NSF30FunctionKey)
207(hi:define-keysym-code :F31 #$NSF31FunctionKey)
208(hi:define-keysym-code :F32 #$NSF32FunctionKey)
209(hi:define-keysym-code :F33 #$NSF33FunctionKey)
210(hi:define-keysym-code :F34 #$NSF34FunctionKey)
211(hi:define-keysym-code :F35 #$NSF35FunctionKey)
212
213;;; Upper right key bank.
214;;;
215(hi:define-keysym-code :Printscreen #$NSPrintScreenFunctionKey)
216;; Couldn't type scroll lock.
217(hi:define-keysym-code :Pause #$NSPauseFunctionKey)
218
219;;; Middle right key bank.
220;;;
221(hi:define-keysym-code :Insert #$NSInsertFunctionKey)
222(hi:define-keysym-code :Del #$NSDeleteFunctionKey)
223(hi:define-keysym-code :Home #$NSHomeFunctionKey)
224(hi:define-keysym-code :Pageup #$NSPageUpFunctionKey)
225(hi:define-keysym-code :End #$NSEndFunctionKey)
226(hi:define-keysym-code :Pagedown #$NSPageDownFunctionKey)
227
228;;; Arrows.
229;;;
230(hi:define-keysym-code :Leftarrow #$NSLeftArrowFunctionKey)
231(hi:define-keysym-code :Uparrow #$NSUpArrowFunctionKey)
232(hi:define-keysym-code :Downarrow #$NSDownArrowFunctionKey)
233(hi:define-keysym-code :Rightarrow #$NSRightArrowFunctionKey)
234
235;;;
236
237;(hi:define-keysym-code :linefeed 65290)
238
239
240
241
242
243;;; We want to display a Hemlock buffer in a "pane" (an on-screen
244;;; view) which in turn is presented in a "frame" (a Cocoa window).  A
245;;; 1:1 mapping between frames and panes seems to fit best into
246;;; Cocoa's document architecture, but we should try to keep the
247;;; concepts separate (in case we come up with better UI paradigms.)
248;;; Each pane has a modeline (which describes attributes of the
249;;; underlying document); each frame has an echo area (which serves
250;;; to display some commands' output and to provide multi-character
251;;; input.)
252
253
254;;; I'd pretty much concluded that it wouldn't be possible to get the
255;;; Cocoa text system (whose storage model is based on NSString
256;;; NSMutableAttributedString, NSTextStorage, etc.) to get along with
257;;; Hemlock, and (since the whole point of using Hemlock was to be
258;;; able to treat an editor buffer as a rich lisp data structure) it
259;;; seemed like it'd be necessary to toss the higher-level Cocoa text
260;;; system and implement our own scrolling, redisplay, selection
261;;; ... code.
262;;;
263;;; Mikel Evins pointed out that NSString and friends were
264;;; abstract classes and that there was therefore no reason (in
265;;; theory) not to implement a thin wrapper around a Hemlock buffer
266;;; that made it act like an NSString.  As long as the text system can
267;;; ask a few questions about the NSString (its length and the
268;;; character and attributes at a given location), it's willing to
269;;; display the string in a scrolling, mouse-selectable NSTextView;
270;;; as long as Hemlock tells the text system when and how the contents
271;;; of the abstract string changes, Cocoa will handle the redisplay
272;;; details.
273;;;
274
275
276;;; Hemlock-buffer-string objects:
277
278(defclass hemlock-buffer-string (ns:ns-string)
279    ((cache :initform nil :initarg :cache :accessor hemlock-buffer-string-cache))
280  (:metaclass ns:+ns-object))
281
282
283 
284(defmethod hemlock-buffer ((self hemlock-buffer-string))
285  (let ((cache (hemlock-buffer-string-cache self)))
286    (when cache
287      (hemlock-buffer cache))))
288
289;;; Cocoa wants to treat the buffer as a linear array of characters;
290;;; Hemlock wants to treat it as a doubly-linked list of lines, so
291;;; we often have to map between an absolute position in the buffer
292;;; and a relative position on a line.  We can certainly do that
293;;; by counting the characters in preceding lines every time that we're
294;;; asked, but we're often asked to map a sequence of nearby positions
295;;; and wind up repeating a lot of work.  Caching the results of that
296;;; work seems to speed things up a bit in many cases; this data structure
297;;; is used in that process.  (It's also the only way to get to the
298;;; actual underlying Lisp buffer from inside the network of text-system
299;;; objects.)
300
301(defstruct buffer-cache 
302  buffer                                ; the hemlock buffer
303  buflen                                ; length of buffer, if known
304  workline                              ; cache for character-at-index
305  workline-offset                       ; cached offset of workline
306  workline-length                       ; length of cached workline
307  workline-start-font-index             ; current font index at start of workline
308  )
309
310(objc:defmethod (#/dealloc :void) ((self hemlock-buffer-string))
311  (let* ((cache (hemlock-buffer-string-cache self))
312         (buffer (if cache (buffer-cache-buffer cache))))
313    (when buffer
314      (setf (buffer-cache-buffer cache) nil
315            (slot-value self 'cache) nil
316            (hi::buffer-document buffer) nil)
317      (when (eq buffer hi::*current-buffer*)
318        (setf hi::*current-buffer* nil))
319      (hi::delete-buffer buffer)))
320  (objc:remove-lisp-slots self)
321  (call-next-method))
322
323(defmethod hemlock-buffer ((self buffer-cache))
324  (buffer-cache-buffer self))
325
326;;; Initialize (or reinitialize) a buffer cache, so that it points
327;;; to the buffer's first line (which is the only line whose
328;;; absolute position will never change).  Code which modifies the
329;;; buffer generally has to call this, since any cached information
330;;; might be invalidated by the modification.
331
332(defun reset-buffer-cache (d &optional (buffer (buffer-cache-buffer d)
333                                                buffer-p))
334  (when buffer-p (setf (buffer-cache-buffer d) buffer))
335  (let* ((hi::*current-buffer* buffer)
336         (workline (hi::mark-line
337                    (hi::buffer-start-mark buffer))))
338    (setf (buffer-cache-buflen d) (hemlock-buffer-length buffer)
339          (buffer-cache-workline-offset d) 0
340          (buffer-cache-workline d) workline
341          (buffer-cache-workline-length d) (hi::line-length workline)
342          (buffer-cache-workline-start-font-index d) 0)
343    d))
344
345
346(defun adjust-buffer-cache-for-insertion (display pos n)
347  (if (buffer-cache-workline display)
348    (let* ((hi::*current-buffer* (buffer-cache-buffer display)))
349      (if (> (buffer-cache-workline-offset display) pos)
350        (incf (buffer-cache-workline-offset display) n)
351        (when (>= (+ (buffer-cache-workline-offset display)
352                     (buffer-cache-workline-length display))
353                  pos)
354          (setf (buffer-cache-workline-length display)
355                (hi::line-length (buffer-cache-workline display)))))
356      (incf (buffer-cache-buflen display) n))
357    (reset-buffer-cache display)))
358
359         
360           
361
362;;; Update the cache so that it's describing the current absolute
363;;; position.
364
365(defun update-line-cache-for-index (cache index)
366  (let* ((buffer (buffer-cache-buffer cache))
367         (hi::*current-buffer* buffer)
368         (line (or
369                (buffer-cache-workline cache)
370                (progn
371                  (reset-buffer-cache cache)
372                  (buffer-cache-workline cache))))
373         (pos (buffer-cache-workline-offset cache))
374         (len (buffer-cache-workline-length cache))
375         (moved nil))
376    (loop
377      (when (and (>= index pos)
378                   (< index (1+ (+ pos len))))
379          (let* ((idx (- index pos)))
380            (when moved
381              (setf (buffer-cache-workline cache) line
382                    (buffer-cache-workline-offset cache) pos
383                    (buffer-cache-workline-length cache) len))
384            (return (values line idx))))
385      (setq moved t)
386      (if (< index pos)
387        (setq line (hi::line-previous line)
388              len (hi::line-length line)
389              pos (1- (- pos len)))
390        (setq line (hi::line-next line)
391              pos (1+ (+ pos len))
392              len (hi::line-length line))))))
393
394;;; Ask Hemlock to count the characters in the buffer.
395(defun hemlock-buffer-length (buffer)
396  (let* ((hi::*current-buffer* buffer))
397    (hemlock::count-characters (hemlock::buffer-region buffer))))
398
399;;; Find the line containing (or immediately preceding) index, which is
400;;; assumed to be less than the buffer's length.  Return the character
401;;; in that line or the trailing #\newline, as appropriate.
402(defun hemlock-char-at-index (cache index)
403  (let* ((hi::*current-buffer* (buffer-cache-buffer cache)))
404    (multiple-value-bind (line idx) (update-line-cache-for-index cache index)
405      (let* ((len (hemlock::line-length line)))
406        (if (< idx len)
407          (hemlock::line-character line idx)
408          #\newline)))))
409
410;;; Given an absolute position, move the specified mark to the appropriate
411;;; offset on the appropriate line.
412(defun move-hemlock-mark-to-absolute-position (mark cache abspos)
413  ;; TODO: figure out if updating the cache matters, and if not, use hi:move-to-absolute-position.
414  (let* ((hi::*current-buffer* (buffer-cache-buffer cache)))
415    (hi::move-to-absolute-position mark abspos)
416    #+old
417    (multiple-value-bind (line idx) (update-line-cache-for-index cache abspos)
418      #+debug
419      (#_NSLog #@"Moving point from current pos %d to absolute position %d"
420               :int (hi:mark-absolute-position mark)
421               :int abspos)
422      (hemlock::move-to-position mark idx line)
423      #+debug
424      (#_NSLog #@"Moved mark to %d" :int (hi:mark-absolute-position mark)))))
425
426;;; Return the length of the abstract string, i.e., the number of
427;;; characters in the buffer (including implicit newlines.)
428(objc:defmethod (#/length :<NSUI>nteger) ((self hemlock-buffer-string))
429  (let* ((cache (hemlock-buffer-string-cache self)))
430    (or (buffer-cache-buflen cache)
431        (setf (buffer-cache-buflen cache)
432              (let* ((buffer (buffer-cache-buffer cache)))
433                (hemlock-buffer-length buffer))))))
434
435
436
437;;; Return the character at the specified index (as a :unichar.)
438
439(objc:defmethod (#/characterAtIndex: :unichar)
440    ((self hemlock-buffer-string) (index :<NSUI>nteger))
441  #+debug
442  (#_NSLog #@"Character at index: %d" :<NSUI>nteger index)
443  (char-code (hemlock-char-at-index (hemlock-buffer-string-cache self) index)))
444
445(objc:defmethod (#/getCharacters:range: :void)
446    ((self hemlock-buffer-string)
447     (buffer (:* :unichar))
448     (r :<NSR>ange))
449  (let* ((cache (hemlock-buffer-string-cache self))
450         (index (ns:ns-range-location r))
451         (length (ns:ns-range-length r))
452         (hi::*current-buffer* (buffer-cache-buffer cache)))
453    #+debug
454    (#_NSLog #@"get characters: %d/%d"
455             :<NSUI>nteger index
456             :<NSUI>nteger length)
457    (multiple-value-bind (line idx) (update-line-cache-for-index cache index)
458      (let* ((len (hemlock::line-length line)))
459        (do* ((i 0 (1+ i)))
460             ((= i length))
461          (cond ((< idx len)
462                 (setf (paref buffer (:* :unichar) i)
463                       (char-code (hemlock::line-character line idx)))
464                 (incf idx))
465                (t
466                 (setf (paref buffer (:* :unichar) i)
467                       (char-code #\Newline)
468                       line (hi::line-next line)
469                       len (if line (hi::line-length line) 0)
470                       idx 0))))))))
471
472
473(objc:defmethod (#/getLineStart:end:contentsEnd:forRange: :void)
474    ((self hemlock-buffer-string)
475     (startptr (:* :<NSUI>nteger))
476     (endptr (:* :<NSUI>nteger))
477     (contents-endptr (:* :<NSUI>nteger))
478     (r :<NSR>ange))
479  (let* ((cache (hemlock-buffer-string-cache self))
480         (index (pref r :<NSR>ange.location))
481         (length (pref r :<NSR>ange.length))
482         (hi::*current-buffer* (buffer-cache-buffer cache)))
483    #+debug
484    (#_NSLog #@"get line start: %d/%d"
485             :unsigned index
486             :unsigned length)
487    (update-line-cache-for-index cache index)
488    (unless (%null-ptr-p startptr)
489      ;; Index of the first character in the line which contains
490      ;; the start of the range.
491      (setf (pref startptr :<NSUI>nteger)
492            (buffer-cache-workline-offset cache)))
493    (unless (%null-ptr-p endptr)
494      ;; Index of the newline which terminates the line which
495      ;; contains the start of the range.
496      (setf (pref endptr :<NSUI>nteger)
497            (+ (buffer-cache-workline-offset cache)
498               (buffer-cache-workline-length cache))))
499    (unless (%null-ptr-p contents-endptr)
500      ;; Index of the newline which terminates the line which
501      ;; contains the start of the range.
502      (unless (zerop length)
503        (update-line-cache-for-index cache (+ index length)))
504      (setf (pref contents-endptr :<NSUI>nteger)
505            (1+ (+ (buffer-cache-workline-offset cache)
506                   (buffer-cache-workline-length cache)))))))
507
508;;; For debugging, mostly: make the printed representation of the string
509;;; referenence the named Hemlock buffer.
510(objc:defmethod #/description ((self hemlock-buffer-string))
511  (let* ((cache (hemlock-buffer-string-cache self))
512         (b (buffer-cache-buffer cache)))
513    (with-cstrs ((s (format nil "~a" b)))
514      (#/stringWithFormat: ns:ns-string #@"<%s for %s>" (#_object_getClassName self) s))))
515
516
517
518;;; hemlock-text-storage objects
519(defclass hemlock-text-storage (ns:ns-text-storage)
520    ((string :foreign-type :id)
521     (hemlock-string :foreign-type :id)
522     (edit-count :foreign-type :int)
523     (mirror :foreign-type :id)
524     (styles :foreign-type :id)
525     (selection-set-by-search :foreign-type :<BOOL>))
526  (:metaclass ns:+ns-object))
527(declaim (special hemlock-text-storage))
528
529(defmethod hemlock-buffer ((self hemlock-text-storage))
530  (let ((string (slot-value self 'hemlock-string)))
531    (unless (%null-ptr-p string)
532      (hemlock-buffer string))))
533
534;;; This is only here so that calls to it can be logged for debugging.
535#+debug
536(objc:defmethod (#/lineBreakBeforeIndex:withinRange: :<NSUI>nteger)
537    ((self hemlock-text-storage)
538     (index :<NSUI>nteger)
539     (r :<NSR>ange))
540  (#_NSLog #@"Line break before index: %d within range: %@"
541           :unsigned index
542           :id (#_NSStringFromRange r))
543  (call-next-method index r))
544
545
546
547
548;;; Return true iff we're inside a "beginEditing/endEditing" pair
549(objc:defmethod (#/editingInProgress :<BOOL>) ((self hemlock-text-storage))
550  ;; This is meaningless outside the event thread, since you can't tell what
551  ;; other edit-count changes have already been queued up for execution on
552  ;; the event thread before it gets to whatever you might queue up next.
553  (assume-cocoa-thread)
554  (> (slot-value self 'edit-count) 0))
555
556(defmethod assume-not-editing ((ts hemlock-text-storage))
557  #+debug NIL (assert (eql (slot-value ts 'edit-count) 0)))
558
559(defun textstorage-note-insertion-at-position (self pos n)
560  (ns:with-ns-range (r pos 0)
561    (#/edited:range:changeInLength: self #$NSTextStorageEditedCharacters r n)
562    (setf (ns:ns-range-length r) n)
563    (#/edited:range:changeInLength: self #$NSTextStorageEditedAttributes r 0)))
564
565
566
567;;; This runs on the main thread; it synchronizes the "real" NSMutableAttributedString
568;;; with the hemlock string and informs the textstorage of the insertion.
569(objc:defmethod (#/noteHemlockInsertionAtPosition:length:extra: :void) ((self hemlock-text-storage)
570                                                                  (pos :<NSI>nteger)
571                                                                  (n :<NSI>nteger)
572                                                                  (extra :<NSI>nteger))
573  (declare (ignorable extra))
574  (assume-cocoa-thread)
575  (let* ((mirror (#/mirror self))
576         (hemlock-string (#/hemlockString self))
577         (display (hemlock-buffer-string-cache hemlock-string))
578         (buffer (buffer-cache-buffer display))
579         (hi::*current-buffer* buffer)
580         (attributes (buffer-active-font-attributes buffer))
581         (document (#/document self))
582         (undo-mgr (and document (#/undoManager document))))
583    #+debug 
584    (#_NSLog #@"insert: pos = %ld, n = %ld" :long pos :long n)
585    ;; We need to update the hemlock string mirror here so that #/substringWithRange:
586    ;; will work on the hemlock buffer string.
587    (adjust-buffer-cache-for-insertion display pos n)
588    (update-line-cache-for-index display pos)
589    (let* ((replacestring (#/substringWithRange: hemlock-string (ns:make-ns-range pos n))))
590      (ns:with-ns-range (replacerange pos 0)
591        (#/replaceCharactersInRange:withString:
592         mirror replacerange replacestring))
593      (when (and undo-mgr (not (#/isUndoing undo-mgr)))
594        (#/replaceCharactersAtPosition:length:withString:
595         (#/prepareWithInvocationTarget: undo-mgr self)
596         pos n #@"")))
597    (#/setAttributes:range: mirror attributes (ns:make-ns-range pos n))
598    (textstorage-note-insertion-at-position self pos n)))
599
600(objc:defmethod (#/noteHemlockDeletionAtPosition:length:extra: :void) ((self hemlock-text-storage)
601                                                                       (pos :<NSI>nteger)
602                                                                       (n :<NSI>nteger)
603                                                                       (extra :<NSI>nteger))
604  (declare (ignorable extra))
605  #+debug
606  (#_NSLog #@"delete: pos = %ld, n = %ld" :long pos :long n)
607  (ns:with-ns-range (range pos n)
608    (let* ((mirror (#/mirror self))
609           (deleted-string (#/substringWithRange: (#/string mirror) range))
610           (document (#/document self))
611           (undo-mgr (and document (#/undoManager document)))
612           (display (hemlock-buffer-string-cache (#/hemlockString self))))
613      ;; It seems to be necessary to call #/edited:range:changeInLength: before
614      ;; deleting from the mirror attributed string.  It's not clear whether this
615      ;; is also true of insertions and modifications.
616      (#/edited:range:changeInLength: self (logior #$NSTextStorageEditedCharacters
617                                                   #$NSTextStorageEditedAttributes)
618                                      range (- n))
619      (#/deleteCharactersInRange: mirror range)
620      (when (and undo-mgr (not (#/isUndoing undo-mgr)))
621        (#/replaceCharactersAtPosition:length:withString:
622         (#/prepareWithInvocationTarget: undo-mgr self)
623         pos 0 deleted-string))
624      (reset-buffer-cache display)
625      (update-line-cache-for-index display pos))))
626
627(objc:defmethod (#/noteHemlockModificationAtPosition:length:extra: :void) ((self hemlock-text-storage)
628                                                                           (pos :<NSI>nteger)
629                                                                           (n :<NSI>nteger)
630                                                                           (extra :<NSI>nteger))
631  (declare (ignorable extra))
632  #+debug
633  (#_NSLog #@"modify: pos = %ld, n = %ld" :long pos :long n)
634  (ns:with-ns-range (range pos n)
635    (let* ((hemlock-string (#/hemlockString self))
636           (mirror (#/mirror self))
637           (deleted-string (#/substringWithRange: (#/string mirror) range))
638           (document (#/document self))
639           (undo-mgr (and document (#/undoManager document))))
640      (#/replaceCharactersInRange:withString:
641       mirror range (#/substringWithRange: hemlock-string range))
642      (#/edited:range:changeInLength: self (logior #$NSTextStorageEditedCharacters
643                                                   #$NSTextStorageEditedAttributes) range 0)
644      (when (and undo-mgr (not (#/isUndoing undo-mgr)))
645        (#/replaceCharactersAtPosition:length:withString:
646         (#/prepareWithInvocationTarget: undo-mgr self)
647         pos n deleted-string)))))
648
649(objc:defmethod (#/noteHemlockAttrChangeAtPosition:length:fontNum: :void) ((self hemlock-text-storage)
650                                                                           (pos :<NSI>nteger)
651                                                                           (n :<NSI>nteger)
652                                                                           (fontnum :<NSI>nteger))
653  (ns:with-ns-range (range pos n)
654    (#/setAttributes:range: (#/mirror self) (#/objectAtIndex: (#/styles self) fontnum) range)
655    (#/edited:range:changeInLength: self #$NSTextStorageEditedAttributes range 0)))
656
657
658(defloadvar *buffer-change-invocation*
659    (with-autorelease-pool
660        (#/retain
661                   (#/invocationWithMethodSignature: ns:ns-invocation
662                                                     (#/instanceMethodSignatureForSelector:
663                                                      hemlock-text-storage
664                                            (@selector #/noteHemlockInsertionAtPosition:length:extra:))))))
665
666(defstatic *buffer-change-invocation-lock* (make-lock))
667
668         
669         
670(objc:defmethod (#/beginEditing :void) ((self hemlock-text-storage))
671  (assume-cocoa-thread)
672  (with-slots (edit-count) self
673    #+debug
674    (#_NSLog #@"begin-editing")
675    (incf edit-count)
676    #+debug
677    (#_NSLog #@"after beginEditing on %@ edit-count now = %d" :id self :int edit-count)
678    (call-next-method)))
679
680(objc:defmethod (#/endEditing :void) ((self hemlock-text-storage))
681  (assume-cocoa-thread)
682  (with-slots (edit-count) self
683    #+debug
684    (#_NSLog #@"end-editing")
685    (call-next-method)
686    (assert (> edit-count 0))
687    (decf edit-count)
688    #+debug
689    (#_NSLog #@"after endEditing on %@, edit-count now = %d" :id self :int edit-count)))
690
691
692
693 
694
695;;; Access the string.  It'd be nice if this was a generic function;
696;;; we could have just made a reader method in the class definition.
697
698
699
700(objc:defmethod #/string ((self hemlock-text-storage))
701  (slot-value self 'string))
702
703(objc:defmethod #/mirror ((self hemlock-text-storage))
704  (slot-value self 'mirror))
705
706(objc:defmethod #/hemlockString ((self hemlock-text-storage))
707  (slot-value self 'hemlock-string))
708
709(objc:defmethod #/styles ((self hemlock-text-storage))
710  (slot-value self 'styles))
711
712(objc:defmethod #/document ((self hemlock-text-storage))
713  (or
714   (let* ((string (#/hemlockString self)))
715     (unless (%null-ptr-p string)
716       (let* ((cache (hemlock-buffer-string-cache string)))
717         (when cache
718           (let* ((buffer (buffer-cache-buffer cache)))
719             (when buffer
720               (hi::buffer-document buffer)))))))
721   +null-ptr+))
722
723
724#-cocotron
725(objc:defmethod #/initWithString: ((self hemlock-text-storage) s)
726  (setq s (%inc-ptr s 0))
727  (let* ((newself (#/init self))
728         (styles (make-editor-style-map))
729         (mirror (make-instance ns:ns-mutable-attributed-string
730                                   :with-string s
731                                   :attributes (#/objectAtIndex: styles 0))))
732    (declare (type hemlock-text-storage newself))
733    (setf (slot-value newself 'styles) styles)
734    (setf (slot-value newself 'hemlock-string) s)
735    (setf (slot-value newself 'mirror) mirror)
736    (setf (slot-value newself 'string) (#/retain (#/string mirror)))
737    newself))
738
739#+cocotron
740(objc:defmethod #/initWithString: ((self hemlock-text-storage) s)
741  (setq s (%inc-ptr s 0))
742  (let* ((styles (make-editor-style-map))
743         (mirror (make-instance ns:ns-mutable-attributed-string
744                                   :with-string s
745                                   :attributes (#/objectAtIndex: styles 0)))
746         (string (#/retain (#/string mirror)))
747         (newself (call-next-method string)))
748    (declare (type hemlock-text-storage newself))
749    (setf (slot-value newself 'styles) styles)
750    (setf (slot-value newself 'hemlock-string) s)
751    (setf (slot-value newself 'mirror) mirror)
752    (setf (slot-value newself 'string) string)
753    newself))
754
755;;; Should generally only be called after open/revert.
756(objc:defmethod (#/updateMirror :void) ((self hemlock-text-storage))
757  (with-slots (hemlock-string mirror styles) self
758    (#/replaceCharactersInRange:withString: mirror (ns:make-ns-range 0 (#/length mirror)) hemlock-string)
759    (#/setAttributes:range: mirror (#/objectAtIndex: styles 0) (ns:make-ns-range 0 (#/length mirror)))))
760
761;;; This is the only thing that's actually called to create a
762;;; hemlock-text-storage object.  (It also creates the underlying
763;;; hemlock-buffer-string.)
764(defun make-textstorage-for-hemlock-buffer (buffer)
765  (make-instance 'hemlock-text-storage
766                 :with-string
767                 (make-instance
768                  'hemlock-buffer-string
769                  :cache
770                  (reset-buffer-cache
771                   (make-buffer-cache)
772                   buffer))))
773
774(objc:defmethod #/attributesAtIndex:effectiveRange:
775    ((self hemlock-text-storage) (index :<NSUI>nteger) (rangeptr (* :<NSR>ange)))
776  #+debug
777  (#_NSLog #@"Attributes at index: %lu storage %@" :<NSUI>nteger index :id self)
778  (with-slots (mirror styles) self
779    (when (>= index (#/length mirror))
780      (#_NSLog #@"Bounds error - Attributes at index: %lu  edit-count: %d mirror: %@ layout: %@" :<NSUI>nteger index ::unsigned (slot-value self 'edit-count) :id mirror :id (#/objectAtIndex: (#/layoutManagers self) 0))
781      (ccl::dbg))
782    (let* ((attrs (#/attributesAtIndex:effectiveRange: mirror index rangeptr)))
783      (when (eql 0 (#/count attrs))
784        (#_NSLog #@"No attributes ?")
785        (ns:with-ns-range (r)
786          (#/attributesAtIndex:longestEffectiveRange:inRange:
787           mirror index r (ns:make-ns-range 0 (#/length mirror)))
788          (setq attrs (#/objectAtIndex: styles 0))
789          (#/setAttributes:range: mirror attrs r)))
790      attrs)))
791
792(objc:defmethod (#/replaceCharactersAtPosition:length:withString: :void)
793    ((self hemlock-text-storage) (pos <NSUI>nteger) (len <NSUI>nteger) string)
794  (let* ((document (#/document self))
795         (undo-mgr (and document (#/undoManager document))))
796    (when (and undo-mgr (not (#/isRedoing undo-mgr)))
797      (let ((replaced-string (#/substringWithRange: (#/hemlockString self) (ns:make-ns-range pos len))))
798        (#/replaceCharactersAtPosition:length:withString:
799         (#/prepareWithInvocationTarget: undo-mgr self)
800         pos (#/length string) replaced-string)))
801    (ns:with-ns-range (r pos len)
802      (#/beginEditing self)
803      (unwind-protect
804           (#/replaceCharactersInRange:withString: self r string)
805        (#/endEditing self)))))
806
807;; In theory (though not yet in practice) we allow for a buffer to be shown in multiple
808;; windows, and any change to a buffer through one window has to be reflected in all of
809;; them.  Once hemlock really supports multiple views of a buffer, it will have some
810;; mechanims to ensure that.
811;; In Cocoa, we get some messages for the buffer (i.e. the document or the textstorage)
812;; with no reference to a view.  There used to be code here that tried to do special-
813;; case stuff for all views on the buffer, but that's not necessary, because as long
814;; as hemlock doesn't support it, there will only be one view, and as soon as hemlock
815;; does support it, will take care of updating all other views.  So all we need is to
816;; get our hands on one of the views and do whatever it is through it.
817(defun front-view-for-buffer (buffer)
818  (loop
819     with win-arr =  (#/orderedWindows *NSApp*)
820     for i from 0 below (#/count win-arr) as w = (#/objectAtIndex: win-arr i)
821     thereis (and (eq (hemlock-buffer w) buffer) (hemlock-view w))))
822
823
824;;; Modify the hemlock buffer; don't change attributes.
825(objc:defmethod (#/replaceCharactersInRange:withString: :void)
826    ((self hemlock-text-storage) (r :<NSR>ange) string)
827  (let* ((buffer (hemlock-buffer self))
828         (hi::*current-buffer* buffer)
829         (position (pref r :<NSR>ange.location))
830         (length (pref r :<NSR>ange.length))
831         (lisp-string (if (> (#/length string) 0) (lisp-string-from-nsstring string)))
832         (view (front-view-for-buffer buffer))
833         (edit-count (slot-value self 'edit-count)))
834    ;; #!#@#@* find panel neglects to call #/beginEditing / #/endEditing.
835    (when (eql 0 edit-count)
836      (#/beginEditing self))
837    (unwind-protect
838         (hi::with-mark ((m (hi::buffer-point buffer)))
839           (hi::move-to-absolute-position m position)
840           (when (> length 0)
841             (hi::delete-characters m length))
842           (when lisp-string
843             (hi::insert-string m lisp-string)))
844      (when (eql 0 edit-count)
845        (#/endEditing self)))
846    (when view
847      (setf (hi::hemlock-view-quote-next-p view) nil))))
848
849(objc:defmethod (#/setAttributes:range: :void) ((self hemlock-text-storage)
850                                                attributes
851                                                (r :<NSR>ange))
852  #+debug
853  (#_NSLog #@"Set attributes: %@ at %d/%d" :id attributes :int (pref r :<NSR>ange.location) :int (pref r :<NSR>ange.length))
854  (with-slots (mirror) self
855    (#/setAttributes:range: mirror attributes r)
856      #+debug
857      (#_NSLog #@"Assigned attributes = %@" :id (#/attributesAtIndex:effectiveRange: mirror (pref r :<NSR>ange.location) +null-ptr+))))
858
859(defun for-each-textview-using-storage (textstorage f)
860  (let* ((layouts (#/layoutManagers textstorage)))
861    (unless (%null-ptr-p layouts)
862      (dotimes (i (#/count layouts))
863        (let* ((layout (#/objectAtIndex: layouts i))
864               (containers (#/textContainers layout)))
865          (unless (%null-ptr-p containers)
866            (dotimes (j (#/count containers))
867              (let* ((container (#/objectAtIndex: containers j))
868                     (tv (#/textView container)))
869                (funcall f tv)))))))))
870
871;;; Again, it's helpful to see the buffer name when debugging.
872(objc:defmethod #/description ((self hemlock-text-storage))
873  (#/stringWithFormat: ns:ns-string #@"%s : string %@" (#_object_getClassName self) (slot-value self 'hemlock-string)))
874
875(defun close-hemlock-textstorage (ts)
876  (declare (type hemlock-text-storage ts))
877  (when (slot-exists-p ts 'styles)
878    (with-slots (styles) ts
879      (#/release styles)
880      (setq styles +null-ptr+)))
881  (let* ((hemlock-string (slot-value ts 'hemlock-string)))
882    (setf (slot-value ts 'hemlock-string) +null-ptr+)
883    (unless (%null-ptr-p hemlock-string)
884      (#/release hemlock-string))))
885
886
887;;; Mostly experimental, so that we can see what happens when a
888;;; real typesetter is used.
889#-cocotron
890(progn
891(defclass hemlock-ats-typesetter (ns:ns-ats-typesetter)
892    ()
893  (:metaclass ns:+ns-object))
894
895(objc:defmethod (#/layoutGlyphsInLayoutManager:startingAtGlyphIndex:maxNumberOfLineFragments:nextGlyphIndex: :void)
896    ((self hemlock-ats-typesetter)
897     layout-manager
898     (start-index :<NSUI>nteger)
899     (max-lines :<NSUI>nteger)
900     (next-index (:* :<NSUI>nteger)))
901  (#_NSLog #@"layoutGlyphs: start = %d, maxlines = %d" :int start-index :int max-lines)
902  (call-next-method layout-manager start-index max-lines next-index))
903)
904
905;;; An abstract superclass of the main and echo-area text views.
906(defclass hemlock-textstorage-text-view (ns::ns-text-view)
907    ((paren-highlight-left-pos :foreign-type #>NSUInteger :accessor text-view-paren-highlight-left-pos)
908     (paren-highlight-right-pos :foreign-type #>NSUInteger :accessor text-view-paren-highlight-right-pos)
909     (paren-highlight-color-attribute :foreign-type :id :accessor text-view-paren-highlight-color)
910     (paren-highlight-enabled :foreign-type #>BOOL :accessor text-view-paren-highlight-enabled)
911     (peer :foreign-type :id))
912  (:metaclass ns:+ns-object))
913(declaim (special hemlock-textstorage-text-view))
914
915#| causes more problems than it solves.
916   removed until a better implementation manifests itself --me
917(objc:defmethod (#/performDragOperation: #>BOOL)
918    ((self hemlock-textstorage-text-view)
919     (sender :id))
920  (let* ((pboard (#/draggingPasteboard sender))
921         (pbTypes (#/arrayWithObjects: ns:ns-array #&NSFilenamesPboardType
922                                       +null-ptr+))
923         (available-type (#/availableTypeFromArray: pboard pbTypes)))
924    (if (%null-ptr-p available-type)
925        (progn (log-debug "No data available of type NSFilenamesPboardType")
926               (call-next-method sender))
927        (let* ((plist (#/propertyListForType: pboard #&NSFilenamesPboardType)))
928          (cond
929            ;; we found NSFilenamesPboardType and it's an array of pathnames
930            ((#/isKindOfClass: plist ns:ns-array)
931             (with-autorelease-pool
932               (let* ((strings-for-dropped-objects
933                       (mapcar (lambda (d)
934                                 (if (#/isKindOfClass: d ns:ns-string)
935                                     (ccl::lisp-string-from-nsstring d)
936                                     (#/description d)))
937                               (list-from-ns-array plist)))
938                      (canonical-dropped-paths
939                       (mapcar (lambda (s)
940                                 (if (and (probe-file s)
941                                          (directoryp s))
942                                     (ccl::ensure-directory-pathname s)
943                                     s))
944                               strings-for-dropped-objects))
945                      (dropstr (if (= (length canonical-dropped-paths) 1)
946                                   (with-output-to-string (out)
947                                     (format out "~S~%" (first canonical-dropped-paths)))
948                                   nil)))
949                 ;; TODO: insert them in the window
950                 (if dropstr
951                     (let* ((hview (hemlock-view self))
952                            (buf (hi:hemlock-view-buffer hview))
953                            (point (hi::buffer-point buf))
954                            (hi::*current-buffer* buf))
955                       (hi::insert-string point dropstr)
956                       #$YES)
957                     #$NO))))
958            ;; we found NSFilenamesPboardType, but didn't get an array of pathnames; huh???
959            (t (log-debug "hemlock-textstorage-text-view received an unrecognized data type in a drag operation: '~S'"
960                          (#/description plist))
961               (call-next-method sender)))))))
962|#
963
964(defmethod hemlock-view ((self hemlock-textstorage-text-view))
965  (let ((frame (#/window self)))
966    (unless (%null-ptr-p frame)
967      (hemlock-view frame))))
968
969(defmethod activate-hemlock-view ((self hemlock-textstorage-text-view))
970  (assume-cocoa-thread)
971  (let* ((the-hemlock-frame (#/window self)))
972    #+debug (log-debug "Activating ~s" self)
973    (with-slots ((echo peer)) self
974      (deactivate-hemlock-view echo))
975    (#/setEditable: self t)
976    (#/makeFirstResponder: the-hemlock-frame self)))
977
978(defmethod deactivate-hemlock-view ((self hemlock-textstorage-text-view))
979  (assume-cocoa-thread)
980  #+debug (log-debug "deactivating ~s" self)
981  (assume-not-editing self)
982  (#/setSelectable: self nil)
983  (disable-paren-highlight self))
984
985
986
987     
988
989(defmethod eventqueue-abort-pending-p ((self hemlock-textstorage-text-view))
990  ;; Return true if cmd-. is in the queue.  Not sure what to do about c-g:
991  ;; would have to distinguish c-g from c-q c-g or c-q c-q c-g etc.... Maybe
992  ;; c-g will need to be synchronous meaning just end current command,
993  ;; while cmd-. is the real abort.
994  #|
995   (let* ((now (#/dateWithTimeIntervalSinceNow: ns:ns-date 0.0d0)))
996    (loop (let* ((event (#/nextEventMatchingMask:untilDate:inMode:dequeue:
997                         target (logior #$whatever) now #&NSDefaultRunLoopMode t)))
998            (when (%null-ptr-p event) (return)))))
999  "target" can either be an NSWindow or the global shared application object;
1000  |#
1001  nil)
1002
1003(defvar *buffer-being-edited* nil)
1004
1005#-darwin-target
1006(objc:defmethod (#/hasMarkedText #>BOOL) ((self hemlock-textstorage-text-view))
1007  nil)
1008
1009(objc:defmethod (#/keyDown: :void) ((self hemlock-textstorage-text-view) event)
1010  #+debug (#_NSLog #@"Key down event in %@  = %@" :id self :address event)
1011  (let* ((view (hemlock-view self))
1012         ;; quote-p means handle characters natively
1013         (quote-p (and view (hi::hemlock-view-quote-next-p view))))
1014    #+debug (log-debug "~&quote-p ~s event ~s" quote-p event)
1015    (cond ((or (null view) (#/hasMarkedText self) (eq quote-p :native))
1016           (when (and quote-p (not (eq quote-p :native)))       ;; see ticket:461
1017             (setf (hi::hemlock-view-quote-next-p view) nil))
1018           (call-next-method event))
1019          ((not (eventqueue-abort-pending-p self))
1020           (let ((hemlock-key (nsevent-to-key-event event quote-p)))
1021             (if (and hemlock-key
1022                      (not (hi:native-key-event-p hemlock-key)))
1023               (progn
1024                 (#/setHiddenUntilMouseMoves: ns:ns-cursor t)
1025                 (hi::handle-hemlock-event view hemlock-key))
1026               (call-next-method event)))))))
1027
1028(defmethod hi::handle-hemlock-event :around ((view hi:hemlock-view) event)
1029  (declare (ignore event))
1030  (with-autorelease-pool
1031   (call-next-method)))
1032
1033(defconstant +shift-event-mask+ (hi:key-event-modifier-mask "Shift"))
1034
1035;;; Translate a keyDown NSEvent to a Hemlock key-event.
1036(defun nsevent-to-key-event (event quote-p)
1037  (let* ((modifiers (#/modifierFlags event)))
1038    (unless (logtest #$NSCommandKeyMask modifiers)
1039      (let* ((native-chars (#/characters event))
1040             (native-len (if (%null-ptr-p native-chars)
1041                           0
1042                           (#/length native-chars)))
1043             (native-c (and (eql 1 native-len)
1044                            (#/characterAtIndex: native-chars 0)))
1045             (option-p (logtest #$NSAlternateKeyMask modifiers)))
1046        ;; If a standalone dead key (e.g. ^'` on a French keyboard,) was pressed,
1047        ;; reverse the meaning of quote-p, i.e. use the system meaning if NOT quoted.
1048        ;; (I have no idea what makes standalone dead keys somehow different from
1049        ;; non-standalone dead keys).
1050        (when (and (not option-p) (eql 0 native-len))
1051          (setq quote-p (not quote-p)))
1052        (let ((c (if (or quote-p
1053                         (and option-p
1054                              (or (not *option-is-meta*)
1055                                  #-cocotron
1056                                  (and native-c
1057                                       (ccl::valid-char-code-p native-c)
1058                                       (standard-char-p (code-char (the ccl::valid-char-code native-c)))))
1059                              (setq quote-p t)))
1060                   native-c
1061                   (let ((chars (#/charactersIgnoringModifiers event)))
1062                     (and (not (%null-ptr-p chars))
1063                          (eql 1 (#/length chars))
1064                          (#/characterAtIndex: chars 0))))))
1065          (when c
1066            (let ((bits 0)
1067                  (useful-modifiers (logandc2 modifiers
1068                                              (logior
1069                                               ;;#$NSShiftKeyMask
1070                                               #$NSAlphaShiftKeyMask))))
1071              (unless quote-p
1072                (dolist (map hi:*modifier-translations*)
1073                  (when (logtest useful-modifiers (car map))
1074                    (setq bits (logior bits
1075                                       (hi:key-event-modifier-mask (cdr map)))))))
1076              (let* ((char (code-char c)))
1077                (when (and char (alpha-char-p char))
1078                  (setq bits (logandc2 bits +shift-event-mask+)))
1079                (when (logtest #$NSAlphaShiftKeyMask modifiers)
1080                  (setf c (char-code (char-upcase char)))))
1081              (hi:make-key-event c bits))))))))
1082
1083;; For now, this is only used to abort i-search.  All actual mouse handling is done
1084;; by Cocoa.   In the future might want to allow users to extend via hemlock, e.g.
1085;; to implement mouse-copy.
1086;; Also -- shouldn't this happen on mouse up?
1087(objc:defmethod (#/mouseDown: :void) ((self hemlock-textstorage-text-view) event)
1088  ;; If no modifier keys are pressed, send hemlock a no-op.
1089  ;; (Or almost a no-op - this does an update-hemlock-selection as a side-effect)
1090  (unless (logtest #$NSDeviceIndependentModifierFlagsMask (#/modifierFlags event))
1091    (let* ((view (hemlock-view self)))
1092      (when view
1093        (unless (eventqueue-abort-pending-p self)
1094          (hi::handle-hemlock-event view #k"leftdown")))))
1095  (call-next-method event))
1096
1097(defmethod assume-not-editing ((tv hemlock-textstorage-text-view))
1098  (assume-not-editing (#/textStorage tv)))
1099
1100(objc:defmethod (#/changeColor: :void) ((self hemlock-textstorage-text-view)
1101                                        sender)
1102  (declare (ignorable sender))
1103  #+debug (#_NSLog #@"Change color to = %@" :id (#/color sender)))
1104
1105(def-cocoa-default *layout-text-in-background* :bool t "When true, do text layout when idle.")
1106
1107(objc:defmethod (#/layoutManager:didCompleteLayoutForTextContainer:atEnd: :void)
1108    ((self hemlock-textstorage-text-view) layout cont (flag :<BOOL>))
1109  (declare (ignorable cont flag))
1110  #+debug (#_NSLog #@"layout complete: container = %@, atend = %d" :id cont :int (if flag 1 0))
1111  (unless *layout-text-in-background*
1112    (#/setDelegate: layout +null-ptr+)
1113    (#/setBackgroundLayoutEnabled: layout nil)))
1114
1115(defloadvar *paren-highlight-background-color* ())
1116
1117(defun paren-highlight-background-color ()
1118  (or *paren-highlight-background-color*
1119      (setq *paren-highlight-background-color*
1120            (#/retain (#/colorWithCalibratedRed:green:blue:alpha:
1121                       ns:ns-color
1122                       .3
1123                       .875
1124                       .8125
1125                       1.0)))))
1126                                                       
1127
1128
1129(defmethod remove-paren-highlight ((self hemlock-textstorage-text-view))
1130  #-cocotron
1131  (let* ((left (text-view-paren-highlight-left-pos self))
1132         (right (text-view-paren-highlight-right-pos self)))
1133    (ns:with-ns-range  (char-range left 1)
1134      (let* ((layout (#/layoutManager self)))
1135        (#/removeTemporaryAttribute:forCharacterRange: 
1136         layout #&NSBackgroundColorAttributeName 
1137         char-range)
1138        (setf (pref char-range #>NSRange.location) right)
1139        (#/removeTemporaryAttribute:forCharacterRange: 
1140         layout #&NSBackgroundColorAttributeName 
1141         char-range)))))
1142
1143(defmethod disable-paren-highlight ((self hemlock-textstorage-text-view))
1144  (when (eql (text-view-paren-highlight-enabled self) #$YES)
1145    (setf (text-view-paren-highlight-enabled self) #$NO)
1146    (remove-paren-highlight self)))
1147
1148
1149(defmethod compute-temporary-attributes ((self hemlock-textstorage-text-view))
1150  #-cocotron
1151  (let* ((container (#/textContainer self))
1152         ;; If there's a containing scroll view, use its contentview         
1153         ;; Otherwise, just use the current view.
1154         (scrollview (#/enclosingScrollView self))
1155         (contentview (if (%null-ptr-p scrollview) self (#/contentView scrollview)))
1156         (rect (#/bounds contentview))
1157         (layout (#/layoutManager container))
1158         (glyph-range (#/glyphRangeForBoundingRect:inTextContainer:
1159                       layout rect container))
1160         (char-range (#/characterRangeForGlyphRange:actualGlyphRange:
1161                      layout glyph-range +null-ptr+))
1162         (start (ns:ns-range-location char-range))
1163         (length (ns:ns-range-length char-range)))
1164    (when (> length 0)
1165      ;; Remove all temporary attributes from the character range
1166      (#/removeTemporaryAttribute:forCharacterRange:
1167       layout #&NSForegroundColorAttributeName char-range)
1168      (#/removeTemporaryAttribute:forCharacterRange:
1169       layout #&NSBackgroundColorAttributeName char-range)
1170      (let* ((ts (#/textStorage self))
1171             (cache (hemlock-buffer-string-cache (slot-value ts 'hemlock-string)))
1172             (hi::*current-buffer* (buffer-cache-buffer cache)))
1173        (multiple-value-bind (start-line start-offset)
1174                             (update-line-cache-for-index cache start)
1175          (let* ((end-line (update-line-cache-for-index cache (+ start length))))
1176            (set-temporary-character-attributes
1177             layout
1178             (- start start-offset)
1179             start-line
1180             (hi::line-next end-line))))))
1181    (when (eql #$YES (text-view-paren-highlight-enabled self))
1182      (let* ((background #&NSBackgroundColorAttributeName)
1183             (paren-highlight-left (text-view-paren-highlight-left-pos self))
1184             (paren-highlight-right (text-view-paren-highlight-right-pos self))
1185             (paren-highlight-color (text-view-paren-highlight-color self))
1186             (attrs (#/dictionaryWithObject:forKey: ns:ns-dictionary
1187                                                    paren-highlight-color
1188                                                    background)))
1189        (#/addTemporaryAttributes:forCharacterRange:
1190         layout attrs (ns:make-ns-range paren-highlight-left 1))
1191        (#/addTemporaryAttributes:forCharacterRange:
1192         layout attrs (ns:make-ns-range paren-highlight-right 1))))))
1193
1194(defmethod update-paren-highlight ((self hemlock-textstorage-text-view))
1195  (disable-paren-highlight self)
1196  (let* ((buffer (hemlock-buffer self)))
1197    (when (and buffer (string= (hi::buffer-major-mode buffer) "Lisp"))
1198      (let* ((hi::*current-buffer* buffer)
1199             (point (hi::buffer-point buffer)))
1200        #+debug (#_NSLog #@"Syntax check for paren-highlighting")
1201        (update-buffer-package (hi::buffer-document buffer) buffer)
1202        (cond ((eql (hi::next-character point) #\()
1203               (hemlock::pre-command-parse-check point)
1204               (when (hemlock::valid-spot point t)
1205                 (hi::with-mark ((temp point))
1206                   (when (hemlock::list-offset temp 1)
1207                     #+debug (#_NSLog #@"enable paren-highlight, forward")
1208                     (setf (text-view-paren-highlight-right-pos self)
1209                           (1- (hi:mark-absolute-position temp))
1210                           (text-view-paren-highlight-left-pos self)
1211                           (hi::mark-absolute-position point)
1212                           (text-view-paren-highlight-enabled self) #$YES)))))
1213              ((eql (hi::previous-character point) #\))
1214               (hemlock::pre-command-parse-check point)
1215               (when (hemlock::valid-spot point nil)
1216                 (hi::with-mark ((temp point))
1217                   (when (hemlock::list-offset temp -1)
1218                     #+debug (#_NSLog #@"enable paren-highlight, backward")
1219                     (setf (text-view-paren-highlight-left-pos self)
1220                           (hi:mark-absolute-position temp)
1221                           (text-view-paren-highlight-right-pos self)
1222                           (1- (hi:mark-absolute-position point))
1223                           (text-view-paren-highlight-enabled self) #$YES))))))
1224        (compute-temporary-attributes self)))))
1225
1226
1227
1228;;; Set and display the selection at pos, whose length is len and whose
1229;;; affinity is affinity.  This should never be called from any Cocoa
1230;;; event handler; it should not call anything that'll try to set the
1231;;; underlying buffer's point and/or mark
1232
1233(objc:defmethod (#/updateSelection:length:affinity: :void)
1234    ((self hemlock-textstorage-text-view)
1235     (pos :int)
1236     (length :int)
1237     (affinity :<NSS>election<A>ffinity))
1238  (assume-cocoa-thread)
1239  (when (eql length 0)
1240    (update-paren-highlight self))
1241  (let* ((buffer (hemlock-buffer self)))
1242    (setf (hi::buffer-selection-set-by-command buffer) (> length 0)))
1243  (rlet ((range :ns-range :location pos :length length))
1244    (ccl::%call-next-objc-method self
1245                                 hemlock-textstorage-text-view
1246                                 (@selector #/setSelectedRange:affinity:stillSelecting:)
1247                                 '(:void :<NSR>ange :<NSS>election<A>ffinity :<BOOL>)
1248                                 range
1249                                 affinity
1250                                 nil)
1251    (assume-not-editing self)
1252    (when (> length 0)
1253      (let* ((ts (#/textStorage self)))
1254        (with-slots (selection-set-by-search) ts
1255          (when (prog1 (eql #$YES selection-set-by-search)
1256                  (setq selection-set-by-search #$NO))
1257            (highlight-search-selection self pos length)))))
1258    ))
1259
1260(defloadvar *can-use-show-find-indicator-for-range*
1261    (#/instancesRespondToSelector: ns:ns-text-view (@selector "showFindIndicatorForRange:")))
1262
1263;;; Add transient highlighting to a selection established via a search
1264;;; primitive, if the OS supports it.
1265(defun highlight-search-selection (tv pos length)
1266  (when *can-use-show-find-indicator-for-range*
1267    (ns:with-ns-range (r pos length)
1268      (objc-message-send tv "showFindIndicatorForRange:" :<NSR>ange r :void))))
1269 
1270;;; A specialized NSTextView. The NSTextView is part of the "pane"
1271;;; object that displays buffers.
1272(defclass hemlock-text-view (hemlock-textstorage-text-view)
1273    ((pane :foreign-type :id :accessor text-view-pane)
1274     (char-width :foreign-type :<CGF>loat :accessor text-view-char-width)
1275     (line-height :foreign-type :<CGF>loat :accessor text-view-line-height))
1276  (:metaclass ns:+ns-object))
1277(declaim (special hemlock-text-view))
1278
1279
1280(defloadvar *lisp-string-color* (#/blueColor ns:ns-color))
1281(defloadvar *lisp-comment-color* (#/brownColor ns:ns-color))
1282
1283;;; LAYOUT is an NSLayoutManager in which we'll set temporary character
1284;;; attrubutes before redisplay.
1285;;; POS is the absolute character position of the start of START-LINE.
1286;;; END-LINE is either EQ to START-LNE (in the degenerate case) or
1287;;; follows it in the buffer; it may be NIL and is the exclusive
1288;;; end of a range of lines
1289;;; HI::*CURRENT-BUFFER* is bound to the buffer containing START-LINE
1290;;; and END-LINE
1291(defun set-temporary-character-attributes (layout pos start-line end-line)
1292  (ns:with-ns-range (range)
1293    (let* ((color-attribute #&NSForegroundColorAttributeName)
1294           (string-color  *lisp-string-color* )
1295           (comment-color *lisp-comment-color*))
1296      (hi::with-mark ((m (hi::buffer-start-mark hi::*current-buffer*)))
1297        (hi::line-start m start-line)
1298        (hi::pre-command-parse-check m))
1299      (do ((p pos (+ p (1+ (hi::line-length line))))
1300           (line start-line (hi::line-next line)))
1301          ((eq line end-line))
1302        (let* ((parse-info (getf (hi::line-plist line) 'hemlock::lisp-info))
1303               (last-end 0))
1304          (when parse-info
1305            (dolist (r (hemlock::lisp-info-ranges-to-ignore parse-info))
1306              (destructuring-bind (istart . iend) r
1307                (let* ((attr (if (= istart 0)
1308                               (hemlock::lisp-info-begins-quoted parse-info)
1309                               (if (< last-end istart)
1310                                 (hi:character-attribute :lisp-syntax
1311                                                         (hi::line-character line (1- istart)))
1312                                 :comment)))
1313                       (type (case attr
1314                               ((:char-quote :symbol-quote) nil)
1315                               (:string-quote :string)
1316                               (t :comment)))
1317                       (start (+ p istart))
1318                       (len (- iend istart)))
1319                  (when type
1320                    (when (eq type :string)
1321                      (decf start)
1322                      (incf len 2))
1323                    (setf (ns:ns-range-location range) start
1324                          (ns:ns-range-length range) len)
1325                    (let ((attrs (#/dictionaryWithObject:forKey:
1326                                  ns:ns-dictionary
1327                                  (if (eq type :string) string-color comment-color)
1328                                  color-attribute)))
1329                      (#/addTemporaryAttributes:forCharacterRange:
1330                       layout attrs range)))
1331                  (setq last-end iend))))))))))
1332
1333#+no
1334(objc:defmethod (#/drawRect: :void) ((self hemlock-text-view) (rect :<NSR>ect))
1335  ;; Um, don't forget to actually draw the view..
1336  (call-next-method  rect))
1337
1338
1339(defmethod hemlock-view ((self hemlock-text-view))
1340  (let ((pane (text-view-pane self)))
1341    (when pane (hemlock-view pane))))
1342
1343
1344
1345(objc:defmethod (#/evalSelection: :void) ((self hemlock-text-view) sender)
1346  (declare (ignore sender))
1347  ;; TODO: this should just invoke editor-evaluate-region-command instead of reinventing the wheel.
1348  (let* ((buffer (hemlock-buffer self))
1349         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer))
1350         (pathname (hi::buffer-pathname buffer))
1351         ;; Cocotron issue 380: NSTextView doesn't implement #/selectedRanges and
1352         ;;  #/setSelectedRanges: methods.
1353         #-cocotron (ranges (#/selectedRanges self))
1354         #+cocotron (ranges (#/arrayWithObject: ns:ns-array 
1355                                                (#/valueWithRange: ns:ns-value
1356                                                                   (#/selectedRange self))))
1357         (text (#/string self)))
1358    (dotimes (i (#/count ranges))
1359      (let* ((r (#/rangeValue (#/objectAtIndex: ranges i)))
1360             (s (#/substringWithRange: text r))
1361             (o (ns:ns-range-location r)))
1362        (setq s (lisp-string-from-nsstring s))
1363        (ui-object-eval-selection *NSApp* (list package-name pathname s o))))))
1364
1365(objc:defmethod (#/evalAll: :void) ((self hemlock-text-view) sender)
1366  (declare (ignore sender))
1367  (let* ((buffer (hemlock-buffer self))
1368         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1369         (pathname (hi::buffer-pathname buffer))
1370         (s (lisp-string-from-nsstring (#/string self))))
1371    (ui-object-eval-selection *NSApp* (list package-name pathname s))))
1372
1373(objc:defmethod (#/loadBuffer: :void) ((self hemlock-text-view) sender)
1374  (declare (ignore sender))
1375  (let* ((buffer (hemlock-buffer self))
1376         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1377         (pathname (hi::buffer-pathname buffer)))
1378    (ui-object-load-buffer *NSApp* (list package-name pathname))))
1379
1380(objc:defmethod (#/compileBuffer: :void) ((self hemlock-text-view) sender)
1381  (declare (ignore sender))
1382  (let* ((buffer (hemlock-buffer self))
1383         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1384         (pathname (hi::buffer-pathname buffer)))
1385    (ui-object-compile-buffer *NSApp* (list package-name pathname))))
1386
1387(objc:defmethod (#/compileAndLoadBuffer: :void) ((self hemlock-text-view) sender)
1388  (declare (ignore sender))
1389  (let* ((buffer (hemlock-buffer self))
1390         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1391         (pathname (hi::buffer-pathname buffer)))
1392    (ui-object-compile-and-load-buffer *NSApp* (list package-name pathname))))
1393
1394(defloadvar *text-view-context-menu* ())
1395
1396(defun text-view-context-menu ()
1397  (or *text-view-context-menu*
1398      (setq *text-view-context-menu*
1399            (#/retain
1400             (let* ((menu (make-instance 'ns:ns-menu :with-title #@"Menu")))
1401               (#/addItemWithTitle:action:keyEquivalent:
1402                menu #@"Cut" (@selector #/cut:) #@"")
1403               (#/addItemWithTitle:action:keyEquivalent:
1404                menu #@"Copy" (@selector #/copy:) #@"")
1405               (#/addItemWithTitle:action:keyEquivalent:
1406                menu #@"Paste" (@selector #/paste:) #@"")
1407               ;; Separator
1408               (#/addItem: menu (#/separatorItem ns:ns-menu-item))
1409               (#/addItemWithTitle:action:keyEquivalent:
1410                menu #@"Background Color ..." (@selector #/changeBackgroundColor:) #@"")
1411               (#/addItemWithTitle:action:keyEquivalent:
1412                menu #@"Text Color ..." (@selector #/changeTextColor:) #@"")
1413
1414               menu)))))
1415
1416
1417
1418
1419
1420(objc:defmethod (#/changeBackgroundColor: :void)
1421    ((self hemlock-text-view) sender)
1422  (let* ((colorpanel (#/sharedColorPanel ns:ns-color-panel))
1423         (color (#/backgroundColor self)))
1424    (#/close colorpanel)
1425    (#/setAction: colorpanel (@selector #/updateBackgroundColor:))
1426    (#/setColor: colorpanel color)
1427    (#/setTarget: colorpanel self)
1428    (#/setContinuous: colorpanel nil)
1429    (#/orderFrontColorPanel: *NSApp* sender)))
1430
1431
1432
1433(objc:defmethod (#/updateBackgroundColor: :void)
1434    ((self hemlock-text-view) sender)
1435  (when (#/isVisible sender)
1436    (let* ((color (#/color sender)))
1437      (unless (typep self 'echo-area-view)
1438        (let* ((window (#/window self))
1439               (echo-view (unless (%null-ptr-p window)
1440                            (slot-value window 'echo-area-view))))
1441          (when echo-view (#/setBackgroundColor: echo-view color))))
1442      #+debug (#_NSLog #@"Updating backgroundColor to %@, sender = %@" :id color :id sender)
1443      (#/setBackgroundColor: self color))))
1444
1445(objc:defmethod (#/changeTextColor: :void)
1446    ((self hemlock-text-view) sender)
1447  (let* ((colorpanel (#/sharedColorPanel ns:ns-color-panel))
1448         (textstorage (#/textStorage self))
1449         (color (#/objectForKey:
1450                 (#/objectAtIndex: (slot-value textstorage 'styles) 0)
1451                 #&NSForegroundColorAttributeName)))
1452    (#/close colorpanel)
1453    (#/setAction: colorpanel (@selector #/updateTextColor:))
1454    (#/setColor: colorpanel color)
1455    (#/setTarget: colorpanel self)
1456    (#/setContinuous: colorpanel nil)
1457    (#/orderFrontColorPanel: *NSApp* sender)))
1458
1459
1460
1461
1462
1463
1464   
1465(objc:defmethod (#/updateTextColor: :void)
1466    ((self hemlock-textstorage-text-view) sender)
1467  (unwind-protect
1468      (progn
1469        (#/setUsesFontPanel: self t)
1470        (ccl::%call-next-objc-method
1471         self
1472         hemlock-textstorage-text-view
1473         (@selector #/changeColor:)
1474         '(:void :id)
1475         sender))
1476    (#/setUsesFontPanel: self nil))
1477  (#/setNeedsDisplay: self t))
1478   
1479(objc:defmethod (#/updateTextColor: :void)
1480    ((self hemlock-text-view) sender)
1481  (let* ((textstorage (#/textStorage self))
1482         (styles (slot-value textstorage 'styles))
1483         (newcolor (#/color sender)))
1484    (dotimes (i (#/count styles))
1485      (let* ((dict (#/objectAtIndex: styles i)))
1486        (#/setValue:forKey: dict newcolor #&NSForegroundColorAttributeName)))
1487    (call-next-method sender)))
1488
1489
1490
1491(defmethod text-view-string-cache ((self hemlock-textstorage-text-view))
1492  (hemlock-buffer-string-cache (#/hemlockString (#/textStorage self))))
1493
1494#-cocotron                             ; for now, small struct return FFI issue
1495
1496(objc:defmethod (#/selectionRangeForProposedRange:granularity: :ns-range)
1497    ((self hemlock-textstorage-text-view)
1498     (proposed :ns-range)
1499     (g :<NSS>election<G>ranularity))
1500  #+debug
1501  (#_NSLog #@"Granularity = %d" :int g)
1502  (objc:returning-foreign-struct (r)
1503     (block HANDLED
1504       (let* ((index (ns:ns-range-location proposed)) 
1505              (length (ns:ns-range-length proposed))
1506              (textstorage (#/textStorage self)))
1507         (when (and (eql 0 length)      ; not extending existing selection
1508                    (or (not (eql g #$NSSelectByCharacter))
1509                        (and (eql index (#/length textstorage))
1510                             (let* ((event (#/currentEvent (#/window self))))
1511                               (and (eql (#/type event) #$NSLeftMouseDown)
1512                                    (> (#/clickCount event) 1))))))
1513           (let* ((cache (hemlock-buffer-string-cache (#/hemlockString textstorage)))
1514                  (buffer (buffer-cache-buffer cache))
1515                  (hi::*current-buffer* buffer)
1516                  (point (hi::buffer-point buffer))
1517                  (atom-mode (or (eql g #$NSSelectByParagraph)
1518                                 (and (eql index (#/length textstorage))
1519                                      (let* ((event (#/currentEvent (#/window self))))
1520                                        (and (eql (#/type event) #$NSLeftMouseDown)
1521                                             (> (#/clickCount event) 2)))))))
1522             (hi::with-mark ((mark point))
1523               (let ((region (selection-for-click mark atom-mode)))
1524                 (when region
1525                   ;; Act as if we started the selection at the other end, so the heuristic
1526                   ;; in #/selectionRangeForProposedRange does the right thing.  ref bug #565.
1527                   (cond ((hi::mark= (hi::region-start region) mark)
1528                          (hi::move-mark point (hi::region-end region)))
1529                         ((hi::mark= (hi::region-end region) mark)
1530                          (hi::move-mark point (hi::region-start region))))
1531                   (let ((start (hi::mark-absolute-position (hi::region-start region)))
1532                         (end (hi::mark-absolute-position (hi::region-end region))))
1533                     (assert (<= start end))
1534                     (ns:init-ns-range r start (- end start)))
1535                   #+debug
1536                   (#_NSLog #@"range = %@, proposed = %@, granularity = %d"
1537                            :address (#_NSStringFromRange r)
1538                            :address (#_NSStringFromRange proposed)
1539                            :<NSS>election<G>ranularity g)
1540                   (return-from HANDLED r)))))))
1541       (prog1
1542           (call-next-method proposed g)
1543         #+debug
1544         (#_NSLog #@"range = %@, proposed = %@, granularity = %d"
1545                  :address (#_NSStringFromRange r)
1546                  :address (#_NSStringFromRange proposed)
1547                  :<NSS>election<G>ranularity g)))))
1548
1549;; Return nil to use the default Cocoa selection, which will be word for double-click, line for triple.
1550(defun selection-for-click (mark paragraph-mode-p)
1551  (unless paragraph-mode-p
1552    ;; Select a word if near one
1553    (hi::with-mark ((fwd mark)
1554                    (bwd mark))
1555      (or (hi::find-attribute fwd :word-delimiter)
1556          (hi::buffer-end fwd))
1557      (or (hi::reverse-find-attribute bwd :word-delimiter)
1558          (hi::buffer-start bwd))
1559      (unless (hi::mark= bwd fwd)
1560        (return-from selection-for-click (hi::region bwd fwd)))))
1561  (when (string= (hi::buffer-major-mode (hi::mark-buffer mark)) "Lisp") ;; gag
1562    (hemlock::pre-command-parse-check mark)
1563    (hemlock::form-region-at-mark mark)))
1564
1565(defun append-output (view string)
1566  (assume-cocoa-thread)
1567  ;; Arrange to do the append in command context
1568  (when view
1569    (hi::handle-hemlock-event view #'(lambda ()
1570                                       (hemlock::append-buffer-output (hi::hemlock-view-buffer view) string)))))
1571
1572
1573;;; Update the underlying buffer's point (and "active region", if appropriate.
1574;;; This is called in response to a mouse click or other event; it shouldn't
1575;;; be called from the Hemlock side of things.
1576
1577(objc:defmethod (#/setSelectedRange:affinity:stillSelecting: :void)
1578    ((self hemlock-text-view)
1579     (r :<NSR>ange)
1580     (affinity :<NSS>election<A>ffinity)
1581     (still-selecting :<BOOL>))
1582  #+debug
1583  (#_NSLog #@"Set selected range called: range = %@, affinity = %d, still-selecting = %d"
1584           :address (#_NSStringFromRange r)
1585           :<NSS>election<A>ffinity affinity
1586           :<BOOL> (if still-selecting #$YES #$NO))
1587  #+debug
1588  (#_NSLog #@"text view string = %@, textstorage string = %@"
1589           :id (#/string self)
1590           :id (#/string (#/textStorage self)))
1591  (unless (#/editingInProgress (#/textStorage self))
1592    (let* ((d (hemlock-buffer-string-cache (#/hemlockString (#/textStorage self))))
1593           (buffer (buffer-cache-buffer d))
1594           (hi::*current-buffer* buffer)
1595           (point (hi::buffer-point buffer))
1596           (location (pref r :<NSR>ange.location))
1597           (len (pref r :<NSR>ange.length)))
1598      (setf (hi::buffer-selection-set-by-command buffer) nil)
1599      (cond ((eql len 0)
1600             #+debug
1601             (#_NSLog #@"Moving point to absolute position %d" :int location)
1602             (setf (hi::buffer-region-active buffer) nil)
1603             (move-hemlock-mark-to-absolute-position point d location)
1604             (update-paren-highlight self))
1605            (t
1606             ;; We don't get much information about which end of the
1607             ;; selection the mark's at and which end point is at, so
1608             ;; we have to sort of guess.  In every case I've ever seen,
1609             ;; selection via the mouse generates a sequence of calls to
1610             ;; this method whose parameters look like:
1611             ;; a: range: {n0,0} still-selecting: false  [ rarely repeats ]
1612             ;; b: range: {n0,0) still-selecting: true   [ rarely repeats ]
1613             ;; c: range: {n1,m} still-selecting: true   [ often repeats ]
1614             ;; d: range: {n1,m} still-selecting: false  [ rarely repeats ]
1615             ;;
1616             ;; (Sadly, "affinity" doesn't tell us anything interesting.)
1617             ;; We've handled a and b in the clause above; after handling
1618             ;; b, point references buffer position n0 and the
1619             ;; region is inactive.
1620             ;; Let's ignore c, and wait until the selection's stabilized.
1621             ;; Make a new mark, a copy of point (position n0).
1622             ;; At step d (here), we should have either
1623             ;; d1) n1=n0.  Mark stays at n0, point moves to n0+m.
1624             ;; d2) n1+m=n0.  Mark stays at n0, point moves to n0-m.
1625             ;; If neither d1 nor d2 apply, arbitrarily assume forward
1626             ;; selection: mark at n1, point at n1+m.
1627             ;; In all cases, activate Hemlock selection.
1628             (unless still-selecting
1629                (let* ((pointpos (hi:mark-absolute-position point))
1630                       (selection-end (+ location len))
1631                       (mark (hi::copy-mark point :right-inserting)))
1632                   (cond ((eql pointpos location)
1633                          (move-hemlock-mark-to-absolute-position point
1634                                                                  d
1635                                                                  selection-end))
1636                         ((eql pointpos selection-end)
1637                          (move-hemlock-mark-to-absolute-position point
1638                                                                  d
1639                                                                  location))
1640                         (t
1641                          (move-hemlock-mark-to-absolute-position mark
1642                                                                  d
1643                                                                  location)
1644                          (move-hemlock-mark-to-absolute-position point
1645                                                                  d
1646                                                                  selection-end)))
1647                   (hemlock::%buffer-push-buffer-mark buffer mark t)))))))
1648  (call-next-method r affinity still-selecting))
1649
1650
1651
1652;;; Modeline-view
1653
1654(defclass modeline-view (ns:ns-view)
1655    ((pane :foreign-type :id :accessor modeline-view-pane)
1656     (text-attributes :foreign-type :id :accessor modeline-text-attributes))
1657  (:metaclass ns:+ns-object))
1658
1659(objc:defmethod #/initWithFrame: ((self modeline-view) (frame :<NSR>ect))
1660  (call-next-method frame)
1661  (let* ((size (#/smallSystemFontSize ns:ns-font))
1662         (font (#/systemFontOfSize: ns:ns-font size))
1663         (dict (#/dictionaryWithObject:forKey: ns:ns-dictionary font #&NSFontAttributeName)))
1664    (setf (modeline-text-attributes self) (#/retain dict)))
1665  self)
1666
1667;;; Find the underlying buffer.
1668(defun buffer-for-modeline-view (mv)
1669  (let* ((pane (modeline-view-pane mv)))
1670    (unless (%null-ptr-p pane)
1671      (let* ((tv (text-pane-text-view pane)))
1672        (unless (%null-ptr-p tv)
1673          (hemlock-buffer tv))))))
1674
1675;;; Draw a string in the modeline view.  The font and other attributes
1676;;; are initialized lazily; apparently, calling the Font Manager too
1677;;; early in the loading sequence confuses some Carbon libraries that're
1678;;; used in the event dispatch mechanism,
1679(defun draw-modeline-string (the-modeline-view)
1680  (with-slots (text-attributes) the-modeline-view
1681    (let* ((buffer (buffer-for-modeline-view the-modeline-view)))
1682      (when buffer
1683        (let* ((string
1684                (apply #'concatenate 'string
1685                       (mapcar
1686                        #'(lambda (field)
1687                            (or (ignore-errors 
1688                                  (funcall (hi::modeline-field-function field) buffer))
1689                                ""))
1690                        (hi::buffer-modeline-fields buffer)))))
1691          (#/drawAtPoint:withAttributes: (#/autorelease (%make-nsstring string))
1692                                         (ns:make-ns-point 5 1)
1693                                         text-attributes))))))
1694
1695(objc:defmethod (#/drawRect: :void) ((self modeline-view) (rect :<NSR>ect))
1696  (declare (ignorable rect))
1697  (let* ((bounds (#/bounds self))
1698         (context (#/currentContext ns:ns-graphics-context)))
1699    (#/saveGraphicsState context)
1700    (#/set (#/colorWithCalibratedWhite:alpha: ns:ns-color 0.9 1.0))
1701    (#_NSRectFill bounds)
1702    (#/set (#/colorWithCalibratedWhite:alpha: ns:ns-color 0.3333 1.0))
1703    ;; Draw borders on top and bottom.
1704    (ns:with-ns-rect (r 0 0.5 (ns:ns-rect-width bounds) 0.5)
1705      (#_NSRectFill r))
1706    (ns:with-ns-rect (r 0 (- (ns:ns-rect-height bounds) 0.5)
1707                        (ns:ns-rect-width bounds) (- (ns:ns-rect-height bounds) 0.5))
1708      (#_NSRectFill r))
1709    (draw-modeline-string self)
1710    (#/restoreGraphicsState context)))
1711
1712;;; Hook things up so that the modeline is updated whenever certain buffer
1713;;; attributes change.
1714(hi::%init-mode-redisplay)
1715
1716
1717;;; A clip view subclass, which exists mostly so that we can track origin changes.
1718(defclass text-pane-clip-view (ns:ns-clip-view)
1719  ()
1720  (:metaclass ns:+ns-object))
1721
1722(objc:defmethod (#/scrollToPoint: :void) ((self text-pane-clip-view)
1723                                           (origin #>NSPoint))
1724  (unless (#/inLiveResize self)
1725    (call-next-method origin)
1726    (compute-temporary-attributes (#/documentView self))))
1727
1728;;; Text-pane
1729
1730;;; The text pane is just an NSBox that (a) provides a draggable border
1731;;; around (b) encapsulates the text view and the mode line.
1732
1733(defclass text-pane (ns:ns-box)
1734    ((hemlock-view :initform nil :reader text-pane-hemlock-view)
1735     (text-view :foreign-type :id :accessor text-pane-text-view)
1736     (mode-line :foreign-type :id :accessor text-pane-mode-line)
1737     (scroll-view :foreign-type :id :accessor text-pane-scroll-view))
1738  (:metaclass ns:+ns-object))
1739
1740(defmethod hemlock-view ((self text-pane))
1741  (text-pane-hemlock-view self))
1742
1743;;; This method gets invoked on the text pane, which is its containing
1744;;; window's delegate object.
1745(objc:defmethod (#/windowDidResignKey: :void)
1746    ((self text-pane) notification)
1747  (declare (ignorable notification))
1748  ;; When the window loses focus, we should remove or change transient
1749  ;; highlighting (like matching-paren highlighting).  Maybe make this
1750  ;; more general ...
1751  ;; Currently, this only removes temporary attributes from matching
1752  ;; parens; other kinds of syntax highlighting stays visible when
1753  ;; the containing window loses keyboard focus
1754  (let* ((tv (text-pane-text-view self)))
1755    (remove-paren-highlight tv)
1756    (remove-paren-highlight (slot-value tv 'peer))))
1757
1758;;; Likewise, reactivate transient highlighting when the window gets
1759;;; focus.
1760(objc:defmethod (#/windowDidBecomeKey: :void)
1761    ((self text-pane) notification)
1762  (declare (ignorable notification))
1763  (let* ((tv (text-pane-text-view self)))
1764    (compute-temporary-attributes tv)
1765    (compute-temporary-attributes (slot-value tv 'peer))))
1766 
1767
1768;;; Mark the buffer's modeline as needing display.  This is called whenever
1769;;; "interesting" attributes of a buffer are changed.
1770(defun hemlock-ext:invalidate-modeline (buffer)
1771  (let* ((doc (hi::buffer-document buffer)))
1772    (when doc
1773      (document-invalidate-modeline doc))))
1774
1775(def-cocoa-default *text-pane-margin-width* :float 0.0f0 "width of indented margin around text pane")
1776(def-cocoa-default *text-pane-margin-height* :float 0.0f0 "height of indented margin around text pane")
1777
1778
1779(objc:defmethod #/initWithFrame: ((self text-pane) (frame :<NSR>ect))
1780  (let* ((pane (call-next-method frame)))
1781    (unless (%null-ptr-p pane)
1782      (#/setAutoresizingMask: pane (logior
1783                                    #$NSViewWidthSizable
1784                                    #$NSViewHeightSizable))
1785      (#/setBoxType: pane #$NSBoxPrimary)
1786      (#/setBorderType: pane #$NSNoBorder)
1787      (#/setContentViewMargins: pane (ns:make-ns-size *text-pane-margin-width*  *text-pane-margin-height*))
1788      (#/setTitlePosition: pane #$NSNoTitle))
1789    pane))
1790
1791(objc:defmethod #/defaultMenu ((class +hemlock-text-view))
1792  (text-view-context-menu))
1793
1794(defun pathname-for-namestring-fragment (string)
1795  "Return a pathname that STRING might designate."
1796  ;; We could get fancy here, but for now just be stupid.
1797  (let ((pathname (ignore-errors (probe-file string))))
1798    (if (and (pathnamep pathname)
1799             (not (directory-pathname-p pathname)))
1800      pathname)))
1801
1802(defun find-symbol-in-packages (string pkgs)
1803  (setq string (string-upcase string))
1804  (let (sym)
1805    (dolist (p pkgs)
1806      (when (setq sym (find-symbol string p))
1807        (return)))
1808    sym))
1809
1810(objc:defmethod (#/openSelection: :void) ((self hemlock-text-view) sender)
1811  (declare (ignore sender))
1812  (let* ((text (#/string self))
1813         (selection (#/substringWithRange: text (#/selectedRange self)))
1814         (pathname (pathname-for-namestring-fragment
1815                    (lisp-string-from-nsstring selection))))
1816    (when (pathnamep pathname)
1817      (ed pathname))))
1818
1819;;; If we get here, we've already checked that the selection represents
1820;;; a valid symbol name.
1821(objc:defmethod (#/inspectSelection: :void) ((self hemlock-text-view) sender)
1822  (declare (ignore sender))
1823  (let* ((text (#/string self))
1824         (selection (#/substringWithRange: text (#/selectedRange self)))
1825         (symbol-name (string-upcase (lisp-string-from-nsstring selection)))
1826         (buffer (hemlock-buffer self))
1827         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer)))
1828    (inspect (find-symbol-in-packages symbol-name 
1829                                      (cons package-name
1830                                            (package-use-list package-name))))))
1831
1832(objc:defmethod (#/sourceForSelection: :void) ((self hemlock-text-view) sender)
1833  (declare (ignore sender))
1834  (let* ((text (#/string self))
1835         (selection (#/substringWithRange: text (#/selectedRange self)))
1836         (sym (find-symbol-in-packages (lisp-string-from-nsstring selection)
1837                                       (list-all-packages))))
1838    (ed sym)))
1839
1840;;; If we don't override this, NSTextView will start adding Google/
1841;;; Spotlight search options and dictionary lookup when a selection
1842;;; is active.
1843(objc:defmethod #/menuForEvent: ((self hemlock-text-view) event)
1844  (declare (ignore event))
1845  (let* ((text (#/string self))
1846         (selection (#/substringWithRange: text (#/selectedRange self)))
1847         (s (lisp-string-from-nsstring selection))
1848         (menu (if (> (length s) 0)
1849                 (#/copy (#/menu self))
1850                 (#/retain (#/menu self))))
1851         (buffer (hemlock-buffer self))
1852         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer)))
1853    (when (find-symbol-in-packages (string-upcase s)
1854                                   (cons package-name
1855                                         (package-use-list package-name)))
1856      (let* ((title (#/stringByAppendingString: #@"Inspect " selection))
1857             (item (make-instance 'ns:ns-menu-item :with-title title
1858                     :action (@selector #/inspectSelection:)
1859                     :key-equivalent #@"")))
1860        (#/setTarget: item self)
1861        (#/insertItem:atIndex: menu item 0)
1862        (#/release item)))
1863    (when (find-symbol-in-packages (string-upcase s) (list-all-packages))
1864      (let* ((title (#/stringByAppendingString: #@"Source of " selection))
1865             (item (make-instance 'ns:ns-menu-item :with-title title
1866                     :action (@selector #/sourceForSelection:)
1867                     :key-equivalent #@"")))
1868        (#/setTarget: item self)
1869        (#/insertItem:atIndex: menu item 0)
1870        (#/release item)))
1871    (when (pathname-for-namestring-fragment s)
1872      (let* ((title (#/stringByAppendingString: #@"Open " selection))
1873             (item (make-instance 'ns:ns-menu-item :with-title title
1874                     :action (@selector #/openSelection:)
1875                     :key-equivalent #@"")))
1876        (#/setTarget: item self)
1877        (#/insertItem:atIndex: menu item 0)
1878        (#/release item)))
1879
1880    (#/autorelease menu)))
1881
1882(defun make-scrolling-text-view-for-textstorage (textstorage x y width height tracks-width color style)
1883  (let* ((scrollview (#/autorelease
1884                      (make-instance
1885                       'ns:ns-scroll-view
1886                       :with-frame (ns:make-ns-rect x y width height)))))
1887    (#/setBorderType: scrollview #$NSNoBorder)
1888    (#/setHasVerticalScroller: scrollview t)
1889    (#/setHasHorizontalScroller: scrollview t)
1890    (#/setRulersVisible: scrollview nil)
1891    (#/setAutoresizingMask: scrollview (logior
1892                                        #$NSViewWidthSizable
1893                                        #$NSViewHeightSizable))
1894    (#/setAutoresizesSubviews: (#/contentView scrollview) t)
1895    (let* ((layout (make-instance 'ns:ns-layout-manager)))
1896      #+suffer
1897      (#/setTypesetter: layout (make-instance 'hemlock-ats-typesetter))
1898      (#/addLayoutManager: textstorage layout)
1899      (#/setUsesScreenFonts: layout *use-screen-fonts*)
1900      (#/release layout)
1901      (let* ((contentsize (#/contentSize scrollview)))
1902        (ns:with-ns-size (containersize large-number-for-text large-number-for-text)
1903          (ns:with-ns-rect (tv-frame 0 0 (ns:ns-size-width contentsize) (ns:ns-size-height contentsize))
1904            (ns:init-ns-size containersize large-number-for-text large-number-for-text)
1905            (ns:init-ns-rect tv-frame 0 0 (ns:ns-size-width contentsize) (ns:ns-size-height contentsize))
1906            (let* ((container (#/autorelease (make-instance
1907                                              'ns:ns-text-container
1908                                              :with-container-size containersize))))
1909              (#/addTextContainer: layout  container)
1910              (let* ((tv (#/autorelease (make-instance 'hemlock-text-view
1911                                                       :with-frame tv-frame
1912                                                       :text-container container))))
1913                (setf (text-view-paren-highlight-color tv) (paren-highlight-background-color))
1914                (#/setDelegate: layout tv)
1915                (#/setMinSize: tv (ns:make-ns-size 0 (ns:ns-size-height contentsize)))
1916                (#/setMaxSize: tv (ns:make-ns-size large-number-for-text large-number-for-text))
1917                (#/setRichText: tv nil)
1918                (#/setAutoresizingMask: tv #$NSViewWidthSizable)
1919                (#/setBackgroundColor: tv color)
1920                (when (slot-exists-p textstorage 'styles)
1921                  (#/setTypingAttributes: tv (#/objectAtIndex:
1922                                              (#/styles textstorage) style)))
1923                #-cocotron
1924                (#/setSmartInsertDeleteEnabled: tv nil)
1925                (#/setAllowsUndo: tv nil) ; don't want NSTextView undo
1926                #-cocotron
1927                (#/setUsesFindPanel: tv t)
1928                #-cocotron
1929                (#/setUsesFontPanel: tv nil)
1930                (#/setMenu: tv (text-view-context-menu))
1931
1932                ;;  The container tracking and the text view sizability along a
1933                ;;  particular axis must always be different, or else things can
1934                ;;  get really confused (possibly causing an infinite loop).
1935
1936                (if (or tracks-width *wrap-lines-to-window*)
1937                  (progn
1938                    (#/setWidthTracksTextView: container t)
1939                    (#/setHeightTracksTextView: container nil)
1940                    (#/setHorizontallyResizable: tv nil)
1941                    (#/setVerticallyResizable: tv t))
1942                  (progn
1943                    (#/setWidthTracksTextView: container nil)
1944                    (#/setHeightTracksTextView: container nil)
1945                    (#/setHorizontallyResizable: tv t)
1946                    (#/setVerticallyResizable: tv t)))
1947                (#/setContentView: scrollview (make-instance 'text-pane-clip-view))
1948                (#/setDocumentView: scrollview tv)           
1949                (values tv scrollview)))))))))
1950
1951(defun make-scrolling-textview-for-pane (pane textstorage track-width color style)
1952  (let* ((contentrect (#/frame (#/contentView pane)) ))
1953    (multiple-value-bind (tv scrollview)
1954        (make-scrolling-text-view-for-textstorage
1955         textstorage
1956         (ns:ns-rect-x contentrect)
1957         (ns:ns-rect-y contentrect)
1958         (ns:ns-rect-width contentrect)
1959         (ns:ns-rect-height contentrect)
1960         track-width
1961         color
1962         style)
1963      (#/addSubview: pane scrollview)
1964      (let* ((r (#/frame scrollview)))
1965        (decf (ns:ns-rect-height r) 15)
1966        (incf (ns:ns-rect-y r) 15)
1967        (#/setFrame: scrollview r))
1968      #-cocotron
1969      (#/setAutohidesScrollers: scrollview t)
1970      (setf (slot-value pane 'scroll-view) scrollview
1971            (slot-value pane 'text-view) tv
1972            (slot-value tv 'pane) pane
1973            #|(slot-value scrollview 'pane) pane|#)
1974      ;;(let* ((modeline  (scroll-view-modeline scrollview)))
1975      (let* ((modeline  (make-instance 'modeline-view
1976                          :with-frame (ns:make-ns-rect 0 0 (ns:ns-rect-width contentrect)
1977                                                       15))))
1978        (#/setAutoresizingMask: modeline #$NSViewWidthSizable)
1979        (#/addSubview: pane modeline)
1980        (#/release modeline)
1981        (setf (slot-value pane 'mode-line) modeline
1982              (slot-value modeline 'pane) pane))
1983      tv)))
1984
1985(defmethod hemlock-view-size ((view hi:hemlock-view))
1986  (let* ((pane (hi::hemlock-view-pane view))
1987         (bounds (#/bounds (#/contentView (text-pane-scroll-view pane))))
1988         (tv (text-pane-text-view pane))
1989         (char-width (text-view-char-width tv))
1990         (line-height (text-view-line-height tv)))
1991    (values (floor (ns:ns-rect-width bounds) char-width)
1992            (floor (ns:ns-rect-height bounds) line-height))))
1993
1994
1995(defmethod hemlock-ext:change-active-pane ((view hi:hemlock-view) new-pane)
1996  #+debug (log-debug "change active pane to ~s" new-pane)
1997  (let* ((pane (hi::hemlock-view-pane view))
1998         (text-view (text-pane-text-view pane))
1999         (tv (ecase new-pane
2000               (:echo (slot-value text-view 'peer))
2001               (:text text-view))))
2002    (activate-hemlock-view tv)))
2003
2004(defclass echo-area-view (hemlock-textstorage-text-view)
2005    ()
2006  (:metaclass ns:+ns-object))
2007(declaim (special echo-area-view))
2008
2009(defmethod compute-temporary-attributes ((self echo-area-view))
2010)
2011
2012(defmethod update-paren-highlight ((self echo-area-view))
2013)
2014
2015(defmethod hemlock-view ((self echo-area-view))
2016  (let ((text-view (slot-value self 'peer)))
2017    (when text-view
2018      (hemlock-view text-view))))
2019
2020;;; The "document" for an echo-area isn't a real NSDocument.
2021(defclass echo-area-document (ns:ns-object)
2022    ((textstorage :foreign-type :id))
2023  (:metaclass ns:+ns-object))
2024
2025(defmethod hemlock-buffer ((self echo-area-document))
2026  (let ((ts (slot-value self 'textstorage)))
2027    (unless (%null-ptr-p ts)
2028      (hemlock-buffer ts))))
2029
2030(objc:defmethod #/undoManager ((self echo-area-document))
2031  +null-ptr+) ;For now, undo is not supported for echo-areas
2032
2033(defmethod update-buffer-package ((doc echo-area-document) buffer)
2034  (declare (ignore buffer)))
2035
2036(defmethod document-invalidate-modeline ((self echo-area-document))
2037  nil)
2038
2039(objc:defmethod (#/close :void) ((self echo-area-document))
2040  (let* ((ts (slot-value self 'textstorage)))
2041    (unless (%null-ptr-p ts)
2042      (setf (slot-value self 'textstorage) (%null-ptr))
2043      (close-hemlock-textstorage ts))))
2044
2045(objc:defmethod (#/updateChangeCount: :void) ((self echo-area-document) (change :<NSD>ocument<C>hange<T>ype))
2046  (declare (ignore change)))
2047
2048(defun make-echo-area (the-hemlock-frame x y width height main-buffer color)
2049  (let* ((box (make-instance 'ns:ns-view :with-frame (ns:make-ns-rect x y width height))))
2050    (#/setAutoresizingMask: box #$NSViewWidthSizable)
2051    (let* ((box-frame (#/bounds box))
2052           (containersize (ns:make-ns-size large-number-for-text (ns:ns-rect-height box-frame)))
2053           (clipview (make-instance 'ns:ns-clip-view
2054                                    :with-frame box-frame)))
2055      (#/setAutoresizingMask: clipview (logior #$NSViewWidthSizable
2056                                               #$NSViewHeightSizable))
2057      (#/setBackgroundColor: clipview color)
2058      (#/addSubview: box clipview)
2059      (#/setAutoresizesSubviews: box t)
2060      (#/release clipview)
2061      (let* ((buffer (hi::make-echo-buffer))
2062             (textstorage
2063              (progn
2064                ;; What's the reason for sharing this?  Is it just the lock?
2065                (setf (hi::buffer-gap-context buffer) (hi::ensure-buffer-gap-context main-buffer))
2066                (make-textstorage-for-hemlock-buffer buffer)))
2067             (doc (make-instance 'echo-area-document))
2068             (layout (make-instance 'ns:ns-layout-manager))
2069             (container (#/autorelease
2070                         (make-instance 'ns:ns-text-container
2071                                        :with-container-size
2072                                        containersize))))
2073        (#/addLayoutManager: textstorage layout)
2074        (#/setUsesScreenFonts: layout *use-screen-fonts*)
2075        (#/addTextContainer: layout container)
2076        (#/release layout)
2077        (let* ((echo (make-instance 'echo-area-view
2078                                    :with-frame box-frame
2079                                    :text-container container)))
2080          (#/setMinSize: echo (pref box-frame :<NSR>ect.size))
2081          (#/setMaxSize: echo (ns:make-ns-size large-number-for-text large-number-for-text))
2082          (#/setRichText: echo nil)
2083          #-cocotron
2084          (#/setUsesFontPanel: echo nil)
2085          (#/setHorizontallyResizable: echo t)
2086          (#/setVerticallyResizable: echo nil)
2087          (#/setAutoresizingMask: echo #$NSViewNotSizable)
2088          (#/setBackgroundColor: echo color)
2089          (#/setWidthTracksTextView: container nil)
2090          (#/setHeightTracksTextView: container nil)
2091          (#/setMenu: echo +null-ptr+)
2092          (setf (hemlock-frame-echo-area-buffer the-hemlock-frame) buffer
2093                (slot-value doc 'textstorage) textstorage
2094                (hi::buffer-document buffer) doc)
2095          (#/setDocumentView: clipview echo)
2096          (#/setAutoresizesSubviews: clipview nil)
2097          (#/sizeToFit echo)
2098          (values echo box))))))
2099                   
2100(defun make-echo-area-for-window (w main-buffer color)
2101  (let* ((content-view (#/contentView w))
2102         (bounds (#/bounds content-view))
2103         (height (+ 1 (size-of-char-in-font *editor-font*))))
2104    (multiple-value-bind (echo-area box)
2105                         (make-echo-area w
2106                                         0.0f0
2107                                         0.0f0
2108                                         (- (ns:ns-rect-width bounds) 16.0f0)
2109                                         height
2110                                         main-buffer
2111                                         color)
2112      (#/addSubview: content-view box)
2113      echo-area)))
2114               
2115(defclass hemlock-frame (ns:ns-window)
2116    ((echo-area-view :foreign-type :id)
2117     (pane :foreign-type :id)
2118     (echo-area-buffer :initform nil :accessor hemlock-frame-echo-area-buffer)
2119     (echo-area-stream :initform nil :accessor hemlock-frame-echo-area-stream))
2120  (:metaclass ns:+ns-object))
2121(declaim (special hemlock-frame))
2122
2123;;; If a window's document's edited status changes, update the modeline.
2124(objc:defmethod (#/setDocumentEdited: :void) ((w hemlock-frame)
2125                                              (edited #>BOOL))
2126  (let* ((was-edited (#/isDocumentEdited w)))
2127    (unless (eq was-edited edited)
2128      (#/setNeedsDisplay: (text-pane-mode-line (slot-value w 'pane)) t)))
2129  (call-next-method edited))
2130
2131(objc:defmethod (#/dealloc :void) ((self hemlock-frame))
2132  (let* ((pane (slot-value self 'pane))
2133         (echo-view (slot-value self 'echo-area-view)))
2134    (unless (%null-ptr-p pane)
2135      (setf (slot-value self 'pane) (%null-ptr))
2136      (#/release pane))
2137    (unless (%null-ptr-p echo-view)
2138      (setf (slot-value self 'echo-area-view) (%null-ptr))
2139      (#/release echo-view))
2140    (objc:remove-lisp-slots self)
2141    (call-next-method)))
2142 
2143
2144(objc:defmethod (#/miniaturize: :void) ((w hemlock-frame) sender)
2145  (let* ((event (#/currentEvent w))
2146         (flags (#/modifierFlags event)))
2147    (if (logtest #$NSControlKeyMask flags)
2148      (progn
2149        (#/orderOut: w nil)
2150        (#/changeWindowsItem:title:filename: *nsapp* w (#/title w) nil))
2151      (call-next-method sender))))
2152
2153(defmethod hemlock-view ((frame hemlock-frame))
2154  (let ((pane (slot-value frame 'pane)))
2155    (when (and pane (not (%null-ptr-p pane)))
2156      (hemlock-view pane))))
2157
2158(objc:defmethod (#/runErrorSheet: :void) ((self hemlock-frame) message)
2159  #+debug (#_NSLog #@"runErrorSheet: signal = %@" :id signal)
2160  (#_NSBeginAlertSheet #@"Error in Hemlock command processing" ;title
2161                       (if (logbitp 0 (random 2))
2162                         #@"Not OK, but what can you do?"
2163                         #@"The sky is falling. FRED never did this!")
2164                       +null-ptr+
2165                       +null-ptr+
2166                       self
2167                       self
2168                       +null-ptr+
2169                       +null-ptr+
2170                       +null-ptr+
2171                       message))
2172
2173(defun report-condition-in-hemlock-frame (condition frame)
2174  (assume-cocoa-thread)
2175  (let ((message (nsstring-for-lisp-condition condition)))
2176    (#/performSelectorOnMainThread:withObject:waitUntilDone:
2177     frame
2178     (@selector #/runErrorSheet:)
2179     message
2180     t)))
2181
2182(defmethod hemlock-ext:report-hemlock-error ((view hi:hemlock-view) condition debug-p)
2183  (when debug-p (maybe-log-callback-error condition))
2184  (let ((pane (hi::hemlock-view-pane view)))
2185    (when (and pane (not (%null-ptr-p pane)))
2186      (report-condition-in-hemlock-frame condition (#/window pane)))))
2187
2188(defun window-menubar-height ()
2189  #+cocotron (objc:objc-message-send (ccl::@class "NSMainMenuView") "menuHeight" #>CGFloat)
2190  #-cocotron 0.0f0)
2191
2192(defun new-hemlock-document-window (class)
2193  (let* ((w (new-cocoa-window :class class
2194                              :activate nil))
2195         (echo-area-height (+ 1 (size-of-char-in-font *editor-font*))))
2196      (values w (add-pane-to-window w :reserve-below echo-area-height))))
2197
2198
2199
2200(defun add-pane-to-window (w &key (reserve-above 0.0f0) (reserve-below 0.0f0))
2201  (let* ((window-content-view (#/contentView w))
2202         (window-frame (#/frame window-content-view)))
2203    (ns:with-ns-rect (pane-rect  0 reserve-below (ns:ns-rect-width window-frame) (- (ns:ns-rect-height window-frame) (+ reserve-above reserve-below)))
2204       (let* ((pane (make-instance 'text-pane :with-frame pane-rect)))
2205         (#/addSubview: window-content-view pane)
2206         (#/setDelegate: w pane)
2207         ;; Cocotron doesn't set the new window's initialFirstResponder which means
2208         ;; that the user must click in the window before they can edit.  So, do it here.
2209         ;; Remove this when Cocotron issue #374 is fixed
2210         ;;  (http://code.google.com/p/cocotron/issues/detail?id=374)
2211         #+cocotron (#/setInitialFirstResponder: w pane)
2212         pane))))
2213
2214(defun textpane-for-textstorage (class ts ncols nrows container-tracks-text-view-width color style)
2215  (let* ((pane (nth-value
2216                1
2217                (new-hemlock-document-window class))))
2218    (make-scrolling-textview-for-pane pane ts container-tracks-text-view-width color style)
2219    (multiple-value-bind (height width)
2220        (size-of-char-in-font (default-font))
2221      (size-text-pane pane height width nrows ncols))
2222    pane))
2223
2224
2225
2226
2227(defun hemlock-buffer-from-nsstring (nsstring name &rest modes)
2228  (let* ((buffer (make-hemlock-buffer name :modes modes)))
2229    (nsstring-to-buffer nsstring buffer)))
2230
2231(defun %nsstring-to-hemlock-string (nsstring)
2232  "returns line-termination of string"
2233  (let* ((string (lisp-string-from-nsstring nsstring))
2234         (lfpos (position #\linefeed string))
2235         (crpos (position #\return string))
2236         (line-termination (if crpos
2237                             (if (eql lfpos (1+ crpos))
2238                               :crlf
2239                               :cr)
2240                             :lf))
2241         (hemlock-string (case line-termination
2242                           (:crlf (remove #\return string))
2243                           (:cr (nsubstitute #\linefeed #\return string))
2244                           (t string))))
2245    (values hemlock-string line-termination)))
2246
2247;: TODO: I think this is jumping through hoops because it want to be invokable outside the main
2248;; cocoa thread.
2249(defun nsstring-to-buffer (nsstring buffer)
2250  (let* ((document (hi::buffer-document buffer))
2251         (hi::*current-buffer* buffer)
2252         (region (hi::buffer-region buffer)))
2253    (multiple-value-bind (hemlock-string line-termination)
2254                         (%nsstring-to-hemlock-string nsstring)
2255      (setf (hi::buffer-line-termination buffer) line-termination)
2256
2257      (setf (hi::buffer-document buffer) nil) ;; What's this about??
2258      (unwind-protect
2259          (let ((point (hi::buffer-point buffer)))
2260            (hi::delete-region region)
2261            (hi::insert-string point hemlock-string)
2262            (setf (hi::buffer-modified buffer) nil)
2263            (hi::buffer-start point)
2264            ;; TODO: why would this be needed? insert-string should take care of any internal bookkeeping.
2265            (hi::renumber-region region)
2266            buffer)
2267        (setf (hi::buffer-document buffer) document)))))
2268
2269
2270(setq hi::*beep-function* #'(lambda (stream)
2271                              (declare (ignore stream))
2272                              (#_NSBeep)))
2273
2274
2275;;; This function must run in the main event thread.
2276(defun %hemlock-frame-for-textstorage (class ts ncols nrows container-tracks-text-view-width color style)
2277  (assume-cocoa-thread)
2278  (let* ((pane (textpane-for-textstorage class ts ncols nrows container-tracks-text-view-width color style))
2279         (buffer (hemlock-buffer ts))
2280         (frame (#/window pane))
2281         (echo-area (make-echo-area-for-window frame buffer color))
2282         (echo-buffer (hemlock-buffer (#/textStorage echo-area)))
2283         (tv (text-pane-text-view pane)))
2284    #+GZ (assert echo-buffer)
2285    (with-slots (peer) tv
2286      (setq peer echo-area))
2287    (with-slots (peer) echo-area
2288      (setq peer tv))
2289    (setf (slot-value frame 'echo-area-view) echo-area
2290          (slot-value frame 'pane) pane)
2291    (setf (slot-value pane 'hemlock-view)
2292          (make-instance 'hi:hemlock-view
2293            :buffer buffer
2294            :pane pane
2295            :echo-area-buffer echo-buffer))
2296    (activate-hemlock-view tv)
2297   frame))
2298
2299(defun hemlock-ext:invoke-modifying-buffer-storage (buffer thunk)
2300  (assume-cocoa-thread)
2301  (when buffer ;; nil means just get rid of any prior buffer
2302    (setq buffer (require-type buffer 'hi::buffer)))
2303  (let ((old *buffer-being-edited*))
2304    (if (eq buffer old)
2305      (funcall thunk)
2306      (unwind-protect
2307          (progn
2308            (buffer-document-end-editing old)
2309            (buffer-document-begin-editing buffer)
2310            (funcall thunk))
2311        (buffer-document-end-editing buffer)
2312        (buffer-document-begin-editing old)))))
2313
2314(defun buffer-document-end-editing (buffer)
2315  (when buffer
2316    (let* ((document (hi::buffer-document (require-type buffer 'hi::buffer))))
2317      (when document
2318        (setq *buffer-being-edited* nil)
2319        (let ((ts (slot-value document 'textstorage)))
2320          (#/endEditing ts)
2321          (update-hemlock-selection ts))))))
2322
2323(defun buffer-document-begin-editing (buffer)
2324  (when buffer
2325    (let* ((document (hi::buffer-document buffer)))
2326      (when document
2327        (setq *buffer-being-edited* buffer)
2328        (#/beginEditing (slot-value document 'textstorage))))))
2329
2330(defun document-edit-level (document)
2331  (assume-cocoa-thread) ;; see comment in #/editingInProgress
2332  (slot-value (slot-value document 'textstorage) 'edit-count))
2333
2334(defun buffer-edit-level (buffer)
2335  (if buffer
2336    (let* ((document (hi::buffer-document buffer)))
2337      (if document
2338        (document-edit-level document)
2339        0))
2340    0))
2341
2342(defun hemlock-ext:invoke-allowing-buffer-display (buffer thunk)
2343  ;; Call THUNK with the buffer's edit-level at 0, then restore the buffer's edit level.
2344  (let* ((level (buffer-edit-level buffer)))
2345    (dotimes (i level) (buffer-document-end-editing buffer))
2346    (unwind-protect
2347        (funcall thunk)
2348      (dotimes (i level) (buffer-document-begin-editing buffer)))))
2349
2350
2351(defun buffer-document-modified (buffer)
2352  (let* ((doc (hi::buffer-document buffer)))
2353    (if doc
2354      (#/isDocumentEdited doc))))
2355
2356(defun perform-edit-change-notification (textstorage selector pos n &optional (extra 0))
2357  (with-lock-grabbed (*buffer-change-invocation-lock*)
2358    (let* ((invocation *buffer-change-invocation*))
2359      (rlet ((ppos :<NSI>nteger pos)
2360             (pn :<NSI>nteger n)
2361             (pextra :<NSI>nteger extra))
2362        (#/setTarget: invocation textstorage)
2363        (#/setSelector: invocation selector)
2364        (#/setArgument:atIndex: invocation ppos 2)
2365        (#/setArgument:atIndex: invocation pn 3)
2366        (#/setArgument:atIndex: invocation pextra 4))
2367      (#/performSelectorOnMainThread:withObject:waitUntilDone:
2368       invocation
2369       (@selector #/invoke)
2370       +null-ptr+
2371       t))))
2372
2373
2374
2375
2376(defun hemlock-ext:buffer-note-font-change (buffer region font)
2377  (when (hi::bufferp buffer)
2378    (let* ((document (hi::buffer-document buffer))
2379           (textstorage (if document (slot-value document 'textstorage)))
2380           (pos (hi:mark-absolute-position (hi::region-start region)))
2381           (n (- (hi:mark-absolute-position (hi::region-end region)) pos)))
2382      (if (eq *current-process* *cocoa-event-process*)
2383        (#/noteHemlockAttrChangeAtPosition:length:fontNum: textstorage
2384                                                           pos
2385                                                           n
2386                                                           font)
2387        (perform-edit-change-notification textstorage
2388                                          (@selector #/noteHemlockAttrChangeAtPosition:length:fontNum:)
2389                                          pos
2390                                          n
2391                                          font)))))
2392
2393(defun buffer-active-font-attributes (buffer)
2394  (let* ((style 0)
2395         (region (hi::buffer-active-font-region buffer))
2396         (textstorage (slot-value (hi::buffer-document buffer) 'textstorage))
2397         (styles (#/styles textstorage)))
2398    (when region
2399      (let* ((start (hi::region-end region)))
2400        (setq style (hi::font-mark-font start))))
2401    (#/objectAtIndex: styles style)))
2402     
2403;; Note that inserted a string of length n at mark.  Assumes this is called after
2404;; buffer marks were updated.
2405(defun hemlock-ext:buffer-note-insertion (buffer mark n)
2406  (when (hi::bufferp buffer)
2407    (let* ((document (hi::buffer-document buffer))
2408           (textstorage (if document (slot-value document 'textstorage))))
2409      (when textstorage
2410        (let* ((pos (hi:mark-absolute-position mark)))
2411          (when (eq (hi::mark-%kind mark) :left-inserting)
2412            ;; Make up for the fact that the mark moved forward with the insertion.
2413            ;; For :right-inserting and :temporary marks, they should be left back.
2414            (decf pos n))
2415          (if (eq *current-process* *cocoa-event-process*)
2416            (#/noteHemlockInsertionAtPosition:length:extra: textstorage
2417                                                            pos
2418                                                            n
2419                                                            0)
2420            (perform-edit-change-notification textstorage
2421                                              (@selector #/noteHemlockInsertionAtPosition:length:extra:)
2422                                              pos
2423                                              n)))))))
2424
2425(defun hemlock-ext:buffer-note-modification (buffer mark n)
2426  (when (hi::bufferp buffer)
2427    (let* ((document (hi::buffer-document buffer))
2428           (textstorage (if document (slot-value document 'textstorage))))
2429      (when textstorage
2430        (if (eq *current-process* *cocoa-event-process*)
2431          (#/noteHemlockModificationAtPosition:length:extra: textstorage
2432                                                             (hi:mark-absolute-position mark)
2433                                                             n
2434                                                             0)
2435          (perform-edit-change-notification textstorage
2436                                            (@selector #/noteHemlockModificationAtPosition:length:extra:)
2437                                            (hi:mark-absolute-position mark)
2438                                            n))))))
2439 
2440
2441(defun hemlock-ext:buffer-note-deletion (buffer mark n)
2442  (when (hi::bufferp buffer)
2443    (let* ((document (hi::buffer-document buffer))
2444           (textstorage (if document (slot-value document 'textstorage))))
2445      (when textstorage
2446        (let* ((pos (hi:mark-absolute-position mark)))
2447          (if (eq *current-process* *cocoa-event-process*)
2448            (#/noteHemlockDeletionAtPosition:length:extra: textstorage
2449                                                           pos
2450                                                           (abs n)
2451                                                           0)
2452            (perform-edit-change-notification textstorage
2453                                              (@selector #/noteHemlockDeletionAtPosition:length:extra:)
2454                                              pos
2455                                              (abs n))))))))
2456
2457
2458
2459(defun hemlock-ext:note-buffer-saved (buffer)
2460  (assume-cocoa-thread)
2461  (let* ((document (hi::buffer-document buffer)))
2462    (when document
2463      ;; Hmm... I guess this is always done by the act of saving.
2464      nil)))
2465
2466(defun hemlock-ext:note-buffer-unsaved (buffer)
2467  (assume-cocoa-thread)
2468  (let* ((document (hi::buffer-document buffer)))
2469    (when document
2470      (#/updateChangeCount: document #$NSChangeCleared))))
2471
2472
2473(defun size-of-char-in-font (f)
2474  (let* ((sf (#/screenFont f))
2475         (screen-p *use-screen-fonts*))
2476    (if (%null-ptr-p sf) (setq sf f screen-p nil))
2477    (let* ((layout (#/autorelease (#/init (#/alloc ns:ns-layout-manager)))))
2478      (#/setUsesScreenFonts: layout screen-p)
2479      (values (fround (#/defaultLineHeightForFont: layout sf))
2480              (fround (ns:ns-size-width (#/advancementForGlyph: sf (char-code #\space))))))))
2481         
2482
2483
2484(defun size-text-pane (pane line-height char-width nrows ncols)
2485  (let* ((tv (text-pane-text-view pane))
2486         (height (fceiling (* nrows line-height)))
2487         (width (fceiling (* ncols char-width)))
2488         (scrollview (text-pane-scroll-view pane))
2489         (window (#/window scrollview))
2490         (has-horizontal-scroller (#/hasHorizontalScroller scrollview))
2491         (has-vertical-scroller (#/hasVerticalScroller scrollview)))
2492    (ns:with-ns-size (tv-size
2493                      (+ width (* 2 (#/lineFragmentPadding (#/textContainer tv))))
2494                      height)
2495      (when has-vertical-scroller 
2496        (#/setVerticalLineScroll: scrollview line-height)
2497        (#/setVerticalPageScroll: scrollview (cgfloat 0.0) #|line-height|#))
2498      (when has-horizontal-scroller
2499        (#/setHorizontalLineScroll: scrollview char-width)
2500        (#/setHorizontalPageScroll: scrollview (cgfloat 0.0) #|char-width|#))
2501      (let* ((sv-size (#/frameSizeForContentSize:hasHorizontalScroller:hasVerticalScroller:borderType: ns:ns-scroll-view tv-size has-horizontal-scroller has-vertical-scroller (#/borderType scrollview)))
2502             (pane-frame (#/frame pane))
2503             (margins (#/contentViewMargins pane)))
2504        (incf (ns:ns-size-height sv-size)
2505              (+ (ns:ns-rect-y pane-frame)
2506                 (* 2 (ns:ns-size-height  margins))))
2507        (incf (ns:ns-size-width sv-size)
2508              (ns:ns-size-width margins))
2509        (#/setContentSize: window sv-size)
2510        (setf (slot-value tv 'char-width) char-width
2511              (slot-value tv 'line-height) line-height)
2512        (#/setResizeIncrements: window
2513                                (ns:make-ns-size char-width line-height))))))
2514                                   
2515 
2516(defclass hemlock-editor-window-controller (ns:ns-window-controller)
2517  ()
2518  (:metaclass ns:+ns-object))
2519
2520;;; This is borrowed from emacs.  The first click on the zoom button will
2521;;; zoom vertically.  The second will zoom completely.  The third will
2522;;; return to the original size.
2523(objc:defmethod (#/windowWillUseStandardFrame:defaultFrame: #>NSRect)
2524                ((wc hemlock-editor-window-controller) sender (default-frame #>NSRect))
2525  (let* ((r (#/frame sender)))
2526    (if (= (ns:ns-rect-height r) (ns:ns-rect-height default-frame))
2527      (setf r default-frame)
2528      (setf (ns:ns-rect-height r) (ns:ns-rect-height default-frame)
2529            (ns:ns-rect-y r) (ns:ns-rect-y default-frame)))
2530    r))
2531
2532(objc:defmethod (#/windowWillClose: :void) ((wc hemlock-editor-window-controller)
2533                                            notification)
2534  (declare (ignore notification))
2535  ;; The echo area "document" should probably be a slot in the document
2536  ;; object, and released when the document object is.
2537  (let* ((w (#/window wc)))
2538    ;; guard against cocotron lossage
2539    (if (#/isKindOfClass: w hemlock-frame)
2540      (let* ((buf (hemlock-frame-echo-area-buffer w))
2541             (echo-doc (if buf (hi::buffer-document buf))))
2542        (when echo-doc
2543          (setf (hemlock-frame-echo-area-buffer w) nil)
2544          (#/close echo-doc))
2545        (#/setFrameAutosaveName: w #@"")
2546        (#/autorelease w))
2547      (#_NSLog #@"window controller %@ got windowWillClose for odd window %@ "
2548               :address wc :address w))))
2549
2550(defmethod hemlock-view ((self hemlock-editor-window-controller))
2551  (let ((frame (#/window self)))
2552    (unless (%null-ptr-p frame)
2553      (hemlock-view frame))))
2554
2555;;; Map *default-file-character-encoding* to an :<NSS>tring<E>ncoding
2556(defun get-default-encoding ()
2557  #-cocotron                            ;need IANA conversion stuff
2558  (let* ((file-encoding *default-file-character-encoding*))
2559    (when (and (typep file-encoding 'keyword)
2560               (lookup-character-encoding file-encoding))
2561      (let* ((string (string file-encoding))
2562             (len (length string)))
2563        (with-cstrs ((cstr string))
2564          (with-nsstr (nsstr cstr len)
2565            (let* ((cf (#_CFStringConvertIANACharSetNameToEncoding nsstr)))
2566              (if (= cf #$kCFStringEncodingInvalidId)
2567                (setq cf (#_CFStringGetSystemEncoding)))
2568              (let* ((ns (#_CFStringConvertEncodingToNSStringEncoding cf)))
2569                (if (= ns #$kCFStringEncodingInvalidId)
2570                  (#/defaultCStringEncoding ns:ns-string)
2571                  ns)))))))))
2572
2573(defclass hemlock-document-controller (ns:ns-document-controller)
2574    ((last-encoding :foreign-type :<NSS>tring<E>ncoding))
2575  (:metaclass ns:+ns-object))
2576(declaim (special hemlock-document-controller))
2577
2578(objc:defmethod #/init ((self hemlock-document-controller))
2579  (prog1
2580      (call-next-method)
2581    (setf (slot-value self 'last-encoding) 0)))
2582
2583
2584;;; The HemlockEditorDocument class.
2585
2586
2587(defclass hemlock-editor-document (ns:ns-document)
2588    ((textstorage :foreign-type :id)
2589     (encoding :foreign-type :<NSS>tring<E>ncoding))
2590  (:metaclass ns:+ns-object))
2591
2592(defmethod hemlock-buffer ((self hemlock-editor-document))
2593  (let ((ts (slot-value self 'textstorage)))
2594    (unless (%null-ptr-p ts)
2595      (hemlock-buffer ts))))
2596
2597(defmethod window-document ((w ns:ns-window))
2598  (let* ((sc (#/sharedDocumentController ns:ns-document-controller))
2599         (doc (#/documentForWindow: sc w)))
2600    (if (%null-ptr-p doc)
2601      nil
2602      doc)))
2603
2604(defmethod window-pathname ((w ns:ns-window))
2605  (document-pathname (window-document w)))
2606
2607(defmethod document-pathname ((doc NULL))
2608  nil)
2609
2610(defmethod document-pathname ((doc hemlock-editor-document))
2611  (hi:buffer-pathname (hemlock-buffer doc)))
2612
2613(defmethod assume-not-editing ((doc hemlock-editor-document))
2614  (assume-not-editing (slot-value doc 'textstorage)))
2615
2616(defmethod document-invalidate-modeline ((self hemlock-editor-document))
2617  (for-each-textview-using-storage
2618   (slot-value self 'textstorage)
2619   #'(lambda (tv)
2620       (let* ((pane (text-view-pane tv)))
2621         (unless (%null-ptr-p pane)
2622           (#/setNeedsDisplay: (text-pane-mode-line pane) t))))))
2623
2624(defmethod update-buffer-package ((doc hemlock-editor-document) buffer)
2625  (let* ((name (or (hemlock::package-at-mark (hi::buffer-point buffer))
2626                   (hi::variable-value 'hemlock::default-package :buffer buffer))))
2627    (when name
2628      (let* ((pkg (find-package name)))
2629        (if pkg
2630          (setq name (shortest-package-name pkg))))
2631      (let* ((curname (hi::variable-value 'hemlock::current-package :buffer buffer)))
2632        (if (or (null curname)
2633                (not (string= curname name)))
2634          (setf (hi::variable-value 'hemlock::current-package :buffer buffer) name))))))
2635
2636(defun hemlock-ext:note-selection-set-by-search (buffer)
2637  (let* ((doc (hi::buffer-document buffer)))
2638    (when doc
2639      (with-slots (textstorage) doc
2640        (when textstorage
2641          (with-slots (selection-set-by-search) textstorage
2642            (setq selection-set-by-search #$YES)))))))
2643
2644(objc:defmethod (#/validateMenuItem: :<BOOL>)
2645    ((self hemlock-text-view) item)
2646  (let* ((action (#/action item)))
2647    #+debug (#_NSLog #@"action = %s" :address action)
2648    (cond ((eql action (@selector #/hyperSpecLookUp:))
2649           ;; For now, demand a selection.
2650           (and *hyperspec-lookup-enabled*
2651                (hyperspec-root-url)
2652                (not (eql 0 (ns:ns-range-length (#/selectedRange self))))))
2653          ((eql action (@selector #/cut:))
2654           (let* ((selection (#/selectedRange self)))
2655             (and (> (ns:ns-range-length selection))
2656                  (#/shouldChangeTextInRange:replacementString: self selection #@""))))
2657          ((eql action (@selector #/evalSelection:))
2658           (not (eql 0 (ns:ns-range-length (#/selectedRange self)))))
2659          ((eql action (@selector #/evalAll:))
2660           (let* ((doc (#/document (#/windowController (#/window self)))))
2661             (and (not (%null-ptr-p doc))
2662                  (eq (type-of doc) 'hemlock-editor-document))))
2663          ;; if this hemlock-text-view is in an editor window and its buffer has
2664          ;; an associated pathname, then activate the Load Buffer item
2665          ((or (eql action (@selector #/loadBuffer:))
2666               (eql action (@selector #/compileBuffer:))
2667               (eql action (@selector #/compileAndLoadBuffer:))) 
2668           (let* ((buffer (hemlock-buffer self))
2669                  (pathname (hi::buffer-pathname buffer)))
2670             (not (null pathname))))
2671          ((eql action (@selector #/openSelection:))
2672           (let* ((text (#/string self))
2673                  (selection (#/substringWithRange: text (#/selectedRange self))))
2674             (pathname-for-namestring-fragment (lisp-string-from-nsstring selection))))
2675          (t (call-next-method item)))))
2676
2677(defmethod user-input-style ((doc hemlock-editor-document))
2678  0)
2679
2680(defvar *encoding-name-hash* (make-hash-table))
2681
2682(defmethod document-encoding-name ((doc hemlock-editor-document))
2683  (with-slots (encoding) doc
2684    (if (eql encoding 0)
2685      "Automatic"
2686      (or (gethash encoding *encoding-name-hash*)
2687          (setf (gethash encoding *encoding-name-hash*)
2688                (lisp-string-from-nsstring (nsstring-for-nsstring-encoding encoding)))))))
2689
2690(defun hemlock-ext:buffer-encoding-name (buffer)
2691  (let ((doc (hi::buffer-document buffer)))
2692    (and doc (document-encoding-name doc))))
2693
2694;; TODO: make each buffer have a slot, and this is just the default value.
2695(defmethod textview-background-color ((doc hemlock-editor-document))
2696  *editor-background-color*)
2697
2698
2699(objc:defmethod (#/setTextStorage: :void) ((self hemlock-editor-document) ts)
2700  (let* ((doc (%inc-ptr self 0))        ; workaround for stack-consed self
2701         (string (#/hemlockString ts))
2702         (buffer (hemlock-buffer string)))
2703    (unless (%null-ptr-p doc)
2704      (setf (slot-value doc 'textstorage) ts
2705            (hi::buffer-document buffer) doc))))
2706
2707;; This runs on the main thread.
2708(objc:defmethod (#/revertToSavedFromFile:ofType: :<BOOL>)
2709    ((self hemlock-editor-document) filename filetype)
2710  (declare (ignore filetype))
2711  (assume-cocoa-thread)
2712  #+debug
2713  (#_NSLog #@"revert to saved from file %@ of type %@"
2714           :id filename :id filetype)
2715  (let* ((encoding (slot-value self 'encoding))
2716         (nsstring (make-instance ns:ns-string
2717                                  :with-contents-of-file filename
2718                                  :encoding encoding
2719                                  :error +null-ptr+))
2720         (buffer (hemlock-buffer self))
2721         (old-length (hemlock-buffer-length buffer))
2722         (hi::*current-buffer* buffer)
2723         (textstorage (slot-value self 'textstorage))
2724         (point (hi::buffer-point buffer))
2725         (pointpos (hi:mark-absolute-position point)))
2726    (hemlock-ext:invoke-modifying-buffer-storage
2727     buffer
2728     #'(lambda ()
2729         (#/edited:range:changeInLength:
2730          textstorage #$NSTextStorageEditedCharacters (ns:make-ns-range 0 old-length) (- old-length))
2731         (nsstring-to-buffer nsstring buffer)
2732         (let* ((newlen (hemlock-buffer-length buffer)))
2733           (#/edited:range:changeInLength: textstorage  #$NSTextStorageEditedAttributes (ns:make-ns-range 0 0) newlen)
2734           (#/edited:range:changeInLength: textstorage #$NSTextStorageEditedCharacters (ns:make-ns-range 0 newlen) 0)
2735           (let* ((ts-string (#/hemlockString textstorage))
2736                  (display (hemlock-buffer-string-cache ts-string)))
2737             (reset-buffer-cache display) 
2738             (update-line-cache-for-index display 0)
2739             (move-hemlock-mark-to-absolute-position point
2740                                                     display
2741                                                     (min newlen pointpos))))
2742         (#/updateMirror textstorage)
2743         (setf (hi::buffer-modified buffer) nil)
2744         (hi::note-modeline-change buffer)))
2745    t))
2746
2747
2748(defvar *last-document-created* nil)
2749
2750(objc:defmethod #/init ((self hemlock-editor-document))
2751  (let* ((doc (call-next-method)))
2752    (unless  (%null-ptr-p doc)
2753      (#/setTextStorage: doc (make-textstorage-for-hemlock-buffer
2754                              (make-hemlock-buffer
2755                               (lisp-string-from-nsstring
2756                                (#/displayName doc))
2757                               :modes '("Lisp" "Editor")))))
2758    (with-slots (encoding) doc
2759      (setq encoding (or (get-default-encoding) #$NSISOLatin1StringEncoding)))
2760    (setq *last-document-created* doc)
2761    doc))
2762
2763 
2764(defun make-buffer-for-document (ns-document pathname)
2765  (let* ((buffer-name (hi::pathname-to-buffer-name pathname))
2766         (buffer (make-hemlock-buffer buffer-name)))
2767    (setf (slot-value ns-document 'textstorage)
2768          (make-textstorage-for-hemlock-buffer buffer))
2769    (setf (hi::buffer-pathname buffer) pathname)
2770    buffer))
2771
2772(objc:defmethod (#/readFromURL:ofType:error: :<BOOL>)
2773    ((self hemlock-editor-document) url type (perror (:* :id)))
2774  (declare (ignorable type))
2775  (with-callback-context "readFromURL"
2776    (rlet ((pused-encoding :<NSS>tring<E>ncoding 0))
2777      (let* ((pathname
2778              (lisp-string-from-nsstring
2779               (if (#/isFileURL url)
2780                 (#/path url)
2781                 (#/absoluteString url))))
2782             (buffer (or (hemlock-buffer self)
2783                         (make-buffer-for-document self pathname)))
2784             (selected-encoding (slot-value (#/sharedDocumentController (find-class 'hemlock-document-controller)) 'last-encoding))
2785             (string
2786              (if (zerop selected-encoding)
2787                (#/stringWithContentsOfURL:usedEncoding:error:
2788                 ns:ns-string
2789                 url
2790                 pused-encoding
2791                 perror)
2792                +null-ptr+)))
2793       
2794        (if (%null-ptr-p string)
2795          (progn
2796            (if (zerop selected-encoding)
2797              (setq selected-encoding (or (get-default-encoding) #$NSISOLatin1StringEncoding)))
2798            (setq string (#/stringWithContentsOfURL:encoding:error:
2799                          ns:ns-string
2800                          url
2801                          selected-encoding
2802                          perror)))
2803          (setq selected-encoding (pref pused-encoding :<NSS>tring<E>ncoding)))
2804        (unless (%null-ptr-p string)
2805          (with-slots (encoding) self (setq encoding selected-encoding))
2806
2807          ;; ** TODO: Argh.  How about we just let hemlock insert it.
2808          (let* ((textstorage (slot-value self 'textstorage))
2809                 (display (hemlock-buffer-string-cache (#/hemlockString textstorage)))
2810                 (hi::*current-buffer* buffer))
2811            (hemlock-ext:invoke-modifying-buffer-storage
2812             buffer
2813             #'(lambda ()
2814                 (nsstring-to-buffer string buffer)
2815                 (reset-buffer-cache display) 
2816                 (#/updateMirror textstorage)
2817                 (update-line-cache-for-index display 0)
2818                 (textstorage-note-insertion-at-position
2819                  textstorage
2820                  0
2821                  (hemlock-buffer-length buffer))
2822                 (hi::note-modeline-change buffer)
2823                 (setf (hi::buffer-modified buffer) nil))))
2824          t)))))
2825
2826
2827
2828
2829(def-cocoa-default *editor-keep-backup-files* :bool t "maintain backup files")
2830
2831(objc:defmethod (#/keepBackupFile :<BOOL>) ((self hemlock-editor-document))
2832  ;;; Don't use the NSDocument backup file scheme.
2833  nil)
2834
2835(objc:defmethod (#/writeSafelyToURL:ofType:forSaveOperation:error: :<BOOL>)
2836    ((self hemlock-editor-document)
2837     absolute-url
2838     type
2839     (save-operation :<NSS>ave<O>peration<T>ype)
2840     (error (:* :id)))
2841  (when (and *editor-keep-backup-files*
2842             (eql save-operation #$NSSaveOperation))
2843    (write-hemlock-backup-file (#/fileURL self)))
2844  (call-next-method absolute-url type save-operation error))
2845
2846(defun write-hemlock-backup-file (url)
2847  (unless (%null-ptr-p url)
2848    (when (#/isFileURL url)
2849      (let* ((path (#/path url)))
2850        (unless (%null-ptr-p path)
2851          (let* ((newpath (#/stringByAppendingString: path #@"~"))
2852                 (fm (#/defaultManager ns:ns-file-manager)))
2853            ;; There are all kinds of ways for this to lose.
2854            ;; In order for the copy to succeed, the destination can't exist.
2855            ;; (It might exist, but be a directory, or there could be
2856            ;; permission problems ...)
2857            (#/removeFileAtPath:handler: fm newpath +null-ptr+)
2858            (#/copyPath:toPath:handler: fm path newpath +null-ptr+)))))))
2859
2860             
2861
2862
2863
2864(defun hemlock-ext:all-hemlock-views ()
2865  "List of all hemlock views, in z-order, frontmost first"
2866  (loop for win in (windows)
2867    as buf = (and (typep win 'hemlock-frame) (hemlock-view win))
2868    when buf collect buf))
2869
2870(defmethod document-panes ((document hemlock-editor-document))
2871  (let* ((ts (slot-value document 'textstorage))
2872         (panes ()))
2873    (for-each-textview-using-storage
2874     ts
2875     #'(lambda (tv)
2876         (let* ((pane (text-view-pane tv)))
2877           (unless (%null-ptr-p pane)
2878             (push pane panes)))))
2879    panes))
2880
2881(objc:defmethod (#/noteEncodingChange: :void) ((self hemlock-editor-document)
2882                                               popup)
2883  (with-slots (encoding) self
2884    (setq encoding (nsinteger-to-nsstring-encoding (#/selectedTag popup)))
2885    (hi::note-modeline-change (hemlock-buffer self))))
2886
2887#-cocotron
2888(objc:defmethod (#/prepareSavePanel: :<BOOL>) ((self hemlock-editor-document)
2889                                               panel)
2890  (with-slots (encoding) self
2891    (let* ((popup (build-encodings-popup (#/sharedDocumentController hemlock-document-controller) encoding)))
2892      (#/setAction: popup (@selector #/noteEncodingChange:))
2893      (#/setTarget: popup self)
2894      (#/setAccessoryView: panel popup)))
2895  (#/setExtensionHidden: panel nil)
2896  (#/setCanSelectHiddenExtension: panel nil)
2897  (#/setAllowedFileTypes: panel +null-ptr+)
2898  (call-next-method panel))
2899
2900
2901(defloadvar *ns-cr-string* (%make-nsstring (string #\return)))
2902(defloadvar *ns-lf-string* (%make-nsstring (string #\linefeed)))
2903(defloadvar *ns-crlf-string* (with-autorelease-pool (#/retain (#/stringByAppendingString: *ns-cr-string* *ns-lf-string*))))
2904
2905(objc:defmethod (#/writeToURL:ofType:error: :<BOOL>)
2906    ((self hemlock-editor-document) url type (error (:* :id)))
2907  (declare (ignore type))
2908  (with-slots (encoding textstorage) self
2909    (let* ((string (#/string textstorage))
2910           (buffer (hemlock-buffer self)))
2911      (case (when buffer (hi::buffer-line-termination buffer))
2912        (:crlf (unless (typep string 'ns:ns-mutable-string)
2913                 (setq string (make-instance 'ns:ns-mutable-string :with string string))
2914                 (#/replaceOccurrencesOfString:withString:options:range:
2915                  string *ns-lf-string* *ns-crlf-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string)))))
2916        (:cr (setq string (if (typep string 'ns:ns-mutable-string)
2917                            string
2918                            (make-instance 'ns:ns-mutable-string :with string string)))
2919             (#/replaceOccurrencesOfString:withString:options:range:
2920              string *ns-lf-string* *ns-cr-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string)))))
2921      (when (#/writeToURL:atomically:encoding:error:
2922             string url t encoding error)
2923        (when buffer
2924          (setf (hi::buffer-modified buffer) nil))
2925        t))))
2926
2927;;; Cocotron's NSDocument uses the deprecated as of 10.4 methods to implement the NSSavePanel
2928#+cocotron
2929(objc:defmethod (#/writeToFile:ofType: :<BOOL>)
2930    ((self hemlock-editor-document) path type)
2931  (rlet ((perror :id +null-ptr+))
2932    (#/writeToURL:ofType:error: self (#/fileURLWithPath: ns:ns-url path) type perror)))
2933
2934
2935;;; Shadow the setFileURL: method, so that we can keep the buffer
2936;;; name and pathname in synch with the document.
2937(objc:defmethod (#/setFileURL: :void) ((self hemlock-editor-document)
2938                                        url)
2939  (call-next-method url)
2940  (let* ((path nil)
2941         (controllers (#/windowControllers self)))
2942    (dotimes (i (#/count controllers))
2943      (let* ((controller (#/objectAtIndex: controllers i))
2944             (window (#/window controller)))
2945        (#/setFrameAutosaveName: window (or path (setq path (#/path url)))))))
2946  (let* ((buffer (hemlock-buffer self)))
2947    (when buffer
2948      (let* ((new-pathname (lisp-string-from-nsstring (#/path url))))
2949        (setf (hi::buffer-name buffer) (hi::pathname-to-buffer-name new-pathname))
2950        (setf (hi::buffer-pathname buffer) new-pathname)))))
2951
2952
2953(def-cocoa-default *initial-editor-x-pos* :float 20.0f0 "X position of upper-left corner of initial editor")
2954
2955(def-cocoa-default *initial-editor-y-pos* :float 10.0f0 "Y position of upper-left corner of initial editor")
2956
2957(defloadvar *editor-cascade-point* nil)
2958
2959(defloadvar *next-editor-x-pos* nil) ; set after defaults initialized
2960(defloadvar *next-editor-y-pos* nil)
2961
2962(defun x-pos-for-window (window x)
2963  (let* ((frame (#/frame window))
2964         (screen (#/screen window)))
2965    (if (%null-ptr-p screen) (setq screen (#/mainScreen ns:ns-screen)))
2966    (let* ((screen-rect (#/visibleFrame screen)))
2967      (if (>= x 0)
2968        (+ x (ns:ns-rect-x screen-rect))
2969        (- (+ (ns:ns-rect-width screen-rect) x) (ns:ns-rect-width frame))))))
2970
2971(defun y-pos-for-window (window y)
2972  (let* ((frame (#/frame window))
2973         (screen (#/screen window)))
2974    (if (%null-ptr-p screen) (setq screen (#/mainScreen ns:ns-screen)))
2975    (let* ((screen-rect (#/visibleFrame screen)))
2976      (if (>= y 0)
2977        (+ y (ns:ns-rect-y screen-rect) (ns:ns-rect-height frame))
2978        (+ (ns:ns-rect-height screen-rect) y)))))
2979
2980(objc:defmethod (#/makeWindowControllers :void) ((self hemlock-editor-document))
2981  #+debug
2982  (#_NSLog #@"Make window controllers")
2983    (let* ((textstorage  (slot-value self 'textstorage))
2984           (window (%hemlock-frame-for-textstorage
2985                    hemlock-frame
2986                    textstorage
2987                    *editor-columns*
2988                    *editor-rows*
2989                    nil
2990                    (textview-background-color self)
2991                    (user-input-style self)))
2992           (controller (make-instance
2993                           'hemlock-editor-window-controller
2994                         :with-window window))
2995           (url (#/fileURL self))
2996           (path (unless (%null-ptr-p url) (#/path url))))
2997      ;;(#/setDelegate: window self)
2998      (#/setDelegate: window controller)
2999      (#/setDelegate: (text-pane-text-view (slot-value window 'pane)) self)
3000      (#/addWindowController: self controller)
3001      (#/release controller)
3002      (#/setShouldCascadeWindows: controller nil)
3003      (when path
3004        (unless (#/setFrameAutosaveName: window path)
3005          (setq path nil)))
3006      (unless (and path
3007                   (#/setFrameUsingName: window path))
3008        ;; Cascade windows from the top left corner of the topmost editor window.
3009        ;; If there's no editor window, use the default position.
3010        (flet ((editor-window-p (w)
3011                 (and (not (eql w window))
3012                      (eql (#/class (#/windowController w))
3013                           (find-class 'hemlock-editor-window-controller)))))
3014          (let* ((editors (remove-if-not #'editor-window-p (windows)))
3015                 (top-editor (car editors)))
3016            (if top-editor
3017              (ns:with-ns-point (zp 0 0)
3018                (setq *editor-cascade-point* (#/cascadeTopLeftFromPoint:
3019                                              top-editor zp)))
3020              (let* ((screen-frame (#/visibleFrame (#/screen window)))
3021                     (pt (ns:make-ns-point *initial-editor-x-pos*
3022                                           (- (ns:ns-rect-height screen-frame)
3023                                              *initial-editor-y-pos*))))
3024                (setq *editor-cascade-point* pt)))))
3025        (#/cascadeTopLeftFromPoint: window *editor-cascade-point*))
3026      (let ((view (hemlock-view window)))
3027        (hi::handle-hemlock-event view #'(lambda ()
3028                                           (hi::process-file-options))))
3029      (#/synchronizeWindowTitleWithDocumentName controller)))
3030
3031
3032(objc:defmethod (#/close :void) ((self hemlock-editor-document))
3033  #+debug
3034  (#_NSLog #@"Document close: %@" :id self)
3035  (let* ((textstorage (slot-value self 'textstorage)))
3036    (unless (%null-ptr-p textstorage)
3037      (setf (slot-value self 'textstorage) (%null-ptr))
3038      #+huh?
3039      (for-each-textview-using-storage
3040       textstorage
3041       #'(lambda (tv)
3042           (let* ((layout (#/layoutManager tv)))
3043             (#/setBackgroundLayoutEnabled: layout nil))))
3044      (close-hemlock-textstorage textstorage)))
3045  (call-next-method))
3046
3047(objc:defmethod (#/dealloc :void) ((self hemlock-editor-document))
3048  (let* ((textstorage (slot-value self 'textstorage)))
3049    (unless (%null-ptr-p textstorage)
3050      (setf (slot-value self 'textstorage) (%null-ptr))
3051      (close-hemlock-textstorage textstorage)))
3052  (objc:remove-lisp-slots self)
3053  (call-next-method))
3054
3055
3056
3057(defmethod view-screen-lines ((view hi:hemlock-view))
3058    (let* ((pane (hi::hemlock-view-pane view)))
3059      (floor (ns:ns-size-height (#/contentSize (text-pane-scroll-view pane)))
3060             (text-view-line-height (text-pane-text-view pane)))))
3061
3062;; Beware this doesn't seem to take horizontal scrolling into account.
3063(defun visible-charpos-range (tv)
3064  (let* ((rect (#/visibleRect tv))
3065         (container-origin (#/textContainerOrigin tv))
3066         (layout (#/layoutManager tv)))
3067    ;; Convert from view coordinates to container coordinates
3068    (decf (pref rect :<NSR>ect.origin.x) (pref container-origin :<NSP>oint.x))
3069    (decf (pref rect :<NSR>ect.origin.y) (pref container-origin :<NSP>oint.y))
3070    (let* ((glyph-range (#/glyphRangeForBoundingRect:inTextContainer:
3071                         layout rect (#/textContainer tv)))
3072           (char-range (#/characterRangeForGlyphRange:actualGlyphRange:
3073                        layout glyph-range +null-ptr+)))
3074      (values (pref char-range :<NSR>ange.location)
3075              (pref char-range :<NSR>ange.length)))))
3076
3077(defun charpos-xy (tv charpos)
3078  (let* ((layout (#/layoutManager tv))
3079         (glyph-range (#/glyphRangeForCharacterRange:actualCharacterRange:
3080                       layout
3081                       (ns:make-ns-range charpos 0)
3082                       +null-ptr+))
3083         (rect (#/boundingRectForGlyphRange:inTextContainer:
3084                layout
3085                glyph-range
3086                (#/textContainer tv)))
3087         (container-origin (#/textContainerOrigin tv)))
3088    (values (+ (pref rect :<NSR>ect.origin.x) (pref container-origin :<NSP>oint.x))
3089            (+ (pref rect :<NSR>ect.origin.y) (pref container-origin :<NSP>oint.y)))))
3090
3091;;(nth-value 1 (charpos-xy tv (visible-charpos-range tv))) - this is smaller as it
3092;; only includes lines fully scrolled off...
3093(defun text-view-vscroll (tv)
3094  ;; Return the number of pixels scrolled off the top of the view.
3095  (let* ((scroll-view (text-pane-scroll-view (text-view-pane tv)))
3096         (clip-view (#/contentView scroll-view))
3097         (bounds (#/bounds clip-view)))
3098    (ns:ns-rect-y bounds)))
3099
3100(defun set-text-view-vscroll (tv vscroll)
3101  (let* ((scroll-view (text-pane-scroll-view (text-view-pane tv)))
3102         (clip-view (#/contentView scroll-view))
3103         (bounds (#/bounds clip-view)))
3104    (decf vscroll (mod vscroll (text-view-line-height tv))) ;; show whole line
3105    (ns:with-ns-point (new-origin (ns:ns-rect-x bounds) vscroll)
3106      (#/scrollToPoint: clip-view (#/constrainScrollPoint: clip-view new-origin))
3107      (#/reflectScrolledClipView: scroll-view clip-view))))
3108
3109(defun scroll-by-lines (tv nlines)
3110  "Change the vertical origin of the containing scrollview's clipview"
3111  (set-text-view-vscroll tv (+ (text-view-vscroll tv)
3112                               (* nlines (text-view-line-height tv)))))
3113
3114;; TODO: should be a hemlock variable..
3115(defvar *next-screen-context-lines* 2)
3116
3117(defmethod hemlock-ext:scroll-view ((view hi:hemlock-view) how &optional where)
3118  (assume-cocoa-thread)
3119  (let* ((tv (text-pane-text-view (hi::hemlock-view-pane view)))
3120         (may-change-selection t))
3121    (when (eq how :line)
3122      (setq where (require-type where '(integer 0)))
3123      (let* ((line-y (nth-value 1 (charpos-xy tv where)))
3124             (top-y (text-view-vscroll tv))
3125             (nlines (floor (- line-y top-y) (text-view-line-height tv))))
3126        (setq how :lines-down where nlines)))
3127    (ecase how
3128      (:center-selection
3129       (#/centerSelectionInVisibleArea: tv +null-ptr+))
3130      ((:page-up :view-page-up)
3131       (when (eq how :view-page-up)
3132         (setq may-change-selection nil))
3133       (require-type where 'null)
3134       ;; TODO: next-screen-context-lines
3135       (scroll-by-lines tv (- *next-screen-context-lines* (view-screen-lines view))))
3136      ((:page-down :view-page-down)
3137       (when (eq how :view-page-down)
3138         (setq may-change-selection nil))
3139       (require-type where 'null)
3140       (scroll-by-lines tv (- (view-screen-lines view) *next-screen-context-lines*)))
3141      (:lines-up
3142       (scroll-by-lines tv (- (require-type where 'integer))))
3143      (:lines-down
3144       (scroll-by-lines tv (require-type where 'integer))))
3145    ;; If point is not on screen, move it.
3146    (when may-change-selection
3147      (let* ((point (hi::current-point))
3148             (point-pos (hi::mark-absolute-position point)))
3149        (multiple-value-bind (win-pos win-len) (visible-charpos-range tv)
3150          (unless (and (<= win-pos point-pos) (< point-pos (+ win-pos win-len)))
3151            (let* ((point (hi::current-point-collapsing-selection))
3152                   (cache (hemlock-buffer-string-cache (#/hemlockString (#/textStorage tv)))))
3153              (move-hemlock-mark-to-absolute-position point cache win-pos)
3154              (update-hemlock-selection (#/textStorage tv)))))))))
3155
3156(defun iana-charset-name-of-nsstringencoding (ns)
3157  #+cocotron (declare (ignore ns))
3158  #+cocotron +null-ptr+
3159  #-cocotron
3160  (#_CFStringConvertEncodingToIANACharSetName
3161   (#_CFStringConvertNSStringEncodingToEncoding ns)))
3162   
3163(defun nsstring-for-nsstring-encoding (ns)
3164  (let* ((iana (iana-charset-name-of-nsstringencoding ns)))
3165    (if (%null-ptr-p iana)
3166      (#/stringWithFormat: ns:ns-string #@"{%@}"
3167                           (#/localizedNameOfStringEncoding: ns:ns-string ns))
3168      iana)))
3169
3170;;; Return T if the specified #>NSStringEncoding names something that
3171;;; CCL supports.  (Could also have a set of other encoding names that
3172;;; the user is interested in, maintained by preferences.
3173
3174(defun supported-string-encoding-p (ns-string-encoding)
3175  #-cocotron
3176  (let* ((cfname (#_CFStringConvertEncodingToIANACharSetName
3177                  (#_CFStringConvertNSStringEncodingToEncoding ns-string-encoding)))
3178         (name (unless (%null-ptr-p cfname)
3179                 (nstring-upcase (ccl::lisp-string-from-nsstring cfname))))
3180         (keyword (when (and name (find-symbol name "KEYWORD"))
3181                    (intern name "KEYWORD"))))
3182    (or (and keyword (not (null (lookup-character-encoding keyword))))
3183        ;; look in other table maintained by preferences
3184        )))
3185   
3186         
3187
3188
3189 
3190;;; Return a list of :<NSS>tring<E>ncodings, sorted by the
3191;;; (localized) name of each encoding.
3192(defun supported-nsstring-encodings ()
3193  (ccl::collect ((ids))
3194    (let* ((ns-ids (#/availableStringEncodings ns:ns-string)))
3195      (unless (%null-ptr-p ns-ids)
3196        (do* ((i 0 (1+ i)))
3197             ()
3198          (let* ((id (paref ns-ids (:* :<NSS>tring<E>ncoding) i)))
3199            (if (zerop id)
3200              (return (sort (ids)
3201                            #'(lambda (x y)
3202                                (= #$NSOrderedAscending
3203                                   (#/localizedCompare:
3204                                    (nsstring-for-nsstring-encoding x)
3205                                    (nsstring-for-nsstring-encoding y))))))
3206              (when (supported-string-encoding-p id)             
3207                (ids id)))))))))
3208
3209
3210
3211
3212
3213;;; TexEdit.app has support for allowing the encoding list in this
3214;;; popup to be customized (e.g., to suppress encodings that the
3215;;; user isn't interested in.)
3216(defmethod build-encodings-popup ((self hemlock-document-controller)
3217                                  &optional (preferred-encoding (get-default-encoding)))
3218  (let* ((id-list (supported-nsstring-encodings))
3219         (popup (make-instance 'ns:ns-pop-up-button)))
3220    ;;; Add a fake "Automatic" item with tag 0.
3221    (#/addItemWithTitle: popup #@"Automatic")
3222    (#/setTag: (#/itemAtIndex: popup 0) 0)
3223    (dolist (id id-list)
3224      (#/addItemWithTitle: popup (nsstring-for-nsstring-encoding id))
3225      (#/setTag: (#/lastItem popup) (nsstring-encoding-to-nsinteger id)))
3226    (when preferred-encoding
3227      (#/selectItemWithTag: popup (nsstring-encoding-to-nsinteger preferred-encoding)))
3228    (#/sizeToFit popup)
3229    popup))
3230
3231
3232(objc:defmethod (#/runModalOpenPanel:forTypes: :<NSI>nteger)
3233    ((self hemlock-document-controller) panel types)
3234  (let* (#-cocotron (popup (build-encodings-popup self #|preferred|#)))
3235    #-cocotron (#/setAccessoryView: panel popup)
3236    (let* ((result (call-next-method panel types)))
3237      (when (= result #$NSOKButton)
3238        #-cocotron
3239        (with-slots (last-encoding) self
3240          (setq last-encoding
3241                (nsinteger-to-nsstring-encoding (#/tag (#/selectedItem popup))))))
3242      result)))
3243 
3244(defun hemlock-ext:open-hemlock-buffer (&key (pathname :prompt))
3245  (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3246  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3247   (#/sharedDocumentController hemlock-document-controller)
3248   (@selector #/openDocument:) +null-ptr+ t))
3249 
3250(defun hemlock-ext:save-hemlock-buffer (buffer &key pathname copy)
3251  (let ((doc (hi::buffer-document buffer)))
3252    (cond (copy
3253           (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3254           (save-hemlock-document-as doc))
3255          ((null pathname)
3256           (save-hemlock-document doc))
3257          (t
3258           (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3259           (save-hemlock-document-to doc)))))
3260
3261(defmethod save-hemlock-document ((self hemlock-editor-document))
3262  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3263   self (@selector #/saveDocument:) +null-ptr+ t))
3264
3265(defmethod save-hemlock-document-as ((self hemlock-editor-document))
3266  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3267   self (@selector #/saveDocumentAs:) +null-ptr+ t))
3268
3269(defmethod save-hemlock-document-to ((self hemlock-editor-document))
3270  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3271   self (@selector #/saveDocumentTo:) +null-ptr+ t))
3272
3273
3274(defun maybe-fixup-application-menu ()
3275  ;; If the CFBundleName isn't #@"Clozure CL", then set the
3276  ;; title of any menu item on the application menu that ends
3277  ;; in #@"Clozure CL" to the CFBundleName.
3278  (let* ((bundle (#/mainBundle ns:ns-bundle))
3279         (dict (#/infoDictionary bundle))
3280         (cfbundlename (#/objectForKey: dict #@"CFBundleName"))
3281         (targetname #@"Clozure CL"))
3282    (unless (#/isEqualToString: cfbundlename targetname)
3283      (let* ((appmenu (#/submenu (#/itemAtIndex: (#/mainMenu *nsapp*)  0)))
3284             (numitems (#/numberOfItems appmenu)))
3285        (dotimes (i numitems)
3286          (let* ((item (#/itemAtIndex: appmenu i))
3287                 (title (#/title item)))
3288            (unless (%null-ptr-p title)
3289              (when (#/hasSuffix: title targetname)
3290                (let ((new-title (#/mutableCopy title)))
3291                  (ns:with-ns-range (r 0 (#/length new-title))
3292                    (#/replaceOccurrencesOfString:withString:options:range:
3293                     new-title targetname cfbundlename #$NSLiteralSearch r))
3294                  (#/setTitle: item new-title)
3295                  (#/release new-title))))))))))
3296
3297(defun initialize-user-interface ()
3298  ;; The first created instance of an NSDocumentController (or
3299  ;; subclass thereof) becomes the shared document controller.  So it
3300  ;; may look like we're dropping this instance on the floor, but
3301  ;; we're really not.
3302  (maybe-fixup-application-menu)
3303  (make-instance 'hemlock-document-controller)
3304  ;(#/sharedPanel lisp-preferences-panel)
3305  (make-editor-style-map))
3306
3307;;; This needs to run on the main thread.  Sets the cocoa selection from the
3308;;; hemlock selection.
3309(defmethod update-hemlock-selection ((self hemlock-text-storage))
3310  (assume-cocoa-thread)
3311  (let ((buffer (hemlock-buffer self)))
3312    (multiple-value-bind (start end) (hi:buffer-selection-range buffer)
3313      #+debug
3314      (#_NSLog #@"update Hemlock selection: charpos = %d, abspos = %d"
3315               :int (hi::mark-charpos (hi::buffer-point buffer)) :int start)
3316      (for-each-textview-using-storage
3317       self
3318       #'(lambda (tv)
3319           (#/updateSelection:length:affinity: tv
3320                                               start
3321                                               (- end start)
3322                                               (if (eql start 0)
3323                                                 #$NSSelectionAffinityUpstream
3324                                                 #$NSSelectionAffinityDownstream)))))))
3325
3326;; This should be invoked by any command that modifies the buffer, so it can show the
3327;; user what happened...  This ensures the Cocoa selection is made visible, so it
3328;; assumes the Cocoa selection has already been synchronized with the hemlock one.
3329(defmethod hemlock-ext:ensure-selection-visible ((view hi:hemlock-view))
3330  (let ((tv (text-pane-text-view (hi::hemlock-view-pane view))))
3331    (#/scrollRangeToVisible: tv (#/selectedRange tv))))
3332
3333(defloadvar *general-pasteboard* nil)
3334
3335(defun general-pasteboard ()
3336  (or *general-pasteboard*
3337      (setq *general-pasteboard*
3338            (#/retain (#/generalPasteboard ns:ns-pasteboard)))))
3339
3340(defloadvar *string-pasteboard-types* ())
3341
3342(defun string-pasteboard-types ()
3343  (or *string-pasteboard-types*
3344      (setq *string-pasteboard-types*
3345            (#/retain (#/arrayWithObject: ns:ns-array #&NSStringPboardType)))))
3346
3347
3348(objc:defmethod (#/stringToPasteBoard:  :void)
3349    ((self lisp-application) string)
3350  (let* ((pb (general-pasteboard)))
3351    (#/declareTypes:owner: pb (string-pasteboard-types) nil)
3352    (#/setString:forType: pb string #&NSStringPboardType)))
3353   
3354(defun hemlock-ext:string-to-clipboard (string)
3355  (when (> (length string) 0)
3356    (#/performSelectorOnMainThread:withObject:waitUntilDone:
3357     *nsapp* (@selector #/stringToPasteBoard:) (%make-nsstring string) t)))
3358
3359;;; The default #/paste method seems to want to set the font to
3360;;; something ... inappropriate.  If we can figure out why it
3361;;; does that and persuade it not to, we wouldn't have to do
3362;;; this here.
3363;;; (It's likely to also be the case that Carbon applications
3364;;; terminate lines with #\Return when writing to the clipboard;
3365;;; we may need to continue to override this method in order to
3366;;; fix that.)
3367(objc:defmethod (#/paste: :void) ((self hemlock-textstorage-text-view) sender)
3368  (declare (ignorable sender))
3369  #+debug (#_NSLog #@"Paste: sender = %@" :id sender)
3370  (let* ((pb (general-pasteboard))
3371         (string (progn (#/types pb) (#/stringForType: pb #&NSStringPboardType))))
3372    #+debug (log-debug "   string = ~s" string)
3373    (unless (%null-ptr-p string)
3374      (unless (zerop (ns:ns-range-length (#/rangeOfString: string *ns-cr-string*)))
3375        (setq string (make-instance 'ns:ns-mutable-string :with-string string))
3376        (#/replaceOccurrencesOfString:withString:options:range:
3377                string *ns-cr-string* *ns-lf-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string))))
3378      (let* ((textstorage (#/textStorage self)))
3379        (unless (#/shouldChangeTextInRange:replacementString: self (#/selectedRange self) string)
3380          (#/setSelectedRange: self (ns:make-ns-range (#/length textstorage) 0)))
3381        (let* ((selectedrange (#/selectedRange self)))
3382          ;; We really should bracket the call to
3383          ;; #/repaceCharactersInRange:withString: here with calls
3384          ;; to #/beginEditing and #/endEditing, but our implementation
3385          ;; of #/replaceCharactersInRange:withString: calls code that
3386          ;; asserts that editing isn't in progress.  Once that's
3387          ;; fixed, this should be fixed as well.
3388          (#/beginEditing textstorage)
3389          (#/replaceCharactersInRange:withString: textstorage selectedrange string)
3390          (#/endEditing textstorage)
3391          (update-hemlock-selection textstorage) )))))
3392
3393
3394(objc:defmethod (#/hyperSpecLookUp: :void)
3395    ((self hemlock-text-view) sender)
3396  (declare (ignore sender))
3397  (let* ((range (#/selectedRange self)))
3398    (unless (eql 0 (ns:ns-range-length range))
3399      (let* ((string (nstring-upcase (lisp-string-from-nsstring (#/substringWithRange: (#/string (#/textStorage self)) range)))))
3400        (multiple-value-bind (symbol win) (find-symbol string "CL")
3401          (when win
3402            (lookup-hyperspec-symbol symbol self)))))))
3403
3404
3405;; This is called by stuff that makes a window programmatically, e.g. m-. or grep.
3406;; But the Open and New menus invoke the cocoa fns below directly. So just changing
3407;; things here will not change how the menus create views.  Instead,f make changes to
3408;; the subfunctions invoked by the below, e.g. #/readFromURL or #/makeWindowControllers.
3409(defun find-or-make-hemlock-view (&optional pathname)
3410  (assume-cocoa-thread)
3411  (rlet ((perror :id +null-ptr+))
3412    (let* ((doc (if pathname
3413                  (#/openDocumentWithContentsOfURL:display:error:
3414                   (#/sharedDocumentController ns:ns-document-controller)
3415                   (pathname-to-url pathname)
3416                   #$YES
3417                   perror)
3418                  (let ((*last-document-created* nil))
3419                    (#/newDocument: 
3420                     (#/sharedDocumentController hemlock-document-controller)
3421                     +null-ptr+)
3422                    *last-document-created*))))
3423      #+debug (log-debug "created ~s" doc)
3424      (when (%null-ptr-p doc)
3425        (error "Couldn't open ~s: ~a" pathname
3426               (let ((error (pref perror :id)))
3427                 (if (%null-ptr-p error)
3428                   "unknown error encountered"
3429                   (lisp-string-from-nsstring (#/localizedDescription error))))))
3430      (front-view-for-buffer (hemlock-buffer doc)))))
3431
3432(defun hemlock-ext:execute-in-file-view (pathname thunk)
3433  (execute-in-gui #'(lambda ()
3434                      (assume-cocoa-thread)
3435                      (let ((view (find-or-make-hemlock-view pathname)))
3436                        (hi::handle-hemlock-event view thunk)))))
3437
3438(defun hemlock-ext:open-sequence-dialog (&key title sequence action (printer #'prin1))
3439  (make-instance 'sequence-window-controller
3440    :title title
3441    :sequence sequence
3442    :result-callback action
3443    :display printer))
3444
3445(objc:defmethod (#/documentClassForType: :<C>lass) ((self hemlock-document-controller)
3446                                                    type)
3447  (if (#/isEqualToString: type #@"html")
3448      display-document
3449      (call-next-method type)))
3450     
3451
3452(objc:defmethod #/newDisplayDocumentWithTitle:content:
3453                ((self hemlock-document-controller)
3454                 title
3455                 string)
3456  (assume-cocoa-thread)
3457  (let* ((doc (#/makeUntitledDocumentOfType:error: self #@"html" +null-ptr+)))
3458    (unless (%null-ptr-p doc)
3459      (#/addDocument: self doc)
3460      (#/makeWindowControllers doc)
3461      (let* ((window (#/window (#/objectAtIndex: (#/windowControllers doc) 0))))
3462        (#/setTitle: window title)
3463        (let* ((tv (slot-value doc 'text-view))
3464               (lm (#/layoutManager tv))
3465               (ts (#/textStorage lm)))
3466          (#/beginEditing ts)
3467          (#/replaceCharactersInRange:withAttributedString:
3468           ts
3469           (ns:make-ns-range 0 (#/length ts))
3470           string)
3471          (#/endEditing ts))
3472        (#/makeKeyAndOrderFront: window self)))
3473    doc))
3474
3475(defun hemlock-ext:revert-hemlock-buffer (buffer)
3476  (let* ((doc (hi::buffer-document buffer)))
3477    (when doc
3478      (#/performSelectorOnMainThread:withObject:waitUntilDone:
3479       doc
3480       (@selector #/revertDocumentToSaved:)
3481       +null-ptr+
3482       t))))
3483
3484(defun hemlock-ext:raise-buffer-view (buffer &optional action)
3485  "Bring a window containing buffer to front and then execute action in
3486   the window.  Returns before operation completes."
3487  ;; Queue for after this event, so don't screw up current context.
3488  (queue-for-gui #'(lambda ()
3489                     (let ((doc (hi::buffer-document buffer)))
3490                       (unless (and doc (not (%null-ptr-p doc)))
3491                         (hi:editor-error "Deleted buffer: ~s" buffer))
3492                       (#/showWindows doc)
3493                       (when action
3494                         (hi::handle-hemlock-event (front-view-for-buffer buffer) action))))))
3495
3496;;; Enable CL:ED
3497(defun cocoa-edit (&optional arg)
3498  (cond ((or (null arg)
3499             (typep arg 'string)
3500             (typep arg 'pathname))
3501         (when arg
3502           (unless (probe-file arg)
3503             (let ((lpath (merge-pathnames arg *.lisp-pathname*)))
3504               (when (probe-file lpath) (setq arg lpath)))))
3505         (execute-in-gui #'(lambda () (find-or-make-hemlock-view arg))))
3506        ((ccl::valid-function-name-p arg)
3507         (hemlock::edit-definition arg)
3508         nil)
3509        (t (report-bad-arg arg '(or null string pathname (satisfies ccl::valid-function-name-p))))))
3510
3511(setq ccl::*resident-editor-hook* 'cocoa-edit)
3512
3513#-cocotron
3514(defclass url-handler-command (ns:ns-script-command)
3515  ()
3516  (:documentation
3517   "Handles AppleEvents that send us URLs to open. Both logical pathnames
3518    ('ccl:lib;foo.lisp') and symbols (ccl::*current-process*) can be parsed as a URL
3519    with a scheme of 'ccl'. So, we accept those as URLs, and handle them appropriately.")
3520  (:metaclass ns:+ns-script-command))
3521
3522#-cocotron
3523(objc:defmethod #/performDefaultImplementation ((self url-handler-command))
3524  (let* ((string (ccl::lisp-string-from-nsstring (#/directParameter self)))
3525         (symbol (let ((*read-eval* nil))
3526                   (handler-case (read-from-string string)
3527                     (error () nil)))))
3528    (if symbol
3529      (hemlock::edit-definition symbol)
3530      (execute-in-gui #'(lambda ()
3531                          (find-or-make-hemlock-view
3532                           (if (probe-file string)
3533                             string
3534                             (let ((lpath (merge-pathnames string *.lisp-pathname*)))
3535                               (when (probe-file lpath)
3536                                 lpath))))))))
3537  +null-ptr+)
Note: See TracBrowser for help on using the repository browser.