intervals.c 50.5 KB
Newer Older
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1
/* Code for doing intervals.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1993, 1994, 1995 Free Software Foundation, Inc.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
3 4 5 6 7

This file is part of GNU Emacs.

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

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

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41


/* NOTES:

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

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

   Need to call *_left_hook when buffer is killed.

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

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

*/


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

49
/* The rest of the file is within this conditional.  */
50 51
#ifdef USE_TEXT_PROPERTIES

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

57 58
#define min(x, y) ((x) < (y) ? (x) : (y))

59
Lisp_Object merge_properties_sticky ();
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 67 68 69

INTERVAL
create_root_interval (parent)
     Lisp_Object parent;
{
Richard M. Stallman's avatar
Richard M. Stallman committed
70 71 72 73 74
  INTERVAL new;

  CHECK_IMPURE (parent);

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

76
  if (BUFFERP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
77
    {
78 79
      new->total_length = (BUF_Z (XBUFFER (parent))
			   - BUF_BEG (XBUFFER (parent)));
80
      BUF_INTERVALS (XBUFFER (parent)) = new;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
81
    }
82
  else if (STRINGP (parent))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107
    {
      new->total_length = XSTRING (parent)->size;
      XSTRING (parent)->intervals = new;
    }

  new->parent = (INTERVAL) parent;
  new->position = 1;

  return new;
}

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

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

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

/* Merge the properties of interval SOURCE into the properties
108 109
   of interval TARGET.  That is to say, each property in SOURCE
   is added to TARGET if TARGET has no such property as yet.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140

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

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

  MERGE_INTERVAL_CACHE (source, target);

  o = source->plist;
  while (! EQ (o, Qnil))
    {
      sym = Fcar (o);
      val = Fmemq (sym, target->plist);

      if (NILP (val))
	{
	  o = Fcdr (o);
	  val = Fcar (o);
	  target->plist = Fcons (sym, Fcons (val, target->plist));
	  o = Fcdr (o);
	}
      else
	o = Fcdr (Fcdr (o));
    }
}

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

int
intervals_equal (i0, i1)
     INTERVAL i0, i1;
{
  register Lisp_Object i0_cdr, i0_sym, i1_val;
  register i1_len;

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

153 154 155
  if (DEFAULT_INTERVAL_P (i0) || DEFAULT_INTERVAL_P (i1))
    return 0;

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

      i0_sym = Fcar (i0_cdr);
      i1_val = Fmemq (i0_sym, i1->plist);

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

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

      i0_cdr = Fcdr (i0_cdr);
      i1_len--;
    }

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

  return 1;
}

static int icount;
static int idepth;
static int zero_length;

/* Traverse an interval tree TREE, performing FUNCTION on each node.
195
   Pass FUNCTION two args: an interval, and ARG.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
196 197

void
198
traverse_intervals (tree, position, depth, function, arg)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
199
     INTERVAL tree;
200
     int position, depth;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
201
     void (* function) ();
202
     Lisp_Object arg;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
203 204 205 206
{
  if (NULL_INTERVAL_P (tree))
    return;

207
  traverse_intervals (tree->left, position, depth + 1, function, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
208 209
  position += LEFT_TOTAL_LENGTH (tree);
  tree->position = position;
210
  (*function) (tree, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
211
  position += LENGTH (tree);
212
  traverse_intervals (tree->right, position, depth + 1,  function, arg);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
213 214 215
}

#if 0
216
/* These functions are temporary, for debugging purposes only.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237

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;
238
  traverse_intervals (tree, 1, 0, &check_for_interval, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
  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;
260
  traverse_intervals (i, 1, 0, &inc_interval_count, Qnil);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

  return icount;
}

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

  while (! ROOT_INTERVAL_P (i))
    i = i->parent;

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

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

static INTERVAL
rotate_right (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->left;
293
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
294

295
  /* Deal with any Parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
296 297
  if (! ROOT_INTERVAL_P (interval))
    if (AM_LEFT_CHILD (interval))
298
      interval->parent->left = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
299
    else
300 301
      interval->parent->right = B;
  B->parent = interval->parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
302

303 304 305 306
  /* Make B the parent of A */
  i = B->right;
  B->right = interval;
  interval->parent = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
307

308
  /* Make A point to c */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
309 310 311
  interval->left = i;
  if (! NULL_INTERVAL_P (i))
    i->parent = interval;
312

313
  /* A's total length is decreased by the length of B and its left child.  */
314 315 316 317
  interval->total_length -= B->total_length - LEFT_TOTAL_LENGTH (interval);

  /* B must have the same total length of A.  */
  B->total_length = old_total;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
318 319 320

  return B;
}
321

