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

Copyright (C) 1985, 1986, 1987, 1989, 1993, 1994, 1995, 1996, 1997,
  1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008,
  2009, 2010 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
6 7 8

This file is part of GNU Emacs.

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

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


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

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

Andreas Schwab's avatar
Andreas Schwab committed
32 33 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37 38 39
#ifdef HAVE_SYS_UTSNAME_H
#include <sys/utsname.h>
#endif

40 41
#include "lisp.h"

42 43 44 45
/* 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"
46 47

#if defined HAVE_SYS_RESOURCE_H
48
#include <sys/resource.h>
49 50
#endif

51 52
#include <ctype.h>

53
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
54
#include "buffer.h"
55
#include "character.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 63 64 65 66 67
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

68 69 70 71
#ifndef NULL
#define NULL 0
#endif

72 73 74 75
#ifndef USER_FULL_NAME
#define USER_FULL_NAME pw->pw_gecos
#endif

76
#ifndef USE_CRT_DLL
77
extern char **environ;
78 79
#endif

80 81
#define TM_YEAR_BASE 1900

82 83 84 85 86 87 88
/* 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

89 90
extern size_t emacs_strftimeu (char *, size_t, const char *,
                               const struct tm *, int);
91 92

#ifdef WINDOWSNT
93
extern Lisp_Object w32_get_internal_run_time (void);
94 95
#endif

96
static int tm_diff (struct tm *, struct tm *);
97 98
static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
			EMACS_INT *, Lisp_Object, EMACS_INT *);
99
static void update_buffer_properties (EMACS_INT, EMACS_INT);
100 101 102
static Lisp_Object region_limit (int);
static size_t emacs_memftimeu (char *, size_t, const char *,
                               size_t, const struct tm *, int);
103 104 105 106 107
static void general_insert_function (void (*) (const unsigned char *, EMACS_INT),
				     void (*) (Lisp_Object, EMACS_INT,
					       EMACS_INT, EMACS_INT,
					       EMACS_INT, int),
				     int, int, Lisp_Object *);
108 109
static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
110 111
static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
			       EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
112 113 114 115

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
116

117
Lisp_Object Fuser_full_name (Lisp_Object);
118

119 120 121 122
/* Non-nil means don't stop at field boundary in text motion commands.  */

Lisp_Object Vinhibit_field_text_motion;

Jim Blandy's avatar
Jim Blandy committed
123 124 125
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
126 127 128
Lisp_Object Vuser_real_login_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;		/* full name of current user */
Lisp_Object Vuser_login_name;		/* user name from LOGNAME or USER */
129
Lisp_Object Voperating_system_release;  /* Operating System Release */
Jim Blandy's avatar
Jim Blandy committed
130

131 132 133 134 135 136 137 138 139
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

Lisp_Object Qboundary;


Jim Blandy's avatar
Jim Blandy committed
140
void
141
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
142
{
Jim Blandy's avatar
Jim Blandy committed
143
  char *user_name;
144
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
145 146 147 148
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
149
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
150 151 152 153 154 155 156 157

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

  pw = (struct passwd *) getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
158 159 160 161
#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.)  */
162
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
163
#else
164
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
165
#endif
Jim Blandy's avatar
Jim Blandy committed
166

Jim Blandy's avatar
Jim Blandy committed
167 168
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
169
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
170
  if (!user_name)
171 172 173
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
174
    user_name = (char *) getenv ("USER");
175
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
176 177 178 179 180
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
181
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
182

Jim Blandy's avatar
Jim Blandy committed
183 184
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
185
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
186 187
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
188

189
  p = (unsigned char *) getenv ("NAME");
190 191
  if (p)
    Vuser_full_name = build_string (p);
192 193
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
194 195 196 197 198 199 200 201 202 203

#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
204 205 206
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
207 208
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
209
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
210
{
Karl Heuer's avatar
Karl Heuer committed
211
  int len;
212
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
213

214
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
215

216
  len = CHAR_STRING (XFASTINT (character), str);
217
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
218 219
}

220 221
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
       doc: /* Convert arg BYTE to a string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
222
  (Lisp_Object byte)
223
{
224
  unsigned char b;
225
  CHECK_NUMBER (byte);
226
  b = XINT (byte);
227 228 229
  return make_string_from_bytes (&b, 1, 1);
}

Jim Blandy's avatar
Jim Blandy committed
230
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
231 232
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
233
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
234 235
{
  register Lisp_Object val;
236
  CHECK_STRING (string);
237
  if (SCHARS (string))
238 239
    {
      if (STRING_MULTIBYTE (string))
240
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
241
      else
242
	XSETFASTINT (val, SREF (string, 0));
243
    }
Jim Blandy's avatar
Jim Blandy committed
244
  else
245
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
246 247 248 249
  return val;
}

static Lisp_Object
250
buildmark (EMACS_INT charpos, EMACS_INT bytepos)
Jim Blandy's avatar
Jim Blandy committed
251 252 253
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
254
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
255 256 257 258
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
259 260
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
261
  (void)
Jim Blandy's avatar
Jim Blandy committed
262 263
{
  Lisp_Object temp;
264
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
265 266 267 268
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
269
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
270
  (void)
Jim Blandy's avatar
Jim Blandy committed
271
{
272
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
273 274 275
}

int
276
clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
Jim Blandy's avatar
Jim Blandy committed
277 278 279 280 281 282 283 284 285 286
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
287
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
288 289 290
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
291
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
292
{
293
  EMACS_INT pos;
Karl Heuer's avatar
Karl Heuer committed
294

295 296
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
297 298 299 300 301 302 303 304 305 306 307 308
    {
      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;
    }

309
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
310

Karl Heuer's avatar
Karl Heuer committed
311 312
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
313
  return position;
Jim Blandy's avatar
Jim Blandy committed
314 315
}

316 317 318 319 320

/* 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
321
static Lisp_Object
322
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
323
{
324
  Lisp_Object m;
325

326 327
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
328
      && NILP (current_buffer->mark_active))
329
    xsignal0 (Qmark_inactive);
330

Jim Blandy's avatar
Jim Blandy committed
331
  m = Fmarker_position (current_buffer->mark);
332
  if (NILP (m))
333
    error ("The mark is not set now, so there is no region");
334

Kenichi Handa's avatar
Kenichi Handa committed
335
  if ((PT < XFASTINT (m)) == (beginningp != 0))
336 337
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
338 339 340
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
341
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
342
  (void)
Jim Blandy's avatar
Jim Blandy committed
343
{
344
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
345 346 347
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
348
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
349
  (void)
Jim Blandy's avatar
Jim Blandy committed
350
{
351
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
352 353 354
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
355
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
356
Watch out!  Moving this marker changes the mark position.
357
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
358
  (void)
Jim Blandy's avatar
Jim Blandy committed
359 360 361
{
  return current_buffer->mark;
}
362 363


364 365 366 367 368
/* 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.  */

static int
369
overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
370
{
371 372
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
373
  EMACS_INT startpos, endpos;
374 375
  int idx = 0;

376
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
377
    {
378
      XSETMISC (overlay, tail);
379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394

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

395
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
396
    {
397
      XSETMISC (overlay, tail);
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423

      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. */
424
Lisp_Object
425
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
426 427 428 429 430
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
431 432 433 434 435 436 437 438 439
  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
440
    {
441
      EMACS_INT posn = XINT (position);
442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483
      int noverlays;
      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;
		}
	    }
	}
484

485
      { /* Now check the text properties.  */
486 487 488 489 490 491 492 493 494 495
	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;
      }
496 497 498
    }
}

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

503 504 505
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

506
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
507 508 509 510 511 512 513 514
   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.
515 516 517 518

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

519
static void
520 521 522
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
	    EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
523
{
524 525
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
526 527 528 529
  /* 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;
530

531 532 533
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
534
    CHECK_NUMBER_COERCE_MARKER (pos);
535

536
  after_field
537
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
538 539
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
540
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
541
					Qfield, Qnil, NULL)
542 543 544
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
545 546 547 548 549 550 551

  /* 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.  */
552
  if (NILP (merge_at_boundary))
553
    {
554 555
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
556
	at_field_end = 1;
557 558
      if (!EQ (field, before_field))
	at_field_start = 1;
559 560 561 562 563 564
      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;
565 566
    }

567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
  /* 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.  */

589
  if (beg)
590 591 592 593 594 595 596 597
    {
      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.  */
	{
598
	  Lisp_Object p = pos;
599 600
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
601
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
602
						       beg_limit);
603 604 605 606

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
607 608
	}
    }
609 610

  if (end)
611 612 613 614 615 616 617 618 619 620
    {
      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.  */
621 622
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
623

624 625
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
626 627 628
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
629
}
630

631

632
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
633
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
634
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
635
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
636
  (Lisp_Object pos)
637
{
638
  EMACS_INT beg, end;
639
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
640 641
  if (beg != end)
    del_range (beg, end);
642
  return Qnil;
643 644 645
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
646
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
647
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
648
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
649
  (Lisp_Object pos)
650
{
651
  EMACS_INT beg, end;
652
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
653 654 655 656
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
657
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
658
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
659
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
660
  (Lisp_Object pos)
661
{
662
  EMACS_INT beg, end;
663
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
664 665 666
  return make_buffer_string (beg, end, 0);
}

667
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
668
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
669 670 671
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
672 673
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
674
is before LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
675
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
676
{
677
  EMACS_INT beg;
678
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
679 680 681
  return make_number (beg);
}

682
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
683
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
684 685 686
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,
687 688
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
689
is after LIMIT, then LIMIT will be returned instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
690
  (Lisp_Object pos, Lisp_Object escape_from_edge, Lisp_Object limit)
691
{
692
  EMACS_INT end;
693
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
694 695 696
  return make_number (end);
}

697
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
698
       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
699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722

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.

723
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
724
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
725 726
{
  /* If non-zero, then the original point, before re-positioning.  */
727
  EMACS_INT orig_point = 0;
728 729
  int fwd;
  Lisp_Object prev_old, prev_new;
730

731 732 733 734 735 736 737
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

738 739 740 741 742 743 744
  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);
745

746 747
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
748 749
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
750 751 752 753 754
          /* 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
755
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
756
          || (XFASTINT (old_pos) > BEGV
757
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
758
      && (NILP (inhibit_capture_property)
759 760 761 762 763
          /* 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
764 765
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
766 767
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
768
    {
769
      int shortage;
770 771 772
      Lisp_Object field_bound;

      if (fwd)
773
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
774
      else
775
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
776

777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
      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)))
794 795 796 797 798 799 800 801 802 803
	/* 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;
}
804

805

806 807
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
808
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
809 810
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
811

812 813 814
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

815 816 817 818
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
819
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
820

821
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
822
  (Lisp_Object n)
823
{
824
  EMACS_INT orig, orig_byte, end;
825 826
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
827 828 829 830

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
831
    CHECK_NUMBER (n);
832 833

  orig = PT;
834
  orig_byte = PT_BYTE;
835 836
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
837

838
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
839

840 841
  unbind_to (count, Qnil);

842
  /* Return END constrained to the current input field.  */
843 844
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
845
			      Qt, Qnil);
846 847
}

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

853 854 855
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

856 857 858 859
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
860 861
boundaries bind `inhibit-field-text-motion' to t.

862
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
863
  (Lisp_Object n)
864
{
865 866
  EMACS_INT end_pos;
  EMACS_INT orig = PT;
867

868 869 870
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
871
    CHECK_NUMBER (n);
872

873 874 875
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
876
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
877
			      Qnil, Qt, Qnil);
878
}
879

880

Jim Blandy's avatar
Jim Blandy committed
881
Lisp_Object
882
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
883
{
884 885
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
886 887

  return Fcons (Fpoint_marker (),
888
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
889
		       Fcons (visible ? Qt : Qnil,
890 891
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
892 893 894
}

Lisp_Object
895
save_excursion_restore (Lisp_Object info)