editfns.c 170 KB
Newer Older
1
/* Lisp functions pertaining to editing.                 -*- coding: utf-8 -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1989, 1993-2017 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 <https://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 <errno.h>
48
#include <float.h>
49
#include <limits.h>
50

51
#include <c-ctype.h>
52
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
53
#include <stdlib.h>
Paul Eggert's avatar
Paul Eggert committed
54
#include <strftime.h>
55
#include <verify.h>
56

57
#include "composite.h"
58
#include "intervals.h"
59
#include "character.h"
60
#include "buffer.h"
61
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
62
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
63
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
64

65 66
#define TM_YEAR_BASE 1900

67
#ifdef WINDOWSNT
68
extern Lisp_Object w32_get_internal_run_time (void);
69 70
#endif

71
static struct lisp_time lisp_time_struct (Lisp_Object, int *);
72
static Lisp_Object format_time_string (char const *, ptrdiff_t, struct timespec,
73
				       Lisp_Object, struct tm *);
74
static long int tm_gmtoff (struct tm *);
75
static int tm_diff (struct tm *, struct tm *);
76
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
77
static Lisp_Object styled_format (ptrdiff_t, Lisp_Object *, bool);
78

79 80 81 82
#ifndef HAVE_TM_GMTOFF
# define HAVE_TM_GMTOFF false
#endif

83 84
enum { tzeqlen = sizeof "TZ=" - 1 };

Paul Eggert's avatar
Paul Eggert committed
85
/* Time zones equivalent to current local time and to UTC, respectively.  */
86 87
static timezone_t local_tz;
static timezone_t const utc_tz = 0;
88

89 90 91 92 93 94 95 96 97 98 99
/* 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;
}

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144
static struct tm *
emacs_localtime_rz (timezone_t tz, time_t const *t, struct tm *tm)
{
  tm = localtime_rz (tz, t, tm);
  if (!tm && errno == ENOMEM)
    memory_full (SIZE_MAX);
  return tm;
}

static time_t
emacs_mktime_z (timezone_t tz, struct tm *tm)
{
  errno = 0;
  time_t t = mktime_z (tz, tm);
  if (t == (time_t) -1 && errno == ENOMEM)
    memory_full (SIZE_MAX);
  return t;
}

/* Allocate a timezone, signaling on failure.  */
static timezone_t
xtzalloc (char const *name)
{
  timezone_t tz = tzalloc (name);
  if (!tz)
    memory_full (SIZE_MAX);
  return tz;
}

/* Free a timezone, except do not free the time zone for local time.
   Freeing utc_tz is also a no-op.  */
static void
xtzfree (timezone_t tz)
{
  if (tz != local_tz)
    tzfree (tz);
}

/* Convert the Lisp time zone rule ZONE to a timezone_t object.
   The returned value either is 0, or is LOCAL_TZ, or is newly allocated.
   If SETTZ, set Emacs local time to the time zone rule; otherwise,
   the caller should eventually pass the returned value to xtzfree.  */
