editfns.c 131 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>
Jim Blandy's avatar
Jim Blandy committed
25 26

#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
27
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
28
#else
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 40 41
/* Without this, sprintf on Mac OS Classic will produce wrong
   result.  */
#ifdef MAC_OS8
#include <stdio.h>
#endif

42
#ifdef HAVE_SYS_TIME_H
43 44
#include <sys/time.h>
#endif
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"

Jim Blandy's avatar
Jim Blandy committed
60
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
61

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

69 70 71 72
#ifndef NULL
#define NULL 0
#endif

73
#ifndef USE_CRT_DLL
74
extern char **environ;
75 76
#endif

77 78 79 80
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 *));
81
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
82 83
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
84
int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
85 86
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
87
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
88 89 90 91 92 93
					 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));
94

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

99 100 101
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
102

103
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
104

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

Lisp_Object Vsystem_name;
112 113 114
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 */
Jim Blandy's avatar
Jim Blandy committed
115

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

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

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

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

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

174
  p = (unsigned char *) getenv ("NAME");
175 176
  if (p)
    Vuser_full_name = build_string (p);
177 178
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
179 180 181
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
182 183
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
184
     (character)
185
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
186
{
Karl Heuer's avatar
Karl Heuer committed
187
  int len;
188
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
189

190
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
191

192 193 194
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
195
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
196 197 198
}

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

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
229 230 231
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
232 233
{
  Lisp_Object temp;
234
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
235 236 237 238
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
239 240
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
241
{
242
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
}

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: ",
258
       doc: /* Set point to POSITION, a number or marker.
Pavel Janík's avatar
Pavel Janík committed
259 260 261
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
262 263
except in the case that `enable-multibyte-characters' is nil.  */)
     (position)
264
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
265
{
Karl Heuer's avatar
Karl Heuer committed
266 267
  int pos;

268 269
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
270 271 272 273 274 275 276 277 278 279 280 281
    {
      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;
    }

282
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
283

Karl Heuer's avatar
Karl Heuer committed
284 285
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
286
  return position;
Jim Blandy's avatar
Jim Blandy committed
287 288
}

289 290 291 292 293

/* 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
294 295 296 297
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
298
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
299
  Lisp_Object m;
300

301 302
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
303 304
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
305

Jim Blandy's avatar
Jim Blandy committed
306
  m = Fmarker_position (current_buffer->mark);
307
  if (NILP (m))
308
    error ("The mark is not set now, so there is no region");
309

310
  if ((PT < XFASTINT (m)) == (beginningp != 0))
311 312
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
313 314 315
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
316 317
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
318
{
319
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
320 321 322
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
323 324
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
325
{
326
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
327 328 329
}

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


339 340 341 342 343 344 345 346 347 348
/* 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;
{
349 350
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
351 352 353
  int startpos, endpos;
  int idx = 0;

354
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
355
    {
356
      XSETMISC (overlay, tail);
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372

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

373
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
374
    {
375
      XSETMISC (overlay, tail);
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401

      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. */
402
Lisp_Object
403 404 405 406 407 408 409 410
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);
411 412 413 414 415 416 417 418 419
  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
420 421 422 423 424 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
    {
      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;
		}
	    }
	}
464

465 466 467 468 469 470 471 472 473 474 475
      { /* 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;
      }
476 477 478
    }
}

479
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
480 481
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
482

483 484 485
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

486
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
487 488 489 490 491 492 493 494
   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.
495 496 497 498

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

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

513 514 515
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
516
    CHECK_NUMBER_COERCE_MARKER (pos);
517

518
  after_field
519
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
520 521
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
522
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
523
					Qfield, Qnil, NULL)
524
       : Qnil);
525 526 527 528 529 530 531

  /* 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.  */
532
  if (NILP (merge_at_boundary))
533
    {
534 535
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
536
	at_field_end = 1;
537 538
      if (!EQ (field, before_field))
	at_field_start = 1;
539 540 541 542 543 544
      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;
545 546
    }

547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568
  /* 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.  */

569
  if (beg)
570 571 572 573 574 575 576 577
    {
      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.  */
	{
578
	  Lisp_Object p = pos;
579 580
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
581
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
582
						       beg_limit);
583 584 585 586

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
587 588
	}
    }
589 590

  if (end)
591 592 593 594 595 596 597 598 599 600
    {
      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.  */
601 602
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
603

604 605
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
606 607 608
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
609
}
610

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

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

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

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

