editfns.c 122 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2
   Copyright (C) 1985,86,87,89,93,94,95,96,97,98, 1999, 2000, 2001, 2002
3
	Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
4 5 6 7 8

This file is part of GNU Emacs.

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

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
along with GNU Emacs; see the file COPYING.  If not, write to
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


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

#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
27
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
28
#else
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 40 41
/* Without this, sprintf on Mac OS Classic will produce wrong
   result.  */
#ifdef MAC_OS8
#include <stdio.h>
#endif

42 43
#include <ctype.h>

Jim Blandy's avatar
Jim Blandy committed
44
#include "lisp.h"
45
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
46
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
47
#include "charset.h"
48
#include "coding.h"
49
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
50 51
#include "window.h"

Jim Blandy's avatar
Jim Blandy committed
52
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
53

54 55 56 57 58 59 60
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

61 62 63 64
#ifndef NULL
#define NULL 0
#endif

65
#ifndef USE_CRT_DLL
66
extern char **environ;
67 68
#endif

69 70 71 72
extern Lisp_Object make_time P_ ((time_t));
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
73
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
74 75 76 77 78
static void update_buffer_properties P_ ((int, int));
static Lisp_Object region_limit P_ ((int));
static int lisp_time_argument P_ ((Lisp_Object, time_t *, int *));
static size_t emacs_memftimeu P_ ((char *, size_t, const char *,
				   size_t, const struct tm *, int));
79
static void general_insert_function P_ ((void (*) (const unsigned char *, int),
80 81 82 83 84 85
					 void (*) (Lisp_Object, int, int, int,
						   int, int),
					 int, int, Lisp_Object *));
static Lisp_Object subst_char_in_region_unwind P_ ((Lisp_Object));
static Lisp_Object subst_char_in_region_unwind_1 P_ ((Lisp_Object));
static void transpose_markers P_ ((int, int, int, int, int, int, int, int));
86

Gerd Moellmann's avatar
Gerd Moellmann committed
87 88 89 90
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

91 92 93
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
94

95
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
96

97 98 99 100
/* 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
101 102 103
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
104 105 106
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 */
Jim Blandy's avatar
Jim Blandy committed
107

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

  /* Set up system_name even when dumping.  */
126
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
127 128 129 130 131 132 133 134

#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
135 136 137 138
#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.)  */
139
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
140
#else
141
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
142
#endif
Jim Blandy's avatar
Jim Blandy committed
143

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

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

166
  p = (unsigned char *) getenv ("NAME");
167 168
  if (p)
    Vuser_full_name = build_string (p);
169 170
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
171 172 173
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
174 175
       doc: /* Convert arg CHAR to a string containing that character.
usage: (char-to-string CHAR)  */)
176
     (character)
177
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
178
{
Karl Heuer's avatar
Karl Heuer committed
179
  int len;
180
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
181

182
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
183

184 185 186
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
187
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
188 189 190
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
191 192 193
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
     (string)
194
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
195 196
{
  register Lisp_Object val;
197
  CHECK_STRING (string);
198
  if (SCHARS (string))
199 200
    {
      if (STRING_MULTIBYTE (string))
201
	XSETFASTINT (val, STRING_CHAR (SDATA (string), SBYTES (string)));
202
      else
203
	XSETFASTINT (val, SREF (string, 0));
204
    }
Jim Blandy's avatar
Jim Blandy committed
205
  else
206
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
207 208 209 210
  return val;
}

static Lisp_Object
211 212
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
213 214 215
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
216
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
217 218 219 220
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
221 222 223
       doc: /* Return value of point, as an integer.
Beginning of buffer is position (point-min).  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
224 225
{
  Lisp_Object temp;
226
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
227 228 229 230
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
231 232
       doc: /* Return value of point, as a marker object.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
233
{
234
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
235 236 237 238 239 240 241 242 243 244 245 246 247 248 249
}

int
clip_to_bounds (lower, num, upper)
     int lower, num, upper;
{
  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: ",
250
       doc: /* Set point to POSITION, a number or marker.
Pavel Janík's avatar
Pavel Janík committed
251 252 253
Beginning of buffer is position (point-min), end is (point-max).
If the position is in the middle of a multibyte form,
the actual point is set at the head of the multibyte form
254 255
except in the case that `enable-multibyte-characters' is nil.  */)
     (position)
