intervals.c 70.7 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
2
   Copyright (C) 1993, 1994, 1995, 1997, 1998, 2002 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"
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 = 1;
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 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
  if (i1_len > 0)
    return 0;

  return 1;
}


192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
/* 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
216
/* Traverse an interval tree TREE, performing FUNCTION on each node.
217
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
218 219

void
220
traverse_intervals (tree, position, function, arg)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
221
     INTERVAL tree;
222
     int position;
223
     void (* function) P_ ((INTERVAL, Lisp_Object));
224
     Lisp_Object arg;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
225
{
226 227
  while (!NULL_INTERVAL_P (tree))
    {
228
      traverse_intervals (tree->left, position, function, arg);
229 230 231
      position += LEFT_TOTAL_LENGTH (tree);
      tree->position = position;
      (*function) (tree, arg);
232
      position += LENGTH (tree); tree = tree->right;
233
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
234 235 236
}

#if 0
237 238 239 240 241

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

242
/* These functions are temporary, for debugging purposes only.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263

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;
264
  traverse_intervals_noorder (tree, &check_for_interval, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285
  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;
286
  traverse_intervals_noorder (i, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
287 288 289 290 291 292 293 294 295 296 297

  return icount;
}

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

  while (! ROOT_INTERVAL_P (i))
298
    i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
299 300 301 302 303 304 305 306 307 308 309 310 311 312

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

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

313
static INLINE INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
314 315 316 317 318
rotate_right (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->left;
319
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
320

321
  /* Deal with any Parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
322
  if (! ROOT_INTERVAL_P (interval))
323 324
    {
      if (AM_LEFT_CHILD (interval))
325
	INTERVAL_PARENT (interval)->left = B;
326
      else
327
	INTERVAL_PARENT (interval)->right = B;
328
    }
329
  COPY_INTERVAL_PARENT (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
330

331 332 333
  /* Make B the parent of A */
  i = B->right;
  B->right = interval;
334
  SET_INTERVAL_PARENT (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
335

336
  /* Make A point to c */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
337 338
  interval->left = i;
  if (! NULL_INTERVAL_P (i))
339
    SET_INTERVAL_PARENT (i, interval);
340

341
  /* A's total length is decreased by the length of B and its left child.  */
342
  interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);
343
  CHECK_TOTAL_LENGTH (interval);
344 345 346

  /* B must have the same total length of A.  */
  B->total_length = old_total;
347
  CHECK_TOTAL_LENGTH (B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
348 349 350

  return B;
}
351

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

Juanma Barranquero's avatar
Juanma Barranquero committed
354 355
    A               B
   / \	           / \
Joseph Arceneaux's avatar
Joseph Arceneaux committed
356
      B	   =>     A
Juanma Barranquero's avatar
Juanma Barranquero committed
357
     / \         / \
Joseph Arceneaux's avatar
Joseph Arceneaux committed
358 359 360
    c               c
*/

361
static INLINE INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
362 363 364 365 366
rotate_left (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->right;
367
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
368

369
  /* Deal with any parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
370
  if (! ROOT_INTERVAL_P (interval))
371 372
    {
      if (AM_LEFT_CHILD (interval))
373
	INTERVAL_PARENT (interval)->left = B;
374
      else
375
	INTERVAL_PARENT (interval)->right = B;
376
    }
377
  COPY_INTERVAL_PARENT (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
378 379

  /* Make B the parent of A */
380 381
  i = B->left;
  B->left = interval;
382
  SET_INTERVAL_PARENT (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
383 384 385 386

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

389
  /* A's total length is decreased by the length of B and its right child.  */
390
  interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);
391
  CHECK_TOTAL_LENGTH (interval);
392 393 394

  /* B must have the same total length of A.  */
  B->total_length = old_total;
395
  CHECK_TOTAL_LENGTH (B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
396 397 398 399

  return B;
}

400 401 402 403 404 405 406 407 408 409 410 411 412 413
/* 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)
	{
414
	  /* Since the left child is longer, there must be one.  */
415 416 417 418 419 420 421 422 423
	  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)
	{
424
	  /* Since the right child is longer, there must be one.  */
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445
	  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;
446
  int have_parent = 0;
447

448
  if (!INTERVAL_HAS_OBJECT (interval) && !INTERVAL_HAS_PARENT (interval))
449 450
    return interval;

451 452 453 454 455
  if (INTERVAL_HAS_OBJECT (interval))
    {
      have_parent = 1;
      GET_INTERVAL_OBJECT (parent, interval);
    }
456 457
  interval = balance_an_interval (interval);

458 459 460 461 462
  if (have_parent)
    {
      if (BUFFERP (parent))
	BUF_INTERVALS (XBUFFER (parent)) = interval;
      else if (STRINGP (parent))
463
	STRING_SET_INTERVALS (parent, interval);
464
    }
465 466 467 468 469 470 471 472 473 474 475 476 477

  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)
478
    balance_intervals_internal (tree->left);
