editfns.c 150 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>
Jim Blandy's avatar
Jim Blandy committed
24

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

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

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

35 36
#include "lisp.h"

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

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

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

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

60 61
#define TM_YEAR_BASE 1900

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

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

71
static Lisp_Object Qbuffer_access_fontify_functions;
72

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

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

79
static Lisp_Object Qboundary;
80 81


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

246 247

/* Return the start or end position of the region.
248
   BEGINNINGP means return the start.
249 250
   If there is no region active, signal an error. */

Jim Blandy's avatar
Jim Blandy committed
251
static Lisp_Object
252
region_limit (bool beginningp)
Jim Blandy's avatar
Jim Blandy committed
253
{
254
  Lisp_Object m;
255

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

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

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

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

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

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

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

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

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

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

326
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
327
    {
328
      XSETMISC (overlay, tail);
329 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

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

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

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

      set_buffer_temp (XBUFFER (object));

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

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

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

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

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

437
   If MERGE_AT_BOUNDARY is non-nil, then if POS is at the very first
438 439 440 441
   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
442
   non-nil case, if two fields are separated by a field with the special
443 444 445
   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.
446 447 448 449

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

450
static void
451 452
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
453
	    ptrdiff_t *beg, Lisp_Object end_limit, ptrdiff_t *end)
454
{
455 456
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
457 458 459 460
  /* True if POS counts as the start of a field.  */
  bool at_field_start = 0;
  /* True if POS counts as the end of a field.  */
  bool at_field_end = 0;
461

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

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

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

498 499 500 501 502 503
  /* Note about special `boundary' fields:

     Consider the case where the point (`.') is between the fields `x' and `y':

	xxxx.yyyy

504
     In this situation, if merge_at_boundary is non-nil, consider the
505 506 507 508
     `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
509
     (a field with a `field' char-property of 'boundary), then ignore
510 511 512 513 514 515
     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
516
     anywhere in-between (within the `boundary' field), merge all
517 518 519
     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.  */

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

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

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

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

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

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

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

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

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

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

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
635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654

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.

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

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

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

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

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

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

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

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

737

Paul Eggert's avatar
Paul Eggert committed
738
DEFUN ("line-beginning-position",
739
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
740
       doc: /* Return the character position of the first character on the current line.
Chong Yidong's avatar
Chong Yidong committed
741 742
With optional argument N, scan forward N - 1 lines first.
If the scan reaches the end of the buffer, return that position.
743

Chong Yidong's avatar
Chong Yidong committed
744 745 746
This function ignores text display directionality; it returns the
position of the first character in logical order, i.e. the smallest
character position on the line.
747

748
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
749
unless that position would be on a different line than the original,
750 751
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
Chong Yidong's avatar
Chong Yidong committed
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

Chong Yidong's avatar
Chong Yidong committed
786 787 788
This function ignores text display directionality; it returns the
position of the last character in logical order, i.e. the largest
character position on the line.
789

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

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

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

808 809
  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));
810 811

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

816

Jim Blandy's avatar
Jim Blandy committed
817
Lisp_Object
818
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
819
{
820 821
  bool visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		  == current_buffer);
822 823 824 825
  /* Do not copy the mark if it points to nowhere.  */
  Lisp_Object mark = (XMARKER (BVAR (current_buffer, mark))->buffer
		      ? Fcopy_marker (BVAR (current_buffer, mark), Qnil)
		      : Qnil);
826 827

  return Fcons (Fpoint_marker (),
828
		Fcons (mark,
829 830 831
		       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
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
839
  bool visible_p;
840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862

  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));
863 864 865 866 867 868 869 870
  if (NILP (tem))
    unchain_marker (XMARKER (BVAR (current_buffer, mark)));
  else
    {
      Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
      nmark = Fmarker_position (tem);
      unchain_marker (XMARKER (tem));
    }
871 872 873 874 875 876 877 878 879 880 881

  /* 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)
882
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
883 884 885 886 887 888 889
    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
890
  bset_mark_active (current_buffer, tem);
891 892 893 894

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

Dmitry Antipov's avatar