editfns.c 158 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-2016 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 "composite.h"
56
#include "intervals.h"
57
#include "character.h"
58
#include "buffer.h"
59
#include "coding.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
static Lisp_Object styled_format (ptrdiff_t, Lisp_Object *, bool);
76

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

81 82 83 84 85 86 87
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;
88

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

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

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

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

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

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

219 220 221 222 223 224
#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.  */
225
  if (tz && strcmp (tz, &dump_tz_string[tzeqlen]) == 0)
226 227 228 229 230 231 232
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

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

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

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

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

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

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

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

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

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

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

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

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

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

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

371 372

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

      set_buffer_temp (XBUFFER (object));

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

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

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

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

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

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

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

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

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

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

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

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

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

	xxxx.yyyy

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

918
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
919
  (Lisp_Object n)
920
{
921 922 923
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
924

925 926 927
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
928
    CHECK_NUMBER (n);
929

930
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
931 932
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
933 934

  /* Return END_POS constrained to the current input field.  */
935
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
936
			      Qnil, Qt, Qnil);
937
}
938

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

Jim Blandy's avatar
Jim Blandy committed
943
Lisp_Object
944
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
945
{
946 947
  return make_save_obj_obj_obj_obj
    (Fpoint_marker (),
948
     Qnil,
949
     /* Selected window if current buffer is shown in it, nil otherwise.  */
950
     (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
951
      ? selected_window : Qnil),
952
     Qnil);
Jim Blandy's avatar
Jim Blandy committed
953 954
}

955 956
/* Restore saved buffer before leaving `save-excursion' special form.  */

957
void
958
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
959
{
960
  Lisp_Object tem, tem1;
961

962
  tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
963 964
  /* If we're unwinding to top level, saved buffer may be deleted.  This
     means that all of its markers are unchained and so tem is nil.  */
965
  if (NILP (tem))
966
    goto out;
967 968 969 970

  Fset_buffer (tem);

  /* Point marker.  */
971
  tem = XSAVE_OBJECT (info, 0);
972 973 974 975 976 977
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* If buffer was visible in a window, and a different window was
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */