editfns.c 154 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1989, 1993-2015 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19 20


21
#include <config.h>
22
#include <sys/types.h>
23
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
24

25
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
26
#include <pwd.h>
27
#include <grp.h>
Jim Blandy's avatar
Jim Blandy committed
28 29
#endif

Andreas Schwab's avatar
Andreas Schwab committed
30 31
#include <unistd.h>

32 33 34 35
#ifdef HAVE_SYS_UTSNAME_H
#include <sys/utsname.h>
#endif

36 37
#include "lisp.h"

38 39 40 41
/* systime.h includes <sys/time.h> which, on some systems, is required
   for <sys/resource.h>; thus systime.h must be included before
   <sys/resource.h> */
#include "systime.h"
42 43

#if defined HAVE_SYS_RESOURCE_H
44
#include <sys/resource.h>
45 46
#endif

47
#include <float.h>
48 49
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
50
#include <strftime.h>
51
#include <verify.h>
52

53
#include "intervals.h"
54
#include "character.h"
55
#include "buffer.h"
56
#include "coding.h"
57
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
58
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
59
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
60

61 62
#define TM_YEAR_BASE 1900

63
#ifdef WINDOWSNT
64
extern Lisp_Object w32_get_internal_run_time (void);
65 66
#endif

67
static struct lisp_time lisp_time_struct (Lisp_Object, int *);
68
static void set_time_zone_rule (char const *);
69
static Lisp_Object format_time_string (char const *, ptrdiff_t, struct timespec,
70
				       bool, struct tm *);
71
static long int tm_gmtoff (struct tm *);
72
static int tm_diff (struct tm *, struct tm *);
73
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
74

75 76 77 78 79
#ifndef HAVE_TM_GMTOFF
# define HAVE_TM_GMTOFF false
#endif

/* The startup value of the TZ environment variable; null if unset.  */
80 81
static char const *initial_tz;

82 83
/* A valid but unlikely setting for the TZ environment variable.
   It is OK (though a bit slower) if the user chooses this value.  */
84
static char dump_tz_string[] = "TZ=UtC0";
85

86 87 88 89 90 91 92 93 94 95 96
/* The cached value of Vsystem_name.  This is used only to compare it
   to Vsystem_name, so it need not be visible to the GC.  */
static Lisp_Object cached_system_name;

static void
init_and_cache_system_name (void)
{
  init_system_name ();
  cached_system_name = Vsystem_name;
}

Jim Blandy's avatar
Jim Blandy committed
97
void
98
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
99
{
100
  const char *user_name;
101
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
106
  init_and_cache_system_name ();
Jim Blandy's avatar
Jim Blandy committed
107 108

#ifndef CANNOT_DUMP
109 110
  /* When just dumping out, set the time zone to a known unlikely value
     and skip the rest of this function.  */
Jim Blandy's avatar
Jim Blandy committed
111
  if (!initialized)
112 113
    {
# ifdef HAVE_TZSET
114
      xputenv (dump_tz_string);
115 116 117 118 119 120 121 122
      tzset ();
# endif
      return;
    }
#endif

  char *tz = getenv ("TZ");
  initial_tz = tz;
Jim Blandy's avatar
Jim Blandy committed
123

124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140
#if !defined CANNOT_DUMP && defined HAVE_TZSET
  /* If the execution TZ happens to be the same as the dump TZ,
     change it to some other value and then change it back,
     to force the underlying implementation to reload the TZ info.
     This is needed on implementations that load TZ info from files,
     since the TZ file contents may differ between dump and execution.  */
  if (tz && strcmp (tz, &dump_tz_string[sizeof "TZ=" - 1]) == 0)
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

  /* Call set_time_zone_rule now, so that its call to putenv is done
     before multiple threads are active.  */
  set_time_zone_rule (tz);
141

142
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
143 144
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
145
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
146
     (The DVX libraries override the Djgpp libraries here.)  */
147
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
148
#else
149
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
150
#endif
Jim Blandy's avatar
Jim Blandy committed
151

Jim Blandy's avatar
Jim Blandy committed
152 153
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
154
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
155
  if (!user_name)
156
#ifdef WINDOWSNT
157
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
158
#else  /* WINDOWSNT */
159
    user_name = getenv ("USER");
160
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
161 162
  if (!user_name)
    {
163 164
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
165
    }
166
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
167

Jim Blandy's avatar
Jim Blandy committed
168 169
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
170
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
171 172 173 174 175 176 177 178
  if (! NILP (tem))
    tem = Vuser_login_name;
  else
    {
      uid_t euid = geteuid ();
      tem = make_fixnum_or_float (euid);
    }
  Vuser_full_name = Fuser_full_name (tem);
Sam Steingold's avatar
Sam Steingold committed
179

180
  p = getenv ("NAME");
181 182
  if (p)
    Vuser_full_name = build_string (p);
183 184
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
185 186 187 188 189 190 191 192 193 194

#ifdef HAVE_SYS_UTSNAME_H
  {
    struct utsname uts;
    uname (&uts);
    Voperating_system_release = build_string (uts.release);
  }
#else
  Voperating_system_release = Qnil;
#endif
Jim Blandy's avatar
Jim Blandy committed
195 196
}

