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

3
Copyright (C) 1985-1987, 1989, 1993-2011 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 49
#include <limits.h>
#include <intprops.h>
Paul Eggert's avatar
Paul Eggert committed
50
#include <strftime.h>
51

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

60 61 62 63 64 65 66
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

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

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

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

79 80
#define TM_YEAR_BASE 1900

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

88
#ifdef WINDOWSNT
89
extern Lisp_Object w32_get_internal_run_time (void);
90 91
#endif

92
static void time_overflow (void) NO_RETURN;
93
static int tm_diff (struct tm *, struct tm *);
94 95
static void find_field (Lisp_Object, Lisp_Object, Lisp_Object,
			EMACS_INT *, Lisp_Object, EMACS_INT *);
96
static void update_buffer_properties (EMACS_INT, EMACS_INT);
97
static Lisp_Object region_limit (int);
98 99
static size_t emacs_nmemftime (char *, size_t, const char *,
			       size_t, const struct tm *, int, int);
100
static void general_insert_function (void (*) (const char *, EMACS_INT),
101 102 103 104
				     void (*) (Lisp_Object, EMACS_INT,
					       EMACS_INT, EMACS_INT,
					       EMACS_INT, int),
				     int, int, Lisp_Object *);
105 106
static Lisp_Object subst_char_in_region_unwind (Lisp_Object);
static Lisp_Object subst_char_in_region_unwind_1 (Lisp_Object);
107 108
static void transpose_markers (EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT,
			       EMACS_INT, EMACS_INT, EMACS_INT, EMACS_INT);
109 110

Lisp_Object Qbuffer_access_fontify_functions;
111
Lisp_Object Fuser_full_name (Lisp_Object);
112

113 114 115 116 117 118 119 120 121
/* 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
122
void
123
init_editfns (void)
Jim Blandy's avatar
Jim Blandy committed
124
{
Jim Blandy's avatar
Jim Blandy committed
125
  char *user_name;
126
  register char *p;
Jim Blandy's avatar
Jim Blandy committed
127 128 129 130
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
131
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
132 133 134 135 136 137 138 139

#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
140 141 142 143
#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.)  */
144
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
145
#else
146
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
147
#endif
Jim Blandy's avatar
Jim Blandy committed
148

Jim Blandy's avatar
Jim Blandy committed
149 150
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
151
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
152
  if (!user_name)
153 154 155
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
156
    user_name = (char *) getenv ("USER");
157
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
158 159 160 161 162
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
163
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
164

Jim Blandy's avatar
Jim Blandy committed
165 166
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
167
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
168 169
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
170

171
  p = getenv ("NAME");
172 173
  if (p)
    Vuser_full_name = build_string (p);
174 175
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
176 177 178 179 180 181 182 183 184 185

#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
186 187 188
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
189 190
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
191
  (Lisp_Object character)
