editfns.c 123 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2
   Copyright (C) 1985,86,87,89,93,94,95,96,97,98, 1999, 2000, 2001
3
	Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


23
#include <config.h>
24
#include <sys/types.h>
Jim Blandy's avatar
Jim Blandy committed
25 26

#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
27
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
28
#else
Jim Blandy's avatar
Jim Blandy committed
29
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#endif

Andreas Schwab's avatar
Andreas Schwab committed
32 33 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37
#include <ctype.h>

Jim Blandy's avatar
Jim Blandy committed
38
#include "lisp.h"
39
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
41
#include "charset.h"
42
#include "coding.h"
43
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
44 45
#include "window.h"

Jim Blandy's avatar
Jim Blandy committed
46
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
47

48 49 50 51 52 53 54
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

55 56 57 58
#ifndef NULL
#define NULL 0
#endif

59
#ifndef USE_CRT_DLL
60
extern char **environ;
61 62
#endif

63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
extern Lisp_Object make_time P_ ((time_t));
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
static void find_field P_ ((Lisp_Object, Lisp_Object, int *, int *));
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
static int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
static void general_insert_function P_ ((void (*) (unsigned char *, int),
					 void (*) (Lisp_Object, int, int, int,
						   int, int),
					 int, int, Lisp_Object *));
static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
80

Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83 84
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

85 86 87
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
88

89
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
90

91 92 93 94
/* Non-nil means don't stop at field boundary in text motion commands.  */

Lisp_Object Vinhibit_field_text_motion;

Jim Blandy's avatar
Jim Blandy committed
95 96 97
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
98 99 100
Lisp_Object Vuser_real_login_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;		/* full name of current user */
Lisp_Object Vuser_login_name;		/* user name from LOGNAME or USER */
Jim Blandy's avatar
Jim Blandy committed
101

102 103 104 105 106 107 108 109 110
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

Lisp_Object Qboundary;


Jim Blandy's avatar
Jim Blandy committed
111 112 113
void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
114
  char *user_name;
115
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
116 117 118 119
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
120
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125 126 127 128

#ifndef CANNOT_DUMP
  /* Don't bother with this on initial start when just dumping out */
  if (!initialized)
    return;
#endif /* not CANNOT_DUMP */

  pw = (struct passwd *) getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
129 130 131 132
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
     accurate on MSDOG and because it lets Emacs find the init file.
     (The DVX libraries override the Djgpp libraries here.)  */
133
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
134
#else
135
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
136
#endif
Jim Blandy's avatar
Jim Blandy committed
137

Jim Blandy's avatar
Jim Blandy committed
138 139
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
140
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
141
  if (!user_name)
142 143 144
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
145
    user_name = (char *) getenv ("USER");
146
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
147 148 149 150 151
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
152
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
153

Jim Blandy's avatar
Jim Blandy committed
154 155
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
156
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
157 158
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
159

160
  p = (unsigned char *) getenv ("NAME");
161 162
  if (p)
    Vuser_full_name = build_string (p);
163 164
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
165 166 167
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
168 169
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
170
     (character)
