intervals.c 60 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1993, 1994, 1995, 1997, 1998 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41


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

*/


42
#include <config.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"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
48

49
/* The rest of the file is within this conditional.  */
50 51
#ifdef USE_TEXT_PROPERTIES

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

57 58
#define min(x, y) ((x) < (y) ? (x) : (y))

59
Lisp_Object merge_properties_sticky ();
Joseph Arceneaux's avatar
Joseph Arceneaux committed
60

61
/* Utility functions for intervals.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
62 63


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

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

  CHECK_IMPURE (parent);

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

76
  if (BUFFERP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
77
    {
78 79
      new->total_length = (BUF_Z (XBUFFER (parent))
			   - BUF_BEG (XBUFFER (parent)));
80
      BUF_INTERVALS (XBUFFER (parent)) = new;
81
      new->position = 1;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
82
    }
83
  else if (STRINGP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
84 85 86
    {
      new->total_length = XSTRING (parent)->size;
      XSTRING (parent)->intervals = new;
87
      new->position = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
88 89
    }

90
  new->parent = (INTERVAL) XFASTINT (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 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141

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;
  while (! EQ (o, Qnil))
    {
      sym = Fcar (o);
      val = Fmemq (sym, target->plist);

      if (NILP (val))
	{
	  o = Fcdr (o);
	  val = Fcar (o);
	  target->plist = Fcons (sym, Fcons (val, target->plist));
	  o = Fcdr (o);
	}
      else
	o = Fcdr (Fcdr (o));
    }
}

/* Return 1 if the two intervals have the same properties,
142
   0 otherwise.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
143 144 145 146 147 148

int
intervals_equal (i0, i1)
     INTERVAL i0, i1;
{
  register Lisp_Object i0_cdr, i0_sym, i1_val;
Andreas Schwab's avatar
Andreas Schwab committed
149
  register int i1_len;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
150 151 152 153

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

154 155 156
  if (DEFAULT_INTERVAL_P (i0) || DEFAULT_INTERVAL_P (i1))
    return 0;

Joseph Arceneaux's avatar
Joseph Arceneaux committed
157 158 159 160 161 162 163
  i1_len = XFASTINT (Flength (i1->plist));
  if (i1_len & 0x1)		/* Paranoia -- plists are always even */
    abort ();
  i1_len /= 2;
  i0_cdr = i0->plist;
  while (!NILP (i0_cdr))
    {
164
      /* Lengths of the two plists were unequal.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
165 166 167 168 169 170
      if (i1_len == 0)
	return 0;

      i0_sym = Fcar (i0_cdr);
      i1_val = Fmemq (i0_sym, i1->plist);

171
      /* i0 has something i1 doesn't.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
172 173 174
      if (EQ (i1_val, Qnil))
	return 0;

175
      /* i0 and i1 both have sym, but it has different values in each.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
176
      i0_cdr = Fcdr (i0_cdr);
177
      if (! EQ (Fcar (Fcdr (i1_val)), Fcar (i0_cdr)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
178 179 180 181 182 183
	return 0;

      i0_cdr = Fcdr (i0_cdr);
      i1_len--;
    }

184
  /* Lengths of the two plists were unequal.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
185 186 187 188 189 190 191 192 193 194 195
  if (i1_len > 0)
    return 0;

  return 1;
}

static int icount;
static int idepth;
static int zero_length;

/* Traverse an interval tree TREE, performing FUNCTION on each node.
196
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
197 198

void
199
traverse_intervals (tree, position, depth, function, arg)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
200
     INTERVAL tree;
201
     int position, depth;
202
     void (* function) P_ ((INTERVAL, Lisp_Object));
203
     Lisp_Object arg;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
204 205 206 207
{
  if (NULL_INTERVAL_P (tree))
    return;

208
  traverse_intervals (tree->left, position, depth + 1, function, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
209 210
  position += LEFT_TOTAL_LENGTH (tree);
  tree->position = position;
211
  (*function) (tree, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
212
  position += LENGTH (tree);
213
  traverse_intervals (tree->right, position, depth + 1,  function, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
214 215 216
}

#if 0
217
/* These functions are temporary, for debugging purposes only.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238

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;
239
  traverse_intervals (tree, 1, 0, &check_for_interval, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260
  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;
261
  traverse_intervals (i, 1, 0, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293

  return icount;
}

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

  while (! ROOT_INTERVAL_P (i))
    i = i->parent;

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

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

static INTERVAL
rotate_right (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->left;
294
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
295

296
  /* Deal with any Parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
297 298
  if (! ROOT_INTERVAL_P (interval))
    if (AM_LEFT_CHILD (interval))
299
      interval->parent->left = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
300
    else
301 302
      interval->parent->right = B;
  B->parent = interval->parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
303

304 305 306 307
  /* Make B the parent of A */
  i = B->right;
  B->right = interval;
  interval->parent = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
308

309
  /* Make A point to c */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
310 311 312
  interval->left = i;
  if (! NULL_INTERVAL_P (i))
    i->parent = interval;
313

314
  /* A's total length is decreased by the length of B and its left child.  */
315 316 317 318
  interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);

  /* B must have the same total length of A.  */
  B->total_length = old_total;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