479
  if (tree->right)
480
    balance_intervals_internal (tree->right);
481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
  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);
}

496 497 498 499
/* 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
500 501 502 503 504

   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
505 506

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

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
510
split_interval_right (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
512
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
513 514 515
{
  INTERVAL new = make_interval ();
  int position = interval->position;
516
  int new_length = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
517

518
  new->position = position + offset;
519
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
520

521
  if (NULL_RIGHT_CHILD (interval))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
522 523 524
    {
      interval->right = new;
      new->total_length = new_length;
525
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
526
    }
527 528 529 530
  else
    {
      /* Insert the new node between INTERVAL and its right child.  */
      new->right = interval->right;
531
      SET_INTERVAL_PARENT (interval->right, new);
532 533
      interval->right = new;
      new->total_length = new_length + new->right->total_length;
534
      CHECK_TOTAL_LENGTH (new);
535 536
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
537

538 539
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
540 541 542
  return new;
}

543 544 545 546
/* 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
547

Joseph Arceneaux's avatar
Joseph Arceneaux committed
548 549 550 551 552 553
   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,
554
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
555 556

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
557
split_interval_left (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
558
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
559
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
560 561
{
  INTERVAL new = make_interval ();
562
  int new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
563 564

  new->position = interval->position;
565
  interval->position = interval->position + offset;
566
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
567 568 569 570 571

  if (NULL_LEFT_CHILD (interval))
    {
      interval->left = new;
      new->total_length = new_length;
572
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
573
    }
574 575 576 577
  else
    {
      /* Insert the new node between INTERVAL and its left child.  */
      new->left = interval->left;
578
      SET_INTERVAL_PARENT (new->left, new);
579 580
      interval->left = new;
      new->total_length = new_length + new->left->total_length;
581
      CHECK_TOTAL_LENGTH (new);
582 583
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
584

585
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
586 587 588 589

  return new;
}

590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606
/* 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;

607 608
  if (! INTERVAL_HAS_OBJECT (source))
    return 0;
609
  GET_INTERVAL_OBJECT (parent, source);
610 611 612 613 614
  if (BUFFERP (parent))
    return BUF_BEG (XBUFFER (parent));
  return 0;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
615
/* Find the interval containing text position POSITION in the text
616
   represented by the interval tree TREE.  POSITION is a buffer
617 618 619
   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
620

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

625
INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
626 627 628 629
find_interval (tree, position)
     register INTERVAL tree;
     register int position;
{
630 631
  /* The distance from the left edge of the subtree at TREE
                    to POSITION.  */
632
  register int relative_position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
633 634 635 636

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

637
  relative_position = position;
638 639 640 641 642 643 644
  if (INTERVAL_HAS_OBJECT (tree))
    {
      Lisp_Object parent;
      GET_INTERVAL_OBJECT (parent, tree);
      if (BUFFERP (parent))
	relative_position -= BUF_BEG (XBUFFER (parent));
    }
645

