intervals.c 71.2 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
2
   Copyright (C) 1993, 1994, 1995, 1997, 1998, 2002, 2003 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 = BEG;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
81
    }
82
  else if (STRINGP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
83
    {
84
      new->total_length = SCHARS (parent);
85
      CHECK_TOTAL_LENGTH (new);
86
      STRING_SET_INTERVALS (parent, new);
87
      new->position = 0;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
88 89
    }

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

  return new;
}

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

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

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

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

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

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

  MERGE_INTERVAL_CACHE (source, target);

  o = source->plist;
124
  while (CONSP (o))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
125
    {
126
      sym = XCAR (o);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
127 128 129 130
      val = Fmemq (sym, target->plist);

      if (NILP (val))
	{
131 132 133
	  o = XCDR (o);
	  CHECK_CONS (o);
	  val = XCAR (o);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
134
	  target->plist = Fcons (sym, Fcons (val, target->plist));
135
	  o = XCDR (o);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
136 137
	}
      else
138
	o = Fcdr (XCDR (o));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
139 140 141 142
    }
}

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

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

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

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

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

169
      i0_sym = XCAR (i0_cdr);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
170 171
      i1_val = Fmemq (i0_sym, i1->plist);

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

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

182
      i0_cdr = XCDR (i0_cdr);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
183 184 185
      i1_len--;
    }

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

  return 1;
}


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

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

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

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

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

  return icount;
}

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

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

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

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

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

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

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

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

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

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

  return B;
}
353

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

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

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

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

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

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

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

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

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

450
  if (!INTERVAL_HAS_OBJECT (interval) && !INTERVAL_HAS_PARENT (interval))
451 452
    return interval;

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

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

  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)
480
    balance_intervals_internal (tree->left);
481
  if (tree->right)
482
    balance_intervals_internal (tree->right);
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497
  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);
}

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 left-hand piece, and the right-hand piece
   (second, lexicographically) is returned.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
502 503 504 505 506

   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
507 508

   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_right (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 = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
519

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

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

540 541
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
542 543 544
  return new;
}

545 546 547 548
/* 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
549

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

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

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

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

587
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
588 589 590 591

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

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

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

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

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

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

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

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

651 652
  if (!handling_signal)
    tree = balance_possible_root_interval (tree);
653

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

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

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

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

  return NULL_INTERVAL;
}

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

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

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

  return NULL_INTERVAL;
}
757 758

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

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

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

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

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

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

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

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

  i = find_interval (tree, position);
910

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

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

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

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

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

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

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

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

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

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

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