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
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

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

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

#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

49 50 51 52
#ifndef NULL
#define NULL 0
#endif

53
#ifndef USE_CRT_DLL
54
extern char **environ;
55 56
#endif

57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
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 *));
static void find_field P_ ((Lisp_Object, Lisp_Object, int *, int *));
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));
74

Gerd Moellmann's avatar
Gerd Moellmann committed
75 76 77 78
#ifdef HAVE_INDEX
extern char *index P_ ((const char *, int));
#endif

79 80 81
Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
82

83
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
84

85 86 87 88
/* 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
89 90 91
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
92 93 94
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
95

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

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

#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
123 124 125 126
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
     accurate on MSDOG and because it lets Emacs find the init file.
     (The DVX libraries override the Djgpp libraries here.)  */
127
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
128
#else
129
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
130
#endif
Jim Blandy's avatar
Jim Blandy committed
131

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

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

154
  p = (unsigned char *) getenv ("NAME");
155 156
  if (p)
    Vuser_full_name = build_string (p);
157 158
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
159 160 161
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
162
  "Convert arg CHAR to a string containing that character.")
163 164
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
165
{
Karl Heuer's avatar
Karl Heuer committed
166
  int len;
167
  unsigned char str[MAX_MULTIBYTE_LENGTH];
Karl Heuer's avatar
Karl Heuer committed
168

169
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
170

171 172 173
  len = (SINGLE_BYTE_CHAR_P (XFASTINT (character))
	 ? (*str = (unsigned char)(XFASTINT (character)), 1)
	 : char_to_string (XFASTINT (character), str));
174
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
175 176 177
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
178 179
  "Convert arg STRING to a character, the first character of that string.\n\
A multibyte character is handled correctly.")
180 181
  (string)
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
182 183 184
{
  register Lisp_Object val;
  register struct Lisp_String *p;
185 186
  CHECK_STRING (string, 0);
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
187
  if (p->size)
188 189 190 191 192 193
    {
      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
194
  else
195
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
196 197 198 199
  return val;
}

static Lisp_Object
200 201
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
202 203 204
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
205
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
206 207 208 209 210 211 212 213 214
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
  "Return value of point, as an integer.\n\
Beginning of buffer is position (point-min)")
  ()
{
  Lisp_Object temp;
215
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
216 217 218 219 220 221 222
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
   "Return value of point, as a marker object.")
  ()
{
223
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
}

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: ",
  "Set point to POSITION, a number or marker.\n\
Karl Heuer's avatar
Karl Heuer committed
240 241 242 243
Beginning of buffer is position (point-min), end is (point-max).\n\
If the position is in the middle of a multibyte form,\n\
the actual point is set at the head of the multibyte form\n\
except in the case that `enable-multibyte-characters' is nil.")
244 245
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
246
{
Karl Heuer's avatar
Karl Heuer committed
247 248
  int pos;

249 250
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
251 252 253 254 255 256 257 258 259 260 261 262
    {
      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;
    }

263
  CHECK_NUMBER_COERCE_MARKER (position, 0);
Jim Blandy's avatar
Jim Blandy committed
264

Karl Heuer's avatar
Karl Heuer committed
265 266
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
267
  return position;
Jim Blandy's avatar
Jim Blandy committed
268 269
}

270 271 272 273 274

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

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
  "Return position of beginning of region, as an integer.")
  ()
{
300
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306
}

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

DEFUN ("mark-marker", Fmark_marker, Smark_marker, 0, 0, 0,
  "Return this buffer's mark, as a marker object.\n\
Watch out!  Moving this marker changes the mark position.\n\
If you set the marker not to point anywhere, the buffer will have no mark.")
  ()
{
  return current_buffer->mark;
}
318

319

320 321
#if 0 /* Not used.  */

322 323
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
324 325

static int
326
char_property_eq (prop, pos1, pos2)
327 328 329 330 331
     Lisp_Object prop;
     Lisp_Object pos1, pos2;
{
  Lisp_Object pval1, pval2;

332 333
  pval1 = Fget_char_property (pos1, prop, Qnil);
  pval2 = Fget_char_property (pos2, prop, Qnil);
334 335 336 337

  return EQ (pval1, pval2);
}

338 339
#endif /* 0 */

Miles Bader's avatar
Miles Bader committed
340
/* Return the direction from which the text-property PROP would be
341 342 343 344
   inherited by any new text inserted at POS: 1 if it would be
   inherited from the char after POS, -1 if it would be inherited from
   the char before POS, and 0 if from neither.  */

345
static int
Miles Bader's avatar
Miles Bader committed
346
text_property_stickiness (prop, pos)
347 348 349 350 351
     Lisp_Object prop;
     Lisp_Object pos;
{
  Lisp_Object front_sticky;

352 353
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
354 355 356
    {
      Lisp_Object prev_pos, rear_non_sticky;

357
      prev_pos = make_number (XINT (pos) - 1);
Miles Bader's avatar
Miles Bader committed
358
      rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);
359 360 361

      if (EQ (rear_non_sticky, Qnil)
	  || (CONSP (rear_non_sticky)
362
	      && NILP (Fmemq (prop, rear_non_sticky))))
363
	/* PROP is not rear-non-sticky, and since this takes precedence over
364
	   any front-stickiness, PROP is inherited from before.  */
365 366 367
	return -1;
    }

368
  /* Consider following character.  */
Miles Bader's avatar
Miles Bader committed
369
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
370 371 372

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
373
	  && !NILP (Fmemq (prop, front_sticky))))
374
    /* PROP is inherited from after.  */
375 376
    return 1;

377
  /* PROP is not inherited from either side.  */
378 379
  return 0;
}
380

381

382
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
383 384
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
385 386

   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
387 388 389 390 391 392 393 394
   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.
395 396 397 398

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

399
static void
400 401 402 403 404
find_field (pos, merge_at_boundary, beg, end)
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
     int *beg, *end;
{
405 406
  /* Fields right before and after the point.  */
  Lisp_Object before_field, after_field;
Miles Bader's avatar
Miles Bader committed
407 408 409
  /* If the fields came from overlays, the associated overlays.
     Qnil means they came from text-properties.  */
  Lisp_Object before_overlay = Qnil, after_overlay = Qnil;
410 411 412 413
  /* 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;
414

415 416 417 418 419
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
    CHECK_NUMBER_COERCE_MARKER (pos, 0);

420
  after_field
Miles Bader's avatar
Miles Bader committed
421
    = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
422 423
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
424 425 426
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
					Qfield, Qnil,
					&before_overlay)
427
       : Qnil);
428 429 430 431 432 433 434 435 436 437 438

  /* 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
439 440 441 442 443 444 445 446 447 448 449 450 451
      /* -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
452 453
      else if (aop
	       && XMARKER (OVERLAY_START (after_overlay))->insertion_type == 0)
Miles Bader's avatar
Miles Bader committed
454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474
	/* 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);
475 476 477 478 479 480 481 482 483 484

      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").  */
485
	{
486 487 488 489
	  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.  */
490 491 492
	}
    }

493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514
  /* 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.  */

515
  if (beg)
516 517 518 519 520 521 522 523 524 525 526
    {
      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.  */
	    pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,Qnil);
527

528 529 530 531
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
532 533

  if (end)
534 535 536 537 538 539 540 541 542 543 544
    {
      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.  */
	    pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
545

546 547 548 549
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
550
}
551

552

553
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
554
  "Delete the field surrounding POS.\n\
555
A field is a region of text with the same `field' property.\n\
556
If POS is nil, the value of point is used for POS.")
557 558 559 560 561 562 563
  (pos)
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  if (beg != end)
    del_range (beg, end);
564
  return Qnil;
565 566 567 568 569
}

DEFUN ("field-string", Ffield_string, Sfield_string, 0, 1, 0,
  "Return the contents of the field surrounding POS as a string.\n\
A field is a region of text with the same `field' property.\n\
570
If POS is nil, the value of point is used for POS.")
571 572 573 574 575 576 577 578 579 580 581
  (pos)
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  return make_buffer_string (beg, end, 1);
}

DEFUN ("field-string-no-properties", Ffield_string_no_properties, Sfield_string_no_properties, 0, 1, 0,
  "Return the contents of the field around POS, without text-properties.\n\
A field is a region of text with the same `field' property.\n\
582
If POS is nil, the value of point is used for POS.")
583 584 585 586 587 588 589 590 591 592 593
  (pos)
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  return make_buffer_string (beg, end, 0);
}

DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 2, 0,
  "Return the beginning of the field surrounding POS.\n\
A field is a region of text with the same `field' property.\n\
594 595
If POS is nil, the value of point is used for POS.\n\
If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its\n\
596 597 598 599 600 601 602 603 604 605 606 607
field, then the beginning of the *previous* field is returned.")
  (pos, escape_from_edge)
     Lisp_Object pos, escape_from_edge;
{
  int beg;
  find_field (pos, escape_from_edge, &beg, 0);
  return make_number (beg);
}

