editfns.c 147 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"
Jim Blandy's avatar
Jim Blandy committed
55
#include "buffer.h"
56
#include "character.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 63 64 65
#ifndef NULL
#define NULL 0
#endif

66 67 68 69
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

70
#ifndef USE_CRT_DLL
71
extern char **environ;
72 73
#endif

74 75
#define TM_YEAR_BASE 1900

76 77 78 79 80 81 82
/* Nonzero if TM_YEAR is a struct tm's tm_year value that causes
   asctime to have well-defined behavior.  */
#ifndef TM_YEAR_IN_ASCTIME_RANGE
# define TM_YEAR_IN_ASCTIME_RANGE(tm_year) \
    (1000 - TM_YEAR_BASE <= (tm_year) && (tm_year) <= 9999 - TM_YEAR_BASE)
#endif

83
#ifdef WINDOWSNT
84
extern Lisp_Object w32_get_internal_run_time (void);
85 86
#endif

87
static void time_overflow (void) NO_RETURN;
88 89
static Lisp_Object format_time_string (char const *, ptrdiff_t, Lisp_Object,
				       int, time_t *, struct tm **);
90
static int tm_diff (struct tm *, struct tm *);
91
static void update_buffer_properties (EMACS_INT, EMACS_INT);
92

93
static Lisp_Object Qbuffer_access_fontify_functions;
94
static Lisp_Object Fuser_full_name (Lisp_Object);
95

96 97 98 99 100 101
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

102
static Lisp_Object Qboundary;
103 104


Jim Blandy's avatar
Jim Blandy committed
105
void
106
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
107
{
108
  const char *user_name;
109
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
110 111 112 113
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
114
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
115 116 117 118 119 120 121

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

122
  pw = getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
123 124 125 126
#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.)  */
127
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
128
#else
129
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
130
#endif
Jim Blandy's avatar
Jim Blandy committed
131

Jim Blandy's avatar
Jim Blandy committed
132 133
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
134
  user_name = getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
135
  if (!user_name)
136
#ifdef WINDOWSNT
137
    user_name = getenv ("USERNAME");	/* it's USERNAME on NT */
138
#else  /* WINDOWSNT */
139
    user_name = getenv ("USER");
140
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
141 142
  if (!user_name)
    {
143 144
      pw = getpwuid (geteuid ());
      user_name = pw ? pw->pw_name : "unknown";
Jim Blandy's avatar
Jim Blandy committed
145
    }
146
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
147

Jim Blandy's avatar
Jim Blandy committed
148 149
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
150
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
Juanma Barranquero's avatar
Juanma Barranquero committed
151
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid ())
152
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
153

154
  p = getenv ("NAME");
155 156
  if (p)
    Vuser_full_name = build_string (p);
157 158
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
159 160 161 162 163 164 165 166 167 168

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

179
  CHECK_CHARACTER (character);
180
  c = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
181

182
  len = CHAR_STRING (c, str);
183
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
184 185
}

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

Jim Blandy's avatar
Jim Blandy committed
198
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
199
       doc: /* Return the first character in STRING.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
200
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
201 202
{
  register Lisp_Object val;
203
  CHECK_STRING (string);
204
  if (SCHARS (string))
205 206
    {
      if (STRING_MULTIBYTE (string))
207
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
208
      else
209
	XSETFASTINT (val, SREF (string, 0));
210
    }
Jim Blandy's avatar
Jim Blandy committed
211
  else
212
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
213 214 215 216
  return val;
}

static Lisp_Object
217
buildmark (EMACS_INT charpos, EMACS_INT bytepos)
Jim Blandy's avatar
Jim Blandy committed
218 219 220
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
221
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
222 223 224
  return mark;
}

Paul Eggert's avatar
Paul Eggert committed
225
DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
226 227
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
228
  (void)
Jim Blandy's avatar
Jim Blandy committed
229 230
{
  Lisp_Object temp;
231
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
232 233 234
  return temp;
}

Paul Eggert's avatar
Paul Eggert committed
235
DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
236
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
237
  (void)
Jim Blandy's avatar
Jim Blandy committed
238
{
239
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
240 241
}

242
EMACS_INT
243
clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
Jim Blandy's avatar
Jim Blandy committed
244 245 246 247 248 249 250 251 252
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

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

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
258
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
259
{
260
  EMACS_INT pos;
Karl Heuer's avatar
Karl Heuer committed
261

262 263
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
264 265 266 267 268 269 270 271 272 273 274 275
    {
      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;
    }

276
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
277

Karl Heuer's avatar
Karl Heuer committed
278 279
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
280
  return position;
Jim Blandy's avatar
Jim Blandy committed
281 282
}

283 284 285 286 287

/* 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
288
static Lisp_Object
289
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
290
{
291
  Lisp_Object m;
292

293 294
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
295
      && NILP (BVAR (current_buffer, mark_active)))
296
    xsignal0 (Qmark_inactive);
297

Tom Tromey's avatar
Tom Tromey committed
298
  m = Fmarker_position (BVAR (current_buffer, mark));
299
  if (NILP (m))
300
    error ("The mark is not set now, so there is no region");
301

Kenichi Handa's avatar
Kenichi Handa committed
302
  if ((PT < XFASTINT (m)) == (beginningp != 0))
303 304
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
305 306 307
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
308
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
309
  (void)
Jim Blandy's avatar
Jim Blandy committed
310
{
311
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
312 313 314
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
315
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
316
  (void)
Jim Blandy's avatar
Jim Blandy committed
317
{
318
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
319 320 321
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
322
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
323
Watch out!  Moving this marker changes the mark position.
324
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
325
  (void)
Jim Blandy's avatar
Jim Blandy committed
326
{
Tom Tromey's avatar
Tom Tromey committed
327
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
328
}
329 330


331 332 333 334
/* 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.  */

335 336
static ptrdiff_t
overlays_around (EMACS_INT pos, Lisp_Object *vec, ptrdiff_t len)
337
{
338 339
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
340
  EMACS_INT startpos, endpos;
341
  ptrdiff_t idx = 0;
342

343
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
344
    {
345
      XSETMISC (overlay, tail);
346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361

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

362
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
363
    {
364
      XSETMISC (overlay, tail);
365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390

      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. */
391
Lisp_Object
392
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
393 394 395 396 397
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
398 399 400 401 402 403 404 405 406
  else if (WINDOWP (object))
    object = XWINDOW (object)->buffer;

  if (!BUFFERP (object))
    /* pos-property only makes sense in buffers right now, since strings
       have no overlays and no notion of insertion for which stickiness
       could be obeyed.  */
    return Fget_text_property (position, prop, object);
  else
407
    {
408
      EMACS_INT posn = XINT (position);
409
      ptrdiff_t noverlays;
410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
      Lisp_Object *overlay_vec, tem;
      struct buffer *obuf = current_buffer;

      set_buffer_temp (XBUFFER (object));

      /* First try with room for 40 overlays.  */
      noverlays = 40;
      overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
      noverlays = overlays_around (posn, overlay_vec, noverlays);

      /* If there are more than 40,
	 make enough space for all, and try again.  */
      if (noverlays > 40)
	{
	  overlay_vec = (Lisp_Object *) alloca (noverlays * sizeof (Lisp_Object));
	  noverlays = overlays_around (posn, overlay_vec, noverlays);
	}
      noverlays = sort_overlays (overlay_vec, noverlays, NULL);

      set_buffer_temp (obuf);

      /* Now check the overlays in order of decreasing priority.  */
      while (--noverlays >= 0)
	{
	  Lisp_Object ol = overlay_vec[noverlays];
	  tem = Foverlay_get (ol, prop);
	  if (!NILP (tem))
	    {
	      /* Check the overlay is indeed active at point.  */
	      Lisp_Object start = OVERLAY_START (ol), finish = OVERLAY_END (ol);
	      if ((OVERLAY_POSITION (start) == posn
		   && XMARKER (start)->insertion_type == 1)
		  || (OVERLAY_POSITION (finish) == posn
		      && XMARKER (finish)->insertion_type == 0))
		; /* The overlay will not cover a char inserted at point.  */
	      else
		{
		  return tem;
		}
	    }
	}
451

452
      { /* Now check the text properties.  */
453 454 455 456 457 458 459 460 461 462
	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;
      }
463 464 465
    }
}

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

470 471 472
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

473
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
474 475 476 477 478 479 480 481
   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.
482 483 484 485

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

486
static void
487 488 489
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
	    EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
490
{
491 492
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
493 494 495 496
  /* 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;
497

498 499 500
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
501
    CHECK_NUMBER_COERCE_MARKER (pos);
502

503
  after_field
504
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
505 506
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
507
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
508
					Qfield, Qnil, NULL)
509 510 511
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
512 513 514 515 516 517 518

  /* 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.  */
519
  if (NILP (merge_at_boundary))
520
    {
521 522
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
523
	at_field_end = 1;
524 525
      if (!EQ (field, before_field))
	at_field_start = 1;
526 527 528 529 530 531
      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;
532 533
    }

534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
  /* 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.  */

556
  if (beg)
557 558 559 560 561 562 563 564
    {
      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.  */
	{
565
	  Lisp_Object p = pos;
566 567
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
568
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
569
						       beg_limit);
570 571 572 573

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
574 575
	}
    }
576 577

  if (end)
578 579 580 581 582 583 584 585 586 587
    {
      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.  */
588 589
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
590

591 592
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
593 594 595
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
596
}
597

598

599
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
600
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
601
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
602
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
603
  (Lisp_Object pos)
604
{
605
  EMACS_INT beg, end;
606
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
607 608
  if (beg != end)
    del_range (beg, end);
609
  return Qnil;
610 611 612
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
613
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
614
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
615
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
616
  (Lisp_Object pos)
617
{
618
  EMACS_INT beg, end;
619
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
620 621 622 623
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
624
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
625
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
626
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
627
  (Lisp_Object pos)
628
{
629
  EMACS_INT beg, end;
630
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
631 632 633
  return make_buffer_string (beg, end, 0);
}

634
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
635
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
636 637 638
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
639 640
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
641
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
642
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
643
{
644
  EMACS_INT beg;
645
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
646 647 648
  return make_number (beg);
}

Paul Eggert's avatar
Paul Eggert committed
649
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
650
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
651 652 653
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,
654 655
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
656
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
657
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
658
{
659
  EMACS_INT end;
660
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
661 662 663
  return make_number (end);
}

Paul Eggert's avatar
Paul Eggert committed
664
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
665
       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
666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689

A field is a region of text with the same `field' property.
If NEW-POS is nil, then the current point is used instead, and set to the
constrained position if that is different.

If OLD-POS is at the boundary of two fields, then the allowable
positions for NEW-POS depends on the value of the optional argument
ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
constrained to the field that has the same `field' char-property
as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
is non-nil, NEW-POS is constrained to the union of the two adjacent
fields.  Additionally, if two fields are separated by another field with
the special value `boundary', then any point within this special field is
also considered to be `on the boundary'.

If the optional argument ONLY-IN-LINE is non-nil and constraining
NEW-POS would move it to a different line, NEW-POS is returned
unconstrained.  This useful for commands that move by line, like
\\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
only in the case where they can still move to the right line.

If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
a non-nil property of that name, then any field boundaries are ignored.

690
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
691
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
692 693
{
  /* If non-zero, then the original point, before re-positioning.  */
694
  EMACS_INT orig_point = 0;
695 696
  int fwd;
  Lisp_Object prev_old, prev_new;
697

698 699 700 701 702 703 704
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

705 706 707 708 709 710 711
  CHECK_NUMBER_COERCE_MARKER (new_pos);
  CHECK_NUMBER_COERCE_MARKER (old_pos);

  fwd = (XFASTINT (new_pos) > XFASTINT (old_pos));

  prev_old = make_number (XFASTINT (old_pos) - 1);
  prev_new = make_number (XFASTINT (new_pos) - 1);
712

713 714
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
715 716
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
717 718 719 720 721
          /* 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
722
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
723
          || (XFASTINT (old_pos) > BEGV
724
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
725
      && (NILP (inhibit_capture_property)
726 727 728 729 730
          /* 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
731 732
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
733 734
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
735
    {
736
      EMACS_INT shortage;
737 738 739
      Lisp_Object field_bound;

      if (fwd)
740
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
741
      else
742
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
743

744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760
      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)))
761 762 763 764 765 766 767 768 769 770
	/* 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;
}
771

772

Paul Eggert's avatar
Paul Eggert committed
773
DEFUN ("line-beginning-position",
774
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
775
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
776 777
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
778

779 780 781
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

782 783 784 785
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
786
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
787

788
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
789
  (Lisp_Object n)
790
{
791
  EMACS_INT orig, orig_byte, end;
792 793
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
794 795 796 797

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
798
    CHECK_NUMBER (n);
799 800

  orig = PT;
801
  orig_byte = PT_BYTE;
802 803
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
804

805
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
806

807 808
  unbind_to (count, Qnil);

809
  /* Return END constrained to the current input field.  */
810 811
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
812
			      Qt, Qnil);
813 814
}

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

820 821 822
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

823 824 825 826
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
827 828
boundaries bind `inhibit-field-text-motion' to t.

829
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
830
  (Lisp_Object n)
831
{
832 833
  EMACS_INT end_pos;
  EMACS_INT orig = PT;
834

835 836 837
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
838
    CHECK_NUMBER (n);
839

840 841 842
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
843
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
844
			      Qnil, Qt, Qnil);
845
}
846

847

Jim Blandy's avatar
Jim Blandy committed
848
Lisp_Object
849
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
850
{
851 852
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
853 854

  return Fcons (Fpoint_marker (),
Tom Tromey's avatar
Tom Tromey committed
855
		Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
856
		       Fcons (visible ? Qt : Qnil,
Tom Tromey's avatar
Tom Tromey committed
857
			      Fcons (BVAR (current_buffer, mark_active),
858
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
859 860 861
}

Lisp_Object
862
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
863
{
864 865
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
866
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
867

868
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
869 870 871 872
  /* If buffer being returned to is now deleted, avoid error */
  /* Otherwise could get error here while unwinding to top level
     and crash */
  /* In that case, Fmarker_buffer returns nil now.  */
Jim Blandy's avatar
Jim Blandy committed
873
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
874
    return Qnil;
875 876 877 878

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

Jim Blandy's avatar
Jim Blandy committed
879
  Fset_buffer (tem);
880 881 882

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
883
  Fgoto_char (tem);
884
  unchain_marker (XMARKER (tem));
885 886 887 888

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
889 890
  omark = Fmarker_position (BVAR (current_buffer, mark));
  Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
891
  nmark = Fmarker_position (tem);
892
  unchain_marker (XMARKER (tem));
893 894 895 896

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

898 899 900 901
#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.  */
902 903
  tem1 = Fcar (tem);
  if (!NILP (tem1)
904
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
905
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
906
#endif /* 0 */
907

908 909 910
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed