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

3
Copyright (C) 1985-1987, 1989, 1993-2012 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6

This file is part of GNU Emacs.

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

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


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

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

Andreas Schwab's avatar
Andreas Schwab committed
30 31
#include <unistd.h>

32 33 34 35
#ifdef HAVE_SYS_UTSNAME_H
#include <sys/utsname.h>
#endif

36 37
#include "lisp.h"

38 39 40 41
/* 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"
42 43

#if defined HAVE_SYS_RESOURCE_H
44
#include <sys/resource.h>
45 46
#endif

47
#include <float.h>
48 49
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
50
#include <strftime.h>
51
#include <verify.h>
52

53
#include "intervals.h"
54
#include "character.h"
55
#include "buffer.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
#define TM_YEAR_BASE 1900

63
#ifdef WINDOWSNT
64
extern Lisp_Object w32_get_internal_run_time (void);
65 66
#endif

67 68
static Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
				       int, struct tm *);
69
static int tm_diff (struct tm *, struct tm *);
70
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
71

72
static Lisp_Object Qbuffer_access_fontify_functions;
73

74 75 76 77 78 79
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

80
static Lisp_Object Qboundary;
81 82


Jim Blandy's avatar
Jim Blandy committed
83
void
84
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
85
{
86
  const char *user_name;
87
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
88 89 90 91
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
92
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
93 94 95 96 97 98 99

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

100
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
101 102 103 104
#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.)  */
105
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
106
#else
107
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
108
#endif
Jim Blandy's avatar
Jim Blandy committed
109

Jim Blandy's avatar
Jim Blandy committed
110 111
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
112
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
113
  if (!user_name)
114
#ifdef WINDOWSNT
115
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
116
#else  /* WINDOWSNT */
117
    user_name = getenv ("USER");
118
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
119 120
  if (!user_name)
    {
121 122
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
123
    }
124
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
125

Jim Blandy's avatar
Jim Blandy committed
126 127
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
128
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
129 130 131 132 133 134 135 136
  if (! NILP (tem))
    tem = Vuser_login_name;
  else
    {
      uid_t euid = geteuid ();
      tem = make_fixnum_or_float (euid);
    }
  Vuser_full_name = Fuser_full_name (tem);
Sam Steingold's avatar
Sam Steingold committed
137

138
  p = getenv ("NAME");
139 140
  if (p)
    Vuser_full_name = build_string (p);
141 142
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
143 144 145 146 147 148 149 150 151 152

#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
153 154
}

Paul Eggert's avatar
Paul Eggert committed
155
DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
156 157
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
158
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
159
{
160
  int c, len;
161
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
162

163
  CHECK_CHARACTER (character);
164
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
165

166
  len = CHAR_STRING (c, str);
167
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
168 169
}

170
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
171
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
172
  (Lisp_Object byte)
173
{
174
  unsigned char b;
175
  CHECK_NUMBER (byte);
176 177
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
178
  b = XINT (byte);
179
  return make_string_from_bytes ((char *) &b, 1, 1);
180 181
}

Jim Blandy's avatar
Jim Blandy committed
182
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
183
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
184
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
185 186
{
  register Lisp_Object val;
187
  CHECK_STRING (string);
188
  if (SCHARS (string))
189 190
    {
      if (STRING_MULTIBYTE (string))
191
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
192
      else
193
	XSETFASTINT (val, SREF (string, 0));
194
    }
Jim Blandy's avatar
Jim Blandy committed
195
  else
196
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
197 198 199
  return val;
}

Paul Eggert's avatar
Paul Eggert committed
200
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
201 202
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
203
  (void)
