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

This file is part of GNU Emacs.

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

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

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


/* NOTES:

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

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

   Need to call *_left_hook when buffer is killed.

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

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

*/


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

49 50 51 52 53
/* 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))

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


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

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

  CHECK_IMPURE (parent);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226
/* 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
227
/* Traverse an interval tree TREE, performing FUNCTION on each node.
228
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
229 230

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

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

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

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

  return icount;
}

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

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

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

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

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

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

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

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

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

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

  return B;
}
362

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

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

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

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

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

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

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

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

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

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

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

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

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

   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
516 517

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

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

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

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

549 550
  balance_possible_root_interval (interval);

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

554 555 556 557
/* 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
558

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

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

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

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

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

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

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

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

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

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

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

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

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

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

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

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

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

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

  return NULL_INTERVAL;
}

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

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

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

  return NULL_INTERVAL;
}
766 767

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

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

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

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

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

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

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

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

  i = find_interval (tree, position);
919

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

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

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

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

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

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

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

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

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

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