editfns.c 143 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2 3
   Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
Glenn Morris's avatar
Glenn Morris committed
4
                 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7

This file is part of GNU Emacs.

8
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
9
it under the terms of the GNU General Public License as published by
10 11
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
12 13 14 15 16 17 18

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
19
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


22
#include <config.h>
23
#include <sys/types.h>
24
#include <stdio.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 32 33
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

34 35 36 37
#ifdef HAVE_SYS_UTSNAME_H
#include <sys/utsname.h>
#endif

38 39
#include "lisp.h"

40 41 42 43
/* 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"
44 45

#if defined HAVE_SYS_RESOURCE_H
46
#include <sys/resource.h>
47 48
#endif

49 50
#include <ctype.h>

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

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

66 67 68 69
#ifndef NULL
#define NULL 0
#endif

70 71 72 73
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

74
#ifndef USE_CRT_DLL
75
extern char **environ;
76 77
#endif

78 79
#define TM_YEAR_BASE 1900

80 81 82 83 84 85 86
/* 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

87 88
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
89 90 91 92 93

#ifdef WINDOWSNT
extern Lisp_Object w32_get_internal_run_time ();
#endif

94
static int tm_diff P_ ((struct tm *, struct tm *));
95
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
96 97
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
98
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
99 100
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
101 102 103 104 105
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 *);
106 107 108
static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
109

Gerd Moellmann's avatar
Gerd Moellmann committed
110 111 112 113
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

114 115 116
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
117

118
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
119

120 121 122 123
/* Non-nil means don't stop at field boundary in text motion commands.  */

Lisp_Object Vinhibit_field_text_motion;

Jim Blandy's avatar
Jim Blandy committed
124 125 126
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
127 128 129
Lisp_Object Vuser_real_login_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;		/* full name of current user */
Lisp_Object Vuser_login_name;		/* user name from LOGNAME or USER */
130
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
131

132 133 134 135 136 137 138 139 140
/* 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
141 142 143
void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
144
  char *user_name;
145
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
146 147 148 149
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
150
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
151 152 153 154 155 156 157 158

#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
159 160 161 162
#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.)  */
163
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
164
#else
165
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
166
#endif
Jim Blandy's avatar
Jim Blandy committed
167

Jim Blandy's avatar
Jim Blandy committed
168 169
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
170
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
171
  if (!user_name)
172 173 174
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
175
    user_name = (char *) getenv ("USER");
176
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
177 178 179 180 181
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
182
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
183

Jim Blandy's avatar
Jim Blandy committed
184 185
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
186
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
187 188
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
189

190
  p = (unsigned char *) getenv ("NAME");
191 192
  if (p)
    Vuser_full_name = build_string (p);
193 194
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
195 196 197 198 199 200 201 202 203 204

#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
205 206 207
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
208 209
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
210
     (character)
211
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
212
{
Karl Heuer's avatar
Karl Heuer committed
213
  int len;
214
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
215

216
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
217

218
  len = CHAR_STRING (XFASTINT (character), str);
219
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
220 221 222
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
223 224 225
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
     (string)
226
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
227 228
{
  register Lisp_Object val;
229
  CHECK_STRING (string);
230
  if (SCHARS (string))
231 232
    {
      if (STRING_MULTIBYTE (string))
233
	XSETFASTINT (val, STRING_CHAR (SDATA (string), SBYTES (string)));
234
      else
235
	XSETFASTINT (val, SREF (string, 0));
236
    }
Jim Blandy's avatar
Jim Blandy committed
237
  else
238
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
239 240 241 242
  return val;
}

static Lisp_Object
243 244
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
245 246 247
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
248
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
253 254 255
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
256 257
{
  Lisp_Object temp;
258
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
259 260 261 262
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
263 264
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
265
{
266
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
}

int
clip_to_bounds (lower, num, upper)
     int lower, num, upper;
{
  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: ",
282
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
283 284 285
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
286
     (position)
287
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
288
{
Karl Heuer's avatar
Karl Heuer committed
289 290
  int pos;

291 292
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
293 294 295 296 297 298 299 300 301 302 303 304
    {
      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;
    }

305
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
306

Karl Heuer's avatar
Karl Heuer committed
307 308
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
309
  return position;
Jim Blandy's avatar
Jim Blandy committed
310 311
}

312 313 314 315 316

/* 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
317 318 319 320
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
321
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
322
  Lisp_Object m;
323

324 325
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
326
      && NILP (current_buffer->mark_active))
327
    xsignal0 (Qmark_inactive);
328

Jim Blandy's avatar
Jim Blandy committed
329
  m = Fmarker_position (current_buffer->mark);
330
  if (NILP (m))
331
    error ("The mark is not set now, so there is no region");
332

Kenichi Handa's avatar
Kenichi Handa committed
333
  if ((PT < XFASTINT (m)) == (beginningp != 0))
334 335
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
336 337 338
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
339 340
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
341
{
342
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
343 344 345
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
346 347
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
348
{
349
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
350 351 352
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
353
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
354
Watch out!  Moving this marker changes the mark position.
355 356
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
357 358 359
{
  return current_buffer->mark;
}
360 361


362 363 364 365 366 367 368 369 370 371
/* 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
overlays_around (pos, vec, len)
     int pos;
     Lisp_Object *vec;
     int len;
{
372 373
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
374 375 376
  int startpos, endpos;
  int idx = 0;

377
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
378
    {
379
      XSETMISC (overlay, tail);
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

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

396
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
397
    {
398
      XSETMISC (overlay, tail);
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

      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. */
425
Lisp_Object
426 427 428 429 430 431 432 433
get_pos_property (position, prop, object)
     Lisp_Object position, object;
     register Lisp_Object prop;
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
434 435 436 437 438 439 440 441 442
  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
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486
    {
      int posn = XINT (position);
      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;
		}
	    }
	}
487

488
      { /* Now check the text properties.  */
489 490 491 492 493 494 495 496 497 498
	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;
      }
499 500 501
    }
}

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

506 507 508
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

509
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
510 511 512 513 514 515 516 517
   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.
518 519 520 521

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

522
static void
523
find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
524 525
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
526
     Lisp_Object beg_limit, end_limit;
527 528
     int *beg, *end;
{
529 530
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
531 532 533 534
  /* 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;
535

536 537 538
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
539
    CHECK_NUMBER_COERCE_MARKER (pos);
540

541
  after_field
542
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
543 544
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
545
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
546
					Qfield, Qnil, NULL)
547 548 549
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
550 551 552 553 554 555 556

  /* 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.  */
557
  if (NILP (merge_at_boundary))
558
    {
559 560
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
561
	at_field_end = 1;
562 563
      if (!EQ (field, before_field))
	at_field_start = 1;
564 565 566 567 568 569
      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;
570 571
    }

572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593
  /* 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.  */

594
  if (beg)
595 596 597 598 599 600 601 602
    {
      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.  */
	{
603
	  Lisp_Object p = pos;
604 605
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
606
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
607
						       beg_limit);
608 609 610 611

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
612 613
	}
    }
614 615

  if (end)
616 617 618 619 620 621 622 623 624 625
    {
      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.  */
626 627
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
628

629 630
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
631 632 633
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
634
}
635

636

637
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
638
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
639
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
640
If POS is nil, the value of point is used for POS.  */)
641
     (pos)
642 643 644
     Lisp_Object pos;
{
  int beg, end;
645
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
646 647
  if (beg != end)
    del_range (beg, end);
648
  return Qnil;
649 650 651
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
652
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
653
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
654
If POS is nil, the value of point is used for POS.  */)
655
     (pos)
656 657 658
     Lisp_Object pos;
{
  int beg, end;
659
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
660 661 662 663
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
664
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
665
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
666
If POS is nil, the value of point is used for POS.  */)
667
     (pos)
668 669 670
     Lisp_Object pos;
{
  int beg, end;
671
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
672 673 674
  return make_buffer_string (beg, end, 0);
}

675
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
676
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
677 678 679
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
680 681
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
682
is before LIMIT, then LIMIT will be returned instead.  */)
683 684
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
685 686
{
  int beg;
687
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
688 689 690
  return make_number (beg);
}

691
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
692
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
693 694 695
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,
696 697
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
698
is after LIMIT, then LIMIT will be returned instead.  */)
699 700
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
701 702
{
  int end;
703
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
704 705 706
  return make_number (end);
}

707
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
708
       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
709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732

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.

733 734
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
     (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
735 736
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
737 738 739
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;
740 741
  int fwd;
  Lisp_Object prev_old, prev_new;
742

743 744 745 746 747 748 749
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

750 751 752 753 754 755 756
  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);
757

758 759
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
760 761
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
762 763 764 765 766
          /* 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
767
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
768
          || (XFASTINT (old_pos) > BEGV
769
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
770
      && (NILP (inhibit_capture_property)
771 772 773 774 775
          /* 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
776 777
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
778 779
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
780
    {
781
      int shortage;
782 783 784
      Lisp_Object field_bound;

      if (fwd)
785
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
786
      else
787
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
788

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805
      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)))
806 807 808 809 810 811 812 813 814 815
	/* 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;
}
816

817

818 819
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
820
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
821 822
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
823

824 825 826 827
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
828
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
829

830 831
This function does not move point.  */)
     (n)
832 833
     Lisp_Object n;
{
834
  int orig, orig_byte, end;
835 836
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
837 838 839 840

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
841
    CHECK_NUMBER (n);
842 843

  orig = PT;
844
  orig_byte = PT_BYTE;
845 846
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
847

848
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
849

850 851
  unbind_to (count, Qnil);

852
  /* Return END constrained to the current input field.  */
853 854
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
855
			      Qt, Qnil);
856 857
}

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

863 864 865 866
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
867 868
boundaries bind `inhibit-field-text-motion' to t.

869 870
This function does not move point.  */)
     (n)
871 872
     Lisp_Object n;
{
873
  int end_pos;
874
  int orig = PT;
875

876 877 878
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
879
    CHECK_NUMBER (n);
880

881 882 883
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
884
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
885
			      Qnil, Qt, Qnil);
886
}
887

888

Jim Blandy's avatar
Jim Blandy committed
889 890 891
Lisp_Object
save_excursion_save ()
{
892 893
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
894 895

  return Fcons (Fpoint_marker (),
896
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
897
		       Fcons (visible ? Qt : Qnil,
898 899
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
900 901 902 903
}

Lisp_Object
save_excursion_restore (info)
904
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
905
{
906 907
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
908
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
909

910
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914
  /* 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
915
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
916
    return Qnil;
917 918 919 920

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

Jim Blandy's avatar
Jim Blandy committed
921
  Fset_buffer (tem);
922 923 924

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
925
  Fgoto_char (tem);
926
  unchain_marker (XMARKER (tem));
927 928 929 930

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
931
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
932
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
933
  nmark = Fmarker_position (tem);
934
  unchain_marker (XMARKER (tem));
935 936 937 938

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

940 941 942 943
#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.  */
944 945
  tem1 = Fcar (tem);
  if (!NILP (tem1)
946
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
947
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
948
#endif /* 0 */
949

950 951 952
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
953
  tem1 = current_buffer->mark_active;
954 955
  current_buffer->mark_active = tem;

956 957
  if (!NILP (Vrun_hooks))
    {
958 959
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
960
      if (! NILP (current_buffer->mark_active))
961 962 963 964 965
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
966 967 968
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
969 970

  /* If buffer was visible in a window, and a different window was
971 972
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
973 974 975
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
976 977 978 979 980
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
981 982
    Fset_window_point (tem, make_number (PT));

983
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
988
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
989 990 991 992 993 994 995 996
Executes BODY just like `progn'.
The values of point, mark and the current buffer are restored
even in case of abnormal exit (throw or error).
The state of activation of the mark is also restored.

This construct does not save `deactivate-mark', and therefore
functions that change the buffer will still cause deactivation
of the mark at the end of the command.  To prevent that, bind
997 998 999
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
1000
     (args)
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
1004
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
1005 1006

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
1007 1008 1009 1010 1011 1012

  val = Fprogn (args);
  return unbind_to (count, val);
}

DEFUN ("save-current-buffer",