Jim Blandy's avatar
Jim Blandy committed
204 205
{
  Lisp_Object temp;
206
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
207 208 209
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
210
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
211
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
212
  (void)
Jim Blandy's avatar
Jim Blandy committed
213
{
214
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
215 216
}

Paul Eggert's avatar
Paul Eggert committed
217
DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
218
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
219 220 221
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
222
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
223
{
224
  ptrdiff_t pos;
Karl Heuer's avatar
Karl Heuer committed
225

226 227
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
228 229 230 231 232 233 234 235 236 237 238 239
    {
      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;
    }

240
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
241

Karl Heuer's avatar
Karl Heuer committed
242 243
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
244
  return position;
Jim Blandy's avatar
Jim Blandy committed
245 246
}

247 248 249 250 251

/* 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
252
static Lisp_Object
253
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
254
{
255
  Lisp_Object m;
256

257 258
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
259
      && NILP (BVAR (current_buffer, mark_active)))
260
    xsignal0 (Qmark_inactive);
261

Tom Tromey's avatar
Tom Tromey committed
262
  m = Fmarker_position (BVAR (current_buffer, mark));
263
  if (NILP (m))
264
    error ("The mark is not set now, so there is no region");
265

266 267 268 269
  /* Clip to the current narrowing (bug#11770).  */
  return make_number ((PT < XFASTINT (m)) == (beginningp != 0)
		      ? PT
		      : clip_to_bounds (BEGV, XFASTINT (m), ZV));
Jim Blandy's avatar
Jim Blandy committed
270 271 272
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
273
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
274
  (void)
Jim Blandy's avatar
Jim Blandy committed
275
{
276
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
277 278 279
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
280
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
281
  (void)
Jim Blandy's avatar
Jim Blandy committed
282
{
283
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
284 285 286
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
287
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
288
Watch out!  Moving this marker changes the mark position.
289
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
290
  (void)
Jim Blandy's avatar
Jim Blandy committed
291
{
Tom Tromey's avatar
Tom Tromey committed
292
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
293
}
294 295


296 297 298 299
/* 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.  */

300 301
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
302
{
303 304
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
305
  ptrdiff_t startpos, endpos;
306
  ptrdiff_t idx = 0;
307

308
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
309
    {
310
      XSETMISC (overlay, tail);
311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326

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

327
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
328
    {
329
      XSETMISC (overlay, tail);
330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355

      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. */
356
Lisp_Object
357
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
358 359 360 361 362
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
363
  else if (WINDOWP (object))
364
    object = XWINDOW (object)->buffer;
365 366 367 368 369 370 371

  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
372
    {
373
      EMACS_INT posn = XINT (position);
374
      ptrdiff_t noverlays;
375 376 377 378 379 380 381
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
      noverlays = 40;
382
      overlay_vec = alloca (noverlays * sizeof *overlay_vec);
383 384 385 386 387 388
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
389
	  overlay_vec = alloca (noverlays * sizeof *overlay_vec);
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415
	  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;
		}
	    }
	}
416

417
      { /* Now check the text properties.  */
418 419 420 421 422 423 424 425 426 427
	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;
      }
428 429 430
    }
}

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

435 436 437
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

438
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
439 440 441 442 443 444 445 446
   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.
447 448 449 450

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

451
static void
452 453
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
454
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
455
{
456 457
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
458 459 460 461
  /* 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;
462

463 464 465
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
466
    CHECK_NUMBER_COERCE_MARKER (pos);
467

468
  after_field
469
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
470 471
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
472
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
473
					Qfield, Qnil, NULL)
474 475 476
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
477 478 479 480 481 482 483

  /* 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.  */
484
  if (NILP (merge_at_boundary))
485
    {
486 487
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
488
	at_field_end = 1;
489 490
      if (!EQ (field, before_field))
	at_field_start = 1;
491 492 493 494 495 496
      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;
497 498
    }

499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520
  /* 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.  */

521
  if (beg)
522 523 524 525 526 527 528 529
    {
      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.  */
	{
530
	  Lisp_Object p = pos;
531 532
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
533
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
534
						       beg_limit);
535 536 537 538

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
539 540
	}
    }
541 542

  if (end)
543 544 545 546 547 548 549 550 551 552
    {
      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.  */
553 554
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
555

556 557
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
558 559 560
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
561
}
562

563

564
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
565
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
566
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
567
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
568
  (Lisp_Object pos)
569
{
570
  ptrdiff_t beg, end;
571
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
572 573
  if (beg != end)
    del_range (beg, end);
574
  return Qnil;
575 576 577
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
578
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
579
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
580
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
581
  (Lisp_Object pos)
582
{
583
  ptrdiff_t beg, end;
584
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
585 586 587 588
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
589
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
590
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
591
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
592
  (Lisp_Object pos)
593
{
594
  ptrdiff_t beg, end;
595
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
596 597 598
  return make_buffer_string (beg, end, 0);
}

599
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
600
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
601 602 603
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
604 605
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
606
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
607
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
608
{
609
  ptrdiff_t beg;
610
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
611 612 613
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
614
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
615
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
616 617 618
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,
619 620
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
621
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
622
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
623
{
624
  ptrdiff_t end;
625
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
626 627 628
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
629
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
630
       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
631
A field is a region of text with the same `field' property.
632 633 634 635

If NEW-POS is nil, then use the current point instead, and move point
to the resulting constrained position, in addition to returning that
position.
Pavel Janík's avatar
Pavel Janík committed
636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655

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.

656
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
657
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
658 659
{
  /* If non-zero, then the original point, before re-positioning.  */
660
  ptrdiff_t orig_point = 0;
661 662
  int fwd;
  Lisp_Object prev_old, prev_new;
663

664 665 666 667 668 669 670
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

671 672 673
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

674
  fwd = (XINT (new_pos) > XINT (old_pos));
675

676 677
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
678

679 680
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
681 682
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
683 684 685 686 687
          /* 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
688
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
689
          || (XFASTINT (old_pos) > BEGV
690
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
691
      && (NILP (inhibit_capture_property)
692 693 694 695 696
          /* 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
697 698
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
699 700
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
701
    {
702
      ptrdiff_t shortage;
703 704 705
      Lisp_Object field_bound;

      if (fwd)
706
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
707
      else
708
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
709

710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726
      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)))
727 728 729 730 731 732 733 734 735 736
	/* 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;
}
737

738

Paul Eggert's avatar
Paul Eggert committed
739
DEFUN ("line-beginning-position",
740
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
741
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
742 743
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
744

745 746 747
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

748 749 750 751
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
752
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
753

754
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
755
  (Lisp_Object n)
756
{
757 758
  ptrdiff_t orig, orig_byte, end;
  ptrdiff_t count = SPECPDL_INDEX ();
759
  specbind (Qinhibit_point_motion_hooks, Qt);
760 761 762 763

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
764
    CHECK_NUMBER (n);
765 766

  orig = PT;
767
  orig_byte = PT_BYTE;
768 769
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
770

771
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
772

773 774
  unbind_to (count, Qnil);

775
  /* Return END constrained to the current input field.  */
776 777
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
778
			      Qt, Qnil);
779 780
}

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

786 787 788
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

789 790 791 792
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
793 794
boundaries bind `inhibit-field-text-motion' to t.

795
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
796
  (Lisp_Object n)
797
{
798 799 800
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
801

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

807 808
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0));
809 810

  /* Return END_POS constrained to the current input field.  */
811
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
812
			      Qnil, Qt, Qnil);
813
}
814

815

Jim Blandy's avatar
Jim Blandy committed
816
Lisp_Object
817
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
818
{
819
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
820 821 822 823 824 825 826
		 == current_buffer);

  return Fcons (Fpoint_marker (),
		Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
		       Fcons (visible ? Qt : Qnil,
			      Fcons (BVAR (current_buffer, mark_active),
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
827 828 829
}

Lisp_Object
830
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
831
{
832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
  int visible_p;

  tem = Fmarker_buffer (XCAR (info));
  /* 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.  */
  if (NILP (tem))
    return Qnil;

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

  Fset_buffer (tem);

  /* Point marker.  */
  tem = XCAR (info);
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
  omark = Fmarker_position (BVAR (current_buffer, mark));
  Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
  nmark = Fmarker_position (tem);
  unchain_marker (XMARKER (tem));

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

#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.  */
  tem1 = Fcar (tem);
  if (!NILP (tem1)
872
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
873 874 875 876 877 878 879
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
#endif /* 0 */

  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
  tem1 = BVAR (current_buffer, mark_active);
Paul Eggert's avatar
Paul Eggert committed
880
  bset_mark_active (current_buffer, tem);
881 882 883 884

  /* If mark is active now, and either was not active
     or was at a different place, run the activate hook.  */
  if (! NILP (tem))
885
    {
886 887 888 889 890 891 892 893 894 895 896
      if (! EQ (omark, nmark))
        {
          tem = intern ("activate-mark-hook");
          Frun_hooks (1, &tem);
        }
    }
  /* If mark has ceased to be active, run deactivate hook.  */
  else if (! NILP (tem1))
    {
      tem = intern ("deactivate-mark-hook");
      Frun_hooks (1, &tem);
897
    }
898

899 900 901 902 903 904
  /* If buffer was visible in a window, and a different window was
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
905
      && (tem1 = XWINDOW (tem)->buffer,
906 907 908 909 910 911 912
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
    Fset_window_point (tem, make_number (PT));

  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
913 914 915 916
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
917
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
918 919 920 921 922 923 924 925
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
926 927
`deactivate-mark' with `let'.

928 929 930
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'.

931
usage: (save-excursion &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
932
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
933 934
{
  register Lisp_Object val;
935
  ptrdiff_t count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
936 937

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
938 939 940 941 942 943

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
Chong Yidong's avatar
Chong Yidong committed
944 945