editfns.c 77.2 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985,86,87,89,93,94,95 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 23
#include <sys/types.h>

24
#include <config.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

Jim Blandy's avatar
Jim Blandy committed
32
#include "lisp.h"
33
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
34 35 36
#include "buffer.h"
#include "window.h"

Jim Blandy's avatar
Jim Blandy committed
37
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
38 39 40 41

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

42 43
extern char **environ;
extern Lisp_Object make_time ();
44
extern void insert_from_buffer ();
45
static int tm_diff ();
46
static void update_buffer_properties ();
47
void set_time_zone_rule ();
48 49 50 51

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
52

Jim Blandy's avatar
Jim Blandy committed
53 54 55
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
56 57 58
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
59 60 61 62

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
63
  char *user_name;
Jim Blandy's avatar
Jim Blandy committed
64 65 66 67 68 69
  register unsigned char *p, *q, *r;
  struct passwd *pw;	/* password entry for the current user */
  extern char *index ();
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
70
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
71 72 73 74 75 76 77 78

#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
79 80 81 82
#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.)  */
83
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
84
#else
85
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
86
#endif
Jim Blandy's avatar
Jim Blandy committed
87

Jim Blandy's avatar
Jim Blandy committed
88 89
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
90
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
91
  if (!user_name)
92 93 94
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
95
    user_name = (char *) getenv ("USER");
96
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
97 98 99 100 101
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
102
  Vuser_login_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
103

Jim Blandy's avatar
Jim Blandy committed
104 105
  /* If the user name claimed in the environment vars differs from
     the real uid, use the claimed name to find the full name.  */
106
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
Jim Blandy's avatar
Jim Blandy committed
107
  if (NILP (tem))
108
    pw = (struct passwd *) getpwnam (XSTRING (Vuser_login_name)->data);
Jim Blandy's avatar
Jim Blandy committed
109 110 111 112 113 114 115
  
  p = (unsigned char *) (pw ? USER_FULL_NAME : "unknown");
  q = (unsigned char *) index (p, ',');
  Vuser_full_name = make_string (p, q ? q - p : strlen (p));
  
#ifdef AMPERSAND_FULL_NAME
  p = XSTRING (Vuser_full_name)->data;
116
  q = (unsigned char *) index (p, '&');
Jim Blandy's avatar
Jim Blandy committed
117 118 119
  /* Substitute the login name for the &, upcasing the first character.  */
  if (q)
    {
120 121
      r = (unsigned char *) alloca (strlen (p)
				    + XSTRING (Vuser_login_name)->size + 1);
Jim Blandy's avatar
Jim Blandy committed
122 123
      bcopy (p, r, q - p);
      r[q - p] = 0;
124
      strcat (r, XSTRING (Vuser_login_name)->data);
Jim Blandy's avatar
Jim Blandy committed
125 126 127 128 129
      r[q - p] = UPCASE (r[q - p]);
      strcat (r, q + 1);
      Vuser_full_name = build_string (r);
    }
#endif /* AMPERSAND_FULL_NAME */
130

131
  p = (unsigned char *) getenv ("NAME");
132 133
  if (p)
    Vuser_full_name = build_string (p);
Jim Blandy's avatar
Jim Blandy committed
134 135 136
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
137 138 139
  "Convert arg CHARACTER to a one-character string containing that character.")
  (character)
     Lisp_Object character;
Jim Blandy's avatar
Jim Blandy committed
140 141
{
  char c;
142
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
143

144
  c = XINT (character);
Jim Blandy's avatar
Jim Blandy committed
145 146 147 148 149
  return make_string (&c, 1);
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
  "Convert arg STRING to a character, the first character of that string.")
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
  CHECK_STRING (string, 0);
Jim Blandy's avatar
Jim Blandy committed
156

157
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
158
  if (p->size)
159
    XSETFASTINT (val, ((unsigned char *) p->data)[0]);
Jim Blandy's avatar
Jim Blandy committed
160
  else
161
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180
  return val;
}

