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

3
Copyright (C) 1985-1987, 1989, 1993-2014 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 <float.h>
48 49
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
50
#include <strftime.h>
51
#include <verify.h>
52

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

61 62
#define TM_YEAR_BASE 1900

63
#ifdef WINDOWSNT
64
extern Lisp_Object w32_get_internal_run_time (void);
65 66
#endif

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

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

79
static Lisp_Object Qbuffer_access_fontify_functions;
80

81 82 83 84 85 86
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

87
static Lisp_Object Qboundary;
88

89
/* The startup value of the TZ environment variable; null if unset.  */
90 91
static char const *initial_tz;

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

Jim Blandy's avatar
Jim Blandy committed
96
void
97
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
98
{
99
  const char *user_name;
100
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
101 102 103 104
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
105
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
106 107

#ifndef CANNOT_DUMP
108 109
  /* When just dumping out, set the time zone to a known unlikely value
     and skip the rest of this function.  */
Jim Blandy's avatar
Jim Blandy committed
110
  if (!initialized)
111 112
    {
# ifdef HAVE_TZSET
113
      xputenv (dump_tz_string);
114 115 116 117 118 119 120 121
      tzset ();
# endif
      return;
    }
#endif

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

123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139
#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.  */
  if (tz && strcmp (tz, &dump_tz_string[sizeof "TZ=" - 1]) == 0)
    {
      ++*tz;
      tzset ();
      --*tz;
    }
#endif

  /* Call set_time_zone_rule now, so that its call to putenv is done
     before multiple threads are active.  */
  set_time_zone_rule (tz);
140

141
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
142 143
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
144
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
145
     (The DVX libraries override the Djgpp libraries here.)  */
146
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
147
#else
148
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
149
#endif
Jim Blandy's avatar
Jim Blandy committed
150

Jim Blandy's avatar
Jim Blandy committed
151 152
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
153
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
154
  if (!user_name)
155
#ifdef WINDOWSNT
156
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
157
#else  /* WINDOWSNT */
158
    user_name = getenv ("USER");
159
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
160 161
  if (!user_name)
    {
162 163
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
164
    }
165
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
166

Jim Blandy's avatar
Jim Blandy committed
167 168
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
169
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
170 171 172 173 174 175 176 177
  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
178

179
  p = getenv ("NAME");
180 181
  if (p)
    Vuser_full_name = build_string (p);
182 183
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
184 185 186 187 188 189 190 191 192 193

#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
194 195
}

Paul Eggert's avatar
Paul Eggert committed
196
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
197 198
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
199
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
200
{
201
  int c, len;
202
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
203

204
  CHECK_CHARACTER (character);
205
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
206

207
  len = CHAR_STRING (c, str);
208
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
209 210
}

211
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
212
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
213
  (Lisp_Object byte)
214
{
215
  unsigned char b;
216
  CHECK_NUMBER (byte);
217 218
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
219
  b = XINT (byte);
220
  return make_string_from_bytes ((char *) &b, 1, 1);
221 222
}

