intervals.c 69 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
2
   Copyright (C) 1993-1995, 1997-1998, 2001-2012  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>
42
#include <intprops.h>
Joseph Arceneaux's avatar
Joseph Arceneaux committed
43 44
#include "lisp.h"
#include "intervals.h"
45
#include "character.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
46
#include "buffer.h"
Richard M. Stallman's avatar
Richard M. Stallman committed
47
#include "puresize.h"
Karl Heuer's avatar
Karl Heuer committed
48
#include "keyboard.h"
Stefan Monnier's avatar
Stefan Monnier committed
49
#include "keymap.h"
Joseph Arceneaux's avatar
Joseph Arceneaux committed
50

51 52 53 54 55
/* 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))

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


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

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

  CHECK_IMPURE (parent);

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

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

91
  interval_set_object (new, parent);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
92 93 94 95 96 97 98

  return new;
}

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

void
99
copy_properties (register INTERVAL source, register INTERVAL target)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
100 101 102 103 104
{
  if (DEFAULT_INTERVAL_P (source) && DEFAULT_INTERVAL_P (target))
    return;

  COPY_INTERVAL_CACHE (source, target);
105
  interval_set_plist (target, Fcopy_sequence (source->plist));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
106 107 108
}

/* Merge the properties of interval SOURCE into the properties
109 110
   of interval TARGET.  That is to say, each property in SOURCE
   is added to TARGET if TARGET has no such property as yet.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
111 112

static void
113
merge_properties (register INTERVAL source, register INTERVAL target)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
114 115 116 117 118 119 120 121 122
{
  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);
141
	  interval_set_plist (target, Fcons (sym, Fcons (val, target->plist)));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
142
	}
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

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

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

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

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

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

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

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

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

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

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

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

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

246
/* These functions are temporary, for debugging purposes only.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
247 248 249 250

INTERVAL search_interval, found_interval;

void
Andreas Schwab's avatar
Andreas Schwab committed
251
check_for_interval (INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
252 253 254 255 256 257 258 259 260
{
  if (i == search_interval)
    {
      found_interval = i;
      icount++;
    }
}

INTERVAL
Andreas Schwab's avatar
Andreas Schwab committed
261
search_for_interval (INTERVAL i, INTERVAL tree)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
262 263 264 265
{
  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
  return found_interval;
}

static void
Andreas Schwab's avatar
Andreas Schwab committed
271
inc_interval_count (INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
272 273 274 275 276 277 278 279 280
{
  icount++;
  if (LENGTH (i) == 0)
    zero_length++;
  if (depth > idepth)
    idepth = depth;
}

int
Andreas Schwab's avatar
Andreas Schwab committed
281
count_intervals (INTERVAL i)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
282 283 284 285
{
  icount = 0;
  idepth = 0;
  zero_length = 0;
286
  traverse_intervals_noorder (i, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
287 288 289 290 291

  return icount;
}

static INTERVAL
Andreas Schwab's avatar
Andreas Schwab committed
292
root_interval (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
293 294 295 296
{
  register INTERVAL i = interval;

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

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

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

Paul Eggert's avatar
Paul Eggert committed
312
static inline INTERVAL
313
rotate_right (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
314 315 316
{
  INTERVAL i;
  INTERVAL B = interval->left;
317
  ptrdiff_t old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
318

319
  /* Deal with any Parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
320
  if (! ROOT_INTERVAL_P (interval))
321 322
    {
      if (AM_LEFT_CHILD (interval))
323
	interval_set_left (INTERVAL_PARENT (interval), B);
324
      else
325
	interval_set_right (INTERVAL_PARENT (interval), B);
326
    }
327
  interval_copy_parent (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
328

329 330
  /* Make B the parent of A */
  i = B->right;
331 332
  interval_set_right (B, interval);
  interval_set_parent (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
333

334
  /* Make A point to c */
335
  interval_set_left (interval, i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
336
  if (! NULL_INTERVAL_P (i))
337
    interval_set_parent (i, interval);
338

339
  /* A's total length is decreased by the length of B and its left child.  */
340
  interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);
341
  eassert (0 <= TOTAL_LENGTH (interval));
342 343 344

  /* B must have the same total length of A.  */
  B->total_length = old_total;
345
  eassert (0 <= TOTAL_LENGTH (B));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
346 347 348

  return B;
}
349

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

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

