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-2014 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>
27
#include <grp.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
static Lisp_Object format_time_string (char const *, ptrdiff_t, struct timespec,
68
				       bool, 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 83 84 85 86 87 88 89 90
/* The startup value of the TZ environment variable so it can be
   restored if the user calls set-time-zone-rule with a nil
   argument.  If null, the TZ environment variable was unset.  */
static char const *initial_tz;

/* True if the static variable tzvalbuf (defined in
   set_time_zone_rule) is part of 'environ'.  */
static bool tzvalbuf_in_environ;

91

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

  /* Set up system_name even when dumping.  */
101
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
102 103 104 105 106 107 108

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

109 110 111
  initial_tz = getenv ("TZ");
  tzvalbuf_in_environ = 0;

112
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
113 114 115 116
#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.)  */
117
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
118
#else
119
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
120
#endif
Jim Blandy's avatar
Jim Blandy committed
121

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

Jim Blandy's avatar
Jim Blandy committed
138 139
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
140
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
141 142 143 144 145 146 147 148
  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
149

150
  p = getenv ("NAME");
151 152
  if (p)
    Vuser_full_name = build_string (p);
153 154
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
155 156 157 158 159 160 161 162 163 164

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

175
  CHECK_CHARACTER (character);
176
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
177

178
  len = CHAR_STRING (c, str);
179
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
180 181
}

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

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

Paul Eggert's avatar
Paul Eggert committed
212
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
213 214
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
215
  (void)
