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