editfns.c 142 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 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
10
the Free Software Foundation; either version 3, 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
#include <sys/resource.h>
49 50
#endif

51 52
#include <ctype.h>

53
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
54
#include "buffer.h"
55
#include "character.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
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
87 88 89 90 91

#ifdef WINDOWSNT
extern Lisp_Object w32_get_internal_run_time ();
#endif

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

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

111 112 113
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
114

115
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
116

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

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

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

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

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

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

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

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

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

213
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
214

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

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

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

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

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

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

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

302
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
303

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

309 310 311 312 313

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

533 534 535
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
536
    CHECK_NUMBER_COERCE_MARKER (pos);
537

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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

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

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

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

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

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

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
838
    CHECK_NUMBER (n);
839 840

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

845
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
846

847 848
  unbind_to (count, Qnil);

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

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

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

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

873 874 875
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
876
    CHECK_NUMBER (n);
877

878 879 880
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
918
  Fset_buffer (tem);
919 920 921

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

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

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

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

947 948 949
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
950
  tem1 = current_buffer->mark_active;
951 952
  current_buffer->mark_active = tem;

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

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

980
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
981 982 983 984
  return Qnil;
}

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

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

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
1004 1005 1006 1007 1008 1009

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

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