171
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
172
{
Karl Heuer's avatar
Karl Heuer committed
173
  int len;
174
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
175

176
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
177

178 179 180
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
181
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
182 183 184
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
185 186 187
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
     (string)
188
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
189 190 191
{
  register Lisp_Object val;
  register struct Lisp_String *p;
192
  CHECK_STRING (string);
193
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
194
  if (p->size)
195 196 197 198 199 200
    {
      if (STRING_MULTIBYTE (string))
	XSETFASTINT (val, STRING_CHAR (p->data, STRING_BYTES (p)));
      else
	XSETFASTINT (val, p->data[0]);
    }
Jim Blandy's avatar
Jim Blandy committed
201
  else
202
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
203 204 205 206
  return val;
}

static Lisp_Object
207 208
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
209 210 211
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
212
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
213 214 215 216
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
217 218 219
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
220 221
{
  Lisp_Object temp;
222
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
227 228
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
229
{
230
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
231 232 233 234 235 236 237 238 239 240 241 242 243 244 245
}

int
clip_to_bounds (lower, num, upper)
     int lower, num, upper;
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
246
       doc: /* Set point to POSITION, a number or marker.
Pavel Janík's avatar
Pavel Janík committed
247 248 249
Beginning of buffer is position (point-min), end is (point-max).
If the position is in the middle of a multibyte form,
the actual point is set at the head of the multibyte form
250 251
except in the case that `enable-multibyte-characters' is nil.  */)
     (position)
252
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
253
{
Karl Heuer's avatar
Karl Heuer committed
254 255
  int pos;

256 257
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
258 259 260 261 262 263 264 265 266 267 268 269
    {
      pos = marker_position (position);
      if (pos < BEGV)
	SET_PT_BOTH (BEGV, BEGV_BYTE);
      else if (pos > ZV)
	SET_PT_BOTH (ZV, ZV_BYTE);
      else
	SET_PT_BOTH (pos, marker_byte_position (position));

      return position;
    }

270
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
271

Karl Heuer's avatar
Karl Heuer committed
272 273
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
274
  return position;
Jim Blandy's avatar
Jim Blandy committed
275 276
}

277 278 279 280 281

/* Return the start or end position of the region.
   BEGINNINGP non-zero means return the start.
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
282 283 284 285
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
286
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
287 288 289 290
  Lisp_Object m;
  
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
291 292
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
293
  
Jim Blandy's avatar
Jim Blandy committed
294
  m = Fmarker_position (current_buffer->mark);
295 296 297
  if (NILP (m))
    error ("There is no region now");
  
298
  if ((PT < XFASTINT (m)) == beginningp)
299 300
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
301 302 303
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
304 305
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
306
{
307
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
308 309 310
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
311 312
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
313
{
314
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
315 316 317
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
318
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
319
Watch out!  Moving this marker changes the mark position.
320 321
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
322 323 324
{
  return current_buffer->mark;
}
325

326

327 328
#if 0 /* Not used.  */

329 330
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
331 332

static int
333
char_property_eq (prop, pos1, pos2)
334 335 336 337 338
     Lisp_Object prop;
     Lisp_Object pos1, pos2;
{
  Lisp_Object pval1, pval2;

339 340
  pval1 = Fget_char_property (pos1, prop, Qnil);
  pval2 = Fget_char_property (pos2, prop, Qnil);
341 342 343 344

  return EQ (pval1, pval2);
}

345 346
#endif /* 0 */

Miles Bader's avatar
Miles Bader committed
347
/* Return the direction from which the text-property PROP would be
348 349 350 351
   inherited by any new text inserted at POS: 1 if it would be
   inherited from the char after POS, -1 if it would be inherited from
   the char before POS, and 0 if from neither.  */

352
static int
Miles Bader's avatar
Miles Bader committed
353
text_property_stickiness (prop, pos)
354 355 356
     Lisp_Object prop;
     Lisp_Object pos;
{
357 358
  Lisp_Object prev_pos, front_sticky;
  int is_rear_sticky = 1, is_front_sticky = 0; /* defaults */
359

360 361
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
362
    {
363 364 365 366 367
      Lisp_Object rear_non_sticky;

      prev_pos = make_number (XINT (pos) - 1);
      rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);

368 369 370
      if (!NILP (CONSP (rear_non_sticky)
		 ? Fmemq (prop, rear_non_sticky)
		 : rear_non_sticky))
371 372
	/* PROP is rear-non-sticky.  */
	is_rear_sticky = 0;
373 374
    }

375
  /* Consider following character.  */
Miles Bader's avatar
Miles Bader committed
376
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
377 378 379

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
380
	  && !NILP (Fmemq (prop, front_sticky))))
381
    /* PROP is inherited from after.  */
382
    is_front_sticky = 1;
383

384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399
  /* Simple cases, where the properties are consistent.  */
  if (is_rear_sticky && !is_front_sticky)
    return -1;
  else if (!is_rear_sticky && is_front_sticky)
    return 1;
  else if (!is_rear_sticky && !is_front_sticky)
    return 0;

  /* The stickiness properties are inconsistent, so we have to
     disambiguate.  Basically, rear-sticky wins, _except_ if the
     property that would be inherited has a value of nil, in which case
     front-sticky wins.  */
  if (XINT (pos) == BEGV || NILP (Fget_text_property (prev_pos, prop, Qnil)))
    return 1;
  else
    return -1;