666
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
667
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
668 669 670
A field is a region of text with the same `field' property.
If POS is nil, the value of point is used for POS.
If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
671 672 673 674 675
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;
676 677
{
  int end;
678
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
679 680 681
  return make_number (end);
}

682
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
683
       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
684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707

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.

708 709
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)
710 711
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
712 713 714 715 716 717 718 719 720 721 722
{
  /* 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);
    }

723 724
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
725 726
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
727 728
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
729 730 731
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
732
      int fwd, shortage;
733 734
      Lisp_Object field_bound;

735 736
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
737 738 739 740

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

      if (fwd)
741
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
742
      else
743
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
744

745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761
      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)))
762 763 764 765 766 767 768 769 770 771
	/* 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;
}
772

773

774 775
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
776
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
777 778
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
779 780 781 782 783

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
784

785 786
This function does not move point.  */)
     (n)
787 788
     Lisp_Object n;
{
789
  int orig, orig_byte, end;
790 791 792 793

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
794
    CHECK_NUMBER (n);
795 796

  orig = PT;
797
  orig_byte = PT_BYTE;
798 799
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
800

801
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
802

803
  /* Return END constrained to the current input field.  */
804 805
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
806
			      Qt, Qnil);
807 808
}

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

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.

819 820
This function does not move point.  */)
     (n)
821 822
     Lisp_Object n;
{
823
  int end_pos;
824
  int orig = PT;
825

826 827 828
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
829
    CHECK_NUMBER (n);
830

831 832 833
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
834
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
835
			      Qnil, Qt, Qnil);
836
}
837

838

Jim Blandy's avatar
Jim Blandy committed
839 840 841
Lisp_Object
save_excursion_save ()
{
842 843
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
844 845

  return Fcons (Fpoint_marker (),
846
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
847
		       Fcons (visible ? Qt : Qnil,
848 849
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
850 851 852 853
}

Lisp_Object
save_excursion_restore (info)
854
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
855
{
856 857
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
858
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
859

860
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
861 862 863 864
  /* 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
865
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
866
    return Qnil;
867 868 869 870

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

Jim Blandy's avatar
Jim Blandy committed
871
  Fset_buffer (tem);
872 873 874

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
875
  Fgoto_char (tem);
876
  unchain_marker (XMARKER (tem));
877 878 879 880

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
881
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
882
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
883
  nmark = Fmarker_position (tem);
884
  unchain_marker (XMARKER (tem));
885 886 887 888

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

890 891 892 893
#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.  */
894 895
  tem1 = Fcar (tem);
  if (!NILP (tem1)
896
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
897
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
898
#endif /* 0 */
899

900 901 902
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
903
  tem1 = current_buffer->mark_active;
904 905
  current_buffer->mark_active = tem;

906 907
  if (!NILP (Vrun_hooks))
    {
908 909
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
910
      if (! NILP (current_buffer->mark_active))
911 912 913 914 915
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
916 917 918
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
919 920

  /* If buffer was visible in a window, and a different window was
921 922
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
923 924 925
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
926 927 928 929 930
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
931 932
    Fset_window_point (tem, make_number (PT));

933
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
934 935 936 937
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
938
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
939 940 941 942 943 944 945 946
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
947 948 949
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
950
     (args)
Jim Blandy's avatar
Jim Blandy committed
951 952 953
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
954
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
955 956

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
957 958 959 960 961 962

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
963
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
964 965
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
966
     (args)
967 968
     Lisp_Object args;
{
969
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
970
  int count = SPECPDL_INDEX ();
971

972
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
973

Jim Blandy's avatar
Jim Blandy committed
974 975 976 977
  val = Fprogn (args);
  return unbind_to (count, val);
}

978
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
979 980 981
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
982
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
983
{
984 985
  if (NILP (buffer))
    return make_number (Z - BEG);
986 987
  else
    {
988
      CHECK_BUFFER (buffer);
989 990 991
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
992 993 994
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
995 996 997
       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
998 999
{
  Lisp_Object temp;
1000
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
1001 1002 1003 1004
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1005 1006 1007
       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
1008
{
1009
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1010 1011 1012
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1013
       doc: /* Return the maximum permissible value of point in the current buffer.
Pavel Janík's avatar
Pavel Janík committed
1014
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
1015 1016
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1017 1018
{
  Lisp_Object temp;
1019
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
1020 1021