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
#include <ctype.h>

Jim Blandy's avatar
Jim Blandy committed
38
#include "lisp.h"
39
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
40
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
41
#include "charset.h"
42
#include "coding.h"
43
#include "frame.h"
Jim Blandy's avatar
Jim Blandy committed
44 45
#include "window.h"

Jim Blandy's avatar
Jim Blandy committed
46
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
47

48 49 50 51 52 53 54
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

55 56 57 58
#ifndef NULL
#define NULL 0
#endif

59
#ifndef USE_CRT_DLL
60
extern char **environ;
61 62
#endif

63 64 65 66
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 *));
67
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
68 69 70 71 72 73 74 75 76 77 78 79
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));
static void general_insert_function P_ ((void (*) (unsigned char *, int),
					 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));
80

Gerd Moellmann's avatar
Gerd Moellmann committed
81 82 83 84
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

85 86 87
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
88

89
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
90

91 92 93 94
/* 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
95 96 97
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
98 99 100
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
101

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

  /* Set up system_name even when dumping.  */
120
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
121 122 123 124 125 126 127 128

#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
129 130 131 132
#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.)  */
133
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
134
#else
135
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
136
#endif
Jim Blandy's avatar
Jim Blandy committed
137

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

Jim Blandy's avatar
Jim Blandy committed
154 155
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
156
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
157 158
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Sam Steingold's avatar
Sam Steingold committed
159

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

176
  CHECK_NUMBER (character);
Jim Blandy's avatar
Jim Blandy committed
177

178 179 180
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
181
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
182 183 184
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
185 186 187
       doc: /* Convert arg STRING to a character, the first character of that string.
A multibyte character is handled correctly.  */)
     (string)
188
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
189 190 191
{
  register Lisp_Object val;
  register struct Lisp_String *p;
192
  CHECK_STRING (string);
193
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
194
  if (p->size)
195 196 197 198 199 200
    {
      if (STRING_MULTIBYTE (string))
	XSETFASTINT (val, STRING_CHAR (p->data, STRING_BYTES (p)));
      else
	XSETFASTINT (val, p->data[0]);
    }
Jim Blandy's avatar
Jim Blandy committed
201
  else
202
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
203 204 205 206
  return val;
}

static Lisp_Object
207 208
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
209 210 211
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
212
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
213 214 215 216
  return mark;
}

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

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

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: ",
246
       doc: /* Set point to POSITION, a number or marker.
Pavel Janík's avatar
Pavel Janík committed
247 248 249
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
250 251
except in the case that `enable-multibyte-characters' is nil.  */)
     (position)
252
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
253
{
Karl Heuer's avatar
Karl Heuer committed
254 255
  int pos;

256 257
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
258 259 260 261 262 263 264 265 266 267 268 269
    {
      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;
    }

270
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
271

Karl Heuer's avatar
Karl Heuer committed
272 273
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
274
  return position;
Jim Blandy's avatar
Jim Blandy committed
275 276
}

277 278 279 280 281

/* 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
282 283 284 285
static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
286
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
287 288 289 290
  Lisp_Object m;
  
  if (!NILP (Vtransient_mark_mode)
      && NILP (Vmark_even_if_inactive)
291 292
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
293
  
Jim Blandy's avatar
Jim Blandy committed
294
  m = Fmarker_position (current_buffer->mark);
295
  if (NILP (m))
296
    error ("The mark is not set now, so there is no region");
297
  
298
  if ((PT < XFASTINT (m)) == beginningp)
299 300
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
301 302 303
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
304 305
       doc: /* Return position of beginning of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
306
{
307
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
308 309 310
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
311 312
       doc: /* Return position of end of region, as an integer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
313
{
314
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
315 316 317
}

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
318
       doc: /* Return this buffer's mark, as a marker object.
Pavel Janík's avatar
Pavel Janík committed
319
Watch out!  Moving this marker changes the mark position.
320 321
If you set the marker not to point anywhere, the buffer will have no mark.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
322 323 324
{
  return current_buffer->mark;
}
325 326


327
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
328 329
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
330

331 332 333
   BEG_LIMIT and END_LIMIT serve to limit the ranged of the returned
   results; they do not effect boundary behavior.

334
   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
335 336 337 338 339 340 341 342
   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.
343 344 345 346

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

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

364 365 366
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
367
    CHECK_NUMBER_COERCE_MARKER (pos);
368

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

  /* 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
388 389 390 391 392 393 394 395 396 397 398 399 400
      /* -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
401 402
      else if (aop
	       && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
Miles Bader's avatar
Miles Bader committed
403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423
	/* 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);
424 425 426 427 428 429 430 431 432 433

      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").  */