Jim Blandy's avatar
Jim Blandy committed
216 217
{
  Lisp_Object temp;
218
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
219 220 221
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
222
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
223
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
224
  (void)
Jim Blandy's avatar
Jim Blandy committed
225
{
226
  return build_marker (current_buffer, PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
227 228
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
234
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
235
{
236 237 238 239 240 241
  if (MARKERP (position))
    set_point_from_marker (position);
  else if (INTEGERP (position))
    SET_PT (clip_to_bounds (BEGV, XINT (position), ZV));
  else
    wrong_type_argument (Qinteger_or_marker_p, position);
242
  return position;
Jim Blandy's avatar
Jim Blandy committed
243 244
}

245 246

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

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

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

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

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

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

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

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

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

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

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

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

325
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
326
    {
327
      XSETMISC (overlay, tail);
328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

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

346 347 348 349 350 351 352 353 354
DEFUN ("get-pos-property", Fget_pos_property, Sget_pos_property, 2, 3, 0,
       doc: /* Return the value of POSITION's property PROP, in OBJECT.
Almost identical to `get-char-property' except for the following difference:
Whereas `get-char-property' returns the property of the char at (i.e. right
after) POSITION, this pays attention to properties's stickiness and overlays's
advancement settings, in order to find the property of POSITION itself,
i.e. the property that a char would inherit if it were inserted
at POSITION.  */)
  (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
355 356 357 358 359
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
360
  else if (WINDOWP (object))
361
    object = XWINDOW (object)->contents;
362 363 364 365 366 367 368

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

      set_buffer_temp (XBUFFER (object));

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

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
387
	  SAFE_ALLOCA_LISP (overlay_vec, noverlays);
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409
	  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
		{
410
		  SAFE_FREE ();
411 412 413 414
		  return tem;
		}
	    }
	}
415
      SAFE_FREE ();
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 non-nil, then if POS is at the very first
439 440 441 442
   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
443
   non-nil case, if two fields are separated by a field with the special
444 445 446
   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
  /* 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;
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
      Lisp_Object field = Fget_pos_property (pos, Qfield, Qnil);
487
      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
  /* Note about special `boundary' fields:

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

	xxxx.yyyy

505
     In this situation, if merge_at_boundary is non-nil, consider the
506 507 508 509
     `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
510
     (a field with a `field' char-property of 'boundary), then ignore
511 512 513 514 515 516
     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
517
     anywhere in-between (within the `boundary' field), merge all
518 519 520
     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.  */)
657 658
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge,
   Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
659 660
{
  /* If non-zero, then the original point, before re-positioning.  */
661
  ptrdiff_t orig_point = 0;
662
  bool fwd;
663
  Lisp_Object prev_old, prev_new;
664

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

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

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

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

680 681
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
682 683
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
684
          /* To recognize field boundaries, we must also look at the
685
             previous positions; we could use `Fget_pos_property'
686 687 688
             instead, but in itself that would fail inside non-sticky
             fields (like comint prompts).  */
          || (XFASTINT (new_pos) > BEGV
689
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
690
          || (XFASTINT (old_pos) > BEGV
691
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
692
      && (NILP (inhibit_capture_property)
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.  */
696
          || (NILP (Fget_pos_property (old_pos, inhibit_capture_property, Qnil))
697
              && (XFASTINT (old_pos) <= BEGV
698 699 700 701
                  || NILP (Fget_char_property
			   (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property
			   (prev_old, inhibit_capture_property, Qnil))))))
702 703
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
704
    {
705
      ptrdiff_t shortage;
706 707 708
      Lisp_Object field_bound;

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

713 714 715 716 717 718 719 720
      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
721
	     case the constraint is OK even if ONLY_IN_LINE is non-nil).  */
722 723 724 725
	  && (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.  */
726 727
	      || (find_newline (XFASTINT (new_pos), -1,
				XFASTINT (field_bound), -1,
728
				fwd ? -1 : 1, &shortage, NULL, 1),
729
		  shortage != 0)))
730 731 732 733 734 735 736 737 738 739
	/* 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;
}
740

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

Chong Yidong's avatar
Chong Yidong committed
748 749 750
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.
751

752
This function constrains the returned position to the current field
Chong Yidong's avatar
Chong Yidong committed
753
unless that position would be on a different line than the original,
754 755
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
756
boundaries, bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
757

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

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

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

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

777 778
  unbind_to (count, Qnil);

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

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

Chong Yidong's avatar
Chong Yidong committed
790 791 792
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.
793

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
  clipped_n = clip_to_bounds (PTRDIFF_MIN + 1, XINT (n), PTRDIFF_MAX);
813 814
  end_pos = find_before_next_newline (orig, 0, clipped_n - (clipped_n <= 0),
				      NULL);
815 816

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

821 822 823 824
/* Save current buffer state for `save-excursion' special form.
   We (ab)use Lisp_Misc_Save_Value to allow explicit free and so
   offload some work from GC.  */

Jim Blandy's avatar
Jim Blandy committed
825
Lisp_Object
826
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
827
{
828 829
  return make_save_obj_obj_obj_obj
    (Fpoint_marker (),
830 831 832 833 834
     /* Do not copy the mark if it points to nowhere.  */
     (XMARKER (BVAR (current_buffer, mark))->buffer
      ? Fcopy_marker (BVAR (current_buffer, mark), Qnil)
      : Qnil),
     /* Selected window if current buffer is shown in it, nil otherwise.  */
835
     (EQ (XWINDOW (selected_window)->contents, Fcurrent_buffer ())
836 837
      ? selected_window : Qnil),
     BVAR (current_buffer, mark_active));
Jim Blandy's avatar
Jim Blandy committed
838 839
}

840 841
/* Restore saved buffer before leaving `save-excursion' special form.  */

842
void
843
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
844
{
845
  Lisp_Object tem, tem1, omark, nmark;
846 847
  struct gcpro gcpro1, gcpro2, gcpro3;

848
  tem = Fmarker_buffer (XSAVE_OBJECT (info, 0));
849 850
  /* If we're unwinding to top level, saved buffer may be deleted.  This
     means that all of its markers are unchained and so tem is nil.  */
851
  if (NILP (tem))
852
    goto out;
853 854 855 856 857 858 859

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

  Fset_buffer (tem);

  /* Point marker.  */
860
  tem = XSAVE_OBJECT (info, 0);
861 862 863 864
  Fgoto_char (tem);
  unchain_marker (XMARKER (tem));

  /* Mark marker.  */
865
  tem = XSAVE_OBJECT (info, 1);
866
  omark = Fmarker_position (BVAR (current_buffer, mark));
867 868 869 870 871 872 873 874
  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));
    }
875

876
  /* Mark active.  */
877
  tem = XSAVE_OBJECT (info, 3);
878
  tem1 = BVAR (current_buffer, mark_active);
Paul Eggert's avatar
Paul Eggert committed
879
  bset_mark_active (current_buffer, tem);
880 881 882 883

  /* If mark is active now, and either was not active
     or was at a different place, run the activate hook.  */
  if (! NILP (tem))
884
    {
885 886 887 888 889 890 891 892 893 894 895
      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);
896
    }
897

898 899 900
  /* 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.  */
901
  tem = XSAVE_OBJECT (info, 2);
902
  if (WINDOWP (tem)
903
      && !EQ (tem, selected_window)
904
      && (tem1 = XWINDOW (tem)->contents,
905 906 907 908 909 910 911
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
    Fset_window_point (tem, make_number (PT));

  UNGCPRO;
912 913 914

 out:

915
  free_misc (info);
Jim Blandy's avatar
Jim Blandy committed
916 917 918
}

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

930 931 932
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'.

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

  record_unwind_protect (save_excursion_restore, save_excursion_save ());