editfns.c 180 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
#include <math.h>
51

Paul Eggert's avatar
Paul Eggert committed
52 53 54 55 56 57 58 59 60 61
#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

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

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

77 78
#define TM_YEAR_BASE 1900

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

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

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

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

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

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

112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130
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
131 132
static _Noreturn void
invalid_time_zone_specification (Lisp_Object zone)
133
{
Paul Eggert's avatar
Paul Eggert committed
134
  xsignal2 (Qerror, build_string ("Invalid time zone specification"), zone);
135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152
}

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

  if (NILP (zone))
    return local_tz;
161
  else if (EQ (zone, Qt) || EQ (zone, make_fixnum (0)))
162 163 164 165 166 167
    {
      zone_string = "UTC0";
      new_tz = utc_tz;
    }
  else
    {
168
      bool plain_integer = FIXNUMP (zone);
169

170 171 172
      if (EQ (zone, Qwall))
	zone_string = 0;
      else if (STRINGP (zone))
173
	zone_string = SSDATA (ENCODE_SYSTEM (zone));
174
      else if (plain_integer || (CONSP (zone) && FIXNUMP (XCAR (zone))
175
				 && CONSP (XCDR (zone))))
176
	{
Paul Eggert's avatar
Paul Eggert committed
177
	  Lisp_Object abbr UNINIT;
178 179 180 181 182 183
	  if (!plain_integer)
	    {
	      abbr = XCAR (XCDR (zone));
	      zone = XCAR (zone);
	    }

Tom Tromey's avatar
Tom Tromey committed
184
	  EMACS_INT abszone = eabs (XFIXNUM (zone)), hour = abszone / (60 * 60);
185 186 187 188 189 190 191 192 193 194 195 196 197
	  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;
		}
198
	      sprintf (tzbuf, tzbuf_format, prec,
Tom Tromey's avatar
Tom Tromey committed
199 200
		       XFIXNUM (zone) < 0 ? -numzone : numzone,
		       &"-"[XFIXNUM (zone) < 0], hour, min, sec);
201 202 203 204 205 206 207
	      zone_string = tzbuf;
	    }
	  else
	    {
	      AUTO_STRING (leading, "<");
	      AUTO_STRING_WITH_LEN (trailing, tzbuf,
				    sprintf (tzbuf, trailing_tzbuf_format,
Tom Tromey's avatar
Tom Tromey committed
208
					     &"-"[XFIXNUM (zone) < 0],
209 210 211 212
					     hour, min, sec));
	      zone_string = SSDATA (concat3 (leading, ENCODE_SYSTEM (abbr),
					     trailing));
	    }
213 214
	}
      else
Paul Eggert's avatar
Paul Eggert committed
215 216 217
	invalid_time_zone_specification (zone);

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

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

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

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

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
324 325
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
326
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
327 328 329 330 331
  if (! NILP (tem))
    tem = Vuser_login_name;
  else
    {
      uid_t euid = geteuid ();
332
      tem = INT_TO_INTEGER (euid);
333 334
    }
  Vuser_full_name = Fuser_full_name (tem);
Sam Steingold's avatar
Sam Steingold committed
335

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

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

361
  CHECK_CHARACTER (character);
Tom Tromey's avatar
Tom Tromey committed
362
  c = XFIXNAT (character);
Jim Blandy's avatar
Jim Blandy committed
363

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

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

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

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

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

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
420
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
421
{
422 423
  if (MARKERP (position))
    set_point_from_marker (position);
424
  else if (FIXNUMP (position))
Tom Tromey's avatar
Tom Tromey committed
425
    SET_PT (clip_to_bounds (BEGV, XFIXNUM (position), ZV));
426 427
  else
    wrong_type_argument (Qinteger_or_marker_p, position);
428
  return position;
Jim Blandy's avatar
Jim Blandy committed
429 430
}

431 432

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

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

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

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

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

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

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

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

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

484 485
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
486
{
487
  ptrdiff_t idx = 0;
488

489 490
  for (struct Lisp_Overlay *tail = current_buffer->overlays_before;
       tail; tail = tail->next)
491
    {
492 493 494
      Lisp_Object overlay = make_lisp_ptr (tail, Lisp_Vectorlike);
      Lisp_Object end = OVERLAY_END (overlay);
      ptrdiff_t endpos = OVERLAY_POSITION (end);
495 496
      if (endpos < pos)
	  break;
497 498
      Lisp_Object start = OVERLAY_START (overlay);
      ptrdiff_t startpos = OVERLAY_POSITION (start);
499 500 501 502 503 504 505 506 507
      if (startpos <= pos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  /* Keep counting overlays even if we can't return them all.  */
	  idx++;
	}
    }

508 509
  for (struct Lisp_Overlay *tail = current_buffer->overlays_after;
       tail; tail = tail->next)
510
    {
511 512 513
      Lisp_Object overlay = make_lisp_ptr (tail, Lisp_Vectorlike);
      Lisp_Object start = OVERLAY_START (overlay);
      ptrdiff_t startpos = OVERLAY_POSITION (start);
514 515
      if (pos < startpos)
	break;
516 517
      Lisp_Object end = OVERLAY_END (overlay);
      ptrdiff_t endpos = OVERLAY_POSITION (end);
518 519 520 521 522 523 524 525 526 527 528
      if (pos <= endpos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  idx++;
	}
    }

  return idx;
}

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

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

  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
