editfns.c 68.5 KB
Newer Older
Jim Blandy's avatar
Jim Blandy committed
1
/* Lisp functions pertaining to editing.
Karl Heuer's avatar
Karl Heuer committed
2
   Copyright (C) 1985,86,87,89,93,94,95 Free Software Foundation, Inc.
Jim Blandy's avatar
Jim Blandy committed
3 4 5 6 7

This file is part of GNU Emacs.

GNU Emacs is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
Karl Heuer's avatar
Karl Heuer committed
8
the Free Software Foundation; either version 2, or (at your option)
Jim Blandy's avatar
Jim Blandy committed
9 10 11 12 13 14 15 16 17 18 19 20
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
/* Some static data, and a function to initialize it for each run */

Lisp_Object Vsystem_name;
47 48 49
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
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
#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.)  */
74
  Vuser_real_login_name = build_string (pw ? pw->pw_name : "root");
Morten Welinder's avatar
Morten Welinder committed
75
#else
76
  Vuser_real_login_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
  if (!user_name)
    {
      pw = (struct passwd *) getpwuid (geteuid ());
      user_name = (char *) (pw ? pw->pw_name : "unknown");
    }
93
  Vuser_login_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.  */
97
  tem = Fstring_equal (Vuser_login_name, Vuser_real_login_name);
Jim Blandy's avatar
Jim Blandy committed
98
  if (NILP (tem))
99
    pw = (struct passwd *) getpwnam (XSTRING (Vuser_login_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 112
      r = (unsigned char *) alloca (strlen (p)
				    + XSTRING (Vuser_login_name)->size + 1);
Jim Blandy's avatar
Jim Blandy committed
113 114
      bcopy (p, r, q - p);
      r[q - p] = 0;
115
      strcat (r, XSTRING (Vuser_login_name)->data);
Jim Blandy's avatar
Jim Blandy committed
116 117 118 119 120
      r[q - p] = UPCASE (r[q - p]);
      strcat (r, q + 1);
      Vuser_full_name = build_string (r);
    }
#endif /* AMPERSAND_FULL_NAME */
121

122
  p = (unsigned char *) getenv ("NAME");
123 124
  if (p)
    Vuser_full_name = build_string (p);
Jim Blandy's avatar
Jim Blandy committed
125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149
}

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)
150
    XSETFASTINT (val, ((unsigned char *) p->data)[0]);
Jim Blandy's avatar
Jim Blandy committed
151
  else
152
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
  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;
172
  XSETFASTINT (temp, point);
Jim Blandy's avatar
Jim Blandy committed
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 210
  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;
{
211
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
212
  register Lisp_Object m;
213 214 215
  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
216
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
217
  if (NILP (m)) error ("There is no region now");
Jim Blandy's avatar
Jim Blandy committed
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
  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));
}

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