Paul Eggert's avatar
Paul Eggert committed
359
static inline INTERVAL
360
rotate_left (INTERVAL interval)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
361 362 363
{
  INTERVAL i;
  INTERVAL B = interval->right;
364
  ptrdiff_t old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
365

366
  /* Deal with any parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
367
  if (! ROOT_INTERVAL_P (interval))
368 369
    {
      if (AM_LEFT_CHILD (interval))
370
	interval_set_left (INTERVAL_PARENT (interval), B);
371
      else
372
	interval_set_right (INTERVAL_PARENT (interval), B);
373
    }
374
  interval_copy_parent (B, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
375 376

  /* Make B the parent of A */
377
  i = B->left;
378 379
  interval_set_left (B, interval);
  interval_set_parent (interval, B);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
380 381

  /* Make A point to c */
382
  interval_set_right (interval, i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
383
  if (! NULL_INTERVAL_P (i))
384
    interval_set_parent (i, interval);
385

386
  /* A's total length is decreased by the length of B and its right child.  */
387
  interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);
388
  eassert (0 <= TOTAL_LENGTH (interval));
389 390 391

  /* B must have the same total length of A.  */
  B->total_length = old_total;
392
  eassert (0 <= TOTAL_LENGTH (B));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
393 394 395 396

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

static INTERVAL
401
balance_an_interval (INTERVAL i)
402
{
403
  register ptrdiff_t old_diff, new_diff;
404 405 406 407 408 409

  while (1)
    {
      old_diff = LEFT_TOTAL_LENGTH (i) - RIGHT_TOTAL_LENGTH (i);
      if (old_diff > 0)
	{
410
	  /* Since the left child is longer, there must be one.  */
411 412
	  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
413
	  if (eabs (new_diff) >= old_diff)
414 415 416 417 418 419
	    break;
	  i = rotate_right (i);
	  balance_an_interval (i->right);
	}
      else if (old_diff < 0)
	{
420
	  /* Since the right child is longer, there must be one.  */
421 422
	  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
423
	  if (eabs (new_diff) >= -old_diff)
424 425 426 427 428 429 430 431 432 433 434 435 436
	    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.  */

Paul Eggert's avatar
Paul Eggert committed
437
static inline INTERVAL
438
balance_possible_root_interval (register INTERVAL interval)
439 440
{
  Lisp_Object parent;
441
  int have_parent = 0;
442

443
  if (!INTERVAL_HAS_OBJECT (interval) && !INTERVAL_HAS_PARENT (interval))
444 445
    return interval;

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

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

  return interval;
}

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

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

/* Advertised interface to balance intervals.  */

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

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

   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
498 499

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

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

509
  new->position = position + offset;
510
  interval_set_parent (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511

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

529 530
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
531 532 533
  return new;
}

534 535 536 537
/* 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
538

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

INTERVAL
548
split_interval_left (INTERVAL interval, ptrdiff_t offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
549 550
{
  INTERVAL new = make_interval ();
551
  ptrdiff_t new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
552 553

  new->position = interval->position;
554
  interval->position = interval->position + offset;
555
  interval_set_parent (new, interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
556 557 558

  if (NULL_LEFT_CHILD (interval))
    {
559
      interval_set_left (interval, new);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
560
      new->total_length = new_length;
561
      eassert (0 <= TOTAL_LENGTH (new));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
562
    }
563 564 565
  else
    {
      /* Insert the new node between INTERVAL and its left child.  */
566 567 568
      interval_set_left (new, interval->left);
      interval_set_parent (new->left, new);
      interval_set_left (interval, new);
569
      new->total_length = new_length + new->left->total_length;
570
      eassert (0 <= TOTAL_LENGTH (new));
571 572
      balance_an_interval (new);
    }
Juanma Barranquero's avatar
Juanma Barranquero committed
573

574
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
575 576 577 578

  return new;
}

579 580 581 582 583 584 585 586
/* 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!  */

587
static int
588
interval_start_pos (INTERVAL source)
589 590 591 592 593 594
{
  Lisp_Object parent;

  if (NULL_INTERVAL_P (source))
    return 0;

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

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

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

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

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

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

632
  eassert (relative_position <= TOTAL_LENGTH (tree));
Joseph Arceneaux's avatar
Joseph Arceneaux committed
633

634 635
  if (!handling_signal)
    tree = balance_possible_root_interval (tree);
636

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

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

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

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

695
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
696 697 698 699 700 701
    }

  return NULL_INTERVAL;
}

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

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

	  i->position = interval->position - LENGTH (i);
	  return i;
	}
733
      i = INTERVAL_PARENT (i);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
734 735 736 737
    }

  return NULL_INTERVAL;
}
738 739

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

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

Joseph Arceneaux's avatar
Joseph Arceneaux committed
787 788
/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
789
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
790 791 792 793 794 795
   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
796
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
797
   interval.  Another possibility would be to create a new interval for
798
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
799 800

static INTERVAL
801
adjust_intervals_for_insertion (INTERVAL tree,
802
				ptrdiff_t position, ptrdiff_t length)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
803 804
{
  register INTERVAL i;
805 806
  register INTERVAL temp;
  int eobp = 0;
807
  Lisp_Object parent;
808
  ptrdiff_t offset;
Juanma Barranquero's avatar
Juanma Barranquero committed
809

810
  eassert (TOTAL_LENGTH (tree) > 0);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
811

812
  GET_INTERVAL_OBJECT (parent, tree);
813 814
  offset = (BUFFERP (parent) ? BUF_BEG (XBUFFER (parent)) : 0);

815 816
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
817 818 819 820 821
  if (position >= TOTAL_LENGTH (tree) + offset)
    {
      position = TOTAL_LENGTH (tree) + offset;
      eobp = 1;
    }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
822 823

  i = find_interval (tree, position);
824

825 826
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
827 828 829 830 831 832 833 834 835 836
     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))
837
    {
838 839 840
      Lisp_Object tail;
      Lisp_Object front, rear;

841 842 843 844 845 846 847 848 849 850 851
      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;
	}
852
      front = textget (i->plist, Qfront_sticky);
853 854 855 856 857 858
      if (! CONSP (front) && ! NILP (front))
	{
	  /* All properties are sticky.  We don't split the interval.  */
	  tail = Qnil;
	  goto check_done;
	}
859

860 861 862
      /* 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)))
863
	{
864
	  Lisp_Object prop, tmp;
865
	  prop = XCAR (tail);
866

867
	  /* Is this particular property front-sticky?  */
868 869 870
	  if (CONSP (front) && ! NILP (Fmemq (prop, front)))
	    continue;

871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886
	  /* 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.  */
887 888
	}

889
    check_done:
890 891 892 893 894 895 896
      /* 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;
	}
897 898
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
899
  /* If we are positioned between intervals, check the stickiness of
900 901
     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
902
    {
903 904 905 906 907 908 909 910 911 912 913
      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
914

915 916
      /* 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
917
	 off a part later, if stickiness demands it.  */
918
      for (temp = prev ? prev : i; temp; temp = INTERVAL_PARENT_OR_NULL (temp))