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
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
102 103 104 105 106 107
					 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));
108

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

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

117
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
118

119 120 121 122
/* 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
123 124 125
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
126 127 128
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 */
129
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
130

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

311 312 313 314 315

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

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

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

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

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

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

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

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

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

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

395
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
396
    {
397
      XSETMISC (overlay, tail);
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

      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. */
424
Lisp_Object
425 426 427 428 429 430 431 432
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);
433 434 435 436 437 438 439 440 441
  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
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 481 482 483 484 485
    {
      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;
		}
	    }
	}
486

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

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

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

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

849 850
  unbind_to (count, Qnil);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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