static timezone_t
tzlookup (Lisp_Object zone, bool settz)
{
Paul Eggert's avatar
Paul Eggert committed
145 146 147
  static char const tzbuf_format[] = "<%+.*"pI"d>%s%"pI"d:%02d:%02d";
  char const *trailing_tzbuf_format = tzbuf_format + sizeof "<%+.*"pI"d" - 1;
  char tzbuf[sizeof tzbuf_format + 2 * INT_STRLEN_BOUND (EMACS_INT)];
148 149 150 151 152 153 154 155 156 157 158 159
  char const *zone_string;
  timezone_t new_tz;

  if (NILP (zone))
    return local_tz;
  else if (EQ (zone, Qt))
    {
      zone_string = "UTC0";
      new_tz = utc_tz;
    }
  else
    {
160 161
      bool plain_integer = INTEGERP (zone);

162 163 164
      if (EQ (zone, Qwall))
	zone_string = 0;
      else if (STRINGP (zone))
165 166 167
	zone_string = SSDATA (ENCODE_SYSTEM (zone));
      else if (plain_integer || (CONSP (zone) && INTEGERP (XCAR (zone))
				 && CONSP (XCDR (zone))))
168
	{
169 170 171 172 173 174 175
	  Lisp_Object abbr;
	  if (!plain_integer)
	    {
	      abbr = XCAR (XCDR (zone));
	      zone = XCAR (zone);
	    }

176
	  EMACS_INT abszone = eabs (XINT (zone)), hour = abszone / (60 * 60);
177 178 179 180 181 182 183 184 185 186 187 188 189
	  int hour_remainder = abszone % (60 * 60);
	  int min = hour_remainder / 60, sec = hour_remainder % 60;

	  if (plain_integer)
	    {
	      int prec = 2;
	      EMACS_INT numzone = hour;
	      if (hour_remainder != 0)
		{
		  prec += 2, numzone = 100 * numzone + min;
		  if (sec != 0)
		    prec += 2, numzone = 100 * numzone + sec;
		}
190 191
	      sprintf (tzbuf, tzbuf_format, prec,
		       XINT (zone) < 0 ? -numzone : numzone,
192 193 194 195 196 197 198 199 200 201 202 203 204
		       &"-"[XINT (zone) < 0], hour, min, sec);
	      zone_string = tzbuf;
	    }
	  else
	    {
	      AUTO_STRING (leading, "<");
	      AUTO_STRING_WITH_LEN (trailing, tzbuf,
				    sprintf (tzbuf, trailing_tzbuf_format,
					     &"-"[XINT (zone) < 0],
					     hour, min, sec));
	      zone_string = SSDATA (concat3 (leading, ENCODE_SYSTEM (abbr),
					     trailing));
	    }
205 206 207 208 209 210 211 212 213 214 215
	}
      else
	xsignal2 (Qerror, build_string ("Invalid time zone specification"),
		  zone);
      new_tz = xtzalloc (zone_string);
    }

  if (settz)
    {
      block_input ();
      emacs_setenv_TZ (zone_string);
Paul Eggert's avatar
Paul Eggert committed
216
      tzset ();
217 218 219 220 221 222 223 224 225
      timezone_t old_tz = local_tz;
      local_tz = new_tz;
      tzfree (old_tz);
      unblock_input ();
    }

  return new_tz;
}

Jim Blandy's avatar
Jim Blandy committed
226
void
227
init_editfns (bool dumping)
Jim Blandy's avatar
Jim Blandy committed
228
{
Paul Eggert's avatar
Paul Eggert committed
229
#if !defined CANNOT_DUMP
230 231 232 233 234
  /* A valid but unlikely setting for the TZ environment variable.
     It is OK (though a bit slower) if the user chooses this value.  */
  static char dump_tz_string[] = "TZ=UtC0";
#endif

235
  const char *user_name;
236
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
237 238 239 240
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
241
  init_and_cache_system_name ();
Jim Blandy's avatar
Jim Blandy committed
242 243

#ifndef CANNOT_DUMP
244 245
  /* When just dumping out, set the time zone to a known unlikely value
     and skip the rest of this function.  */
246
  if (dumping)
247
    {
248
      xputenv (dump_tz_string);
249 250 251 252 253 254
      tzset ();
      return;
    }
#endif

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

Paul Eggert's avatar
Paul Eggert committed
256
#if !defined CANNOT_DUMP
257 258 259 260 261
  /* 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.  */
262
  if (tz && strcmp (tz, &dump_tz_string[tzeqlen]) == 0)
263 264 265 266 267 268 269
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

270
  /* Set the time zone rule now, so that the call to putenv is done
271
     before multiple threads are active.  */
272
  tzlookup (tz ? build_string (tz) : Qwall, true);
273

274
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
275 276
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
277
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
278
     (The DVX libraries override the Djgpp libraries here.)  */
279
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
280
#else
281
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
282
#endif
Jim Blandy's avatar
Jim Blandy committed
283

Jim Blandy's avatar
Jim Blandy committed
284 285
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
286
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
287
  if (!user_name)
288
#ifdef WINDOWSNT
289
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
290
#else  /* WINDOWSNT */
291
    user_name = getenv ("USER");
292
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
293 294
  if (!user_name)
    {
295 296
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
297
    }
298
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
299

Jim Blandy's avatar
Jim Blandy committed
300 301
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
302
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
303 304 305 306 307 308 309 310
  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
311

312
  p = getenv ("NAME");
313 314
  if (p)
    Vuser_full_name = build_string (p);
315 316
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
317 318 319 320 321 322 323 324 325 326

#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
327 328
}

Paul Eggert's avatar
Paul Eggert committed
329
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
330 331
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
332
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
333
{
334
  int c, len;
335
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
336

337
  CHECK_CHARACTER (character);
338
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
339

340
  len = CHAR_STRING (c, str);
341
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
342 343
}

344
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
345
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
346
  (Lisp_Object byte)
