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 49 50 51 52
#ifdef STDC_HEADERS
#include <float.h>
#define MAX_10_EXP	DBL_MAX_10_EXP
#else
#define MAX_10_EXP	310
#endif

Jim Blandy's avatar
Jim Blandy committed
53 54 55
#define min(a, b) ((a) < (b) ? (a) : (b))
#define max(a, b) ((a) > (b) ? (a) : (b))

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

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

64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80
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));
81

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

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

90
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
91

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

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

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

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

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

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

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

161
  p = (unsigned char *) getenv ("NAME");
162 163
  if (p)
    Vuser_full_name = build_string (p);
164 165
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
166 167 168
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
169
  "Convert arg CHAR to a string containing that character.")
170 171
  (character)
     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, 0);
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,
Karl Heuer's avatar
Karl Heuer committed
185 186
  "Convert arg STRING to a character, the first character of that string.\n\
A multibyte character is handled correctly.")
187 188
  (string)
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
189 190 191
{
  register Lisp_Object val;
  register struct Lisp_String *p;
192 193
  CHECK_STRING (string, 0);
  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 217 218 219 220 221
  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;
222
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
223 224 225 226 227 228 229
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
   "Return value of point, as a marker object.")
  ()
{
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 246
}

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
247 248 249 250
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.")
251 252
  (position)
     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, 0);
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 296 297
  if (NILP (m))
    error ("There is no region now");
  
298
  if ((PT < XFASTINT (m)) == beginningp)
299 300
    m = make_number (PT);
  return m;
Jim Blandy's avatar
Jim Blandy committed
301 302 303 304 305 306
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
  "Return position of beginning of region, as an integer.")
  ()
{
307
  return region_limit (1);
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311 312 313
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
  "Return position of end of region, as an integer.")
  ()
{
314
  return region_limit (0);
Jim Blandy's avatar
Jim Blandy committed
315 316 317 318 319 320 321 322 323 324
}

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

326

327 328
#if 0 /* Not used.  */

329 330
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
331 332

static int
333
char_property_eq (prop, pos1, pos2)
334 335 336 337 338
     Lisp_Object prop;
     Lisp_Object pos1, pos2;
{
  Lisp_Object pval1, pval2;

339 340
  pval1 = Fget_char_property (pos1, prop, Qnil);
  pval2 = Fget_char_property (pos2, prop, Qnil);
341 342 343 344

  return EQ (pval1, pval2);
}

345 346
#endif /* 0 */

Miles Bader's avatar
Miles Bader committed
347
/* Return the direction from which the text-property PROP would be
348 349 350 351
   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.  */

352
static int
Miles Bader's avatar
Miles Bader committed
353
text_property_stickiness (prop, pos)
354 355 356 357 358
     Lisp_Object prop;
     Lisp_Object pos;
{
  Lisp_Object front_sticky;

359 360
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
361 362 363
    {
      Lisp_Object prev_pos, rear_non_sticky;

364
      prev_pos = make_number (XINT (pos) - 1);
Miles Bader's avatar
Miles Bader committed
365
      rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);
366 367 368

      if (EQ (rear_non_sticky, Qnil)
	  || (CONSP (rear_non_sticky)
369
	      && NILP (Fmemq (prop, rear_non_sticky))))
370
	/* PROP is not rear-non-sticky, and since this takes precedence over
371
	   any front-stickiness, PROP is inherited from before.  */
372 373 374
	return -1;
    }

375
  /* Consider following character.  */
Miles Bader's avatar
Miles Bader committed
376
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
377 378 379

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
380
	  && !NILP (Fmemq (prop, front_sticky))))
381
    /* PROP is inherited from after.  */
382 383
    return 1;

384
  /* PROP is not inherited from either side.  */
385 386
  return 0;
}
387

388

389
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
390 391
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
392 393

   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
394 395 396 397 398 399 400 401
   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.
402 403 404 405

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

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

422 423 424 425 426
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
    CHECK_NUMBER_COERCE_MARKER (pos, 0);

427
  after_field
Miles Bader's avatar
Miles Bader committed
428
    = get_char_property_and_overlay (pos, Qfield, Qnil, &after_overlay);
429 430
  before_field
    = (XFASTINT (pos) > BEGV
Miles Bader's avatar
Miles Bader committed
431 432 433
       ? get_char_property_and_overlay (make_number (XINT (pos) - 1),
					Qfield, Qnil,
					&before_overlay)
434
       : Qnil);
435 436 437 438 439 440 441 442 443 444 445

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

      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").  */
492
	{
493 494 495 496
	  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.  */
497 498 499
	}
    }

500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521
  /* 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.  */

522
  if (beg)
523 524 525 526 527 528 529 530 531 532 533
    {
      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);
534

535 536 537 538
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
539 540

  if (end)
541 542 543 544 545 546 547 548 549 550 551
    {
      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);
