editfns.c 142 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

#ifdef WINDOWSNT
93
extern Lisp_Object w32_get_internal_run_time (void);
94 95
#endif

96 97 98 99 100 101
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);
static size_t emacs_memftimeu (char *, size_t, const char *,
                               size_t, const struct tm *, int);
102 103 104 105 106
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 *);
107 108 109
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);
110 111 112 113

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
114

115
Lisp_Object Fuser_full_name (Lisp_Object);
116

117 118 119 120
/* Non-nil means don't stop at field boundary in text motion commands.  */

Lisp_Object Vinhibit_field_text_motion;

Jim Blandy's avatar
Jim Blandy committed
121 122 123
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
124 125 126
Lisp_Object Vuser_real_login_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;		/* full name of current user */
Lisp_Object Vuser_login_name;		/* user name from LOGNAME or USER */
127
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
128

129 130 131 132 133 134 135 136 137
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

Lisp_Object Qboundary;


Jim Blandy's avatar
Jim Blandy committed
138
void
139
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
140
{
Jim Blandy's avatar
Jim Blandy committed
141
  char *user_name;
142
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
143 144 145 146
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

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

#ifndef CANNOT_DUMP
  /* Don't bother with this on initial start when just dumping out */
  if (!initialized)
    return;
#endif /* not CANNOT_DUMP */

  pw = (struct passwd *) getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
156 157 158 159
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
     accurate on MSDOG and because it lets Emacs find the init file.
     (The DVX libraries override the Djgpp libraries here.)  */
160
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
161
#else
162
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
163
#endif
Jim Blandy's avatar
Jim Blandy committed
164

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

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

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

#ifdef HAVE_SYS_UTSNAME_H
  {
    struct utsname uts;
    uname (&uts);
    Voperating_system_release = build_string (uts.release);
  }
#else
  Voperating_system_release = Qnil;
#endif
Jim Blandy's avatar
Jim Blandy committed
202 203 204
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
205 206
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
207
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
208
{
Karl Heuer's avatar
Karl Heuer committed
209
  int len;
210
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
211

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

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

218 219
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
       doc: /* Convert arg BYTE to a string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
220
  (Lisp_Object byte)
221
{
222
  unsigned char b;
223
  CHECK_NUMBER (byte);
224
  b = XINT (byte);
225 226 227
  return make_string_from_bytes (&b, 1, 1);
}

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

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
257 258
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
259
  (void)
Jim Blandy's avatar
Jim Blandy committed
260 261
{
  Lisp_Object temp;
262
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
263 264 265 266
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
267
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
268
  (void)
Jim Blandy's avatar
Jim Blandy committed
269
{
270
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
271 272 273
}

int
274
clip_to_bounds (int lower, int num, int upper)
Jim Blandy's avatar
Jim Blandy committed
275 276 277 278 279 280 281 282 283 284
{
  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: ",
285
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
286 287 288
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
289
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
290
{
Karl Heuer's avatar
Karl Heuer committed
291 292
  int pos;

293 294
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
295 296 297 298 299 300 301 302 303 304 305 306
    {
      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;
    }

307
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
308

Karl Heuer's avatar
Karl Heuer committed
309 310
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
311
  return position;
Jim Blandy's avatar
Jim Blandy committed
312 313
}

314 315 316 317 318

/* 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
319
static Lisp_Object
320
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
321
{
322
  Lisp_Object m;
323

324 325
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
326
      && NILP (current_buffer->mark_active))
327
    xsignal0 (Qmark_inactive);
328

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

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

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

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

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

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

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

      end = OVERLAY_END (overlay);
      endpos = OVERLAY_POSITION (end);
      if (endpos < pos)
	  break;
      start = OVERLAY_START (overlay);
      startpos = OVERLAY_POSITION (start);
      if (startpos <= pos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  /* Keep counting overlays even if we can't return them all.  */
	  idx++;
	}
    }

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

      start = OVERLAY_START (overlay);
      startpos = OVERLAY_POSITION (start);
      if (pos < startpos)
	break;
      end = OVERLAY_END (overlay);
      endpos = OVERLAY_POSITION (end);
      if (pos <= endpos)
	{
	  if (idx < len)
	    vec[idx] = overlay;
	  idx++;
	}
    }

  return idx;
}

