editfns.c 72.3 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 42
extern char **environ;
extern Lisp_Object make_time ();
43
extern void insert_from_buffer ();
44
static long difftm ();
45
static void update_buffer_properties ();
46
void set_time_zone_rule ();
47 48 49 50

Lisp_Object Vbuffer_access_fontify_functions;
Lisp_Object Qbuffer_access_fontify_functions;
Lisp_Object Vbuffer_access_fontified_property;
51

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

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

void
init_editfns ()
{
Jim Blandy's avatar
Jim Blandy committed
62
  char *user_name;
Jim Blandy's avatar
Jim Blandy committed
63 64 65 66 67 68
  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.  */
69
  init_system_name ();
Jim Blandy's avatar
Jim Blandy committed
70 71 72 73 74 75 76 77

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

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

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

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

143
  c = XINT (character);
Jim Blandy's avatar
Jim Blandy committed
144 145 146 147 148
  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.")
149 150
  (string)
     register Lisp_Object string;
Jim Blandy's avatar
Jim Blandy committed
151 152 153
{
  register Lisp_Object val;
  register struct Lisp_String *p;
154
  CHECK_STRING (string, 0);
Jim Blandy's avatar
Jim Blandy committed
155

156
  p = XSTRING (string);
Jim Blandy's avatar
Jim Blandy committed
157
  if (p->size)
158
    XSETFASTINT (val, ((unsigned char *) p->data)[0]);
Jim Blandy's avatar
Jim Blandy committed
159
  else
160
    XSETFASTINT (val, 0);
Jim Blandy's avatar
Jim Blandy committed
161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179
  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;
180
  XSETFASTINT (temp, point);
Jim Blandy's avatar
Jim Blandy committed
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
  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).")
206 207
  (position)
     register Lisp_Object position;
Jim Blandy's avatar
Jim Blandy committed
208
{
209
  CHECK_NUMBER_COERCE_MARKER (position, 0);
Jim Blandy's avatar
Jim Blandy committed
210

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

static Lisp_Object
region_limit (beginningp)
     int beginningp;
{
219
  extern Lisp_Object Vmark_even_if_inactive; /* Defined in callint.c. */
Jim Blandy's avatar
Jim Blandy committed
220
  register Lisp_Object m;
221 222 223
  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
224
  m = Fmarker_position (current_buffer->mark);
Jim Blandy's avatar
Jim Blandy committed
225
  if (NILP (m)) error ("There is no region now");
Jim Blandy's avatar
Jim Blandy committed
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
  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 ()
{
258 259
  register int visible = (XBUFFER (XWINDOW (selected_window)->buffer)
			  == current_buffer);
Jim Blandy's avatar
Jim Blandy committed
260 261

  return Fcons (Fpoint_marker (),
262
		Fcons (Fcopy_marker (current_buffer->mark, Qnil),
263 264
		       Fcons (visible ? Qt : Qnil,
			      current_buffer->mark_active)));		       
Jim Blandy's avatar
Jim Blandy committed
265 266 267 268 269 270
}

Lisp_Object
save_excursion_restore (info)
     register Lisp_Object info;
{
271
  register Lisp_Object tem, tem1, omark, nmark;
Jim Blandy's avatar
Jim Blandy committed
272 273 274 275 276 277

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

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

Jim Blandy's avatar
Jim Blandy committed
383 384 385
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
386 387 388
  ()
{
  Lisp_Object temp;
Jim Blandy's avatar
Jim Blandy committed
389
  if (point >= ZV)
390
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
391
  else
392
    XSETFASTINT (temp, FETCH_CHAR (point));
Jim Blandy's avatar
Jim Blandy committed
393 394 395
  return temp;
}

Jim Blandy's avatar
Jim Blandy committed
396 397 398
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
399 400 401 402
  ()
{
  Lisp_Object temp;
  if (point <= BEGV)
403
    XSETFASTINT (temp, 0);
Jim Blandy's avatar
Jim Blandy committed
404
  else
405
    XSETFASTINT (temp, FETCH_CHAR (point - 1));
Jim Blandy's avatar
Jim Blandy committed
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 455 456 457 458 459 460 461 462
  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;

463
  XSETFASTINT (val, FETCH_CHAR (n));
Jim Blandy's avatar
Jim Blandy committed
464 465 466
  return val;
}

Morten Welinder's avatar
Morten Welinder committed
467
DEFUN ("user-login-name", Fuser_login_name, Suser_login_name, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
468 469
  "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\
470
Also, if the environment variable LOGNAME or USER is set,\n\
Morten Welinder's avatar
Morten Welinder committed
471 472 473 474 475
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
476
{
Morten Welinder's avatar
Morten Welinder committed
477 478
  struct passwd *pw;

479 480 481
  /* 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.  */
482
  if (INTEGERP (Vuser_login_name))
483
    init_editfns ();
Morten Welinder's avatar
Morten Welinder committed
484 485

  if (NILP (uid))
486
    return Vuser_login_name;
Morten Welinder's avatar
Morten Welinder committed
487 488 489 490

  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
491 492 493 494 495
}

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

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

536 537 538 539
/* For the benefit of callers who don't want to include lisp.h */
char *
get_system_name ()
{
540
  return (char *) XSTRING (Vsystem_name)->data;
541 542
}

543 544 545 546 547 548 549
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
550
DEFUN ("current-time", Fcurrent_time, Scurrent_time, 0, 0, 0,
551
  "Return the current time, as the number of seconds since 1970-01-01 00:00:00.\n\
Jim Blandy's avatar
Jim Blandy committed
552 553 554 555 556 557 558
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
559 560
  ()
{
Jim Blandy's avatar
Jim Blandy committed
561 562 563 564
  EMACS_TIME t;
  Lisp_Object result[3];

  EMACS_GET_TIME (t);
565 566 567
  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
568 569

  return Flist (3, result);
Jim Blandy's avatar
Jim Blandy committed
570 571 572
}


573 574 575 576 577 578 579 580 581 582 583 584 585
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);
586
      if (CONSP (low))
587 588 589 590 591 592 593
	low = Fcar (low);
      CHECK_NUMBER (low, 0);
      *result = (XINT (high) << 16) + (XINT (low) & 0xffff);
      return *result >> 16 == XINT (high);
    }
}

594
DEFUN ("format-time-string", Fformat_time_string, Sformat_time_string, 1, 2, 0,
595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614
  "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\
615
%M is replaced by the minute (00-59).\n\
616 617 618 619
%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\
620
%S is replaced by the second (00-60).\n\
621 622 623 624 625 626 627 628 629 630 631
%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\
632
The number of options reflects the `strftime' function.")
633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649
  (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);
650
      *buf = 1;
651
      if (emacs_strftime (buf, size, XSTRING (format_string)->data,
652 653
			  localtime (&value))
	  || !*buf)
654 655 656 657 658 659
	return build_string (buf);
      /* If buffer was too small, make it bigger.  */
      size *= 2;
    }
}

660 661 662 663 664
DEFUN ("decode-time", Fdecode_time, Sdecode_time, 0, 1, 0,
  "Decode a time value as (SEC MINUTE HOUR DAY MONTH YEAR DOW DST ZONE).\n\
The optional SPECIFIED-TIME should be a list of (HIGH LOW . IGNORED)\n\
or (HIGH . LOW), as from `current-time' and `file-attributes', or `nil'\n\
to use the current time.  The list has the following nine members:\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
665 666
SEC is an integer between 0 and 60; SEC is 60 for a leap second, which\n\
only some operating systems support.  MINUTE is an integer between 0 and 59.\n\
667 668 669 670 671
HOUR is an integer between 0 and 23.  DAY is an integer between 1 and 31.\n\
MONTH is an integer between 1 and 12.  YEAR is an integer indicating the\n\
four-digit year.  DOW is the day of week, an integer between 0 and 6, where\n\
0 is Sunday.  DST is t if daylight savings time is effect, otherwise nil.\n\
ZONE is an integer indicating the number of seconds east of Greenwich.\n\
Richard M. Stallman's avatar
Richard M. Stallman committed
672
\(Note that Common Lisp has different meanings for DOW and ZONE.)")
673 674 675 676
  (specified_time)
     Lisp_Object specified_time;
{
  time_t time_spec;
677
  struct tm save_tm;
678 679 680 681 682 683 684
  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);
685 686 687 688 689 690 691
  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);
692
  list_args[7] = (decoded_time->tm_isdst)? Qt : Qnil;
693 694 695 696 697 698 699 700

  /* 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));
701 702 703
  return Flist (9, list_args);
}

704
DEFUN ("encode-time", Fencode_time, Sencode_time, 6, 7, 0,
705
  "Convert SECOND, MINUTE, HOUR, DAY, MONTH, YEAR and ZONE to internal time.\n\
706
This is the reverse operation of `decode-time', which see.  ZONE defaults\n\
707 708 709 710 711 712
to the current time zone rule if not specified; if specified, it can\n\
be a string (as from `set-time-zone-rule'), or it can be a list\n\
(as from `current-time-zone') or an integer (as from `decode-time')\n\
applied without consideration for daylight savings time.\n\
Out-of-range values for SEC, MINUTE, HOUR, DAY, or MONTH are allowed;\n\
for example, a DAY of 0 means the day preceding the given month.\n\
713
Year numbers less than 100 are treated just like other year numbers.\n\
714
If you want them to stand for years in this century, you must do that yourself.")
715 716
  (second, minute, hour, day, month, year, zone)
     Lisp_Object second, minute, hour, day, month, year, zone;
717
{
718
  time_t time;
719 720
  struct tm tm;

721
  CHECK_NUMBER (second, 0);
722 723 724 725 726 727
  CHECK_NUMBER (minute, 1);
  CHECK_NUMBER (hour, 2);
  CHECK_NUMBER (day, 3);
  CHECK_NUMBER (month, 4);
  CHECK_NUMBER (year, 5);

728
  tm.tm_sec = XINT (second);
729 730 731 732 733 734 735 736 737
  tm.tm_min = XINT (minute);
  tm.tm_hour = XINT (hour);
  tm.tm_mday = XINT (day);
  tm.tm_mon = XINT (month) - 1;
  tm.tm_year = XINT (year) - 1900;
  tm.tm_isdst = -1;

  if (CONSP (zone))
    zone = Fcar (zone);
738
  if (NILP (zone))
739 740
    time = mktime (&tm);
  else
741
    {
742 743 744 745 746
      char tzbuf[100];
      char *tzstring;
      char **oldenv = environ, **newenv;
      
      if (STRINGP (zone))
747
	tzstring = (char *) XSTRING (zone)->data;
748
      else if (INTEGERP (zone))
749
	{
750 751 752 753
	  int abszone = abs (XINT (zone));
	  sprintf (tzbuf, "XXX%s%d:%02d:%02d", "-" + (XINT (zone) < 0),
		   abszone / (60*60), (abszone/60) % 60, abszone % 60);
	  tzstring = tzbuf;
754
	}
755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770
      else
	error ("Invalid time zone specification");

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

      time = mktime (&tm);

      /* Restore TZ to previous value.  */
      newenv = environ;
      environ = oldenv;
      free (newenv);
#ifdef LOCALTIME_CACHE
      tzset ();
#endif
771 772
    }

773 774 775 776
  if (time == (time_t) -1)
    error ("Specified time is not representable");

  return make_time (time);
777 778
}

779
DEFUN ("current-time-string", Fcurrent_time_string, Scurrent_time_string, 0, 1, 0,
Jim Blandy's avatar
Jim Blandy committed
780
  "Return the current time, as a human-readable string.\n\
781 782 783 784 785 786 787 788 789 790 791 792 793
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;
{
794
  time_t value;
Jim Blandy's avatar
Jim Blandy committed
795
  char buf[30];
796 797
  register char *tem;

798 799
  if (! lisp_time_argument (specified_time, &value))
    value = -1;
800
  tem = (char *) ctime (&value);
Jim Blandy's avatar
Jim Blandy committed
801 802 803 804 805 806

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

  return build_string (buf);
}
807

808 809 810 811
#define TM_YEAR_ORIGIN 1900

/* Yield A - B, measured in seconds.  */
static long
Karl Heuer's avatar
Karl Heuer committed
812
difftm (a, b)
813 814 815 816
     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
817
  /* Some compilers can't handle this as a single return statement.  */
818
  long days = (
Karl Heuer's avatar
Karl Heuer committed
819 820 821 822 823 824 825 826 827 828 829 830
	      /* 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));
831 832 833 834 835 836 837 838 839 840 841 842 843 844 845
}

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\
846 847
\n\
Some operating systems cannot provide all this information to Emacs;\n\
848
in this case, `current-time-zone' returns a list containing nil for\n\
849
the data it can't find.")
850 851
  (specified_time)
     Lisp_Object specified_time;
852
{
853 854
  time_t value;
  struct tm *t;
855

856
  if (lisp_time_argument (specified_time, &value)
857
      && (t = gmtime (&value)) != 0)
858
    {
859
      struct tm gmt;
860 861
      long offset;
      char *s, buf[6];
862 863 864 865

      gmt = *t;		/* Make a copy, in case localtime modifies *t.  */
      t = localtime (&value);
      offset = difftm (t, &gmt);
866 867 868
      s = 0;
#ifdef HAVE_TM_ZONE
      if (t->tm_zone)
869
	s = (char *)t->tm_zone;
870 871 872 873
#else /* not HAVE_TM_ZONE */
#ifdef HAVE_TZNAME
      if (t->tm_isdst == 0 || t->tm_isdst == 1)
	s = tzname[t->tm_isdst];
874
#endif
875
#endif /* not HAVE_TM_ZONE */
876 877 878
      if (!s)
	{
	  /* No local time zone name is available; use "+-NNNN" instead.  */
879
	  int am = (offset < 0 ? -offset : offset) / 60;
880 881 882 883 884 885 886
	  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);
887 888
}

889 890 891 892 893
/* This holds the value of `environ' produced by the previous
   call to Fset_time_zone_rule, or 0 if Fset_time_zone_rule
   has never been called.  */
static char **environbuf;

894 895 896 897 898 899 900 901 902 903 904 905 906
DEFUN ("set-time-zone-rule", Fset_time_zone_rule, Sset_time_zone_rule, 1, 1, 0,
  "Set the local time zone using TZ, a string specifying a time zone rule.\n\
If TZ is nil, use implementation-defined default time zone information.")
  (tz)
     Lisp_Object tz;
{
  char *tzstring;

  if (NILP (tz))
    tzstring = 0;
  else
    {
      CHECK_STRING (tz, 0);
907
      tzstring = (char *) XSTRING (tz)->data;
908 909
    }

910 911 912 913 914 915 916 917 918 919 920
  set_time_zone_rule (tzstring);
  if (environbuf)
    free (environbuf);
  environbuf = environ;

  return Qnil;
}

/* Set the local time zone rule to TZSTRING.
   This allocates memory into `environ', which it is the caller's
   responsibility to free.  */
921
void
922 923 924 925 926 927
set_time_zone_rule (tzstring)
     char *tzstring;
{
  int envptrs;
  char **from, **to, **newenv;

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
  for (from = environ; *from; from++)
    continue;
  envptrs = from - environ + 2;
  newenv = to = (char **) xmalloc (envptrs * sizeof (char *)
				   + (tzstring ? strlen (tzstring) + 4 : 0));
  if (tzstring)
    {
      char *t = (char *) (to + envptrs);
      strcpy (t, "TZ=");
      strcat (t, tzstring);
      *to++ = t;
    }

  for (from = environ; *from; from++)
    if (strncmp (*from, "TZ=", 3) != 0)
      *to++ = *from;
  *to = 0;

  environ = newenv;

#ifdef LOCALTIME_CACHE
  tzset ();
#endif
}
Jim Blandy's avatar
Jim Blandy committed
952 953 954 955 956 957 958 959

void
insert1 (arg)
     Lisp_Object arg;
{
  Finsert (1, &arg);
}

Jim Blandy's avatar
Jim Blandy committed
960 961 962 963 964 965

/* 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
966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981
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:
982
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
983 984 985 986
	{
	  str[0] = XINT (tem);
	  insert (str, 1);
	}
987
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
988
	{
989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017
	  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:
1018
      if (INTEGERP (tem))
1019 1020
	{
	  str[0] = XINT (tem);
1021
	  insert_and_inherit (str, 1);
1022
	}
1023
      else if (STRINGP (tem))
1024 1025
	{
	  insert_from_string (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052
	}
      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:
1053
      if (INTEGERP (tem))
Jim Blandy's avatar
Jim Blandy committed
1054 1055 1056 1057
	{
	  str[0] = XINT (tem);
	  insert_before_markers (str, 1);
	}
1058
      else if (STRINGP (tem))
Jim Blandy's avatar
Jim Blandy committed
1059
	{
1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
	  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:
1090
      if (INTEGERP (tem))
1091 1092
	{
	  str[0] = XINT (tem);
1093
	  insert_before_markers_and_inherit (str, 1);
1094
	}
1095
      else if (STRINGP (tem))
1096 1097
	{
	  insert_from_string_before_markers (tem, 0, XSTRING (tem)->size, 1);
Jim Blandy's avatar
Jim Blandy committed
1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108
	}
      else
	{
	  tem = wrong_type_argument (Qchar_or_string_p, tem);
	  goto retry;
	}
    }

  return Qnil;
}

1109
DEFUN ("insert-char", Finsert_char, Sinsert_char, 2, 3, 0,
1110
  "Insert COUNT (second arg) copies of CHARACTER (first arg).\n\
Jim Blandy's avatar
Jim Blandy committed
1111
Point and all markers are affected as in the function `insert'.\n\
1112 1113 1114
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.")
1115 1116
  (character, count, inherit)
       Lisp_Object character, count, inherit;
Jim Blandy's avatar
Jim Blandy committed
1117 1118 1119 1120 1121
{
  register unsigned char *string;
  register int strlen;
  register int i, n;

1122
  CHECK_NUMBER (character, 0);
Jim Blandy's avatar
Jim Blandy committed
1123 1124 1125 1126 1127 1128 1129 1130
  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++)
1131
    string[i] = XFASTINT (character);
Jim Blandy's avatar
Jim Blandy committed
1132 1133
  while (n >= strlen)
    {
1134 1135 1136 1137
      if (!NILP (inherit))
	insert_and_inherit (string, strlen);
      else
	insert (string, strlen);
Jim Blandy's avatar
Jim Blandy committed
1138 1139 1140
      n -= strlen;
    }
  if (n > 0)
1141 1142 1143 1144 1145 1146
    {
      if (!NILP (inherit))
	insert_and_inherit (string, n);
      else
	insert (string, n);
    }
Jim Blandy's avatar
Jim Blandy committed
1147 1148 1149 1150
  return Qnil;
}


Jim Blandy's avatar
Jim Blandy committed
1151 1152 1153
/* Making strings from buffer contents.  */

/* Return a Lisp_String containing the text of the current buffer from
1154
   START to END.  If text properties are in use and the current buffer
1155
   has properties in the range specified, the resulting string will also
1156
   have them, if PROPS is nonzero.
Jim Blandy's avatar
Jim Blandy committed
1157 1158 1159 1160 1161 1162 1163 1164

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

Jim Blandy's avatar
Jim Blandy committed
1166
Lisp_Object
1167
make_buffer_string (start, end, props)
Jim Blandy's avatar
Jim Blandy committed
1168
     int start, end;
1169
     int props;
Jim Blandy's avatar
Jim Blandy committed
1170
{
1171
  Lisp_Object result, tem, tem1;
Jim Blandy's avatar
Jim Blandy committed
1172 1173 1174 1175 1176 1177 1178

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

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

1179
  /* If desired, update and copy the text properties.  */
1180
#ifdef USE_TEXT_PROPERTIES
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190
  if (props)
    {
      update_buffer_properties (start, end);

      tem = Fnext_property_change (make_number (start), Qnil, make_number (end));
      tem1 = Ftext_properties_at (make_number (start), Qnil);

      if (XINT (tem) != end || !NILP (tem1))
	copy_intervals_to_string (result, current_buffer, start, end - start);
    }
1191
#endif
1192

Jim Blandy's avatar
Jim Blandy committed
1193 1194
  return result;
}
Jim Blandy's avatar
Jim Blandy committed
1195

1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222
/* Call Vbuffer_access_fontify_functions for the range START ... END
   in the current buffer, if necessary.  */

static void
update_buffer_properties (start, end)
     int start, end;
{
#ifdef USE_TEXT_PROPERTIES
  /* If this buffer has some access functions,
     call them, specifying the range of the buffer being accessed.  */
  if (!NILP (Vbuffer_access_fontify_functions))
    {
      Lisp_Object args[3];
      Lisp_Object tem;

      args[0] = Qbuffer_access_fontify_functions;
      XSETINT (args[1], start);
      XSETINT (args[2], end);

      /* But don't call them if we can tell that the work
	 has already been done.  */
      if (!NILP (Vbuffer_access_fontified_property))
	{
	  tem = Ftext_property_any (args[1], args[2],
				    Vbuffer_access_fontified_property,
				    Qnil, Qnil);
	  if (! NILP (tem))
1223
	    Frun_hook_with_args (3, args);
1224 1225
	}
      else
1226
	Frun_hook_with_args (3, args);
1227 1228 1229 1230
    }
#endif
}

Jim Blandy's avatar
Jim Blandy committed
1231 1232 1233 1234
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.")
1235 1236
  (start, end)
     Lisp_Object start, end;