Joseph Arceneaux's avatar
Joseph Arceneaux committed
322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
/* Assuming that a right child exists, perform the following operation:

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

static INTERVAL
rotate_left (interval)
     INTERVAL interval;
{
  INTERVAL i;
  INTERVAL B = interval->right;
337
  int old_total = interval->total_length;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
338

339
  /* Deal with any parent of A;  make it point to B.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
340 341
  if (! ROOT_INTERVAL_P (interval))
    if (AM_LEFT_CHILD (interval))
342
      interval->parent->left = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
343
    else
344 345
      interval->parent->right = B;
  B->parent = interval->parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
346 347

  /* Make B the parent of A */
348 349 350
  i = B->left;
  B->left = interval;
  interval->parent = B;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
351 352 353 354 355

  /* Make A point to c */
  interval->right = i;
  if (! NULL_INTERVAL_P (i))
    i->parent = interval;
356

357
  /* A's total length is decreased by the length of B and its right child.  */
358 359 360 361
  interval->total_length -= B->total_length - RIGHT_TOTAL_LENGTH (interval);

  /* B must have the same total length of A.  */
  B->total_length = old_total;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
362 363 364 365

  return B;
}

366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416
/* Balance an interval tree with the assumption that the subtrees
   themselves are already balanced.  */

static INTERVAL
balance_an_interval (i)
     INTERVAL i;
{
  register int old_diff, new_diff;

  while (1)
    {
      old_diff = LEFT_TOTAL_LENGTH (i) - RIGHT_TOTAL_LENGTH (i);
      if (old_diff > 0)
	{
	  new_diff = i->total_length - i->left->total_length
	    + RIGHT_TOTAL_LENGTH (i->left) - LEFT_TOTAL_LENGTH (i->left);
	  if (abs (new_diff) >= old_diff)
	    break;
	  i = rotate_right (i);
	  balance_an_interval (i->right);
	}
      else if (old_diff < 0)
	{
	  new_diff = i->total_length - i->right->total_length
	    + LEFT_TOTAL_LENGTH (i->right) - RIGHT_TOTAL_LENGTH (i->right);
	  if (abs (new_diff) >= -old_diff)
	    break;
	  i = rotate_left (i);
	  balance_an_interval (i->left);
	}
      else
	break;
    }
  return i;
}

/* Balance INTERVAL, potentially stuffing it back into its parent
   Lisp Object.  */

static INLINE INTERVAL
balance_possible_root_interval (interval)
     register INTERVAL interval;
{
  Lisp_Object parent;

  if (interval->parent == NULL_INTERVAL)
    return interval;

  parent = (Lisp_Object) (interval->parent);
  interval = balance_an_interval (interval);

417
  if (BUFFERP (parent))
418
    BUF_INTERVALS (XBUFFER (parent)) = interval;
419
  else if (STRINGP (parent))
420 421 422 423 424 425 426 427 428 429 430 431 432 433
    XSTRING (parent)->intervals = interval;

  return interval;
}

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

static INTERVAL
balance_intervals_internal (tree)
     register INTERVAL tree;
{
  /* Balance within each side.  */
  if (tree->left)
434
    balance_intervals_internal (tree->left);
435
  if (tree->right)
436
    balance_intervals_internal (tree->right);
437 438 439 440 441 442 443 444 445 446 447 448 449 450 451
  return balance_an_interval (tree);
}

