marker.c 23 KB
Newer Older
1
/* Markers: examining, setting and deleting.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985, 1997, 1998 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy 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
Karl Heuer's avatar
Karl Heuer committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy 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.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
Jim Blandy's avatar
Jim Blandy committed
23 24
#include "lisp.h"
#include "buffer.h"
25
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
26

27 28 29 30 31 32 33
/* Record one cached position found recently by
   buf_charpos_to_bytepos or buf_bytepos_to_charpos.  */

static int cached_charpos;
static int cached_bytepos;
static struct buffer *cached_buffer;
static int cached_modiff;
34

35 36
static void byte_char_debug_check P_ ((struct buffer *, int, int));

37 38 39 40
/* Nonzero means enable debugging checks on byte/char correspondences.  */

static int byte_debug_flag;

Andreas Schwab's avatar
Andreas Schwab committed
41
void
42 43 44 45 46 47
clear_charpos_cache (b)
     struct buffer *b;
{
  if (cached_buffer == b)
    cached_buffer = 0;
}
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67

/* Converting between character positions and byte positions.  */

/* There are several places in the buffer where we know
   the corrspondence: BEG, BEGV, PT, GPT, ZV and Z,
   and everywhere there is a marker.  So we find the one of these places
   that is closest to the specified position, and scan from there.  */

/* charpos_to_bytepos returns the byte position corresponding to CHARPOS.  */

/* This macro is a subroutine of charpos_to_bytepos.
   Note that it is desirable that BYTEPOS is not evaluated
   except when we really want its value.  */

#define CONSIDER(CHARPOS, BYTEPOS)					\
{									\
  int this_charpos = (CHARPOS);						\
  int changed = 0;							\
									\
  if (this_charpos == charpos)						\
68 69 70 71 72 73
    {									\
      int value = (BYTEPOS);						\
      if (byte_debug_flag)						\
	byte_char_debug_check (b, charpos, value);			\
      return value;							\
    }									\
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92
  else if (this_charpos > charpos)					\
    {									\
      if (this_charpos < best_above)					\
	{								\
	  best_above = this_charpos;					\
	  best_above_byte = (BYTEPOS);					\
	  changed = 1;							\
	}								\
    }									\
  else if (this_charpos > best_below)					\
    {									\
      best_below = this_charpos;					\
      best_below_byte = (BYTEPOS);					\
      changed = 1;							\
    }									\
									\
  if (changed)								\
    {									\
      if (best_above - best_below == best_above_byte - best_below_byte)	\
93 94 95 96 97 98
        {								\
	  int value = best_below_byte + (charpos - best_below);		\
	  if (byte_debug_flag)						\
	    byte_char_debug_check (b, charpos, value);			\
	  return value;							\
	}								\
99 100 101
    }									\
}

102
static void
103 104 105 106 107 108 109 110
byte_char_debug_check (b, charpos, bytepos)
     struct buffer *b;
     int charpos, bytepos;
{
  int nchars = 0;

  if (bytepos > BUF_GPT_BYTE (b))
    {
111 112 113 114
      nchars = multibyte_chars_in_text (BUF_BEG_ADDR (b),
					BUF_GPT_BYTE (b) - BUF_BEG_BYTE (b));
      nchars += multibyte_chars_in_text (BUF_GAP_END_ADDR (b),
					 bytepos - BUF_GPT_BYTE (b));
115 116
    }
  else
117 118
    nchars = multibyte_chars_in_text (BUF_BEG_ADDR (b),
				      bytepos - BUF_BEG_BYTE (b));
119 120 121 122 123

  if (charpos - 1 != nchars)
    abort ();
}

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
int
charpos_to_bytepos (charpos)
     int charpos;
{
  return buf_charpos_to_bytepos (current_buffer, charpos);
}

