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-2011 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 NULL
#define NULL 0
#endif

66 67 68 69
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

70
#ifndef USE_CRT_DLL
71
extern char **environ;
72 73
#endif

74 75
#define TM_YEAR_BASE 1900

76 77 78 79 80 81 82
/* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
   asctime to have well-defined behavior.  */
#ifndef TM_YEAR_IN_ASCTIME_RANGE
# define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
    (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
#endif

83
#ifdef WINDOWSNT
84
extern Lisp_Object w32_get_internal_run_time (void);
85 86
#endif

87
static void time_overflow (void) NO_RETURN;
88
static int tm_diff (struct tm *, struct tm *);
89
static void update_buffer_properties (EMACS_INT, EMACS_INT);
90

91
static Lisp_Object Qbuffer_access_fontify_functions;
92
static Lisp_Object Fuser_full_name (Lisp_Object);
93

94 95 96 97 98 99
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

100
static Lisp_Object Qboundary;
101 102


Jim Blandy's avatar
Jim Blandy committed
103
void
104
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
105
{
106
  const char *user_name;
107
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
108 109 110 111
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
112
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
113 114 115 116 117 118 119

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

120
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
121 122 123 124
#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.)  */
125
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
126
#else
127
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
128
#endif
Jim Blandy's avatar
Jim Blandy committed
129

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

Jim Blandy's avatar
Jim Blandy committed
146 147
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
148
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
Juanma Barranquero's avatar
Juanma Barranquero committed
149
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid ())
150
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
151

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

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

177
  CHECK_CHARACTER (character);
178
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
179

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

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

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

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

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

240
EMACS_INT
241
clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
Jim Blandy's avatar
Jim Blandy committed
242 243 244 245 246 247 248 249 250
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
256
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
257
{
258
  EMACS_INT pos;
Karl Heuer's avatar
Karl Heuer committed
259

260 261
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
262 263 264 265 266 267 268 269 270 271 272 273
    {
      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;
    }

274
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
275

Karl Heuer's avatar
Karl Heuer committed
276 277
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
278
  return position;
Jim Blandy's avatar
Jim Blandy committed
279 280
}

281 282 283 284 285

/* 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
286
static Lisp_Object
287
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
288
{
289
  Lisp_Object m;
290

291 292
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
293
      && NILP (BVAR (current_buffer, mark_active)))
294
    xsignal0 (Qmark_inactive);
295

Tom Tromey's avatar
Tom Tromey committed
296
  m = Fmarker_position (BVAR (current_buffer, mark));
297
  if (NILP (m))
298
    error ("The mark is not set now, so there is no region");
299

Kenichi Handa's avatar
Kenichi Handa committed
300
  if ((PT < XFASTINT (m)) == (beginningp != 0))
301 302
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
303 304 305
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
306
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
307
  (void)
Jim Blandy's avatar
Jim Blandy committed
308
{
309
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
310 311 312
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
313
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
314
  (void)
Jim Blandy's avatar
Jim Blandy committed
315
{
316
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
317 318 319
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
320
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
321
Watch out!  Moving this marker changes the mark position.
322
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
323
  (void)
Jim Blandy's avatar
Jim Blandy committed
324
{
Tom Tromey's avatar
Tom Tromey committed
325
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
326
}
327 328


329 330 331 332
/* 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.  */

333 334
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
335
{
336 337
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
338
  EMACS_INT startpos, endpos;
339
  ptrdiff_t idx = 0;
340

341
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
342
    {
343
      XSETMISC (overlay, tail);
344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359

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

360
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
361
    {
362
      XSETMISC (overlay, tail);
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388

      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. */
389
Lisp_Object
390
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
391 392 393 394 395
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
396 397 398 399 400 401 402 403 404
  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
405
    {
406
      EMACS_INT posn = XINT (position);
407
      ptrdiff_t noverlays;
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 437 438 439 440 441 442 443 444 445 446 447 448
      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;
		}
	    }
	}
449

450
      { /* Now check the text properties.  */
451 452 453 454 455 456 457 458 459 460
	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;
      }
461 462 463
    }
}

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

468 469 470
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

471
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
472 473 474 475 476 477 478 479
   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.
480 481 482 483

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

484
static void
485 486 487
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
	    EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
488
{
489 490
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
491 492 493 494
  /* 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;
495

496 497 498
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
499
    CHECK_NUMBER_COERCE_MARKER (pos);
500

501
  after_field
502
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
503 504
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
505
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
506
					Qfield, Qnil, NULL)
507 508 509
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
510 511 512 513 514 515 516

  /* 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.  */
517
  if (NILP (merge_at_boundary))
518
    {
519 520
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
521
	at_field_end = 1;
522 523
      if (!EQ (field, before_field))
	at_field_start = 1;
524 525 526 527 528 529
      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;
530 531
    }

532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553
  /* 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.  */

554
  if (beg)
555 556 557 558 559 560 561 562
    {
      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.  */
	{
563
	  Lisp_Object p = pos;
564 565
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
566
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
567
						       beg_limit);
568 569 570 571

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
572 573
	}
    }
574 575

  if (end)
576 577 578 579 580 581 582 583 584 585
    {
      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.  */
586 587
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
588

589 590
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
591 592 593
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
594
}
595

596

597
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
598
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
599
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
600
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
601
  (Lisp_Object pos)
602
{
603
  EMACS_INT beg, end;
604
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
605 606
  if (beg != end)
    del_range (beg, end);
607
  return Qnil;
608 609 610
}

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

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
622
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
623
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
624
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
625
  (Lisp_Object pos)
626
{
627
  EMACS_INT beg, end;
628
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
629 630 631
  return make_buffer_string (beg, end, 0);
}

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

Paul Eggert's avatar
Paul Eggert committed
647
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
648
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
649 650 651
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,
652 653
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
654
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
655
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
656
{
657
  EMACS_INT end;
658
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
659 660 661
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
662
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
663
       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
664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687

A field is a region of text with the same `field' property.
If NEW-POS is nil, then the current point is used instead, and set to the
constrained position if that is different.

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.

688
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
689
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
690 691
{
  /* If non-zero, then the original point, before re-positioning.  */
692
  EMACS_INT orig_point = 0;
693 694
  int fwd;
  Lisp_Object prev_old, prev_new;
695

696 697 698 699 700 701 702
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

703 704 705 706 707 708 709
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

  fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));

  prev_old = make_number (XFASTINT (old_pos) - 1);
  prev_new = make_number (XFASTINT (new_pos) - 1);
710

711 712
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
713 714
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
715 716 717 718 719
          /* 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
720
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
721
          || (XFASTINT (old_pos) > BEGV
722
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
723
      && (NILP (inhibit_capture_property)
724 725 726 727 728
          /* 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
729 730
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
731 732
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
733
    {
734
      EMACS_INT shortage;
735 736 737
      Lisp_Object field_bound;

      if (fwd)
738
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
739
      else
740
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
741

742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758
      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)))
759 760 761 762 763 764 765 766 767 768
	/* 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;
}
769

770

Paul Eggert's avatar
Paul Eggert committed
771
DEFUN ("line-beginning-position",
772
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
773
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
774 775
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
776

777 778 779
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

780 781 782 783
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
784
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
785

786
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
787
  (Lisp_Object n)
788
{
789
  EMACS_INT orig, orig_byte, end;
790 791
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
792 793 794 795

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
796
    CHECK_NUMBER (n);
797 798

  orig = PT;
799
  orig_byte = PT_BYTE;
800 801
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
802

803
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
804

805 806
  unbind_to (count, Qnil);

807
  /* Return END constrained to the current input field.  */
808 809
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
810
			      Qt, Qnil);
811 812
}

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

818 819 820
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

821 822 823 824
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
825 826
boundaries bind `inhibit-field-text-motion' to t.

827
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
828
  (Lisp_Object n)
829
{
830 831
  EMACS_INT end_pos;
  EMACS_INT orig = PT;
832

833 834 835
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
836
    CHECK_NUMBER (n);
837

838 839 840
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
841
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
842
			      Qnil, Qt, Qnil);
843
}
844

845

Jim Blandy's avatar
Jim Blandy committed
846
Lisp_Object
847
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
848
{
849 850
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
851 852

  return Fcons (Fpoint_marker (),
Tom Tromey's avatar
Tom Tromey committed
853
		Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
854
		       Fcons (visible ? Qt : Qnil,
Tom Tromey's avatar
Tom Tromey committed
855
			      Fcons (BVAR (current_buffer, mark_active),
856
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
857 858 859
}

Lisp_Object
860
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
861
{
862 863
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
864
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
865

866
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
867 868 869 870
  /* 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
871
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
872
    return Qnil;
873 874 875 876

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

Jim Blandy's avatar
Jim Blandy committed
877
  Fset_buffer (tem);
878 879 880

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
881
  Fgoto_char (tem);
882
  unchain_marker (XMARKER (tem));
883 884 885 886

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
887 888
  omark = Fmarker_position (BVAR (current_buffer, mark));
  Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
889
  nmark = Fmarker_position (tem);
890
  unchain_marker (XMARKER (tem));
891 892 893 894

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

896 897 898 899
#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.  */
900 901
  tem1 = Fcar (tem);
  if (!NILP (tem1)
902
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
903
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
904
#endif /* 0 */
905

906 907 908
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
909 910
  tem1 = BVAR (current_buffer, mark_active);
  BVAR (current_buffer, mark_active) = tem;