/* Advertised interface to balance intervals.  */

INTERVAL
balance_intervals (tree)
     INTERVAL tree;
{
  if (tree == NULL_INTERVAL)
    return NULL_INTERVAL;

  return balance_intervals_internal (tree);
}

452 453 454 455
/* 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
456 457 458 459 460

   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
461 462

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

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
466
split_interval_right (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
467
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
468
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
469 470 471
{
  INTERVAL new = make_interval ();
  int position = interval->position;
472
  int new_length = LENGTH (interval) - offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
473

474
  new->position = position + offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
475 476
  new->parent = interval;

477
  if (NULL_RIGHT_CHILD (interval))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
478 479 480 481 482 483 484
    {
      interval->right = new;
      new->total_length = new_length;

      return new;
    }

485
  /* Insert the new node between INTERVAL and its right child.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
486 487 488 489 490
  new->right = interval->right;
  interval->right->parent = new;
  interval->right = new;
  new->total_length = new_length + new->right->total_length;

491 492 493
  balance_an_interval (new);
  balance_possible_root_interval (interval);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
494 495 496
  return new;
}

497 498 499 500
/* 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
501

Joseph Arceneaux's avatar
Joseph Arceneaux committed
502 503 504 505 506 507
   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,
508
   it is still a root after this operation.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
509 510

INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
511
split_interval_left (interval, offset)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
512
     INTERVAL interval;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
513
     int offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
514 515 516
{
  INTERVAL new = make_interval ();
  int position = interval->position;
517
  int new_length = offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
518 519

  new->position = interval->position;
520
  interval->position = interval->position + offset;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
521 522 523 524 525 526 527 528 529 530
  new->parent = interval;

  if (NULL_LEFT_CHILD (interval))
    {
      interval->left = new;
      new->total_length = new_length;

      return new;
    }

531
  /* Insert the new node between INTERVAL and its left child.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
532 533 534
  new->left = interval->left;
  new->left->parent = new;
  interval->left = new;
535 536 537 538
  new->total_length = new_length + new->left->total_length;

  balance_an_interval (new);
  balance_possible_root_interval (interval);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
539 540 541 542

  return new;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
543
/* Find the interval containing text position POSITION in the text
544 545 546
   represented by the interval tree TREE.  POSITION is a buffer
   position; the earliest position is 1.  If POSITION is at the end of
   the buffer, return the interval containing the last character.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
547

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

INLINE INTERVAL
Joseph Arceneaux's avatar
Joseph Arceneaux committed
553 554 555 556
find_interval (tree, position)
     register INTERVAL tree;
     register int position;
{
557 558 559
  /* The distance from the left edge of the subtree at TREE
                    to POSITION.  */
  register int relative_position = position - BEG;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
560 561 562 563

  if (NULL_INTERVAL_P (tree))
    return NULL_INTERVAL;