Jim Blandy's avatar
Jim Blandy committed
192
{
Karl Heuer's avatar
Karl Heuer committed
193
  int len;
194
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
195

196
  CHECK_CHARACTER (character);
Jim Blandy's avatar
Jim Blandy committed
197

198
  len = CHAR_STRING (XFASTINT (character), str);
199
  return make_string_from_bytes ((char *) str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
200 201
}

202
DEFUN ("byte-to-string", Fbyte_to_string, Sbyte_to_string, 1, 1, 0,
203
       doc: /* Convert arg BYTE to a unibyte string containing that byte.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
204
  (Lisp_Object byte)
205
{
206
  unsigned char b;
207
  CHECK_NUMBER (byte);
208 209
  if (XINT (byte) < 0 || XINT (byte) > 255)
    error ("Invalid byte");
210
  b = XINT (byte);
211
  return make_string_from_bytes ((char *) &b, 1, 1);
212 213
}

Jim Blandy's avatar
Jim Blandy committed
214
DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
215 216
       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
217
  (register Lisp_Object string)
Jim Blandy's avatar
Jim Blandy committed
218 219
{
  register Lisp_Object val;
220
  CHECK_STRING (string);
221
  if (SCHARS (string))
222 223
    {
      if (STRING_MULTIBYTE (string))
224
	XSETFASTINT (val, STRING_CHAR (SDATA (string)));
225
      else
226
	XSETFASTINT (val, SREF (string, 0));
227
    }
Jim Blandy's avatar
Jim Blandy committed
228
  else
229
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
230 231 232 233
  return val;
}

static Lisp_Object
234
buildmark (EMACS_INT charpos, EMACS_INT bytepos)
Jim Blandy's avatar
Jim Blandy committed
235 236 237
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
238
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
239 240 241 242
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
243 244
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
245
  (void)
Jim Blandy's avatar
Jim Blandy committed
246 247
{
  Lisp_Object temp;
248
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
249 250 251 252
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
253
       doc: /* Return value of point, as a marker object.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
254
  (void)
Jim Blandy's avatar
Jim Blandy committed
255
{
256
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
257 258
}

259
EMACS_INT
260
clip_to_bounds (EMACS_INT lower, EMACS_INT num, EMACS_INT upper)
Jim Blandy's avatar
Jim Blandy committed
261 262 263 264 265 266 267 268 269 270
{
  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: ",
271
       doc: /* Set point to POSITION, a number or marker.
Eli Zaretskii's avatar
Eli Zaretskii committed
272 273 274
Beginning of buffer is position (point-min), end is (point-max).

The return value is POSITION.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
275
  (register Lisp_Object position)
Jim Blandy's avatar
Jim Blandy committed
276
{
277
  EMACS_INT pos;
Karl Heuer's avatar
Karl Heuer committed
278

279 280
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
281 282 283 284 285 286 287 288 289 290 291 292
    {
      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;
    }

293
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
294

Karl Heuer's avatar
Karl Heuer committed
295 296
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
297
  return position;
Jim Blandy's avatar
Jim Blandy committed
298 299
}

300 301 302 303 304

/* 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
305
static Lisp_Object
306
region_limit (int beginningp)
Jim Blandy's avatar
Jim Blandy committed
307
{
308
  Lisp_Object m;
309

310 311
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
Tom Tromey's avatar
Tom Tromey committed
312
      && NILP (BVAR (current_buffer, mark_active)))
313
    xsignal0 (Qmark_inactive);
314

Tom Tromey's avatar
Tom Tromey committed
315
  m = Fmarker_position (BVAR (current_buffer, mark));
316
  if (NILP (m))
317
    error ("The mark is not set now, so there is no region");
318

Kenichi Handa's avatar
Kenichi Handa committed
319
  if ((PT < XFASTINT (m)) == (beginningp != 0))
320 321
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
322 323 324
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
325
       doc: /* Return the integer value of point or mark, whichever is smaller.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
326
  (void)
Jim Blandy's avatar
Jim Blandy committed
327
{
328
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
329 330 331
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
332
       doc: /* Return the integer value of point or mark, whichever is larger.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
333
  (void)
Jim Blandy's avatar
Jim Blandy committed
334
{
335
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
336 337 338
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
339
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
340
Watch out!  Moving this marker changes the mark position.
341
If you set the marker not to point anywhere, the buffer will have no mark.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
342
  (void)
Jim Blandy's avatar
Jim Blandy committed
343
{
Tom Tromey's avatar
Tom Tromey committed
344
  return BVAR (current_buffer, mark);
Jim Blandy's avatar
Jim Blandy committed
345
}
346 347


348 349 350 351 352
/* 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
353
overlays_around (EMACS_INT pos, Lisp_Object *vec, int len)
354
{
355 356
  Lisp_Object overlay, start, end;
  struct Lisp_Overlay *tail;
357
  EMACS_INT startpos, endpos;
358 359
  int idx = 0;

360
  for (tail = current_buffer->overlays_before; tail; tail = tail->next)
361
    {
362
      XSETMISC (overlay, tail);
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378

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

379
  for (tail = current_buffer->overlays_after; tail; tail = tail->next)
380
    {
381
      XSETMISC (overlay, tail);
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407

      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. */
408
Lisp_Object
409
get_pos_property (Lisp_Object position, register Lisp_Object prop, Lisp_Object object)
410 411 412 413 414
{
  CHECK_NUMBER_COERCE_MARKER (position);

  if (NILP (object))
    XSETBUFFER (object, current_buffer);
415 416 417 418 419 420 421 422 423
  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
424
    {
425
      EMACS_INT posn = XINT (position);
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 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467
      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;
		}
	    }
	}
468

469
      { /* Now check the text properties.  */
470 471 472 473 474 475 476 477 478 479
	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;
      }
480 481 482
    }
}

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

487 488 489
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

490
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
491 492 493 494 495 496 497 498
   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.
499 500 501 502

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

