editfns.c 68.1 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985,86,87,89,93,94,95 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20

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
the Free Software Foundation; either version 1, or (at your option)
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
the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.  */


21 22
#include <sys/types.h>

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

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

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

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

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

41
extern void insert_from_buffer ();
42
static long difftm ();
43

Jim Blandy's avatar
Jim Blandy committed
44 45 46 47 48
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
Lisp_Object Vuser_real_name;	/* login name of current user ID */
Lisp_Object Vuser_full_name;	/* full name of current user */
49
Lisp_Object Vuser_name;		/* user name from LOGNAME or USER */
Jim Blandy's avatar
Jim Blandy committed
50 51 52 53

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
54
  char *user_name;
Jim Blandy's avatar
Jim Blandy committed
55 56 57 58 59 60
  register unsigned char *p, *q, *r;
  struct passwd *pw;	/* password entry for the current user */
  extern char *index ();
  Lisp_Object tem;

  /* Set up system_name even when dumping.  */
61
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
62 63 64 65 66 67 68 69

#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
70 71 72 73 74 75
#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.)  */
  Vuser_real_name = build_string (pw ? pw->pw_name : "root");
#else
Jim Blandy's avatar
Jim Blandy committed
76
  Vuser_real_name = build_string (pw ? pw->pw_name : "unknown");
Morten Welinder's avatar
Morten Welinder committed
77
#endif
Jim Blandy's avatar
Jim Blandy committed
78

Jim Blandy's avatar
Jim Blandy committed
79 80
  /* Get the effective user name, by consulting environment variables,
     or the effective uid if those are unset.  */
81
  user_name = (char *) getenv ("LOGNAME");
Jim Blandy's avatar
Jim Blandy committed
82
  if (!user_name)
83 84 85
#ifdef WINDOWSNT
    user_name = (char *) getenv ("USERNAME");	/* it's USERNAME on NT */
#else  /* WINDOWSNT */
86
    user_name = (char *) getenv ("USER");
87
#endif /* WINDOWSNT */
Jim Blandy's avatar
Jim Blandy committed
88 89 90 91 92 93
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
  Vuser_name = build_string (user_name);
Jim Blandy's avatar
Jim Blandy committed
94

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

121
  p = (unsigned char *) getenv ("NAME");
122 123
  if (p)
    Vuser_full_name = build_string (p);
Jim Blandy's avatar
Jim Blandy committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148
}

DEFUN ("char-to-string", Fchar_to_string, Schar_to_string, 1, 1, 0,
  "Convert arg CHAR to a one-character string containing that character.")
  (n)
     Lisp_Object n;
{
  char c;
  CHECK_NUMBER (n, 0);

  c = XINT (n);
  return make_string (&c, 1);
}

DEFUN ("string-to-char", Fstring_to_char, Sstring_to_char, 1, 1, 0,
  "Convert arg STRING to a character, the first character of that string.")
  (str)
     register Lisp_Object str;
{
  register Lisp_Object val;
  register struct Lisp_String *p;
  CHECK_STRING (str, 0);

  p = XSTRING (str);
  if (p->size)
149
    XSETFASTINT (val, ((unsigned char *) p->data)[0]);
Jim Blandy's avatar
Jim Blandy committed
150
  else
151
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170
  return val;
}

static Lisp_Object
buildmark (val)
     int val;
{
  register Lisp_Object mark;
  mark = Fmake_marker ();
  Fset_marker (mark, make_number (val), Qnil);
  return mark;
}

DEFUN ("point", Fpoint, Spoint, 0, 0, 0,
  "Return value of point, as an integer.\n\
Beginning of buffer is position (point-min)")
  ()
{
  Lisp_Object temp;
171
  XSETFASTINT (temp, point);
Jim Blandy's avatar
Jim Blandy committed
172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209
  return temp;
}

DEFUN ("point-marker", Fpoint_marker, Spoint_marker, 0, 0, 0,
   "Return value of point, as a marker object.")
  ()
{
  return buildmark (point);
}

int
clip_to_bounds (lower, num, upper)
     int lower, num, upper;
{
  if (num < lower)
    return lower;
  else if (num > upper)
    return upper;
  else
    return num;
}

DEFUN ("goto-char", Fgoto_char, Sgoto_char, 1, 1, "NGoto char: ",
  "Set point to POSITION, a number or marker.\n\
Beginning of buffer is position (point-min), end is (point-max).")
  (n)
     register Lisp_Object n;
{
  CHECK_NUMBER_COERCE_MARKER (n, 0);

  SET_PT (clip_to_bounds (BEGV, XINT (n), ZV));
  return n;
}

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