Paul Eggert's avatar
Paul Eggert committed
197
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
198 199
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
200
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
201
{
202
  int c, len;
203
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
204

205
  CHECK_CHARACTER (character);
206
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
207

208
  len = CHAR_STRING (c, str);
209
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
210 211
}

212
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
213
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
214
  (Lisp_Object byte)
215
{
216
  unsigned char b;
217
  CHECK_NUMBER (byte);
218 219
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
220
  b = XINT (byte);
221
  return make_string_from_bytes ((char *) &b, 1, 1);
222 223
}

Jim Blandy's avatar
Jim Blandy committed
224
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
225
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
226
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
227 228
{
  register Lisp_Object val;
229
  CHECK_STRING (string);
230
  if (SCHARS (string))
231 232
    {
      if (STRING_MULTIBYTE (string))
233
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
234
      else
235
	XSETFASTINT (val, SREF (string, 0));
236
    }
Jim Blandy's avatar
Jim Blandy committed
237
  else
238
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
239 240 241
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
242
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
243 244
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
245
  (void)
Jim Blandy's avatar
Jim Blandy committed
246 247
{
  Lisp_Object temp;
248
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
249 250 251
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
252
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
253
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254
  (void)
Jim Blandy's avatar
Jim Blandy committed
255
{
256
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
257 258
}

Paul Eggert's avatar
Paul Eggert committed
259
DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
260
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
261 262 263
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
264
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
265
{
266 267 268 269 270 271
  if (MARKERP (position))
    set_point_from_marker (position);
  else if (INTEGERP (position))
    SET_PT (clip_to_bounds (BEGV, XINT (position), ZV));
  else
    wrong_type_argument (Qinteger_or_marker_p, position);
272
  return position;
Jim Blandy's avatar
Jim Blandy committed
273 274
}

275 276

/* Return the start or end position of the region.
277
   BEGINNINGP means return the start.
278 279
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
280
static Lisp_Object
281
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
282
{
283
  Lisp_Object m;
284

285 286
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
287
      && NILP (BVAR (current_buffer, mark_active)))
288
    xsignal0 (Qmark_inactive);
289

Tom Tromey's avatar
Tom Tromey committed
290
  m = Fmarker_position (BVAR (current_buffer, mark));
291
  if (NILP (m))
292
    error ("The mark is not set now, so there is no region");
293

294
  /* Clip to the current narrowing (bug#11770).  */
295
  return make_number ((PT < XFASTINT (m)) == beginningp
296 297
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
298 299 300
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
301
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (void)
Jim Blandy's avatar
Jim Blandy committed
303
{
304
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
305 306 307
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
308
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
309
  (void)
Jim Blandy's avatar
Jim Blandy committed
310
{
311
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
312 313 314
}

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


324 325 326 327
/* Find all the overlays in the current buffer that touch position POS.
   Return the number found, and store them in a vector in VEC
   of length LEN.  */

328 329
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
330
{
331 332
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
333
  ptrdiff_t startpos, endpos;
334
  ptrdiff_t idx = 0;
335

336
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
337
    {
338
      XSETMISC (overlay, tail);
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354

      end = OVERLAY_END (overlay);
      endpos = OVERLAY_POSITION (end);
      if (endpos < pos)
	  break;
      start = OVERLAY_START (overlay);
      startpos = OVERLAY_POSITION (start);
      if (startpos <= pos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  /* Keep counting overlays even if we can't return them all.  */
	  idx++;
	}
    }

355
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
356
    {
357
      XSETMISC (overlay, tail);
358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375

      start = OVERLAY_START (overlay);
      startpos = OVERLAY_POSITION (start);
      if (pos < startpos)
	break;
      end = OVERLAY_END (overlay);
      endpos = OVERLAY_POSITION (end);
      if (pos <= endpos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  idx++;
	}
    }

  return idx;
}

376 377 378 379 380 381 382 383 384
DEFUN ("get-pos-property", Fget_pos_property, Sget_pos_property, 2, 3, 0,
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
Almost identical to `get-char-property' except for the following difference:
Whereas `get-char-property' returns the property of the char at (i.e. right
after) POSITION, this pays attention to properties's stickiness and overlays's
advancement settings, in order to find the property of POSITION itself,
i.e. the property that a char would inherit if it were inserted
at POSITION.  */)
  (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
385 386 387 388 389
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
390
  else if (WINDOWP (object))
391
    object = XWINDOW (object)->contents;
392 393 394 395 396 397 398

  if (!BUFFERP (object))
    /* pos-property only makes sense in buffers right now, since strings
       have no overlays and no notion of insertion for which stickiness
       could be obeyed.  */
    return Fget_text_property (position, prop, object);
  else
399
    {
400
      EMACS_INT posn = XINT (position);
401
      ptrdiff_t noverlays;
402 403
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
404
      USE_SAFE_ALLOCA;
405 406 407 408

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
409 410 411
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
412 413 414 415
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
416
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
417
	{
418
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
	  noverlays = overlays_around (posn, overlay_vec, noverlays);
	}
      noverlays = sort_overlays (overlay_vec, noverlays, NULL);

      set_buffer_temp (obuf);

      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
	  Lisp_Object ol = overlay_vec[noverlays];
	  tem = Foverlay_get (ol, prop);
	  if (!NILP (tem))
	    {
	      /* Check the overlay is indeed active at point.  */
	      Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
	      if ((OVERLAY_POSITION (start) == posn
		   && XMARKER (start)->insertion_type == 1)
		  || (OVERLAY_POSITION (finish) == posn
		      && XMARKER (finish)->insertion_type == 0))
		; /* The overlay will not cover a char inserted at point.  */
	      else
		{
441
		  SAFE_FREE ();
442 443 444 445
		  return tem;
		}
	    }
	}
446
      SAFE_FREE ();
447

448
      { /* Now check the text properties.  */
449 450 451 452 453 454 455 456 457 458
	int stickiness = text_property_stickiness (prop, position, object);
	if (stickiness > 0)
	  return Fget_text_property (position, prop, object);
	else if (stickiness < 0
		 && XINT (position) > BUF_BEGV (XBUFFER (object)))
	  return Fget_text_property (make_number (XINT (position) - 1),
				     prop, object);
	else
	  return Qnil;
      }
459 460 461
    }
}

462
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
Lars Hansen's avatar
Lars Hansen committed
463
   the value of point is used instead.  If BEG or END is null,
464
   means don't store the beginning or end of the field.
465

466 467 468
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

469
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
470 471 472 473
   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
474
   non-nil case, if two fields are separated by a field with the special
475 476 477
   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.
478 479 480 481

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

482
static void
483 484
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
485
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
486
{
487 488
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
489 490 491 492
  /* True if POS counts as the start of a field.  */
  bool at_field_start = 0;
  /* True if POS counts as the end of a field.  */
  bool at_field_end = 0;
493

494 495 496
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
497
    CHECK_NUMBER_COERCE_MARKER (pos);
498

499
  after_field
500
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
501 502
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
503
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
504
					Qfield, Qnil, NULL)
505 506 507
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
508 509 510 511 512 513 514

  /* 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.  */
515
  if (NILP (merge_at_boundary))
516
    {
517
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
518
      if (!EQ (field, after_field))
519
	at_field_end = 1;
520 521
      if (!EQ (field, before_field))
	at_field_start = 1;
522 523 524 525 526 527
      if (NILP (field) && at_field_start && at_field_end)
	/* If an inserted char would have a nil field while the surrounding
	   text is non-nil, we're probably not looking at a
	   zero-length field, but instead at a non-nil field that's
	   not intended for editing (such as comint's prompts).  */
	at_field_end = at_field_start = 0;
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

536
     In this situation, if merge_at_boundary is non-nil, consider the
537 538 539 540
     `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
541
     (a field with a `field' char-property of 'boundary), then ignore
542 543 544 545 546 547
     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
548
     anywhere in-between (within the `boundary' field), merge all
549 550 551
     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.  */

552
  if (beg)
553 554 555 556 557 558 559 560
    {
      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.  */
	{
561
	  Lisp_Object p = pos;
562 563
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
564
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
565
						       beg_limit);
566 567 568 569

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
570 571
	}
    }
572 573

  if (end)
574 575 576 577 578 579 580 581 582 583
    {
      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.  */
584 585
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
586

587 588
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
589 590 591
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
592
}
593

594

595
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
596
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
597
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
598
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
599
  (Lisp_Object pos)
600
{
601
  ptrdiff_t beg, end;
602
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
603 604
  if (beg != end)
    del_range (beg, end);
605
  return Qnil;
606 607 608
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
609
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
610
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
611
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
612
  (Lisp_Object pos)
613
{
614
  ptrdiff_t beg, end;
615
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
616 617 618 619
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
620
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
621
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
622
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
623
  (Lisp_Object pos)
624
{
625
  ptrdiff_t beg, end;
626
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
627 628 629
  return make_buffer_string (beg, end, 0);
}

630
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
631
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
632 633 634
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
635 636
field, then the beginning of the *previous* field is returned.
If LIMIT is non-nil, it is a buffer position; if the beginning of the field
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
637
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
638
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
639
{
640
  ptrdiff_t beg;
641
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
642 643 644
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
645
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
646
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
647 648 649
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,
650 651
then the end of the *following* field is returned.
If LIMIT is non-nil, it is a buffer position; if the end of the field
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
652
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
653
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
654
{
655
  ptrdiff_t end;
656
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
657 658 659
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
660
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
661
       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
662
A field is a region of text with the same `field' property.
663 664 665 666

If NEW-POS is nil, then use the current point instead, and move point
to the resulting constrained position, in addition to returning that
position.
Pavel Janík's avatar
Pavel Janík committed
667 668 669 670 671 672 673 674 675 676 677 678 679

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
680
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
681 682 683 684 685 686
\\[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.

687
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
688 689
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
690 691
{
  /* If non-zero, then the original point, before re-positioning.  */
692
  ptrdiff_t orig_point = 0;
693
  bool fwd;
694
  Lisp_Object prev_old, prev_new;
695

696 697 698 699 700 701 702
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

703 704 705
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

706
  fwd = (XINT (new_pos) > XINT (old_pos));
707

708 709
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
710

711 712
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
713 714
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
715
          /* To recognize field boundaries, we must also look at the
716
             previous positions; we could use `Fget_pos_property'
717 718 719
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
720
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
721
          || (XFASTINT (old_pos) > BEGV
722
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
723
      && (NILP (inhibit_capture_property)
724 725 726
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
727
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
728
              && (XFASTINT (old_pos) <= BEGV
729 730 731 732
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
733 734
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
735
    {
736
      ptrdiff_t shortage;
737 738 739
      Lisp_Object field_bound;

      if (fwd)
740
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
741
      else
742
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
743

744 745 746 747 748 749 750 751
      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
752
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
753 754 755 756
	  && (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.  */
757 758
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
759
				fwd ? -1 : 1, &shortage, NULL, 1),
760
		  shortage != 0)))
761 762 763 764 765 766 767 768 769 770
	/* 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;
}
771

772

Paul Eggert's avatar
Paul Eggert committed
773
DEFUN ("line-beginning-position",
774
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
775
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
776 777
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
778

Chong Yidong's avatar
Chong Yidong committed
779 780 781
This function ignores text display directionality; it returns the
position of the first character in logical order, i.e. the smallest
character position on the line.
782

783
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
784
unless that position would be on a different line than the original,
785 786
unconstrained result.  If N is nil or 1, and a front-sticky field
starts at point, the scan stops as soon as it starts.  To ignore field
Chong Yidong's avatar
Chong Yidong committed
787
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
788

789
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
790
  (Lisp_Object n)
791
{
792
  ptrdiff_t charpos, bytepos;
793 794 795 796

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
797
    CHECK_NUMBER (n);
798

799
  scan_newline_from_point (XINT (n) - 1, &charpos, &bytepos);
800

801
  /* Return END constrained to the current input field.  */
802
  return Fconstrain_to_field (make_number (charpos), make_number (PT),
803
			      XINT (n) != 1 ? Qt : Qnil,
804
			      Qt, Qnil);
805 806
}