503
static void
504 505 506
find_field (Lisp_Object pos, Lisp_Object merge_at_boundary,
	    Lisp_Object beg_limit,
	    EMACS_INT *beg, Lisp_Object end_limit, EMACS_INT *end)
507
{
508 509
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
510 511 512 513
  /* 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;
514

515 516 517
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
518
    CHECK_NUMBER_COERCE_MARKER (pos);
519

520
  after_field
521
    = get_char_property_and_overlay (pos, Qfield, Qnil, NULL);
522 523
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
524
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
525
					Qfield, Qnil, NULL)
526 527 528
       /* Using nil here would be a more obvious choice, but it would
          fail when the buffer starts with a non-sticky field.  */
       : after_field);
529 530 531 532 533 534 535

  /* 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.  */
536
  if (NILP (merge_at_boundary))
537
    {
538 539
      Lisp_Object field = get_pos_property (pos, Qfield, Qnil);
      if (!EQ (field, after_field))
540
	at_field_end = 1;
541 542
      if (!EQ (field, before_field))
	at_field_start = 1;
543 544 545 546 547 548
      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;
549 550
    }

551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
  /* 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.  */

573
  if (beg)
574 575 576 577 578 579 580 581
    {
      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.  */
	{
582
	  Lisp_Object p = pos;
583 584
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
585
	    p = Fprevious_single_char_property_change (p, Qfield, Qnil,
586
						       beg_limit);
587 588 589 590

	  p = Fprevious_single_char_property_change (p, Qfield, Qnil,
						     beg_limit);
	  *beg = NILP (p) ? BEGV : XFASTINT (p);
591 592
	}
    }
593 594

  if (end)
595 596 597 598 599 600 601 602 603 604
    {
      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.  */
605 606
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
607

608 609
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
610 611 612
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
613
}
614

615

616
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
617
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
618
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
619
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
620
  (Lisp_Object pos)
621
{
622
  EMACS_INT beg, end;
623
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
624 625
  if (beg != end)
    del_range (beg, end);
626
  return Qnil;
627 628 629
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
630
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
631
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
632
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
633
  (Lisp_Object pos)
634
{
635
  EMACS_INT beg, end;
636
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
637 638 639 640
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
641
       doc: /* Return the contents of the field around POS, without text properties.
Pavel Janík's avatar
Pavel Janík committed
642
A field is a region of text with the same `field' property.
Thien-Thi Nguyen's avatar
Thien-Thi Nguyen committed
643
If POS is nil, the value of point is used for POS.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
644
  (Lisp_Object pos)
645
{
646
  EMACS_INT beg, end;
647
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
648 649 650
  return make_buffer_string (beg, end, 0);
}

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

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

681
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
682
       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
683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706

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.

707
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
708
  (Lisp_Object new_pos, Lisp_Object old_pos, Lisp_Object escape_from_edge, Lisp_Object only_in_line, Lisp_Object inhibit_capture_property)
709 710
{
  /* If non-zero, then the original point, before re-positioning.  */
711
  EMACS_INT orig_point = 0;
712 713
  int fwd;
  Lisp_Object prev_old, prev_new;
714

715 716 717 718 719 720 721
  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

722 723 724 725 726 727 728
  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);
729

730 731
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
732 733
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
          || !NILP (Fget_char_property (old_pos, Qfield, Qnil))
734 735 736 737 738
          /* 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
739
              && !NILP (Fget_char_property (prev_new, Qfield, Qnil)))
740
          || (XFASTINT (old_pos) > BEGV
741
              && !NILP (Fget_char_property (prev_old, Qfield, Qnil))))
742
      && (NILP (inhibit_capture_property)
743 744 745 746 747
          /* 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
748 749
                  || NILP (Fget_char_property (old_pos, inhibit_capture_property, Qnil))
                  || NILP (Fget_char_property (prev_old, inhibit_capture_property, Qnil))))))
750 751
    /* It is possible that NEW_POS is not within the same field as
       OLD_POS; try to move NEW_POS so that it is.  */
752
    {
753
      int shortage;
754 755 756
      Lisp_Object field_bound;

      if (fwd)
757
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
758
      else
759
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
760

761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777
      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)))
