Comment changes.
[bpt/emacs.git] / src / buffer.c
... / ...
CommitLineData
1/* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 86, 87, 88, 89, 93, 94, 95, 97, 98, 99,
3 2000, 01, 02, 03, 04, 2005 Free Software Foundation, Inc.
4
5This file is part of GNU Emacs.
6
7GNU Emacs is free software; you can redistribute it and/or modify
8it under the terms of the GNU General Public License as published by
9the Free Software Foundation; either version 2, or (at your option)
10any later version.
11
12GNU Emacs is distributed in the hope that it will be useful,
13but WITHOUT ANY WARRANTY; without even the implied warranty of
14MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15GNU General Public License for more details.
16
17You should have received a copy of the GNU General Public License
18along with GNU Emacs; see the file COPYING. If not, write to
19the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20Boston, MA 02111-1307, USA. */
21
22#include <config.h>
23
24#include <sys/types.h>
25#include <sys/stat.h>
26#include <sys/param.h>
27#include <errno.h>
28#include <stdio.h>
29
30#ifndef USE_CRT_DLL
31extern int errno;
32#endif
33
34#ifndef MAXPATHLEN
35/* in 4.1 [probably SunOS? -stef] , param.h fails to define this. */
36#define MAXPATHLEN 1024
37#endif /* not MAXPATHLEN */
38
39#ifdef HAVE_UNISTD_H
40#include <unistd.h>
41#endif
42
43#include "lisp.h"
44#include "intervals.h"
45#include "window.h"
46#include "commands.h"
47#include "buffer.h"
48#include "charset.h"
49#include "region-cache.h"
50#include "indent.h"
51#include "blockinput.h"
52#include "keyboard.h"
53#include "keymap.h"
54#include "frame.h"
55
56struct buffer *current_buffer; /* the current buffer */
57
58/* First buffer in chain of all buffers (in reverse order of creation).
59 Threaded through ->next. */
60
61struct buffer *all_buffers;
62
63/* This structure holds the default values of the buffer-local variables
64 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
65 The default value occupies the same slot in this structure
66 as an individual buffer's value occupies in that buffer.
67 Setting the default value also goes through the alist of buffers
68 and stores into each buffer that does not say it has a local value. */
69
70DECL_ALIGN (struct buffer, buffer_defaults);
71
72/* A Lisp_Object pointer to the above, used for staticpro */
73
74static Lisp_Object Vbuffer_defaults;
75
76/* This structure marks which slots in a buffer have corresponding
77 default values in buffer_defaults.
78 Each such slot has a nonzero value in this structure.
79 The value has only one nonzero bit.
80
81 When a buffer has its own local value for a slot,
82 the entry for that slot (found in the same slot in this structure)
83 is turned on in the buffer's local_flags array.
84
85 If a slot in this structure is -1, then even though there may
86 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
87 and the corresponding slot in buffer_defaults is not used.
88
89 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
90 but there is a default value which is copied into each buffer.
91
92 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
93 zero, that is a bug */
94
95struct buffer buffer_local_flags;
96
97/* This structure holds the names of symbols whose values may be
98 buffer-local. It is indexed and accessed in the same way as the above. */
99
100DECL_ALIGN (struct buffer, buffer_local_symbols);
101
102/* A Lisp_Object pointer to the above, used for staticpro */
103static Lisp_Object Vbuffer_local_symbols;
104
105/* This structure holds the required types for the values in the
106 buffer-local slots. If a slot contains Qnil, then the
107 corresponding buffer slot may contain a value of any type. If a
108 slot contains an integer, then prospective values' tags must be
109 equal to that integer (except nil is always allowed).
110 When a tag does not match, the function
111 buffer_slot_type_mismatch will signal an error.
112
113 If a slot here contains -1, the corresponding variable is read-only. */
114struct buffer buffer_local_types;
115
116/* Flags indicating which built-in buffer-local variables
117 are permanent locals. */
118static char buffer_permanent_local_flags[MAX_PER_BUFFER_VARS];
119
120/* Number of per-buffer variables used. */
121
122int last_per_buffer_idx;
123
124Lisp_Object Fset_buffer ();
125void set_buffer_internal ();
126void set_buffer_internal_1 ();
127static void call_overlay_mod_hooks ();
128static void swap_out_buffer_local_variables ();
129static void reset_buffer_local_variables ();
130
131/* Alist of all buffer names vs the buffers. */
132/* This used to be a variable, but is no longer,
133 to prevent lossage due to user rplac'ing this alist or its elements. */
134Lisp_Object Vbuffer_alist;
135
136/* Functions to call before and after each text change. */
137Lisp_Object Vbefore_change_functions;
138Lisp_Object Vafter_change_functions;
139
140Lisp_Object Vtransient_mark_mode;
141
142/* t means ignore all read-only text properties.
143 A list means ignore such a property if its value is a member of the list.
144 Any non-nil value means ignore buffer-read-only. */
145Lisp_Object Vinhibit_read_only;
146
147/* List of functions to call that can query about killing a buffer.
148 If any of these functions returns nil, we don't kill it. */
149Lisp_Object Vkill_buffer_query_functions;
150Lisp_Object Qkill_buffer_query_functions;
151
152/* List of functions to call before changing an unmodified buffer. */
153Lisp_Object Vfirst_change_hook;
154
155Lisp_Object Qfirst_change_hook;
156Lisp_Object Qbefore_change_functions;
157Lisp_Object Qafter_change_functions;
158Lisp_Object Qucs_set_table_for_input;
159
160/* If nonzero, all modification hooks are suppressed. */
161int inhibit_modification_hooks;
162
163Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
164
165Lisp_Object Qprotected_field;
166
167Lisp_Object QSFundamental; /* A string "Fundamental" */
168
169Lisp_Object Qkill_buffer_hook;
170
171Lisp_Object Qget_file_buffer;
172
173Lisp_Object Qoverlayp;
174
175Lisp_Object Qpriority, Qwindow, Qevaporate, Qbefore_string, Qafter_string;
176
177Lisp_Object Qmodification_hooks;
178Lisp_Object Qinsert_in_front_hooks;
179Lisp_Object Qinsert_behind_hooks;
180
181static void alloc_buffer_text P_ ((struct buffer *, size_t));
182static void free_buffer_text P_ ((struct buffer *b));
183static struct Lisp_Overlay * copy_overlays P_ ((struct buffer *, struct Lisp_Overlay *));
184static void modify_overlay P_ ((struct buffer *, EMACS_INT, EMACS_INT));
185static Lisp_Object buffer_lisp_local_variables P_ ((struct buffer *));
186
187
188/* For debugging; temporary. See set_buffer_internal. */
189/* Lisp_Object Qlisp_mode, Vcheck_symbol; */
190
191void
192nsberror (spec)
193 Lisp_Object spec;
194{
195 if (STRINGP (spec))
196 error ("No buffer named %s", SDATA (spec));
197 error ("Invalid buffer argument");
198}
199\f
200DEFUN ("buffer-live-p", Fbuffer_live_p, Sbuffer_live_p, 1, 1, 0,
201 doc: /* Return non-nil if OBJECT is a buffer which has not been killed.
202Value is nil if OBJECT is not a buffer or if it has been killed. */)
203 (object)
204 Lisp_Object object;
205{
206 return ((BUFFERP (object) && ! NILP (XBUFFER (object)->name))
207 ? Qt : Qnil);
208}
209
210DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 1, 0,
211 doc: /* Return a list of all existing live buffers.
212If the optional arg FRAME is a frame, we return the buffer list
213in the proper order for that frame: the buffers in FRAME's `buffer-list'
214frame parameter come first, followed by the rest of the buffers. */)
215 (frame)
216 Lisp_Object frame;
217{
218 Lisp_Object framelist, general;
219 general = Fmapcar (Qcdr, Vbuffer_alist);
220
221 if (FRAMEP (frame))
222 {
223 Lisp_Object tail;
224
225 CHECK_FRAME (frame);
226
227 framelist = Fcopy_sequence (XFRAME (frame)->buffer_list);
228
229 /* Remove from GENERAL any buffer that duplicates one in FRAMELIST. */
230 tail = framelist;
231 while (! NILP (tail))
232 {
233 general = Fdelq (XCAR (tail), general);
234 tail = XCDR (tail);
235 }
236 return nconc2 (framelist, general);
237 }
238
239 return general;
240}
241
242/* Like Fassoc, but use Fstring_equal to compare
243 (which ignores text properties),
244 and don't ever QUIT. */
245
246static Lisp_Object
247assoc_ignore_text_properties (key, list)
248 register Lisp_Object key;
249 Lisp_Object list;
250{
251 register Lisp_Object tail;
252 for (tail = list; CONSP (tail); tail = XCDR (tail))
253 {
254 register Lisp_Object elt, tem;
255 elt = XCAR (tail);
256 tem = Fstring_equal (Fcar (elt), key);
257 if (!NILP (tem))
258 return elt;
259 }
260 return Qnil;
261}
262
263DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
264 doc: /* Return the buffer named NAME (a string).
265If there is no live buffer named NAME, return nil.
266NAME may also be a buffer; if so, the value is that buffer. */)
267 (name)
268 register Lisp_Object name;
269{
270 if (BUFFERP (name))
271 return name;
272 CHECK_STRING (name);
273
274 return Fcdr (assoc_ignore_text_properties (name, Vbuffer_alist));
275}
276
277DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
278 doc: /* Return the buffer visiting file FILENAME (a string).
279The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.
280If there is no such live buffer, return nil.
281See also `find-buffer-visiting'. */)
282 (filename)
283 register Lisp_Object filename;
284{
285 register Lisp_Object tail, buf, tem;
286 Lisp_Object handler;
287
288 CHECK_STRING (filename);
289 filename = Fexpand_file_name (filename, Qnil);
290
291 /* If the file name has special constructs in it,
292 call the corresponding file handler. */
293 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
294 if (!NILP (handler))
295 return call2 (handler, Qget_file_buffer, filename);
296
297 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
298 {
299 buf = Fcdr (XCAR (tail));
300 if (!BUFFERP (buf)) continue;
301 if (!STRINGP (XBUFFER (buf)->filename)) continue;
302 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
303 if (!NILP (tem))
304 return buf;
305 }
306 return Qnil;
307}
308
309Lisp_Object
310get_truename_buffer (filename)
311 register Lisp_Object filename;
312{
313 register Lisp_Object tail, buf, tem;
314
315 for (tail = Vbuffer_alist; CONSP (tail); tail = XCDR (tail))
316 {
317 buf = Fcdr (XCAR (tail));
318 if (!BUFFERP (buf)) continue;
319 if (!STRINGP (XBUFFER (buf)->file_truename)) continue;
320 tem = Fstring_equal (XBUFFER (buf)->file_truename, filename);
321 if (!NILP (tem))
322 return buf;
323 }
324 return Qnil;
325}
326
327/* Incremented for each buffer created, to assign the buffer number. */
328int buffer_count;
329
330DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
331 doc: /* Return the buffer named NAME, or create such a buffer and return it.
332A new buffer is created if there is no live buffer named NAME.
333If NAME starts with a space, the new buffer does not keep undo information.
334If NAME is a buffer instead of a string, then it is the value returned.
335The value is never nil. */)
336 (name)
337 register Lisp_Object name;
338{
339 register Lisp_Object buf;
340 register struct buffer *b;
341
342 buf = Fget_buffer (name);
343 if (!NILP (buf))
344 return buf;
345
346 if (SCHARS (name) == 0)
347 error ("Empty string for buffer name is not allowed");
348
349 b = (struct buffer *) allocate_buffer ();
350
351 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
352
353 /* An ordinary buffer uses its own struct buffer_text. */
354 b->text = &b->own_text;
355 b->base_buffer = 0;
356
357 BUF_GAP_SIZE (b) = 20;
358 BLOCK_INPUT;
359 /* We allocate extra 1-byte at the tail and keep it always '\0' for
360 anchoring a search. */
361 alloc_buffer_text (b, BUF_GAP_SIZE (b) + 1);
362 UNBLOCK_INPUT;
363 if (! BUF_BEG_ADDR (b))
364 buffer_memory_full ();
365
366 BUF_PT (b) = BEG;
367 BUF_GPT (b) = BEG;
368 BUF_BEGV (b) = BEG;
369 BUF_ZV (b) = BEG;
370 BUF_Z (b) = BEG;
371 BUF_PT_BYTE (b) = BEG_BYTE;
372 BUF_GPT_BYTE (b) = BEG_BYTE;
373 BUF_BEGV_BYTE (b) = BEG_BYTE;
374 BUF_ZV_BYTE (b) = BEG_BYTE;
375 BUF_Z_BYTE (b) = BEG_BYTE;
376 BUF_MODIFF (b) = 1;
377 BUF_OVERLAY_MODIFF (b) = 1;
378 BUF_SAVE_MODIFF (b) = 1;
379 BUF_INTERVALS (b) = 0;
380 BUF_UNCHANGED_MODIFIED (b) = 1;
381 BUF_OVERLAY_UNCHANGED_MODIFIED (b) = 1;
382 BUF_END_UNCHANGED (b) = 0;
383 BUF_BEG_UNCHANGED (b) = 0;
384 *(BUF_GPT_ADDR (b)) = *(BUF_Z_ADDR (b)) = 0; /* Put an anchor '\0'. */
385
386 b->newline_cache = 0;
387 b->width_run_cache = 0;
388 b->width_table = Qnil;
389 b->prevent_redisplay_optimizations_p = 1;
390
391 /* Put this on the chain of all buffers including killed ones. */
392 b->next = all_buffers;
393 all_buffers = b;
394
395 /* An ordinary buffer normally doesn't need markers
396 to handle BEGV and ZV. */
397 b->pt_marker = Qnil;
398 b->begv_marker = Qnil;
399 b->zv_marker = Qnil;
400
401 name = Fcopy_sequence (name);
402 STRING_SET_INTERVALS (name, NULL_INTERVAL);
403 b->name = name;
404
405 if (SREF (name, 0) != ' ')
406 b->undo_list = Qnil;
407 else
408 b->undo_list = Qt;
409
410 reset_buffer (b);
411 reset_buffer_local_variables (b, 1);
412
413 b->mark = Fmake_marker ();
414 BUF_MARKERS (b) = NULL;
415 b->name = name;
416
417 /* Put this in the alist of all live buffers. */
418 XSETBUFFER (buf, b);
419 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
420
421 /* An error in calling the function here (should someone redfine it)
422 can lead to infinite regress until you run out of stack. rms
423 says that's not worth protecting against. */
424 if (!NILP (Ffboundp (Qucs_set_table_for_input)))
425 /* buf is on buffer-alist, so no gcpro. */
426 call1 (Qucs_set_table_for_input, buf);
427
428 return buf;
429}
430
431
432/* Return a list of overlays which is a copy of the overlay list
433 LIST, but for buffer B. */
434
435static struct Lisp_Overlay *
436copy_overlays (b, list)
437 struct buffer *b;
438 struct Lisp_Overlay *list;
439{
440 Lisp_Object buffer;
441 struct Lisp_Overlay *result = NULL, *tail = NULL;
442
443 XSETBUFFER (buffer, b);
444
445 for (; list; list = list->next)
446 {
447 Lisp_Object overlay, start, end, old_overlay;
448 EMACS_INT charpos;
449
450 XSETMISC (old_overlay, list);
451 charpos = marker_position (OVERLAY_START (old_overlay));
452 start = Fmake_marker ();
453 Fset_marker (start, make_number (charpos), buffer);
454 XMARKER (start)->insertion_type
455 = XMARKER (OVERLAY_START (old_overlay))->insertion_type;
456
457 charpos = marker_position (OVERLAY_END (old_overlay));
458 end = Fmake_marker ();
459 Fset_marker (end, make_number (charpos), buffer);
460 XMARKER (end)->insertion_type
461 = XMARKER (OVERLAY_END (old_overlay))->insertion_type;
462
463 overlay = allocate_misc ();
464 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
465 OVERLAY_START (overlay) = start;
466 OVERLAY_END (overlay) = end;
467 OVERLAY_PLIST (overlay) = Fcopy_sequence (OVERLAY_PLIST (old_overlay));
468 XOVERLAY (overlay)->next = NULL;
469
470 if (tail)
471 tail = tail->next = XOVERLAY (overlay);
472 else
473 result = tail = XOVERLAY (overlay);
474 }
475
476 return result;
477}
478
479
480/* Clone per-buffer values of buffer FROM.
481
482 Buffer TO gets the same per-buffer values as FROM, with the
483 following exceptions: (1) TO's name is left untouched, (2) markers
484 are copied and made to refer to TO, and (3) overlay lists are
485 copied. */
486
487static void
488clone_per_buffer_values (from, to)
489 struct buffer *from, *to;
490{
491 Lisp_Object to_buffer, tem;
492 int offset;
493
494 XSETBUFFER (to_buffer, to);
495
496 for (offset = PER_BUFFER_VAR_OFFSET (name) + sizeof (Lisp_Object);
497 offset < sizeof *to;
498 offset += sizeof (Lisp_Object))
499 {
500 Lisp_Object obj;
501
502 obj = PER_BUFFER_VALUE (from, offset);
503 if (MARKERP (obj))
504 {
505 struct Lisp_Marker *m = XMARKER (obj);
506 obj = Fmake_marker ();
507 XMARKER (obj)->insertion_type = m->insertion_type;
508 set_marker_both (obj, to_buffer, m->charpos, m->bytepos);
509 }
510
511 PER_BUFFER_VALUE (to, offset) = obj;
512 }
513
514 bcopy (from->local_flags, to->local_flags, sizeof to->local_flags);
515
516 to->overlays_before = copy_overlays (to, from->overlays_before);
517 to->overlays_after = copy_overlays (to, from->overlays_after);
518
519 /* Get (a copy of) the alist of Lisp-level local variables of FROM
520 and install that in TO. */
521 to->local_var_alist = buffer_lisp_local_variables (from);
522}
523
524DEFUN ("make-indirect-buffer", Fmake_indirect_buffer, Smake_indirect_buffer,
525 2, 3,
526 "bMake indirect buffer (to buffer): \nBName of indirect buffer: ",
527 doc: /* Create and return an indirect buffer for buffer BASE-BUFFER, named NAME.
528BASE-BUFFER should be a live buffer, or the name of an existing buffer.
529NAME should be a string which is not the name of an existing buffer.
530Optional argument CLONE non-nil means preserve BASE-BUFFER's state,
531such as major and minor modes, in the indirect buffer.
532CLONE nil means the indirect buffer's state is reset to default values. */)
533 (base_buffer, name, clone)
534 Lisp_Object base_buffer, name, clone;
535{
536 Lisp_Object buf, tem;
537 struct buffer *b;
538
539 CHECK_STRING (name);
540 buf = Fget_buffer (name);
541 if (!NILP (buf))
542 error ("Buffer name `%s' is in use", SDATA (name));
543
544 tem = base_buffer;
545 base_buffer = Fget_buffer (base_buffer);
546 if (NILP (base_buffer))
547 error ("No such buffer: `%s'", SDATA (tem));
548 if (NILP (XBUFFER (base_buffer)->name))
549 error ("Base buffer has been killed");
550
551 if (SCHARS (name) == 0)
552 error ("Empty string for buffer name is not allowed");
553
554 b = (struct buffer *) allocate_buffer ();
555 b->size = sizeof (struct buffer) / sizeof (EMACS_INT);
556
557 if (XBUFFER (base_buffer)->base_buffer)
558 b->base_buffer = XBUFFER (base_buffer)->base_buffer;
559 else
560 b->base_buffer = XBUFFER (base_buffer);
561
562 /* Use the base buffer's text object. */
563 b->text = b->base_buffer->text;
564
565 BUF_BEGV (b) = BUF_BEGV (b->base_buffer);
566 BUF_ZV (b) = BUF_ZV (b->base_buffer);
567 BUF_PT (b) = BUF_PT (b->base_buffer);
568 BUF_BEGV_BYTE (b) = BUF_BEGV_BYTE (b->base_buffer);
569 BUF_ZV_BYTE (b) = BUF_ZV_BYTE (b->base_buffer);
570 BUF_PT_BYTE (b) = BUF_PT_BYTE (b->base_buffer);
571
572 b->newline_cache = 0;
573 b->width_run_cache = 0;
574 b->width_table = Qnil;
575
576 /* Put this on the chain of all buffers including killed ones. */
577 b->next = all_buffers;
578 all_buffers = b;
579
580 name = Fcopy_sequence (name);
581 STRING_SET_INTERVALS (name, NULL_INTERVAL);
582 b->name = name;
583
584 reset_buffer (b);
585 reset_buffer_local_variables (b, 1);
586
587 /* Put this in the alist of all live buffers. */
588 XSETBUFFER (buf, b);
589 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
590
591 b->mark = Fmake_marker ();
592 b->name = name;
593
594 /* The multibyte status belongs to the base buffer. */
595 b->enable_multibyte_characters = b->base_buffer->enable_multibyte_characters;
596
597 /* Make sure the base buffer has markers for its narrowing. */
598 if (NILP (b->base_buffer->pt_marker))
599 {
600 b->base_buffer->pt_marker = Fmake_marker ();
601 set_marker_both (b->base_buffer->pt_marker, base_buffer,
602 BUF_PT (b->base_buffer),
603 BUF_PT_BYTE (b->base_buffer));
604 }
605 if (NILP (b->base_buffer->begv_marker))
606 {
607 b->base_buffer->begv_marker = Fmake_marker ();
608 set_marker_both (b->base_buffer->begv_marker, base_buffer,
609 BUF_BEGV (b->base_buffer),
610 BUF_BEGV_BYTE (b->base_buffer));
611 }
612 if (NILP (b->base_buffer->zv_marker))
613 {
614 b->base_buffer->zv_marker = Fmake_marker ();
615 set_marker_both (b->base_buffer->zv_marker, base_buffer,
616 BUF_ZV (b->base_buffer),
617 BUF_ZV_BYTE (b->base_buffer));
618 XMARKER (b->base_buffer->zv_marker)->insertion_type = 1;
619 }
620
621 if (NILP (clone))
622 {
623 /* Give the indirect buffer markers for its narrowing. */
624 b->pt_marker = Fmake_marker ();
625 set_marker_both (b->pt_marker, buf, BUF_PT (b), BUF_PT_BYTE (b));
626 b->begv_marker = Fmake_marker ();
627 set_marker_both (b->begv_marker, buf, BUF_BEGV (b), BUF_BEGV_BYTE (b));
628 b->zv_marker = Fmake_marker ();
629 set_marker_both (b->zv_marker, buf, BUF_ZV (b), BUF_ZV_BYTE (b));
630 XMARKER (b->zv_marker)->insertion_type = 1;
631 }
632 else
633 clone_per_buffer_values (b->base_buffer, b);
634
635 return buf;
636}
637
638void
639delete_all_overlays (b)
640 struct buffer *b;
641{
642 Lisp_Object overlay;
643
644 /* `reset_buffer' blindly sets the list of overlays to NULL, so we
645 have to empty the list, otherwise we end up with overlays that
646 think they belong to this buffer while the buffer doesn't know about
647 them any more. */
648 while (b->overlays_before)
649 {
650 XSETMISC (overlay, b->overlays_before);
651 Fdelete_overlay (overlay);
652 }
653 while (b->overlays_after)
654 {
655 XSETMISC (overlay, b->overlays_after);
656 Fdelete_overlay (overlay);
657 }
658 eassert (b->overlays_before == NULL);
659 eassert (b->overlays_after == NULL);
660}
661
662/* Reinitialize everything about a buffer except its name and contents
663 and local variables.
664 If called on an already-initialized buffer, the list of overlays
665 should be deleted before calling this function, otherwise we end up
666 with overlays that claim to belong to the buffer but the buffer
667 claims it doesn't belong to it. */
668
669void
670reset_buffer (b)
671 register struct buffer *b;
672{
673 b->filename = Qnil;
674 b->file_truename = Qnil;
675 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
676 b->modtime = 0;
677 XSETFASTINT (b->save_length, 0);
678 b->last_window_start = 1;
679 /* It is more conservative to start out "changed" than "unchanged". */
680 b->clip_changed = 0;
681 b->prevent_redisplay_optimizations_p = 1;
682 b->backed_up = Qnil;
683 b->auto_save_modified = 0;
684 b->auto_save_failure_time = -1;
685 b->auto_save_file_name = Qnil;
686 b->read_only = Qnil;
687 b->overlays_before = NULL;
688 b->overlays_after = NULL;
689 b->overlay_center = BEG;
690 b->mark_active = Qnil;
691 b->point_before_scroll = Qnil;
692 b->file_format = Qnil;
693 b->auto_save_file_format = Qt;
694 b->last_selected_window = Qnil;
695 XSETINT (b->display_count, 0);
696 b->display_time = Qnil;
697 b->enable_multibyte_characters = buffer_defaults.enable_multibyte_characters;
698 b->cursor_type = buffer_defaults.cursor_type;
699 b->extra_line_spacing = buffer_defaults.extra_line_spacing;
700
701 b->display_error_modiff = 0;
702}
703
704/* Reset buffer B's local variables info.
705 Don't use this on a buffer that has already been in use;
706 it does not treat permanent locals consistently.
707 Instead, use Fkill_all_local_variables.
708
709 If PERMANENT_TOO is 1, then we reset permanent built-in
710 buffer-local variables. If PERMANENT_TOO is 0,
711 we preserve those. */
712
713static void
714reset_buffer_local_variables (b, permanent_too)
715 register struct buffer *b;
716 int permanent_too;
717{
718 register int offset;
719 int i;
720
721 /* Reset the major mode to Fundamental, together with all the
722 things that depend on the major mode.
723 default-major-mode is handled at a higher level.
724 We ignore it here. */
725 b->major_mode = Qfundamental_mode;
726 b->keymap = Qnil;
727 b->mode_name = QSFundamental;
728 b->minor_modes = Qnil;
729
730 /* If the standard case table has been altered and invalidated,
731 fix up its insides first. */
732 if (! (CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[0])
733 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[1])
734 && CHAR_TABLE_P (XCHAR_TABLE (Vascii_downcase_table)->extras[2])))
735 Fset_standard_case_table (Vascii_downcase_table);
736
737 b->downcase_table = Vascii_downcase_table;
738 b->upcase_table = XCHAR_TABLE (Vascii_downcase_table)->extras[0];
739 b->case_canon_table = XCHAR_TABLE (Vascii_downcase_table)->extras[1];
740 b->case_eqv_table = XCHAR_TABLE (Vascii_downcase_table)->extras[2];
741 b->invisibility_spec = Qt;
742#ifndef DOS_NT
743 b->buffer_file_type = Qnil;
744#endif
745
746 /* Reset all (or most) per-buffer variables to their defaults. */
747 b->local_var_alist = Qnil;
748 for (i = 0; i < last_per_buffer_idx; ++i)
749 if (permanent_too || buffer_permanent_local_flags[i] == 0)
750 SET_PER_BUFFER_VALUE_P (b, i, 0);
751
752 /* For each slot that has a default value,
753 copy that into the slot. */
754
755 for (offset = PER_BUFFER_VAR_OFFSET (name);
756 offset < sizeof *b;
757 offset += sizeof (Lisp_Object))
758 {
759 int idx = PER_BUFFER_IDX (offset);
760 if ((idx > 0
761 && (permanent_too
762 || buffer_permanent_local_flags[idx] == 0))
763 /* Is -2 used anywhere? */
764 || idx == -2)
765 PER_BUFFER_VALUE (b, offset) = PER_BUFFER_DEFAULT (offset);
766 }
767}
768
769/* We split this away from generate-new-buffer, because rename-buffer
770 and set-visited-file-name ought to be able to use this to really
771 rename the buffer properly. */
772
773DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
774 1, 2, 0,
775 doc: /* Return a string that is the name of no existing buffer based on NAME.
776If there is no live buffer named NAME, then return NAME.
777Otherwise modify name by appending `<NUMBER>', incrementing NUMBER
778\(starting at 2) until an unused name is found, and then return that name.
779Optional second argument IGNORE specifies a name that is okay to use
780\(if it is in the sequence to be tried)
781even if a buffer with that name exists. */)
782 (name, ignore)
783 register Lisp_Object name, ignore;
784{
785 register Lisp_Object gentemp, tem;
786 int count;
787 char number[10];
788
789 CHECK_STRING (name);
790
791 tem = Fstring_equal (name, ignore);
792 if (!NILP (tem))
793 return name;
794 tem = Fget_buffer (name);
795 if (NILP (tem))
796 return name;
797
798 count = 1;
799 while (1)
800 {
801 sprintf (number, "<%d>", ++count);
802 gentemp = concat2 (name, build_string (number));
803 tem = Fstring_equal (gentemp, ignore);
804 if (!NILP (tem))
805 return gentemp;
806 tem = Fget_buffer (gentemp);
807 if (NILP (tem))
808 return gentemp;
809 }
810}
811
812\f
813DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
814 doc: /* Return the name of BUFFER, as a string.
815With no argument or nil as argument, return the name of the current buffer. */)
816 (buffer)
817 register Lisp_Object buffer;
818{
819 if (NILP (buffer))
820 return current_buffer->name;
821 CHECK_BUFFER (buffer);
822 return XBUFFER (buffer)->name;
823}
824
825DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
826 doc: /* Return name of file BUFFER is visiting, or nil if none.
827No argument or nil as argument means use the current buffer. */)
828 (buffer)
829 register Lisp_Object buffer;
830{
831 if (NILP (buffer))
832 return current_buffer->filename;
833 CHECK_BUFFER (buffer);
834 return XBUFFER (buffer)->filename;
835}
836
837DEFUN ("buffer-base-buffer", Fbuffer_base_buffer, Sbuffer_base_buffer,
838 0, 1, 0,
839 doc: /* Return the base buffer of indirect buffer BUFFER.
840If BUFFER is not indirect, return nil.
841BUFFER defaults to the current buffer. */)
842 (buffer)
843 register Lisp_Object buffer;
844{
845 struct buffer *base;
846 Lisp_Object base_buffer;
847
848 if (NILP (buffer))
849 base = current_buffer->base_buffer;
850 else
851 {
852 CHECK_BUFFER (buffer);
853 base = XBUFFER (buffer)->base_buffer;
854 }
855
856 if (! base)
857 return Qnil;
858 XSETBUFFER (base_buffer, base);
859 return base_buffer;
860}
861
862DEFUN ("buffer-local-value", Fbuffer_local_value,
863 Sbuffer_local_value, 2, 2, 0,
864 doc: /* Return the value of VARIABLE in BUFFER.
865If VARIABLE does not have a buffer-local binding in BUFFER, the value
866is the default binding of variable. */)
867 (symbol, buffer)
868 register Lisp_Object symbol;
869 register Lisp_Object buffer;
870{
871 register struct buffer *buf;
872 register Lisp_Object result;
873
874 CHECK_SYMBOL (symbol);
875 CHECK_BUFFER (buffer);
876 buf = XBUFFER (buffer);
877
878 /* Look in local_var_list */
879 result = Fassoc (symbol, buf->local_var_alist);
880 if (NILP (result))
881 {
882 int offset, idx;
883 int found = 0;
884
885 /* Look in special slots */
886 for (offset = PER_BUFFER_VAR_OFFSET (name);
887 offset < sizeof (struct buffer);
888 /* sizeof EMACS_INT == sizeof Lisp_Object */
889 offset += (sizeof (EMACS_INT)))
890 {
891 idx = PER_BUFFER_IDX (offset);
892 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
893 && SYMBOLP (PER_BUFFER_SYMBOL (offset))
894 && EQ (PER_BUFFER_SYMBOL (offset), symbol))
895 {
896 result = PER_BUFFER_VALUE (buf, offset);
897 found = 1;
898 break;
899 }
900 }
901
902 if (!found)
903 result = Fdefault_value (symbol);
904 }
905 else
906 {
907 Lisp_Object valcontents;
908 Lisp_Object current_alist_element;
909
910 /* What binding is loaded right now? */
911 valcontents = SYMBOL_VALUE (symbol);
912 current_alist_element
913 = XCAR (XBUFFER_LOCAL_VALUE (valcontents)->cdr);
914
915 /* The value of the currently loaded binding is not
916 stored in it, but rather in the realvalue slot.
917 Store that value into the binding it belongs to
918 in case that is the one we are about to use. */
919
920 Fsetcdr (current_alist_element,
921 do_symval_forwarding (XBUFFER_LOCAL_VALUE (valcontents)->realvalue));
922
923 /* Now get the (perhaps updated) value out of the binding. */
924 result = XCDR (result);
925 }
926
927 if (EQ (result, Qunbound))
928 return Fsignal (Qvoid_variable, Fcons (symbol, Qnil));
929
930 return result;
931}
932
933/* Return an alist of the Lisp-level buffer-local bindings of
934 buffer BUF. That is, do't include the variables maintained
935 in special slots in the buffer object. */
936
937static Lisp_Object
938buffer_lisp_local_variables (buf)
939 struct buffer *buf;
940{
941 Lisp_Object result = Qnil;
942 register Lisp_Object tail;
943 for (tail = buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
944 {
945 Lisp_Object val, elt;
946
947 elt = XCAR (tail);
948
949 /* Reference each variable in the alist in buf.
950 If inquiring about the current buffer, this gets the current values,
951 so store them into the alist so the alist is up to date.
952 If inquiring about some other buffer, this swaps out any values
953 for that buffer, making the alist up to date automatically. */
954 val = find_symbol_value (XCAR (elt));
955 /* Use the current buffer value only if buf is the current buffer. */
956 if (buf != current_buffer)
957 val = XCDR (elt);
958
959 /* If symbol is unbound, put just the symbol in the list. */
960 if (EQ (val, Qunbound))
961 result = Fcons (XCAR (elt), result);
962 /* Otherwise, put (symbol . value) in the list. */
963 else
964 result = Fcons (Fcons (XCAR (elt), val), result);
965 }
966
967 return result;
968}
969
970DEFUN ("buffer-local-variables", Fbuffer_local_variables,
971 Sbuffer_local_variables, 0, 1, 0,
972 doc: /* Return an alist of variables that are buffer-local in BUFFER.
973Most elements look like (SYMBOL . VALUE), describing one variable.
974For a symbol that is locally unbound, just the symbol appears in the value.
975Note that storing new VALUEs in these elements doesn't change the variables.
976No argument or nil as argument means use current buffer as BUFFER. */)
977 (buffer)
978 register Lisp_Object buffer;
979{
980 register struct buffer *buf;
981 register Lisp_Object result;
982
983 if (NILP (buffer))
984 buf = current_buffer;
985 else
986 {
987 CHECK_BUFFER (buffer);
988 buf = XBUFFER (buffer);
989 }
990
991 result = buffer_lisp_local_variables (buf);
992
993 /* Add on all the variables stored in special slots. */
994 {
995 int offset, idx;
996
997 for (offset = PER_BUFFER_VAR_OFFSET (name);
998 offset < sizeof (struct buffer);
999 /* sizeof EMACS_INT == sizeof Lisp_Object */
1000 offset += (sizeof (EMACS_INT)))
1001 {
1002 idx = PER_BUFFER_IDX (offset);
1003 if ((idx == -1 || PER_BUFFER_VALUE_P (buf, idx))
1004 && SYMBOLP (PER_BUFFER_SYMBOL (offset)))
1005 result = Fcons (Fcons (PER_BUFFER_SYMBOL (offset),
1006 PER_BUFFER_VALUE (buf, offset)),
1007 result);
1008 }
1009 }
1010
1011 return result;
1012}
1013\f
1014DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
1015 0, 1, 0,
1016 doc: /* Return t if BUFFER was modified since its file was last read or saved.
1017No argument or nil as argument means use current buffer as BUFFER. */)
1018 (buffer)
1019 register Lisp_Object buffer;
1020{
1021 register struct buffer *buf;
1022 if (NILP (buffer))
1023 buf = current_buffer;
1024 else
1025 {
1026 CHECK_BUFFER (buffer);
1027 buf = XBUFFER (buffer);
1028 }
1029
1030 return BUF_SAVE_MODIFF (buf) < BUF_MODIFF (buf) ? Qt : Qnil;
1031}
1032
1033DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
1034 1, 1, 0,
1035 doc: /* Mark current buffer as modified or unmodified according to FLAG.
1036A non-nil FLAG means mark the buffer modified. */)
1037 (flag)
1038 register Lisp_Object flag;
1039{
1040 register int already;
1041 register Lisp_Object fn;
1042 Lisp_Object buffer, window;
1043
1044#ifdef CLASH_DETECTION
1045 /* If buffer becoming modified, lock the file.
1046 If buffer becoming unmodified, unlock the file. */
1047
1048 fn = current_buffer->file_truename;
1049 /* Test buffer-file-name so that binding it to nil is effective. */
1050 if (!NILP (fn) && ! NILP (current_buffer->filename))
1051 {
1052 already = SAVE_MODIFF < MODIFF;
1053 if (!already && !NILP (flag))
1054 lock_file (fn);
1055 else if (already && NILP (flag))
1056 unlock_file (fn);
1057 }
1058#endif /* CLASH_DETECTION */
1059
1060 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1061
1062 /* Set update_mode_lines only if buffer is displayed in some window.
1063 Packages like jit-lock or lazy-lock preserve a buffer's modified
1064 state by recording/restoring the state around blocks of code.
1065 Setting update_mode_lines makes redisplay consider all windows
1066 (on all frames). Stealth fontification of buffers not displayed
1067 would incur additional redisplay costs if we'd set
1068 update_modes_lines unconditionally.
1069
1070 Ideally, I think there should be another mechanism for fontifying
1071 buffers without "modifying" buffers, or redisplay should be
1072 smarter about updating the `*' in mode lines. --gerd */
1073 XSETBUFFER (buffer, current_buffer);
1074 window = Fget_buffer_window (buffer, Qt);
1075 if (WINDOWP (window))
1076 {
1077 ++update_mode_lines;
1078 current_buffer->prevent_redisplay_optimizations_p = 1;
1079 }
1080
1081 return flag;
1082}
1083
1084DEFUN ("restore-buffer-modified-p", Frestore_buffer_modified_p,
1085 Srestore_buffer_modified_p, 1, 1, 0,
1086 doc: /* Like `set-buffer-modified-p', with a difference concerning redisplay.
1087It is not ensured that mode lines will be updated to show the modified
1088state of the current buffer. Use with care. */)
1089 (flag)
1090 Lisp_Object flag;
1091{
1092#ifdef CLASH_DETECTION
1093 Lisp_Object fn;
1094
1095 /* If buffer becoming modified, lock the file.
1096 If buffer becoming unmodified, unlock the file. */
1097
1098 fn = current_buffer->file_truename;
1099 /* Test buffer-file-name so that binding it to nil is effective. */
1100 if (!NILP (fn) && ! NILP (current_buffer->filename))
1101 {
1102 int already = SAVE_MODIFF < MODIFF;
1103 if (!already && !NILP (flag))
1104 lock_file (fn);
1105 else if (already && NILP (flag))
1106 unlock_file (fn);
1107 }
1108#endif /* CLASH_DETECTION */
1109
1110 SAVE_MODIFF = NILP (flag) ? MODIFF : 0;
1111 return flag;
1112}
1113
1114DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
1115 0, 1, 0,
1116 doc: /* Return BUFFER's tick counter, incremented for each change in text.
1117Each buffer has a tick counter which is incremented each time the text in
1118that buffer is changed. It wraps around occasionally.
1119No argument or nil as argument means use current buffer as BUFFER. */)
1120 (buffer)
1121 register Lisp_Object buffer;
1122{
1123 register struct buffer *buf;
1124 if (NILP (buffer))
1125 buf = current_buffer;
1126 else
1127 {
1128 CHECK_BUFFER (buffer);
1129 buf = XBUFFER (buffer);
1130 }
1131
1132 return make_number (BUF_MODIFF (buf));
1133}
1134\f
1135DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
1136 "sRename buffer (to new name): \nP",
1137 doc: /* Change current buffer's name to NEWNAME (a string).
1138If second arg UNIQUE is nil or omitted, it is an error if a
1139buffer named NEWNAME already exists.
1140If UNIQUE is non-nil, come up with a new name using
1141`generate-new-buffer-name'.
1142Interactively, you can set UNIQUE with a prefix argument.
1143We return the name we actually gave the buffer.
1144This does not change the name of the visited file (if any). */)
1145 (newname, unique)
1146 register Lisp_Object newname, unique;
1147{
1148 register Lisp_Object tem, buf;
1149
1150 CHECK_STRING (newname);
1151
1152 if (SCHARS (newname) == 0)
1153 error ("Empty string is invalid as a buffer name");
1154
1155 tem = Fget_buffer (newname);
1156 if (!NILP (tem))
1157 {
1158 /* Don't short-circuit if UNIQUE is t. That is a useful way to
1159 rename the buffer automatically so you can create another
1160 with the original name. It makes UNIQUE equivalent to
1161 (rename-buffer (generate-new-buffer-name NEWNAME)). */
1162 if (NILP (unique) && XBUFFER (tem) == current_buffer)
1163 return current_buffer->name;
1164 if (!NILP (unique))
1165 newname = Fgenerate_new_buffer_name (newname, current_buffer->name);
1166 else
1167 error ("Buffer name `%s' is in use", SDATA (newname));
1168 }
1169
1170 current_buffer->name = newname;
1171
1172 /* Catch redisplay's attention. Unless we do this, the mode lines for
1173 any windows displaying current_buffer will stay unchanged. */
1174 update_mode_lines++;
1175
1176 XSETBUFFER (buf, current_buffer);
1177 Fsetcar (Frassq (buf, Vbuffer_alist), newname);
1178 if (NILP (current_buffer->filename)
1179 && !NILP (current_buffer->auto_save_file_name))
1180 call0 (intern ("rename-auto-save-file"));
1181 /* Refetch since that last call may have done GC. */
1182 return current_buffer->name;
1183}
1184
1185DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 3, 0,
1186 doc: /* Return most recently selected buffer other than BUFFER.
1187Buffers not visible in windows are preferred to visible buffers,
1188unless optional second argument VISIBLE-OK is non-nil.
1189If the optional third argument FRAME is non-nil, use that frame's
1190buffer list instead of the selected frame's buffer list.
1191If no other buffer exists, the buffer `*scratch*' is returned.
1192If BUFFER is omitted or nil, some interesting buffer is returned. */)
1193 (buffer, visible_ok, frame)
1194 register Lisp_Object buffer, visible_ok, frame;
1195{
1196 Lisp_Object Fset_buffer_major_mode ();
1197 register Lisp_Object tail, buf, notsogood, tem, pred, add_ons;
1198 notsogood = Qnil;
1199
1200 if (NILP (frame))
1201 frame = selected_frame;
1202
1203 tail = Vbuffer_alist;
1204 pred = frame_buffer_predicate (frame);
1205
1206 /* Consider buffers that have been seen in the selected frame
1207 before other buffers. */
1208
1209 tem = frame_buffer_list (frame);
1210 add_ons = Qnil;
1211 while (CONSP (tem))
1212 {
1213 if (BUFFERP (XCAR (tem)))
1214 add_ons = Fcons (Fcons (Qnil, XCAR (tem)), add_ons);
1215 tem = XCDR (tem);
1216 }
1217 tail = nconc2 (Fnreverse (add_ons), tail);
1218
1219 for (; CONSP (tail); tail = XCDR (tail))
1220 {
1221 buf = Fcdr (XCAR (tail));
1222 if (EQ (buf, buffer))
1223 continue;
1224 if (NILP (buf))
1225 continue;
1226 if (NILP (XBUFFER (buf)->name))
1227 continue;
1228 if (SREF (XBUFFER (buf)->name, 0) == ' ')
1229 continue;
1230 /* If the selected frame has a buffer_predicate,
1231 disregard buffers that don't fit the predicate. */
1232 if (!NILP (pred))
1233 {
1234 tem = call1 (pred, buf);
1235 if (NILP (tem))
1236 continue;
1237 }
1238
1239 if (NILP (visible_ok))
1240 tem = Fget_buffer_window (buf, Qvisible);
1241 else
1242 tem = Qnil;
1243 if (NILP (tem))
1244 return buf;
1245 if (NILP (notsogood))
1246 notsogood = buf;
1247 }
1248 if (!NILP (notsogood))
1249 return notsogood;
1250 buf = Fget_buffer (build_string ("*scratch*"));
1251 if (NILP (buf))
1252 {
1253 buf = Fget_buffer_create (build_string ("*scratch*"));
1254 Fset_buffer_major_mode (buf);
1255 }
1256 return buf;
1257}
1258\f
1259DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
1260 0, 1, "",
1261 doc: /* Start keeping undo information for buffer BUFFER.
1262No argument or nil as argument means do this for the current buffer. */)
1263 (buffer)
1264 register Lisp_Object buffer;
1265{
1266 Lisp_Object real_buffer;
1267
1268 if (NILP (buffer))
1269 XSETBUFFER (real_buffer, current_buffer);
1270 else
1271 {
1272 real_buffer = Fget_buffer (buffer);
1273 if (NILP (real_buffer))
1274 nsberror (buffer);
1275 }
1276
1277 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
1278 XBUFFER (real_buffer)->undo_list = Qnil;
1279
1280 return Qnil;
1281}
1282
1283/*
1284 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
1285Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
1286The buffer being killed will be current while the hook is running.\n\
1287See `kill-buffer'."
1288 */
1289DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
1290 doc: /* Kill the buffer BUFFER.
1291The argument may be a buffer or may be the name of a buffer.
1292An argument of nil means kill the current buffer.
1293
1294Value is t if the buffer is actually killed, nil if user says no.
1295
1296The value of `kill-buffer-hook' (which may be local to that buffer),
1297if not void, is a list of functions to be called, with no arguments,
1298before the buffer is actually killed. The buffer to be killed is current
1299when the hook functions are called.
1300
1301Any processes that have this buffer as the `process-buffer' are killed
1302with SIGHUP. */)
1303 (buffer)
1304 Lisp_Object buffer;
1305{
1306 Lisp_Object buf;
1307 register struct buffer *b;
1308 register Lisp_Object tem;
1309 register struct Lisp_Marker *m;
1310 struct gcpro gcpro1;
1311
1312 if (NILP (buffer))
1313 buf = Fcurrent_buffer ();
1314 else
1315 buf = Fget_buffer (buffer);
1316 if (NILP (buf))
1317 nsberror (buffer);
1318
1319 b = XBUFFER (buf);
1320
1321 /* Avoid trouble for buffer already dead. */
1322 if (NILP (b->name))
1323 return Qnil;
1324
1325 /* Query if the buffer is still modified. */
1326 if (INTERACTIVE && !NILP (b->filename)
1327 && BUF_MODIFF (b) > BUF_SAVE_MODIFF (b))
1328 {
1329 GCPRO1 (buf);
1330 tem = do_yes_or_no_p (format2 ("Buffer %s modified; kill anyway? ",
1331 b->name, make_number (0)));
1332 UNGCPRO;
1333 if (NILP (tem))
1334 return Qnil;
1335 }
1336
1337 /* Run hooks with the buffer to be killed the current buffer. */
1338 {
1339 int count = SPECPDL_INDEX ();
1340 Lisp_Object arglist[1];
1341
1342 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1343 set_buffer_internal (b);
1344
1345 /* First run the query functions; if any query is answered no,
1346 don't kill the buffer. */
1347 arglist[0] = Qkill_buffer_query_functions;
1348 if (NILP (Frun_hook_with_args_until_failure (1, arglist)))
1349 return unbind_to (count, Qnil);
1350
1351 /* Then run the hooks. */
1352 Frun_hooks (1, &Qkill_buffer_hook);
1353 unbind_to (count, Qnil);
1354 }
1355
1356 /* We have no more questions to ask. Verify that it is valid
1357 to kill the buffer. This must be done after the questions
1358 since anything can happen within do_yes_or_no_p. */
1359
1360 /* Don't kill the minibuffer now current. */
1361 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
1362 return Qnil;
1363
1364 if (NILP (b->name))
1365 return Qnil;
1366
1367 /* When we kill a base buffer, kill all its indirect buffers.
1368 We do it at this stage so nothing terrible happens if they
1369 ask questions or their hooks get errors. */
1370 if (! b->base_buffer)
1371 {
1372 struct buffer *other;
1373
1374 GCPRO1 (buf);
1375
1376 for (other = all_buffers; other; other = other->next)
1377 /* all_buffers contains dead buffers too;
1378 don't re-kill them. */
1379 if (other->base_buffer == b && !NILP (other->name))
1380 {
1381 Lisp_Object buf;
1382 XSETBUFFER (buf, other);
1383 Fkill_buffer (buf);
1384 }
1385
1386 UNGCPRO;
1387 }
1388
1389 /* Make this buffer not be current.
1390 In the process, notice if this is the sole visible buffer
1391 and give up if so. */
1392 if (b == current_buffer)
1393 {
1394 tem = Fother_buffer (buf, Qnil, Qnil);
1395 Fset_buffer (tem);
1396 if (b == current_buffer)
1397 return Qnil;
1398 }
1399
1400 /* Notice if the buffer to kill is the sole visible buffer
1401 when we're currently in the mini-buffer, and give up if so. */
1402 XSETBUFFER (tem, current_buffer);
1403 if (EQ (tem, XWINDOW (minibuf_window)->buffer))
1404 {
1405 tem = Fother_buffer (buf, Qnil, Qnil);
1406 if (EQ (buf, tem))
1407 return Qnil;
1408 }
1409
1410 /* Now there is no question: we can kill the buffer. */
1411
1412#ifdef CLASH_DETECTION
1413 /* Unlock this buffer's file, if it is locked. */
1414 unlock_buffer (b);
1415#endif /* CLASH_DETECTION */
1416
1417 kill_buffer_processes (buf);
1418 clear_charpos_cache (b);
1419
1420 tem = Vinhibit_quit;
1421 Vinhibit_quit = Qt;
1422 replace_buffer_in_all_windows (buf);
1423 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
1424 frames_discard_buffer (buf);
1425 Vinhibit_quit = tem;
1426
1427 /* Delete any auto-save file, if we saved it in this session.
1428 But not if the buffer is modified. */
1429 if (STRINGP (b->auto_save_file_name)
1430 && b->auto_save_modified != 0
1431 && BUF_SAVE_MODIFF (b) < b->auto_save_modified
1432 && BUF_SAVE_MODIFF (b) < BUF_MODIFF (b)
1433 && NILP (Fsymbol_value (intern ("auto-save-visited-file-name"))))
1434 {
1435 Lisp_Object tem;
1436 tem = Fsymbol_value (intern ("delete-auto-save-files"));
1437 if (! NILP (tem))
1438 internal_delete_file (b->auto_save_file_name);
1439 }
1440
1441 if (b->base_buffer)
1442 {
1443 /* Unchain all markers that belong to this indirect buffer.
1444 Don't unchain the markers that belong to the base buffer
1445 or its other indirect buffers. */
1446 for (m = BUF_MARKERS (b); m; )
1447 {
1448 struct Lisp_Marker *next = m->next;
1449 if (m->buffer == b)
1450 unchain_marker (m);
1451 m = next;
1452 }
1453 }
1454 else
1455 {
1456 /* Unchain all markers of this buffer and its indirect buffers.
1457 and leave them pointing nowhere. */
1458 for (m = BUF_MARKERS (b); m; )
1459 {
1460 struct Lisp_Marker *next = m->next;
1461 m->buffer = 0;
1462 m->next = NULL;
1463 m = next;
1464 }
1465 BUF_MARKERS (b) = NULL;
1466 BUF_INTERVALS (b) = NULL_INTERVAL;
1467
1468 /* Perhaps we should explicitly free the interval tree here... */
1469 }
1470
1471 /* Reset the local variables, so that this buffer's local values
1472 won't be protected from GC. They would be protected
1473 if they happened to remain encached in their symbols.
1474 This gets rid of them for certain. */
1475 swap_out_buffer_local_variables (b);
1476 reset_buffer_local_variables (b, 1);
1477
1478 b->name = Qnil;
1479
1480 BLOCK_INPUT;
1481 if (! b->base_buffer)
1482 free_buffer_text (b);
1483
1484 if (b->newline_cache)
1485 {
1486 free_region_cache (b->newline_cache);
1487 b->newline_cache = 0;
1488 }
1489 if (b->width_run_cache)
1490 {
1491 free_region_cache (b->width_run_cache);
1492 b->width_run_cache = 0;
1493 }
1494 b->width_table = Qnil;
1495 UNBLOCK_INPUT;
1496 b->undo_list = Qnil;
1497
1498 return Qt;
1499}
1500\f
1501/* Move the assoc for buffer BUF to the front of buffer-alist. Since
1502 we do this each time BUF is selected visibly, the more recently
1503 selected buffers are always closer to the front of the list. This
1504 means that other_buffer is more likely to choose a relevant buffer. */
1505
1506void
1507record_buffer (buf)
1508 Lisp_Object buf;
1509{
1510 register Lisp_Object link, prev;
1511 Lisp_Object frame;
1512 frame = selected_frame;
1513
1514 prev = Qnil;
1515 for (link = Vbuffer_alist; CONSP (link); link = XCDR (link))
1516 {
1517 if (EQ (XCDR (XCAR (link)), buf))
1518 break;
1519 prev = link;
1520 }
1521
1522 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
1523 we cannot use Fdelq itself here because it allows quitting. */
1524
1525 if (NILP (prev))
1526 Vbuffer_alist = XCDR (Vbuffer_alist);
1527 else
1528 XSETCDR (prev, XCDR (XCDR (prev)));
1529
1530 XSETCDR (link, Vbuffer_alist);
1531 Vbuffer_alist = link;
1532
1533 /* Now move this buffer to the front of frame_buffer_list also. */
1534
1535 prev = Qnil;
1536 for (link = frame_buffer_list (frame); CONSP (link);
1537 link = XCDR (link))
1538 {
1539 if (EQ (XCAR (link), buf))
1540 break;
1541 prev = link;
1542 }
1543
1544 /* Effectively do delq. */
1545
1546 if (CONSP (link))
1547 {
1548 if (NILP (prev))
1549 set_frame_buffer_list (frame,
1550 XCDR (frame_buffer_list (frame)));
1551 else
1552 XSETCDR (prev, XCDR (XCDR (prev)));
1553
1554 XSETCDR (link, frame_buffer_list (frame));
1555 set_frame_buffer_list (frame, link);
1556 }
1557 else
1558 set_frame_buffer_list (frame, Fcons (buf, frame_buffer_list (frame)));
1559}
1560
1561DEFUN ("set-buffer-major-mode", Fset_buffer_major_mode, Sset_buffer_major_mode, 1, 1, 0,
1562 doc: /* Set an appropriate major mode for BUFFER.
1563For the *scratch* buffer, use `initial-major-mode', otherwise choose a mode
1564according to `default-major-mode'.
1565Use this function before selecting the buffer, since it may need to inspect
1566the current buffer's major mode. */)
1567 (buffer)
1568 Lisp_Object buffer;
1569{
1570 int count;
1571 Lisp_Object function;
1572
1573 if (STRINGP (XBUFFER (buffer)->name)
1574 && strcmp (SDATA (XBUFFER (buffer)->name), "*scratch*") == 0)
1575 function = find_symbol_value (intern ("initial-major-mode"));
1576 else
1577 {
1578 function = buffer_defaults.major_mode;
1579 if (NILP (function)
1580 && NILP (Fget (current_buffer->major_mode, Qmode_class)))
1581 function = current_buffer->major_mode;
1582 }
1583
1584 if (NILP (function) || EQ (function, Qfundamental_mode))
1585 return Qnil;
1586
1587 count = SPECPDL_INDEX ();
1588
1589 /* To select a nonfundamental mode,
1590 select the buffer temporarily and then call the mode function. */
1591
1592 record_unwind_protect (save_excursion_restore, save_excursion_save ());
1593
1594 Fset_buffer (buffer);
1595 call0 (function);
1596
1597 return unbind_to (count, Qnil);
1598}
1599
1600/* If switching buffers in WINDOW would be an error, return
1601 a C string saying what the error would be. */
1602
1603char *
1604no_switch_window (window)
1605 Lisp_Object window;
1606{
1607 Lisp_Object tem;
1608 if (EQ (minibuf_window, window))
1609 return "Cannot switch buffers in minibuffer window";
1610 tem = Fwindow_dedicated_p (window);
1611 if (EQ (tem, Qt))
1612 return "Cannot switch buffers in a dedicated window";
1613 return NULL;
1614}
1615
1616/* Switch to buffer BUFFER in the selected window.
1617 If NORECORD is non-nil, don't call record_buffer. */
1618
1619Lisp_Object
1620switch_to_buffer_1 (buffer, norecord)
1621 Lisp_Object buffer, norecord;
1622{
1623 register Lisp_Object buf;
1624
1625 if (NILP (buffer))
1626 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1627 else
1628 {
1629 buf = Fget_buffer (buffer);
1630 if (NILP (buf))
1631 {
1632 buf = Fget_buffer_create (buffer);
1633 Fset_buffer_major_mode (buf);
1634 }
1635 }
1636 Fset_buffer (buf);
1637 if (NILP (norecord))
1638 record_buffer (buf);
1639
1640 Fset_window_buffer (EQ (selected_window, minibuf_window)
1641 ? Fnext_window (minibuf_window, Qnil, Qnil)
1642 : selected_window,
1643 buf, Qnil);
1644
1645 return buf;
1646}
1647
1648DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
1649 doc: /* Select buffer BUFFER in the current window.
1650If BUFFER does not identify an existing buffer,
1651then this function creates a buffer with that name.
1652
1653When called from Lisp, BUFFER may be a buffer, a string \(a buffer name),
1654or nil. If BUFFER is nil, then this function chooses a buffer
1655using `other-buffer'.
1656Optional second arg NORECORD non-nil means
1657do not put this buffer at the front of the list of recently selected ones.
1658This function returns the buffer it switched to.
1659
1660WARNING: This is NOT the way to work on another buffer temporarily
1661within a Lisp program! Use `set-buffer' instead. That avoids messing with
1662the window-buffer correspondences. */)
1663 (buffer, norecord)
1664 Lisp_Object buffer, norecord;
1665{
1666 char *err;
1667
1668 if (EQ (buffer, Fwindow_buffer (selected_window)))
1669 /* Basically a NOP. Avoid signalling an error if the selected window
1670 is dedicated, or a minibuffer, ... */
1671 return Fset_buffer (buffer);
1672
1673 err = no_switch_window (selected_window);
1674 if (err) error (err);
1675
1676 return switch_to_buffer_1 (buffer, norecord);
1677}
1678
1679DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 3, 0,
1680 doc: /* Select buffer BUFFER in some window, preferably a different one.
1681BUFFER may be a buffer, a string \(a buffer name), or nil.
1682If BUFFER is a string which is not the name of an existing buffer,
1683then this function creates a buffer with that name.
1684If BUFFER is nil, then it chooses some other buffer.
1685If `pop-up-windows' is non-nil, windows can be split to do this.
1686If optional second arg OTHER-WINDOW is non-nil, insist on finding another
1687window even if BUFFER is already visible in the selected window,
1688and ignore `same-window-regexps' and `same-window-buffer-names'.
1689This function returns the buffer it switched to.
1690This uses the function `display-buffer' as a subroutine; see the documentation
1691of `display-buffer' for additional customization information.
1692
1693Optional third arg NORECORD non-nil means
1694do not put this buffer at the front of the list of recently selected ones. */)
1695 (buffer, other_window, norecord)
1696 Lisp_Object buffer, other_window, norecord;
1697{
1698 register Lisp_Object buf;
1699 if (NILP (buffer))
1700 buf = Fother_buffer (Fcurrent_buffer (), Qnil, Qnil);
1701 else
1702 {
1703 buf = Fget_buffer (buffer);
1704 if (NILP (buf))
1705 {
1706 buf = Fget_buffer_create (buffer);
1707 Fset_buffer_major_mode (buf);
1708 }
1709 }
1710 Fset_buffer (buf);
1711 if (NILP (norecord))
1712 /* Why bother ? Fselect_window will do it for us anyway. -stef */
1713 record_buffer (buf);
1714 Fselect_window (Fdisplay_buffer (buf, other_window, Qnil), norecord);
1715 return buf;
1716}
1717
1718DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
1719 doc: /* Return the current buffer as a Lisp object. */)
1720 ()
1721{
1722 register Lisp_Object buf;
1723 XSETBUFFER (buf, current_buffer);
1724 return buf;
1725}
1726\f
1727/* Set the current buffer to B.
1728
1729 We previously set windows_or_buffers_changed here to invalidate
1730 global unchanged information in beg_unchanged and end_unchanged.
1731 This is no longer necessary because we now compute unchanged
1732 information on a buffer-basis. Every action affecting other
1733 windows than the selected one requires a select_window at some
1734 time, and that increments windows_or_buffers_changed. */
1735
1736void
1737set_buffer_internal (b)
1738 register struct buffer *b;
1739{
1740 if (current_buffer != b)
1741 set_buffer_internal_1 (b);
1742}
1743
1744/* Set the current buffer to B, and do not set windows_or_buffers_changed.
1745 This is used by redisplay. */
1746
1747void
1748set_buffer_internal_1 (b)
1749 register struct buffer *b;
1750{
1751 register struct buffer *old_buf;
1752 register Lisp_Object tail, valcontents;
1753 Lisp_Object tem;
1754
1755#ifdef USE_MMAP_FOR_BUFFERS
1756 if (b->text->beg == NULL)
1757 enlarge_buffer_text (b, 0);
1758#endif /* USE_MMAP_FOR_BUFFERS */
1759
1760 if (current_buffer == b)
1761 return;
1762
1763 old_buf = current_buffer;
1764 current_buffer = b;
1765 last_known_column_point = -1; /* invalidate indentation cache */
1766
1767 if (old_buf)
1768 {
1769 /* Put the undo list back in the base buffer, so that it appears
1770 that an indirect buffer shares the undo list of its base. */
1771 if (old_buf->base_buffer)
1772 old_buf->base_buffer->undo_list = old_buf->undo_list;
1773
1774 /* If the old current buffer has markers to record PT, BEGV and ZV
1775 when it is not current, update them now. */
1776 if (! NILP (old_buf->pt_marker))
1777 {
1778 Lisp_Object obuf;
1779 XSETBUFFER (obuf, old_buf);
1780 set_marker_both (old_buf->pt_marker, obuf,
1781 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1782 }
1783 if (! NILP (old_buf->begv_marker))
1784 {
1785 Lisp_Object obuf;
1786 XSETBUFFER (obuf, old_buf);
1787 set_marker_both (old_buf->begv_marker, obuf,
1788 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1789 }
1790 if (! NILP (old_buf->zv_marker))
1791 {
1792 Lisp_Object obuf;
1793 XSETBUFFER (obuf, old_buf);
1794 set_marker_both (old_buf->zv_marker, obuf,
1795 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1796 }
1797 }
1798
1799 /* Get the undo list from the base buffer, so that it appears
1800 that an indirect buffer shares the undo list of its base. */
1801 if (b->base_buffer)
1802 b->undo_list = b->base_buffer->undo_list;
1803
1804 /* If the new current buffer has markers to record PT, BEGV and ZV
1805 when it is not current, fetch them now. */
1806 if (! NILP (b->pt_marker))
1807 {
1808 BUF_PT (b) = marker_position (b->pt_marker);
1809 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1810 }
1811 if (! NILP (b->begv_marker))
1812 {
1813 BUF_BEGV (b) = marker_position (b->begv_marker);
1814 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1815 }
1816 if (! NILP (b->zv_marker))
1817 {
1818 BUF_ZV (b) = marker_position (b->zv_marker);
1819 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1820 }
1821
1822 /* Look down buffer's list of local Lisp variables
1823 to find and update any that forward into C variables. */
1824
1825 for (tail = b->local_var_alist; CONSP (tail); tail = XCDR (tail))
1826 {
1827 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1828 if ((BUFFER_LOCAL_VALUEP (valcontents)
1829 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1830 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1831 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1832 /* Just reference the variable
1833 to cause it to become set for this buffer. */
1834 Fsymbol_value (XCAR (XCAR (tail)));
1835 }
1836
1837 /* Do the same with any others that were local to the previous buffer */
1838
1839 if (old_buf)
1840 for (tail = old_buf->local_var_alist; CONSP (tail); tail = XCDR (tail))
1841 {
1842 valcontents = SYMBOL_VALUE (XCAR (XCAR (tail)));
1843 if ((BUFFER_LOCAL_VALUEP (valcontents)
1844 || SOME_BUFFER_LOCAL_VALUEP (valcontents))
1845 && (tem = XBUFFER_LOCAL_VALUE (valcontents)->realvalue,
1846 (BOOLFWDP (tem) || INTFWDP (tem) || OBJFWDP (tem))))
1847 /* Just reference the variable
1848 to cause it to become set for this buffer. */
1849 Fsymbol_value (XCAR (XCAR (tail)));
1850 }
1851}
1852
1853/* Switch to buffer B temporarily for redisplay purposes.
1854 This avoids certain things that don't need to be done within redisplay. */
1855
1856void
1857set_buffer_temp (b)
1858 struct buffer *b;
1859{
1860 register struct buffer *old_buf;
1861
1862 if (current_buffer == b)
1863 return;
1864
1865 old_buf = current_buffer;
1866 current_buffer = b;
1867
1868 if (old_buf)
1869 {
1870 /* If the old current buffer has markers to record PT, BEGV and ZV
1871 when it is not current, update them now. */
1872 if (! NILP (old_buf->pt_marker))
1873 {
1874 Lisp_Object obuf;
1875 XSETBUFFER (obuf, old_buf);
1876 set_marker_both (old_buf->pt_marker, obuf,
1877 BUF_PT (old_buf), BUF_PT_BYTE (old_buf));
1878 }
1879 if (! NILP (old_buf->begv_marker))
1880 {
1881 Lisp_Object obuf;
1882 XSETBUFFER (obuf, old_buf);
1883 set_marker_both (old_buf->begv_marker, obuf,
1884 BUF_BEGV (old_buf), BUF_BEGV_BYTE (old_buf));
1885 }
1886 if (! NILP (old_buf->zv_marker))
1887 {
1888 Lisp_Object obuf;
1889 XSETBUFFER (obuf, old_buf);
1890 set_marker_both (old_buf->zv_marker, obuf,
1891 BUF_ZV (old_buf), BUF_ZV_BYTE (old_buf));
1892 }
1893 }
1894
1895 /* If the new current buffer has markers to record PT, BEGV and ZV
1896 when it is not current, fetch them now. */
1897 if (! NILP (b->pt_marker))
1898 {
1899 BUF_PT (b) = marker_position (b->pt_marker);
1900 BUF_PT_BYTE (b) = marker_byte_position (b->pt_marker);
1901 }
1902 if (! NILP (b->begv_marker))
1903 {
1904 BUF_BEGV (b) = marker_position (b->begv_marker);
1905 BUF_BEGV_BYTE (b) = marker_byte_position (b->begv_marker);
1906 }
1907 if (! NILP (b->zv_marker))
1908 {
1909 BUF_ZV (b) = marker_position (b->zv_marker);
1910 BUF_ZV_BYTE (b) = marker_byte_position (b->zv_marker);
1911 }
1912}
1913
1914DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
1915 doc: /* Make the buffer BUFFER current for editing operations.
1916BUFFER may be a buffer or the name of an existing buffer.
1917See also `save-excursion' when you want to make a buffer current temporarily.
1918This function does not display the buffer, so its effect ends
1919when the current command terminates.
1920Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently. */)
1921 (buffer)
1922 register Lisp_Object buffer;
1923{
1924 register Lisp_Object buf;
1925 buf = Fget_buffer (buffer);
1926 if (NILP (buf))
1927 nsberror (buffer);
1928 if (NILP (XBUFFER (buf)->name))
1929 error ("Selecting deleted buffer");
1930 set_buffer_internal (XBUFFER (buf));
1931 return buf;
1932}
1933
1934/* Set the current buffer to BUFFER provided it is alive. */
1935
1936Lisp_Object
1937set_buffer_if_live (buffer)
1938 Lisp_Object buffer;
1939{
1940 if (! NILP (XBUFFER (buffer)->name))
1941 Fset_buffer (buffer);
1942 return Qnil;
1943}
1944\f
1945DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1946 Sbarf_if_buffer_read_only, 0, 0, 0,
1947 doc: /* Signal a `buffer-read-only' error if the current buffer is read-only. */)
1948 ()
1949{
1950 if (!NILP (current_buffer->read_only)
1951 && NILP (Vinhibit_read_only))
1952 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1953 return Qnil;
1954}
1955
1956DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1957 doc: /* Put BUFFER at the end of the list of all buffers.
1958There it is the least likely candidate for `other-buffer' to return;
1959thus, the least likely buffer for \\[switch-to-buffer] to select by default.
1960You can specify a buffer name as BUFFER, or an actual buffer object.
1961If BUFFER is nil or omitted, bury the current buffer.
1962Also, if BUFFER is nil or omitted, remove the current buffer from the
1963selected window if it is displayed there. */)
1964 (buffer)
1965 register Lisp_Object buffer;
1966{
1967 /* Figure out what buffer we're going to bury. */
1968 if (NILP (buffer))
1969 {
1970 Lisp_Object tem;
1971 XSETBUFFER (buffer, current_buffer);
1972
1973 tem = Fwindow_buffer (selected_window);
1974 /* If we're burying the current buffer, unshow it. */
1975 if (EQ (buffer, tem))
1976 {
1977 if (NILP (Fwindow_dedicated_p (selected_window)))
1978 Fswitch_to_buffer (Fother_buffer (buffer, Qnil, Qnil), Qnil);
1979 else if (NILP (XWINDOW (selected_window)->parent))
1980 Ficonify_frame (Fwindow_frame (selected_window));
1981 else
1982 Fdelete_window (selected_window);
1983 }
1984 }
1985 else
1986 {
1987 Lisp_Object buf1;
1988
1989 buf1 = Fget_buffer (buffer);
1990 if (NILP (buf1))
1991 nsberror (buffer);
1992 buffer = buf1;
1993 }
1994
1995 /* Move buffer to the end of the buffer list. Do nothing if the
1996 buffer is killed. */
1997 if (!NILP (XBUFFER (buffer)->name))
1998 {
1999 Lisp_Object aelt, link;
2000
2001 aelt = Frassq (buffer, Vbuffer_alist);
2002 link = Fmemq (aelt, Vbuffer_alist);
2003 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
2004 XSETCDR (link, Qnil);
2005 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
2006
2007 /* Removing BUFFER from frame-specific lists
2008 has the effect of putting BUFFER at the end
2009 of the combined list in each frame. */
2010 frames_discard_buffer (buffer);
2011 }
2012
2013 return Qnil;
2014}
2015\f
2016DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
2017 doc: /* Delete the entire contents of the current buffer.
2018Any narrowing restriction in effect (see `narrow-to-region') is removed,
2019so the buffer is truly empty after this. */)
2020 ()
2021{
2022 Fwiden ();
2023
2024 del_range (BEG, Z);
2025
2026 current_buffer->last_window_start = 1;
2027 /* Prevent warnings, or suspension of auto saving, that would happen
2028 if future size is less than past size. Use of erase-buffer
2029 implies that the future text is not really related to the past text. */
2030 XSETFASTINT (current_buffer->save_length, 0);
2031 return Qnil;
2032}
2033
2034void
2035validate_region (b, e)
2036 register Lisp_Object *b, *e;
2037{
2038 CHECK_NUMBER_COERCE_MARKER (*b);
2039 CHECK_NUMBER_COERCE_MARKER (*e);
2040
2041 if (XINT (*b) > XINT (*e))
2042 {
2043 Lisp_Object tem;
2044 tem = *b; *b = *e; *e = tem;
2045 }
2046
2047 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
2048 && XINT (*e) <= ZV))
2049 args_out_of_range (*b, *e);
2050}
2051\f
2052/* Advance BYTE_POS up to a character boundary
2053 and return the adjusted position. */
2054
2055static int
2056advance_to_char_boundary (byte_pos)
2057 int byte_pos;
2058{
2059 int c;
2060
2061 if (byte_pos == BEG)
2062 /* Beginning of buffer is always a character boundary. */
2063 return BEG;
2064
2065 c = FETCH_BYTE (byte_pos);
2066 if (! CHAR_HEAD_P (c))
2067 {
2068 /* We should advance BYTE_POS only when C is a constituent of a
2069 multibyte sequence. */
2070 int orig_byte_pos = byte_pos;
2071
2072 do
2073 {
2074 byte_pos--;
2075 c = FETCH_BYTE (byte_pos);
2076 }
2077 while (! CHAR_HEAD_P (c) && byte_pos > BEG);
2078 INC_POS (byte_pos);
2079 if (byte_pos < orig_byte_pos)
2080 byte_pos = orig_byte_pos;
2081 /* If C is a constituent of a multibyte sequence, BYTE_POS was
2082 surely advance to the correct character boundary. If C is
2083 not, BYTE_POS was unchanged. */
2084 }
2085
2086 return byte_pos;
2087}
2088
2089DEFUN ("set-buffer-multibyte", Fset_buffer_multibyte, Sset_buffer_multibyte,
2090 1, 1, 0,
2091 doc: /* Set the multibyte flag of the current buffer to FLAG.
2092If FLAG is t, this makes the buffer a multibyte buffer.
2093If FLAG is nil, this makes the buffer a single-byte buffer.
2094The buffer contents remain unchanged as a sequence of bytes
2095but the contents viewed as characters do change.
2096If the multibyte flag was really changed, undo information of the
2097current buffer is cleared. */)
2098 (flag)
2099 Lisp_Object flag;
2100{
2101 struct Lisp_Marker *tail, *markers;
2102 struct buffer *other;
2103 int undo_enabled_p = !EQ (current_buffer->undo_list, Qt);
2104 int begv, zv;
2105 int narrowed = (BEG != BEGV || Z != ZV);
2106 int modified_p = !NILP (Fbuffer_modified_p (Qnil));
2107
2108 if (current_buffer->base_buffer)
2109 error ("Cannot do `set-buffer-multibyte' on an indirect buffer");
2110
2111 /* Do nothing if nothing actually changes. */
2112 if (NILP (flag) == NILP (current_buffer->enable_multibyte_characters))
2113 return flag;
2114
2115 /* It would be better to update the list,
2116 but this is good enough for now. */
2117 if (undo_enabled_p)
2118 current_buffer->undo_list = Qt;
2119
2120 /* If the cached position is for this buffer, clear it out. */
2121 clear_charpos_cache (current_buffer);
2122
2123 if (NILP (flag))
2124 begv = BEGV_BYTE, zv = ZV_BYTE;
2125 else
2126 begv = BEGV, zv = ZV;
2127
2128 if (narrowed)
2129 Fwiden ();
2130
2131 if (NILP (flag))
2132 {
2133 int pos, stop;
2134 unsigned char *p;
2135
2136 /* Do this first, so it can use CHAR_TO_BYTE
2137 to calculate the old correspondences. */
2138 set_intervals_multibyte (0);
2139
2140 current_buffer->enable_multibyte_characters = Qnil;
2141
2142 Z = Z_BYTE;
2143 BEGV = BEGV_BYTE;
2144 ZV = ZV_BYTE;
2145 GPT = GPT_BYTE;
2146 TEMP_SET_PT_BOTH (PT_BYTE, PT_BYTE);
2147
2148
2149 for (tail = BUF_MARKERS (current_buffer); tail; tail = tail->next)
2150 tail->charpos = tail->bytepos;
2151
2152 /* Convert multibyte form of 8-bit characters to unibyte. */
2153 pos = BEG;
2154 stop = GPT;
2155 p = BEG_ADDR;
2156 while (1)
2157 {
2158 int c, bytes;
2159
2160 if (pos == stop)
2161 {
2162 if (pos == Z)
2163 break;
2164 p = GAP_END_ADDR;
2165 stop = Z;
2166 }
2167 if (MULTIBYTE_STR_AS_UNIBYTE_P (p, bytes))
2168 p += bytes, pos += bytes;
2169 else
2170 {
2171 c = STRING_CHAR (p, stop - pos);
2172 /* Delete all bytes for this 8-bit character but the
2173 last one, and change the last one to the charcter
2174 code. */
2175 bytes--;
2176 del_range_2 (pos, pos, pos + bytes, pos + bytes, 0);
2177 p = GAP_END_ADDR;
2178 *p++ = c;
2179 pos++;
2180 if (begv > pos)
2181 begv -= bytes;
2182 if (zv > pos)
2183 zv -= bytes;
2184 stop = Z;
2185 }
2186 }
2187 if (narrowed)
2188 Fnarrow_to_region (make_number (begv), make_number (zv));
2189 }
2190 else
2191 {
2192 int pt = PT;
2193 int pos, stop;
2194 unsigned char *p;
2195
2196 /* Be sure not to have a multibyte sequence striding over the GAP.
2197 Ex: We change this: "...abc\201 _GAP_ \241def..."
2198 to: "...abc _GAP_ \201\241def..." */
2199
2200 if (GPT_BYTE > 1 && GPT_BYTE < Z_BYTE
2201 && ! CHAR_HEAD_P (*(GAP_END_ADDR)))
2202 {
2203 unsigned char *p = GPT_ADDR - 1;
2204
2205 while (! CHAR_HEAD_P (*p) && p > BEG_ADDR) p--;
2206 if (BASE_LEADING_CODE_P (*p))
2207 {
2208 int new_gpt = GPT_BYTE - (GPT_ADDR - p);
2209
2210 move_gap_both (new_gpt, new_gpt);
2211 }
2212 }
2213
2214 /* Make the buffer contents valid as multibyte by converting
2215 8-bit characters to multibyte form. */
2216 pos = BEG;
2217 stop = GPT;
2218 p = BEG_ADDR;
2219 while (1)
2220 {
2221 int bytes;
2222
2223 if (pos == stop)
2224 {
2225 if (pos == Z)
2226 break;
2227 p = GAP_END_ADDR;
2228 stop = Z;
2229 }
2230
2231 if (UNIBYTE_STR_AS_MULTIBYTE_P (p, stop - pos, bytes))
2232 p += bytes, pos += bytes;
2233 else
2234 {
2235 unsigned char tmp[MAX_MULTIBYTE_LENGTH];
2236
2237 bytes = CHAR_STRING (*p, tmp);
2238 *p = tmp[0];
2239 TEMP_SET_PT_BOTH (pos + 1, pos + 1);
2240 bytes--;
2241 insert_1_both (tmp + 1, bytes, bytes, 1, 0, 0);
2242 /* Now the gap is after the just inserted data. */
2243 pos = GPT;
2244 p = GAP_END_ADDR;
2245 if (pos <= begv)
2246 begv += bytes;
2247 if (pos <= zv)
2248 zv += bytes;
2249 if (pos <= pt)
2250 pt += bytes;
2251 stop = Z;
2252 }
2253 }
2254
2255 if (pt != PT)
2256 TEMP_SET_PT (pt);
2257
2258 if (narrowed)
2259 Fnarrow_to_region (make_number (begv), make_number (zv));
2260
2261 /* Do this first, so that chars_in_text asks the right question.
2262 set_intervals_multibyte needs it too. */
2263 current_buffer->enable_multibyte_characters = Qt;
2264
2265 GPT_BYTE = advance_to_char_boundary (GPT_BYTE);
2266 GPT = chars_in_text (BEG_ADDR, GPT_BYTE - BEG_BYTE) + BEG;
2267
2268 Z = chars_in_text (GAP_END_ADDR, Z_BYTE - GPT_BYTE) + GPT;
2269
2270 BEGV_BYTE = advance_to_char_boundary (BEGV_BYTE);
2271 if (BEGV_BYTE > GPT_BYTE)
2272 BEGV = chars_in_text (GAP_END_ADDR, BEGV_BYTE - GPT_BYTE) + GPT;
2273 else
2274 BEGV = chars_in_text (BEG_ADDR, BEGV_BYTE - BEG_BYTE) + BEG;
2275
2276 ZV_BYTE = advance_to_char_boundary (ZV_BYTE);
2277 if (ZV_BYTE > GPT_BYTE)
2278 ZV = chars_in_text (GAP_END_ADDR, ZV_BYTE - GPT_BYTE) + GPT;
2279 else
2280 ZV = chars_in_text (BEG_ADDR, ZV_BYTE - BEG_BYTE) + BEG;
2281
2282 {
2283 int pt_byte = advance_to_char_boundary (PT_BYTE);
2284 int pt;
2285
2286 if (pt_byte > GPT_BYTE)
2287 pt = chars_in_text (GAP_END_ADDR, pt_byte - GPT_BYTE) + GPT;
2288 else
2289 pt = chars_in_text (BEG_ADDR, pt_byte - BEG_BYTE) + BEG;
2290 TEMP_SET_PT_BOTH (pt, pt_byte);
2291 }
2292
2293 tail = markers = BUF_MARKERS (current_buffer);
2294
2295 /* This prevents BYTE_TO_CHAR (that is, buf_bytepos_to_charpos) from
2296 getting confused by the markers that have not yet been updated.
2297 It is also a signal that it should never create a marker. */
2298 BUF_MARKERS (current_buffer) = NULL;
2299
2300 for (; tail; tail = tail->next)
2301 {
2302 tail->bytepos = advance_to_char_boundary (tail->bytepos);
2303 tail->charpos = BYTE_TO_CHAR (tail->bytepos);
2304 }
2305
2306 /* Make sure no markers were put on the chain
2307 while the chain value was incorrect. */
2308 if (BUF_MARKERS (current_buffer))
2309 abort ();
2310
2311 BUF_MARKERS (current_buffer) = markers;
2312
2313 /* Do this last, so it can calculate the new correspondences
2314 between chars and bytes. */
2315 set_intervals_multibyte (1);
2316 }
2317
2318 if (undo_enabled_p)
2319 current_buffer->undo_list = Qnil;
2320
2321 /* Changing the multibyteness of a buffer means that all windows
2322 showing that buffer must be updated thoroughly. */
2323 current_buffer->prevent_redisplay_optimizations_p = 1;
2324 ++windows_or_buffers_changed;
2325
2326 /* Copy this buffer's new multibyte status
2327 into all of its indirect buffers. */
2328 for (other = all_buffers; other; other = other->next)
2329 if (other->base_buffer == current_buffer && !NILP (other->name))
2330 {
2331 other->enable_multibyte_characters
2332 = current_buffer->enable_multibyte_characters;
2333 other->prevent_redisplay_optimizations_p = 1;
2334 }
2335
2336 /* Restore the modifiedness of the buffer. */
2337 if (!modified_p && !NILP (Fbuffer_modified_p (Qnil)))
2338 Fset_buffer_modified_p (Qnil);
2339
2340#ifdef subprocesses
2341 /* Update coding systems of this buffer's process (if any). */
2342 {
2343 Lisp_Object process;
2344
2345 process = Fget_buffer_process (Fcurrent_buffer ());
2346 if (PROCESSP (process))
2347 setup_process_coding_systems (process);
2348 }
2349#endif /* subprocesses */
2350
2351 return flag;
2352}
2353\f
2354DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
2355 0, 0, 0,
2356 doc: /* Switch to Fundamental mode by killing current buffer's local variables.
2357Most local variable bindings are eliminated so that the default values
2358become effective once more. Also, the syntax table is set from
2359`standard-syntax-table', the local keymap is set to nil,
2360and the abbrev table from `fundamental-mode-abbrev-table'.
2361This function also forces redisplay of the mode line.
2362
2363Every function to select a new major mode starts by
2364calling this function.
2365
2366As a special exception, local variables whose names have
2367a non-nil `permanent-local' property are not eliminated by this function.
2368
2369The first thing this function does is run
2370the normal hook `change-major-mode-hook'. */)
2371 ()
2372{
2373 register Lisp_Object alist, sym, tem;
2374 Lisp_Object oalist;
2375
2376 if (!NILP (Vrun_hooks))
2377 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
2378 oalist = current_buffer->local_var_alist;
2379
2380 /* Make sure none of the bindings in oalist
2381 remain swapped in, in their symbols. */
2382
2383 swap_out_buffer_local_variables (current_buffer);
2384
2385 /* Actually eliminate all local bindings of this buffer. */
2386
2387 reset_buffer_local_variables (current_buffer, 0);
2388
2389 /* Any which are supposed to be permanent,
2390 make local again, with the same values they had. */
2391
2392 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2393 {
2394 sym = XCAR (XCAR (alist));
2395 tem = Fget (sym, Qpermanent_local);
2396 if (! NILP (tem))
2397 {
2398 Fmake_local_variable (sym);
2399 Fset (sym, XCDR (XCAR (alist)));
2400 }
2401 }
2402
2403 /* Force mode-line redisplay. Useful here because all major mode
2404 commands call this function. */
2405 update_mode_lines++;
2406
2407 return Qnil;
2408}
2409
2410/* Make sure no local variables remain set up with buffer B
2411 for their current values. */
2412
2413static void
2414swap_out_buffer_local_variables (b)
2415 struct buffer *b;
2416{
2417 Lisp_Object oalist, alist, sym, tem, buffer;
2418
2419 XSETBUFFER (buffer, b);
2420 oalist = b->local_var_alist;
2421
2422 for (alist = oalist; !NILP (alist); alist = XCDR (alist))
2423 {
2424 sym = XCAR (XCAR (alist));
2425
2426 /* Need not do anything if some other buffer's binding is now encached. */
2427 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer;
2428 if (BUFFERP (tem) && XBUFFER (tem) == current_buffer)
2429 {
2430 /* Symbol is set up for this buffer's old local value.
2431 Set it up for the current buffer with the default value. */
2432
2433 tem = XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->cdr;
2434 /* Store the symbol's current value into the alist entry
2435 it is currently set up for. This is so that, if the
2436 local is marked permanent, and we make it local again
2437 later in Fkill_all_local_variables, we don't lose the value. */
2438 XSETCDR (XCAR (tem),
2439 do_symval_forwarding (XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue));
2440 /* Switch to the symbol's default-value alist entry. */
2441 XSETCAR (tem, tem);
2442 /* Mark it as current for buffer B. */
2443 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->buffer = buffer;
2444 /* Store the current value into any forwarding in the symbol. */
2445 store_symval_forwarding (sym,
2446 XBUFFER_LOCAL_VALUE (SYMBOL_VALUE (sym))->realvalue,
2447 XCDR (tem), NULL);
2448 }
2449 }
2450}
2451\f
2452/* Find all the overlays in the current buffer that contain position POS.
2453 Return the number found, and store them in a vector in *VEC_PTR.
2454 Store in *LEN_PTR the size allocated for the vector.
2455 Store in *NEXT_PTR the next position after POS where an overlay starts,
2456 or ZV if there are no more overlays.
2457 Store in *PREV_PTR the previous position before POS where an overlay ends,
2458 or where an overlay starts which ends at or after POS;
2459 or BEGV if there are no such overlays.
2460 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2461
2462 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2463 when this function is called.
2464
2465 If EXTEND is non-zero, we make the vector bigger if necessary.
2466 If EXTEND is zero, we never extend the vector,
2467 and we store only as many overlays as will fit.
2468 But we still return the total number of overlays.
2469
2470 If CHANGE_REQ is true, then any position written into *PREV_PTR or
2471 *NEXT_PTR is guaranteed to be not equal to POS, unless it is the
2472 default (BEGV or ZV). */
2473
2474int
2475overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr, prev_ptr, change_req)
2476 EMACS_INT pos;
2477 int extend;
2478 Lisp_Object **vec_ptr;
2479 int *len_ptr;
2480 int *next_ptr;
2481 int *prev_ptr;
2482 int change_req;
2483{
2484 Lisp_Object overlay, start, end;
2485 struct Lisp_Overlay *tail;
2486 int idx = 0;
2487 int len = *len_ptr;
2488 Lisp_Object *vec = *vec_ptr;
2489 int next = ZV;
2490 int prev = BEGV;
2491 int inhibit_storing = 0;
2492
2493 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2494 {
2495 int startpos, endpos;
2496
2497 XSETMISC (overlay, tail);
2498
2499 start = OVERLAY_START (overlay);
2500 end = OVERLAY_END (overlay);
2501 endpos = OVERLAY_POSITION (end);
2502 if (endpos < pos)
2503 {
2504 if (prev < endpos)
2505 prev = endpos;
2506 break;
2507 }
2508 startpos = OVERLAY_POSITION (start);
2509 /* This one ends at or after POS
2510 so its start counts for PREV_PTR if it's before POS. */
2511 if (prev < startpos && startpos < pos)
2512 prev = startpos;
2513 if (endpos == pos)
2514 continue;
2515 if (startpos <= pos)
2516 {
2517 if (idx == len)
2518 {
2519 /* The supplied vector is full.
2520 Either make it bigger, or don't store any more in it. */
2521 if (extend)
2522 {
2523 /* Make it work with an initial len == 0. */
2524 len *= 2;
2525 if (len == 0)
2526 len = 4;
2527 *len_ptr = len;
2528 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2529 *vec_ptr = vec;
2530 }
2531 else
2532 inhibit_storing = 1;
2533 }
2534
2535 if (!inhibit_storing)
2536 vec[idx] = overlay;
2537 /* Keep counting overlays even if we can't return them all. */
2538 idx++;
2539 }
2540 else if (startpos < next)
2541 next = startpos;
2542 }
2543
2544 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2545 {
2546 int startpos, endpos;
2547
2548 XSETMISC (overlay, tail);
2549
2550 start = OVERLAY_START (overlay);
2551 end = OVERLAY_END (overlay);
2552 startpos = OVERLAY_POSITION (start);
2553 if (pos < startpos)
2554 {
2555 if (startpos < next)
2556 next = startpos;
2557 break;
2558 }
2559 endpos = OVERLAY_POSITION (end);
2560 if (pos < endpos)
2561 {
2562 if (idx == len)
2563 {
2564 if (extend)
2565 {
2566 /* Make it work with an initial len == 0. */
2567 len *= 2;
2568 if (len == 0)
2569 len = 4;
2570 *len_ptr = len;
2571 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2572 *vec_ptr = vec;
2573 }
2574 else
2575 inhibit_storing = 1;
2576 }
2577
2578 if (!inhibit_storing)
2579 vec[idx] = overlay;
2580 idx++;
2581
2582 if (startpos < pos && startpos > prev)
2583 prev = startpos;
2584 }
2585 else if (endpos < pos && endpos > prev)
2586 prev = endpos;
2587 else if (endpos == pos && startpos > prev
2588 && (!change_req || startpos < pos))
2589 prev = startpos;
2590 }
2591
2592 if (next_ptr)
2593 *next_ptr = next;
2594 if (prev_ptr)
2595 *prev_ptr = prev;
2596 return idx;
2597}
2598\f
2599/* Find all the overlays in the current buffer that overlap the range BEG-END
2600 or are empty at BEG.
2601
2602 Return the number found, and store them in a vector in *VEC_PTR.
2603 Store in *LEN_PTR the size allocated for the vector.
2604 Store in *NEXT_PTR the next position after POS where an overlay starts,
2605 or ZV if there are no more overlays.
2606 Store in *PREV_PTR the previous position before POS where an overlay ends,
2607 or BEGV if there are no previous overlays.
2608 NEXT_PTR and/or PREV_PTR may be 0, meaning don't store that info.
2609
2610 *VEC_PTR and *LEN_PTR should contain a valid vector and size
2611 when this function is called.
2612
2613 If EXTEND is non-zero, we make the vector bigger if necessary.
2614 If EXTEND is zero, we never extend the vector,
2615 and we store only as many overlays as will fit.
2616 But we still return the total number of overlays. */
2617
2618static int
2619overlays_in (beg, end, extend, vec_ptr, len_ptr, next_ptr, prev_ptr)
2620 int beg, end;
2621 int extend;
2622 Lisp_Object **vec_ptr;
2623 int *len_ptr;
2624 int *next_ptr;
2625 int *prev_ptr;
2626{
2627 Lisp_Object overlay, ostart, oend;
2628 struct Lisp_Overlay *tail;
2629 int idx = 0;
2630 int len = *len_ptr;
2631 Lisp_Object *vec = *vec_ptr;
2632 int next = ZV;
2633 int prev = BEGV;
2634 int inhibit_storing = 0;
2635
2636 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2637 {
2638 int startpos, endpos;
2639
2640 XSETMISC (overlay, tail);
2641
2642 ostart = OVERLAY_START (overlay);
2643 oend = OVERLAY_END (overlay);
2644 endpos = OVERLAY_POSITION (oend);
2645 if (endpos < beg)
2646 {
2647 if (prev < endpos)
2648 prev = endpos;
2649 break;
2650 }
2651 startpos = OVERLAY_POSITION (ostart);
2652 /* Count an interval if it either overlaps the range
2653 or is empty at the start of the range. */
2654 if ((beg < endpos && startpos < end)
2655 || (startpos == endpos && beg == endpos))
2656 {
2657 if (idx == len)
2658 {
2659 /* The supplied vector is full.
2660 Either make it bigger, or don't store any more in it. */
2661 if (extend)
2662 {
2663 /* Make it work with an initial len == 0. */
2664 len *= 2;
2665 if (len == 0)
2666 len = 4;
2667 *len_ptr = len;
2668 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2669 *vec_ptr = vec;
2670 }
2671 else
2672 inhibit_storing = 1;
2673 }
2674
2675 if (!inhibit_storing)
2676 vec[idx] = overlay;
2677 /* Keep counting overlays even if we can't return them all. */
2678 idx++;
2679 }
2680 else if (startpos < next)
2681 next = startpos;
2682 }
2683
2684 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2685 {
2686 int startpos, endpos;
2687
2688 XSETMISC (overlay, tail);
2689
2690 ostart = OVERLAY_START (overlay);
2691 oend = OVERLAY_END (overlay);
2692 startpos = OVERLAY_POSITION (ostart);
2693 if (end < startpos)
2694 {
2695 if (startpos < next)
2696 next = startpos;
2697 break;
2698 }
2699 endpos = OVERLAY_POSITION (oend);
2700 /* Count an interval if it either overlaps the range
2701 or is empty at the start of the range. */
2702 if ((beg < endpos && startpos < end)
2703 || (startpos == endpos && beg == endpos))
2704 {
2705 if (idx == len)
2706 {
2707 if (extend)
2708 {
2709 /* Make it work with an initial len == 0. */
2710 len *= 2;
2711 if (len == 0)
2712 len = 4;
2713 *len_ptr = len;
2714 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
2715 *vec_ptr = vec;
2716 }
2717 else
2718 inhibit_storing = 1;
2719 }
2720
2721 if (!inhibit_storing)
2722 vec[idx] = overlay;
2723 idx++;
2724 }
2725 else if (endpos < beg && endpos > prev)
2726 prev = endpos;
2727 }
2728
2729 if (next_ptr)
2730 *next_ptr = next;
2731 if (prev_ptr)
2732 *prev_ptr = prev;
2733 return idx;
2734}
2735
2736
2737/* Return non-zero if there exists an overlay with a non-nil
2738 `mouse-face' property overlapping OVERLAY. */
2739
2740int
2741mouse_face_overlay_overlaps (overlay)
2742 Lisp_Object overlay;
2743{
2744 int start = OVERLAY_POSITION (OVERLAY_START (overlay));
2745 int end = OVERLAY_POSITION (OVERLAY_END (overlay));
2746 int n, i, size;
2747 Lisp_Object *v, tem;
2748
2749 size = 10;
2750 v = (Lisp_Object *) alloca (size * sizeof *v);
2751 n = overlays_in (start, end, 0, &v, &size, NULL, NULL);
2752 if (n > size)
2753 {
2754 v = (Lisp_Object *) alloca (n * sizeof *v);
2755 overlays_in (start, end, 0, &v, &n, NULL, NULL);
2756 }
2757
2758 for (i = 0; i < n; ++i)
2759 if (!EQ (v[i], overlay)
2760 && (tem = Foverlay_get (overlay, Qmouse_face),
2761 !NILP (tem)))
2762 break;
2763
2764 return i < n;
2765}
2766
2767
2768\f
2769/* Fast function to just test if we're at an overlay boundary. */
2770int
2771overlay_touches_p (pos)
2772 int pos;
2773{
2774 Lisp_Object overlay;
2775 struct Lisp_Overlay *tail;
2776
2777 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
2778 {
2779 int endpos;
2780
2781 XSETMISC (overlay ,tail);
2782 if (!GC_OVERLAYP (overlay))
2783 abort ();
2784
2785 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
2786 if (endpos < pos)
2787 break;
2788 if (endpos == pos || OVERLAY_POSITION (OVERLAY_START (overlay)) == pos)
2789 return 1;
2790 }
2791
2792 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
2793 {
2794 int startpos;
2795
2796 XSETMISC (overlay, tail);
2797 if (!GC_OVERLAYP (overlay))
2798 abort ();
2799
2800 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
2801 if (pos < startpos)
2802 break;
2803 if (startpos == pos || OVERLAY_POSITION (OVERLAY_END (overlay)) == pos)
2804 return 1;
2805 }
2806 return 0;
2807}
2808\f
2809struct sortvec
2810{
2811 Lisp_Object overlay;
2812 int beg, end;
2813 int priority;
2814};
2815
2816static int
2817compare_overlays (v1, v2)
2818 const void *v1, *v2;
2819{
2820 const struct sortvec *s1 = (const struct sortvec *) v1;
2821 const struct sortvec *s2 = (const struct sortvec *) v2;
2822 if (s1->priority != s2->priority)
2823 return s1->priority - s2->priority;
2824 if (s1->beg != s2->beg)
2825 return s1->beg - s2->beg;
2826 if (s1->end != s2->end)
2827 return s2->end - s1->end;
2828 return 0;
2829}
2830
2831/* Sort an array of overlays by priority. The array is modified in place.
2832 The return value is the new size; this may be smaller than the original
2833 size if some of the overlays were invalid or were window-specific. */
2834int
2835sort_overlays (overlay_vec, noverlays, w)
2836 Lisp_Object *overlay_vec;
2837 int noverlays;
2838 struct window *w;
2839{
2840 int i, j;
2841 struct sortvec *sortvec;
2842 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
2843
2844 /* Put the valid and relevant overlays into sortvec. */
2845
2846 for (i = 0, j = 0; i < noverlays; i++)
2847 {
2848 Lisp_Object tem;
2849 Lisp_Object overlay;
2850
2851 overlay = overlay_vec[i];
2852 if (OVERLAY_VALID (overlay)
2853 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
2854 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
2855 {
2856 /* If we're interested in a specific window, then ignore
2857 overlays that are limited to some other window. */
2858 if (w)
2859 {
2860 Lisp_Object window;
2861
2862 window = Foverlay_get (overlay, Qwindow);
2863 if (WINDOWP (window) && XWINDOW (window) != w)
2864 continue;
2865 }
2866
2867 /* This overlay is good and counts: put it into sortvec. */
2868 sortvec[j].overlay = overlay;
2869 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
2870 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
2871 tem = Foverlay_get (overlay, Qpriority);
2872 if (INTEGERP (tem))
2873 sortvec[j].priority = XINT (tem);
2874 else
2875 sortvec[j].priority = 0;
2876 j++;
2877 }
2878 }
2879 noverlays = j;
2880
2881 /* Sort the overlays into the proper order: increasing priority. */
2882
2883 if (noverlays > 1)
2884 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
2885
2886 for (i = 0; i < noverlays; i++)
2887 overlay_vec[i] = sortvec[i].overlay;
2888 return (noverlays);
2889}
2890\f
2891struct sortstr
2892{
2893 Lisp_Object string, string2;
2894 int size;
2895 int priority;
2896};
2897
2898struct sortstrlist
2899{
2900 struct sortstr *buf; /* An array that expands as needed; never freed. */
2901 int size; /* Allocated length of that array. */
2902 int used; /* How much of the array is currently in use. */
2903 int bytes; /* Total length of the strings in buf. */
2904};
2905
2906/* Buffers for storing information about the overlays touching a given
2907 position. These could be automatic variables in overlay_strings, but
2908 it's more efficient to hold onto the memory instead of repeatedly
2909 allocating and freeing it. */
2910static struct sortstrlist overlay_heads, overlay_tails;
2911static unsigned char *overlay_str_buf;
2912
2913/* Allocated length of overlay_str_buf. */
2914static int overlay_str_len;
2915
2916/* A comparison function suitable for passing to qsort. */
2917static int
2918cmp_for_strings (as1, as2)
2919 char *as1, *as2;
2920{
2921 struct sortstr *s1 = (struct sortstr *)as1;
2922 struct sortstr *s2 = (struct sortstr *)as2;
2923 if (s1->size != s2->size)
2924 return s2->size - s1->size;
2925 if (s1->priority != s2->priority)
2926 return s1->priority - s2->priority;
2927 return 0;
2928}
2929
2930static void
2931record_overlay_string (ssl, str, str2, pri, size)
2932 struct sortstrlist *ssl;
2933 Lisp_Object str, str2, pri;
2934 int size;
2935{
2936 int nbytes;
2937
2938 if (ssl->used == ssl->size)
2939 {
2940 if (ssl->buf)
2941 ssl->size *= 2;
2942 else
2943 ssl->size = 5;
2944 ssl->buf = ((struct sortstr *)
2945 xrealloc (ssl->buf, ssl->size * sizeof (struct sortstr)));
2946 }
2947 ssl->buf[ssl->used].string = str;
2948 ssl->buf[ssl->used].string2 = str2;
2949 ssl->buf[ssl->used].size = size;
2950 ssl->buf[ssl->used].priority = (INTEGERP (pri) ? XINT (pri) : 0);
2951 ssl->used++;
2952
2953 if (NILP (current_buffer->enable_multibyte_characters))
2954 nbytes = SCHARS (str);
2955 else if (! STRING_MULTIBYTE (str))
2956 nbytes = count_size_as_multibyte (SDATA (str),
2957 SBYTES (str));
2958 else
2959 nbytes = SBYTES (str);
2960
2961 ssl->bytes += nbytes;
2962
2963 if (STRINGP (str2))
2964 {
2965 if (NILP (current_buffer->enable_multibyte_characters))
2966 nbytes = SCHARS (str2);
2967 else if (! STRING_MULTIBYTE (str2))
2968 nbytes = count_size_as_multibyte (SDATA (str2),
2969 SBYTES (str2));
2970 else
2971 nbytes = SBYTES (str2);
2972
2973 ssl->bytes += nbytes;
2974 }
2975}
2976
2977/* Return the concatenation of the strings associated with overlays that
2978 begin or end at POS, ignoring overlays that are specific to a window
2979 other than W. The strings are concatenated in the appropriate order:
2980 shorter overlays nest inside longer ones, and higher priority inside
2981 lower. Normally all of the after-strings come first, but zero-sized
2982 overlays have their after-strings ride along with the before-strings
2983 because it would look strange to print them inside-out.
2984
2985 Returns the string length, and stores the contents indirectly through
2986 PSTR, if that variable is non-null. The string may be overwritten by
2987 subsequent calls. */
2988
2989int
2990overlay_strings (pos, w, pstr)
2991 EMACS_INT pos;
2992 struct window *w;
2993 unsigned char **pstr;
2994{
2995 Lisp_Object overlay, window, str;
2996 struct Lisp_Overlay *ov;
2997 int startpos, endpos;
2998 int multibyte = ! NILP (current_buffer->enable_multibyte_characters);
2999
3000 overlay_heads.used = overlay_heads.bytes = 0;
3001 overlay_tails.used = overlay_tails.bytes = 0;
3002 for (ov = current_buffer->overlays_before; ov; ov = ov->next)
3003 {
3004 XSETMISC (overlay, ov);
3005 eassert (OVERLAYP (overlay));
3006
3007 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3008 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3009 if (endpos < pos)
3010 break;
3011 if (endpos != pos && startpos != pos)
3012 continue;
3013 window = Foverlay_get (overlay, Qwindow);
3014 if (WINDOWP (window) && XWINDOW (window) != w)
3015 continue;
3016 if (startpos == pos
3017 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3018 record_overlay_string (&overlay_heads, str,
3019 (startpos == endpos
3020 ? Foverlay_get (overlay, Qafter_string)
3021 : Qnil),
3022 Foverlay_get (overlay, Qpriority),
3023 endpos - startpos);
3024 else if (endpos == pos
3025 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3026 record_overlay_string (&overlay_tails, str, Qnil,
3027 Foverlay_get (overlay, Qpriority),
3028 endpos - startpos);
3029 }
3030 for (ov = current_buffer->overlays_after; ov; ov = ov->next)
3031 {
3032 XSETMISC (overlay, ov);
3033 eassert (OVERLAYP (overlay));
3034
3035 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3036 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3037 if (startpos > pos)
3038 break;
3039 if (endpos != pos && startpos != pos)
3040 continue;
3041 window = Foverlay_get (overlay, Qwindow);
3042 if (WINDOWP (window) && XWINDOW (window) != w)
3043 continue;
3044 if (startpos == pos
3045 && (str = Foverlay_get (overlay, Qbefore_string), STRINGP (str)))
3046 record_overlay_string (&overlay_heads, str,
3047 (startpos == endpos
3048 ? Foverlay_get (overlay, Qafter_string)
3049 : Qnil),
3050 Foverlay_get (overlay, Qpriority),
3051 endpos - startpos);
3052 else if (endpos == pos
3053 && (str = Foverlay_get (overlay, Qafter_string), STRINGP (str)))
3054 record_overlay_string (&overlay_tails, str, Qnil,
3055 Foverlay_get (overlay, Qpriority),
3056 endpos - startpos);
3057 }
3058 if (overlay_tails.used > 1)
3059 qsort (overlay_tails.buf, overlay_tails.used, sizeof (struct sortstr),
3060 cmp_for_strings);
3061 if (overlay_heads.used > 1)
3062 qsort (overlay_heads.buf, overlay_heads.used, sizeof (struct sortstr),
3063 cmp_for_strings);
3064 if (overlay_heads.bytes || overlay_tails.bytes)
3065 {
3066 Lisp_Object tem;
3067 int i;
3068 unsigned char *p;
3069 int total = overlay_heads.bytes + overlay_tails.bytes;
3070
3071 if (total > overlay_str_len)
3072 {
3073 overlay_str_len = total;
3074 overlay_str_buf = (unsigned char *)xrealloc (overlay_str_buf,
3075 total);
3076 }
3077 p = overlay_str_buf;
3078 for (i = overlay_tails.used; --i >= 0;)
3079 {
3080 int nbytes;
3081 tem = overlay_tails.buf[i].string;
3082 nbytes = copy_text (SDATA (tem), p,
3083 SBYTES (tem),
3084 STRING_MULTIBYTE (tem), multibyte);
3085 p += nbytes;
3086 }
3087 for (i = 0; i < overlay_heads.used; ++i)
3088 {
3089 int nbytes;
3090 tem = overlay_heads.buf[i].string;
3091 nbytes = copy_text (SDATA (tem), p,
3092 SBYTES (tem),
3093 STRING_MULTIBYTE (tem), multibyte);
3094 p += nbytes;
3095 tem = overlay_heads.buf[i].string2;
3096 if (STRINGP (tem))
3097 {
3098 nbytes = copy_text (SDATA (tem), p,
3099 SBYTES (tem),
3100 STRING_MULTIBYTE (tem), multibyte);
3101 p += nbytes;
3102 }
3103 }
3104 if (p != overlay_str_buf + total)
3105 abort ();
3106 if (pstr)
3107 *pstr = overlay_str_buf;
3108 return total;
3109 }
3110 return 0;
3111}
3112\f
3113/* Shift overlays in BUF's overlay lists, to center the lists at POS. */
3114
3115void
3116recenter_overlay_lists (buf, pos)
3117 struct buffer *buf;
3118 EMACS_INT pos;
3119{
3120 Lisp_Object overlay, beg, end;
3121 struct Lisp_Overlay *prev, *tail, *next;
3122
3123 /* See if anything in overlays_before should move to overlays_after. */
3124
3125 /* We don't strictly need prev in this loop; it should always be nil.
3126 But we use it for symmetry and in case that should cease to be true
3127 with some future change. */
3128 prev = NULL;
3129 for (tail = buf->overlays_before; tail; prev = tail, tail = next)
3130 {
3131 next = tail->next;
3132 XSETMISC (overlay, tail);
3133
3134 /* If the overlay is not valid, get rid of it. */
3135 if (!OVERLAY_VALID (overlay))
3136#if 1
3137 abort ();
3138#else
3139 {
3140 /* Splice the cons cell TAIL out of overlays_before. */
3141 if (!NILP (prev))
3142 XCDR (prev) = next;
3143 else
3144 buf->overlays_before = next;
3145 tail = prev;
3146 continue;
3147 }
3148#endif
3149
3150 beg = OVERLAY_START (overlay);
3151 end = OVERLAY_END (overlay);
3152
3153 if (OVERLAY_POSITION (end) > pos)
3154 {
3155 /* OVERLAY needs to be moved. */
3156 int where = OVERLAY_POSITION (beg);
3157 struct Lisp_Overlay *other, *other_prev;
3158
3159 /* Splice the cons cell TAIL out of overlays_before. */
3160 if (prev)
3161 prev->next = next;
3162 else
3163 buf->overlays_before = next;
3164
3165 /* Search thru overlays_after for where to put it. */
3166 other_prev = NULL;
3167 for (other = buf->overlays_after; other;
3168 other_prev = other, other = other->next)
3169 {
3170 Lisp_Object otherbeg, otheroverlay;
3171
3172 XSETMISC (otheroverlay, other);
3173 eassert (OVERLAY_VALID (otheroverlay));
3174
3175 otherbeg = OVERLAY_START (otheroverlay);
3176 if (OVERLAY_POSITION (otherbeg) >= where)
3177 break;
3178 }
3179
3180 /* Add TAIL to overlays_after before OTHER. */
3181 tail->next = other;
3182 if (other_prev)
3183 other_prev->next = tail;
3184 else
3185 buf->overlays_after = tail;
3186 tail = prev;
3187 }
3188 else
3189 /* We've reached the things that should stay in overlays_before.
3190 All the rest of overlays_before must end even earlier,
3191 so stop now. */
3192 break;
3193 }
3194
3195 /* See if anything in overlays_after should be in overlays_before. */
3196 prev = NULL;
3197 for (tail = buf->overlays_after; tail; prev = tail, tail = next)
3198 {
3199 next = tail->next;
3200 XSETMISC (overlay, tail);
3201
3202 /* If the overlay is not valid, get rid of it. */
3203 if (!OVERLAY_VALID (overlay))
3204#if 1
3205 abort ();
3206#else
3207 {
3208 /* Splice the cons cell TAIL out of overlays_after. */
3209 if (!NILP (prev))
3210 XCDR (prev) = next;
3211 else
3212 buf->overlays_after = next;
3213 tail = prev;
3214 continue;
3215 }
3216#endif
3217
3218 beg = OVERLAY_START (overlay);
3219 end = OVERLAY_END (overlay);
3220
3221 /* Stop looking, when we know that nothing further
3222 can possibly end before POS. */
3223 if (OVERLAY_POSITION (beg) > pos)
3224 break;
3225
3226 if (OVERLAY_POSITION (end) <= pos)
3227 {
3228 /* OVERLAY needs to be moved. */
3229 int where = OVERLAY_POSITION (end);
3230 struct Lisp_Overlay *other, *other_prev;
3231
3232 /* Splice the cons cell TAIL out of overlays_after. */
3233 if (prev)
3234 prev->next = next;
3235 else
3236 buf->overlays_after = next;
3237
3238 /* Search thru overlays_before for where to put it. */
3239 other_prev = NULL;
3240 for (other = buf->overlays_before; other;
3241 other_prev = other, other = other->next)
3242 {
3243 Lisp_Object otherend, otheroverlay;
3244
3245 XSETMISC (otheroverlay, other);
3246 eassert (OVERLAY_VALID (otheroverlay));
3247
3248 otherend = OVERLAY_END (otheroverlay);
3249 if (OVERLAY_POSITION (otherend) <= where)
3250 break;
3251 }
3252
3253 /* Add TAIL to overlays_before before OTHER. */
3254 tail->next = other;
3255 if (other_prev)
3256 other_prev->next = tail;
3257 else
3258 buf->overlays_before = tail;
3259 tail = prev;
3260 }
3261 }
3262
3263 buf->overlay_center = pos;
3264}
3265
3266void
3267adjust_overlays_for_insert (pos, length)
3268 EMACS_INT pos;
3269 EMACS_INT length;
3270{
3271 /* After an insertion, the lists are still sorted properly,
3272 but we may need to update the value of the overlay center. */
3273 if (current_buffer->overlay_center >= pos)
3274 current_buffer->overlay_center += length;
3275}
3276
3277void
3278adjust_overlays_for_delete (pos, length)
3279 EMACS_INT pos;
3280 EMACS_INT length;
3281{
3282 if (current_buffer->overlay_center < pos)
3283 /* The deletion was to our right. No change needed; the before- and
3284 after-lists are still consistent. */
3285 ;
3286 else if (current_buffer->overlay_center > pos + length)
3287 /* The deletion was to our left. We need to adjust the center value
3288 to account for the change in position, but the lists are consistent
3289 given the new value. */
3290 current_buffer->overlay_center -= length;
3291 else
3292 /* We're right in the middle. There might be things on the after-list
3293 that now belong on the before-list. Recentering will move them,
3294 and also update the center point. */
3295 recenter_overlay_lists (current_buffer, pos);
3296}
3297
3298/* Fix up overlays that were garbled as a result of permuting markers
3299 in the range START through END. Any overlay with at least one
3300 endpoint in this range will need to be unlinked from the overlay
3301 list and reinserted in its proper place.
3302 Such an overlay might even have negative size at this point.
3303 If so, we'll make the overlay empty. */
3304void
3305fix_start_end_in_overlays (start, end)
3306 register int start, end;
3307{
3308 Lisp_Object overlay;
3309 struct Lisp_Overlay *before_list, *after_list;
3310 /* These are either nil, indicating that before_list or after_list
3311 should be assigned, or the cons cell the cdr of which should be
3312 assigned. */
3313 struct Lisp_Overlay *beforep = NULL, *afterp = NULL;
3314 /* 'Parent', likewise, indicates a cons cell or
3315 current_buffer->overlays_before or overlays_after, depending
3316 which loop we're in. */
3317 struct Lisp_Overlay *tail, *parent;
3318 int startpos, endpos;
3319
3320 /* This algorithm shifts links around instead of consing and GCing.
3321 The loop invariant is that before_list (resp. after_list) is a
3322 well-formed list except that its last element, the CDR of beforep
3323 (resp. afterp) if beforep (afterp) isn't nil or before_list
3324 (after_list) if it is, is still uninitialized. So it's not a bug
3325 that before_list isn't initialized, although it may look
3326 strange. */
3327 for (parent = NULL, tail = current_buffer->overlays_before; tail;)
3328 {
3329 XSETMISC (overlay, tail);
3330
3331 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3332 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3333
3334 /* If the overlay is backwards, make it empty. */
3335 if (endpos < startpos)
3336 {
3337 startpos = endpos;
3338 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3339 Qnil);
3340 }
3341
3342 if (endpos < start)
3343 break;
3344
3345 if (endpos < end
3346 || (startpos >= start && startpos < end))
3347 {
3348 /* Add it to the end of the wrong list. Later on,
3349 recenter_overlay_lists will move it to the right place. */
3350 if (endpos < current_buffer->overlay_center)
3351 {
3352 if (!afterp)
3353 after_list = tail;
3354 else
3355 afterp->next = tail;
3356 afterp = tail;
3357 }
3358 else
3359 {
3360 if (!beforep)
3361 before_list = tail;
3362 else
3363 beforep->next = tail;
3364 beforep = tail;
3365 }
3366 if (!parent)
3367 current_buffer->overlays_before = tail->next;
3368 else
3369 parent->next = tail->next;
3370 tail = tail->next;
3371 }
3372 else
3373 parent = tail, tail = parent->next;
3374 }
3375 for (parent = NULL, tail = current_buffer->overlays_after; tail;)
3376 {
3377 XSETMISC (overlay, tail);
3378
3379 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
3380 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
3381
3382 /* If the overlay is backwards, make it empty. */
3383 if (endpos < startpos)
3384 {
3385 startpos = endpos;
3386 Fset_marker (OVERLAY_START (overlay), make_number (startpos),
3387 Qnil);
3388 }
3389
3390 if (startpos >= end)
3391 break;
3392
3393 if (startpos >= start
3394 || (endpos >= start && endpos < end))
3395 {
3396 if (endpos < current_buffer->overlay_center)
3397 {
3398 if (!afterp)
3399 after_list = tail;
3400 else
3401 afterp->next = tail;
3402 afterp = tail;
3403 }
3404 else
3405 {
3406 if (!beforep)
3407 before_list = tail;
3408 else
3409 beforep->next = tail;
3410 beforep = tail;
3411 }
3412 if (!parent)
3413 current_buffer->overlays_after = tail->next;
3414 else
3415 parent->next = tail->next;
3416 tail = tail->next;
3417 }
3418 else
3419 parent = tail, tail = parent->next;
3420 }
3421
3422 /* Splice the constructed (wrong) lists into the buffer's lists,
3423 and let the recenter function make it sane again. */
3424 if (beforep)
3425 {
3426 beforep->next = current_buffer->overlays_before;
3427 current_buffer->overlays_before = before_list;
3428 }
3429 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3430
3431 if (afterp)
3432 {
3433 afterp->next = current_buffer->overlays_after;
3434 current_buffer->overlays_after = after_list;
3435 }
3436 recenter_overlay_lists (current_buffer, current_buffer->overlay_center);
3437}
3438
3439/* We have two types of overlay: the one whose ending marker is
3440 after-insertion-marker (this is the usual case) and the one whose
3441 ending marker is before-insertion-marker. When `overlays_before'
3442 contains overlays of the latter type and the former type in this
3443 order and both overlays end at inserting position, inserting a text
3444 increases only the ending marker of the latter type, which results
3445 in incorrect ordering of `overlays_before'.
3446
3447 This function fixes ordering of overlays in the slot
3448 `overlays_before' of the buffer *BP. Before the insertion, `point'
3449 was at PREV, and now is at POS. */
3450
3451void
3452fix_overlays_before (bp, prev, pos)
3453 struct buffer *bp;
3454 EMACS_INT prev, pos;
3455{
3456 /* If parent is nil, replace overlays_before; otherwise, parent->next. */
3457 struct Lisp_Overlay *tail = bp->overlays_before, *parent = NULL, *right_pair;
3458 Lisp_Object tem;
3459 EMACS_INT end;
3460
3461 /* After the insertion, the several overlays may be in incorrect
3462 order. The possibility is that, in the list `overlays_before',
3463 an overlay which ends at POS appears after an overlay which ends
3464 at PREV. Since POS is greater than PREV, we must fix the
3465 ordering of these overlays, by moving overlays ends at POS before
3466 the overlays ends at PREV. */
3467
3468 /* At first, find a place where disordered overlays should be linked
3469 in. It is where an overlay which end before POS exists. (i.e. an
3470 overlay whose ending marker is after-insertion-marker if disorder
3471 exists). */
3472 while (tail
3473 && (XSETMISC (tem, tail),
3474 (end = OVERLAY_POSITION (OVERLAY_END (tem))) >= pos))
3475 {
3476 parent = tail;
3477 tail = tail->next;
3478 }
3479
3480 /* If we don't find such an overlay,
3481 or the found one ends before PREV,
3482 or the found one is the last one in the list,
3483 we don't have to fix anything. */
3484 if (!tail || end < prev || !tail->next)
3485 return;
3486
3487 right_pair = parent;
3488 parent = tail;
3489 tail = tail->next;
3490
3491 /* Now, end position of overlays in the list TAIL should be before
3492 or equal to PREV. In the loop, an overlay which ends at POS is
3493 moved ahead to the place indicated by the CDR of RIGHT_PAIR. If
3494 we found an overlay which ends before PREV, the remaining
3495 overlays are in correct order. */
3496 while (tail)
3497 {
3498 XSETMISC (tem, tail);
3499 end = OVERLAY_POSITION (OVERLAY_END (tem));
3500
3501 if (end == pos)
3502 { /* This overlay is disordered. */
3503 struct Lisp_Overlay *found = tail;
3504
3505 /* Unlink the found overlay. */
3506 tail = found->next;
3507 parent->next = tail;
3508 /* Move an overlay at RIGHT_PLACE to the next of the found one,
3509 and link it into the right place. */
3510 if (!right_pair)
3511 {
3512 found->next = bp->overlays_before;
3513 bp->overlays_before = found;
3514 }
3515 else
3516 {
3517 found->next = right_pair->next;
3518 right_pair->next = found;
3519 }
3520 }
3521 else if (end == prev)
3522 {
3523 parent = tail;
3524 tail = tail->next;
3525 }
3526 else /* No more disordered overlay. */
3527 break;
3528 }
3529}
3530\f
3531DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
3532 doc: /* Return t if OBJECT is an overlay. */)
3533 (object)
3534 Lisp_Object object;
3535{
3536 return (OVERLAYP (object) ? Qt : Qnil);
3537}
3538
3539DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 5, 0,
3540 doc: /* Create a new overlay with range BEG to END in BUFFER.
3541If omitted, BUFFER defaults to the current buffer.
3542BEG and END may be integers or markers.
3543The fourth arg FRONT-ADVANCE, if non-nil, makes the
3544front delimiter advance when text is inserted there.
3545The fifth arg REAR-ADVANCE, if non-nil, makes the
3546rear delimiter advance when text is inserted there. */)
3547 (beg, end, buffer, front_advance, rear_advance)
3548 Lisp_Object beg, end, buffer;
3549 Lisp_Object front_advance, rear_advance;
3550{
3551 Lisp_Object overlay;
3552 struct buffer *b;
3553
3554 if (NILP (buffer))
3555 XSETBUFFER (buffer, current_buffer);
3556 else
3557 CHECK_BUFFER (buffer);
3558 if (MARKERP (beg)
3559 && ! EQ (Fmarker_buffer (beg), buffer))
3560 error ("Marker points into wrong buffer");
3561 if (MARKERP (end)
3562 && ! EQ (Fmarker_buffer (end), buffer))
3563 error ("Marker points into wrong buffer");
3564
3565 CHECK_NUMBER_COERCE_MARKER (beg);
3566 CHECK_NUMBER_COERCE_MARKER (end);
3567
3568 if (XINT (beg) > XINT (end))
3569 {
3570 Lisp_Object temp;
3571 temp = beg; beg = end; end = temp;
3572 }
3573
3574 b = XBUFFER (buffer);
3575
3576 beg = Fset_marker (Fmake_marker (), beg, buffer);
3577 end = Fset_marker (Fmake_marker (), end, buffer);
3578
3579 if (!NILP (front_advance))
3580 XMARKER (beg)->insertion_type = 1;
3581 if (!NILP (rear_advance))
3582 XMARKER (end)->insertion_type = 1;
3583
3584 overlay = allocate_misc ();
3585 XMISCTYPE (overlay) = Lisp_Misc_Overlay;
3586 XOVERLAY (overlay)->start = beg;
3587 XOVERLAY (overlay)->end = end;
3588 XOVERLAY (overlay)->plist = Qnil;
3589 XOVERLAY (overlay)->next = NULL;
3590
3591 /* Put the new overlay on the wrong list. */
3592 end = OVERLAY_END (overlay);
3593 if (OVERLAY_POSITION (end) < b->overlay_center)
3594 {
3595 if (b->overlays_after)
3596 XOVERLAY (overlay)->next = b->overlays_after;
3597 b->overlays_after = XOVERLAY (overlay);
3598 }
3599 else
3600 {
3601 if (b->overlays_before)
3602 XOVERLAY (overlay)->next = b->overlays_before;
3603 b->overlays_before = XOVERLAY (overlay);
3604 }
3605
3606 /* This puts it in the right list, and in the right order. */
3607 recenter_overlay_lists (b, b->overlay_center);
3608
3609 /* We don't need to redisplay the region covered by the overlay, because
3610 the overlay has no properties at the moment. */
3611
3612 return overlay;
3613}
3614\f
3615/* Mark a section of BUF as needing redisplay because of overlays changes. */
3616
3617static void
3618modify_overlay (buf, start, end)
3619 struct buffer *buf;
3620 EMACS_INT start, end;
3621{
3622 if (start > end)
3623 {
3624 int temp = start;
3625 start = end;
3626 end = temp;
3627 }
3628
3629 BUF_COMPUTE_UNCHANGED (buf, start, end);
3630
3631 /* If this is a buffer not in the selected window,
3632 we must do other windows. */
3633 if (buf != XBUFFER (XWINDOW (selected_window)->buffer))
3634 windows_or_buffers_changed = 1;
3635 /* If multiple windows show this buffer, we must do other windows. */
3636 else if (buffer_shared > 1)
3637 windows_or_buffers_changed = 1;
3638
3639 ++BUF_OVERLAY_MODIFF (buf);
3640}
3641
3642\f
3643Lisp_Object Fdelete_overlay ();
3644
3645static struct Lisp_Overlay *
3646unchain_overlay (list, overlay)
3647 struct Lisp_Overlay *list, *overlay;
3648{
3649 struct Lisp_Overlay *tmp, *prev;
3650 for (tmp = list, prev = NULL; tmp; prev = tmp, tmp = tmp->next)
3651 if (tmp == overlay)
3652 {
3653 if (prev)
3654 prev->next = tmp->next;
3655 else
3656 list = tmp->next;
3657 overlay->next = NULL;
3658 break;
3659 }
3660 return list;
3661}
3662
3663DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
3664 doc: /* Set the endpoints of OVERLAY to BEG and END in BUFFER.
3665If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.
3666If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current
3667buffer. */)
3668 (overlay, beg, end, buffer)
3669 Lisp_Object overlay, beg, end, buffer;
3670{
3671 struct buffer *b, *ob;
3672 Lisp_Object obuffer;
3673 int count = SPECPDL_INDEX ();
3674
3675 CHECK_OVERLAY (overlay);
3676 if (NILP (buffer))
3677 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3678 if (NILP (buffer))
3679 XSETBUFFER (buffer, current_buffer);
3680 CHECK_BUFFER (buffer);
3681
3682 if (MARKERP (beg)
3683 && ! EQ (Fmarker_buffer (beg), buffer))
3684 error ("Marker points into wrong buffer");
3685 if (MARKERP (end)
3686 && ! EQ (Fmarker_buffer (end), buffer))
3687 error ("Marker points into wrong buffer");
3688
3689 CHECK_NUMBER_COERCE_MARKER (beg);
3690 CHECK_NUMBER_COERCE_MARKER (end);
3691
3692 if (XINT (beg) == XINT (end) && ! NILP (Foverlay_get (overlay, Qevaporate)))
3693 return Fdelete_overlay (overlay);
3694
3695 if (XINT (beg) > XINT (end))
3696 {
3697 Lisp_Object temp;
3698 temp = beg; beg = end; end = temp;
3699 }
3700
3701 specbind (Qinhibit_quit, Qt);
3702
3703 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
3704 b = XBUFFER (buffer);
3705 ob = BUFFERP (obuffer) ? XBUFFER (obuffer) : (struct buffer *) 0;
3706
3707 /* If the overlay has changed buffers, do a thorough redisplay. */
3708 if (!EQ (buffer, obuffer))
3709 {
3710 /* Redisplay where the overlay was. */
3711 if (!NILP (obuffer))
3712 {
3713 int o_beg;
3714 int o_end;
3715
3716 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3717 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3718
3719 modify_overlay (ob, o_beg, o_end);
3720 }
3721
3722 /* Redisplay where the overlay is going to be. */
3723 modify_overlay (b, XINT (beg), XINT (end));
3724 }
3725 else
3726 /* Redisplay the area the overlay has just left, or just enclosed. */
3727 {
3728 int o_beg, o_end;
3729
3730 o_beg = OVERLAY_POSITION (OVERLAY_START (overlay));
3731 o_end = OVERLAY_POSITION (OVERLAY_END (overlay));
3732
3733 if (o_beg == XINT (beg))
3734 modify_overlay (b, o_end, XINT (end));
3735 else if (o_end == XINT (end))
3736 modify_overlay (b, o_beg, XINT (beg));
3737 else
3738 {
3739 if (XINT (beg) < o_beg) o_beg = XINT (beg);
3740 if (XINT (end) > o_end) o_end = XINT (end);
3741 modify_overlay (b, o_beg, o_end);
3742 }
3743 }
3744
3745 if (!NILP (obuffer))
3746 {
3747 ob->overlays_before
3748 = unchain_overlay (ob->overlays_before, XOVERLAY (overlay));
3749 ob->overlays_after
3750 = unchain_overlay (ob->overlays_after, XOVERLAY (overlay));
3751 eassert (XOVERLAY (overlay)->next == NULL);
3752 }
3753
3754 Fset_marker (OVERLAY_START (overlay), beg, buffer);
3755 Fset_marker (OVERLAY_END (overlay), end, buffer);
3756
3757 /* Put the overlay on the wrong list. */
3758 end = OVERLAY_END (overlay);
3759 if (OVERLAY_POSITION (end) < b->overlay_center)
3760 {
3761 XOVERLAY (overlay)->next = b->overlays_after;
3762 b->overlays_after = XOVERLAY (overlay);
3763 }
3764 else
3765 {
3766 XOVERLAY (overlay)->next = b->overlays_before;
3767 b->overlays_before = XOVERLAY (overlay);
3768 }
3769
3770 /* This puts it in the right list, and in the right order. */
3771 recenter_overlay_lists (b, b->overlay_center);
3772
3773 return unbind_to (count, overlay);
3774}
3775
3776DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
3777 doc: /* Delete the overlay OVERLAY from its buffer. */)
3778 (overlay)
3779 Lisp_Object overlay;
3780{
3781 Lisp_Object buffer;
3782 struct buffer *b;
3783 int count = SPECPDL_INDEX ();
3784
3785 CHECK_OVERLAY (overlay);
3786
3787 buffer = Fmarker_buffer (OVERLAY_START (overlay));
3788 if (NILP (buffer))
3789 return Qnil;
3790
3791 b = XBUFFER (buffer);
3792 specbind (Qinhibit_quit, Qt);
3793
3794 b->overlays_before = unchain_overlay (b->overlays_before,XOVERLAY (overlay));
3795 b->overlays_after = unchain_overlay (b->overlays_after, XOVERLAY (overlay));
3796 eassert (XOVERLAY (overlay)->next == NULL);
3797 modify_overlay (b,
3798 marker_position (OVERLAY_START (overlay)),
3799 marker_position (OVERLAY_END (overlay)));
3800 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
3801 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
3802
3803 /* When deleting an overlay with before or after strings, turn off
3804 display optimizations for the affected buffer, on the basis that
3805 these strings may contain newlines. This is easier to do than to
3806 check for that situation during redisplay. */
3807 if (!windows_or_buffers_changed
3808 && (!NILP (Foverlay_get (overlay, Qbefore_string))
3809 || !NILP (Foverlay_get (overlay, Qafter_string))))
3810 b->prevent_redisplay_optimizations_p = 1;
3811
3812 return unbind_to (count, Qnil);
3813}
3814\f
3815/* Overlay dissection functions. */
3816
3817DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
3818 doc: /* Return the position at which OVERLAY starts. */)
3819 (overlay)
3820 Lisp_Object overlay;
3821{
3822 CHECK_OVERLAY (overlay);
3823
3824 return (Fmarker_position (OVERLAY_START (overlay)));
3825}
3826
3827DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
3828 doc: /* Return the position at which OVERLAY ends. */)
3829 (overlay)
3830 Lisp_Object overlay;
3831{
3832 CHECK_OVERLAY (overlay);
3833
3834 return (Fmarker_position (OVERLAY_END (overlay)));
3835}
3836
3837DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
3838 doc: /* Return the buffer OVERLAY belongs to.
3839Return nil if OVERLAY has been deleted. */)
3840 (overlay)
3841 Lisp_Object overlay;
3842{
3843 CHECK_OVERLAY (overlay);
3844
3845 return Fmarker_buffer (OVERLAY_START (overlay));
3846}
3847
3848DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
3849 doc: /* Return a list of the properties on OVERLAY.
3850This is a copy of OVERLAY's plist; modifying its conses has no effect on
3851OVERLAY. */)
3852 (overlay)
3853 Lisp_Object overlay;
3854{
3855 CHECK_OVERLAY (overlay);
3856
3857 return Fcopy_sequence (XOVERLAY (overlay)->plist);
3858}
3859
3860\f
3861DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
3862 doc: /* Return a list of the overlays that contain position POS. */)
3863 (pos)
3864 Lisp_Object pos;
3865{
3866 int noverlays;
3867 Lisp_Object *overlay_vec;
3868 int len;
3869 Lisp_Object result;
3870
3871 CHECK_NUMBER_COERCE_MARKER (pos);
3872
3873 len = 10;
3874 /* We can't use alloca here because overlays_at can call xrealloc. */
3875 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3876
3877 /* Put all the overlays we want in a vector in overlay_vec.
3878 Store the length in len. */
3879 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3880 (int *) 0, (int *) 0, 0);
3881
3882 /* Make a list of them all. */
3883 result = Flist (noverlays, overlay_vec);
3884
3885 xfree (overlay_vec);
3886 return result;
3887}
3888
3889DEFUN ("overlays-in", Foverlays_in, Soverlays_in, 2, 2, 0,
3890 doc: /* Return a list of the overlays that overlap the region BEG ... END.
3891Overlap means that at least one character is contained within the overlay
3892and also contained within the specified region.
3893Empty overlays are included in the result if they are located at BEG
3894or between BEG and END. */)
3895 (beg, end)
3896 Lisp_Object beg, end;
3897{
3898 int noverlays;
3899 Lisp_Object *overlay_vec;
3900 int len;
3901 Lisp_Object result;
3902
3903 CHECK_NUMBER_COERCE_MARKER (beg);
3904 CHECK_NUMBER_COERCE_MARKER (end);
3905
3906 len = 10;
3907 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3908
3909 /* Put all the overlays we want in a vector in overlay_vec.
3910 Store the length in len. */
3911 noverlays = overlays_in (XINT (beg), XINT (end), 1, &overlay_vec, &len,
3912 (int *) 0, (int *) 0);
3913
3914 /* Make a list of them all. */
3915 result = Flist (noverlays, overlay_vec);
3916
3917 xfree (overlay_vec);
3918 return result;
3919}
3920
3921DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
3922 1, 1, 0,
3923 doc: /* Return the next position after POS where an overlay starts or ends.
3924If there are no more overlay boundaries after POS, return (point-max). */)
3925 (pos)
3926 Lisp_Object pos;
3927{
3928 int noverlays;
3929 int endpos;
3930 Lisp_Object *overlay_vec;
3931 int len;
3932 int i;
3933
3934 CHECK_NUMBER_COERCE_MARKER (pos);
3935
3936 len = 10;
3937 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3938
3939 /* Put all the overlays we want in a vector in overlay_vec.
3940 Store the length in len.
3941 endpos gets the position where the next overlay starts. */
3942 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3943 &endpos, (int *) 0, 1);
3944
3945 /* If any of these overlays ends before endpos,
3946 use its ending point instead. */
3947 for (i = 0; i < noverlays; i++)
3948 {
3949 Lisp_Object oend;
3950 int oendpos;
3951
3952 oend = OVERLAY_END (overlay_vec[i]);
3953 oendpos = OVERLAY_POSITION (oend);
3954 if (oendpos < endpos)
3955 endpos = oendpos;
3956 }
3957
3958 xfree (overlay_vec);
3959 return make_number (endpos);
3960}
3961
3962DEFUN ("previous-overlay-change", Fprevious_overlay_change,
3963 Sprevious_overlay_change, 1, 1, 0,
3964 doc: /* Return the previous position before POS where an overlay starts or ends.
3965If there are no more overlay boundaries before POS, return (point-min). */)
3966 (pos)
3967 Lisp_Object pos;
3968{
3969 int noverlays;
3970 int prevpos;
3971 Lisp_Object *overlay_vec;
3972 int len;
3973
3974 CHECK_NUMBER_COERCE_MARKER (pos);
3975
3976 /* At beginning of buffer, we know the answer;
3977 avoid bug subtracting 1 below. */
3978 if (XINT (pos) == BEGV)
3979 return pos;
3980
3981 len = 10;
3982 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
3983
3984 /* Put all the overlays we want in a vector in overlay_vec.
3985 Store the length in len.
3986 prevpos gets the position of the previous change. */
3987 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len,
3988 (int *) 0, &prevpos, 1);
3989
3990 xfree (overlay_vec);
3991 return make_number (prevpos);
3992}
3993\f
3994/* These functions are for debugging overlays. */
3995
3996DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
3997 doc: /* Return a pair of lists giving all the overlays of the current buffer.
3998The car has all the overlays before the overlay center;
3999the cdr has all the overlays after the overlay center.
4000Recentering overlays moves overlays between these lists.
4001The lists you get are copies, so that changing them has no effect.
4002However, the overlays you get are the real objects that the buffer uses. */)
4003 ()
4004{
4005 struct Lisp_Overlay *ol;
4006 Lisp_Object before = Qnil, after = Qnil, tmp;
4007 for (ol = current_buffer->overlays_before; ol; ol = ol->next)
4008 {
4009 XSETMISC (tmp, ol);
4010 before = Fcons (tmp, before);
4011 }
4012 for (ol = current_buffer->overlays_after; ol; ol = ol->next)
4013 {
4014 XSETMISC (tmp, ol);
4015 after = Fcons (tmp, after);
4016 }
4017 return Fcons (Fnreverse (before), Fnreverse (after));
4018}
4019
4020DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
4021 doc: /* Recenter the overlays of the current buffer around position POS.
4022That makes overlay lookup faster for positions near POS (but perhaps slower
4023for positions far away from POS). */)
4024 (pos)
4025 Lisp_Object pos;
4026{
4027 CHECK_NUMBER_COERCE_MARKER (pos);
4028
4029 recenter_overlay_lists (current_buffer, XINT (pos));
4030 return Qnil;
4031}
4032\f
4033DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
4034 doc: /* Get the property of overlay OVERLAY with property name PROP. */)
4035 (overlay, prop)
4036 Lisp_Object overlay, prop;
4037{
4038 CHECK_OVERLAY (overlay);
4039 return lookup_char_property (XOVERLAY (overlay)->plist, prop, 0);
4040}
4041
4042DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
4043 doc: /* Set one property of overlay OVERLAY: give property PROP value VALUE. */)
4044 (overlay, prop, value)
4045 Lisp_Object overlay, prop, value;
4046{
4047 Lisp_Object tail, buffer;
4048 int changed;
4049
4050 CHECK_OVERLAY (overlay);
4051
4052 buffer = Fmarker_buffer (OVERLAY_START (overlay));
4053
4054 for (tail = XOVERLAY (overlay)->plist;
4055 CONSP (tail) && CONSP (XCDR (tail));
4056 tail = XCDR (XCDR (tail)))
4057 if (EQ (XCAR (tail), prop))
4058 {
4059 changed = !EQ (XCAR (XCDR (tail)), value);
4060 XSETCAR (XCDR (tail), value);
4061 goto found;
4062 }
4063 /* It wasn't in the list, so add it to the front. */
4064 changed = !NILP (value);
4065 XOVERLAY (overlay)->plist
4066 = Fcons (prop, Fcons (value, XOVERLAY (overlay)->plist));
4067 found:
4068 if (! NILP (buffer))
4069 {
4070 if (changed)
4071 modify_overlay (XBUFFER (buffer),
4072 marker_position (OVERLAY_START (overlay)),
4073 marker_position (OVERLAY_END (overlay)));
4074 if (EQ (prop, Qevaporate) && ! NILP (value)
4075 && (OVERLAY_POSITION (OVERLAY_START (overlay))
4076 == OVERLAY_POSITION (OVERLAY_END (overlay))))
4077 Fdelete_overlay (overlay);
4078 }
4079 return value;
4080}
4081\f
4082/* Subroutine of report_overlay_modification. */
4083
4084/* Lisp vector holding overlay hook functions to call.
4085 Vector elements come in pairs.
4086 Each even-index element is a list of hook functions.
4087 The following odd-index element is the overlay they came from.
4088
4089 Before the buffer change, we fill in this vector
4090 as we call overlay hook functions.
4091 After the buffer change, we get the functions to call from this vector.
4092 This way we always call the same functions before and after the change. */
4093static Lisp_Object last_overlay_modification_hooks;
4094
4095/* Number of elements actually used in last_overlay_modification_hooks. */
4096static int last_overlay_modification_hooks_used;
4097
4098/* Add one functionlist/overlay pair
4099 to the end of last_overlay_modification_hooks. */
4100
4101static void
4102add_overlay_mod_hooklist (functionlist, overlay)
4103 Lisp_Object functionlist, overlay;
4104{
4105 int oldsize = XVECTOR (last_overlay_modification_hooks)->size;
4106
4107 if (last_overlay_modification_hooks_used == oldsize)
4108 {
4109 Lisp_Object old;
4110 old = last_overlay_modification_hooks;
4111 last_overlay_modification_hooks
4112 = Fmake_vector (make_number (oldsize * 2), Qnil);
4113 bcopy (XVECTOR (old)->contents,
4114 XVECTOR (last_overlay_modification_hooks)->contents,
4115 sizeof (Lisp_Object) * oldsize);
4116 }
4117 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = functionlist;
4118 AREF (last_overlay_modification_hooks, last_overlay_modification_hooks_used++) = overlay;
4119}
4120\f
4121/* Run the modification-hooks of overlays that include
4122 any part of the text in START to END.
4123 If this change is an insertion, also
4124 run the insert-before-hooks of overlay starting at END,
4125 and the insert-after-hooks of overlay ending at START.
4126
4127 This is called both before and after the modification.
4128 AFTER is nonzero when we call after the modification.
4129
4130 ARG1, ARG2, ARG3 are arguments to pass to the hook functions.
4131 When AFTER is nonzero, they are the start position,
4132 the position after the inserted new text,
4133 and the length of deleted or replaced old text. */
4134
4135void
4136report_overlay_modification (start, end, after, arg1, arg2, arg3)
4137 Lisp_Object start, end;
4138 int after;
4139 Lisp_Object arg1, arg2, arg3;
4140{
4141 Lisp_Object prop, overlay;
4142 struct Lisp_Overlay *tail;
4143 /* 1 if this change is an insertion. */
4144 int insertion = (after ? XFASTINT (arg3) == 0 : EQ (start, end));
4145 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4146
4147 overlay = Qnil;
4148 tail = NULL;
4149
4150 /* We used to run the functions as soon as we found them and only register
4151 them in last_overlay_modification_hooks for the purpose of the `after'
4152 case. But running elisp code as we traverse the list of overlays is
4153 painful because the list can be modified by the elisp code so we had to
4154 copy at several places. We now simply do a read-only traversal that
4155 only collects the functions to run and we run them afterwards. It's
4156 simpler, especially since all the code was already there. -stef */
4157
4158 if (!after)
4159 {
4160 /* We are being called before a change.
4161 Scan the overlays to find the functions to call. */
4162 last_overlay_modification_hooks_used = 0;
4163 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4164 {
4165 int startpos, endpos;
4166 Lisp_Object ostart, oend;
4167
4168 XSETMISC (overlay, tail);
4169
4170 ostart = OVERLAY_START (overlay);
4171 oend = OVERLAY_END (overlay);
4172 endpos = OVERLAY_POSITION (oend);
4173 if (XFASTINT (start) > endpos)
4174 break;
4175 startpos = OVERLAY_POSITION (ostart);
4176 if (insertion && (XFASTINT (start) == startpos
4177 || XFASTINT (end) == startpos))
4178 {
4179 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4180 if (!NILP (prop))
4181 add_overlay_mod_hooklist (prop, overlay);
4182 }
4183 if (insertion && (XFASTINT (start) == endpos
4184 || XFASTINT (end) == endpos))
4185 {
4186 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4187 if (!NILP (prop))
4188 add_overlay_mod_hooklist (prop, overlay);
4189 }
4190 /* Test for intersecting intervals. This does the right thing
4191 for both insertion and deletion. */
4192 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4193 {
4194 prop = Foverlay_get (overlay, Qmodification_hooks);
4195 if (!NILP (prop))
4196 add_overlay_mod_hooklist (prop, overlay);
4197 }
4198 }
4199
4200 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4201 {
4202 int startpos, endpos;
4203 Lisp_Object ostart, oend;
4204
4205 XSETMISC (overlay, tail);
4206
4207 ostart = OVERLAY_START (overlay);
4208 oend = OVERLAY_END (overlay);
4209 startpos = OVERLAY_POSITION (ostart);
4210 endpos = OVERLAY_POSITION (oend);
4211 if (XFASTINT (end) < startpos)
4212 break;
4213 if (insertion && (XFASTINT (start) == startpos
4214 || XFASTINT (end) == startpos))
4215 {
4216 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
4217 if (!NILP (prop))
4218 add_overlay_mod_hooklist (prop, overlay);
4219 }
4220 if (insertion && (XFASTINT (start) == endpos
4221 || XFASTINT (end) == endpos))
4222 {
4223 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
4224 if (!NILP (prop))
4225 add_overlay_mod_hooklist (prop, overlay);
4226 }
4227 /* Test for intersecting intervals. This does the right thing
4228 for both insertion and deletion. */
4229 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
4230 {
4231 prop = Foverlay_get (overlay, Qmodification_hooks);
4232 if (!NILP (prop))
4233 add_overlay_mod_hooklist (prop, overlay);
4234 }
4235 }
4236 }
4237
4238 GCPRO4 (overlay, arg1, arg2, arg3);
4239 {
4240 /* Call the functions recorded in last_overlay_modification_hooks.
4241 First copy the vector contents, in case some of these hooks
4242 do subsequent modification of the buffer. */
4243 int size = last_overlay_modification_hooks_used;
4244 Lisp_Object *copy = (Lisp_Object *) alloca (size * sizeof (Lisp_Object));
4245 int i;
4246
4247 bcopy (XVECTOR (last_overlay_modification_hooks)->contents,
4248 copy, size * sizeof (Lisp_Object));
4249 gcpro1.var = copy;
4250 gcpro1.nvars = size;
4251
4252 for (i = 0; i < size;)
4253 {
4254 Lisp_Object prop, overlay;
4255 prop = copy[i++];
4256 overlay = copy[i++];
4257 call_overlay_mod_hooks (prop, overlay, after, arg1, arg2, arg3);
4258 }
4259 }
4260 UNGCPRO;
4261}
4262
4263static void
4264call_overlay_mod_hooks (list, overlay, after, arg1, arg2, arg3)
4265 Lisp_Object list, overlay;
4266 int after;
4267 Lisp_Object arg1, arg2, arg3;
4268{
4269 struct gcpro gcpro1, gcpro2, gcpro3, gcpro4;
4270
4271 GCPRO4 (list, arg1, arg2, arg3);
4272
4273 while (CONSP (list))
4274 {
4275 if (NILP (arg3))
4276 call4 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2);
4277 else
4278 call5 (XCAR (list), overlay, after ? Qt : Qnil, arg1, arg2, arg3);
4279 list = XCDR (list);
4280 }
4281 UNGCPRO;
4282}
4283
4284/* Delete any zero-sized overlays at position POS, if the `evaporate'
4285 property is set. */
4286void
4287evaporate_overlays (pos)
4288 EMACS_INT pos;
4289{
4290 Lisp_Object overlay, hit_list;
4291 struct Lisp_Overlay *tail;
4292
4293 hit_list = Qnil;
4294 if (pos <= current_buffer->overlay_center)
4295 for (tail = current_buffer->overlays_before; tail; tail = tail->next)
4296 {
4297 int endpos;
4298 XSETMISC (overlay, tail);
4299 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
4300 if (endpos < pos)
4301 break;
4302 if (endpos == pos && OVERLAY_POSITION (OVERLAY_START (overlay)) == pos
4303 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4304 hit_list = Fcons (overlay, hit_list);
4305 }
4306 else
4307 for (tail = current_buffer->overlays_after; tail; tail = tail->next)
4308 {
4309 int startpos;
4310 XSETMISC (overlay, tail);
4311 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
4312 if (startpos > pos)
4313 break;
4314 if (startpos == pos && OVERLAY_POSITION (OVERLAY_END (overlay)) == pos
4315 && ! NILP (Foverlay_get (overlay, Qevaporate)))
4316 hit_list = Fcons (overlay, hit_list);
4317 }
4318 for (; CONSP (hit_list); hit_list = XCDR (hit_list))
4319 Fdelete_overlay (XCAR (hit_list));
4320}
4321\f
4322/* Somebody has tried to store a value with an unacceptable type
4323 in the slot with offset OFFSET. */
4324
4325void
4326buffer_slot_type_mismatch (offset)
4327 int offset;
4328{
4329 Lisp_Object sym;
4330 char *type_name;
4331
4332 switch (XINT (PER_BUFFER_TYPE (offset)))
4333 {
4334 case Lisp_Int:
4335 type_name = "integers";
4336 break;
4337
4338 case Lisp_String:
4339 type_name = "strings";
4340 break;
4341
4342 case Lisp_Symbol:
4343 type_name = "symbols";
4344 break;
4345
4346 default:
4347 abort ();
4348 }
4349
4350 sym = PER_BUFFER_SYMBOL (offset);
4351 error ("Only %s should be stored in the buffer-local variable %s",
4352 type_name, SDATA (SYMBOL_NAME (sym)));
4353}
4354
4355\f
4356/***********************************************************************
4357 Allocation with mmap
4358 ***********************************************************************/
4359
4360#ifdef USE_MMAP_FOR_BUFFERS
4361
4362#include <sys/types.h>
4363#include <sys/mman.h>
4364
4365#ifndef MAP_ANON
4366#ifdef MAP_ANONYMOUS
4367#define MAP_ANON MAP_ANONYMOUS
4368#else
4369#define MAP_ANON 0
4370#endif
4371#endif
4372
4373#ifndef MAP_FAILED
4374#define MAP_FAILED ((void *) -1)
4375#endif
4376
4377#include <stdio.h>
4378#include <errno.h>
4379
4380#if MAP_ANON == 0
4381#include <fcntl.h>
4382#endif
4383
4384#include "coding.h"
4385
4386
4387/* Memory is allocated in regions which are mapped using mmap(2).
4388 The current implementation lets the system select mapped
4389 addresses; we're not using MAP_FIXED in general, except when
4390 trying to enlarge regions.
4391
4392 Each mapped region starts with a mmap_region structure, the user
4393 area starts after that structure, aligned to MEM_ALIGN.
4394
4395 +-----------------------+
4396 | struct mmap_info + |
4397 | padding |
4398 +-----------------------+
4399 | user data |
4400 | |
4401 | |
4402 +-----------------------+ */
4403
4404struct mmap_region
4405{
4406 /* User-specified size. */
4407 size_t nbytes_specified;
4408
4409 /* Number of bytes mapped */
4410 size_t nbytes_mapped;
4411
4412 /* Pointer to the location holding the address of the memory
4413 allocated with the mmap'd block. The variable actually points
4414 after this structure. */
4415 POINTER_TYPE **var;
4416
4417 /* Next and previous in list of all mmap'd regions. */
4418 struct mmap_region *next, *prev;
4419};
4420
4421/* Doubly-linked list of mmap'd regions. */
4422
4423static struct mmap_region *mmap_regions;
4424
4425/* File descriptor for mmap. If we don't have anonymous mapping,
4426 /dev/zero will be opened on it. */
4427
4428static int mmap_fd;
4429
4430/* Temporary storage for mmap_set_vars, see there. */
4431
4432static struct mmap_region *mmap_regions_1;
4433static int mmap_fd_1;
4434
4435/* Page size on this system. */
4436
4437static int mmap_page_size;
4438
4439/* 1 means mmap has been intialized. */
4440
4441static int mmap_initialized_p;
4442
4443/* Value is X rounded up to the next multiple of N. */
4444
4445#define ROUND(X, N) (((X) + (N) - 1) / (N) * (N))
4446
4447/* Size of mmap_region structure plus padding. */
4448
4449#define MMAP_REGION_STRUCT_SIZE \
4450 ROUND (sizeof (struct mmap_region), MEM_ALIGN)
4451
4452/* Given a pointer P to the start of the user-visible part of a mapped
4453 region, return a pointer to the start of the region. */
4454
4455#define MMAP_REGION(P) \
4456 ((struct mmap_region *) ((char *) (P) - MMAP_REGION_STRUCT_SIZE))
4457
4458/* Given a pointer P to the start of a mapped region, return a pointer
4459 to the start of the user-visible part of the region. */
4460
4461#define MMAP_USER_AREA(P) \
4462 ((POINTER_TYPE *) ((char *) (P) + MMAP_REGION_STRUCT_SIZE))
4463
4464#define MEM_ALIGN sizeof (double)
4465
4466/* Predicate returning true if part of the address range [START .. END]
4467 is currently mapped. Used to prevent overwriting an existing
4468 memory mapping.
4469
4470 Default is to conservativly assume the address range is occupied by
4471 something else. This can be overridden by system configuration
4472 files if system-specific means to determine this exists. */
4473
4474#ifndef MMAP_ALLOCATED_P
4475#define MMAP_ALLOCATED_P(start, end) 1
4476#endif
4477
4478/* Function prototypes. */
4479
4480static int mmap_free_1 P_ ((struct mmap_region *));
4481static int mmap_enlarge P_ ((struct mmap_region *, int));
4482static struct mmap_region *mmap_find P_ ((POINTER_TYPE *, POINTER_TYPE *));
4483static POINTER_TYPE *mmap_alloc P_ ((POINTER_TYPE **, size_t));
4484static POINTER_TYPE *mmap_realloc P_ ((POINTER_TYPE **, size_t));
4485static void mmap_free P_ ((POINTER_TYPE **ptr));
4486static void mmap_init P_ ((void));
4487
4488
4489/* Return a region overlapping address range START...END, or null if
4490 none. END is not including, i.e. the last byte in the range
4491 is at END - 1. */
4492
4493static struct mmap_region *
4494mmap_find (start, end)
4495 POINTER_TYPE *start, *end;
4496{
4497 struct mmap_region *r;
4498 char *s = (char *) start, *e = (char *) end;
4499
4500 for (r = mmap_regions; r; r = r->next)
4501 {
4502 char *rstart = (char *) r;
4503 char *rend = rstart + r->nbytes_mapped;
4504
4505 if (/* First byte of range, i.e. START, in this region? */
4506 (s >= rstart && s < rend)
4507 /* Last byte of range, i.e. END - 1, in this region? */
4508 || (e > rstart && e <= rend)
4509 /* First byte of this region in the range? */
4510 || (rstart >= s && rstart < e)
4511 /* Last byte of this region in the range? */
4512 || (rend > s && rend <= e))
4513 break;
4514 }
4515
4516 return r;
4517}
4518
4519
4520/* Unmap a region. P is a pointer to the start of the user-araa of
4521 the region. Value is non-zero if successful. */
4522
4523static int
4524mmap_free_1 (r)
4525 struct mmap_region *r;
4526{
4527 if (r->next)
4528 r->next->prev = r->prev;
4529 if (r->prev)
4530 r->prev->next = r->next;
4531 else
4532 mmap_regions = r->next;
4533
4534 if (munmap ((POINTER_TYPE *) r, r->nbytes_mapped) == -1)
4535 {
4536 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4537 return 0;
4538 }
4539
4540 return 1;
4541}
4542
4543
4544/* Enlarge region R by NPAGES pages. NPAGES < 0 means shrink R.
4545 Value is non-zero if successful. */
4546
4547static int
4548mmap_enlarge (r, npages)
4549 struct mmap_region *r;
4550 int npages;
4551{
4552 char *region_end = (char *) r + r->nbytes_mapped;
4553 size_t nbytes;
4554 int success = 0;
4555
4556 if (npages < 0)
4557 {
4558 /* Unmap pages at the end of the region. */
4559 nbytes = - npages * mmap_page_size;
4560 if (munmap (region_end - nbytes, nbytes) == -1)
4561 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4562 else
4563 {
4564 r->nbytes_mapped -= nbytes;
4565 success = 1;
4566 }
4567 }
4568 else if (npages > 0)
4569 {
4570 nbytes = npages * mmap_page_size;
4571
4572 /* Try to map additional pages at the end of the region. We
4573 cannot do this if the address range is already occupied by
4574 something else because mmap deletes any previous mapping.
4575 I'm not sure this is worth doing, let's see. */
4576 if (!MMAP_ALLOCATED_P (region_end, region_end + nbytes))
4577 {
4578 POINTER_TYPE *p;
4579
4580 p = mmap (region_end, nbytes, PROT_READ | PROT_WRITE,
4581 MAP_ANON | MAP_PRIVATE | MAP_FIXED, mmap_fd, 0);
4582 if (p == MAP_FAILED)
4583 ; /* fprintf (stderr, "mmap: %s\n", emacs_strerror (errno)); */
4584 else if (p != (POINTER_TYPE *) region_end)
4585 {
4586 /* Kernels are free to choose a different address. In
4587 that case, unmap what we've mapped above; we have
4588 no use for it. */
4589 if (munmap (p, nbytes) == -1)
4590 fprintf (stderr, "munmap: %s\n", emacs_strerror (errno));
4591 }
4592 else
4593 {
4594 r->nbytes_mapped += nbytes;
4595 success = 1;
4596 }
4597 }
4598 }
4599
4600 return success;
4601}
4602
4603
4604/* Set or reset variables holding references to mapped regions. If
4605 RESTORE_P is zero, set all variables to null. If RESTORE_P is
4606 non-zero, set all variables to the start of the user-areas
4607 of mapped regions.
4608
4609 This function is called from Fdump_emacs to ensure that the dumped
4610 Emacs doesn't contain references to memory that won't be mapped
4611 when Emacs starts. */
4612
4613void
4614mmap_set_vars (restore_p)
4615 int restore_p;
4616{
4617 struct mmap_region *r;
4618
4619 if (restore_p)
4620 {
4621 mmap_regions = mmap_regions_1;
4622 mmap_fd = mmap_fd_1;
4623 for (r = mmap_regions; r; r = r->next)
4624 *r->var = MMAP_USER_AREA (r);
4625 }
4626 else
4627 {
4628 for (r = mmap_regions; r; r = r->next)
4629 *r->var = NULL;
4630 mmap_regions_1 = mmap_regions;
4631 mmap_regions = NULL;
4632 mmap_fd_1 = mmap_fd;
4633 mmap_fd = -1;
4634 }
4635}
4636
4637
4638/* Allocate a block of storage large enough to hold NBYTES bytes of
4639 data. A pointer to the data is returned in *VAR. VAR is thus the
4640 address of some variable which will use the data area.
4641
4642 The allocation of 0 bytes is valid.
4643
4644 If we can't allocate the necessary memory, set *VAR to null, and
4645 return null. */
4646
4647static POINTER_TYPE *
4648mmap_alloc (var, nbytes)
4649 POINTER_TYPE **var;
4650 size_t nbytes;
4651{
4652 void *p;
4653 size_t map;
4654
4655 mmap_init ();
4656
4657 map = ROUND (nbytes + MMAP_REGION_STRUCT_SIZE, mmap_page_size);
4658 p = mmap (NULL, map, PROT_READ | PROT_WRITE, MAP_ANON | MAP_PRIVATE,
4659 mmap_fd, 0);
4660
4661 if (p == MAP_FAILED)
4662 {
4663 if (errno != ENOMEM)
4664 fprintf (stderr, "mmap: %s\n", emacs_strerror (errno));
4665 p = NULL;
4666 }
4667 else
4668 {
4669 struct mmap_region *r = (struct mmap_region *) p;
4670
4671 r->nbytes_specified = nbytes;
4672 r->nbytes_mapped = map;
4673 r->var = var;
4674 r->prev = NULL;
4675 r->next = mmap_regions;
4676 if (r->next)
4677 r->next->prev = r;
4678 mmap_regions = r;
4679
4680 p = MMAP_USER_AREA (p);
4681 }
4682
4683 return *var = p;
4684}
4685
4686
4687/* Given a pointer at address VAR to data allocated with mmap_alloc,
4688 resize it to size NBYTES. Change *VAR to reflect the new block,
4689 and return this value. If more memory cannot be allocated, then
4690 leave *VAR unchanged, and return null. */
4691
4692static POINTER_TYPE *
4693mmap_realloc (var, nbytes)
4694 POINTER_TYPE **var;
4695 size_t nbytes;
4696{
4697 POINTER_TYPE *result;
4698
4699 mmap_init ();
4700
4701 if (*var == NULL)
4702 result = mmap_alloc (var, nbytes);
4703 else if (nbytes == 0)
4704 {
4705 mmap_free (var);
4706 result = mmap_alloc (var, nbytes);
4707 }
4708 else
4709 {
4710 struct mmap_region *r = MMAP_REGION (*var);
4711 size_t room = r->nbytes_mapped - MMAP_REGION_STRUCT_SIZE;
4712
4713 if (room < nbytes)
4714 {
4715 /* Must enlarge. */
4716 POINTER_TYPE *old_ptr = *var;
4717
4718 /* Try to map additional pages at the end of the region.
4719 If that fails, allocate a new region, copy data
4720 from the old region, then free it. */
4721 if (mmap_enlarge (r, (ROUND (nbytes - room, mmap_page_size)
4722 / mmap_page_size)))
4723 {
4724 r->nbytes_specified = nbytes;
4725 *var = result = old_ptr;
4726 }
4727 else if (mmap_alloc (var, nbytes))
4728 {
4729 bcopy (old_ptr, *var, r->nbytes_specified);
4730 mmap_free_1 (MMAP_REGION (old_ptr));
4731 result = *var;
4732 r = MMAP_REGION (result);
4733 r->nbytes_specified = nbytes;
4734 }
4735 else
4736 {
4737 *var = old_ptr;
4738 result = NULL;
4739 }
4740 }
4741 else if (room - nbytes >= mmap_page_size)
4742 {
4743 /* Shrinking by at least a page. Let's give some
4744 memory back to the system.
4745
4746 The extra parens are to make the division happens first,
4747 on positive values, so we know it will round towards
4748 zero. */
4749 mmap_enlarge (r, - ((room - nbytes) / mmap_page_size));
4750 result = *var;
4751 r->nbytes_specified = nbytes;
4752 }
4753 else
4754 {
4755 /* Leave it alone. */
4756 result = *var;
4757 r->nbytes_specified = nbytes;
4758 }
4759 }
4760
4761 return result;
4762}
4763
4764
4765/* Free a block of relocatable storage whose data is pointed to by
4766 PTR. Store 0 in *PTR to show there's no block allocated. */
4767
4768static void
4769mmap_free (var)
4770 POINTER_TYPE **var;
4771{
4772 mmap_init ();
4773
4774 if (*var)
4775 {
4776 mmap_free_1 (MMAP_REGION (*var));
4777 *var = NULL;
4778 }
4779}
4780
4781
4782/* Perform necessary intializations for the use of mmap. */
4783
4784static void
4785mmap_init ()
4786{
4787#if MAP_ANON == 0
4788 /* The value of mmap_fd is initially 0 in temacs, and -1
4789 in a dumped Emacs. */
4790 if (mmap_fd <= 0)
4791 {
4792 /* No anonymous mmap -- we need the file descriptor. */
4793 mmap_fd = open ("/dev/zero", O_RDONLY);
4794 if (mmap_fd == -1)
4795 fatal ("Cannot open /dev/zero: %s", emacs_strerror (errno));
4796 }
4797#endif /* MAP_ANON == 0 */
4798
4799 if (mmap_initialized_p)
4800 return;
4801 mmap_initialized_p = 1;
4802
4803#if MAP_ANON != 0
4804 mmap_fd = -1;
4805#endif
4806
4807 mmap_page_size = getpagesize ();
4808}
4809
4810#endif /* USE_MMAP_FOR_BUFFERS */
4811
4812
4813\f
4814/***********************************************************************
4815 Buffer-text Allocation
4816 ***********************************************************************/
4817
4818#ifdef REL_ALLOC
4819extern POINTER_TYPE *r_alloc P_ ((POINTER_TYPE **, size_t));
4820extern POINTER_TYPE *r_re_alloc P_ ((POINTER_TYPE **, size_t));
4821extern void r_alloc_free P_ ((POINTER_TYPE **ptr));
4822#endif /* REL_ALLOC */
4823
4824
4825/* Allocate NBYTES bytes for buffer B's text buffer. */
4826
4827static void
4828alloc_buffer_text (b, nbytes)
4829 struct buffer *b;
4830 size_t nbytes;
4831{
4832 POINTER_TYPE *p;
4833
4834 BLOCK_INPUT;
4835#if defined USE_MMAP_FOR_BUFFERS
4836 p = mmap_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4837#elif defined REL_ALLOC
4838 p = r_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4839#else
4840 p = xmalloc (nbytes);
4841#endif
4842
4843 if (p == NULL)
4844 {
4845 UNBLOCK_INPUT;
4846 memory_full ();
4847 }
4848
4849 b->text->beg = (unsigned char *) p;
4850 UNBLOCK_INPUT;
4851}
4852
4853/* Enlarge buffer B's text buffer by DELTA bytes. DELTA < 0 means
4854 shrink it. */
4855
4856void
4857enlarge_buffer_text (b, delta)
4858 struct buffer *b;
4859 int delta;
4860{
4861 POINTER_TYPE *p;
4862 size_t nbytes = (BUF_Z_BYTE (b) - BUF_BEG_BYTE (b) + BUF_GAP_SIZE (b) + 1
4863 + delta);
4864 BLOCK_INPUT;
4865#if defined USE_MMAP_FOR_BUFFERS
4866 p = mmap_realloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4867#elif defined REL_ALLOC
4868 p = r_re_alloc ((POINTER_TYPE **) &b->text->beg, nbytes);
4869#else
4870 p = xrealloc (b->text->beg, nbytes);
4871#endif
4872
4873 if (p == NULL)
4874 {
4875 UNBLOCK_INPUT;
4876 memory_full ();
4877 }
4878
4879 BUF_BEG_ADDR (b) = (unsigned char *) p;
4880 UNBLOCK_INPUT;
4881}
4882
4883
4884/* Free buffer B's text buffer. */
4885
4886static void
4887free_buffer_text (b)
4888 struct buffer *b;
4889{
4890 BLOCK_INPUT;
4891
4892#if defined USE_MMAP_FOR_BUFFERS
4893 mmap_free ((POINTER_TYPE **) &b->text->beg);
4894#elif defined REL_ALLOC
4895 r_alloc_free ((POINTER_TYPE **) &b->text->beg);
4896#else
4897 xfree (b->text->beg);
4898#endif
4899
4900 BUF_BEG_ADDR (b) = NULL;
4901 UNBLOCK_INPUT;
4902}
4903
4904
4905\f
4906/***********************************************************************
4907 Initialization
4908 ***********************************************************************/
4909
4910void
4911init_buffer_once ()
4912{
4913 int idx;
4914
4915 bzero (buffer_permanent_local_flags, sizeof buffer_permanent_local_flags);
4916
4917 /* Make sure all markable slots in buffer_defaults
4918 are initialized reasonably, so mark_buffer won't choke. */
4919 reset_buffer (&buffer_defaults);
4920 reset_buffer_local_variables (&buffer_defaults, 1);
4921 reset_buffer (&buffer_local_symbols);
4922 reset_buffer_local_variables (&buffer_local_symbols, 1);
4923 /* Prevent GC from getting confused. */
4924 buffer_defaults.text = &buffer_defaults.own_text;
4925 buffer_local_symbols.text = &buffer_local_symbols.own_text;
4926 BUF_INTERVALS (&buffer_defaults) = 0;
4927 BUF_INTERVALS (&buffer_local_symbols) = 0;
4928 XSETBUFFER (Vbuffer_defaults, &buffer_defaults);
4929 XSETBUFFER (Vbuffer_local_symbols, &buffer_local_symbols);
4930
4931 /* Set up the default values of various buffer slots. */
4932 /* Must do these before making the first buffer! */
4933
4934 /* real setup is done in bindings.el */
4935 buffer_defaults.mode_line_format = build_string ("%-");
4936 buffer_defaults.header_line_format = Qnil;
4937 buffer_defaults.abbrev_mode = Qnil;
4938 buffer_defaults.overwrite_mode = Qnil;
4939 buffer_defaults.case_fold_search = Qt;
4940 buffer_defaults.auto_fill_function = Qnil;
4941 buffer_defaults.selective_display = Qnil;
4942#ifndef old
4943 buffer_defaults.selective_display_ellipses = Qt;
4944#endif
4945 buffer_defaults.abbrev_table = Qnil;
4946 buffer_defaults.display_table = Qnil;
4947 buffer_defaults.undo_list = Qnil;
4948 buffer_defaults.mark_active = Qnil;
4949 buffer_defaults.file_format = Qnil;
4950 buffer_defaults.auto_save_file_format = Qt;
4951 buffer_defaults.overlays_before = NULL;
4952 buffer_defaults.overlays_after = NULL;
4953 buffer_defaults.overlay_center = BEG;
4954
4955 XSETFASTINT (buffer_defaults.tab_width, 8);
4956 buffer_defaults.truncate_lines = Qnil;
4957 buffer_defaults.ctl_arrow = Qt;
4958 buffer_defaults.direction_reversed = Qnil;
4959 buffer_defaults.cursor_type = Qt;
4960 buffer_defaults.extra_line_spacing = Qnil;
4961
4962#ifdef DOS_NT
4963 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
4964#endif
4965 buffer_defaults.enable_multibyte_characters = Qt;
4966 buffer_defaults.buffer_file_coding_system = Qnil;
4967 XSETFASTINT (buffer_defaults.fill_column, 70);
4968 XSETFASTINT (buffer_defaults.left_margin, 0);
4969 buffer_defaults.cache_long_line_scans = Qnil;
4970 buffer_defaults.file_truename = Qnil;
4971 XSETFASTINT (buffer_defaults.display_count, 0);
4972 XSETFASTINT (buffer_defaults.left_margin_cols, 0);
4973 XSETFASTINT (buffer_defaults.right_margin_cols, 0);
4974 buffer_defaults.left_fringe_width = Qnil;
4975 buffer_defaults.right_fringe_width = Qnil;
4976 buffer_defaults.fringes_outside_margins = Qnil;
4977 buffer_defaults.scroll_bar_width = Qnil;
4978 buffer_defaults.vertical_scroll_bar_type = Qt;
4979 buffer_defaults.indicate_empty_lines = Qnil;
4980 buffer_defaults.indicate_buffer_boundaries = Qnil;
4981 buffer_defaults.scroll_up_aggressively = Qnil;
4982 buffer_defaults.scroll_down_aggressively = Qnil;
4983 buffer_defaults.display_time = Qnil;
4984
4985 /* Assign the local-flags to the slots that have default values.
4986 The local flag is a bit that is used in the buffer
4987 to say that it has its own local value for the slot.
4988 The local flag bits are in the local_var_flags slot of the buffer. */
4989
4990 /* Nothing can work if this isn't true */
4991 if (sizeof (EMACS_INT) != sizeof (Lisp_Object)) abort ();
4992
4993 /* 0 means not a lisp var, -1 means always local, else mask */
4994 bzero (&buffer_local_flags, sizeof buffer_local_flags);
4995 XSETINT (buffer_local_flags.filename, -1);
4996 XSETINT (buffer_local_flags.directory, -1);
4997 XSETINT (buffer_local_flags.backed_up, -1);
4998 XSETINT (buffer_local_flags.save_length, -1);
4999 XSETINT (buffer_local_flags.auto_save_file_name, -1);
5000 XSETINT (buffer_local_flags.read_only, -1);
5001 XSETINT (buffer_local_flags.major_mode, -1);
5002 XSETINT (buffer_local_flags.mode_name, -1);
5003 XSETINT (buffer_local_flags.undo_list, -1);
5004 XSETINT (buffer_local_flags.mark_active, -1);
5005 XSETINT (buffer_local_flags.point_before_scroll, -1);
5006 XSETINT (buffer_local_flags.file_truename, -1);
5007 XSETINT (buffer_local_flags.invisibility_spec, -1);
5008 XSETINT (buffer_local_flags.file_format, -1);
5009 XSETINT (buffer_local_flags.auto_save_file_format, -1);
5010 XSETINT (buffer_local_flags.display_count, -1);
5011 XSETINT (buffer_local_flags.display_time, -1);
5012 XSETINT (buffer_local_flags.enable_multibyte_characters, -1);
5013
5014 idx = 1;
5015 XSETFASTINT (buffer_local_flags.mode_line_format, idx); ++idx;
5016 XSETFASTINT (buffer_local_flags.abbrev_mode, idx); ++idx;
5017 XSETFASTINT (buffer_local_flags.overwrite_mode, idx); ++idx;
5018 XSETFASTINT (buffer_local_flags.case_fold_search, idx); ++idx;
5019 XSETFASTINT (buffer_local_flags.auto_fill_function, idx); ++idx;
5020 XSETFASTINT (buffer_local_flags.selective_display, idx); ++idx;
5021#ifndef old
5022 XSETFASTINT (buffer_local_flags.selective_display_ellipses, idx); ++idx;
5023#endif
5024 XSETFASTINT (buffer_local_flags.tab_width, idx); ++idx;
5025 XSETFASTINT (buffer_local_flags.truncate_lines, idx); ++idx;
5026 XSETFASTINT (buffer_local_flags.ctl_arrow, idx); ++idx;
5027 XSETFASTINT (buffer_local_flags.fill_column, idx); ++idx;
5028 XSETFASTINT (buffer_local_flags.left_margin, idx); ++idx;
5029 XSETFASTINT (buffer_local_flags.abbrev_table, idx); ++idx;
5030 XSETFASTINT (buffer_local_flags.display_table, idx); ++idx;
5031#ifdef DOS_NT
5032 XSETFASTINT (buffer_local_flags.buffer_file_type, idx);
5033 /* Make this one a permanent local. */
5034 buffer_permanent_local_flags[idx++] = 1;
5035#endif
5036 XSETFASTINT (buffer_local_flags.syntax_table, idx); ++idx;
5037 XSETFASTINT (buffer_local_flags.cache_long_line_scans, idx); ++idx;
5038 XSETFASTINT (buffer_local_flags.category_table, idx); ++idx;
5039 XSETFASTINT (buffer_local_flags.direction_reversed, idx); ++idx;
5040 XSETFASTINT (buffer_local_flags.buffer_file_coding_system, idx);
5041 /* Make this one a permanent local. */
5042 buffer_permanent_local_flags[idx++] = 1;
5043 XSETFASTINT (buffer_local_flags.left_margin_cols, idx); ++idx;
5044 XSETFASTINT (buffer_local_flags.right_margin_cols, idx); ++idx;
5045 XSETFASTINT (buffer_local_flags.left_fringe_width, idx); ++idx;
5046 XSETFASTINT (buffer_local_flags.right_fringe_width, idx); ++idx;
5047 XSETFASTINT (buffer_local_flags.fringes_outside_margins, idx); ++idx;
5048 XSETFASTINT (buffer_local_flags.scroll_bar_width, idx); ++idx;
5049 XSETFASTINT (buffer_local_flags.vertical_scroll_bar_type, idx); ++idx;
5050 XSETFASTINT (buffer_local_flags.indicate_empty_lines, idx); ++idx;
5051 XSETFASTINT (buffer_local_flags.indicate_buffer_boundaries, idx); ++idx;
5052 XSETFASTINT (buffer_local_flags.scroll_up_aggressively, idx); ++idx;
5053 XSETFASTINT (buffer_local_flags.scroll_down_aggressively, idx); ++idx;
5054 XSETFASTINT (buffer_local_flags.header_line_format, idx); ++idx;
5055 XSETFASTINT (buffer_local_flags.cursor_type, idx); ++idx;
5056 XSETFASTINT (buffer_local_flags.extra_line_spacing, idx); ++idx;
5057
5058 /* Need more room? */
5059 if (idx >= MAX_PER_BUFFER_VARS)
5060 abort ();
5061 last_per_buffer_idx = idx;
5062
5063 Vbuffer_alist = Qnil;
5064 current_buffer = 0;
5065 all_buffers = 0;
5066
5067 QSFundamental = build_string ("Fundamental");
5068
5069 Qfundamental_mode = intern ("fundamental-mode");
5070 buffer_defaults.major_mode = Qfundamental_mode;
5071
5072 Qmode_class = intern ("mode-class");
5073
5074 Qprotected_field = intern ("protected-field");
5075
5076 Qpermanent_local = intern ("permanent-local");
5077
5078 Qkill_buffer_hook = intern ("kill-buffer-hook");
5079 Fput (Qkill_buffer_hook, Qpermanent_local, Qt);
5080
5081 Qucs_set_table_for_input = intern ("ucs-set-table-for-input");
5082
5083 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
5084
5085 /* super-magic invisible buffer */
5086 Vbuffer_alist = Qnil;
5087
5088 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5089
5090 inhibit_modification_hooks = 0;
5091}
5092
5093void
5094init_buffer ()
5095{
5096 char buf[MAXPATHLEN + 1];
5097 char *pwd;
5098 struct stat dotstat, pwdstat;
5099 Lisp_Object temp;
5100 int rc;
5101
5102#ifdef USE_MMAP_FOR_BUFFERS
5103 {
5104 /* When using the ralloc implementation based on mmap(2), buffer
5105 text pointers will have been set to null in the dumped Emacs.
5106 Map new memory. */
5107 struct buffer *b;
5108
5109 for (b = all_buffers; b; b = b->next)
5110 if (b->text->beg == NULL)
5111 enlarge_buffer_text (b, 0);
5112 }
5113#endif /* USE_MMAP_FOR_BUFFERS */
5114
5115 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
5116 if (NILP (buffer_defaults.enable_multibyte_characters))
5117 Fset_buffer_multibyte (Qnil);
5118
5119 /* If PWD is accurate, use it instead of calling getwd. PWD is
5120 sometimes a nicer name, and using it may avoid a fatal error if a
5121 parent directory is searchable but not readable. */
5122 if ((pwd = getenv ("PWD")) != 0
5123 && (IS_DIRECTORY_SEP (*pwd) || (*pwd && IS_DEVICE_SEP (pwd[1])))
5124 && stat (pwd, &pwdstat) == 0
5125 && stat (".", &dotstat) == 0
5126 && dotstat.st_ino == pwdstat.st_ino
5127 && dotstat.st_dev == pwdstat.st_dev
5128 && strlen (pwd) < MAXPATHLEN)
5129 strcpy (buf, pwd);
5130#ifdef HAVE_GETCWD
5131 else if (getcwd (buf, MAXPATHLEN+1) == 0)
5132 fatal ("`getcwd' failed: %s\n", strerror (errno));
5133#else
5134 else if (getwd (buf) == 0)
5135 fatal ("`getwd' failed: %s\n", buf);
5136#endif
5137
5138#ifndef VMS
5139 /* Maybe this should really use some standard subroutine
5140 whose definition is filename syntax dependent. */
5141 rc = strlen (buf);
5142 if (!(IS_DIRECTORY_SEP (buf[rc - 1])))
5143 {
5144 buf[rc] = DIRECTORY_SEP;
5145 buf[rc + 1] = '\0';
5146 }
5147#endif /* not VMS */
5148
5149 current_buffer->directory = make_unibyte_string (buf, strlen (buf));
5150 if (! NILP (buffer_defaults.enable_multibyte_characters))
5151 /* At this momemnt, we still don't know how to decode the
5152 direcotry name. So, we keep the bytes in multibyte form so
5153 that ENCODE_FILE correctly gets the original bytes. */
5154 current_buffer->directory
5155 = string_to_multibyte (current_buffer->directory);
5156
5157 /* Add /: to the front of the name
5158 if it would otherwise be treated as magic. */
5159 temp = Ffind_file_name_handler (current_buffer->directory, Qt);
5160 if (! NILP (temp)
5161 /* If the default dir is just /, TEMP is non-nil
5162 because of the ange-ftp completion handler.
5163 However, it is not necessary to turn / into /:/.
5164 So avoid doing that. */
5165 && strcmp ("/", SDATA (current_buffer->directory)))
5166 current_buffer->directory
5167 = concat2 (build_string ("/:"), current_buffer->directory);
5168
5169 temp = get_minibuffer (0);
5170 XBUFFER (temp)->directory = current_buffer->directory;
5171}
5172
5173/* initialize the buffer routines */
5174void
5175syms_of_buffer ()
5176{
5177 staticpro (&last_overlay_modification_hooks);
5178 last_overlay_modification_hooks
5179 = Fmake_vector (make_number (10), Qnil);
5180
5181 staticpro (&Vbuffer_defaults);
5182 staticpro (&Vbuffer_local_symbols);
5183 staticpro (&Qfundamental_mode);
5184 staticpro (&Qmode_class);
5185 staticpro (&QSFundamental);
5186 staticpro (&Vbuffer_alist);
5187 staticpro (&Qprotected_field);
5188 staticpro (&Qpermanent_local);
5189 staticpro (&Qkill_buffer_hook);
5190 Qoverlayp = intern ("overlayp");
5191 staticpro (&Qoverlayp);
5192 Qevaporate = intern ("evaporate");
5193 staticpro (&Qevaporate);
5194 Qmodification_hooks = intern ("modification-hooks");
5195 staticpro (&Qmodification_hooks);
5196 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
5197 staticpro (&Qinsert_in_front_hooks);
5198 Qinsert_behind_hooks = intern ("insert-behind-hooks");
5199 staticpro (&Qinsert_behind_hooks);
5200 Qget_file_buffer = intern ("get-file-buffer");
5201 staticpro (&Qget_file_buffer);
5202 Qpriority = intern ("priority");
5203 staticpro (&Qpriority);
5204 Qwindow = intern ("window");
5205 staticpro (&Qwindow);
5206 Qbefore_string = intern ("before-string");
5207 staticpro (&Qbefore_string);
5208 Qafter_string = intern ("after-string");
5209 staticpro (&Qafter_string);
5210 Qfirst_change_hook = intern ("first-change-hook");
5211 staticpro (&Qfirst_change_hook);
5212 Qbefore_change_functions = intern ("before-change-functions");
5213 staticpro (&Qbefore_change_functions);
5214 Qafter_change_functions = intern ("after-change-functions");
5215 staticpro (&Qafter_change_functions);
5216 staticpro (&Qucs_set_table_for_input);
5217
5218 Qkill_buffer_query_functions = intern ("kill-buffer-query-functions");
5219 staticpro (&Qkill_buffer_query_functions);
5220
5221 Fput (Qprotected_field, Qerror_conditions,
5222 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
5223 Fput (Qprotected_field, Qerror_message,
5224 build_string ("Attempt to modify a protected field"));
5225
5226 /* All these use DEFVAR_LISP_NOPRO because the slots in
5227 buffer_defaults will all be marked via Vbuffer_defaults. */
5228
5229 DEFVAR_LISP_NOPRO ("default-mode-line-format",
5230 &buffer_defaults.mode_line_format,
5231 doc: /* Default value of `mode-line-format' for buffers that don't override it.
5232This is the same as (default-value 'mode-line-format). */);
5233
5234 DEFVAR_LISP_NOPRO ("default-header-line-format",
5235 &buffer_defaults.header_line_format,
5236 doc: /* Default value of `header-line-format' for buffers that don't override it.
5237This is the same as (default-value 'header-line-format). */);
5238
5239 DEFVAR_LISP_NOPRO ("default-cursor-type", &buffer_defaults.cursor_type,
5240 doc: /* Default value of `cursor-type' for buffers that don't override it.
5241This is the same as (default-value 'cursor-type). */);
5242
5243 DEFVAR_LISP_NOPRO ("default-line-spacing",
5244 &buffer_defaults.extra_line_spacing,
5245 doc: /* Default value of `line-spacing' for buffers that don't override it.
5246This is the same as (default-value 'line-spacing). */);
5247
5248 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
5249 &buffer_defaults.abbrev_mode,
5250 doc: /* Default value of `abbrev-mode' for buffers that do not override it.
5251This is the same as (default-value 'abbrev-mode). */);
5252
5253 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
5254 &buffer_defaults.ctl_arrow,
5255 doc: /* Default value of `ctl-arrow' for buffers that do not override it.
5256This is the same as (default-value 'ctl-arrow). */);
5257
5258 DEFVAR_LISP_NOPRO ("default-direction-reversed",
5259 &buffer_defaults.direction_reversed,
5260 doc: /* Default value of `direction-reversed' for buffers that do not override it.
5261This is the same as (default-value 'direction-reversed). */);
5262
5263 DEFVAR_LISP_NOPRO ("default-enable-multibyte-characters",
5264 &buffer_defaults.enable_multibyte_characters,
5265 doc: /* *Default value of `enable-multibyte-characters' for buffers not overriding it.
5266This is the same as (default-value 'enable-multibyte-characters). */);
5267
5268 DEFVAR_LISP_NOPRO ("default-buffer-file-coding-system",
5269 &buffer_defaults.buffer_file_coding_system,
5270 doc: /* Default value of `buffer-file-coding-system' for buffers not overriding it.
5271This is the same as (default-value 'buffer-file-coding-system). */);
5272
5273 DEFVAR_LISP_NOPRO ("default-truncate-lines",
5274 &buffer_defaults.truncate_lines,
5275 doc: /* Default value of `truncate-lines' for buffers that do not override it.
5276This is the same as (default-value 'truncate-lines). */);
5277
5278 DEFVAR_LISP_NOPRO ("default-fill-column",
5279 &buffer_defaults.fill_column,
5280 doc: /* Default value of `fill-column' for buffers that do not override it.
5281This is the same as (default-value 'fill-column). */);
5282
5283 DEFVAR_LISP_NOPRO ("default-left-margin",
5284 &buffer_defaults.left_margin,
5285 doc: /* Default value of `left-margin' for buffers that do not override it.
5286This is the same as (default-value 'left-margin). */);
5287
5288 DEFVAR_LISP_NOPRO ("default-tab-width",
5289 &buffer_defaults.tab_width,
5290 doc: /* Default value of `tab-width' for buffers that do not override it.
5291This is the same as (default-value 'tab-width). */);
5292
5293 DEFVAR_LISP_NOPRO ("default-case-fold-search",
5294 &buffer_defaults.case_fold_search,
5295 doc: /* Default value of `case-fold-search' for buffers that don't override it.
5296This is the same as (default-value 'case-fold-search). */);
5297
5298#ifdef DOS_NT
5299 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
5300 &buffer_defaults.buffer_file_type,
5301 doc: /* Default file type for buffers that do not override it.
5302This is the same as (default-value 'buffer-file-type).
5303The file type is nil for text, t for binary. */);
5304#endif
5305
5306 DEFVAR_LISP_NOPRO ("default-left-margin-width",
5307 &buffer_defaults.left_margin_cols,
5308 doc: /* Default value of `left-margin-width' for buffers that don't override it.
5309This is the same as (default-value 'left-margin-width). */);
5310
5311 DEFVAR_LISP_NOPRO ("default-right-margin-width",
5312 &buffer_defaults.right_margin_cols,
5313 doc: /* Default value of `right-margin-width' for buffers that don't override it.
5314This is the same as (default-value 'right-margin-width). */);
5315
5316 DEFVAR_LISP_NOPRO ("default-left-fringe-width",
5317 &buffer_defaults.left_fringe_width,
5318 doc: /* Default value of `left-fringe-width' for buffers that don't override it.
5319This is the same as (default-value 'left-fringe-width). */);
5320
5321 DEFVAR_LISP_NOPRO ("default-right-fringe-width",
5322 &buffer_defaults.right_fringe_width,
5323 doc: /* Default value of `right-fringe-width' for buffers that don't override it.
5324This is the same as (default-value 'right-fringe-width). */);
5325
5326 DEFVAR_LISP_NOPRO ("default-fringes-outside-margins",
5327 &buffer_defaults.fringes_outside_margins,
5328 doc: /* Default value of `fringes-outside-margins' for buffers that don't override it.
5329This is the same as (default-value 'fringes-outside-margins). */);
5330
5331 DEFVAR_LISP_NOPRO ("default-scroll-bar-width",
5332 &buffer_defaults.scroll_bar_width,
5333 doc: /* Default value of `scroll-bar-width' for buffers that don't override it.
5334This is the same as (default-value 'scroll-bar-width). */);
5335
5336 DEFVAR_LISP_NOPRO ("default-vertical-scroll-bar",
5337 &buffer_defaults.vertical_scroll_bar_type,
5338 doc: /* Default value of `vertical-scroll-bar' for buffers that don't override it.
5339This is the same as (default-value 'vertical-scroll-bar). */);
5340
5341 DEFVAR_LISP_NOPRO ("default-indicate-empty-lines",
5342 &buffer_defaults.indicate_empty_lines,
5343 doc: /* Default value of `indicate-empty-lines' for buffers that don't override it.
5344This is the same as (default-value 'indicate-empty-lines). */);
5345
5346 DEFVAR_LISP_NOPRO ("default-indicate-buffer-boundaries",
5347 &buffer_defaults.indicate_buffer_boundaries,
5348 doc: /* Default value of `indicate-buffer-boundaries' for buffers that don't override it.
5349This is the same as (default-value 'indicate-buffer-boundaries). */);
5350
5351 DEFVAR_LISP_NOPRO ("default-scroll-up-aggressively",
5352 &buffer_defaults.scroll_up_aggressively,
5353 doc: /* Default value of `scroll-up-aggressively'.
5354This value applies in buffers that don't have their own local values.
5355This variable is an alias for (default-value 'scroll-up-aggressively). */);
5356
5357 DEFVAR_LISP_NOPRO ("default-scroll-down-aggressively",
5358 &buffer_defaults.scroll_down_aggressively,
5359 doc: /* Default value of `scroll-down-aggressively'.
5360This value applies in buffers that don't have their own local values.
5361This variable is an alias for (default-value 'scroll-down-aggressively). */);
5362
5363 DEFVAR_PER_BUFFER ("header-line-format",
5364 &current_buffer->header_line_format,
5365 Qnil,
5366 doc: /* Analogous to `mode-line-format', but controls the header line.
5367The header line appears, optionally, at the top of a window;
5368the mode line appears at the bottom. */);
5369
5370 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
5371 Qnil,
5372 doc: /* Template for displaying mode line for current buffer.
5373Each buffer has its own value of this variable.
5374Value may be nil, a string, a symbol or a list or cons cell.
5375A value of nil means don't display a mode line.
5376For a symbol, its value is used (but it is ignored if t or nil).
5377 A string appearing directly as the value of a symbol is processed verbatim
5378 in that the %-constructs below are not recognized.
5379 Note that unless the symbol is marked as a `risky-local-variable', all
5380 properties in any strings, as well as all :eval and :propertize forms
5381 in the value of that symbol will be ignored.
5382For a list of the form `(:eval FORM)', FORM is evaluated and the result
5383 is used as a mode line element. Be careful--FORM should not load any files,
5384 because that can cause an infinite recursion.
5385For a list of the form `(:propertize ELT PROPS...)', ELT is displayed
5386 with the specified properties PROPS applied.
5387For a list whose car is a symbol, the symbol's value is taken,
5388 and if that is non-nil, the cadr of the list is processed recursively.
5389 Otherwise, the caddr of the list (if there is one) is processed.
5390For a list whose car is a string or list, each element is processed
5391 recursively and the results are effectively concatenated.
5392For a list whose car is an integer, the cdr of the list is processed
5393 and padded (if the number is positive) or truncated (if negative)
5394 to the width specified by that number.
5395A string is printed verbatim in the mode line except for %-constructs:
5396 (%-constructs are allowed when the string is the entire mode-line-format
5397 or when it is found in a cons-cell or a list)
5398 %b -- print buffer name. %f -- print visited file name.
5399 %F -- print frame name.
5400 %* -- print %, * or hyphen. %+ -- print *, % or hyphen.
5401 %& is like %*, but ignore read-only-ness.
5402 % means buffer is read-only and * means it is modified.
5403 For a modified read-only buffer, %* gives % and %+ gives *.
5404 %s -- print process status. %l -- print the current line number.
5405 %c -- print the current column number (this makes editing slower).
5406 To make the column number update correctly in all cases,
5407 `column-number-mode' must be non-nil.
5408 %i -- print the size of the buffer.
5409 %I -- like %i, but use k, M, G, etc., to abbreviate.
5410 %p -- print percent of buffer above top of window, or Top, Bot or All.
5411 %P -- print percent of buffer above bottom of window, perhaps plus Top,
5412 or print Bottom or All.
5413 %m -- print the mode name.
5414 %n -- print Narrow if appropriate.
5415 %z -- print mnemonics of buffer, terminal, and keyboard coding systems.
5416 %Z -- like %z, but including the end-of-line format.
5417 %[ -- print one [ for each recursive editing level. %] similar.
5418 %% -- print %. %- -- print infinitely many dashes.
5419Decimal digits after the % specify field width to which to pad. */);
5420
5421 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
5422 doc: /* *Major mode for new buffers. Defaults to `fundamental-mode'.
5423nil here means use current buffer's major mode, provided it is not
5424marked as "special".
5425
5426When a mode is used by default, `find-file' switches to it
5427before it reads the contents into the buffer and before
5428it finishes setting up the buffer. Thus, the mode and
5429its hooks should not expect certain variables such as
5430`buffer-read-only' and `buffer-file-coding-system' to be set up. */);
5431
5432 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
5433 make_number (Lisp_Symbol),
5434 doc: /* Symbol for current buffer's major mode. */);
5435
5436 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
5437 Qnil,
5438 doc: /* Pretty name of current buffer's major mode (a string). */);
5439
5440 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
5441 doc: /* Non-nil turns on automatic expansion of abbrevs as they are inserted. */);
5442
5443 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
5444 Qnil,
5445 doc: /* *Non-nil if searches and matches should ignore case. */);
5446
5447 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
5448 make_number (Lisp_Int),
5449 doc: /* *Column beyond which automatic line-wrapping should happen.
5450Interactively, you can set the buffer local value using \\[set-fill-column]. */);
5451
5452 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
5453 make_number (Lisp_Int),
5454 doc: /* *Column for the default indent-line-function to indent to.
5455Linefeed indents to this column in Fundamental mode. */);
5456
5457 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
5458 make_number (Lisp_Int),
5459 doc: /* *Distance between tab stops (for display of tab characters), in columns. */);
5460
5461 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
5462 doc: /* *Non-nil means display control chars with uparrow.
5463A value of nil means use backslash and octal digits.
5464This variable does not apply to characters whose display is specified
5465in the current display table (if there is one). */);
5466
5467 DEFVAR_PER_BUFFER ("enable-multibyte-characters",
5468 &current_buffer->enable_multibyte_characters,
5469 Qnil,
5470 doc: /* Non-nil means the buffer contents are regarded as multi-byte characters.
5471Otherwise they are regarded as unibyte. This affects the display,
5472file I/O and the behavior of various editing commands.
5473
5474This variable is buffer-local but you cannot set it directly;
5475use the function `set-buffer-multibyte' to change a buffer's representation.
5476Changing its default value with `setq-default' is supported.
5477See also variable `default-enable-multibyte-characters' and Info node
5478`(elisp)Text Representations'. */);
5479 XSYMBOL (intern ("enable-multibyte-characters"))->constant = 1;
5480
5481 DEFVAR_PER_BUFFER ("buffer-file-coding-system",
5482 &current_buffer->buffer_file_coding_system, Qnil,
5483 doc: /* Coding system to be used for encoding the buffer contents on saving.
5484This variable applies to saving the buffer, and also to `write-region'
5485and other functions that use `write-region'.
5486It does not apply to sending output to subprocesses, however.
5487
5488If this is nil, the buffer is saved without any code conversion
5489unless some coding system is specified in `file-coding-system-alist'
5490for the buffer file.
5491
5492If the text to be saved cannot be encoded as specified by this variable,
5493an alternative encoding is selected by `select-safe-coding-system', which see.
5494
5495The variable `coding-system-for-write', if non-nil, overrides this variable.
5496
5497This variable is never applied to a way of decoding a file while reading it. */);
5498
5499 DEFVAR_PER_BUFFER ("direction-reversed", &current_buffer->direction_reversed,
5500 Qnil,
5501 doc: /* *Non-nil means lines in the buffer are displayed right to left. */);
5502
5503 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
5504 doc: /* *Non-nil means do not display continuation lines.
5505Instead, give each line of text just one screen line.
5506
5507Note that this is overridden by the variable
5508`truncate-partial-width-windows' if that variable is non-nil
5509and this buffer is not full-frame width. */);
5510
5511#ifdef DOS_NT
5512 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
5513 Qnil,
5514 doc: /* Non-nil if the visited file is a binary file.
5515This variable is meaningful on MS-DOG and Windows NT.
5516On those systems, it is automatically local in every buffer.
5517On other systems, this variable is normally always nil. */);
5518#endif
5519
5520 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
5521 make_number (Lisp_String),
5522 doc: /* Name of default directory of current buffer. Should end with slash.
5523To interactively change the default directory, use command `cd'. */);
5524
5525 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
5526 Qnil,
5527 doc: /* Function called (if non-nil) to perform auto-fill.
5528It is called after self-inserting any character specified in
5529the `auto-fill-chars' table.
5530NOTE: This variable is not a hook;
5531its value may not be a list of functions. */);
5532
5533 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
5534 make_number (Lisp_String),
5535 doc: /* Name of file visited in current buffer, or nil if not visiting a file. */);
5536
5537 DEFVAR_PER_BUFFER ("buffer-file-truename", &current_buffer->file_truename,
5538 make_number (Lisp_String),
5539 doc: /* Abbreviated truename of file visited in current buffer, or nil if none.
5540The truename of a file is calculated by `file-truename'
5541and then abbreviated with `abbreviate-file-name'. */);
5542
5543 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
5544 &current_buffer->auto_save_file_name,
5545 make_number (Lisp_String),
5546 doc: /* Name of file for auto-saving current buffer.
5547If it is nil, that means don't auto-save this buffer. */);
5548
5549 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
5550 doc: /* Non-nil if this buffer is read-only. */);
5551
5552 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
5553 doc: /* Non-nil if this buffer's file has been backed up.
5554Backing up is done before the first time the file is saved. */);
5555
5556 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
5557 make_number (Lisp_Int),
5558 doc: /* Length of current buffer when last read in, saved or auto-saved.
55590 initially. */);
5560
5561 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
5562 Qnil,
5563 doc: /* Non-nil enables selective display.
5564An Integer N as value means display only lines
5565that start with less than n columns of space.
5566A value of t means that the character ^M makes itself and
5567all the rest of the line invisible; also, when saving the buffer
5568in a file, save the ^M as a newline. */);
5569
5570#ifndef old
5571 DEFVAR_PER_BUFFER ("selective-display-ellipses",
5572 &current_buffer->selective_display_ellipses,
5573 Qnil,
5574 doc: /* Non-nil means display ... on previous line when a line is invisible. */);
5575#endif
5576
5577 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
5578 doc: /* Non-nil if self-insertion should replace existing text.
5579The value should be one of `overwrite-mode-textual',
5580`overwrite-mode-binary', or nil.
5581If it is `overwrite-mode-textual', self-insertion still
5582inserts at the end of a line, and inserts when point is before a tab,
5583until the tab is filled in.
5584If `overwrite-mode-binary', self-insertion replaces newlines and tabs too. */);
5585
5586 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
5587 Qnil,
5588 doc: /* Display table that controls display of the contents of current buffer.
5589
5590If this variable is nil, the value of `standard-display-table' is used.
5591Each window can have its own, overriding display table, see
5592`set-window-display-table' and `window-display-table'.
5593
5594The display table is a char-table created with `make-display-table'.
5595A char-table is an array indexed by character codes. Normal array
5596primitives `aref' and `aset' can be used to access elements of a char-table.
5597
5598Each of the char-table elements control how to display the corresponding
5599text character: the element at index C in the table says how to display
5600the character whose code is C. Each element should be a vector of
5601characters or nil. nil means display the character in the default fashion;
5602otherwise, the characters from the vector are delivered to the screen
5603instead of the original character.
5604
5605For example, (aset buffer-display-table ?X ?Y) will cause Emacs to display
5606a capital Y instead of each X character.
5607
5608In addition, a char-table has six extra slots to control the display of:
5609
5610 the end of a truncated screen line (extra-slot 0, a single character);
5611 the end of a continued line (extra-slot 1, a single character);
5612 the escape character used to display character codes in octal
5613 (extra-slot 2, a single character);
5614 the character used as an arrow for control characters (extra-slot 3,
5615 a single character);
5616 the decoration indicating the presence of invisible lines (extra-slot 4,
5617 a vector of characters);
5618 the character used to draw the border between side-by-side windows
5619 (extra-slot 5, a single character).
5620
5621See also the functions `display-table-slot' and `set-display-table-slot'. */);
5622
5623 DEFVAR_PER_BUFFER ("left-margin-width", &current_buffer->left_margin_cols,
5624 Qnil,
5625 doc: /* *Width of left marginal area for display of a buffer.
5626A value of nil means no marginal area. */);
5627
5628 DEFVAR_PER_BUFFER ("right-margin-width", &current_buffer->right_margin_cols,
5629 Qnil,
5630 doc: /* *Width of right marginal area for display of a buffer.
5631A value of nil means no marginal area. */);
5632
5633 DEFVAR_PER_BUFFER ("left-fringe-width", &current_buffer->left_fringe_width,
5634 Qnil,
5635 doc: /* *Width of this buffer's left fringe (in pixels).
5636A value of 0 means no left fringe is shown in this buffer's window.
5637A value of nil means to use the left fringe width from the window's frame. */);
5638
5639 DEFVAR_PER_BUFFER ("right-fringe-width", &current_buffer->right_fringe_width,
5640 Qnil,
5641 doc: /* *Width of this buffer's right fringe (in pixels).
5642A value of 0 means no right fringe is shown in this buffer's window.
5643A value of nil means to use the right fringe width from the window's frame. */);
5644
5645 DEFVAR_PER_BUFFER ("fringes-outside-margins", &current_buffer->fringes_outside_margins,
5646 Qnil,
5647 doc: /* *Non-nil means to display fringes outside display margins.
5648A value of nil means to display fringes between margins and buffer text. */);
5649
5650 DEFVAR_PER_BUFFER ("scroll-bar-width", &current_buffer->scroll_bar_width,
5651 Qnil,
5652 doc: /* *Width of this buffer's scroll bars in pixels.
5653A value of nil means to use the scroll bar width from the window's frame. */);
5654
5655 DEFVAR_PER_BUFFER ("vertical-scroll-bar", &current_buffer->vertical_scroll_bar_type,
5656 Qnil,
5657 doc: /* *Position of this buffer's vertical scroll bar.
5658The value takes effect whenever you tell a window to display this buffer;
5659for instance, with `set-window-buffer' or when `display-buffer' displays it.
5660
5661A value of `left' or `right' means put the vertical scroll bar at that side
5662of the window; a value of nil means don't show any vertical scroll bars.
5663A value of t (the default) means do whatever the window's frame specifies. */);
5664
5665 DEFVAR_PER_BUFFER ("indicate-empty-lines",
5666 &current_buffer->indicate_empty_lines, Qnil,
5667 doc: /* *Visually indicate empty lines after the buffer end.
5668If non-nil, a bitmap is displayed in the left fringe of a window on
5669window-systems. */);
5670
5671 DEFVAR_PER_BUFFER ("indicate-buffer-boundaries",
5672 &current_buffer->indicate_buffer_boundaries, Qnil,
5673 doc: /* *Visually indicate buffer boundaries and scrolling.
5674If non-nil, the first and last line of the buffer are marked in the fringe
5675of a window on window-systems with angle bitmaps, or if the window can be
5676scrolled, the top and bottom line of the window are marked with up and down
5677arrow bitmaps.
5678
5679If value is a symbol `left' or `right', both angle and arrow bitmaps
5680are displayed in the left or right fringe, resp. Any other value
5681that doesn't look like an alist means display the angle bitmaps in
5682the left fringe but no arrows.
5683
5684You can exercise more precise control by using an alist as the
5685value. Each alist element (INDICATOR . POSITION) specifies
5686where to show one of the indicators. INDICATOR is one of `top',
5687`bottom', `up', `down', or t, which specifies the default position,
5688and POSITION is one of `left', `right', or nil, meaning do not show
5689this indicator.
5690
5691For example, ((top . left) (t . right)) places the top angle bitmap in
5692left fringe, the bottom angle bitmap in right fringe, and both arrow
5693bitmaps in right fringe. To show just the angle bitmaps in the left
5694fringe, but no arrow bitmaps, use ((top . left) (bottom . left)). */);
5695
5696 DEFVAR_PER_BUFFER ("scroll-up-aggressively",
5697 &current_buffer->scroll_up_aggressively, Qnil,
5698 doc: /* How far to scroll windows upward.
5699If you move point off the bottom, the window scrolls automatically.
5700This variable controls how far it scrolls. nil, the default,
5701means scroll to center point. A fraction means scroll to put point
5702that fraction of the window's height from the bottom of the window.
5703When the value is 0.0, point goes at the bottom line, which in the simple
5704case that you moved off with C-f means scrolling just one line. 1.0 means
5705point goes at the top, so that in that simple case, the window
5706window scrolls by a full window height. Meaningful values are
5707between 0.0 and 1.0, inclusive. */);
5708
5709 DEFVAR_PER_BUFFER ("scroll-down-aggressively",
5710 &current_buffer->scroll_down_aggressively, Qnil,
5711 doc: /* How far to scroll windows downward.
5712If you move point off the top, the window scrolls automatically.
5713This variable controls how far it scrolls. nil, the default,
5714means scroll to center point. A fraction means scroll to put point
5715that fraction of the window's height from the top of the window.
5716When the value is 0.0, point goes at the top line, which in the simple
5717case that you moved off with C-b means scrolling just one line. 1.0 means
5718point goes at the bottom, so that in that simple case, the window
5719window scrolls by a full window height. Meaningful values are
5720between 0.0 and 1.0, inclusive. */);
5721
5722/*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
5723 "Don't ask.");
5724*/
5725
5726 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
5727 doc: /* List of functions to call before each text change.
5728Two arguments are passed to each function: the positions of
5729the beginning and end of the range of old text to be changed.
5730\(For an insertion, the beginning and end are at the same place.)
5731No information is given about the length of the text after the change.
5732
5733Buffer changes made while executing the `before-change-functions'
5734don't call any before-change or after-change functions.
5735That's because these variables are temporarily set to nil.
5736As a result, a hook function cannot straightforwardly alter the value of
5737these variables. See the Emacs Lisp manual for a way of
5738accomplishing an equivalent result by using other variables.
5739
5740If an unhandled error happens in running these functions,
5741the variable's value remains nil. That prevents the error
5742from happening repeatedly and making Emacs nonfunctional. */);
5743 Vbefore_change_functions = Qnil;
5744
5745 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
5746 doc: /* List of functions to call after each text change.
5747Three arguments are passed to each function: the positions of
5748the beginning and end of the range of changed text,
5749and the length in bytes of the pre-change text replaced by that range.
5750\(For an insertion, the pre-change length is zero;
5751for a deletion, that length is the number of bytes deleted,
5752and the post-change beginning and end are at the same place.)
5753
5754Buffer changes made while executing the `after-change-functions'
5755don't call any before-change or after-change functions.
5756That's because these variables are temporarily set to nil.
5757As a result, a hook function cannot straightforwardly alter the value of
5758these variables. See the Emacs Lisp manual for a way of
5759accomplishing an equivalent result by using other variables.
5760
5761If an unhandled error happens in running these functions,
5762the variable's value remains nil. That prevents the error
5763from happening repeatedly and making Emacs nonfunctional. */);
5764 Vafter_change_functions = Qnil;
5765
5766 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
5767 doc: /* A list of functions to call before changing a buffer which is unmodified.
5768The functions are run using the `run-hooks' function. */);
5769 Vfirst_change_hook = Qnil;
5770
5771 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
5772 doc: /* List of undo entries in current buffer.
5773Recent changes come first; older changes follow newer.
5774
5775An entry (BEG . END) represents an insertion which begins at
5776position BEG and ends at position END.
5777
5778An entry (TEXT . POSITION) represents the deletion of the string TEXT
5779from (abs POSITION). If POSITION is positive, point was at the front
5780of the text being deleted; if negative, point was at the end.
5781
5782An entry (t HIGH . LOW) indicates that the buffer previously had
5783\"unmodified\" status. HIGH and LOW are the high and low 16-bit portions
5784of the visited file's modification time, as of that time. If the
5785modification time of the most recent save is different, this entry is
5786obsolete.
5787
5788An entry (nil PROPERTY VALUE BEG . END) indicates that a text property
5789was modified between BEG and END. PROPERTY is the property name,
5790and VALUE is the old value.
5791
5792An entry (apply FUN-NAME . ARGS) means undo the change with
5793\(apply FUN-NAME ARGS).
5794
5795An entry (apply DELTA BEG END FUN-NAME . ARGS) supports selective undo
5796in the active region. BEG and END is the range affected by this entry
5797and DELTA is the number of bytes added or deleted in that range by
5798this change.
5799
5800An entry (MARKER . DISTANCE) indicates that the marker MARKER
5801was adjusted in position by the offset DISTANCE (an integer).
5802
5803An entry of the form POSITION indicates that point was at the buffer
5804location given by the integer. Undoing an entry of this form places
5805point at POSITION.
5806
5807nil marks undo boundaries. The undo command treats the changes
5808between two undo boundaries as a single step to be undone.
5809
5810If the value of the variable is t, undo information is not recorded. */);
5811
5812 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
5813 doc: /* Non-nil means the mark and region are currently active in this buffer. */);
5814
5815 DEFVAR_PER_BUFFER ("cache-long-line-scans", &current_buffer->cache_long_line_scans, Qnil,
5816 doc: /* Non-nil means that Emacs should use caches to handle long lines more quickly.
5817
5818Normally, the line-motion functions work by scanning the buffer for
5819newlines. Columnar operations (like `move-to-column' and
5820`compute-motion') also work by scanning the buffer, summing character
5821widths as they go. This works well for ordinary text, but if the
5822buffer's lines are very long (say, more than 500 characters), these
5823motion functions will take longer to execute. Emacs may also take
5824longer to update the display.
5825
5826If `cache-long-line-scans' is non-nil, these motion functions cache the
5827results of their scans, and consult the cache to avoid rescanning
5828regions of the buffer until the text is modified. The caches are most
5829beneficial when they prevent the most searching---that is, when the
5830buffer contains long lines and large regions of characters with the
5831same, fixed screen width.
5832
5833When `cache-long-line-scans' is non-nil, processing short lines will
5834become slightly slower (because of the overhead of consulting the
5835cache), and the caches will use memory roughly proportional to the
5836number of newlines and characters whose screen width varies.
5837
5838The caches require no explicit maintenance; their accuracy is
5839maintained internally by the Emacs primitives. Enabling or disabling
5840the cache should not affect the behavior of any of the motion
5841functions; it should only affect their performance. */);
5842
5843 DEFVAR_PER_BUFFER ("point-before-scroll", &current_buffer->point_before_scroll, Qnil,
5844 doc: /* Value of point before the last series of scroll operations, or nil. */);
5845
5846 DEFVAR_PER_BUFFER ("buffer-file-format", &current_buffer->file_format, Qnil,
5847 doc: /* List of formats to use when saving this buffer.
5848Formats are defined by `format-alist'. This variable is
5849set when a file is visited. */);
5850
5851 DEFVAR_PER_BUFFER ("buffer-auto-save-file-format",
5852 &current_buffer->auto_save_file_format, Qnil,
5853 doc: /* *Format in which to write auto-save files.
5854Should be a list of symbols naming formats that are defined in `format-alist'.
5855If it is t, which is the default, auto-save files are written in the
5856same format as a regular save would use. */);
5857
5858 DEFVAR_PER_BUFFER ("buffer-invisibility-spec",
5859 &current_buffer->invisibility_spec, Qnil,
5860 doc: /* Invisibility spec of this buffer.
5861The default is t, which means that text is invisible
5862if it has a non-nil `invisible' property.
5863If the value is a list, a text character is invisible if its `invisible'
5864property is an element in that list.
5865If an element is a cons cell of the form (PROP . ELLIPSIS),
5866then characters with property value PROP are invisible,
5867and they have an ellipsis as well if ELLIPSIS is non-nil. */);
5868
5869 DEFVAR_PER_BUFFER ("buffer-display-count",
5870 &current_buffer->display_count, Qnil,
5871 doc: /* A number incremented each time this buffer is displayed in a window.
5872The function `set-window-buffer' increments it. */);
5873
5874 DEFVAR_PER_BUFFER ("buffer-display-time",
5875 &current_buffer->display_time, Qnil,
5876 doc: /* Time stamp updated each time this buffer is displayed in a window.
5877The function `set-window-buffer' updates this variable
5878to the value obtained by calling `current-time'.
5879If the buffer has never been shown in a window, the value is nil. */);
5880
5881 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
5882 doc: /* *Non-nil means deactivate the mark when the buffer contents change.
5883Non-nil also enables highlighting of the region whenever the mark is active.
5884The variable `highlight-nonselected-windows' controls whether to highlight
5885all windows or just the selected window.
5886
5887If the value is `lambda', that enables Transient Mark mode temporarily
5888until the next buffer modification. If a command sets the value to `only',
5889that enables Transient Mark mode for the following command only.
5890During that following command, the value of `transient-mark-mode'
5891is `identity'. If it is still `identity' at the end of that command,
5892it changes to nil. */);
5893 Vtransient_mark_mode = Qnil;
5894
5895 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
5896 doc: /* *Non-nil means disregard read-only status of buffers or characters.
5897If the value is t, disregard `buffer-read-only' and all `read-only'
5898text properties. If the value is a list, disregard `buffer-read-only'
5899and disregard a `read-only' text property if the property value
5900is a member of the list. */);
5901 Vinhibit_read_only = Qnil;
5902
5903 DEFVAR_PER_BUFFER ("cursor-type", &current_buffer->cursor_type, Qnil,
5904 doc: /* Cursor to use when this buffer is in the selected window.
5905Values are interpreted as follows:
5906
5907 t use the cursor specified for the frame
5908 nil don't display a cursor
5909 box display a filled box cursor
5910 hollow display a hollow box cursor
5911 bar display a vertical bar cursor with default width
5912 (bar . WIDTH) display a vertical bar cursor with width WIDTH
5913 hbar display a horizontal bar cursor with default width
5914 (hbar . WIDTH) display a horizontal bar cursor with width WIDTH
5915 ANYTHING ELSE display a hollow box cursor.
5916
5917When the buffer is displayed in a nonselected window,
5918this variable has no effect; the cursor appears as a hollow box. */);
5919
5920 DEFVAR_PER_BUFFER ("line-spacing",
5921 &current_buffer->extra_line_spacing, Qnil,
5922 doc: /* Additional space to put between lines when displaying a buffer.
5923The space is measured in pixels, and put below lines on window systems.
5924If value is a floating point number, it specifies the spacing relative
5925to the default frame line height. */);
5926
5927 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
5928 doc: /* List of functions called with no args to query before killing a buffer. */);
5929 Vkill_buffer_query_functions = Qnil;
5930
5931 defsubr (&Sbuffer_live_p);
5932 defsubr (&Sbuffer_list);
5933 defsubr (&Sget_buffer);
5934 defsubr (&Sget_file_buffer);
5935 defsubr (&Sget_buffer_create);
5936 defsubr (&Smake_indirect_buffer);
5937 defsubr (&Sgenerate_new_buffer_name);
5938 defsubr (&Sbuffer_name);
5939/*defsubr (&Sbuffer_number);*/
5940 defsubr (&Sbuffer_file_name);
5941 defsubr (&Sbuffer_base_buffer);
5942 defsubr (&Sbuffer_local_value);
5943 defsubr (&Sbuffer_local_variables);
5944 defsubr (&Sbuffer_modified_p);
5945 defsubr (&Sset_buffer_modified_p);
5946 defsubr (&Sbuffer_modified_tick);
5947 defsubr (&Srename_buffer);
5948 defsubr (&Sother_buffer);
5949 defsubr (&Sbuffer_enable_undo);
5950 defsubr (&Skill_buffer);
5951 defsubr (&Sset_buffer_major_mode);
5952 defsubr (&Sswitch_to_buffer);
5953 defsubr (&Spop_to_buffer);
5954 defsubr (&Scurrent_buffer);
5955 defsubr (&Sset_buffer);
5956 defsubr (&Sbarf_if_buffer_read_only);
5957 defsubr (&Sbury_buffer);
5958 defsubr (&Serase_buffer);
5959 defsubr (&Sset_buffer_multibyte);
5960 defsubr (&Skill_all_local_variables);
5961
5962 defsubr (&Soverlayp);
5963 defsubr (&Smake_overlay);
5964 defsubr (&Sdelete_overlay);
5965 defsubr (&Smove_overlay);
5966 defsubr (&Soverlay_start);
5967 defsubr (&Soverlay_end);
5968 defsubr (&Soverlay_buffer);
5969 defsubr (&Soverlay_properties);
5970 defsubr (&Soverlays_at);
5971 defsubr (&Soverlays_in);
5972 defsubr (&Snext_overlay_change);
5973 defsubr (&Sprevious_overlay_change);
5974 defsubr (&Soverlay_recenter);
5975 defsubr (&Soverlay_lists);
5976 defsubr (&Soverlay_get);
5977 defsubr (&Soverlay_put);
5978 defsubr (&Srestore_buffer_modified_p);
5979}
5980
5981void
5982keys_of_buffer ()
5983{
5984 initial_define_key (control_x_map, 'b', "switch-to-buffer");
5985 initial_define_key (control_x_map, 'k', "kill-buffer");
5986
5987 /* This must not be in syms_of_buffer, because Qdisabled is not
5988 initialized when that function gets called. */
5989 Fput (intern ("erase-buffer"), Qdisabled, Qt);
5990}
5991
5992/* arch-tag: e48569bf-69a9-4b65-a23b-8e68769436e1
5993 (do not change this comment) */