Paul Eggert's avatar
Paul Eggert committed
807
DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
808
       doc: /* Return the character position of the last character on the current line.
Pavel Janík's avatar
Pavel Janík committed
809 810
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
811

Chong Yidong's avatar
Chong Yidong committed
812 813 814
This function ignores text display directionality; it returns the
position of the last character in logical order, i.e. the largest
character position on the line.
815

816 817 818 819
This function constrains the returned position to the current field
unless that would be on a different line than the original,
unconstrained result.  If N is nil or 1, and a rear-sticky field ends
at point, the scan stops as soon as it starts.  To ignore field
820 821
boundaries bind `inhibit-field-text-motion' to t.

822
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
823
  (Lisp_Object n)
824
{
825 826 827
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
828

829 830 831
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
832
    CHECK_NUMBER (n);
833

834
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
835 836
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
837 838

  /* Return END_POS constrained to the current input field.  */
839
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
840
			      Qnil, Qt, Qnil);
841
}
842

843 844 845 846
/* Save current buffer state for `save-excursion' special form.
   We (ab)use Lisp_Misc_Save_Value to allow explicit free and so
   offload some work from GC.  */

Jim Blandy's avatar
Jim Blandy committed
847
Lisp_Object
848
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
849
{
850 851
  return make_save_obj_obj_obj_obj
    (Fpoint_marker (),
852
     Qnil,
853
     /* Selected window if current buffer is shown in it, nil otherwise.  */
854
     (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
855
      ? selected_window : Qnil),
856
     Qnil);
Jim Blandy's avatar
Jim Blandy committed
857 858
}