Lisp_Object
save_excursion_save ()
{
250 251
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
252 253

  return Fcons (Fpoint_marker (),
254
		Fcons (Fcopy_marker (current_buffer->mark),
255 256
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
257 258 259 260 261 262
}

Lisp_Object
save_excursion_restore (info)
     register Lisp_Object info;
{
263
  register Lisp_Object tem, tem1, omark, nmark;
Jim Blandy's avatar
Jim Blandy committed
264 265 266 267 268 269

  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
270
  if (NILP (tem))
Jim Blandy's avatar
Jim Blandy committed
271 272 273 274 275 276
    return Qnil;
  Fset_buffer (tem);
  tem = Fcar (info);
  Fgoto_char (tem);
  unchain_marker (tem);
  tem = Fcar (Fcdr (info));
277
  omark = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
278
  Fset_marker (current_buffer->mark, tem, Fcurrent_buffer ());
279
  nmark = Fmarker_position (tem);
Jim Blandy's avatar
Jim Blandy committed
280 281
  unchain_marker (tem);
  tem = Fcdr (Fcdr (info));
282 283 284 285
#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.  */
286 287
  tem1 = Fcar (tem);
  if (!NILP (tem1)
288
      && current_buffer != XBUFFER (XWINDOW (selected_window)->buffer))
Jim Blandy's avatar
Jim Blandy committed
289
    Fswitch_to_buffer (Fcurrent_buffer (), Qnil);
290
#endif /* 0 */
291 292 293

  tem1 = current_buffer->mark_active;
  current_buffer->mark_active = Fcdr (tem);
294 295
  if (!NILP (Vrun_hooks))
    {
296 297
      /* If mark is active now, and either was not active
	 or was at a different place, run the activate hook.  */
298
      if (! NILP (current_buffer->mark_active))
299 300 301 302 303
	{
	  if (! EQ (omark, nmark))
	    call1 (Vrun_hooks, intern ("activate-mark-hook"));
	}
      /* If mark has ceased to be active, run deactivate hook.  */
304 305 306
      else if (! NILP (tem1))
	call1 (Vrun_hooks, intern ("deactivate-mark-hook"));
    }
Jim Blandy's avatar
Jim Blandy committed
307 308 309 310 311 312 313
  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\
314 315
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
316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332
  (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;
333
  XSETFASTINT (temp, Z - BEG);
Jim Blandy's avatar
Jim Blandy committed
334 335 336 337 338
  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
339
This is 1, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
340 341 342
  ()
{
  Lisp_Object temp;
343
  XSETFASTINT (temp, BEGV);
Jim Blandy's avatar
Jim Blandy committed
344 345 346 347 348
  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
349
This is the beginning, unless narrowing (a buffer restriction) is in effect.")
Jim Blandy's avatar
Jim Blandy committed
350 351 352 353 354 355 356
  ()
{
  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
357 358
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
359 360 361
  ()
{
  Lisp_Object temp;
362
  XSETFASTINT (temp, ZV);
Jim Blandy's avatar
Jim Blandy committed
363 364 365 366 367
  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
368 369
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
370 371 372 373 374
  ()
{
  return buildmark (ZV);
}

Jim Blandy's avatar
Jim Blandy committed
375 376 377
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
378 379 380
  ()
{
  Lisp_Object temp;
Jim Blandy's avatar
Jim Blandy committed
381
  if (point >= ZV)
382
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
383
  else
384
    XSETFASTINT (temp, FETCH_CHAR (point));
Jim Blandy's avatar
Jim Blandy committed
385 386 387
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
388 389 390
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
391 392 393 394
  ()
{
  Lisp_Object temp;
  if (point <= BEGV)
395
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
396
  else
397
    XSETFASTINT (temp, FETCH_CHAR (point - 1));
Jim Blandy's avatar
Jim Blandy committed
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
  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;

455
  XSETFASTINT (val, FETCH_CHAR (n));
Jim Blandy's avatar
Jim Blandy committed
456 457 458
  return val;
}

Morten Welinder's avatar
Morten Welinder committed
459
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
460 461
  "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\
462
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
463 464 465 466 467
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
468
{
Morten Welinder's avatar
Morten Welinder committed
469 470
  struct passwd *pw;

471 472 473
  /* 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.  */
474
  if (INTEGERP (Vuser_login_name))
475
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
476 477

  if (NILP (uid))
478
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
479 480 481 482

  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
483 484 485 486 487
}

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\
488
This ignores the environment variables LOGNAME and USER, so it differs from\n\
Karl Heuer's avatar
Karl Heuer committed
489
`user-login-name' when running under `su'.")
Jim Blandy's avatar
Jim Blandy committed
490 491
  ()
{
492 493 494
  /* 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.  */
495
  if (INTEGERP (Vuser_login_name))
496
    init_editfns ();
497
  return Vuser_real_login_name;
Jim Blandy's avatar
Jim Blandy committed
498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527
}

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

528 529 530 531
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
532
  return (char *) XSTRING (Vsystem_name)->data;
533 534
}

535 536 537 538 539 540 541
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
542
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
Jim Blandy's avatar
Jim Blandy committed
543 544 545 546 547 548 549 550
  "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
551 552
  ()
{
Jim Blandy's avatar
Jim Blandy committed
553 554 555 556
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
557 558 559
  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
560 561

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
562 563 564
}


565 566 567 568 569 570 571 572 573 574 575 576 577
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);
578
      if (CONSP (low))
579 580 581 582 583 584 585
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623
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\
624
The number of options reflects the `strftime' function.")
625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641
  (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);
642 643
      if (emacs_strftime (buf, size, XSTRING (format_string)->data,
			  localtime (&value)))
644 645 646 647 648 649
	return build_string (buf);
      /* If buffer was too small, make it bigger.  */
      size *= 2;
    }
}

650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665
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;
666
  struct tm save_tm;
667 668 669 670 671 672 673
  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);
674 675 676 677 678 679 680
  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);
681
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
682 683 684 685 686 687 688 689

  /* 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));
690 691 692
  return Flist (9, list_args);
}

693 694 695
static char days_per_month[11]
  = { 31, 30, 31, 30, 31, 31, 30, 31, 30, 31, 31 };

696
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, 7, 0,
697
  "Convert SEC, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
698 699 700 701
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\
702
daylight savings time.\n\
703
Year numbers less than 100 are treated just like other year numbers.\n\
Karl Heuer's avatar
Karl Heuer committed
704
If you want them to stand for years above 1900, you must do that yourself.")
705 706
  (sec, minute, hour, day, month, year, zone)
     Lisp_Object sec, minute, hour, day, month, year, zone;
707
{
708 709
  time_t time;
  int fullyear, mon, days, seconds, tz = 0;
710 711

  CHECK_NATNUM (sec, 0);
712
  CHECK_NATNUM (minute, 1);
713 714 715 716 717 718 719
  CHECK_NATNUM (hour, 2);
  CHECK_NATNUM (day, 3);
  CHECK_NATNUM (month, 4);
  CHECK_NATNUM (year, 5);

  fullyear = XINT (year);

Richard M. Stallman's avatar
Richard M. Stallman committed
720 721 722
  /* Adjust incoming datespec to epoch = March 1, year 0.
     The "date" March 1, year 0, is an abstraction used purely for its
     computational convenience; year 0 never existed.  */
723 724
  mon = XINT (month) - 1 + 10;
  fullyear += mon/12 - 1;
725 726
  mon %= 12;

727 728 729 730
  days = XINT (day) - 1;		/* day of month */
  while (mon-- > 0)			/* day of year */
    days += days_per_month[mon];
  days += 146097 * (fullyear/400);	/* 400 years = 146097 days */
731
  fullyear %= 400;
732
  days += 36524 * (fullyear/100);	/* 100 years = 36524 days */
733
  fullyear %= 100;
734
  days += 1461 * (fullyear/4);		/* 4 years = 1461 days */
735
  fullyear %= 4;
736 737 738 739 740 741
  days += 365 * fullyear;		/* 1 year = 365 days */

  /* Adjust computed datespec to epoch = January 1, 1970.  */
  days += 59;				/* March 1 is 59th day.  */
  days -= 719527;			/* 1970 years = 719527 days */

742
  seconds = XINT (sec) + 60 * XINT (minute) + 3600 * XINT (hour);
743 744 745 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

  if (sizeof (time_t) == 4
      && ((days+(seconds/86400) > 24854) || (days+(seconds/86400) < -24854)))
    error ("the specified time is outside the representable range");

  time = days * 86400 + seconds;

  /* We have the correct value for UTC.  Adjust for timezones.  */
  if (NILP (zone))
    {
      struct tm gmt, *t;
      time_t adjusted_time;
      int adjusted_tz;
      /* If the system does not use timezones, gmtime returns 0, and we
	 already have the correct value, by definition.  */
      if ((t = gmtime (&time)) != 0)
	{
	  gmt = *t;
	  t = localtime (&time);
	  tz = difftm (t, &gmt);
	  /* The timezone returned is that at the specified Universal Time,
	     not the local time, which is what we want.  Adjust, repeat.  */
	  adjusted_time = time - tz;
	  gmt = *gmtime (&adjusted_time); /* this is safe now */
	  t = localtime (&adjusted_time);
	  adjusted_tz = difftm (t, &gmt);
	  /* In case of discrepancy, adjust again for extra accuracy.  */
	  if (adjusted_tz != tz)
	    {
	      adjusted_time = time - adjusted_tz;
	      gmt = *gmtime (&adjusted_time);
	      t = localtime (&adjusted_time);
	      adjusted_tz = difftm (t, &gmt);
	    }
	  tz = adjusted_tz;
	}
    }
  else 
    {
      if (CONSP (zone))
	zone = Fcar (zone);
      CHECK_NUMBER (zone, 6);
      tz = XINT (zone);
    }

  return make_time (time - tz);
789 790
}

791
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
792
  "Return the current time, as a human-readable string.\n\
793 794 795 796 797 798 799 800 801 802 803 804 805
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;
{
806
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
807
  char buf[30];
808 809
  register char *tem;

810 811
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
812
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
813 814 815 816 817 818

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

  return build_string (buf);
}
819

820 821 822 823
#define TM_YEAR_ORIGIN 1900

/* Yield A - B, measured in seconds.  */
static long
Karl Heuer's avatar
Karl Heuer committed
824
difftm (a, b)
825 826 827 828
     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
829
  /* Some compilers can't handle this as a single return statement.  */
830
  long days = (
Karl Heuer's avatar
Karl Heuer committed
831 832 833 834 835 836 837 838 839 840 841 842
	      /* 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));
843 844 845 846 847 848 849 850 851 852 853 854 855 856 857
}

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\
858 859
\n\
Some operating systems cannot provide all this information to Emacs;\n\
860
in this case, `current-time-zone' returns a list containing nil for\n\
861
the data it can't find.")
862 863
  (specified_time)
     Lisp_Object specified_time;
864
{
865 866
  time_t value;
  struct tm *t;
867

868
  if (lisp_time_argument (specified_time, &value)
869
      && (t = gmtime (&value)) != 0)
870
    {
871
      struct tm gmt;
872 873
      long offset;
      char *s, buf[6];
874 875 876 877

      gmt = *t;		/* Make a copy, in case localtime modifies *t.  */
      t = localtime (&value);
      offset = difftm (t, &gmt);
878 879 880
      s = 0;
#ifdef HAVE_TM_ZONE
      if (t->tm_zone)
881
	s = (char *)t->tm_zone;
882 883 884 885
#else /* not HAVE_TM_ZONE */
#ifdef HAVE_TZNAME
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
	s = tzname[t->tm_isdst];
886
#endif
887
#endif /* not HAVE_TM_ZONE */
888 889 890
      if (!s)
	{
	  /* No local time zone name is available; use "+-NNNN" instead.  */
891
	  int am = (offset < 0 ? -offset : offset) / 60;
892 893 894 895 896 897 898
	  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);
899 900
}

Jim Blandy's avatar
Jim Blandy committed
901 902 903 904 905 906 907 908

void
insert1 (arg)
     Lisp_Object arg;
{
  Finsert (1, &arg);
}

Jim Blandy's avatar
Jim Blandy committed
909 910 911 912 913 914

/* 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
915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930
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:
931
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
932 933 934 935
	{
	  str[0] = XINT (tem);
	  insert (str, 1);
	}
936
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
937
	{
938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966
	  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:
967
      if (INTEGERP (tem))
968 969
	{
	  str[0] = XINT (tem);
970
	  insert_and_inherit (str, 1);
971
	}
972
      else if (STRINGP (tem))
973 974
	{
	  insert_from_string (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001
	}
      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:
1002
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
1003 1004 1005 1006
	{
	  str[0] = XINT (tem);
	  insert_before_markers (str, 1);
	}
1007
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
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 1033 1034 1035 1036 1037 1038
	  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:
1039
      if (INTEGERP (tem))
1040 1041
	{
	  str[0] = XINT (tem);
1042
	  insert_before_markers_and_inherit (str, 1);
1043
	}
1044
      else if (STRINGP (tem))
1045 1046
	{
	  insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

1058
DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
Jim Blandy's avatar
Jim Blandy committed
1059 1060
  "Insert COUNT (second arg) copies of CHAR (first arg).\n\
Point and all markers are affected as in the function `insert'.\n\
1061 1062 1063 1064 1065
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
1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082
{
  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)
    {
1083 1084 1085 1086
      if (!NILP (inherit))
	insert_and_inherit (string, strlen);
      else
	insert (string, strlen);
Jim Blandy's avatar
Jim Blandy committed
1087 1088 1089
      n -= strlen;
    }
  if (n > 0)
1090 1091 1092 1093 1094 1095
    {
      if (!NILP (inherit))
	insert_and_inherit (string, n);
      else
	insert (string, n);
    }
Jim Blandy's avatar
Jim Blandy committed
1096 1097 1098 1099
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
1100 1101 1102
/* Making strings from buffer contents.  */

/* Return a Lisp_String containing the text of the current buffer from
1103
   START to END.  If text properties are in use and the current buffer
1104
   has properties in the range specified, the resulting string will also
1105
   have them.
Jim Blandy's avatar
Jim Blandy committed
1106 1107 1108 1109 1110 1111 1112 1113

   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.  */
1114

Jim Blandy's avatar
Jim Blandy committed
1115 1116 1117 1118
Lisp_Object
make_buffer_string (start, end)
     int start, end;
{
1119
  Lisp_Object result, tem, tem1;
Jim Blandy's avatar
Jim Blandy committed
1120 1121 1122 1123 1124 1125 1126

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

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

1127
  tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
1128
  tem1 = Ftext_properties_at (make_number (start), Qnil);
1129 1130

#ifdef USE_TEXT_PROPERTIES
1131
  if (XINT (tem) != end || !NILP (tem1))
1132 1133
    copy_intervals_to_string (result, current_buffer, start, end - start);
#endif
1134

Jim Blandy's avatar
Jim Blandy committed
1135 1136
  return result;
}
Jim Blandy's avatar
Jim Blandy committed
1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150

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
1151
  return make_buffer_string (beg, end);
Jim Blandy's avatar
Jim Blandy committed
1152 1153 1154
}

DEFUN ("buffer-string", Fbuffer_string, Sbuffer_string, 0, 0, 0,
1155 1156 1157
  "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
1158 1159
  ()
{
Jim Blandy's avatar
Jim Blandy committed
1160
  return make_buffer_string (BEGV, ZV);
Jim Blandy's avatar
Jim Blandy committed
1161 1162 1163 1164
}

DEFUN ("insert-buffer-substring", Finsert_buffer_substring, Sinsert_buffer_substring,
  1, 3, 0,
1165
  "Insert before point a substring of the contents of buffer BUFFER.\n\
Jim Blandy's avatar
Jim Blandy committed
1166 1167 1168 1169 1170 1171
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;
{
1172
  register int beg, end, temp;
Jim Blandy's avatar
Jim Blandy committed
1173
  register struct buffer *bp;
1174
  Lisp_Object buffer;
Jim Blandy's avatar
Jim Blandy committed
1175

1176 1177 1178 1179
  buffer = Fget_buffer (buf);
  if (NILP (buffer))
    nsberror (buf);
  bp = XBUFFER (buffer);
Jim Blandy's avatar
Jim Blandy committed
1180

Jim Blandy's avatar
Jim Blandy committed
1181
  if (NILP (b))
Jim Blandy's avatar
Jim Blandy committed
1182 1183 1184 1185 1186 1187
    beg = BUF_BEGV (bp);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (b, 0);
      beg = XINT (b);
    }
Jim Blandy's avatar
Jim Blandy committed
1188
  if (NILP (e))
Jim Blandy's avatar
Jim Blandy committed
1189 1190 1191 1192 1193 1194 1195 1196
    end = BUF_ZV (bp);
  else
    {
      CHECK_NUMBER_COERCE_MARKER (e, 1);
      end = XINT (e);
    }

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

1199
  if (!(BUF_BEGV (bp) <= beg && end <= BUF_ZV (bp)))
Jim Blandy's avatar
Jim Blandy committed
1200 1201
    args_out_of_range (b, e);

1202
  insert_from_buffer (bp, beg, end - beg, 0);
Jim Blandy's avatar
Jim Blandy committed
1203 1204
  return Qnil;
}
1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229

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
    {
1230 1231 1232 1233 1234
      Lisp_Object buf1;
      buf1 = Fget_buffer (buffer1);
      if (NILP (buf1))
	nsberror (buffer1);
      bp1 = XBUFFER (buf1);
1235 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 1261 1262 1263 1264 1265
    }

  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
    {
1266 1267 1268 1269
      Lisp_Object buf2;
      buf2 = Fget_buffer (buffer2);
      if (NILP (buf2))
	nsberror (buffer2);
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 1297 1298 1299 1300 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
      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
1327

1328 1329 1330 1331 1332 1333 1334
static Lisp_Obje