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-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>
24
#include <setjmp.h>
Jim Blandy's avatar
Jim Blandy committed
25

26
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
27
#include <pwd.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 <ctype.h>
48
#include <float.h>
49 50
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
51
#include <strftime.h>
52
#include <verify.h>
53

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

62 63 64 65
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

66
#ifndef USE_CRT_DLL
67
extern char **environ;
68 69
#endif

70 71
#define TM_YEAR_BASE 1900

72
#ifdef WINDOWSNT
73
extern Lisp_Object w32_get_internal_run_time (void);
74 75
#endif

76 77
static Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
				       int, struct tm *);
78
static int tm_diff (struct tm *, struct tm *);
79
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
80

81
static Lisp_Object Qbuffer_access_fontify_functions;
82

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

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

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

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

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

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

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

172
  CHECK_CHARACTER (character);
173
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
174

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

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

Jim Blandy's avatar
Jim Blandy committed
191
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
192
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
193
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
194 195
{
  register Lisp_Object val;
196
  CHECK_STRING (string);
197
  if (SCHARS (string))
198 199
    {
      if (STRING_MULTIBYTE (string))
200
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
201
      else
202
	XSETFASTINT (val, SREF (string, 0));
203
    }
Jim Blandy's avatar
Jim Blandy committed
204
  else
205
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
206 207 208 209
  return val;
}

static Lisp_Object
210
buildmark (ptrdiff_t charpos, ptrdiff_t bytepos)
Jim Blandy's avatar
Jim Blandy committed
211 212 213
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
214
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
215 216 217
  return mark;
}

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

Paul Eggert's avatar
Paul Eggert committed
228
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
229
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
230
  (void)
Jim Blandy's avatar
Jim Blandy committed
231
{
232
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
233 234
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
240
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
241
{
242
  ptrdiff_t pos;
Karl Heuer's avatar
Karl Heuer committed
243

244 245
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
246 247 248 249 250 251 252 253 254 255 256 257
    {
      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;
    }

258
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
259

Karl Heuer's avatar
Karl Heuer committed
260 261
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
262
  return position;
Jim Blandy's avatar
Jim Blandy committed
263 264
}

265 266 267 268 269

/* Return the start or end position of the region.
   BEGINNINGP non-zero means return the start.
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
270
static Lisp_Object
271
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
272
{
273
  Lisp_Object m;
274

275 276
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
277
      && NILP (BVAR (current_buffer, mark_active)))
278
    xsignal0 (Qmark_inactive);
279

Tom Tromey's avatar
Tom Tromey committed
280
  m = Fmarker_position (BVAR (current_buffer, mark));
281
  if (NILP (m))
282
    error ("The mark is not set now, so there is no region");
283

Kenichi Handa's avatar
Kenichi Handa committed
284
  if ((PT < XFASTINT (m)) == (beginningp != 0))
285 286 287 288
    return make_number (PT);
  else
    { /* Clip to the current narrowing (bug#11770).  */
      ptrdiff_t mark = XFASTINT (m);
289
      return make_number (mark < BEGV ? BEGV : mark > ZV ? ZV : mark);
290
    }
Jim Blandy's avatar
Jim Blandy committed
291 292 293
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
294
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
295
  (void)
Jim Blandy's avatar
Jim Blandy committed
296
{
297
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
298 299 300
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
301
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
302
  (void)
Jim Blandy's avatar
Jim Blandy committed
303
{
304
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
305 306 307
}

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


317 318 319 320
/* 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.  */

321 322
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
323
{
324 325
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
326
  ptrdiff_t startpos, endpos;
327
  ptrdiff_t idx = 0;
328

329
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
330
    {
331
      XSETMISC (overlay, tail);
332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347

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

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

      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. */
377
Lisp_Object
378
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
379 380 381 382 383
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
384 385 386 387 388 389 390 391 392
  else if (WINDOWP (object))
    object = XWINDOW (object)->buffer;

  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
393
    {
394
      EMACS_INT posn = XINT (position);
395
      ptrdiff_t noverlays;
396 397 398 399 400 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 427 428 429 430 431 432 433 434 435 436
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
      noverlays = 40;
      overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
	  overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
	  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;
		}
	    }
	}
437

438
      { /* Now check the text properties.  */
439 440 441 442 443 444 445 446 447 448
	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;
      }
449 450 451
    }
}

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

456 457 458
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

459
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
460 461 462 463 464 465 466 467
   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
   true case, if two fields are separated by a field with the special
   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.
468 469 470 471

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