400
}
401

402

403
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
404 405
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
406 407

   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
408 409 410 411 412 413 414 415
   position of a field, then the beginning of the previous field is
   returned instead of the beginning of POS's field (since the end of a
   field is actually also the beginning of the next input field, this
   behavior is sometimes useful).  Additionally in the MERGE_AT_BOUNDARY
   true case, if two fields are separated by a field with the special
   value `boundary', and POS lies within it, then the two separated
   fields are considered to be adjacent, and POS between them, when
   finding the beginning and ending of the "merged" field.
416 417 418 419

   Either BEG or END may be 0, in which case the corresponding value
   is not stored.  */

420
static void
421 422 423 424 425
find_field (pos, merge_at_boundary, beg, end)
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
     int *beg, *end;
{
426 427
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
Miles Bader's avatar
Miles Bader committed
428 429 430
  /* If the fields came from overlays, the associated overlays.
     Qnil means they came from text-properties.  */
  Lisp_Object before_overlay = Qnil, after_overlay = Qnil;
431 432 433 434
  /* 1 if POS counts as the start of a field.  */
  int at_field_start = 0;
  /* 1 if POS counts as the end of a field.  */
  int at_field_end = 0;
435

436 437 438
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
439
    CHECK_NUMBER_COERCE_MARKER (pos);
440

441
  after_field
Miles Bader's avatar
Miles Bader committed
442
    = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
443 444
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
445 446 447
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
					Qfield, Qnil,
					&before_overlay)
448
       : Qnil);
449 450 451 452 453 454 455 456 457 458 459

  /* See if we need to handle the case where MERGE_AT_BOUNDARY is nil
     and POS is at beginning of a field, which can also be interpreted
     as the end of the previous field.  Note that the case where if
     MERGE_AT_BOUNDARY is non-nil (see function comment) is actually the
     more natural one; then we avoid treating the beginning of a field
     specially.  */
  if (NILP (merge_at_boundary) && !EQ (after_field, before_field))
    /* We are at a boundary, see which direction is inclusive.  We
       decide by seeing which field the `field' property sticks to.  */
    {
Miles Bader's avatar
Miles Bader committed
460 461 462 463 464 465 466 467 468 469 470 471 472
      /* -1 means insertions go into before_field, 1 means they go
	 into after_field, 0 means neither.  */
      int stickiness;
      /* Whether the before/after_field come from overlays.  */
      int bop = !NILP (before_overlay);
      int aop = !NILP (after_overlay);

      if (bop && XMARKER (OVERLAY_END (before_overlay))->insertion_type == 1)
	/* before_field is from an overlay, which expands upon
	   end-insertions.  Note that it's possible for after_overlay to
	   also eat insertions here, but then they will overlap, and
	   there's not much we can do.  */
	stickiness = -1;
Miles Bader's avatar
Miles Bader committed
473 474
      else if (aop
	       && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
Miles Bader's avatar
Miles Bader committed
475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495
	/* after_field is from an overlay, which expand to contain
	   start-insertions.  */
	stickiness = 1;
      else if (bop && aop)
	/* Both fields come from overlays, but neither will contain any
	   insertion here.  */
	stickiness = 0;
      else if (bop)
	/* before_field is an overlay that won't eat any insertion, but
	   after_field is from a text-property.  Assume that the
	   text-property continues underneath the overlay, and so will
	   be inherited by any insertion, regardless of any stickiness
	   settings.  */
	stickiness = 1;
      else if (aop)
	/* Similarly, when after_field is the overlay.  */
	stickiness = -1;
      else
	/* Both fields come from text-properties.  Look for explicit
	   stickiness properties.  */
	stickiness = text_property_stickiness (Qfield, pos);
496 497 498 499 500 501 502 503 504 505

      if (stickiness > 0)
	at_field_start = 1;
      else if (stickiness < 0)
	at_field_end = 1;
      else
	/* STICKINESS == 0 means that any inserted text will get a
	   `field' char-property of nil, so check to see if that
	   matches either of the adjacent characters (this being a
	   kind of "stickiness by default").  */
506
	{
507 508 509 510
	  if (NILP (before_field))
	    at_field_end = 1; /* Sticks to the left.  */
	  else if (NILP (after_field))
	    at_field_start = 1; /* Sticks to the right.  */
511 512 513
	}
    }

514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
  /* Note about special `boundary' fields:

     Consider the case where the point (`.') is between the fields `x' and `y':

	xxxx.yyyy

     In this situation, if merge_at_boundary is true, we consider the
     `x' and `y' fields as forming one big merged field, and so the end
     of the field is the end of `y'.

     However, if `x' and `y' are separated by a special `boundary' field
     (a field with a `field' char-property of 'boundary), then we ignore
     this special field when merging adjacent fields.  Here's the same
     situation, but with a `boundary' field between the `x' and `y' fields:

	xxx.BBBByyyy

     Here, if point is at the end of `x', the beginning of `y', or
     anywhere in-between (within the `boundary' field), we merge all
     three fields and consider the beginning as being the beginning of
     the `x' field, and the end as being the end of the `y' field.  */

536
  if (beg)
537 538 539 540 541 542 543 544 545 546 547
    {
      if (at_field_start)
	/* POS is at the edge of a field, and we should consider it as
	   the beginning of the following field.  */
	*beg = XFASTINT (pos);
      else
	/* Find the previous field boundary.  */
	{
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
	    pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,Qnil);
548

549 550 551 552
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
553 554

  if (end)
555 556 557 558 559 560 561 562 563 564 565
    {
      if (at_field_end)
	/* POS is at the edge of a field, and we should consider it as
	   the end of the previous field.  */
	*end = XFASTINT (pos);
      else
	/* Find the next field boundary.  */
	{
	  if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
	    /* Skip a `boundary' field.  */
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
566

567 568 569 570
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
571
}
572

573

574
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
575
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
576
A field is a region of text with the same `field' property.
577 578
If POS is nil, the value of point is used for POS.  */)
     (pos)
579 580 581 582 583 584
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  if (beg != end)
    del_range (beg, end);
585
  return Qnil;
586 587 588
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
589
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
590
A field is a region of text with the same `field' property.
591 592
If POS is nil, the value of point is used for POS.  */)
     (pos)
593 594 595 596 597 598 599 600
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
601
       doc: /* Return the contents of the field around POS, without text-properties.
Pavel Janík's avatar
Pavel Janík committed
602
A field is a region of text with the same `field' property.
603 604
If POS is nil, the value of point is used for POS.  */)
     (pos)
605 606 607 608 609 610 611 612
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  return make_buffer_string (beg, end, 0);
}

DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 2, 0,
613
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
614 615 616
A field is a region of text with the same `field' property.
If POS is nil, the value of point is used for POS.
If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
617 618
field, then the beginning of the *previous* field is returned.  */)
     (pos, escape_from_edge)
619 620 621 622 623 624 625 626
     Lisp_Object pos, escape_from_edge;
{
  int beg;
  find_field (pos, escape_from_edge, &beg, 0);
  return make_number (beg);
}

DEFUN ("field-end", Ffield_end, Sfield_end, 0, 2, 0,
627
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
628 629 630
A field is a region of text with the same `field' property.
If POS is nil, the value of point is used for POS.
If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
631 632
then the end of the *following* field is returned.  */)
     (pos, escape_from_edge)
633 634 635 636 637 638 639
     Lisp_Object pos, escape_from_edge;
{
  int end;
  find_field (pos, escape_from_edge, 0, &end);
  return make_number (end);
}

640
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
641
       doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
Pavel Janík's avatar
Pavel Janík committed
642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665

A field is a region of text with the same `field' property.
If NEW-POS is nil, then the current point is used instead, and set to the
constrained position if that is different.

If OLD-POS is at the boundary of two fields, then the allowable
positions for NEW-POS depends on the value of the optional argument
ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
constrained to the field that has the same `field' char-property
as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
is non-nil, NEW-POS is constrained to the union of the two adjacent
fields.  Additionally, if two fields are separated by another field with
the special value `boundary', then any point within this special field is
also considered to be `on the boundary'.

If the optional argument ONLY-IN-LINE is non-nil and constraining
NEW-POS would move it to a different line, NEW-POS is returned
unconstrained.  This useful for commands that move by line, like
\\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
only in the case where they can still move to the right line.