256
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
257
{
Karl Heuer's avatar
Karl Heuer committed
258 259
  int pos;

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

274
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
275

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

281 282 283 284 285

/* 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
286 287 288 289
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
290
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
291 292 293 294
  Lisp_Object m;
  
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
295 296
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
297
  
Jim Blandy's avatar
Jim Blandy committed
298
  m = Fmarker_position (current_buffer->mark);
299
  if (NILP (m))
300
    error ("The mark is not set now, so there is no region");
301
  
302
  if ((PT < XFASTINT (m)) == beginningp)
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 309
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
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 316
       doc: /* Return position of end of region, as an integer.  */)
     ()
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 325
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
326 327 328
{
  return current_buffer->mark;
}
329 330


331
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
332 333
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
334

335 336 337
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

338
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
339 340 341 342 343 344 345 346
   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.
347 348 349 350

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

351
static void
352
find_field (pos, merge_at_boundary, beg_limit, beg, end_limit, end)
353 354
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
355
     Lisp_Object beg_limit, end_limit;
356 357
     int *beg, *end;
{
358 359
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
Miles Bader's avatar
Miles Bader committed
360 361 362
  /* If the fields came from overlays, the associated overlays.
     Qnil means they came from text-properties.  */
  Lisp_Object before_overlay = Qnil, after_overlay = Qnil;
363 364 365 366
  /* 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;
367

368 369 370
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
371
    CHECK_NUMBER_COERCE_MARKER (pos);
372

373
  after_field
Miles Bader's avatar
Miles Bader committed
374
    = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
375 376
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
377 378 379
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
					Qfield, Qnil,
					&before_overlay)
380
       : Qnil);
381 382 383 384 385 386 387 388 389 390 391

  /* 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.  */
  if (NILP (merge_at_boundary) && !EQ (after_field, before_field))
    /* We are at a boundary, see which direction is inclusive.  We
       decide by seeing which field the `field' property sticks to.  */
    {
Miles Bader's avatar
Miles Bader committed
392 393 394 395 396 397 398 399 400 401 402 403 404
      /* -1 means insertions go into before_field, 1 means they go
	 into after_field, 0 means neither.  */
      int stickiness;
      /* Whether the before/after_field come from overlays.  */
      int bop = !NILP (before_overlay);
      int aop = !NILP (after_overlay);

      if (bop && XMARKER (OVERLAY_END (before_overlay))->insertion_type == 1)
	/* before_field is from an overlay, which expands upon
	   end-insertions.  Note that it's possible for after_overlay to
	   also eat insertions here, but then they will overlap, and
	   there's not much we can do.  */
	stickiness = -1;
Miles Bader's avatar
Miles Bader committed
405 406
      else if (aop
	       && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
Miles Bader's avatar
Miles Bader committed
407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427
	/* after_field is from an overlay, which expand to contain
	   start-insertions.  */
	stickiness = 1;
      else if (bop && aop)
	/* Both fields come from overlays, but neither will contain any
	   insertion here.  */
	stickiness = 0;
      else if (bop)
	/* before_field is an overlay that won't eat any insertion, but
	   after_field is from a text-property.  Assume that the
	   text-property continues underneath the overlay, and so will
	   be inherited by any insertion, regardless of any stickiness
	   settings.  */
	stickiness = 1;
      else if (aop)
	/* Similarly, when after_field is the overlay.  */
	stickiness = -1;
      else
	/* Both fields come from text-properties.  Look for explicit
	   stickiness properties.  */
	stickiness = text_property_stickiness (Qfield, pos);
428 429 430 431 432 433 434 435 436 437

      if (stickiness > 0)
	at_field_start = 1;
      else if (stickiness < 0)
	at_field_end = 1;
      else
	/* STICKINESS == 0 means that any inserted text will get a
	   `field' char-property of nil, so check to see if that
	   matches either of the adjacent characters (this being a
	   kind of "stickiness by default").  */
438
	{
439 440 441 442
	  if (NILP (before_field))
	    at_field_end = 1; /* Sticks to the left.  */
	  else if (NILP (after_field))
	    at_field_start = 1; /* Sticks to the right.  */
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
  /* 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.  */

468
  if (beg)
469 470 471 472 473 474 475 476 477 478
    {
      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.  */
	{
	  if (!NILP (merge_at_boundary) && EQ (before_field, Qboundary))
	    /* Skip a `boundary' field.  */
479 480
	    pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,
							 beg_limit);
481

482 483
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,
						       beg_limit);
484 485 486
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
487 488

  if (end)
489 490 491 492 493 494 495 496 497 498
    {
      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.  */
499 500
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						     end_limit);
501

502 503
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
504 505 506
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
507
}
508

509

510
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
511
       doc: /* Delete the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
512
A field is a region of text with the same `field' property.
513 514
If POS is nil, the value of point is used for POS.  */)
     (pos)
515 516 517
     Lisp_Object pos;
{
  int beg, end;
518
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
519 520
  if (beg != end)
    del_range (beg, end);
521
  return Qnil;
522 523 524
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
525
       doc: /* Return the contents of the field surrounding POS as a string.
Pavel Janík's avatar
Pavel Janík committed
526
A field is a region of text with the same `field' property.
527 528
If POS is nil, the value of point is used for POS.  */)
     (pos)
529 530 531
     Lisp_Object pos;
{
  int beg, end;
532
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
533 534 535 536
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
537
       doc: /* Return the contents of the field around POS, without text-properties.
Pavel Janík's avatar
Pavel Janík committed
538
A field is a region of text with the same `field' property.
539 540
If POS is nil, the value of point is used for POS.  */)
     (pos)
541 542 543
     Lisp_Object pos;
{
  int beg, end;
544
  find_field (pos, Qnil, Qnil, &beg, Qnil, &end);
545 546 547
  return make_buffer_string (beg, end, 0);
}

548
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
549
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
550 551 552
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
553 554 555 556 557
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
is before LIMIT, then LIMIT will be returned instead.  */)
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
558 559
{
  int beg;
560
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
561 562 563
  return make_number (beg);
}

564
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
565
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
566 567 568
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,
569 570 571 572 573
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
is after LIMIT, then LIMIT will be returned instead.  */)
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
574 575
{
  int end;
576
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
577 578 579
  return make_number (end);
}

