editfns.c 140 KB
Newer Older
1
/* Lisp functions pertaining to editing.                 -*- coding: utf-8 -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
Copyright (C) 1985-1987, 1989, 1993-2019 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 <https://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
#include <float.h>
39
#include <limits.h>
40
#include <math.h>
41

42
#include <c-ctype.h>
43
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
44
#include <stdlib.h>
45
#include <verify.h>
46

47
#include "composite.h"
48
#include "intervals.h"
49
#include "ptr-bounds.h"
50
#include "character.h"
51
#include "buffer.h"
Jim Blandy's avatar
Jim Blandy committed
52
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
53
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
54

55
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
56
static Lisp_Object styled_format (ptrdiff_t, Lisp_Object *, bool);
57

58 59 60 61 62 63 64 65 66 67 68
/* The cached value of Vsystem_name.  This is used only to compare it
   to Vsystem_name, so it need not be visible to the GC.  */
static Lisp_Object cached_system_name;

static void
init_and_cache_system_name (void)
{
  init_system_name ();
  cached_system_name = Vsystem_name;
}

Jim Blandy's avatar
Jim Blandy committed
69
void
70
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
71
{
72
  const char *user_name;
73
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
74 75 76 77
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
78
  init_and_cache_system_name ();
Jim Blandy's avatar
Jim Blandy committed
79

80
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
81 82
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
83
     accurate on MS-DOS and because it lets Emacs find the init file.
Morten Welinder's avatar
Morten Welinder committed
84
     (The DVX libraries override the Djgpp libraries here.)  */
85
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
86
#else
87
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
88
#endif
Jim Blandy's avatar
Jim Blandy committed
89

Jim Blandy's avatar
Jim Blandy committed
90 91
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
92
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
93
  if (!user_name)
94
#ifdef WINDOWSNT
95
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
96
#else  /* WINDOWSNT */
97
    user_name = getenv ("USER");
98
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
99 100
  if (!user_name)
    {
101 102
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
103
    }
104
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
105

Jim Blandy's avatar
Jim Blandy committed
106 107
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
108
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
109 110 111 112 113
  if (! NILP (tem))
    tem = Vuser_login_name;
  else
    {
      uid_t euid = geteuid ();
114
      tem = INT_TO_INTEGER (euid);
115 116
    }
  Vuser_full_name = Fuser_full_name (tem);
Sam Steingold's avatar
Sam Steingold committed
117

118
  p = getenv ("NAME");
119 120
  if (p)
    Vuser_full_name = build_string (p);
121 122
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
123 124 125 126 127 128 129 130 131 132

#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
133 134
}

Paul Eggert's avatar
Paul Eggert committed
135
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
136 137
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
138
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
139
{
140
  int c, len;
141
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
142

143
  CHECK_CHARACTER (character);
Tom Tromey's avatar
Tom Tromey committed
144
  c = XFIXNAT (character);
Jim Blandy's avatar
Jim Blandy committed
145

146
  len = CHAR_STRING (c, str);
147
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
148 149
}

150
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
151
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
152
  (Lisp_Object byte)
153
{
154
  unsigned char b;
155
  CHECK_FIXNUM (byte);
Tom Tromey's avatar
Tom Tromey committed
156
  if (XFIXNUM (byte) < 0 || XFIXNUM (byte) > 255)
157
    error ("Invalid byte");
Tom Tromey's avatar
Tom Tromey committed
158
  b = XFIXNUM (byte);
159
  return make_string_from_bytes ((char *) &b, 1, 1);
160 161
}