646
  if (relative_position > TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
647 648
    abort ();			/* Paranoia */

649 650
  if (!handling_signal)
    tree = balance_possible_root_interval (tree);
651

Joseph Arceneaux's avatar
Joseph Arceneaux committed
652 653
  while (1)
    {
654
      if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
655 656 657
	{
	  tree = tree->left;
	}
658 659 660
      else if (! NULL_RIGHT_CHILD (tree)
	       && relative_position >= (TOTAL_LENGTH (tree)
					- RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
661 662 663 664 665 666 667
	{
	  relative_position -= (TOTAL_LENGTH (tree)
				- RIGHT_TOTAL_LENGTH (tree));
	  tree = tree->right;
	}
      else
	{
668 669 670
	  tree->position
	    = (position - relative_position /* the left edge of *tree */
	       + LEFT_TOTAL_LENGTH (tree)); /* the left edge of this interval */
671

Joseph Arceneaux's avatar
Joseph Arceneaux committed
672 673 674 675 676 677
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
678
   Sets the `position' field based on that of INTERVAL (see
679
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

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))
	{
706
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
707 708 709 710
	  i->position = next_position;
	  return i;
	}

711
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
712 713 714 715 716 717
    }

  return NULL_INTERVAL;
}

/* Find the preceding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
718
   Sets the `position' field based on that of INTERVAL (see
719
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744

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))
	{
745
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
746 747 748 749

	  i->position = interval->position - LENGTH (i);
	  return i;
	}
750
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
751 752 753 754
    }

  return NULL_INTERVAL;
}
755 756

/* Find the interval containing POS given some non-NULL INTERVAL
757
   in the same tree.  Note that we need to update interval->position
758 759 760
   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.  */
761 762 763 764 765 766 767 768
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
769
  while (1)
770
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
771
      if (pos < i->position)
772 773
	{
	  /* Move left. */
Juanma Barranquero's avatar
Juanma Barranquero committed
774
	  if (pos >= i->position - TOTAL_LENGTH (i->left))
775 776 777 778 779
	    {
	      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
780
	  else if (NULL_PARENT (i))
781
	    error ("Point before start of properties");
Juanma Barranquero's avatar
Juanma Barranquero committed
782
	  else
783
	      i = INTERVAL_PARENT (i);
784 785 786 787 788
	  continue;
	}
      else if (pos >= INTERVAL_LAST_POS (i))
	{
	  /* Move right. */
Juanma Barranquero's avatar
Juanma Barranquero committed
789
	  if (pos < INTERVAL_LAST_POS (i) + TOTAL_LENGTH (i->right))
790 791 792 793 794
	    {
	      i->right->position = INTERVAL_LAST_POS (i) +
		LEFT_TOTAL_LENGTH (i->right);
	      i = i->right;		/* Move to the right child */
	    }
Juanma Barranquero's avatar
Juanma Barranquero committed
795
	  else if (NULL_PARENT (i))
796
	    error ("Point after end of properties");
Juanma Barranquero's avatar
Juanma Barranquero committed
797
	  else
798
	      i = INTERVAL_PARENT (i);
799 800
	  continue;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
801
      else
802 803 804 805
	return i;
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
806

Joseph Arceneaux's avatar
Joseph Arceneaux committed
807
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
808 809 810 811 812 813 814 815 816
/* 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
817
   and check the hungry bits of both.  Then add the length going back up
818
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842

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;
843
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
844 845 846 847 848 849 850 851
	  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;
852
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853 854 855 856 857
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
858
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
859
	  this->total_length += length;
860
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
861 862 863 864 865 866
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
867 868 869 870
#endif

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
871
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
872 873 874 875 876 877
   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
878
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
879
   interval.  Another possibility would be to create a new interval for
880
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
881 882 883 884 885 886 887

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
     int position, length;
{
  register INTERVAL i;
888 889
  register INTERVAL temp;
  int eobp = 0;
890 891
  Lisp_Object parent;
  int offset;
Juanma Barranquero's avatar
Juanma Barranquero committed
892

Joseph Arceneaux's avatar
Joseph Arceneaux committed
893 894 895
  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

896
  GET_INTERVAL_OBJECT (parent, tree);
897 898
  offset = (BUFFERP (parent) ? BUF_BEG (XBUFFER (parent)) : 0);

899 900
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
901 902 903 904 905
  if (position >= TOTAL_LENGTH (tree) + offset)
    {
      position = TOTAL_LENGTH (tree) + offset;
      eobp = 1;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
906 907

  i = find_interval (tree, position);
908

909 910
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
911 912 913 914 915 916 917 918 919 920
     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))
921
    {
922 923 924
      Lisp_Object tail;
      Lisp_Object front, rear;

925 926 927 928 929 930 931 932 933 934 935
      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;
	}
936
      front = textget (i->plist, Qfront_sticky);
937 938 939 940 941 942
      if (! CONSP (front) && ! NILP (front))
	{
	  /* All properties are sticky.  We don't split the interval.  */
	  tail = Qnil;
	  goto check_done;
	}
943

944 945 946
      /* 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)))
947
	{
948
	  Lisp_Object prop, tmp;
949
	  prop = XCAR (tail);
950

951
	  /* Is this particular property front-sticky?  */
952 953 954
	  if (CONSP (front) && ! NILP (Fmemq (prop, front)))
	    continue;

955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
	  /* 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.  */
971 972
	}

973
    check_done:
974 975 976 977 978 979 980
      /* 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;
	}
981 982
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
983
  /* If we are positioned between intervals, check the stickiness of
984 985
     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
986
    {
987 988 989 990 991 992 993 994 995 996 997
      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
998

999 1000
      /* 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
1001
	 off a part later, if stickiness demands it.  */
1002
      for (temp = prev ? prev : i; temp; temp = INTERVAL_PARENT_OR_NULL (temp))
1003 1004
	{
	  temp->total_length += length;
1005
	  CHECK_TOTAL_LENGTH (temp);
1006 1007
	  temp = balance_possible_root_interval (temp);
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
1008

1009
      /* If at least one interval has sticky properties,
1010 1011 1012 1013 1014 1015 1016 1017 1018 1019
	 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)
1020
	{
1021
	  Lisp_Object pleft, pright;
1022 1023
	  struct interval newi;

1024 1025
	  pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
	  pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;
1026 1027
	  newi.plist = merge_properties_sticky (pleft, pright);

1028
	  if (! prev) /* i.e. position == BEG */
1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053
	    {
	      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
1054 1055
    }

1056 1057
  /* Otherwise just extend the interval.  */
  else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1058
    {
1059
      for (temp = i; temp; temp = INTERVAL_PARENT_OR_NULL (temp))
1060 1061
	{
	  temp->total_length += length;
1062
	  CHECK_TOTAL_LENGTH (temp);
1063 1064
	  temp = balance_possible_root_interval (temp);
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1065
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
1066

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1067 1068
  return tree;
}
1069

1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086