intervals.c 71.8 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 55
static Lisp_Object merge_properties_sticky (Lisp_Object, Lisp_Object);
static INTERVAL merge_interval_right (INTERVAL);
56 57
static INTERVAL reproduce_tree (INTERVAL, INTERVAL);
static INTERVAL reproduce_tree_obj (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

INTERVAL
65
create_root_interval (Lisp_Object parent)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
66
{
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

  return new;
}

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

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

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

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

  MERGE_INTERVAL_CACHE (source, target);

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

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

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

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

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

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

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

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

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

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

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

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

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

void
225
traverse_intervals (INTERVAL tree, EMACS_INT position,
226
		    void (*function) (INTERVAL, Lisp_Object), 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
316
rotate_right (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
317 318 319
{
  INTERVAL i;
  INTERVAL B = interval->left;
320
  EMACS_INT old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
321

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

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

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

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

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

  return B;
}
352

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  return interval;
}

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

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

/* Advertised interface to balance intervals.  */

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

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

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

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

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

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

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

532 533
  balance_possible_root_interval (interval);

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

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

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

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

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

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

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

  return new;
}

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!  */

590
static int
591
interval_start_pos (INTERVAL source)
592 593 594 595 596 597
{
  Lisp_Object parent;

  if (NULL_INTERVAL_P (source))
    return 0;

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

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

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

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

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

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

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

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

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

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

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

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

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

  return NULL_INTERVAL;
}

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

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

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

  return NULL_INTERVAL;
}
742 743

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
791

Joseph Arceneaux's avatar
Joseph Arceneaux committed
792
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
793 794 795 796 797 798 799 800 801
/* 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
802
   and check the hungry bits of both.  Then add the length going back up
803
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
804 805 806 807

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
808
     EMACS_INT position, length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
809
{
810
  register EMACS_INT relative_position;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827
  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;
828
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
829 830 831 832 833 834 835 836
	  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;
837
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
838 839 840 841 842
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
843
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
844
	  this->total_length += length;
845
	  CHECK_TOTAL_LENGTH (this);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
846 847 848 849 850 851
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
852 853 854 855
#endif

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

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

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

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

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

  i = find_interval (tree, position);
892

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

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

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

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

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
967
  /* If we are positioned between intervals, check the stickiness of
968 969
     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
970
    {
971 972 973