editfns.c 134 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 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 59
#include "window.h"

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

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

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

75 76
#define TM_YEAR_BASE 1900

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

84 85 86
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
87
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
88 89
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
90
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
91 92
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
93
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
94 95 96 97 98 99
					 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));
100

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

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

109
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
110

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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: ",
275
       doc: /* Set point to POSITION, a number or marker.
276
Beginning of buffer is position (point-min), end is (point-max).  */)
277
     (position)
278
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
279
{
Karl Heuer's avatar
Karl Heuer committed
280 281
  int pos;

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

296
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
297

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

303 304 305 306 307

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

315 316
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
317 318
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
319

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

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

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

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

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

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

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

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

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

      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. */
416
Lisp_Object
417 418 419 420 421 422 423 424
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);
425 426 427 428 429 430 431 432 433
  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
434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477
    {
      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;
		}
	    }
	}
478

479 480 481 482 483 484 485 486 487 488 489
      { /* 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;
      }
490 491 492
    }
}

493
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
494 495
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
496

497 498 499
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

500
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
501 502 503 504 505 506 507 508
   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.
509 510 511 512

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

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

527 528 529
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
530
    CHECK_NUMBER_COERCE_MARKER (pos);
531

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

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

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

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
603 604
	}
    }
605 606

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

620 621
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
622 623 624
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
625
}
626

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

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

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

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

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

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

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.

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

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

741 742 743 744 745 746 747
  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);
748

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

      if (fwd)
776
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
777
      else
778
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
779

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

808

809 810
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
811
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
812 813
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
814

815 816 817 818
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
819
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
820

821 822
This function does not move point.  */)
     (n)
823 824
     Lisp_Object n;
{
825
  int orig, orig_byte, end;
826 827 828 829

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
830
    CHECK_NUMBER (n);
831 832

  orig = PT;
833
  orig_byte = PT_BYTE;
834 835
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
836

837
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
838

839
  /* Return END constrained to the current input field.  */
840 841
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
842
			      Qt, Qnil);
843 844
}

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

850 851 852 853
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
854 855
boundaries bind `inhibit-field-text-motion' to t.

856 857
This function does not move point.  */)
     (n)
858 859
     Lisp_Object n;
{
860
  int end_pos;
861
  int orig = PT;
862

863 864 865
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
866
    CHECK_NUMBER (n);
867

868 869 870
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
871
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
872
			      Qnil, Qt, Qnil);
873
}
874

875

Jim Blandy's avatar
Jim Blandy committed
876 877 878
Lisp_Object
save_excursion_save ()
{
879 880
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
881 882

  return Fcons (Fpoint_marker (),
883
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
884
		       Fcons (visible ? Qt : Qnil,
885 886
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890
}

Lisp_Object
save_excursion_restore (info)
891
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
892
{
893 894
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
895
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
896

897
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
898 899 900 901
  /* 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
902
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
903
    return Qnil;
904 905 906 907

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

Jim Blandy's avatar
Jim Blandy committed
908
  Fset_buffer (tem);
909 910 911

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
912
  Fgoto_char (tem);
913
  unchain_marker (XMARKER (tem));
914 915 916 917

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
918
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
919
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
920
  nmark = Fmarker_position (tem);
921
  unchain_marker (XMARKER (tem));
922 923 924 925

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

927 928 929 930
#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.  */
931 932
  tem1 = Fcar (tem);
  if (!NILP (tem1)
933
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
934
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
935
#endif /* 0 */
936

937 938 939
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
940
  tem1 = current_buffer->mark_active;
941 942
  current_buffer->mark_active = tem;

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

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

970
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
971 972 973 974
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
975
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
976 977 978 979 980 981 982 983
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
984 985 986
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
987
     (args)
Jim Blandy's avatar
Jim Blandy committed
988 989 990
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
991
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
992 993

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
994 995 996 997 998 999

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1000
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
1001 1002
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
1003
     (args)
1004 1005
     Lisp_Object args;
{
1006
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
1007
  int count = SPECPDL_INDEX ();
1008

1009
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1010

Jim Blandy's avatar
Jim Blandy committed
1011 1012 1013 1014
  val = Fprogn (args);
  return unbind_to (count, val);
}

1015
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1016 1017 1018
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
1019
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1020
{
1021 1022
  if (NILP (buffer))
    return make_number (Z - BEG);
1023 1024
  else
    {