DEFUN ("field-end", Ffield_end, Sfield_end, 0, 2, 0,
  "Return the end of the field surrounding POS.\n\
A field is a region of text with the same `field' property.\n\
608 609
If POS is nil, the value of point is used for POS.\n\
If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,\n\
610 611 612 613 614 615 616 617 618
then the end of the *following* field is returned.")
  (pos, escape_from_edge)
     Lisp_Object pos, escape_from_edge;
{
  int end;
  find_field (pos, escape_from_edge, 0, &end);
  return make_number (end);
}

619
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
620
  "Return the position closest to NEW-POS that is in the same field as OLD-POS.\n\
621
\n\
622 623
A field is a region of text with the same `field' property.\n\
If NEW-POS is nil, then the current point is used instead, and set to the\n\
624
constrained position if that is different.\n\
625 626 627 628
\n\
If OLD-POS is at the boundary of two fields, then the allowable\n\
positions for NEW-POS depends on the value of the optional argument\n\
ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is\n\
629
constrained to the field that has the same `field' char-property\n\
630 631
as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE\n\
is non-nil, NEW-POS is constrained to the union of the two adjacent\n\
632 633 634
fields.  Additionally, if two fields are separated by another field with\n\
the special value `boundary', then any point within this special field is\n\
also considered to be `on the boundary'.\n\
635 636 637 638 639
\n\
If the optional argument ONLY-IN-LINE is non-nil and constraining\n\
NEW-POS would move it to a different line, NEW-POS is returned\n\
unconstrained.  This useful for commands that move by line, like\n\
\\[next-line] or \\[beginning-of-line], which should generally respect field boundaries\n\
640 641
only in the case where they can still move to the right line.\n\
\n\
642 643 644
If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has\n\
a non-nil property of that name, then any field boundaries are ignored.\n\
\n\
645
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.")
646 647 648
  (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
649 650 651 652 653 654 655 656 657 658 659
{
  /* 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);
    }

660 661
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
662 663
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
664 665
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
666 667 668
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
669
      int fwd, shortage;
670 671 672 673 674 675 676 677 678 679 680 681
      Lisp_Object field_bound;

      CHECK_NUMBER_COERCE_MARKER (new_pos, 0);
      CHECK_NUMBER_COERCE_MARKER (old_pos, 0);

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

      if (fwd)
	field_bound = Ffield_end (old_pos, escape_from_edge);
      else
	field_bound = Ffield_beginning (old_pos, escape_from_edge);

682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698
      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)))
699 700 701 702 703 704 705 706 707 708
	/* 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;
}
709

710

711 712 713 714 715
DEFUN ("line-beginning-position", Fline_beginning_position, Sline_beginning_position,
  0, 1, 0,
  "Return the character position of the first character on the current line.\n\
With argument N not nil or 1, move forward N - 1 lines first.\n\
If scan reaches end of buffer, return that position.\n\
716
The scan does not cross a field boundary unless it would move\n\
717 718 719 720
beyond there to a different line.  Field boundaries are not noticed if\n\
`inhibit-field-text-motion' is non-nil. .And if N is nil or 1,\n\
and scan starts at a field boundary, the scan stops as soon as it starts.\n\
\n\
721
This function does not move point.")
722 723 724
  (n)
     Lisp_Object n;
{
725
  int orig, orig_byte, end;
726 727 728 729 730 731 732

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

  orig = PT;
733
  orig_byte = PT_BYTE;
734 735
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
736

737
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
738

739
  /* Return END constrained to the current input field.  */
740 741
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
742
			      Qt, Qnil);
743 744 745 746 747 748 749 750 751 752 753
}

DEFUN ("line-end-position", Fline_end_position, Sline_end_position,
  0, 1, 0,
  "Return the character position of the last character on the current line.\n\
With argument N not nil or 1, move forward N - 1 lines first.\n\
If scan reaches end of buffer, return that position.\n\
This function does not move point.")
  (n)
     Lisp_Object n;
{
754
  int end_pos;
755
  int orig = PT;
756

757 758 759 760 761
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

762 763 764
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
765
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
766
			      Qnil, Qt, Qnil);
767 768
}

