intervals.c 71.6 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
2
   Copyright (C) 1993-1995, 1997-1998, 2001-2011  Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5

This file is part of GNU Emacs.

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

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
17
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39


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

*/


40
#include <config.h>
41
#include <setjmp.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 (Lisp_Object pleft, Lisp_Object pright);
55 56
static INTERVAL reproduce_tree (INTERVAL, INTERVAL);
static INTERVAL reproduce_tree_obj (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

INTERVAL
64
create_root_interval (Lisp_Object parent)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
65
{
Richard M. Stallman's avatar
Richard M. Stallman committed
66 67 68 69 70
  INTERVAL new;

  CHECK_IMPURE (parent);

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

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

88
  SET_INTERVAL_OBJECT (new, parent);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
89 90 91 92 93 94 95

  return new;
}

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

void
96
copy_properties (register INTERVAL source, register INTERVAL target)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
97 98 99 100 101 102 103 104 105
{
  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
106 107
   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
108 109

static void
110
merge_properties (register INTERVAL source, register INTERVAL target)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112 113 114 115 116 117 118 119
{
  register Lisp_Object o, sym, val;

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

  MERGE_INTERVAL_CACHE (source, target);

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

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

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

int
148
intervals_equal (INTERVAL i0, INTERVAL i1)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
149
{
150 151
  register Lisp_Object i0_cdr, i0_sym;
  register Lisp_Object i1_cdr, i1_val;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
152 153 154 155

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
159
  i0_cdr = i0->plist;
160 161
  i1_cdr = i1->plist;
  while (CONSP (i0_cdr) && CONSP (i1_cdr))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
162
    {
163
      i0_sym = XCAR (i0_cdr);
164 165 166 167 168 169 170 171 172 173 174
      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
175

176
      /* i0 has something i1 doesn't.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
177 178 179
      if (EQ (i1_val, Qnil))
	return 0;

180
      /* i0 and i1 both have sym, but it has different values in each.  */
181 182 183
      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
184 185
	return 0;

186
      i0_cdr = XCDR (i0_cdr);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
187

188 189 190 191 192
      i1_cdr = XCDR (i1_cdr);
      if (!CONSP (i1_cdr))
	return 0;		/* abort (); */
      i1_cdr = XCDR (i1_cdr);
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
193

194 195
  /* Lengths of the two plists were equal.  */
  return (NILP (i0_cdr) && NILP (i1_cdr));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
196 197 198
}


199 200 201 202 203
/* 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
204
traverse_intervals_noorder (INTERVAL tree, void (*function) (INTERVAL, Lisp_Object), Lisp_Object arg)
205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
{
  /* 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
220
/* Traverse an interval tree TREE, performing FUNCTION on each node.
221
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
222 223

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

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

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

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

  return icount;
}

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

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

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

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

314
static INLINE INTERVAL
315
rotate_right (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
316 317 318
{
  INTERVAL i;
  INTERVAL B = interval->left;
319
  EMACS_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
362
rotate_left (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
363 364 365
{
  INTERVAL i;
  INTERVAL B = interval->right;
366
  EMACS_INT old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
367

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

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

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

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

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

  return B;
}

399 400 401 402
/* Balance an interval tree with the assumption that the subtrees
   themselves are already balanced.  */

static INTERVAL
403
balance_an_interval (INTERVAL i)
404
{
405
  register EMACS_INT old_diff, new_diff;
406 407 408 409 410 411

  while (1)
    {
      old_diff = LEFT_TOTAL_LENGTH (i) - RIGHT_TOTAL_LENGTH (i);
      if (old_diff > 0)
	{
412
	  /* Since the left child is longer, there must be one.  */
413 414
	  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
415
	  if (eabs (new_diff) >= old_diff)
416 417 418 419 420 421
	    break;
	  i = rotate_right (i);
	  balance_an_interval (i->right);
	}
      else if (old_diff < 0)
	{
422
	  /* Since the right child is longer, there must be one.  */
423 424
	  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
425
	  if (eabs (new_diff) >= -old_diff)
426 427 428 429 430 431 432 433 434 435 436 437 438 439
	    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
440
balance_possible_root_interval (register INTERVAL interval)
441 442
{
  Lisp_Object parent;
443
  int have_parent = 0;
444

445
  if (!INTERVAL_HAS_OBJECT (interval) && !INTERVAL_HAS_PARENT (interval))
446 447
    return interval;

448 449 450 451 452
  if (INTERVAL_HAS_OBJECT (interval))
    {
      have_parent = 1;
      GET_INTERVAL_OBJECT (parent, interval);
    }
453 454
  interval = balance_an_interval (interval);

455 456 457 458 459
  if (have_parent)
    {
      if (BUFFERP (parent))
	BUF_INTERVALS (XBUFFER (parent)) = interval;
      else if (STRINGP (parent))
460
	STRING_SET_INTERVALS (parent, interval);
461
    }
462 463 464 465 466 467 468 469

  return interval;
}

/* Balance the interval tree TREE.  Balancing is by weight
   (the amount of text).  */

static INTERVAL
470
balance_intervals_internal (register INTERVAL tree)
471 472 473
{
  /* Balance within each side.  */
  if (tree->left)
474
    balance_intervals_internal (tree->left);
475
  if (tree->right)
476
    balance_intervals_internal (tree->right);
477 478 479 480 481 482
  return balance_an_interval (tree);
}

/* Advertised interface to balance intervals.  */

INTERVAL
483
balance_intervals (INTERVAL tree)
484 485 486 487 488 489 490
{
  if (tree == NULL_INTERVAL)
    return NULL_INTERVAL;

  return balance_intervals_internal (tree);
}

491 492 493 494
/* 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
495 496 497 498 499

   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
500 501

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

INTERVAL
505
split_interval_right (INTERVAL interval, EMACS_INT offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
506 507
{
  INTERVAL new = make_interval ();
508 509
  EMACS_INT position = interval->position;
  EMACS_INT new_length = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
510

511
  new->position = position + offset;
512
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
513

514
  if (NULL_RIGHT_CHILD (interval))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
515 516 517
    {
      interval->right = new;
      new->total_length = new_length;
518
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
519
    }
520 521 522 523
  else
    {
      /* Insert the new node between INTERVAL and its right child.  */
      new->right = interval->right;
524
      SET_INTERVAL_PARENT (interval->right, new);
525 526
      interval->right = new;
      new->total_length = new_length + new->right->total_length;
527
      CHECK_TOTAL_LENGTH (new);
528 529
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
530

531 532
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
533 534 535
  return new;
}

536 537 538 539
/* 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
540

Joseph Arceneaux's avatar
Joseph Arceneaux committed
541 542 543 544 545 546
   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,
547
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
548 549

INTERVAL
550
split_interval_left (INTERVAL interval, EMACS_INT offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
551 552
{
  INTERVAL new = make_interval ();
553
  EMACS_INT new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
554 555

  new->position = interval->position;
556
  interval->position = interval->position + offset;
557
  SET_INTERVAL_PARENT (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
558 559 560 561 562

  if (NULL_LEFT_CHILD (interval))
    {
      interval->left = new;
      new->total_length = new_length;
563
      CHECK_TOTAL_LENGTH (new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
564
    }
565 566 567 568
  else
    {
      /* Insert the new node between INTERVAL and its left child.  */
      new->left = interval->left;
569
      SET_INTERVAL_PARENT (new->left, new);
570 571
      interval->left = new;
      new->total_length = new_length + new->left->total_length;
572
      CHECK_TOTAL_LENGTH (new);
573 574
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
575

576
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
577 578 579 580

  return new;
}

581 582 583 584 585 586 587 588 589
/* 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
590
interval_start_pos (INTERVAL source)
591 592 593 594 595 596
{
  Lisp_Object parent;

  if (NULL_INTERVAL_P (source))
    return 0;

597 598
  if (! INTERVAL_HAS_OBJECT (source))
    return 0;
599
  GET_INTERVAL_OBJECT (parent, source);
600 601 602 603 604
  if (BUFFERP (parent))
    return BUF_BEG (XBUFFER (parent));
  return 0;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
605
/* Find the interval containing text position POSITION in the text
606
   represented by the interval tree TREE.  POSITION is a buffer
607 608 609
   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
610

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

615
INTERVAL
616
find_interval (register INTERVAL tree, register EMACS_INT position)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
617
{
618 619
  /* The distance from the left edge of the subtree at TREE
                    to POSITION.  */
620
  register EMACS_INT relative_position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
621 622 623 624

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

625
  relative_position = position;
626 627 628 629 630 631 632
  if (INTERVAL_HAS_OBJECT (tree))
    {
      Lisp_Object parent;
      GET_INTERVAL_OBJECT (parent, tree);
      if (BUFFERP (parent))
	relative_position -= BUF_BEG (XBUFFER (parent));
    }
633

634
  if (relative_position > TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
635 636
    abort ();			/* Paranoia */

637 638
  if (!handling_signal)
    tree = balance_possible_root_interval (tree);
639

Joseph Arceneaux's avatar
Joseph Arceneaux committed
640 641
  while (1)
    {
642
      if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
643 644 645
	{
	  tree = tree->left;
	}
646 647 648
      else if (! NULL_RIGHT_CHILD (tree)
	       && relative_position >= (TOTAL_LENGTH (tree)
					- RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
649 650 651 652 653 654 655
	{
	  relative_position -= (TOTAL_LENGTH (tree)
				- RIGHT_TOTAL_LENGTH (tree));
	  tree = tree->right;
	}
      else
	{
656
	  tree->position
657 658
	    = (position - relative_position /* left edge of *tree.  */
	       + LEFT_TOTAL_LENGTH (tree)); /* left edge of this interval.  */
659

Joseph Arceneaux's avatar
Joseph Arceneaux committed
660 661 662 663 664 665
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
666
   Sets the `position' field based on that of INTERVAL (see
667
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
668 669

INTERVAL
670
next_interval (register INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
671 672
{
  register INTERVAL i = interval;
673
  register EMACS_INT next_position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692

  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))
	{
693
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
694 695 696 697
	  i->position = next_position;
	  return i;
	}

698
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
699 700 701 702 703 704
    }

  return NULL_INTERVAL;
}

/* Find the preceding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
705
   Sets the `position' field based on that of INTERVAL (see
706
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
707 708

INTERVAL
709
previous_interval (register INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730
{
  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))
	{
731
	  i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
732 733 734 735

	  i->position = interval->position - LENGTH (i);
	  return i;
	}
736
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
737 738 739 740
    }

  return NULL_INTERVAL;
}
741 742

/* Find the interval containing POS given some non-NULL INTERVAL
743
   in the same tree.  Note that we need to update interval->position
744 745 746
   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.  */
747
INTERVAL
748
update_interval (register INTERVAL i, EMACS_INT pos)
749 750 751 752
{
  if (NULL_INTERVAL_P (i))
    return NULL_INTERVAL;

Juanma Barranquero's avatar
Juanma Barranquero committed
753
  while (1)
754
    {
Juanma Barranquero's avatar
Juanma Barranquero committed
755
      if (pos < i->position)
756 757
	{
	  /* Move left. */
Juanma Barranquero's avatar
Juanma Barranquero committed
758
	  if (pos >= i->position - TOTAL_LENGTH (i->left))
759 760 761 762 763
	    {
	      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
764
	  else if (NULL_PARENT (i))
765
	    error ("Point before start of properties");
Juanma Barranquero's avatar
Juanma Barranquero committed
766
	  else
767
	      i = INTERVAL_PARENT (i);
768 769 770 771 772
	  continue;
	}
      else if (pos >= INTERVAL_LAST_POS (i))
	{
	  /* Move right. */
Juanma Barranquero's avatar
Juanma Barranquero committed
773
	  if (pos < INTERVAL_LAST_POS (i) + TOTAL_LENGTH (i->right))
774
	    {
775 776
	      i->right->position = INTERVAL_LAST_POS (i)
	        + LEFT_TOTAL_LENGTH (i->right);
777 778
	      i = i->right;		/* Move to the right child */
	    }
Juanma Barranquero's avatar
Juanma Barranquero committed
779
	  else if (NULL_PARENT (i))
780
	    error ("Point %d after end of properties", pos);
Juanma Barranquero's avatar
Juanma Barranquero committed
781
	  else
782
            i = INTERVAL_PARENT (i);
783 784
	  continue;
	}
Juanma Barranquero's avatar
Juanma Barranquero committed
785
      else
786 787 788 789
	return i;
    }
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
790

Joseph Arceneaux's avatar
Joseph Arceneaux committed
791
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
792 793 794 795 796 797 798 799 800
/* 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
801
   and check the hungry bits of both.  Then add the length going back up
802
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826

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;
827
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
828 829 830 831 832 833 834 835
	  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;
836
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
837 838 839 840 841
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
842
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
843
	  this->total_length += length;
844
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
845 846 847 848 849 850
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
851 852 853 854
#endif

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
855
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
856 857 858 859 860 861
   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
862
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
863
   interval.  Another possibility would be to create a new interval for
864
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
865 866

static INTERVAL
867 868
adjust_intervals_for_insertion (INTERVAL tree,
				EMACS_INT position, EMACS_INT length)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
869 870
{
  register INTERVAL i;
871 872
  register INTERVAL temp;
  int eobp = 0;
873
  Lisp_Object parent;
874
  EMACS_INT offset;
Juanma Barranquero's avatar
Juanma Barranquero committed
875

Joseph Arceneaux's avatar
Joseph Arceneaux committed
876 877 878
  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

879
  GET_INTERVAL_OBJECT (parent, tree);
880 881
  offset = (BUFFERP (parent) ? BUF_BEG (XBUFFER (parent)) : 0);

882 883
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
884 885 886 887 888
  if (position >= TOTAL_LENGTH (tree) + offset)
    {
      position = TOTAL_LENGTH (tree) + offset;
      eobp = 1;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
889 890

  i = find_interval (tree, position);
891

892 893
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
894 895 896 897 898 899 900 901 902 903
     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))
904
    {
905 906 907
      Lisp_Object tail;
      Lisp_Object front, rear;

908 909 910 911 912 913 914 915 916 917 918
      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;
	}
919
      front = textget (i->plist, Qfront_sticky);
920 921 922 923 924 925
      if (! CONSP (front) && ! NILP (front))
	{
	  /* All properties are sticky.  We don't split the interval.  */
	  tail = Qnil;
	  goto check_done;
	}
926

927 928 929
      /* 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)))
930
	{
931
	  Lisp_Object prop, tmp;
932
	  prop = XCAR (tail);
933

934
	  /* Is this particular property front-sticky?  */
935 936 937
	  if (CONSP (front) && ! NILP (Fmemq (prop, front)))
	    continue;

938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953
	  /* 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.  */
954 955
	}

956
    check_done:
957 958 959 960 961 962 963
      /* 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;
	}
964 965
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
966
  /* If we are positioned between intervals, check the stickiness of
967 968
     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
969
    {
970 971 972 973 974 975 976 977 978 979 980
      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
981

982 983
      /* Even if we are positioned between intervals, we default
	 to the left one if it exists.  We extend it now and split