editfns.c 132 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2
   Copyright (C) 1985,86,87,89,93,94,95,96,97,98,1999,2000,01,02,03,2004
3
	Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

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
9
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
10 11 12 13 14 15 16 17 18
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
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


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

#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
28
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
29
#else
Jim Blandy's avatar
Jim Blandy committed
30
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
31 32
#endif

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

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

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

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

50 51
#include <ctype.h>

Jim Blandy's avatar
Jim Blandy committed
52
#include "lisp.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 78
extern Lisp_Object make_time P_ ((time_t));
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
79
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
80 81
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
82
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
83 84
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
85
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
86 87 88 89 90 91
					 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));
92

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

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

101
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
102

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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: ",
267
       doc: /* Set point to POSITION, a number or marker.
Pavel Janík's avatar
Pavel Janík committed
268 269 270
Beginning of buffer is position (point-min), end is (point-max).
If the position is in the middle of a multibyte form,
the actual point is set at the head of the multibyte form
271 272
except in the case that `enable-multibyte-characters' is nil.  */)
     (position)
273
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
274
{
Karl Heuer's avatar
Karl Heuer committed
275 276
  int pos;

277 278
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
279 280 281 282 283 284 285 286 287 288 289 290
    {
      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;
    }

291
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
292

Karl Heuer's avatar
Karl Heuer committed
293 294
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
295
  return position;
Jim Blandy's avatar
Jim Blandy committed
296 297
}

298 299 300 301 302

/* 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
303 304 305 306
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
307
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
308
  Lisp_Object m;
309

310 311
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
312 313
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
314

Jim Blandy's avatar
Jim Blandy committed
315
  m = Fmarker_position (current_buffer->mark);
316
  if (NILP (m))
317
    error ("The mark is not set now, so there is no region");
318

319
  if ((PT < XFASTINT (m)) == (beginningp != 0))
320 321
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
322 323 324
}

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

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

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

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

363
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
364
    {
365
      XSETMISC (overlay, tail);
366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381

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

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

      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. */
411
Lisp_Object
412 413 414 415 416 417 418 419
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);
420 421 422 423 424 425 426 427 428
  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
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 469 470 471 472
    {
      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;
		}
	    }
	}
473

474 475 476 477 478 479 480 481 482 483 484
      { /* 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;
      }
485 486 487
    }
}

488
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
489 490
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
491

492 493 494
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

495
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
496 497 498 499 500 501 502 503
   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.
504 505 506 507

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

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

522 523 524
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
525
    CHECK_NUMBER_COERCE_MARKER (pos);
526

527
  after_field
528
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
529 530
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
531
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
532
					Qfield, Qnil, NULL)
533
       : Qnil);
534 535 536 537 538 539 540

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

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

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

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

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

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

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

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

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

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

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

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

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.

717 718
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)
719 720
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
721 722 723 724 725 726 727 728 729 730 731
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;

  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

732 733
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
734 735
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
736 737
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
738 739 740
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
741
      int fwd, shortage;
742 743
      Lisp_Object field_bound;

744 745
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
746 747 748 749

      fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));

      if (fwd)
750
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
751
      else
752
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
753

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
      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)))
771 772 773 774 775 776 777 778 779 780
	/* 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;
}
781

782

783 784
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
785
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
786 787
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
788 789 790 791 792

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
793

794 795
This function does not move point.  */)
     (n)
796 797
     Lisp_Object n;
{
798
  int orig, orig_byte, end;
799 800 801 802

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
803
    CHECK_NUMBER (n);
804 805

  orig = PT;
806
  orig_byte = PT_BYTE;
807 808
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
809

810
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
811

812
  /* Return END constrained to the current input field.  */
813 814
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
815
			      Qt, Qnil);
816 817
}

818
DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
819
       doc: /* Return the character position of the last character on the current line.
Pavel Janík's avatar
Pavel Janík committed
820 821
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
822 823 824 825 826 827

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.

828 829
This function does not move point.  */)
     (n)
830 831
     Lisp_Object n;
{
832
  int end_pos;
833
  int orig = PT;
834

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

840 841 842
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
843
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
844
			      Qnil, Qt, Qnil);
845
}
846

847

Jim Blandy's avatar
Jim Blandy committed
848 849 850
Lisp_Object
save_excursion_save ()
{
851 852
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
853 854

  return Fcons (Fpoint_marker (),
855
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
856
		       Fcons (visible ? Qt : Qnil,
857 858
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
859 860 861 862
}

Lisp_Object
save_excursion_restore (info)
863
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
864
{
865 866
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
867
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
868

869
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
870 871 872 873
  /* 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
874
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
875
    return Qnil;
876 877 878 879

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

Jim Blandy's avatar
Jim Blandy committed
880
  Fset_buffer (tem);
881 882 883

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
884
  Fgoto_char (tem);
885
  unchain_marker (XMARKER (tem));
886 887 888 889

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
890
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
891
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
892
  nmark = Fmarker_position (tem);
893
  unchain_marker (XMARKER (tem));
894 895 896 897

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

899 900 901 902
#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.  */
903 904
  tem1 = Fcar (tem);
  if (!NILP (tem1)
905
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
906
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
907
#endif /* 0 */
908

909 910 911
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
912
  tem1 = current_buffer->mark_active;
913 914
  current_buffer->mark_active = tem;

915 916
  if (!NILP (Vrun_hooks))
    {
917 918
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
919
      if (! NILP (current_buffer->mark_active))
920 921 922 923 924
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
925 926 927
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
928 929

  /* If buffer was visible in a window, and a different window was
930 931
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
932 933 934
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
935 936 937 938 939
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
940 941
    Fset_window_point (tem, make_number (PT));

942
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
943 944 945 946
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
947
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
948 949 950 951 952 953 954 955
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
956 957 958
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
959
     (args)
Jim Blandy's avatar
Jim Blandy committed
960 961 962
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
963
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
964 965

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
966 967 968 969 970 971

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
972
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
973 974
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
975
     (args)
976 977
     Lisp_Object args;
{
978
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
979
  int count = SPECPDL_INDEX ();
980

981
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
982

Jim Blandy's avatar
Jim Blandy committed
983 984 985 986
  val = Fprogn (args);
  return unbind_to (count, val);
}

987
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
988 989 990
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
991
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
992
{
993 994
  if (NILP (buffer))
    return make_number (Z - BEG);
995 996
  else
    {
997
      CHECK_BUFFER (buffer);
998 999 1000
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1004 1005 1006
       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
1007 1008
{
  Lisp_Object temp;
1009
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012 1013
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1014 1015 1016
       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
1017
{
1018
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1022
       doc: /* Return the maximum permissible value of point in the current buffer.
Pavel Janík's avatar
Pavel Janík committed
1023
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1024 1025
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1026 1027
{
  Lisp_Object temp;