If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
a non-nil property of that name, then any field boundaries are ignored.

666 667
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
     (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
668 669
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
670 671 672 673 674 675 676 677 678 679 680
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;

  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

681 682
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
683 684
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
685 686
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
687 688 689
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
690
      int fwd, shortage;
691 692
      Lisp_Object field_bound;

693 694
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
695 696 697 698 699 700 701 702

      fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));

      if (fwd)
	field_bound = Ffield_end (old_pos, escape_from_edge);
      else
	field_bound = Ffield_beginning (old_pos, escape_from_edge);

703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719
      if (/* See if ESCAPE_FROM_EDGE caused FIELD_BOUND to jump to the
             other side of NEW_POS, which would mean that NEW_POS is
             already acceptable, and it's not necessary to constrain it
             to FIELD_BOUND.  */
	  ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? fwd : !fwd)
	  /* NEW_POS should be constrained, but only if either
	     ONLY_IN_LINE is nil (in which case any constraint is OK),
	     or NEW_POS and FIELD_BOUND are on the same line (in which
	     case the constraint is OK even if ONLY_IN_LINE is non-nil). */
	  && (NILP (only_in_line)
	      /* This is the ONLY_IN_LINE case, check that NEW_POS and
		 FIELD_BOUND are on the same line by seeing whether
		 there's an intervening newline or not.  */
	      || (scan_buffer ('\n',
			       XFASTINT (new_pos), XFASTINT (field_bound),
			       fwd ? -1 : 1, &shortage, 1),
		  shortage != 0)))
720 721 722 723 724 725 726 727 728 729
	/* Constrain NEW_POS to FIELD_BOUND.  */
	new_pos = field_bound;

      if (orig_point && XFASTINT (new_pos) != orig_point)
	/* The NEW_POS argument was originally nil, so automatically set PT. */
	SET_PT (XFASTINT (new_pos));
    }

  return new_pos;
}
730

731

732 733
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
734
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
735 736
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
737 738 739 740 741

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
742

743 744
This function does not move point.  */)
     (n)
745 746
     Lisp_Object n;
{
747
  int orig, orig_byte, end;
748 749 750 751

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
752
    CHECK_NUMBER (n);
753 754

  orig = PT;
755
  orig_byte = PT_BYTE;
756 757
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
758

759
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
760

761
  /* Return END constrained to the current input field.  */
762 763
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
764
			      Qt, Qnil);
765 766
}

767
DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
768
       doc: /* Return the character position of the last character on the current line.
Pavel Janík's avatar
Pavel Janík committed
769 770
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
771 772 773 774 775 776

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.

777 778
This function does not move point.  */)
     (n)
779 780
     Lisp_Object n;
{
781
  int end_pos;
782
  int orig = PT;
783

784 785 786
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
787
    CHECK_NUMBER (n);
788

789 790 791
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
792
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
793
			      Qnil, Qt, Qnil);
794
}
795

796