564
  if (relative_position > TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
565 566
    abort ();			/* Paranoia */

567 568
  tree = balance_possible_root_interval (tree);

Joseph Arceneaux's avatar
Joseph Arceneaux committed
569 570
  while (1)
    {
571
      if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
572 573 574
	{
	  tree = tree->left;
	}
575 576 577
      else if (! NULL_RIGHT_CHILD (tree)
	       && relative_position >= (TOTAL_LENGTH (tree)
					- RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
578 579 580 581 582 583 584
	{
	  relative_position -= (TOTAL_LENGTH (tree)
				- RIGHT_TOTAL_LENGTH (tree));
	  tree = tree->right;
	}
      else
	{
585 586 587 588
	  tree->position =
	    (position - relative_position /* the left edge of *tree */
	     + LEFT_TOTAL_LENGTH (tree)); /* the left edge of this interval */

Joseph Arceneaux's avatar
Joseph Arceneaux committed
589 590 591 592 593 594
	  return tree;
	}
    }
}

/* Find the succeeding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
595
   Sets the `position' field based on that of INTERVAL (see
596
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634

INTERVAL
next_interval (interval)
     register INTERVAL interval;
{
  register INTERVAL i = interval;
  register int next_position;

  if (NULL_INTERVAL_P (i))
    return NULL_INTERVAL;
  next_position = interval->position + LENGTH (interval);

  if (! NULL_RIGHT_CHILD (i))
    {
      i = i->right;
      while (! NULL_LEFT_CHILD (i))
	i = i->left;

      i->position = next_position;
      return i;
    }

  while (! NULL_PARENT (i))
    {
      if (AM_LEFT_CHILD (i))
	{
	  i = i->parent;
	  i->position = next_position;
	  return i;
	}

      i = i->parent;
    }

  return NULL_INTERVAL;
}

/* Find the preceding interval (lexicographically) to INTERVAL.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
635
   Sets the `position' field based on that of INTERVAL (see
636
   find_interval).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673

INTERVAL
previous_interval (interval)
     register INTERVAL interval;
{
  register INTERVAL i;
  register position_of_previous;

  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))
	{
	  i = i->parent;

	  i->position = interval->position - LENGTH (i);
	  return i;
	}
      i = i->parent;
    }

  return NULL_INTERVAL;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
674
#if 0
Joseph Arceneaux's avatar
Joseph Arceneaux committed
675 676 677 678 679 680 681 682 683
/* 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
684
   and check the hungry bits of both.  Then add the length going back up
685
   to the root.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722

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;
	  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;
	  this = this->right;
	}
      else
	{
	  /* If we are to use zero-length intervals as buffer pointers,
723
	     then this code will have to change.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
724 725 726 727 728 729 730
	  this->total_length += length;
	  this->position = LEFT_TOTAL_LENGTH (this)
	                   + position - relative_position + 1;
	  return tree;
	}
    }
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
731 732 733 734
#endif

/* Effect an adjustment corresponding to the addition of LENGTH characters
   of text.  Do this by finding the interval containing POSITION in the
735
   interval tree TREE, and then adjusting all of its ancestors by adding
Joseph Arceneaux's avatar
Joseph Arceneaux committed
736 737 738 739 740 741
   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
742
   If both intervals are "sticky", then make them belong to the left-most
Joseph Arceneaux's avatar
Joseph Arceneaux committed
743
   interval.  Another possibility would be to create a new interval for
744
   this text, and make it have the merged properties of both ends.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
745 746 747 748 749 750 751

static INTERVAL
adjust_intervals_for_insertion (tree, position, length)
     INTERVAL tree;
     int position, length;
{
  register INTERVAL i;
752 753 754
  register INTERVAL temp;
  int eobp = 0;
  
Joseph Arceneaux's avatar
Joseph Arceneaux committed
755 756 757
  if (TOTAL_LENGTH (tree) == 0)	/* Paranoia */
    abort ();

758 759
  /* If inserting at point-max of a buffer, that position will be out
     of range.  Remember that buffer positions are 1-based.  */
760
  if (position >= BEG + TOTAL_LENGTH (tree)){
761
    position = BEG + TOTAL_LENGTH (tree);
762 763
    eobp = 1;
  }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
764 765

  i = find_interval (tree, position);
766

767 768 769 770 771 772 773 774 775 776 777 778
  /* If in middle of an interval which is not sticky either way,
     we must not just give its properties to the insertion.
     So split this interval at the insertion point.  */
  if (! (position == i->position || eobp)
      && END_NONSTICKY_P (i)
      && ! FRONT_STICKY_P (i))
    {
      temp = split_interval_right (i, position - i->position);
      copy_properties (i, temp);
      i = temp;
    }

Joseph Arceneaux's avatar
Joseph Arceneaux committed
779
  /* If we are positioned between intervals, check the stickiness of
780 781
     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
782
    {
783 784 785 786 787 788 789 790 791 792 793
      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
794

795 796
      /* 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
797
	 off a part later, if stickiness demands it.  */
798 799 800 801 802
      for (temp = prev ? prev : i;! NULL_INTERVAL_P (temp); temp = temp->parent)
	{
	  temp->total_length += length;
	  temp = balance_possible_root_interval (temp);
	}
803 804
      
      /* If at least one interval has sticky properties,
Karl Heuer's avatar
Karl Heuer committed
805
	 we check the stickiness property by property.  */
806 807
      if (END_NONSTICKY_P (prev) || FRONT_STICKY_P (i))
	{
808
	  Lisp_Object pleft, pright;
809 810
	  struct interval newi;

811 812
	  pleft = NULL_INTERVAL_P (prev) ? Qnil : prev->plist;
	  pright = NULL_INTERVAL_P (i) ? Qnil : i->plist;
813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840
	  newi.plist = merge_properties_sticky (pleft, pright);

	  if(! prev) /* i.e. position == BEG */
	    {
	      if (! intervals_equal (i, &newi))
		{
		  i = split_interval_left (i, length);
		  i->plist = newi.plist;
		}
	    }
	  else if (! intervals_equal (prev, &newi))
	    {
	      prev = split_interval_right (prev,
					   position - prev->position);
	      prev->plist = newi.plist;
	      if (! NULL_INTERVAL_P (i)
		  && intervals_equal (prev, i))
		merge_interval_right (prev);
	    }

	  /* We will need to update the cache here later.  */
	}
      else if (! prev && ! NILP (i->plist))
        {
	  /* Just split off a new interval at the left.
	     Since I wasn't front-sticky, the empty plist is ok.  */
	  i = split_interval_left (i, length);
        }
Joseph Arceneaux's avatar
Joseph Arceneaux committed
841 842
    }

843 844
  /* Otherwise just extend the interval.  */
  else
Joseph Arceneaux's avatar
Joseph Arceneaux committed
845
    {
846
      for (temp = i; ! NULL_INTERVAL_P (temp); temp = temp->parent)
847 848 849 850
	{
	  temp->total_length += length;
	  temp = balance_possible_root_interval (temp);
	}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
851
    }
852
      
Joseph Arceneaux's avatar
Joseph Arceneaux committed
853 854
  return tree;
}
855

