editfns.c 133 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2 3 4
   Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996,
                 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004,
                 2005 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 77
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
78
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
79 80
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
81
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
82 83
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
84
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
85 86 87 88 89 90
					 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));
91

Gerd Moellmann's avatar
Gerd Moellmann committed
92 93 94 95
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

96 97 98
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
99

100
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
101

102 103 104 105
/* 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
106 107 108
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
109 110 111
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 */
112
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
113

114 115 116 117 118 119 120 121 122
/* 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
123 124 125
void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
126
  char *user_name;
127
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
128 129 130 131
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
132
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
133 134 135 136 137 138 139 140

#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
141 142 143 144
#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.)  */
145
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
146
#else
147
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
148
#endif
Jim Blandy's avatar
Jim Blandy committed
149

Jim Blandy's avatar
Jim Blandy committed
150 151
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
152
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
153
  if (!user_name)
154 155 156
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
157
    user_name = (char *) getenv ("USER");
158
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
159 160 161 162 163
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
164
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
165

Jim Blandy's avatar
Jim Blandy committed
166 167
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
168
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
169 170
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
171

172
  p = (unsigned char *) getenv ("NAME");
173 174
  if (p)
    Vuser_full_name = build_string (p);
175 176
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
177 178 179 180 181 182 183 184 185 186

#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
187 188 189
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
190 191
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
192
     (character)
193
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
194
{
Karl Heuer's avatar
Karl Heuer committed
195
  int len;
196
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
197

198
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
199

200 201 202
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
203
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
204 205 206
}

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

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
237 238 239
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
240 241
{
  Lisp_Object temp;
242
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
247 248
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
249
{
250
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
}

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: ",
266
       doc: /* Set point to POSITION, a number or marker.
267
Beginning of buffer is position (point-min), end is (point-max).  */)
268
     (position)
269
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
270
{
Karl Heuer's avatar
Karl Heuer committed
271 272
  int pos;

273 274
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
275 276 277 278 279 280 281 282 283 284 285 286
    {
      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;
    }

287
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
288

Karl Heuer's avatar
Karl Heuer committed
289 290
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
291
  return position;
Jim Blandy's avatar
Jim Blandy committed
292 293
}

294 295 296 297 298

/* 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
299 300 301 302
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
303
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
304
  Lisp_Object m;
305

306 307
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
308 309
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
310

Jim Blandy's avatar
Jim Blandy committed
311
  m = Fmarker_position (current_buffer->mark);
312
  if (NILP (m))
313
    error ("The mark is not set now, so there is no region");
314

315
  if ((PT < XFASTINT (m)) == (beginningp != 0))
316 317
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
318 319 320
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
321 322
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
323
{
324
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
325 326 327
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
328 329
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
330
{
331
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
332 333 334
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
335
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
336
Watch out!  Moving this marker changes the mark position.
337 338
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
339 340 341
{
  return current_buffer->mark;
}
342 343


344 345 346 347 348 349 350 351 352 353
/* 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;
{
354 355
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
356 357 358
  int startpos, endpos;
  int idx = 0;

359
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
360
    {
361
      XSETMISC (overlay, tail);
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377

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

378
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
379
    {
380
      XSETMISC (overlay, tail);
381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406

      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. */
407
Lisp_Object
408 409 410 411 412 413 414 415
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);
416 417 418 419 420 421 422 423 424
  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
425 426 427 428 429 430 431 432 433 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
    {
      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;
		}
	    }
	}
469

470 471 472 473 474 475 476 477 478 479 480
      { /* 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;
      }
481 482 483
    }
}

484
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
485 486
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
487

488 489 490
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

491
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
492 493 494 495 496 497 498 499
   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.
500 501 502 503

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

504
static void
505
find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
506 507
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
508
     Lisp_Object beg_limit, end_limit;
509 510
     int *beg, *end;
{
511 512
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
513 514 515 516
  /* 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;
517

518 519 520
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
521
    CHECK_NUMBER_COERCE_MARKER (pos);
522

523
  after_field
524
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
525 526
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
527
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
528
					Qfield, Qnil, NULL)
529 530 531
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
532 533 534 535 536 537 538

  /* 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.  */
539
  if (NILP (merge_at_boundary))
540
    {
541 542
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
543
	at_field_end = 1;
544 545
      if (!EQ (field, before_field))
	at_field_start = 1;
546 547 548 549 550 551
      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;
552 553
    }

554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575
  /* 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.  */

576
  if (beg)
577 578 579 580 581 582 583 584
    {
      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.  */
	{
585
	  Lisp_Object p = pos;
586 587
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
588
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
589
						       beg_limit);
590 591 592 593

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
594 595
	}
    }