int
buf_charpos_to_bytepos (b, charpos)
     struct buffer *b;
     int charpos;
{
  Lisp_Object tail;
  int best_above, best_above_byte;
  int best_below, best_below_byte;

  if (charpos < BUF_BEG (b) || charpos > BUF_Z (b))
    abort ();

  best_above = BUF_Z (b);
  best_above_byte = BUF_Z_BYTE (b);

  /* If this buffer has as many characters as bytes,
     each character must be one byte.
     This takes care of the case where enable-multibyte-characters is nil.  */
  if (best_above == best_above_byte)
    return charpos;

152 153
  best_below = BEG;
  best_below_byte = BEG_BYTE;
154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172

  /* We find in best_above and best_above_byte
     the closest known point above CHARPOS,
     and in best_below and best_below_byte
     the closest known point below CHARPOS,

     If at any point we can tell that the space between those
     two best approximations is all single-byte,
     we interpolate the result immediately.  */

  CONSIDER (BUF_PT (b), BUF_PT_BYTE (b));
  CONSIDER (BUF_GPT (b), BUF_GPT_BYTE (b));
  CONSIDER (BUF_BEGV (b), BUF_BEGV_BYTE (b));
  CONSIDER (BUF_ZV (b), BUF_ZV_BYTE (b));

  if (b == cached_buffer && BUF_MODIFF (b) == cached_modiff)
    CONSIDER (cached_charpos, cached_bytepos);

  tail = BUF_MARKERS (b);
173
  while (! NILP (tail))
174
    {
175
      CONSIDER (XMARKER (tail)->charpos, XMARKER (tail)->bytepos);
176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204

      /* If we are down to a range of 50 chars,
	 don't bother checking any other markers;
	 scan the intervening chars directly now.  */
      if (best_above - best_below < 50)
	break;

      tail = XMARKER (tail)->chain;
    }

  /* We get here if we did not exactly hit one of the known places.
     We have one known above and one known below.
     Scan, counting characters, from whichever one is closer.  */

  if (charpos - best_below < best_above - charpos)
    {
      int record = charpos - best_below > 5000;

      while (best_below != charpos)
	{
	  best_below++;
	  BUF_INC_POS (b, best_below_byte);
	}

      /* If this position is quite far from the nearest known position,
	 cache the correspondence by creating a marker here.
	 It will last until the next GC.  */
      if (record)
	{
205
	  Lisp_Object marker, buffer;
206
	  marker = Fmake_marker ();
207 208
	  XSETBUFFER (buffer, b);
	  set_marker_both (marker, buffer, best_below, best_below_byte);
209 210
	}

211 212 213
      if (byte_debug_flag)
	byte_char_debug_check (b, charpos, best_below_byte);

214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235
      cached_buffer = b;
      cached_modiff = BUF_MODIFF (b);
      cached_charpos = best_below;
      cached_bytepos = best_below_byte;

      return best_below_byte;
    }
  else
    {
      int record = best_above - charpos > 5000;

      while (best_above != charpos)
	{
	  best_above--;
	  BUF_DEC_POS (b, best_above_byte);
	}

      /* If this position is quite far from the nearest known position,
	 cache the correspondence by creating a marker here.
	 It will last until the next GC.  */
      if (record)
	{
236
	  Lisp_Object marker, buffer;
237
	  marker = Fmake_marker ();
238 239
	  XSETBUFFER (buffer, b);
	  set_marker_both (marker, buffer, best_above, best_above_byte);
240 241
	}

242 243 244
      if (byte_debug_flag)
	byte_char_debug_check (b, charpos, best_above_byte);

245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
      cached_buffer = b;
      cached_modiff = BUF_MODIFF (b);
      cached_charpos = best_above;
      cached_bytepos = best_above_byte;

      return best_above_byte;
    }
}

#undef CONSIDER

/* bytepos_to_charpos returns the char position corresponding to BYTEPOS.  */

/* This macro is a subroutine of bytepos_to_charpos.
   It is used when BYTEPOS is actually the byte position.  */