580
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
581
       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
582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605

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.

606 607
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
     (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
608 609
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
610 611 612 613 614 615 616 617 618 619 620
{
  /* If non-zero, then the original point, before re-positioning.  */
  int orig_point = 0;

  if (NILP (new_pos))
    /* Use the current point, and afterwards, set it.  */
    {
      orig_point = PT;
      XSETFASTINT (new_pos, PT);
    }

621 622
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
623 624
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
625 626
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
627 628 629
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
630
      int fwd, shortage;
631 632
      Lisp_Object field_bound;

633 634
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
635 636 637 638

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

      if (fwd)
639
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
640
      else
641
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
642

643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659
      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)))
660 661 662 663 664 665 666 667 668 669
	/* 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;
}
670

671

672 673
DEFUN ("line-beginning-position",
       Fline_beginning_position, Sline_beginning_position, 0, 1, 0,
674
       doc: /* Return the character position of the first character on the current line.
Pavel Janík's avatar
Pavel Janík committed
675 676
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
677 678 679 680 681

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.
Pavel Janík's avatar
Pavel Janík committed
682

683 684
This function does not move point.  */)
     (n)
685 686
     Lisp_Object n;
{
687
  int orig, orig_byte, end;
688 689 690 691

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
692
    CHECK_NUMBER (n);
693 694

  orig = PT;
695
  orig_byte = PT_BYTE;
696 697
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
698

699
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
700

701
  /* Return END constrained to the current input field.  */
702 703
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
704
			      Qt, Qnil);
705 706
}

707
DEFUN ("line-end-position", Fline_end_position, Sline_end_position, 0, 1, 0,
708
       doc: /* Return the character position of the last character on the current line.
Pavel Janík's avatar
Pavel Janík committed
709 710
With argument N not nil or 1, move forward N - 1 lines first.
If scan reaches end of buffer, return that position.
711 712 713 714 715 716

The scan does not cross a field boundary unless doing so would move
beyond there to a different line; if N is nil or 1, and scan starts at a
field boundary, the scan stops as soon as it starts.  To ignore field
boundaries bind `inhibit-field-text-motion' to t.

717 718
This function does not move point.  */)
     (n)
719 720
     Lisp_Object n;
{
721
  int end_pos;
722
  int orig = PT;
723

724 725 726
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
727
    CHECK_NUMBER (n);
728

729 730 731
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
732
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
733
			      Qnil, Qt, Qnil);
734
}
735

736

Jim Blandy's avatar
Jim Blandy committed
737 738 739
Lisp_Object
save_excursion_save ()
{
740 741
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
742 743

  return Fcons (Fpoint_marker (),
744
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
745
		       Fcons (visible ? Qt : Qnil,
746 747
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751
}

Lisp_Object
save_excursion_restore (info)
752
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
753
{
754 755
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
756
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
757

758
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
759 760 761 762
  /* 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
763
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
764
    return Qnil;
765 766 767 768

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

Jim Blandy's avatar
Jim Blandy committed
769
  Fset_buffer (tem);
770 771 772

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
773 774
  Fgoto_char (tem);
  unchain_marker (tem);
775 776 777 778

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
779
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
780
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
781
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
782
  unchain_marker (tem);
783 784 785 786 787

  /* visible */
  info = XCDR (info);
  visible_p = !NILP (XCAR (info));
  
788 789 790 791
#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.  */
792 793
  tem1 = Fcar (tem);
  if (!NILP (tem1)
794
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
795
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
796
#endif /* 0 */
797

798 799 800
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
801
  tem1 = current_buffer->mark_active;
802 803
  current_buffer->mark_active = tem;

804 805
  if (!NILP (Vrun_hooks))
    {
806 807
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
808
      if (! NILP (current_buffer->mark_active))
809 810 811 812 813
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
814 815 816
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
817 818

  /* If buffer was visible in a window, and a different window was
819 820
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
821 822 823
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
824 825 826 827 828
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
829 830
    Fset_window_point (tem, make_number (PT));

831
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
832 833 834 835
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
836
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
837 838 839 840 841 842 843 844
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
845 846 847
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
848
     (args)
Jim Blandy's avatar
Jim Blandy committed
849 850 851
     Lisp_Object args;
{
  register Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
852
  int count = SPECPDL_INDEX ();
Jim Blandy's avatar
Jim Blandy committed
853 854

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
855 856 857 858 859 860

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
861
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
862 863
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
864
     (args)
865 866
     Lisp_Object args;
{
867
  Lisp_Object val;
Juanma Barranquero's avatar
Juanma Barranquero committed
868
  int count = SPECPDL_INDEX ();
869

870
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
871

Jim Blandy's avatar
Jim Blandy committed
872 873 874 875
  val = Fprogn (args);
  return unbind_to (count, val);
}

876
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
877 878 879
       doc: /* Return the number of characters in the current buffer.
If BUFFER, return the number of characters in that buffer instead.  */)
     (buffer)
880
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
881
{
882 883
  if (NILP (buffer))
    return make_number (Z - BEG);
884 885
  else
    {
886
      CHECK_BUFFER (buffer);
887 888 889
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
890 891 892
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
893 894 895
       doc: /* Return the minimum permissible value of point in the current buffer.
This is 1, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
896 897
{
  Lisp_Object temp;
898
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
899 900 901 902
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
903 904 905
       doc: /* Return a marker to the minimum permissible value of point in this buffer.
This is the beginning, unless narrowing (a buffer restriction) is in effect.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
906
{
907
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
908 909 910
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
911
       doc: /* Return the maximum permissible value of point in the current buffer.
Pavel Janík's avatar
Pavel Janík committed
912
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
913 914
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
915 916
{
  Lisp_Object temp;
917
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
918 919 920 921
  return temp;
}

DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
922
       doc: /* Return a marker to the maximum permissible value of point in this buffer.
Pavel Janík's avatar
Pavel Janík committed
923
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)
924 925
is in effect, in which case it is less.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
926
{
927
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
928 929
}

930
DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
931 932 933
       doc: /* Return the position of the gap, in the current buffer.
See also `gap-size'.  */)
     ()
934 935 936 937 938 939 940
{
  Lisp_Object temp;
  XSETFASTINT (temp, GPT);
  return temp;
}

DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
941 942 943
       doc: /* Return the size of the current buffer's gap.
See also `gap-position'.  */)
     ()
944 945 946 947 948 949
{
  Lisp_Object temp;
  XSETFASTINT (temp, GAP_SIZE);
  return temp;
}

950
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
951 952 953
       doc: /* Return the byte position for character position POSITION.
If POSITION is out of range, the value is nil.  */)
     (position)
954
     Lisp_Object position;
955
{
956
  CHECK_NUMBER_COERCE_MARKER (position);
957 958
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
959
  return make_number (CHAR_TO_BYTE (XINT (position)));
960
}
961 962

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
963 964 965
       doc: /* Return the character position for byte position BYTEPOS.
If BYTEPOS is out of range, the value is nil.  */)
     (bytepos)
966 967
     Lisp_Object bytepos;
{
968
  CHECK_NUMBER (bytepos);
969 970
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
971 972
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
973

Jim Blandy's avatar
Jim Blandy committed
974
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
975 976 977
       doc: /* Return the character following point, as a number.
At the end of the buffer or accessible region, return 0.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
978 979
{
  Lisp_Object temp;
980
  if (PT >= ZV)
981
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
982
  else
983
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
984 985 986
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
987
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
988 989 990
       doc: /* Return the character preceding point, as a number.
At the beginning of the buffer or accessible region, return 0.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
991 992
{
  Lisp_Object temp;
993
  if (PT <= BEGV)
994
    XSETFASTINT (temp, 0);