596 597

  if (end)
598 599 600 601 602 603 604 605 606 607
    {
      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.  */
608 609
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
610

611 612
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
613 614 615
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
616
}
617

618

619
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
620
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
621
A field is a region of text with the same `field' property.
622 623
If POS is nil, the value of point is used for POS.  */)
     (pos)
624 625 626
     Lisp_Object pos;
{
  int beg, end;
627
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
628 629
  if (beg != end)
    del_range (beg, end);
630
  return Qnil;
631 632 633
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
634
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
635
A field is a region of text with the same `field' property.
636 637
If POS is nil, the value of point is used for POS.  */)
     (pos)
638 639 640
     Lisp_Object pos;
{
  int beg, end;
641
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
642 643 644 645
  return make_buffer_string (beg, end, 1);
}

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

657
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
658
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
659 660 661
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
662 663 664 665 666
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;
667 668
{
  int beg;
669
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
670 671 672
  return make_number (beg);
}

673
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
674
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
675 676 677
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,
678 679 680 681 682
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;
683 684
{
  int end;
685
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
686 687 688
  return make_number (end);
}

689
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
690
       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
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714

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.

715 716
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)
717 718
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
719 720 721
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;
722 723
  int fwd, prev_old, prev_new;
  
724 725 726 727 728 729 730
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

731 732 733 734 735 736 737 738
  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);
  
739 740
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
741 742 743 744 745 746 747 748 749 750
      && (!NILP (Fget_text_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_text_property (old_pos, Qfield, Qnil))
          /* 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
              && !NILP (Fget_text_property (prev_new, Qfield, Qnil)))
          || (XFASTINT (old_pos) > BEGV
              && !NILP (Fget_text_property (prev_old, Qfield, Qnil))))
751
      && (NILP (inhibit_capture_property)
752 753 754 755 756 757 758
          /* 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
                  || NILP (Fget_text_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_text_property (prev_old, inhibit_capture_property, Qnil))))))
759 760
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
761
    {
762
      int shortage;
763 764 765
      Lisp_Object field_bound;

      if (fwd)
766
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
767
      else
768
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
769

770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786
      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)))
787 788 789 790 791 792 793 794 795 796
	/* 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;
}
797

798

799 800
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
801
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
802 803
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
804

805 806 807 808
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
809
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
810

811 812
This function does not move point.  */)
     (n)
813 814
     Lisp_Object n;
{
815
  int orig, orig_byte, end;
816 817 818 819

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
820
    CHECK_NUMBER (n);
821 822

  orig = PT;
823
  orig_byte = PT_BYTE;
824 825
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
826

827
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
828

829
  /* Return END constrained to the current input field.  */
830 831
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
832
			      Qt, Qnil);
833 834
}

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