#define CONSIDER(BYTEPOS, CHARPOS)					\
{									\
  int this_bytepos = (BYTEPOS);						\
  int changed = 0;							\
									\
  if (this_bytepos == bytepos)						\
267 268 269 270 271 272
    {									\
      int value = (CHARPOS);						\
      if (byte_debug_flag)						\
	byte_char_debug_check (b, value, bytepos);			\
      return value;							\
    }									\
273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291
  else if (this_bytepos > bytepos)					\
    {									\
      if (this_bytepos < best_above_byte)				\
	{								\
	  best_above = (CHARPOS);					\
	  best_above_byte = this_bytepos;				\
	  changed = 1;							\
	}								\
    }									\
  else if (this_bytepos > best_below_byte)				\
    {									\
      best_below = (CHARPOS);						\
      best_below_byte = this_bytepos;					\
      changed = 1;							\
    }									\
									\
  if (changed)								\
    {									\
      if (best_above - best_below == best_above_byte - best_below_byte)	\
292 293 294 295 296 297
	{								\
	  int value = best_below + (bytepos - best_below_byte);		\
	  if (byte_debug_flag)						\
	    byte_char_debug_check (b, value, bytepos);			\
	  return value;							\
	}								\
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328
    }									\
}

int
bytepos_to_charpos (bytepos)
     int bytepos;
{
  return buf_bytepos_to_charpos (current_buffer, bytepos);
}

int
buf_bytepos_to_charpos (b, bytepos)
     struct buffer *b;
     int bytepos;
{
  Lisp_Object tail;
  int best_above, best_above_byte;
  int best_below, best_below_byte;

  if (bytepos < BUF_BEG_BYTE (b) || bytepos > BUF_Z_BYTE (b))
    abort ();

  best_above = BUF_Z (b);
  best_above_byte = BUF_Z_BYTE (b);

  /* If this buffer has as many characters as bytes,
     each character must be one byte.
     This takes care of the case where enable-multibyte-characters is nil.  */
  if (best_above == best_above_byte)
    return bytepos;

329 330
  best_below = BEG;
  best_below_byte = BEG_BYTE;
331 332 333 334 335 336 337 338 339 340

  CONSIDER (BUF_PT_BYTE (b), BUF_PT (b));
  CONSIDER (BUF_GPT_BYTE (b), BUF_GPT (b));
  CONSIDER (BUF_BEGV_BYTE (b), BUF_BEGV (b));
  CONSIDER (BUF_ZV_BYTE (b), BUF_ZV (b));

  if (b == cached_buffer && BUF_MODIFF (b) == cached_modiff)
    CONSIDER (cached_bytepos, cached_charpos);

  tail = BUF_MARKERS (b);
341
  while (! NILP (tail))
342
    {
343
      CONSIDER (XMARKER (tail)->bytepos, XMARKER (tail)->charpos);
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

      /* If we are down to a range of 50 chars,
	 don't bother checking any other markers;
	 scan the intervening chars directly now.  */
      if (best_above - best_below < 50)
	break;

      tail = XMARKER (tail)->chain;
    }

  /* We get here if we did not exactly hit one of the known places.
     We have one known above and one known below.
     Scan, counting characters, from whichever one is closer.  */

  if (bytepos - best_below_byte < best_above_byte - bytepos)
    {
360
      int record = bytepos - best_below_byte > 5000;
361 362 363 364 365 366 367 368 369

      while (best_below_byte < bytepos)
	{
	  best_below++;
	  BUF_INC_POS (b, best_below_byte);
	}

      /* If this position is quite far from the nearest known position,
	 cache the correspondence by creating a marker here.
370 371 372 373
	 It will last until the next GC.
	 But don't do it if BUF_MARKERS is nil;
	 that is a signal from Fset_buffer_multibyte.  */
      if (record && ! NILP (BUF_MARKERS (b)))
374
	{
375
	  Lisp_Object marker, buffer;
376
	  marker = Fmake_marker ();
377 378
	  XSETBUFFER (buffer, b);
	  set_marker_both (marker, buffer, best_below, best_below_byte);
379 380
	}

381 382 383
      if (byte_debug_flag)
	byte_char_debug_check (b, best_below, bytepos);

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402
      cached_buffer = b;
      cached_modiff = BUF_MODIFF (b);
      cached_charpos = best_below;
      cached_bytepos = best_below_byte;

      return best_below;
    }
  else
    {
      int record = best_above_byte - bytepos > 5000;

      while (best_above_byte > bytepos)
	{
	  best_above--;
	  BUF_DEC_POS (b, best_above_byte);
	}

      /* If this position is quite far from the nearest known position,
	 cache the correspondence by creating a marker here.
403 404 405 406
	 It will last until the next GC.
	 But don't do it if BUF_MARKERS is nil;
	 that is a signal from Fset_buffer_multibyte.  */
      if (record && ! NILP (BUF_MARKERS (b)))
407
	{
408
	  Lisp_Object marker, buffer;
409
	  marker = Fmake_marker ();
410 411
	  XSETBUFFER (buffer, b);
	  set_marker_both (marker, buffer, best_above, best_above_byte);
412 413
	}

414 415 416
      if (byte_debug_flag)
	byte_char_debug_check (b, best_above, bytepos);

417 418 419 420 421 422 423 424 425 426 427
      cached_buffer = b;
      cached_modiff = BUF_MODIFF (b);
      cached_charpos = best_above;
      cached_bytepos = best_above_byte;

      return best_above;
    }
}

#undef CONSIDER

Jim Blandy's avatar
Jim Blandy committed
428 429 430
/* Operations on markers. */

DEFUN ("marker-buffer", Fmarker_buffer, Smarker_buffer, 1, 1, 0,
431 432 433
       doc: /* Return the buffer that MARKER points into, or nil if none.
Returns nil if MARKER points into a dead buffer.  */)
     (marker)
Jim Blandy's avatar
Jim Blandy committed
434 435 436
     register Lisp_Object marker;
{
  register Lisp_Object buf;
437
  CHECK_MARKER (marker);
Jim Blandy's avatar
Jim Blandy committed
438 439
  if (XMARKER (marker)->buffer)
    {
440
      XSETBUFFER (buf, XMARKER (marker)->buffer);
Jim Blandy's avatar
Jim Blandy committed
441
      /* Return marker's buffer only if it is not dead.  */
Jim Blandy's avatar
Jim Blandy committed
442
      if (!NILP (XBUFFER (buf)->name))
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446 447 448
	return buf;
    }
  return Qnil;
}

DEFUN ("marker-position", Fmarker_position, Smarker_position, 1, 1, 0,
449 450
       doc: /* Return the position MARKER points at, as a character number.  */)
     (marker)
Jim Blandy's avatar
Jim Blandy committed
451 452
     Lisp_Object marker;
{
453
  CHECK_MARKER (marker);
Jim Blandy's avatar
Jim Blandy committed
454
  if (XMARKER (marker)->buffer)
455
    return make_number (XMARKER (marker)->charpos);
Jim Blandy's avatar
Jim Blandy committed
456 457 458

  return Qnil;
}
459

Jim Blandy's avatar
Jim Blandy committed
460
DEFUN ("set-marker", Fset_marker, Sset_marker, 2, 3, 0,
461 462 463 464 465 466
       doc: /* Position MARKER before character number POSITION in BUFFER.
BUFFER defaults to the current buffer.
If POSITION is nil, makes marker point nowhere.
Then it no longer slows down editing in any buffer.
Returns MARKER.  */)
     (marker, position, buffer)
467
     Lisp_Object marker, position, buffer;
Jim Blandy's avatar
Jim Blandy committed
468
{
469
  register int charno, bytepos;
Jim Blandy's avatar
Jim Blandy committed
470 471 472
  register struct buffer *b;
  register struct Lisp_Marker *m;

473
  CHECK_MARKER (marker);
Jim Blandy's avatar
Jim Blandy committed
474 475
  /* If position is nil or a marker that points nowhere,
     make this marker point nowhere.  */
476 477
  if (NILP (position)
      || (MARKERP (position) && !XMARKER (position)->buffer))
Jim Blandy's avatar
Jim Blandy committed
478 479 480 481 482
    {
      unchain_marker (marker);
      return marker;
    }

Jim Blandy's avatar
Jim Blandy committed
483
  if (NILP (buffer))
Jim Blandy's avatar
Jim Blandy committed
484 485 486
    b = current_buffer;
  else
    {
487
      CHECK_BUFFER (buffer);
Jim Blandy's avatar
Jim Blandy committed
488 489 490 491 492 493 494 495 496 497 498
      b = XBUFFER (buffer);
      /* If buffer is dead, set marker to point nowhere.  */
      if (EQ (b->name, Qnil))
	{
	  unchain_marker (marker);
	  return marker;
	}
    }

  m = XMARKER (marker);

499 500 501 502 503
  /* Optimize the special case where we are copying the position
     of an existing marker, and MARKER is already in the same buffer.  */
  if (MARKERP (position) && b == XMARKER (position)->buffer
      && b == m->buffer)
    {
504
      m->bytepos = XMARKER (position)->bytepos;
505 506 507 508
      m->charpos = XMARKER (position)->charpos;
      return marker;
    }

509
  CHECK_NUMBER_COERCE_MARKER (position);
510 511 512

  charno = XINT (position);

Jim Blandy's avatar
Jim Blandy committed
513 514 515 516
  if (charno < BUF_BEG (b))
    charno = BUF_BEG (b);
  if (charno > BUF_Z (b))
    charno = BUF_Z (b);
517 518 519 520 521 522 523

  bytepos = buf_charpos_to_bytepos (b, charno);

  /* Every character is at least one byte.  */
  if (charno > bytepos)
    abort ();

524
  m->bytepos = bytepos;
525
  m->charpos = charno;
Jim Blandy's avatar
Jim Blandy committed
526 527 528 529 530

  if (m->buffer != b)
    {
      unchain_marker (marker);
      m->buffer = b;
531 532
      m->chain = BUF_MARKERS (b);
      BUF_MARKERS (b) = marker;
Jim Blandy's avatar
Jim Blandy committed
533 534 535 536 537 538 539 540 541 542 543 544
    }
  
  return marker;
}

/* This version of Fset_marker won't let the position
   be outside the visible part.  */

Lisp_Object 
set_marker_restricted (marker, pos, buffer)
     Lisp_Object marker, pos, buffer;
{
545
  register int charno, bytepos;
Jim Blandy's avatar
Jim Blandy committed
546 547 548
  register struct buffer *b;
  register struct Lisp_Marker *m;

549
  CHECK_MARKER (marker);
Jim Blandy's avatar
Jim Blandy committed
550 551
  /* If position is nil or a marker that points nowhere,
     make this marker point nowhere.  */
552 553
  if (NILP (pos)
      || (MARKERP (pos) && !XMARKER (pos)->buffer))
Jim Blandy's avatar
Jim Blandy committed
554 555 556 557 558
    {
      unchain_marker (marker);
      return marker;
    }

Jim Blandy's avatar
Jim Blandy committed
559
  if (NILP (buffer))
Jim Blandy's avatar
Jim Blandy committed
560 561 562
    b = current_buffer;
  else
    {
563
      CHECK_BUFFER (buffer);
Jim Blandy's avatar
Jim Blandy committed
564 565 566 567 568 569 570 571 572 573 574
      b = XBUFFER (buffer);
      /* If buffer is dead, set marker to point nowhere.  */
      if (EQ (b->name, Qnil))
	{
	  unchain_marker (marker);
	  return marker;
	}
    }

  m = XMARKER (marker);

575 576 577 578 579
  /* Optimize the special case where we are copying the position
     of an existing marker, and MARKER is already in the same buffer.  */
  if (MARKERP (pos) && b == XMARKER (pos)->buffer
      && b == m->buffer)
    {
580
      m->bytepos = XMARKER (pos)->bytepos;
581 582 583 584
      m->charpos = XMARKER (pos)->charpos;
      return marker;
    }

585
  CHECK_NUMBER_COERCE_MARKER (pos);
586 587 588

  charno = XINT (pos);

Jim Blandy's avatar
Jim Blandy committed
589 590 591 592
  if (charno < BUF_BEGV (b))
    charno = BUF_BEGV (b);
  if (charno > BUF_ZV (b))
    charno = BUF_ZV (b);
593 594 595 596 597 598 599

  bytepos = buf_charpos_to_bytepos (b, charno);

  /* Every character is at least one byte.  */
  if (charno > bytepos)
    abort ();

600
  m->bytepos = bytepos;
601
  m->charpos = charno;
Jim Blandy's avatar
Jim Blandy committed
602 603 604 605 606

  if (m->buffer != b)
    {
      unchain_marker (marker);
      m->buffer = b;
607 608
      m->chain = BUF_MARKERS (b);
      BUF_MARKERS (b) = marker;
Jim Blandy's avatar
Jim Blandy committed
609 610 611 612
    }
  
  return marker;
}
613 614 615

