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