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

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
19 20
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42


/* 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.

*/


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

51 52 53 54 55
/* 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))

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


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

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

  CHECK_IMPURE (parent);

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

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

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

  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
110 111
   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
112 113 114 115 116 117 118 119 120 121 122 123 124

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;
125
  while (CONSP (o))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
126
    {
127
      sym = XCAR (o);
128 129 130 131 132 133 134 135 136 137 138
      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
139 140 141

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

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
165
  i0_cdr = i0->plist;
166 167
  i1_cdr = i1->plist;
  while (CONSP (i0_cdr) && CONSP (i1_cdr))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
168
    {
169
      i0_sym = XCAR (i0_cdr);
170 171 172 173 174 175 176 177 178 179 180
      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
181

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

186
      /* i0 and i1 both have sym, but it has different values in each.  */
187 188 189
      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
190 191
	return 0;

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

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

200 201
  /* Lengths of the two plists were equal.  */
  return (NILP (i0_cdr) && NILP (i1_cdr));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 228
/* 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
229
/* Traverse an interval tree TREE, performing FUNCTION on each node.
230
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
231 232

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

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

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

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;
277
  traverse_intervals_noorder (tree, &check_for_interval, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298
  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;
299
  traverse_intervals_noorder (i, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
300 301 302 303 304 305 306 307 308 309 310

  return icount;
}

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

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

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

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

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

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

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

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

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

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

  return B;
}
364

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

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

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

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

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

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

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

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

  return B;
}

413 414 415 416 417 418 419 420 421 422 423 424 425 426
/* 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)
	{
427
	  /* Since the left child is longer, there must be one.  */
428 429 430 431 432 433 434 435 436
	  new_diff = i->total_length - i->left->total_length
	    + RIGHT_TOTAL_LENGTH (i->left) - LEFT_TOTAL_LENGTH (i->left);
	  if (abs (new_diff) >= old_diff)
	    break;
	  i = rotate_right (i);
	  balance_an_interval (i->right);
	}
      else if (old_diff < 0)
	{
437
	  /* Since the right child is longer, there must be one.  */
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458
	  new_diff = i->total_length - i->right->total_length
	    + LEFT_TOTAL_LENGTH (i->right) - RIGHT_TOTAL_LENGTH (i->right);
	  if (abs (new_diff) >= -old_diff)
	    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;
459
  int have_parent = 0;
460

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

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

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

  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)
491
    balance_intervals_internal (tree->left);
492
  if (tree->right)
493
    balance_intervals_internal (tree->right);
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508
  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);
}

509 510 511 512
/* 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
513 514 515 516 517

   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
518 519

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

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

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

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

551 552
  balance_possible_root_interval (interval);

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

556 557 558 559
/* 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
560

Joseph Arceneaux's avatar
Joseph Arceneaux committed
561 562 563 564 565 566
   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,
567
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
568 569

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

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

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

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

  return new;
}

603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
/* 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;

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
628
/* Find the interval containing text position POSITION in the text
629
   represented by the interval tree TREE.  POSITION is a buffer
630 631 632
   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
633

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

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

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
685 686 687 688 689 690
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
691
   Sets the `position' field based on that of INTERVAL (see
692
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
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 718

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))
	{
719
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
720 721 722 723
	  i->position = next_position;
	  return i;
	}

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

  return NULL_INTERVAL;
}

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

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))
	{
758
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
759 760 761 762

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

  return NULL_INTERVAL;
}
768 769

/* Find the interval containing POS given some non-NULL INTERVAL
770
   in the same tree.  Note that we need to update interval->position
771 772 773
   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.  */
774 775 776 777 778 779 780 781
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
782
  while (1)
783
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
784
      if (pos < i->position)
785 786
	{
	  /* Move left. */
Juanma Barranquero's avatar
Juanma Barranquero committed
787
	  if (pos >= i->position - TOTAL_LENGTH (i->left))
788 789 790 791 792
	    {
	      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
793
	  else if (NULL_PARENT (i))
794
	    error ("Point before start of properties");
Juanma Barranquero's avatar
Juanma Barranquero committed
795
	  else
796
	      i = INTERVAL_PARENT (i);
797 798 799 800 801
	  continue;
	}
      else if (pos >= INTERVAL_LAST_POS (i))
	{
	  /* Move right. */
Juanma Barranquero's avatar
Juanma Barranquero committed
802
	  if (pos < INTERVAL_LAST_POS (i) + TOTAL_LENGTH (i->right))
803
	    {
804 805
	      i->right->position = INTERVAL_LAST_POS (i)
	        + LEFT_TOTAL_LENGTH (i->right);
806 807
	      i = i->right;		/* Move to the right child */
	    }
Juanma Barranquero's avatar
Juanma Barranquero committed
808
	  else if (NULL_PARENT (i))
809
	    error ("Point %d after end of properties", pos);
Juanma Barranquero's avatar
Juanma Barranquero committed
810
	  else
811
            i = INTERVAL_PARENT (i);
812 813
	  continue;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
814
      else
815 816 817 818
	return i;
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
819

Joseph Arceneaux's avatar
Joseph Arceneaux committed
820
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
821 822 823 824 825 826 827 828 829
/* 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
830
   and check the hungry bits of both.  Then add the length going back up
831
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855

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

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
884
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
885 886 887 888 889 890
   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
891
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
892
   interval.  Another possibility would be to create a new interval for
893
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
894 895 896 897 898 899 900

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

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

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

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

  i = find_interval (tree, position);
921

922 923
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
924 925 926 927 928 929 930 931 932 933
     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))
934
    {
935 936 937
      Lisp_Object tail;
      Lisp_Object front, rear;

938 939 940 941 942 943 944 945 946 947 948
      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;
	}
949
      front = textget (i->plist, Qfront_sticky);
950 951 952 953 954 955
      if (! CONSP (front) && ! NILP (front))
	{
	  /* All properties are sticky.  We don't split the interval.  */
	  tail = Qnil;
	  goto check_done;
	}
956

957 958 959
      /* 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)))
960
	{
961
	  Lisp_Object prop, tmp;
962
	  prop = XCAR (tail);
963

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

968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983
	  /* 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.  */
984 985
	}

986
    check_done:
987 988 989 990 991 992 993
      /* 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;
	}
994 995
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
996
  /* If we are positioned between intervals, check the stickiness of
997 998
     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
999
    {
1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010
      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
1011

1012 1013
      /* 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
1014
	 off a part later, if stickiness demands it.  */
1015
      for (temp = prev ? prev : i; temp; temp = INTERVAL_PARENT_OR_NULL (temp))
1016 1017
	{
	  temp->total_length += length;
1018
	  CHECK_TOTAL_LENGTH (temp);
1019 1020
	  temp = balance_possible_root_interval (temp);
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
1021

1022
      /* If at least one interval has sticky properties,
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
	 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)
1033
	{
1034
	  Lisp_Object pleft, pright;
1035 1036
	  struct interval newi;

1037 1038
	  pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
	  pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;
1039 1040
	  newi.plist = merge_properties_sticky (pleft, pright);

1041
	  if (! prev) /* i.e. position == BEG */
1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065