319 320 321

  return B;
}
322

Joseph Arceneaux's avatar
Joseph Arceneaux committed
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
/* Assuming that a right child exists, perform the following operation:

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

static INTERVAL
rotate_left (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->right;
338
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
339

340
  /* Deal with any parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
341 342
  if (! ROOT_INTERVAL_P (interval))
    if (AM_LEFT_CHILD (interval))
343
      interval->parent->left = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
344
    else
345 346
      interval->parent->right = B;
  B->parent = interval->parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
347 348

  /* Make B the parent of A */
349 350 351
  i = B->left;
  B->left = interval;
  interval->parent = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
352 353 354 355 356

  /* Make A point to c */
  interval->right = i;
  if (! NULL_INTERVAL_P (i))
    i->parent = interval;
357

358
  /* A's total length is decreased by the length of B and its right child.  */
359 360 361 362
  interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);

  /* B must have the same total length of A.  */
  B->total_length = old_total;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
363 364 365 366

  return B;
}

367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414
/* 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)
	{
	  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)
	{
	  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;

  if (interval->parent == NULL_INTERVAL)
    return interval;

415
  XSETFASTINT (parent, (EMACS_INT) interval->parent);
416 417
  interval = balance_an_interval (interval);

418
  if (BUFFERP (parent))
419
    BUF_INTERVALS (XBUFFER (parent)) = interval;
420
  else if (STRINGP (parent))
421 422 423 424 425 426 427 428 429 430 431 432 433 434
    XSTRING (parent)->intervals = interval;

  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)
435
    balance_intervals_internal (tree->left);
436
  if (tree->right)
437
    balance_intervals_internal (tree->right);
438 439 440 441 442 443 444 445 446 447 448 449 450 451 452
  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);
}

453 454 455 456
/* 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
457 458 459 460 461

   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
462 463

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

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467
split_interval_right (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
468
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
470 471 472
{
  INTERVAL new = make_interval ();
  int position = interval->position;
473
  int new_length = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
474

475
  new->position = position + offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
476 477
  new->parent = interval;

478
  if (NULL_RIGHT_CHILD (interval))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
479 480 481 482
    {
      interval->right = new;
      new->total_length = new_length;
    }
483 484 485 486 487 488 489 490 491 492
  else
    {
      /* Insert the new node between INTERVAL and its right child.  */
      new->right = interval->right;
      interval->right->parent = new;
      interval->right = new;
      new->total_length = new_length + new->right->total_length;
      balance_an_interval (new);
    }
  
493 494
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
495 496 497
  return new;
}

498 499 500 501
/* 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
502

Joseph Arceneaux's avatar
Joseph Arceneaux committed
503 504 505 506 507 508
   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,
509
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
510 511

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
512
split_interval_left (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
513
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
514
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
515 516 517
{
  INTERVAL new = make_interval ();
  int position = interval->position;
518
  int new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
519 520

  new->position = interval->position;
521
  interval->position = interval->position + offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
522 523 524 525 526 527 528
  new->parent = interval;

  if (NULL_LEFT_CHILD (interval))
    {
      interval->left = new;
      new->total_length = new_length;
    }
529 530 531 532 533 534 535 536 537 538
  else
    {
      /* Insert the new node between INTERVAL and its left child.  */
      new->left = interval->left;
      new->left->parent = new;
      interval->left = new;
      new->total_length = new_length + new->left->total_length;
      balance_an_interval (new);
    }
  
539
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
540 541 542 543

  return new;
}

