editfns.c 172 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-2018 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

Paul Eggert's avatar
Paul Eggert committed
51 52 53 54 55 56 57 58 59 60
#ifdef HAVE_TIMEZONE_T
# include <sys/param.h>
# if defined __NetBSD_Version__ && __NetBSD_Version__ < 700000000
#  define HAVE_TZALLOC_BUG true
# endif
#endif
#ifndef HAVE_TZALLOC_BUG
# define HAVE_TZALLOC_BUG false
#endif

61
#include <c-ctype.h>
62
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
63
#include <stdlib.h>
Paul Eggert's avatar
Paul Eggert committed
64
#include <strftime.h>
65
#include <verify.h>
66

67
#include "composite.h"
68
#include "intervals.h"
69
#include "ptr-bounds.h"
70
#include "character.h"
71
#include "buffer.h"
72
#include "coding.h"
Jim Blandy's avatar
Jim Blandy committed
73
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
74
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
75

76 77
#define TM_YEAR_BASE 1900

78
#ifdef WINDOWSNT
79
extern Lisp_Object w32_get_internal_run_time (void);
80 81
#endif

82
static struct lisp_time lisp_time_struct (Lisp_Object, int *);
83
static Lisp_Object format_time_string (char const *, ptrdiff_t, struct timespec,
84
				       Lisp_Object, struct tm *);
85
static long int tm_gmtoff (struct tm *);
86
static int tm_diff (struct tm *, struct tm *);
87
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
88
static Lisp_Object styled_format (ptrdiff_t, Lisp_Object *, bool);
89

90 91 92 93
#ifndef HAVE_TM_GMTOFF
# define HAVE_TM_GMTOFF false
#endif

94 95
enum { tzeqlen = sizeof "TZ=" - 1 };

Paul Eggert's avatar
Paul Eggert committed
96
/* Time zones equivalent to current local time and to UTC, respectively.  */
97 98
static timezone_t local_tz;
static timezone_t const utc_tz = 0;
99

100 101 102 103 104 105 106 107 108 109 110
/* 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;
}

111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129
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;
}

Paul Eggert's avatar
Paul Eggert committed
130 131
static _Noreturn void
invalid_time_zone_specification (Lisp_Object zone)
132
{
Paul Eggert's avatar
Paul Eggert committed
133
  xsignal2 (Qerror, build_string ("Invalid time zone specification"), zone);
134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151
}

/* 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
152 153 154
  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)];
155 156 157 158 159
  char const *zone_string;
  timezone_t new_tz;

  if (NILP (zone))
    return local_tz;
Paul Eggert's avatar
Paul Eggert committed
160
  else if (EQ (zone, Qt) || EQ (zone, make_number (0)))
161 162 163 164 165 166
    {
      zone_string = "UTC0";
      new_tz = utc_tz;
    }
  else
    {
167 168
      bool plain_integer = INTEGERP (zone);

169 170 171
      if (EQ (zone, Qwall))
	zone_string = 0;
      else if (STRINGP (zone))
172 173 174
	zone_string = SSDATA (ENCODE_SYSTEM (zone));
      else if (plain_integer || (CONSP (zone) && INTEGERP (XCAR (zone))
				 && CONSP (XCDR (zone))))
175
	{
176 177 178 179 180 181 182
	  Lisp_Object abbr;
	  if (!plain_integer)
	    {
	      abbr = XCAR (XCDR (zone));
	      zone = XCAR (zone);
	    }

183
	  EMACS_INT abszone = eabs (XINT (zone)), hour = abszone / (60 * 60);
184 185 186 187 188 189 190 191 192 193 194 195 196
	  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;
		}
197 198
	      sprintf (tzbuf, tzbuf_format, prec,
		       XINT (zone) < 0 ? -numzone : numzone,
199 200 201 202 203 204 205 206 207 208 209 210 211
		       &"-"[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));
	    }
212 213
	}
      else
Paul Eggert's avatar
Paul Eggert committed
214 215 216
	invalid_time_zone_specification (zone);

      new_tz = tzalloc (zone_string);
Paul Eggert's avatar
Paul Eggert committed
217

Paul Eggert's avatar
Paul Eggert committed
218
      if (HAVE_TZALLOC_BUG && !new_tz && errno != ENOMEM && plain_integer
Paul Eggert's avatar
Paul Eggert committed
219 220
	  && XINT (zone) % (60 * 60) == 0)
	{
Paul Eggert's avatar
Paul Eggert committed
221 222
	  /* tzalloc mishandles POSIX strings; fall back on tzdb if
	     possible (Bug#30738).  */
Paul Eggert's avatar
Paul Eggert committed
223 224 225 226
	  sprintf (tzbuf, "Etc/GMT%+"pI"d", - (XINT (zone) / (60 * 60)));
	  new_tz = tzalloc (zone_string);
	}

Paul Eggert's avatar
Paul Eggert committed
227 228 229 230 231 232
      if (!new_tz)
	{
	  if (errno == ENOMEM)
	    memory_full (SIZE_MAX);
	  invalid_time_zone_specification (zone);
	}
