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

3
Copyright (C) 1985-1987, 1989, 1993-2012 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>
Jim Blandy's avatar
Jim Blandy committed
27 28
#endif

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

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

35 36
#include "lisp.h"

37 38 39 40
/* 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"
41 42

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

46
#include <float.h>
47 48
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
49
#include <strftime.h>
50
#include <verify.h>
51

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

60 61
#define TM_YEAR_BASE 1900

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

66
static Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
67
				       bool, struct tm *);
68
static int tm_diff (struct tm *, struct tm *);
69
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
70

71
static Lisp_Object Qbuffer_access_fontify_functions;
72

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

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

79
static Lisp_Object Qboundary;
80

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

90

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

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

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

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

111
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
112 113 114 115
#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.)  */
116
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
117
#else
118
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
119
#endif
Jim Blandy's avatar
Jim Blandy committed
120

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

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

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

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

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

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

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

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

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

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

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

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

237 238
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
239 240 241 242 243 244 245 246 247 248 249 250
    {
      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;
    }

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

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

258 259

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

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

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

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

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

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

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

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

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

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

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

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

338
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
339
    {
340
      XSETMISC (overlay, tail);
341 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

      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. */
367
Lisp_Object
368
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
369 370 371 372 373
{
  CHECK_NUMBER_COERCE_MARKER (position);

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

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

      set_buffer_temp (XBUFFER (object));

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

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

428
      { /* Now check the text properties.  */
429 430 431 432 433 434 435 436 437 438
	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;
      }
439 440 441
    }
}

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

446 447 448
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

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

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

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

474 475 476
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
477
    CHECK_NUMBER_COERCE_MARKER (pos);
478

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

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

510 511 512 513 514 515
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

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

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
550 551
	}
    }
552 553

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

567 568
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
569 570 571
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
572
}
573

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

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

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

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

Paul Eggert's avatar
Paul Eggert committed
625
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
626
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
627 628 629
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,
630 631
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
632
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
633
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
634
{
635
  ptrdiff_t end;
636
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
637 638 639
  return make_number (end);
}

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

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
647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666

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.

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

675 676 677 678 679 680 681
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

682 683 684
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

685
  fwd = (XINT (new_pos) > XINT (old_pos));
686

687 688
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
689

690 691
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
692 693
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
694 695 696 697 698
          /* 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
699
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
700
          || (XFASTINT (old_pos) > BEGV
701
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
702
      && (NILP (inhibit_capture_property)
703 704 705 706 707
          /* 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
708 709
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
710 711
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
712
    {
713
      ptrdiff_t shortage;
714 715 716
      Lisp_Object field_bound;

      if (fwd)
717
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
718
      else
719
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
720

721 722 723 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.  */
	      || (scan_buffer ('\n',
			       XFASTINT (new_pos), XFASTINT (field_bound),
			       fwd ? -1 : 1, &shortage, 1),
		  shortage != 0)))
738 739 740 741 742 743 744 745 746 747
	/* 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;
}
748

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

Chong Yidong's avatar
Chong Yidong committed
756 757 758
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.
759

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

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

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
776
    CHECK_NUMBER (n);
777 778

  orig = PT;
779
  orig_byte = PT_BYTE;
780 781
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
782

783
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
784

785 786
  unbind_to (count, Qnil);

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

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

Chong Yidong's avatar
Chong Yidong committed
798 799 800
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.
801

802 803 804 805
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
806 807
boundaries bind `inhibit-field-text-motion' to t.

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

815 816 817
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
818
    CHECK_NUMBER (n);
819

820 821
  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));
822 823

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

828 829 830 831
/* 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
832
Lisp_Object
833
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
834
{
835 836 837
  Lisp_Object save, *data = xmalloc (word_size * 4);

  data[0] = Fpoint_marker ();
838
  /* Do not copy the mark if it points to nowhere.  */
839 840 841 842 843 844 845 846 847 848 849
  data[1] = (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.  */
  data[2] = ((XBUFFER (XWINDOW (selected_window)->buffer) == current_buffer)
	     ? selected_window : Qnil);
  data[3] = BVAR (current_buffer, mark_active);

  save = make_save_value (data, 4);
  XSAVE_VALUE (save)->dogc = 1;
  return save;
Jim Blandy's avatar
Jim Blandy committed
850 851
}

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

Jim Blandy's avatar
Jim Blandy committed
854
Lisp_Object
855
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
856
{
857
  Lisp_Object tem, tem1, omark, nmark, *data = XSAVE_VALUE (info)->pointer;
858 859
  struct gcpro gcpro1, gcpro2, gcpro3;

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

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

  Fset_buffer (tem);

  /* Point marker.  */
872
  tem = data[0];
873 874 875 876
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* Mark marker.  */
877
  tem = data[1];
878
  omark = Fmarker_position (BVAR (current_buffer, mark));
879 880 881 882 883 884 885 886
  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));
    }
887

888 889
  /* Mark active.  */
  tem = data[3];
890
  tem1 = BVAR (current_buffer, mark_active);