840 841 842 843
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
844 845
boundaries bind `inhibit-field-text-motion' to t.

846 847
This function does not move point.  */)
     (n)
848 849
     Lisp_Object n;
{
850
  int end_pos;
851
  int orig = PT;
852

853 854 855
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
856
    CHECK_NUMBER (n);
857

858 859 860
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
861
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
862
			      Qnil, Qt, Qnil);
863
}
864

865

Jim Blandy's avatar
Jim Blandy committed
866 867 868
Lisp_Object
save_excursion_save ()
{
869 870
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
871 872

  return Fcons (Fpoint_marker (),
873
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
874
		       Fcons (visible ? Qt : Qnil,
875 876
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880
}

Lisp_Object
save_excursion_restore (info)
881
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
882
{
883 884
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
885
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
886

887
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
888 889 890 891
  /* 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
892
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
893
    return Qnil;
894 895 896 897

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

Jim Blandy's avatar
Jim Blandy committed
898
  Fset_buffer (tem);
899 900 901

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
902
  Fgoto_char (tem);
903
  unchain_marker (XMARKER (tem));
904 905 906 907

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
908
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
909
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
910
  nmark = Fmarker_position (tem);
911
  unchain_marker (XMARKER (tem));
912 913 914 915

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

917 918 919 920
#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.  */
921 922
  tem1 = Fcar (tem);
  if (!NILP (tem1)
923
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
924
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
925
#endif /* 0 */
926

927 928 929
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
930
  tem1 = current_buffer->mark_active;
931 932
  current_buffer->mark_active = tem;

933 934
  if (!NILP (Vrun_hooks))
    {
935 936
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
937
      if (! NILP (current_buffer->mark_active))
938 939 940 941 942
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
943 944 945
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
946 947

  /* If buffer was visible in a window, and a different window was
948 949
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
950 951 952
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
953 954 955 956 957
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
958 959
    Fset_window_point (tem, make_number (PT));

960
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
961 962 963 964
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
965
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
966 967 968 969 970 971 972 973
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
974 975 976
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
977
     (args)
Jim Blandy's avatar
Jim Blandy committed
978 979 980
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
981
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
982 983

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
984 985 986 987 988 989

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
990
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
991 992
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
993
     (args)
994 995
     Lisp_Object args;
{
996
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
997
  int count = SPECPDL_INDEX ();
998

999
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1000

Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003 1004
  val = Fprogn (args);
  return unbind_to (count, val);
}

1005
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1006 1007 1008
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
1009
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1010
{
1011 1012
  if (NILP (buffer))
    return make_number (Z - BEG);
1013 1014
  else
    {
1015
      CHECK_BUFFER (buffer);
1016 1017 1018
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1022 1023 1024
       doc: /* Return the minimum permissible value of point in the current buffer.
This is 1, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1025 1026
{
  Lisp_Object temp;
1027
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
1028 1029 1030 1031
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1032 1033 1034
       doc: /* Return a marker to the minimum permissible value of point in this buffer.
This is the beginning, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1035
{
1036
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1040
       doc: /* Return the maximum permissible value of point in the current buffer.
Pavel Janík's avatar
Pavel Janík committed
1041
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1042 1043
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1044 1045
{
  Lisp_Object temp;
1046
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050
  return temp;
}

DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
1051
       doc: /* Return a marker to the maximum permissible value of point in this buffer.
Pavel Janík's avatar
Pavel Janík committed
1052
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1053 1054
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1055
{
1056
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1057 1058
}

1059
DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
1060 1061 1062
       doc: /* Return the position of the gap, in the current buffer.
See also `gap-size'.  */)
     ()
1063 1064 1065 1066 1067 1068 1069
{
  Lisp_Object temp;
  XSETFASTINT (temp, GPT);
  return temp;
}

DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
1070 1071 1072
       doc: /* Return the size of the current buffer's gap.
See also `gap-position'.  */)
     ()
1073 1074 1075 1076 1077 1078
{
  Lisp_Object temp;
  XSETFASTINT (temp, GAP_SIZE);
  return temp;
}

1079
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
1080 1081 1082
       doc: /* Return the byte position for character position POSITION.
If POSITION is out of range, the value is nil.  */)
     (position)
1083
     Lisp_Object position;
1084
{
1085
  CHECK_NUMBER_COERCE_MARKER (position);
1086 1087
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
1088
  return make_number (CHAR_TO_BYTE (XINT (position)));
1089
}
1090 1091

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
1092 1093 1094
       doc: /* Return the character position for byte position BYTEPOS.
If BYTEPOS is out of range, the value is nil.  */)
     (bytepos)
1095 1096
     Lisp_Object bytepos;
{
1097
  CHECK_NUMBER (bytepos);
1098 1099
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
1100 1101
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
1102

Jim Blandy's avatar
Jim Blandy committed
1103
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
1104 1105 1106
       doc: /* Return the character following point, as a number.
At the end of the buffer or accessible region, return 0.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1107 1108
{
  Lisp_Object temp;
1109
  if (PT >= ZV)