856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894
/* Any property might be front-sticky on the left, rear-sticky on the left,
   front-sticky on the right, or rear-sticky on the right; the 16 combinations
   can be arranged in a matrix with rows denoting the left conditions and
   columns denoting the right conditions:
      _  __  _
_     FR FR FR FR
FR__   0  1  2  3
 _FR   4  5  6  7
FR     8  9  A  B
  FR   C  D  E  F

   left-props  = '(front-sticky (p8 p9 pa pb pc pd pe pf)
		   rear-nonsticky (p4 p5 p6 p7 p8 p9 pa pb)
		   p0 L p1 L p2 L p3 L p4 L p5 L p6 L p7 L
		   p8 L p9 L pa L pb L pc L pd L pe L pf L)
   right-props = '(front-sticky (p2 p3 p6 p7 pa pb pe pf)
		   rear-nonsticky (p1 p2 p5 p6 p9 pa pd pe)
		   p0 R p1 R p2 R p3 R p4 R p5 R p6 R p7 R
		   p8 R p9 R pa R pb R pc R pd R pe R pf R)

   We inherit from whoever has a sticky side facing us.  If both sides
   do (cases 2, 3, E, and F), then we inherit from whichever side has a
   non-nil value for the current property.  If both sides do, then we take
   from the left.

   When we inherit a property, we get its stickiness as well as its value.
   So, when we merge the above two lists, we expect to get this:

   result      = '(front-sticky (p6 p7 pa pb pc pd pe pf)
		   rear-nonsticky (p6 pa)
		   p0 L p1 L p2 L p3 L p6 R p7 R
		   pa R pb R pc L pd L pe L pf L)

   The optimizable special cases are:
       left rear-nonsticky = nil, right front-sticky = nil (inherit left)
       left rear-nonsticky = t,   right front-sticky = t   (inherit right)
       left rear-nonsticky = t,   right front-sticky = nil (inherit none)
*/