#if 0 /* now in lisp code */
DEFUN ("mark", Fmark, Smark, 0, 0, 0,
  "Return this buffer's mark value as integer, or nil if no mark.\n\
If you are using this in an editing command, you are most likely making\n\
a mistake; see the documentation of `set-mark'.")
  ()
{
  return Fmarker_position (current_buffer->mark);
}
#endif /* commented out code */

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

#if 0 /* this is now in lisp code */
DEFUN ("set-mark", Fset_mark, Sset_mark, 1, 1, 0,
  "Set this buffer's mark to POS.  Don't use this function!\n\
That is to say, don't use this function unless you want\n\
the user to see that the mark has moved, and you want the previous\n\
mark position to be lost.\n\
\n\
Normally, when a new mark is set, the old one should go on the stack.\n\
This is why most applications should use push-mark, not set-mark.\n\
\n\
Novice programmers often try to use the mark for the wrong purposes.\n\
The mark saves a location for the user's convenience.\n\
Most editing commands should not alter the mark.\n\
To remember a location for internal use in the Lisp program,\n\
store it in a Lisp variable.  Example:\n\
\n\
   (let ((beg (point))) (forward-line 1) (delete-region beg (point))).")
  (pos)
     Lisp_Object pos;
{
Jim Blandy's avatar
Jim Blandy committed
277
  if (NILP (pos))
Jim Blandy's avatar
Jim Blandy committed
278 279 280 281 282 283
    {
      current_buffer->mark = Qnil;
      return Qnil;
    }
  CHECK_NUMBER_COERCE_MARKER (pos, 0);

Jim Blandy's avatar
Jim Blandy committed
284
  if (NILP (current_buffer->mark))
Jim Blandy's avatar
Jim Blandy committed
285 286 287 288 289 290 291 292 293 294
    current_buffer->mark = Fmake_marker ();

  Fset_marker (current_buffer->mark, pos, Qnil);
  return pos;
}
#endif /* commented-out code */

