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 <ctype.h>
48
#include <float.h>
49 50
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
51
#include <strftime.h>
52
#include <verify.h>
53

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

62
#ifndef USE_CRT_DLL
63
extern char **environ;
64 65
#endif

66 67
#define TM_YEAR_BASE 1900

68
#ifdef WINDOWSNT
69
extern Lisp_Object w32_get_internal_run_time (void);
70 71
#endif

72 73
static Lisp_Object format_time_string (char const *, ptrdiff_t, EMACS_TIME,
				       int, struct tm *);
74
static int tm_diff (struct tm *, struct tm *);
75
static void update_buffer_properties (ptrdiff_t, ptrdiff_t);
76

77
static Lisp_Object Qbuffer_access_fontify_functions;
78

79 80 81 82 83 84
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

85
static Lisp_Object Qboundary;
86 87


Jim Blandy's avatar
Jim Blandy committed
88
void
89
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
90
{
91
  const char *user_name;
92
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
93 94 95 96
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
97
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
98 99 100 101 102 103 104

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

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

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

Jim Blandy's avatar
Jim Blandy committed
131 132
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
133
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
134 135 136 137 138 139 140 141
  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
142

143
  p = getenv ("NAME");
144 145
  if (p)
    Vuser_full_name = build_string (p);
146 147
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
148 149 150 151 152 153 154 155 156 157

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

168
  CHECK_CHARACTER (character);
169
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
170

171
  len = CHAR_STRING (c, str);
172
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
173 174
}

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

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

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

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

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
227
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
228
{
229
  ptrdiff_t pos;
Karl Heuer's avatar
Karl Heuer committed
230

231 232
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
233 234 235 236 237 238 239 240 241 242 243 244
    {
      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;
    }

245
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
246

Karl Heuer's avatar
Karl Heuer committed
247 248
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
249
  return position;
Jim Blandy's avatar
Jim Blandy committed
250 251
}

252 253 254 255 256

/* 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
257
static Lisp_Object
258
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
259
{
260
  Lisp_Object m;
261

262 263
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
264
      && NILP (BVAR (current_buffer, mark_active)))
265
    xsignal0 (Qmark_inactive);
266

Tom Tromey's avatar
Tom Tromey committed
267
  m = Fmarker_position (BVAR (current_buffer, mark));
268
  if (NILP (m))
269
    error ("The mark is not set now, so there is no region");
270

271 272 273 274
  /* 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
275 276 277
}

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

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

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


301 302 303 304
/* 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.  */

305 306
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
307
{
308 309
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
310
  ptrdiff_t startpos, endpos;
311
  ptrdiff_t idx = 0;
312

313
  for (tail = buffer_get_overlays (NULL, OV_BEFORE); tail; tail = tail->next)
314
    {
315
      XSETMISC (overlay, tail);
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

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

332
  for (tail = buffer_get_overlays (NULL, OV_AFTER); tail; tail = tail->next)
333
    {
334
      XSETMISC (overlay, tail);
335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360

      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. */
361
Lisp_Object
362
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
363 364 365 366 367
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
368
  else if (WINDOWP (object))
369
    object = XWINDOW (object)->buffer;
370 371 372 373 374 375 376

  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
377
    {
378
      EMACS_INT posn = XINT (position);
379
      ptrdiff_t noverlays;
380 381 382 383 384 385 386
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
      noverlays = 40;
387
      overlay_vec = alloca (noverlays * sizeof *overlay_vec);
388 389 390 391 392 393
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
394
	  overlay_vec = alloca (noverlays * sizeof *overlay_vec);
395 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
	  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;
		}
	    }
	}
421

422
      { /* Now check the text properties.  */
423 424 425 426 427 428 429 430 431 432
	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;
      }
433 434 435
    }
}

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

440 441 442
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

443
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
444 445 446 447 448 449 450 451
   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.
452 453 454 455

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

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

468 469 470
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
471
    CHECK_NUMBER_COERCE_MARKER (pos);
472

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

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

504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525
  /* 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.  */

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

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
544 545
	}
    }
546 547

  if (end)
548 549 550 551 552 553 554 555 556 557
    {
      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.  */
558 559
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
560

561 562
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
563 564 565
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
566
}
567

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

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

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

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

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

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

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
641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660

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.

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

669 670 671 672 673 674 675
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

676 677 678
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

679
  fwd = (XINT (new_pos) > XINT (old_pos));
680

681 682
  prev_old = make_number (XINT (old_pos) - 1);
  prev_new = make_number (XINT (new_pos) - 1);
683

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

      if (fwd)
711
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
712
      else
713
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
714

715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731
      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)))
732 733 734 735 736 737 738 739 740 741
	/* 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;
}
742

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

750 751 752
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

753 754 755 756
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
757
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
758

759
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
760
  (Lisp_Object n)
761
{
762 763
  ptrdiff_t orig, orig_byte, end;
  ptrdiff_t count = SPECPDL_INDEX ();
764
  specbind (Qinhibit_point_motion_hooks, Qt);
765 766 767 768

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
769
    CHECK_NUMBER (n);
770 771

  orig = PT;
772
  orig_byte = PT_BYTE;
773 774
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
775

776
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
777

778 779
  unbind_to (count, Qnil);

780
  /* Return END constrained to the current input field.  */
781 782
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
783
			      Qt, Qnil);
784 785
}

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

791 792 793
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

794 795 796 797
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
798 799
boundaries bind `inhibit-field-text-motion' to t.

800
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
801
  (Lisp_Object n)
802
{
803 804 805
  ptrdiff_t clipped_n;
  ptrdiff_t end_pos;
  ptrdiff_t orig = PT;
806

807 808 809
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
810
    CHECK_NUMBER (n);
811

812 813
  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));
814 815

  /* Return END_POS constrained to the current input field.  */
816
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
817
			      Qnil, Qt, Qnil);
818
}
819

820

Jim Blandy's avatar
Jim Blandy committed
821
Lisp_Object
822
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
823
{
824
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
825 826 827 828 829 830 831
		 == 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
832 833 834
}

Lisp_Object
835
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
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 872 873 874 875 876
  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)
877
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
878 879 880 881 882 883 884
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
#endif /* 0 */

  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
  tem1 = BVAR (current_buffer, mark_active);
885
  BSET (current_buffer, mark_active, tem);
886 887 888 889

  /* If mark is active now, and either was not active
     or was at a different place, run the activate hook.  */
  if (! NILP (tem))
890
    {
891 892 893 894 895 896 897 898 899 900 901
      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);
902
    }
903

904 905 906 907 908 909
  /* 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)
910
      && (tem1 = XWINDOW (tem)->buffer,
911 912 913 914 915 916 917
	  (/* 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
918 919 920 921
  return Qnil;
}

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

933 934 935
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'.

936
usage: (save-excursion &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
937
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
938 939
{
  register Lisp_Object val;