editfns.c 136 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,
4
                 2005, 2006, 2007 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
5 6 7 8 9

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Lute Kamstra's avatar
Lute Kamstra committed
20 21
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.  */
Jim Blandy's avatar
Jim Blandy committed
22 23


24
#include <config.h>
25
#include <sys/types.h>
26
#include <stdio.h>
Jim Blandy's avatar
Jim Blandy committed
27

28
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
29
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#endif

Andreas Schwab's avatar
Andreas Schwab committed
32 33 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37 38 39
#ifdef HAVE_SYS_UTSNAME_H
#include <sys/utsname.h>
#endif

40 41
#include "lisp.h"

42 43 44 45
/* 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"
46 47

#if defined HAVE_SYS_RESOURCE_H
48 49 50
#include <sys/resource.h>
#endif

51 52
#include <ctype.h>

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

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

68 69 70 71
#ifndef NULL
#define NULL 0
#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 87
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
88
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
89 90
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
91
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
92 93
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
94
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
95 96 97 98 99 100
					 void (*) (Lisp_Object, int, int, int,
						   int, int),
					 int, int, Lisp_Object *));
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));
101

Gerd Moellmann's avatar
Gerd Moellmann committed
102 103 104 105
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

106 107 108
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
109

110
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
111

112 113 114 115
/* 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
116 117 118
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
119 120 121
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 */
122
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
123

124 125 126 127 128 129 130 131 132
/* 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
133 134 135
void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
136
  char *user_name;
137
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
138 139 140 141
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
142
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
143 144 145 146 147 148 149 150

#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
151 152 153 154
#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.)  */
155
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
156
#else
157
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
158
#endif
Jim Blandy's avatar
Jim Blandy committed
159

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

Jim Blandy's avatar
Jim Blandy committed
176 177
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
178
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
179 180
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
181

182
  p = (unsigned char *) getenv ("NAME");
183 184
  if (p)
    Vuser_full_name = build_string (p);
185 186
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
187 188 189 190 191 192 193 194 195 196

#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
197 198 199
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
200 201
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
202
     (character)
203
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
204
{
Karl Heuer's avatar
Karl Heuer committed
205
  int len;
206
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
207

208
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
209

210 211 212
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
213
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
214 215 216
}

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

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
247 248 249
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
250 251
{
  Lisp_Object temp;
252
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256
  return temp;
}

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

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: ",
276
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
277 278 279
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
280
     (position)
281
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
282
{
Karl Heuer's avatar
Karl Heuer committed
283 284
  int pos;

285 286
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
287 288 289 290 291 292 293 294 295 296 297 298
    {
      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;
    }

299
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
300

Karl Heuer's avatar
Karl Heuer committed
301 302
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
303
  return position;
Jim Blandy's avatar
Jim Blandy committed
304 305
}

306 307 308 309 310

/* 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
311 312 313 314
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
315
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
316
  Lisp_Object m;
317

318 319
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
320
      && NILP (current_buffer->mark_active))
321
    xsignal0 (Qmark_inactive);
322

Jim Blandy's avatar
Jim Blandy committed
323
  m = Fmarker_position (current_buffer->mark);
324
  if (NILP (m))
325
    error ("The mark is not set now, so there is no region");
326

327
  if ((PT < XFASTINT (m)) == (beginningp != 0))
328 329
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
330 331 332
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
333 334
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
335
{
336
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
337 338 339
}

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

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


356 357 358 359 360 361 362 363 364 365
/* 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;
{
366 367
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
368 369 370
  int startpos, endpos;
  int idx = 0;

371
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
372
    {
373
      XSETMISC (overlay, tail);
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389

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

390
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
391
    {
392
      XSETMISC (overlay, tail);
393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418

      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. */
419
Lisp_Object
420 421 422 423 424 425 426 427
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);
428 429 430 431 432 433 434 435 436
  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
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 467 468 469 470 471 472 473 474 475 476 477 478 479 480
    {
      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;
		}
	    }
	}
481

