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

This file is part of GNU Emacs.

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

GNU Emacs is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with GNU Emacs; see the file COPYING.  If not, write to
Richard M. Stallman's avatar
Richard M. Stallman committed
19 20
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
21 22


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

#ifdef VMS
Jim Blandy's avatar
Jim Blandy committed
27
#include "vms-pwd.h"
Jim Blandy's avatar
Jim Blandy committed
28
#else
Jim Blandy's avatar
Jim Blandy committed
29
#include <pwd.h>
Jim Blandy's avatar
Jim Blandy committed
30 31
#endif

Andreas Schwab's avatar
Andreas Schwab committed
32 33 34 35
#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

36 37 38 39 40 41
/* Without this, sprintf on Mac OS Classic will produce wrong
   result.  */
#ifdef MAC_OS8
#include <stdio.h>
#endif

42 43
#include <ctype.h>

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

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

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

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

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

69 70 71 72
extern Lisp_Object make_time P_ ((time_t));
extern size_t emacs_strftimeu P_ ((char *, size_t, const char *,
				   const struct tm *, int));
static int tm_diff P_ ((struct tm *, struct tm *));
73
static void find_field P_ ((Lisp_Object, Lisp_Object, Lisp_Object, int *, Lisp_Object, int *));
74 75 76 77 78 79 80 81 82 83 84 85
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));
86

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

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

95
Lisp_Object Fuser_full_name P_ ((Lisp_Object));
96

97 98 99 100
/* Non-nil means don't stop at field boundary in text motion commands.  */

Lisp_Object Vinhibit_field_text_motion;

Jim Blandy's avatar
Jim Blandy committed
101 102 103
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
104 105 106
Lisp_Object Vuser_real_login_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;		/* full name of current user */
Lisp_Object Vuser_login_name;		/* user name from LOGNAME or USER */
Jim Blandy's avatar
Jim Blandy committed
107

108 109 110 111 112 113 114 115 116
/* Symbol for the text property used to mark fields.  */

Lisp_Object Qfield;

/* A special value for Qfield properties.  */

Lisp_Object Qboundary;


Jim Blandy's avatar
Jim Blandy committed
117 118 119
void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
120
  char *user_name;
121
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
122 123 124 125
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

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

#ifndef CANNOT_DUMP
  /* Don't bother with this on initial start when just dumping out */
  if (!initialized)
    return;
#endif /* not CANNOT_DUMP */

  pw = (struct passwd *) getpwuid (getuid ());
Morten Welinder's avatar
Morten Welinder committed
135 136 137 138
#ifdef MSDOS
  /* We let the real user name default to "root" because that's quite
     accurate on MSDOG and because it lets Emacs find the init file.
     (The DVX libraries override the Djgpp libraries here.)  */
139
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
140
#else
141
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
142
#endif
Jim Blandy's avatar
Jim Blandy committed
143

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

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

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

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

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

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

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

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

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

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

276
  CHECK_NUMBER_COERCE_MARKER (position);
Jim Blandy's avatar
Jim Blandy committed
277

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

283 284 285 286 287

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

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

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

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

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

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

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

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

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

370 371 372
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
373
    CHECK_NUMBER_COERCE_MARKER (pos);
374

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

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

      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").  */
440
	{
441 442 443 444
	  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.  */
445 446 447
	}
    }

448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469
  /* 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.  */

470
  if (beg)
471 472 473 474 475 476 477 478 479 480
    {
      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.  */
481 482
	    pos = Fprevious_single_char_property_change (pos, Qfield, Qnil,
							 beg_limit);
483

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

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

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

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

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

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

550
DEFUN ("field-beginning", Ffield_beginning, Sfield_beginning, 0, 3, 0,
551
       doc: /* Return the beginning of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
552 553 554
A field is a region of text with the same `field' property.
If POS is nil, the value of point is used for POS.
If ESCAPE-FROM-EDGE is non-nil and POS is at the beginning of its
555 556 557 558 559
field, then the beginning of the *previous* field is returned.
If LIMIT is non-nil, it is a buffer position; if the beginning of the field
is before LIMIT, then LIMIT will be returned instead.  */)
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
560 561
{
  int beg;
562
  find_field (pos, escape_from_edge, limit, &beg, Qnil, 0);
563 564 565
  return make_number (beg);
}

566
DEFUN ("field-end", Ffield_end, Sfield_end, 0, 3, 0,
567
       doc: /* Return the end of the field surrounding POS.
Pavel Janík's avatar
Pavel Janík committed
568 569 570
A field is a region of text with the same `field' property.
If POS is nil, the value of point is used for POS.
If ESCAPE-FROM-EDGE is non-nil and POS is at the end of its field,
571 572 573 574 575
then the end of the *following* field is returned.
If LIMIT is non-nil, it is a buffer position; if the end of the field
is after LIMIT, then LIMIT will be returned instead.  */)
     (pos, escape_from_edge, limit)
     Lisp_Object pos, escape_from_edge, limit;
576 577
{
  int end;
578
  find_field (pos, escape_from_edge, Qnil, 0, limit, &end);
579 580 581
  return make_number (end);
}

582
DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 5, 0,
583
       doc: /* Return the position closest to NEW-POS that is in the same field as OLD-POS.
Pavel Janík's avatar
Pavel Janík committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607

A field is a region of text with the same `field' property.
If NEW-POS is nil, then the current point is used instead, and set to the
constrained position if that is different.

If OLD-POS is at the boundary of two fields, then the allowable
positions for NEW-POS depends on the value of the optional argument
ESCAPE-FROM-EDGE: If ESCAPE-FROM-EDGE is nil, then NEW-POS is
constrained to the field that has the same `field' char-property
as any new characters inserted at OLD-POS, whereas if ESCAPE-FROM-EDGE
is non-nil, NEW-POS is constrained to the union of the two adjacent
fields.  Additionally, if two fields are separated by another field with
the special value `boundary', then any point within this special field is
also considered to be `on the boundary'.

If the optional argument ONLY-IN-LINE is non-nil and constraining
NEW-POS would move it to a different line, NEW-POS is returned
unconstrained.  This useful for commands that move by line, like
\\[next-line] or \\[beginning-of-line], which should generally respect field boundaries
only in the case where they can still move to the right line.

If the optional argument INHIBIT-CAPTURE-PROPERTY is non-nil, and OLD-POS has
a non-nil property of that name, then any field boundaries are ignored.

608 609
Field boundaries are not noticed if `inhibit-field-text-motion' is non-nil.  */)
     (new_pos, old_pos, escape_from_edge, only_in_line, inhibit_capture_property)
