editfns.c 101 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
Richard M. Stallman's avatar
Richard M. Stallman committed
2
   Copyright (C) 1985,86,87,89,93,94,95,96,97,98 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

Andreas Schwab's avatar
Andreas Schwab committed
32 33 34 35 36 37 38 39
#ifdef STDC_HEADERS
#include <stdlib.h>
#endif

#ifdef HAVE_UNISTD_H
#include <unistd.h>
#endif

Jim Blandy's avatar
Jim Blandy committed
40
#include "lisp.h"
41
#include "intervals.h"
Jim Blandy's avatar
Jim Blandy committed
42
#include "buffer.h"
Karl Heuer's avatar
Karl Heuer committed
43
#include "charset.h"
Jim Blandy's avatar
Jim Blandy committed
44 45
#include "window.h"

Jim Blandy's avatar
Jim Blandy committed
46
#include "systime.h"
Jim Blandy's avatar
Jim Blandy committed
47 48 49 50

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

51 52 53 54
#ifndef NULL
#define NULL 0
#endif

55 56
extern char **environ;
extern Lisp_Object make_time ();
57
extern void insert_from_buffer ();
58
static int tm_diff ();
59
static void update_buffer_properties ();
Paul Eggert's avatar
Paul Eggert committed
60
size_t emacs_strftime ();
61
void set_time_zone_rule ();
62 63 64 65

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
66

67 68
Lisp_Object Fuser_full_name ();

Jim Blandy's avatar
Jim Blandy committed
69 70 71
/* Some static data, and a function to initialize it for each run */

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

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
79
  char *user_name;
Jim Blandy's avatar
Jim Blandy committed
80 81 82 83 84
  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.  */