Jim Blandy's avatar
Jim Blandy committed
797 798 799
Lisp_Object
save_excursion_save ()
{
800 801
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
802 803

  return Fcons (Fpoint_marker (),
804
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
805
		       Fcons (visible ? Qt : Qnil,
806 807
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
808 809 810 811
}

Lisp_Object
save_excursion_restore (info)
812
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
813
{
814 815
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
816
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
817

818
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
819 820 821 822
  /* If buffer being returned to is now deleted, avoid error */
  /* Otherwise could get error here while unwinding to top level
     and crash */
  /* In that case, Fmarker_buffer returns nil now.  */
Jim Blandy's avatar
Jim Blandy committed
823
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
824
    return Qnil;
825 826 827 828

  omark = nmark = Qnil;
  GCPRO3 (info, omark, nmark);

Jim Blandy's avatar
Jim Blandy committed
829
  Fset_buffer (tem);
830 831 832

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
833 834
  Fgoto_char (tem);
  unchain_marker (tem);
835 836 837 838

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
839
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
840
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
841
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
842
  unchain_marker (tem);
843 844 845 846 847

  /* visible */
  info = XCDR (info);
  visible_p = !NILP (XCAR (info));
  
848 849 850 851
#if 0 /* We used to make the current buffer visible in the selected window
	 if that was true previously.  That avoids some anomalies.
	 But it creates others, and it wasn't documented, and it is simpler
	 and cleaner never to alter the window/buffer connections.  */
852 853
  tem1 = Fcar (tem);
  if (!NILP (tem1)
854
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
855
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
856
#endif /* 0 */
857

858 859 860
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
861
  tem1 = current_buffer->mark_active;
862 863
  current_buffer->mark_active = tem;

864 865
  if (!NILP (Vrun_hooks))
    {
866 867
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
868
      if (! NILP (current_buffer->mark_active))
869 870 871 872 873
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
874 875 876
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
877 878

  /* If buffer was visible in a window, and a different window was
879 880
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
881 882 883
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
884 885 886 887 888
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
889 890
    Fset_window_point (tem, make_number (PT));

891
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
892 893 894 895
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
896
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
897 898 899 900 901 902 903 904
Executes BODY just like `progn'.
The values of point, mark and the current buffer are restored
even in case of abnormal exit (throw or error).
The state of activation of the mark is also restored.

This construct does not save `deactivate-mark', and therefore
functions that change the buffer will still cause deactivation
of the mark at the end of the command.  To prevent that, bind
905 906 907
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
908
     (args)
Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913 914
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
915 916 917 918 919 920

  val = Fprogn (args);
  return unbind_to (count, val);
}

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
921
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
922 923
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
924
     (args)
925 926
     Lisp_Object args;
{
927
  Lisp_Object val;
928 929
  int count = specpdl_ptr - specpdl;

930
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
931

Jim Blandy's avatar
Jim Blandy committed
932 933 934 935
  val = Fprogn (args);
  return unbind_to (count, val);
}

936
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
937 938 939
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
940
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
941
{
942 943
  if (NILP (buffer))
    return make_number (Z - BEG);
944 945
  else
    {
946
      CHECK_BUFFER (buffer);
947 948 949
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
950 951 952
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
953 954 955
       doc: /* Return the minimum permissible value of point in the current buffer.
This is 1, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
956 957
{
  Lisp_Object temp;
958
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
963 964 965
       doc: /* Return a marker to the minimum permissible value of point in this buffer.
This is the beginning, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
966
{
967
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
968 969 970
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
971
       doc: /* Return the maximum permissible value of point in the current buffer.
Pavel Janík's avatar
Pavel Janík committed
972
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
973 974
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
975 976
{
  Lisp_Object temp;
977
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
978 979 980 981
  return temp;
}

DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
982
       doc: /* Return a marker to the maximum permissible value of point in this buffer.
Pavel Janík's avatar
Pavel Janík committed
983
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
984 985
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
986
{
987
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
988 989
}

990
DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
991 992 993
       doc: /* Return the position of the gap, in the current buffer.
See also `gap-size'.  */)
     ()
994 995 996 997 998 999 1000
{
  Lisp_Object temp;
  XSETFASTINT (temp, GPT);
  return temp;
}

DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1001 1002 1003
       doc: /* Return the size of the current buffer's gap.
See also `gap-position'.  */)
     ()
1004 1005 1006 1007 1008 1009
{
  Lisp_Object temp;
  XSETFASTINT (temp, GAP_SIZE);
  return temp;
}

1010
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1011 1012 1013
       doc: /* Return the byte position for character position POSITION.
If POSITION is out of range, the value is nil.  */)
     (position)
1014
     Lisp_Object position;
1015
{
1016
  CHECK_NUMBER_COERCE_MARKER (position);
1017 1018
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
1019
  return make_number (CHAR_TO_BYTE (XINT (position)));
1020
}
1021 1022

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1023 1024 1025
       doc: /* Return the character position for byte position BYTEPOS.
If BYTEPOS is out of range, the value is nil.  */)
     (bytepos)
1026 1027
     Lisp_Object bytepos;
{
1028
  CHECK_NUMBER (bytepos);
1029 1030
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
1031 1032
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
1033

Jim Blandy's avatar
Jim Blandy committed
1034
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1035 1036 1037
       doc: /* Return the character following point, as a number.
At the end of the buffer or accessible region, return 0.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1038 1039
{
  Lisp_Object temp;
1040
  if (PT >= ZV)
1041
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed