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