editfns.c 122 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
2 3
   Copyright (C) 1985,86,87,89,93,94,95,96,97,98, 1999, 2000
	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"
Jim Blandy's avatar
Jim Blandy committed
41 42
#include "window.h"

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

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

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

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

56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
extern Lisp_Object make_time P_ ((time_t));
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
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));
73

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

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

82
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
83

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

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

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

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

#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
122 123 124 125
#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.)  */
126
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
127
#else
128
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
129
#endif
Jim Blandy's avatar
Jim Blandy committed
130

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

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

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

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

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

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

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

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
239 240 241 242
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.")
243 244
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
245
{
Karl Heuer's avatar
Karl Heuer committed
246 247
  int pos;

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

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

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

269 270 271 272 273

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

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

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

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

318

319 320
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
321 322

static int
323
char_property_eq (prop, pos1, pos2)
324 325 326 327 328
     Lisp_Object prop;
     Lisp_Object pos1, pos2;
{
  Lisp_Object pval1, pval2;

329 330
  pval1 = Fget_char_property (pos1, prop, Qnil);
  pval2 = Fget_char_property (pos2, prop, Qnil);
331 332 333 334

  return EQ (pval1, pval2);
}

Miles Bader's avatar
Miles Bader committed
335
/* Return the direction from which the text-property PROP would be
336 337 338 339
   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.  */

340
static int
Miles Bader's avatar
Miles Bader committed
341
text_property_stickiness (prop, pos)
342 343 344 345 346
     Lisp_Object prop;
     Lisp_Object pos;
{
  Lisp_Object front_sticky;

347 348
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
349 350 351
    {
      Lisp_Object prev_pos, rear_non_sticky;

352
      prev_pos = make_number (XINT (pos) - 1);
Miles Bader's avatar
Miles Bader committed
353
      rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);
354 355 356

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

363
  /* Consider following character.  */
Miles Bader's avatar
Miles Bader committed
364
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);
365 366 367

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
368
	  && !NILP (Fmemq (prop, front_sticky))))
369
    /* PROP is inherited from after.  */
370 371
    return 1;

372
  /* PROP is not inherited from either side.  */
373 374
  return 0;
}
375

376

377
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
378 379
   the value of point is used instead.  If BEG or END null,
   means don't store the beginning or end of the field.
380 381

   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
382 383 384 385 386 387 388 389
   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.
390 391 392 393

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

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

410 411 412 413 414
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
    CHECK_NUMBER_COERCE_MARKER (pos, 0);

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

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

      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").  */
480
	{
481 482 483 484
	  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.  */
485 486 487
	}
    }

488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509
  /* 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.  */

510
  if (beg)
511 512 513 514 515 516 517 518 519 520 521
    {
      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);
522

523 524 525 526
	  pos = Fprevious_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *beg = NILP (pos) ? BEGV : XFASTINT (pos);
	}
    }
527 528

  if (end)
529 530 531 532 533 534 535 536 537 538 539
    {
      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);
540

541 542 543 544
	  pos = Fnext_single_char_property_change (pos, Qfield, Qnil, Qnil);
	  *end = NILP (pos) ? ZV : XFASTINT (pos);
	}
    }
545
}
546

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

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\
565
If POS is nil, the value of point is used for POS.")
566 567 568 569 570 571 572 573 574 575 576
  (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\
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, 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\
589 590
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\
591 592 593 594 595 596 597 598 599 600 601 602
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\
603 604
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\
605 606 607 608 609 610 611 612 613
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);
}

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

655 656
  if (NILP (Vinhibit_field_text_motion)
      && !EQ (new_pos, old_pos)
657 658
      && (!NILP (Fget_char_property (new_pos, Qfield, Qnil))
	  || !NILP (Fget_char_property (old_pos, Qfield, Qnil)))
659 660
      && (NILP (inhibit_capture_property)
	  || NILP (Fget_char_property(old_pos, inhibit_capture_property, Qnil))))
661 662 663
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
664
      int fwd, shortage;
665 666 667 668 669 670 671 672 673 674 675 676
      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);

677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693
      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)))
