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

3
Copyright (C) 1985-1987, 1989, 1993-2013 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 Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
68
				       bool, struct tm *);
69
static int tm_diff (struct tm *, struct tm *);
70
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
71

72
static Lisp_Object Qbuffer_access_fontify_functions;
73

74 75 76 77 78 79
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

80
static Lisp_Object Qboundary;
81

82 83 84 85 86 87 88 89 90
/* The startup value of the TZ environment variable so it can be
   restored if the user calls set-time-zone-rule with a nil
   argument.  If null, the TZ environment variable was unset.  */
static char const *initial_tz;

/* True if the static variable tzvalbuf (defined in
   set_time_zone_rule) is part of 'environ'.  */
static bool tzvalbuf_in_environ;

91

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

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

#ifndef CANNOT_DUMP
  /* Don't bother with this on initial start when just dumping out */
  if (!initialized)
    return;
#endif /* not CANNOT_DUMP */

109 110 111
  initial_tz = getenv ("TZ");
  tzvalbuf_in_environ = 0;

112
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
113 114 115 116
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
     accurate on MSDOG and because it lets Emacs find the init file.
     (The DVX libraries override the Djgpp libraries here.)  */
117
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
118
#else
119
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
120
#endif
Jim Blandy's avatar
Jim Blandy committed
121

Jim Blandy's avatar
Jim Blandy committed
122 123
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
124
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
125
  if (!user_name)
126
#ifdef WINDOWSNT
127
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
128
#else  /* WINDOWSNT */
129
    user_name = getenv ("USER");
130
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
131 132
  if (!user_name)
    {
133 134
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
135
    }
136
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
137

Jim Blandy's avatar
Jim Blandy committed
138 139
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
140
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
141 142 143 144 145 146 147 148
  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
149

150
  p = getenv ("NAME");
151 152
  if (p)
    Vuser_full_name = build_string (p);
153 154
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
155 156 157 158 159 160 161 162 163 164

#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
165 166
}

Paul Eggert's avatar
Paul Eggert committed
167
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
168 169
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
170
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
171
{
172
  int c, len;
173
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
174

175
  CHECK_CHARACTER (character);
176
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
177

178
  len = CHAR_STRING (c, str);
179
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
180 181
}

182
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
183
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
184
  (Lisp_Object byte)
185
{
186
  unsigned char b;
187
  CHECK_NUMBER (byte);
188 189
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
190
  b = XINT (byte);
191
  return make_string_from_bytes ((char *) &b, 1, 1);
192 193
}

Jim Blandy's avatar
Jim Blandy committed
194
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
195
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
196
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
197 198
{
  register Lisp_Object val;
199
  CHECK_STRING (string);
200
  if (SCHARS (string))
201 202
    {
      if (STRING_MULTIBYTE (string))
203
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
204
      else
205
	XSETFASTINT (val, SREF (string, 0));
206
    }
Jim Blandy's avatar
Jim Blandy committed
207
  else
208
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
209 210 211
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
212
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
213 214
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
215
  (void)
Jim Blandy's avatar
Jim Blandy committed
216 217
{
  Lisp_Object temp;
218
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
219 220 221
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
222
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
223
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
224
  (void)
Jim Blandy's avatar
Jim Blandy committed
225
{
226
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
227 228
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
234
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
235
{
236
  ptrdiff_t pos;
Karl Heuer's avatar
Karl Heuer committed
237

238 239
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
240 241 242 243 244 245 246 247 248 249 250 251
    {
      pos = marker_position (position);
      if (pos < BEGV)
	SET_PT_BOTH (BEGV, BEGV_BYTE);
      else if (pos > ZV)
	SET_PT_BOTH (ZV, ZV_BYTE);
      else
	SET_PT_BOTH (pos, marker_byte_position (position));

      return position;
    }

252
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
253

Karl Heuer's avatar
Karl Heuer committed
254 255
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
256
  return position;
Jim Blandy's avatar
Jim Blandy committed
257 258
}

259 260

/* Return the start or end position of the region.
261
   BEGINNINGP means return the start.
262 263
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
264
static Lisp_Object
265
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
266
{
267
  Lisp_Object m;
268

269 270
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
271
      && NILP (BVAR (current_buffer, mark_active)))
272
    xsignal0 (Qmark_inactive);
273

Tom Tromey's avatar
Tom Tromey committed
274
  m = Fmarker_position (BVAR (current_buffer, mark));
275
  if (NILP (m))
276
    error ("The mark is not set now, so there is no region");
277

278
  /* Clip to the current narrowing (bug#11770).  */
279
  return make_number ((PT < XFASTINT (m)) == beginningp
280 281
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
282 283 284
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
285
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
286
  (void)
Jim Blandy's avatar
Jim Blandy committed
287
{
288
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
289 290 291
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
292
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
293
  (void)
Jim Blandy's avatar
Jim Blandy committed
294
{
295
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
296 297 298
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
299
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
300
Watch out!  Moving this marker changes the mark position.
301
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (void)
Jim Blandy's avatar
Jim Blandy committed
303
{
Tom Tromey's avatar
Tom Tromey committed
304
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
305
}
306 307


308 309 310 311
/* 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.  */

312 313
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
314
{
315 316
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
317
  ptrdiff_t startpos, endpos;
318
  ptrdiff_t idx = 0;
319

320
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
321
    {
322
      XSETMISC (overlay, tail);
323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338

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

339
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
340
    {
341
      XSETMISC (overlay, tail);
342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367

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

/* Return the value of property PROP, in OBJECT at POSITION.
   It's the value of PROP that a char inserted at POSITION would get.
   OBJECT is optional and defaults to the current buffer.
   If OBJECT is a buffer, then overlay properties are considered as well as
   text properties.
   If OBJECT is a window, then that window's buffer is used, but
   window-specific overlays are considered only if they are associated
   with OBJECT. */
368
Lisp_Object
369
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
370 371 372 373 374
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
375
  else if (WINDOWP (object))
376
    object = XWINDOW (object)->buffer;
377 378 379 380 381 382 383

  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
384
    {
385
      EMACS_INT posn = XINT (position);
386
      ptrdiff_t noverlays;
387 388
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
389
      USE_SAFE_ALLOCA;
390 391 392 393 394

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
      noverlays = 40;
395
      overlay_vec = alloca (noverlays * sizeof *overlay_vec);
396 397 398 399 400 401
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
402
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
	  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
		{
425
		  SAFE_FREE ();
426 427 428 429
		  return tem;
		}
	    }
	}
430
      SAFE_FREE ();
431

432
      { /* Now check the text properties.  */
433 434 435 436 437 438 439 440 441 442
	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;
      }
443 444 445
    }
}

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

450 451 452
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

453
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
454 455 456 457
   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
458
   non-nil case, if two fields are separated by a field with the special
459 460 461
   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.
462 463 464 465

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

466
static void
467 468
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
469
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
470
{
471 472
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
473 474 475 476
  /* 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;
477

478 479 480
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
481
    CHECK_NUMBER_COERCE_MARKER (pos);
482

483
  after_field
484
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
485 486
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
487
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
488
					Qfield, Qnil, NULL)
489 490 491
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
492 493 494 495 496 497 498

  /* 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.  */
499
  if (NILP (merge_at_boundary))
500
    {
501 502
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
503
	at_field_end = 1;
504 505
      if (!EQ (field, before_field))
	at_field_start = 1;
506 507 508 509 510 511
      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;
512 513
    }

514 515 516 517 518 519
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

520
     In this situation, if merge_at_boundary is non-nil, consider the
521 522 523 524
     `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
525
     (a field with a `field' char-property of 'boundary), then ignore
526 527 528 529 530 531
     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
532
     anywhere in-between (within the `boundary' field), merge all
533 534 535
     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.  */

536
  if (beg)
537 538 539 540 541 542 543 544
    {
      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.  */
	{
545
	  Lisp_Object p = pos;
546 547
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
548
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
549
						       beg_limit);
550 551 552 553

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
554 555
	}
    }
556 557

  if (end)
558 559 560 561 562 563 564 565 566 567
    {
      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.  */
568 569
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
570

571 572
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
573 574 575
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
576
}
577

578

579
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
580
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
581
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
582
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
583
  (Lisp_Object pos)
584
{
585
  ptrdiff_t beg, end;
586
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
587 588
  if (beg != end)
    del_range (beg, end);
589
  return Qnil;
590 591 592
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
593
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
594
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
595
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
596
  (Lisp_Object pos)
597
{
598
  ptrdiff_t beg, end;
599
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
600 601 602 603
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
604
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
605
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
606
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
607
  (Lisp_Object pos)
608
{
609
  ptrdiff_t beg, end;
610
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
611 612 613
  return make_buffer_string (beg, end, 0);
}

614
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
615
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
616 617 618
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
619 620
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
621
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
622
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
623
{
624
  ptrdiff_t beg;
625
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
626 627 628
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
629
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
630
       doc: /* Return the end 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 end of its field,
634 635
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
636
is after 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 end;
640
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
641 642 643
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
644
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
645
       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
646
A field is a region of text with the same `field' property.
647 648 649 650

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
651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670

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
unconstrained.  This useful for commands that move by line, like
\\[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.

671
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
672
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
673 674
{
  /* If non-zero, then the original point, before re-positioning.  */
675
  ptrdiff_t orig_point = 0;
676
  bool fwd;
677
  Lisp_Object prev_old, prev_new;
678

679 680 681 682 683 684 685
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

686 687 688
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

689
  fwd = (XINT (new_pos) > XINT (old_pos));
690

691 692
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
693

694 695
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
696 697
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
698 699 700 701 702
          /* To recognize field boundaries, we must also look at the
             previous positions; we could use `get_pos_property'
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
703
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
704
          || (XFASTINT (old_pos) > BEGV
705
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
706
      && (NILP (inhibit_capture_property)
707 708 709 710 711
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
          || (NILP (get_pos_property (old_pos, inhibit_capture_property, Qnil))
              && (XFASTINT (old_pos) <= BEGV
712 713
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
714 715
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
716
    {
717
      ptrdiff_t shortage;
718 719 720
      Lisp_Object field_bound;

      if (fwd)
721
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
722
      else
723
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
724

725 726 727 728 729 730 731 732 733 734 735 736 737
      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
	     case the constraint is OK even if ONLY_IN_LINE is non-nil). */
	  && (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.  */
738 739
	      || (find_newline (XFASTINT (new_pos), XFASTINT (field_bound),
				fwd ? -1 : 1, &shortage, 1),
740
		  shortage != 0)))
741 742 743 744 745 746 747 748 749 750
	/* 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;
}
751

752

Paul Eggert's avatar
Paul Eggert committed
753
DEFUN ("line-beginning-position",
754
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
755
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
756 757
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
758

Chong Yidong's avatar
Chong Yidong committed
759 760 761
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.
762

763
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
764
unless that position would be on a different line than the original,
765 766
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
767
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
768

769
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
770
  (Lisp_Object n)
771
{
772 773
  ptrdiff_t orig, orig_byte, end;
  ptrdiff_t count = SPECPDL_INDEX ();
774
  specbind (Qinhibit_point_motion_hooks, Qt);
775 776 777 778

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
779
    CHECK_NUMBER (n);
780 781

  orig = PT;
782
  orig_byte = PT_BYTE;
783 784
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
785

786
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
787

788 789
  unbind_to (count, Qnil);

790
  /* Return END constrained to the current input field.  */
791 792
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
793
			      Qt, Qnil);
794 795
}

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

Chong Yidong's avatar
Chong Yidong committed
801 802 803
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.
804

805 806 807 808
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
809 810
boundaries bind `inhibit-field-text-motion' to t.

811
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
812
  (Lisp_Object n)
813
{
814 815 816
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
817

818 819 820
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
821
    CHECK_NUMBER (n);
822

823 824
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0));
825 826

  /* Return END_POS constrained to the current input field.  */
827
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
828
			      Qnil, Qt, Qnil);
829
}
830

831 832 833 834
/* 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
835
Lisp_Object
836
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
837
{
838
  return make_save_value
839 840 841 842 843 844 845 846 847 848
    ("oooo",
     Fpoint_marker (),
     /* 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.  */
     ((XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
      ? selected_window : Qnil),
     BVAR (current_buffer, mark_active));
Jim Blandy's avatar
Jim Blandy committed
849 850
}

851 852
/* Restore saved buffer before leaving `save-excursion' special form.  */

Jim Blandy's avatar
Jim Blandy committed
853
Lisp_Object
854
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
855
{
856
  Lisp_Object tem, tem1, omark, nmark;
857 858
  struct gcpro gcpro1, gcpro2, gcpro3;

859
  tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
860 861
  /* 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.  */
862
  if (NILP (tem))
863
    goto out;
864 865 866 867 868 869 870

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

  Fset_buffer (tem);

  /* Point marker.  */
871
  tem = XSAVE_OBJECT (info, 0);
872 873 874 875
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* Mark marker.  */
876
  tem = XSAVE_OBJECT (info, 1);
877
  omark = Fmarker_position (BVAR (current_buffer, mark));