Jim Blandy's avatar
Jim Blandy committed
769 770 771
Lisp_Object
save_excursion_save ()
{
772 773
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
774 775

  return Fcons (Fpoint_marker (),
776
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
777
		       Fcons (visible ? Qt : Qnil,
778 779
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
780 781 782 783
}

Lisp_Object
save_excursion_restore (info)
784
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
785
{
786 787
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
788
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
789

790
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
791 792 793 794
  /* 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
795
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
796
    return Qnil;
797 798 799 800

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

Jim Blandy's avatar
Jim Blandy committed
801
  Fset_buffer (tem);
802 803 804

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
805 806
  Fgoto_char (tem);
  unchain_marker (tem);
807 808 809 810

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
811
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
812
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
813
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
814
  unchain_marker (tem);
815 816 817 818 819

  /* visible */
  info = XCDR (info);
  visible_p = !NILP (XCAR (info));
  
820 821 822 823
#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.  */
824 825
  tem1 = Fcar (tem);
  if (!NILP (tem1)
826
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
827
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
828
#endif /* 0 */
829

830 831 832
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
833
  tem1 = current_buffer->mark_active;
834 835
  current_buffer->mark_active = tem;

836 837
  if (!NILP (Vrun_hooks))
    {
838 839
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
840
      if (! NILP (current_buffer->mark_active))
841 842 843 844 845
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
846 847 848
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
849 850

  /* If buffer was visible in a window, and a different window was
851 852
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
853 854 855
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
856 857 858 859 860
      && (tem1 = XWINDOW (tem)->buffer,
	  (/* Window is live...  */
	   BUFFERP (tem1)
	   /* ...and it shows the current buffer.  */
	   && XBUFFER (tem1) == current_buffer)))
861 862
    Fset_window_point (tem, make_number (PT));

863
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
864 865 866 867 868 869 870
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
  "Save point, mark, and current buffer; execute BODY; restore those things.\n\
Executes BODY just like `progn'.\n\
The values of point, mark and the current buffer are restored\n\
871
even in case of abnormal exit (throw or error).\n\
872 873 874 875 876 877
The state of activation of the mark is also restored.\n\
\n\
This construct does not save `deactivate-mark', and therefore\n\
functions that change the buffer will still cause deactivation\n\
of the mark at the end of the command.  To prevent that, bind\n\
`deactivate-mark' with `let'.")
Jim Blandy's avatar
Jim Blandy committed
878 879 880 881 882 883 884
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
885 886 887 888 889 890 891 892 893 894 895

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
  "Save the current buffer; execute BODY; restore the current buffer.\n\
Executes BODY just like `progn'.")
  (args)
     Lisp_Object args;
{
896
  Lisp_Object val;
897 898
  int count = specpdl_ptr - specpdl;

899
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
900

Jim Blandy's avatar
Jim Blandy committed
901 902 903 904
  val = Fprogn (args);
  return unbind_to (count, val);
}

905 906 907 908 909
DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 1, 0,
  "Return the number of characters in the current buffer.\n\
If BUFFER, return the number of characters in that buffer instead.")
  (buffer)
     Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
