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

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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
18
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
19 20


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

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

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

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

36 37
#include "lisp.h"

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

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

47
#include <errno.h>
48
#include <float.h>
49
#include <limits.h>
50

51
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
52
#include <strftime.h>
53
#include <verify.h>
54

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

63 64
#define TM_YEAR_BASE 1900

65
#ifdef WINDOWSNT
66
extern Lisp_Object w32_get_internal_run_time (void);
67 68
#endif

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

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

80 81 82 83 84 85 86
enum { tzeqlen = sizeof "TZ=" - 1 };

/* Time zones equivalent to current local time, to wall clock time,
   and to UTC, respectively.  */
static timezone_t local_tz;
static timezone_t wall_clock_tz;
static timezone_t const utc_tz = 0;
87

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

92 93 94 95 96 97 98 99 100 101 102
/* 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;
}

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 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191
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)
{
  static char const tzbuf_format[] = "XXX%s%"pI"d:%02d:%02d";
  char tzbuf[sizeof tzbuf_format + INT_STRLEN_BOUND (EMACS_INT)];
  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
    {
      if (EQ (zone, Qwall))
	zone_string = 0;
      else if (STRINGP (zone))
	zone_string = SSDATA (zone);
      else if (INTEGERP (zone))
	{
	  EMACS_INT abszone = eabs (XINT (zone)), hour = abszone / (60 * 60);
	  int min = (abszone / 60) % 60, sec = abszone % 60;
	  sprintf (tzbuf, tzbuf_format, &"-"[XINT (zone) < 0], hour, min, sec);
	  zone_string = tzbuf;
	}
      else
	xsignal2 (Qerror, build_string ("Invalid time zone specification"),
		  zone);
      new_tz = xtzalloc (zone_string);
    }

  if (settz)
    {
      block_input ();
      emacs_setenv_TZ (zone_string);
      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
192
void
193
init_editfns (bool dumping)
Jim Blandy's avatar
Jim Blandy committed
194
{
195
  const char *user_name;
196
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
197 198 199 200
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
201
  init_and_cache_system_name ();
Jim Blandy's avatar
Jim Blandy committed
202 203

#ifndef CANNOT_DUMP
204 205
  /* When just dumping out, set the time zone to a known unlikely value
     and skip the rest of this function.  */
206
  if (dumping)
207 208
    {
# ifdef HAVE_TZSET
209
      xputenv (dump_tz_string);
210 211 212 213 214 215 216
      tzset ();
# endif
      return;
    }
#endif

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

218 219 220 221 222 223
#if !defined CANNOT_DUMP && defined HAVE_TZSET
  /* If the execution TZ happens to be the same as the dump TZ,
     change it to some other value and then change it back,
     to force the underlying implementation to reload the TZ info.
     This is needed on implementations that load TZ info from files,
     since the TZ file contents may differ between dump and execution.  */
224
  if (tz && strcmp (tz, &dump_tz_string[tzeqlen]) == 0)
225 226 227 228 229 230 231
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

232
  /* Set the time zone rule now, so that the call to putenv is done
233
     before multiple threads are active.  */
234 235
  wall_clock_tz = xtzalloc (0);
  tzlookup (tz ? build_string (tz) : Qwall, true);
236

237
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
238 239
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
240
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
241
     (The DVX libraries override the Djgpp libraries here.)  */
242
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
243
#else
244
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
245
#endif
Jim Blandy's avatar
Jim Blandy committed
246

Jim Blandy's avatar
Jim Blandy committed
247 248
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
249
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
250
  if (!user_name)
251
#ifdef WINDOWSNT
252
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
253
#else  /* WINDOWSNT */
254
    user_name = getenv ("USER");
255
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
256 257
  if (!user_name)
    {
258 259
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
260
    }
261
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
262

Jim Blandy's avatar
Jim Blandy committed
263 264
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
265
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
266 267 268 269 270 271 272 273
  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
274

275
  p = getenv ("NAME");
276 277
  if (p)
    Vuser_full_name = build_string (p);
278 279
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
280 281 282 283 284 285 286 287 288 289

#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
290 291
}

Paul Eggert's avatar
Paul Eggert committed
292
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
293 294
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
295
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
296
{
297
  int c, len;
298
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
299

300
  CHECK_CHARACTER (character);
301
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
302

303
  len = CHAR_STRING (c, str);
304
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
305 306
}