895 896 897 898
Lisp_Object
merge_properties_sticky (pleft, pright)
     Lisp_Object pleft, pright;
{
899 900
  register Lisp_Object props, front, rear;
  Lisp_Object lfront, lrear, rfront, rrear;
901 902
  register Lisp_Object tail1, tail2, sym, lval, rval;
  int use_left, use_right;
903

904 905 906 907 908 909 910 911
  props = Qnil;
  front = Qnil;
  rear  = Qnil;
  lfront = textget (pleft, Qfront_sticky);
  lrear  = textget (pleft, Qrear_nonsticky);
  rfront = textget (pright, Qfront_sticky);
  rrear  = textget (pright, Qrear_nonsticky);

912 913
  /* Go through each element of PRIGHT.  */
  for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
914 915 916 917 918 919
    {
      sym = Fcar (tail1);

      /* Sticky properties get special treatment.  */
      if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
	continue;
920 921 922 923 924 925 926 927 928 929 930 931 932 933 934

      rval = Fcar (Fcdr (tail1));
      for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
	if (EQ (sym, Fcar (tail2)))
	  break;
      lval = (NILP (tail2) ? Qnil : Fcar( Fcdr (tail2)));

      use_left = ! TMEM (sym, lrear);
      use_right = TMEM (sym, rfront);
      if (use_left && use_right)
	{
	  use_left = ! NILP (lval);
	  use_right = ! NILP (rval);
	}
      if (use_left)
935
	{
936 937 938 939 940
	  /* We build props as (value sym ...) rather than (sym value ...)
	     because we plan to nreverse it when we're done.  */
	  if (! NILP (lval))
	    props = Fcons (lval, Fcons (sym, props));
	  if (TMEM (sym, lfront))
941
	    front = Fcons (sym, front);
942 943
	  if (TMEM (sym, lrear))
	    rear = Fcons (sym, rear);
944
	}
945
      else if (use_right)
946
	{
947 948 949 950 951 952
	  if (! NILP (rval))
	    props = Fcons (rval, Fcons (sym, props));
	  if (TMEM (sym, rfront))
	    front = Fcons (sym, front);
	  if (TMEM (sym, rrear))
	    rear = Fcons (sym, rear);
953 954
	}
    }
955 956 957

  /* Now go through each element of PLEFT.  */
  for (tail2 = pleft; ! NILP (tail2); tail2 = Fcdr (Fcdr (tail2)))
958 959 960 961 962 963 964
    {
      sym = Fcar (tail2);

      /* Sticky properties get special treatment.  */
      if (EQ (sym, Qrear_nonsticky) || EQ (sym, Qfront_sticky))
	continue;

965 966
      /* If sym is in PRIGHT, we've already considered it.  */
      for (tail1 = pright; ! NILP (tail1); tail1 = Fcdr (Fcdr (tail1)))
967 968
	if (EQ (sym, Fcar (tail1)))
	  break;
969 970 971 972 973 974 975
      if (! NILP (tail1))
	continue;

      lval = Fcar (Fcdr (tail2));

      /* Since rval is known to be nil in this loop, the test simplifies.  */
      if (! TMEM (sym, lrear))
976
	{
977 978 979 980 981 982 983 984 985
	  if (! NILP (lval))
	    props = Fcons (lval, Fcons (sym, props));
	  if (TMEM (sym, lfront))
	    front = Fcons (sym, front);
	}
      else if (TMEM (sym, rfront))
	{
	  /* The value is nil, but we still inherit the stickiness
	     from the right.  */
986
	  front = Fcons (sym, front);
987
	  if (TMEM (sym, rrear))
988 989 990
	    rear = Fcons (sym, rear);
	}
    }
991
  props = Fnreverse (props);
992
  if (! NILP (rear))
993
    props = Fcons (Qrear_nonsticky, Fcons (Fnreverse (rear), props));
994 995
  if (! NILP (front))
    props = Fcons (Qfront_sticky, Fcons (Fnreverse (front), props));
996 997 998
  return props;
}