434
	{
435 436 437 438
	  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.  */
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
  /* 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.  */

464
  if (beg)
465 466 467 468 469 470 471 472 473 474
    {
      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.  */
475 476
	    pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,
							 beg_limit);
477

478 479
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,
						       beg_limit);
480 481 482
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
483 484

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

498 499
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil,
						   end_limit);
500 501 502
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
503
}
504

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

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

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

544
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
545
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
546 547 548
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
549 550 551 552 553
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;
554 555
{
  int beg;
556
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
557 558 559
  return make_number (beg);
}

560
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
561
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
562 563 564
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,
565 566 567 568 569
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;
570 571
{
  int end;
572
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
573 574 575
  return make_number (end);
}

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

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.

602 603
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)
604 605
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
606 607 608 609 610 611 612 613 614 615 616
{
  /* 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);
    }

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

629 630
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
631 632 633 634

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

      if (fwd)
635
	field_bound = Ffield_end (old_pos, escape_from_edge, new_pos);
636
      else
637
	field_bound = Ffield_beginning (old_pos, escape_from_edge, new_pos);
638

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

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

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
678

679 680
This function does not move point.  */)
     (n)
681 682
     Lisp_Object n;
{
683
  int orig, orig_byte, end;
684 685 686 687

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
688
    CHECK_NUMBER (n);
689 690

  orig = PT;
691
  orig_byte = PT_BYTE;
692 693
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
694

695
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
696

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

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

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.

713 714
This function does not move point.  */)
     (n)
715 716
     Lisp_Object n;
{
717
  int end_pos;
718
  int orig = PT;
719

720 721 722
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
723
    CHECK_NUMBER (n);
724

725 726 727
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
728
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
729
			      Qnil, Qt, Qnil);
730
}
731

732

Jim Blandy's avatar
Jim Blandy committed
733 734 735
Lisp_Object
save_excursion_save ()
{
736 737
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
738 739

  return Fcons (Fpoint_marker (),
740
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
741
		       Fcons (visible ? Qt : Qnil,
742 743
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
744 745 746 747
}

Lisp_Object
save_excursion_restore (info)
748
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
749
{
750 751
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
752
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
753

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

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

Jim Blandy's avatar
Jim Blandy committed
765
  Fset_buffer (tem);
766 767 768

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
769 770
  Fgoto_char (tem);
  unchain_marker (tem);
771 772 773 774

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

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

794 795 796
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
797
  tem1 = current_buffer->mark_active;
798 799
  current_buffer->mark_active = tem;

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

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

827
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
828 829 830 831
  return Qnil;
}

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

usage: (save-excursion &rest BODY)  */)
844
     (args)
Jim Blandy's avatar
Jim Blandy committed
845 846 847 848 849 850
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
851 852 853 854 855 856

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
857
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
858 859
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
860
     (args)
861 862
     Lisp_Object args;
{
863
  Lisp_Object val;
864 865
  int count = specpdl_ptr - specpdl;

866
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
867

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

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
889 890 891
       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
892 893
{
  Lisp_Object temp;
894
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
895 896 897 898
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
899 900 901
       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
902
{
903
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
904 905 906
}

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

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

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

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

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

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
959 960 961
       doc: /* Return the character position for byte position BYTEPOS.
If BYTEPOS is out of range, the value is nil.  */)
     (bytepos)
962 963
     Lisp_Object bytepos;
{
964
  CHECK_NUMBER (bytepos);
965 966
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
967 968
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
969

Jim Blandy's avatar
Jim Blandy committed
970
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
971 972 973
       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
974 975
{
  Lisp_Object temp;
976
  if (PT >= ZV)
977
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
978
  else
979
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
980 981 982
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
983
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
984 985 986
       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
987 988
{
  Lisp_Object temp;
989
  if (PT <= BEGV)
990
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
991 992
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
993
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
994 995 996
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
997
  else
998
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
999 1000 1001 1002
  return temp;
}

DEFUN ("bobp", Fbobp,