/* Set the position of MARKER, specifying both the
   character position and the corresponding byte position.  */
Jim Blandy's avatar
Jim Blandy committed
616

617 618 619 620 621 622 623 624
Lisp_Object 
set_marker_both (marker, buffer, charpos, bytepos)
     Lisp_Object marker, buffer;
     int charpos, bytepos;
{
  register struct buffer *b;
  register struct Lisp_Marker *m;

625
  CHECK_MARKER (marker);
626 627 628 629 630

  if (NILP (buffer))
    b = current_buffer;
  else
    {
631
      CHECK_BUFFER (buffer);
632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650
      b = XBUFFER (buffer);
      /* If buffer is dead, set marker to point nowhere.  */
      if (EQ (b->name, Qnil))
	{
	  unchain_marker (marker);
	  return marker;
	}
    }

  m = XMARKER (marker);

  /* In a single-byte buffer, the two positions must be equal.  */
  if (BUF_Z (b) == BUF_Z_BYTE (b)
      && charpos != bytepos)
    abort ();
  /* Every character is at least one byte.  */
  if (charpos > bytepos)
    abort ();

651
  m->bytepos = bytepos;
652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675
  m->charpos = charpos;

  if (m->buffer != b)
    {
      unchain_marker (marker);
      m->buffer = b;
      m->chain = BUF_MARKERS (b);
      BUF_MARKERS (b) = marker;
    }
  
  return marker;
}

/* This version of set_marker_both won't let the position
   be outside the visible part.  */

Lisp_Object 
set_marker_restricted_both (marker, buffer, charpos, bytepos)
     Lisp_Object marker, buffer;
     int charpos, bytepos;
{
  register struct buffer *b;
  register struct Lisp_Marker *m;

676
  CHECK_MARKER (marker);
677 678 679 680 681

  if (NILP (buffer))
    b = current_buffer;
  else
    {
682
      CHECK_BUFFER (buffer);
683 684 685 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
      b = XBUFFER (buffer);
      /* If buffer is dead, set marker to point nowhere.  */
      if (EQ (b->name, Qnil))
	{
	  unchain_marker (marker);
	  return marker;
	}
    }

  m = XMARKER (marker);

  if (charpos < BUF_BEGV (b))
    charpos = BUF_BEGV (b);
  if (charpos > BUF_ZV (b))
    charpos = BUF_ZV (b);
  if (bytepos < BUF_BEGV_BYTE (b))
    bytepos = BUF_BEGV_BYTE (b);
  if (bytepos > BUF_ZV_BYTE (b))
    bytepos = BUF_ZV_BYTE (b);

  /* In a single-byte buffer, the two positions must be equal.  */
  if (BUF_Z (b) == BUF_Z_BYTE (b)
      && charpos != bytepos)
    abort ();
  /* Every character is at least one byte.  */
  if (charpos > bytepos)
    abort ();

711
  m->bytepos = bytepos;
712 713 714 715 716 717 718 719 720 721 722 723 724
  m->charpos = charpos;

  if (m->buffer != b)
    {
      unchain_marker (marker);
      m->buffer = b;
      m->chain = BUF_MARKERS (b);
      BUF_MARKERS (b) = marker;
    }
  
  return marker;
}

