editfns.c 112 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 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

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
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17
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
18 19
the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
Boston, MA 02111-1307, USA.  */
Jim Blandy's avatar
Jim Blandy committed
20 21


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

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

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

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

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

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

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

51 52
extern char **environ;
extern Lisp_Object make_time ();
53
extern void insert_from_buffer ();
54
static int tm_diff ();
55
static void update_buffer_properties ();
56
size_t emacs_strftimeu ();
57
void set_time_zone_rule ();
58 59 60 61

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
62

63 64
Lisp_Object Fuser_full_name ();

Jim Blandy's avatar
Jim Blandy committed
65 66 67
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
68 69 70
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
71 72 73 74

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
75
  char *user_name;
76
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
77 78 79 80
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
81
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
82 83 84 85 86 87 88 89

#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
90 91 92 93
#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.)  */
94
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
95
#else
96
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
97
#endif
Jim Blandy's avatar
Jim Blandy committed
98

Jim Blandy's avatar
Jim Blandy committed
99 100
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
101
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
102
  if (!user_name)
103 104 105
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
106
    user_name = (char *) getenv ("USER");
107
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
108 109 110 111 112
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
113
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
114

Jim Blandy's avatar
Jim Blandy committed
115 116
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
117
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
118 119
  Vuser_full_name = Fuser_full_name (NILP (tem)? make_number (geteuid())
				     : Vuser_login_name);
Jim Blandy's avatar
Jim Blandy committed
120
  
121
  p = (unsigned char *) getenv ("NAME");
122 123
  if (p)
    Vuser_full_name = build_string (p);
124 125
  else if (NILP (Vuser_full_name))
    Vuser_full_name = build_string ("unknown");
Jim Blandy's avatar
Jim Blandy committed
126 127 128
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
129
  "Convert arg CHAR to a string containing that character.")
130 131
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
132
{
Karl Heuer's avatar
Karl Heuer committed
133
  int len;
134
  unsigned char workbuf[4], *str;
Karl Heuer's avatar
Karl Heuer committed
135

136
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
137

Karl Heuer's avatar
Karl Heuer committed
138
  len = CHAR_STRING (XFASTINT (character), workbuf, str);
139
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
140 141 142
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
143 144
  "Convert arg STRING to a character, the first character of that string.\n\
A multibyte character is handled correctly.")
145 146
  (string)
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
147 148 149
{
  register Lisp_Object val;
  register struct Lisp_String *p;
150 151
  CHECK_STRING (string, 0);
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
152
  if (p->size)
153 154 155 156 157 158
    {
      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
159
  else
160
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
161 162 163 164
  return val;
}

static Lisp_Object
165 166
buildmark (charpos, bytepos)
     int charpos, bytepos;
Jim Blandy's avatar
Jim Blandy committed
167 168 169
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
170
  set_marker_both (mark, Qnil, charpos, bytepos);
Jim Blandy's avatar
Jim Blandy committed
171 172 173 174 175 176 177 178 179
  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;
180
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
181 182 183 184 185 186 187
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
   "Return value of point, as a marker object.")
  ()
{
188
  return buildmark (PT, PT_BYTE);
Jim Blandy's avatar
Jim Blandy committed
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204
}

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
205 206 207 208
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.")
209 210
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
211
{
Karl Heuer's avatar
Karl Heuer committed
212 213
  int pos;

214 215
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
216 217 218 219 220 221 222 223 224 225 226 227
    {
      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;
    }

228
  CHECK_NUMBER_COERCE_MARKER (position, 0);
Jim Blandy's avatar
Jim Blandy committed
229

Karl Heuer's avatar
Karl Heuer committed
230 231
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
232
  return position;
Jim Blandy's avatar
Jim Blandy committed
233 234 235 236 237 238
}

static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
239
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
240
  register Lisp_Object m;
241 242 243
  if (!NILP (Vtransient_mark_mode) && NILP (Vmark_even_if_inactive)
      && NILP (current_buffer->mark_active))
    Fsignal (Qmark_inactive, Qnil);
Jim Blandy's avatar
Jim Blandy committed
244
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
245
  if (NILP (m)) error ("There is no region now");
246 247
  if ((PT < XFASTINT (m)) == beginningp)
    return (make_number (PT));