552

553 554 555 556
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
557
}
558

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

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\
577
If POS is nil, the value of point is used for POS.")
578 579 580 581 582 583 584 585 586 587 588
  (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\
589
If POS is nil, the value of point is used for POS.")
590 591 592 593 594 595 596 597 598 599 600
  (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\
601 602
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\
603 604 605 606 607 608 609 610 611 612 613 614
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\
615 616
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\
617 618 619 620 621 622 623 624 625
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);
}

626
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
627
  "Return the position closest to NEW-POS that is in the same field as OLD-POS.\n\
628
\n\
629 630
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\
631
constrained position if that is different.\n\
632 633 634 635
\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\
636
constrained to the field that has the same `field' char-property\n\
637 638
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\
639 640 641
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\
642 643 644 645 646
\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\
647 648
only in the case where they can still move to the right line.\n\
\n\
649 650 651
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\
652
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.")
653 654 655
  (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;
656 657 658 659 660 661 662 663 664 665 666
{
  /* 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);
    }

667 668
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
669 670
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
671 672
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
673 674 675
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
676
      int fwd, shortage;
677 678 679 680 681 682 683 684 685 686 687 688
      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);

689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705
      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)))
706 707 708 709 710 711 712 713 714 715
	/* 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;
}
716

717

718 719 720 721 722
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\
723
The scan does not cross a field boundary unless it would move\n\
724 725 726 727
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\
728
This function does not move point.")
729 730 731
  (n)
     Lisp_Object n;
{
732
  int orig, orig_byte, end;
733 734 735 736 737 738 739

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

  orig = PT;
740
  orig_byte = PT_BYTE;
741 742
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
743

744
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
745

746
  /* Return END constrained to the current input field.  */
747 748
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
749
			      Qt, Qnil);
750 751 752 753 754 755 756 757 758 759 760
}

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;
{
761
  int end_pos;
762
  int orig = PT;
763

764 765 766 767 768
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

769 770 771
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
772
  return Fconstrain_to_field (make_number (end_pos), make_number (orig),
773
			      Qnil, Qt, Qnil);
774 775
}

Jim Blandy's avatar
Jim Blandy committed
776 777 778
Lisp_Object
save_excursion_save ()
{
779 780
  int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
		 == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
781 782

  return Fcons (Fpoint_marker (),
783
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
784
		       Fcons (visible ? Qt : Qnil,
785 786
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
787 788 789 790
}

Lisp_Object
save_excursion_restore (info)
791
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
792
{
793 794
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
795
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
796

797
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
798 799 800 801
  /* 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
802
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
803
    return Qnil;
804 805 806 807

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

Jim Blandy's avatar
Jim Blandy committed
808
  Fset_buffer (tem);
809 810 811

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
812 813
  Fgoto_char (tem);
  unchain_marker (tem);
814 815 816 817

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
818
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
819
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
820
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
821
  unchain_marker (tem);
822 823 824 825 826

  /* visible */
  info = XCDR (info);
  visible_p = !NILP (XCAR (info));
  
827 828 829 830
#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.  */
831 832
  tem1 = Fcar (tem);
  if (!NILP (tem1)
833
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
834
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
835
#endif /* 0 */
836

837 838 839
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
840
  tem1 = current_buffer->mark_active;
841 842
  current_buffer->mark_active = tem;

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

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

870
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
871 872 873 874 875 876 877
  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\
878
even in case of abnormal exit (throw or error).\n\
879 880 881 882 883 884
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
885 886 887 888 889 890 891
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
892 893 894 895 896 897 898 899 900 901 902

  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;
{
903
  Lisp_Object val;
904 905
  int count = specpdl_ptr - specpdl;

906
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
907

Jim Blandy's avatar
Jim Blandy committed
908 909 910 911
  val = Fprogn (args);
  return unbind_to (count, val);
}

912 913 914 915 916
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
917
{
918 919
  if (NILP (buffer))
    return make_number (Z - BEG);
920 921 922 923 924 925
  else
    {
      CHECK_BUFFER (buffer, 1);
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
926 927 928 929
}

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
930
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
931 932 933
  ()
{
  Lisp_Object temp;
934
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
935 936 937 938 939
  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
940
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
941 942
  ()
{
943
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
944 945 946 947
}

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
948 949
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
950 951 952
  ()
{
  Lisp_Object temp;
953
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
954 955 956 957 958
  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
959 960
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
961 962
  ()
{
963
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
964 965
}

966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985
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;
}

986
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
987 988
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
989
  (position)
990
     Lisp_Object position;
991
{
992
  CHECK_NUMBER_COERCE_MARKER (position, 1);
993 994
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
995
  return make_number (CHAR_TO_BYTE (XINT (position)));
996
}
997 998

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

Jim Blandy's avatar
Jim Blandy committed
1023 1024
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
  "Return the character preceding point, as a number.\n\