editfns.c 82.5 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 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
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
35
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
36 37
#include "window.h"

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

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

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

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
53

54 55
Lisp_Object Fuser_full_name ();

Jim Blandy's avatar
Jim Blandy committed
56 57 58
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
59 60 61
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
62 63 64 65

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

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

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

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

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

127
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
128

Karl Heuer's avatar
Karl Heuer committed
129 130
  len = CHAR_STRING (XFASTINT (character), workbuf, str);
  return make_string (str, len);
Jim Blandy's avatar
Jim Blandy committed
131 132 133
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
134 135
  "Convert arg STRING to a character, the first character of that string.\n\
A multibyte character is handled correctly.")
136 137
  (string)
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
138 139 140
{
  register Lisp_Object val;
  register struct Lisp_String *p;
141 142
  CHECK_STRING (string, 0);
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
143
  if (p->size)
Karl Heuer's avatar
Karl Heuer committed
144
    XSETFASTINT (val, STRING_CHAR (p->data, p->size));
Jim Blandy's avatar
Jim Blandy committed
145
  else
146
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
147 148
  return val;
}
Karl Heuer's avatar
Karl Heuer committed
149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174

DEFUN ("sref", Fsref, Ssref, 2, 2, 0,
  "Return the character in STRING at INDEX.  INDEX starts at 0.\n\
A multibyte character is handled correctly.\n\
INDEX not pointing at character boundary is an error.")
  (str, idx)
     Lisp_Object str, idx;
{
  register int idxval, len;
  register unsigned char *p;
  register Lisp_Object val;

  CHECK_STRING (str, 0);
  CHECK_NUMBER (idx, 1);
  idxval = XINT (idx);
  if (idxval < 0 || idxval >= (len = XVECTOR (str)->size))
    args_out_of_range (str, idx);
  p = XSTRING (str)->data + idxval;
  if (!CHAR_HEAD_P (p))
    error ("Not character boundary");

  len = XSTRING (str)->size - idxval;
  XSETFASTINT (val, STRING_CHAR (p, len));
  return val;
}

Jim Blandy's avatar
Jim Blandy committed
175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191

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;
192
  XSETFASTINT (temp, PT);
Jim Blandy's avatar
Jim Blandy committed
193 194 195 196 197 198 199
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
   "Return value of point, as a marker object.")
  ()
{
200
  return buildmark (PT);
Jim Blandy's avatar
Jim Blandy committed
201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216
}

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
217 218 219 220
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.")
221 222
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
223
{
Karl Heuer's avatar
Karl Heuer committed
224 225 226
  int pos;
  unsigned char *p;

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

Karl Heuer's avatar
Karl Heuer committed
229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
  pos = clip_to_bounds (BEGV, XINT (position), ZV);
  /* If POS is in a middle of multi-byte form (i.e. *P >= 0xA0), we
     must decrement POS until it points the head of the multi-byte
     form.  */
  if (!NILP (current_buffer->enable_multibyte_characters)
      && *(p = POS_ADDR (pos)) >= 0xA0
      && pos > BEGV)
    {
      /* Since a multi-byte form does not contain the gap, POS should
         not stride over the gap while it is being decreased.  So, we
         set the limit as below.  */
      unsigned char *p_min = pos < GPT ? BEG_ADDR : GAP_END_ADDR;
      unsigned int saved_pos = pos;

      do {
	p--, pos--;
      } while (p > p_min && *p >= 0xA0);
      if (*p < 0x80)
	/* This was an invalid multi-byte form.  */
	pos = saved_pos;
      XSETFASTINT (position, pos);
    }
  SET_PT (pos);
252
  return position;
Jim Blandy's avatar
Jim Blandy committed
253 254 255 256 257 258
}

static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
259
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
260
  register Lisp_Object m;
261 262 263
  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
264
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
265
  if (NILP (m)) error ("There is no region now");
266 267
  if ((PT < XFASTINT (m)) == beginningp)
    return (make_number (PT));
Jim Blandy's avatar
Jim Blandy committed
268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293
  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;
}
294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314

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
315

