editfns.c 113 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
extern char **environ;
52
extern int use_dialog_box;
53
extern Lisp_Object make_time ();
54
extern void insert_from_buffer ();
55
static int tm_diff ();
56
static void update_buffer_properties ();
57
size_t emacs_strftimeu ();
58
void set_time_zone_rule ();
59 60 61 62

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
63

64 65
Lisp_Object Fuser_full_name ();

66 67 68 69
/* 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
70 71 72
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
73 74 75
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
76 77 78 79

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
80
  char *user_name;
81
  register unsigned char *p;
Jim Blandy's avatar
Jim Blandy committed
82 83 84 85
  struct passwd *pw;	/* password entry for the current user */
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
86
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
87 88 89 90 91 92 93 94

#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
95 96 97 98
#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.)  */
99
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
100
#else
101
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
102
#endif
Jim Blandy's avatar
Jim Blandy committed
103

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

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

141
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
142

143
  len = CHAR_STRING (XFASTINT (character), str);
144
  return make_string_from_bytes (str, 1, len);
Jim Blandy's avatar
Jim Blandy committed
145 146 147
}

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

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

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
210 211 212 213
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.")
214 215
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
216
{
Karl Heuer's avatar
Karl Heuer committed
217 218
  int pos;

219 220
  if (MARKERP (position)
      && current_buffer == XMARKER (position)->buffer)
221 222 223 224 225 226 227 228 229 230 231 232
    {
      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;
    }

233
  CHECK_NUMBER_COERCE_MARKER (position, 0);
Jim Blandy's avatar
Jim Blandy committed
234

Karl Heuer's avatar
Karl Heuer committed
235 236
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  SET_PT (pos);
237
  return position;
Jim Blandy's avatar
Jim Blandy committed
238 239 240 241 242 243
}

static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
244
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
245
  register Lisp_Object m;
246 247 248
  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
249
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
250
  if (NILP (m)) error ("There is no region now");
251 252
  if ((PT < XFASTINT (m)) == beginningp)
    return (make_number (PT));
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278
  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;
}
279

280 281
/* Return nonzero if POS1 and POS2 have the same value
   for the text property PROP.  */
282 283 284 285 286 287 288 289 290 291 292 293 294 295

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

296 297 298 299 300
/* 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.  */

301 302 303 304 305 306 307
static int
text_property_stickiness (prop, pos)
     Lisp_Object prop;
     Lisp_Object pos;
{
  Lisp_Object front_sticky;

308 309
  if (XINT (pos) > BEGV)
    /* Consider previous character.  */
310 311 312
    {
      Lisp_Object prev_pos, rear_non_sticky;

313
      prev_pos = make_number (XINT (pos) - 1);
314 315 316 317 318 319
      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
320
	   any front-stickiness, PROP is inherited from before.  */
321 322 323
	return -1;
    }

324
  /* Consider following character.  */
325 326 327 328 329
  front_sticky = Fget_text_property (pos, Qfront_sticky, Qnil);

  if (EQ (front_sticky, Qt)
      || (CONSP (front_sticky)
	  && Fmemq (prop, front_sticky)))
330
    /* PROP is inherited from after.  */
331 332
    return 1;

333
  /* PROP is not inherited from either side.  */
334 335 336
  return 0;
}

337
/* Symbol for the text property used to mark fields.  */
338 339
Lisp_Object Qfield;

340 341 342 343
/* 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
344 345 346
   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
347 348 349 350 351
   field, this behavior is sometimes useful).

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

352 353 354 355 356 357
void
find_field (pos, merge_at_boundary, beg, end)
     Lisp_Object pos;
     Lisp_Object merge_at_boundary;
     int *beg, *end;
{
358 359 360 361
  /* 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;
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
  
  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);
380 381
      before_field = Fget_text_property (make_number (XINT (pos) - 1),
					 Qfield, Qnil);
382 383 384 385

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

388 389 390 391 392
	  if (stickiness > 0)
	    at_field_start = 1;
	  else if (stickiness < 0)
	    at_field_end = 1;
	  else
393 394 395
	    /* 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
396
	       kind of "stickiness by default").  */
