]> code.delx.au - gnu-emacs/blob - src/buffer.c
(Foverlay_put): Pass redisplay_region a struct buffer *.
[gnu-emacs] / src / buffer.c
1 /* Buffer manipulation primitives for GNU Emacs.
2 Copyright (C) 1985, 1986, 1987, 1988, 1989, 1993, 1994
3 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 2, or (at your option)
10 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; see the file COPYING. If not, write to
19 the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA. */
20
21
22 #include <sys/types.h>
23 #include <sys/stat.h>
24 #include <sys/param.h>
25
26 #ifndef MAXPATHLEN
27 /* in 4.1, param.h fails to define this. */
28 #define MAXPATHLEN 1024
29 #endif /* not MAXPATHLEN */
30
31 #include <config.h>
32 #include "lisp.h"
33 #include "intervals.h"
34 #include "window.h"
35 #include "commands.h"
36 #include "buffer.h"
37 #include "indent.h"
38 #include "blockinput.h"
39
40 struct buffer *current_buffer; /* the current buffer */
41
42 /* First buffer in chain of all buffers (in reverse order of creation).
43 Threaded through ->next. */
44
45 struct buffer *all_buffers;
46
47 /* This structure holds the default values of the buffer-local variables
48 defined with DEFVAR_PER_BUFFER, that have special slots in each buffer.
49 The default value occupies the same slot in this structure
50 as an individual buffer's value occupies in that buffer.
51 Setting the default value also goes through the alist of buffers
52 and stores into each buffer that does not say it has a local value. */
53
54 struct buffer buffer_defaults;
55
56 /* A Lisp_Object pointer to the above, used for staticpro */
57
58 static Lisp_Object Vbuffer_defaults;
59
60 /* This structure marks which slots in a buffer have corresponding
61 default values in buffer_defaults.
62 Each such slot has a nonzero value in this structure.
63 The value has only one nonzero bit.
64
65 When a buffer has its own local value for a slot,
66 the bit for that slot (found in the same slot in this structure)
67 is turned on in the buffer's local_var_flags slot.
68
69 If a slot in this structure is -1, then even though there may
70 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
71 and the corresponding slot in buffer_defaults is not used.
72
73 If a slot is -2, then there is no DEFVAR_PER_BUFFER for it,
74 but there is a default value which is copied into each buffer.
75
76 If a slot in this structure is negative, then even though there may
77 be a DEFVAR_PER_BUFFER for the slot, there is no default value for it;
78 and the corresponding slot in buffer_defaults is not used.
79
80 If a slot in this structure corresponding to a DEFVAR_PER_BUFFER is
81 zero, that is a bug */
82
83 struct buffer buffer_local_flags;
84
85 /* This structure holds the names of symbols whose values may be
86 buffer-local. It is indexed and accessed in the same way as the above. */
87
88 struct buffer buffer_local_symbols;
89 /* A Lisp_Object pointer to the above, used for staticpro */
90 static Lisp_Object Vbuffer_local_symbols;
91
92 /* This structure holds the required types for the values in the
93 buffer-local slots. If a slot contains Qnil, then the
94 corresponding buffer slot may contain a value of any type. If a
95 slot contains an integer, then prospective values' tags must be
96 equal to that integer. When a tag does not match, the function
97 buffer_slot_type_mismatch will signal an error. */
98 struct buffer buffer_local_types;
99
100 Lisp_Object Fset_buffer ();
101 void set_buffer_internal ();
102 static void call_overlay_mod_hooks ();
103
104 /* Alist of all buffer names vs the buffers. */
105 /* This used to be a variable, but is no longer,
106 to prevent lossage due to user rplac'ing this alist or its elements. */
107 Lisp_Object Vbuffer_alist;
108
109 /* Functions to call before and after each text change. */
110 Lisp_Object Vbefore_change_function;
111 Lisp_Object Vafter_change_function;
112 Lisp_Object Vbefore_change_functions;
113 Lisp_Object Vafter_change_functions;
114
115 Lisp_Object Vtransient_mark_mode;
116
117 /* t means ignore all read-only text properties.
118 A list means ignore such a property if its value is a member of the list.
119 Any non-nil value means ignore buffer-read-only. */
120 Lisp_Object Vinhibit_read_only;
121
122 /* List of functions to call that can query about killing a buffer.
123 If any of these functions returns nil, we don't kill it. */
124 Lisp_Object Vkill_buffer_query_functions;
125
126 /* List of functions to call before changing an unmodified buffer. */
127 Lisp_Object Vfirst_change_hook;
128 Lisp_Object Qfirst_change_hook;
129
130 Lisp_Object Qfundamental_mode, Qmode_class, Qpermanent_local;
131
132 Lisp_Object Qprotected_field;
133
134 Lisp_Object QSFundamental; /* A string "Fundamental" */
135
136 Lisp_Object Qkill_buffer_hook;
137
138 Lisp_Object Qget_file_buffer;
139
140 Lisp_Object Qoverlayp;
141
142 Lisp_Object Qpriority, Qwindow;
143
144 Lisp_Object Qmodification_hooks;
145 Lisp_Object Qinsert_in_front_hooks;
146 Lisp_Object Qinsert_behind_hooks;
147
148 /* For debugging; temporary. See set_buffer_internal. */
149 /* Lisp_Object Qlisp_mode, Vcheck_symbol; */
150
151 nsberror (spec)
152 Lisp_Object spec;
153 {
154 if (XTYPE (spec) == Lisp_String)
155 error ("No buffer named %s", XSTRING (spec)->data);
156 error ("Invalid buffer argument");
157 }
158 \f
159 DEFUN ("buffer-list", Fbuffer_list, Sbuffer_list, 0, 0, 0,
160 "Return a list of all existing live buffers.")
161 ()
162 {
163 return Fmapcar (Qcdr, Vbuffer_alist);
164 }
165
166 DEFUN ("get-buffer", Fget_buffer, Sget_buffer, 1, 1, 0,
167 "Return the buffer named NAME (a string).\n\
168 If there is no live buffer named NAME, return nil.\n\
169 NAME may also be a buffer; if so, the value is that buffer.")
170 (name)
171 register Lisp_Object name;
172 {
173 if (XTYPE (name) == Lisp_Buffer)
174 return name;
175 CHECK_STRING (name, 0);
176
177 return Fcdr (Fassoc (name, Vbuffer_alist));
178 }
179
180 DEFUN ("get-file-buffer", Fget_file_buffer, Sget_file_buffer, 1, 1, 0,
181 "Return the buffer visiting file FILENAME (a string).\n\
182 The buffer's `buffer-file-name' must match exactly the expansion of FILENAME.\n\
183 If there is no such live buffer, return nil.")
184 (filename)
185 register Lisp_Object filename;
186 {
187 register Lisp_Object tail, buf, tem;
188 Lisp_Object handler;
189
190 CHECK_STRING (filename, 0);
191 filename = Fexpand_file_name (filename, Qnil);
192
193 /* If the file name has special constructs in it,
194 call the corresponding file handler. */
195 handler = Ffind_file_name_handler (filename, Qget_file_buffer);
196 if (!NILP (handler))
197 return call2 (handler, Qget_file_buffer, filename);
198
199 for (tail = Vbuffer_alist; CONSP (tail); tail = XCONS (tail)->cdr)
200 {
201 buf = Fcdr (XCONS (tail)->car);
202 if (XTYPE (buf) != Lisp_Buffer) continue;
203 if (XTYPE (XBUFFER (buf)->filename) != Lisp_String) continue;
204 tem = Fstring_equal (XBUFFER (buf)->filename, filename);
205 if (!NILP (tem))
206 return buf;
207 }
208 return Qnil;
209 }
210
211 /* Incremented for each buffer created, to assign the buffer number. */
212 int buffer_count;
213
214 DEFUN ("get-buffer-create", Fget_buffer_create, Sget_buffer_create, 1, 1, 0,
215 "Return the buffer named NAME, or create such a buffer and return it.\n\
216 A new buffer is created if there is no live buffer named NAME.\n\
217 If NAME starts with a space, the new buffer does not keep undo information.\n\
218 If NAME is a buffer instead of a string, then it is the value returned.\n\
219 The value is never nil.")
220 (name)
221 register Lisp_Object name;
222 {
223 register Lisp_Object buf, function, tem;
224 int count = specpdl_ptr - specpdl;
225 register struct buffer *b;
226
227 buf = Fget_buffer (name);
228 if (!NILP (buf))
229 return buf;
230
231 if (XSTRING (name)->size == 0)
232 error ("Empty string for buffer name is not allowed");
233
234 b = (struct buffer *) xmalloc (sizeof (struct buffer));
235
236 BUF_GAP_SIZE (b) = 20;
237 BLOCK_INPUT;
238 BUFFER_ALLOC (BUF_BEG_ADDR (b), BUF_GAP_SIZE (b));
239 UNBLOCK_INPUT;
240 if (! BUF_BEG_ADDR (b))
241 memory_full ();
242
243 BUF_PT (b) = 1;
244 BUF_GPT (b) = 1;
245 BUF_BEGV (b) = 1;
246 BUF_ZV (b) = 1;
247 BUF_Z (b) = 1;
248 BUF_MODIFF (b) = 1;
249
250 /* Put this on the chain of all buffers including killed ones. */
251 b->next = all_buffers;
252 all_buffers = b;
253
254 b->mark = Fmake_marker ();
255 /*b->number = make_number (++buffer_count);*/
256 b->name = name;
257 if (XSTRING (name)->data[0] != ' ')
258 b->undo_list = Qnil;
259 else
260 b->undo_list = Qt;
261
262 reset_buffer (b);
263
264 /* Put this in the alist of all live buffers. */
265 XSET (buf, Lisp_Buffer, b);
266 Vbuffer_alist = nconc2 (Vbuffer_alist, Fcons (Fcons (name, buf), Qnil));
267
268 b->mark = Fmake_marker ();
269 b->markers = Qnil;
270 b->name = name;
271
272 function = buffer_defaults.major_mode;
273 if (NILP (function))
274 {
275 tem = Fget (current_buffer->major_mode, Qmode_class);
276 if (EQ (tem, Qnil))
277 function = current_buffer->major_mode;
278 }
279
280 if (NILP (function) || EQ (function, Qfundamental_mode))
281 return buf;
282
283 /* To select a nonfundamental mode,
284 select the buffer temporarily and then call the mode function. */
285
286 record_unwind_protect (save_excursion_restore, save_excursion_save ());
287
288 Fset_buffer (buf);
289 call0 (function);
290
291 return unbind_to (count, buf);
292 }
293
294 /* Reinitialize everything about a buffer except its name and contents. */
295
296 void
297 reset_buffer (b)
298 register struct buffer *b;
299 {
300 b->filename = Qnil;
301 b->directory = (current_buffer) ? current_buffer->directory : Qnil;
302 b->modtime = 0;
303 b->save_modified = 1;
304 XFASTINT (b->save_length) = 0;
305 b->last_window_start = 1;
306 b->backed_up = Qnil;
307 b->auto_save_modified = 0;
308 b->auto_save_failure_time = -1;
309 b->auto_save_file_name = Qnil;
310 b->read_only = Qnil;
311 b->overlays_before = Qnil;
312 b->overlays_after = Qnil;
313 XFASTINT (b->overlay_center) = 1;
314 b->mark_active = Qnil;
315
316 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
317 INITIALIZE_INTERVAL (b, NULL_INTERVAL);
318
319 reset_buffer_local_variables(b);
320 }
321
322 reset_buffer_local_variables (b)
323 register struct buffer *b;
324 {
325 register int offset;
326
327 /* Reset the major mode to Fundamental, together with all the
328 things that depend on the major mode.
329 default-major-mode is handled at a higher level.
330 We ignore it here. */
331 b->major_mode = Qfundamental_mode;
332 b->keymap = Qnil;
333 b->abbrev_table = Vfundamental_mode_abbrev_table;
334 b->mode_name = QSFundamental;
335 b->minor_modes = Qnil;
336 b->downcase_table = Vascii_downcase_table;
337 b->upcase_table = Vascii_upcase_table;
338 b->case_canon_table = Vascii_canon_table;
339 b->case_eqv_table = Vascii_eqv_table;
340 #if 0
341 b->sort_table = XSTRING (Vascii_sort_table);
342 b->folding_sort_table = XSTRING (Vascii_folding_sort_table);
343 #endif /* 0 */
344
345 /* Reset all per-buffer variables to their defaults. */
346 b->local_var_alist = Qnil;
347 b->local_var_flags = 0;
348
349 /* For each slot that has a default value,
350 copy that into the slot. */
351
352 for (offset = (char *)&buffer_local_flags.name - (char *)&buffer_local_flags;
353 offset < sizeof (struct buffer);
354 offset += sizeof (Lisp_Object)) /* sizeof int == sizeof Lisp_Object */
355 if (*(int *)(offset + (char *) &buffer_local_flags) > 0
356 || *(int *)(offset + (char *) &buffer_local_flags) == -2)
357 *(Lisp_Object *)(offset + (char *)b) =
358 *(Lisp_Object *)(offset + (char *)&buffer_defaults);
359 }
360
361 /* We split this away from generate-new-buffer, because rename-buffer
362 and set-visited-file-name ought to be able to use this to really
363 rename the buffer properly. */
364
365 DEFUN ("generate-new-buffer-name", Fgenerate_new_buffer_name, Sgenerate_new_buffer_name,
366 1, 2, 0,
367 "Return a string that is the name of no existing buffer based on NAME.\n\
368 If there is no live buffer named NAME, then return NAME.\n\
369 Otherwise modify name by appending `<NUMBER>', incrementing NUMBER\n\
370 until an unused name is found, and then return that name.\n\
371 Optional second argument IGNORE specifies a name that is okay to use\n\
372 \(if it is in the sequence to be tried)\n\
373 even if a buffer with that name exists.")
374 (name, ignore)
375 register Lisp_Object name, ignore;
376 {
377 register Lisp_Object gentemp, tem;
378 int count;
379 char number[10];
380
381 CHECK_STRING (name, 0);
382
383 tem = Fget_buffer (name);
384 if (NILP (tem))
385 return name;
386
387 count = 1;
388 while (1)
389 {
390 sprintf (number, "<%d>", ++count);
391 gentemp = concat2 (name, build_string (number));
392 tem = Fstring_equal (gentemp, ignore);
393 if (!NILP (tem))
394 return gentemp;
395 tem = Fget_buffer (gentemp);
396 if (NILP (tem))
397 return gentemp;
398 }
399 }
400
401 \f
402 DEFUN ("buffer-name", Fbuffer_name, Sbuffer_name, 0, 1, 0,
403 "Return the name of BUFFER, as a string.\n\
404 With no argument or nil as argument, return the name of the current buffer.")
405 (buffer)
406 register Lisp_Object buffer;
407 {
408 if (NILP (buffer))
409 return current_buffer->name;
410 CHECK_BUFFER (buffer, 0);
411 return XBUFFER (buffer)->name;
412 }
413
414 DEFUN ("buffer-file-name", Fbuffer_file_name, Sbuffer_file_name, 0, 1, 0,
415 "Return name of file BUFFER is visiting, or nil if none.\n\
416 No argument or nil as argument means use the current buffer.")
417 (buffer)
418 register Lisp_Object buffer;
419 {
420 if (NILP (buffer))
421 return current_buffer->filename;
422 CHECK_BUFFER (buffer, 0);
423 return XBUFFER (buffer)->filename;
424 }
425
426 DEFUN ("buffer-local-variables", Fbuffer_local_variables,
427 Sbuffer_local_variables, 0, 1, 0,
428 "Return an alist of variables that are buffer-local in BUFFER.\n\
429 Most elements look like (SYMBOL . VALUE), describing one variable.\n\
430 For a symbol that is locally unbound, just the symbol appears in the value.\n\
431 Note that storing new VALUEs in these elements doesn't change the variables.\n\
432 No argument or nil as argument means use current buffer as BUFFER.")
433 (buffer)
434 register Lisp_Object buffer;
435 {
436 register struct buffer *buf;
437 register Lisp_Object result;
438
439 if (NILP (buffer))
440 buf = current_buffer;
441 else
442 {
443 CHECK_BUFFER (buffer, 0);
444 buf = XBUFFER (buffer);
445 }
446
447 result = Qnil;
448
449 {
450 /* Reference each variable in the alist in our current buffer.
451 If inquiring about the current buffer, this gets the current values,
452 so store them into the alist so the alist is up to date.
453 If inquiring about some other buffer, this swaps out any values
454 for that buffer, making the alist up to date automatically. */
455 register Lisp_Object tail;
456 for (tail = buf->local_var_alist; CONSP (tail); tail = XCONS (tail)->cdr)
457 {
458 Lisp_Object val, elt;
459
460 elt = XCONS (tail)->car;
461
462 if (buf == current_buffer)
463 val = find_symbol_value (XCONS (elt)->car);
464 else
465 val = XCONS (elt)->cdr;
466
467 /* If symbol is unbound, put just the symbol in the list. */
468 if (EQ (val, Qunbound))
469 result = Fcons (XCONS (elt)->car, result);
470 /* Otherwise, put (symbol . value) in the list. */
471 else
472 result = Fcons (Fcons (XCONS (elt)->car, val), result);
473 }
474 }
475
476 /* Add on all the variables stored in special slots. */
477 {
478 register int offset, mask;
479
480 for (offset = (char *)&buffer_local_symbols.name - (char *)&buffer_local_symbols;
481 offset < sizeof (struct buffer);
482 offset += (sizeof (int))) /* sizeof int == sizeof Lisp_Object */
483 {
484 mask = *(int *)(offset + (char *) &buffer_local_flags);
485 if (mask == -1 || (buf->local_var_flags & mask))
486 if (XTYPE (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols))
487 == Lisp_Symbol)
488 result = Fcons (Fcons (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols),
489 *(Lisp_Object *)(offset + (char *)buf)),
490 result);
491 }
492 }
493
494 return result;
495 }
496
497 \f
498 DEFUN ("buffer-modified-p", Fbuffer_modified_p, Sbuffer_modified_p,
499 0, 1, 0,
500 "Return t if BUFFER was modified since its file was last read or saved.\n\
501 No argument or nil as argument means use current buffer as BUFFER.")
502 (buffer)
503 register Lisp_Object buffer;
504 {
505 register struct buffer *buf;
506 if (NILP (buffer))
507 buf = current_buffer;
508 else
509 {
510 CHECK_BUFFER (buffer, 0);
511 buf = XBUFFER (buffer);
512 }
513
514 return buf->save_modified < BUF_MODIFF (buf) ? Qt : Qnil;
515 }
516
517 DEFUN ("set-buffer-modified-p", Fset_buffer_modified_p, Sset_buffer_modified_p,
518 1, 1, 0,
519 "Mark current buffer as modified or unmodified according to FLAG.\n\
520 A non-nil FLAG means mark the buffer modified.")
521 (flag)
522 register Lisp_Object flag;
523 {
524 register int already;
525 register Lisp_Object fn;
526
527 #ifdef CLASH_DETECTION
528 /* If buffer becoming modified, lock the file.
529 If buffer becoming unmodified, unlock the file. */
530
531 fn = current_buffer->filename;
532 if (!NILP (fn))
533 {
534 already = current_buffer->save_modified < MODIFF;
535 if (!already && !NILP (flag))
536 lock_file (fn);
537 else if (already && NILP (flag))
538 unlock_file (fn);
539 }
540 #endif /* CLASH_DETECTION */
541
542 current_buffer->save_modified = NILP (flag) ? MODIFF : 0;
543 update_mode_lines++;
544 return flag;
545 }
546
547 DEFUN ("buffer-modified-tick", Fbuffer_modified_tick, Sbuffer_modified_tick,
548 0, 1, 0,
549 "Return BUFFER's tick counter, incremented for each change in text.\n\
550 Each buffer has a tick counter which is incremented each time the text in\n\
551 that buffer is changed. It wraps around occasionally.\n\
552 No argument or nil as argument means use current buffer as BUFFER.")
553 (buffer)
554 register Lisp_Object buffer;
555 {
556 register struct buffer *buf;
557 if (NILP (buffer))
558 buf = current_buffer;
559 else
560 {
561 CHECK_BUFFER (buffer, 0);
562 buf = XBUFFER (buffer);
563 }
564
565 return make_number (BUF_MODIFF (buf));
566 }
567 \f
568 DEFUN ("rename-buffer", Frename_buffer, Srename_buffer, 1, 2,
569 "sRename buffer (to new name): \nP",
570 "Change current buffer's name to NEWNAME (a string).\n\
571 If second arg UNIQUE is nil or omitted, it is an error if a\n\
572 buffer named NEWNAME already exists.\n\
573 If UNIQUE is non-nil, come up with a new name using\n\
574 `generate-new-buffer-name'.\n\
575 Interactively, you can set UNIQUE with a prefix argument.\n\
576 We return the name we actually gave the buffer.\n\
577 This does not change the name of the visited file (if any).")
578 (name, unique)
579 register Lisp_Object name, unique;
580 {
581 register Lisp_Object tem, buf;
582
583 CHECK_STRING (name, 0);
584
585 if (XSTRING (name)->size == 0)
586 error ("Empty string is invalid as a buffer name");
587
588 tem = Fget_buffer (name);
589 /* Don't short-circuit if UNIQUE is t. That is a useful way to rename
590 the buffer automatically so you can create another with the original name.
591 It makes UNIQUE equivalent to
592 (rename-buffer (generate-new-buffer-name NAME)). */
593 if (NILP (unique) && XBUFFER (tem) == current_buffer)
594 return current_buffer->name;
595 if (!NILP (tem))
596 {
597 if (!NILP (unique))
598 name = Fgenerate_new_buffer_name (name, current_buffer->name);
599 else
600 error ("Buffer name \"%s\" is in use", XSTRING (name)->data);
601 }
602
603 current_buffer->name = name;
604
605 /* Catch redisplay's attention. Unless we do this, the mode lines for
606 any windows displaying current_buffer will stay unchanged. */
607 update_mode_lines++;
608
609 XSET (buf, Lisp_Buffer, current_buffer);
610 Fsetcar (Frassq (buf, Vbuffer_alist), name);
611 if (NILP (current_buffer->filename) && !NILP (current_buffer->auto_save_file_name))
612 call0 (intern ("rename-auto-save-file"));
613 return name;
614 }
615
616 DEFUN ("other-buffer", Fother_buffer, Sother_buffer, 0, 2, 0,
617 "Return most recently selected buffer other than BUFFER.\n\
618 Buffers not visible in windows are preferred to visible buffers,\n\
619 unless optional second argument VISIBLE-OK is non-nil.\n\
620 If no other buffer exists, the buffer `*scratch*' is returned.\n\
621 If BUFFER is omitted or nil, some interesting buffer is returned.")
622 (buffer, visible_ok)
623 register Lisp_Object buffer, visible_ok;
624 {
625 register Lisp_Object tail, buf, notsogood, tem;
626 notsogood = Qnil;
627
628 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
629 {
630 buf = Fcdr (Fcar (tail));
631 if (EQ (buf, buffer))
632 continue;
633 if (XSTRING (XBUFFER (buf)->name)->data[0] == ' ')
634 continue;
635 if (NILP (visible_ok))
636 tem = Fget_buffer_window (buf, Qt);
637 else
638 tem = Qnil;
639 if (NILP (tem))
640 return buf;
641 if (NILP (notsogood))
642 notsogood = buf;
643 }
644 if (!NILP (notsogood))
645 return notsogood;
646 return Fget_buffer_create (build_string ("*scratch*"));
647 }
648 \f
649 DEFUN ("buffer-disable-undo", Fbuffer_disable_undo, Sbuffer_disable_undo, 0, 1,
650 0,
651 "Make BUFFER stop keeping undo information.\n\
652 No argument or nil as argument means do this for the current buffer.")
653 (buffer)
654 register Lisp_Object buffer;
655 {
656 Lisp_Object real_buffer;
657
658 if (NILP (buffer))
659 XSET (real_buffer, Lisp_Buffer, current_buffer);
660 else
661 {
662 real_buffer = Fget_buffer (buffer);
663 if (NILP (real_buffer))
664 nsberror (buffer);
665 }
666
667 XBUFFER (real_buffer)->undo_list = Qt;
668
669 return Qnil;
670 }
671
672 DEFUN ("buffer-enable-undo", Fbuffer_enable_undo, Sbuffer_enable_undo,
673 0, 1, "",
674 "Start keeping undo information for buffer BUFFER.\n\
675 No argument or nil as argument means do this for the current buffer.")
676 (buffer)
677 register Lisp_Object buffer;
678 {
679 Lisp_Object real_buffer;
680
681 if (NILP (buffer))
682 XSET (real_buffer, Lisp_Buffer, current_buffer);
683 else
684 {
685 real_buffer = Fget_buffer (buffer);
686 if (NILP (real_buffer))
687 nsberror (buffer);
688 }
689
690 if (EQ (XBUFFER (real_buffer)->undo_list, Qt))
691 XBUFFER (real_buffer)->undo_list = Qnil;
692
693 return Qnil;
694 }
695
696 /*
697 DEFVAR_LISP ("kill-buffer-hook", no_cell, "\
698 Hook to be run (by `run-hooks', which see) when a buffer is killed.\n\
699 The buffer being killed will be current while the hook is running.\n\
700 See `kill-buffer'."
701 */
702 DEFUN ("kill-buffer", Fkill_buffer, Skill_buffer, 1, 1, "bKill buffer: ",
703 "Kill the buffer BUFFER.\n\
704 The argument may be a buffer or may be the name of a buffer.\n\
705 An argument of nil means kill the current buffer.\n\n\
706 Value is t if the buffer is actually killed, nil if user says no.\n\n\
707 The value of `kill-buffer-hook' (which may be local to that buffer),\n\
708 if not void, is a list of functions to be called, with no arguments,\n\
709 before the buffer is actually killed. The buffer to be killed is current\n\
710 when the hook functions are called.\n\n\
711 Any processes that have this buffer as the `process-buffer' are killed\n\
712 with `delete-process'.")
713 (bufname)
714 Lisp_Object bufname;
715 {
716 Lisp_Object buf;
717 register struct buffer *b;
718 register Lisp_Object tem;
719 register struct Lisp_Marker *m;
720 struct gcpro gcpro1, gcpro2;
721
722 if (NILP (bufname))
723 buf = Fcurrent_buffer ();
724 else
725 buf = Fget_buffer (bufname);
726 if (NILP (buf))
727 nsberror (bufname);
728
729 b = XBUFFER (buf);
730
731 /* Query if the buffer is still modified. */
732 if (INTERACTIVE && !NILP (b->filename)
733 && BUF_MODIFF (b) > b->save_modified)
734 {
735 GCPRO2 (buf, bufname);
736 tem = do_yes_or_no_p (format1 ("Buffer %s modified; kill anyway? ",
737 XSTRING (b->name)->data));
738 UNGCPRO;
739 if (NILP (tem))
740 return Qnil;
741 }
742
743 /* Run hooks with the buffer to be killed the current buffer. */
744 {
745 register Lisp_Object val;
746 int count = specpdl_ptr - specpdl;
747 Lisp_Object list;
748
749 record_unwind_protect (save_excursion_restore, save_excursion_save ());
750 set_buffer_internal (b);
751
752 /* First run the query functions; if any query is answered no,
753 don't kill the buffer. */
754 for (list = Vkill_buffer_query_functions; !NILP (list); list = Fcdr (list))
755 {
756 tem = call0 (Fcar (list));
757 if (NILP (tem))
758 return unbind_to (count, Qnil);
759 }
760
761 /* Then run the hooks. */
762 if (!NILP (Vrun_hooks))
763 call1 (Vrun_hooks, Qkill_buffer_hook);
764 unbind_to (count, Qnil);
765 }
766
767 /* We have no more questions to ask. Verify that it is valid
768 to kill the buffer. This must be done after the questions
769 since anything can happen within do_yes_or_no_p. */
770
771 /* Don't kill the minibuffer now current. */
772 if (EQ (buf, XWINDOW (minibuf_window)->buffer))
773 return Qnil;
774
775 if (NILP (b->name))
776 return Qnil;
777
778 /* Make this buffer not be current.
779 In the process, notice if this is the sole visible buffer
780 and give up if so. */
781 if (b == current_buffer)
782 {
783 tem = Fother_buffer (buf, Qnil);
784 Fset_buffer (tem);
785 if (b == current_buffer)
786 return Qnil;
787 }
788
789 /* Now there is no question: we can kill the buffer. */
790
791 #ifdef CLASH_DETECTION
792 /* Unlock this buffer's file, if it is locked. */
793 unlock_buffer (b);
794 #endif /* CLASH_DETECTION */
795
796 kill_buffer_processes (buf);
797
798 tem = Vinhibit_quit;
799 Vinhibit_quit = Qt;
800 Vbuffer_alist = Fdelq (Frassq (buf, Vbuffer_alist), Vbuffer_alist);
801 Freplace_buffer_in_windows (buf);
802 Vinhibit_quit = tem;
803
804 /* Delete any auto-save file, if we saved it in this session. */
805 if (XTYPE (b->auto_save_file_name) == Lisp_String
806 && b->auto_save_modified != 0)
807 {
808 Lisp_Object tem;
809 tem = Fsymbol_value (intern ("delete-auto-save-files"));
810 if (! NILP (tem))
811 unlink (XSTRING (b->auto_save_file_name)->data);
812 }
813
814 /* Unchain all markers of this buffer
815 and leave them pointing nowhere. */
816 for (tem = b->markers; !EQ (tem, Qnil); )
817 {
818 m = XMARKER (tem);
819 m->buffer = 0;
820 tem = m->chain;
821 m->chain = Qnil;
822 }
823 b->markers = Qnil;
824
825 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
826 INITIALIZE_INTERVAL (b, NULL_INTERVAL);
827 /* Perhaps we should explicitly free the interval tree here... */
828
829 b->name = Qnil;
830 BLOCK_INPUT;
831 BUFFER_FREE (BUF_BEG_ADDR (b));
832 UNBLOCK_INPUT;
833 b->undo_list = Qnil;
834
835 return Qt;
836 }
837 \f
838 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
839 we do this each time BUF is selected visibly, the more recently
840 selected buffers are always closer to the front of the list. This
841 means that other_buffer is more likely to choose a relevant buffer. */
842
843 record_buffer (buf)
844 Lisp_Object buf;
845 {
846 register Lisp_Object link, prev;
847
848 prev = Qnil;
849 for (link = Vbuffer_alist; CONSP (link); link = XCONS (link)->cdr)
850 {
851 if (EQ (XCONS (XCONS (link)->car)->cdr, buf))
852 break;
853 prev = link;
854 }
855
856 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
857 we cannot use Fdelq itself here because it allows quitting. */
858
859 if (NILP (prev))
860 Vbuffer_alist = XCONS (Vbuffer_alist)->cdr;
861 else
862 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
863
864 XCONS(link)->cdr = Vbuffer_alist;
865 Vbuffer_alist = link;
866 }
867
868 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
869 "Select buffer BUFFER in the current window.\n\
870 BUFFER may be a buffer or a buffer name.\n\
871 Optional second arg NORECORD non-nil means\n\
872 do not put this buffer at the front of the list of recently selected ones.\n\
873 \n\
874 WARNING: This is NOT the way to work on another buffer temporarily\n\
875 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
876 the window-buffer correspondences.")
877 (bufname, norecord)
878 Lisp_Object bufname, norecord;
879 {
880 register Lisp_Object buf;
881 Lisp_Object tem;
882
883 if (EQ (minibuf_window, selected_window))
884 error ("Cannot switch buffers in minibuffer window");
885 tem = Fwindow_dedicated_p (selected_window);
886 if (!NILP (tem))
887 error ("Cannot switch buffers in a dedicated window");
888
889 if (NILP (bufname))
890 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
891 else
892 buf = Fget_buffer_create (bufname);
893 Fset_buffer (buf);
894 if (NILP (norecord))
895 record_buffer (buf);
896
897 Fset_window_buffer (EQ (selected_window, minibuf_window)
898 ? Fnext_window (minibuf_window, Qnil, Qnil)
899 : selected_window,
900 buf);
901
902 return buf;
903 }
904
905 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 2, 0,
906 "Select buffer BUFFER in some window, preferably a different one.\n\
907 If BUFFER is nil, then some other buffer is chosen.\n\
908 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
909 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
910 window even if BUFFER is already visible in the selected window.")
911 (bufname, other)
912 Lisp_Object bufname, other;
913 {
914 register Lisp_Object buf;
915 if (NILP (bufname))
916 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
917 else
918 buf = Fget_buffer_create (bufname);
919 Fset_buffer (buf);
920 record_buffer (buf);
921 Fselect_window (Fdisplay_buffer (buf, other));
922 return buf;
923 }
924
925 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
926 "Return the current buffer as a Lisp object.")
927 ()
928 {
929 register Lisp_Object buf;
930 XSET (buf, Lisp_Buffer, current_buffer);
931 return buf;
932 }
933 \f
934 /* Set the current buffer to b */
935
936 void
937 set_buffer_internal (b)
938 register struct buffer *b;
939 {
940 register struct buffer *old_buf;
941 register Lisp_Object tail, valcontents;
942 enum Lisp_Type tem;
943
944 if (current_buffer == b)
945 return;
946
947 windows_or_buffers_changed = 1;
948 old_buf = current_buffer;
949 current_buffer = b;
950 last_known_column_point = -1; /* invalidate indentation cache */
951
952 /* Look down buffer's list of local Lisp variables
953 to find and update any that forward into C variables. */
954
955 for (tail = b->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
956 {
957 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
958 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
959 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
960 && (tem = XTYPE (XCONS (valcontents)->car),
961 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
962 || tem == Lisp_Objfwd)))
963 /* Just reference the variable
964 to cause it to become set for this buffer. */
965 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
966 }
967
968 /* Do the same with any others that were local to the previous buffer */
969
970 if (old_buf)
971 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
972 {
973 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
974 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
975 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
976 && (tem = XTYPE (XCONS (valcontents)->car),
977 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
978 || tem == Lisp_Objfwd)))
979 /* Just reference the variable
980 to cause it to become set for this buffer. */
981 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
982 }
983 }
984
985 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
986 "Make the buffer BUFFER current for editing operations.\n\
987 BUFFER may be a buffer or the name of an existing buffer.\n\
988 See also `save-excursion' when you want to make a buffer current temporarily.\n\
989 This function does not display the buffer, so its effect ends\n\
990 when the current command terminates.\n\
991 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
992 (bufname)
993 register Lisp_Object bufname;
994 {
995 register Lisp_Object buffer;
996 buffer = Fget_buffer (bufname);
997 if (NILP (buffer))
998 nsberror (bufname);
999 if (NILP (XBUFFER (buffer)->name))
1000 error ("Selecting deleted buffer");
1001 set_buffer_internal (XBUFFER (buffer));
1002 return buffer;
1003 }
1004 \f
1005 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1006 Sbarf_if_buffer_read_only, 0, 0, 0,
1007 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1008 ()
1009 {
1010 if (!NILP (current_buffer->read_only)
1011 && NILP (Vinhibit_read_only))
1012 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1013 return Qnil;
1014 }
1015
1016 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1017 "Put BUFFER at the end of the list of all buffers.\n\
1018 There it is the least likely candidate for `other-buffer' to return;\n\
1019 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1020 If BUFFER is nil or omitted, bury the current buffer.\n\
1021 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1022 selected window if it is displayed there.")
1023 (buf)
1024 register Lisp_Object buf;
1025 {
1026 /* Figure out what buffer we're going to bury. */
1027 if (NILP (buf))
1028 {
1029 XSET (buf, Lisp_Buffer, current_buffer);
1030
1031 /* If we're burying the current buffer, unshow it. */
1032 Fswitch_to_buffer (Fother_buffer (buf, Qnil), Qnil);
1033 }
1034 else
1035 {
1036 Lisp_Object buf1;
1037
1038 buf1 = Fget_buffer (buf);
1039 if (NILP (buf1))
1040 nsberror (buf);
1041 buf = buf1;
1042 }
1043
1044 /* Move buf to the end of the buffer list. */
1045 {
1046 register Lisp_Object aelt, link;
1047
1048 aelt = Frassq (buf, Vbuffer_alist);
1049 link = Fmemq (aelt, Vbuffer_alist);
1050 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1051 XCONS (link)->cdr = Qnil;
1052 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1053 }
1054
1055 return Qnil;
1056 }
1057 \f
1058 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1059 "Delete the entire contents of the current buffer.\n\
1060 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1061 so the buffer is truly empty after this.")
1062 ()
1063 {
1064 Fwiden ();
1065 del_range (BEG, Z);
1066 current_buffer->last_window_start = 1;
1067 /* Prevent warnings, or suspension of auto saving, that would happen
1068 if future size is less than past size. Use of erase-buffer
1069 implies that the future text is not really related to the past text. */
1070 XFASTINT (current_buffer->save_length) = 0;
1071 return Qnil;
1072 }
1073
1074 validate_region (b, e)
1075 register Lisp_Object *b, *e;
1076 {
1077 register int i;
1078
1079 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1080 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1081
1082 if (XINT (*b) > XINT (*e))
1083 {
1084 i = XFASTINT (*b); /* This is legit even if *b is < 0 */
1085 *b = *e;
1086 XFASTINT (*e) = i; /* because this is all we do with i. */
1087 }
1088
1089 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1090 && XINT (*e) <= ZV))
1091 args_out_of_range (*b, *e);
1092 }
1093 \f
1094 static Lisp_Object
1095 list_buffers_1 (files)
1096 Lisp_Object files;
1097 {
1098 register Lisp_Object tail, tem, buf;
1099 Lisp_Object col1, col2, col3, minspace;
1100 register struct buffer *old = current_buffer, *b;
1101 Lisp_Object desired_point;
1102 Lisp_Object other_file_symbol;
1103
1104 desired_point = Qnil;
1105 other_file_symbol = intern ("list-buffers-directory");
1106
1107 XFASTINT (col1) = 19;
1108 XFASTINT (col2) = 25;
1109 XFASTINT (col3) = 40;
1110 XFASTINT (minspace) = 1;
1111
1112 Fset_buffer (Vstandard_output);
1113 Fbuffer_disable_undo (Vstandard_output);
1114 current_buffer->read_only = Qnil;
1115
1116 write_string ("\
1117 MR Buffer Size Mode File\n\
1118 -- ------ ---- ---- ----\n", -1);
1119
1120 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
1121 {
1122 buf = Fcdr (Fcar (tail));
1123 b = XBUFFER (buf);
1124 /* Don't mention the minibuffers. */
1125 if (XSTRING (b->name)->data[0] == ' ')
1126 continue;
1127 /* Optionally don't mention buffers that lack files. */
1128 if (!NILP (files) && NILP (b->filename))
1129 continue;
1130 /* Identify the current buffer. */
1131 if (b == old)
1132 XFASTINT (desired_point) = point;
1133 write_string (b == old ? "." : " ", -1);
1134 /* Identify modified buffers */
1135 write_string (BUF_MODIFF (b) > b->save_modified ? "*" : " ", -1);
1136 write_string (NILP (b->read_only) ? " " : "% ", -1);
1137 Fprinc (b->name, Qnil);
1138 Findent_to (col1, make_number (2));
1139 XFASTINT (tem) = BUF_Z (b) - BUF_BEG (b);
1140 Fprin1 (tem, Qnil);
1141 Findent_to (col2, minspace);
1142 Fprinc (b->mode_name, Qnil);
1143 Findent_to (col3, minspace);
1144
1145 if (!NILP (b->filename))
1146 Fprinc (b->filename, Qnil);
1147 else
1148 {
1149 /* No visited file; check local value of list-buffers-directory. */
1150 Lisp_Object tem;
1151 set_buffer_internal (b);
1152 tem = Fboundp (other_file_symbol);
1153 if (!NILP (tem))
1154 {
1155 tem = Fsymbol_value (other_file_symbol);
1156 Fset_buffer (Vstandard_output);
1157 if (XTYPE (tem) == Lisp_String)
1158 Fprinc (tem, Qnil);
1159 }
1160 else
1161 Fset_buffer (Vstandard_output);
1162 }
1163 write_string ("\n", -1);
1164 }
1165
1166 tail = intern ("Buffer-menu-mode");
1167 if ((tem = Ffboundp (tail), !NILP (tem)))
1168 call0 (tail);
1169 set_buffer_internal (old);
1170 return desired_point;
1171 }
1172
1173 DEFUN ("list-buffers", Flist_buffers, Slist_buffers, 0, 1, "P",
1174 "Display a list of names of existing buffers.\n\
1175 The list is displayed in a buffer named `*Buffer List*'.\n\
1176 Note that buffers with names starting with spaces are omitted.\n\
1177 Non-null optional arg FILES-ONLY means mention only file buffers.\n\
1178 \n\
1179 The M column contains a * for buffers that are modified.\n\
1180 The R column contains a % for buffers that are read-only.")
1181 (files)
1182 Lisp_Object files;
1183 {
1184 Lisp_Object desired_point;
1185
1186 desired_point
1187 = internal_with_output_to_temp_buffer ("*Buffer List*",
1188 list_buffers_1, files);
1189
1190 if (NUMBERP (desired_point))
1191 {
1192 int count = specpdl_ptr - specpdl;
1193 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1194 Fset_buffer (build_string ("*Buffer List*"));
1195 SET_PT (XINT (desired_point));
1196 return unbind_to (count, Qnil);
1197 }
1198 return Qnil;
1199 }
1200
1201 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
1202 0, 0, 0,
1203 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1204 Most local variable bindings are eliminated so that the default values\n\
1205 become effective once more. Also, the syntax table is set from\n\
1206 `standard-syntax-table', the local keymap is set to nil,\n\
1207 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1208 This function also forces redisplay of the mode line.\n\
1209 \n\
1210 Every function to select a new major mode starts by\n\
1211 calling this function.\n\n\
1212 As a special exception, local variables whose names have\n\
1213 a non-nil `permanent-local' property are not eliminated by this function.\n\
1214 \n\
1215 The first thing this function does is run\n\
1216 the normal hook `change-major-mode-hook'.")
1217 ()
1218 {
1219 register Lisp_Object alist, sym, tem;
1220 Lisp_Object oalist;
1221
1222 if (!NILP (Vrun_hooks))
1223 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
1224 oalist = current_buffer->local_var_alist;
1225
1226 /* Make sure no local variables remain set up with this buffer
1227 for their current values. */
1228
1229 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1230 {
1231 sym = XCONS (XCONS (alist)->car)->car;
1232
1233 /* Need not do anything if some other buffer's binding is now encached. */
1234 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car;
1235 if (XBUFFER (tem) == current_buffer)
1236 {
1237 /* Symbol is set up for this buffer's old local value.
1238 Set it up for the current buffer with the default value. */
1239
1240 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->cdr;
1241 /* Store the symbol's current value into the alist entry
1242 it is currently set up for. This is so that, if the
1243 local is marked permanent, and we make it local again below,
1244 we don't lose the value. */
1245 XCONS (XCONS (tem)->car)->cdr
1246 = do_symval_forwarding (XCONS (XSYMBOL (sym)->value)->car);
1247 /* Switch to the symbol's default-value alist entry. */
1248 XCONS (tem)->car = tem;
1249 /* Mark it as current for the current buffer. */
1250 XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car = Fcurrent_buffer ();
1251 /* Store the current value into any forwarding in the symbol. */
1252 store_symval_forwarding (sym, XCONS (XSYMBOL (sym)->value)->car,
1253 XCONS (tem)->cdr);
1254 }
1255 }
1256
1257 /* Actually eliminate all local bindings of this buffer. */
1258
1259 reset_buffer_local_variables (current_buffer);
1260
1261 /* Redisplay mode lines; we are changing major mode. */
1262
1263 update_mode_lines++;
1264
1265 /* Any which are supposed to be permanent,
1266 make local again, with the same values they had. */
1267
1268 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1269 {
1270 sym = XCONS (XCONS (alist)->car)->car;
1271 tem = Fget (sym, Qpermanent_local);
1272 if (! NILP (tem))
1273 {
1274 Fmake_local_variable (sym);
1275 Fset (sym, XCONS (XCONS (alist)->car)->cdr);
1276 }
1277 }
1278
1279 /* Force mode-line redisplay. Useful here because all major mode
1280 commands call this function. */
1281 update_mode_lines++;
1282
1283 return Qnil;
1284 }
1285 \f
1286 /* Find all the overlays in the current buffer that contain position POS.
1287 Return the number found, and store them in a vector in *VEC_PTR.
1288 Store in *LEN_PTR the size allocated for the vector.
1289 Store in *NEXT_PTR the next position after POS where an overlay starts,
1290 or ZV if there are no more overlays.
1291
1292 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1293 when this function is called.
1294
1295 If EXTEND is non-zero, we make the vector bigger if necessary.
1296 If EXTEND is zero, we never extend the vector,
1297 and we store only as many overlays as will fit.
1298 But we still return the total number of overlays. */
1299
1300 int
1301 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr)
1302 int pos;
1303 int extend;
1304 Lisp_Object **vec_ptr;
1305 int *len_ptr;
1306 int *next_ptr;
1307 {
1308 Lisp_Object tail, overlay, start, end, result;
1309 int idx = 0;
1310 int len = *len_ptr;
1311 Lisp_Object *vec = *vec_ptr;
1312 int next = ZV;
1313 int inhibit_storing = 0;
1314
1315 for (tail = current_buffer->overlays_before;
1316 XGCTYPE (tail) == Lisp_Cons;
1317 tail = XCONS (tail)->cdr)
1318 {
1319 int startpos;
1320
1321 overlay = XCONS (tail)->car;
1322 if (XGCTYPE (overlay) != Lisp_Overlay)
1323 abort ();
1324
1325 start = OVERLAY_START (overlay);
1326 end = OVERLAY_END (overlay);
1327 if (OVERLAY_POSITION (end) <= pos)
1328 break;
1329 startpos = OVERLAY_POSITION (start);
1330 if (startpos <= pos)
1331 {
1332 if (idx == len)
1333 {
1334 /* The supplied vector is full.
1335 Either make it bigger, or don't store any more in it. */
1336 if (extend)
1337 {
1338 *len_ptr = len *= 2;
1339 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1340 *vec_ptr = vec;
1341 }
1342 else
1343 inhibit_storing = 1;
1344 }
1345
1346 if (!inhibit_storing)
1347 vec[idx] = overlay;
1348 /* Keep counting overlays even if we can't return them all. */
1349 idx++;
1350 }
1351 else if (startpos < next)
1352 next = startpos;
1353 }
1354
1355 for (tail = current_buffer->overlays_after;
1356 XGCTYPE (tail) == Lisp_Cons;
1357 tail = XCONS (tail)->cdr)
1358 {
1359 int startpos;
1360
1361 overlay = XCONS (tail)->car;
1362 if (XGCTYPE (overlay) != Lisp_Overlay)
1363 abort ();
1364
1365 start = OVERLAY_START (overlay);
1366 end = OVERLAY_END (overlay);
1367 startpos = OVERLAY_POSITION (start);
1368 if (pos < startpos)
1369 {
1370 if (startpos < next)
1371 next = startpos;
1372 break;
1373 }
1374 if (pos < OVERLAY_POSITION (end))
1375 {
1376 if (idx == len)
1377 {
1378 if (extend)
1379 {
1380 *len_ptr = len *= 2;
1381 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1382 *vec_ptr = vec;
1383 }
1384 else
1385 inhibit_storing = 1;
1386 }
1387
1388 if (!inhibit_storing)
1389 vec[idx] = overlay;
1390 idx++;
1391 }
1392 }
1393
1394 *next_ptr = next;
1395 return idx;
1396 }
1397 \f
1398 struct sortvec
1399 {
1400 Lisp_Object overlay;
1401 int beg, end;
1402 int priority;
1403 };
1404
1405 static int
1406 compare_overlays (s1, s2)
1407 struct sortvec *s1, *s2;
1408 {
1409 if (s1->priority != s2->priority)
1410 return s1->priority - s2->priority;
1411 if (s1->beg != s2->beg)
1412 return s1->beg - s2->beg;
1413 if (s1->end != s2->end)
1414 return s2->end - s1->end;
1415 return 0;
1416 }
1417
1418 /* Sort an array of overlays by priority. The array is modified in place.
1419 The return value is the new size; this may be smaller than the original
1420 size if some of the overlays were invalid or were window-specific. */
1421 int
1422 sort_overlays (overlay_vec, noverlays, w)
1423 Lisp_Object *overlay_vec;
1424 int noverlays;
1425 struct window *w;
1426 {
1427 int i, j;
1428 struct sortvec *sortvec;
1429 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
1430
1431 /* Put the valid and relevant overlays into sortvec. */
1432
1433 for (i = 0, j = 0; i < noverlays; i++)
1434 {
1435 Lisp_Object tem;
1436 Lisp_Object overlay;
1437
1438 overlay = overlay_vec[i];
1439 if (OVERLAY_VALID (overlay)
1440 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
1441 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
1442 {
1443 /* If we're interested in a specific window, then ignore
1444 overlays that are limited to some other window. */
1445 if (w)
1446 {
1447 Lisp_Object window;
1448
1449 window = Foverlay_get (overlay, Qwindow);
1450 if (XTYPE (window) == Lisp_Window && XWINDOW (window) != w)
1451 continue;
1452 }
1453
1454 /* This overlay is good and counts: put it into sortvec. */
1455 sortvec[j].overlay = overlay;
1456 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
1457 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
1458 tem = Foverlay_get (overlay, Qpriority);
1459 if (INTEGERP (tem))
1460 sortvec[j].priority = XINT (tem);
1461 else
1462 sortvec[j].priority = 0;
1463 j++;
1464 }
1465 }
1466 noverlays = j;
1467
1468 /* Sort the overlays into the proper order: increasing priority. */
1469
1470 if (noverlays > 1)
1471 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
1472
1473 for (i = 0; i < noverlays; i++)
1474 overlay_vec[i] = sortvec[i].overlay;
1475 return (noverlays);
1476 }
1477 \f
1478 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1479
1480 void
1481 recenter_overlay_lists (buf, pos)
1482 struct buffer *buf;
1483 int pos;
1484 {
1485 Lisp_Object overlay, tail, next, prev, beg, end;
1486
1487 /* See if anything in overlays_before should move to overlays_after. */
1488
1489 /* We don't strictly need prev in this loop; it should always be nil.
1490 But we use it for symmetry and in case that should cease to be true
1491 with some future change. */
1492 prev = Qnil;
1493 for (tail = buf->overlays_before;
1494 CONSP (tail);
1495 prev = tail, tail = next)
1496 {
1497 next = XCONS (tail)->cdr;
1498 overlay = XCONS (tail)->car;
1499
1500 /* If the overlay is not valid, get rid of it. */
1501 if (!OVERLAY_VALID (overlay))
1502 #if 1
1503 abort ();
1504 #else
1505 {
1506 /* Splice the cons cell TAIL out of overlays_before. */
1507 if (!NILP (prev))
1508 XCONS (prev)->cdr = next;
1509 else
1510 buf->overlays_before = next;
1511 tail = prev;
1512 continue;
1513 }
1514 #endif
1515
1516 beg = OVERLAY_START (overlay);
1517 end = OVERLAY_END (overlay);
1518
1519 if (OVERLAY_POSITION (end) > pos)
1520 {
1521 /* OVERLAY needs to be moved. */
1522 int where = OVERLAY_POSITION (beg);
1523 Lisp_Object other, other_prev;
1524
1525 /* Splice the cons cell TAIL out of overlays_before. */
1526 if (!NILP (prev))
1527 XCONS (prev)->cdr = next;
1528 else
1529 buf->overlays_before = next;
1530
1531 /* Search thru overlays_after for where to put it. */
1532 other_prev = Qnil;
1533 for (other = buf->overlays_after;
1534 CONSP (other);
1535 other_prev = other, other = XCONS (other)->cdr)
1536 {
1537 Lisp_Object otherbeg, otheroverlay, follower;
1538 int win;
1539
1540 otheroverlay = XCONS (other)->car;
1541 if (! OVERLAY_VALID (otheroverlay))
1542 abort ();
1543
1544 otherbeg = OVERLAY_START (otheroverlay);
1545 if (OVERLAY_POSITION (otherbeg) >= where)
1546 break;
1547 }
1548
1549 /* Add TAIL to overlays_after before OTHER. */
1550 XCONS (tail)->cdr = other;
1551 if (!NILP (other_prev))
1552 XCONS (other_prev)->cdr = tail;
1553 else
1554 buf->overlays_after = tail;
1555 tail = prev;
1556 }
1557 else
1558 /* We've reached the things that should stay in overlays_before.
1559 All the rest of overlays_before must end even earlier,
1560 so stop now. */
1561 break;
1562 }
1563
1564 /* See if anything in overlays_after should be in overlays_before. */
1565 prev = Qnil;
1566 for (tail = buf->overlays_after;
1567 CONSP (tail);
1568 prev = tail, tail = next)
1569 {
1570 next = XCONS (tail)->cdr;
1571 overlay = XCONS (tail)->car;
1572
1573 /* If the overlay is not valid, get rid of it. */
1574 if (!OVERLAY_VALID (overlay))
1575 #if 1
1576 abort ();
1577 #else
1578 {
1579 /* Splice the cons cell TAIL out of overlays_after. */
1580 if (!NILP (prev))
1581 XCONS (prev)->cdr = next;
1582 else
1583 buf->overlays_after = next;
1584 tail = prev;
1585 continue;
1586 }
1587 #endif
1588
1589 beg = OVERLAY_START (overlay);
1590 end = OVERLAY_END (overlay);
1591
1592 /* Stop looking, when we know that nothing further
1593 can possibly end before POS. */
1594 if (OVERLAY_POSITION (beg) > pos)
1595 break;
1596
1597 if (OVERLAY_POSITION (end) <= pos)
1598 {
1599 /* OVERLAY needs to be moved. */
1600 int where = OVERLAY_POSITION (end);
1601 Lisp_Object other, other_prev;
1602
1603 /* Splice the cons cell TAIL out of overlays_after. */
1604 if (!NILP (prev))
1605 XCONS (prev)->cdr = next;
1606 else
1607 buf->overlays_after = next;
1608
1609 /* Search thru overlays_before for where to put it. */
1610 other_prev = Qnil;
1611 for (other = buf->overlays_before;
1612 CONSP (other);
1613 other_prev = other, other = XCONS (other)->cdr)
1614 {
1615 Lisp_Object otherend, otheroverlay;
1616 int win;
1617
1618 otheroverlay = XCONS (other)->car;
1619 if (! OVERLAY_VALID (otheroverlay))
1620 abort ();
1621
1622 otherend = OVERLAY_END (otheroverlay);
1623 if (OVERLAY_POSITION (otherend) <= where)
1624 break;
1625 }
1626
1627 /* Add TAIL to overlays_before before OTHER. */
1628 XCONS (tail)->cdr = other;
1629 if (!NILP (other_prev))
1630 XCONS (other_prev)->cdr = tail;
1631 else
1632 buf->overlays_before = tail;
1633 tail = prev;
1634 }
1635 }
1636
1637 XFASTINT (buf->overlay_center) = pos;
1638 }
1639
1640 /* Fix up overlays that were garbled as a result of permuting markers
1641 in the range START through END. Any overlay with at least one
1642 endpoint in this range will need to be unlinked from the overlay
1643 list and reinserted in its proper place.
1644 Such an overlay might even have negative size at this point.
1645 If so, we'll reverse the endpoints. Can you think of anything
1646 better to do in this situation? */
1647 void
1648 fix_overlays_in_range (start, end)
1649 register int start, end;
1650 {
1651 Lisp_Object tem, overlay;
1652 Lisp_Object before_list, after_list;
1653 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
1654 int startpos, endpos;
1655
1656 /* This algorithm shifts links around instead of consing and GCing.
1657 The loop invariant is that before_list (resp. after_list) is a
1658 well-formed list except that its last element, the one that
1659 *pbefore (resp. *pafter) points to, is still uninitialized.
1660 So it's not a bug that before_list isn't initialized, although
1661 it may look strange. */
1662 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
1663 {
1664 overlay = XCONS (*ptail)->car;
1665 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1666 if (endpos < start)
1667 break;
1668 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1669 if (endpos < end
1670 || (startpos >= start && startpos < end))
1671 {
1672 /* If the overlay is backwards, fix that now. */
1673 if (startpos > endpos)
1674 {
1675 int tem;
1676 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1677 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1678 tem = startpos; startpos = endpos; endpos = tem;
1679 }
1680 /* Add it to the end of the wrong list. Later on,
1681 recenter_overlay_lists will move it to the right place. */
1682 if (endpos < XINT (current_buffer->overlay_center))
1683 {
1684 *pafter = *ptail;
1685 pafter = &XCONS (*ptail)->cdr;
1686 }
1687 else
1688 {
1689 *pbefore = *ptail;
1690 pbefore = &XCONS (*ptail)->cdr;
1691 }
1692 *ptail = XCONS (*ptail)->cdr;
1693 }
1694 else
1695 ptail = &XCONS (*ptail)->cdr;
1696 }
1697 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
1698 {
1699 overlay = XCONS (*ptail)->car;
1700 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1701 if (startpos >= end)
1702 break;
1703 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1704 if (startpos >= start
1705 || (endpos >= start && endpos < end))
1706 {
1707 if (startpos > endpos)
1708 {
1709 int tem;
1710 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1711 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1712 tem = startpos; startpos = endpos; endpos = tem;
1713 }
1714 if (endpos < XINT (current_buffer->overlay_center))
1715 {
1716 *pafter = *ptail;
1717 pafter = &XCONS (*ptail)->cdr;
1718 }
1719 else
1720 {
1721 *pbefore = *ptail;
1722 pbefore = &XCONS (*ptail)->cdr;
1723 }
1724 *ptail = XCONS (*ptail)->cdr;
1725 }
1726 else
1727 ptail = &XCONS (*ptail)->cdr;
1728 }
1729
1730 /* Splice the constructed (wrong) lists into the buffer's lists,
1731 and let the recenter function make it sane again. */
1732 *pbefore = current_buffer->overlays_before;
1733 current_buffer->overlays_before = before_list;
1734 recenter_overlay_lists (current_buffer,
1735 XINT (current_buffer->overlay_center));
1736
1737 *pafter = current_buffer->overlays_after;
1738 current_buffer->overlays_after = after_list;
1739 recenter_overlay_lists (current_buffer,
1740 XINT (current_buffer->overlay_center));
1741 }
1742 \f
1743 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
1744 "Return t if OBJECT is an overlay.")
1745 (object)
1746 Lisp_Object object;
1747 {
1748 return (OVERLAYP (object) ? Qt : Qnil);
1749 }
1750
1751 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 3, 0,
1752 "Create a new overlay with range BEG to END in BUFFER.\n\
1753 If omitted, BUFFER defaults to the current buffer.\n\
1754 BEG and END may be integers or markers.")
1755 (beg, end, buffer)
1756 Lisp_Object beg, end, buffer;
1757 {
1758 Lisp_Object overlay;
1759 struct buffer *b;
1760
1761 if (NILP (buffer))
1762 XSET (buffer, Lisp_Buffer, current_buffer);
1763 else
1764 CHECK_BUFFER (buffer, 2);
1765 if (MARKERP (beg)
1766 && ! EQ (Fmarker_buffer (beg), buffer))
1767 error ("Marker points into wrong buffer");
1768 if (MARKERP (end)
1769 && ! EQ (Fmarker_buffer (end), buffer))
1770 error ("Marker points into wrong buffer");
1771
1772 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1773 CHECK_NUMBER_COERCE_MARKER (end, 1);
1774
1775 if (XINT (beg) > XINT (end))
1776 {
1777 Lisp_Object temp;
1778 temp = beg; beg = end; end = temp;
1779 }
1780
1781 b = XBUFFER (buffer);
1782
1783 beg = Fset_marker (Fmake_marker (), beg, buffer);
1784 end = Fset_marker (Fmake_marker (), end, buffer);
1785
1786 overlay = Fcons (Fcons (beg, end), Qnil);
1787 XSETTYPE (overlay, Lisp_Overlay);
1788
1789 /* Put the new overlay on the wrong list. */
1790 end = OVERLAY_END (overlay);
1791 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1792 b->overlays_after = Fcons (overlay, b->overlays_after);
1793 else
1794 b->overlays_before = Fcons (overlay, b->overlays_before);
1795
1796 /* This puts it in the right list, and in the right order. */
1797 recenter_overlay_lists (b, XINT (b->overlay_center));
1798
1799 /* We don't need to redisplay the region covered by the overlay, because
1800 the overlay has no properties at the moment. */
1801
1802 return overlay;
1803 }
1804
1805 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
1806 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
1807 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
1808 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
1809 buffer.")
1810 (overlay, beg, end, buffer)
1811 Lisp_Object overlay, beg, end, buffer;
1812 {
1813 struct buffer *b, *ob;
1814 Lisp_Object obuffer;
1815 int count = specpdl_ptr - specpdl;
1816
1817 CHECK_OVERLAY (overlay, 0);
1818 if (NILP (buffer))
1819 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1820 if (NILP (buffer))
1821 XSET (buffer, Lisp_Buffer, current_buffer);
1822 CHECK_BUFFER (buffer, 3);
1823
1824 if (MARKERP (beg)
1825 && ! EQ (Fmarker_buffer (beg), buffer))
1826 error ("Marker points into wrong buffer");
1827 if (MARKERP (end)
1828 && ! EQ (Fmarker_buffer (end), buffer))
1829 error ("Marker points into wrong buffer");
1830
1831 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1832 CHECK_NUMBER_COERCE_MARKER (end, 1);
1833
1834 specbind (Qinhibit_quit, Qt);
1835
1836 if (XINT (beg) > XINT (end))
1837 {
1838 Lisp_Object temp;
1839 temp = beg; beg = end; end = temp;
1840 }
1841
1842 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
1843 b = XBUFFER (buffer);
1844 ob = XBUFFER (obuffer);
1845
1846 /* If the overlay has changed buffers, do a thorough redisplay. */
1847 if (!EQ (buffer, obuffer))
1848 {
1849 /* Redisplay where the overlay was. */
1850 if (!NILP (obuffer))
1851 {
1852 Lisp_Object o_beg;
1853 Lisp_Object o_end;
1854
1855 o_beg = OVERLAY_START (overlay);
1856 o_end = OVERLAY_END (overlay);
1857 o_beg = OVERLAY_POSITION (o_beg);
1858 o_end = OVERLAY_POSITION (o_end);
1859
1860 redisplay_region (ob, XINT (o_beg), XINT (o_end));
1861 }
1862
1863 /* Redisplay where the overlay is going to be. */
1864 redisplay_region (b, XINT (beg), XINT (end));
1865
1866 /* Don't limit redisplay to the selected window. */
1867 windows_or_buffers_changed = 1;
1868 }
1869 else
1870 /* Redisplay the area the overlay has just left, or just enclosed. */
1871 {
1872 Lisp_Object o_beg;
1873 Lisp_Object o_end;
1874 int change_beg, change_end;
1875
1876 o_beg = OVERLAY_START (overlay);
1877 o_end = OVERLAY_END (overlay);
1878 o_beg = OVERLAY_POSITION (o_beg);
1879 o_end = OVERLAY_POSITION (o_end);
1880
1881 if (XINT (o_beg) == XINT (beg))
1882 redisplay_region (b, XINT (o_end), XINT (end));
1883 else if (XINT (o_end) == XINT (end))
1884 redisplay_region (b, XINT (o_beg), XINT (beg));
1885 else
1886 {
1887 if (XINT (beg) < XINT (o_beg)) o_beg = beg;
1888 if (XINT (end) > XINT (o_end)) o_end = end;
1889 redisplay_region (b, XINT (o_beg), XINT (o_end));
1890 }
1891 }
1892
1893 if (!NILP (obuffer))
1894 {
1895 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
1896 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
1897 }
1898
1899 Fset_marker (OVERLAY_START (overlay), beg, buffer);
1900 Fset_marker (OVERLAY_END (overlay), end, buffer);
1901
1902 /* Put the overlay on the wrong list. */
1903 end = OVERLAY_END (overlay);
1904 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1905 b->overlays_after = Fcons (overlay, b->overlays_after);
1906 else
1907 b->overlays_before = Fcons (overlay, b->overlays_before);
1908
1909 /* This puts it in the right list, and in the right order. */
1910 recenter_overlay_lists (b, XINT (b->overlay_center));
1911
1912 return unbind_to (count, overlay);
1913 }
1914
1915 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
1916 "Delete the overlay OVERLAY from its buffer.")
1917 (overlay)
1918 Lisp_Object overlay;
1919 {
1920 Lisp_Object buffer;
1921 struct buffer *b;
1922 int count = specpdl_ptr - specpdl;
1923
1924 CHECK_OVERLAY (overlay, 0);
1925
1926 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1927 if (NILP (buffer))
1928 return Qnil;
1929
1930 b = XBUFFER (buffer);
1931
1932 specbind (Qinhibit_quit, Qt);
1933
1934 b->overlays_before = Fdelq (overlay, b->overlays_before);
1935 b->overlays_after = Fdelq (overlay, b->overlays_after);
1936
1937 redisplay_region (b,
1938 marker_position (OVERLAY_START (overlay)),
1939 marker_position (OVERLAY_END (overlay)));
1940
1941 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
1942 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
1943
1944 return unbind_to (count, Qnil);
1945 }
1946 \f
1947 /* Overlay dissection functions. */
1948
1949 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
1950 "Return the position at which OVERLAY starts.")
1951 (overlay)
1952 Lisp_Object overlay;
1953 {
1954 CHECK_OVERLAY (overlay, 0);
1955
1956 return (Fmarker_position (OVERLAY_START (overlay)));
1957 }
1958
1959 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
1960 "Return the position at which OVERLAY ends.")
1961 (overlay)
1962 Lisp_Object overlay;
1963 {
1964 CHECK_OVERLAY (overlay, 0);
1965
1966 return (Fmarker_position (OVERLAY_END (overlay)));
1967 }
1968
1969 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
1970 "Return the buffer OVERLAY belongs to.")
1971 (overlay)
1972 Lisp_Object overlay;
1973 {
1974 CHECK_OVERLAY (overlay, 0);
1975
1976 return Fmarker_buffer (OVERLAY_START (overlay));
1977 }
1978
1979 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
1980 "Return a list of the properties on OVERLAY.\n\
1981 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
1982 OVERLAY.")
1983 (overlay)
1984 Lisp_Object overlay;
1985 {
1986 CHECK_OVERLAY (overlay, 0);
1987
1988 return Fcopy_sequence (Fcdr_safe (XCONS (overlay)->cdr));
1989 }
1990
1991 \f
1992 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
1993 "Return a list of the overlays that contain position POS.")
1994 (pos)
1995 Lisp_Object pos;
1996 {
1997 int noverlays;
1998 int endpos;
1999 Lisp_Object *overlay_vec;
2000 int len;
2001 Lisp_Object result;
2002
2003 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2004
2005 len = 10;
2006 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2007
2008 /* Put all the overlays we want in a vector in overlay_vec.
2009 Store the length in len. */
2010 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, &endpos);
2011
2012 /* Make a list of them all. */
2013 result = Flist (noverlays, overlay_vec);
2014
2015 xfree (overlay_vec);
2016 return result;
2017 }
2018
2019 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
2020 1, 1, 0,
2021 "Return the next position after POS where an overlay starts or ends.\n\
2022 If there are no more overlay boundaries after POS, return (point-max).")
2023 (pos)
2024 Lisp_Object pos;
2025 {
2026 int noverlays;
2027 int endpos;
2028 Lisp_Object *overlay_vec;
2029 int len;
2030 Lisp_Object result;
2031 int i;
2032
2033 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2034
2035 len = 10;
2036 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2037
2038 /* Put all the overlays we want in a vector in overlay_vec.
2039 Store the length in len.
2040 endpos gets the position where the next overlay starts. */
2041 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, &endpos);
2042
2043 /* If any of these overlays ends before endpos,
2044 use its ending point instead. */
2045 for (i = 0; i < noverlays; i++)
2046 {
2047 Lisp_Object oend;
2048 int oendpos;
2049
2050 oend = OVERLAY_END (overlay_vec[i]);
2051 oendpos = OVERLAY_POSITION (oend);
2052 if (oendpos < endpos)
2053 endpos = oendpos;
2054 }
2055
2056 xfree (overlay_vec);
2057 return make_number (endpos);
2058 }
2059 \f
2060 /* These functions are for debugging overlays. */
2061
2062 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
2063 "Return a pair of lists giving all the overlays of the current buffer.\n\
2064 The car has all the overlays before the overlay center;\n\
2065 the cdr has all the overlays after the overlay center.\n\
2066 Recentering overlays moves overlays between these lists.\n\
2067 The lists you get are copies, so that changing them has no effect.\n\
2068 However, the overlays you get are the real objects that the buffer uses.")
2069 ()
2070 {
2071 Lisp_Object before, after;
2072 before = current_buffer->overlays_before;
2073 if (CONSP (before))
2074 before = Fcopy_sequence (before);
2075 after = current_buffer->overlays_after;
2076 if (CONSP (after))
2077 after = Fcopy_sequence (after);
2078
2079 return Fcons (before, after);
2080 }
2081
2082 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
2083 "Recenter the overlays of the current buffer around position POS.")
2084 (pos)
2085 Lisp_Object pos;
2086 {
2087 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2088
2089 recenter_overlay_lists (current_buffer, XINT (pos));
2090 return Qnil;
2091 }
2092 \f
2093 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
2094 "Get the property of overlay OVERLAY with property name NAME.")
2095 (overlay, prop)
2096 Lisp_Object overlay, prop;
2097 {
2098 Lisp_Object plist;
2099
2100 CHECK_OVERLAY (overlay, 0);
2101
2102 for (plist = Fcdr_safe (XCONS (overlay)->cdr);
2103 CONSP (plist) && CONSP (XCONS (plist)->cdr);
2104 plist = XCONS (XCONS (plist)->cdr)->cdr)
2105 {
2106 if (EQ (XCONS (plist)->car, prop))
2107 return XCONS (XCONS (plist)->cdr)->car;
2108 }
2109
2110 return Qnil;
2111 }
2112
2113 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
2114 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
2115 (overlay, prop, value)
2116 Lisp_Object overlay, prop, value;
2117 {
2118 Lisp_Object plist, tail, buffer;
2119
2120 CHECK_OVERLAY (overlay, 0);
2121
2122 buffer = Fmarker_buffer (OVERLAY_START (overlay));
2123
2124 plist = Fcdr_safe (XCONS (overlay)->cdr);
2125
2126 for (tail = plist;
2127 CONSP (tail) && CONSP (XCONS (tail)->cdr);
2128 tail = XCONS (XCONS (tail)->cdr)->cdr)
2129 if (EQ (XCONS (tail)->car, prop))
2130 {
2131 /* If actually changing the property, mark redisplay needed. */
2132 if (! NILP (buffer) && !EQ (XCONS (XCONS (tail)->cdr)->car, value))
2133 redisplay_region (XBUFFER (buffer),
2134 marker_position (OVERLAY_START (overlay)),
2135 marker_position (OVERLAY_END (overlay)));
2136
2137 return XCONS (XCONS (tail)->cdr)->car = value;
2138 }
2139
2140 /* Actually changing the property; mark redisplay needed. */
2141 if (! NILP (buffer))
2142 redisplay_region (XBUFFER (buffer),
2143 marker_position (OVERLAY_START (overlay)),
2144 marker_position (OVERLAY_END (overlay)));
2145
2146 if (! CONSP (XCONS (overlay)->cdr))
2147 XCONS (overlay)->cdr = Fcons (Qnil, Qnil);
2148
2149 XCONS (XCONS (overlay)->cdr)->cdr
2150 = Fcons (prop, Fcons (value, plist));
2151
2152 return value;
2153 }
2154 \f
2155 /* Run the modification-hooks of overlays that include
2156 any part of the text in START to END.
2157 Run the insert-before-hooks of overlay starting at END,
2158 and the insert-after-hooks of overlay ending at START. */
2159
2160 void
2161 verify_overlay_modification (start, end)
2162 Lisp_Object start, end;
2163 {
2164 Lisp_Object prop, overlay, tail;
2165 int insertion = EQ (start, end);
2166 int tail_copied;
2167 struct gcpro gcpro1, gcpro2;
2168
2169 overlay = Qnil;
2170 tail = Qnil;
2171 GCPRO2 (overlay, tail);
2172
2173 tail_copied = 0;
2174 for (tail = current_buffer->overlays_before;
2175 CONSP (tail);
2176 tail = XCONS (tail)->cdr)
2177 {
2178 int startpos, endpos;
2179 Lisp_Object ostart, oend;
2180
2181 overlay = XCONS (tail)->car;
2182
2183 ostart = OVERLAY_START (overlay);
2184 oend = OVERLAY_END (overlay);
2185 endpos = OVERLAY_POSITION (oend);
2186 if (XFASTINT (start) > endpos)
2187 break;
2188 startpos = OVERLAY_POSITION (ostart);
2189 if (XFASTINT (end) == startpos && insertion)
2190 {
2191 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2192 if (!NILP (prop))
2193 {
2194 /* Copy TAIL in case the hook recenters the overlay lists. */
2195 if (!tail_copied)
2196 tail = Fcopy_sequence (tail);
2197 tail_copied = 1;
2198 call_overlay_mod_hooks (prop, overlay, start, end);
2199 }
2200 }
2201 if (XFASTINT (start) == endpos && insertion)
2202 {
2203 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2204 if (!NILP (prop))
2205 {
2206 if (!tail_copied)
2207 tail = Fcopy_sequence (tail);
2208 tail_copied = 1;
2209 call_overlay_mod_hooks (prop, overlay, start, end);
2210 }
2211 }
2212 /* Test for intersecting intervals. This does the right thing
2213 for both insertion and deletion. */
2214 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2215 {
2216 prop = Foverlay_get (overlay, Qmodification_hooks);
2217 if (!NILP (prop))
2218 {
2219 if (!tail_copied)
2220 tail = Fcopy_sequence (tail);
2221 tail_copied = 1;
2222 call_overlay_mod_hooks (prop, overlay, start, end);
2223 }
2224 }
2225 }
2226
2227 tail_copied = 0;
2228 for (tail = current_buffer->overlays_after;
2229 CONSP (tail);
2230 tail = XCONS (tail)->cdr)
2231 {
2232 int startpos, endpos;
2233 Lisp_Object ostart, oend;
2234
2235 overlay = XCONS (tail)->car;
2236
2237 ostart = OVERLAY_START (overlay);
2238 oend = OVERLAY_END (overlay);
2239 startpos = OVERLAY_POSITION (ostart);
2240 endpos = OVERLAY_POSITION (oend);
2241 if (XFASTINT (end) < startpos)
2242 break;
2243 if (XFASTINT (end) == startpos && insertion)
2244 {
2245 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2246 if (!NILP (prop))
2247 {
2248 if (!tail_copied)
2249 tail = Fcopy_sequence (tail);
2250 tail_copied = 1;
2251 call_overlay_mod_hooks (prop, overlay, start, end);
2252 }
2253 }
2254 if (XFASTINT (start) == endpos && insertion)
2255 {
2256 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2257 if (!NILP (prop))
2258 {
2259 if (!tail_copied)
2260 tail = Fcopy_sequence (tail);
2261 tail_copied = 1;
2262 call_overlay_mod_hooks (prop, overlay, start, end);
2263 }
2264 }
2265 /* Test for intersecting intervals. This does the right thing
2266 for both insertion and deletion. */
2267 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2268 {
2269 prop = Foverlay_get (overlay, Qmodification_hooks);
2270 if (!NILP (prop))
2271 {
2272 if (!tail_copied)
2273 tail = Fcopy_sequence (tail);
2274 tail_copied = 1;
2275 call_overlay_mod_hooks (prop, overlay, start, end);
2276 }
2277 }
2278 }
2279
2280 UNGCPRO;
2281 }
2282
2283 static void
2284 call_overlay_mod_hooks (list, overlay, start, end)
2285 Lisp_Object list, overlay, start, end;
2286 {
2287 struct gcpro gcpro1;
2288 GCPRO1 (list);
2289 while (!NILP (list))
2290 {
2291 call3 (Fcar (list), overlay, start, end);
2292 list = Fcdr (list);
2293 }
2294 UNGCPRO;
2295 }
2296 \f
2297 /* Somebody has tried to store NEWVAL into the buffer-local slot with
2298 offset XUINT (valcontents), and NEWVAL has an unacceptable type. */
2299 void
2300 buffer_slot_type_mismatch (valcontents, newval)
2301 Lisp_Object valcontents, newval;
2302 {
2303 unsigned int offset = XUINT (valcontents);
2304 unsigned char *symbol_name =
2305 (XSYMBOL (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols))
2306 ->name->data);
2307 char *type_name;
2308
2309 switch (XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_types)))
2310 {
2311 case Lisp_Int: type_name = "integers"; break;
2312 case Lisp_String: type_name = "strings"; break;
2313 case Lisp_Marker: type_name = "markers"; break;
2314 case Lisp_Symbol: type_name = "symbols"; break;
2315 case Lisp_Cons: type_name = "lists"; break;
2316 case Lisp_Vector: type_name = "vectors"; break;
2317 default:
2318 abort ();
2319 }
2320
2321 error ("only %s should be stored in the buffer-local variable %s",
2322 type_name, symbol_name);
2323 }
2324 \f
2325 init_buffer_once ()
2326 {
2327 register Lisp_Object tem;
2328
2329 /* Make sure all markable slots in buffer_defaults
2330 are initialized reasonably, so mark_buffer won't choke. */
2331 reset_buffer (&buffer_defaults);
2332 reset_buffer (&buffer_local_symbols);
2333 XSET (Vbuffer_defaults, Lisp_Buffer, &buffer_defaults);
2334 XSET (Vbuffer_local_symbols, Lisp_Buffer, &buffer_local_symbols);
2335
2336 /* Set up the default values of various buffer slots. */
2337 /* Must do these before making the first buffer! */
2338
2339 /* real setup is done in loaddefs.el */
2340 buffer_defaults.mode_line_format = build_string ("%-");
2341 buffer_defaults.abbrev_mode = Qnil;
2342 buffer_defaults.overwrite_mode = Qnil;
2343 buffer_defaults.case_fold_search = Qt;
2344 buffer_defaults.auto_fill_function = Qnil;
2345 buffer_defaults.selective_display = Qnil;
2346 #ifndef old
2347 buffer_defaults.selective_display_ellipses = Qt;
2348 #endif
2349 buffer_defaults.abbrev_table = Qnil;
2350 buffer_defaults.display_table = Qnil;
2351 buffer_defaults.undo_list = Qnil;
2352 buffer_defaults.mark_active = Qnil;
2353 buffer_defaults.overlays_before = Qnil;
2354 buffer_defaults.overlays_after = Qnil;
2355 XFASTINT (buffer_defaults.overlay_center) = 1;
2356
2357 XFASTINT (buffer_defaults.tab_width) = 8;
2358 buffer_defaults.truncate_lines = Qnil;
2359 buffer_defaults.ctl_arrow = Qt;
2360
2361 #ifdef MSDOS
2362 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
2363 #endif
2364 XFASTINT (buffer_defaults.fill_column) = 70;
2365 XFASTINT (buffer_defaults.left_margin) = 0;
2366
2367 /* Assign the local-flags to the slots that have default values.
2368 The local flag is a bit that is used in the buffer
2369 to say that it has its own local value for the slot.
2370 The local flag bits are in the local_var_flags slot of the buffer. */
2371
2372 /* Nothing can work if this isn't true */
2373 if (sizeof (int) != sizeof (Lisp_Object)) abort ();
2374
2375 /* 0 means not a lisp var, -1 means always local, else mask */
2376 bzero (&buffer_local_flags, sizeof buffer_local_flags);
2377 XFASTINT (buffer_local_flags.filename) = -1;
2378 XFASTINT (buffer_local_flags.directory) = -1;
2379 XFASTINT (buffer_local_flags.backed_up) = -1;
2380 XFASTINT (buffer_local_flags.save_length) = -1;
2381 XFASTINT (buffer_local_flags.auto_save_file_name) = -1;
2382 XFASTINT (buffer_local_flags.read_only) = -1;
2383 XFASTINT (buffer_local_flags.major_mode) = -1;
2384 XFASTINT (buffer_local_flags.mode_name) = -1;
2385 XFASTINT (buffer_local_flags.undo_list) = -1;
2386 XFASTINT (buffer_local_flags.mark_active) = -1;
2387
2388 XFASTINT (buffer_local_flags.mode_line_format) = 1;
2389 XFASTINT (buffer_local_flags.abbrev_mode) = 2;
2390 XFASTINT (buffer_local_flags.overwrite_mode) = 4;
2391 XFASTINT (buffer_local_flags.case_fold_search) = 8;
2392 XFASTINT (buffer_local_flags.auto_fill_function) = 0x10;
2393 XFASTINT (buffer_local_flags.selective_display) = 0x20;
2394 #ifndef old
2395 XFASTINT (buffer_local_flags.selective_display_ellipses) = 0x40;
2396 #endif
2397 XFASTINT (buffer_local_flags.tab_width) = 0x80;
2398 XFASTINT (buffer_local_flags.truncate_lines) = 0x100;
2399 XFASTINT (buffer_local_flags.ctl_arrow) = 0x200;
2400 XFASTINT (buffer_local_flags.fill_column) = 0x400;
2401 XFASTINT (buffer_local_flags.left_margin) = 0x800;
2402 XFASTINT (buffer_local_flags.abbrev_table) = 0x1000;
2403 XFASTINT (buffer_local_flags.display_table) = 0x2000;
2404 XFASTINT (buffer_local_flags.syntax_table) = 0x8000;
2405 #ifdef MSDOS
2406 XFASTINT (buffer_local_flags.buffer_file_type) = 0x4000;
2407 #endif
2408
2409 Vbuffer_alist = Qnil;
2410 current_buffer = 0;
2411 all_buffers = 0;
2412
2413 QSFundamental = build_string ("Fundamental");
2414
2415 Qfundamental_mode = intern ("fundamental-mode");
2416 buffer_defaults.major_mode = Qfundamental_mode;
2417
2418 Qmode_class = intern ("mode-class");
2419
2420 Qprotected_field = intern ("protected-field");
2421
2422 Qpermanent_local = intern ("permanent-local");
2423
2424 Qkill_buffer_hook = intern ("kill-buffer-hook");
2425
2426 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
2427 /* super-magic invisible buffer */
2428 Vbuffer_alist = Qnil;
2429
2430 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2431 }
2432
2433 init_buffer ()
2434 {
2435 char buf[MAXPATHLEN+1];
2436 char *pwd;
2437 struct stat dotstat, pwdstat;
2438 Lisp_Object temp;
2439
2440 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2441
2442 /* If PWD is accurate, use it instead of calling getwd. This is faster
2443 when PWD is right, and may avoid a fatal error. */
2444 if ((pwd = getenv ("PWD")) != 0 && *pwd == '/'
2445 && stat (pwd, &pwdstat) == 0
2446 && stat (".", &dotstat) == 0
2447 && dotstat.st_ino == pwdstat.st_ino
2448 && dotstat.st_dev == pwdstat.st_dev
2449 && strlen (pwd) < MAXPATHLEN)
2450 strcpy (buf, pwd);
2451 else if (getwd (buf) == 0)
2452 fatal ("`getwd' failed: %s.\n", buf);
2453
2454 #ifndef VMS
2455 /* Maybe this should really use some standard subroutine
2456 whose definition is filename syntax dependent. */
2457 if (buf[strlen (buf) - 1] != '/')
2458 strcat (buf, "/");
2459 #endif /* not VMS */
2460 current_buffer->directory = build_string (buf);
2461
2462 temp = get_minibuffer (0);
2463 XBUFFER (temp)->directory = current_buffer->directory;
2464 }
2465
2466 /* initialize the buffer routines */
2467 syms_of_buffer ()
2468 {
2469 extern Lisp_Object Qdisabled;
2470
2471 staticpro (&Vbuffer_defaults);
2472 staticpro (&Vbuffer_local_symbols);
2473 staticpro (&Qfundamental_mode);
2474 staticpro (&Qmode_class);
2475 staticpro (&QSFundamental);
2476 staticpro (&Vbuffer_alist);
2477 staticpro (&Qprotected_field);
2478 staticpro (&Qpermanent_local);
2479 staticpro (&Qkill_buffer_hook);
2480 staticpro (&Qoverlayp);
2481 staticpro (&Qmodification_hooks);
2482 Qmodification_hooks = intern ("modification-hooks");
2483 staticpro (&Qinsert_in_front_hooks);
2484 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
2485 staticpro (&Qinsert_behind_hooks);
2486 Qinsert_behind_hooks = intern ("insert-behind-hooks");
2487 staticpro (&Qget_file_buffer);
2488 Qget_file_buffer = intern ("get-file-buffer");
2489 Qpriority = intern ("priority");
2490 staticpro (&Qpriority);
2491 Qwindow = intern ("window");
2492 staticpro (&Qwindow);
2493
2494 Qoverlayp = intern ("overlayp");
2495
2496 Fput (Qprotected_field, Qerror_conditions,
2497 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
2498 Fput (Qprotected_field, Qerror_message,
2499 build_string ("Attempt to modify a protected field"));
2500
2501 /* All these use DEFVAR_LISP_NOPRO because the slots in
2502 buffer_defaults will all be marked via Vbuffer_defaults. */
2503
2504 DEFVAR_LISP_NOPRO ("default-mode-line-format",
2505 &buffer_defaults.mode_line_format,
2506 "Default value of `mode-line-format' for buffers that don't override it.\n\
2507 This is the same as (default-value 'mode-line-format).");
2508
2509 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
2510 &buffer_defaults.abbrev_mode,
2511 "Default value of `abbrev-mode' for buffers that do not override it.\n\
2512 This is the same as (default-value 'abbrev-mode).");
2513
2514 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
2515 &buffer_defaults.ctl_arrow,
2516 "Default value of `ctl-arrow' for buffers that do not override it.\n\
2517 This is the same as (default-value 'ctl-arrow).");
2518
2519 DEFVAR_LISP_NOPRO ("default-truncate-lines",
2520 &buffer_defaults.truncate_lines,
2521 "Default value of `truncate-lines' for buffers that do not override it.\n\
2522 This is the same as (default-value 'truncate-lines).");
2523
2524 DEFVAR_LISP_NOPRO ("default-fill-column",
2525 &buffer_defaults.fill_column,
2526 "Default value of `fill-column' for buffers that do not override it.\n\
2527 This is the same as (default-value 'fill-column).");
2528
2529 DEFVAR_LISP_NOPRO ("default-left-margin",
2530 &buffer_defaults.left_margin,
2531 "Default value of `left-margin' for buffers that do not override it.\n\
2532 This is the same as (default-value 'left-margin).");
2533
2534 DEFVAR_LISP_NOPRO ("default-tab-width",
2535 &buffer_defaults.tab_width,
2536 "Default value of `tab-width' for buffers that do not override it.\n\
2537 This is the same as (default-value 'tab-width).");
2538
2539 DEFVAR_LISP_NOPRO ("default-case-fold-search",
2540 &buffer_defaults.case_fold_search,
2541 "Default value of `case-fold-search' for buffers that don't override it.\n\
2542 This is the same as (default-value 'case-fold-search).");
2543
2544 #ifdef MSDOS
2545 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
2546 &buffer_defaults.buffer_file_type,
2547 "Default file type for buffers that do not override it.\n\
2548 This is the same as (default-value 'buffer-file-type).\n\
2549 The file type is nil for text, t for binary.");
2550 #endif
2551
2552 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2553 Qnil, 0);
2554
2555 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
2556 But make-docfile finds it!
2557 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2558 Qnil,
2559 "Template for displaying mode line for current buffer.\n\
2560 Each buffer has its own value of this variable.\n\
2561 Value may be a string, a symbol or a list or cons cell.\n\
2562 For a symbol, its value is used (but it is ignored if t or nil).\n\
2563 A string appearing directly as the value of a symbol is processed verbatim\n\
2564 in that the %-constructs below are not recognized.\n\
2565 For a list whose car is a symbol, the symbol's value is taken,\n\
2566 and if that is non-nil, the cadr of the list is processed recursively.\n\
2567 Otherwise, the caddr of the list (if there is one) is processed.\n\
2568 For a list whose car is a string or list, each element is processed\n\
2569 recursively and the results are effectively concatenated.\n\
2570 For a list whose car is an integer, the cdr of the list is processed\n\
2571 and padded (if the number is positive) or truncated (if negative)\n\
2572 to the width specified by that number.\n\
2573 A string is printed verbatim in the mode line except for %-constructs:\n\
2574 (%-constructs are allowed when the string is the entire mode-line-format\n\
2575 or when it is found in a cons-cell or a list)\n\
2576 %b -- print buffer name. %f -- print visited file name.\n\
2577 %* -- print *, % or hyphen. %m -- print value of mode-name (obsolete).\n\
2578 %s -- print process status. %l -- print the current line number.\n\
2579 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
2580 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
2581 or print Bottom or All.\n\
2582 %n -- print Narrow if appropriate.\n\
2583 %t -- print T if files is text, B if binary.\n\
2584 %[ -- print one [ for each recursive editing level. %] similar.\n\
2585 %% -- print %. %- -- print infinitely many dashes.\n\
2586 Decimal digits after the % specify field width to which to pad.");
2587 */
2588
2589 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
2590 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
2591 nil here means use current buffer's major mode.");
2592
2593 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
2594 make_number (Lisp_Symbol),
2595 "Symbol for current buffer's major mode.");
2596
2597 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
2598 make_number (Lisp_String),
2599 "Pretty name of current buffer's major mode (a string).");
2600
2601 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
2602 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
2603 Automatically becomes buffer-local when set in any fashion.");
2604
2605 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
2606 Qnil,
2607 "*Non-nil if searches should ignore case.\n\
2608 Automatically becomes buffer-local when set in any fashion.");
2609
2610 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
2611 make_number (Lisp_Int),
2612 "*Column beyond which automatic line-wrapping should happen.\n\
2613 Automatically becomes buffer-local when set in any fashion.");
2614
2615 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
2616 make_number (Lisp_Int),
2617 "*Column for the default indent-line-function to indent to.\n\
2618 Linefeed indents to this column in Fundamental mode.\n\
2619 Automatically becomes buffer-local when set in any fashion.");
2620
2621 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
2622 make_number (Lisp_Int),
2623 "*Distance between tab stops (for display of tab characters), in columns.\n\
2624 Automatically becomes buffer-local when set in any fashion.");
2625
2626 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
2627 "*Non-nil means display control chars with uparrow.\n\
2628 Nil means use backslash and octal digits.\n\
2629 Automatically becomes buffer-local when set in any fashion.\n\
2630 This variable does not apply to characters whose display is specified\n\
2631 in the current display table (if there is one).");
2632
2633 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
2634 "*Non-nil means do not display continuation lines;\n\
2635 give each line of text one screen line.\n\
2636 Automatically becomes buffer-local when set in any fashion.\n\
2637 \n\
2638 Note that this is overridden by the variable\n\
2639 `truncate-partial-width-windows' if that variable is non-nil\n\
2640 and this buffer is not full-frame width.");
2641
2642 #ifdef MSDOS
2643 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
2644 Qnil,
2645 "*If visited file is text, nil; otherwise, t.");
2646 #endif
2647
2648 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
2649 make_number (Lisp_String),
2650 "Name of default directory of current buffer. Should end with slash.\n\
2651 Each buffer has its own value of this variable.");
2652
2653 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
2654 Qnil,
2655 "Function called (if non-nil) to perform auto-fill.\n\
2656 It is called after self-inserting a space at a column beyond `fill-column'.\n\
2657 Each buffer has its own value of this variable.\n\
2658 NOTE: This variable is not an ordinary hook;\n\
2659 It may not be a list of functions.");
2660
2661 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
2662 make_number (Lisp_String),
2663 "Name of file visited in current buffer, or nil if not visiting a file.\n\
2664 Each buffer has its own value of this variable.");
2665
2666 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
2667 &current_buffer->auto_save_file_name,
2668 make_number (Lisp_String),
2669 "Name of file for auto-saving current buffer,\n\
2670 or nil if buffer should not be auto-saved.\n\
2671 Each buffer has its own value of this variable.");
2672
2673 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
2674 "Non-nil if this buffer is read-only.\n\
2675 Each buffer has its own value of this variable.");
2676
2677 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
2678 "Non-nil if this buffer's file has been backed up.\n\
2679 Backing up is done before the first time the file is saved.\n\
2680 Each buffer has its own value of this variable.");
2681
2682 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
2683 make_number (Lisp_Int),
2684 "Length of current buffer when last read in, saved or auto-saved.\n\
2685 0 initially.\n\
2686 Each buffer has its own value of this variable.");
2687
2688 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
2689 Qnil,
2690 "Non-nil enables selective display:\n\
2691 Integer N as value means display only lines\n\
2692 that start with less than n columns of space.\n\
2693 A value of t means, after a ^M, all the rest of the line is invisible.\n\
2694 Then ^M's in the file are written into files as newlines.\n\n\
2695 Automatically becomes buffer-local when set in any fashion.");
2696
2697 #ifndef old
2698 DEFVAR_PER_BUFFER ("selective-display-ellipses",
2699 &current_buffer->selective_display_ellipses,
2700 Qnil,
2701 "t means display ... on previous line when a line is invisible.\n\
2702 Automatically becomes buffer-local when set in any fashion.");
2703 #endif
2704
2705 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
2706 "Non-nil if self-insertion should replace existing text.\n\
2707 If non-nil and not `overwrite-mode-binary', self-insertion still\n\
2708 inserts at the end of a line, and inserts when point is before a tab,\n\
2709 until the tab is filled in.\n\
2710 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
2711 Automatically becomes buffer-local when set in any fashion.");
2712
2713 #if 0 /* The doc string is too long for some compilers,
2714 but make-docfile can find it in this comment. */
2715 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2716 Qnil,
2717 "Display table that controls display of the contents of current buffer.\n\
2718 Automatically becomes buffer-local when set in any fashion.\n\
2719 The display table is a vector created with `make-display-table'.\n\
2720 The first 256 elements control how to display each possible text character.\n\
2721 Each value should be a vector of characters or nil;\n\
2722 nil means display the character in the default fashion.\n\
2723 The remaining five elements control the display of\n\
2724 the end of a truncated screen line (element 256, a single character);\n\
2725 the end of a continued line (element 257, a single character);\n\
2726 the escape character used to display character codes in octal\n\
2727 (element 258, a single character);\n\
2728 the character used as an arrow for control characters (element 259,\n\
2729 a single character);\n\
2730 the decoration indicating the presence of invisible lines (element 260,\n\
2731 a vector of characters).\n\
2732 If this variable is nil, the value of `standard-display-table' is used.\n\
2733 Each window can have its own, overriding display table.");
2734 #endif
2735 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2736 Qnil, 0);
2737
2738 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
2739 "Don't ask.");
2740 */
2741 DEFVAR_LISP ("before-change-function", &Vbefore_change_function,
2742 "Function to call before each text change.\n\
2743 Two arguments are passed to the function: the positions of\n\
2744 the beginning and end of the range of old text to be changed.\n\
2745 \(For an insertion, the beginning and end are at the same place.)\n\
2746 No information is given about the length of the text after the change.\n\
2747 \n\
2748 Buffer changes made while executing the `before-change-function'\n\
2749 don't call any before-change or after-change functions.\n\
2750 That's because these variables are temporarily set to nil.\n\
2751 As a result, a hook function cannot straightforwardly alter the value of\n\
2752 these variables. See the Emacs Lisp manual for a way of\n\
2753 accomplishing an equivalent result by using other variables.");
2754 Vbefore_change_function = Qnil;
2755
2756 DEFVAR_LISP ("after-change-function", &Vafter_change_function,
2757 "Function to call after each text change.\n\
2758 Three arguments are passed to the function: the positions of\n\
2759 the beginning and end of the range of changed text,\n\
2760 and the length of the pre-change text replaced by that range.\n\
2761 \(For an insertion, the pre-change length is zero;\n\
2762 for a deletion, that length is the number of characters deleted,\n\
2763 and the post-change beginning and end are at the same place.)\n\
2764 \n\
2765 Buffer changes made while executing the `after-change-function'\n\
2766 don't call any before-change or after-change functions.\n\
2767 That's because these variables are temporarily set to nil.\n\
2768 As a result, a hook function cannot straightforwardly alter the value of\n\
2769 these variables. See the Emacs Lisp manual for a way of\n\
2770 accomplishing an equivalent result by using other variables.");
2771 Vafter_change_function = Qnil;
2772
2773 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
2774 "List of functions to call before each text change.\n\
2775 Two arguments are passed to each function: the positions of\n\
2776 the beginning and end of the range of old text to be changed.\n\
2777 \(For an insertion, the beginning and end are at the same place.)\n\
2778 No information is given about the length of the text after the change.\n\
2779 \n\
2780 Buffer changes made while executing the `before-change-functions'\n\
2781 don't call any before-change or after-change functions.\n\
2782 That's because these variables are temporarily set to nil.\n\
2783 As a result, a hook function cannot straightforwardly alter the value of\n\
2784 these variables. See the Emacs Lisp manual for a way of\n\
2785 accomplishing an equivalent result by using other variables.");
2786 Vbefore_change_functions = Qnil;
2787
2788 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
2789 "List of function to call after each text change.\n\
2790 Three arguments are passed to each function: the positions of\n\
2791 the beginning and end of the range of changed text,\n\
2792 and the length of the pre-change text replaced by that range.\n\
2793 \(For an insertion, the pre-change length is zero;\n\
2794 for a deletion, that length is the number of characters deleted,\n\
2795 and the post-change beginning and end are at the same place.)\n\
2796 \n\
2797 Buffer changes made while executing the `after-change-functions'\n\
2798 don't call any before-change or after-change functions.\n\
2799 That's because these variables are temporarily set to nil.\n\
2800 As a result, a hook function cannot straightforwardly alter the value of\n\
2801 these variables. See the Emacs Lisp manual for a way of\n\
2802 accomplishing an equivalent result by using other variables.");
2803
2804 Vafter_change_functions = Qnil;
2805
2806 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
2807 "A list of functions to call before changing a buffer which is unmodified.\n\
2808 The functions are run using the `run-hooks' function.");
2809 Vfirst_change_hook = Qnil;
2810 Qfirst_change_hook = intern ("first-change-hook");
2811 staticpro (&Qfirst_change_hook);
2812
2813 #if 0 /* The doc string is too long for some compilers,
2814 but make-docfile can find it in this comment. */
2815 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2816 "List of undo entries in current buffer.\n\
2817 Recent changes come first; older changes follow newer.\n\
2818 \n\
2819 An entry (START . END) represents an insertion which begins at\n\
2820 position START and ends at position END.\n\
2821 \n\
2822 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
2823 from (abs POSITION). If POSITION is positive, point was at the front\n\
2824 of the text being deleted; if negative, point was at the end.\n\
2825 \n\
2826 An entry (t HIGHWORD LOWWORD) indicates that the buffer had been\n\
2827 previously unmodified. HIGHWORD and LOWWORD are the high and low\n\
2828 16-bit words of the buffer's modification count at the time. If the\n\
2829 modification count of the most recent save is different, this entry is\n\
2830 obsolete.\n\
2831 \n\
2832 An entry (nil PROP VAL BEG . END) indicates that a text property\n\
2833 was modified between BEG and END. PROP is the property name,\n\
2834 and VAL is the old value.\n\
2835 \n\
2836 An entry of the form POSITION indicates that point was at the buffer\n\
2837 location given by the integer. Undoing an entry of this form places\n\
2838 point at POSITION.\n\
2839 \n\
2840 nil marks undo boundaries. The undo command treats the changes\n\
2841 between two undo boundaries as a single step to be undone.\n\
2842 \n\
2843 If the value of the variable is t, undo information is not recorded.");
2844 #endif
2845 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2846 0);
2847
2848 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
2849 "Non-nil means the mark and region are currently active in this buffer.\n\
2850 Automatically local in all buffers.");
2851
2852 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
2853 "*Non-nil means deactivate the mark when the buffer contents change.");
2854 Vtransient_mark_mode = Qnil;
2855
2856 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
2857 "*Non-nil means disregard read-only status of buffers or characters.\n\
2858 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
2859 text properties. If the value is a list, disregard `buffer-read-only'\n\
2860 and disregard a `read-only' text property if the property value\n\
2861 is a member of the list.");
2862 Vinhibit_read_only = Qnil;
2863
2864 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
2865 "List of functions called with no args to query before killing a buffer.");
2866 Vkill_buffer_query_functions = Qnil;
2867
2868 defsubr (&Sbuffer_list);
2869 defsubr (&Sget_buffer);
2870 defsubr (&Sget_file_buffer);
2871 defsubr (&Sget_buffer_create);
2872 defsubr (&Sgenerate_new_buffer_name);
2873 defsubr (&Sbuffer_name);
2874 /*defsubr (&Sbuffer_number);*/
2875 defsubr (&Sbuffer_file_name);
2876 defsubr (&Sbuffer_local_variables);
2877 defsubr (&Sbuffer_modified_p);
2878 defsubr (&Sset_buffer_modified_p);
2879 defsubr (&Sbuffer_modified_tick);
2880 defsubr (&Srename_buffer);
2881 defsubr (&Sother_buffer);
2882 defsubr (&Sbuffer_disable_undo);
2883 defsubr (&Sbuffer_enable_undo);
2884 defsubr (&Skill_buffer);
2885 defsubr (&Serase_buffer);
2886 defsubr (&Sswitch_to_buffer);
2887 defsubr (&Spop_to_buffer);
2888 defsubr (&Scurrent_buffer);
2889 defsubr (&Sset_buffer);
2890 defsubr (&Sbarf_if_buffer_read_only);
2891 defsubr (&Sbury_buffer);
2892 defsubr (&Slist_buffers);
2893 defsubr (&Skill_all_local_variables);
2894
2895 defsubr (&Soverlayp);
2896 defsubr (&Smake_overlay);
2897 defsubr (&Sdelete_overlay);
2898 defsubr (&Smove_overlay);
2899 defsubr (&Soverlay_start);
2900 defsubr (&Soverlay_end);
2901 defsubr (&Soverlay_buffer);
2902 defsubr (&Soverlay_properties);
2903 defsubr (&Soverlays_at);
2904 defsubr (&Snext_overlay_change);
2905 defsubr (&Soverlay_recenter);
2906 defsubr (&Soverlay_lists);
2907 defsubr (&Soverlay_get);
2908 defsubr (&Soverlay_put);
2909 }
2910
2911 keys_of_buffer ()
2912 {
2913 initial_define_key (control_x_map, 'b', "switch-to-buffer");
2914 initial_define_key (control_x_map, 'k', "kill-buffer");
2915 initial_define_key (control_x_map, Ctl ('B'), "list-buffers");
2916
2917 /* This must not be in syms_of_buffer, because Qdisabled is not
2918 initialized when that function gets called. */
2919 Fput (intern ("erase-buffer"), Qdisabled, Qt);
2920 }