Joseph Arceneaux's avatar
Joseph Arceneaux committed
999

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1000 1001
/* Delete an node I from its interval tree by merging its subtrees
   into one subtree which is then returned.  Caller is responsible for
1002
   storing the resulting subtree into its parent.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034

static INTERVAL
delete_node (i)
     register INTERVAL i;
{
  register INTERVAL migrate, this;
  register int migrate_amt;

  if (NULL_INTERVAL_P (i->left))
    return i->right;
  if (NULL_INTERVAL_P (i->right))
    return i->left;

  migrate = i->left;
  migrate_amt = i->left->total_length;
  this = i->right;
  this->total_length += migrate_amt;
  while (! NULL_INTERVAL_P (this->left))
    {
      this = this->left;
      this->total_length += migrate_amt;
    }
  this->left = migrate;
  migrate->parent = this;

  return i->right;
}

/* Delete interval I from its tree by calling `delete_node'
   and properly connecting the resultant subtree.

   I is presumed to be empty; that is, no adjustments are made
1035
   for the length of I.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1036 1037 1038 1039 1040 1041 1042 1043

void
delete_interval (i)
     register INTERVAL i;
{
  register INTERVAL parent;
  int amt = LENGTH (i);

1044
  if (amt > 0)			/* Only used on zero-length intervals now.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1045 1046 1047 1048
    abort ();

  if (ROOT_INTERVAL_P (i))
    {
1049 1050
      Lisp_Object owner;
      owner = (Lisp_Object) i->parent;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1051 1052 1053 1054
      parent = delete_node (i);
      if (! NULL_INTERVAL_P (parent))
	parent->parent = (INTERVAL) owner;

1055
      if (BUFFERP (owner))
1056
	BUF_INTERVALS (XBUFFER (owner)) = parent;
1057
      else if (STRINGP (owner))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079
	XSTRING (owner)->intervals = parent;
      else
	abort ();

      return;
    }

  parent = i->parent;
  if (AM_LEFT_CHILD (i))
    {
      parent->left = delete_node (i);
      if (! NULL_INTERVAL_P (parent->left))
	parent->left->parent = parent;
    }
  else
    {
      parent->right = delete_node (i);
      if (! NULL_INTERVAL_P (parent->right))
	parent->right->parent = parent;
    }
}

1080 1081 1082 1083 1084 1085 1086 1087
/* Find the interval in TREE corresponding to the relative position
   FROM and delete as much as possible of AMOUNT from that interval.
   Return the amount actually deleted, and if the interval was
   zeroed-out, delete that interval node from the tree.

   Note that FROM is actually origin zero, aka relative to the
   leftmost edge of tree.  This is appropriate since we call ourselves
   recursively on subtrees.
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1088

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1089
   Do this by recursing down TREE to the interval in question, and
1090
   deleting the appropriate amount of text.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102

static int
interval_deletion_adjustment (tree, from, amount)
     register INTERVAL tree;
     register int from, amount;
{
  register int relative_position = from;

  if (NULL_INTERVAL_P (tree))
    return 0;

  /* Left branch */
1103
  if (relative_position < LEFT_TOTAL_LENGTH (tree))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1104 1105 1106 1107 1108 1109 1110 1111
    {
      int subtract = interval_deletion_adjustment (tree->left,
						   relative_position,
						   amount);
      tree->total_length -= subtract;
      return subtract;
    }
  /* Right branch */
1112 1113
  else if (relative_position >= (TOTAL_LENGTH (tree)
				 - RIGHT_TOTAL_LENGTH (tree)))
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124
    {
      int subtract;

      relative_position -= (tree->total_length
			    - RIGHT_TOTAL_LENGTH (tree));
      subtract = interval_deletion_adjustment (tree->right,
					       relative_position,
					       amount);
      tree->total_length -= subtract;
      return subtract;
    }