/* Return the value of property PROP, in OBJECT at POSITION.
   It's the value of PROP that a char inserted at POSITION would get.
   OBJECT is optional and defaults to the current buffer.
   If OBJECT is a buffer, then overlay properties are considered as well as
   text properties.
   If OBJECT is a window, then that window's buffer is used, but
   window-specific overlays are considered only if they are associated
   with OBJECT. */
422
Lisp_Object
423
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
424 425 426 427 428
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
429 430 431 432 433 434 435 436 437
  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
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 473 474 475 476 477 478 479 480 481
    {
      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;
		}
	    }
	}
482

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

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

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

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

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

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

527 528 529
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
530
    CHECK_NUMBER_COERCE_MARKER (pos);
531

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

  /* 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.  */
548
  if (NILP (merge_at_boundary))
549
    {
550 551
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
552
	at_field_end = 1;
553 554
      if (!EQ (field, before_field))
	at_field_start = 1;
555 556 557 558 559 560
      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;
561 562
    }

563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584
  /* 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.  */

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
603 604
	}
    }
605 606

  if (end)
607 608 609 610 611 612 613 614 615 616
    {
      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.  */
617 618
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
619

620 621
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
622 623 624
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
625
}
626

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

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

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
653
       doc: /* Return the contents of the field around POS, without text properties.
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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
656
  (Lisp_Object pos)
657 658
{
  int beg, end;
659
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
660 661 662
  return make_buffer_string (beg, end, 0);
}

663
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
664
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
665 666 667
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
668 669
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
670
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
671
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
672 673
{
  int beg;
674
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
675 676 677
  return make_number (beg);
}

678
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
679
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
680 681 682
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,
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
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
685
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
686
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
687 688
{
  int end;
689
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
690 691 692
  return make_number (end);
}

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

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.

719
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
720
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
721 722 723
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;
724 725
  int fwd;
  Lisp_Object prev_old, prev_new;
726

727 728 729 730 731 732 733
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

734 735 736 737 738 739 740
  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);
741

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

      if (fwd)
769
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
770
      else
771
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
772

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

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

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

814
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
815
  (Lisp_Object n)
816
{
817
  int orig, orig_byte, end;
818 819
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
820 821 822 823

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
824
    CHECK_NUMBER (n);
825 826

  orig = PT;
827
  orig_byte = PT_BYTE;
828 829
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
830

831
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
832

833 834
  unbind_to (count, Qnil);

835
  /* Return END constrained to the current input field.  */
836 837
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
838
			      Qt, Qnil);
839 840
}

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

846 847 848 849
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
850 851
boundaries bind `inhibit-field-text-motion' to t.

852
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
853
  (Lisp_Object n)
854
{
855
  int end_pos;
856
  int orig = PT;
857

858 859 860
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
861
    CHECK_NUMBER (n);
862

863 864 865
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
866
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
867
			      Qnil, Qt, Qnil);
868
}
869

870

Jim Blandy's avatar
Jim Blandy committed
871
Lisp_Object
872
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
873
{
874 875
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
876 877

  return Fcons (Fpoint_marker (),
878
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
879
		       Fcons (visible ? Qt : Qnil,
880 881
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
882 883 884
}

Lisp_Object
885
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
886
{
887 888
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
889
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
890

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

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

Jim Blandy's avatar
Jim Blandy committed
902
  Fset_buffer (tem);
903 904 905

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
906
  Fgoto_char (tem);
907
  unchain_marker (XMARKER (tem));
908 909 910 911

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

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

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

931 932 933
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
934
  tem1 = current_buffer->mark_active;
935 936
  current_buffer->mark_active = tem;

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

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

964
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
965 966 967 968
  return Qnil;
}

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

980 981 982
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'.

983
usage: (save-excursion &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
984
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
985 986
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
987
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
988 989

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
990 991 992 993 994 995

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
996
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
997 998
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
999
  (Lisp_Object args)
1000
{
1001
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
1002
  int count = SPECPDL_INDEX ();
1003

1004
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
1005

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

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

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
1036 1037
       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.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1038
  (void)
Jim Blandy's avatar
Jim Blandy committed
1039
{
1040
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,