editfns.c 143 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2 3 4 5

Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996, 1997,
  1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
  2009, 2010 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

9
GNU Emacs is free software: you can redistribute it and/or modify
Jim Blandy's avatar
Jim Blandy committed
10
it under the terms of the GNU General Public License as published by
11 12
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
Jim Blandy's avatar
Jim Blandy committed
13 14 15 16 17 18 19

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
20
along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


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

28
#ifdef HAVE_PWD_H
Jim Blandy's avatar
Jim Blandy committed
29
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#endif

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

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

40 41
#include "lisp.h"

42 43 44 45
/* systime.h includes <sys/time.h> which, on some systems, is required
   for <sys/resource.h>; thus systime.h must be included before
   <sys/resource.h> */
#include "systime.h"
46 47

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

51 52
#include <ctype.h>

53
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
54
#include "buffer.h"
55
#include "character.h"
56
#include "coding.h"
57
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
58
#include "window.h"
YAMAMOTO Mitsuharu's avatar
YAMAMOTO Mitsuharu committed
59
#include "blockinput.h"
Jim Blandy's avatar
Jim Blandy committed
60

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

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

72 73 74 75
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

76
#ifndef USE_CRT_DLL
77
extern char **environ;
78 79
#endif

80 81
#define TM_YEAR_BASE 1900

82 83 84 85 86 87 88
/* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
   asctime to have well-defined behavior.  */
#ifndef TM_YEAR_IN_ASCTIME_RANGE
# define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
    (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
#endif

89 90
extern size_t emacs_strftimeu (char *, size_t, const char *,
                               const struct tm *, int);
91 92 93 94 95

#ifdef WINDOWSNT
extern Lisp_Object w32_get_internal_run_time ();
#endif

96 97 98 99 100 101 102
static int tm_diff (struct tm *, struct tm *);
static void find_field (Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *);
static void update_buffer_properties (int, int);
static Lisp_Object region_limit (int);
int lisp_time_argument (Lisp_Object, time_t *, int *);
static size_t emacs_memftimeu (char *, size_t, const char *,
                               size_t, const struct tm *, int);
103 104 105 106 107
static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
				     void (*) (Lisp_Object, EMACS_INT,
					       EMACS_INT, EMACS_INT,
					       EMACS_INT, int),
				     int, int, Lisp_Object *);
108 109 110
static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
static void transpose_markers (int, int, int, int, int, int, int, int);
111

Gerd Moellmann's avatar
Gerd Moellmann committed
112
#ifdef HAVE_INDEX
113
extern char *index (const char *, int);
Gerd Moellmann's avatar
Gerd Moellmann committed
114 115
#endif

116 117 118
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
119

120
Lisp_Object Fuser_full_name (Lisp_Object);
121

122 123 124 125
/* 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
126 127 128
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
129 130 131
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 */
132
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
133

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

  /* Set up system_name even when dumping.  */
152
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158 159 160

#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
161 162 163 164
#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.)  */
165
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
166
#else
167
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
168
#endif
Jim Blandy's avatar
Jim Blandy committed
169

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

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

192
  p = (unsigned char *) getenv ("NAME");
193 194
  if (p)
    Vuser_full_name = build_string (p);
195 196
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
197 198 199 200 201 202 203 204 205 206

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

218
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
219

220
  len = CHAR_STRING (XFASTINT (character), str);
221
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
222 223
}

224 225 226 227 228
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
       doc: /* Convert arg BYTE to a string containing that byte.  */)
     (byte)
     Lisp_Object byte;
{
229
  unsigned char b;
230
  CHECK_NUMBER (byte);
231
  b = XINT (byte);
232 233 234
  return make_string_from_bytes (&b, 1, 1);
}

Jim Blandy's avatar
Jim Blandy committed
235
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
236 237 238
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
     (string)
239
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
240 241
{
  register Lisp_Object val;
242
  CHECK_STRING (string);
243
  if (SCHARS (string))
244 245
    {
      if (STRING_MULTIBYTE (string))
246
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
247
      else
248
	XSETFASTINT (val, SREF (string, 0));
249
    }
Jim Blandy's avatar
Jim Blandy committed
250
  else
251
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
252 253 254 255
  return val;
}

