editfns.c 147 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"
Jim Blandy's avatar
Jim Blandy committed
55
#include "buffer.h"
56
#include "character.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
static void time_overflow (void) NO_RETURN;
77
static Lisp_Object format_time_string (char const *, ptrdiff_t, Lisp_Object,
78
				       int, time_t *, struct tm *);
79
static int tm_diff (struct tm *, struct tm *);
80
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
81

82
static Lisp_Object Qbuffer_access_fontify_functions;
83
static Lisp_Object Fuser_full_name (Lisp_Object);
84

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

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

91
static Lisp_Object Qboundary;
92 93


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

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

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

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 211
  return val;
}

static Lisp_Object
212
buildmark (ptrdiff_t charpos, ptrdiff_t bytepos)
Jim Blandy's avatar
Jim Blandy committed
213 214 215
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
216
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
217 218 219
  return mark;
}

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

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

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

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

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

260
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
261

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

267 268 269 270 271

/* 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
272
static Lisp_Object
273
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
274
{
275
  Lisp_Object m;
276

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

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

Kenichi Handa's avatar
Kenichi Handa committed
286
  if ((PT < XFASTINT (m)) == (beginningp != 0))
287 288
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
289 290 291
}

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

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

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


315 316 317 318
/* 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.  */

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

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

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

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

      start = OVERLAY_START (overlay);
      startpos = OVERLAY_POSITION (start);
      if (pos < startpos)
	break;
      end = OVERLAY_END (overlay);
      endpos = OVERLAY_POSITION (end);
      if (pos <= endpos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  idx++;
	}
    }

  return idx;
}

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

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
382 383 384 385 386 387 388 389 390
  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
391
    {
392
      EMACS_INT posn = XINT (position);
393
      ptrdiff_t noverlays;
394 395 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
      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;
		}
	    }
	}
435

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

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

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

457
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
458 459 460 461 462 463 464 465
   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.
466 467 468 469

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

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

482 483 484
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
485
    CHECK_NUMBER_COERCE_MARKER (pos);
486

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

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

518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539
  /* 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.  */

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

690 691 692
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

693
  fwd = (XINT (new_pos) > XINT (old_pos));
694

695 696
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
697

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

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

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

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

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

767 768 769 770
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
771
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
772

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

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
783
    CHECK_NUMBER (n);
784 785

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

790
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
791

792 793
  unbind_to (count, Qnil);

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

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

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

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

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

821 822 823
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
824
    CHECK_NUMBER (n);
825

826 827
  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));
828 829

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

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

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

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

855
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
856 857 858 859
  /* 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
860
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
861
    return Qnil;
862 863 864 865

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

Jim Blandy's avatar
Jim Blandy committed
866
  Fset_buffer (tem);
867 868 869

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

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

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

885 886 887 888
#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.  */
889 890
  tem1 = Fcar (tem);
  if (!NILP (tem1)
891
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
892
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
893
#endif /* 0 */
894

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