233 234 235 236 237 238
    }

  if (settz)
    {
      block_input ();
      emacs_setenv_TZ (zone_string);
Paul Eggert's avatar
Paul Eggert committed
239
      tzset ();
240 241 242 243 244 245 246 247 248
      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
249
void
250
init_editfns (bool dumping)
Jim Blandy's avatar
Jim Blandy committed
251
{
Paul Eggert's avatar
Paul Eggert committed
252
#if !defined CANNOT_DUMP
253 254 255 256 257
  /* 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

258
  const char *user_name;
259
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
260 261 262 263
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
264
  init_and_cache_system_name ();
Jim Blandy's avatar
Jim Blandy committed
265 266

#ifndef CANNOT_DUMP
267 268
  /* When just dumping out, set the time zone to a known unlikely value
     and skip the rest of this function.  */
269
  if (dumping)
270
    {
271
      xputenv (dump_tz_string);
272 273 274 275 276 277
      tzset ();
      return;
    }
#endif

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

Paul Eggert's avatar
Paul Eggert committed
279
#if !defined CANNOT_DUMP
280 281 282 283 284
  /* 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.  */
285
  if (tz && strcmp (tz, &dump_tz_string[tzeqlen]) == 0)
286 287 288 289 290 291 292
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

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

297
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
298 299
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
300
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
301
     (The DVX libraries override the Djgpp libraries here.)  */
302
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
303
#else
304
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
305
#endif
Jim Blandy's avatar
Jim Blandy committed
306

Jim Blandy's avatar
Jim Blandy committed
307 308
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
309
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
310
  if (!user_name)
311
#ifdef WINDOWSNT
312
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
313
#else  /* WINDOWSNT */
314
    user_name = getenv ("USER");
315
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
316 317
  if (!user_name)
    {
318 319
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
320
    }
321
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
322

Jim Blandy's avatar
Jim Blandy committed
323 324
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
325
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
326 327 328 329 330 331 332 333
  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
334

335
  p = getenv ("NAME");
336 337
  if (p)
    Vuser_full_name = build_string (p);
338 339
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
340 341 342 343 344 345 346 347 348 349

#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
350 351
}

Paul Eggert's avatar
Paul Eggert committed
352
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
353 354
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
355
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
356
{
357
  int c, len;
358
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
359

360
  CHECK_CHARACTER (character);
361
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
362

363
  len = CHAR_STRING (c, str);
364
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
365 366
}

367
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
368
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
369
  (Lisp_Object byte)
370
{
371
  unsigned char b;
372
  CHECK_NUMBER (byte);
373 374
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
375
  b = XINT (byte);
376
  return make_string_from_bytes ((char *) &b, 1, 1);
377 378
}

Jim Blandy's avatar
Jim Blandy committed
379
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
380
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
381
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
382 383
{
  register Lisp_Object val;
384
  CHECK_STRING (string);
385
  if (SCHARS (string))
386 387
    {
      if (STRING_MULTIBYTE (string))
388
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
389
      else
390
	XSETFASTINT (val, SREF (string, 0));
391
    }
Jim Blandy's avatar
Jim Blandy committed
392
  else
393
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
394 395 396
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
397
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
398 399
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
400
  (void)
Jim Blandy's avatar
Jim Blandy committed
401 402
{
  Lisp_Object temp;
403
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
404 405 406
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
407
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
408
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
409
  (void)
Jim Blandy's avatar
Jim Blandy committed
410
{
411
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
412 413
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
419
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
420
{
421 422 423 424 425 426
  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);
427
  return position;
Jim Blandy's avatar
Jim Blandy committed
428 429
}

430 431

/* Return the start or end position of the region.
432
   BEGINNINGP means return the start.
433 434
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
435
static Lisp_Object
436
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
437
{
438
  Lisp_Object m;
439

440 441
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
442
      && NILP (BVAR (current_buffer, mark_active)))
443
    xsignal0 (Qmark_inactive);
444

Tom Tromey's avatar
Tom Tromey committed
445
  m = Fmarker_position (BVAR (current_buffer, mark));
446
  if (NILP (m))
447
    error ("The mark is not set now, so there is no region");
448

449
  /* Clip to the current narrowing (bug#11770).  */
450
  return make_number ((PT < XFASTINT (m)) == beginningp
451 452
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
453 454 455
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
456
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
457
  (void)
Jim Blandy's avatar
Jim Blandy committed
458
{
459
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
460 461 462
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
463
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
464
  (void)
Jim Blandy's avatar
Jim Blandy committed
465
{
466
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
467 468 469
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
470
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
471
Watch out!  Moving this marker changes the mark position.
472
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
473
  (void)
Jim Blandy's avatar
Jim Blandy committed
474
{
Tom Tromey's avatar
Tom Tromey committed
475
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
476
}
477 478


479 480 481 482
/* 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.  */

483 484
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
485
{
486 487
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
488
  ptrdiff_t startpos, endpos;
489
  ptrdiff_t idx = 0;
490

491
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
492
    {
493
      XSETMISC (overlay, tail);
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509

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

510
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
511
    {
512
      XSETMISC (overlay, tail);
513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530

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

531 532 533 534 535 536 537 538 539
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)
540 541 542 543 544
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
545
  else if (WINDOWP (object))
546
    object = XWINDOW (object)->contents;
547 548 549 550 551 552 553

  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
554
    {
555
      EMACS_INT posn = XINT (position);
556
      ptrdiff_t noverlays;
557 558
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
559
      USE_SAFE_ALLOCA;
560 561 562 563

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
564 565 566
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
567 568 569 570
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
571
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
572
	{
573
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595
	  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
		{
596
		  SAFE_FREE ();
597 598 599 600
		  return tem;
		}
	    }
	}
601
      SAFE_FREE ();
602

603
      { /* Now check the text properties.  */
604 605 606 607 608 609 610 611 612 613
	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;
      }
614 615 616
    }
}

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

621 622 623
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

624
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
625 626 627 628
   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
629
   non-nil case, if two fields are separated by a field with the special
630 631 632
   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.
633 634 635 636

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

637
static void
638 639
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
640
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
641
{
642 643
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
644 645 646 647
  /* 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;
648

649 650 651
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
652
    CHECK_NUMBER_COERCE_MARKER (pos);
653

654
  after_field
655
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
656 657
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
658
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
659
					Qfield, Qnil, NULL)
660 661 662
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
663 664 665 666 667 668 669

  /* 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.  */
670
  if (NILP (merge_at_boundary))
671
    {
672
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
673
      if (!EQ (field, after_field))
674
	at_field_end = 1;
675 676
      if (!EQ (field, before_field))
	at_field_start = 1;
677 678 679 680 681 682
      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;
683 684
    }

685 686 687 688 689 690
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

691
     In this situation, if merge_at_boundary is non-nil, consider the
692 693 694 695
     `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
696
     (a field with a `field' char-property of 'boundary), then ignore
697 698 699 700 701 702
     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
703
     anywhere in-between (within the `boundary' field), merge all
704 705 706
     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.  */

707
  if (beg)
708 709 710 711 712 713 714 715
    {
      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.  */
	{
716
	  Lisp_Object p = pos;
717 718
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
719
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
720
						       beg_limit);
721 722 723 724

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
725 726
	}
    }
727 728

  if (end)
729 730 731 732 733 734 735 736 737 738
    {
      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.  */
739 740
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
741

742 743
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
744 745 746
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
747
}
748

749

750
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
751
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
752
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
753
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
754
  (Lisp_Object pos)
755
{
756
  ptrdiff_t beg, end;
757
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
758 759
  if (beg != end)
    del_range (beg, end);
760
  return Qnil;
761 762 763
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
764
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
765
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
766
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
767
  (Lisp_Object pos)
768
{
769
  ptrdiff_t beg, end;
770
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
771 772 773 774
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
775
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
776
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
777
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
778
  (Lisp_Object pos)
779
{
780
  ptrdiff_t beg, end;
781
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
782 783 784
  return make_buffer_string (beg, end, 0);
}

785
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
786
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
787 788 789
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
790 791
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
792
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
793
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
794
{
795
  ptrdiff_t beg;
796
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
797 798 799
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
800
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
801
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
802 803 804
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,
805 806
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
807
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
808
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
809
{
810
  ptrdiff_t end;
811
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
812 813 814
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
815
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
816
       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
817
A field is a region of text with the same `field' property.
818 819 820 821

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
822 823 824 825 826 827 828 829 830 831 832 833 834

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
835
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
836 837 838 839 840 841
\\[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.

842
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
843 844
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
845 846
{
  /* If non-zero, then the original point, before re-positioning.  */
847
  ptrdiff_t orig_point = 0;
848
  bool fwd;
849
  Lisp_Object prev_old, prev_new;
850

851 852 853 854 855 856 857
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

858 859 860
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

861
  fwd = (XINT (new_pos) > XINT (old_pos));
862

863 864
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
865

866 867
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
868 869
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
870
          /* To recognize field boundaries, we must also look at the
871
             previous positions; we could use `Fget_pos_property'
872 873 874
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
875
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
876
          || (XFASTINT (old_pos) > BEGV
877
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
878
      && (NILP (inhibit_capture_property)
879 880 881
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
882
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
883
              && (XFASTINT (old_pos) <= BEGV
884 885 886 887
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
888 889
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
890
    {
891
      ptrdiff_t shortage;
892 893 894
      Lisp_Object field_bound;

      if (fwd)
895
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
896
      else
897
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
898

899 900 901 902 903 904 905 906
      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
907
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
908 909 910 911
	  && (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.  */
912 913
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
914
				fwd ? -1 : 1, &shortage, NULL, 1),
915
		  shortage != 0)))
916 917 918 919 920 921 922 923 924 925
	/* 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;
}
926

927