Jim Blandy's avatar
Jim Blandy committed
248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273
  else
    return (m);
}

DEFUN ("region-beginning", Fregion_beginning, Sregion_beginning, 0, 0, 0,
  "Return position of beginning of region, as an integer.")
  ()
{
  return (region_limit (1));
}

DEFUN ("region-end", Fregion_end, Sregion_end, 0, 0, 0,
  "Return position of end of region, as an integer.")
  ()
{
  return (region_limit (0));
}

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;
}
274

275 276
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
277 278 279 280 281 282 283 284 285 286 287 288 289 290

static int
text_property_eq (prop, pos1, pos2)
     Lisp_Object prop;
     Lisp_Object pos1, pos2;
{
  Lisp_Object pval1, pval2;

  pval1 = Fget_text_property (pos1, prop, Qnil);
  pval2 = Fget_text_property (pos2, prop, Qnil);

  return EQ (pval1, pval2);
}

291 292 293 294 295
/* Return the direction from which the text-property PROP would be
   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.  */

296 297 298 299 300 301 302
static int
text_property_stickiness (prop, pos)
     Lisp_Object prop;
     Lisp_Object pos;
{
  Lisp_Object front_sticky;

303 304
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
305 306 307
    {
      Lisp_Object prev_pos, rear_non_sticky;

308
      prev_pos = make_number (XINT (pos) - 1);
309 310 311 312 313 314
      rear_non_sticky = Fget_text_property (prev_pos, Qrear_nonsticky, Qnil);

      if (EQ (rear_non_sticky, Qnil)
	  || (CONSP (rear_non_sticky)
	      && !Fmemq (prop, rear_non_sticky)))
	/* PROP is not rear-non-sticky, and since this takes precedence over
315
	   any front-stickiness, PROP is inherited from before.  */
316 317 318
	return -1;
    }

319
  /* Consider following character.  */
320 321 322 323 324
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
	  && Fmemq (prop, front_sticky)))
325
    /* PROP is inherited from after.  */
326 327
    return 1;

328
  /* PROP is not inherited from either side.  */
329 330 331
  return 0;
}

332
/* Symbol for the text property used to mark fields.  */
333 334
Lisp_Object Qfield;

335 336 337 338
/* Find the field surrounding POS in *BEG and *END.  If POS is nil,
   the value of point is used instead.

   If MERGE_AT_BOUNDARY is nonzero, then if POS is at the very first
339 340 341
   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
342 343 344 345 346
   field, this behavior is sometimes useful).

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

347 348 349 350 351 352
void
find_field (pos, merge_at_boundary, beg, end)
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
     int *beg, *end;
{
353 354 355 356
  /* 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;
357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
  
  if (NILP (pos))
    XSETFASTINT (pos, PT);
  else
    CHECK_NUMBER_COERCE_MARKER (pos, 0);

  if (NILP (merge_at_boundary) && XFASTINT (pos) > BEGV)
    /* See if we need to handle the case where POS is at beginning of a
       field, which can also be interpreted as the end of the previous
       field.  We decide which one by seeing which field the `field'
       property sticks to.  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.  */
    {
      /* First see if POS is actually *at* a boundary. */
      Lisp_Object after_field, before_field;

      after_field = Fget_text_property (pos, Qfield, Qnil);
375 376
      before_field = Fget_text_property (make_number (XINT (pos) - 1),
					 Qfield, Qnil);
377 378 379 380

      if (! EQ (after_field, before_field))
	/* We are at a boundary, see which direction is inclusive.  */
	{
381
	  int stickiness = text_property_stickiness (Qfield, pos);
382

383 384 385 386 387
	  if (stickiness > 0)
	    at_field_start = 1;
	  else if (stickiness < 0)
	    at_field_end = 1;
	  else
388 389 390
	    /* STICKINESS == 0 means that any inserted text will get a
	       `field' text-property of nil, so check to see if that
	       matches either of the adjacent characters (this being a
391
	       kind of "stickiness by default").  */
392 393
	    {
	      if (NILP (before_field))
394
		at_field_end = 1; /* Sticks to the left.  */
395
	      else if (NILP (after_field))
396
		at_field_start = 1; /* Sticks to the right.  */
397 398 399 400 401 402
	    }
	}
    }

  if (beg)
    {
403
      if (at_field_start)
404 405 406 407 408 409 410 411
	/* 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.  */
	{
	  Lisp_Object prev;
	  prev = Fprevious_single_property_change (pos, Qfield, Qnil, Qnil);
412
	  *beg = NILP (prev) ? BEGV : XFASTINT (prev);
413 414 415 416 417
	}
    }

  if (end)
    {
418
      if (at_field_end)
419 420 421 422 423 424 425 426
	/* 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.  */
	{
	  Lisp_Object next;
	  next = Fnext_single_property_change (pos, Qfield, Qnil, Qnil);
427
	  *end = NILP (next) ? ZV : XFASTINT (next);
428 429 430 431
	}
    }
}

432
DEFUN ("delete-field", Fdelete_field, Sdelete_field, 0, 1, 0,
433
  "Delete the field surrounding POS.\n\
434
A field is a region of text with the same `field' property.\n\
435
If POS is nil, the value of point is used for POS.")
436 437 438 439 440 441 442
  (pos)
     Lisp_Object pos;
{
  int beg, end;
  find_field (pos, Qnil, &beg, &end);
  if (beg != end)
    del_range (beg, end);
443
  return Qnil;
444 445 446 447 448
}

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\
449
If POS is nil, the value of point is used for POS.")
450 451 452 453 454 455 456 457 458 459 460
  (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\
461
If POS is nil, the value of point is used for POS.")
462 463 464 465 466 467 468 469 470 471 472
  (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\
473 474
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\
475 476 477 478 479 480 481 482 483 484 485 486
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\
487 488
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\
489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571
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);
}

DEFUN ("constrain-to-field", Fconstrain_to_field, Sconstrain_to_field, 2, 4, 0,
  "Return the position closest to NEW-POS that is in the same field as OLD-POS.\n\
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\
constrained position if that is is different.\n\
\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\
constrained to the field that has the same `field' text-property\n\
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\
fields.\n\
\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\
only in the case where they can still move to the right line.")
  (new_pos, old_pos, escape_from_edge, only_in_line)
     Lisp_Object new_pos, old_pos, escape_from_edge, only_in_line;
{
  /* 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);
    }

  if (!EQ (new_pos, old_pos) && !text_property_eq (Qfield, new_pos, old_pos))
    /* NEW_POS is not within the same field as OLD_POS; try to
       move NEW_POS so that it is.  */
    {
      int fwd;
      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);

      if (/* If ONLY_IN_LINE is non-nil, we only constrain NEW_POS if doing
	     so would remain within the same line.  */
	  NILP (only_in_line)
	  /* In that case, 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 that we don't
             have to do the line-check.  */
	  || ((XFASTINT (field_bound) < XFASTINT (new_pos)) ? !fwd : fwd)
	  /* If not, see if there's no newline intervening between
             NEW_POS and FIELD_BOUND.  */
	  || (find_before_next_newline (XFASTINT (new_pos),
					XFASTINT (field_bound),
					fwd ? -1 : 1)
	      == XFASTINT (field_bound)))
	/* 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;
}

572 573 574 575 576
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\
577 578 579 580
The scan does not cross a field boundary unless it would move\n\
beyond there to a different line.  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\
This function does not move point.")
581 582 583
  (n)
     Lisp_Object n;
{
584
  register int orig, orig_byte, end;
585 586 587 588 589 590 591

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

  orig = PT;
592
  orig_byte = PT_BYTE;
593 594
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
595

596
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
597

598
  /* Return END constrained to the current input field.  */
599 600 601
  return Fconstrain_to_field (make_number (end), make_number (orig),
			      XINT (n) != 1 ? Qt : Qnil,
			      Qt);
602 603 604 605 606 607 608 609 610 611 612
}

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;
{
613 614 615
  int end_pos;
  register int orig = PT;

616 617 618 619 620
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

621 622 623 624 625
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
  return
    Fconstrain_to_field (make_number (end_pos), make_number (orig), Qnil, Qt);
626 627
}

Jim Blandy's avatar
Jim Blandy committed
628 629 630
Lisp_Object
save_excursion_save ()
{
631 632
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
633 634

  return Fcons (Fpoint_marker (),
635
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
636 637
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
638 639 640 641
}

Lisp_Object
save_excursion_restore (info)
642
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
643
{
644 645
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
646 647 648 649 650 651

  tem = Fmarker_buffer (Fcar (info));
  /* 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
652
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
653
    return Qnil;
654 655 656 657

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

Jim Blandy's avatar
Jim Blandy committed
658 659 660 661 662
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
663
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
664
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
665
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
666 667
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
668 669 670 671
#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.  */
672 673
  tem1 = Fcar (tem);
  if (!NILP (tem1)
674
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
675
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
676
#endif /* 0 */
677 678 679

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
680 681
  if (!NILP (Vrun_hooks))
    {
682 683
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
684
      if (! NILP (current_buffer->mark_active))
685 686 687 688 689
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
690 691 692
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
693
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
694 695 696 697 698 699 700
  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\
701
even in case of abnormal exit (throw or error).\n\
702 703 704 705 706 707
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
708 709 710 711 712 713 714
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
715 716 717 718 719 720 721 722 723 724 725 726 727 728

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

729
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
730

Jim Blandy's avatar
Jim Blandy committed
731 732 733 734
  val = Fprogn (args);
  return unbind_to (count, val);
}

735 736 737 738 739
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
740
{
741 742
  if (NILP (buffer))
    return make_number (Z - BEG);
743 744 745 746 747 748
  else
    {
      CHECK_BUFFER (buffer, 1);
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
749 750 751 752
}

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
753
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
754 755 756
  ()
{
  Lisp_Object temp;
757
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
758 759 760 761 762
  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
763
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
764 765
  ()
{
766
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
767 768 769 770
}

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
771 772
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
773 774 775
  ()
{
  Lisp_Object temp;
776
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
777 778 779 780 781
  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
782 783
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
784 785
  ()
{
786
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
787 788
}

789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
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;
}

809
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
810 811
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
812
  (position)
813
     Lisp_Object position;
814
{
815
  CHECK_NUMBER_COERCE_MARKER (position, 1);
816 817
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
818
  return make_number (CHAR_TO_BYTE (XINT (position)));
819
}
820 821

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
822 823
  "Return the character position for byte position BYTEPOS.\n\
If BYTEPOS is out of range, the value is nil.")
824 825 826 827
  (bytepos)
     Lisp_Object bytepos;
{
  CHECK_NUMBER (bytepos, 1);
828 829
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
830 831
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
832

Jim Blandy's avatar
Jim Blandy committed
833 834
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
  "Return the character following point, as a number.\n\
Karl Heuer's avatar
Karl Heuer committed
835 836 837 838
At the end of the buffer or accessible region, return 0.\n\
If `enable-multibyte-characters' is nil or point is not\n\
 at character boundary,  multibyte form is ignored,\n\
 and only one byte following point is returned as a character.")
Jim Blandy's avatar
Jim Blandy committed
839 840 841
  ()
{
  Lisp_Object temp;
842
  if (PT >= ZV)
843
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
844
  else
845
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
846 847 848
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
849 850
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
  "Return the character preceding point, as a number.\n\
Karl Heuer's avatar
Karl Heuer committed
851 852 853 854
At the beginning of the buffer or accessible region, return 0.\n\
If `enable-multibyte-characters' is nil or point is not\n\
 at character boundary, multi-byte form is ignored,\n\
 and only one byte preceding point is returned as a character.")
Jim Blandy's avatar
Jim Blandy committed
855 856 857
  ()
{
  Lisp_Object temp;
858
  if (PT <= BEGV)
859
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
860 861
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
862
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
863 864 865
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
866
  else
867
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
868 869 870 871
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
872
  "Return t if point is at the beginning of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
873 874 875
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
876
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880 881
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
882
  "Return t if point is at the end of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
883 884 885
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
886
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
887 888 889 890 891
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
892
  "Return t if point is at the beginning of a line.")
Jim Blandy's avatar
Jim Blandy committed
893 894
  ()
{
895
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
901
  "Return t if point is at the end of a line.\n\
Jim Blandy's avatar
Jim Blandy committed
902 903 904
`End of a line' includes point being at the end of the buffer.")
  ()
{
905
  if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
Jim Blandy's avatar
Jim Blandy committed
906 907 908 909
    return Qt;
  return Qnil;
}

910
DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
911 912
  "Return character in current buffer at position POS.\n\
POS is an integer or a buffer pointer.\n\
913
If POS is out of range, the value is nil.")
Jim Blandy's avatar
Jim Blandy committed
914 915 916
  (pos)
     Lisp_Object pos;
{
917
  register int pos_byte;
Jim Blandy's avatar
Jim Blandy committed
918

919
  if (NILP (pos))
920 921
    {
      pos_byte = PT_BYTE;
922
      XSETFASTINT (pos, PT);
923 924 925
    }

  if (MARKERP (pos))
926 927 928 929 930
    {
      pos_byte = marker_byte_position (pos);
      if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
	return Qnil;
    }
931 932 933
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
934
      if (XINT (pos) < BEGV || XINT (pos) >= ZV)
935
	return Qnil;
936 937
      
      pos_byte = CHAR_TO_BYTE (XINT (pos));
938
    }
Jim Blandy's avatar
Jim Blandy committed
939

940
  return make_number (FETCH_CHAR (pos_byte));
Jim Blandy's avatar
Jim Blandy committed
941
}
Karl Heuer's avatar
Karl Heuer committed
942

943
DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
944 945
  "Return character in current buffer preceding position POS.\n\
POS is an integer or a buffer pointer.\n\
946
If POS is out of range, the value is nil.")
Karl Heuer's avatar
Karl Heuer committed
947 948 949 950
  (pos)
     Lisp_Object pos;
{
  register Lisp_Object val;
951
  register int pos_byte;
Karl Heuer's avatar
Karl Heuer committed
952

953
  if (NILP (pos))
954 955
    {
      pos_byte = PT_BYTE;
956
      XSETFASTINT (pos, PT);
957 958 959
    }

  if (MARKERP (pos))
960 961 962 963 964 965
    {
      pos_byte = marker_byte_position (pos);

      if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
	return Qnil;
    }
966 967 968
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
Karl Heuer's avatar
Karl Heuer committed
969

970
      if (XINT (pos) <= BEGV || XINT (pos) > ZV)
971 972
	return Qnil;

973
      pos_byte = CHAR_TO_BYTE (XINT (pos));
974
    }
Karl Heuer's avatar
Karl Heuer committed
975 976 977

  if (!NILP (current_buffer->enable_multibyte_characters))
    {
978 979
      DEC_POS (pos_byte);
      XSETFASTINT (val, FETCH_CHAR (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
980 981 982
    }
  else
    {
983 984
      pos_byte--;
      XSETFASTINT (val, FETCH_BYTE (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
985 986 987
    }
   return val;
}
Jim Blandy's avatar
Jim Blandy committed
988

Morten Welinder's avatar
Morten Welinder committed
989
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
990 991
  "Return the name under which the user logged in, as a string.\n\
This is based on the effective uid, not the real uid.\n\
992
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
993 994 995 996 997
that determines the value of this function.\n\n\
If optional argument UID is an integer, return the login name of the user\n\
with that uid, or nil if there is no such user.")
  (uid)
     Lisp_Object uid;
Jim Blandy's avatar
Jim Blandy committed
998
{
Morten Welinder's avatar
Morten Welinder committed
999 1000
  struct passwd *pw;

1001 1002 1003
  /* Set up the user name info if we didn't do it before.
     (That can happen if Emacs is dumpable
     but you decide to run `temacs -l loadup' and not dump.  */
1004
  if (INTEGERP (Vuser_login_name))
1005
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
1006 1007

  if (NILP (uid))
1008
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
1009 1010 1011 1012

  CHECK_NUMBER (uid, 0);
  pw = (struct passwd *) getpwuid (XINT (uid));
  return (pw ? build_string (pw->pw_name) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
1013 1014 1015 1016 1017
}

DEFUN ("user-real-login-name", Fuser_real_login_name, Suser_real_login_name,
  0, 0, 0,
  "Return the name of the user's real uid, as a string.\n\
1018
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
1019
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
1020 1021
  ()
{
1022 1023 1024
  /* Set up the user name info if we didn't do it before.
     (That can happen if Emacs is dumpable
     but you decide to run `temacs -l loadup' and not dump.  */
1025
  if (INTEGERP (Vuser_login_name))
1026
    init_editfns ();
1027
  return Vuser_real_login_name;