Richard M. Stallman's avatar
Richard M. Stallman committed
725 726 727 728
/* Remove MARKER from the chain of whatever buffer it is in.
   Leave it "in no buffer".

   This is called during garbage collection,
Jim Blandy's avatar
Jim Blandy committed
729 730 731
   so we must be careful to ignore and preserve mark bits,
   including those in chain fields of markers.  */

732
void
Jim Blandy's avatar
Jim Blandy committed
733 734 735 736
unchain_marker (marker)
     register Lisp_Object marker;
{
  register Lisp_Object tail, prev, next;
737
  register EMACS_INT omark;
Jim Blandy's avatar
Jim Blandy committed
738 739 740 741 742 743 744 745 746
  register struct buffer *b;

  b = XMARKER (marker)->buffer;
  if (b == 0)
    return;

  if (EQ (b->name, Qnil))
    abort ();

747 748
  XMARKER (marker)->buffer = 0;

749
  tail = BUF_MARKERS (b);
Jim Blandy's avatar
Jim Blandy committed
750
  prev = Qnil;
751
  while (! GC_NILP (tail))
Jim Blandy's avatar
Jim Blandy committed
752 753 754 755 756 757
    {
      next = XMARKER (tail)->chain;
      XUNMARK (next);

      if (XMARKER (marker) == XMARKER (tail))
	{
Jim Blandy's avatar
Jim Blandy committed
758
	  if (NILP (prev))
Jim Blandy's avatar
Jim Blandy committed
759
	    {
760 761 762
	      BUF_MARKERS (b) = next;
	      /* Deleting first marker from the buffer's chain.  Crash
		 if new first marker in chain does not say it belongs
763 764 765
		 to the same buffer, or at least that they have the same
		 base buffer.  */
	      if (!NILP (next) && b->text != XMARKER (next)->buffer->text)
Jim Blandy's avatar
Jim Blandy committed
766 767 768 769 770 771 772 773
		abort ();
	    }
	  else
	    {
	      omark = XMARKBIT (XMARKER (prev)->chain);
	      XMARKER (prev)->chain = next;
	      XSETMARKBIT (XMARKER (prev)->chain, omark);
	    }
774 775 776
	  /* We have removed the marker from the chain;
	     no need to scan the rest of the chain.  */
	  return;
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781
	}
      else
	prev = tail;
      tail = next;
    }
782 783 784

  /* Marker was not in its chain.  */
  abort ();
Jim Blandy's avatar
Jim Blandy committed
785 786
}

787
/* Return the char position of marker MARKER, as a C integer.  */
788 789

int
Jim Blandy's avatar
Jim Blandy committed
790 791 792 793 794
marker_position (marker)
     Lisp_Object marker;
{
  register struct Lisp_Marker *m = XMARKER (marker);
  register struct buffer *buf = m->buffer;
795 796 797 798 799 800 801 802 803 804 805 806 807 808 809

  if (!buf)
    error ("Marker does not point anywhere");

  return m->charpos;
}

/* Return the byte position of marker MARKER, as a C integer.  */

int
marker_byte_position (marker)
     Lisp_Object marker;
{
  register struct Lisp_Marker *m = XMARKER (marker);
  register struct buffer *buf = m->buffer;
810
  register int i = m->bytepos;
Jim Blandy's avatar
Jim Blandy committed
811 812 813 814

  if (!buf)
    error ("Marker does not point anywhere");

815
  if (i < BUF_BEG_BYTE (buf) || i > BUF_Z_BYTE (buf))
Jim Blandy's avatar
Jim Blandy committed
816 817 818 819
    abort ();

  return i;
}
820 821