347
{
348
  unsigned char b;
349
  CHECK_NUMBER (byte);
350 351
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
352
  b = XINT (byte);
353
  return make_string_from_bytes ((char *) &b, 1, 1);
354 355
}

Jim Blandy's avatar
Jim Blandy committed
356
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
357
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
358
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
359 360
{
  register Lisp_Object val;
361
  CHECK_STRING (string);
362
  if (SCHARS (string))
363 364
    {
      if (STRING_MULTIBYTE (string))
365
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
366
      else
367
	XSETFASTINT (val, SREF (string, 0));
368
    }
Jim Blandy's avatar
Jim Blandy committed
369
  else
370
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
371 372 373
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
374
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
375 376
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
377
  (void)
Jim Blandy's avatar
Jim Blandy committed
378 379
{
  Lisp_Object temp;
380
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
381 382 383
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
384
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
385
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
386
  (void)
Jim Blandy's avatar
Jim Blandy committed
387
{
388
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
389 390
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
396
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
397
{
398 399 400 401 402 403
  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);
404
  return position;
Jim Blandy's avatar
Jim Blandy committed
405 406
}

407 408

/* Return the start or end position of the region.
409
   BEGINNINGP means return the start.
410 411
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
412
static Lisp_Object
413
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
414
{
415
  Lisp_Object m;
416

417 418
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
419
      && NILP (BVAR (current_buffer, mark_active)))
420
    xsignal0 (Qmark_inactive);
421

Tom Tromey's avatar
Tom Tromey committed
422
  m = Fmarker_position (BVAR (current_buffer, mark));
423
  if (NILP (m))
424
    error ("The mark is not set now, so there is no region");
425

426
  /* Clip to the current narrowing (bug#11770).  */
427
  return make_number ((PT < XFASTINT (m)) == beginningp
428 429
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
430 431 432
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
433
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
434
  (void)
Jim Blandy's avatar
Jim Blandy committed
435
{
436
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
437 438 439
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
440
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
441
  (void)
Jim Blandy's avatar
Jim Blandy committed
442
{
443
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
444 445 446
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
447
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
448
Watch out!  Moving this marker changes the mark position.
449
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
450
  (void)
Jim Blandy's avatar
Jim Blandy committed
451
{
Tom Tromey's avatar
Tom Tromey committed
452
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
453
}
454 455


456 457 458 459
/* 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.  */

460 461
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
462
{
463 464
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
465
  ptrdiff_t startpos, endpos;
466
  ptrdiff_t idx = 0;
467

468
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
469
    {
470
      XSETMISC (overlay, tail);
471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486

      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++;
	}
    }

487
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
488
    {
489
      XSETMISC (overlay, tail);
490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507

      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;
}

508 509 510 511 512 513 514 515 516
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)
517 518 519 520 521
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
522
  else if (WINDOWP (object))
523
    object = XWINDOW (object)->contents;
524 525 526 527 528 529 530

  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
531
    {
532
      EMACS_INT posn = XINT (position);
533
      ptrdiff_t noverlays;
534 535
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
536
      USE_SAFE_ALLOCA;
537 538 539 540

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
541 542 543
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
544 545 546 547
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
548
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
549
	{
550
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
	  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
		{
573
		  SAFE_FREE ();
574 575 576 577
		  return tem;
		}
	    }
	}
578
      SAFE_FREE ();
579

580
      { /* Now check the text properties.  */
581 582 583 584 585 586 587 588 589 590
	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;
      }
591 592 593
    }
}

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

598 599 600
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

601
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
602 603 604 605
   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
606
   non-nil case, if two fields are separated by a field with the special
607 608 609
   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.
610 611 612 613

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

614
static void
615 616
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
617
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
618
{
619 620
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
621 622 623 624
  /* 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;
625

626 627 628
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
629
    CHECK_NUMBER_COERCE_MARKER (pos);
630

631
  after_field
632
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
633 634
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
635
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
636
					Qfield, Qnil, NULL)
637 638 639
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
640 641 642 643 644 645 646

  /* 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.  */
647
  if (NILP (merge_at_boundary))
648
    {
649
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
650
      if (!EQ (field, after_field))
651
	at_field_end = 1;
652 653
      if (!EQ (field, before_field))
	at_field_start = 1;
654 655 656 657 658 659
      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;
660 661
    }

662 663 664 665 666 667
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

668
     In this situation, if merge_at_boundary is non-nil, consider the
669 670 671 672
     `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
673
     (a field with a `field' char-property of 'boundary), then ignore
674 675 676 677 678 679
     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
680
     anywhere in-between (within the `boundary' field), merge all
681 682 683
     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.  */

684
  if (beg)
685 686 687 688 689 690 691 692
    {
      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.  */
	{
693
	  Lisp_Object p = pos;
694 695
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
696
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
697
						       beg_limit);
698 699 700 701

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
702 703
	}
    }
704 705

  if (end)
706 707 708 709 710 711 712 713 714 715
    {
      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.  */
716 717
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
718

719 720
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
721 722 723
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
724
}
725

726

727
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
728
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
729
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
730
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
731
  (Lisp_Object pos)
732
{
733
  ptrdiff_t beg, end;
734
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
735 736
  if (beg != end)
    del_range (beg, end);
737
  return Qnil;
738 739 740
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
741
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
742
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
743
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
744
  (Lisp_Object pos)
745
{
746
  ptrdiff_t beg, end;
747
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
748 749 750 751
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
752
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
753
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
754
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
755
  (Lisp_Object pos)
756
{
757
  ptrdiff_t beg, end;
758
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
759 760 761
  return make_buffer_string (beg, end, 0);
}

762
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
763
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
764 765 766
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
767 768
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
769
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
770
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
771
{
772
  ptrdiff_t beg;
773
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
774 775 776
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
777
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
778
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
779 780 781
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,
782 783
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
784
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
785
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
786
{
787
  ptrdiff_t end;
788
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
789 790 791
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
792
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
793
       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
794
A field is a region of text with the same `field' property.
795 796 797 798

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
799 800 801 802 803 804 805 806 807 808 809 810 811

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
812
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
813 814 815 816 817 818
\\[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.

819
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
820 821
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
822 823
{
  /* If non-zero, then the original point, before re-positioning.  */
824
  ptrdiff_t orig_point = 0;
825
  bool fwd;
826
  Lisp_Object prev_old, prev_new;
827

828 829 830 831 832 833 834
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

835 836 837
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

838
  fwd = (XINT (new_pos) > XINT (old_pos));
839

840 841
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
842

843 844
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
845 846
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
847
          /* To recognize field boundaries, we must also look at the
848
             previous positions; we could use `Fget_pos_property'
849 850 851
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
852
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
853
          || (XFASTINT (old_pos) > BEGV
854
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
855
      && (NILP (inhibit_capture_property)
856 857 858
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
859
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
860
              && (XFASTINT (old_pos) <= BEGV
861 862 863 864
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
865 866
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
867
    {
868
      ptrdiff_t shortage;
869 870 871
      Lisp_Object field_bound;

      if (fwd)
872
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
873
      else
874
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
875

876 877 878 879 880 881 882 883
      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
884
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
885 886 887 888
	  && (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.  */
889 890
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
891
				fwd ? -1 : 1, &shortage, NULL, 1),
892
		  shortage != 0)))
893 894 895 896 897 898 899 900 901 902
	/* 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;
}
903

904

Paul Eggert's avatar
Paul Eggert committed
905
DEFUN ("line-beginning-position",
906
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
907
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
908 909
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
910

Chong Yidong's avatar
Chong Yidong committed
911 912 913
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.
914

915
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
916
unless that position would be on a different line than the original,
917 918
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
919
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
920

921
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
922
  (Lisp_Object n)
923
{
924
  ptrdiff_t charpos, bytepos;
925 926 927 928

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
929
    CHECK_NUMBER (n);
930

931
  scan_newline_from_point (XINT (n) - 1, &charpos, &bytepos);
932

933
  /* Return END constrained to the current input field.  */
934
  return Fconstrain_to_field (make_number (charpos), make_number (PT),
935
			      XINT (n) != 1 ? Qt : Qnil,
936
			      Qt, Qnil);
937 938
}

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

Chong Yidong's avatar
Chong Yidong committed
944 945 946
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.
947

948 949 950 951
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
952 953
boundaries bind `inhibit-field-text-motion' to t.

954
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
955
  (Lisp_Object n)
956
{
957 958 959
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
960

961 962 963
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
964
    CHECK_NUMBER (n);
965

966
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
967 968
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
969 970

  /* Return END_POS constrained to the current input field.  */
971
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
972
			      Qnil, Qt, Qnil);
973
}
974

975 976 977 978
/* 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
979
Lisp_Object
980
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
981
{
982 983
  return make_save_obj_obj_obj_obj
    (Fpoint_marker (),
984
     Qnil,