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

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

Needs more testing on Cocotron ...

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 152.1 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;;; This assumes that NSBackgroundColorAttributeName can only be
1129;;; present id it's (possibly stale) paren highlighting info.
1130;;; We can't be sure of the locations (because of insertions/deletions),
1131;;; so remove the attribute from the entire textstorage.
1132(defmethod remove-paren-highlight ((self hemlock-textstorage-text-view))
1133  (let* ((textstorage (#/textStorage self))
1134         (len (#/length textstorage)))
1135    (#/beginEditing textstorage)
1136    (ns:with-ns-range  (char-range 0 len)
1137      (#/removeAttribute:range: textstorage #&NSBackgroundColorAttributeName
1138                                char-range))
1139    (#/endEditing textstorage)))
1140
1141(defmethod disable-paren-highlight ((self hemlock-textstorage-text-view))
1142  (when (eql (text-view-paren-highlight-enabled self) #$YES)
1143    (setf (text-view-paren-highlight-enabled self) #$NO)
1144    (remove-paren-highlight self)))
1145
1146
1147(defmethod compute-temporary-attributes ((self hemlock-textstorage-text-view))    (let* ((container (#/textContainer self))
1148         ;; If there's a containing scroll view, use its contentview         
1149         ;; Otherwise, just use the current view.
1150         (scrollview (#/enclosingScrollView self))
1151         (contentview (if (%null-ptr-p scrollview) self (#/contentView scrollview)))
1152         (rect (#/bounds contentview))
1153         (layout (#/layoutManager container))
1154         (glyph-range (#/glyphRangeForBoundingRect:inTextContainer:
1155                       layout rect container))
1156         (char-range (#/characterRangeForGlyphRange:actualGlyphRange:
1157                      layout glyph-range +null-ptr+))
1158         (start (ns:ns-range-location char-range))
1159         (length (ns:ns-range-length char-range)))
1160                                                                                    #-cocotron
1161    (when (> length 0)
1162      ;; Remove all temporary attributes from the character range
1163      (#/removeTemporaryAttribute:forCharacterRange:
1164       layout #&NSForegroundColorAttributeName char-range)
1165      (#/removeTemporaryAttribute:forCharacterRange:
1166       layout #&NSBackgroundColorAttributeName char-range)
1167      (let* ((ts (#/textStorage self))
1168             (cache (hemlock-buffer-string-cache (slot-value ts 'hemlock-string)))
1169             (hi::*current-buffer* (buffer-cache-buffer cache)))
1170        (multiple-value-bind (start-line start-offset)
1171                             (update-line-cache-for-index cache start)
1172          (let* ((end-line (update-line-cache-for-index cache (+ start length))))
1173            (set-temporary-character-attributes
1174             layout
1175             (- start start-offset)
1176             start-line
1177             (hi::line-next end-line))))))
1178    (when (eql #$YES (text-view-paren-highlight-enabled self))
1179      (let* ((background #&NSBackgroundColorAttributeName)
1180             (paren-highlight-left (text-view-paren-highlight-left-pos self))
1181             (paren-highlight-right (text-view-paren-highlight-right-pos self))
1182             (paren-highlight-color (text-view-paren-highlight-color self))
1183             (attrs (#/dictionaryWithObject:forKey: ns:ns-dictionary
1184                                                    paren-highlight-color
1185                                                    background))
1186             (ts (#/textStorage self)))
1187        (ns:with-ns-range (left-range paren-highlight-left 1)
1188          (ns:with-ns-range (right-range paren-highlight-right 1)
1189            (#/beginEditing ts)
1190            (#/addAttributes:range: ts attrs left-range)
1191            ;(#/edited:range:changeInLength: ts #$NSTextStorageEditedAttributes left-range 0)
1192            (#/addAttributes:range: ts attrs right-range)
1193            ;(#/edited:range:changeInLength: ts #$NSTextStorageEditedAttributes right-range 0)
1194            (#/endEditing ts)))))))
1195
1196(defmethod update-paren-highlight ((self hemlock-textstorage-text-view))
1197  (disable-paren-highlight self)
1198  (let* ((buffer (hemlock-buffer self)))
1199    (when (and buffer (string= (hi::buffer-major-mode buffer) "Lisp"))
1200      (let* ((hi::*current-buffer* buffer)
1201             (point (hi::buffer-point buffer)))
1202        #+debug (#_NSLog #@"Syntax check for paren-highlighting")
1203        (update-buffer-package (hi::buffer-document buffer) buffer)
1204        (cond ((eql (hi::next-character point) #\()
1205               (hemlock::pre-command-parse-check point)
1206               (when (hemlock::valid-spot point t)
1207                 (hi::with-mark ((temp point))
1208                   (when (hemlock::list-offset temp 1)
1209                     #+debug (#_NSLog #@"enable paren-highlight, forward")
1210                     (setf (text-view-paren-highlight-right-pos self)
1211                           (1- (hi:mark-absolute-position temp))
1212                           (text-view-paren-highlight-left-pos self)
1213                           (hi::mark-absolute-position point)
1214                           (text-view-paren-highlight-enabled self) #$YES)))))
1215              ((eql (hi::previous-character point) #\))
1216               (hemlock::pre-command-parse-check point)
1217               (when (hemlock::valid-spot point nil)
1218                 (hi::with-mark ((temp point))
1219                   (when (hemlock::list-offset temp -1)
1220                     #+debug (#_NSLog #@"enable paren-highlight, backward")
1221                     (setf (text-view-paren-highlight-left-pos self)
1222                           (hi:mark-absolute-position temp)
1223                           (text-view-paren-highlight-right-pos self)
1224                           (1- (hi:mark-absolute-position point))
1225                           (text-view-paren-highlight-enabled self) #$YES))))))
1226        (compute-temporary-attributes self)))))
1227
1228
1229
1230;;; Set and display the selection at pos, whose length is len and whose
1231;;; affinity is affinity.  This should never be called from any Cocoa
1232;;; event handler; it should not call anything that'll try to set the
1233;;; underlying buffer's point and/or mark
1234
1235(objc:defmethod (#/updateSelection:length:affinity: :void)
1236    ((self hemlock-textstorage-text-view)
1237     (pos :int)
1238     (length :int)
1239     (affinity :<NSS>election<A>ffinity))
1240  (assume-cocoa-thread)
1241  (when (eql length 0)
1242    (update-paren-highlight self))
1243  (let* ((buffer (hemlock-buffer self)))
1244    (setf (hi::buffer-selection-set-by-command buffer) (> length 0)))
1245  (rlet ((range :ns-range :location pos :length length))
1246    (ccl::%call-next-objc-method self
1247                                 hemlock-textstorage-text-view
1248                                 (@selector #/setSelectedRange:affinity:stillSelecting:)
1249                                 '(:void :<NSR>ange :<NSS>election<A>ffinity :<BOOL>)
1250                                 range
1251                                 affinity
1252                                 nil)
1253    (assume-not-editing self)
1254    (when (> length 0)
1255      (let* ((ts (#/textStorage self)))
1256        (with-slots (selection-set-by-search) ts
1257          (when (prog1 (eql #$YES selection-set-by-search)
1258                  (setq selection-set-by-search #$NO))
1259            (highlight-search-selection self pos length)))))
1260    ))
1261
1262(defloadvar *can-use-show-find-indicator-for-range*
1263    (#/instancesRespondToSelector: ns:ns-text-view (@selector "showFindIndicatorForRange:")))
1264
1265;;; Add transient highlighting to a selection established via a search
1266;;; primitive, if the OS supports it.
1267(defun highlight-search-selection (tv pos length)
1268  (when *can-use-show-find-indicator-for-range*
1269    (ns:with-ns-range (r pos length)
1270      (objc-message-send tv "showFindIndicatorForRange:" :<NSR>ange r :void))))
1271 
1272;;; A specialized NSTextView. The NSTextView is part of the "pane"
1273;;; object that displays buffers.
1274(defclass hemlock-text-view (hemlock-textstorage-text-view)
1275    ((pane :foreign-type :id :accessor text-view-pane)
1276     (char-width :foreign-type :<CGF>loat :accessor text-view-char-width)
1277     (line-height :foreign-type :<CGF>loat :accessor text-view-line-height))
1278  (:metaclass ns:+ns-object))
1279(declaim (special hemlock-text-view))
1280
1281
1282(defloadvar *lisp-string-color* (#/blueColor ns:ns-color))
1283(defloadvar *lisp-comment-color* (#/brownColor ns:ns-color))
1284
1285;;; LAYOUT is an NSLayoutManager in which we'll set temporary character
1286;;; attrubutes before redisplay.
1287;;; POS is the absolute character position of the start of START-LINE.
1288;;; END-LINE is either EQ to START-LNE (in the degenerate case) or
1289;;; follows it in the buffer; it may be NIL and is the exclusive
1290;;; end of a range of lines
1291;;; HI::*CURRENT-BUFFER* is bound to the buffer containing START-LINE
1292;;; and END-LINE
1293(defun set-temporary-character-attributes (layout pos start-line end-line)
1294  (ns:with-ns-range (range)
1295    (let* ((color-attribute #&NSForegroundColorAttributeName)
1296           (string-color  *lisp-string-color* )
1297           (comment-color *lisp-comment-color*))
1298      (hi::with-mark ((m (hi::buffer-start-mark hi::*current-buffer*)))
1299        (hi::line-start m start-line)
1300        (hi::pre-command-parse-check m))
1301      (do ((p pos (+ p (1+ (hi::line-length line))))
1302           (line start-line (hi::line-next line)))
1303          ((eq line end-line))
1304        (let* ((parse-info (getf (hi::line-plist line) 'hemlock::lisp-info))
1305               (last-end 0))
1306          (when parse-info
1307            (dolist (r (hemlock::lisp-info-ranges-to-ignore parse-info))
1308              (destructuring-bind (istart . iend) r
1309                (let* ((attr (if (= istart 0)
1310                               (hemlock::lisp-info-begins-quoted parse-info)
1311                               (if (< last-end istart)
1312                                 (hi:character-attribute :lisp-syntax
1313                                                         (hi::line-character line (1- istart)))
1314                                 :comment)))
1315                       (type (case attr
1316                               ((:char-quote :symbol-quote) nil)
1317                               (:string-quote :string)
1318                               (t :comment)))
1319                       (start (+ p istart))
1320                       (len (- iend istart)))
1321                  (when type
1322                    (when (eq type :string)
1323                      (decf start)
1324                      (incf len 2))
1325                    (setf (ns:ns-range-location range) start
1326                          (ns:ns-range-length range) len)
1327                    (let ((attrs (if (eq type :string) string-color comment-color)))
1328                      (#/addTemporaryAttribute:value:forCharacterRange:
1329                       layout color-attribute attrs range)))
1330                  (setq last-end iend))))))))))
1331
1332#+no
1333(objc:defmethod (#/drawRect: :void) ((self hemlock-text-view) (rect :<NSR>ect))
1334  ;; Um, don't forget to actually draw the view..
1335  (call-next-method  rect))
1336
1337
1338(defmethod hemlock-view ((self hemlock-text-view))
1339  (let ((pane (text-view-pane self)))
1340    (when pane (hemlock-view pane))))
1341
1342
1343
1344(objc:defmethod (#/evalSelection: :void) ((self hemlock-text-view) sender)
1345  (declare (ignore sender))
1346  ;; TODO: this should just invoke editor-evaluate-region-command instead of reinventing the wheel.
1347  (let* ((buffer (hemlock-buffer self))
1348         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer))
1349         (pathname (hi::buffer-pathname buffer))
1350         ;; Cocotron issue 380: NSTextView doesn't implement #/selectedRanges and
1351         ;;  #/setSelectedRanges: methods.
1352         #-cocotron (ranges (#/selectedRanges self))
1353         #+cocotron (ranges (#/arrayWithObject: ns:ns-array 
1354                                                (#/valueWithRange: ns:ns-value
1355                                                                   (#/selectedRange self))))
1356         (text (#/string self)))
1357    (dotimes (i (#/count ranges))
1358      (let* ((r (#/rangeValue (#/objectAtIndex: ranges i)))
1359             (s (#/substringWithRange: text r))
1360             (o (ns:ns-range-location r)))
1361        (setq s (lisp-string-from-nsstring s))
1362        (ui-object-eval-selection *NSApp* (list package-name pathname s o))))))
1363
1364(objc:defmethod (#/evalAll: :void) ((self hemlock-text-view) sender)
1365  (declare (ignore sender))
1366  (let* ((buffer (hemlock-buffer self))
1367         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1368         (pathname (hi::buffer-pathname buffer))
1369         (s (lisp-string-from-nsstring (#/string self))))
1370    (ui-object-eval-selection *NSApp* (list package-name pathname s))))
1371
1372(objc:defmethod (#/loadBuffer: :void) ((self hemlock-text-view) sender)
1373  (declare (ignore sender))
1374  (let* ((buffer (hemlock-buffer self))
1375         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1376         (pathname (hi::buffer-pathname buffer)))
1377    (ui-object-load-buffer *NSApp* (list package-name pathname))))
1378
1379(objc:defmethod (#/compileBuffer: :void) ((self hemlock-text-view) sender)
1380  (declare (ignore sender))
1381  (let* ((buffer (hemlock-buffer self))
1382         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1383         (pathname (hi::buffer-pathname buffer)))
1384    (ui-object-compile-buffer *NSApp* (list package-name pathname))))
1385
1386(objc:defmethod (#/compileAndLoadBuffer: :void) ((self hemlock-text-view) sender)
1387  (declare (ignore sender))
1388  (let* ((buffer (hemlock-buffer self))
1389         (package-name (hi::variable-value 'hemlock::default-package :buffer buffer))
1390         (pathname (hi::buffer-pathname buffer)))
1391    (ui-object-compile-and-load-buffer *NSApp* (list package-name pathname))))
1392
1393(defloadvar *text-view-context-menu* ())
1394
1395(defun text-view-context-menu ()
1396  (or *text-view-context-menu*
1397      (setq *text-view-context-menu*
1398            (#/retain
1399             (let* ((menu (make-instance 'ns:ns-menu :with-title #@"Menu")))
1400               (#/addItemWithTitle:action:keyEquivalent:
1401                menu #@"Cut" (@selector #/cut:) #@"")
1402               (#/addItemWithTitle:action:keyEquivalent:
1403                menu #@"Copy" (@selector #/copy:) #@"")
1404               (#/addItemWithTitle:action:keyEquivalent:
1405                menu #@"Paste" (@selector #/paste:) #@"")
1406               ;; Separator
1407               (#/addItem: menu (#/separatorItem ns:ns-menu-item))
1408               (#/addItemWithTitle:action:keyEquivalent:
1409                menu #@"Background Color ..." (@selector #/changeBackgroundColor:) #@"")
1410               (#/addItemWithTitle:action:keyEquivalent:
1411                menu #@"Text Color ..." (@selector #/changeTextColor:) #@"")
1412
1413               menu)))))
1414
1415
1416
1417
1418
1419(objc:defmethod (#/changeBackgroundColor: :void)
1420    ((self hemlock-text-view) sender)
1421  (let* ((colorpanel (#/sharedColorPanel ns:ns-color-panel))
1422         (color (#/backgroundColor self)))
1423    (#/close colorpanel)
1424    (#/setAction: colorpanel (@selector #/updateBackgroundColor:))
1425    (#/setColor: colorpanel color)
1426    (#/setTarget: colorpanel self)
1427    (#/setContinuous: colorpanel nil)
1428    (#/orderFrontColorPanel: *NSApp* sender)))
1429
1430
1431
1432(objc:defmethod (#/updateBackgroundColor: :void)
1433    ((self hemlock-text-view) sender)
1434  (when (#/isVisible sender)
1435    (let* ((color (#/color sender)))
1436      (unless (typep self 'echo-area-view)
1437        (let* ((window (#/window self))
1438               (echo-view (unless (%null-ptr-p window)
1439                            (slot-value window 'echo-area-view))))
1440          (when echo-view (#/setBackgroundColor: echo-view color))))
1441      #+debug (#_NSLog #@"Updating backgroundColor to %@, sender = %@" :id color :id sender)
1442      (#/setBackgroundColor: self color))))
1443
1444(objc:defmethod (#/changeTextColor: :void)
1445    ((self hemlock-text-view) sender)
1446  (let* ((colorpanel (#/sharedColorPanel ns:ns-color-panel))
1447         (textstorage (#/textStorage self))
1448         (color (#/objectForKey:
1449                 (#/objectAtIndex: (slot-value textstorage 'styles) 0)
1450                 #&NSForegroundColorAttributeName)))
1451    (#/close colorpanel)
1452    (#/setAction: colorpanel (@selector #/updateTextColor:))
1453    (#/setColor: colorpanel color)
1454    (#/setTarget: colorpanel self)
1455    (#/setContinuous: colorpanel nil)
1456    (#/orderFrontColorPanel: *NSApp* sender)))
1457
1458
1459
1460
1461
1462
1463   
1464(objc:defmethod (#/updateTextColor: :void)
1465    ((self hemlock-textstorage-text-view) sender)
1466  (unwind-protect
1467      (progn
1468        (#/setUsesFontPanel: self t)
1469        (ccl::%call-next-objc-method
1470         self
1471         hemlock-textstorage-text-view
1472         (@selector #/changeColor:)
1473         '(:void :id)
1474         sender))
1475    (#/setUsesFontPanel: self nil))
1476  (#/setNeedsDisplay: self t))
1477   
1478(objc:defmethod (#/updateTextColor: :void)
1479    ((self hemlock-text-view) sender)
1480  (let* ((textstorage (#/textStorage self))
1481         (styles (slot-value textstorage 'styles))
1482         (newcolor (#/color sender)))
1483    (dotimes (i (#/count styles))
1484      (let* ((dict (#/objectAtIndex: styles i)))
1485        (#/setValue:forKey: dict newcolor #&NSForegroundColorAttributeName)))
1486    (call-next-method sender)))
1487
1488
1489
1490(defmethod text-view-string-cache ((self hemlock-textstorage-text-view))
1491  (hemlock-buffer-string-cache (#/hemlockString (#/textStorage self))))
1492
1493#-cocotron                             ; for now, small struct return FFI issue
1494
1495(objc:defmethod (#/selectionRangeForProposedRange:granularity: :ns-range)
1496    ((self hemlock-textstorage-text-view)
1497     (proposed :ns-range)
1498     (g :<NSS>election<G>ranularity))
1499  #+debug
1500  (#_NSLog #@"Granularity = %d" :int g)
1501  (objc:returning-foreign-struct (r)
1502     (block HANDLED
1503       (let* ((index (ns:ns-range-location proposed)) 
1504              (length (ns:ns-range-length proposed))
1505              (textstorage (#/textStorage self)))
1506         (when (and (eql 0 length)      ; not extending existing selection
1507                    (or (not (eql g #$NSSelectByCharacter))
1508                        (and (eql index (#/length textstorage))
1509                             (let* ((event (#/currentEvent (#/window self))))
1510                               (and (eql (#/type event) #$NSLeftMouseDown)
1511                                    (> (#/clickCount event) 1))))))
1512           (let* ((cache (hemlock-buffer-string-cache (#/hemlockString textstorage)))
1513                  (buffer (buffer-cache-buffer cache))
1514                  (hi::*current-buffer* buffer)
1515                  (point (hi::buffer-point buffer))
1516                  (atom-mode (or (eql g #$NSSelectByParagraph)
1517                                 (and (eql index (#/length textstorage))
1518                                      (let* ((event (#/currentEvent (#/window self))))
1519                                        (and (eql (#/type event) #$NSLeftMouseDown)
1520                                             (> (#/clickCount event) 2)))))))
1521             (hi::with-mark ((mark point))
1522               (let ((region (selection-for-click mark atom-mode)))
1523                 (when region
1524                   ;; Act as if we started the selection at the other end, so the heuristic
1525                   ;; in #/selectionRangeForProposedRange does the right thing.  ref bug #565.
1526                   (cond ((hi::mark= (hi::region-start region) mark)
1527                          (hi::move-mark point (hi::region-end region)))
1528                         ((hi::mark= (hi::region-end region) mark)
1529                          (hi::move-mark point (hi::region-start region))))
1530                   (let ((start (hi::mark-absolute-position (hi::region-start region)))
1531                         (end (hi::mark-absolute-position (hi::region-end region))))
1532                     (assert (<= start end))
1533                     (ns:init-ns-range r start (- end start)))
1534                   #+debug
1535                   (#_NSLog #@"range = %@, proposed = %@, granularity = %d"
1536                            :address (#_NSStringFromRange r)
1537                            :address (#_NSStringFromRange proposed)
1538                            :<NSS>election<G>ranularity g)
1539                   (return-from HANDLED r)))))))
1540       (prog1
1541           (call-next-method proposed g)
1542         #+debug
1543         (#_NSLog #@"range = %@, proposed = %@, granularity = %d"
1544                  :address (#_NSStringFromRange r)
1545                  :address (#_NSStringFromRange proposed)
1546                  :<NSS>election<G>ranularity g)))))
1547
1548;; Return nil to use the default Cocoa selection, which will be word for double-click, line for triple.
1549(defun selection-for-click (mark paragraph-mode-p)
1550  (unless paragraph-mode-p
1551    ;; Select a word if near one
1552    (hi::with-mark ((fwd mark)
1553                    (bwd mark))
1554      (or (hi::find-attribute fwd :word-delimiter)
1555          (hi::buffer-end fwd))
1556      (or (hi::reverse-find-attribute bwd :word-delimiter)
1557          (hi::buffer-start bwd))
1558      (unless (hi::mark= bwd fwd)
1559        (return-from selection-for-click (hi::region bwd fwd)))))
1560  (when (string= (hi::buffer-major-mode (hi::mark-buffer mark)) "Lisp") ;; gag
1561    (hemlock::pre-command-parse-check mark)
1562    (hemlock::form-region-at-mark mark)))
1563
1564(defun append-output (view string)
1565  (assume-cocoa-thread)
1566  ;; Arrange to do the append in command context
1567  (when view
1568    (hi::handle-hemlock-event view #'(lambda ()
1569                                       (hemlock::append-buffer-output (hi::hemlock-view-buffer view) string)))))
1570
1571
1572;;; Update the underlying buffer's point (and "active region", if appropriate.
1573;;; This is called in response to a mouse click or other event; it shouldn't
1574;;; be called from the Hemlock side of things.
1575
1576(objc:defmethod (#/setSelectedRange:affinity:stillSelecting: :void)
1577    ((self hemlock-text-view)
1578     (r :<NSR>ange)
1579     (affinity :<NSS>election<A>ffinity)
1580     (still-selecting :<BOOL>))
1581  #+debug
1582  (#_NSLog #@"Set selected range called: range = %@, affinity = %d, still-selecting = %d"
1583           :address (#_NSStringFromRange r)
1584           :<NSS>election<A>ffinity affinity
1585           :<BOOL> (if still-selecting #$YES #$NO))
1586  #+debug
1587  (#_NSLog #@"text view string = %@, textstorage string = %@"
1588           :id (#/string self)
1589           :id (#/string (#/textStorage self)))
1590  (unless (#/editingInProgress (#/textStorage self))
1591    (let* ((d (hemlock-buffer-string-cache (#/hemlockString (#/textStorage self))))
1592           (buffer (buffer-cache-buffer d))
1593           (hi::*current-buffer* buffer)
1594           (point (hi::buffer-point buffer))
1595           (location (pref r :<NSR>ange.location))
1596           (len (pref r :<NSR>ange.length)))
1597      (setf (hi::buffer-selection-set-by-command buffer) nil)
1598      (cond ((eql len 0)
1599             #+debug
1600             (#_NSLog #@"Moving point to absolute position %d" :int location)
1601             (setf (hi::buffer-region-active buffer) nil)
1602             (move-hemlock-mark-to-absolute-position point d location)
1603             (update-paren-highlight self))
1604            (t
1605             ;; We don't get much information about which end of the
1606             ;; selection the mark's at and which end point is at, so
1607             ;; we have to sort of guess.  In every case I've ever seen,
1608             ;; selection via the mouse generates a sequence of calls to
1609             ;; this method whose parameters look like:
1610             ;; a: range: {n0,0} still-selecting: false  [ rarely repeats ]
1611             ;; b: range: {n0,0) still-selecting: true   [ rarely repeats ]
1612             ;; c: range: {n1,m} still-selecting: true   [ often repeats ]
1613             ;; d: range: {n1,m} still-selecting: false  [ rarely repeats ]
1614             ;;
1615             ;; (Sadly, "affinity" doesn't tell us anything interesting.)
1616             ;; We've handled a and b in the clause above; after handling
1617             ;; b, point references buffer position n0 and the
1618             ;; region is inactive.
1619             ;; Let's ignore c, and wait until the selection's stabilized.
1620             ;; Make a new mark, a copy of point (position n0).
1621             ;; At step d (here), we should have either
1622             ;; d1) n1=n0.  Mark stays at n0, point moves to n0+m.
1623             ;; d2) n1+m=n0.  Mark stays at n0, point moves to n0-m.
1624             ;; If neither d1 nor d2 apply, arbitrarily assume forward
1625             ;; selection: mark at n1, point at n1+m.
1626             ;; In all cases, activate Hemlock selection.
1627             (unless still-selecting
1628                (let* ((pointpos (hi:mark-absolute-position point))
1629                       (selection-end (+ location len))
1630                       (mark (hi::copy-mark point :right-inserting)))
1631                   (cond ((eql pointpos location)
1632                          (move-hemlock-mark-to-absolute-position point
1633                                                                  d
1634                                                                  selection-end))
1635                         ((eql pointpos selection-end)
1636                          (move-hemlock-mark-to-absolute-position point
1637                                                                  d
1638                                                                  location))
1639                         (t
1640                          (move-hemlock-mark-to-absolute-position mark
1641                                                                  d
1642                                                                  location)
1643                          (move-hemlock-mark-to-absolute-position point
1644                                                                  d
1645                                                                  selection-end)))
1646                   (hemlock::%buffer-push-buffer-mark buffer mark t)))))))
1647  (call-next-method r affinity still-selecting))
1648
1649
1650
1651;;; Modeline-view
1652
1653(defclass modeline-view (ns:ns-view)
1654    ((pane :foreign-type :id :accessor modeline-view-pane)
1655     (text-attributes :foreign-type :id :accessor modeline-text-attributes))
1656  (:metaclass ns:+ns-object))
1657
1658(objc:defmethod #/initWithFrame: ((self modeline-view) (frame :<NSR>ect))
1659  (call-next-method frame)
1660  (let* ((size (#/smallSystemFontSize ns:ns-font))
1661         (font (#/systemFontOfSize: ns:ns-font size))
1662         (dict (#/dictionaryWithObject:forKey: ns:ns-dictionary font #&NSFontAttributeName)))
1663    (setf (modeline-text-attributes self) (#/retain dict)))
1664  self)
1665
1666;;; Find the underlying buffer.
1667(defun buffer-for-modeline-view (mv)
1668  (let* ((pane (modeline-view-pane mv)))
1669    (unless (%null-ptr-p pane)
1670      (let* ((tv (text-pane-text-view pane)))
1671        (unless (%null-ptr-p tv)
1672          (hemlock-buffer tv))))))
1673
1674;;; Draw a string in the modeline view.  The font and other attributes
1675;;; are initialized lazily; apparently, calling the Font Manager too
1676;;; early in the loading sequence confuses some Carbon libraries that're
1677;;; used in the event dispatch mechanism,
1678(defun draw-modeline-string (the-modeline-view)
1679  (with-slots (text-attributes) the-modeline-view
1680    (let* ((buffer (buffer-for-modeline-view the-modeline-view)))
1681      (when buffer
1682        (let* ((string
1683                (apply #'concatenate 'string
1684                       (mapcar
1685                        #'(lambda (field)
1686                            (or (ignore-errors 
1687                                  (funcall (hi::modeline-field-function field) buffer))
1688                                ""))
1689                        (hi::buffer-modeline-fields buffer)))))
1690          (#/drawAtPoint:withAttributes: (#/autorelease (%make-nsstring string))
1691                                         (ns:make-ns-point 5 1)
1692                                         text-attributes))))))
1693
1694(objc:defmethod (#/drawRect: :void) ((self modeline-view) (rect :<NSR>ect))
1695  (declare (ignorable rect))
1696  (let* ((bounds (#/bounds self))
1697         (context (#/currentContext ns:ns-graphics-context)))
1698    (#/saveGraphicsState context)
1699    (#/set (#/colorWithCalibratedWhite:alpha: ns:ns-color 0.9 1.0))
1700    (#_NSRectFill bounds)
1701    (#/set (#/colorWithCalibratedWhite:alpha: ns:ns-color 0.3333 1.0))
1702    ;; Draw borders on top and bottom.
1703    (ns:with-ns-rect (r 0 0.5 (ns:ns-rect-width bounds) 0.5)
1704      (#_NSRectFill r))
1705    (ns:with-ns-rect (r 0 (- (ns:ns-rect-height bounds) 0.5)
1706                        (ns:ns-rect-width bounds) (- (ns:ns-rect-height bounds) 0.5))
1707      (#_NSRectFill r))
1708    (draw-modeline-string self)
1709    (#/restoreGraphicsState context)))
1710
1711;;; Hook things up so that the modeline is updated whenever certain buffer
1712;;; attributes change.
1713(hi::%init-mode-redisplay)
1714
1715
1716;;; A clip view subclass, which exists mostly so that we can track origin changes.
1717(defclass text-pane-clip-view (ns:ns-clip-view)
1718  ()
1719  (:metaclass ns:+ns-object))
1720
1721(objc:defmethod (#/scrollToPoint: :void) ((self text-pane-clip-view)
1722                                           (origin #>NSPoint))
1723  (unless (#/inLiveResize self)
1724    (call-next-method origin)
1725    (compute-temporary-attributes (#/documentView self))))
1726
1727;;; Text-pane
1728
1729;;; The text pane is just an NSBox that (a) provides a draggable border
1730;;; around (b) encapsulates the text view and the mode line.
1731
1732(defclass text-pane (ns:ns-box)
1733    ((hemlock-view :initform nil :reader text-pane-hemlock-view)
1734     (text-view :foreign-type :id :accessor text-pane-text-view)
1735     (mode-line :foreign-type :id :accessor text-pane-mode-line)
1736     (scroll-view :foreign-type :id :accessor text-pane-scroll-view))
1737  (:metaclass ns:+ns-object))
1738
1739(defmethod hemlock-view ((self text-pane))
1740  (text-pane-hemlock-view self))
1741
1742;;; This method gets invoked on the text pane, which is its containing
1743;;; window's delegate object.
1744(objc:defmethod (#/windowDidResignKey: :void)
1745    ((self text-pane) notification)
1746  (declare (ignorable notification))
1747  ;; When the window loses focus, we should remove or change transient
1748  ;; highlighting (like matching-paren highlighting).  Maybe make this
1749  ;; more general ...
1750  ;; Currently, this only removes temporary attributes from matching
1751  ;; parens; other kinds of syntax highlighting stays visible when
1752  ;; the containing window loses keyboard focus
1753  (let* ((tv (text-pane-text-view self)))
1754    (remove-paren-highlight tv)
1755    (remove-paren-highlight (slot-value tv 'peer))))
1756
1757;;; Likewise, reactivate transient highlighting when the window gets
1758;;; focus.
1759(objc:defmethod (#/windowDidBecomeKey: :void)
1760    ((self text-pane) notification)
1761  (declare (ignorable notification))
1762  (let* ((tv (text-pane-text-view self)))
1763    (compute-temporary-attributes tv)
1764    (compute-temporary-attributes (slot-value tv 'peer))))
1765 
1766
1767;;; Mark the buffer's modeline as needing display.  This is called whenever
1768;;; "interesting" attributes of a buffer are changed.
1769(defun hemlock-ext:invalidate-modeline (buffer)
1770  (let* ((doc (hi::buffer-document buffer)))
1771    (when doc
1772      (document-invalidate-modeline doc))))
1773
1774(def-cocoa-default *text-pane-margin-width* :float 0.0f0 "width of indented margin around text pane")
1775(def-cocoa-default *text-pane-margin-height* :float 0.0f0 "height of indented margin around text pane")
1776
1777
1778(objc:defmethod #/initWithFrame: ((self text-pane) (frame :<NSR>ect))
1779  (let* ((pane (call-next-method frame)))
1780    (unless (%null-ptr-p pane)
1781      (#/setAutoresizingMask: pane (logior
1782                                    #$NSViewWidthSizable
1783                                    #$NSViewHeightSizable))
1784      (#/setBoxType: pane #$NSBoxPrimary)
1785      (#/setBorderType: pane #$NSNoBorder)
1786      (#/setContentViewMargins: pane (ns:make-ns-size *text-pane-margin-width*  *text-pane-margin-height*))
1787      (#/setTitlePosition: pane #$NSNoTitle))
1788    pane))
1789
1790(objc:defmethod #/defaultMenu ((class +hemlock-text-view))
1791  (text-view-context-menu))
1792
1793(defun pathname-for-namestring-fragment (string)
1794  "Return a pathname that STRING might designate."
1795  ;; We could get fancy here, but for now just be stupid.
1796  (let* ((rfs (ignore-errors (read-from-string string nil nil)))
1797         (pathname (or (ignore-errors (probe-file string))
1798                       (ignore-errors (probe-file rfs))
1799                       (ignore-errors (probe-file (merge-pathnames *.lisp-pathname* string)))
1800                       (ignore-errors (probe-file (merge-pathnames *.lisp-pathname* rfs))))))
1801    (if (and (pathnamep pathname)
1802             (not (directory-pathname-p pathname)))
1803      pathname)))
1804
1805(defun find-symbol-in-packages (string pkgs)
1806  (setq string (string-upcase string))
1807  (let (sym)
1808    (dolist (p pkgs)
1809      (when (setq sym (find-symbol string p))
1810        (return)))
1811    sym))
1812
1813(objc:defmethod (#/openSelection: :void) ((self hemlock-text-view) sender)
1814  (declare (ignore sender))
1815  (let* ((text (#/string self))
1816         (selection (#/substringWithRange: text (#/selectedRange self)))
1817         (pathname (pathname-for-namestring-fragment
1818                    (lisp-string-from-nsstring selection))))
1819    (when (pathnamep pathname)
1820      (ed pathname))))
1821
1822;;; If we get here, we've already checked that the selection represents
1823;;; a valid symbol name.
1824(objc:defmethod (#/inspectSelection: :void) ((self hemlock-text-view) sender)
1825  (declare (ignore sender))
1826  (let* ((text (#/string self))
1827         (selection (#/substringWithRange: text (#/selectedRange self)))
1828         (symbol-name (string-upcase (lisp-string-from-nsstring selection)))
1829         (buffer (hemlock-buffer self))
1830         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer)))
1831    (inspect (find-symbol-in-packages symbol-name 
1832                                      (cons package-name
1833                                            (package-use-list package-name))))))
1834
1835(objc:defmethod (#/sourceForSelection: :void) ((self hemlock-text-view) sender)
1836  (declare (ignore sender))
1837  (let* ((text (#/string self))
1838         (selection (#/substringWithRange: text (#/selectedRange self)))
1839         (sym (find-symbol-in-packages (lisp-string-from-nsstring selection)
1840                                       (list-all-packages))))
1841    (ed sym)))
1842
1843;;; If we don't override this, NSTextView will start adding Google/
1844;;; Spotlight search options and dictionary lookup when a selection
1845;;; is active.
1846(objc:defmethod #/menuForEvent: ((self hemlock-text-view) event)
1847  (declare (ignore event))
1848  (let* ((text (#/string self))
1849         (selection (#/substringWithRange: text (#/selectedRange self)))
1850         (s (lisp-string-from-nsstring selection))
1851         (menu (if (> (length s) 0)
1852                 (#/copy (#/menu self))
1853                 (#/retain (#/menu self))))
1854         (buffer (hemlock-buffer self))
1855         (package-name (hi::variable-value 'hemlock::current-package :buffer buffer)))
1856    (when (find-symbol-in-packages (string-upcase s)
1857                                   (cons package-name
1858                                         (package-use-list package-name)))
1859      (let* ((title (#/stringByAppendingString: #@"Inspect " selection))
1860             (item (make-instance 'ns:ns-menu-item :with-title title
1861                     :action (@selector #/inspectSelection:)
1862                     :key-equivalent #@"")))
1863        (#/setTarget: item self)
1864        (#/insertItem:atIndex: menu item 0)
1865        (#/release item)))
1866    (when (find-symbol-in-packages (string-upcase s) (list-all-packages))
1867      (let* ((title (#/stringByAppendingString: #@"Source of " selection))
1868             (item (make-instance 'ns:ns-menu-item :with-title title
1869                     :action (@selector #/sourceForSelection:)
1870                     :key-equivalent #@"")))
1871        (#/setTarget: item self)
1872        (#/insertItem:atIndex: menu item 0)
1873        (#/release item)))
1874    (when (pathname-for-namestring-fragment s)
1875      (let* ((title (#/stringByAppendingString: #@"Open " selection))
1876             (item (make-instance 'ns:ns-menu-item :with-title title
1877                     :action (@selector #/openSelection:)
1878                     :key-equivalent #@"")))
1879        (#/setTarget: item self)
1880        (#/insertItem:atIndex: menu item 0)
1881        (#/release item)))
1882
1883    (#/autorelease menu)))
1884
1885(defun make-scrolling-text-view-for-textstorage (textstorage x y width height tracks-width color style)
1886  (let* ((scrollview (#/autorelease
1887                      (make-instance
1888                       'ns:ns-scroll-view
1889                       :with-frame (ns:make-ns-rect x y width height)))))
1890    (#/setBorderType: scrollview #$NSNoBorder)
1891    (#/setHasVerticalScroller: scrollview t)
1892    (#/setHasHorizontalScroller: scrollview t)
1893    (#/setRulersVisible: scrollview nil)
1894    (#/setAutoresizingMask: scrollview (logior
1895                                        #$NSViewWidthSizable
1896                                        #$NSViewHeightSizable))
1897    (#/setAutoresizesSubviews: (#/contentView scrollview) t)
1898    (let* ((layout (make-instance 'ns:ns-layout-manager)))
1899      #+suffer
1900      (#/setTypesetter: layout (make-instance 'hemlock-ats-typesetter))
1901      (#/addLayoutManager: textstorage layout)
1902      (#/setUsesScreenFonts: layout *use-screen-fonts*)
1903      (#/release layout)
1904      (let* ((contentsize (#/contentSize scrollview)))
1905        (ns:with-ns-size (containersize large-number-for-text large-number-for-text)
1906          (ns:with-ns-rect (tv-frame 0 0 (ns:ns-size-width contentsize) (ns:ns-size-height contentsize))
1907            (ns:init-ns-size containersize large-number-for-text large-number-for-text)
1908            (ns:init-ns-rect tv-frame 0 0 (ns:ns-size-width contentsize) (ns:ns-size-height contentsize))
1909            (let* ((container (#/autorelease (make-instance
1910                                              'ns:ns-text-container
1911                                              :with-container-size containersize))))
1912              (#/addTextContainer: layout  container)
1913              (let* ((tv (#/autorelease (make-instance 'hemlock-text-view
1914                                                       :with-frame tv-frame
1915                                                       :text-container container))))
1916                (setf (text-view-paren-highlight-color tv) (paren-highlight-background-color))
1917                (#/setDelegate: layout tv)
1918                (#/setMinSize: tv (ns:make-ns-size 0 (ns:ns-size-height contentsize)))
1919                (#/setMaxSize: tv (ns:make-ns-size large-number-for-text large-number-for-text))
1920                (#/setRichText: tv nil)
1921                (#/setAutoresizingMask: tv #$NSViewWidthSizable)
1922                (#/setBackgroundColor: tv color)
1923                (when (slot-exists-p textstorage 'styles)
1924                  (#/setTypingAttributes: tv (#/objectAtIndex:
1925                                              (#/styles textstorage) style)))
1926                #-cocotron
1927                (#/setSmartInsertDeleteEnabled: tv nil)
1928                (#/setAllowsUndo: tv nil) ; don't want NSTextView undo
1929                #-cocotron
1930                (#/setUsesFindPanel: tv t)
1931                #-cocotron
1932                (#/setUsesFontPanel: tv nil)
1933                (#/setMenu: tv (text-view-context-menu))
1934
1935                ;;  The container tracking and the text view sizability along a
1936                ;;  particular axis must always be different, or else things can
1937                ;;  get really confused (possibly causing an infinite loop).
1938
1939                (if (or tracks-width *wrap-lines-to-window*)
1940                  (progn
1941                    (#/setWidthTracksTextView: container t)
1942                    (#/setHeightTracksTextView: container nil)
1943                    (#/setHorizontallyResizable: tv nil)
1944                    (#/setVerticallyResizable: tv t))
1945                  (progn
1946                    (#/setWidthTracksTextView: container nil)
1947                    (#/setHeightTracksTextView: container nil)
1948                    (#/setHorizontallyResizable: tv t)
1949                    (#/setVerticallyResizable: tv t)))
1950                (#/setContentView: scrollview (make-instance 'text-pane-clip-view))
1951                (#/setDocumentView: scrollview tv)           
1952                (values tv scrollview)))))))))
1953
1954(defun make-scrolling-textview-for-pane (pane textstorage track-width color style)
1955  (let* ((contentrect (#/frame (#/contentView pane)) ))
1956    (multiple-value-bind (tv scrollview)
1957        (make-scrolling-text-view-for-textstorage
1958         textstorage
1959         (ns:ns-rect-x contentrect)
1960         (ns:ns-rect-y contentrect)
1961         (ns:ns-rect-width contentrect)
1962         (ns:ns-rect-height contentrect)
1963         track-width
1964         color
1965         style)
1966      (#/addSubview: pane scrollview)
1967      (let* ((r (#/frame scrollview)))
1968        (decf (ns:ns-rect-height r) 15)
1969        (incf (ns:ns-rect-y r) 15)
1970        (#/setFrame: scrollview r))
1971      #-cocotron
1972      (#/setAutohidesScrollers: scrollview t)
1973      (setf (slot-value pane 'scroll-view) scrollview
1974            (slot-value pane 'text-view) tv
1975            (slot-value tv 'pane) pane
1976            #|(slot-value scrollview 'pane) pane|#)
1977      ;;(let* ((modeline  (scroll-view-modeline scrollview)))
1978      (let* ((modeline  (make-instance 'modeline-view
1979                          :with-frame (ns:make-ns-rect 0 0 (ns:ns-rect-width contentrect)
1980                                                       15))))
1981        (#/setAutoresizingMask: modeline #$NSViewWidthSizable)
1982        (#/addSubview: pane modeline)
1983        (#/release modeline)
1984        (setf (slot-value pane 'mode-line) modeline
1985              (slot-value modeline 'pane) pane))
1986      tv)))
1987
1988(defmethod hemlock-view-size ((view hi:hemlock-view))
1989  (let* ((pane (hi::hemlock-view-pane view))
1990         (bounds (#/bounds (#/contentView (text-pane-scroll-view pane))))
1991         (tv (text-pane-text-view pane))
1992         (char-width (text-view-char-width tv))
1993         (line-height (text-view-line-height tv)))
1994    (values (floor (ns:ns-rect-width bounds) char-width)
1995            (floor (ns:ns-rect-height bounds) line-height))))
1996
1997
1998(defmethod hemlock-ext:change-active-pane ((view hi:hemlock-view) new-pane)
1999  #+debug (log-debug "change active pane to ~s" new-pane)
2000  (let* ((pane (hi::hemlock-view-pane view))
2001         (text-view (text-pane-text-view pane))
2002         (tv (ecase new-pane
2003               (:echo (slot-value text-view 'peer))
2004               (:text text-view))))
2005    (activate-hemlock-view tv)))
2006
2007(defclass echo-area-view (hemlock-textstorage-text-view)
2008    ()
2009  (:metaclass ns:+ns-object))
2010(declaim (special echo-area-view))
2011
2012(defmethod compute-temporary-attributes ((self echo-area-view))
2013)
2014
2015(defmethod update-paren-highlight ((self echo-area-view))
2016)
2017
2018(defmethod hemlock-view ((self echo-area-view))
2019  (let ((text-view (slot-value self 'peer)))
2020    (when text-view
2021      (hemlock-view text-view))))
2022
2023;;; The "document" for an echo-area isn't a real NSDocument.
2024(defclass echo-area-document (ns:ns-object)
2025    ((textstorage :foreign-type :id))
2026  (:metaclass ns:+ns-object))
2027
2028(defmethod hemlock-buffer ((self echo-area-document))
2029  (let ((ts (slot-value self 'textstorage)))
2030    (unless (%null-ptr-p ts)
2031      (hemlock-buffer ts))))
2032
2033(objc:defmethod #/undoManager ((self echo-area-document))
2034  +null-ptr+) ;For now, undo is not supported for echo-areas
2035
2036(defmethod update-buffer-package ((doc echo-area-document) buffer)
2037  (declare (ignore buffer)))
2038
2039(defmethod document-invalidate-modeline ((self echo-area-document))
2040  nil)
2041
2042(objc:defmethod (#/close :void) ((self echo-area-document))
2043  (let* ((ts (slot-value self 'textstorage)))
2044    (unless (%null-ptr-p ts)
2045      (setf (slot-value self 'textstorage) (%null-ptr))
2046      (close-hemlock-textstorage ts))))
2047
2048(objc:defmethod (#/updateChangeCount: :void) ((self echo-area-document) (change :<NSD>ocument<C>hange<T>ype))
2049  (declare (ignore change)))
2050
2051(defun make-echo-area (the-hemlock-frame x y width height main-buffer color)
2052  (let* ((box (make-instance 'ns:ns-view :with-frame (ns:make-ns-rect x y width height))))
2053    (#/setAutoresizingMask: box #$NSViewWidthSizable)
2054    (let* ((box-frame (#/bounds box))
2055           (containersize (ns:make-ns-size large-number-for-text (ns:ns-rect-height box-frame)))
2056           (clipview (make-instance 'ns:ns-clip-view
2057                                    :with-frame box-frame)))
2058      (#/setAutoresizingMask: clipview (logior #$NSViewWidthSizable
2059                                               #$NSViewHeightSizable))
2060      (#/setBackgroundColor: clipview color)
2061      (#/addSubview: box clipview)
2062      (#/setAutoresizesSubviews: box t)
2063      (#/release clipview)
2064      (let* ((buffer (hi::make-echo-buffer))
2065             (textstorage
2066              (progn
2067                ;; What's the reason for sharing this?  Is it just the lock?
2068                (setf (hi::buffer-gap-context buffer) (hi::ensure-buffer-gap-context main-buffer))
2069                (make-textstorage-for-hemlock-buffer buffer)))
2070             (doc (make-instance 'echo-area-document))
2071             (layout (make-instance 'ns:ns-layout-manager))
2072             (container (#/autorelease
2073                         (make-instance 'ns:ns-text-container
2074                                        :with-container-size
2075                                        containersize))))
2076        (#/addLayoutManager: textstorage layout)
2077        (#/setUsesScreenFonts: layout *use-screen-fonts*)
2078        (#/addTextContainer: layout container)
2079        (#/release layout)
2080        (let* ((echo (make-instance 'echo-area-view
2081                                    :with-frame box-frame
2082                                    :text-container container)))
2083          (#/setMinSize: echo (pref box-frame :<NSR>ect.size))
2084          (#/setMaxSize: echo (ns:make-ns-size large-number-for-text large-number-for-text))
2085          (#/setRichText: echo nil)
2086          #-cocotron
2087          (#/setUsesFontPanel: echo nil)
2088          (#/setHorizontallyResizable: echo t)
2089          (#/setVerticallyResizable: echo nil)
2090          (#/setAutoresizingMask: echo #$NSViewNotSizable)
2091          (#/setBackgroundColor: echo color)
2092          (#/setWidthTracksTextView: container nil)
2093          (#/setHeightTracksTextView: container nil)
2094          (#/setMenu: echo +null-ptr+)
2095          (setf (hemlock-frame-echo-area-buffer the-hemlock-frame) buffer
2096                (slot-value doc 'textstorage) textstorage
2097                (hi::buffer-document buffer) doc)
2098          (#/setDocumentView: clipview echo)
2099          (#/setAutoresizesSubviews: clipview nil)
2100          (#/sizeToFit echo)
2101          (values echo box))))))
2102                   
2103(defun make-echo-area-for-window (w main-buffer color)
2104  (let* ((content-view (#/contentView w))
2105         (bounds (#/bounds content-view))
2106         (height (+ 1 (size-of-char-in-font *editor-font*))))
2107    (multiple-value-bind (echo-area box)
2108                         (make-echo-area w
2109                                         0.0f0
2110                                         0.0f0
2111                                         (- (ns:ns-rect-width bounds) 16.0f0)
2112                                         height
2113                                         main-buffer
2114                                         color)
2115      (#/addSubview: content-view box)
2116      echo-area)))
2117               
2118(defclass hemlock-frame (ns:ns-window)
2119    ((echo-area-view :foreign-type :id)
2120     (pane :foreign-type :id)
2121     (echo-area-buffer :initform nil :accessor hemlock-frame-echo-area-buffer)
2122     (echo-area-stream :initform nil :accessor hemlock-frame-echo-area-stream))
2123  (:metaclass ns:+ns-object))
2124(declaim (special hemlock-frame))
2125
2126;;; If a window's document's edited status changes, update the modeline.
2127(objc:defmethod (#/setDocumentEdited: :void) ((w hemlock-frame)
2128                                              (edited #>BOOL))
2129  (let* ((was-edited (#/isDocumentEdited w)))
2130    (unless (eq was-edited edited)
2131      (#/setNeedsDisplay: (text-pane-mode-line (slot-value w 'pane)) t)))
2132  (call-next-method edited))
2133
2134(objc:defmethod (#/dealloc :void) ((self hemlock-frame))
2135  (let* ((pane (slot-value self 'pane))
2136         (echo-view (slot-value self 'echo-area-view)))
2137    (unless (%null-ptr-p pane)
2138      (setf (slot-value self 'pane) (%null-ptr))
2139      (#/release pane))
2140    (unless (%null-ptr-p echo-view)
2141      (setf (slot-value self 'echo-area-view) (%null-ptr))
2142      (#/release echo-view))
2143    (objc:remove-lisp-slots self)
2144    (call-next-method)))
2145 
2146
2147(objc:defmethod (#/miniaturize: :void) ((w hemlock-frame) sender)
2148  (let* ((event (#/currentEvent w))
2149         (flags (#/modifierFlags event)))
2150    (if (logtest #$NSControlKeyMask flags)
2151      (progn
2152        (#/orderOut: w nil)
2153        (#/changeWindowsItem:title:filename: *nsapp* w (#/title w) nil))
2154      (call-next-method sender))))
2155
2156(defmethod hemlock-view ((frame hemlock-frame))
2157  (let ((pane (slot-value frame 'pane)))
2158    (when (and pane (not (%null-ptr-p pane)))
2159      (hemlock-view pane))))
2160
2161(objc:defmethod (#/runErrorSheet: :void) ((self hemlock-frame) message)
2162  #+debug (#_NSLog #@"runErrorSheet: signal = %@" :id signal)
2163  (#_NSBeginAlertSheet #@"Error in Hemlock command processing" ;title
2164                       (if (logbitp 0 (random 2))
2165                         #@"Not OK, but what can you do?"
2166                         #@"The sky is falling. FRED never did this!")
2167                       +null-ptr+
2168                       +null-ptr+
2169                       self
2170                       self
2171                       +null-ptr+
2172                       +null-ptr+
2173                       +null-ptr+
2174                       message))
2175
2176(defun report-condition-in-hemlock-frame (condition frame)
2177  (assume-cocoa-thread)
2178  (let ((message (nsstring-for-lisp-condition condition)))
2179    (#/performSelectorOnMainThread:withObject:waitUntilDone:
2180     frame
2181     (@selector #/runErrorSheet:)
2182     message
2183     t)))
2184
2185(defmethod hemlock-ext:report-hemlock-error ((view hi:hemlock-view) condition debug-p)
2186  (when debug-p (maybe-log-callback-error condition))
2187  (let ((pane (hi::hemlock-view-pane view)))
2188    (when (and pane (not (%null-ptr-p pane)))
2189      (report-condition-in-hemlock-frame condition (#/window pane)))))
2190
2191(defun window-menubar-height ()
2192  #+cocotron (objc:objc-message-send (ccl::@class "NSMainMenuView") "menuHeight" #>CGFloat)
2193  #-cocotron 0.0f0)
2194
2195(defun new-hemlock-document-window (class)
2196  (let* ((w (new-cocoa-window :class class
2197                              :activate nil))
2198         (echo-area-height (+ 1 (size-of-char-in-font *editor-font*))))
2199      (values w (add-pane-to-window w :reserve-below echo-area-height))))
2200
2201
2202
2203(defun add-pane-to-window (w &key (reserve-above 0.0f0) (reserve-below 0.0f0))
2204  (let* ((window-content-view (#/contentView w))
2205         (window-frame (#/frame window-content-view)))
2206    (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)))
2207       (let* ((pane (make-instance 'text-pane :with-frame pane-rect)))
2208         (#/addSubview: window-content-view pane)
2209         (#/setDelegate: w pane)
2210         ;; Cocotron doesn't set the new window's initialFirstResponder which means
2211         ;; that the user must click in the window before they can edit.  So, do it here.
2212         ;; Remove this when Cocotron issue #374 is fixed
2213         ;;  (http://code.google.com/p/cocotron/issues/detail?id=374)
2214         #+cocotron (#/setInitialFirstResponder: w pane)
2215         pane))))
2216
2217(defun textpane-for-textstorage (class ts ncols nrows container-tracks-text-view-width color style)
2218  (let* ((pane (nth-value
2219                1
2220                (new-hemlock-document-window class))))
2221    (make-scrolling-textview-for-pane pane ts container-tracks-text-view-width color style)
2222    (multiple-value-bind (height width)
2223        (size-of-char-in-font (default-font))
2224      (size-text-pane pane height width nrows ncols))
2225    pane))
2226
2227
2228
2229
2230(defun hemlock-buffer-from-nsstring (nsstring name &rest modes)
2231  (let* ((buffer (make-hemlock-buffer name :modes modes)))
2232    (nsstring-to-buffer nsstring buffer)))
2233
2234(defun %nsstring-to-hemlock-string (nsstring)
2235  "returns line-termination of string"
2236  (let* ((string (lisp-string-from-nsstring nsstring))
2237         (lfpos (position #\linefeed string))
2238         (crpos (position #\return string))
2239         (line-termination (if crpos
2240                             (if (eql lfpos (1+ crpos))
2241                               :crlf
2242                               :cr)
2243                             :lf))
2244         (hemlock-string (case line-termination
2245                           (:crlf (remove #\return string))
2246                           (:cr (nsubstitute #\linefeed #\return string))
2247                           (t string))))
2248    (values hemlock-string line-termination)))
2249
2250;: TODO: I think this is jumping through hoops because it want to be invokable outside the main
2251;; cocoa thread.
2252(defun nsstring-to-buffer (nsstring buffer)
2253  (let* ((document (hi::buffer-document buffer))
2254         (hi::*current-buffer* buffer)
2255         (region (hi::buffer-region buffer)))
2256    (multiple-value-bind (hemlock-string line-termination)
2257                         (%nsstring-to-hemlock-string nsstring)
2258      (setf (hi::buffer-line-termination buffer) line-termination)
2259
2260      (setf (hi::buffer-document buffer) nil) ;; What's this about??
2261      (unwind-protect
2262          (let ((point (hi::buffer-point buffer)))
2263            (hi::delete-region region)
2264            (hi::insert-string point hemlock-string)
2265            (setf (hi::buffer-modified buffer) nil)
2266            (hi::buffer-start point)
2267            ;; TODO: why would this be needed? insert-string should take care of any internal bookkeeping.
2268            (hi::renumber-region region)
2269            buffer)
2270        (setf (hi::buffer-document buffer) document)))))
2271
2272
2273(setq hi::*beep-function* #'(lambda (stream)
2274                              (declare (ignore stream))
2275                              (#_NSBeep)))
2276
2277
2278;;; This function must run in the main event thread.
2279(defun %hemlock-frame-for-textstorage (class ts ncols nrows container-tracks-text-view-width color style)
2280  (assume-cocoa-thread)
2281  (let* ((pane (textpane-for-textstorage class ts ncols nrows container-tracks-text-view-width color style))
2282         (buffer (hemlock-buffer ts))
2283         (frame (#/window pane))
2284         (echo-area (make-echo-area-for-window frame buffer color))
2285         (echo-buffer (hemlock-buffer (#/textStorage echo-area)))
2286         (tv (text-pane-text-view pane)))
2287    #+GZ (assert echo-buffer)
2288    (with-slots (peer) tv
2289      (setq peer echo-area))
2290    (with-slots (peer) echo-area
2291      (setq peer tv))
2292    (setf (slot-value frame 'echo-area-view) echo-area
2293          (slot-value frame 'pane) pane)
2294    (setf (slot-value pane 'hemlock-view)
2295          (make-instance 'hi:hemlock-view
2296            :buffer buffer
2297            :pane pane
2298            :echo-area-buffer echo-buffer))
2299    (activate-hemlock-view tv)
2300   frame))
2301
2302(defun hemlock-ext:invoke-modifying-buffer-storage (buffer thunk)
2303  (assume-cocoa-thread)
2304  (when buffer ;; nil means just get rid of any prior buffer
2305    (setq buffer (require-type buffer 'hi::buffer)))
2306  (let ((old *buffer-being-edited*))
2307    (if (eq buffer old)
2308      (funcall thunk)
2309      (unwind-protect
2310          (progn
2311            (buffer-document-end-editing old)
2312            (buffer-document-begin-editing buffer)
2313            (funcall thunk))
2314        (buffer-document-end-editing buffer)
2315        (buffer-document-begin-editing old)))))
2316
2317(defun buffer-document-end-editing (buffer)
2318  (when buffer
2319    (let* ((document (hi::buffer-document (require-type buffer 'hi::buffer))))
2320      (when document
2321        (setq *buffer-being-edited* nil)
2322        (let ((ts (slot-value document 'textstorage)))
2323          (#/endEditing ts)
2324          (update-hemlock-selection ts))))))
2325
2326(defun buffer-document-begin-editing (buffer)
2327  (when buffer
2328    (let* ((document (hi::buffer-document buffer)))
2329      (when document
2330        (setq *buffer-being-edited* buffer)
2331        (#/beginEditing (slot-value document 'textstorage))))))
2332
2333(defun document-edit-level (document)
2334  (assume-cocoa-thread) ;; see comment in #/editingInProgress
2335  (slot-value (slot-value document 'textstorage) 'edit-count))
2336
2337(defun buffer-edit-level (buffer)
2338  (if buffer
2339    (let* ((document (hi::buffer-document buffer)))
2340      (if document
2341        (document-edit-level document)
2342        0))
2343    0))
2344
2345(defun hemlock-ext:invoke-allowing-buffer-display (buffer thunk)
2346  ;; Call THUNK with the buffer's edit-level at 0, then restore the buffer's edit level.
2347  (let* ((level (buffer-edit-level buffer)))
2348    (dotimes (i level) (buffer-document-end-editing buffer))
2349    (unwind-protect
2350        (funcall thunk)
2351      (dotimes (i level) (buffer-document-begin-editing buffer)))))
2352
2353
2354(defun buffer-document-modified (buffer)
2355  (let* ((doc (hi::buffer-document buffer)))
2356    (if doc
2357      (#/isDocumentEdited doc))))
2358
2359(defun perform-edit-change-notification (textstorage selector pos n &optional (extra 0))
2360  (with-lock-grabbed (*buffer-change-invocation-lock*)
2361    (let* ((invocation *buffer-change-invocation*))
2362      (rlet ((ppos :<NSI>nteger pos)
2363             (pn :<NSI>nteger n)
2364             (pextra :<NSI>nteger extra))
2365        (#/setTarget: invocation textstorage)
2366        (#/setSelector: invocation selector)
2367        (#/setArgument:atIndex: invocation ppos 2)
2368        (#/setArgument:atIndex: invocation pn 3)
2369        (#/setArgument:atIndex: invocation pextra 4))
2370      (#/performSelectorOnMainThread:withObject:waitUntilDone:
2371       invocation
2372       (@selector #/invoke)
2373       +null-ptr+
2374       t))))
2375
2376
2377
2378
2379(defun hemlock-ext:buffer-note-font-change (buffer region font)
2380  (when (hi::bufferp buffer)
2381    (let* ((document (hi::buffer-document buffer))
2382           (textstorage (if document (slot-value document 'textstorage)))
2383           (pos (hi:mark-absolute-position (hi::region-start region)))
2384           (n (- (hi:mark-absolute-position (hi::region-end region)) pos)))
2385      (if (eq *current-process* *cocoa-event-process*)
2386        (#/noteHemlockAttrChangeAtPosition:length:fontNum: textstorage
2387                                                           pos
2388                                                           n
2389                                                           font)
2390        (perform-edit-change-notification textstorage
2391                                          (@selector #/noteHemlockAttrChangeAtPosition:length:fontNum:)
2392                                          pos
2393                                          n
2394                                          font)))))
2395
2396(defun buffer-active-font-attributes (buffer)
2397  (let* ((style 0)
2398         (region (hi::buffer-active-font-region buffer))
2399         (textstorage (slot-value (hi::buffer-document buffer) 'textstorage))
2400         (styles (#/styles textstorage)))
2401    (when region
2402      (let* ((start (hi::region-end region)))
2403        (setq style (hi::font-mark-font start))))
2404    (#/objectAtIndex: styles style)))
2405     
2406;; Note that inserted a string of length n at mark.  Assumes this is called after
2407;; buffer marks were updated.
2408(defun hemlock-ext:buffer-note-insertion (buffer mark n)
2409  (when (hi::bufferp buffer)
2410    (let* ((document (hi::buffer-document buffer))
2411           (textstorage (if document (slot-value document 'textstorage))))
2412      (when textstorage
2413        (let* ((pos (hi:mark-absolute-position mark)))
2414          (when (eq (hi::mark-%kind mark) :left-inserting)
2415            ;; Make up for the fact that the mark moved forward with the insertion.
2416            ;; For :right-inserting and :temporary marks, they should be left back.
2417            (decf pos n))
2418          (if (eq *current-process* *cocoa-event-process*)
2419            (#/noteHemlockInsertionAtPosition:length:extra: textstorage
2420                                                            pos
2421                                                            n
2422                                                            0)
2423            (perform-edit-change-notification textstorage
2424                                              (@selector #/noteHemlockInsertionAtPosition:length:extra:)
2425                                              pos
2426                                              n)))))))
2427
2428(defun hemlock-ext:buffer-note-modification (buffer mark n)
2429  (when (hi::bufferp buffer)
2430    (let* ((document (hi::buffer-document buffer))
2431           (textstorage (if document (slot-value document 'textstorage))))
2432      (when textstorage
2433        (if (eq *current-process* *cocoa-event-process*)
2434          (#/noteHemlockModificationAtPosition:length:extra: textstorage
2435                                                             (hi:mark-absolute-position mark)
2436                                                             n
2437                                                             0)
2438          (perform-edit-change-notification textstorage
2439                                            (@selector #/noteHemlockModificationAtPosition:length:extra:)
2440                                            (hi:mark-absolute-position mark)
2441                                            n))))))
2442 
2443
2444(defun hemlock-ext:buffer-note-deletion (buffer mark n)
2445  (when (hi::bufferp buffer)
2446    (let* ((document (hi::buffer-document buffer))
2447           (textstorage (if document (slot-value document 'textstorage))))
2448      (when textstorage
2449        (let* ((pos (hi:mark-absolute-position mark)))
2450          (if (eq *current-process* *cocoa-event-process*)
2451            (#/noteHemlockDeletionAtPosition:length:extra: textstorage
2452                                                           pos
2453                                                           (abs n)
2454                                                           0)
2455            (perform-edit-change-notification textstorage
2456                                              (@selector #/noteHemlockDeletionAtPosition:length:extra:)
2457                                              pos
2458                                              (abs n))))))))
2459
2460
2461
2462(defun hemlock-ext:note-buffer-saved (buffer)
2463  (assume-cocoa-thread)
2464  (let* ((document (hi::buffer-document buffer)))
2465    (when document
2466      ;; Hmm... I guess this is always done by the act of saving.
2467      nil)))
2468
2469(defun hemlock-ext:note-buffer-unsaved (buffer)
2470  (assume-cocoa-thread)
2471  (let* ((document (hi::buffer-document buffer)))
2472    (when document
2473      (#/updateChangeCount: document #$NSChangeCleared))))
2474
2475
2476(defun size-of-char-in-font (f)
2477  (let* ((sf (#/screenFont f))
2478         (screen-p *use-screen-fonts*))
2479    (if (%null-ptr-p sf) (setq sf f screen-p nil))
2480    (let* ((layout (#/autorelease (#/init (#/alloc ns:ns-layout-manager)))))
2481      (#/setUsesScreenFonts: layout screen-p)
2482      (values (fround (#/defaultLineHeightForFont: layout sf))
2483              (fround (ns:ns-size-width (#/advancementForGlyph: sf (char-code #\space))))))))
2484         
2485
2486
2487(defun size-text-pane (pane line-height char-width nrows ncols)
2488  (let* ((tv (text-pane-text-view pane))
2489         (height (fceiling (* nrows line-height)))
2490         (width (fceiling (* ncols char-width)))
2491         (scrollview (text-pane-scroll-view pane))
2492         (window (#/window scrollview))
2493         (has-horizontal-scroller (#/hasHorizontalScroller scrollview))
2494         (has-vertical-scroller (#/hasVerticalScroller scrollview)))
2495    (ns:with-ns-size (tv-size
2496                      (+ width (* 2 (#/lineFragmentPadding (#/textContainer tv))))
2497                      height)
2498      (when has-vertical-scroller 
2499        (#/setVerticalLineScroll: scrollview line-height)
2500        (#/setVerticalPageScroll: scrollview (cgfloat 0.0) #|line-height|#))
2501      (when has-horizontal-scroller
2502        (#/setHorizontalLineScroll: scrollview char-width)
2503        (#/setHorizontalPageScroll: scrollview (cgfloat 0.0) #|char-width|#))
2504      (let* ((sv-size (#/frameSizeForContentSize:hasHorizontalScroller:hasVerticalScroller:borderType: ns:ns-scroll-view tv-size has-horizontal-scroller has-vertical-scroller (#/borderType scrollview)))
2505             (pane-frame (#/frame pane))
2506             (margins (#/contentViewMargins pane)))
2507        (incf (ns:ns-size-height sv-size)
2508              (+ (ns:ns-rect-y pane-frame)
2509                 (* 2 (ns:ns-size-height  margins))))
2510        (incf (ns:ns-size-width sv-size)
2511              (ns:ns-size-width margins))
2512        (#/setContentSize: window sv-size)
2513        (setf (slot-value tv 'char-width) char-width
2514              (slot-value tv 'line-height) line-height)
2515        (#/setResizeIncrements: window
2516                                (ns:make-ns-size char-width line-height))))))
2517                                   
2518 
2519(defclass hemlock-editor-window-controller (ns:ns-window-controller)
2520  ()
2521  (:metaclass ns:+ns-object))
2522
2523;;; This is borrowed from emacs.  The first click on the zoom button will
2524;;; zoom vertically.  The second will zoom completely.  The third will
2525;;; return to the original size.
2526(objc:defmethod (#/windowWillUseStandardFrame:defaultFrame: #>NSRect)
2527                ((wc hemlock-editor-window-controller) sender (default-frame #>NSRect))
2528  (let* ((r (#/frame sender)))
2529    (if (= (ns:ns-rect-height r) (ns:ns-rect-height default-frame))
2530      (setf r default-frame)
2531      (setf (ns:ns-rect-height r) (ns:ns-rect-height default-frame)
2532            (ns:ns-rect-y r) (ns:ns-rect-y default-frame)))
2533    r))
2534
2535(objc:defmethod (#/windowWillClose: :void) ((wc hemlock-editor-window-controller)
2536                                            notification)
2537  (declare (ignore notification))
2538  ;; The echo area "document" should probably be a slot in the document
2539  ;; object, and released when the document object is.
2540  (let* ((w (#/window wc)))
2541    ;; guard against cocotron lossage
2542    (if (#/isKindOfClass: w hemlock-frame)
2543      (let* ((buf (hemlock-frame-echo-area-buffer w))
2544             (echo-doc (if buf (hi::buffer-document buf))))
2545        (when echo-doc
2546          (setf (hemlock-frame-echo-area-buffer w) nil)
2547          (#/close echo-doc))
2548        (#/setFrameAutosaveName: w #@"")
2549        (#/autorelease w))
2550      (#_NSLog #@"window controller %@ got windowWillClose for odd window %@ "
2551               :address wc :address w))))
2552
2553(defmethod hemlock-view ((self hemlock-editor-window-controller))
2554  (let ((frame (#/window self)))
2555    (unless (%null-ptr-p frame)
2556      (hemlock-view frame))))
2557
2558;;; Map *default-file-character-encoding* to an :<NSS>tring<E>ncoding
2559(defun get-default-encoding ()
2560  #-cocotron                            ;need IANA conversion stuff
2561  (let* ((file-encoding *default-file-character-encoding*))
2562    (when (and (typep file-encoding 'keyword)
2563               (lookup-character-encoding file-encoding))
2564      (let* ((string (string file-encoding))
2565             (len (length string)))
2566        (with-cstrs ((cstr string))
2567          (with-nsstr (nsstr cstr len)
2568            (let* ((cf (#_CFStringConvertIANACharSetNameToEncoding nsstr)))
2569              (if (= cf #$kCFStringEncodingInvalidId)
2570                (setq cf (#_CFStringGetSystemEncoding)))
2571              (let* ((ns (#_CFStringConvertEncodingToNSStringEncoding cf)))
2572                (if (= ns #$kCFStringEncodingInvalidId)
2573                  (#/defaultCStringEncoding ns:ns-string)
2574                  ns)))))))))
2575
2576(defclass hemlock-document-controller (ns:ns-document-controller)
2577    ((last-encoding :foreign-type :<NSS>tring<E>ncoding))
2578  (:metaclass ns:+ns-object))
2579(declaim (special hemlock-document-controller))
2580
2581(objc:defmethod #/init ((self hemlock-document-controller))
2582  (prog1
2583      (call-next-method)
2584    (setf (slot-value self 'last-encoding) 0)))
2585
2586
2587;;; The HemlockEditorDocument class.
2588
2589
2590(defclass hemlock-editor-document (ns:ns-document)
2591    ((textstorage :foreign-type :id)
2592     (encoding :foreign-type :<NSS>tring<E>ncoding))
2593  (:metaclass ns:+ns-object))
2594
2595(defmethod hemlock-buffer ((self hemlock-editor-document))
2596  (let ((ts (slot-value self 'textstorage)))
2597    (unless (%null-ptr-p ts)
2598      (hemlock-buffer ts))))
2599
2600(defmethod window-document ((w ns:ns-window))
2601  (let* ((sc (#/sharedDocumentController ns:ns-document-controller))
2602         (doc (#/documentForWindow: sc w)))
2603    (if (%null-ptr-p doc)
2604      nil
2605      doc)))
2606
2607(defmethod window-pathname ((w ns:ns-window))
2608  (document-pathname (window-document w)))
2609
2610(defmethod document-pathname ((doc NULL))
2611  nil)
2612
2613(defmethod document-pathname ((doc hemlock-editor-document))
2614  (hi:buffer-pathname (hemlock-buffer doc)))
2615
2616(defmethod assume-not-editing ((doc hemlock-editor-document))
2617  (assume-not-editing (slot-value doc 'textstorage)))
2618
2619(defmethod document-invalidate-modeline ((self hemlock-editor-document))
2620  (for-each-textview-using-storage
2621   (slot-value self 'textstorage)
2622   #'(lambda (tv)
2623       (let* ((pane (text-view-pane tv)))
2624         (unless (%null-ptr-p pane)
2625           (#/setNeedsDisplay: (text-pane-mode-line pane) t))))))
2626
2627(defmethod update-buffer-package ((doc hemlock-editor-document) buffer)
2628  (let* ((name (or (hemlock::package-at-mark (hi::buffer-point buffer))
2629                   (hi::variable-value 'hemlock::default-package :buffer buffer))))
2630    (when name
2631      (let* ((pkg (find-package name)))
2632        (if pkg
2633          (setq name (shortest-package-name pkg))))
2634      (let* ((curname (hi::variable-value 'hemlock::current-package :buffer buffer)))
2635        (if (or (null curname)
2636                (not (string= curname name)))
2637          (setf (hi::variable-value 'hemlock::current-package :buffer buffer) name))))))
2638
2639(defun hemlock-ext:note-selection-set-by-search (buffer)
2640  (let* ((doc (hi::buffer-document buffer)))
2641    (when doc
2642      (with-slots (textstorage) doc
2643        (when textstorage
2644          (with-slots (selection-set-by-search) textstorage
2645            (setq selection-set-by-search #$YES)))))))
2646
2647(objc:defmethod (#/validateMenuItem: :<BOOL>)
2648    ((self hemlock-text-view) item)
2649  (let* ((action (#/action item)))
2650    #+debug (#_NSLog #@"action = %s" :address action)
2651    (cond ((eql action (@selector #/hyperSpecLookUp:))
2652           ;; For now, demand a selection.
2653           (and *hyperspec-lookup-enabled*
2654                (hyperspec-root-url)
2655                (not (eql 0 (ns:ns-range-length (#/selectedRange self))))))
2656          ((eql action (@selector #/cut:))
2657           (let* ((selection (#/selectedRange self)))
2658             (and (> (ns:ns-range-length selection))
2659                  (#/shouldChangeTextInRange:replacementString: self selection #@""))))
2660          ((eql action (@selector #/evalSelection:))
2661           (not (eql 0 (ns:ns-range-length (#/selectedRange self)))))
2662          ((eql action (@selector #/evalAll:))
2663           (let* ((doc (#/document (#/windowController (#/window self)))))
2664             (and (not (%null-ptr-p doc))
2665                  (eq (type-of doc) 'hemlock-editor-document))))
2666          ;; if this hemlock-text-view is in an editor window and its buffer has
2667          ;; an associated pathname, then activate the Load Buffer item
2668          ((or (eql action (@selector #/loadBuffer:))
2669               (eql action (@selector #/compileBuffer:))
2670               (eql action (@selector #/compileAndLoadBuffer:))) 
2671           (let* ((buffer (hemlock-buffer self))
2672                  (pathname (hi::buffer-pathname buffer)))
2673             (not (null pathname))))
2674          ((eql action (@selector #/openSelection:))
2675           (let* ((text (#/string self))
2676                  (selection (#/substringWithRange: text (#/selectedRange self))))
2677             (pathname-for-namestring-fragment (lisp-string-from-nsstring selection))))
2678          (t (call-next-method item)))))
2679
2680(defmethod user-input-style ((doc hemlock-editor-document))
2681  0)
2682
2683(defvar *encoding-name-hash* (make-hash-table))
2684
2685(defmethod document-encoding-name ((doc hemlock-editor-document))
2686  (with-slots (encoding) doc
2687    (if (eql encoding 0)
2688      "Automatic"
2689      (or (gethash encoding *encoding-name-hash*)
2690          (setf (gethash encoding *encoding-name-hash*)
2691                (lisp-string-from-nsstring (nsstring-for-nsstring-encoding encoding)))))))
2692
2693(defun hemlock-ext:buffer-encoding-name (buffer)
2694  (let ((doc (hi::buffer-document buffer)))
2695    (and doc (document-encoding-name doc))))
2696
2697;; TODO: make each buffer have a slot, and this is just the default value.
2698(defmethod textview-background-color ((doc hemlock-editor-document))
2699  *editor-background-color*)
2700
2701
2702(objc:defmethod (#/setTextStorage: :void) ((self hemlock-editor-document) ts)
2703  (let* ((doc (%inc-ptr self 0))        ; workaround for stack-consed self
2704         (string (#/hemlockString ts))
2705         (buffer (hemlock-buffer string)))
2706    (unless (%null-ptr-p doc)
2707      (setf (slot-value doc 'textstorage) ts
2708            (hi::buffer-document buffer) doc))))
2709
2710;; This runs on the main thread.
2711(objc:defmethod (#/revertToSavedFromFile:ofType: :<BOOL>)
2712    ((self hemlock-editor-document) filename filetype)
2713  (declare (ignore filetype))
2714  (assume-cocoa-thread)
2715  #+debug
2716  (#_NSLog #@"revert to saved from file %@ of type %@"
2717           :id filename :id filetype)
2718  (let* ((encoding (slot-value self 'encoding))
2719         (nsstring (make-instance ns:ns-string
2720                                  :with-contents-of-file filename
2721                                  :encoding encoding
2722                                  :error +null-ptr+))
2723         (buffer (hemlock-buffer self))
2724         (old-length (hemlock-buffer-length buffer))
2725         (hi::*current-buffer* buffer)
2726         (textstorage (slot-value self 'textstorage))
2727         (point (hi::buffer-point buffer))
2728         (pointpos (hi:mark-absolute-position point)))
2729    (hemlock-ext:invoke-modifying-buffer-storage
2730     buffer
2731     #'(lambda ()
2732         (#/edited:range:changeInLength:
2733          textstorage #$NSTextStorageEditedCharacters (ns:make-ns-range 0 old-length) (- old-length))
2734         (nsstring-to-buffer nsstring buffer)
2735         (let* ((newlen (hemlock-buffer-length buffer)))
2736           (#/edited:range:changeInLength: textstorage  #$NSTextStorageEditedAttributes (ns:make-ns-range 0 0) newlen)
2737           (#/edited:range:changeInLength: textstorage #$NSTextStorageEditedCharacters (ns:make-ns-range 0 newlen) 0)
2738           (let* ((ts-string (#/hemlockString textstorage))
2739                  (display (hemlock-buffer-string-cache ts-string)))
2740             (reset-buffer-cache display) 
2741             (update-line-cache-for-index display 0)
2742             (move-hemlock-mark-to-absolute-position point
2743                                                     display
2744                                                     (min newlen pointpos))))
2745         (#/updateMirror textstorage)
2746         (setf (hi::buffer-modified buffer) nil)
2747         (hi::note-modeline-change buffer)))
2748    t))
2749
2750
2751(defvar *last-document-created* nil)
2752
2753(objc:defmethod #/init ((self hemlock-editor-document))
2754  (let* ((doc (call-next-method)))
2755    (unless  (%null-ptr-p doc)
2756      (#/setTextStorage: doc (make-textstorage-for-hemlock-buffer
2757                              (make-hemlock-buffer
2758                               (lisp-string-from-nsstring
2759                                (#/displayName doc))
2760                               :modes '("Lisp" "Editor")))))
2761    (with-slots (encoding) doc
2762      (setq encoding (or (get-default-encoding) #$NSISOLatin1StringEncoding)))
2763    (setq *last-document-created* doc)
2764    doc))
2765
2766 
2767(defun make-buffer-for-document (ns-document pathname)
2768  (let* ((buffer-name (hi::pathname-to-buffer-name pathname))
2769         (buffer (make-hemlock-buffer buffer-name)))
2770    (setf (slot-value ns-document 'textstorage)
2771          (make-textstorage-for-hemlock-buffer buffer))
2772    (setf (hi::buffer-pathname buffer) pathname)
2773    buffer))
2774
2775(objc:defmethod (#/readFromURL:ofType:error: :<BOOL>)
2776    ((self hemlock-editor-document) url type (perror (:* :id)))
2777  (declare (ignorable type))
2778  (with-callback-context "readFromURL"
2779    (rlet ((pused-encoding :<NSS>tring<E>ncoding 0))
2780      (let* ((pathname
2781              (lisp-string-from-nsstring
2782               (if (#/isFileURL url)
2783                 (#/path url)
2784                 (#/absoluteString url))))
2785             (buffer (or (hemlock-buffer self)
2786                         (make-buffer-for-document self pathname)))
2787             (selected-encoding (slot-value (#/sharedDocumentController (find-class 'hemlock-document-controller)) 'last-encoding))
2788             (string
2789              (if (zerop selected-encoding)
2790                (#/stringWithContentsOfURL:usedEncoding:error:
2791                 ns:ns-string
2792                 url
2793                 pused-encoding
2794                 perror)
2795                +null-ptr+)))
2796       
2797        (if (%null-ptr-p string)
2798          (progn
2799            (if (zerop selected-encoding)
2800              (setq selected-encoding (or (get-default-encoding) #$NSISOLatin1StringEncoding)))
2801            (setq string (#/stringWithContentsOfURL:encoding:error:
2802                          ns:ns-string
2803                          url
2804                          selected-encoding
2805                          perror)))
2806          (setq selected-encoding (pref pused-encoding :<NSS>tring<E>ncoding)))
2807        (unless (%null-ptr-p string)
2808          (with-slots (encoding) self (setq encoding selected-encoding))
2809
2810          ;; ** TODO: Argh.  How about we just let hemlock insert it.
2811          (let* ((textstorage (slot-value self 'textstorage))
2812                 (display (hemlock-buffer-string-cache (#/hemlockString textstorage)))
2813                 (hi::*current-buffer* buffer))
2814            (hemlock-ext:invoke-modifying-buffer-storage
2815             buffer
2816             #'(lambda ()
2817                 (nsstring-to-buffer string buffer)
2818                 (reset-buffer-cache display) 
2819                 (#/updateMirror textstorage)
2820                 (update-line-cache-for-index display 0)
2821                 (textstorage-note-insertion-at-position
2822                  textstorage
2823                  0
2824                  (hemlock-buffer-length buffer))
2825                 (hi::note-modeline-change buffer)
2826                 (setf (hi::buffer-modified buffer) nil))))
2827          t)))))
2828
2829
2830
2831
2832(def-cocoa-default *editor-keep-backup-files* :bool t "maintain backup files")
2833
2834(objc:defmethod (#/keepBackupFile :<BOOL>) ((self hemlock-editor-document))
2835  ;;; Don't use the NSDocument backup file scheme.
2836  nil)
2837
2838(objc:defmethod (#/writeSafelyToURL:ofType:forSaveOperation:error: :<BOOL>)
2839    ((self hemlock-editor-document)
2840     absolute-url
2841     type
2842     (save-operation :<NSS>ave<O>peration<T>ype)
2843     (error (:* :id)))
2844  (when (and *editor-keep-backup-files*
2845             (eql save-operation #$NSSaveOperation))
2846    (write-hemlock-backup-file (#/fileURL self)))
2847  (call-next-method absolute-url type save-operation error))
2848
2849(defun write-hemlock-backup-file (url)
2850  (unless (%null-ptr-p url)
2851    (when (#/isFileURL url)
2852      (let* ((path (#/path url)))
2853        (unless (%null-ptr-p path)
2854          (let* ((newpath (#/stringByAppendingString: path #@"~"))
2855                 (fm (#/defaultManager ns:ns-file-manager)))
2856            ;; There are all kinds of ways for this to lose.
2857            ;; In order for the copy to succeed, the destination can't exist.
2858            ;; (It might exist, but be a directory, or there could be
2859            ;; permission problems ...)
2860            (#/removeFileAtPath:handler: fm newpath +null-ptr+)
2861            (#/copyPath:toPath:handler: fm path newpath +null-ptr+)))))))
2862
2863             
2864
2865
2866
2867(defun hemlock-ext:all-hemlock-views ()
2868  "List of all hemlock views, in z-order, frontmost first"
2869  (loop for win in (windows)
2870    as buf = (and (typep win 'hemlock-frame) (hemlock-view win))
2871    when buf collect buf))
2872
2873(defmethod document-panes ((document hemlock-editor-document))
2874  (let* ((ts (slot-value document 'textstorage))
2875         (panes ()))
2876    (for-each-textview-using-storage
2877     ts
2878     #'(lambda (tv)
2879         (let* ((pane (text-view-pane tv)))
2880           (unless (%null-ptr-p pane)
2881             (push pane panes)))))
2882    panes))
2883
2884(objc:defmethod (#/noteEncodingChange: :void) ((self hemlock-editor-document)
2885                                               popup)
2886  (with-slots (encoding) self
2887    (setq encoding (nsinteger-to-nsstring-encoding (#/selectedTag popup)))
2888    (hi::note-modeline-change (hemlock-buffer self))))
2889
2890#-cocotron
2891(objc:defmethod (#/prepareSavePanel: :<BOOL>) ((self hemlock-editor-document)
2892                                               panel)
2893  (with-slots (encoding) self
2894    (let* ((popup (build-encodings-popup (#/sharedDocumentController hemlock-document-controller) encoding)))
2895      (#/setAction: popup (@selector #/noteEncodingChange:))
2896      (#/setTarget: popup self)
2897      (#/setAccessoryView: panel popup)))
2898  (#/setExtensionHidden: panel nil)
2899  (#/setCanSelectHiddenExtension: panel nil)
2900  (#/setAllowedFileTypes: panel +null-ptr+)
2901  (call-next-method panel))
2902
2903
2904(defloadvar *ns-cr-string* (%make-nsstring (string #\return)))
2905(defloadvar *ns-lf-string* (%make-nsstring (string #\linefeed)))
2906(defloadvar *ns-crlf-string* (with-autorelease-pool (#/retain (#/stringByAppendingString: *ns-cr-string* *ns-lf-string*))))
2907
2908(objc:defmethod (#/writeToURL:ofType:error: :<BOOL>)
2909    ((self hemlock-editor-document) url type (error (:* :id)))
2910  (declare (ignore type))
2911  (with-slots (encoding textstorage) self
2912    (let* ((string (#/string textstorage))
2913           (buffer (hemlock-buffer self)))
2914      (case (when buffer (hi::buffer-line-termination buffer))
2915        (:crlf (unless (typep string 'ns:ns-mutable-string)
2916                 (setq string (make-instance 'ns:ns-mutable-string :with string string))
2917                 (#/replaceOccurrencesOfString:withString:options:range:
2918                  string *ns-lf-string* *ns-crlf-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string)))))
2919        (:cr (setq string (if (typep string 'ns:ns-mutable-string)
2920                            string
2921                            (make-instance 'ns:ns-mutable-string :with string string)))
2922             (#/replaceOccurrencesOfString:withString:options:range:
2923              string *ns-lf-string* *ns-cr-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string)))))
2924      (when (#/writeToURL:atomically:encoding:error:
2925             string url t encoding error)
2926        (when buffer
2927          (setf (hi::buffer-modified buffer) nil))
2928        t))))
2929
2930;;; Cocotron's NSDocument uses the deprecated as of 10.4 methods to implement the NSSavePanel
2931#+cocotron
2932(objc:defmethod (#/writeToFile:ofType: :<BOOL>)
2933    ((self hemlock-editor-document) path type)
2934  (rlet ((perror :id +null-ptr+))
2935    (#/writeToURL:ofType:error: self (#/fileURLWithPath: ns:ns-url path) type perror)))
2936
2937
2938;;; Shadow the setFileURL: method, so that we can keep the buffer
2939;;; name and pathname in synch with the document.
2940(objc:defmethod (#/setFileURL: :void) ((self hemlock-editor-document)
2941                                        url)
2942  (call-next-method url)
2943  (let* ((path nil)
2944         (controllers (#/windowControllers self)))
2945    (dotimes (i (#/count controllers))
2946      (let* ((controller (#/objectAtIndex: controllers i))
2947             (window (#/window controller)))
2948        (#/setFrameAutosaveName: window (or path (setq path (#/path url)))))))
2949  (let* ((buffer (hemlock-buffer self)))
2950    (when buffer
2951      (let* ((new-pathname (lisp-string-from-nsstring (#/path url))))
2952        (setf (hi::buffer-name buffer) (hi::pathname-to-buffer-name new-pathname))
2953        (setf (hi::buffer-pathname buffer) new-pathname)))))
2954
2955
2956(def-cocoa-default *initial-editor-x-pos* :float 20.0f0 "X position of upper-left corner of initial editor")
2957
2958(def-cocoa-default *initial-editor-y-pos* :float 10.0f0 "Y position of upper-left corner of initial editor")
2959
2960(defloadvar *editor-cascade-point* nil)
2961
2962(defloadvar *next-editor-x-pos* nil) ; set after defaults initialized
2963(defloadvar *next-editor-y-pos* nil)
2964
2965(defun x-pos-for-window (window x)
2966  (let* ((frame (#/frame window))
2967         (screen (#/screen window)))
2968    (if (%null-ptr-p screen) (setq screen (#/mainScreen ns:ns-screen)))
2969    (let* ((screen-rect (#/visibleFrame screen)))
2970      (if (>= x 0)
2971        (+ x (ns:ns-rect-x screen-rect))
2972        (- (+ (ns:ns-rect-width screen-rect) x) (ns:ns-rect-width frame))))))
2973
2974(defun y-pos-for-window (window y)
2975  (let* ((frame (#/frame window))
2976         (screen (#/screen window)))
2977    (if (%null-ptr-p screen) (setq screen (#/mainScreen ns:ns-screen)))
2978    (let* ((screen-rect (#/visibleFrame screen)))
2979      (if (>= y 0)
2980        (+ y (ns:ns-rect-y screen-rect) (ns:ns-rect-height frame))
2981        (+ (ns:ns-rect-height screen-rect) y)))))
2982
2983(objc:defmethod (#/makeWindowControllers :void) ((self hemlock-editor-document))
2984  #+debug
2985  (#_NSLog #@"Make window controllers")
2986    (let* ((textstorage  (slot-value self 'textstorage))
2987           (window (%hemlock-frame-for-textstorage
2988                    hemlock-frame
2989                    textstorage
2990                    *editor-columns*
2991                    *editor-rows*
2992                    nil
2993                    (textview-background-color self)
2994                    (user-input-style self)))
2995           (controller (make-instance
2996                           'hemlock-editor-window-controller
2997                         :with-window window))
2998           (url (#/fileURL self))
2999           (path (unless (%null-ptr-p url) (#/path url))))
3000      ;;(#/setDelegate: window self)
3001      (#/setDelegate: window controller)
3002      (#/setDelegate: (text-pane-text-view (slot-value window 'pane)) self)
3003      (#/addWindowController: self controller)
3004      (#/release controller)
3005      (#/setShouldCascadeWindows: controller nil)
3006      (when path
3007        (unless (#/setFrameAutosaveName: window path)
3008          (setq path nil)))
3009      (unless (and path
3010                   (#/setFrameUsingName: window path))
3011        ;; Cascade windows from the top left corner of the topmost editor window.
3012        ;; If there's no editor window, use the default position.
3013        (flet ((editor-window-p (w)
3014                 (and (not (eql w window))
3015                      (eql (#/class (#/windowController w))
3016                           (find-class 'hemlock-editor-window-controller)))))
3017          (let* ((editors (remove-if-not #'editor-window-p (windows)))
3018                 (top-editor (car editors)))
3019            (if top-editor
3020              (ns:with-ns-point (zp 0 0)
3021                (setq *editor-cascade-point* (#/cascadeTopLeftFromPoint:
3022                                              top-editor zp)))
3023              (let* ((screen-frame (#/visibleFrame (#/screen window)))
3024                     (pt (ns:make-ns-point *initial-editor-x-pos*
3025                                           (- (ns:ns-rect-height screen-frame)
3026                                              *initial-editor-y-pos*))))
3027                (setq *editor-cascade-point* pt)))))
3028        (#/cascadeTopLeftFromPoint: window *editor-cascade-point*))
3029      (let ((view (hemlock-view window)))
3030        (hi::handle-hemlock-event view #'(lambda ()
3031                                           (hi::process-file-options))))
3032      (#/synchronizeWindowTitleWithDocumentName controller)))
3033
3034
3035(objc:defmethod (#/close :void) ((self hemlock-editor-document))
3036  #+debug
3037  (#_NSLog #@"Document close: %@" :id self)
3038  (let* ((textstorage (slot-value self 'textstorage)))
3039    (unless (%null-ptr-p textstorage)
3040      (setf (slot-value self 'textstorage) (%null-ptr))
3041      #+huh?
3042      (for-each-textview-using-storage
3043       textstorage
3044       #'(lambda (tv)
3045           (let* ((layout (#/layoutManager tv)))
3046             (#/setBackgroundLayoutEnabled: layout nil))))
3047      (close-hemlock-textstorage textstorage)))
3048  (call-next-method))
3049
3050(objc:defmethod (#/dealloc :void) ((self hemlock-editor-document))
3051  (let* ((textstorage (slot-value self 'textstorage)))
3052    (unless (%null-ptr-p textstorage)
3053      (setf (slot-value self 'textstorage) (%null-ptr))
3054      (close-hemlock-textstorage textstorage)))
3055  (objc:remove-lisp-slots self)
3056  (call-next-method))
3057
3058
3059
3060(defmethod view-screen-lines ((view hi:hemlock-view))
3061    (let* ((pane (hi::hemlock-view-pane view)))
3062      (floor (ns:ns-size-height (#/contentSize (text-pane-scroll-view pane)))
3063             (text-view-line-height (text-pane-text-view pane)))))
3064
3065;; Beware this doesn't seem to take horizontal scrolling into account.
3066(defun visible-charpos-range (tv)
3067  (let* ((rect (#/visibleRect tv))
3068         (container-origin (#/textContainerOrigin tv))
3069         (layout (#/layoutManager tv)))
3070    ;; Convert from view coordinates to container coordinates
3071    (decf (pref rect :<NSR>ect.origin.x) (pref container-origin :<NSP>oint.x))
3072    (decf (pref rect :<NSR>ect.origin.y) (pref container-origin :<NSP>oint.y))
3073    (let* ((glyph-range (#/glyphRangeForBoundingRect:inTextContainer:
3074                         layout rect (#/textContainer tv)))
3075           (char-range (#/characterRangeForGlyphRange:actualGlyphRange:
3076                        layout glyph-range +null-ptr+)))
3077      (values (pref char-range :<NSR>ange.location)
3078              (pref char-range :<NSR>ange.length)))))
3079
3080(defun charpos-xy (tv charpos)
3081  (let* ((layout (#/layoutManager tv))
3082         (glyph-range (#/glyphRangeForCharacterRange:actualCharacterRange:
3083                       layout
3084                       (ns:make-ns-range charpos 0)
3085                       +null-ptr+))
3086         (rect (#/boundingRectForGlyphRange:inTextContainer:
3087                layout
3088                glyph-range
3089                (#/textContainer tv)))
3090         (container-origin (#/textContainerOrigin tv)))
3091    (values (+ (pref rect :<NSR>ect.origin.x) (pref container-origin :<NSP>oint.x))
3092            (+ (pref rect :<NSR>ect.origin.y) (pref container-origin :<NSP>oint.y)))))
3093
3094;;(nth-value 1 (charpos-xy tv (visible-charpos-range tv))) - this is smaller as it
3095;; only includes lines fully scrolled off...
3096(defun text-view-vscroll (tv)
3097  ;; Return the number of pixels scrolled off the top of the view.
3098  (let* ((scroll-view (text-pane-scroll-view (text-view-pane tv)))
3099         (clip-view (#/contentView scroll-view))
3100         (bounds (#/bounds clip-view)))
3101    (ns:ns-rect-y bounds)))
3102
3103(defun set-text-view-vscroll (tv vscroll)
3104  (let* ((scroll-view (text-pane-scroll-view (text-view-pane tv)))
3105         (clip-view (#/contentView scroll-view))
3106         (bounds (#/bounds clip-view)))
3107    (decf vscroll (mod vscroll (text-view-line-height tv))) ;; show whole line
3108    (ns:with-ns-point (new-origin (ns:ns-rect-x bounds) vscroll)
3109      (#/scrollToPoint: clip-view (#/constrainScrollPoint: clip-view new-origin))
3110      (#/reflectScrolledClipView: scroll-view clip-view))))
3111
3112(defun scroll-by-lines (tv nlines)
3113  "Change the vertical origin of the containing scrollview's clipview"
3114  (set-text-view-vscroll tv (+ (text-view-vscroll tv)
3115                               (* nlines (text-view-line-height tv)))))
3116
3117;; TODO: should be a hemlock variable..
3118(defvar *next-screen-context-lines* 2)
3119
3120(defmethod hemlock-ext:scroll-view ((view hi:hemlock-view) how &optional where)
3121  (assume-cocoa-thread)
3122  (let* ((tv (text-pane-text-view (hi::hemlock-view-pane view)))
3123         (may-change-selection t))
3124    (when (eq how :line)
3125      (setq where (require-type where '(integer 0)))
3126      (let* ((line-y (nth-value 1 (charpos-xy tv where)))
3127             (top-y (text-view-vscroll tv))
3128             (nlines (floor (- line-y top-y) (text-view-line-height tv))))
3129        (setq how :lines-down where nlines)))
3130    (ecase how
3131      (:center-selection
3132       (#/centerSelectionInVisibleArea: tv +null-ptr+))
3133      ((:page-up :view-page-up)
3134       (when (eq how :view-page-up)
3135         (setq may-change-selection nil))
3136       (require-type where 'null)
3137       ;; TODO: next-screen-context-lines
3138       (scroll-by-lines tv (- *next-screen-context-lines* (view-screen-lines view))))
3139      ((:page-down :view-page-down)
3140       (when (eq how :view-page-down)
3141         (setq may-change-selection nil))
3142       (require-type where 'null)
3143       (scroll-by-lines tv (- (view-screen-lines view) *next-screen-context-lines*)))
3144      (:lines-up
3145       (scroll-by-lines tv (- (require-type where 'integer))))
3146      (:lines-down
3147       (scroll-by-lines tv (require-type where 'integer))))
3148    ;; If point is not on screen, move it.
3149    (when may-change-selection
3150      (let* ((point (hi::current-point))
3151             (point-pos (hi::mark-absolute-position point)))
3152        (multiple-value-bind (win-pos win-len) (visible-charpos-range tv)
3153          (unless (and (<= win-pos point-pos) (< point-pos (+ win-pos win-len)))
3154            (let* ((point (hi::current-point-collapsing-selection))
3155                   (cache (hemlock-buffer-string-cache (#/hemlockString (#/textStorage tv)))))
3156              (move-hemlock-mark-to-absolute-position point cache win-pos)
3157              (update-hemlock-selection (#/textStorage tv)))))))))
3158
3159(defun iana-charset-name-of-nsstringencoding (ns)
3160  #+cocotron (declare (ignore ns))
3161  #+cocotron +null-ptr+
3162  #-cocotron
3163  (#_CFStringConvertEncodingToIANACharSetName
3164   (#_CFStringConvertNSStringEncodingToEncoding ns)))
3165   
3166(defun nsstring-for-nsstring-encoding (ns)
3167  (let* ((iana (iana-charset-name-of-nsstringencoding ns)))
3168    (if (%null-ptr-p iana)
3169      (#/stringWithFormat: ns:ns-string #@"{%@}"
3170                           (#/localizedNameOfStringEncoding: ns:ns-string ns))
3171      iana)))
3172
3173;;; Return T if the specified #>NSStringEncoding names something that
3174;;; CCL supports.  (Could also have a set of other encoding names that
3175;;; the user is interested in, maintained by preferences.
3176
3177(defun supported-string-encoding-p (ns-string-encoding)
3178  #-cocotron
3179  (let* ((cfname (#_CFStringConvertEncodingToIANACharSetName
3180                  (#_CFStringConvertNSStringEncodingToEncoding ns-string-encoding)))
3181         (name (unless (%null-ptr-p cfname)
3182                 (nstring-upcase (ccl::lisp-string-from-nsstring cfname))))
3183         (keyword (when (and name (find-symbol name "KEYWORD"))
3184                    (intern name "KEYWORD"))))
3185    (or (and keyword (not (null (lookup-character-encoding keyword))))
3186        ;; look in other table maintained by preferences
3187        )))
3188   
3189         
3190
3191
3192 
3193;;; Return a list of :<NSS>tring<E>ncodings, sorted by the
3194;;; (localized) name of each encoding.
3195(defun supported-nsstring-encodings ()
3196  (ccl::collect ((ids))
3197    (let* ((ns-ids (#/availableStringEncodings ns:ns-string)))
3198      (unless (%null-ptr-p ns-ids)
3199        (do* ((i 0 (1+ i)))
3200             ()
3201          (let* ((id (paref ns-ids (:* :<NSS>tring<E>ncoding) i)))
3202            (if (zerop id)
3203              (return (sort (ids)
3204                            #'(lambda (x y)
3205                                (= #$NSOrderedAscending
3206                                   (#/localizedCompare:
3207                                    (nsstring-for-nsstring-encoding x)
3208                                    (nsstring-for-nsstring-encoding y))))))
3209              (when (supported-string-encoding-p id)             
3210                (ids id)))))))))
3211
3212
3213
3214
3215
3216;;; TexEdit.app has support for allowing the encoding list in this
3217;;; popup to be customized (e.g., to suppress encodings that the
3218;;; user isn't interested in.)
3219(defmethod build-encodings-popup ((self hemlock-document-controller)
3220                                  &optional (preferred-encoding (get-default-encoding)))
3221  (let* ((id-list (supported-nsstring-encodings))
3222         (popup (make-instance 'ns:ns-pop-up-button)))
3223    ;;; Add a fake "Automatic" item with tag 0.
3224    (#/addItemWithTitle: popup #@"Automatic")
3225    (#/setTag: (#/itemAtIndex: popup 0) 0)
3226    (dolist (id id-list)
3227      (#/addItemWithTitle: popup (nsstring-for-nsstring-encoding id))
3228      (#/setTag: (#/lastItem popup) (nsstring-encoding-to-nsinteger id)))
3229    (when preferred-encoding
3230      (#/selectItemWithTag: popup (nsstring-encoding-to-nsinteger preferred-encoding)))
3231    (#/sizeToFit popup)
3232    popup))
3233
3234
3235(objc:defmethod (#/runModalOpenPanel:forTypes: :<NSI>nteger)
3236    ((self hemlock-document-controller) panel types)
3237  (let* (#-cocotron (popup (build-encodings-popup self #|preferred|#)))
3238    #-cocotron (#/setAccessoryView: panel popup)
3239    (let* ((result (call-next-method panel types)))
3240      (when (= result #$NSOKButton)
3241        #-cocotron
3242        (with-slots (last-encoding) self
3243          (setq last-encoding
3244                (nsinteger-to-nsstring-encoding (#/tag (#/selectedItem popup))))))
3245      result)))
3246 
3247(defun hemlock-ext:open-hemlock-buffer (&key (pathname :prompt))
3248  (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3249  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3250   (#/sharedDocumentController hemlock-document-controller)
3251   (@selector #/openDocument:) +null-ptr+ t))
3252 
3253(defun hemlock-ext:save-hemlock-buffer (buffer &key pathname copy)
3254  (let ((doc (hi::buffer-document buffer)))
3255    (cond (copy
3256           (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3257           (save-hemlock-document-as doc))
3258          ((null pathname)
3259           (save-hemlock-document doc))
3260          (t
3261           (assert (eq pathname :prompt)) ;; TODO: should handle pathname
3262           (save-hemlock-document-to doc)))))
3263
3264(defmethod save-hemlock-document ((self hemlock-editor-document))
3265  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3266   self (@selector #/saveDocument:) +null-ptr+ t))
3267
3268(defmethod save-hemlock-document-as ((self hemlock-editor-document))
3269  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3270   self (@selector #/saveDocumentAs:) +null-ptr+ t))
3271
3272(defmethod save-hemlock-document-to ((self hemlock-editor-document))
3273  (#/performSelectorOnMainThread:withObject:waitUntilDone:
3274   self (@selector #/saveDocumentTo:) +null-ptr+ t))
3275
3276
3277(defun maybe-fixup-application-menu ()
3278  ;; If the CFBundleName isn't #@"Clozure CL", then set the
3279  ;; title of any menu item on the application menu that ends
3280  ;; in #@"Clozure CL" to the CFBundleName.
3281  (let* ((bundle (#/mainBundle ns:ns-bundle))
3282         (dict (#/infoDictionary bundle))
3283         (cfbundlename (#/objectForKey: dict #@"CFBundleName"))
3284         (targetname #@"Clozure CL"))
3285    (unless (#/isEqualToString: cfbundlename targetname)
3286      (let* ((appmenu (#/submenu (#/itemAtIndex: (#/mainMenu *nsapp*)  0)))
3287             (numitems (#/numberOfItems appmenu)))
3288        (dotimes (i numitems)
3289          (let* ((item (#/itemAtIndex: appmenu i))
3290                 (title (#/title item)))
3291            (unless (%null-ptr-p title)
3292              (when (#/hasSuffix: title targetname)
3293                (let ((new-title (#/mutableCopy title)))
3294                  (ns:with-ns-range (r 0 (#/length new-title))
3295                    (#/replaceOccurrencesOfString:withString:options:range:
3296                     new-title targetname cfbundlename #$NSLiteralSearch r))
3297                  (#/setTitle: item new-title)
3298                  (#/release new-title))))))))))
3299
3300(defun initialize-user-interface ()
3301  ;; The first created instance of an NSDocumentController (or
3302  ;; subclass thereof) becomes the shared document controller.  So it
3303  ;; may look like we're dropping this instance on the floor, but
3304  ;; we're really not.
3305  (maybe-fixup-application-menu)
3306  (make-instance 'hemlock-document-controller)
3307  ;(#/sharedPanel lisp-preferences-panel)
3308  (make-editor-style-map))
3309
3310;;; This needs to run on the main thread.  Sets the cocoa selection from the
3311;;; hemlock selection.
3312(defmethod update-hemlock-selection ((self hemlock-text-storage))
3313  (assume-cocoa-thread)
3314  (let ((buffer (hemlock-buffer self)))
3315    (multiple-value-bind (start end) (hi:buffer-selection-range buffer)
3316      #+debug
3317      (#_NSLog #@"update Hemlock selection: charpos = %d, abspos = %d"
3318               :int (hi::mark-charpos (hi::buffer-point buffer)) :int start)
3319      (for-each-textview-using-storage
3320       self
3321       #'(lambda (tv)
3322           (#/updateSelection:length:affinity: tv
3323                                               start
3324                                               (- end start)
3325                                               (if (eql start 0)
3326                                                 #$NSSelectionAffinityUpstream
3327                                                 #$NSSelectionAffinityDownstream)))))))
3328
3329;; This should be invoked by any command that modifies the buffer, so it can show the
3330;; user what happened...  This ensures the Cocoa selection is made visible, so it
3331;; assumes the Cocoa selection has already been synchronized with the hemlock one.
3332(defmethod hemlock-ext:ensure-selection-visible ((view hi:hemlock-view))
3333  (let ((tv (text-pane-text-view (hi::hemlock-view-pane view))))
3334    (#/scrollRangeToVisible: tv (#/selectedRange tv))))
3335
3336(defloadvar *general-pasteboard* nil)
3337
3338(defun general-pasteboard ()
3339  (or *general-pasteboard*
3340      (setq *general-pasteboard*
3341            (#/retain (#/generalPasteboard ns:ns-pasteboard)))))
3342
3343(defloadvar *string-pasteboard-types* ())
3344
3345(defun string-pasteboard-types ()
3346  (or *string-pasteboard-types*
3347      (setq *string-pasteboard-types*
3348            (#/retain (#/arrayWithObject: ns:ns-array #&NSStringPboardType)))))
3349
3350
3351(objc:defmethod (#/stringToPasteBoard:  :void)
3352    ((self lisp-application) string)
3353  (let* ((pb (general-pasteboard)))
3354    (#/declareTypes:owner: pb (string-pasteboard-types) nil)
3355    (#/setString:forType: pb string #&NSStringPboardType)))
3356   
3357(defun hemlock-ext:string-to-clipboard (string)
3358  (when (> (length string) 0)
3359    (#/performSelectorOnMainThread:withObject:waitUntilDone:
3360     *nsapp* (@selector #/stringToPasteBoard:) (%make-nsstring string) t)))
3361
3362#+cocotron
3363;;; Work around a byte-order bug that affects #/paste.
3364(defun maybe-byte-reverse-string (nsstring)
3365  (let* ((len (#/length nsstring))
3366         (maybe-reversed-count  0))
3367    (dotimes (i len)
3368      (when (not (logtest #xff (#/characterAtIndex: nsstring i)))
3369        (incf maybe-reversed-count)))
3370    (if (> maybe-reversed-count (ash len -1))
3371      (%stack-block ((chars (* 2 len)))
3372        (ns:with-ns-range (r 0 len)
3373          (#/getCharacters:range: nsstring chars r)
3374          (dotimes (i len)
3375            (declare (fixnum i))
3376            (let* ((j (+ i i)))
3377              (declare (fixnum j))
3378              (let* ((w (%get-unsigned-word chars j)))
3379                (setf (%get-unsigned-word chars j)
3380                      (dpb (ldb (byte 8 0) w)
3381                           (byte 8 8)
3382                           (ldb (byte 8 8) w))))))
3383
3384           
3385          (#/autorelease
3386           (make-instance ns:ns-string
3387                          :with-characters chars
3388                          :length len))))
3389      nsstring)))
3390                       
3391                   
3392                                                           
3393;;; The default #/paste method seems to want to set the font to
3394;;; something ... inappropriate.  If we can figure out why it
3395;;; does that and persuade it not to, we wouldn't have to do
3396;;; this here.
3397;;; (It's likely to also be the case that Carbon applications
3398;;; terminate lines with #\Return when writing to the clipboard;
3399;;; we may need to continue to override this method in order to
3400;;; fix that.)
3401(objc:defmethod (#/paste: :void) ((self hemlock-textstorage-text-view) sender)
3402  (declare (ignorable sender))
3403  #+debug (#_NSLog #@"Paste: sender = %@" :id sender)
3404  (let* ((pb (general-pasteboard))
3405         (string (progn (#/types pb) (#/stringForType: pb #&NSStringPboardType))))
3406    #+debug (log-debug "   string = ~s" string)
3407    (unless (%null-ptr-p string)
3408      #+cocotron (setq string (maybe-byte-reverse-string string))
3409      (unless (zerop (ns:ns-range-length (#/rangeOfString: string *ns-cr-string*)))
3410        (setq string (make-instance 'ns:ns-mutable-string :with-string string))
3411        (#/replaceOccurrencesOfString:withString:options:range:
3412                string *ns-cr-string* *ns-lf-string* #$NSLiteralSearch (ns:make-ns-range 0 (#/length string))))
3413      (let* ((textstorage (#/textStorage self)))
3414        (unless (#/shouldChangeTextInRange:replacementString: self (#/selectedRange self) string)
3415          (#/setSelectedRange: self (ns:make-ns-range (#/length textstorage) 0)))
3416        (let* ((selectedrange (#/selectedRange self)))
3417          ;; We really should bracket the call to
3418          ;; #/repaceCharactersInRange:withString: here with calls
3419          ;; to #/beginEditing and #/endEditing, but our implementation
3420          ;; of #/replaceCharactersInRange:withString: calls code that
3421          ;; asserts that editing isn't in progress.  Once that's
3422          ;; fixed, this should be fixed as well.
3423          (#/beginEditing textstorage)
3424          (#/replaceCharactersInRange:withString: textstorage selectedrange string)
3425          (#/endEditing textstorage)
3426          (update-hemlock-selection textstorage) )))))
3427
3428
3429(objc:defmethod (#/hyperSpecLookUp: :void)
3430    ((self hemlock-text-view) sender)
3431  (declare (ignore sender))
3432  (let* ((range (#/selectedRange self)))
3433    (unless (eql 0 (ns:ns-range-length range))
3434      (let* ((string (nstring-upcase (lisp-string-from-nsstring (#/substringWithRange: (#/string (#/textStorage self)) range)))))
3435        (multiple-value-bind (symbol win) (find-symbol string "CL")
3436          (when win
3437            (lookup-hyperspec-symbol symbol self)))))))
3438
3439
3440;; This is called by stuff that makes a window programmatically, e.g. m-. or grep.
3441;; But the Open and New menus invoke the cocoa fns below directly. So just changing
3442;; things here will not change how the menus create views.  Instead,f make changes to
3443;; the subfunctions invoked by the below, e.g. #/readFromURL or #/makeWindowControllers.
3444(defun find-or-make-hemlock-view (&optional pathname)
3445  (assume-cocoa-thread)
3446  (rlet ((perror :id +null-ptr+))
3447    (let* ((doc (if pathname
3448                  (#/openDocumentWithContentsOfURL:display:error:
3449                   (#/sharedDocumentController ns:ns-document-controller)
3450                   (pathname-to-url pathname)
3451                   #$YES
3452                   perror)
3453                  (let ((*last-document-created* nil))
3454                    (#/newDocument: 
3455                     (#/sharedDocumentController hemlock-document-controller)
3456                     +null-ptr+)
3457                    *last-document-created*))))
3458      #+debug (log-debug "created ~s" doc)
3459      (when (%null-ptr-p doc)
3460        (error "Couldn't open ~s: ~a" pathname
3461               (let ((error (pref perror :id)))
3462                 (if (%null-ptr-p error)
3463                   "unknown error encountered"
3464                   (lisp-string-from-nsstring (#/localizedDescription error))))))
3465      (front-view-for-buffer (hemlock-buffer doc)))))
3466
3467(defun hemlock-ext:execute-in-file-view (pathname thunk)
3468  (execute-in-gui #'(lambda ()
3469                      (assume-cocoa-thread)
3470                      (let ((view (find-or-make-hemlock-view pathname)))
3471                        (hi::handle-hemlock-event view thunk)))))
3472
3473(defun hemlock-ext:open-sequence-dialog (&key title sequence action (printer #'prin1))
3474  (make-instance 'sequence-window-controller
3475    :title title
3476    :sequence sequence
3477    :result-callback action
3478    :display printer))
3479
3480(objc:defmethod (#/documentClassForType: :<C>lass) ((self hemlock-document-controller)
3481                                                    type)
3482  (if (#/isEqualToString: type #@"html")
3483      display-document
3484      (call-next-method type)))
3485     
3486
3487(objc:defmethod #/newDisplayDocumentWithTitle:content:
3488                ((self hemlock-document-controller)
3489                 title
3490                 string)
3491  (assume-cocoa-thread)
3492  (let* ((doc (#/makeUntitledDocumentOfType:error: self #@"html" +null-ptr+)))
3493    (unless (%null-ptr-p doc)
3494      (#/addDocument: self doc)
3495      (#/makeWindowControllers doc)
3496      (let* ((window (#/window (#/objectAtIndex: (#/windowControllers doc) 0))))
3497        (#/setTitle: window title)
3498        (let* ((tv (slot-value doc 'text-view))
3499               (lm (#/layoutManager tv))
3500               (ts (#/textStorage lm)))
3501          (#/beginEditing ts)
3502          (#/replaceCharactersInRange:withAttributedString:
3503           ts
3504           (ns:make-ns-range 0 (#/length ts))
3505           string)
3506          (#/endEditing ts))
3507        (#/makeKeyAndOrderFront: window self)))
3508    doc))
3509
3510(defun hemlock-ext:revert-hemlock-buffer (buffer)
3511  (let* ((doc (hi::buffer-document buffer)))
3512    (when doc
3513      (#/performSelectorOnMainThread:withObject:waitUntilDone:
3514       doc
3515       (@selector #/revertDocumentToSaved:)
3516       +null-ptr+
3517       t))))
3518
3519(defun hemlock-ext:raise-buffer-view (buffer &optional action)
3520  "Bring a window containing buffer to front and then execute action in
3521   the window.  Returns before operation completes."
3522  ;; Queue for after this event, so don't screw up current context.
3523  (queue-for-gui #'(lambda ()
3524                     (let ((doc (hi::buffer-document buffer)))
3525                       (unless (and doc (not (%null-ptr-p doc)))
3526                         (hi:editor-error "Deleted buffer: ~s" buffer))
3527                       (#/showWindows doc)
3528                       (when action
3529                         (hi::handle-hemlock-event (front-view-for-buffer buffer) action))))))
3530
3531;;; Enable CL:ED
3532(defun cocoa-edit (&optional arg)
3533  (cond ((or (null arg)
3534             (typep arg 'string)
3535             (typep arg 'pathname))
3536         (when arg
3537           (unless (probe-file arg)
3538             (let ((lpath (merge-pathnames arg *.lisp-pathname*)))
3539               (when (probe-file lpath) (setq arg lpath)))))
3540         (execute-in-gui #'(lambda () (find-or-make-hemlock-view arg))))
3541        ((ccl::valid-function-name-p arg)
3542         (hemlock::edit-definition arg)
3543         nil)
3544        (t (report-bad-arg arg '(or null string pathname (satisfies ccl::valid-function-name-p))))))
3545
3546(setq ccl::*resident-editor-hook* 'cocoa-edit)
3547
3548#-cocotron
3549(defclass url-handler-command (ns:ns-script-command)
3550  ()
3551  (:documentation
3552   "Handles AppleEvents that send us URLs to open. Both logical pathnames
3553    ('ccl:lib;foo.lisp') and symbols (ccl::*current-process*) can be parsed as a URL
3554    with a scheme of 'ccl'. So, we accept those as URLs, and handle them appropriately.")
3555  (:metaclass ns:+ns-script-command))
3556
3557#-cocotron
3558(objc:defmethod #/performDefaultImplementation ((self url-handler-command))
3559  (let* ((string (ccl::lisp-string-from-nsstring (#/directParameter self)))
3560         (symbol (let ((*read-eval* nil))
3561                   (handler-case (read-from-string string)
3562                     (error () nil)))))
3563    (if symbol
3564      (hemlock::edit-definition symbol)
3565      (execute-in-gui #'(lambda ()
3566                          (find-or-make-hemlock-view
3567                           (if (probe-file string)
3568                             string
3569                             (let ((lpath (merge-pathnames string *.lisp-pathname*)))
3570                               (when (probe-file lpath)
3571                                 lpath))))))))
3572  +null-ptr+)
Note: See TracBrowser for help on using the repository browser.