472
static void
473 474
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
475
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
476
{
477 478
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
479 480 481 482
  /* 1 if POS counts as the start of a field.  */
  int at_field_start = 0;
  /* 1 if POS counts as the end of a field.  */
  int at_field_end = 0;
483

484 485 486
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
487
    CHECK_NUMBER_COERCE_MARKER (pos);
488

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

  /* 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.  */
505
  if (NILP (merge_at_boundary))
506
    {
507 508
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
509
	at_field_end = 1;
510 511
      if (!EQ (field, before_field))
	at_field_start = 1;
512 513 514 515 516 517
      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;
518 519
    }

520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

     In this situation, if merge_at_boundary is true, we consider the
     `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
     (a field with a `field' char-property of 'boundary), then we ignore
     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
     anywhere in-between (within the `boundary' field), we merge all
     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.  */

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
560 561
	}
    }
562 563

  if (end)
564 565 566 567 568 569 570 571 572 573
    {
      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.  */
574 575
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
576

577 578
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
579 580 581
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
582
}
583

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

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

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

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

Paul Eggert's avatar
Paul Eggert committed
635
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
636
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
637 638 639
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,
640 641
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
642
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
643
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
644
{
645
  ptrdiff_t end;
646
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
647 648 649
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
650
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
651
       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
652
A field is a region of text with the same `field' property.
653 654 655 656

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
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676

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.

677
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
678
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
679 680
{
  /* If non-zero, then the original point, before re-positioning.  */
681
  ptrdiff_t orig_point = 0;
682 683
  int fwd;
  Lisp_Object prev_old, prev_new;
684

685 686 687 688 689 690 691
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

692 693 694
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

695
  fwd = (XINT (new_pos) > XINT (old_pos));
696

697 698
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
699

700 701
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
702 703
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
704 705 706 707 708
          /* 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
709
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
710
          || (XFASTINT (old_pos) > BEGV
711
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
712
      && (NILP (inhibit_capture_property)
713 714 715 716 717
          /* 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
718 719
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
720 721
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
722
    {
723
      ptrdiff_t shortage;
724 725 726
      Lisp_Object field_bound;

      if (fwd)
727
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
728
      else
729
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
730

731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747
      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)))
748 749 750 751 752 753 754 755 756 757
	/* 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;
}
758

759

Paul Eggert's avatar
Paul Eggert committed
760
DEFUN ("line-beginning-position",
761
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
762
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
763 764
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
765

766 767 768
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

769 770 771 772
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 front-sticky field
starts at point, the scan stops as soon as it starts.  To ignore field
773
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
774

775
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
776
  (Lisp_Object n)
777
{
778 779
  ptrdiff_t orig, orig_byte, end;
  ptrdiff_t count = SPECPDL_INDEX ();
780
  specbind (Qinhibit_point_motion_hooks, Qt);
781 782 783 784

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
785
    CHECK_NUMBER (n);
786 787

  orig = PT;
788
  orig_byte = PT_BYTE;
789 790
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
791

792
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
793

794 795
  unbind_to (count, Qnil);

796
  /* Return END constrained to the current input field.  */
797 798
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
799
			      Qt, Qnil);
800 801
}

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

807 808 809
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

810 811 812 813
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
814 815
boundaries bind `inhibit-field-text-motion' to t.

816
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
817
  (Lisp_Object n)
818
{
819 820 821
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
822

823 824 825
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
826
    CHECK_NUMBER (n);
827

828 829
  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));
830 831

  /* Return END_POS constrained to the current input field.  */
832
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
833
			      Qnil, Qt, Qnil);
834
}
835

836

Jim Blandy's avatar
Jim Blandy committed
837
Lisp_Object
838
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
839
{
840 841
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
842 843

  return Fcons (Fpoint_marker (),
Tom Tromey's avatar
Tom Tromey committed
844
		Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
845
		       Fcons (visible ? Qt : Qnil,
Tom Tromey's avatar
Tom Tromey committed
846
			      Fcons (BVAR (current_buffer, mark_active),
847
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
848 849 850
}

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

857
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
858 859 860 861
  /* If buffer being returned to is now deleted, avoid error */
  /* Otherwise could get error here while unwinding to top level
     and crash */
  /* In that case, Fmarker_buffer returns nil now.  */
Jim Blandy's avatar
Jim Blandy committed
862
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
863
    return Qnil;
864 865 866 867

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

Jim Blandy's avatar
Jim Blandy committed
868
  Fset_buffer (tem);
869 870 871

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
872
  Fgoto_char (tem);
873
  unchain_marker (XMARKER (tem));
874 875 876 877

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
878 879
  omark = Fmarker_position (BVAR (current_buffer, mark));
  Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
880
  nmark = Fmarker_position (tem);
881
  unchain_marker (XMARKER (tem));
882 883 884 885

  /* visible */
  info = XCDR (info);
  visible_p = !NILP (XCAR (info));
886

887 888 889 890
#if 0 /* We used to make the current buffer visible in the selected window
	 if that was true previously.  That avoids some anomalies.
	 But it creates others, and it wasn't documented, and it is simpler
	 and cleaner never to alter the window/buffer connections.  */
891 892
  tem1 = Fcar (tem);
  if (!NILP (tem1)
893
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
894
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
895
#endif /* 0 */
896

897 898 899
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
900 901
  tem1 = BVAR (current_buffer, mark_active);
  BVAR (current_buffer, mark_active) = tem;
Gerd Moellmann's avatar