DEFUN ("copy-marker", Fcopy_marker, Scopy_marker, 1, 2, 0,
822 823 824 825 826 827
       doc: /* Return a new marker pointing at the same place as MARKER.
If argument is a number, makes a new marker pointing
at that position in the current buffer.
The optional argument TYPE specifies the insertion type of the new marker;
see `marker-insertion-type'.  */)
     (marker, type)
828
     register Lisp_Object marker, type;
Jim Blandy's avatar
Jim Blandy committed
829 830 831
{
  register Lisp_Object new;

832
  if (! (INTEGERP (marker) || MARKERP (marker)))
833
    marker = wrong_type_argument (Qinteger_or_marker_p, marker);
834 835 836 837 838 839

  new = Fmake_marker ();
  Fset_marker (new, marker,
	       (MARKERP (marker) ? Fmarker_buffer (marker) : Qnil));
  XMARKER (new)->insertion_type = !NILP (type);
  return new;
840 841 842 843
}

DEFUN ("marker-insertion-type", Fmarker_insertion_type,
       Smarker_insertion_type, 1, 1, 0,
844 845 846
       doc: /* Return insertion type of MARKER: t if it stays after inserted text.
nil means the marker stays before text inserted there.  */)
     (marker)
847 848
     register Lisp_Object marker;
{
849
  CHECK_MARKER (marker);
850 851 852 853 854
  return XMARKER (marker)->insertion_type ? Qt : Qnil;
}

DEFUN ("set-marker-insertion-type", Fset_marker_insertion_type,
       Sset_marker_insertion_type, 2, 2, 0,
855 856 857 858
       doc: /* Set the insertion-type of MARKER to TYPE.
If TYPE is t, it means the marker advances when you insert text at it.
If TYPE is nil, it means the marker stays behind when you insert text at it.  */)
     (marker, type)
859 860
     Lisp_Object marker, type;
{
861
  CHECK_MARKER (marker);
862 863 864

  XMARKER (marker)->insertion_type = ! NILP (type);
  return type;
Jim Blandy's avatar
Jim Blandy committed
865
}
866 867

DEFUN ("buffer-has-markers-at", Fbuffer_has_markers_at, Sbuffer_has_markers_at,
868 869 870 871
       1, 1, 0,
       doc: /* Return t if there are markers pointing at POSITION in the current buffer.  */)
     (position)
     Lisp_Object position;
872 873 874 875 876 877 878 879 880 881 882 883
{
  register Lisp_Object tail;
  register int charno;

  charno = XINT (position);

  if (charno < BEG)
    charno = BEG;
  if (charno > Z)
    charno = Z;

  for (tail = BUF_MARKERS (current_buffer);
884
       !NILP (tail);
885
       tail = XMARKER (tail)->chain)
886
    if (XMARKER (tail)->charpos == charno)
887 888 889 890
      return Qt;

  return Qnil;
}
891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907

/* For debugging -- count the markers in buffer BUF.  */

int
count_markers (buf)
     struct buffer *buf;
{
  int total = 0;
  Lisp_Object tail;

  for (tail = BUF_MARKERS (buf);
       !NILP (tail);
       tail = XMARKER (tail)->chain)
    total++;

  return total;
}
Jim Blandy's avatar
Jim Blandy committed
908

909
void
Jim Blandy's avatar
Jim Blandy committed
910 911 912 913 914 915
syms_of_marker ()
{
  defsubr (&Smarker_position);
  defsubr (&Smarker_buffer);
  defsubr (&Sset_marker);
  defsubr (&Scopy_marker);
916 917
  defsubr (&Smarker_insertion_type);
  defsubr (&Sset_marker_insertion_type);
918
  defsubr (&Sbuffer_has_markers_at);
919 920

  DEFVAR_BOOL ("byte-debug-flag", &byte_debug_flag,
921
	       doc: /* Non-nil enables debugging checks in byte/char position conversions.  */);
922
  byte_debug_flag = 0;
Jim Blandy's avatar
Jim Blandy committed
923
}