544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566
/* 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;

  XSETFASTINT (parent, (EMACS_INT) source->parent);
  if (BUFFERP (parent))
    return BUF_BEG (XBUFFER (parent));
  return 0;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
567
/* Find the interval containing text position POSITION in the text
568
   represented by the interval tree TREE.  POSITION is a buffer
569 570 571
   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
572

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

577
INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
578 579 580 581
find_interval (tree, position)
     register INTERVAL tree;
     register int position;
{
582 583
  /* The distance from the left edge of the subtree at TREE
                    to POSITION.  */
584 585
  register int relative_position;
  Lisp_Object parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
586 587 588 589

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

590 591 592 593 594
  XSETFASTINT (parent, (EMACS_INT) tree->parent);
  relative_position = position;
  if (BUFFERP (parent))
    relative_position -= BUF_BEG (XBUFFER (parent));

595
  if (relative_position > TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
596 597
    abort ();			/* Paranoia */

598 599
  tree = balance_possible_root_interval (tree);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
600 601
  while (1)
    {
602
      if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
603 604 605
	{
	  tree = tree->left;
	}
606 607 608
      else if (! NULL_RIGHT_CHILD (tree)
	       && relative_position >= (TOTAL_LENGTH (tree)
					- RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
609 610 611 612 613 614 615
	{
	  relative_position -= (TOTAL_LENGTH (tree)
				- RIGHT_TOTAL_LENGTH (tree));
	  tree = tree->right;
	}
      else
	{
616 617 618
	  tree->position
	    = (position - relative_position /* the left edge of *tree */
	       + LEFT_TOTAL_LENGTH (tree)); /* the left edge of this interval */
619

Joseph Arceneaux's avatar
Joseph Arceneaux committed
620 621 622 623 624 625
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
626
   Sets the `position' field based on that of INTERVAL (see
627
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

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))
	{
	  i = i->parent;
	  i->position = next_position;
	  return i;
	}

      i = i->parent;
    }

  return NULL_INTERVAL;
}

/* Find the preceding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
666
   Sets the `position' field based on that of INTERVAL (see
667
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
668 669 670 671 672 673

INTERVAL
previous_interval (interval)
     register INTERVAL interval;
{
  register INTERVAL i;
Andreas Schwab's avatar
Andreas Schwab committed
674
  register int position_of_previous;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703

  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))
	{
	  i = i->parent;

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

  return NULL_INTERVAL;
}
704 705

/* Find the interval containing POS given some non-NULL INTERVAL
706 707
   in the same tree.  Note that we need to update interval->position
   if we go down the tree.  */
708 709 710 711 712 713 714 715 716 717 718 719 720
INTERVAL
update_interval (i, pos)
     register INTERVAL i;
     int pos;
{
  if (NULL_INTERVAL_P (i))
    return NULL_INTERVAL;

  while (1) 
    {
      if (pos < i->position) 
	{
	  /* Move left. */
721 722 723 724 725 726
	  if (pos >= i->position - TOTAL_LENGTH (i->left)) 
	    {
	      i->left->position = i->position - TOTAL_LENGTH (i->left)
		+ LEFT_TOTAL_LENGTH (i->left);
	      i = i->left;		/* Move to the left child */
	    }
727 728
	  else if (NULL_PARENT (i)) 
	    error ("Point before start of properties");
729 730
	  else  
	      i = i->parent;
731 732 733 734 735
	  continue;
	}
      else if (pos >= INTERVAL_LAST_POS (i))
	{
	  /* Move right. */
736 737 738 739 740 741
	  if (pos < INTERVAL_LAST_POS (i) + TOTAL_LENGTH (i->right)) 
	    {
	      i->right->position = INTERVAL_LAST_POS (i) +
		LEFT_TOTAL_LENGTH (i->right);
	      i = i->right;		/* Move to the right child */
	    }
742 743 744
	  else if (NULL_PARENT (i)) 
	    error ("Point after end of properties");
	  else 
745
	      i = i->parent;
746 747 748 749 750 751 752
	  continue;
	}
      else 
	return i;
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
753

Joseph Arceneaux's avatar
Joseph Arceneaux committed
754
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
755 756 757 758 759 760 761 762 763
/* 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
764
   and check the hungry bits of both.  Then add the length going back up
765
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802

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;
	  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;
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
803
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
804 805 806 807 808 809 810
	  this->total_length += length;
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
811 812 813 814
#endif

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
815
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
816 817 818 819 820 821
   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
822
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
823
   interval.  Another possibility would be to create a new interval for
824
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
825 826 827 828 829 830 831

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
     int position, length;
{
  register INTERVAL i;
832 833
  register INTERVAL temp;
  int eobp = 0;
834 835
  Lisp_Object parent;
  int offset;
836
  
Joseph Arceneaux's avatar
Joseph Arceneaux committed
837 838 839
  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

840 841 842
  XSETFASTINT (parent, (EMACS_INT) tree->parent);
  offset = (BUFFERP (parent) ? BUF_BEG (XBUFFER (parent)) : 0);

843 844
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
845 846 847 848 849
  if (position >= TOTAL_LENGTH (tree) + offset)
    {
      position = TOTAL_LENGTH (tree) + offset;
      eobp = 1;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
850 851

  i = find_interval (tree, position);
852

853 854 855 856 857
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
     So split this interval at the insertion point.  */
  if (! (position == i->position || eobp)
      && END_NONSTICKY_P (i)
858
      && FRONT_NONSTICKY_P (i))
859
    {
860 861 862 863 864 865 866 867 868 869
      Lisp_Object tail;
      Lisp_Object front, rear;

      front = textget (i->plist, Qfront_sticky);
      rear  = textget (i->plist, Qrear_nonsticky);

      /* Does any actual property pose an actual problem?  */
      for (tail = i->plist; ! NILP (tail); tail = Fcdr (Fcdr (tail)))
	{
	  Lisp_Object prop;
870
	  prop = XCAR (tail);
871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894

	  /* Is this particular property rear-sticky?
	     Note, if REAR isn't a cons, it must be non-nil,
	     which means that all properties are rear-nonsticky.  */
	  if (CONSP (rear) && NILP (Fmemq (prop, rear)))
	    continue;

	  /* Is this particular property front-sticky?
	     Note, if FRONT isn't a cons, it must be nil,
	     which means that all properties are front-nonsticky.  */
	  if (CONSP (front) && ! NILP (Fmemq (prop, front)))
	    continue;

	  /* PROP isn't sticky on either side => it is a real problem.  */
	  break;
	}

      /* 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;
	}
895 896
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
897
  /* If we are positioned between intervals, check the stickiness of
898 899
     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
900
    {
901 902 903 904 905 906 907 908 909 910 911
      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
912

913 914
      /* 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
915
	 off a part later, if stickiness demands it.  */
916 917 918 919 920
      for (temp = prev ? prev : i;! NULL_INTERVAL_P (temp); temp = temp->parent)
	{
	  temp->total_length += length;
	  temp = balance_possible_root_interval (temp);
	}
921 922
      
      /* If at least one interval has sticky properties,
Karl Heuer's avatar
Karl Heuer committed
923
	 we check the stickiness property by property.  */
924 925
      if (END_NONSTICKY_P (prev) || FRONT_STICKY_P (i))
	{
926
	  Lisp_Object pleft, pright;
927 928
	  struct interval newi;

929 930
	  pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
	  pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;
931 932
	  newi.plist = merge_properties_sticky (pleft, pright);

933
	  if (! prev) /* i.e. position == BEG */
934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958
	    {
	      if (! intervals_equal (i, &newi))
		{
		  i = split_interval_left (i, length);
		  i->plist = newi.plist;
		}
	    }
	  else if (! intervals_equal (prev, &newi))
	    {
	      prev = split_interval_right (prev,
					   position - prev->position);
	      prev->plist = newi.plist;
	      if (! NULL_INTERVAL_P (i)
		  && intervals_equal (prev, i))
		merge_interval_right (prev);
	    }

	  /* We will need to update the cache here later.  */
	}
      else if (! prev && ! NILP (i->plist))
        {
	  /* Just split off a new interval at the left.
	     Since I wasn't front-sticky, the empty plist is ok.  */
	  i = split_interval_left (i, length);
        }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
959 960
    }

961 962
  /* Otherwise just extend the interval.  */
  else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
963
    {
964
      for (temp = i; ! NULL_INTERVAL_P (temp); temp = temp->parent)
965 966 967 968
	{
	  temp->total_length += length;
	  temp = balance_possible_root_interval (temp);
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
969
    }
970
      
Joseph Arceneaux's avatar
Joseph Arceneaux committed
971 972
  return tree;
}
973

974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
/* Any property might be front-sticky on the left, rear-sticky on the left,
   front-sticky on the right, or rear-sticky on the right; the 16 combinations
   can be arranged in a matrix with rows denoting the left conditions and
   columns denoting the right conditions:
      _  __  _
_     FR FR FR FR
FR__   0  1  2  3
 _FR   4  5  6  7
FR     8  9  A  B
  FR   C  D  E  F

   left-props  = '(front-sticky (p8 p9 pa pb pc pd pe pf)
		   rear-nonsticky (p4 p5 p6 p7 p8 p9 pa pb)
		   p0 L p1 L p2 L p3 L p4 L p5 L p6 L p7 L
		   p8 L p9 L pa L pb L pc L pd L pe L pf L)
   right-props = '(front-sticky (p2 p3 p6 p7 pa pb pe pf)
		   rear-nonsticky (p1 p2 p5 p6 p9 pa pd pe)
		   p0 R p1 R p2 R p3 R p4 R p5 R p6 R p7 R
		   p8 R p9 R pa R pb R pc R pd R pe R pf R)

   We inherit from whoever has a sticky side facing us.  If both sides
   do (cases 2, 3, E, and F), then we inherit from whichever side has a
   non-nil value for the current property.  If both sides do, then we take
   from the left.

   When we inherit a property, we get its stickiness as well as its value.
   So, when we merge the above two lists, we expect to get this:

   result      = '(front-sticky (p6 p7 pa pb pc pd pe pf)
		   rear-nonsticky (p6 pa)
		   p0 L p1 L p2 L p3 L p6 R p7 R
		   pa R pb R pc L pd L pe L pf L)

   The optimizable special cases are:
       left rear-nonsticky = nil, right front-sticky = nil (inherit left)
       left rear-nonsticky = t,   right front-sticky = t   (inherit right)
       left rear-nonsticky = t,   right front-sticky = nil (inherit none)
*/

1013 1014 1015 1016
Lisp_Object
merge_properties_sticky (pleft, pright)
     Lisp_Object pleft, pright;
{
1017 1018
  register Lisp_Object props, front, rear;
  Lisp_Object lfront, lrear, rfront, rrear;
1019
  register Lisp_Object tail1, tail2, sym, lval, rval, cat;
1020
  int use_left, use_right;
1021
  int lpresent;
1022

1023 1024 1025 1026 1027 1028 1029 1030
  props = Qnil;
  front = Qnil;
  rear  = Qnil;
  lfront = textget (pleft, Qfront_sticky);
  lrear  = textget (pleft, Qrear_nonsticky);
  rfront = textget (pright, Qfront_sticky);
  rrear  = textget (pright, Qrear_nonsticky);

1031 1032
  /* Go through each element of PRIGHT.  */
  for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
1033 1034 1035 1036 1037 1038
    {
      sym = Fcar (tail1);

      /* Sticky properties get special treatment.  */
      if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
	continue;
1039 1040 1041 1042 1043 1044

      rval = Fcar (Fcdr (tail1));
      for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
	if (EQ (sym, Fcar (tail2)))
	  break;

1045 1046 1047 1048 1049 1050 1051
      /* Indicate whether the property is explicitly defined on the left.
	 (We know it is defined explicitly on the right
	 because otherwise we don't get here.)  */
      lpresent = ! NILP (tail2);
      lval = (NILP (tail2) ? Qnil : Fcar (Fcdr (tail2)));

      use_left = ! TMEM (sym, lrear) && lpresent;
1052 1053 1054
      use_right = TMEM (sym, rfront);
      if (use_left && use_right)
	{
1055 1056 1057 1058
	  if (NILP (lval))
	    use_left = 0;
	  else if (NILP (rval))
	    use_right = 0;
1059 1060
	}
      if (use_left)
1061
	{
1062 1063
	  /* We build props as (value sym ...) rather than (sym value ...)
	     because we plan to nreverse it when we're done.  */
1064
	  props = Fcons (lval, Fcons (sym, props));
1065
	  if (TMEM (sym, lfront))
1066
	    front = Fcons (sym, front);
1067 1068
	  if (TMEM (sym, lrear))
	    rear = Fcons (sym, rear);
1069
	}
1070
      else if (use_right)
1071
	{
1072
	  props = Fcons (rval, Fcons (sym, props));
1073 1074 1075 1076
	  if (TMEM (sym, rfront))
	    front = Fcons (sym, front);
	  if (TMEM (sym, rrear))
	    rear = Fcons (sym, rear);
1077 1078
	}
    }
1079 1080 1081

  /* Now go through each element of PLEFT.  */
  for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
1082 1083 1084 1085 1086 1087 1088
    {
      sym = Fcar (tail2);

      /* Sticky properties get special treatment.  */
      if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
	continue;

1089 1090
      /* If sym is in PRIGHT, we've already considered it.  */
      for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
1091 1092
	if (EQ (sym, Fcar (tail1)))
	  break;
1093 1094 1095 1096 1097 1098 1099
      if (! NILP (tail1))
	continue;

      lval = Fcar (Fcdr (tail2));

      /* Since rval is known to be nil in this loop, the test simplifies.  */
      if (! TMEM (sym, lrear))
1100
	{
1101
	  props = Fcons (lval, Fcons (sym, props));
1102 1103 1104 1105 1106 1107 1108
	  if (TMEM (sym, lfront))
	    front = Fcons (sym, front);
	}
      else if (TMEM (sym, rfront))
	{
	  /* The value is nil, but we still inherit the stickiness
	     from the right.  */
1109
	  front = Fcons (sym, front);
1110
	  if (TMEM (sym, rrear))
1111 1112 1113
	    rear = Fcons (sym, rear);
	}
    }
1114
  props = Fnreverse (props);
1115
  if (! NILP (rear))
1116
    props = Fcons (Qrear_nonsticky, Fcons (Fnreverse (rear), props));
1117 1118 1119 1120 1121 1122 1123 1124

  cat = textget (props, Qcategory);
  if (! NILP (front)
      && 
      /* If we have inherited a front-stick category property that is t,
	 we don't need to set up a detailed one.  */
      ! (! NILP (cat) && SYMBOLP (cat)
	 && EQ (Fget (cat, Qfront_sticky), Qt)))
1125
    props = Fcons (Qfront_sticky, Fcons (Fnreverse (front), props));
1126 1127 1128
  return props;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1129

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1130 1131
/* Delete an node I from its interval tree by merging its subtrees
   into one subtree which is then returned.  Caller is responsible for
1132
   storing the resulting subtree into its parent.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164

static INTERVAL
delete_node (i)
     register INTERVAL i;
{
  register INTERVAL migrate, this;
  register int migrate_amt;

  if (NULL_INTERVAL_P (i->left))
    return i->right;
  if (NULL_INTERVAL_P (i->right))
    return i->left;

  migrate = i->left;
  migrate_amt = i->left->total_length;
  this = i->right;
  this->total_length += migrate_amt;
  while (! NULL_INTERVAL_P (this->left))
    {
      this = this->left;
      this->total_length += migrate_amt;
    }
  this->left = migrate;
  migrate->parent = this;

  return i->right;
}

/* Delete interval I from its tree by calling `delete_node'
   and properly connecting the resultant subtree.

   I is presumed to be empty; that is, no adjustments are made
1165
   for the length of I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1166 1167 1168 1169 1170 1171 1172 1173

void
delete_interval (i)
     register INTERVAL i;
{
  register INTERVAL parent;
  int amt = LENGTH (i);

1174
  if (amt > 0)			/* Only used on zero-length intervals now.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1175 1176 1177 1178
    abort ();

  if (ROOT_INTERVAL_P (i))
    {
1179
      Lisp_Object owner;
1180
      XSETFASTINT (owner, (EMACS_INT) i->parent);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1181 1182
      parent = delete_node (i);
      if (! NULL_INTERVAL_P (parent))
1183
	parent->parent = (INTERVAL) XFASTINT (owner);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1184

1185
      if (BUFFERP (owner))
1186
	BUF_INTERVALS (XBUFFER (owner)) = parent;
1187
      else if (STRINGP (owner))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
	XSTRING (owner)->intervals = parent;
      else
	abort ();

      return;
    }

  parent = i->parent;
  if (AM_LEFT_CHILD (i))
    {
      parent->left = delete_node (i);
      if (! NULL_INTERVAL_P (parent->left))
	parent->left->parent = parent;
    }
  else
    {
      parent->right = delete_node (i);
      if (! NULL_INTERVAL_P (parent->right))
	parent->right->parent = parent;
    }
}

1210 1211 1212 1213 1214 1215 1216 1217
/* Find the interval in TREE corresponding to the relative position
   FROM and delete as much as possible of AMOUNT from that interval.
   Return the amount actually deleted, and if the interval was
   zeroed-out, delete that interval node from the tree.

   Note that FROM is actually origin zero, aka relative to the
   leftmost edge of tree.  This is appropriate since we call ourselves
   recursively on subtrees.