1125
  /* Here -- this node.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1126 1127
  else
    {
1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140
      /* How much can we delete from this interval?  */
      int my_amount = ((tree->total_length 
			- RIGHT_TOTAL_LENGTH (tree))
		       - relative_position);

      if (amount > my_amount)
	amount = my_amount;

      tree->total_length -= amount;
      if (LENGTH (tree) == 0)
	delete_interval (tree);
      
      return amount;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1141 1142
    }

1143
  /* Never reach here.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1144 1145
}

1146 1147 1148
/* Effect the adjustments necessary to the interval tree of BUFFER to
   correspond to the deletion of LENGTH characters from that buffer
   text.  The deletion is effected at position START (which is a
1149
   buffer position, i.e. origin 1).  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1150

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1151 1152 1153 1154 1155 1156
static void
adjust_intervals_for_deletion (buffer, start, length)
     struct buffer *buffer;
     int start, length;
{
  register int left_to_delete = length;
1157
  register INTERVAL tree = BUF_INTERVALS (buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1158 1159 1160 1161 1162
  register int deleted;

  if (NULL_INTERVAL_P (tree))
    return;

1163 1164 1165 1166
  if (start > BEG + TOTAL_LENGTH (tree)
      || start + length > BEG + TOTAL_LENGTH (tree))
    abort ();

Joseph Arceneaux's avatar
Joseph Arceneaux committed
1167 1168
  if (length == TOTAL_LENGTH (tree))
    {
1169
      BUF_INTERVALS (buffer) = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1170 1171 1172 1173 1174 1175 1176 1177 1178
      return;
    }

  if (ONLY_INTERVAL_P (tree))
    {
      tree->total_length -= length;
      return;
    }

1179 1180
  if (start > BEG + TOTAL_LENGTH (tree))
    start = BEG + TOTAL_LENGTH (tree);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1181 1182
  while (left_to_delete > 0)
    {
1183
      left_to_delete -= interval_deletion_adjustment (tree, start - 1,
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1184
						      left_to_delete);
1185
      tree = BUF_INTERVALS (buffer);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1186 1187
      if (left_to_delete == tree->total_length)
	{
1188
	  BUF_INTERVALS (buffer) = NULL_INTERVAL;
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1189 1190 1191 1192 1193
	  return;
	}
    }
}

1194
/* Make the adjustments necessary to the interval tree of BUFFER to
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1195 1196
   represent an addition or deletion of LENGTH characters starting
   at position START.  Addition or deletion is indicated by the sign
1197
   of LENGTH.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1198 1199 1200 1201 1202 1203

INLINE void
offset_intervals (buffer, start, length)
     struct buffer *buffer;
     int start, length;
{
1204
  if (NULL_INTERVAL_P (BUF_INTERVALS (buffer)) || length == 0)
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1205 1206 1207
    return;

  if (length > 0)
1208
    adjust_intervals_for_insertion (BUF_INTERVALS (buffer), start, length);
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1209 1210 1211
  else
    adjust_intervals_for_deletion (buffer, start, -length);
}
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1212 1213 1214 1215 1216 1217 1218 1219

/* Merge interval I with its lexicographic successor. The resulting
   interval is returned, and has the properties of the original
   successor.  The properties of I are lost.  I is removed from the
   interval tree.

   IMPORTANT:
   The caller must verify that this is not the last (rightmost)
1220
   interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1221 1222 1223 1224 1225 1226 1227 1228

INTERVAL
merge_interval_right (i)
     register INTERVAL i;
{
  register int absorb = LENGTH (i);
  register INTERVAL successor;

1229
  /* Zero out this interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1230 1231
  i->total_length -= absorb;

1232
  /* Find the succeeding interval.  */
Joseph Arceneaux's avatar
Joseph Arceneaux committed
1233
  if (! NULL_RIGHT_CHILD (i))      /* It's below us.  Add absorb