Lisp_Object
save_excursion_save ()
{
295 296
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
297 298

  return Fcons (Fpoint_marker (),
299
		Fcons (Fcopy_marker (current_buffer->mark),
300 301
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
302 303 304 305 306 307
}

Lisp_Object
save_excursion_restore (info)
     register Lisp_Object info;
{
308
  register Lisp_Object tem, tem1, omark, nmark;
Jim Blandy's avatar
Jim Blandy committed
309 310 311 312 313 314

  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
315
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
316 317 318 319 320 321
    return Qnil;
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
322
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
323
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
324
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
325 326
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
327 328 329 330
#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.  */
331 332
  tem1 = Fcar (tem);
  if (!NILP (tem1)
333
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
334
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
335
#endif /* 0 */
336 337 338

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
339 340
  if (!NILP (Vrun_hooks))
    {
341 342
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
343
      if (! NILP (current_buffer->mark_active))
344 345 346 347 348
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
349 350 351
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
Jim Blandy's avatar
Jim Blandy committed
352 353 354 355 356 357 358
  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\
359 360
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
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
  (args)
     Lisp_Object args;
{
  register Lisp_Object val;
  int count = specpdl_ptr - specpdl;

  record_unwind_protect (save_excursion_restore, save_excursion_save ());
			 
  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;
378
  XSETFASTINT (temp, Z - BEG);
Jim Blandy's avatar
Jim Blandy committed
379 380 381 382 383
  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
384
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
385 386 387
  ()
{
  Lisp_Object temp;
388
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
389 390 391 392 393
  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
394
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
395 396 397 398 399 400 401
  ()
{
  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
402 403
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
404 405 406
  ()
{
  Lisp_Object temp;
407
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
408 409 410 411 412
  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
413 414
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
415 416 417 418 419
  ()
{
  return buildmark (ZV);
}

Jim Blandy's avatar
Jim Blandy committed
420 421 422
DEFUN ("following-char", Ffollowing_char, Sfollowing_char, 0, 0, 0,
  "Return the character following point, as a number.\n\
At the end of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
423 424 425
  ()
{
  Lisp_Object temp;
Jim Blandy's avatar
Jim Blandy committed
426
  if (point >= ZV)
427
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
428
  else
429
    XSETFASTINT (temp, FETCH_CHAR (point));
Jim Blandy's avatar
Jim Blandy committed
430 431 432
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
433 434 435
DEFUN ("preceding-char", Fprevious_char, Sprevious_char, 0, 0, 0,
  "Return the character preceding point, as a number.\n\
At the beginning of the buffer or accessible region, return 0.")
Jim Blandy's avatar
Jim Blandy committed
436 437 438 439
  ()
{
  Lisp_Object temp;
  if (point <= BEGV)
440
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
441
  else
442
    XSETFASTINT (temp, FETCH_CHAR (point - 1));
Jim Blandy's avatar
Jim Blandy committed
443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499
  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.")
  ()
{
  if (point == BEGV)
    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.")
  ()
{
  if (point == ZV)
    return Qt;
  return Qnil;
}

DEFUN ("bolp", Fbolp, Sbolp, 0, 0, 0,
  "Return T if point is at the beginning of a line.")
  ()
{
  if (point == BEGV || FETCH_CHAR (point - 1) == '\n')
    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.")
  ()
{
  if (point == ZV || FETCH_CHAR (point) == '\n')
    return Qt;
  return Qnil;
}

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

  CHECK_NUMBER_COERCE_MARKER (pos, 0);

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

500
  XSETFASTINT (val, FETCH_CHAR (n));
Jim Blandy's avatar
Jim Blandy committed
501 502 503
  return val;
}

Morten Welinder's avatar
Morten Welinder committed
504
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
505 506
  "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\
507
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
508 509 510 511 512
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
513
{
Morten Welinder's avatar
Morten Welinder committed
514 515
  struct passwd *pw;

516 517 518 519 520
  /* 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.  */
  if (INTEGERP (Vuser_name))
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
521 522 523 524 525 526 527

  if (NILP (uid))
    return Vuser_name;

  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
528 529 530 531 532
}

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\
533
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
534
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
535 536
  ()
{
537 538 539 540 541
  /* 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.  */
  if (INTEGERP (Vuser_name))
    init_editfns ();
Jim Blandy's avatar
Jim Blandy committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
  return Vuser_real_name;
}

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

DEFUN ("user-full-name", Fuser_full_name, Suser_full_name, 0, 0, 0,
  "Return the full name of the user logged in, as a string.")
  ()
{
  return Vuser_full_name;
}

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

573 574 575 576
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
577
  return (char *) XSTRING (Vsystem_name)->data;
578 579
}

580 581 582 583 584 585 586
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
587
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
588 589 590 591 592 593 594 595
  "Return the current time, as the number of seconds since 12:00 AM January 1970.\n\
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
596 597
  ()
{
Jim Blandy's avatar
Jim Blandy committed
598 599 600 601
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
602 603 604
  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
605 606

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
607 608 609
}


610 611 612 613 614 615 616 617 618 619 620 621 622
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);
623
      if (CONSP (low))
624 625 626 627 628 629 630
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668
DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 2, 2, 0,
  "Use FORMAT-STRING to format the time TIME.\n\
TIME is specified as (HIGH LOW . IGNORED) or (HIGH . LOW), as from\n\
`current-time' and `file-attributes'.\n\
FORMAT-STRING may contain %-sequences to substitute parts of the time.\n\
%a is replaced by the abbreviated name of the day of week.\n\
%A is replaced by the full name of the day of week.\n\
%b is replaced by the abbreviated name of the month.\n\
%B is replaced by the full name of the month.\n\
%c is a synonym for \"%x %X\".\n\
%C is a locale-specific synonym, which defaults to \"%A, %B %e, %Y\" in the C locale.\n\
%d is replaced by the day of month, zero-padded.\n\
%D is a synonym for \"%m/%d/%y\".\n\
%e is replaced by the day of month, blank-padded.\n\
%h is a synonym for \"%b\".\n\
%H is replaced by the hour (00-23).\n\
%I is replaced by the hour (00-12).\n\
%j is replaced by the day of the year (001-366).\n\
%k is replaced by the hour (0-23), blank padded.\n\
%l is replaced by the hour (1-12), blank padded.\n\
%m is replaced by the month (01-12).\n\
%M is replaced by the minut (00-59).\n\
%n is a synonym for \"\\n\".\n\
%p is replaced by AM or PM, as appropriate.\n\
%r is a synonym for \"%I:%M:%S %p\".\n\
%R is a synonym for \"%H:%M\".\n\
%S is replaced by the seconds (00-60).\n\
%t is a synonym for \"\\t\".\n\
%T is a synonym for \"%H:%M:%S\".\n\
%U is replaced by the week of the year (01-52), first day of week is Sunday.\n\
%w is replaced by the day of week (0-6), Sunday is day 0.\n\
%W is replaced by the week of the year (01-52), first day of week is Monday.\n\
%x is a locale-specific synonym, which defaults to \"%D\" in the C locale.\n\
%X is a locale-specific synonym, which defaults to \"%T\" in the C locale.\n\
%y is replaced by the year without century (00-99).\n\
%Y is replaced by the year with century.\n\
%Z is replaced by the time zone abbreviation.\n\
\n\
669
The number of options reflects the `strftime' function.")
670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
  (format_string, time)
     Lisp_Object format_string, time;
{
  time_t value;
  int size;

  CHECK_STRING (format_string, 1);

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

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

  while (1)
    {
      char *buf = (char *) alloca (size);
687 688
      if (emacs_strftime (buf, size, XSTRING (format_string)->data,
			  localtime (&value)))
689 690 691 692 693 694
	return build_string (buf);
      /* If buffer was too small, make it bigger.  */
      size *= 2;
    }
}

695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710
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\
SEC is an integer between 0 and 59.  MINUTE is an integer between 0 and 59.\n\
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\
(Note that Common Lisp has different meanings for DOW and ZONE.)")
  (specified_time)
     Lisp_Object specified_time;
{
  time_t time_spec;
711
  struct tm save_tm;
712 713 714 715 716 717 718
  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);
719 720 721 722 723 724 725
  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);
  XSETFASTINT (list_args[5], decoded_time->tm_year + 1900);
  XSETFASTINT (list_args[6], decoded_time->tm_wday);
726
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
727 728 729 730 731 732 733 734

  /* 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
    XSETINT (list_args[8], difftm (&save_tm, decoded_time));
735 736 737
  return Flist (9, list_args);
}

738 739
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, 7, 0,
  "Convert SEC, MIN, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
740 741 742 743 744 745
This is the reverse operation of `decode-time', which see.  ZONE defaults\n\
to the current time zone and daylight savings time if not specified; if\n\
specified, it can be either a list (as from `current-time-zone') or an\n\
integer (as from `decode-time'), and is applied without consideration for\n\
daylight savings time.  If YEAR is less than 100, values in the range 0 to\n\
37 are interpreted as in the 21st century, all other values are in the 20th\n\
746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821
century.")
  (sec, min, hour, day, month, year, zone)
     Lisp_Object sec, min, hour, day, month, year, zone;
{
  double universal;
  int fullyear, mon;
  static char days[11] = { 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31 };

  CHECK_NATNUM (sec, 0);
  CHECK_NATNUM (min, 1);
  CHECK_NATNUM (hour, 2);
  CHECK_NATNUM (day, 3);
  CHECK_NATNUM (month, 4);
  CHECK_NATNUM (year, 5);

  fullyear = XINT (year);
  if (fullyear < 100)
    {
      if (fullyear < 38)		/* end of time: 2038-01-19 03:14:08 */
	fullyear += 2000;
      else
	fullyear += 1900;
    }

  if (NILP (zone))
    zone = Fcurrent_time_zone (Qnil);
  if (CONSP (zone))
    zone = Fcar (zone);

  CHECK_NUMBER (zone, 6);

  /* all of these should evaluate to compile-time constants. */
#define MIN 60.0				/*          60 */
#define HOUR (60*MIN)				/*        3600 */
#define DAY (24*HOUR)				/*       86400 */
#define YEAR (365*DAY)				/*    31536000 */
#define YEAR4 (4*YEAR+DAY)			/*   126230400 */
#define YEAR100 (25*YEAR4-DAY)			/*  3155673600 */
#define YEAR400 (4*YEAR100+DAY)			/* 12622780800 */
#define YEAR1900 (4*YEAR400+3*YEAR100)		/* 59958144000 */
#define YEAR1970 (YEAR1900+17*YEAR4+2*YEAR)	/* 62167132800 */
#define LEAPBIAS (59*DAY)			/*     5097600 */

  mon = XINT (month) - 1;
  fullyear--;
  mon += 10;
  fullyear += mon/12;
  mon %= 12;

  universal = XINT (sec) + XINT (min) * MIN + XINT (hour) * HOUR;
  while (mon-- > 0)
    universal += days[mon] * DAY;
  universal += (XINT (day) - 1) * DAY;
  universal += YEAR400 * (fullyear/400);
  fullyear %= 400;
  universal += YEAR100 * (fullyear/100);
  fullyear %= 100;
  universal += YEAR4 * (fullyear/4);
  fullyear %= 4;
  universal += YEAR * fullyear;
  universal -= YEAR1970 - LEAPBIAS;

  return make_time ((int)(universal - XINT (zone)));

#undef MIN
#undef HOUR
#undef DAY
#undef YEAR
#undef YEAR4
#undef YEAR100
#undef YEAR400
#undef YEAR1900
#undef YEAR1970
#undef LEAPBIAS
}

822
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
823
  "Return the current time, as a human-readable string.\n\
824 825 826 827 828 829 830 831 832 833 834 835 836
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;
{
837
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
838
  char buf[30];
839 840
  register char *tem;

841 842
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
843
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
844 845 846 847 848 849

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

  return build_string (buf);
}
850

851 852 853 854
#define TM_YEAR_ORIGIN 1900

/* Yield A - B, measured in seconds.  */
static long
Karl Heuer's avatar
Karl Heuer committed
855
difftm (a, b)
856 857 858 859
     struct tm *a, *b;
{
  int ay = a->tm_year + (TM_YEAR_ORIGIN - 1);
  int by = b->tm_year + (TM_YEAR_ORIGIN - 1);
Karl Heuer's avatar
Karl Heuer committed
860
  /* Some compilers can't handle this as a single return statement.  */
861
  long days = (
Karl Heuer's avatar
Karl Heuer committed
862 863 864 865 866 867 868 869 870 871 872 873
	      /* difference in day of year */
	      a->tm_yday - b->tm_yday
	      /* + intervening leap days */
	      +  ((ay >> 2) - (by >> 2))
	      -  (ay/100 - by/100)
	      +  ((ay/100 >> 2) - (by/100 >> 2))
	      /* + difference in years * 365 */
	      +  (long)(ay-by) * 365
	      );
  return (60*(60*(24*days + (a->tm_hour - b->tm_hour))
	      + (a->tm_min - b->tm_min))
	  + (a->tm_sec - b->tm_sec));
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888
}

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\
889 890
\n\
Some operating systems cannot provide all this information to Emacs;\n\
891
in this case, `current-time-zone' returns a list containing nil for\n\
892
the data it can't find.")
893 894
  (specified_time)
     Lisp_Object specified_time;
895
{
896 897
  time_t value;
  struct tm *t;
898

899
  if (lisp_time_argument (specified_time, &value)
900
      && (t = gmtime (&value)) != 0)
901
    {
902
      struct tm gmt;
903 904
      long offset;
      char *s, buf[6];
905 906 907 908

      gmt = *t;		/* Make a copy, in case localtime modifies *t.  */
      t = localtime (&value);
      offset = difftm (t, &gmt);
909 910 911
      s = 0;
#ifdef HAVE_TM_ZONE
      if (t->tm_zone)
912
	s = (char *)t->tm_zone;
913 914 915 916
#else /* not HAVE_TM_ZONE */
#ifdef HAVE_TZNAME
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
	s = tzname[t->tm_isdst];
917
#endif
918
#endif /* not HAVE_TM_ZONE */
919 920 921
      if (!s)
	{
	  /* No local time zone name is available; use "+-NNNN" instead.  */
922
	  int am = (offset < 0 ? -offset : offset) / 60;
923 924 925 926 927 928 929
	  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);
930 931
}

Jim Blandy's avatar
Jim Blandy committed
932 933 934 935 936 937 938 939

void
insert1 (arg)
     Lisp_Object arg;
{
  Finsert (1, &arg);
}

Jim Blandy's avatar
Jim Blandy committed
940 941 942 943 944 945

/* Callers passing one argument to Finsert need not gcpro the
   argument "array", since the only element of the array will
   not be used after calling insert or insert_from_string, so
   we don't care if it gets trashed.  */

Jim Blandy's avatar
Jim Blandy committed
946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961
DEFUN ("insert", Finsert, Sinsert, 0, MANY, 0,
  "Insert the arguments, either strings or characters, at point.\n\
Point moves forward so that it ends up after the inserted text.\n\
Any other markers at the point of insertion remain before the text.")
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
{
  register int argnum;
  register Lisp_Object tem;
  char str[1];

  for (argnum = 0; argnum < nargs; argnum++)
    {
      tem = args[argnum];
    retry:
962
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
963 964 965 966
	{
	  str[0] = XINT (tem);
	  insert (str, 1);
	}
967
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
968
	{
969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997
	  insert_from_string (tem, 0, XSTRING (tem)->size, 0);
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

DEFUN ("insert-and-inherit", Finsert_and_inherit, Sinsert_and_inherit,
   0, MANY, 0,
  "Insert the arguments at point, inheriting properties from adjoining text.\n\
Point moves forward so that it ends up after the inserted text.\n\
Any other markers at the point of insertion remain before the text.")
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
{
  register int argnum;
  register Lisp_Object tem;
  char str[1];

  for (argnum = 0; argnum < nargs; argnum++)
    {
      tem = args[argnum];
    retry:
998
      if (INTEGERP (tem))
999 1000
	{
	  str[0] = XINT (tem);
1001
	  insert_and_inherit (str, 1);
1002
	}
1003
      else if (STRINGP (tem))
1004 1005
	{
	  insert_from_string (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

DEFUN ("insert-before-markers", Finsert_before_markers, Sinsert_before_markers, 0, MANY, 0,
  "Insert strings or characters at point, relocating markers after the text.\n\
Point moves forward so that it ends up after the inserted text.\n\
Any other markers at the point of insertion also end up after the text.")
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
{
  register int argnum;
  register Lisp_Object tem;
  char str[1];

  for (argnum = 0; argnum < nargs; argnum++)
    {
      tem = args[argnum];
    retry:
1033
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
1034 1035 1036 1037
	{
	  str[0] = XINT (tem);
	  insert_before_markers (str, 1);
	}
1038
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
1039
	{
1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069
	  insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 0);
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

DEFUN ("insert-before-markers-and-inherit",
  Finsert_and_inherit_before_markers, Sinsert_and_inherit_before_markers,
  0, MANY, 0,
  "Insert text at point, relocating markers and inheriting properties.\n\
Point moves forward so that it ends up after the inserted text.\n\
Any other markers at the point of insertion also end up after the text.")
  (nargs, args)
     int nargs;
     register Lisp_Object *args;
{
  register int argnum;
  register Lisp_Object tem;
  char str[1];

  for (argnum = 0; argnum < nargs; argnum++)
    {
      tem = args[argnum];
    retry:
1070
      if (INTEGERP (tem))
1071 1072
	{
	  str[0] = XINT (tem);
1073
	  insert_before_markers_and_inherit (str, 1);
1074
	}
1075
      else if (STRINGP (tem))
1076 1077
	{
	  insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

1089
DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
1090 1091
  "Insert COUNT (second arg) copies of CHAR (first arg).\n\
Point and all markers are affected as in the function `insert'.\n\
1092 1093 1094 1095 1096
Both arguments are required.\n\
The optional third arg INHERIT, if non-nil, says to inherit text properties\n\
from adjoining text, if those properties are sticky.")
  (chr, count, inherit)
       Lisp_Object chr, count, inherit;
Jim Blandy's avatar
Jim Blandy committed
1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113
{
  register unsigned char *string;
  register int strlen;
  register int i, n;

  CHECK_NUMBER (chr, 0);
  CHECK_NUMBER (count, 1);

  n = XINT (count);
  if (n <= 0)
    return Qnil;
  strlen = min (n, 256);
  string = (unsigned char *) alloca (strlen);
  for (i = 0; i < strlen; i++)
    string[i] = XFASTINT (chr);
  while (n >= strlen)
    {
1114 1115 1116 1117
      if (!NILP (inherit))
	insert_and_inherit (string, strlen);
      else
	insert (string, strlen);
Jim Blandy's avatar
Jim Blandy committed
1118 1119 1120
      n -= strlen;
    }
  if (n > 0)
1121 1122 1123 1124 1125 1126
    {
      if (!NILP (inherit))
	insert_and_inherit (string, n);
      else
	insert (string, n);
    }
Jim Blandy's avatar
Jim Blandy committed
1127 1128 1129 1130
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
1131 1132 1133
/* Making strings from buffer contents.  */

/* Return a Lisp_String containing the text of the current buffer from
1134
   START to END.  If text properties are in use and the current buffer
1135
   has properties in the range specified, the resulting string will also
1136
   have them.
Jim Blandy's avatar
Jim Blandy committed
1137 1138 1139 1140 1141 1142 1143 1144

   We don't want to use plain old make_string here, because it calls
   make_uninit_string, which can cause the buffer arena to be
   compacted.  make_string has no way of knowing that the data has
   been moved, and thus copies the wrong data into the string.  This
   doesn't effect most of the other users of make_string, so it should
   be left as is.  But we should use this function when conjuring
   buffer substrings.  */
1145

Jim Blandy's avatar
Jim Blandy committed
1146 1147 1148 1149
Lisp_Object
make_buffer_string (start, end)
     int start, end;
{
1150
  Lisp_Object result, tem, tem1;
Jim Blandy's avatar
Jim Blandy committed
1151 1152 1153 1154 1155 1156 1157

  if (start < GPT && GPT < end)
    move_gap (start);

  result = make_uninit_string (end - start);
  bcopy (&FETCH_CHAR (start), XSTRING (result)->data, end - start);

1158
  tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
1159
  tem1 = Ftext_properties_at (make_number (start), Qnil);
1160 1161

#ifdef USE_TEXT_PROPERTIES
1162
  if (XINT (tem) != end || !NILP (tem1))
1163 1164
    copy_intervals_to_string (result, current_buffer, start, end - start);
#endif
1165

Jim Blandy's avatar
Jim Blandy committed
1166 1167
  return result;
}
Jim Blandy's avatar
Jim Blandy committed
1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181

DEFUN ("buffer-substring", Fbuffer_substring, Sbuffer_substring, 2, 2, 0,
  "Return the contents of part of the current buffer as a string.\n\
The two arguments START and END are character positions;\n\
they can be in either order.")
  (b, e)
     Lisp_Object b, e;
{
  register int beg, end;

  validate_region (&b, &e);
  beg = XINT (b);
  end = XINT (e);

Jim Blandy's avatar
Jim Blandy committed
1182
  return make_buffer_string (beg, end);
Jim Blandy's avatar
Jim Blandy committed
1183 1184 1185
}

DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
1186 1187 1188
  "Return the contents of the current buffer as a string.\n\
If narrowing is in effect, this function returns only the visible part\n\
of the buffer.")
Jim Blandy's avatar
Jim Blandy committed
1189 1190
  ()
{
Jim Blandy's avatar
Jim Blandy committed
1191
  return make_buffer_string (BEGV, ZV);
Jim Blandy's avatar
Jim Blandy committed
1192 1193 1194 1195
}

DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
  1, 3, 0,
1196
  "Insert before point a substring of the contents of buffer BUFFER.\n\
Jim Blandy's avatar
Jim Blandy committed
1197 1198 1199 1200 1201 1202
BUFFER may be a buffer or a buffer name.\n\
Arguments START and END are character numbers specifying the substring.\n\
They default to the beginning and the end of BUFFER.")
  (buf, b, e)
     Lisp_Object buf, b, e;
{
1203
  register int beg, end, temp;
Jim Blandy's avatar
Jim Blandy committed
1204
  register struct buffer *bp;
1205
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1206

1207 1208 1209 1210
  buffer = Fget_buffer (buf);
  if (NILP (buffer))
    nsberror (buf);
  bp = XBUFFER (buffer);
Jim Blandy's avatar
Jim Blandy committed
1211

Jim Blandy's avatar
Jim Blandy committed
1212
  if (NILP (b))
Jim Blandy's avatar
Jim Blandy committed
1213 1214 1215 1216 1217 1218
    beg = BUF_BEGV (bp);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (b, 0);
      beg = XINT (b);
    }
Jim Blandy's avatar
Jim Blandy committed
1219
  if (NILP (e))
Jim Blandy's avatar
Jim Blandy committed
1220 1221 1222 1223 1224 1225 1226 1227
    end = BUF_ZV (bp);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (e, 1);
      end = XINT (e);
    }

  if (beg > end)
1228
    temp = beg, beg = end, end = temp;
Jim Blandy's avatar
Jim Blandy committed
1229

1230
  if (!(BUF_BEGV (bp) <= beg && end <= BUF_ZV (bp)))
Jim Blandy's avatar
Jim Blandy committed
1231 1232
    args_out_of_range (b, e);

1233
  insert_from_buffer (bp, beg, end - beg, 0);
Jim Blandy's avatar
Jim Blandy committed
1234 1235
  return Qnil;
}
1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260

DEFUN ("compare-buffer-substrings", Fcompare_buffer_substrings, Scompare_buffer_substrings,
  6, 6, 0,
  "Compare two substrings of two buffers; return result as number.\n\
the value is -N if first string is less after N-1 chars,\n\
+N if first string is greater after N-1 chars, or 0 if strings match.\n\
Each substring is represented as three arguments: BUFFER, START and END.\n\
That makes six args in all, three for each substring.\n\n\
The value of `case-fold-search' in the current buffer\n\
determines whether case is significant or ignored.")
  (buffer1, start1, end1, buffer2, start2, end2)
     Lisp_Object buffer1, start1, end1, buffer2, start2, end2;
{
  register int begp1, endp1, begp2, endp2, temp, len1, len2, length, i;
  register struct buffer *bp1, *bp2;
  register unsigned char *trt
    = (!NILP (current_buffer->case_fold_search)
       ? XSTRING (current_buffer->case_canon_table)->data : 0);

  /* Find the first buffer and its substring.  */

  if (NILP (buffer1))
    bp1 = current_buffer;
  else
    {
1261 1262 1263 1264 1265
      Lisp_Object buf1;
      buf1 = Fget_buffer (buffer1);
      if (NILP (buf1))
	nsberror (buffer1);
      bp1 = XBUFFER (buf1);
1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296
    }

  if (NILP (start1))
    begp1 = BUF_BEGV (bp1);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (start1, 1);
      begp1 = XINT (start1);
    }
  if (NILP (end1))
    endp1 = BUF_ZV (bp1);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (end1, 2);
      endp1 = XINT (end1);
    }

  if (begp1 > endp1)
    temp = begp1, begp1 = endp1, endp1 = temp;

  if (!(BUF_BEGV (bp1) <= begp1
	&& begp1 <= endp1
        && endp1 <= BUF_ZV (bp1)))
    args_out_of_range (start1, end1);

  /* Likewise for second substring.  */

  if (NILP (buffer2))
    bp2 = current_buffer;
  else
    {
1297 1298 1299 1300
      Lisp_Object buf2;
      buf2 = Fget_buffer (buffer2);
      if (NILP (buf2))
	nsberror (buffer2);
1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357
      bp2 = XBUFFER (buffer2);
    }

  if (NILP (start2))
    begp2 = BUF_BEGV (bp2);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (start2, 4);
      begp2 = XINT (start2);
    }
  if (NILP (end2))
    endp2 = BUF_ZV (bp2);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (end2, 5);
      endp2 = XINT (end2);
    }

  if (begp2 > endp2)
    temp = begp2, begp2 = endp2, endp2 = temp;

  if (!(BUF_BEGV (bp2) <= begp2
	&& begp2 <= endp2
        && endp2 <= BUF_ZV (bp2)))
    args_out_of_range (start2, end2);

  len1 = endp1 - begp1;
  len2 = endp2 - begp2;
  length = len1;
  if (len2 < length)
    length = len2;

  for (i = 0; i < length; i++)
    {
      int c1 = *BUF_CHAR_ADDRESS (bp1, begp1 + i);
      int c2 = *BUF_CHAR_ADDRESS (bp2, begp2 + i);
      if (trt)
	{
	  c1 = trt[c1];
	  c2 = trt[c2];
	}
      if (c1 < c2)
	return make_number (- 1 - i);
      if (c1 > c2)
	return make_number (i + 1);
    }

  /* The strings match as far as they go.
     If one is shorter, that one is less.  */
  if (length < len1)
    return make_number (length + 1);
  else if (length < len2)
    return make_number (- length - 1);

  /* Same length too => they are equal.  */
  return make_number (0);
}
Jim Blandy's avatar
Jim Blandy committed
1358

1359 1360 1361 1362 1363 1364 1365
static Lisp_Object
subst_char_in_region_unwind (arg)
     Lisp_Object arg;
{
  return current_buffer->undo_list = arg;
}

Jim Blandy's avatar
Jim Blandy committed
1366 1367 1368 1369 1370 1371 1372 1373 1374
DEFUN ("subst-char-in-region", Fsubst_char_in_region,
  Ssubst_char_in_region, 4, 5, 0,
  "From START to END, replace FROMCHAR with TOCHAR each time it occurs.\n\
If optional arg NOUNDO is non-nil, don't record this change for undo\n\
and don't mark the buffer as really changed.")
  (start, end, fromchar, tochar, noundo)
     Lisp_Object start, end, fromchar, tochar, noundo;
{
  register int pos, stop, look;
1375
  int changed = 0;
1376
  int count = specpdl_ptr - specpdl;
Jim Blandy's avatar
Jim Blandy committed
1377 1378 1379 1380 1381 1382 1383 1384 1385

  validate_region (&start, &end);
  CHECK_NUMBER (fromchar, 2);
  CHECK_NUMBER (tochar, 3);

  pos = XINT (start);
  stop = XINT (end);
  look = XINT (fromchar);

1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
  /* If we don't want undo, turn off putting stuff on the list.
     That's faster than getting rid of things,
     and it prevents even the entry for a first change.  */
  if (!NILP (noundo))
    {
      record_unwind_protect (subst_char_in_region_unwind,
			     current_buffer->undo_list);
      current_buffer->undo_list = Qt;
    }

Jim Blandy's avatar
Jim Blandy committed
1396 1397 1398 1399
  while (pos < stop)
    {
      if (FETCH_CHAR (pos) == look)
	{
1400 1401 1402
	  if (! changed)
	    {
	      modify_region (current_buffer, XINT (start), stop);
1403 1404 1405

	      if (! NILP (noundo))
		{
1406 1407
		  if (MODIFF - 1 == SAVE_MODIFF)
		    SAVE_MODIFF++;
1408 1409 1410 1411 1412
		  if (MODIFF - 1 == current_buffer->auto_save_modified)
		    current_buffer->auto_save_modified++;
		}

 	      changed = 1;
1413 1414
	    }