316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
  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
337 338 339
Lisp_Object
save_excursion_save ()
{
340 341
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
342 343

  return Fcons (Fpoint_marker (),
344
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
345 346
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
347 348 349 350
}

Lisp_Object
save_excursion_restore (info)
351
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
352
{
353 354
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
355 356 357 358 359 360

  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
361
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
362
    return Qnil;
363 364 365 366

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

Jim Blandy's avatar
Jim Blandy committed
367 368 369 370 371
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
372
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
373
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
374
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
375 376
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
377 378 379 380
#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.  */
381 382
  tem1 = Fcar (tem);
  if (!NILP (tem1)
383
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
384
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
385
#endif /* 0 */
386 387 388

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
389 390
  if (!NILP (Vrun_hooks))
    {
391 392
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
393
      if (! NILP (current_buffer->mark_active))
394 395 396 397 398
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
399 400 401
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
402
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
403 404 405 406 407 408 409
  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\
410 411
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
412 413 414 415 416 417 418
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434

  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
435 436 437 438 439 440 441 442 443
  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;
444
  XSETFASTINT (temp, Z - BEG);
Jim Blandy's avatar
Jim Blandy committed
445 446 447 448 449
  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
450
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
451 452 453
  ()
{
  Lisp_Object temp;
454
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
455 456 457 458 459
  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
460
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
461 462 463 464 465 466 467
  ()
{
  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
468 469
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
470 471 472
  ()
{
  Lisp_Object temp;
473
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
474 475 476 477 478
  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
479 480
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
481 482 483 484 485
  ()
{
  return buildmark (ZV);
}

Jim Blandy's avatar
Jim Blandy committed
486 487
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
488 489 490 491
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
492 493 494
  ()
{
  Lisp_Object temp;
495
  if (PT >= ZV)
496
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
497
  else
498
    XSETFASTINT (temp, FETCH_CHAR (PT));
Jim Blandy's avatar
Jim Blandy committed
499 500 501
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
502 503
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
504 505 506 507
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
508 509 510
  ()
{
  Lisp_Object temp;
511
  if (PT <= BEGV)
512
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
513 514 515 516 517 518
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
      int pos = PT;
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
519
  else
Karl Heuer's avatar
Karl Heuer committed
520
    XSETFASTINT (temp, FETCH_BYTE (point - 1));
Jim Blandy's avatar
Jim Blandy committed
521 522 523 524 525 526 527 528
  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.")
  ()
{
529
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
530 531 532 533 534 535 536 537 538
    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.")
  ()
{
539
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
540 541 542 543 544 545 546 547
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
  "Return T if point is at the beginning of a line.")
  ()
{
Karl Heuer's avatar
Karl Heuer committed
548
  if (PT == BEGV || FETCH_BYTE (PT - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
549 550 551 552 553 554 555 556 557
    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.")
  ()
{
Karl Heuer's avatar
Karl Heuer committed
558
  if (PT == ZV || FETCH_BYTE (PT) == '\n')
Jim Blandy's avatar
Jim Blandy committed
559 560 561 562 563 564 565
    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\
Karl Heuer's avatar
Karl Heuer committed
566 567 568 569
If POS is out of range, the value is nil.\n\
If `enable-multibyte-characters' is nil or POS is not at character boundary,\n\
 multi-byte form is ignored, and only one byte at POS\n\
 is returned as a character.")
Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574 575 576 577 578 579 580
  (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;

581
  XSETFASTINT (val, FETCH_CHAR (n));
Jim Blandy's avatar
Jim Blandy committed
582 583
  return val;
}
Karl Heuer's avatar
Karl Heuer committed
584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614

DEFUN ("char-before", Fchar_before, Schar_before, 1, 1, 0,
  "Return character in current buffer preceding position POS.\n\
POS is an integer or a buffer pointer.\n\
If POS is out of range, the value is nil.\n\
If `enable-multibyte-characters' is nil or POS is not at character boundary,\n\
multi-byte form is ignored, and only one byte preceding POS\n\
is returned as a character.")
  (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;

  if (!NILP (current_buffer->enable_multibyte_characters))
    {
      DEC_POS (pos);
      XSETFASTINT (val, FETCH_CHAR (pos));
    }
  else
    {
      pos--;
      XSETFASTINT (val, FETCH_BYTE (pos));
    }
   return val;
}
Jim Blandy's avatar
Jim Blandy committed
615

Morten Welinder's avatar
Morten Welinder committed
616
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
617 618
  "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\
619
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
620 621 622 623 624
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
625
{
Morten Welinder's avatar
Morten Welinder committed
626 627
  struct passwd *pw;

628 629 630
  /* 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.  */
631
  if (INTEGERP (Vuser_login_name))
632
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
633 634

  if (NILP (uid))
635
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
636 637 638 639

  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
640 641 642 643 644
}

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\
645
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
646
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
647 648
  ()
{
649 650 651
  /* 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.  */
652
  if (INTEGERP (Vuser_login_name))
653
    init_editfns ();
654
  return Vuser_real_login_name;
Jim Blandy's avatar
Jim Blandy committed
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
}

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

671 672 673
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\
Kenichi Handa's avatar
Kenichi Handa committed
674
with that uid, or \"unknown\" if there is no such user.\n\
675 676
If UID is a string, return the full name of the user with that login\n\
name, or \"unknown\" if no such user could be found.")
677 678
  (uid)
     Lisp_Object uid;
Jim Blandy's avatar
Jim Blandy committed
679
{
680
  struct passwd *pw;
681 682 683
  register char *p, *q;
  extern char *index ();
  Lisp_Object full;
684 685

  if (NILP (uid))
686 687 688 689 690 691 692
    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");
693

694
  if (!pw)
695
    return Qnil;
696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722
  
  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)
    {
      register char *r;
      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
723 724 725 726 727 728 729 730 731
}

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

732 733 734 735
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
736
  return (char *) XSTRING (Vsystem_name)->data;
737 738
}

739 740 741 742 743 744 745
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
746
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
747
  "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
Jim Blandy's avatar
Jim Blandy committed
748 749 750 751 752 753 754
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
755 756
  ()
{
Jim Blandy's avatar
Jim Blandy committed
757 758 759 760
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
761 762 763
  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
764 765

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
766 767 768
}


769 770 771 772 773 774 775 776 777 778 779 780 781
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);
782
      if (CONSP (low))
783 784 785 786 787 788 789
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

790 791 792 793 794 795 796 797
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\
798
\n\
799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837
%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\
%m is the numeric month, %b and %h the abbreviated name, %B the full name.\n\
%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\
%a is the abbreviated name of the day of week, %A the full name.\n\
%U is the week number starting on Sunday, %W starting on Monday,\n\
 %V according to ISO 8601.\n\
%j is the day of the year.\n\
\n\
%H is the hour on a 24-hour clock, %I is on a 12-hour clock, %k is like %H\n\
 only blank-padded, %l is like %I blank-padded.\n\
%p is AM or PM.\n\
%M is the minute.\n\
%S is the second.\n\
%Z is the time zone name, %z is the numeric form.\n\
%s is the number of seconds since 1970-01-01 00:00:00 +0000.\n\
\n\
%c is the locale's date and time format.\n\
%x is the locale's \"preferred\" date format.\n\
%D is like \"%m/%d/%y\".\n\
\n\
%R is like \"%H:%M\", %T is like \"%H:%M:%S\", %r is like \"%I:%M:%S %p\".\n\
%X is the locale's \"preferred\" time format.\n\
\n\
Finally, %n is like \n, %t is like \t, %% is a literal %.\n\
\n\
Certain flags and modifiers are available with some format controls.
The flags are `_' and `-'.  For certain characters X, %_X is like %X,\n\
but padded with blanks; %-X is like %X, but without padding.\n\
%NX (where N stands for an integer) is like %X,\n\
but takes up at least N (a number) positions.\n\
The modifiers are `E' and `O'.  For certain characters X,\n\
%EX is a locale's alternative version of %X;\n\
%OX is like %X, but uses the locale's number symbols.\n\
\n\
For example, to produce full ISO 8601 format, use \"%Y-%m-%dT%T%z\".")
  (format_string, time, universal)
     Lisp_Object format_string, time, universal;
838 839 840 841 842 843 844 845 846 847 848 849 850 851
{
  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)
    {
852 853 854 855 856 857 858
      char *buf = (char *) alloca (size + 1);
      int result;

      result = emacs_strftime (buf, size, XSTRING (format_string)->data,
			       (NILP (universal) ? localtime (&value)
				: gmtime (&value)));
      if (result > 0 && result < size)
859
	return build_string (buf);
860 861 862 863 864 865 866 867
      if (result < 0)
	error ("Invalid time format specification");

      /* If buffer was too small, make it bigger and try again.  */
      result = emacs_strftime (buf, 0, XSTRING (format_string)->data,
			       (NILP (universal) ? localtime (&value)
				: gmtime (&value)));
      size = result + 1;
868 869 870
    }
}

871 872 873 874 875
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
876 877
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\
878 879 880 881 882
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
883
\(Note that Common Lisp has different meanings for DOW and ZONE.)")
884 885 886 887
  (specified_time)
     Lisp_Object specified_time;
{
  time_t time_spec;
888
  struct tm save_tm;
889 890 891 892 893 894 895
  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);
896 897 898 899 900
  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);
901
  XSETINT (list_args[5], decoded_time->tm_year + 1900);
902
  XSETFASTINT (list_args[6], decoded_time->tm_wday);
903
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
904 905 906 907 908 909 910

  /* 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
911
    XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
912 913 914
  return Flist (9, list_args);
}

915
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
916
  "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
917 918
This is the reverse operation of `decode-time', which see.\n\
ZONE defaults to the current time zone rule.  This can\n\
919
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
920
\(as from `current-time-zone') or an integer (as from `decode-time')\n\
921
applied without consideration for daylight savings time.\n\
922 923 924 925 926 927
\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\
928 929
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\
930
Year numbers less than 100 are treated just like other year numbers.\n\
931
If you want them to stand for years in this century, you must do that yourself.")
932 933 934
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
935
{
936
  time_t time;
937
  struct tm tm;
Richard M. Stallman's avatar
Richard M. Stallman committed
938
  Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
939 940 941 942 943 944 945 946 947 948 949 950 951 952

  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;
953 954 955 956
  tm.tm_isdst = -1;

  if (CONSP (zone))
    zone = Fcar (zone);
957
  if (NILP (zone))
958 959
    time = mktime (&tm);
  else
960
    {
961 962 963 964
      char tzbuf[100];
      char *tzstring;
      char **oldenv = environ, **newenv;
      
965 966 967
      if (zone == Qt)
	tzstring = "UTC0";
      else if (STRINGP (zone))
968
	tzstring = (char *) XSTRING (zone)->data;
969
      else if (INTEGERP (zone))
970
	{
971 972 973 974
	  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;
975
	}
976 977 978 979 980 981 982 983 984 985 986 987
      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;
988
      xfree (newenv);
989 990 991
#ifdef LOCALTIME_CACHE
      tzset ();
#endif
992 993
    }

994 995 996 997
  if (time == (time_t) -1)
    error ("Specified time is not representable");

  return make_time (time);
998 999
}

1000
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
1001
  "Return the current time, as a human-readable string.\n\
1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014
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;
{
1015
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
1016
  char buf[30];
1017 1018
  register char *tem;

1019 1020
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
1021
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
1022 1023 1024 1025 1026 1027

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

  return build_string (buf);
}
1028

1029
#define TM_YEAR_BASE 1900
1030

1031 1032 1033 1034
/* Yield A - B, measured in seconds.
   This function is copied from the GNU C Library.  */
static int
tm_diff (a, b)
1035 1036
     struct tm *a, *b;
{
1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
  /* 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
1052
	  + (a->tm_sec - b->tm_sec));
1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067
}

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\
1068 1069
\n\
Some operating systems cannot provide all this information to Emacs;\n\
1070
in this case, `current-time-zone' returns a list containing nil for\n\
1071
the data it can't find.")
1072 1073
  (specified_time)
     Lisp_Object specified_time;
1074
{
1075 1076
  time_t value;
  struct tm *t;
1077

1078
  if (lisp_time_argument (specified_time, &value)
1079
      && (t = gmtime (&value)) != 0)
1080
    {
1081
      struct tm gmt;
1082
      int offset;
1083
      char *s, buf[6];
1084 1085 1086

      gmt = *t;		/* Make a copy, in case localtime modifies *t.  */
      t = localtime (&value);
1087
      offset = tm_diff (t, &gmt);
1088 1089 1090
      s = 0;
#ifdef HAVE_TM_ZONE
      if (t->tm_zone)
1091
	s = (char *)t->tm_zone;
1092 1093 1094 1095
#else /* not HAVE_TM_ZONE */
#ifdef HAVE_TZNAME
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
	s = tzname[t->tm_isdst];
1096
#endif
1097
#endif /* not HAVE_TM_ZONE */
1098 1099 1100
      if (!s)
	{
	  /* No local time zone name is available; use "+-NNNN" instead.  */
1101
	  int am = (offset < 0 ? -offset : offset) / 60;
1102 1103 1104 1105 1106 1107 1108
	  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);
1109 1110
}

1111 1112 1113 1114 1115
/* 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;

1116 1117
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\
1118 1119
If TZ is nil, use implementation-defined default time zone information.\n\
If TZ is t, use Universal Time.")
1120 1121 1122 1123 1124 1125 1126
  (tz)
     Lisp_Object tz;
{
  char *tzstring;

  if (NILP (tz))
    tzstring = 0;
1127 1128
  else if (tz == Qt)
    tzstring = "UTC0";
1129 1130 1131
  else
    {
      CHECK_STRING (tz, 0);
1132
      tzstring = (char *) XSTRING (tz)->data;
1133 1134
    }

1135 1136 1137 1138 1139 1140 1141 1142
  set_time_zone_rule (tzstring);
  if (environbuf)
    free (environbuf);
  environbuf = environ;

  return Qnil;
}

1143 1144 1145 1146
#ifdef LOCALTIME_CACHE

/* These two values are known to load tz files in buggy implementations,
   i.e. Solaris 1 executables running under either Solaris 1 or Solaris 2.
1147 1148 1149 1150 1151 1152 1153
   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''.  */

1154 1155 1156 1157
static char set_time_zone_rule_tz1[] = "TZ=GMT+0";
static char set_time_zone_rule_tz2[] = "TZ=GMT+1";

#endif
1158

1159 1160 1161
/* Set the local time zone rule to TZSTRING.
   This allocates memory into `environ', which it is the caller's
   responsibility to free.  */
1162
void
1163 1164 1165 1166 1167 1168
set_time_zone_rule (tzstring)
     char *tzstring;
{
  int envptrs;
  char **from, **to, **newenv;

Richard M. Stallman's avatar
Richard M. Stallman committed
1169
  /* Make the ENVIRON vector longer with room for TZSTRING.  */
1170 1171 1172 1173 1174
  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
1175 1176

  /* Add TZSTRING to the end of environ, as a value for TZ.  */
1177 1178 1179 1180 1181 1182 1183 1184
  if (tzstring)
    {
      char *t = (char *) (to + envptrs);
      strcpy (t, "TZ=");
      strcat (t, tzstring);
      *to++ = t;
    }

Richard M. Stallman's avatar
Richard M. Stallman committed
1185 1186 1187
  /* 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.  */
1188 1189 1190 1191 1192 1193 1194
  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
1195 1196 1197 1198
  /* 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.  */

1199
#ifdef LOCALTIME_CACHE
Richard M. Stallman's avatar
Richard M. Stallman committed
1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213
  {
    /* 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;
1214 1215