editfns.c 142 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 48
#include <ctype.h>

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

57 58 59 60 61 62 63
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

64 65 66 67
#ifndef NULL
#define NULL 0
#endif

68 69 70 71
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

72
#ifndef USE_CRT_DLL
73
extern char **environ;
74 75
#endif

76 77
#define TM_YEAR_BASE 1900

78 79 80 81 82 83 84
/* 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

85 86
extern size_t emacs_strftimeu (char *, size_t, const char *,
                               const struct tm *, int);
87 88

#ifdef WINDOWSNT
89
extern Lisp_Object w32_get_internal_run_time (void);
90 91
#endif

92
static int tm_diff (struct tm *, struct tm *);
93 94
static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
			EMACS_INT *, Lisp_Object, EMACS_INT *);
95
static void update_buffer_properties (EMACS_INT, EMACS_INT);
96 97 98
static Lisp_Object region_limit (int);
static size_t emacs_memftimeu (char *, size_t, const char *,
                               size_t, const struct tm *, int);
99 100 101 102 103
static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
				     void (*) (Lisp_Object, EMACS_INT,
					       EMACS_INT, EMACS_INT,
					       EMACS_INT, int),
				     int, int, Lisp_Object *);
104 105
static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
106 107
static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
			       EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
108 109

Lisp_Object Qbuffer_access_fontify_functions;
110
Lisp_Object Fuser_full_name (Lisp_Object);
111

112 113 114 115 116 117 118 119 120
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

Lisp_Object Qboundary;


Jim Blandy's avatar
Jim Blandy committed
121
void
122
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
123
{
Jim Blandy's avatar
Jim Blandy committed
124
  char *user_name;
125
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
126 127 128 129
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
130
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
131 132 133 134 135 136 137 138

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

  pw = (struct passwd *) getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
139 140 141 142
#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.)  */
143
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
144
#else
145
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
146
#endif
Jim Blandy's avatar
Jim Blandy committed
147

Jim Blandy's avatar
Jim Blandy committed
148 149
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
150
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
151
  if (!user_name)
152 153 154
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
155
    user_name = (char *) getenv ("USER");
156
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
157 158 159 160 161
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
162
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
163

Jim Blandy's avatar
Jim Blandy committed
164 165
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
166
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
167 168
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
169

170
  p = (unsigned char *) getenv ("NAME");
171 172
  if (p)
    Vuser_full_name = build_string (p);
173 174
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
175 176 177 178 179 180 181 182 183 184

#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
185 186 187
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
188 189
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
190
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
191
{
Karl Heuer's avatar
Karl Heuer committed
192
  int len;
193
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
194

195
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
196

197
  len = CHAR_STRING (XFASTINT (character), str);
198
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
199 200
}

201
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
202
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
203
  (Lisp_Object byte)
204
{
205
  unsigned char b;
206
  CHECK_NUMBER (byte);
207 208
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
209
  b = XINT (byte);
210 211 212
  return make_string_from_bytes (&b, 1, 1);
}

Jim Blandy's avatar
Jim Blandy committed
213
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
214 215
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
216
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
217 218
{
  register Lisp_Object val;
219
  CHECK_STRING (string);
220
  if (SCHARS (string))
221 222
    {
      if (STRING_MULTIBYTE (string))
223
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
224
      else
225
	XSETFASTINT (val, SREF (string, 0));
226
    }
Jim Blandy's avatar
Jim Blandy committed
227
  else
228
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232
  return val;
}

static Lisp_Object
233
buildmark (EMACS_INT charpos, EMACS_INT bytepos)
Jim Blandy's avatar
Jim Blandy committed
234 235 236
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
237
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
238 239 240 241
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
242 243
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
244
  (void)
Jim Blandy's avatar
Jim Blandy committed
245 246
{
  Lisp_Object temp;
247
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
252
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
253
  (void)
Jim Blandy's avatar
Jim Blandy committed
254
{
255
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
256 257
}

258
EMACS_INT
259
clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
Jim Blandy's avatar
Jim Blandy committed
260 261 262 263 264 265 266 267 268 269
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
270
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
271 272 273
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
274
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
275
{
276
  EMACS_INT pos;
Karl Heuer's avatar
Karl Heuer committed
277

278 279
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
280 281 282 283 284 285 286 287 288 289 290 291
    {
      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;
    }

292
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
293

Karl Heuer's avatar
Karl Heuer committed
294 295
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
296
  return position;
Jim Blandy's avatar
Jim Blandy committed
297 298
}

299 300 301 302 303

/* 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
304
static Lisp_Object
305
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
306
{
307
  Lisp_Object m;
308

309 310
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
311
      && NILP (current_buffer->mark_active))
312
    xsignal0 (Qmark_inactive);
313

Jim Blandy's avatar
Jim Blandy committed
314
  m = Fmarker_position (current_buffer->mark);
315
  if (NILP (m))
316
    error ("The mark is not set now, so there is no region");
317

Kenichi Handa's avatar
Kenichi Handa committed
318
  if ((PT < XFASTINT (m)) == (beginningp != 0))
319 320
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
321 322 323
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
324
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
325
  (void)
Jim Blandy's avatar
Jim Blandy committed
326
{
327
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
328 329 330
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
331
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
332
  (void)
Jim Blandy's avatar
Jim Blandy committed
333
{
334
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
335 336 337
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
338
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
339
Watch out!  Moving this marker changes the mark position.
340
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
341
  (void)
Jim Blandy's avatar
Jim Blandy committed
342 343 344
{
  return current_buffer->mark;
}
345 346


347 348 349 350 351
/* 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.  */

static int
352
overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
353
{
354 355
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
356
  EMACS_INT startpos, endpos;
357 358
  int idx = 0;

359
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
360
    {
361
      XSETMISC (overlay, tail);
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

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

378
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
379
    {
380
      XSETMISC (overlay, tail);
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

      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. */
407
Lisp_Object
408
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
409 410 411 412 413
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
414 415 416 417 418 419 420 421 422
  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
423
    {
424
      EMACS_INT posn = XINT (position);
425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466
      int noverlays;
      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;
		}
	    }
	}
467

468
      { /* Now check the text properties.  */
469 470 471 472 473 474 475 476 477 478
	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;
      }
479 480 481
    }
}

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

486 487 488
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

489
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
490 491 492 493 494 495 496 497
   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.
498 499 500 501

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

502
static void
503 504 505
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
	    EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
506
{
507 508
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
509 510 511 512
  /* 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;
513

514 515 516
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
517
    CHECK_NUMBER_COERCE_MARKER (pos);
518

519
  after_field
520
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
521 522
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
523
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
524
					Qfield, Qnil, NULL)
525 526 527
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
528 529 530 531 532 533 534

  /* 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.  */
535
  if (NILP (merge_at_boundary))
536
    {
537 538
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
539
	at_field_end = 1;
540 541
      if (!EQ (field, before_field))
	at_field_start = 1;
542 543 544 545 546 547
      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;
548 549
    }

550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
  /* 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.  */

572
  if (beg)
573 574 575 576 577 578 579 580
    {
      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.  */
	{
581
	  Lisp_Object p = pos;
582 583
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
584
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
585
						       beg_limit);
586 587 588 589

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
590 591
	}
    }
592 593

  if (end)
594 595 596 597 598 599 600 601 602 603
    {
      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.  */
604 605
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
606

607 608
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
609 610 611
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
612
}
613

614

615
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
616
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
617
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
618
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
619
  (Lisp_Object pos)
620
{
621
  EMACS_INT beg, end;
622
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
623 624
  if (beg != end)
    del_range (beg, end);
625
  return Qnil;
626 627 628
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
629
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
630
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
631
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
632
  (Lisp_Object pos)
633
{
634
  EMACS_INT beg, end;
635
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
636 637 638 639
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
640
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
641
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
642
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
643
  (Lisp_Object pos)
644
{
645
  EMACS_INT beg, end;
646
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
647 648 649
  return make_buffer_string (beg, end, 0);
}

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

665
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
666
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
667 668 669
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,
670 671
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
672
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
673
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
674
{
675
  EMACS_INT end;
676
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
677 678 679
  return make_number (end);
}

680
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
681
       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
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705

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.

706
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
707
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
708 709
{
  /* If non-zero, then the original point, before re-positioning.  */
710
  EMACS_INT orig_point = 0;
711 712
  int fwd;
  Lisp_Object prev_old, prev_new;
713

714 715 716 717 718 719 720
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

721 722 723 724 725 726 727
  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);
728

729 730
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
731 732
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
733 734 735 736 737
          /* 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
738
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
739
          || (XFASTINT (old_pos) > BEGV
740
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
741
      && (NILP (inhibit_capture_property)
742 743 744 745 746
          /* 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
747 748
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
749 750
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
751
    {
752
      int shortage;
753 754 755
      Lisp_Object field_bound;

      if (fwd)
756
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
757
      else
758
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
759

760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776
      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)))
777 778 779 780 781 782 783 784 785 786
	/* 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;
}
787

788

789 790
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
791
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
792 793
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
794

795 796 797
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

798 799 800 801
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
802
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
803

804
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
805
  (Lisp_Object n)
806
{
807
  EMACS_INT orig, orig_byte, end;
808 809
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
810 811 812 813

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
814
    CHECK_NUMBER (n);
815 816

  orig = PT;
817
  orig_byte = PT_BYTE;
818 819
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
820

821
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
822

823 824
  unbind_to (count, Qnil);

825
  /* Return END constrained to the current input field.  */
826 827
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
828
			      Qt, Qnil);
829 830
}

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

836 837 838
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

839 840 841 842
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
843 844
boundaries bind `inhibit-field-text-motion' to t.

845
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
846
  (Lisp_Object n)
847
{
848 849
  EMACS_INT end_pos;
  EMACS_INT orig = PT;
850

851 852 853
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
854
    CHECK_NUMBER (n);
855

856 857 858
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
859
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
860
			      Qnil, Qt, Qnil);
861
}
862

863

Jim Blandy's avatar
Jim Blandy committed
864
Lisp_Object
865
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
866
{
867 868
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
869 870

  return Fcons (Fpoint_marker (),
871
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
872
		       Fcons (visible ? Qt : Qnil,
873 874
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
875 876 877
}

Lisp_Object
878
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
879
{
880 881
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
882
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
883

884
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
885 886 887 888
  /* 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
889
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
890
    return Qnil;
891 892 893 894

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

Jim Blandy's avatar
Jim Blandy committed
895
  Fset_buffer (tem);
896 897 898

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
899
  Fgoto_char (tem);
900
  unchain_marker (XMARKER (tem));
901 902 903 904

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
905
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
906
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
907
  nmark = Fmarker_position (tem);
908
  unchain_marker (XMARKER (tem));
909 910 911 912

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

914 915 916 917
#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.  */
918 919
  tem1 = Fcar (tem);
  if (!NILP (tem1)
920
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
921
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
922
#endif /* 0 */
923

924 925 926
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
927
  tem1 = current_buffer->mark_active;
928 929
  current_buffer->mark_active = tem;

930 931
  if (!NILP (Vrun_hooks))
    {
932 933
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
934
      if (! NILP (current_buffer->mark_active))
935 936 937 938 939
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
940 941 942
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
943 944

  /* If buffer was visible in a window, and a different window was
945 946
     selected, and the old selected window is still showing this
     buffe