397 398
	    {
	      if (NILP (before_field))
399
		at_field_end = 1; /* Sticks to the left.  */
400
	      else if (NILP (after_field))
401
		at_field_start = 1; /* Sticks to the right.  */
402 403 404 405 406 407
	    }
	}
    }

  if (beg)
    {
408
      if (at_field_start)
409 410 411 412 413 414 415 416
	/* 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);
417
	  *beg = NILP (prev) ? BEGV : XFASTINT (prev);
418 419 420 421 422
	}
    }

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

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\
454
If POS is nil, the value of point is used for POS.")
455 456 457 458 459 460 461 462 463 464 465
  (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\
466
If POS is nil, the value of point is used for POS.")
467 468 469 470 471 472 473 474 475 476 477
  (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\
478 479
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\
480 481 482 483 484 485 486 487 488 489 490 491
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\
492 493
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\
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 572 573 574 575 576
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;
}

577 578 579 580 581
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\
582 583 584 585
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.")
586 587 588
  (n)
     Lisp_Object n;
{
589
  register int orig, orig_byte, end;
590 591 592 593 594 595 596

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

  orig = PT;
597
  orig_byte = PT_BYTE;
598 599
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
600

601
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
602

603
  /* Return END constrained to the current input field.  */
604 605 606 607 608
  if (NILP (Vinhibit_field_text_motion))
    end = Fconstrain_to_field (make_number (end), make_number (orig),
				XINT (n) != 1 ? Qt : Qnil,
				Qt);
  return end;
609 610 611 612 613 614 615 616 617 618 619
}

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;
{
620 621 622
  int end_pos;
  register int orig = PT;

623 624 625 626 627
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

628 629 630
  end_pos = find_before_next_newline (orig, 0, XINT (n) - (XINT (n) <= 0));

  /* Return END_POS constrained to the current input field.  */
631 632 633 634
  if (NILP (Vinhibit_field_text_motion))
    end_pos = Fconstrain_to_field (make_number (end_pos), make_number (orig),
				   Qnil, Qt);
  return end_pos;
635 636
}