610 611
     Lisp_Object new_pos, old_pos;
     Lisp_Object escape_from_edge, only_in_line, inhibit_capture_property;
612 613 614 615 616 617 618 619 620 621 622
{
  /* 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);
    }

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

635 636
      CHECK_NUMBER_COERCE_MARKER (new_pos);
      CHECK_NUMBER_COERCE_MARKER (old_pos);
637 638 639 640

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

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

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

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

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

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

  if (NILP (n))
    XSETFASTINT (n, 1);
  else
694
    CHECK_NUMBER (n);
695 696

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

701
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
702

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

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

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

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

726 727 728
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
729
    CHECK_NUMBER (n);
730

731 732 733
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
771
  Fset_buffer (tem);
772 773 774

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

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

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

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

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

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

833
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
834 835 836 837
  return Qnil;
}

DEFUN ("save-excursion", Fsave_excursion, Ssave_excursion, 0, UNEVALLED, 0,
838
       doc: /* Save point, mark, and current buffer; execute BODY; restore those things.
Pavel Janík's avatar
Pavel Janík committed
839 840 841 842 843 844 845 846
Executes BODY just like `progn'.
The values of point, mark and the current buffer are restored
even in case of abnormal exit (throw or error).
The state of activation of the mark is also restored.

This construct does not save `deactivate-mark', and therefore
functions that change the buffer will still cause deactivation
of the mark at the end of the command.  To prevent that, bind
847 848 849
`deactivate-mark' with `let'.

usage: (save-excursion &rest BODY)  */)
850
     (args)
Jim Blandy's avatar
Jim Blandy committed
851 852 853 854 855 856
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
857 858 859 860 861 862

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

DEFUN ("save-current-buffer", Fsave_current_buffer, Ssave_current_buffer, 0, UNEVALLED, 0,
863
       doc: /* Save the current buffer; execute BODY; restore the current buffer.
864 865
Executes BODY just like `progn'.
usage: (save-current-buffer &rest BODY)  */)
866
     (args)
867 868
     Lisp_Object args;
{
869
  Lisp_Object val;
870 871
  int count = specpdl_ptr - specpdl;

872
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
873

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

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

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

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

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

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

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

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

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

Jim Blandy's avatar
Jim Blandy committed
989
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
990 991 992
       doc: /* Return the character preceding point, as a number.
At the beginning of the buffer or accessible region, return 0.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
993 994
{
  Lisp_Object temp;
995
  if (PT <= BEGV)
996
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
997 998
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
999
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
1000 1001 1002
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
1003
  else
1004
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
1005 1006 1007 1008
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
1009 1010 1011
       doc: /* Return t if point is at the beginning of the buffer.
If the buffer is narrowed, this means the beginning of the narrowed part.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1012
{
1013
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
1014 1015 1016 1017 1018
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
1019 1020 1021
       doc: /* Return t if point is at the end of the buffer.
If the buffer is narrowed, this means the end of the narrowed part.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1022
{
1023
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
1024 1025 1026 1027 1028
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
1029 1030
       doc: /* Return t if point is at the beginning of a line.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1031
{
1032
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
1033 1034 1035 1036 1037
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
1038 1039 1040
       doc: /* Return t if point is at the end of a line.
`End of a line' includes point being at the end of the buffer.  */)
     ()
Jim Blandy's avatar
Jim Blandy committed
1041
{
1042
  if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
Jim Blandy's avatar
Jim Blandy committed
1043 1044 1045 1046
    return Qt;
  return Qnil;
}

1047
DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
1048
       doc: /* Return character in current buffer at position POS.
Pavel Janík's avatar
Pavel Janík committed
1049
POS is an integer or a marker.
1050 1051
If POS is out of range, the value is nil.  */)
     (pos)
Jim Blandy's avatar
Jim Blandy committed
1052 1053
     Lisp_Object pos;
{
1054
  register int pos_byte;
Jim Blandy's avatar
Jim Blandy committed
1055

1056
  if (NILP (pos))
1057 1058
    {
      pos_byte = PT_BYTE;
1059
      XSETFASTINT (pos, PT);
1060 1061 1062
    }

  if (MARKERP (pos))
1063 1064 1065 1066 1067
    {
      pos_byte = marker_byte_position (pos);
      if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
	return Qnil;
    }
1068 1069
  else
    {
1070
      CHECK_NUMBER_COERCE_MARKER (pos);
1071
      if (XINT (pos) < BEGV || XINT (pos) >= ZV)
1072
	return Qnil;
Sam Steingold's avatar
Sam Steingold committed
1073

1074
      pos_byte = CHAR_TO_BYTE (XINT (pos));
1075
    }
Jim Blandy's avatar
Jim Blandy committed
1076

1077
  return make_number (FETCH_CHAR (pos_byte));