85
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
86 87 88 89 90 91 92 93

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

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

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

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

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

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

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

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

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 282 283 284 285 286 287 288

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;
{
289
  register int orig, orig_byte, end;
290 291 292 293 294 295 296

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

  orig = PT;
297
  orig_byte = PT_BYTE;
298 299
  Fforward_line (make_number (XINT (n) - 1));
  end = PT;
300
  SET_PT_BOTH (orig, orig_byte);
Jim Blandy's avatar
Jim Blandy committed
301

302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322
  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
323 324 325
Lisp_Object
save_excursion_save ()
{
326 327
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
328 329

  return Fcons (Fpoint_marker (),
330
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
331 332
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
333 334 335 336
}

Lisp_Object
save_excursion_restore (info)
337
     Lisp_Object info;
Jim Blandy's avatar
Jim Blandy committed
338
{
339 340
  Lisp_Object tem, tem1, omark, nmark;
  struct gcpro gcpro1, gcpro2, gcpro3;
Jim Blandy's avatar
Jim Blandy committed
341 342 343 344 345 346

  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
347
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
348
    return Qnil;
349 350 351 352

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

Jim Blandy's avatar
Jim Blandy committed
353 354 355 356 357
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
358
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
359
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
360
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
361 362
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
363 364 365 366
#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.  */
367 368
  tem1 = Fcar (tem);
  if (!NILP (tem1)
369
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
370
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
371
#endif /* 0 */
372 373 374

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
375 376
  if (!NILP (Vrun_hooks))
    {
377 378
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
379
      if (! NILP (current_buffer->mark_active))
380 381 382 383 384
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
385 386 387
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
388
  UNGCPRO;
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393 394 395
  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\
396
even in case of abnormal exit (throw or error).\n\
397 398 399 400 401 402
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
403 404 405 406 407 408 409
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
410 411 412 413 414 415 416 417 418 419 420 421 422 423

  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;

424
  record_unwind_protect (set_buffer_if_live, Fcurrent_buffer ());
425

Jim Blandy's avatar
Jim Blandy committed
426 427 428 429
  val = Fprogn (args);
  return unbind_to (count, val);
}

430 431 432 433 434
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
435
{
436 437 438 439 440 441
  if (NILP (buffer))
    return make_number (Z - BEG);
  else {
    CHECK_BUFFER (buffer, 1);
    return make_number (BUF_Z (XBUFFER (buffer)) - BUF_BEG (XBUFFER (buffer)));
  }
Jim Blandy's avatar
Jim Blandy committed
442 443 444 445
}

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
446
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
447 448 449
  ()
{
  Lisp_Object temp;
450
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
451 452 453 454 455
  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
456
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
457 458
  ()
{
459
  return buildmark (BEGV, BEGV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
460 461 462 463
}

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
464 465
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
466 467 468
  ()
{
  Lisp_Object temp;
469
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
470 471 472 473 474
  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
475 476
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
477 478
  ()
{
479
  return buildmark (ZV, ZV_BYTE);
Jim Blandy's avatar
Jim Blandy committed
480 481
}

482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501
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;
}

502
DEFUN ("position-bytes", Fposition_bytes, Sposition_bytes, 1, 1, 0,
503 504
  "Return the byte position for character position POSITION.\n\
If POSITION is out of range, the value is nil.")
505
  (position)
506
     Lisp_Object position;
507
{
508
  CHECK_NUMBER_COERCE_MARKER (position, 1);
509 510
  if (XINT (position) < BEG || XINT (position) > Z)
    return Qnil;
511
  return make_number (CHAR_TO_BYTE (XINT (position)));
512
}
513 514

DEFUN ("byte-to-position", Fbyte_to_position, Sbyte_to_position, 1, 1, 0,
515 516
  "Return the character position for byte position BYTEPOS.\n\
If BYTEPOS is out of range, the value is nil.")
517 518 519 520
  (bytepos)
     Lisp_Object bytepos;
{
  CHECK_NUMBER (bytepos, 1);
521 522
  if (XINT (bytepos) < BEG_BYTE || XINT (bytepos) > Z_BYTE)
    return Qnil;
523 524
  return make_number (BYTE_TO_CHAR (XINT (bytepos)));
}
525

Jim Blandy's avatar
Jim Blandy committed
526 527
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
528 529 530 531
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
532 533 534
  ()
{
  Lisp_Object temp;
535
  if (PT >= ZV)
536
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
537
  else
538
    XSETFASTINT (temp, FETCH_CHAR (PT_BYTE));
Jim Blandy's avatar
Jim Blandy committed
539 540 541
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
542 543
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
544 545 546 547
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
548 549 550
  ()
{
  Lisp_Object temp;
551
  if (PT <= BEGV)
552
    XSETFASTINT (temp, 0);
Karl Heuer's avatar
Karl Heuer committed
553 554
  else if (!NILP (current_buffer->enable_multibyte_characters))
    {
555
      int pos = PT_BYTE;
Karl Heuer's avatar
Karl Heuer committed
556 557 558
      DEC_POS (pos);
      XSETFASTINT (temp, FETCH_CHAR (pos));
    }
Jim Blandy's avatar
Jim Blandy committed
559
  else
560
    XSETFASTINT (temp, FETCH_BYTE (PT_BYTE - 1));
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564
  return temp;
}

DEFUN ("bobp", Fbobp, Sbobp, 0, 0, 0,
565
  "Return t if point is at the beginning of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
566 567 568
If the buffer is narrowed, this means the beginning of the narrowed part.")
  ()
{
569
  if (PT == BEGV)
Jim Blandy's avatar
Jim Blandy committed
570 571 572 573 574
    return Qt;
  return Qnil;
}

DEFUN ("eobp", Feobp, Seobp, 0, 0, 0,
575
  "Return t if point is at the end of the buffer.\n\
Jim Blandy's avatar
Jim Blandy committed
576 577 578
If the buffer is narrowed, this means the end of the narrowed part.")
  ()
{
579
  if (PT == ZV)
Jim Blandy's avatar
Jim Blandy committed
580 581 582 583 584
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
585
  "Return t if point is at the beginning of a line.")
Jim Blandy's avatar
Jim Blandy committed
586 587
  ()
{
588
  if (PT == BEGV || FETCH_BYTE (PT_BYTE - 1) == '\n')
Jim Blandy's avatar
Jim Blandy committed
589 590 591 592 593
    return Qt;
  return Qnil;
}

DEFUN ("eolp", Feolp, Seolp, 0, 0, 0,
594
  "Return t if point is at the end of a line.\n\
Jim Blandy's avatar
Jim Blandy committed
595 596 597
`End of a line' includes point being at the end of the buffer.")
  ()
{
598
  if (PT == ZV || FETCH_BYTE (PT_BYTE) == '\n')
Jim Blandy's avatar
Jim Blandy committed
599 600 601 602
    return Qt;
  return Qnil;
}

603
DEFUN ("char-after", Fchar_after, Schar_after, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
604 605
  "Return character in current buffer at position POS.\n\
POS is an integer or a buffer pointer.\n\
606
If POS is out of range, the value is nil.")
Jim Blandy's avatar
Jim Blandy committed
607 608 609
  (pos)
     Lisp_Object pos;
{
610
  register int pos_byte;
Jim Blandy's avatar
Jim Blandy committed
611 612
  register Lisp_Object val;

613
  if (NILP (pos))
614 615
    {
      pos_byte = PT_BYTE;
616
      XSETFASTINT (pos, PT);
617 618 619
    }

  if (MARKERP (pos))
620 621 622 623 624
    {
      pos_byte = marker_byte_position (pos);
      if (pos_byte < BEGV_BYTE || pos_byte >= ZV_BYTE)
	return Qnil;
    }
625 626 627
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
628
      if (XINT (pos) < BEGV || XINT (pos) >= ZV)
629
	return Qnil;
630 631
      
      pos_byte = CHAR_TO_BYTE (XINT (pos));
632
    }
Jim Blandy's avatar
Jim Blandy committed
633

634
  return make_number (FETCH_CHAR (pos_byte));
Jim Blandy's avatar
Jim Blandy committed
635
}
Karl Heuer's avatar
Karl Heuer committed
636

637
DEFUN ("char-before", Fchar_before, Schar_before, 0, 1, 0,
Karl Heuer's avatar
Karl Heuer committed
638 639
  "Return character in current buffer preceding position POS.\n\
POS is an integer or a buffer pointer.\n\
640
If POS is out of range, the value is nil.")
Karl Heuer's avatar
Karl Heuer committed
641 642 643 644
  (pos)
     Lisp_Object pos;
{
  register Lisp_Object val;
645
  register int pos_byte;
Karl Heuer's avatar
Karl Heuer committed
646

647
  if (NILP (pos))
648 649
    {
      pos_byte = PT_BYTE;
650
      XSETFASTINT (pos, PT);
651 652 653
    }

  if (MARKERP (pos))
654 655 656 657 658 659
    {
      pos_byte = marker_byte_position (pos);

      if (pos_byte <= BEGV_BYTE || pos_byte > ZV_BYTE)
	return Qnil;
    }
660 661 662
  else
    {
      CHECK_NUMBER_COERCE_MARKER (pos, 0);
Karl Heuer's avatar
Karl Heuer committed
663

664
      if (XINT (pos) <= BEGV || XINT (pos) > ZV)
665 666
	return Qnil;

667
      pos_byte = CHAR_TO_BYTE (XINT (pos));
668
    }
Karl Heuer's avatar
Karl Heuer committed
669 670 671

  if (!NILP (current_buffer->enable_multibyte_characters))
    {
672 673
      DEC_POS (pos_byte);
      XSETFASTINT (val, FETCH_CHAR (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
674 675 676
    }
  else
    {
677 678
      pos_byte--;
      XSETFASTINT (val, FETCH_BYTE (pos_byte));
Karl Heuer's avatar
Karl Heuer committed
679 680 681
    }
   return val;
}
Jim Blandy's avatar
Jim Blandy committed
682

Morten Welinder's avatar
Morten Welinder committed
683
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
684 685
  "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\
686
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
687 688 689 690 691
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
692
{
Morten Welinder's avatar
Morten Welinder committed
693 694
  struct passwd *pw;

695 696 697
  /* 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.  */
698
  if (INTEGERP (Vuser_login_name))
699
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
700 701

  if (NILP (uid))
702
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
703 704 705 706

  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
707 708 709 710 711
}

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\
712
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
713
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
714 715
  ()
{
716 717 718
  /* 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.  */
719
  if (INTEGERP (Vuser_login_name))
720
    init_editfns ();
721
  return Vuser_real_login_name;
Jim Blandy's avatar
Jim Blandy committed
722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737
}

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

738 739
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
740 741 742
If the full name corresponding to Emacs's userid is not known,\n\
return \"unknown\".\n\
\n\
743
If optional argument UID is an integer, return the full name of the user\n\
Karl Heuer's avatar
Karl Heuer committed
744
with that uid, or nil if there is no such user.\n\
745
If UID is a string, return the full name of the user with that login\n\
Karl Heuer's avatar
Karl Heuer committed
746
name, or nil if there is no such user.")
747 748
  (uid)
     Lisp_Object uid;
Jim Blandy's avatar
Jim Blandy committed
749
{
750
  struct passwd *pw;
751
  register unsigned char *p, *q;
752 753
  extern char *index ();
  Lisp_Object full;
754 755

  if (NILP (uid))
756 757 758 759 760 761 762
    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");
763

764
  if (!pw)
765
    return Qnil;
766 767 768 769 770 771 772 773 774 775 776 777
  
  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)
    {
778
      register unsigned char *r;
779 780 781 782 783 784 785 786 787 788 789 790 791 792
      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
793 794 795 796 797 798 799 800 801
}

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

802 803 804 805
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
806 807 808 809
  if (STRINGP (Vsystem_name))
    return (char *) XSTRING (Vsystem_name)->data;
  else
    return "";
810 811
}

812 813 814 815 816 817 818
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
819
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
820
  "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
Jim Blandy's avatar
Jim Blandy committed
821 822 823 824 825 826 827
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
828 829
  ()
{
Jim Blandy's avatar
Jim Blandy committed
830 831 832 833
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
834 835 836
  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
837 838

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
839 840 841
}


842 843 844 845 846 847 848 849 850 851 852 853 854
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);
855
      if (CONSP (low))
856 857 858 859 860 861 862
	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
863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881
/* Write information into buffer S of size MAXSIZE, according to the
   FORMAT of length FORMAT_LEN, using time information taken from *TP.
   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.

   This function behaves like emacs_strftime, except it allows null
   bytes in FORMAT.  */
static size_t
emacs_memftime (s, maxsize, format, format_len, tp)
      char *s;
      size_t maxsize;
      const char *format;
      size_t format_len;
      const struct tm *tp;
{
  size_t total = 0;

882 883 884 885 886
  /* 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
     format contains '\0' bytes.  emacs_strftime stops at the first
     '\0' byte so we must invoke it separately for each such string.  */
Paul Eggert's avatar
Paul Eggert committed
887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914
  for (;;)
    {
      size_t len;
      size_t result;

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

      result = emacs_strftime (s, maxsize, format, tp);

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

915
/*
916 917 918 919 920 921 922 923
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\
924
\n\
925 926
%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
927 928
%m is the numeric month.\n\
%b and %h are the locale's abbreviated month name, %B the full name.\n\
929 930
%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
931
%a is the locale's abbreviated name of the day of week, %A the full name.\n\
932 933 934 935 936 937
%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\
Paul Eggert's avatar
Paul Eggert committed
938
%p is the locale's equivalent of either AM or PM.\n\
939 940 941 942 943 944 945 946 947 948 949 950
%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\
Paul Eggert's avatar
Paul Eggert committed
951
Finally, %n is a newline, %t is a tab, %% is a literal %.\n\
952
\n\
953
Certain flags and modifiers are available with some format controls.\n\
954 955 956 957 958 959 960 961 962
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\".")
963
  (format_string, time, universal)
964 965 966 967
*/

DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 3, 0,
  0 /* See immediately above */)
968 969
  (format_string, time, universal)
     Lisp_Object format_string, time, universal;
970 971 972
{
  time_t value;
  int size;
973
  struct tm *tm;
974 975 976 977 978 979 980

  CHECK_STRING (format_string, 1);

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

  /* This is probably enough.  */
981
  size = STRING_BYTES (XSTRING (format_string)) * 6 + 50;
982

983 984 985 986
  tm = NILP (universal) ? localtime (&value) : gmtime (&value);
  if (! tm)
    error ("Specified time is not representable");

987 988
  while (1)
    {
989 990 991
      char *buf = (char *) alloca (size + 1);
      int result;

992
      buf[0] = '\1';
Paul Eggert's avatar
Paul Eggert committed
993 994
      result = emacs_memftime (buf, size, XSTRING (format_string)->data,
			       STRING_BYTES (XSTRING (format_string)),
995
			       tm);
996
      if ((result > 0 && result < size) || (result == 0 && buf[0] == '\0'))
Paul Eggert's avatar
Paul Eggert committed
997
	return make_string (buf, result);
998 999

      /* If buffer was too small, make it bigger and try again.  */
Paul Eggert's avatar
Paul Eggert committed
1000 1001 1002
      result = emacs_memftime (NULL, (size_t) -1,
			       XSTRING (format_string)->data,
			       STRING_BYTES (XSTRING (format_string)),
1003
			       tm);
1004
      size = result + 1;
1005 1006 1007
    }
}

1008 1009 1010 1011 1012
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
1013 1014
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\
1015 1016 1017 1018 1019
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
1020
\(Note that Common Lisp has different meanings for DOW and ZONE.)")
1021 1022 1023 1024
  (specified_time)
     Lisp_Object specified_time;
{
  time_t time_spec;
1025
  struct tm save_tm;
1026 1027 1028 1029 1030 1031 1032
  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);
1033 1034
  if (! decoded_time)
    error ("Specified time is not representable");
1035 1036 1037 1038 1039
  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);
1040
  XSETINT (list_args[5], decoded_time->tm_year + 1900);
1041
  XSETFASTINT (list_args[6], decoded_time->tm_wday);
1042
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
1043 1044 1045 1046 1047 1048 1049

  /* 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
1050
    XSETINT (list_args[8], tm_diff (&save_tm, decoded_time));
1051 1052 1053
  return Flist (9, list_args);
}

1054
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, MANY, 0,
1055
  "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
1056 1057
This is the reverse operation of `decode-time', which see.\n\
ZONE defaults to the current time zone rule.  This can\n\
1058
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
1059
\(as from `current-time-zone') or an integer (as from `decode-time')\n\
1060
applied without consideration for daylight savings time.\n\
1061 1062 1063 1064 1065 1066
\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\
1067 1068
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\
1069
Year numbers less than 100 are treated just like other year numbers.\n\
1070
If you want them to stand for years in this century, you must do that yourself.")
1071 1072 1073
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
1074
{
1075
  time_t time;
1076
  struct tm tm;
Richard M. Stallman's avatar
Richard M. Stallman committed
1077
  Lisp_Object zone = (nargs > 6 ? args[nargs - 1] : Qnil);
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091

  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;
1092 1093 1094 1095
  tm.tm_isdst = -1;

  if (CONSP (zone))
    zone = Fcar (zone);
1096
  if (NILP (zone))
1097 1098
    time = mktime (&tm);
  else
1099
    {
1100 1101 1102 1103
      char tzbuf[100];
      char *tzstring;
      char **oldenv = environ, **newenv;
      
1104
      if (EQ (zone, Qt))
1105 1106
	tzstring = "UTC0";
      else if (STRINGP (zone))
1107
	tzstring = (char *) XSTRING (zone)->data;
1108
      else if (INTEGERP (zone))
1109
	{
1110 1111 1112 1113
	  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;
1114
	}
1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126
      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;
1127
      xfree (newenv);
1128 1129 1130
#ifdef LOCALTIME_CACHE
      tzset ();
#endif
1131 1132
    }

1133 1134 1135 1136
  if (time == (time_t) -1)
    error ("Specified time is not representable");

  return make_time (time);
1137 1138
}

1139
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
1140
  "Return the current time, as a human-readable string.\n\
1141 1142 1143
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\
1144 1145 1146
However, see also the functions `decode-time' and `format-time-string'\n\
which provide a much more powerful and general facility.\n\
\n\
1147 1148 1149 1150 1151 1152 1153 1154 1155 1156
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;
{
1157
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
1158
  char buf[30];
1159 1160
  register char *tem;

1161 1162
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
1163
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
1164 1165 1166 1167 1168 1169

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

  return build_string (buf);
}
1170

1171
#define TM_YEAR_BASE 1900
1172

1173 1174 1175 1176
/* Yield A - B, measured in seconds.
   This function is copied from the GNU C Library.  */
static int
tm_diff (a, b)
1177 1178
     struct tm *a, *b;
{
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193
  /* 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
1194
	  + (a->tm_sec - b->tm_sec));
1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209
}

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\
1210 1211
\n\
Some operating systems cannot provide all this information to Emacs;\n\