static Lisp_Object
256
buildmark (int charpos, int bytepos)
Jim Blandy's avatar
Jim Blandy committed
257 258 259
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
260
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
265 266 267
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
268 269
{
  Lisp_Object temp;
270
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
275 276
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
277
{
278
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
279 280 281
}

int
282
clip_to_bounds (int lower, int num, int upper)
Jim Blandy's avatar
Jim Blandy committed
283 284 285 286 287 288 289 290 291 292
{
  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: ",
293
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
294 295 296
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
297
     (position)
298
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
299
{
Karl Heuer's avatar
Karl Heuer committed
300 301
  int pos;

302 303
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
304 305 306 307 308 309 310 311 312 313 314 315
    {
      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;
    }

316
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
317

Karl Heuer's avatar
Karl Heuer committed
318 319
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
320
  return position;
Jim Blandy's avatar
Jim Blandy committed
321 322
}

323 324 325 326 327

/* 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
328
static Lisp_Object
329
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
330
{
331
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
332
  Lisp_Object m;
333

334 335
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
336
      && NILP (current_buffer->mark_active))
337
    xsignal0 (Qmark_inactive);
338

Jim Blandy's avatar
Jim Blandy committed
339
  m = Fmarker_position (current_buffer->mark);
340
  if (NILP (m))
341
    error ("The mark is not set now, so there is no region");
342

Kenichi Handa's avatar
Kenichi Handa committed
343
  if ((PT < XFASTINT (m)) == (beginningp != 0))
344 345
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
346 347 348
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
349 350
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
351
{
352
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
353 354 355
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
356 357
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
358
{
359
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
360 361 362
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
363
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
364
Watch out!  Moving this marker changes the mark position.
365 366
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
367 368 369
{
  return current_buffer->mark;
}
370 371


372 373 374 375 376
/* 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
377
overlays_around (int pos, Lisp_Object *vec, int len)
378
{
379 380
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
381 382 383
  int startpos, endpos;
  int idx = 0;

384
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
385
    {
386
      XSETMISC (overlay, tail);
387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402

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

403
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
404
    {
405
      XSETMISC (overlay, tail);
406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431

      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. */
432
Lisp_Object
433
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
434 435 436 437 438
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
439 440 441 442 443 444 445 446 447
  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
448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491
    {
      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;
		}
	    }
	}
492

493
      { /* Now check the text properties.  */
494 495 496 497 498 499 500 501 502 503
	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;
      }
504 505 506
    }
}

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

511 512 513
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

514
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
515 516 517 518 519 520 521 522
   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.
523 524 525 526

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

527
static void
528
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary, Lisp_Object beg_limit, int *beg, Lisp_Object end_limit, int *end)
529
{
530 531
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
532 533 534 535
  /* 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;
536

537 538 539
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
540
    CHECK_NUMBER_COERCE_MARKER (pos);
541

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

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

573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
  /* 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.  */

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
613 614
	}
    }
615 616

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

630 631
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
632 633 634
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
635
}
636

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

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

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

676
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
677
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
678 679 680
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
681 682
field, then the beginning of the *previous* field is returned.
If LIMIT is non-nil, it is a buffer position; if the beginning of the field
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
683
is before LIMIT, then LIMIT will be returned instead.  */)
684 685
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
686 687
{
  int beg;
688
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
689 690 691
  return make_number (beg);
}

692
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
693
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
694 695 696
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,
697 698
then the end of the *following* field is returned.
If LIMIT is non-nil, it is a buffer position; if the end of the field
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
699
is after LIMIT, then LIMIT will be returned instead.  */)
700 701
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
702 703
{
  int end;
704
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
705 706 707
  return make_number (end);
}

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

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.

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

744 745 746 747 748 749 750
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

751 752 753 754 755 756 757
  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);
758

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

      if (fwd)
786
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
787
      else
788
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
789

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

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

825 826 827 828
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
829
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
830

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

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
842
    CHECK_NUMBER (n);
843 844

  orig = PT;
845
  orig_byte = PT_BYTE;
846 847
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
848

849
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
850

851 852
  unbind_to (count, Qnil);

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

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

864 865 866 867
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
868 869
boundaries bind `inhibit-field-text-motion' to t.

870 871
This function does not move point.  */)
     (n)
872 873
     Lisp_Object n;
{
874
  int end_pos;
875
  int orig = PT;
876

877 878 879
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
880
    CHECK_NUMBER (n);
881

882 883 884
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
885
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
886
			      Qnil, Qt, Qnil);
887
}
888

889

Jim Blandy's avatar
Jim Blandy committed
890
Lisp_Object
891
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
892
{
893 894
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
895 896

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
921
  Fset_buffer (tem);
922 923 924

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

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

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

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

950 951 952
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
953
  tem1 = current_buffer->mark_active;
954 955
  current_buffer->mark_active = tem;

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

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

983
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
984 985 986 987
  return Qnil;
}

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

999 1000 1001
If you only want to save the current buffer but not point nor mark,
then just use `save-current-buffer', or even `with-current-buffer'.

1002
usage: (save-excursion &rest BODY)  */)
1003
     (args)
Jim Blandy's avatar
Jim Blandy committed
1004 1005 1006
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
1007
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
1008 1009

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
1010 1011 1012 1013 1014 1015

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
1016
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
1017 1018
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
1019
     (args)
1020 1021
     Lisp_Object args;
{
1022
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
1023
  int count = SPECPDL_INDEX ();
1024

1025
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1026

Jim Blandy's avatar
Jim Blandy committed
1027 1028 1029 1030
  val = Fprogn (args);
  return unbind_to (count, val);
}

1031
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1032 1033 1034
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
1035
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1036
{
1037 1038
  if (NILP (buffer))
    return make_number (Z - BEG);
1039 1040
  else
    {
1041
      CHECK_BUFFER (buffer);
1042 1043 1044
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
1045 1046 1047
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
1048 1049 1050
       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
1051 1052
{
  Lisp_Object temp;
1053
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1058 1059 1060
       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
1061
{
1062
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1063 1064 1065
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
1066
       doc: /* Return the maximum permissible value of point in the current buffer.