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

Last change on this file since 9251 was 9251, checked in by gb, 13 years ago

In #/drawInsertionPointInRect:color:turnedOn:, just call-next-method
if not on the main thread.

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