694 695 696 697 698 699 700 701 702 703
	/* 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;
}
704

705

706 707 708 709 710
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\
711
The scan does not cross a field boundary unless it would move\n\
712 713 714 715
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\
716
This function does not move point.")
717 718 719
  (n)
     Lisp_Object n;
{
720
  int orig, orig_byte, end;
721 722 723 724 725 726 727

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

  orig = PT;
728
  orig_byte = PT_BYTE;
729 730
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
731

732
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
733

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

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;
{
749
  int end_pos;
750
  int orig = PT;
751

752 753 754 755 756
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

757 758 759
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

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

  return Fcons (Fpoint_marker (),
771
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
772
		       Fcons (visible ? Qt : Qnil,
773 774
			      Fcons (current_buffer->mark_active,
				     selected_window))));
Jim Blandy's avatar
Jim Blandy committed
775 776 777 778
}

Lisp_Object
save_excursion_restore (info)
779
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
780
{
781 782
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
783
  int visible_p;
Jim Blandy's avatar
Jim Blandy committed
784

785
  tem = Fmarker_buffer (XCAR (info));
Jim Blandy's avatar
Jim Blandy committed
786 787 788 789
  /* 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
790
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
791
    return Qnil;
792 793 794 795

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

Jim Blandy's avatar
Jim Blandy committed
796
  Fset_buffer (tem);
797 798 799

  /* Point marker.  */
  tem = XCAR (info);
Jim Blandy's avatar
Jim Blandy committed
800 801
  Fgoto_char (tem);
  unchain_marker (tem);
802 803 804 805

  /* Mark marker.  */
  info = XCDR (info);
  tem = XCAR (info);
806
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
807
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
808
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
809
  unchain_marker (tem);
810 811 812 813 814

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

825 826 827
  /* Mark active */
  info = XCDR (info);
  tem = XCAR (info);
828
  tem1 = current_buffer->mark_active;
829 830
  current_buffer->mark_active = tem;

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

  /* If buffer was visible in a window, and a different window was
846 847
     selected, and the old selected window is still showing this
     buffer, restore point in that window.  */
848 849 850
  tem = XCDR (info);
  if (visible_p
      && !EQ (tem, selected_window)
851 852
      /* This also verifies that the window is still live.  */
      && XBUFFER (XWINDOW (tem)->buffer) == current_buffer)
853 854
    Fset_window_point (tem, make_number (PT));

855
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
856 857 858 859 860 861 862
  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\
863
even in case of abnormal exit (throw or error).\n\
864 865 866 867 868 869
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
870 871 872 873 874 875 876
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
877 878 879 880 881 882 883 884 885 886 887

  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;
{
888
  Lisp_Object val;
889 890
  int count = specpdl_ptr - specpdl;

891
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
892

Jim Blandy's avatar
Jim Blandy committed
893 894 895 896
  val = Fprogn (args);
  return unbind_to (count, val);
}

897 898 899 900 901
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
902
{
903 904
  if (NILP (buffer))
    return make_number (Z - BEG);
905 906 907 908 909 910
  else
    {
      CHECK_BUFFER (buffer, 1);
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
911 912 913 914
}

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
915
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
916 917 918
  ()
{
  Lisp_Object temp;
919
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
920 921 922 923 924
  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
925
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
926 927
  ()
{
928
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
929 930 931 932
}

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
933 934
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
935 936 937
  ()
{
  Lisp_Object temp;
938
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
939 940 941 942 943
  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
944 945
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
946 947
  ()
{
948
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
949 950
}

951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970
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;
}

971
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
972 973
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
974
  (position)
975
     Lisp_Object position;
976
{
977
  CHECK_NUMBER_COERCE_MARKER (position, 1);
978 979
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
980
  return make_number (CHAR_TO_BYTE (XINT (position)));
981
}
982 983

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

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

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1028
  "Return t if point is at the beginning of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
1029 1030 1031
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
1032
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035 1036 1037
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1038
  "Return t if point is at the end of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
1039 1040 1041
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
1042
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046 1047
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1048
  "Return t if point is at the beginning of a line.")
Jim Blandy's avatar
Jim Blandy committed
1049 1050
  ()
{
1051
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
1052 1053 1054 1055 1056
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1057
  "Return t if point is at the end of a line.\n\