859 860
/* Restore saved buffer before leaving `save-excursion' special form.  */

861
void
862
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
863
{
864 865
  Lisp_Object tem, tem1;
  struct gcpro gcpro1;
866

867
  tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
868 869
  /* If we're unwinding to top level, saved buffer may be deleted.  This
     means that all of its markers are unchained and so tem is nil.  */
870
  if (NILP (tem))
871
    goto out;
872

873
  GCPRO1 (info);
874 875 876 877

  Fset_buffer (tem);

  /* Point marker.  */
878
  tem = XSAVE_OBJECT (info, 0);
879 880 881 882 883 884
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* If buffer was visible in a window, and a different window was
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
885
  tem = XSAVE_OBJECT (info, 2);
886
  if (WINDOWP (tem)
887
      && !EQ (tem, selected_window)
888
      && (tem1 = XWINDOW (tem)->contents,
889 890 891 892 893 894 895
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
    Fset_window_point (tem, make_number (PT));

  UNGCPRO;
896 897 898

 out:

899
  free_misc (info);
Jim Blandy's avatar
Jim Blandy committed
900 901 902
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
903
       doc: /* Save point, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
904
Executes BODY just like `progn'.
905
The values of point and the current buffer are restored
Pavel Janík's avatar
Pavel Janík committed
906
even in case of abnormal exit (throw or error).
907

908
If you only want to save the current buffer but not point,
909 910
then just use `save-current-buffer', or even `with-current-buffer'.

911 912 913 914
Before Emacs 25.1, `save-excursion' used to save the mark state.
To save the marker state as well as the point and buffer, use
`save-mark-and-excursion'.

915
usage: (save-excursion &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
916
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
917 918
{
  register Lisp_Object val;
919
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
920