source: trunk/source/cocoa-ide/hemlock/src/htext2.lisp @ 8428

Last change on this file since 8428 was 8428, checked in by gz, 12 years ago

Merge of the 'event-ide' branch. Hemlock's thread model has been changed
so that Hemlock commands now run in the Cocoa event thread -- see the
Hemlock file view.lisp for an overview.

IDE compilation has also been reorganized. Hemlock is now more fully
integrated into the IDE and cannot be compiled separately, sorry.

The hemlock-ext package has been repurposed to contain all interfaces
to window-system specific functionality.

There are also many many assorted other changes, cleanups and fixes.

The Hemlock documentation (Hemlock Command Implementor's Manual) in
http://trac.clozure.com/openmcl/wiki now correctly reflects the
implementation, although it doesn't (yet) describe the integration
with Cocoa or the threading model.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Author Date Id Revision
File size: 19.1 KB
Line 
1;;; -*- Log: hemlock.log; Package: Hemlock-Internals -*-
2;;;
3;;; **********************************************************************
4;;; This code was written as part of the CMU Common Lisp project at
5;;; Carnegie Mellon University, and has been placed in the public domain.
6;;;
7#+CMU (ext:file-comment
8  "$Header$")
9;;;
10;;; **********************************************************************
11;;;
12;;; More Hemlock Text-Manipulation functions.
13;;; Written by Skef Wholey.
14;;;
15;;; The code in this file implements the non-insert/delete functions in the
16;;; "Doing Stuff and Going Places" chapter of the Hemlock Design document.
17;;;
18
19(in-package :hemlock-internals)
20
21
22   
23         
24
25(defun region-to-string (region &optional output-string)
26  "Returns a string containing the characters in the given Region."
27  (close-line)
28  (let* ((dst-length (count-characters region))
29         (string (if (and output-string
30                          (<= dst-length (length output-string)))
31                     output-string
32                     (make-string dst-length)))
33         (start-mark (region-start region))
34         (end-mark (region-end region))
35         (start-line (mark-line start-mark))
36         (end-line (mark-line end-mark))
37         (start-charpos (mark-charpos start-mark)))
38    (declare (simple-string string))
39    (if (eq start-line end-line)
40        (%sp-byte-blt (line-chars start-line) start-charpos string 0
41                      dst-length)
42        (let ((index ()))
43          (let* ((line-chars (line-chars start-line))
44                 (dst-end (- (length line-chars) start-charpos)))
45            (declare (simple-string line-chars))
46            (%sp-byte-blt line-chars start-charpos string 0 dst-end)
47            (setf (char string dst-end) #\newline)
48            (setq index (1+ dst-end)))
49          (do* ((line (line-next start-line) (line-next line))
50                (chars (line-chars line) (line-chars line)))
51               ((eq line end-line)
52                (%sp-byte-blt (line-chars line) 0 string index dst-length))
53            (declare (simple-string chars))
54            (%sp-byte-blt (line-chars line) 0 string index
55                          (incf index (length chars)))
56            (setf (char string index) #\newline)
57            (setq index (1+ index)))))
58    (values string dst-length)))
59
60(defun string-to-region (string)
61  "Returns a region containing the characters in the given String."
62  (let* ((string (if (simple-string-p string)
63                     string (coerce string 'simple-string)))
64         (end (length string)))
65    (declare (simple-string string))
66    (do* ((index 0)
67          (buffer (next-disembodied-buffer-counter))
68          (previous-line)
69          (line (make-line :%buffer buffer))
70          (first-line line))
71         (())
72      (let ((right-index (%sp-find-character string index end #\newline)))
73        (cond (right-index
74               (let* ((length (- right-index index))
75                      (chars (make-string length)))
76                 (%sp-byte-blt string index chars 0 length)
77                 (setf (line-chars line) chars))
78               (setq index (1+ right-index))
79               (setq previous-line line)
80               (setq line (make-line :%buffer buffer))
81               (setf (line-next previous-line) line)
82               (setf (line-previous line) previous-line))
83              (t
84               (let* ((length (- end index))
85                      (chars (make-string length)))
86                 (%sp-byte-blt string index chars 0 length)
87                 (setf (line-chars line) chars))
88               (return (renumber-region
89                        (internal-make-region
90                         (mark first-line 0 :right-inserting)
91                         (mark line (length (line-chars line))
92                               :left-inserting))))))))))
93
94(defun line-to-region (line)
95  "Returns a region containing the specified line."
96  (internal-make-region (mark line 0 :right-inserting)
97                        (mark line (line-length* line) :left-inserting)))
98
99(defun previous-character (mark)
100  "Returns the character immediately before the given Mark."
101  (let ((line (mark-line mark))
102        (charpos (mark-charpos mark)))
103    (if (= charpos 0)
104        (if (line-previous line)
105            #\newline
106            nil)
107        (if (current-open-line-p line)
108            (char (the simple-string (current-open-chars))
109                  (if (<= charpos (current-left-open-pos))
110                      (1- charpos)
111                      (1- (+ (current-right-open-pos) (- charpos (current-left-open-pos))))))
112            (schar (line-chars line) (1- charpos))))))
113
114(defun next-character (mark)
115  "Returns the character immediately after the given Mark."
116  (let ((line (mark-line mark))
117        (charpos (mark-charpos mark)))
118    (if (current-open-line-p line)
119        (if (= charpos (- (current-line-cache-length) (- (current-right-open-pos) (current-left-open-pos))))
120            (if (line-next line)
121                #\newline
122                nil)
123            (schar (current-open-chars)
124                   (if (< charpos (current-left-open-pos))
125                       charpos
126                       (+ (current-right-open-pos) (- charpos (current-left-open-pos))))))
127        (let ((chars (line-chars line)))
128          (if (= charpos (strlen chars))
129              (if (line-next line)
130                  #\newline
131                  nil)
132              (schar chars charpos))))))
133
134;;; %Set-Next-Character  --  Internal
135;;;
136;;;    This is the setf form for Next-Character.  Since we may change a
137;;; character to or from a newline, we must be prepared to split and
138;;; join lines.  We cannot just delete  a character and insert the new one
139;;; because the marks would not be right.
140;;;
141(defun %set-next-character (mark character)
142  (let* ((line (mark-line mark))
143         (next (line-next line))
144         (buffer (line-%buffer line)))
145    (check-buffer-modification buffer mark)
146    (modifying-buffer buffer
147      (modifying-line line mark)
148      (cond ((= (mark-charpos mark)
149                (- (current-line-cache-length) (- (current-right-open-pos) (current-left-open-pos))))
150             ;; The mark is at the end of the line.
151             (unless next
152               (error "~S has no next character, so it cannot be set." mark))
153             (unless (char= character #\newline)
154               ;; If the character is no longer a newline then mash two
155               ;; lines together.
156               (let ((chars (line-chars next)))
157                 (declare (simple-string chars))
158                 (setf (current-right-open-pos) (- (current-line-cache-length) (length chars)))
159                 (when (<= (current-right-open-pos) (current-left-open-pos))
160                   (grow-open-chars (* (+ (length chars) (current-left-open-pos) 1) 2)))
161                 (%sp-byte-blt chars 0 (current-open-chars) (current-right-open-pos) 
162                               (current-line-cache-length))
163                 (setf (schar (current-open-chars) (current-left-open-pos)) character)
164                 (incf (current-left-open-pos)))
165               (move-some-marks (charpos next line) 
166                                (+ charpos (current-left-open-pos)))
167               (setq next (line-next next))
168               (setf (line-next line) next)
169               (when next (setf (line-previous next) line))))
170            ((char= character #\newline)
171             ;; The char is being changed to a newline, so we must split lines.
172             (incf (current-right-open-pos))
173             (let* ((len (- (current-line-cache-length) (current-right-open-pos)))         
174                    (chars (make-string len))
175                    (new (make-line :chars chars  :previous line 
176                                    :next next  :%buffer buffer)))
177               (%sp-byte-blt (current-open-chars) (current-right-open-pos) chars 0 len)
178               (maybe-move-some-marks* (charpos line new) (current-left-open-pos)
179                                       (- charpos (current-left-open-pos) 1))
180               (setf (line-next line) new)
181               (when next (setf (line-previous next) new))
182               (setf (current-right-open-pos) (current-line-cache-length))
183               (number-line new)))
184            (t
185             (setf (char (the simple-string (current-open-chars)) (current-right-open-pos))
186                   character)
187             (hi::buffer-note-modification buffer mark 1)))))
188  character)
189
190;;; %Set-Previous-Character  --  Internal
191;;;
192;;;    The setf form for Previous-Character.  We just Temporarily move the
193;;; mark back one and call %Set-Next-Character.
194;;;
195(defun %set-previous-character (mark character)
196  (unless (mark-before mark)
197    (error "~S has no previous character, so it cannot be set." mark))
198  (%set-next-character mark character)
199  (mark-after mark)
200  character)
201
202(defun count-lines (region)
203  "Returns the number of lines in the region, first and last lines inclusive."
204  (do ((line (mark-line (region-start region)) (line-next line))
205       (count 1 (1+ count))
206       (last-line (mark-line (region-end region))))
207      ((eq line last-line) count)))
208
209(defun count-characters (region)
210  "Returns the number of characters in the region."
211  (let* ((start (region-start region))
212         (end (region-end region))
213         (first-line (mark-line start))
214         (last-line (mark-line end)))
215    (if (eq first-line last-line)
216      (- (mark-charpos end) (mark-charpos start))
217      (do ((line (line-next first-line) (line-next line))
218           (count (1+ (- (line-length* first-line) (mark-charpos start)))))
219          ((eq line last-line)
220           (+ count (mark-charpos end)))
221        (setq count (+ 1 count (line-length* line)))))))
222
223(defun line-start (mark &optional line)
224  "Changes the Mark to point to the beginning of the Line and returns it.
225  Line defaults to the line Mark is on."
226  (when line
227    (change-line mark line))
228  (setf (mark-charpos mark) 0)
229  mark)
230
231(defun line-end (mark &optional line)
232  "Changes the Mark to point to the end of the line and returns it.
233  Line defaults to the line Mark is on."
234  (if line
235      (change-line mark line)
236      (setq line (mark-line mark)))
237  (setf (mark-charpos mark) (line-length* line))
238  mark)
239
240(defun buffer-start (mark &optional (buffer (mark-buffer mark)))
241  "Change Mark to point to the beginning of Buffer, which defaults to
242  the buffer Mark is currently in."
243  (unless buffer (error "Mark ~S does not point into a buffer."))
244  (move-mark mark (buffer-start-mark buffer)))
245
246(defun buffer-end (mark &optional (buffer (mark-buffer mark)))
247  "Change Mark to point to the end of Buffer, which defaults to
248  the buffer Mark is currently in."
249  (unless buffer (error "Mark ~S does not point into a buffer."))
250  (move-mark mark (buffer-end-mark buffer)))
251
252(defun move-mark (mark new-position)
253  "Changes the Mark to point to the same position as New-Position."
254  (let* ((line (mark-line new-position)))
255    (change-line mark line))
256  (setf (mark-charpos mark) (mark-charpos new-position))
257  mark)
258
259
260(defun mark-before (mark)
261  "Changes the Mark to point one character before where it currently points.
262  NIL is returned if there is no previous character."
263  (let ((charpos (mark-charpos mark)))
264    (cond ((zerop charpos)
265           (let ((prev (line-previous (mark-line mark))))
266             (when prev
267               (always-change-line mark prev)
268               (setf (mark-charpos mark) (line-length* prev))
269               mark)))
270          (t
271           (setf (mark-charpos mark) (1- charpos))
272           mark))))
273
274(defun mark-after (mark)
275  "Changes the Mark to point one character after where it currently points.
276  NIL is returned if there is no previous character."
277  (let ((line (mark-line mark))
278        (charpos (mark-charpos mark)))
279    (cond ((= charpos (line-length* line))
280           (let ((next (line-next line)))
281             (when next
282               (always-change-line mark next)
283               (setf (mark-charpos mark) 0)
284               mark)))
285          (t
286           (setf (mark-charpos mark) (1+ charpos))
287           mark))))
288
289(defun character-offset (mark n)
290  "Changes the Mark to point N characters after (or -N before if N is negative)
291  where it currently points.  If there aren't N characters before (or after)
292  the mark, Nil is returned."
293  (let* ((charpos (mark-charpos mark)))
294    (if (< n 0)
295      (let ((n (- n)))
296        (if (< charpos n)
297          (do ((line (line-previous (mark-line mark)) (line-previous line))
298               (n (- n charpos 1)))
299              ((null line) nil)
300            (let ((length (line-length* line)))
301              (cond ((<= n length)
302                     (always-change-line mark line)
303                     (setf (mark-charpos mark) (- length n))
304                     (return mark))
305                    (t
306                     (setq n (- n (1+ length)))))))
307          (progn (setf (mark-charpos mark) (- charpos n))
308                 mark)))
309      (let* ((line (mark-line mark))
310             (length (line-length* line)))
311        (if (> (+ charpos n) length)
312          (do ((line (line-next line) (line-next line))
313               (n (- n (1+ (- length charpos)))))
314              ((null line) nil)
315            (let ((length (line-length* line)))
316              (cond ((<= n length)
317                     (always-change-line mark line)
318                     (setf (mark-charpos mark) n)
319                     (return mark))
320                    (t
321                     (setq n (- n (1+ length)))))))
322          (progn (setf (mark-charpos mark) (+ charpos n))
323                 mark))))))
324
325(defun line-offset (mark n &optional charpos)
326  "Changes to Mark to point N lines after (-N before if N is negative) where
327  it currently points.  If there aren't N lines after (or before) the Mark,
328  Nil is returned."
329    (if (< n 0)
330            (do ((line (mark-line mark) (line-previous line))
331                 (n n (1+ n)))
332                ((null line) nil)
333              (when (= n 0)
334                (always-change-line mark line)
335                (setf (mark-charpos mark)
336                      (if charpos
337                        (min (line-length line) charpos)
338                        (min (line-length line) (mark-charpos mark))))
339                (return mark)))
340            (do ((line (mark-line mark) (line-next line))
341                 (n n (1- n)))
342                ((null line) nil)
343              (when (= n 0)
344                (change-line mark line)
345                (setf (mark-charpos mark)
346                      (if charpos
347                        (min (line-length line) charpos)
348                        (min (line-length line) (mark-charpos mark))))
349                (return mark)))))
350
351;;; region-bounds  --  Public
352;;;
353(defun region-bounds (region)
354  "Return as multiple-value the start and end of Region."
355  (values (region-start region) (region-end region)))
356
357(defun set-region-bounds (region start end)
358  "Set the start and end of Region to the marks Start and End."
359  (let ((sl (mark-line start))
360        (el (mark-line end)))
361    (when (or (neq (line-%buffer sl) (line-%buffer el))
362              (> (line-number sl) (line-number el))
363              (and (eq sl el) (> (mark-charpos start) (mark-charpos end))))
364      (error "Marks ~S and ~S cannot be made into a region." start end))
365    (setf (region-start region) start  (region-end region) end))
366  region)
367
368
369;;;; Debugging stuff.
370
371(defun slf (string)
372  "For a good time, figure out what this function does, and why it was written."
373  (delete #\linefeed (the simple-string string)))
374
375(defun %print-whole-line (structure stream)
376  (let* ((hi::*current-buffer* (line-buffer structure)))
377    (cond ((current-open-line-p structure)
378           (write-string (current-open-chars) stream :end (current-left-open-pos))
379           (write-string (current-open-chars) stream :start (current-right-open-pos)
380                         :end (current-line-cache-length)))
381          (t
382           (write-string (line-chars structure) stream)))))
383
384(defun %print-before-mark (mark stream)
385  (let* ((hi::*current-buffer* (mark-buffer mark)))
386    (if (mark-line mark)
387        (let* ((line (mark-line mark))
388               (chars (line-chars line))
389               (charpos (mark-charpos mark))
390               (length (line-length line)))
391          (declare (simple-string chars))
392          (cond ((or (> charpos length) (< charpos 0))
393                 (write-string "{bad mark}" stream))
394                ((current-open-line-p line)
395                 (cond ((< charpos (current-left-open-pos))
396                        (write-string (current-open-chars) stream :end charpos))
397                       (t
398                        (write-string (current-open-chars) stream :end (current-left-open-pos))
399                        (let ((p (+ charpos (- (current-right-open-pos) (current-left-open-pos)))))
400                          (write-string (current-open-chars) stream  :start (current-right-open-pos)
401                                        :end p)))))
402                (t
403                 (write-string chars stream :end charpos))))
404        (write-string "{deleted mark}" stream))))
405
406
407(defun %print-after-mark (mark stream)
408  (let* ((hi::*current-buffer* (mark-buffer mark)))
409    (if (mark-line mark)
410        (let* ((line (mark-line mark))
411               (chars (line-chars line))
412               (charpos (mark-charpos mark))
413               (length (line-length line)))
414          (declare (simple-string chars))
415          (cond ((or (> charpos length) (< charpos 0))
416                 (write-string "{bad mark}" stream))
417                ((current-open-line-p line)
418                 (cond ((< charpos (current-left-open-pos))
419                        (write-string (current-open-chars) stream  :start charpos
420                                      :end (current-left-open-pos))
421                        (write-string (current-open-chars) stream  :start (current-right-open-pos)
422                                      :end (current-line-cache-length)))
423                       (t
424                        (let ((p (+ charpos (- (current-right-open-pos) (current-left-open-pos)))))
425                          (write-string (current-open-chars) stream :start p
426                                        :end (current-line-cache-length))))))
427                (t
428                 (write-string chars stream  :start charpos  :end length))))
429        (write-string "{deleted mark}" stream))))
430
431(defun %print-hline (structure stream d)
432  (declare (ignore d))
433  (write-string "#<Hemlock Line \"" stream)
434  (%print-whole-line structure stream)
435  (write-string "\">" stream))
436
437(defun %print-hmark (structure stream d)
438  (declare (ignore d))
439  (let ((hi::*current-buffer* (mark-buffer structure)))
440    (write-string "#<Hemlock Mark \"" stream)
441    (%print-before-mark structure stream)
442    (write-string "^" stream)
443    (%print-after-mark structure stream)
444    (write-string "\">" stream)))
445
446(defvar *print-region* 10
447  "The number of lines to print out of a region, or NIL if none.")
448
449(defun %print-hregion (region stream d)
450  (declare (ignore d))
451  (write-string "#<Hemlock Region \"" stream)
452  (let* ((start (region-start region))
453         (end (region-end region))
454         (hi::*current-buffer* (mark-buffer start))
455         (first-line (mark-line start))
456         (last-line (mark-line end)))
457    (cond
458     ((not (and (linep first-line) (linep last-line)
459                (eq (line-%buffer first-line) (line-%buffer last-line))
460                (mark<= start end)))
461      (write-string "{bad region}" stream))
462     (*print-region*
463      (cond ((eq first-line last-line)
464             (let ((cs (mark-charpos start))
465                   (ce (mark-charpos end))
466                   (len (line-length first-line)))
467               (cond
468                ((or (< cs 0) (> ce len))
469                 (write-string "{bad region}" stream))
470                ((current-open-line-p first-line)
471                 (let ((gap (- (current-right-open-pos) (current-left-open-pos))))
472                   (cond
473                    ((<= ce (current-left-open-pos))
474                     (write-string (current-open-chars) stream  :start cs  :end ce))
475                    ((>= cs (current-left-open-pos))
476                     (write-string (current-open-chars) stream  :start (+ cs gap)
477                                   :end (+ ce gap)))
478                    (t
479                     (write-string (current-open-chars) stream :start cs
480                                   :end (current-left-open-pos))
481                     (write-string (current-open-chars) stream :start (current-right-open-pos)
482                                   :end (+ gap ce))))))
483                (t
484                 (write-string (line-chars first-line) stream  :start cs
485                               :end ce)))))
486            (t
487             (%print-after-mark start stream)
488             (write-char #\/ stream)
489             (do ((line (line-next first-line) (line-next line))
490                  (last-line (mark-line end))
491                  (cnt *print-region* (1- cnt)))
492                 ((or (eq line last-line)
493                      (when (zerop cnt) (write-string "..." stream) t))
494                  (%print-before-mark end stream))
495               (%print-whole-line line stream)
496               (write-char #\/ stream)))))
497     (t
498      (write-string "{mumble}" stream))))
499  (write-string "\">" stream))
500
501(defun %print-hbuffer (structure stream d)
502  (declare (ignore d))
503  (write-string "#<Hemlock Buffer \"" stream)
504  (write-string (buffer-name structure) stream)
505  (write-string "\">" stream))
506
507(defun check-buffer-modification (buffer mark)
508  (when (typep buffer 'buffer)
509    (let* ((protected-region (buffer-protected-region buffer)))
510      (when protected-region
511        (let* ((prot-start (region-start protected-region))
512               (prot-end (region-end protected-region)))
513         
514          (when (and (mark>= mark prot-start)
515                     (mark< mark prot-end))
516            (editor-error "Can't modify protected buffer region.")))))))
Note: See TracBrowser for help on using the repository browser.