static Lisp_Object
buildmark (val)
     int val;
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
  Fset_marker (mark, make_number (val), Qnil);
  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;
181
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
182 183 184 185 186 187 188
  return temp;
}

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

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\
Beginning of buffer is position (point-min), end is (point-max).")
207 208
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
209
{
210
  CHECK_NUMBER_COERCE_MARKER (position, 0);
Jim Blandy's avatar
Jim Blandy committed
211

212 213
  SET_PT (clip_to_bounds (BEGV, XINT (position), ZV));
  return position;
Jim Blandy's avatar
Jim Blandy committed
214 215 216 217 218 219
}

static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
220
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
221
  register Lisp_Object m;
222 223 224
  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
225
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
226
  if (NILP (m)) error ("There is no region now");
227 228
  if ((PT < XFASTINT (m)) == beginningp)
    return (make_number (PT));
Jim Blandy's avatar
Jim Blandy committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254
  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;
}
255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275

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\
This function does not move point.")
  (n)
     Lisp_Object n;
{
  register int orig, end;

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

  orig = PT;
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
  SET_PT (orig);
Jim Blandy's avatar
Jim Blandy committed
276

277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297
  return make_number (end);
}

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;
{
  if (NILP (n))
    XSETFASTINT (n, 1);
  else
    CHECK_NUMBER (n, 0);

  return make_number (find_before_next_newline 
		      (PT, 0, XINT (n) - (XINT (n) <= 0)));
}

Jim Blandy's avatar
Jim Blandy committed
298 299 300
Lisp_Object
save_excursion_save ()
{
301 302
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
303 304

  return Fcons (Fpoint_marker (),
305
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
306 307
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
308 309 310 311
}

Lisp_Object
save_excursion_restore (info)
312
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
313
{
314 315
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321

  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
322
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
323
    return Qnil;
324 325 326 327

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

Jim Blandy's avatar
Jim Blandy committed
328 329 330 331 332
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
333
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
334
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
335
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
336 337
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
338 339 340 341
#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.  */
342 343
  tem1 = Fcar (tem);
  if (!NILP (tem1)
344
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
345
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
346
#endif /* 0 */
347 348 349

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
350 351
  if (!NILP (Vrun_hooks))
    {
352 353
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
354
      if (! NILP (current_buffer->mark_active))
355 356 357 358 359
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
360 361 362
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
363
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
364 365 366 367 368 369 370
  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\
371 372
even in case of abnormal exit (throw or error).\n\
The state of activation of the mark is also restored.")
Jim Blandy's avatar
Jim Blandy committed
373 374 375 376 377 378 379
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

  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;

  record_unwind_protect (Fset_buffer, Fcurrent_buffer ());

Jim Blandy's avatar
Jim Blandy committed
396 397 398 399 400 401 402 403 404
  val = Fprogn (args);
  return unbind_to (count, val);
}

DEFUN ("buffer-size", Fbufsize, Sbufsize, 0, 0, 0,
  "Return the number of characters in the current buffer.")
  ()
{
  Lisp_Object temp;
405
  XSETFASTINT (temp, Z - BEG);
Jim Blandy's avatar
Jim Blandy committed
406 407 408 409 410
  return temp;
}

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
411
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
412 413 414
  ()
{
  Lisp_Object temp;
415
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
416 417 418 419 420
  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
421
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
422 423 424 425 426 427 428
  ()
{
  return buildmark (BEGV);
}

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
429 430
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
431 432 433
  ()
{
  Lisp_Object temp;
434
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
435 436 437 438 439
  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
440 441
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
442 443 444 445 446
  ()
{
  return buildmark (ZV);
}

Jim Blandy's avatar
Jim Blandy committed
447 448 449
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
  "Return the character following point, as a number.\n\
At the end of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
450 451 452
  ()
{
  Lisp_Object temp;
453
  if (PT >= ZV)
454
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
455
  else
456
    XSETFASTINT (temp, FETCH_CHAR (PT));
Jim Blandy's avatar
Jim Blandy committed
457 458 459
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
460 461 462
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
  "Return the character preceding point, as a number.\n\
At the beginning of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
463 464 465
  ()
{
  Lisp_Object temp;
466
  if (PT <= BEGV)
467
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
468
  else
469
    XSETFASTINT (temp, FETCH_CHAR (PT - 1));
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474 475 476 477
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
  "Return T if point is at the beginning of the buffer.\n\
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
478
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
479 480 481 482 483 484 485 486 487
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
  "Return T if point is at the end of the buffer.\n\
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
488
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
489 490 491 492 493 494 495 496
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
  "Return T if point is at the beginning of a line.")
  ()
{
497
  if (PT == BEGV || FETCH_CHAR (PT - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503 504 505 506
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
  "Return T if point is at the end of a line.\n\
`End of a line' includes point being at the end of the buffer.")
  ()
{
507
  if (PT == ZV || FETCH_CHAR (PT) == '\n')
Jim Blandy's avatar
Jim Blandy committed
508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526
    return Qt;
  return Qnil;
}

DEFUN ("char-after", Fchar_after, Schar_after, 1, 1, 0,
  "Return character in current buffer at position POS.\n\
POS is an integer or a buffer pointer.\n\
If POS is out of range, the value is nil.")
  (pos)
     Lisp_Object pos;
{
  register Lisp_Object val;
  register int n;

  CHECK_NUMBER_COERCE_MARKER (pos, 0);

  n = XINT (pos);
  if (n < BEGV || n >= ZV) return Qnil;

527
  XSETFASTINT (val, FETCH_CHAR (n));
Jim Blandy's avatar
Jim Blandy committed
528 529 530
  return val;
}

Morten Welinder's avatar
Morten Welinder committed
531
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
532 533
  "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\
534
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
535 536 537 538 539
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
540
{
Morten Welinder's avatar
Morten Welinder committed
541 542
  struct passwd *pw;

543 544 545
  /* 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.  */
546
  if (INTEGERP (Vuser_login_name))
547
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
548 549

  if (NILP (uid))
550
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
551 552 553 554

  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
555 556 557 558 559
}

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\
560
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
561
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
562 563
  ()
{
564 565 566
  /* 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.  */
567
  if (INTEGERP (Vuser_login_name))
568
    init_editfns ();
569
  return Vuser_real_login_name;
Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585
}

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

586 587 588 589 590 591
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\
If optional argument UID is an integer, return the full 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
592
{
593 594 595 596 597 598 599 600
  struct passwd *pw;

  if (NILP (uid))
    return Vuser_full_name;

  CHECK_NUMBER (uid, 0);
  pw = (struct passwd *) getpwuid (XINT (uid));
  return (pw ? build_string (pw->pw_gecos) : Qnil);
Jim Blandy's avatar
Jim Blandy committed
601 602 603 604 605 606 607 608 609
}

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

610 611 612 613
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
614
  return (char *) XSTRING (Vsystem_name)->data;
615 616
}

617 618 619 620 621 622 623
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
624
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
625
  "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
Jim Blandy's avatar
Jim Blandy committed
626 627 628 629 630 631 632
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
633 634
  ()
{
Jim Blandy's avatar
Jim Blandy committed
635 636 637 638
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
639 640 641
  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
642 643

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
644 645 646
}


647 648 649 650 651 652 653 654 655 656 657 658 659
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);
660
      if (CONSP (low))
661 662 663 664 665 666 667
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

668
DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 2, 0,
669 670 671 672 673 674 675 676
  "Use FORMAT-STRING to format the time TIME.\n\
TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from\n\
`current-time' and `file-attributes'.\n\
FORMAT-STRING may contain %-sequences to substitute parts of the time.\n\
%a is replaced by the abbreviated name of the day of week.\n\
%A is replaced by the full name of the day of week.\n\
%b is replaced by the abbreviated name of the month.\n\
%B is replaced by the full name of the month.\n\
Karl Heuer's avatar
Karl Heuer committed
677
%c stands for the preferred date/time format of the C locale.\n\
678 679 680 681 682 683 684 685 686 687
%d is replaced by the day of month, zero-padded.\n\
%D is a synonym for \"%m/%d/%y\".\n\
%e is replaced by the day of month, blank-padded.\n\
%h is a synonym for \"%b\".\n\
%H is replaced by the hour (00-23).\n\
%I is replaced by the hour (00-12).\n\
%j is replaced by the day of the year (001-366).\n\
%k is replaced by the hour (0-23), blank padded.\n\
%l is replaced by the hour (1-12), blank padded.\n\
%m is replaced by the month (01-12).\n\
688
%M is replaced by the minute (00-59).\n\
689 690 691 692
%n is a synonym for \"\\n\".\n\
%p is replaced by AM or PM, as appropriate.\n\
%r is a synonym for \"%I:%M:%S %p\".\n\
%R is a synonym for \"%H:%M\".\n\
693
%S is replaced by the second (00-60).\n\
694 695
%t is a synonym for \"\\t\".\n\
%T is a synonym for \"%H:%M:%S\".\n\
696
%U is replaced by the week of the year (00-53), first day of week is Sunday.\n\
697
%w is replaced by the day of week (0-6), Sunday is day 0.\n\
698
%W is replaced by the week of the year (00-53), first day of week is Monday.\n\
699 700 701 702 703 704
%x is a locale-specific synonym, which defaults to \"%D\" in the C locale.\n\
%X is a locale-specific synonym, which defaults to \"%T\" in the C locale.\n\
%y is replaced by the year without century (00-99).\n\
%Y is replaced by the year with century.\n\
%Z is replaced by the time zone abbreviation.\n\
\n\
705
The number of options reflects the `strftime' function.")
706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  (format_string, time)
     Lisp_Object format_string, time;
{
  time_t value;
  int size;

  CHECK_STRING (format_string, 1);

  if (! lisp_time_argument (time, &value))
    error ("Invalid time specification");

  /* This is probably enough.  */
  size = XSTRING (format_string)->size * 6 + 50;

  while (1)
    {
      char *buf = (char *) alloca (size);
723
      *buf = 1;
724
      if (emacs_strftime (buf, size, XSTRING (format_string)->data,
725 726
			  localtime (&value))
	  || !*buf)
727 728 729 730 731 732
	return build_string (buf);
      /* If buffer was too small, make it bigger.  */
      size *= 2;
    }
}

733 734 735 736 737
DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
  "Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).\n\
The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)\n\
or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'\n\
to use the current time.  The list has the following nine members:\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
738 739
SEC is an integer between 0 and 60; SEC is 60 for a leap second, which\n\
only some operating systems support.  MINUTE is an integer between 0 and 59.\n\
740 741 742 743 744
HOUR is an integer between 0 and 23.  DAY is an integer between 1 and 31.\n\
MONTH is an integer between 1 and 12.  YEAR is an integer indicating the\n\
four-digit year.  DOW is the day of week, an integer between 0 and 6, where\n\
0 is Sunday.  DST is t if daylight savings time is effect, otherwise nil.\n\
ZONE is an integer indicating the number of seconds east of Greenwich.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
745
\(Note that Common Lisp has different meanings for DOW and ZONE.)")
746 747 748 749
  (specified_time)
     Lisp_Object specified_time;
{
  time_t time_spec;
750
  struct tm save_tm;
751 752 753 754 755 756 757
  struct tm *decoded_time;
  Lisp_Object list_args[9];
  
  if (! lisp_time_argument (specified_time, &time_spec))
    error ("Invalid time specification");

  decoded_time = localtime (&time_spec);
758 759 760 761 762
  XSETFASTINT (list_args[0], decoded_time->tm_sec);
  XSETFASTINT (list_args[1], decoded_time->tm_min);
  XSETFASTINT (list_args[2], decoded_time->tm_hour);
  XSETFASTINT (list_args[3], decoded_time->tm_mday);
  XSETFASTINT (list_args[4], decoded_time->tm_mon + 1);
763
  XSETINT (list_args[5], decoded_time->tm_year + 1900);
764
  XSETFASTINT (list_args[6], decoded_time->tm_wday);
765
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
766 767 768 769 770 771 772

  /* Make a copy, in case gmtime modifies the struct.  */
  save_tm = *decoded_time;
  decoded_time = gmtime (&time_spec);
  if (decoded_time == 0)
    list_args[8] = Qnil;
  else
773
    XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
774 775 776
  return Flist (9, list_args);
}

777
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
778
  "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
779 780
This is the reverse operation of `decode-time', which see.\n\
ZONE defaults to the current time zone rule.  This can\n\
781
be a string or t (as from `set-time-zone-rule'), or it can be a list\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
782
\(as from `current-time-zone') or an integer (as from `decode-time')\n\
783
applied without consideration for daylight savings time.\n\
784 785 786 787 788 789
\n\
You can pass more than 7 arguments; then the first six arguments\n\
are used as SECOND through YEAR, and the *last* argument is used as ZONE.\n\
The intervening arguments are ignored.\n\
This feature lets (apply 'encode-time (decode-time ...)) work.\n\
\n\
790 791
Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;\n\
for example, a DAY of 0 means the day preceding the given month.\n\
792
Year numbers less than 100 are treated just like other year numbers.\n\
793
If you want them to stand for years in this century, you must do that yourself.")
794 795 796
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
797
{
798
  time_t time;
799
  struct tm tm;
800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
  Lisp_Object zone = (nargs > 6)? args[nargs - 1] : Qnil;

  CHECK_NUMBER (args[0], 0);	/* second */
  CHECK_NUMBER (args[1], 1);	/* minute */
  CHECK_NUMBER (args[2], 2);	/* hour */
  CHECK_NUMBER (args[3], 3);	/* day */
  CHECK_NUMBER (args[4], 4);	/* month */
  CHECK_NUMBER (args[5], 5);	/* year */

  tm.tm_sec = XINT (args[0]);
  tm.tm_min = XINT (args[1]);
  tm.tm_hour = XINT (args[2]);
  tm.tm_mday = XINT (args[3]);
  tm.tm_mon = XINT (args[4]) - 1;
  tm.tm_year = XINT (args[5]) - 1900;
815 816 817 818
  tm.tm_isdst = -1;

  if (CONSP (zone))
    zone = Fcar (zone);
819
  if (NILP (zone))
820 821
    time = mktime (&tm);
  else
822
    {
823 824 825 826
      char tzbuf[100];
      char *tzstring;
      char **oldenv = environ, **newenv;
      
827 828 829
      if (zone == Qt)
	tzstring = "UTC0";
      else if (STRINGP (zone))
830
	tzstring = (char *) XSTRING (zone)->data;
831
      else if (INTEGERP (zone))
832
	{
833 834 835 836
	  int abszone = abs (XINT (zone));
	  sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
		   abszone / (60*60), (abszone/60) % 60, abszone % 60);
	  tzstring = tzbuf;
837
	}
838 839 840 841 842 843 844 845 846 847 848 849
      else
	error ("Invalid time zone specification");

      /* Set TZ before calling mktime; merely adjusting mktime's returned 
	 value doesn't suffice, since that would mishandle leap seconds.  */
      set_time_zone_rule (tzstring);

      time = mktime (&tm);

      /* Restore TZ to previous value.  */
      newenv = environ;
      environ = oldenv;
850
      xfree (newenv);
851 852 853
#ifdef LOCALTIME_CACHE
      tzset ();
#endif
854 855
    }

856 857 858 859
  if (time == (time_t) -1)
    error ("Specified time is not representable");

  return make_time (time);
860 861
}

862
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
863
  "Return the current time, as a human-readable string.\n\
864 865 866 867 868 869 870 871 872 873 874 875 876
Programs can use this function to decode a time,\n\
since the number of columns in each field is fixed.\n\
The format is `Sun Sep 16 01:03:52 1973'.\n\
If an argument is given, it specifies a time to format\n\
instead of the current time.  The argument should have the form:\n\
  (HIGH . LOW)\n\
or the form:\n\
  (HIGH LOW . IGNORED).\n\
Thus, you can use times obtained from `current-time'\n\
and from `file-attributes'.")
  (specified_time)
     Lisp_Object specified_time;
{
877
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
878
  char buf[30];
879 880
  register char *tem;

881 882
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
883
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
884 885 886 887 888 889

  strncpy (buf, tem, 24);
  buf[24] = 0;

  return build_string (buf);
}
890

891
#define TM_YEAR_BASE 1900
892

893 894 895 896
/* Yield A - B, measured in seconds.
   This function is copied from the GNU C Library.  */
static int
tm_diff (a, b)
897 898
     struct tm *a, *b;
{
899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
  /* Compute intervening leap days correctly even if year is negative.
     Take care to avoid int overflow in leap day calculations,
     but it's OK to assume that A and B are close to each other.  */
  int a4 = (a->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (a->tm_year & 3);
  int b4 = (b->tm_year >> 2) + (TM_YEAR_BASE >> 2) - ! (b->tm_year & 3);
  int a100 = a4 / 25 - (a4 % 25 < 0);
  int b100 = b4 / 25 - (b4 % 25 < 0);
  int a400 = a100 >> 2;
  int b400 = b100 >> 2;
  int intervening_leap_days = (a4 - b4) - (a100 - b100) + (a400 - b400);
  int years = a->tm_year - b->tm_year;
  int days = (365 * years + intervening_leap_days
	      + (a->tm_yday - b->tm_yday));
  return (60 * (60 * (24 * days + (a->tm_hour - b->tm_hour))
		+ (a->tm_min - b->tm_min))
Karl Heuer's avatar
Karl Heuer committed
914
	  + (a->tm_sec - b->tm_sec));
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929
}

DEFUN ("current-time-zone", Fcurrent_time_zone, Scurrent_time_zone, 0, 1, 0,
  "Return the offset and name for the local time zone.\n\
This returns a list of the form (OFFSET NAME).\n\
OFFSET is an integer number of seconds ahead of UTC (east of Greenwich).\n\
    A negative value means west of Greenwich.\n\
NAME is a string giving the name of the time zone.\n\
If an argument is given, it specifies when the time zone offset is determined\n\
instead of using the current time.  The argument should have the form:\n\
  (HIGH . LOW)\n\
or the form:\n\
  (HIGH LOW . IGNORED).\n\
Thus, you can use times obtained from `current-time'\n\
and from `file-attributes'.\n\
930 931
\n\
Some operating systems cannot provide all this information to Emacs;\n\
932
in this case, `current-time-zone' returns a list containing nil for\n\
933
the data it can't find.")
934 935
  (specified_time)
     Lisp_Object specified_time;
936
{
937 938
  time_t value;
  struct tm *t;
939

940
  if (lisp_time_argument (specified_time, &value)
941
      && (t = gmtime (&value)) != 0)
942
    {
943
      struct tm gmt;
944
      int offset;
945
      char *s, buf[6];
946 947 948

      gmt = *t;		/* Make a copy, in case localtime modifies *t.  */
      t = localtime (&value);
949
      offset = tm_diff (t, &gmt);
950 951 952
      s = 0;
#ifdef HAVE_TM_ZONE
      if (t->tm_zone)
953
	s = (char *)t->tm_zone;
954 955 956 957
#else /* not HAVE_TM_ZONE */
#ifdef HAVE_TZNAME
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
	s = tzname[t->tm_isdst];
958
#endif
959
#endif /* not HAVE_TM_ZONE */
960 961 962
      if (!s)
	{
	  /* No local time zone name is available; use "+-NNNN" instead.  */
963
	  int am = (offset < 0 ? -offset : offset) / 60;
964 965 966 967 968 969 970
	  sprintf (buf, "%c%02d%02d", (offset < 0 ? '-' : '+'), am/60, am%60);
	  s = buf;
	}
      return Fcons (make_number (offset), Fcons (build_string (s), Qnil));
    }
  else
    return Fmake_list (2, Qnil);
971 972
}

973 974 975 976 977
/* This holds the value of `environ' produced by the previous
   call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
   has never been called.  */
static char **environbuf;

978 979
DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
  "Set the local time zone using TZ, a string specifying a time zone rule.\n\
980 981
If TZ is nil, use implementation-defined default time zone information.\n\
If TZ is t, use Universal Time.")
982 983 984 985 986 987 988
  (tz)
     Lisp_Object tz;
{
  char *tzstring;

  if (NILP (tz))
    tzstring = 0;
989 990
  else if (tz == Qt)
    tzstring = "UTC0";
991 992 993
  else
    {
      CHECK_STRING (tz, 0);
994
      tzstring = (char *) XSTRING (tz)->data;
995 996
    }

997 998 999 1000 1001 1002 1003 1004
  set_time_zone_rule (tzstring);
  if (environbuf)
    free (environbuf);
  environbuf = environ;

  return Qnil;
}

1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015
/* These two values are known to load tz files in buggy implementations.
   Their values shouldn't matter in non-buggy implementations.
   We don't use string literals for these strings, 
   since if a string in the environment is in readonly
   storage, it runs afoul of bugs in SVR4 and Solaris 2.3.
   See Sun bugs 1113095 and 1114114, ``Timezone routines
   improperly modify environment''.  */

static char set_time_zone_rule_tz1[] = "TZ=GMT0";
static char set_time_zone_rule_tz2[] = "TZ=GMT1";

1016 1017 1018
/* Set the local time zone rule to TZSTRING.
   This allocates memory into `environ', which it is the caller's
   responsibility to free.  */
1019
void
1020 1021 1022 1023 1024 1025
set_time_zone_rule (tzstring)
     char *tzstring;
{
  int envptrs;
  char **from, **to, **newenv;

Richard M. Stallman's avatar
Richard M. Stallman committed
1026
  /* Make the ENVIRON vector longer with room for TZSTRING.  */
1027 1028 1029 1030 1031
  for (from = environ; *from; from++)
    continue;
  envptrs = from - environ + 2;
  newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
				   + (tzstring ? strlen (tzstring) + 4 : 0));
Richard M. Stallman's avatar
Richard M. Stallman committed
1032 1033

  /* Add TZSTRING to the end of environ, as a value for TZ.  */
1034 1035 1036 1037 1038 1039 1040 1041
  if (tzstring)
    {
      char *t = (char *) (to + envptrs);
      strcpy (t, "TZ=");
      strcat (t, tzstring);
      *to++ = t;
    }

Richard M. Stallman's avatar
Richard M. Stallman committed
1042 1043 1044
  /* Copy the old environ vector elements into NEWENV,
     but don't copy the TZ variable.
     So we have only one definition of TZ, which came from TZSTRING.  */
1045 1046 1047 1048 1049 1050 1051
  for (from = environ; *from; from++)
    if (strncmp (*from, "TZ=", 3) != 0)
      *to++ = *from;
  *to = 0;

  environ = newenv;

Richard M. Stallman's avatar
Richard M. Stallman committed
1052 1053 1054 1055
  /* If we do have a TZSTRING, NEWENV points to the vector slot where
     the TZ variable is stored.  If we do not have a TZSTRING,
     TO points to the vector slot which has the terminating null.  */

1056
#ifdef LOCALTIME_CACHE
Richard M. Stallman's avatar
Richard M. Stallman committed
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070
  {
    /* In SunOS 4.1.3_U1 and 4.1.4, if TZ has a value like
       "US/Pacific" that loads a tz file, then changes to a value like
       "XXX0" that does not load a tz file, and then changes back to
       its original value, the last change is (incorrectly) ignored.
       Also, if TZ changes twice in succession to values that do
       not load a tz file, tzset can dump core (see Sun bug#1225179).
       The following code works around these bugs.  */

    if (tzstring)
      {
	/* Temporarily set TZ to a value that loads a tz file
	   and that differs from tzstring.  */
	char *tz = *newenv;
1071 1072
	*newenv = (strcmp (tzstring, set_time_zone_rule_tz1 + 3