intervals.c 72.3 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
2
   Copyright (C) 1993, 1994, 1995, 1997, 1998, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
3
                 2005, 2006, 2007, 2008, 2009, 2010  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
4 5 6

This file is part of GNU Emacs.

7
GNU Emacs is free software: you can redistribute it and/or modify
Joseph Arceneaux's avatar
Joseph Arceneaux committed
8
it under the terms of the GNU General Public License as published by
9 10
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
11 12 13 14 15 16 17

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40


/* NOTES:

   Have to ensure that we can't put symbol nil on a plist, or some
   functions may work incorrectly.

   An idea:  Have the owner of the tree keep count of splits and/or
   insertion lengths (in intervals), and balance after every N.

   Need to call *_left_hook when buffer is killed.

   Scan for zero-length, or 0-length to see notes about handling
   zero length interval-markers.

   There are comments around about freeing intervals.  It might be
   faster to explicitly free them (put them on the free list) than
   to GC them.

*/


41
#include <config.h>
42
#include <setjmp.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
43 44 45
#include "lisp.h"
#include "intervals.h"
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
46
#include "puresize.h"
Karl Heuer's avatar
Karl Heuer committed
47
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
48
#include "keymap.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
49

50 51 52 53 54
/* Test for membership, allowing for t (actually any non-cons) to mean the
   universal set.  */

#define TMEM(sym, set) (CONSP (set) ? ! NILP (Fmemq (sym, set)) : ! NILP (set))

55
Lisp_Object merge_properties_sticky ();
56 57
static INTERVAL reproduce_tree P_ ((INTERVAL, INTERVAL));
static INTERVAL reproduce_tree_obj P_ ((INTERVAL, Lisp_Object));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
58

59
/* Utility functions for intervals.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
60 61


62
/* Create the root interval of some object, a buffer or string.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
63 64 65 66 67

INTERVAL
create_root_interval (parent)
     Lisp_Object parent;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
68 69 70 71 72
  INTERVAL new;

  CHECK_IMPURE (parent);

  new = make_interval ();
Joseph Arceneaux's avatar
Joseph Arceneaux committed
73

74
  if (BUFFERP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
75
    {
76 77
      new->total_length = (BUF_Z (XBUFFER (parent))
			   - BUF_BEG (XBUFFER (parent)));
78
      CHECK_TOTAL_LENGTH (new);
79
      BUF_INTERVALS (XBUFFER (parent)) = new;
80
      new->position = BEG;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
81
    }
82
  else if (STRINGP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
83
    {
84
      new->total_length = SCHARS (parent);
85
      CHECK_TOTAL_LENGTH (new);
86
      STRING_SET_INTERVALS (parent, new);
87
      new->position = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
88 89
    }

90
  SET_INTERVAL_OBJECT (new, parent);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108

  return new;
}

/* Make the interval TARGET have exactly the properties of SOURCE */

void
copy_properties (source, target)
     register INTERVAL source, target;
{
  if (DEFAULT_INTERVAL_P (source) && DEFAULT_INTERVAL_P (target))
    return;

  COPY_INTERVAL_CACHE (source, target);
  target->plist = Fcopy_sequence (source->plist);
}