307
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
308
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
309
  (Lisp_Object byte)
310
{
311
  unsigned char b;
312
  CHECK_NUMBER (byte);
313 314
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
315
  b = XINT (byte);
316
  return make_string_from_bytes ((char *) &b, 1, 1);
317 318
}

Jim Blandy's avatar
Jim Blandy committed
319
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
320
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
321
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
322 323
{
  register Lisp_Object val;
324
  CHECK_STRING (string);
325
  if (SCHARS (string))
326 327
    {
      if (STRING_MULTIBYTE (string))
328
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
329
      else
330
	XSETFASTINT (val, SREF (string, 0));
331
    }
Jim Blandy's avatar
Jim Blandy committed
332
  else
333
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
334 335 336
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
337
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
338 339
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
340
  (void)
Jim Blandy's avatar
Jim Blandy committed
341 342
{
  Lisp_Object temp;
343
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
344 345 346
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
347
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
348
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
349
  (void)
Jim Blandy's avatar
Jim Blandy committed
350
{
351
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
352 353
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
359
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
360
{
361 362 363 364 365 366
  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);
367
  return position;
Jim Blandy's avatar
Jim Blandy committed
368 369
}

370 371

/* Return the start or end position of the region.
372
   BEGINNINGP means return the start.
373 374
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
375
static Lisp_Object
376
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
377
{
378
  Lisp_Object m;
379

380 381
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
382
      && NILP (BVAR (current_buffer, mark_active)))
383
    xsignal0 (Qmark_inactive);
384

Tom Tromey's avatar
Tom Tromey committed
385
  m = Fmarker_position (BVAR (current_buffer, mark));
386
  if (NILP (m))
387
    error ("The mark is not set now, so there is no region");
388

389
  /* Clip to the current narrowing (bug#11770).  */
390
  return make_number ((PT < XFASTINT (m)) == beginningp
391 392
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
393 394 395
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
396
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
397
  (void)
Jim Blandy's avatar
Jim Blandy committed
398
{
399
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
400 401 402
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
403
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
404
  (void)
Jim Blandy's avatar
Jim Blandy committed
405
{
406
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
407 408 409
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
410
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
411
Watch out!  Moving this marker changes the mark position.
412
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
413
  (void)
Jim Blandy's avatar
Jim Blandy committed
414
{
Tom Tromey's avatar
Tom Tromey committed
415
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
416
}
417 418


419 420 421 422
/* 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.  */

423 424
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
425
{
426 427
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
428
  ptrdiff_t startpos, endpos;
429
  ptrdiff_t idx = 0;
430

431
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
432
    {
433
      XSETMISC (overlay, tail);
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449

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

450
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
451
    {
452
      XSETMISC (overlay, tail);
453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470

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

471 472 473 474 475 476 477 478 479
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)
480 481 482 483 484
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
485
  else if (WINDOWP (object))
486
    object = XWINDOW (object)->contents;
487 488 489 490 491 492 493

  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
494
    {
495
      EMACS_INT posn = XINT (position);
496
      ptrdiff_t noverlays;
497 498
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
499
      USE_SAFE_ALLOCA;
500 501 502 503

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
504 505 506
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
507 508 509 510
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
511
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
512
	{
513
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535
	  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
		{
536
		  SAFE_FREE ();
537 538 539 540
		  return tem;
		}
	    }
	}
541
      SAFE_FREE ();
542

543
      { /* Now check the text properties.  */
544 545 546 547 548 549 550 551 552 553
	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;
      }
554 555 556
    }
}

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

561 562 563
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

564
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
565 566 567 568
   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
569
   non-nil case, if two fields are separated by a field with the special
570 571 572
   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.
573 574 575 576

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

577
static void
578 579
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
580
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
581
{
582 583
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
584 585 586 587
  /* 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;
588

589 590 591
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
592
    CHECK_NUMBER_COERCE_MARKER (pos);
593

594
  after_field
595
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
596 597
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
598
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
599
					Qfield, Qnil, NULL)
600 601 602
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
603 604 605 606 607 608 609

  /* 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.  */
610
  if (NILP (merge_at_boundary))
611
    {
612
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
613
      if (!EQ (field, after_field))
614
	at_field_end = 1;
615 616
      if (!EQ (field, before_field))
	at_field_start = 1;
617 618 619 620 621 622
      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;
623 624
    }

625 626 627 628 629 630
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

631
     In this situation, if merge_at_boundary is non-nil, consider the
632 633 634 635
     `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
636
     (a field with a `field' char-property of 'boundary), then ignore
637 638 639 640 641 642
     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
643
     anywhere in-between (within the `boundary' field), merge all
644 645 646
     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.  */

647
  if (beg)
648 649 650 651 652 653 654 655
    {
      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.  */
	{
656
	  Lisp_Object p = pos;
657 658
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
659
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
660
						       beg_limit);
661 662 663 664

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
665 666
	}
    }
667 668

  if (end)
669 670 671 672 673 674 675 676 677 678
    {
      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.  */
679 680
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
681

682 683
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
684 685 686
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
687
}
688

689

690
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
691
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
692
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
693
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
694
  (Lisp_Object pos)
695
{
696
  ptrdiff_t beg, end;
697
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
698 699
  if (beg != end)
    del_range (beg, end);
700
  return Qnil;
701 702 703
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
704
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
705
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
706
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
707
  (Lisp_Object pos)
708
{
709
  ptrdiff_t beg, end;
710
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
711 712 713 714
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
715
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
716
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
717
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
718
  (Lisp_Object pos)
719
{
720
  ptrdiff_t beg, end;
721
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
722 723 724
  return make_buffer_string (beg, end, 0);
}

725
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
726
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
727 728 729
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
730 731
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
732
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
733
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
734
{
735
  ptrdiff_t beg;
736
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
737 738 739
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
740
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
741
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
742 743 744
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,
745 746
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
747
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
748
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
749
{
750
  ptrdiff_t end;
751
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
752 753 754
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
755
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
756
       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
757
A field is a region of text with the same `field' property.
758 759 760 761

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
762 763 764 765 766 767 768 769 770 771 772 773 774

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
775
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
776 777 778 779 780 781
\\[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.

782
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
783 784
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
785 786
{
  /* If non-zero, then the original point, before re-positioning.  */
787
  ptrdiff_t orig_point = 0;
788
  bool fwd;
789
  Lisp_Object prev_old, prev_new;
790

791 792 793 794 795 796 797
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

798 799 800
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

801
  fwd = (XINT (new_pos) > XINT (old_pos));
802

803 804
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
805

806 807
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
808 809
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
810
          /* To recognize field boundaries, we must also look at the
811
             previous positions; we could use `Fget_pos_property'
812 813 814
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
815
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
816
          || (XFASTINT (old_pos) > BEGV
817
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
818
      && (NILP (inhibit_capture_property)
819 820 821
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
822
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
823
              && (XFASTINT (old_pos) <= BEGV
824 825 826 827
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
828 829
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
830
    {
831
      ptrdiff_t shortage;
832 833 834
      Lisp_Object field_bound;

      if (fwd)
835
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
836
      else
837
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
838

839 840 841 842 843 844 845 846
      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
847
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
848 849 850 851
	  && (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.  */
852 853
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
854
				fwd ? -1 : 1, &shortage, NULL, 1),
855
		  shortage != 0)))
856 857 858 859 860 861 862 863 864 865
	/* 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;
}
866

867

Paul Eggert's avatar
Paul Eggert committed
868
DEFUN ("line-beginning-position",
869
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
870
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
871 872
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
873

Chong Yidong's avatar
Chong Yidong committed
874 875 876
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.
877

878
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
879
unless that position would be on a different line than the original,
880 881
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
882
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
883

884
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
885
  (Lisp_Object n)
886
{
887
  ptrdiff_t charpos, bytepos;
888 889 890 891

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
892
    CHECK_NUMBER (n);
893

894
  scan_newline_from_point (XINT (n) - 1, &charpos, &bytepos);
895

896
  /* Return END constrained to the current input field.  */
897
  return Fconstrain_to_field (make_number (charpos), make_number (PT),
898
			      XINT (n) != 1 ? Qt : Qnil,
899
			      Qt, Qnil);
900 901
}

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

Chong Yidong's avatar
Chong Yidong committed
907 908 909
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.
910

911 912 913 914
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
915 916
boundaries bind `inhibit-field-text-motion' to t.

917
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
918
  (Lisp_Object n)
919
{