Jim Blandy's avatar
Jim Blandy committed
223
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
224
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
225
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
226 227
{
  register Lisp_Object val;
228
  CHECK_STRING (string);
229
  if (SCHARS (string))
230 231
    {
      if (STRING_MULTIBYTE (string))
232
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
233
      else
234
	XSETFASTINT (val, SREF (string, 0));
235
    }
Jim Blandy's avatar
Jim Blandy committed
236
  else
237
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
238 239 240
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
241
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
242 243
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
244
  (void)
Jim Blandy's avatar
Jim Blandy committed
245 246
{
  Lisp_Object temp;
247
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
248 249 250
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
251
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
252
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
253
  (void)
Jim Blandy's avatar
Jim Blandy committed
254
{
255
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
256 257
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
263
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
264
{
265 266 267 268 269 270
  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);
271
  return position;
Jim Blandy's avatar
Jim Blandy committed
272 273
}

274 275

/* Return the start or end position of the region.
276
   BEGINNINGP means return the start.
277 278
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
279
static Lisp_Object
280
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
281
{
282
  Lisp_Object m;
283

284 285
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
286
      && NILP (BVAR (current_buffer, mark_active)))
287
    xsignal0 (Qmark_inactive);
288

Tom Tromey's avatar
Tom Tromey committed
289
  m = Fmarker_position (BVAR (current_buffer, mark));
290
  if (NILP (m))
291
    error ("The mark is not set now, so there is no region");
292

293
  /* Clip to the current narrowing (bug#11770).  */
294
  return make_number ((PT < XFASTINT (m)) == beginningp
295 296
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
297 298 299
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
300
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
301
  (void)
Jim Blandy's avatar
Jim Blandy committed
302
{
303
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
304 305 306
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
307
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
308
  (void)
Jim Blandy's avatar
Jim Blandy committed
309
{
310
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
311 312 313
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
314
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
315
Watch out!  Moving this marker changes the mark position.
316
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
317
  (void)
Jim Blandy's avatar
Jim Blandy committed
318
{
Tom Tromey's avatar
Tom Tromey committed
319
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
320
}
321 322


323 324 325 326
/* 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.  */

327 328
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
329
{
330 331
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
332
  ptrdiff_t startpos, endpos;
333
  ptrdiff_t idx = 0;
334

335
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
336
    {
337
      XSETMISC (overlay, tail);
338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353

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

354
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
355
    {
356
      XSETMISC (overlay, tail);
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

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

375 376 377 378 379 380 381 382 383
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)
384 385 386 387 388
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
389
  else if (WINDOWP (object))
390
    object = XWINDOW (object)->contents;
391 392 393 394 395 396 397

  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
398
    {
399
      EMACS_INT posn = XINT (position);
400
      ptrdiff_t noverlays;
401 402
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
403
      USE_SAFE_ALLOCA;
404 405 406 407

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
408 409 410
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
411 412 413 414
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
415
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
416
	{
417
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439
	  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
		{
440
		  SAFE_FREE ();
441 442 443 444
		  return tem;
		}
	    }
	}
445
      SAFE_FREE ();
446

447
      { /* Now check the text properties.  */
448 449 450 451 452 453 454 455 456 457
	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;
      }
458 459 460
    }
}

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

465 466 467
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

468
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
469 470 471 472
   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
473
   non-nil case, if two fields are separated by a field with the special
474 475 476
   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.
477 478 479 480

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

481
static void
482 483
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
484
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
485
{
486 487
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
488 489 490 491
  /* 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;
492

493 494 495
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
496
    CHECK_NUMBER_COERCE_MARKER (pos);
497

498
  after_field
499
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
500 501
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
502
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
503
					Qfield, Qnil, NULL)
504 505 506
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
507 508 509 510 511 512 513

  /* 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.  */
514
  if (NILP (merge_at_boundary))
515
    {
516
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
517
      if (!EQ (field, after_field))
518
	at_field_end = 1;
519 520
      if (!EQ (field, before_field))
	at_field_start = 1;
521 522 523 524 525 526
      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;
527 528
    }

529 530 531 532 533 534
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

535
     In this situation, if merge_at_boundary is non-nil, consider the
536 537 538 539
     `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
540
     (a field with a `field' char-property of 'boundary), then ignore
541 542 543 544 545 546
     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
547
     anywhere in-between (within the `boundary' field), merge all
548 549 550
     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.  */

551
  if (beg)
552 553 554 555 556 557 558 559
    {
      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.  */
	{
560
	  Lisp_Object p = pos;
561 562
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
563
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
564
						       beg_limit);
565 566 567 568

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
569 570
	}
    }
571 572

  if (end)
573 574 575 576 577 578 579 580 581 582
    {
      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.  */
583 584
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
585

586 587
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
588 589 590
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
591
}
592

593

594
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
595
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
596
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
597
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
598
  (Lisp_Object pos)
599
{
600
  ptrdiff_t beg, end;
601
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
602 603
  if (beg != end)
    del_range (beg, end);
604
  return Qnil;
605 606 607
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
608
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
609
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
610
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
611
  (Lisp_Object pos)
612
{
613
  ptrdiff_t beg, end;
614
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
615 616 617 618
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
619
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
620
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
621
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
622
  (Lisp_Object pos)
623
{
624
  ptrdiff_t beg, end;
625
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
626 627 628
  return make_buffer_string (beg, end, 0);
}

629
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
630
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
631 632 633
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
634 635
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
636
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
637
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
638
{
639
  ptrdiff_t beg;
640
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
641 642 643
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
644
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
645
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
646 647 648
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,
649 650
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
651
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
652
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
653
{
654
  ptrdiff_t end;
655
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
656 657 658
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
659
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
660
       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
661
A field is a region of text with the same `field' property.
662 663 664 665

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
666 667 668 669 670 671 672 673 674 675 676 677 678

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
679
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
680 681 682 683 684 685
\\[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.

686
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
687 688
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
689 690
{
  /* If non-zero, then the original point, before re-positioning.  */
691
  ptrdiff_t orig_point = 0;
692
  bool fwd;
693
  Lisp_Object prev_old, prev_new;
694

695 696 697 698 699 700 701
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

702 703 704
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

705
  fwd = (XINT (new_pos) > XINT (old_pos));
706

707 708
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
709

710 711
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
712 713
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
714
          /* To recognize field boundaries, we must also look at the
715
             previous positions; we could use `Fget_pos_property'
716 717 718
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
719
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
720
          || (XFASTINT (old_pos) > BEGV
721
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
722
      && (NILP (inhibit_capture_property)
723 724 725
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
726
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
727
              && (XFASTINT (old_pos) <= BEGV
728 729 730 731
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
732 733
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
734
    {
735
      ptrdiff_t shortage;
736 737 738
      Lisp_Object field_bound;

      if (fwd)
739
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
740
      else
741
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
742

743 744 745 746 747 748 749 750
      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
751
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
752 753 754 755
	  && (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.  */
756 757
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
758
				fwd ? -1 : 1, &shortage, NULL, 1),
759
		  shortage != 0)))
760 761 762 763 764 765 766 767 768 769
	/* 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;
}
770

771

Paul Eggert's avatar
Paul Eggert committed
772
DEFUN ("line-beginning-position",
773
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
774
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
775 776
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
777

Chong Yidong's avatar
Chong Yidong committed
778 779 780
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.
781

782
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
783
unless that position would be on a different line than the original,
784 785
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
786
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
787

788
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
789
  (Lisp_Object n)
790
{
791
  ptrdiff_t charpos, bytepos;
792 793 794 795

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
796
    CHECK_NUMBER (n);
797

798
  scan_newline_from_point (XINT (n) - 1, &charpos, &bytepos);
799

800
  /* Return END constrained to the current input field.  */
801
  return Fconstrain_to_field (make_number (charpos), make_number (PT),
802
			      XINT (n) != 1 ? Qt : Qnil,
803
			      Qt, Qnil);
804 805
}

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

Chong Yidong's avatar
Chong Yidong committed
811 812 813
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.
814

815 816 817 818
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
819 820
boundaries bind `inhibit-field-text-motion' to t.

821
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
822
  (Lisp_Object n)
823
{
824 825 826
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
827

828 829 830
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
831
    CHECK_NUMBER (n);
832

833
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
834 835
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
836 837

  /* Return END_POS constrained to the current input field.  */
838
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
839
			      Qnil, Qt, Qnil);
840
}
841

842 843 844 845
/* 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
846
Lisp_Object
847
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
848
{
849 850
  return make_save_obj_obj_obj_obj
    (Fpoint_marker (),
851 852 853 854 855
     /* Do not copy the mark if it points to nowhere.  */
     (XMARKER (BVAR (current_buffer, mark))->buffer
      ? Fcopy_marker (BVAR (current_buffer, mark), Qnil)
      : Qnil),
     /* Selected window if current buffer is shown in it, nil otherwise.  */
856
     (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
857 858
      ? selected_window : Qnil),
     BVAR (current_buffer, mark_active));
Jim Blandy's avatar
Jim Blandy committed
859 860
}

861 862
/* Restore saved buffer before leaving `save-excursion' special form.  */

863
void
864
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
865
{
866
  Lisp_Object tem, tem1, omark, nmark;
867 868
  struct gcpro gcpro1, gcpro2, gcpro3;

869
  tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
870 871
  /* 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.  */
872
  if (NILP (tem))
873
    goto out;
874 875 876 877 878 879 880

  omark = nmark = Qnil;
  GCPRO3 (info, omark, nmark);

  Fset_buffer (tem);

  /* Point marker.  */
881
  tem = XSAVE_OBJECT (info, 0);
882 883 884 885
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* Mark marker.  */
886
  tem = XSAVE_OBJECT (info, 1);
887
  omark = Fmarker_position (BVAR (current_buffer, mark));
888 889 890 891 892 893 894 895
  if (NILP (tem))
    unchain_marker (XMARKER (BVAR (current_buffer, mark)));
  else
    {
      Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
      nmark = Fmarker_position (tem);
      unchain_marker (XMARKER (tem));
    }
896

897
  /* Mark active.  */
898
  tem = XSAVE_OBJECT (info, 3);
899
  tem1 = BVAR (current_buffer, mark_active);
Paul Eggert's avatar
Paul Eggert committed
900
  bset_mark_active (current_buffer, tem);
901 902 903 904

  /* If mark is active now, and either was not active
     or was at a different place, run the activate hook.  */
  if (! NILP (tem))
905
    {
906 907 908 909 910 911 912 913 914 915 916
      if (! EQ (omark, nmark))
        {
          tem = intern ("activate-mark-hook");
          Frun_hooks (1, &tem);
        }
    }
  /* If mark has ceased to be active, run deactivate hook.  */
  else if (! NILP (tem1))
    {
      tem = intern ("deactivate-mark-hook");
      Frun_hooks (1, &tem);
917
    }
918

919 920 921
  /* 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.  */
922
  tem = XSAVE_OBJECT (info, 2);
923
  if (WINDOWP (tem)
924
      && !EQ (tem, selected_window)
925
      && (tem1 = XWINDOW (tem)->contents,