Jim Blandy's avatar
Jim Blandy committed
162
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
163
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
164
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
165 166
{
  register Lisp_Object val;
167
  CHECK_STRING (string);
168
  if (SCHARS (string))
169 170
    {
      if (STRING_MULTIBYTE (string))
171
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
172
      else
173
	XSETFASTINT (val, SREF (string, 0));
174
    }
Jim Blandy's avatar
Jim Blandy committed
175
  else
176
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
177 178 179
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
180
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
181 182
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
183
  (void)
Jim Blandy's avatar
Jim Blandy committed
184 185
{
  Lisp_Object temp;
186
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
187 188 189
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
190
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
191
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
192
  (void)
Jim Blandy's avatar
Jim Blandy committed
193
{
194
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
195 196
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
202
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
203
{
204 205
  if (MARKERP (position))
    set_point_from_marker (position);
206
  else if (FIXNUMP (position))
Tom Tromey's avatar
Tom Tromey committed
207
    SET_PT (clip_to_bounds (BEGV, XFIXNUM (position), ZV));
208 209
  else
    wrong_type_argument (Qinteger_or_marker_p, position);
210
  return position;
Jim Blandy's avatar
Jim Blandy committed
211 212
}

213 214

/* Return the start or end position of the region.
215
   BEGINNINGP means return the start.
216 217
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
218
static Lisp_Object
219
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
220
{
221
  Lisp_Object m;
222

223 224
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
225
      && NILP (BVAR (current_buffer, mark_active)))
226
    xsignal0 (Qmark_inactive);
227

Tom Tromey's avatar
Tom Tromey committed
228
  m = Fmarker_position (BVAR (current_buffer, mark));
229
  if (NILP (m))
230
    error ("The mark is not set now, so there is no region");
231

232
  /* Clip to the current narrowing (bug#11770).  */
Tom Tromey's avatar
Tom Tromey committed
233
  return make_fixnum ((PT < XFIXNAT (m)) == beginningp
234
		      ? PT
Tom Tromey's avatar
Tom Tromey committed
235
		      : clip_to_bounds (BEGV, XFIXNAT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
236 237 238
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
239
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
240
  (void)
Jim Blandy's avatar
Jim Blandy committed
241
{
242
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
243 244 245
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
246
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
247
  (void)
Jim Blandy's avatar
Jim Blandy committed
248
{
249
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
250 251 252
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
253
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
254
Watch out!  Moving this marker changes the mark position.
255
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
256
  (void)
Jim Blandy's avatar
Jim Blandy committed
257
{
Tom Tromey's avatar
Tom Tromey committed
258
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
259
}
260 261


262 263 264 265
/* 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.  */

266 267
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
268
{
269
  ptrdiff_t idx = 0;
270

271 272
  for (struct Lisp_Overlay *tail = current_buffer->overlays_before;
       tail; tail = tail->next)
273
    {
274 275 276
      Lisp_Object overlay = make_lisp_ptr (tail, Lisp_Vectorlike);
      Lisp_Object end = OVERLAY_END (overlay);
      ptrdiff_t endpos = OVERLAY_POSITION (end);
277 278
      if (endpos < pos)
	  break;
279 280
      Lisp_Object start = OVERLAY_START (overlay);
      ptrdiff_t startpos = OVERLAY_POSITION (start);
281 282 283 284 285 286 287 288 289
      if (startpos <= pos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  /* Keep counting overlays even if we can't return them all.  */
	  idx++;
	}
    }

290 291
  for (struct Lisp_Overlay *tail = current_buffer->overlays_after;
       tail; tail = tail->next)
292
    {
293 294 295
      Lisp_Object overlay = make_lisp_ptr (tail, Lisp_Vectorlike);
      Lisp_Object start = OVERLAY_START (overlay);
      ptrdiff_t startpos = OVERLAY_POSITION (start);
296 297
      if (pos < startpos)
	break;
298 299
      Lisp_Object end = OVERLAY_END (overlay);
      ptrdiff_t endpos = OVERLAY_POSITION (end);
300 301 302 303 304 305 306 307 308 309 310
      if (pos <= endpos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  idx++;
	}
    }

  return idx;
}

311 312 313 314 315 316 317 318 319
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)
320
{
321
  CHECK_FIXNUM_COERCE_MARKER (position);
322 323 324

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
325
  else if (WINDOWP (object))
326
    object = XWINDOW (object)->contents;
327 328 329 330 331 332 333

  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
334
    {
Tom Tromey's avatar
Tom Tromey committed
335
      EMACS_INT posn = XFIXNUM (position);
336
      ptrdiff_t noverlays;
337 338
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;
339
      USE_SAFE_ALLOCA;
340 341 342 343

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
344 345 346
      Lisp_Object overlay_vecbuf[40];
      noverlays = ARRAYELTS (overlay_vecbuf);
      overlay_vec = overlay_vecbuf;
347 348 349 350
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
351
      if (ARRAYELTS (overlay_vecbuf) < noverlays)
352
	{
353
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
	  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
		{
376
		  SAFE_FREE ();
377 378 379 380
		  return tem;
		}
	    }
	}
381
      SAFE_FREE ();
382

383
      { /* Now check the text properties.  */
384 385 386 387
	int stickiness = text_property_stickiness (prop, position, object);
	if (stickiness > 0)
	  return Fget_text_property (position, prop, object);
	else if (stickiness < 0
Tom Tromey's avatar
Tom Tromey committed
388 389
		 && XFIXNUM (position) > BUF_BEGV (XBUFFER (object)))
	  return Fget_text_property (make_fixnum (XFIXNUM (position) - 1),
390 391 392 393
				     prop, object);
	else
	  return Qnil;
      }
394 395 396
    }
}

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

401 402 403
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

404
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
405 406 407 408
   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
409
   non-nil case, if two fields are separated by a field with the special
410 411 412
   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.
413 414 415 416

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

417
static void
418 419
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
420
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
421
{
422 423
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
424 425 426 427
  /* 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;
428

429 430 431
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
432
    CHECK_FIXNUM_COERCE_MARKER (pos);
433

434
  after_field
435
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
436
  before_field
Tom Tromey's avatar
Tom Tromey committed
437 438
    = (XFIXNAT (pos) > BEGV
       ? get_char_property_and_overlay (make_fixnum (XFIXNUM (pos) - 1),
439
					Qfield, Qnil, NULL)
440 441 442
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
443 444 445 446 447 448 449

  /* 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.  */
450
  if (NILP (merge_at_boundary))
451
    {
452
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
453
      if (!EQ (field, after_field))
454
	at_field_end = 1;
455 456
      if (!EQ (field, before_field))
	at_field_start = 1;
457 458 459 460 461 462
      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;
463 464
    }

465 466 467 468 469 470
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

471
     In this situation, if merge_at_boundary is non-nil, consider the
472 473 474 475
     `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
476
     (a field with a `field' char-property of 'boundary), then ignore
477 478 479 480 481 482
     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
483
     anywhere in-between (within the `boundary' field), merge all
484 485 486
     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.  */

487
  if (beg)
488 489 490 491
    {
      if (at_field_start)
	/* POS is at the edge of a field, and we should consider it as
	   the beginning of the following field.  */
Tom Tromey's avatar
Tom Tromey committed
492
	*beg = XFIXNAT (pos);
493 494 495
      else
	/* Find the previous field boundary.  */
	{
496
	  Lisp_Object p = pos;
497 498
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
499
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
500
						       beg_limit);
501 502 503

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
Tom Tromey's avatar
Tom Tromey committed
504
	  *beg = NILP (p) ? BEGV : XFIXNAT (p);
505 506
	}
    }
507 508

  if (end)
509 510 511 512
    {
      if (at_field_end)
	/* POS is at the edge of a field, and we should consider it as
	   the end of the previous field.  */
Tom Tromey's avatar
Tom Tromey committed
513
	*end = XFIXNAT (pos);
514 515 516 517 518
      else
	/* Find the next field boundary.  */
	{
	  if (!NILP (merge_at_boundary) && EQ (after_field, Qboundary))
	    /* Skip a `boundary' field.  */
519 520
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
521

522 523
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
Tom Tromey's avatar
Tom Tromey committed
524
	  *end = NILP (pos) ? ZV : XFIXNAT (pos);
525 526
	}
    }
527
}
528

529

530
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
531
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
532
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
533
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
534
  (Lisp_Object pos)
535
{
536
  ptrdiff_t beg, end;
537
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
538 539
  if (beg != end)
    del_range (beg, end);
540
  return Qnil;
541 542 543
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
544
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
545
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
546
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
547
  (Lisp_Object pos)
548
{
549
  ptrdiff_t beg, end;
550
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
551 552 553 554
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
555
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
556
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
557
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
558
  (Lisp_Object pos)
559
{
560
  ptrdiff_t beg, end;
561
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
562 563 564
  return make_buffer_string (beg, end, 0);
}

565
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
566
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
567 568 569
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
570 571
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
572
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
573
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
574
{
575
  ptrdiff_t beg;
576
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
577
  return make_fixnum (beg);
578 579
}

Paul Eggert's avatar
Paul Eggert committed
580
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
581
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
582 583 584
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,
585 586
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
587
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
588
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
589
{
590
  ptrdiff_t end;
591
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
592
  return make_fixnum (end);
593 594
}

Paul Eggert's avatar
Paul Eggert committed
595
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
596
       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
597
A field is a region of text with the same `field' property.
598 599 600 601

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
602 603 604 605 606 607 608 609 610 611 612 613 614

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
615
unconstrained.  This is useful for commands that move by line, like
Pavel Janík's avatar
Pavel Janík committed
616 617 618 619 620 621
\\[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.

622
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
623 624
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
625 626
{
  /* If non-zero, then the original point, before re-positioning.  */
627
  ptrdiff_t orig_point = 0;
628
  bool fwd;
629
  Lisp_Object prev_old, prev_new;
630

631 632 633 634 635 636 637
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

638 639
  CHECK_FIXNUM_COERCE_MARKER (new_pos);
  CHECK_FIXNUM_COERCE_MARKER (old_pos);
640

Tom Tromey's avatar
Tom Tromey committed
641
  fwd = (XFIXNUM (new_pos) > XFIXNUM (old_pos));
642

Tom Tromey's avatar
Tom Tromey committed
643 644
  prev_old = make_fixnum (XFIXNUM (old_pos) - 1);
  prev_new = make_fixnum (XFIXNUM (new_pos) - 1);
645

646 647
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
648 649
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
650
          /* To recognize field boundaries, we must also look at the
651
             previous positions; we could use `Fget_pos_property'
652 653
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
Tom Tromey's avatar
Tom Tromey committed
654
          || (XFIXNAT (new_pos) > BEGV
655
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
Tom Tromey's avatar
Tom Tromey committed
656
          || (XFIXNAT (old_pos) > BEGV
657
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
658
      && (NILP (inhibit_capture_property)
659 660 661
          /* Field boundaries are again a problem; but now we must
             decide the case exactly, so we need to call
             `get_pos_property' as well.  */
662
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
Tom Tromey's avatar
Tom Tromey committed
663
              && (XFIXNAT (old_pos) <= BEGV
664 665 666 667
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
668 669
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
670
    {
671
      ptrdiff_t shortage;
672 673 674
      Lisp_Object field_bound;

      if (fwd)
675
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
676
      else
677
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
678

679 680 681 682
      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.  */
Tom Tromey's avatar
Tom Tromey committed
683
	  ((XFIXNAT (field_bound) < XFIXNAT (new_pos)) ? fwd : !fwd)
684 685 686
	  /* 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
687
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
688 689 690 691
	  && (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.  */
Tom Tromey's avatar
Tom Tromey committed
692 693
	      || (find_newline (XFIXNAT (new_pos), -1,
				XFIXNAT (field_bound), -1,
694
				fwd ? -1 : 1, &shortage, NULL, 1),
695
		  shortage != 0)))
696 697 698
	/* Constrain NEW_POS to FIELD_BOUND.  */
	new_pos = field_bound;

Tom Tromey's avatar
Tom Tromey committed
699
      if (orig_point && XFIXNAT (new_pos) != orig_point)
700
	/* The NEW_POS argument was originally nil, so automatically set PT. */
Tom Tromey's avatar
Tom Tromey committed
701
	SET_PT (XFIXNAT (new_pos));
702 703 704 705
    }

  return new_pos;
}
706

707

Paul Eggert's avatar
Paul Eggert committed
708
DEFUN ("line-beginning-position",
709
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
710
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
711 712
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
713

Chong Yidong's avatar
Chong Yidong committed
714 715 716
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.
717

718
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
719
unless that position would be on a different line than the original,
720 721
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
722
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
723

724
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
725
  (Lisp_Object n)
726
{
727
  ptrdiff_t charpos, bytepos;
728 729 730 731

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
732
    CHECK_FIXNUM (n);
733

Tom Tromey's avatar
Tom Tromey committed
734
  scan_newline_from_point (XFIXNUM (n) - 1, &charpos, &bytepos);
735

736
  /* Return END constrained to the current input field.  */
737
  return Fconstrain_to_field (make_fixnum (charpos), make_fixnum (PT),
Tom Tromey's avatar
Tom Tromey committed
738
			      XFIXNUM (n) != 1 ? Qt : Qnil,
739
			      Qt, Qnil);
740 741
}

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

Chong Yidong's avatar
Chong Yidong committed
747 748 749
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.
750

751 752 753 754
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
755 756
boundaries bind `inhibit-field-text-motion' to t.

757
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
758
  (Lisp_Object n)
759
{
760 761 762
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
763

764 765 766
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
767
    CHECK_FIXNUM (n);
768

Tom Tromey's avatar
Tom Tromey committed
769
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XFIXNUM (n), PTRDIFF_MAX);
770 771
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
772 773

  /* Return END_POS constrained to the current input field.  */
774
  return Fconstrain_to_field (make_fixnum (end_pos), make_fixnum (orig),
775
			      Qnil, Qt, Qnil);
776
}
777

778
/* Save current buffer state for save-excursion special form.  */
779

780 781
void
save_excursion_save (union specbinding *pdl)
Jim Blandy's avatar
Jim Blandy committed
782
{
783 784 785 786 787 788
  eassert (pdl->unwind_excursion.kind == SPECPDL_UNWIND_EXCURSION);
  pdl->unwind_excursion.marker = Fpoint_marker ();
  /* Selected window if current buffer is shown in it, nil otherwise.  */
  pdl->unwind_excursion.window
    = (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
       ? selected_window : Qnil);
Jim Blandy's avatar
Jim Blandy committed
789 790
}

791 792
/* Restore saved buffer before leaving `save-excursion' special form.  */

793
void
794
save_excursion_restore (Lisp_Object marker, Lisp_Object window)
Jim Blandy's avatar
Jim Blandy committed
795
{
796
  Lisp_Object buffer = Fmarker_buffer (marker);
797
  /* If we're unwinding to top level, saved buffer may be deleted.  This
798 799 800
     means that all of its markers are unchained and so BUFFER is nil.  */
  if (NILP (buffer))
    return;
801

802
  Fset_buffer (buffer);
803

804
  /* Point marker.  */
805 806
  Fgoto_char (marker);
  unchain_marker (XMARKER (marker));
807 808 809 810

  /* 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.  */
811 812 813 814 815
  if (WINDOWP (window) && !EQ (window, selected_window))
    {