910
{
911 912
  if (NILP (buffer))
    return make_number (Z - BEG);
913 914 915 916 917 918
  else
    {
      CHECK_BUFFER (buffer, 1);
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
919 920 921 922
}

DEFUN ("point-min", Fpoint_min, Spoint_min, 0, 0, 0,
  "Return the minimum permissible value of point in the current buffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
923
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
924 925 926
  ()
{
  Lisp_Object temp;
927
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
928 929 930 931 932
  return temp;
}

DEFUN ("point-min-marker", Fpoint_min_marker, Spoint_min_marker, 0, 0, 0,
  "Return a marker to the minimum permissible value of point in this buffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
933
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
934 935
  ()
{
936
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
937 938 939 940
}

DEFUN ("point-max", Fpoint_max, Spoint_max, 0, 0, 0,
  "Return the maximum permissible value of point in the current buffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
941 942
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
is in effect, in which case it is less.")
Jim Blandy's avatar
Jim Blandy committed
943 944 945
  ()
{
  Lisp_Object temp;
946
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
947 948 949 950 951
  return temp;
}

DEFUN ("point-max-marker", Fpoint_max_marker, Spoint_max_marker, 0, 0, 0,
  "Return a marker to the maximum permissible value of point in this buffer.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
952 953
This is (1+ (buffer-size)), unless narrowing (a buffer restriction)\n\
is in effect, in which case it is less.")
Jim Blandy's avatar
Jim Blandy committed
954 955
  ()
{
956
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
957 958
}

959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978
DEFUN ("gap-position", Fgap_position, Sgap_position, 0, 0, 0,
  "Return the position of the gap, in the current buffer.\n\
See also `gap-size'.")
  ()
{
  Lisp_Object temp;
  XSETFASTINT (temp, GPT);
  return temp;
}

DEFUN ("gap-size", Fgap_size, Sgap_size, 0, 0, 0,
  "Return the size of the current buffer's gap.\n\
See also `gap-position'.")
  ()
{
  Lisp_Object temp;
  XSETFASTINT (temp, GAP_SIZE);
  return temp;
}

979
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
980 981
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
982
  (position)
983
     Lisp_Object position;
984
{
985
  CHECK_NUMBER_COERCE_MARKER (position, 1);
986 987
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
988
  return make_number (CHAR_TO_BYTE (XINT (position)));
989
}
990 991

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
992 993
  "Return the character position for byte position BYTEPOS.\n\
If BYTEPOS is out of range, the value is nil.")
994 995 996 997
  (bytepos)
     Lisp_Object bytepos;
{
  CHECK_NUMBER (bytepos, 1);
998 999
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
1000 1001
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
1002

Jim Blandy's avatar
Jim Blandy committed
1003 1004
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
  "Return the character following point, as a number.\n\
1005
At the end of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
1006 1007 1008
  ()
{
  Lisp_Object temp;
1009
  if (PT >= ZV)
1010
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
1011
  else
1012
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
1016 1017
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
  "Return the character preceding point, as a number.\n\
1018
At the beginning of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
1019 1020 1021
  ()
{
  Lisp_Object temp;
1022
  if (PT <= BEGV)
1023
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
1024 1025
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
1026
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
1027 1028 1029
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
1030
  else
1031
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
1032 1033 1034 1035
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1036
  "Return t if point is at the beginning of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
1040
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
1041 1042 1043 1044 1045
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1046
  "Return t if point is at the end of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
1050
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
1051 1052 1053 1054 1055
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1056
  "Return t if point is at the beginning of a line.")
Jim Blandy's avatar
Jim Blandy committed
1057 1058
  ()
{
1059
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
1060 1061 1062 1063 1064
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1065
  "Return t if point is at the end of a line.\n\
Jim Blandy's avatar
Jim Blandy committed
1066 1067 1068
`End of a line' includes point being at the end of the buffer.")
  ()
{
1069
  if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
Jim Blandy's avatar
Jim Blandy committed
1070 1071 1072 1073
    return Qt;
  return Qnil;
}

1074
DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
1075
  "Return character in current buffer at position POS.\n\
1076
POS is an integer or a marker.\n\
1077
If POS is out of range, the value is nil.")
Jim Blandy's avatar
Jim Blandy committed
1078 1079 1080
  (pos)
     Lisp_Object pos;
{
1081
  register int pos_byte;
Jim Blandy's avatar
Jim Blandy committed
1082

1083
  if (NILP (pos))
1084 1085
    {
      pos_byte = PT_BYTE;
1086
      XSETFASTINT (pos, PT);