Jim Blandy's avatar
Jim Blandy committed
637 638 639
Lisp_Object
save_excursion_save ()
{
640 641
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
642 643

  return Fcons (Fpoint_marker (),
644
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
645 646
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
647 648 649 650
}

Lisp_Object
save_excursion_restore (info)
651
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
652
{
653 654
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658 659 660

  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
661
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
662
    return Qnil;
663 664 665 666

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

Jim Blandy's avatar
Jim Blandy committed
667 668 669 670 671
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
672
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
673
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
674
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
675 676
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
677 678 679 680
#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.  */
681 682
  tem1 = Fcar (tem);
  if (!NILP (tem1)
683
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
684
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
685
#endif /* 0 */
686 687 688

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

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
724 725 726 727 728 729 730 731 732 733 734 735 736 737

  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;

738
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
739

Jim Blandy's avatar
Jim Blandy committed
740 741 742 743
  val = Fprogn (args);
  return unbind_to (count, val);
}

744 745 746 747 748
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
749
{
750 751
  if (NILP (buffer))
    return make_number (Z - BEG);
752 753 754 755 756 757
  else
    {
      CHECK_BUFFER (buffer, 1);
      return make_number (BUF_Z (XBUFFER (buffer))
			  - BUF_BEG (XBUFFER (buffer)));
    }
Jim Blandy's avatar
Jim Blandy committed
758 759 760 761
}

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
762
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
763 764 765
  ()
{
  Lisp_Object temp;
766
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
767 768 769 770 771
  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
772
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
773 774
  ()
{
775
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
776 777 778 779
}

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
780 781
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
782 783 784
  ()
{
  Lisp_Object temp;
785
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
786 787 788 789 790
  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
791 792
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
793 794
  ()
{
795
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
796 797
}

798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817
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;
}

818
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
819 820
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
821
  (position)
822
     Lisp_Object position;
823
{
824
  CHECK_NUMBER_COERCE_MARKER (position, 1);
825 826
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
827
  return make_number (CHAR_TO_BYTE (XINT (position)));
828
}
829 830

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
831 832
  "Return the character position for byte position BYTEPOS.\n\
If BYTEPOS is out of range, the value is nil.")
833 834 835 836
  (bytepos)
     Lisp_Object bytepos;
{
  CHECK_NUMBER (bytepos, 1);
837 838
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
839 840
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
841

Jim Blandy's avatar
Jim Blandy committed
842 843
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
844 845 846 847
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
848 849 850
  ()
{
  Lisp_Object temp;
851
  if (PT >= ZV)
852
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
853
  else
854
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
855 856 857
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
858 859
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
860 861 862 863
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
864 865 866
  ()
{
  Lisp_Object temp;
867
  if (PT <= BEGV)
868
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
869 870
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
871
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
872 873 874
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
875
  else
876
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
877 878 879 880
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
881
  "Return t if point is at the beginning of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
882 883 884
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
885
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
886 887 888 889 890
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
891
  "Return t if point is at the end of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
892 893 894
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
895
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
896 897 898 899 900
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
901
  "Return t if point is at the beginning of a line.")
Jim Blandy's avatar
Jim Blandy committed
902 903
  ()
{
904
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
905 906 907 908 909
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
910
  "Return t if point is at the end of a line.\n\
Jim Blandy's avatar
Jim Blandy committed
911 912 913
`End of a line' includes point being at the end of the buffer.")
  ()
{
914
  if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
Jim Blandy's avatar
Jim Blandy committed
915 916 917 918
    return Qt;
  return Qnil;
}

919
DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
920 921
  "Return character in current buffer at position POS.\n\
POS is an integer or a buffer pointer.\n\
922
If POS is out of range, the value is nil.")
Jim Blandy's avatar
Jim Blandy committed
923 924 925
  (pos)
     Lisp_Object pos;
{
926
  register int pos_byte;
Jim Blandy's avatar
Jim Blandy committed
927

928
  if (NILP (pos))
929 930
    {
      pos_byte = PT_BYTE;
931
      XSETFASTINT (pos, PT);
932 933 934
    }

  if (MARKERP (pos))
935 936 937 938 939
    {
      pos_byte = marker_byte_position (pos);
      if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
	return Qnil;
    }
940 941 942
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
943
      if (XINT (pos) < BEGV || XINT (pos) >= ZV)
944
	return Qnil;
945 946
      
      pos_byte = CHAR_TO_BYTE (XINT (pos));
947
    }
Jim Blandy's avatar
Jim Blandy committed
948

949
  return make_number (FETCH_CHAR (pos_byte));
Jim Blandy's avatar
Jim Blandy committed
950
}
Karl Heuer's avatar
Karl Heuer committed
951

952
DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
953 954
  "Return character in current buffer preceding position POS.\n\
POS is an integer or a buffer pointer.\n\
955
If POS is out of range, the value is nil.")
Karl Heuer's avatar
Karl Heuer committed
956 957 958 959
  (pos)
     Lisp_Object pos;
{
  register Lisp_Object val;
960
  register int pos_byte;
Karl Heuer's avatar
Karl Heuer committed
961

962
  if (NILP (pos))
963 964
    {
      pos_byte = PT_BYTE;
965
      XSETFASTINT (pos, PT);
966 967 968
    }

  if (MARKERP (pos))
969 970 971 972 973 974
    {
      pos_byte = marker_byte_position (pos);

      if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
	return Qnil;
    }
975 976 977
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
Karl Heuer's avatar
Karl Heuer committed
978

979
      if (XINT (pos) <= BEGV || XINT (pos) > ZV)
980 981
	return Qnil;

982
      pos_byte = CHAR_TO_BYTE (XINT (pos));
983
    }
Karl Heuer's avatar
Karl Heuer committed
984 985 986

  if (!NILP (current_buffer->enable_multibyte_characters))
    {
987 988
      DEC_POS (pos_byte);
      XSETFASTINT (val, FETCH_CHAR (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
989 990 991
    }
  else
    {
992 993
      pos_byte--;
      XSETFASTINT (val, FETCH_BYTE (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
994 995 996
    }
   return val;
}
Jim Blandy's avatar
Jim Blandy committed
997

Morten Welinder's avatar
Morten Welinder committed
998
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
999 1000
  "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\
1001
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
1002 1003 1004 1005 1006
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
1007
{
Morten Welinder's avatar
Morten Welinder committed
1008 1009
  struct passwd *pw;

1010 1011 1012
  /* 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.  */
1013
  if (INTEGERP (Vuser_login_name))
1014
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
1015 1016

  if (NILP (uid))
1017
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
1018 1019 1020 1021

  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
1022 1023 1024 1025 1026
}

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\
1027
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
1028
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
1029 1030
  ()
{
1031 1032 1033
  /* 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.  */
1034
  if (INTEGERP (Vuser_login_name))
1035
    init_editfns ();
1036
  return Vuser_real_login_name;
Jim Blandy's avatar
Jim Blandy committed
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
}

DEFUN ("user-uid", Fuser_uid, Suser_uid, 0, 0, 0,
  "Return the effective uid of Emacs, as an integer.")
  ()
{
  return make_number (geteuid ());
}

DEFUN ("user-real-uid", Fuser_real_uid, Suser_real_uid, 0, 0, 0,
  "Return the real uid of Emacs, as an integer.")
  ()
{
  return make_number (getuid ());
}

1053 1054
DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 1, 0,
  "Return the full name of the user logged in, as a string.\n\
Karl Heuer's avatar
Karl Heuer committed
1055 1056 1057
If the full name corresponding to Emacs's userid is not known,\n\
return \"unknown\".\n\
\n\
1058
If optional argument UID is an integer, return the full name of the user\n\
Karl Heuer's avatar
Karl Heuer committed
1059
with that uid, or nil if there is no such user.\n\
1060
If UID is a string, return the full name of the user with that login\n\
Karl Heuer's avatar
Karl Heuer committed
1061
name, or nil if there is no such user.")
1062 1063
  (uid)
     Lisp_Object uid;
Jim Blandy's avatar
Jim Blandy committed
1064
{
1065
  struct passwd *pw;
1066
  register unsigned char *p, *q;
1067 1068
  extern char *index ();
  Lisp_Object full;
1069 1070

  if (NILP (uid))
1071 1072 1073 1074 1075 1076 1077
    return Vuser_full_name; 
  else if (NUMBERP (uid))
    pw = (struct passwd *) getpwuid (XINT (uid));
  else if (STRINGP (uid)) 
    pw = (struct passwd *) getpwnam (XSTRING (uid)->data);
  else
    error ("Invalid UID specification");
1078

1079
  if (!pw)
1080
    return Qnil;
1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092
  
  p = (unsigned char *) USER_FULL_NAME;
  /* Chop off everything after the first comma. */
  q = (unsigned char *) index (p, ',');
  full = make_string (p, q ? q - p : strlen (p));
  
#ifdef AMPERSAND_FULL_NAME
  p = XSTRING (full)->data;
  q = (unsigned char *) index (p, '&');
  /* Substitute the login name for the &, upcasing the first character.  */
  if (q)
    {
1093
      register unsigned char *r;
1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107
      Lisp_Object login;

      login = Fuser_login_name (make_number (pw->pw_uid));
      r = (unsigned char *) alloca (strlen (p) + XSTRING (login)->size + 1);
      bcopy (p, r, q - p);
      r[q - p] = 0;
      strcat (r, XSTRING (login)->data);
      r[q - p] = UPCASE (r[q - p]);
      strcat (r, q + 1);
      full = build_string (r);
    }
#endif /* AMPERSAND_FULL_NAME */

  return full;
Jim Blandy's avatar
Jim Blandy committed
1108 1109 1110 1111 1112 1113 1114 1115 1116
}

DEFUN ("system-name", Fsystem_name, Ssystem_name, 0, 0, 0,
  "Return the name of the machine you are running on, as a string.")
  ()
{
  return Vsystem_name;
}

1117 1118 1119 1120
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
1121 1122 1123 1124
  if (STRINGP (Vsystem_name))
    return (char *) XSTRING (Vsystem_name)->data;
  else
    return "";
1125 1126
}

1127 1128 1129 1130 1131 1132 1133
DEFUN ("emacs-pid", Femacs_pid, Semacs_pid, 0, 0, 0,
  "Return the process ID of Emacs, as an integer.")
  ()
{
  return make_number (getpid ());
}

Jim Blandy's avatar
Jim Blandy committed
1134
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
1135
  "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
Jim Blandy's avatar
Jim Blandy committed
1136 1137 1138 1139 1140 1141 1142
The time is returned as a list of three integers.  The first has the\n\
most significant 16 bits of the seconds, while the second has the\n\
least significant 16 bits.  The third integer gives the microsecond\n\
count.\n\
\n\
The microsecond count is zero on systems that do not provide\n\
resolution finer than a second.")
Jim Blandy's avatar
Jim Blandy committed
1143 1144
  ()
{
Jim Blandy's avatar
Jim Blandy committed
1145 1146 1147 1148
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
1149 1150 1151
  XSETINT (result[0], (EMACS_SECS (t) >> 16) & 0xffff);
  XSETINT (result[1], (EMACS_SECS (t) >> 0)  & 0xffff);
  XSETINT (result[2], EMACS_USECS (t));
Jim Blandy's avatar
Jim Blandy committed
1152 1153

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
1154 1155 1156
}


1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169
static int
lisp_time_argument (specified_time, result)
     Lisp_Object specified_time;
     time_t *result;
{
  if (NILP (specified_time))
    return time (result) != -1;
  else
    {
      Lisp_Object high, low;
      high = Fcar (specified_time);
      CHECK_NUMBER (high, 0);
      low = Fcdr (specified_time);
1170
      if (CONSP (low))
1171 1172 1173 1174 1175 1176 1177
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

Paul Eggert's avatar
Paul Eggert committed
1178 1179
/* Write information into buffer S of size MAXSIZE, according to the
   FORMAT of length FORMAT_LEN, using time information taken from *TP.
1180
   Default to Universal Time if UT is nonzero, local time otherwise.
Paul Eggert's avatar
Paul Eggert committed
1181 1182 1183 1184 1185
   Return the number of bytes written, not including the terminating
   '\0'.  If S is NULL, nothing will be written anywhere; so to
   determine how many bytes would be written, use NULL for S and
   ((size_t) -1) for MAXSIZE.

1186
   This function behaves like emacs_strftimeu, except it allows null
Paul Eggert's avatar
Paul Eggert committed
1187 1188
   bytes in FORMAT.  */
static size_t
1189
emacs_memftimeu (s, maxsize, format, format_len, tp, ut)
Paul Eggert's avatar
Paul Eggert committed
1190 1191 1192 1193 1194
      char *s;
      size_t maxsize;
      const char *format;
      size_t format_len;
      const struct tm *tp;
1195
      int ut;
Paul Eggert's avatar
Paul Eggert committed
1196 1197 1198
{
  size_t total = 0;

1199 1200 1201
  /* Loop through all the null-terminated strings in the format
     argument.  Normally there's just one null-terminated string, but
     there can be arbitrarily many, concatenated together, if the
1202
     format contains '\0' bytes.  emacs_strftimeu stops at the first
1203
     '\0' byte so we must invoke it separately for each such string.  */
Paul Eggert's avatar
Paul Eggert committed
1204 1205 1206 1207 1208 1209 1210 1211
  for (;;)
    {
      size_t len;
      size_t result;

      if (s)
	s[0] = '\1';

1212
      result = emacs_strftimeu (s, maxsize, format, tp, ut);
Paul Eggert's avatar
Paul Eggert committed
1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231

      if (s)
	{
	  if (result == 0 && s[0] != '\0')
	    return 0;
	  s += result + 1;
	}

      maxsize -= result + 1;
      total += result;
      len = strlen (format);
      if (len == format_len)
	return total;
      total++;
      format += len + 1;
      format_len -= len + 1;
    }
}

1232
/*
1233 1234 1235 1236 1237 1238 1239 1240
DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
  "Use FORMAT-STRING to format the time TIME, or now if omitted.\n\
TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as returned by\n\
`current-time' or `file-attributes'.\n\
The third, optional, argument UNIVERSAL, if non-nil, means describe TIME\n\
as Universal Time; nil means describe TIME in the local time zone.\n\
The value is a copy of FORMAT-STRING, but with certain constructs replaced\n\
by text that describes the specified date and time in TIME:\n\
1241
\n\
1242 1243
%Y is the year, %y within the century, %C the century.\n\
%G is the year corresponding to the ISO week, %g within the century.\n\
Paul Eggert's avatar
Paul Eggert committed
1244 1245
%m is the numeric month.\n\
%b and %h are the locale's abbreviated month name, %B the full name.\n\
1246 1247
%d is the day of the month, zero-padded, %e is blank-padded.\n\
%u is the numeric day of week from 1 (Monday) to 7, %w from 0 (Sunday) to 6.\n\
Paul Eggert's avatar
Paul Eggert committed
1248
%a is the locale's abbreviated name of the day of week, %A the full name.\n\
1249 1250 1251 1252