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