778 779 780 781 782 783 784 785 786 787
	/* 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;
}
788

789

790 791
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
792
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
793 794
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
795

796 797 798
The returned position is of the first character in the logical order,
i.e. the one that has the smallest character position.

799 800 801 802
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
803
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
804

805
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
806
  (Lisp_Object n)
807
{
808
  EMACS_INT orig, orig_byte, end;
809 810
  int count = SPECPDL_INDEX ();
  specbind (Qinhibit_point_motion_hooks, Qt);
811 812 813 814

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
815
    CHECK_NUMBER (n);
816 817

  orig = PT;
818
  orig_byte = PT_BYTE;
819 820
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
821

822
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
823

824 825
  unbind_to (count, Qnil);

826
  /* Return END constrained to the current input field.  */
827 828
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
829
			      Qt, Qnil);
830 831
}

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

837 838 839
The returned position is of the last character in the logical order,
i.e. the character whose buffer position is the largest one.

840 841 842 843
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
844 845
boundaries bind `inhibit-field-text-motion' to t.

846
This function does not move point.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
847
  (Lisp_Object n)
848
{
849 850
  EMACS_INT end_pos;
  EMACS_INT orig = PT;
851

852 853 854
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
855
    CHECK_NUMBER (n);
856

857 858 859
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
860
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
861
			      Qnil, Qt, Qnil);
862
}
863

864

Jim Blandy's avatar
Jim Blandy committed
865
Lisp_Object
866
save_excursion_save (void)
Jim Blandy's avatar
Jim Blandy committed
867
{
868 869
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
870 871

  return Fcons (Fpoint_marker (),
Tom Tromey's avatar
Tom Tromey committed
872
		Fcons (Fcopy_marker (BVAR (current_buffer, mark), Qnil),
873
		       Fcons (visible ? Qt : Qnil,
Tom Tromey's avatar
Tom Tromey committed
874
			      Fcons (BVAR (current_buffer, mark_active),
875
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
876 877 878
}

Lisp_Object
879
save_excursion_restore (Lisp_Object info)
Jim Blandy's avatar
Jim Blandy committed
880
{
881 882
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
883
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
884

885
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
886 887 888 889
  /* 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
890
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
891
    return Qnil;
892 893 894 895

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

Jim Blandy's avatar
Jim Blandy committed
896
  Fset_buffer (tem);
897 898 899

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
900
  Fgoto_char (tem);
901
  unchain_marker (XMARKER (tem));
902 903 904 905

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
906 907
  omark = Fmarker_position (BVAR (current_buffer, mark));
  Fset_marker (BVAR (current_buffer, mark), tem, Fcurrent_buffer ());
908
  nmark = Fmarker_position (tem);
909
  unchain_marker (XMARKER (tem));
910 911 912 913

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

915 916 917 918
#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.  */
919 920
  tem1 = Fcar (tem);
  if (!NILP (tem1)
921
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
922
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
923
#endif /* 0 */
924

925 926 927
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
Tom Tromey's avatar
Tom Tromey committed
928 929
  tem1 = BVAR (current_buffer, mark_active);
  BVAR (current_buffer, mark_active) = tem;
930

931 932
  if (!NILP (Vrun_hooks))
    {
933 934
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
Tom Tromey's avatar
Tom Tromey committed
935
      if (! NILP (BVAR (current_buffer, mark_active)))
936 937 938 939 940
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
941 942 943
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
944 945

  /* If buffer was visible in a window, and a different window was
946 947
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
948 949 950
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
951 952 953 954 955
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
956 957
    Fset_window_point (tem, make_number (PT));

958
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
959 960 961 962
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
963
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
964 965 966 967 968 969 970 971
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
972 973
`deactivate-mark' with `let'.

974 975 976
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'.

977
usage: (save-excursion &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
978
  (Lisp_Object args)
Jim Blandy's avatar
Jim Blandy committed
979 980
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
981
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
982 983

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
984 985 986 987 988 989

  val = Fprogn (args);
  return unbind_to (count, val);
}

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
990
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
991 992
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
993
  (Lisp_Object args)
994
{
995
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
996
  int count = SPECPDL_INDEX ();
997

998
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
999

Jim Blandy's avatar
Jim Blandy committed
1000 1001 1002 1003
  val = Fprogn (args);
  return unbind_to (count, val);
}

1004
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
1005 1006
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
Dan Nicolaescu's avatar
Dan Nicolaescu committed
1007
  (Lisp_Object buffer)
Jim Blandy's avatar
Jim Blandy committed
1008
{
1009 1010
  if (NILP (buffer))
    return make_number (Z - BEG);