482 483 484 485 486 487 488 489 490 491 492
      { /* Now check the text-properties.  */
	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;
      }
493 494 495
    }
}

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

500 501 502
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

503 504 505 506 507
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
   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
508 509 510
   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
511 512 513 514
   finding the beginning and ending of the "merged" field.

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

516
static void
517
find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
518 519
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
520
     Lisp_Object beg_limit, end_limit;
521 522
     int *beg, *end;
{
523 524
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
525 526 527 528
  /* 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;
529

530 531 532
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
533
    CHECK_NUMBER_COERCE_MARKER (pos);
534

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

  /* 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.  */
551
  if (NILP (merge_at_boundary))
552
    {
553 554
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
555
	at_field_end = 1;
556 557
      if (!EQ (field, before_field))
	at_field_start = 1;
558 559 560 561 562 563
      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;
564 565
    }

566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587
  /* 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.  */

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
606 607
	}
    }
608 609

  if (end)
610 611 612 613 614 615 616 617 618 619
    {
      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.  */
620 621
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
622

623 624
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
625 626 627
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
628
}
629

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

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

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

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

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

701
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
702
       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
703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726

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.

727 728
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)
729 730
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
731 732 733
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;
734 735
  int fwd;
  Lisp_Object prev_old, prev_new;
736

737 738 739 740 741 742 743
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

744 745 746 747 748 749 750
  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);
751

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

      if (fwd)
779
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
780
      else
781
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
782

783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799
      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)))
800 801 802 803 804 805 806 807 808 809
	/* 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;
}
810

811

812 813
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
814
       doc: /* Return the character position of the first 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 821
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
822
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
823

824 825
This function does not move point.  */)
     (n)
826 827
     Lisp_Object n;
{
828
  int orig, orig_byte, end;
829 830
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
831 832 833 834

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

  orig = PT;
838
  orig_byte = PT_BYTE;
839 840
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
841

842
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
843

844 845
  unbind_to (count, Qnil);

846
  /* Return END constrained to the current input field.  */
847 848
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
849
			      Qt, Qnil);
850 851
}

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

857 858 859 860
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
861 862
boundaries bind `inhibit-field-text-motion' to t.

863 864
This function does not move point.  */)
     (n)
865 866
     Lisp_Object n;
{
867
  int end_pos;
868
  int orig = PT;
869

870 871 872
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
873
    CHECK_NUMBER (n);
874

875 876 877
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
878
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
879
			      Qnil, Qt, Qnil);
880
}
881

882

Jim Blandy's avatar
Jim Blandy committed
883 884 885
Lisp_Object
save_excursion_save ()
{
886 887
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
888 889

  return Fcons (Fpoint_marker (),
890
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
891
		       Fcons (visible ? Qt : Qnil,
892 893
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
894 895 896 897
}

Lisp_Object
save_excursion_restore (info)
898
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
899
{
900 901
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
902
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
903

904
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
905 906 907 908
  /* 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
909
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
910
    return Qnil;
911 912 913 914

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

Jim Blandy's avatar
Jim Blandy committed
915
  Fset_buffer (tem);
916 917 918

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
919
  Fgoto_char (tem);
920
  unchain_marker (XMARKER (tem));
921 922 923 924

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
925
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
926
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
927
  nmark = Fmarker_position (tem);
928
  unchain_marker (XMARKER (tem));
929 930 931 932

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

934 935 936 937
#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.  */
938 939
  tem1 = Fcar (tem);
  if (!NILP (tem1)
940
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
941
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
942
#endif /* 0 */
943

944 945 946
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
947
  tem1 = current_buffer->mark_active;
948 949
  current_buffer->mark_active = tem;

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

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

977
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
978 979 980 981
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
982
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
983 984 985 986 987 988 989 990
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
991 992 993
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
994
     (args)
Jim Blandy's avatar
Jim Blandy committed
995 996 997
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
998
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
999 1000

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
1001 1002 1003 1004 1005 1006

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1007
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
1008 1009
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
1010
     (args)
1011 1012
     Lisp_Object args;
{
1013
  Lisp_Object val;