552
    {
Tom Tromey's avatar
Tom Tromey committed
553
      EMACS_INT posn = XFIXNUM (position);
554
      ptrdiff_t noverlays;
555 556
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
557
      USE_SAFE_ALLOCA;
558 559 560 561

      set_buffer_temp (XBUFFER (object));

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

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

601
      { /* Now check the text properties.  */
602 603 604 605
	int stickiness = text_property_stickiness (prop, position, object);
	if (stickiness > 0)
	  return Fget_text_property (position, prop, object);
	else if (stickiness < 0
Tom Tromey's avatar
Tom Tromey committed
606 607
		 && XFIXNUM (position) > BUF_BEGV (XBUFFER (object)))
	  return Fget_text_property (make_fixnum (XFIXNUM (position) - 1),
608 609 610 611
				     prop, object);
	else
	  return Qnil;
      }
612 613 614
    }
}

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

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

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

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

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

647 648 649
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
650
    CHECK_FIXNUM_COERCE_MARKER (pos);
651

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

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

683 684 685 686 687 688
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

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

705
  if (beg)
706 707 708 709
    {
      if (at_field_start)
	/* POS is at the edge of a field, and we should consider it as
	   the beginning of the following field.  */
Tom Tromey's avatar
Tom Tromey committed
710
	*beg = XFIXNAT (pos);
711 712 713
      else
	/* Find the previous field boundary.  */
	{
714
	  Lisp_Object p = pos;
715 716
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
717
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
718
						       beg_limit);
719 720 721

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
Tom Tromey's avatar
Tom Tromey committed
722
	  *beg = NILP (p) ? BEGV : XFIXNAT (p);
723 724
	}
    }
725 726

  if (end)
727 728 729 730
    {
      if (at_field_end)
	/* POS is at the edge of a field, and we should consider it as
	   the end of the previous field.  */
Tom Tromey's avatar
Tom Tromey committed
731
	*end = XFIXNAT (pos);
732 733 734 735 736
      else
	/* Find the next field boundary.  */
	{
	  if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
	    /* Skip a `boundary' field.  */
737 738
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
739

740 741
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
Tom Tromey's avatar
Tom Tromey committed
742
	  *end = NILP (pos) ? ZV : XFIXNAT (pos);
743 744
	}
    }
745
}
746

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

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

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

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

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

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

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

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

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

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

856 857
  CHECK_FIXNUM_COERCE_MARKER (new_pos);
  CHECK_FIXNUM_COERCE_MARKER (old_pos);
858

Tom Tromey's avatar
Tom Tromey committed
859
  fwd = (XFIXNUM (new_pos) > XFIXNUM (old_pos));
860

Tom Tromey's avatar
Tom Tromey committed
861 862
  prev_old = make_fixnum (XFIXNUM (old_pos) - 1);
  prev_new = make_fixnum (XFIXNUM (new_pos) - 1);
863

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

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

897 898 899 900
      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.  */
Tom Tromey's avatar
Tom Tromey committed
901
	  ((XFIXNAT (field_bound) < XFIXNAT (new_pos)) ? fwd : !fwd)
902 903 904
	  /* 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
905
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
906 907 908 909
	  && (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.  */
Tom Tromey's avatar
Tom Tromey committed
910 911
	      || (find_newline (XFIXNAT (new_pos), -1,
				XFIXNAT (field_bound), -1,
912
				fwd ? -1 : 1, &shortage, NULL, 1),
913
		  shortage != 0)))
914 915 916
	/* Constrain NEW_POS to FIELD_BOUND.  */
	new_pos = field_bound;

Tom Tromey's avatar
Tom Tromey committed
917
      if (orig_point && XFIXNAT (new_pos) != orig_point)
918
	/* The NEW_POS argument was originally nil, so automatically set PT. */
Tom Tromey's avatar
Tom Tromey committed
919
	SET_PT (XFIXNAT (new_pos));
920 921 922 923
    }

  return new_pos;
}
924

925

Paul Eggert's avatar
Paul Eggert committed
926
DEFUN ("line-beginning-position",
927
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
928
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
929 930
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
931

Chong Yidong's avatar
Chong Yidong committed
932 933 934
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.
935

936
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
937
unless that position would be on a different line than the original,
938 939
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
940
boundaries, bind `inhibit-field-text-motion' to t.