(Fnext_char_property_change): New function.
[bpt/emacs.git] / src / intervals.c
CommitLineData
a50699fd 1/* Code for doing intervals.
f8c25f1b 2 Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
a50699fd
JA
3
4This file is part of GNU Emacs.
5
6GNU Emacs is free software; you can redistribute it and/or modify
7it under the terms of the GNU General Public License as published by
7ce503fd 8the Free Software Foundation; either version 2, or (at your option)
a50699fd
JA
9any later version.
10
11GNU Emacs is distributed in the hope that it will be useful,
12but WITHOUT ANY WARRANTY; without even the implied warranty of
13MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14GNU General Public License for more details.
15
16You should have received a copy of the GNU General Public License
17along with GNU Emacs; see the file COPYING. If not, write to
3b7ad313
EN
18the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
19Boston, MA 02111-1307, USA. */
a50699fd
JA
20
21
22/* NOTES:
23
24 Have to ensure that we can't put symbol nil on a plist, or some
25 functions may work incorrectly.
26
27 An idea: Have the owner of the tree keep count of splits and/or
28 insertion lengths (in intervals), and balance after every N.
29
30 Need to call *_left_hook when buffer is killed.
31
32 Scan for zero-length, or 0-length to see notes about handling
33 zero length interval-markers.
34
35 There are comments around about freeing intervals. It might be
36 faster to explicitly free them (put them on the free list) than
37 to GC them.
38
39*/
40
41
18160b98 42#include <config.h>
a50699fd
JA
43#include "lisp.h"
44#include "intervals.h"
45#include "buffer.h"
328c0f1f 46#include "puresize.h"
f54a8c1a 47#include "keyboard.h"
a50699fd 48
7ce503fd 49/* The rest of the file is within this conditional. */
d2f7a802
JA
50#ifdef USE_TEXT_PROPERTIES
51
45d82bdc
KH
52/* Test for membership, allowing for t (actually any non-cons) to mean the
53 universal set. */
54
55#define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))
56
d8638d30
RS
57#define min(x, y) ((x) < (y) ? (x) : (y))
58
b5f37d3f 59Lisp_Object merge_properties_sticky ();
a50699fd 60\f
7ce503fd 61/* Utility functions for intervals. */
a50699fd
JA
62
63
7ce503fd 64/* Create the root interval of some object, a buffer or string. */
a50699fd
JA
65
66INTERVAL
67create_root_interval (parent)
68 Lisp_Object parent;
69{
328c0f1f
RS
70 INTERVAL new;
71
72 CHECK_IMPURE (parent);
73
74 new = make_interval ();
a50699fd 75
b629dd47 76 if (BUFFERP (parent))
a50699fd 77 {
2bc7a79b
JB
78 new->total_length = (BUF_Z (XBUFFER (parent))
79 - BUF_BEG (XBUFFER (parent)));
e5d967c9 80 BUF_INTERVALS (XBUFFER (parent)) = new;
a50699fd 81 }
b629dd47 82 else if (STRINGP (parent))
a50699fd
JA
83 {
84 new->total_length = XSTRING (parent)->size;
85 XSTRING (parent)->intervals = new;
86 }
87
88 new->parent = (INTERVAL) parent;
89 new->position = 1;
90
91 return new;
92}
93
94/* Make the interval TARGET have exactly the properties of SOURCE */
95
96void
97copy_properties (source, target)
98 register INTERVAL source, target;
99{
100 if (DEFAULT_INTERVAL_P (source) && DEFAULT_INTERVAL_P (target))
101 return;
102
103 COPY_INTERVAL_CACHE (source, target);
104 target->plist = Fcopy_sequence (source->plist);
105}
106
107/* Merge the properties of interval SOURCE into the properties
323a7ad4
RS
108 of interval TARGET. That is to say, each property in SOURCE
109 is added to TARGET if TARGET has no such property as yet. */
a50699fd
JA
110
111static void
112merge_properties (source, target)
113 register INTERVAL source, target;
114{
115 register Lisp_Object o, sym, val;
116
117 if (DEFAULT_INTERVAL_P (source) && DEFAULT_INTERVAL_P (target))
118 return;
119
120 MERGE_INTERVAL_CACHE (source, target);
121
122 o = source->plist;
123 while (! EQ (o, Qnil))
124 {
125 sym = Fcar (o);
126 val = Fmemq (sym, target->plist);
127
128 if (NILP (val))
129 {
130 o = Fcdr (o);
131 val = Fcar (o);
132 target->plist = Fcons (sym, Fcons (val, target->plist));
133 o = Fcdr (o);
134 }
135 else
136 o = Fcdr (Fcdr (o));
137 }
138}
139
140/* Return 1 if the two intervals have the same properties,
7ce503fd 141 0 otherwise. */
a50699fd
JA
142
143int
144intervals_equal (i0, i1)
145 INTERVAL i0, i1;
146{
147 register Lisp_Object i0_cdr, i0_sym, i1_val;
148 register i1_len;
149
150 if (DEFAULT_INTERVAL_P (i0) && DEFAULT_INTERVAL_P (i1))
151 return 1;
152
323a7ad4
RS
153 if (DEFAULT_INTERVAL_P (i0) || DEFAULT_INTERVAL_P (i1))
154 return 0;
155
a50699fd
JA
156 i1_len = XFASTINT (Flength (i1->plist));
157 if (i1_len & 0x1) /* Paranoia -- plists are always even */
158 abort ();
159 i1_len /= 2;
160 i0_cdr = i0->plist;
161 while (!NILP (i0_cdr))
162 {
7ce503fd 163 /* Lengths of the two plists were unequal. */
a50699fd
JA
164 if (i1_len == 0)
165 return 0;
166
167 i0_sym = Fcar (i0_cdr);
168 i1_val = Fmemq (i0_sym, i1->plist);
169
7ce503fd 170 /* i0 has something i1 doesn't. */
a50699fd
JA
171 if (EQ (i1_val, Qnil))
172 return 0;
173
7ce503fd 174 /* i0 and i1 both have sym, but it has different values in each. */
a50699fd 175 i0_cdr = Fcdr (i0_cdr);
7ce503fd 176 if (! EQ (Fcar (Fcdr (i1_val)), Fcar (i0_cdr)))
a50699fd
JA
177 return 0;
178
179 i0_cdr = Fcdr (i0_cdr);
180 i1_len--;
181 }
182
7ce503fd 183 /* Lengths of the two plists were unequal. */
a50699fd
JA
184 if (i1_len > 0)
185 return 0;
186
187 return 1;
188}
189\f
190static int icount;
191static int idepth;
192static int zero_length;
193
a50699fd 194/* Traverse an interval tree TREE, performing FUNCTION on each node.
4a93c905 195 Pass FUNCTION two args: an interval, and ARG. */
a50699fd
JA
196
197void
4a93c905 198traverse_intervals (tree, position, depth, function, arg)
a50699fd 199 INTERVAL tree;
e0b63493 200 int position, depth;
a50699fd 201 void (* function) ();
4a93c905 202 Lisp_Object arg;
a50699fd
JA
203{
204 if (NULL_INTERVAL_P (tree))
205 return;
206
323a7ad4 207 traverse_intervals (tree->left, position, depth + 1, function, arg);
a50699fd
JA
208 position += LEFT_TOTAL_LENGTH (tree);
209 tree->position = position;
4a93c905 210 (*function) (tree, arg);
a50699fd 211 position += LENGTH (tree);
323a7ad4 212 traverse_intervals (tree->right, position, depth + 1, function, arg);
a50699fd
JA
213}
214\f
215#if 0
7ce503fd 216/* These functions are temporary, for debugging purposes only. */
a50699fd
JA
217
218INTERVAL search_interval, found_interval;
219
220void
221check_for_interval (i)
222 register INTERVAL i;
223{
224 if (i == search_interval)
225 {
226 found_interval = i;
227 icount++;
228 }
229}
230
231INTERVAL
232search_for_interval (i, tree)
233 register INTERVAL i, tree;
234{
235 icount = 0;
236 search_interval = i;
237 found_interval = NULL_INTERVAL;
4a93c905 238 traverse_intervals (tree, 1, 0, &check_for_interval, Qnil);
a50699fd
JA
239 return found_interval;
240}
241
242static void
243inc_interval_count (i)
244 INTERVAL i;
245{
246 icount++;
247 if (LENGTH (i) == 0)
248 zero_length++;
249 if (depth > idepth)
250 idepth = depth;
251}
252
253int
254count_intervals (i)
255 register INTERVAL i;
256{
257 icount = 0;
258 idepth = 0;
259 zero_length = 0;
4a93c905 260 traverse_intervals (i, 1, 0, &inc_interval_count, Qnil);
a50699fd
JA
261
262 return icount;
263}
264
265static INTERVAL
266root_interval (interval)
267 INTERVAL interval;
268{
269 register INTERVAL i = interval;
270
271 while (! ROOT_INTERVAL_P (i))
272 i = i->parent;
273
274 return i;
275}
276#endif
277\f
278/* Assuming that a left child exists, perform the following operation:
279
280 A B
281 / \ / \
282 B => A
283 / \ / \
284 c c
285*/
286
287static INTERVAL
288rotate_right (interval)
289 INTERVAL interval;
290{
291 INTERVAL i;
292 INTERVAL B = interval->left;
4314dea4 293 int old_total = interval->total_length;
a50699fd 294
7ce503fd 295 /* Deal with any Parent of A; make it point to B. */
a50699fd
JA
296 if (! ROOT_INTERVAL_P (interval))
297 if (AM_LEFT_CHILD (interval))
4314dea4 298 interval->parent->left = B;
a50699fd 299 else
4314dea4
RS
300 interval->parent->right = B;
301 B->parent = interval->parent;
a50699fd 302
4314dea4
RS
303 /* Make B the parent of A */
304 i = B->right;
305 B->right = interval;
306 interval->parent = B;
a50699fd 307
4314dea4 308 /* Make A point to c */
a50699fd
JA
309 interval->left = i;
310 if (! NULL_INTERVAL_P (i))
311 i->parent = interval;
4314dea4 312
550bd63a 313 /* A's total length is decreased by the length of B and its left child. */
4314dea4
RS
314 interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);
315
316 /* B must have the same total length of A. */
317 B->total_length = old_total;
a50699fd
JA
318
319 return B;
320}
4314dea4 321
a50699fd
JA
322/* Assuming that a right child exists, perform the following operation:
323
324 A B
325 / \ / \
326 B => A
327 / \ / \
328 c c
329*/
330
331static INTERVAL
332rotate_left (interval)
333 INTERVAL interval;
334{
335 INTERVAL i;
336 INTERVAL B = interval->right;
4314dea4 337 int old_total = interval->total_length;
a50699fd 338
4314dea4 339 /* Deal with any parent of A; make it point to B. */
a50699fd
JA
340 if (! ROOT_INTERVAL_P (interval))
341 if (AM_LEFT_CHILD (interval))
4314dea4 342 interval->parent->left = B;
a50699fd 343 else
4314dea4
RS
344 interval->parent->right = B;
345 B->parent = interval->parent;
a50699fd
JA
346
347 /* Make B the parent of A */
4314dea4
RS
348 i = B->left;
349 B->left = interval;
350 interval->parent = B;
a50699fd
JA
351
352 /* Make A point to c */
353 interval->right = i;
354 if (! NULL_INTERVAL_P (i))
355 i->parent = interval;
4314dea4 356
550bd63a 357 /* A's total length is decreased by the length of B and its right child. */
4314dea4
RS
358 interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);
359
360 /* B must have the same total length of A. */
361 B->total_length = old_total;
a50699fd
JA
362
363 return B;
364}
365\f
4314dea4
RS
366/* Balance an interval tree with the assumption that the subtrees
367 themselves are already balanced. */
368
369static INTERVAL
370balance_an_interval (i)
371 INTERVAL i;
372{
373 register int old_diff, new_diff;
374
375 while (1)
376 {
377 old_diff = LEFT_TOTAL_LENGTH (i) - RIGHT_TOTAL_LENGTH (i);
378 if (old_diff > 0)
379 {
380 new_diff = i->total_length - i->left->total_length
381 + RIGHT_TOTAL_LENGTH (i->left) - LEFT_TOTAL_LENGTH (i->left);
382 if (abs (new_diff) >= old_diff)
383 break;
384 i = rotate_right (i);
385 balance_an_interval (i->right);
386 }
387 else if (old_diff < 0)
388 {
389 new_diff = i->total_length - i->right->total_length
390 + LEFT_TOTAL_LENGTH (i->right) - RIGHT_TOTAL_LENGTH (i->right);
391 if (abs (new_diff) >= -old_diff)
392 break;
393 i = rotate_left (i);
394 balance_an_interval (i->left);
395 }
396 else
397 break;
398 }
399 return i;
400}
401
402/* Balance INTERVAL, potentially stuffing it back into its parent
403 Lisp Object. */
404
405static INLINE INTERVAL
406balance_possible_root_interval (interval)
407 register INTERVAL interval;
408{
409 Lisp_Object parent;
410
411 if (interval->parent == NULL_INTERVAL)
412 return interval;
413
414 parent = (Lisp_Object) (interval->parent);
415 interval = balance_an_interval (interval);
416
b629dd47 417 if (BUFFERP (parent))
e5d967c9 418 BUF_INTERVALS (XBUFFER (parent)) = interval;
b629dd47 419 else if (STRINGP (parent))
4314dea4
RS
420 XSTRING (parent)->intervals = interval;
421
422 return interval;
423}
424
425/* Balance the interval tree TREE. Balancing is by weight
426 (the amount of text). */
427
428static INTERVAL
429balance_intervals_internal (tree)
430 register INTERVAL tree;
431{
432 /* Balance within each side. */
433 if (tree->left)
8f3b9b95 434 balance_intervals_internal (tree->left);
4314dea4 435 if (tree->right)
8f3b9b95 436 balance_intervals_internal (tree->right);
4314dea4
RS
437 return balance_an_interval (tree);
438}
439
440/* Advertised interface to balance intervals. */
441
442INTERVAL
443balance_intervals (tree)
444 INTERVAL tree;
445{
446 if (tree == NULL_INTERVAL)
447 return NULL_INTERVAL;
448
449 return balance_intervals_internal (tree);
450}
451\f
2bc7a79b
JB
452/* Split INTERVAL into two pieces, starting the second piece at
453 character position OFFSET (counting from 0), relative to INTERVAL.
454 INTERVAL becomes the left-hand piece, and the right-hand piece
455 (second, lexicographically) is returned.
90ba40fc
JA
456
457 The size and position fields of the two intervals are set based upon
458 those of the original interval. The property list of the new interval
459 is reset, thus it is up to the caller to do the right thing with the
460 result.
a50699fd
JA
461
462 Note that this does not change the position of INTERVAL; if it is a root,
7ce503fd 463 it is still a root after this operation. */
a50699fd
JA
464
465INTERVAL
90ba40fc 466split_interval_right (interval, offset)
a50699fd 467 INTERVAL interval;
90ba40fc 468 int offset;
a50699fd
JA
469{
470 INTERVAL new = make_interval ();
471 int position = interval->position;
2bc7a79b 472 int new_length = LENGTH (interval) - offset;
a50699fd 473
2bc7a79b 474 new->position = position + offset;
a50699fd 475 new->parent = interval;
a50699fd 476
4314dea4 477 if (NULL_RIGHT_CHILD (interval))
a50699fd
JA
478 {
479 interval->right = new;
480 new->total_length = new_length;
481
482 return new;
483 }
484
7ce503fd 485 /* Insert the new node between INTERVAL and its right child. */
a50699fd
JA
486 new->right = interval->right;
487 interval->right->parent = new;
488 interval->right = new;
a50699fd
JA
489 new->total_length = new_length + new->right->total_length;
490
4314dea4
RS
491 balance_an_interval (new);
492 balance_possible_root_interval (interval);
493
a50699fd
JA
494 return new;
495}
496
2bc7a79b
JB
497/* Split INTERVAL into two pieces, starting the second piece at
498 character position OFFSET (counting from 0), relative to INTERVAL.
499 INTERVAL becomes the right-hand piece, and the left-hand piece
500 (first, lexicographically) is returned.
a50699fd 501
90ba40fc
JA
502 The size and position fields of the two intervals are set based upon
503 those of the original interval. The property list of the new interval
504 is reset, thus it is up to the caller to do the right thing with the
505 result.
506
507 Note that this does not change the position of INTERVAL; if it is a root,
7ce503fd 508 it is still a root after this operation. */
a50699fd
JA
509
510INTERVAL
90ba40fc 511split_interval_left (interval, offset)
a50699fd 512 INTERVAL interval;
90ba40fc 513 int offset;
a50699fd
JA
514{
515 INTERVAL new = make_interval ();
516 int position = interval->position;
2bc7a79b 517 int new_length = offset;
a50699fd 518
a50699fd 519 new->position = interval->position;
2bc7a79b 520 interval->position = interval->position + offset;
a50699fd
JA
521 new->parent = interval;
522
523 if (NULL_LEFT_CHILD (interval))
524 {
525 interval->left = new;
526 new->total_length = new_length;
527
528 return new;
529 }
530
7ce503fd 531 /* Insert the new node between INTERVAL and its left child. */
a50699fd
JA
532 new->left = interval->left;
533 new->left->parent = new;
534 interval->left = new;
4314dea4
RS
535 new->total_length = new_length + new->left->total_length;
536
537 balance_an_interval (new);
538 balance_possible_root_interval (interval);
a50699fd
JA
539
540 return new;
541}
542\f
90ba40fc 543/* Find the interval containing text position POSITION in the text
24e3d3bf
JB
544 represented by the interval tree TREE. POSITION is a buffer
545 position; the earliest position is 1. If POSITION is at the end of
546 the buffer, return the interval containing the last character.
a50699fd 547
90ba40fc
JA
548 The `position' field, which is a cache of an interval's position,
549 is updated in the interval found. Other functions (e.g., next_interval)
7ce503fd 550 will update this cache based on the result of find_interval. */
90ba40fc
JA
551
552INLINE INTERVAL
a50699fd
JA
553find_interval (tree, position)
554 register INTERVAL tree;
555 register int position;
556{
24e3d3bf
JB
557 /* The distance from the left edge of the subtree at TREE
558 to POSITION. */
559 register int relative_position = position - BEG;
a50699fd
JA
560
561 if (NULL_INTERVAL_P (tree))
562 return NULL_INTERVAL;
563
24e3d3bf 564 if (relative_position > TOTAL_LENGTH (tree))
a50699fd 565 abort (); /* Paranoia */
a50699fd 566
4314dea4
RS
567 tree = balance_possible_root_interval (tree);
568
a50699fd
JA
569 while (1)
570 {
24e3d3bf 571 if (relative_position < LEFT_TOTAL_LENGTH (tree))
a50699fd
JA
572 {
573 tree = tree->left;
574 }
24e3d3bf
JB
575 else if (! NULL_RIGHT_CHILD (tree)
576 && relative_position >= (TOTAL_LENGTH (tree)
577 - RIGHT_TOTAL_LENGTH (tree)))
a50699fd
JA
578 {
579 relative_position -= (TOTAL_LENGTH (tree)
580 - RIGHT_TOTAL_LENGTH (tree));
581 tree = tree->right;
582 }
583 else
584 {
24e3d3bf
JB
585 tree->position =
586 (position - relative_position /* the left edge of *tree */
587 + LEFT_TOTAL_LENGTH (tree)); /* the left edge of this interval */
588
a50699fd
JA
589 return tree;
590 }
591 }
592}
593\f
594/* Find the succeeding interval (lexicographically) to INTERVAL.
90ba40fc 595 Sets the `position' field based on that of INTERVAL (see
7ce503fd 596 find_interval). */
a50699fd
JA
597
598INTERVAL
599next_interval (interval)
600 register INTERVAL interval;
601{
602 register INTERVAL i = interval;
603 register int next_position;
604
605 if (NULL_INTERVAL_P (i))
606 return NULL_INTERVAL;
607 next_position = interval->position + LENGTH (interval);
608
609 if (! NULL_RIGHT_CHILD (i))
610 {
611 i = i->right;
612 while (! NULL_LEFT_CHILD (i))
613 i = i->left;
614
615 i->position = next_position;
616 return i;
617 }
618
619 while (! NULL_PARENT (i))
620 {
621 if (AM_LEFT_CHILD (i))
622 {
623 i = i->parent;
624 i->position = next_position;
625 return i;
626 }
627
628 i = i->parent;
629 }
630
631 return NULL_INTERVAL;
632}
633
634/* Find the preceding interval (lexicographically) to INTERVAL.
90ba40fc 635 Sets the `position' field based on that of INTERVAL (see
7ce503fd 636 find_interval). */
a50699fd
JA
637
638INTERVAL
639previous_interval (interval)
640 register INTERVAL interval;
641{
642 register INTERVAL i;
643 register position_of_previous;
644
645 if (NULL_INTERVAL_P (interval))
646 return NULL_INTERVAL;
647
648 if (! NULL_LEFT_CHILD (interval))
649 {
650 i = interval->left;
651 while (! NULL_RIGHT_CHILD (i))
652 i = i->right;
653
654 i->position = interval->position - LENGTH (i);
655 return i;
656 }
657
658 i = interval;
659 while (! NULL_PARENT (i))
660 {
661 if (AM_RIGHT_CHILD (i))
662 {
663 i = i->parent;
664
665 i->position = interval->position - LENGTH (i);
666 return i;
667 }
668 i = i->parent;
669 }
670
671 return NULL_INTERVAL;
672}
673\f
90ba40fc 674#if 0
a50699fd
JA
675/* Traverse a path down the interval tree TREE to the interval
676 containing POSITION, adjusting all nodes on the path for
677 an addition of LENGTH characters. Insertion between two intervals
678 (i.e., point == i->position, where i is second interval) means
679 text goes into second interval.
680
681 Modifications are needed to handle the hungry bits -- after simply
682 finding the interval at position (don't add length going down),
683 if it's the beginning of the interval, get the previous interval
8e6208c5 684 and check the hungry bits of both. Then add the length going back up
7ce503fd 685 to the root. */
a50699fd
JA
686
687static INTERVAL
688adjust_intervals_for_insertion (tree, position, length)
689 INTERVAL tree;
690 int position, length;
691{
692 register int relative_position;
693 register INTERVAL this;
694
695 if (TOTAL_LENGTH (tree) == 0) /* Paranoia */
696 abort ();
697
698 /* If inserting at point-max of a buffer, that position
699 will be out of range */
700 if (position > TOTAL_LENGTH (tree))
701 position = TOTAL_LENGTH (tree);
702 relative_position = position;
703 this = tree;
704
705 while (1)
706 {
707 if (relative_position <= LEFT_TOTAL_LENGTH (this))
708 {
709 this->total_length += length;
710 this = this->left;
711 }
712 else if (relative_position > (TOTAL_LENGTH (this)
713 - RIGHT_TOTAL_LENGTH (this)))
714 {
715 relative_position -= (TOTAL_LENGTH (this)
716 - RIGHT_TOTAL_LENGTH (this));
717 this->total_length += length;
718 this = this->right;
719 }
720 else
721 {
722 /* If we are to use zero-length intervals as buffer pointers,
7ce503fd 723 then this code will have to change. */
a50699fd
JA
724 this->total_length += length;
725 this->position = LEFT_TOTAL_LENGTH (this)
726 + position - relative_position + 1;
727 return tree;
728 }
729 }
730}
90ba40fc
JA
731#endif
732
733/* Effect an adjustment corresponding to the addition of LENGTH characters
734 of text. Do this by finding the interval containing POSITION in the
550bd63a 735 interval tree TREE, and then adjusting all of its ancestors by adding
90ba40fc
JA
736 LENGTH to them.
737
738 If POSITION is the first character of an interval, meaning that point
739 is actually between the two intervals, make the new text belong to
740 the interval which is "sticky".
741
1d1d7ba0 742 If both intervals are "sticky", then make them belong to the left-most
90ba40fc 743 interval. Another possibility would be to create a new interval for
7ce503fd 744 this text, and make it have the merged properties of both ends. */
90ba40fc
JA
745
746static INTERVAL
747adjust_intervals_for_insertion (tree, position, length)
748 INTERVAL tree;
749 int position, length;
750{
751 register INTERVAL i;
7ce503fd
RS
752 register INTERVAL temp;
753 int eobp = 0;
754
90ba40fc
JA
755 if (TOTAL_LENGTH (tree) == 0) /* Paranoia */
756 abort ();
757
24e3d3bf
JB
758 /* If inserting at point-max of a buffer, that position will be out
759 of range. Remember that buffer positions are 1-based. */
7ce503fd 760 if (position >= BEG + TOTAL_LENGTH (tree)){
24e3d3bf 761 position = BEG + TOTAL_LENGTH (tree);
7ce503fd
RS
762 eobp = 1;
763 }
90ba40fc
JA
764
765 i = find_interval (tree, position);
7ce503fd 766
2313b945
RS
767 /* If in middle of an interval which is not sticky either way,
768 we must not just give its properties to the insertion.
769 So split this interval at the insertion point. */
770 if (! (position == i->position || eobp)
771 && END_NONSTICKY_P (i)
772 && ! FRONT_STICKY_P (i))
773 {
774 temp = split_interval_right (i, position - i->position);
775 copy_properties (i, temp);
776 i = temp;
777 }
778
90ba40fc 779 /* If we are positioned between intervals, check the stickiness of
7ce503fd
RS
780 both of them. We have to do this too, if we are at BEG or Z. */
781 if (position == i->position || eobp)
90ba40fc 782 {
7ce503fd
RS
783 register INTERVAL prev;
784
785 if (position == BEG)
786 prev = 0;
787 else if (eobp)
788 {
789 prev = i;
790 i = 0;
791 }
792 else
793 prev = previous_interval (i);
90ba40fc 794
7ce503fd
RS
795 /* Even if we are positioned between intervals, we default
796 to the left one if it exists. We extend it now and split
8e6208c5 797 off a part later, if stickiness demands it. */
4314dea4
RS
798 for (temp = prev ? prev : i;! NULL_INTERVAL_P (temp); temp = temp->parent)
799 {
800 temp->total_length += length;
801 temp = balance_possible_root_interval (temp);
802 }
7ce503fd
RS
803
804 /* If at least one interval has sticky properties,
8e6208c5 805 we check the stickiness property by property. */
7ce503fd
RS
806 if (END_NONSTICKY_P (prev) || FRONT_STICKY_P (i))
807 {
dd675b05 808 Lisp_Object pleft, pright;
7ce503fd
RS
809 struct interval newi;
810
dd675b05
KH
811 pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
812 pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;
7ce503fd
RS
813 newi.plist = merge_properties_sticky (pleft, pright);
814
815 if(! prev) /* i.e. position == BEG */
816 {
817 if (! intervals_equal (i, &newi))
818 {
819 i = split_interval_left (i, length);
820 i->plist = newi.plist;
821 }
822 }
823 else if (! intervals_equal (prev, &newi))
824 {
825 prev = split_interval_right (prev,
826 position - prev->position);
827 prev->plist = newi.plist;
828 if (! NULL_INTERVAL_P (i)
829 && intervals_equal (prev, i))
830 merge_interval_right (prev);
831 }
832
833 /* We will need to update the cache here later. */
834 }
835 else if (! prev && ! NILP (i->plist))
836 {
837 /* Just split off a new interval at the left.
838 Since I wasn't front-sticky, the empty plist is ok. */
839 i = split_interval_left (i, length);
840 }
90ba40fc
JA
841 }
842
7ce503fd
RS
843 /* Otherwise just extend the interval. */
844 else
90ba40fc 845 {
7ce503fd 846 for (temp = i; ! NULL_INTERVAL_P (temp); temp = temp->parent)
4314dea4
RS
847 {
848 temp->total_length += length;
849 temp = balance_possible_root_interval (temp);
850 }
90ba40fc 851 }
7ce503fd 852
90ba40fc
JA
853 return tree;
854}
7ce503fd 855
45d82bdc
KH
856/* Any property might be front-sticky on the left, rear-sticky on the left,
857 front-sticky on the right, or rear-sticky on the right; the 16 combinations
858 can be arranged in a matrix with rows denoting the left conditions and
859 columns denoting the right conditions:
860 _ __ _
861_ FR FR FR FR
862FR__ 0 1 2 3
863 _FR 4 5 6 7
864FR 8 9 A B
865 FR C D E F
866
867 left-props = '(front-sticky (p8 p9 pa pb pc pd pe pf)
868 rear-nonsticky (p4 p5 p6 p7 p8 p9 pa pb)
869 p0 L p1 L p2 L p3 L p4 L p5 L p6 L p7 L
870 p8 L p9 L pa L pb L pc L pd L pe L pf L)
871 right-props = '(front-sticky (p2 p3 p6 p7 pa pb pe pf)
872 rear-nonsticky (p1 p2 p5 p6 p9 pa pd pe)
873 p0 R p1 R p2 R p3 R p4 R p5 R p6 R p7 R
874 p8 R p9 R pa R pb R pc R pd R pe R pf R)
875
876 We inherit from whoever has a sticky side facing us. If both sides
877 do (cases 2, 3, E, and F), then we inherit from whichever side has a
878 non-nil value for the current property. If both sides do, then we take
879 from the left.
880
881 When we inherit a property, we get its stickiness as well as its value.
882 So, when we merge the above two lists, we expect to get this:
883
884 result = '(front-sticky (p6 p7 pa pb pc pd pe pf)
885 rear-nonsticky (p6 pa)
886 p0 L p1 L p2 L p3 L p6 R p7 R
887 pa R pb R pc L pd L pe L pf L)
888
889 The optimizable special cases are:
890 left rear-nonsticky = nil, right front-sticky = nil (inherit left)
891 left rear-nonsticky = t, right front-sticky = t (inherit right)
892 left rear-nonsticky = t, right front-sticky = nil (inherit none)
893*/
894
7ce503fd
RS
895Lisp_Object
896merge_properties_sticky (pleft, pright)
897 Lisp_Object pleft, pright;
898{
dd675b05
KH
899 register Lisp_Object props, front, rear;
900 Lisp_Object lfront, lrear, rfront, rrear;
45d82bdc
KH
901 register Lisp_Object tail1, tail2, sym, lval, rval;
902 int use_left, use_right;
7ce503fd 903
dd675b05
KH
904 props = Qnil;
905 front = Qnil;
906 rear = Qnil;
907 lfront = textget (pleft, Qfront_sticky);
908 lrear = textget (pleft, Qrear_nonsticky);
909 rfront = textget (pright, Qfront_sticky);
910 rrear = textget (pright, Qrear_nonsticky);
911
45d82bdc
KH
912 /* Go through each element of PRIGHT. */
913 for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
7ce503fd
RS
914 {
915 sym = Fcar (tail1);
916
917 /* Sticky properties get special treatment. */
918 if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
919 continue;
45d82bdc
KH
920
921 rval = Fcar (Fcdr (tail1));
922 for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
923 if (EQ (sym, Fcar (tail2)))
924 break;
925 lval = (NILP (tail2) ? Qnil : Fcar( Fcdr (tail2)));
926
927 use_left = ! TMEM (sym, lrear);
928 use_right = TMEM (sym, rfront);
929 if (use_left && use_right)
930 {
931 use_left = ! NILP (lval);
932 use_right = ! NILP (rval);
933 }
934 if (use_left)
7ce503fd 935 {
45d82bdc
KH
936 /* We build props as (value sym ...) rather than (sym value ...)
937 because we plan to nreverse it when we're done. */
938 if (! NILP (lval))
939 props = Fcons (lval, Fcons (sym, props));
940 if (TMEM (sym, lfront))
7ce503fd 941 front = Fcons (sym, front);
45d82bdc
KH
942 if (TMEM (sym, lrear))
943 rear = Fcons (sym, rear);
7ce503fd 944 }
45d82bdc 945 else if (use_right)
7ce503fd 946 {
45d82bdc
KH
947 if (! NILP (rval))
948 props = Fcons (rval, Fcons (sym, props));
949 if (TMEM (sym, rfront))
950 front = Fcons (sym, front);
951 if (TMEM (sym, rrear))
952 rear = Fcons (sym, rear);
7ce503fd
RS
953 }
954 }
45d82bdc
KH
955
956 /* Now go through each element of PLEFT. */
957 for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
7ce503fd
RS
958 {
959 sym = Fcar (tail2);
960
961 /* Sticky properties get special treatment. */
962 if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
963 continue;
964
45d82bdc
KH
965 /* If sym is in PRIGHT, we've already considered it. */
966 for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
7ce503fd
RS
967 if (EQ (sym, Fcar (tail1)))
968 break;
45d82bdc
KH
969 if (! NILP (tail1))
970 continue;
971
972 lval = Fcar (Fcdr (tail2));
973
974 /* Since rval is known to be nil in this loop, the test simplifies. */
975 if (! TMEM (sym, lrear))
7ce503fd 976 {
45d82bdc
KH
977 if (! NILP (lval))
978 props = Fcons (lval, Fcons (sym, props));
979 if (TMEM (sym, lfront))
980 front = Fcons (sym, front);
981 }
982 else if (TMEM (sym, rfront))
983 {
984 /* The value is nil, but we still inherit the stickiness
985 from the right. */
7ce503fd 986 front = Fcons (sym, front);
45d82bdc 987 if (TMEM (sym, rrear))
7ce503fd
RS
988 rear = Fcons (sym, rear);
989 }
990 }
550bd63a 991 props = Fnreverse (props);
7ce503fd 992 if (! NILP (rear))
550bd63a 993 props = Fcons (Qrear_nonsticky, Fcons (Fnreverse (rear), props));
45d82bdc
KH
994 if (! NILP (front))
995 props = Fcons (Qfront_sticky, Fcons (Fnreverse (front), props));
7ce503fd 996 return props;
7ce503fd
RS
997}
998
a50699fd 999\f
90ba40fc
JA
1000/* Delete an node I from its interval tree by merging its subtrees
1001 into one subtree which is then returned. Caller is responsible for
7ce503fd 1002 storing the resulting subtree into its parent. */
a50699fd
JA
1003
1004static INTERVAL
1005delete_node (i)
1006 register INTERVAL i;
1007{
1008 register INTERVAL migrate, this;
1009 register int migrate_amt;
1010
1011 if (NULL_INTERVAL_P (i->left))
1012 return i->right;
1013 if (NULL_INTERVAL_P (i->right))
1014 return i->left;
1015
1016 migrate = i->left;
1017 migrate_amt = i->left->total_length;
1018 this = i->right;
1019 this->total_length += migrate_amt;
1020 while (! NULL_INTERVAL_P (this->left))
1021 {
1022 this = this->left;
1023 this->total_length += migrate_amt;
1024 }
1025 this->left = migrate;
1026 migrate->parent = this;
1027
1028 return i->right;
1029}
1030
1031/* Delete interval I from its tree by calling `delete_node'
1032 and properly connecting the resultant subtree.
1033
1034 I is presumed to be empty; that is, no adjustments are made
7ce503fd 1035 for the length of I. */
a50699fd
JA
1036
1037void
1038delete_interval (i)
1039 register INTERVAL i;
1040{
1041 register INTERVAL parent;
1042 int amt = LENGTH (i);
1043
7ce503fd 1044 if (amt > 0) /* Only used on zero-length intervals now. */
a50699fd
JA
1045 abort ();
1046
1047 if (ROOT_INTERVAL_P (i))
1048 {
dd675b05
KH
1049 Lisp_Object owner;
1050 owner = (Lisp_Object) i->parent;
a50699fd
JA
1051 parent = delete_node (i);
1052 if (! NULL_INTERVAL_P (parent))
1053 parent->parent = (INTERVAL) owner;
1054
b629dd47 1055 if (BUFFERP (owner))
e5d967c9 1056 BUF_INTERVALS (XBUFFER (owner)) = parent;
b629dd47 1057 else if (STRINGP (owner))
a50699fd
JA
1058 XSTRING (owner)->intervals = parent;
1059 else
1060 abort ();
1061
1062 return;
1063 }
1064
1065 parent = i->parent;
1066 if (AM_LEFT_CHILD (i))
1067 {
1068 parent->left = delete_node (i);
1069 if (! NULL_INTERVAL_P (parent->left))
1070 parent->left->parent = parent;
1071 }
1072 else
1073 {
1074 parent->right = delete_node (i);
1075 if (! NULL_INTERVAL_P (parent->right))
1076 parent->right->parent = parent;
1077 }
1078}
1079\f
24e3d3bf
JB
1080/* Find the interval in TREE corresponding to the relative position
1081 FROM and delete as much as possible of AMOUNT from that interval.
1082 Return the amount actually deleted, and if the interval was
1083 zeroed-out, delete that interval node from the tree.
1084
1085 Note that FROM is actually origin zero, aka relative to the
1086 leftmost edge of tree. This is appropriate since we call ourselves
1087 recursively on subtrees.
a50699fd 1088
1d1d7ba0 1089 Do this by recursing down TREE to the interval in question, and
7ce503fd 1090 deleting the appropriate amount of text. */
a50699fd
JA
1091
1092static int
1093interval_deletion_adjustment (tree, from, amount)
1094 register INTERVAL tree;
1095 register int from, amount;
1096{
1097 register int relative_position = from;
1098
1099 if (NULL_INTERVAL_P (tree))
1100 return 0;
1101
1102 /* Left branch */
24e3d3bf 1103 if (relative_position < LEFT_TOTAL_LENGTH (tree))
a50699fd
JA
1104 {
1105 int subtract = interval_deletion_adjustment (tree->left,
1106 relative_position,
1107 amount);
1108 tree->total_length -= subtract;
1109 return subtract;
1110 }
1111 /* Right branch */
24e3d3bf
JB
1112 else if (relative_position >= (TOTAL_LENGTH (tree)
1113 - RIGHT_TOTAL_LENGTH (tree)))
a50699fd
JA
1114 {
1115 int subtract;
1116
1117 relative_position -= (tree->total_length
1118 - RIGHT_TOTAL_LENGTH (tree));
1119 subtract = interval_deletion_adjustment (tree->right,
1120 relative_position,
1121 amount);
1122 tree->total_length -= subtract;
1123 return subtract;
1124 }
7ce503fd 1125 /* Here -- this node. */
a50699fd
JA
1126 else
1127 {
24e3d3bf
JB
1128 /* How much can we delete from this interval? */
1129 int my_amount = ((tree->total_length
1130 - RIGHT_TOTAL_LENGTH (tree))
1131 - relative_position);
1132
1133 if (amount > my_amount)
1134 amount = my_amount;
1135
1136 tree->total_length -= amount;
1137 if (LENGTH (tree) == 0)
1138 delete_interval (tree);
1139
1140 return amount;
a50699fd
JA
1141 }
1142
7ce503fd 1143 /* Never reach here. */
a50699fd
JA
1144}
1145
24e3d3bf
JB
1146/* Effect the adjustments necessary to the interval tree of BUFFER to
1147 correspond to the deletion of LENGTH characters from that buffer
1148 text. The deletion is effected at position START (which is a
7ce503fd 1149 buffer position, i.e. origin 1). */
1d1d7ba0 1150
a50699fd
JA
1151static void
1152adjust_intervals_for_deletion (buffer, start, length)
1153 struct buffer *buffer;
1154 int start, length;
1155{
1156 register int left_to_delete = length;
e5d967c9 1157 register INTERVAL tree = BUF_INTERVALS (buffer);
a50699fd
JA
1158 register int deleted;
1159
1160 if (NULL_INTERVAL_P (tree))
1161 return;
1162
24e3d3bf
JB
1163 if (start > BEG + TOTAL_LENGTH (tree)
1164 || start + length > BEG + TOTAL_LENGTH (tree))
1165 abort ();
1166
a50699fd
JA
1167 if (length == TOTAL_LENGTH (tree))
1168 {
e5d967c9 1169 BUF_INTERVALS (buffer) = NULL_INTERVAL;
a50699fd
JA
1170 return;
1171 }
1172
1173 if (ONLY_INTERVAL_P (tree))
1174 {
1175 tree->total_length -= length;
1176 return;
1177 }
1178
24e3d3bf
JB
1179 if (start > BEG + TOTAL_LENGTH (tree))
1180 start = BEG + TOTAL_LENGTH (tree);
a50699fd
JA
1181 while (left_to_delete > 0)
1182 {
24e3d3bf 1183 left_to_delete -= interval_deletion_adjustment (tree, start - 1,
a50699fd 1184 left_to_delete);
e5d967c9 1185 tree = BUF_INTERVALS (buffer);
a50699fd
JA
1186 if (left_to_delete == tree->total_length)
1187 {
e5d967c9 1188 BUF_INTERVALS (buffer) = NULL_INTERVAL;
a50699fd
JA
1189 return;
1190 }
1191 }
1192}
1193\f
eb8c3be9 1194/* Make the adjustments necessary to the interval tree of BUFFER to
1d1d7ba0
JA
1195 represent an addition or deletion of LENGTH characters starting
1196 at position START. Addition or deletion is indicated by the sign
7ce503fd 1197 of LENGTH. */
a50699fd
JA
1198
1199INLINE void
1200offset_intervals (buffer, start, length)
1201 struct buffer *buffer;
1202 int start, length;
1203{
e5d967c9 1204 if (NULL_INTERVAL_P (BUF_INTERVALS (buffer)) || length == 0)
a50699fd
JA
1205 return;
1206
1207 if (length > 0)
e5d967c9 1208 adjust_intervals_for_insertion (BUF_INTERVALS (buffer), start, length);
a50699fd
JA
1209 else
1210 adjust_intervals_for_deletion (buffer, start, -length);
1211}
9c79dd1b
JA
1212\f
1213/* Merge interval I with its lexicographic successor. The resulting
1214 interval is returned, and has the properties of the original
1215 successor. The properties of I are lost. I is removed from the
1216 interval tree.
1217
1218 IMPORTANT:
1219 The caller must verify that this is not the last (rightmost)
7ce503fd 1220 interval. */
9c79dd1b
JA
1221
1222INTERVAL
1223merge_interval_right (i)
1224 register INTERVAL i;
1225{
1226 register int absorb = LENGTH (i);
1227 register INTERVAL successor;
1228
7ce503fd 1229 /* Zero out this interval. */
9c79dd1b
JA
1230 i->total_length -= absorb;
1231
7ce503fd 1232 /* Find the succeeding interval. */
9c79dd1b 1233 if (! NULL_RIGHT_CHILD (i)) /* It's below us. Add absorb
7ce503fd 1234 as we descend. */
9c79dd1b
JA
1235 {
1236 successor = i->right;
1237 while (! NULL_LEFT_CHILD (successor))
1238 {
1239 successor->total_length += absorb;
1240 successor = successor->left;
1241 }
1242
1243 successor->total_length += absorb;
1244 delete_interval (i);
1245 return successor;
1246 }
1247
1248 successor = i;
1249 while (! NULL_PARENT (successor)) /* It's above us. Subtract as
7ce503fd 1250 we ascend. */
9c79dd1b
JA
1251 {
1252 if (AM_LEFT_CHILD (successor))
1253 {
1254 successor = successor->parent;
1255 delete_interval (i);
1256 return successor;
1257 }
1258
1259 successor = successor->parent;
1260 successor->total_length -= absorb;
1261 }
1262
1263 /* This must be the rightmost or last interval and cannot
7ce503fd 1264 be merged right. The caller should have known. */
9c79dd1b
JA
1265 abort ();
1266}
1267\f
1268/* Merge interval I with its lexicographic predecessor. The resulting
1269 interval is returned, and has the properties of the original predecessor.
1270 The properties of I are lost. Interval node I is removed from the tree.
1271
1272 IMPORTANT:
7ce503fd 1273 The caller must verify that this is not the first (leftmost) interval. */
9c79dd1b
JA
1274
1275INTERVAL
1276merge_interval_left (i)
1277 register INTERVAL i;
1278{
1279 register int absorb = LENGTH (i);
1280 register INTERVAL predecessor;
1281
7ce503fd 1282 /* Zero out this interval. */
9c79dd1b
JA
1283 i->total_length -= absorb;
1284
7ce503fd 1285 /* Find the preceding interval. */
9c79dd1b 1286 if (! NULL_LEFT_CHILD (i)) /* It's below us. Go down,
7ce503fd 1287 adding ABSORB as we go. */
9c79dd1b
JA
1288 {
1289 predecessor = i->left;
1290 while (! NULL_RIGHT_CHILD (predecessor))
1291 {
1292 predecessor->total_length += absorb;
1293 predecessor = predecessor->right;
1294 }
1295
1296 predecessor->total_length += absorb;
1297 delete_interval (i);
1298 return predecessor;
1299 }
1300
1301 predecessor = i;
1302 while (! NULL_PARENT (predecessor)) /* It's above us. Go up,
7ce503fd 1303 subtracting ABSORB. */
9c79dd1b
JA
1304 {
1305 if (AM_RIGHT_CHILD (predecessor))
1306 {
1307 predecessor = predecessor->parent;
1308 delete_interval (i);
1309 return predecessor;
1310 }
1311
1312 predecessor = predecessor->parent;
1313 predecessor->total_length -= absorb;
1314 }
a50699fd 1315
9c79dd1b 1316 /* This must be the leftmost or first interval and cannot
7ce503fd 1317 be merged left. The caller should have known. */
9c79dd1b
JA
1318 abort ();
1319}
1320\f
1d1d7ba0
JA
1321/* Make an exact copy of interval tree SOURCE which descends from
1322 PARENT. This is done by recursing through SOURCE, copying
1323 the current interval and its properties, and then adjusting
7ce503fd 1324 the pointers of the copy. */
1d1d7ba0 1325
a50699fd
JA
1326static INTERVAL
1327reproduce_tree (source, parent)
1328 INTERVAL source, parent;
1329{
1330 register INTERVAL t = make_interval ();
1331
1332 bcopy (source, t, INTERVAL_SIZE);
1333 copy_properties (source, t);
1334 t->parent = parent;
1335 if (! NULL_LEFT_CHILD (source))
1336 t->left = reproduce_tree (source->left, t);
1337 if (! NULL_RIGHT_CHILD (source))
1338 t->right = reproduce_tree (source->right, t);
1339
1340 return t;
1341}
1342
24e3d3bf
JB
1343#if 0
1344/* Nobody calls this. Perhaps it's a vestige of an earlier design. */
1345
1d1d7ba0
JA
1346/* Make a new interval of length LENGTH starting at START in the
1347 group of intervals INTERVALS, which is actually an interval tree.
1348 Returns the new interval.
1349
1350 Generate an error if the new positions would overlap an existing
7ce503fd 1351 interval. */
1d1d7ba0 1352
a50699fd
JA
1353static INTERVAL
1354make_new_interval (intervals, start, length)
1355 INTERVAL intervals;
1356 int start, length;
1357{
1358 INTERVAL slot;
1359
1360 slot = find_interval (intervals, start);
1361 if (start + length > slot->position + LENGTH (slot))
1362 error ("Interval would overlap");
1363
1364 if (start == slot->position && length == LENGTH (slot))
1365 return slot;
1366
1367 if (slot->position == start)
1368 {
7ce503fd 1369 /* New right node. */
2bc7a79b 1370 split_interval_right (slot, length);
a50699fd
JA
1371 return slot;
1372 }
1373
1374 if (slot->position + LENGTH (slot) == start + length)
1375 {
7ce503fd 1376 /* New left node. */
2bc7a79b 1377 split_interval_left (slot, LENGTH (slot) - length);
a50699fd
JA
1378 return slot;
1379 }
1380
7ce503fd 1381 /* Convert interval SLOT into three intervals. */
2bc7a79b
JB
1382 split_interval_left (slot, start - slot->position);
1383 split_interval_right (slot, length);
a50699fd
JA
1384 return slot;
1385}
24e3d3bf 1386#endif
294efdbe 1387\f
9c79dd1b 1388/* Insert the intervals of SOURCE into BUFFER at POSITION.
0b79989f 1389 LENGTH is the length of the text in SOURCE.
a50699fd 1390
2bc7a79b
JB
1391 This is used in insdel.c when inserting Lisp_Strings into the
1392 buffer. The text corresponding to SOURCE is already in the buffer
1393 when this is called. The intervals of new tree are a copy of those
1394 belonging to the string being inserted; intervals are never
1395 shared.
a50699fd 1396
0b79989f
RS
1397 If the inserted text had no intervals associated, and we don't
1398 want to inherit the surrounding text's properties, this function
a50699fd 1399 simply returns -- offset_intervals should handle placing the
90ba40fc 1400 text in the correct interval, depending on the sticky bits.
a50699fd
JA
1401
1402 If the inserted text had properties (intervals), then there are two
1403 cases -- either insertion happened in the middle of some interval,
1404 or between two intervals.
1405
1406 If the text goes into the middle of an interval, then new
1407 intervals are created in the middle with only the properties of
1408 the new text, *unless* the macro MERGE_INSERTIONS is true, in
1409 which case the new text has the union of its properties and those
1410 of the text into which it was inserted.
1411
1412 If the text goes between two intervals, then if neither interval
90ba40fc
JA
1413 had its appropriate sticky property set (front_sticky, rear_sticky),
1414 the new text has only its properties. If one of the sticky properties
a50699fd 1415 is set, then the new text "sticks" to that region and its properties
eb8c3be9 1416 depend on merging as above. If both the preceding and succeeding
90ba40fc
JA
1417 intervals to the new text are "sticky", then the new text retains
1418 only its properties, as if neither sticky property were set. Perhaps
a50699fd 1419 we should consider merging all three sets of properties onto the new
7ce503fd 1420 text... */
a50699fd
JA
1421
1422void
0b79989f 1423graft_intervals_into_buffer (source, position, length, buffer, inherit)
9c79dd1b 1424 INTERVAL source;
0b79989f 1425 int position, length;
9c79dd1b 1426 struct buffer *buffer;
7ea69158 1427 int inherit;
a50699fd 1428{
323a7ad4 1429 register INTERVAL under, over, this, prev;
e5d967c9 1430 register INTERVAL tree;
323a7ad4 1431 int middle;
a50699fd 1432
e5d967c9
RS
1433 tree = BUF_INTERVALS (buffer);
1434
a50699fd 1435 /* If the new text has no properties, it becomes part of whatever
7ce503fd 1436 interval it was inserted into. */
9c79dd1b 1437 if (NULL_INTERVAL_P (source))
0b79989f
RS
1438 {
1439 Lisp_Object buf;
08b05272 1440 if (!inherit && ! NULL_INTERVAL_P (tree))
0b79989f 1441 {
55cfc731 1442 XSETBUFFER (buf, buffer);
0b79989f
RS
1443 Fset_text_properties (make_number (position),
1444 make_number (position + length),
1445 Qnil, buf);
1446 }
e5d967c9
RS
1447 if (! NULL_INTERVAL_P (BUF_INTERVALS (buffer)))
1448 BUF_INTERVALS (buffer) = balance_an_interval (BUF_INTERVALS (buffer));
0b79989f
RS
1449 return;
1450 }
a50699fd 1451
a50699fd
JA
1452 if (NULL_INTERVAL_P (tree))
1453 {
1454 /* The inserted text constitutes the whole buffer, so
7ce503fd 1455 simply copy over the interval structure. */
2bc7a79b 1456 if ((BUF_Z (buffer) - BUF_BEG (buffer)) == TOTAL_LENGTH (source))
a50699fd 1457 {
b8e4857c 1458 Lisp_Object buf;
55cfc731 1459 XSETBUFFER (buf, buffer);
e5d967c9 1460 BUF_INTERVALS (buffer) = reproduce_tree (source, buf);
7ce503fd 1461 /* Explicitly free the old tree here. */
a50699fd
JA
1462
1463 return;
1464 }
1465
1466 /* Create an interval tree in which to place a copy
7ce503fd 1467 of the intervals of the inserted string. */
a50699fd 1468 {
249a6da9 1469 Lisp_Object buf;
55cfc731 1470 XSETBUFFER (buf, buffer);
323a7ad4 1471 tree = create_root_interval (buf);
a50699fd
JA
1472 }
1473 }
7ea69158
RS
1474 else if (TOTAL_LENGTH (tree) == TOTAL_LENGTH (source))
1475 /* If the buffer contains only the new string, but
1476 there was already some interval tree there, then it may be
1477 some zero length intervals. Eventually, do something clever
1478 about inserting properly. For now, just waste the old intervals. */
1479 {
e5d967c9 1480 BUF_INTERVALS (buffer) = reproduce_tree (source, tree->parent);
7ea69158 1481 /* Explicitly free the old tree here. */
a50699fd 1482
7ea69158
RS
1483 return;
1484 }
1485 /* Paranoia -- the text has already been added, so this buffer
1486 should be of non-zero length. */
1487 else if (TOTAL_LENGTH (tree) == 0)
1488 abort ();
a50699fd
JA
1489
1490 this = under = find_interval (tree, position);
1491 if (NULL_INTERVAL_P (under)) /* Paranoia */
1492 abort ();
9c79dd1b 1493 over = find_interval (source, 1);
a50699fd 1494
323a7ad4
RS
1495 /* Here for insertion in the middle of an interval.
1496 Split off an equivalent interval to the right,
1497 then don't bother with it any more. */
a50699fd 1498
323a7ad4 1499 if (position > under->position)
a50699fd
JA
1500 {
1501 INTERVAL end_unchanged
2bc7a79b 1502 = split_interval_left (this, position - under->position);
a50699fd 1503 copy_properties (under, end_unchanged);
323a7ad4
RS
1504 under->position = position;
1505 prev = 0;
1506 middle = 1;
a50699fd 1507 }
323a7ad4
RS
1508 else
1509 {
1510 prev = previous_interval (under);
7ce503fd 1511 if (prev && !END_NONSTICKY_P (prev))
323a7ad4
RS
1512 prev = 0;
1513 }
1514
1515 /* Insertion is now at beginning of UNDER. */
a50699fd 1516
323a7ad4 1517 /* The inserted text "sticks" to the interval `under',
7ce503fd
RS
1518 which means it gets those properties.
1519 The properties of under are the result of
8e6208c5 1520 adjust_intervals_for_insertion, so stickiness has
7ce503fd
RS
1521 already been taken care of. */
1522
a50699fd
JA
1523 while (! NULL_INTERVAL_P (over))
1524 {
767809fb 1525 if (LENGTH (over) < LENGTH (under))
7ce503fd
RS
1526 {
1527 this = split_interval_left (under, LENGTH (over));
1528 copy_properties (under, this);
1529 }
323a7ad4
RS
1530 else
1531 this = under;
a50699fd 1532 copy_properties (over, this);
7ea69158 1533 if (inherit)
7ce503fd
RS
1534 merge_properties (over, this);
1535 else
1536 copy_properties (over, this);
a50699fd
JA
1537 over = next_interval (over);
1538 }
1539
e5d967c9
RS
1540 if (! NULL_INTERVAL_P (BUF_INTERVALS (buffer)))
1541 BUF_INTERVALS (buffer) = balance_an_interval (BUF_INTERVALS (buffer));
a50699fd
JA
1542 return;
1543}
1544
5cae0ec6
RS
1545/* Get the value of property PROP from PLIST,
1546 which is the plist of an interval.
70743ff1 1547 We check for direct properties, for categories with property PROP,
06d92327 1548 and for PROP appearing on the default-text-properties list. */
5cae0ec6
RS
1549
1550Lisp_Object
323a7ad4
RS
1551textget (plist, prop)
1552 Lisp_Object plist;
1553 register Lisp_Object prop;
1554{
5cae0ec6
RS
1555 register Lisp_Object tail, fallback;
1556 fallback = Qnil;
323a7ad4
RS
1557
1558 for (tail = plist; !NILP (tail); tail = Fcdr (Fcdr (tail)))
1559 {
1560 register Lisp_Object tem;
1561 tem = Fcar (tail);
1562 if (EQ (prop, tem))
1563 return Fcar (Fcdr (tail));
5cae0ec6 1564 if (EQ (tem, Qcategory))
5dd6606e
RS
1565 {
1566 tem = Fcar (Fcdr (tail));
1567 if (SYMBOLP (tem))
1568 fallback = Fget (tem, prop);
1569 }
323a7ad4 1570 }
5cae0ec6 1571
70743ff1
BG
1572 if (! NILP (fallback))
1573 return fallback;
06d92327
BG
1574 if (CONSP (Vdefault_text_properties))
1575 return Fplist_get (Vdefault_text_properties, prop);
70743ff1 1576 return Qnil;
323a7ad4 1577}
7ce503fd 1578
294efdbe 1579\f
5cae0ec6 1580/* Set point in BUFFER to POSITION. If the target position is
f65013b0 1581 before an intangible character, move to an ok place. */
a50699fd
JA
1582
1583void
1584set_point (position, buffer)
1585 register int position;
1586 register struct buffer *buffer;
1587{
323a7ad4 1588 register INTERVAL to, from, toprev, fromprev, target;
a50699fd
JA
1589 int buffer_point;
1590 register Lisp_Object obj;
1591 int backwards = (position < BUF_PT (buffer)) ? 1 : 0;
e5d967c9 1592 int old_position = BUF_PT (buffer);
a50699fd 1593
b6a0ebc3
RS
1594 buffer->point_before_scroll = Qnil;
1595
e5d967c9 1596 if (position == BUF_PT (buffer))
a50699fd
JA
1597 return;
1598
62056764
JB
1599 /* Check this now, before checking if the buffer has any intervals.
1600 That way, we can catch conditions which break this sanity check
1601 whether or not there are intervals in the buffer. */
1602 if (position > BUF_Z (buffer) || position < BUF_BEG (buffer))
1603 abort ();
1604
e5d967c9 1605 if (NULL_INTERVAL_P (BUF_INTERVALS (buffer)))
a50699fd 1606 {
e5d967c9
RS
1607
1608 BUF_PT (buffer) = position;
a50699fd
JA
1609 return;
1610 }
1611
323a7ad4
RS
1612 /* Set TO to the interval containing the char after POSITION,
1613 and TOPREV to the interval containing the char before POSITION.
1614 Either one may be null. They may be equal. */
e5d967c9 1615 to = find_interval (BUF_INTERVALS (buffer), position);
294efdbe
RS
1616 if (position == BUF_BEGV (buffer))
1617 toprev = 0;
1618 else if (to->position == position)
323a7ad4 1619 toprev = previous_interval (to);
323a7ad4
RS
1620 else
1621 toprev = to;
1622
294efdbe
RS
1623 buffer_point = (BUF_PT (buffer) == BUF_ZV (buffer)
1624 ? BUF_ZV (buffer) - 1
323a7ad4 1625 : BUF_PT (buffer));
9c79dd1b 1626
323a7ad4
RS
1627 /* Set FROM to the interval containing the char after PT,
1628 and FROMPREV to the interval containing the char before PT.
1629 Either one may be null. They may be equal. */
7ce503fd 1630 /* We could cache this and save time. */
e5d967c9 1631 from = find_interval (BUF_INTERVALS (buffer), buffer_point);
7ce503fd 1632 if (buffer_point == BUF_BEGV (buffer))
294efdbe
RS
1633 fromprev = 0;
1634 else if (from->position == BUF_PT (buffer))
323a7ad4
RS
1635 fromprev = previous_interval (from);
1636 else if (buffer_point != BUF_PT (buffer))
1637 fromprev = from, from = 0;
1638 else
1639 fromprev = from;
a50699fd 1640
7ce503fd 1641 /* Moving within an interval. */
323a7ad4 1642 if (to == from && toprev == fromprev && INTERVAL_VISIBLE_P (to))
a50699fd 1643 {
e5d967c9 1644 BUF_PT (buffer) = position;
a50699fd
JA
1645 return;
1646 }
1647
5eabb4e7
RS
1648 /* If the new position is between two intangible characters
1649 with the same intangible property value,
1650 move forward or backward until a change in that property. */
d5219de5
RS
1651 if (NILP (Vinhibit_point_motion_hooks) && ! NULL_INTERVAL_P (to)
1652 && ! NULL_INTERVAL_P (toprev))
a50699fd 1653 {
d5219de5
RS
1654 if (backwards)
1655 {
5eabb4e7
RS
1656 Lisp_Object intangible_propval;
1657 intangible_propval = textget (to->plist, Qintangible);
1658
1659 /* If following char is intangible,
1660 skip back over all chars with matching intangible property. */
1661 if (! NILP (intangible_propval))
1662 while (to == toprev
1663 || ((! NULL_INTERVAL_P (toprev)
1664 && EQ (textget (toprev->plist, Qintangible),
1665 intangible_propval))))
d5219de5
RS
1666 {
1667 to = toprev;
1668 toprev = previous_interval (toprev);
1669 if (NULL_INTERVAL_P (toprev))
1670 position = BUF_BEGV (buffer);
1671 else
1672 /* This is the only line that's not
1673 dual to the following loop.
1674 That's because we want the position
1675 at the end of TOPREV. */
1676 position = to->position;
1677 }
1678 }
0df8950e 1679 else
d5219de5 1680 {
5eabb4e7
RS
1681 Lisp_Object intangible_propval;
1682 intangible_propval = textget (toprev->plist, Qintangible);
1683
1684 /* If previous char is intangible,
1685 skip fwd over all chars with matching intangible property. */
1686 if (! NILP (intangible_propval))
1687 while (to == toprev
1688 || ((! NULL_INTERVAL_P (to)
1689 && EQ (textget (to->plist, Qintangible),
1690 intangible_propval))))
d5219de5
RS
1691 {
1692 toprev = to;
1693 to = next_interval (to);
1694 if (NULL_INTERVAL_P (to))
1695 position = BUF_ZV (buffer);
1696 else
1697 position = to->position;
1698 }
1699 }
a50699fd 1700 }
323a7ad4 1701
5eabb4e7
RS
1702 /* Here TO is the interval after the stopping point
1703 and TOPREV is the interval before the stopping point.
1704 One or the other may be null. */
1705
e5d967c9 1706 BUF_PT (buffer) = position;
a50699fd 1707
d7e3e52b
JA
1708 /* We run point-left and point-entered hooks here, iff the
1709 two intervals are not equivalent. These hooks take
323a7ad4 1710 (old_point, new_point) as arguments. */
ddd931ff
RS
1711 if (NILP (Vinhibit_point_motion_hooks)
1712 && (! intervals_equal (from, to)
1713 || ! intervals_equal (fromprev, toprev)))
9c79dd1b 1714 {
323a7ad4
RS
1715 Lisp_Object leave_after, leave_before, enter_after, enter_before;
1716
1717 if (fromprev)
1718 leave_after = textget (fromprev->plist, Qpoint_left);
1719 else
1720 leave_after = Qnil;
1721 if (from)
1722 leave_before = textget (from->plist, Qpoint_left);
1723 else
1724 leave_before = Qnil;
1725
1726 if (toprev)
1727 enter_after = textget (toprev->plist, Qpoint_entered);
1728 else
1729 enter_after = Qnil;
1730 if (to)
1731 enter_before = textget (to->plist, Qpoint_entered);
1732 else
1733 enter_before = Qnil;
9c79dd1b 1734
323a7ad4
RS
1735 if (! EQ (leave_before, enter_before) && !NILP (leave_before))
1736 call2 (leave_before, old_position, position);
1737 if (! EQ (leave_after, enter_after) && !NILP (leave_after))
1738 call2 (leave_after, old_position, position);
9c79dd1b 1739
323a7ad4
RS
1740 if (! EQ (enter_before, leave_before) && !NILP (enter_before))
1741 call2 (enter_before, old_position, position);
1742 if (! EQ (enter_after, leave_after) && !NILP (enter_after))
1743 call2 (enter_after, old_position, position);
9c79dd1b 1744 }
a50699fd
JA
1745}
1746
7ce503fd 1747/* Set point temporarily, without checking any text properties. */
a50699fd 1748
9c79dd1b
JA
1749INLINE void
1750temp_set_point (position, buffer)
1751 int position;
1752 struct buffer *buffer;
1753{
e5d967c9 1754 BUF_PT (buffer) = position;
9c79dd1b 1755}
294efdbe 1756\f
5cae0ec6
RS
1757/* Return the proper local map for position POSITION in BUFFER.
1758 Use the map specified by the local-map property, if any.
1759 Otherwise, use BUFFER's local map. */
1760
1761Lisp_Object
1762get_local_map (position, buffer)
1763 register int position;
1764 register struct buffer *buffer;
1765{
0f7a5fda
KH
1766 Lisp_Object prop, tem, lispy_position, lispy_buffer;
1767 int old_begv, old_zv;
5cae0ec6 1768
7ce503fd 1769 /* Perhaps we should just change `position' to the limit. */
5cae0ec6
RS
1770 if (position > BUF_Z (buffer) || position < BUF_BEG (buffer))
1771 abort ();
1772
0f7a5fda
KH
1773 /* Ignore narrowing, so that a local map continues to be valid even if
1774 the visible region contains no characters and hence no properties. */
1775 old_begv = BUF_BEGV (buffer);
1776 old_zv = BUF_ZV (buffer);
1777 BUF_BEGV (buffer) = BUF_BEG (buffer);
1778 BUF_ZV (buffer) = BUF_Z (buffer);
1779
1780 /* There are no properties at the end of the buffer, so in that case
1781 check for a local map on the last character of the buffer instead. */
1782 if (position == BUF_Z (buffer) && BUF_Z (buffer) > BUF_BEG (buffer))
1783 --position;
1784 XSETFASTINT (lispy_position, position);
1785 XSETBUFFER (lispy_buffer, buffer);
1786 prop = Fget_char_property (lispy_position, Qlocal_map, lispy_buffer);
1787
1788 BUF_BEGV (buffer) = old_begv;
1789 BUF_ZV (buffer) = old_zv;
5cae0ec6
RS
1790
1791 /* Use the local map only if it is valid. */
4a9f44cd
RS
1792 /* Do allow symbols that are defined as keymaps. */
1793 if (SYMBOLP (prop) && !NILP (prop))
1794 prop = Findirect_function (prop);
0f7a5fda
KH
1795 if (!NILP (prop)
1796 && (tem = Fkeymapp (prop), !NILP (tem)))
5cae0ec6
RS
1797 return prop;
1798
e5d967c9 1799 return buffer->keymap;
5cae0ec6
RS
1800}
1801\f
9c79dd1b 1802/* Produce an interval tree reflecting the intervals in
7ce503fd 1803 TREE from START to START + LENGTH. */
a50699fd 1804
7b1d5b85 1805INTERVAL
a50699fd
JA
1806copy_intervals (tree, start, length)
1807 INTERVAL tree;
1808 int start, length;
1809{
1810 register INTERVAL i, new, t;
95e3e1ef 1811 register int got, prevlen;
a50699fd
JA
1812
1813 if (NULL_INTERVAL_P (tree) || length <= 0)
1814 return NULL_INTERVAL;
1815
1816 i = find_interval (tree, start);
1817 if (NULL_INTERVAL_P (i) || LENGTH (i) == 0)
1818 abort ();
1819
7ce503fd 1820 /* If there is only one interval and it's the default, return nil. */
a50699fd
JA
1821 if ((start - i->position + 1 + length) < LENGTH (i)
1822 && DEFAULT_INTERVAL_P (i))
1823 return NULL_INTERVAL;
1824
1825 new = make_interval ();
1826 new->position = 1;
1827 got = (LENGTH (i) - (start - i->position));
9c79dd1b 1828 new->total_length = length;
a50699fd
JA
1829 copy_properties (i, new);
1830
1831 t = new;
95e3e1ef 1832 prevlen = got;
a50699fd
JA
1833 while (got < length)
1834 {
1835 i = next_interval (i);
2bc7a79b 1836 t = split_interval_right (t, prevlen);
a50699fd 1837 copy_properties (i, t);
95e3e1ef
RS
1838 prevlen = LENGTH (i);
1839 got += prevlen;
a50699fd
JA
1840 }
1841
4314dea4 1842 return balance_an_interval (new);
a50699fd
JA
1843}
1844
7ce503fd 1845/* Give STRING the properties of BUFFER from POSITION to LENGTH. */
a50699fd 1846
d7e3e52b 1847INLINE void
a50699fd 1848copy_intervals_to_string (string, buffer, position, length)
46d8a55b
RS
1849 Lisp_Object string;
1850 struct buffer *buffer;
a50699fd
JA
1851 int position, length;
1852{
46d8a55b 1853 INTERVAL interval_copy = copy_intervals (BUF_INTERVALS (buffer),
a50699fd
JA
1854 position, length);
1855 if (NULL_INTERVAL_P (interval_copy))
1856 return;
1857
1858 interval_copy->parent = (INTERVAL) string;
1859 XSTRING (string)->intervals = interval_copy;
1860}
d8638d30
RS
1861\f
1862/* Return 1 if string S1 and S2 have identical properties; 0 otherwise.
1863 Assume they have identical characters. */
1864
1865int
1866compare_string_intervals (s1, s2)
1867 Lisp_Object s1, s2;
1868{
1869 INTERVAL i1, i2;
1870 int pos = 1;
1871 int end = XSTRING (s1)->size + 1;
1872
1873 /* We specify 1 as position because the interval functions
1874 always use positions starting at 1. */
1875 i1 = find_interval (XSTRING (s1)->intervals, 1);
1876 i2 = find_interval (XSTRING (s2)->intervals, 1);
1877
1878 while (pos < end)
1879 {
1880 /* Determine how far we can go before we reach the end of I1 or I2. */
1881 int len1 = (i1 != 0 ? INTERVAL_LAST_POS (i1) : end) - pos;
1882 int len2 = (i2 != 0 ? INTERVAL_LAST_POS (i2) : end) - pos;
1883 int distance = min (len1, len2);
1884
1885 /* If we ever find a mismatch between the strings,
1886 they differ. */
1887 if (! intervals_equal (i1, i2))
1888 return 0;
1889
1890 /* Advance POS till the end of the shorter interval,
1891 and advance one or both interval pointers for the new position. */
1892 pos += distance;
1893 if (len1 == distance)
1894 i1 = next_interval (i1);
1895 if (len2 == distance)
1896 i2 = next_interval (i2);
1897 }
1898 return 1;
1899}
d2f7a802
JA
1900
1901#endif /* USE_TEXT_PROPERTIES */