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