/* Merge the properties of interval SOURCE into the properties
109 110
   of interval TARGET.  That is to say, each property in SOURCE
   is added to TARGET if TARGET has no such property as yet.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112 113 114 115 116 117 118 119 120 121 122 123

static void
merge_properties (source, target)
     register INTERVAL source, target;
{
  register Lisp_Object o, sym, val;

  if (DEFAULT_INTERVAL_P (source) && DEFAULT_INTERVAL_P (target))
    return;

  MERGE_INTERVAL_CACHE (source, target);

  o = source->plist;
124
  while (CONSP (o))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
125
    {
126
      sym = XCAR (o);
127 128 129 130 131 132 133 134 135 136 137
      o = XCDR (o);
      CHECK_CONS (o);

      val = target->plist;
      while (CONSP (val) && !EQ (XCAR (val), sym))
	{
	  val = XCDR (val);
	  if (!CONSP (val))
	    break;
	  val = XCDR (val);
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
138 139 140

      if (NILP (val))
	{
141
	  val = XCAR (o);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
142 143
	  target->plist = Fcons (sym, Fcons (val, target->plist));
	}
144
      o = XCDR (o);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
145 146 147 148
    }
}

/* Return 1 if the two intervals have the same properties,
149
   0 otherwise.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
150 151 152 153 154

int
intervals_equal (i0, i1)
     INTERVAL i0, i1;
{
155 156
  register Lisp_Object i0_cdr, i0_sym;
  register Lisp_Object i1_cdr, i1_val;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
157 158 159 160

  if (DEFAULT_INTERVAL_P (i0) && DEFAULT_INTERVAL_P (i1))
    return 1;

161 162 163
  if (DEFAULT_INTERVAL_P (i0) || DEFAULT_INTERVAL_P (i1))
    return 0;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
164
  i0_cdr = i0->plist;
165 166
  i1_cdr = i1->plist;
  while (CONSP (i0_cdr) && CONSP (i1_cdr))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
167
    {
168
      i0_sym = XCAR (i0_cdr);
169 170 171 172 173 174 175 176 177 178 179
      i0_cdr = XCDR (i0_cdr);
      if (!CONSP (i0_cdr))
	return 0;		/* abort (); */
      i1_val = i1->plist;
      while (CONSP (i1_val) && !EQ (XCAR (i1_val), i0_sym))
	{
	  i1_val = XCDR (i1_val);
	  if (!CONSP (i1_val))
	    return 0;		/* abort (); */
	  i1_val = XCDR (i1_val);
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
180

181
      /* i0 has something i1 doesn't.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
182 183 184
      if (EQ (i1_val, Qnil))
	return 0;

185
      /* i0 and i1 both have sym, but it has different values in each.  */
186 187 188
      if (!CONSP (i1_val)
	  || (i1_val = XCDR (i1_val), !CONSP (i1_val))
	  || !EQ (XCAR (i1_val), XCAR (i0_cdr)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
189 190
	return 0;

191
      i0_cdr = XCDR (i0_cdr);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
192

193 194 195 196 197
      i1_cdr = XCDR (i1_cdr);
      if (!CONSP (i1_cdr))
	return 0;		/* abort (); */
      i1_cdr = XCDR (i1_cdr);
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
198

199 200
  /* Lengths of the two plists were equal.  */
  return (NILP (i0_cdr) && NILP (i1_cdr));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
201 202 203
}


204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227
/* Traverse an interval tree TREE, performing FUNCTION on each node.
   No guarantee is made about the order of traversal.
   Pass FUNCTION two args: an interval, and ARG.  */

void
traverse_intervals_noorder (tree, function, arg)
     INTERVAL tree;
     void (* function) P_ ((INTERVAL, Lisp_Object));
     Lisp_Object arg;
{
  /* Minimize stack usage.  */
  while (!NULL_INTERVAL_P (tree))
    {
      (*function) (tree, arg);
      if (NULL_INTERVAL_P (tree->right))
	tree = tree->left;
      else
	{
	  traverse_intervals_noorder (tree->left, function, arg);
	  tree = tree->right;
	}
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
228
/* Traverse an interval tree TREE, performing FUNCTION on each node.
229
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
230 231

void
232
traverse_intervals (tree, position, function, arg)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
233
     INTERVAL tree;
234
     int position;
235
     void (* function) P_ ((INTERVAL, Lisp_Object));
236
     Lisp_Object arg;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
237
{
238 239
  while (!NULL_INTERVAL_P (tree))
    {
240
      traverse_intervals (tree->left, position, function, arg);
241 242 243
      position += LEFT_TOTAL_LENGTH (tree);
      tree->position = position;
      (*function) (tree, arg);
244
      position += LENGTH (tree); tree = tree->right;
245
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
246 247 248
}

#if 0
249 250 251 252 253

static int icount;
static int idepth;
static int zero_length;

254
/* These functions are temporary, for debugging purposes only.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

INTERVAL search_interval, found_interval;

void
check_for_interval (i)
     register INTERVAL i;
{
  if (i == search_interval)
    {
      found_interval = i;
      icount++;
    }
}

INTERVAL
search_for_interval (i, tree)
     register INTERVAL i, tree;
{
  icount = 0;
  search_interval = i;
  found_interval = NULL_INTERVAL;
276
  traverse_intervals_noorder (tree, &check_for_interval, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  return found_interval;
}

static void
inc_interval_count (i)
     INTERVAL i;
{
  icount++;
  if (LENGTH (i) == 0)
    zero_length++;
  if (depth > idepth)
    idepth = depth;
}

int
count_intervals (i)
     register INTERVAL i;
{
  icount = 0;
  idepth = 0;
  zero_length = 0;
298
  traverse_intervals_noorder (i, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
299 300 301 302 303 304 305 306 307 308 309

  return icount;
}

static INTERVAL
root_interval (interval)
     INTERVAL interval;
{
  register INTERVAL i = interval;

  while (! ROOT_INTERVAL_P (i))
310
    i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324

  return i;
}
#endif

/* Assuming that a left child exists, perform the following operation:

     A		  B
    / \		 / \
   B       =>       A
  / \		   / \
     c		  c
*/

325
static INLINE INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
326 327 328 329 330
rotate_right (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->left;
331
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
332

333
  /* Deal with any Parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
334
  if (! ROOT_INTERVAL_P (interval))
335 336
    {
      if (AM_LEFT_CHILD (interval))
337
	INTERVAL_PARENT (interval)->left = B;
338
      else
339
	INTERVAL_PARENT (interval)->right = B;
340
    }
341
  COPY_INTERVAL_PARENT (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
342

343 344 345
  /* Make B the parent of A */
  i = B->right;
  B->right = interval;
346
  SET_INTERVAL_PARENT (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
347

348
  /* Make A point to c */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
349 350
  interval->left = i;
  if (! NULL_INTERVAL_P (i))
351
    SET_INTERVAL_PARENT (i, interval);
352

353
  /* A's total length is decreased by the length of B and its left child.  */
354
  interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);
355
  CHECK_TOTAL_LENGTH (interval);
356 357 358

  /* B must have the same total length of A.  */
  B->total_length = old_total;
359
  CHECK_TOTAL_LENGTH (B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
360 361 362

  return B;
}
363

Joseph Arceneaux's avatar
Joseph Arceneaux committed
364 365
/* Assuming that a right child exists, perform the following operation:

Juanma Barranquero's avatar
Juanma Barranquero committed
366 367
    A               B
   / \	           / \
Joseph Arceneaux's avatar
Joseph Arceneaux committed
368
      B	   =>     A
Juanma Barranquero's avatar
Juanma Barranquero committed
369
     / \         / \
Joseph Arceneaux's avatar
Joseph Arceneaux committed
370 371 372
    c               c
*/

373
static INLINE INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
374 375 376 377 378
rotate_left (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->right;
379
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
380

381
  /* Deal with any parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
382
  if (! ROOT_INTERVAL_P (interval))
383 384
    {
      if (AM_LEFT_CHILD (interval))
385
	INTERVAL_PARENT (interval)->left = B;
386
      else
387
	INTERVAL_PARENT (interval)->right = B;
388
    }
389
  COPY_INTERVAL_PARENT (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
390 391

  /* Make B the parent of A */
392 393
  i = B->left;
  B->left = interval;
394
  SET_INTERVAL_PARENT (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
395 396 397 398

  /* Make A point to c */
  interval->right = i;
  if (! NULL_INTERVAL_P (i))
399
    SET_INTERVAL_PARENT (i, interval);
400

401
  /* A's total length is decreased by the length of B and its right child.  */
402
  interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);
403
  CHECK_TOTAL_LENGTH (interval);
404 405 406

  /* B must have the same total length of A.  */
  B->total_length = old_total;
407
  CHECK_TOTAL_LENGTH (B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
408 409 410 411

  return B;
}

412 413 414 415 416 417 418 419 420 421 422 423 424 425
/* Balance an interval tree with the assumption that the subtrees
   themselves are already balanced.  */

static INTERVAL
balance_an_interval (i)
     INTERVAL i;
{
  register int old_diff, new_diff;

  while (1)
    {
      old_diff = LEFT_TOTAL_LENGTH (i) - RIGHT_TOTAL_LENGTH (i);
      if (old_diff > 0)
	{
426
	  /* Since the left child is longer, there must be one.  */
427 428
	  new_diff = i->total_length - i->left->total_length
	    + RIGHT_TOTAL_LENGTH (i->left) - LEFT_TOTAL_LENGTH (i->left);
Eli Zaretskii's avatar
Eli Zaretskii committed
429
	  if (eabs (new_diff) >= old_diff)
430 431 432 433 434 435
	    break;
	  i = rotate_right (i);
	  balance_an_interval (i->right);
	}
      else if (old_diff < 0)
	{
436
	  /* Since the right child is longer, there must be one.  */
437 438
	  new_diff = i->total_length - i->right->total_length
	    + LEFT_TOTAL_LENGTH (i->right) - RIGHT_TOTAL_LENGTH (i->right);
Eli Zaretskii's avatar
Eli Zaretskii committed
439
	  if (eabs (new_diff) >= -old_diff)
440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457
	    break;
	  i = rotate_left (i);
	  balance_an_interval (i->left);
	}
      else
	break;
    }
  return i;
}

/* Balance INTERVAL, potentially stuffing it back into its parent
   Lisp Object.  */

static INLINE INTERVAL
balance_possible_root_interval (interval)
     register INTERVAL interval;
{
  Lisp_Object parent;
458
  int have_parent = 0;
459

460
  if (!INTERVAL_HAS_OBJECT (interval) && !INTERVAL_HAS_PARENT (interval))
461 462
    return interval;

463 464 465 466 467
  if (INTERVAL_HAS_OBJECT (interval))
    {
      have_parent = 1;
      GET_INTERVAL_OBJECT (parent, interval);
    }
468 469
  interval = balance_an_interval (interval);

470 471 472 473 474
  if (have_parent)
    {
      if (BUFFERP (parent))
	BUF_INTERVALS (XBUFFER (parent)) = interval;
      else if (STRINGP (parent))
475
	STRING_SET_INTERVALS (parent, interval);
476
    }
477 478 479 480 481 482 483 484 485 486 487 488 489

  return interval;
}

/* Balance the interval tree TREE.  Balancing is by weight
   (the amount of text).  */

static INTERVAL
balance_intervals_internal (tree)
     register INTERVAL tree;
{
  /* Balance within each side.  */
  if (tree->left)
490
    balance_intervals_internal (tree->left);
491
  if (tree->right)
492
    balance_intervals_internal (tree->right);
493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
  return balance_an_interval (tree);
}

/* Advertised interface to balance intervals.  */

INTERVAL
balance_intervals (tree)
     INTERVAL tree;
{
  if (tree == NULL_INTERVAL)
    return NULL_INTERVAL;

  return balance_intervals_internal (tree);
}

508 509 510 511
/* Split INTERVAL into two pieces, starting the second piece at
   character position OFFSET (counting from 0), relative to INTERVAL.
   INTERVAL becomes the left-hand piece, and the right-hand piece
   (second, lexicographically) is returned.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
512 513 514 515 516

   The size and position fields of the two intervals are set based upon
   those of the original interval.  The property list of the new interval
   is reset, thus it is up to the caller to do the right thing with the
   result.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
517 518

   Note that this does not change the position of INTERVAL;  if it is a root,
519
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
520 521

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
522
split_interval_right (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
523
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
524
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
525 526 527
{
  INTERVAL new = make_interval ();
  int position = interval->position;
528
  int new_length = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
529

530
  new->position = position + offset;
531
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
532

533
  if (NULL_RIGHT_CHILD (interval))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
534 535 536
    {
      interval->right = new;
      new->total_length = new_length;
537
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
538
    }
539 540 541 542
  else
    {
      /* Insert the new node between INTERVAL and its right child.  */
      new->right = interval->right;
543
      SET_INTERVAL_PARENT (interval->right, new);
544 545
      interval->right = new;
      new->total_length = new_length + new->right->total_length;
546
      CHECK_TOTAL_LENGTH (new);
547 548
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
549

550 551
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
552 553 554
  return new;
}

555 556 557 558
/* Split INTERVAL into two pieces, starting the second piece at
   character position OFFSET (counting from 0), relative to INTERVAL.
   INTERVAL becomes the right-hand piece, and the left-hand piece
   (first, lexicographically) is returned.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
559

Joseph Arceneaux's avatar
Joseph Arceneaux committed
560 561 562 563 564 565
   The size and position fields of the two intervals are set based upon
   those of the original interval.  The property list of the new interval
   is reset, thus it is up to the caller to do the right thing with the
   result.

   Note that this does not change the position of INTERVAL;  if it is a root,
566
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
567 568

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
569
split_interval_left (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
570
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
571
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
572 573
{
  INTERVAL new = make_interval ();
574
  int new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
575 576

  new->position = interval->position;
577
  interval->position = interval->position + offset;
578
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
579 580 581 582 583

  if (NULL_LEFT_CHILD (interval))
    {
      interval->left = new;
      new->total_length = new_length;
584
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
585
    }
586 587 588 589
  else
    {
      /* Insert the new node between INTERVAL and its left child.  */
      new->left = interval->left;
590
      SET_INTERVAL_PARENT (new->left, new);
591 592
      interval->left = new;
      new->total_length = new_length + new->left->total_length;
593
      CHECK_TOTAL_LENGTH (new);
594 595
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
596

597
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
598 599 600 601

  return new;
}

602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618
/* Return the proper position for the first character
   described by the interval tree SOURCE.
   This is 1 if the parent is a buffer,
   0 if the parent is a string or if there is no parent.

   Don't use this function on an interval which is the child
   of another interval!  */

int
interval_start_pos (source)
     INTERVAL source;
{
  Lisp_Object parent;

  if (NULL_INTERVAL_P (source))
    return 0;

619 620
  if (! INTERVAL_HAS_OBJECT (source))
    return 0;
621
  GET_INTERVAL_OBJECT (parent, source);
622 623 624 625 626
  if (BUFFERP (parent))
    return BUF_BEG (XBUFFER (parent));
  return 0;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
627
/* Find the interval containing text position POSITION in the text
628
   represented by the interval tree TREE.  POSITION is a buffer
629 630 631
   position (starting from 1) or a string index (starting from 0).
   If POSITION is at the end of the buffer or string,
   return the interval containing the last character.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
632

Joseph Arceneaux's avatar
Joseph Arceneaux committed
633 634
   The `position' field, which is a cache of an interval's position,
   is updated in the interval found.  Other functions (e.g., next_interval)
635
   will update this cache based on the result of find_interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
636

637
INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
638 639 640 641
find_interval (tree, position)
     register INTERVAL tree;
     register int position;
{
642 643
  /* The distance from the left edge of the subtree at TREE
                    to POSITION.  */
644
  register int relative_position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
645 646 647 648

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

649
  relative_position = position;
650 651 652 653 654 655 656
  if (INTERVAL_HAS_OBJECT (tree))
    {
      Lisp_Object parent;
      GET_INTERVAL_OBJECT (parent, tree);
      if (BUFFERP (parent))
	relative_position -= BUF_BEG (XBUFFER (parent));
    }
657

658
  if (relative_position > TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
659 660
    abort ();			/* Paranoia */

661 662
  if (!handling_signal)
    tree = balance_possible_root_interval (tree);
663

Joseph Arceneaux's avatar
Joseph Arceneaux committed
664 665
  while (1)
    {
666
      if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
667 668 669
	{
	  tree = tree->left;
	}
670 671 672
      else if (! NULL_RIGHT_CHILD (tree)
	       && relative_position >= (TOTAL_LENGTH (tree)
					- RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
673 674 675 676 677 678 679
	{
	  relative_position -= (TOTAL_LENGTH (tree)
				- RIGHT_TOTAL_LENGTH (tree));
	  tree = tree->right;
	}
      else
	{
680
	  tree->position
681 682
	    = (position - relative_position /* left edge of *tree.  */
	       + LEFT_TOTAL_LENGTH (tree)); /* left edge of this interval.  */
683

Joseph Arceneaux's avatar
Joseph Arceneaux committed
684 685 686 687 688 689
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
690
   Sets the `position' field based on that of INTERVAL (see
691
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717

INTERVAL
next_interval (interval)
     register INTERVAL interval;
{
  register INTERVAL i = interval;
  register int next_position;

  if (NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
  next_position = interval->position + LENGTH (interval);

  if (! NULL_RIGHT_CHILD (i))
    {
      i = i->right;
      while (! NULL_LEFT_CHILD (i))
	i = i->left;

      i->position = next_position;
      return i;
    }

  while (! NULL_PARENT (i))
    {
      if (AM_LEFT_CHILD (i))
	{
718
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
719 720 721 722
	  i->position = next_position;
	  return i;
	}

723
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
724 725 726 727 728 729
    }

  return NULL_INTERVAL;
}

/* Find the preceding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
730
   Sets the `position' field based on that of INTERVAL (see
731
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756

INTERVAL
previous_interval (interval)
     register INTERVAL interval;
{
  register INTERVAL i;

  if (NULL_INTERVAL_P (interval))
    return NULL_INTERVAL;

  if (! NULL_LEFT_CHILD (interval))
    {
      i = interval->left;
      while (! NULL_RIGHT_CHILD (i))
	i = i->right;

      i->position = interval->position - LENGTH (i);
      return i;
    }

  i = interval;
  while (! NULL_PARENT (i))
    {
      if (AM_RIGHT_CHILD (i))
	{
757
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
758 759 760 761

	  i->position = interval->position - LENGTH (i);
	  return i;
	}
762
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
763 764 765 766
    }

  return NULL_INTERVAL;
}
767 768

/* Find the interval containing POS given some non-NULL INTERVAL
769
   in the same tree.  Note that we need to update interval->position
770 771 772
   if we go down the tree.
   To speed up the process, we assume that the ->position of
   I and all its parents is already uptodate.  */
773 774 775 776 777 778 779 780
INTERVAL
update_interval (i, pos)
     register INTERVAL i;
     int pos;
{
  if (NULL_INTERVAL_P (i))
    return NULL_INTERVAL;

Juanma Barranquero's avatar
Juanma Barranquero committed
781
  while (1)
782
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
783
      if (pos < i->position)
784 785
	{
	  /* Move left. */
Juanma Barranquero's avatar
Juanma Barranquero committed
786
	  if (pos >= i->position - TOTAL_LENGTH (i->left))
787 788 789 790 791
	    {
	      i->left->position = i->position - TOTAL_LENGTH (i->left)
		+ LEFT_TOTAL_LENGTH (i->left);
	      i = i->left;		/* Move to the left child */
	    }
Juanma Barranquero's avatar
Juanma Barranquero committed
792
	  else if (NULL_PARENT (i))
793
	    error ("Point before start of properties");
Juanma Barranquero's avatar
Juanma Barranquero committed
794
	  else
795
	      i = INTERVAL_PARENT (i);
796 797 798 799 800
	  continue;
	}
      else if (pos >= INTERVAL_LAST_POS (i))
	{
	  /* Move right. */
Juanma Barranquero's avatar
Juanma Barranquero committed
801
	  if (pos < INTERVAL_LAST_POS (i) + TOTAL_LENGTH (i->right))
802
	    {
803 804
	      i->right->position = INTERVAL_LAST_POS (i)
	        + LEFT_TOTAL_LENGTH (i->right);
805 806
	      i = i->right;		/* Move to the right child */
	    }
Juanma Barranquero's avatar
Juanma Barranquero committed
807
	  else if (NULL_PARENT (i))
808
	    error ("Point %d after end of properties", pos);
Juanma Barranquero's avatar
Juanma Barranquero committed
809
	  else
810
            i = INTERVAL_PARENT (i);
811 812
	  continue;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
813
      else
814 815 816 817
	return i;
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
818

Joseph Arceneaux's avatar
Joseph Arceneaux committed
819
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
820 821 822 823 824 825 826 827 828
/* Traverse a path down the interval tree TREE to the interval
   containing POSITION, adjusting all nodes on the path for
   an addition of LENGTH characters.  Insertion between two intervals
   (i.e., point == i->position, where i is second interval) means
   text goes into second interval.

   Modifications are needed to handle the hungry bits -- after simply
   finding the interval at position (don't add length going down),
   if it's the beginning of the interval, get the previous interval
Karl Heuer's avatar
Karl Heuer committed
829
   and check the hungry bits of both.  Then add the length going back up
830
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
     int position, length;
{
  register int relative_position;
  register INTERVAL this;

  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

  /* If inserting at point-max of a buffer, that position
     will be out of range */
  if (position > TOTAL_LENGTH (tree))
    position = TOTAL_LENGTH (tree);
  relative_position = position;
  this = tree;

  while (1)
    {
      if (relative_position <= LEFT_TOTAL_LENGTH (this))
	{
	  this->total_length += length;
855
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
856 857 858 859 860 861 862 863
	  this = this->left;
	}
      else if (relative_position > (TOTAL_LENGTH (this)
				    - RIGHT_TOTAL_LENGTH (this)))
	{
	  relative_position -= (TOTAL_LENGTH (this)
				- RIGHT_TOTAL_LENGTH (this));
	  this->total_length += length;
864
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
865 866 867 868 869
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
870
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
871
	  this->total_length += length;
872
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
873 874 875 876 877 878
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879 880 881 882
#endif

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
883
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
884 885 886 887 888 889
   LENGTH to them.

   If POSITION is the first character of an interval, meaning that point
   is actually between the two intervals, make the new text belong to
   the interval which is "sticky".

Joseph Arceneaux's avatar
Joseph Arceneaux committed
890
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
891
   interval.  Another possibility would be to create a new interval for
892
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
893 894 895 896 897 898 899

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
     int position, length;
{
  register INTERVAL i;
900 901
  register INTERVAL temp;
  int eobp = 0;
902 903
  Lisp_Object parent;
  int offset;
Juanma Barranquero's avatar
Juanma Barranquero committed
904

Joseph Arceneaux's avatar
Joseph Arceneaux committed
905 906 907
  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

908
  GET_INTERVAL_OBJECT (parent, tree);
909 910
  offset = (BUFFERP (parent) ? BUF_BEG (XBUFFER (parent)) : 0);

911 912
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
913 914 915 916 917
  if (position >= TOTAL_LENGTH (tree) + offset)
    {
      position = TOTAL_LENGTH (tree) + offset;
      eobp = 1;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
918 919

  i = find_interval (tree, position);
920

921 922
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
923 924 925 926 927 928 929 930 931 932
     So split this interval at the insertion point.

     Originally, the if condition here was this:
	(! (position == i->position || eobp)
	 && END_NONSTICKY_P (i)
	 && FRONT_NONSTICKY_P (i))
     But, these macros are now unreliable because of introduction of
     Vtext_property_default_nonsticky.  So, we always check properties
     one by one if POSITION is in middle of an interval.  */
  if (! (position == i->position || eobp))
933
    {
934 935 936
      Lisp_Object tail;
      Lisp_Object front, rear;

937 938 939 940 941 942 943 944 945 946 947
      tail = i->plist;

      /* Properties font-sticky and rear-nonsticky override
         Vtext_property_default_nonsticky.  So, if they are t, we can
         skip one by one checking of properties.  */
      rear = textget (i->plist, Qrear_nonsticky);
      if (! CONSP (rear) && ! NILP (rear))
	{
	  /* All properties are nonsticky.  We split the interval.  */
	  goto check_done;
	}
948
      front = textget (i->plist, Qfront_sticky);
949 950 951 952 953 954
      if (! CONSP (front) && ! NILP (front))
	{
	  /* All properties are sticky.  We don't split the interval.  */
	  tail = Qnil;
	  goto check_done;
	}
955

956 957 958
      /* Does any actual property pose an actual problem?  We break
         the loop if we find a nonsticky property.  */
      for (; CONSP (tail); tail = Fcdr (XCDR (tail)))
959
	{
960
	  Lisp_Object prop, tmp;
961
	  prop = XCAR (tail);
962

963
	  /* Is this particular property front-sticky?  */
964 965 966
	  if (CONSP (front) && ! NILP (Fmemq (prop, front)))
	    continue;

967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982
	  /* Is this particular property rear-nonsticky?  */
	  if (CONSP (rear) && ! NILP (Fmemq (prop, rear)))
	    break;

	  /* Is this particular property recorded as sticky or
             nonsticky in Vtext_property_default_nonsticky?  */
	  tmp = Fassq (prop, Vtext_property_default_nonsticky);
	  if (CONSP (tmp))
	    {
	      if (NILP (tmp))
		continue;
	      break;
	    }

	  /* By default, a text property is rear-sticky, thus we
	     continue the loop.  */
983 984
	}

985
    check_done:
986 987 988 989 990 991 992
      /* If any property is a real problem, split the interval.  */
      if (! NILP (tail))
	{
	  temp = split_interval_right (i, position - i->position);
	  copy_properties (i, temp);
	  i = temp;
	}
993 994
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
995
  /* If we are positioned between intervals, check the stickiness of
996 997
     both of them.  We have to do this too, if we are at BEG or Z.  */
  if (position == i->position || eobp)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
998
    {
999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009
      register INTERVAL prev;

      if (position == BEG)
	prev = 0;
      else if (eobp)
	{
	  prev = i;
	  i = 0;
	}
      else
	prev = previous_interval (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1010

1011 1012
      /* Even if we are positioned between intervals, we default
	 to the left one if it exists.  We extend it now and split
Karl Heuer's avatar
Karl Heuer committed
1013
	 off a part later, if stickiness demands it.  */
1014
      for (temp = prev ? prev : i; temp; temp = INTERVAL_PARENT_OR_NULL (temp))
1015 1016
	{
	  temp->total_length += length;
1017
	  CHECK_TOTAL_LENGTH (temp);
1018 1019
	  temp = balance_possible_root_interval (temp);
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
1020

1021
      /* If at least one interval has sticky properties,
1022 1023 1024 1025 1026 1027 1028 1029 1030 1031
	 we check the stickiness property by property.

	 Originally, the if condition here was this:
		(END_NONSTICKY_P (prev) || FRONT_STICKY_P (i))
	 But, these macros are now unreliable because of introduction
	 of Vtext_property_default_nonsticky.  So, we always have to
	 check stickiness of properties one by one.  If cache of
	 stickiness is implemented in the future, we may be able to
	 use those macros again.  */
      if (1)
1032
	{
1033
	  Lisp_Object pleft, pright;
1034 1035
	  struct interval newi;

1036 1037
	  pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
	  pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;