(verify_overlay_modification): GCPRO tail and overlay.
[bpt/emacs.git] / 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. */
805 if (XTYPE (b->auto_save_file_name) == Lisp_String)
806 {
807 Lisp_Object tem;
808 tem = Fsymbol_value (intern ("delete-auto-save-files"));
809 if (! NILP (tem))
810 unlink (XSTRING (b->auto_save_file_name)->data);
811 }
812
813 /* Unchain all markers of this buffer
814 and leave them pointing nowhere. */
815 for (tem = b->markers; !EQ (tem, Qnil); )
816 {
817 m = XMARKER (tem);
818 m->buffer = 0;
819 tem = m->chain;
820 m->chain = Qnil;
821 }
822 b->markers = Qnil;
823
824 /* Only defined if Emacs is compiled with USE_TEXT_PROPERTIES */
825 INITIALIZE_INTERVAL (b, NULL_INTERVAL);
826 /* Perhaps we should explicitly free the interval tree here... */
827
828 b->name = Qnil;
829 BLOCK_INPUT;
830 BUFFER_FREE (BUF_BEG_ADDR (b));
831 UNBLOCK_INPUT;
832 b->undo_list = Qnil;
833
834 return Qt;
835 }
836 \f
837 /* Move the assoc for buffer BUF to the front of buffer-alist. Since
838 we do this each time BUF is selected visibly, the more recently
839 selected buffers are always closer to the front of the list. This
840 means that other_buffer is more likely to choose a relevant buffer. */
841
842 record_buffer (buf)
843 Lisp_Object buf;
844 {
845 register Lisp_Object link, prev;
846
847 prev = Qnil;
848 for (link = Vbuffer_alist; CONSP (link); link = XCONS (link)->cdr)
849 {
850 if (EQ (XCONS (XCONS (link)->car)->cdr, buf))
851 break;
852 prev = link;
853 }
854
855 /* Effectively do Vbuffer_alist = Fdelq (link, Vbuffer_alist);
856 we cannot use Fdelq itself here because it allows quitting. */
857
858 if (NILP (prev))
859 Vbuffer_alist = XCONS (Vbuffer_alist)->cdr;
860 else
861 XCONS (prev)->cdr = XCONS (XCONS (prev)->cdr)->cdr;
862
863 XCONS(link)->cdr = Vbuffer_alist;
864 Vbuffer_alist = link;
865 }
866
867 DEFUN ("switch-to-buffer", Fswitch_to_buffer, Sswitch_to_buffer, 1, 2, "BSwitch to buffer: ",
868 "Select buffer BUFFER in the current window.\n\
869 BUFFER may be a buffer or a buffer name.\n\
870 Optional second arg NORECORD non-nil means\n\
871 do not put this buffer at the front of the list of recently selected ones.\n\
872 \n\
873 WARNING: This is NOT the way to work on another buffer temporarily\n\
874 within a Lisp program! Use `set-buffer' instead. That avoids messing with\n\
875 the window-buffer correspondences.")
876 (bufname, norecord)
877 Lisp_Object bufname, norecord;
878 {
879 register Lisp_Object buf;
880 Lisp_Object tem;
881
882 if (EQ (minibuf_window, selected_window))
883 error ("Cannot switch buffers in minibuffer window");
884 tem = Fwindow_dedicated_p (selected_window);
885 if (!NILP (tem))
886 error ("Cannot switch buffers in a dedicated window");
887
888 if (NILP (bufname))
889 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
890 else
891 buf = Fget_buffer_create (bufname);
892 Fset_buffer (buf);
893 if (NILP (norecord))
894 record_buffer (buf);
895
896 Fset_window_buffer (EQ (selected_window, minibuf_window)
897 ? Fnext_window (minibuf_window, Qnil, Qnil)
898 : selected_window,
899 buf);
900
901 return buf;
902 }
903
904 DEFUN ("pop-to-buffer", Fpop_to_buffer, Spop_to_buffer, 1, 2, 0,
905 "Select buffer BUFFER in some window, preferably a different one.\n\
906 If BUFFER is nil, then some other buffer is chosen.\n\
907 If `pop-up-windows' is non-nil, windows can be split to do this.\n\
908 If optional second arg OTHER-WINDOW is non-nil, insist on finding another\n\
909 window even if BUFFER is already visible in the selected window.")
910 (bufname, other)
911 Lisp_Object bufname, other;
912 {
913 register Lisp_Object buf;
914 if (NILP (bufname))
915 buf = Fother_buffer (Fcurrent_buffer (), Qnil);
916 else
917 buf = Fget_buffer_create (bufname);
918 Fset_buffer (buf);
919 record_buffer (buf);
920 Fselect_window (Fdisplay_buffer (buf, other));
921 return buf;
922 }
923
924 DEFUN ("current-buffer", Fcurrent_buffer, Scurrent_buffer, 0, 0, 0,
925 "Return the current buffer as a Lisp object.")
926 ()
927 {
928 register Lisp_Object buf;
929 XSET (buf, Lisp_Buffer, current_buffer);
930 return buf;
931 }
932 \f
933 /* Set the current buffer to b */
934
935 void
936 set_buffer_internal (b)
937 register struct buffer *b;
938 {
939 register struct buffer *old_buf;
940 register Lisp_Object tail, valcontents;
941 enum Lisp_Type tem;
942
943 if (current_buffer == b)
944 return;
945
946 windows_or_buffers_changed = 1;
947 old_buf = current_buffer;
948 current_buffer = b;
949 last_known_column_point = -1; /* invalidate indentation cache */
950
951 /* Look down buffer's list of local Lisp variables
952 to find and update any that forward into C variables. */
953
954 for (tail = b->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
955 {
956 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
957 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
958 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
959 && (tem = XTYPE (XCONS (valcontents)->car),
960 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
961 || tem == Lisp_Objfwd)))
962 /* Just reference the variable
963 to cause it to become set for this buffer. */
964 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
965 }
966
967 /* Do the same with any others that were local to the previous buffer */
968
969 if (old_buf)
970 for (tail = old_buf->local_var_alist; !NILP (tail); tail = XCONS (tail)->cdr)
971 {
972 valcontents = XSYMBOL (XCONS (XCONS (tail)->car)->car)->value;
973 if ((XTYPE (valcontents) == Lisp_Buffer_Local_Value
974 || XTYPE (valcontents) == Lisp_Some_Buffer_Local_Value)
975 && (tem = XTYPE (XCONS (valcontents)->car),
976 (tem == Lisp_Boolfwd || tem == Lisp_Intfwd
977 || tem == Lisp_Objfwd)))
978 /* Just reference the variable
979 to cause it to become set for this buffer. */
980 Fsymbol_value (XCONS (XCONS (tail)->car)->car);
981 }
982 }
983
984 DEFUN ("set-buffer", Fset_buffer, Sset_buffer, 1, 1, 0,
985 "Make the buffer BUFFER current for editing operations.\n\
986 BUFFER may be a buffer or the name of an existing buffer.\n\
987 See also `save-excursion' when you want to make a buffer current temporarily.\n\
988 This function does not display the buffer, so its effect ends\n\
989 when the current command terminates.\n\
990 Use `switch-to-buffer' or `pop-to-buffer' to switch buffers permanently.")
991 (bufname)
992 register Lisp_Object bufname;
993 {
994 register Lisp_Object buffer;
995 buffer = Fget_buffer (bufname);
996 if (NILP (buffer))
997 nsberror (bufname);
998 if (NILP (XBUFFER (buffer)->name))
999 error ("Selecting deleted buffer");
1000 set_buffer_internal (XBUFFER (buffer));
1001 return buffer;
1002 }
1003 \f
1004 DEFUN ("barf-if-buffer-read-only", Fbarf_if_buffer_read_only,
1005 Sbarf_if_buffer_read_only, 0, 0, 0,
1006 "Signal a `buffer-read-only' error if the current buffer is read-only.")
1007 ()
1008 {
1009 if (!NILP (current_buffer->read_only)
1010 && NILP (Vinhibit_read_only))
1011 Fsignal (Qbuffer_read_only, (Fcons (Fcurrent_buffer (), Qnil)));
1012 return Qnil;
1013 }
1014
1015 DEFUN ("bury-buffer", Fbury_buffer, Sbury_buffer, 0, 1, "",
1016 "Put BUFFER at the end of the list of all buffers.\n\
1017 There it is the least likely candidate for `other-buffer' to return;\n\
1018 thus, the least likely buffer for \\[switch-to-buffer] to select by default.\n\
1019 If BUFFER is nil or omitted, bury the current buffer.\n\
1020 Also, if BUFFER is nil or omitted, remove the current buffer from the\n\
1021 selected window if it is displayed there.")
1022 (buf)
1023 register Lisp_Object buf;
1024 {
1025 /* Figure out what buffer we're going to bury. */
1026 if (NILP (buf))
1027 {
1028 XSET (buf, Lisp_Buffer, current_buffer);
1029
1030 /* If we're burying the current buffer, unshow it. */
1031 Fswitch_to_buffer (Fother_buffer (buf, Qnil), Qnil);
1032 }
1033 else
1034 {
1035 Lisp_Object buf1;
1036
1037 buf1 = Fget_buffer (buf);
1038 if (NILP (buf1))
1039 nsberror (buf);
1040 buf = buf1;
1041 }
1042
1043 /* Move buf to the end of the buffer list. */
1044 {
1045 register Lisp_Object aelt, link;
1046
1047 aelt = Frassq (buf, Vbuffer_alist);
1048 link = Fmemq (aelt, Vbuffer_alist);
1049 Vbuffer_alist = Fdelq (aelt, Vbuffer_alist);
1050 XCONS (link)->cdr = Qnil;
1051 Vbuffer_alist = nconc2 (Vbuffer_alist, link);
1052 }
1053
1054 return Qnil;
1055 }
1056 \f
1057 DEFUN ("erase-buffer", Ferase_buffer, Serase_buffer, 0, 0, "*",
1058 "Delete the entire contents of the current buffer.\n\
1059 Any narrowing restriction in effect (see `narrow-to-region') is removed,\n\
1060 so the buffer is truly empty after this.")
1061 ()
1062 {
1063 Fwiden ();
1064 del_range (BEG, Z);
1065 current_buffer->last_window_start = 1;
1066 /* Prevent warnings, or suspension of auto saving, that would happen
1067 if future size is less than past size. Use of erase-buffer
1068 implies that the future text is not really related to the past text. */
1069 XFASTINT (current_buffer->save_length) = 0;
1070 return Qnil;
1071 }
1072
1073 validate_region (b, e)
1074 register Lisp_Object *b, *e;
1075 {
1076 register int i;
1077
1078 CHECK_NUMBER_COERCE_MARKER (*b, 0);
1079 CHECK_NUMBER_COERCE_MARKER (*e, 1);
1080
1081 if (XINT (*b) > XINT (*e))
1082 {
1083 i = XFASTINT (*b); /* This is legit even if *b is < 0 */
1084 *b = *e;
1085 XFASTINT (*e) = i; /* because this is all we do with i. */
1086 }
1087
1088 if (!(BEGV <= XINT (*b) && XINT (*b) <= XINT (*e)
1089 && XINT (*e) <= ZV))
1090 args_out_of_range (*b, *e);
1091 }
1092 \f
1093 static Lisp_Object
1094 list_buffers_1 (files)
1095 Lisp_Object files;
1096 {
1097 register Lisp_Object tail, tem, buf;
1098 Lisp_Object col1, col2, col3, minspace;
1099 register struct buffer *old = current_buffer, *b;
1100 Lisp_Object desired_point;
1101 Lisp_Object other_file_symbol;
1102
1103 desired_point = Qnil;
1104 other_file_symbol = intern ("list-buffers-directory");
1105
1106 XFASTINT (col1) = 19;
1107 XFASTINT (col2) = 25;
1108 XFASTINT (col3) = 40;
1109 XFASTINT (minspace) = 1;
1110
1111 Fset_buffer (Vstandard_output);
1112 Fbuffer_disable_undo (Vstandard_output);
1113 current_buffer->read_only = Qnil;
1114
1115 write_string ("\
1116 MR Buffer Size Mode File\n\
1117 -- ------ ---- ---- ----\n", -1);
1118
1119 for (tail = Vbuffer_alist; !NILP (tail); tail = Fcdr (tail))
1120 {
1121 buf = Fcdr (Fcar (tail));
1122 b = XBUFFER (buf);
1123 /* Don't mention the minibuffers. */
1124 if (XSTRING (b->name)->data[0] == ' ')
1125 continue;
1126 /* Optionally don't mention buffers that lack files. */
1127 if (!NILP (files) && NILP (b->filename))
1128 continue;
1129 /* Identify the current buffer. */
1130 if (b == old)
1131 XFASTINT (desired_point) = point;
1132 write_string (b == old ? "." : " ", -1);
1133 /* Identify modified buffers */
1134 write_string (BUF_MODIFF (b) > b->save_modified ? "*" : " ", -1);
1135 write_string (NILP (b->read_only) ? " " : "% ", -1);
1136 Fprinc (b->name, Qnil);
1137 Findent_to (col1, make_number (2));
1138 XFASTINT (tem) = BUF_Z (b) - BUF_BEG (b);
1139 Fprin1 (tem, Qnil);
1140 Findent_to (col2, minspace);
1141 Fprinc (b->mode_name, Qnil);
1142 Findent_to (col3, minspace);
1143
1144 if (!NILP (b->filename))
1145 Fprinc (b->filename, Qnil);
1146 else
1147 {
1148 /* No visited file; check local value of list-buffers-directory. */
1149 Lisp_Object tem;
1150 set_buffer_internal (b);
1151 tem = Fboundp (other_file_symbol);
1152 if (!NILP (tem))
1153 {
1154 tem = Fsymbol_value (other_file_symbol);
1155 Fset_buffer (Vstandard_output);
1156 if (XTYPE (tem) == Lisp_String)
1157 Fprinc (tem, Qnil);
1158 }
1159 else
1160 Fset_buffer (Vstandard_output);
1161 }
1162 write_string ("\n", -1);
1163 }
1164
1165 tail = intern ("Buffer-menu-mode");
1166 if ((tem = Ffboundp (tail), !NILP (tem)))
1167 call0 (tail);
1168 set_buffer_internal (old);
1169 return desired_point;
1170 }
1171
1172 DEFUN ("list-buffers", Flist_buffers, Slist_buffers, 0, 1, "P",
1173 "Display a list of names of existing buffers.\n\
1174 The list is displayed in a buffer named `*Buffer List*'.\n\
1175 Note that buffers with names starting with spaces are omitted.\n\
1176 Non-null optional arg FILES-ONLY means mention only file buffers.\n\
1177 \n\
1178 The M column contains a * for buffers that are modified.\n\
1179 The R column contains a % for buffers that are read-only.")
1180 (files)
1181 Lisp_Object files;
1182 {
1183 Lisp_Object desired_point;
1184
1185 desired_point
1186 = internal_with_output_to_temp_buffer ("*Buffer List*",
1187 list_buffers_1, files);
1188
1189 if (NUMBERP (desired_point))
1190 {
1191 int count = specpdl_ptr - specpdl;
1192 record_unwind_protect (Fset_buffer, Fcurrent_buffer ());
1193 Fset_buffer (build_string ("*Buffer List*"));
1194 SET_PT (XINT (desired_point));
1195 return unbind_to (count, Qnil);
1196 }
1197 return Qnil;
1198 }
1199
1200 DEFUN ("kill-all-local-variables", Fkill_all_local_variables, Skill_all_local_variables,
1201 0, 0, 0,
1202 "Switch to Fundamental mode by killing current buffer's local variables.\n\
1203 Most local variable bindings are eliminated so that the default values\n\
1204 become effective once more. Also, the syntax table is set from\n\
1205 `standard-syntax-table', the local keymap is set to nil,\n\
1206 and the abbrev table from `fundamental-mode-abbrev-table'.\n\
1207 This function also forces redisplay of the mode line.\n\
1208 \n\
1209 Every function to select a new major mode starts by\n\
1210 calling this function.\n\n\
1211 As a special exception, local variables whose names have\n\
1212 a non-nil `permanent-local' property are not eliminated by this function.\n\
1213 \n\
1214 The first thing this function does is run\n\
1215 the normal hook `change-major-mode-hook'.")
1216 ()
1217 {
1218 register Lisp_Object alist, sym, tem;
1219 Lisp_Object oalist;
1220
1221 if (!NILP (Vrun_hooks))
1222 call1 (Vrun_hooks, intern ("change-major-mode-hook"));
1223 oalist = current_buffer->local_var_alist;
1224
1225 /* Make sure no local variables remain set up with this buffer
1226 for their current values. */
1227
1228 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1229 {
1230 sym = XCONS (XCONS (alist)->car)->car;
1231
1232 /* Need not do anything if some other buffer's binding is now encached. */
1233 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car;
1234 if (XBUFFER (tem) == current_buffer)
1235 {
1236 /* Symbol is set up for this buffer's old local value.
1237 Set it up for the current buffer with the default value. */
1238
1239 tem = XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->cdr;
1240 /* Store the symbol's current value into the alist entry
1241 it is currently set up for. This is so that, if the
1242 local is marked permanent, and we make it local again below,
1243 we don't lose the value. */
1244 XCONS (XCONS (tem)->car)->cdr
1245 = do_symval_forwarding (XCONS (XSYMBOL (sym)->value)->car);
1246 /* Switch to the symbol's default-value alist entry. */
1247 XCONS (tem)->car = tem;
1248 /* Mark it as current for the current buffer. */
1249 XCONS (XCONS (XSYMBOL (sym)->value)->cdr)->car = Fcurrent_buffer ();
1250 /* Store the current value into any forwarding in the symbol. */
1251 store_symval_forwarding (sym, XCONS (XSYMBOL (sym)->value)->car,
1252 XCONS (tem)->cdr);
1253 }
1254 }
1255
1256 /* Actually eliminate all local bindings of this buffer. */
1257
1258 reset_buffer_local_variables (current_buffer);
1259
1260 /* Redisplay mode lines; we are changing major mode. */
1261
1262 update_mode_lines++;
1263
1264 /* Any which are supposed to be permanent,
1265 make local again, with the same values they had. */
1266
1267 for (alist = oalist; !NILP (alist); alist = XCONS (alist)->cdr)
1268 {
1269 sym = XCONS (XCONS (alist)->car)->car;
1270 tem = Fget (sym, Qpermanent_local);
1271 if (! NILP (tem))
1272 {
1273 Fmake_local_variable (sym);
1274 Fset (sym, XCONS (XCONS (alist)->car)->cdr);
1275 }
1276 }
1277
1278 /* Force mode-line redisplay. Useful here because all major mode
1279 commands call this function. */
1280 update_mode_lines++;
1281
1282 return Qnil;
1283 }
1284 \f
1285 /* Find all the overlays in the current buffer that contain position POS.
1286 Return the number found, and store them in a vector in *VEC_PTR.
1287 Store in *LEN_PTR the size allocated for the vector.
1288 Store in *NEXT_PTR the next position after POS where an overlay starts,
1289 or ZV if there are no more overlays.
1290
1291 *VEC_PTR and *LEN_PTR should contain a valid vector and size
1292 when this function is called.
1293
1294 If EXTEND is non-zero, we make the vector bigger if necessary.
1295 If EXTEND is zero, we never extend the vector,
1296 and we store only as many overlays as will fit.
1297 But we still return the total number of overlays. */
1298
1299 int
1300 overlays_at (pos, extend, vec_ptr, len_ptr, next_ptr)
1301 int pos;
1302 int extend;
1303 Lisp_Object **vec_ptr;
1304 int *len_ptr;
1305 int *next_ptr;
1306 {
1307 Lisp_Object tail, overlay, start, end, result;
1308 int idx = 0;
1309 int len = *len_ptr;
1310 Lisp_Object *vec = *vec_ptr;
1311 int next = ZV;
1312 int inhibit_storing = 0;
1313
1314 for (tail = current_buffer->overlays_before;
1315 XGCTYPE (tail) == Lisp_Cons;
1316 tail = XCONS (tail)->cdr)
1317 {
1318 int startpos;
1319
1320 overlay = XCONS (tail)->car;
1321 if (XGCTYPE (overlay) != Lisp_Overlay)
1322 abort ();
1323
1324 start = OVERLAY_START (overlay);
1325 end = OVERLAY_END (overlay);
1326 if (OVERLAY_POSITION (end) <= pos)
1327 break;
1328 startpos = OVERLAY_POSITION (start);
1329 if (startpos <= pos)
1330 {
1331 if (idx == len)
1332 {
1333 /* The supplied vector is full.
1334 Either make it bigger, or don't store any more in it. */
1335 if (extend)
1336 {
1337 *len_ptr = len *= 2;
1338 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1339 *vec_ptr = vec;
1340 }
1341 else
1342 inhibit_storing = 1;
1343 }
1344
1345 if (!inhibit_storing)
1346 vec[idx] = overlay;
1347 /* Keep counting overlays even if we can't return them all. */
1348 idx++;
1349 }
1350 else if (startpos < next)
1351 next = startpos;
1352 }
1353
1354 for (tail = current_buffer->overlays_after;
1355 XGCTYPE (tail) == Lisp_Cons;
1356 tail = XCONS (tail)->cdr)
1357 {
1358 int startpos;
1359
1360 overlay = XCONS (tail)->car;
1361 if (XGCTYPE (overlay) != Lisp_Overlay)
1362 abort ();
1363
1364 start = OVERLAY_START (overlay);
1365 end = OVERLAY_END (overlay);
1366 startpos = OVERLAY_POSITION (start);
1367 if (pos < startpos)
1368 {
1369 if (startpos < next)
1370 next = startpos;
1371 break;
1372 }
1373 if (pos < OVERLAY_POSITION (end))
1374 {
1375 if (idx == len)
1376 {
1377 if (extend)
1378 {
1379 *len_ptr = len *= 2;
1380 vec = (Lisp_Object *) xrealloc (vec, len * sizeof (Lisp_Object));
1381 *vec_ptr = vec;
1382 }
1383 else
1384 inhibit_storing = 1;
1385 }
1386
1387 if (!inhibit_storing)
1388 vec[idx] = overlay;
1389 idx++;
1390 }
1391 }
1392
1393 *next_ptr = next;
1394 return idx;
1395 }
1396 \f
1397 struct sortvec
1398 {
1399 Lisp_Object overlay;
1400 int beg, end;
1401 int priority;
1402 };
1403
1404 static int
1405 compare_overlays (s1, s2)
1406 struct sortvec *s1, *s2;
1407 {
1408 if (s1->priority != s2->priority)
1409 return s1->priority - s2->priority;
1410 if (s1->beg != s2->beg)
1411 return s1->beg - s2->beg;
1412 if (s1->end != s2->end)
1413 return s2->end - s1->end;
1414 return 0;
1415 }
1416
1417 /* Sort an array of overlays by priority. The array is modified in place.
1418 The return value is the new size; this may be smaller than the original
1419 size if some of the overlays were invalid or were window-specific. */
1420 int
1421 sort_overlays (overlay_vec, noverlays, w)
1422 Lisp_Object *overlay_vec;
1423 int noverlays;
1424 struct window *w;
1425 {
1426 int i, j;
1427 struct sortvec *sortvec;
1428 sortvec = (struct sortvec *) alloca (noverlays * sizeof (struct sortvec));
1429
1430 /* Put the valid and relevant overlays into sortvec. */
1431
1432 for (i = 0, j = 0; i < noverlays; i++)
1433 {
1434 Lisp_Object tem;
1435 Lisp_Object overlay;
1436
1437 overlay = overlay_vec[i];
1438 if (OVERLAY_VALID (overlay)
1439 && OVERLAY_POSITION (OVERLAY_START (overlay)) > 0
1440 && OVERLAY_POSITION (OVERLAY_END (overlay)) > 0)
1441 {
1442 /* If we're interested in a specific window, then ignore
1443 overlays that are limited to some other window. */
1444 if (w)
1445 {
1446 Lisp_Object window;
1447
1448 window = Foverlay_get (overlay, Qwindow);
1449 if (XTYPE (window) == Lisp_Window && XWINDOW (window) != w)
1450 continue;
1451 }
1452
1453 /* This overlay is good and counts: put it into sortvec. */
1454 sortvec[j].overlay = overlay;
1455 sortvec[j].beg = OVERLAY_POSITION (OVERLAY_START (overlay));
1456 sortvec[j].end = OVERLAY_POSITION (OVERLAY_END (overlay));
1457 tem = Foverlay_get (overlay, Qpriority);
1458 if (INTEGERP (tem))
1459 sortvec[j].priority = XINT (tem);
1460 else
1461 sortvec[j].priority = 0;
1462 j++;
1463 }
1464 }
1465 noverlays = j;
1466
1467 /* Sort the overlays into the proper order: increasing priority. */
1468
1469 if (noverlays > 1)
1470 qsort (sortvec, noverlays, sizeof (struct sortvec), compare_overlays);
1471
1472 for (i = 0; i < noverlays; i++)
1473 overlay_vec[i] = sortvec[i].overlay;
1474 return (noverlays);
1475 }
1476 \f
1477 /* Shift overlays in BUF's overlay lists, to center the lists at POS. */
1478
1479 void
1480 recenter_overlay_lists (buf, pos)
1481 struct buffer *buf;
1482 int pos;
1483 {
1484 Lisp_Object overlay, tail, next, prev, beg, end;
1485
1486 /* See if anything in overlays_before should move to overlays_after. */
1487
1488 /* We don't strictly need prev in this loop; it should always be nil.
1489 But we use it for symmetry and in case that should cease to be true
1490 with some future change. */
1491 prev = Qnil;
1492 for (tail = buf->overlays_before;
1493 CONSP (tail);
1494 prev = tail, tail = next)
1495 {
1496 next = XCONS (tail)->cdr;
1497 overlay = XCONS (tail)->car;
1498
1499 /* If the overlay is not valid, get rid of it. */
1500 if (!OVERLAY_VALID (overlay))
1501 #if 1
1502 abort ();
1503 #else
1504 {
1505 /* Splice the cons cell TAIL out of overlays_before. */
1506 if (!NILP (prev))
1507 XCONS (prev)->cdr = next;
1508 else
1509 buf->overlays_before = next;
1510 tail = prev;
1511 continue;
1512 }
1513 #endif
1514
1515 beg = OVERLAY_START (overlay);
1516 end = OVERLAY_END (overlay);
1517
1518 if (OVERLAY_POSITION (end) > pos)
1519 {
1520 /* OVERLAY needs to be moved. */
1521 int where = OVERLAY_POSITION (beg);
1522 Lisp_Object other, other_prev;
1523
1524 /* Splice the cons cell TAIL out of overlays_before. */
1525 if (!NILP (prev))
1526 XCONS (prev)->cdr = next;
1527 else
1528 buf->overlays_before = next;
1529
1530 /* Search thru overlays_after for where to put it. */
1531 other_prev = Qnil;
1532 for (other = buf->overlays_after;
1533 CONSP (other);
1534 other_prev = other, other = XCONS (other)->cdr)
1535 {
1536 Lisp_Object otherbeg, otheroverlay, follower;
1537 int win;
1538
1539 otheroverlay = XCONS (other)->car;
1540 if (! OVERLAY_VALID (otheroverlay))
1541 abort ();
1542
1543 otherbeg = OVERLAY_START (otheroverlay);
1544 if (OVERLAY_POSITION (otherbeg) >= where)
1545 break;
1546 }
1547
1548 /* Add TAIL to overlays_after before OTHER. */
1549 XCONS (tail)->cdr = other;
1550 if (!NILP (other_prev))
1551 XCONS (other_prev)->cdr = tail;
1552 else
1553 buf->overlays_after = tail;
1554 tail = prev;
1555 }
1556 else
1557 /* We've reached the things that should stay in overlays_before.
1558 All the rest of overlays_before must end even earlier,
1559 so stop now. */
1560 break;
1561 }
1562
1563 /* See if anything in overlays_after should be in overlays_before. */
1564 prev = Qnil;
1565 for (tail = buf->overlays_after;
1566 CONSP (tail);
1567 prev = tail, tail = next)
1568 {
1569 next = XCONS (tail)->cdr;
1570 overlay = XCONS (tail)->car;
1571
1572 /* If the overlay is not valid, get rid of it. */
1573 if (!OVERLAY_VALID (overlay))
1574 #if 1
1575 abort ();
1576 #else
1577 {
1578 /* Splice the cons cell TAIL out of overlays_after. */
1579 if (!NILP (prev))
1580 XCONS (prev)->cdr = next;
1581 else
1582 buf->overlays_after = next;
1583 tail = prev;
1584 continue;
1585 }
1586 #endif
1587
1588 beg = OVERLAY_START (overlay);
1589 end = OVERLAY_END (overlay);
1590
1591 /* Stop looking, when we know that nothing further
1592 can possibly end before POS. */
1593 if (OVERLAY_POSITION (beg) > pos)
1594 break;
1595
1596 if (OVERLAY_POSITION (end) <= pos)
1597 {
1598 /* OVERLAY needs to be moved. */
1599 int where = OVERLAY_POSITION (end);
1600 Lisp_Object other, other_prev;
1601
1602 /* Splice the cons cell TAIL out of overlays_after. */
1603 if (!NILP (prev))
1604 XCONS (prev)->cdr = next;
1605 else
1606 buf->overlays_after = next;
1607
1608 /* Search thru overlays_before for where to put it. */
1609 other_prev = Qnil;
1610 for (other = buf->overlays_before;
1611 CONSP (other);
1612 other_prev = other, other = XCONS (other)->cdr)
1613 {
1614 Lisp_Object otherend, otheroverlay;
1615 int win;
1616
1617 otheroverlay = XCONS (other)->car;
1618 if (! OVERLAY_VALID (otheroverlay))
1619 abort ();
1620
1621 otherend = OVERLAY_END (otheroverlay);
1622 if (OVERLAY_POSITION (otherend) <= where)
1623 break;
1624 }
1625
1626 /* Add TAIL to overlays_before before OTHER. */
1627 XCONS (tail)->cdr = other;
1628 if (!NILP (other_prev))
1629 XCONS (other_prev)->cdr = tail;
1630 else
1631 buf->overlays_before = tail;
1632 tail = prev;
1633 }
1634 }
1635
1636 XFASTINT (buf->overlay_center) = pos;
1637 }
1638
1639 /* Fix up overlays that were garbled as a result of permuting markers
1640 in the range START through END. Any overlay with at least one
1641 endpoint in this range will need to be unlinked from the overlay
1642 list and reinserted in its proper place.
1643 Such an overlay might even have negative size at this point.
1644 If so, we'll reverse the endpoints. Can you think of anything
1645 better to do in this situation? */
1646 void
1647 fix_overlays_in_range (start, end)
1648 register int start, end;
1649 {
1650 Lisp_Object tem, overlay;
1651 Lisp_Object before_list, after_list;
1652 Lisp_Object *ptail, *pbefore = &before_list, *pafter = &after_list;
1653 int startpos, endpos;
1654
1655 /* This algorithm shifts links around instead of consing and GCing.
1656 The loop invariant is that before_list (resp. after_list) is a
1657 well-formed list except that its last element, the one that
1658 *pbefore (resp. *pafter) points to, is still uninitialized.
1659 So it's not a bug that before_list isn't initialized, although
1660 it may look strange. */
1661 for (ptail = &current_buffer->overlays_before; CONSP (*ptail);)
1662 {
1663 overlay = XCONS (*ptail)->car;
1664 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1665 if (endpos < start)
1666 break;
1667 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1668 if (endpos < end
1669 || (startpos >= start && startpos < end))
1670 {
1671 /* If the overlay is backwards, fix that now. */
1672 if (startpos > endpos)
1673 {
1674 int tem;
1675 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1676 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1677 tem = startpos; startpos = endpos; endpos = tem;
1678 }
1679 /* Add it to the end of the wrong list. Later on,
1680 recenter_overlay_lists will move it to the right place. */
1681 if (endpos < XINT (current_buffer->overlay_center))
1682 {
1683 *pafter = *ptail;
1684 pafter = &XCONS (*ptail)->cdr;
1685 }
1686 else
1687 {
1688 *pbefore = *ptail;
1689 pbefore = &XCONS (*ptail)->cdr;
1690 }
1691 *ptail = XCONS (*ptail)->cdr;
1692 }
1693 else
1694 ptail = &XCONS (*ptail)->cdr;
1695 }
1696 for (ptail = &current_buffer->overlays_after; CONSP (*ptail);)
1697 {
1698 overlay = XCONS (*ptail)->car;
1699 startpos = OVERLAY_POSITION (OVERLAY_START (overlay));
1700 if (startpos >= end)
1701 break;
1702 endpos = OVERLAY_POSITION (OVERLAY_END (overlay));
1703 if (startpos >= start
1704 || (endpos >= start && endpos < end))
1705 {
1706 if (startpos > endpos)
1707 {
1708 int tem;
1709 Fset_marker (OVERLAY_START (overlay), endpos, Qnil);
1710 Fset_marker (OVERLAY_END (overlay), startpos, Qnil);
1711 tem = startpos; startpos = endpos; endpos = tem;
1712 }
1713 if (endpos < XINT (current_buffer->overlay_center))
1714 {
1715 *pafter = *ptail;
1716 pafter = &XCONS (*ptail)->cdr;
1717 }
1718 else
1719 {
1720 *pbefore = *ptail;
1721 pbefore = &XCONS (*ptail)->cdr;
1722 }
1723 *ptail = XCONS (*ptail)->cdr;
1724 }
1725 else
1726 ptail = &XCONS (*ptail)->cdr;
1727 }
1728
1729 /* Splice the constructed (wrong) lists into the buffer's lists,
1730 and let the recenter function make it sane again. */
1731 *pbefore = current_buffer->overlays_before;
1732 current_buffer->overlays_before = before_list;
1733 recenter_overlay_lists (current_buffer,
1734 XINT (current_buffer->overlay_center));
1735
1736 *pafter = current_buffer->overlays_after;
1737 current_buffer->overlays_after = after_list;
1738 recenter_overlay_lists (current_buffer,
1739 XINT (current_buffer->overlay_center));
1740 }
1741 \f
1742 DEFUN ("overlayp", Foverlayp, Soverlayp, 1, 1, 0,
1743 "Return t if OBJECT is an overlay.")
1744 (object)
1745 Lisp_Object object;
1746 {
1747 return (OVERLAYP (object) ? Qt : Qnil);
1748 }
1749
1750 DEFUN ("make-overlay", Fmake_overlay, Smake_overlay, 2, 3, 0,
1751 "Create a new overlay with range BEG to END in BUFFER.\n\
1752 If omitted, BUFFER defaults to the current buffer.\n\
1753 BEG and END may be integers or markers.")
1754 (beg, end, buffer)
1755 Lisp_Object beg, end, buffer;
1756 {
1757 Lisp_Object overlay;
1758 struct buffer *b;
1759
1760 if (NILP (buffer))
1761 XSET (buffer, Lisp_Buffer, current_buffer);
1762 else
1763 CHECK_BUFFER (buffer, 2);
1764 if (MARKERP (beg)
1765 && ! EQ (Fmarker_buffer (beg), buffer))
1766 error ("Marker points into wrong buffer");
1767 if (MARKERP (end)
1768 && ! EQ (Fmarker_buffer (end), buffer))
1769 error ("Marker points into wrong buffer");
1770
1771 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1772 CHECK_NUMBER_COERCE_MARKER (end, 1);
1773
1774 if (XINT (beg) > XINT (end))
1775 {
1776 Lisp_Object temp;
1777 temp = beg; beg = end; end = temp;
1778 }
1779
1780 b = XBUFFER (buffer);
1781
1782 beg = Fset_marker (Fmake_marker (), beg, buffer);
1783 end = Fset_marker (Fmake_marker (), end, buffer);
1784
1785 overlay = Fcons (Fcons (beg, end), Qnil);
1786 XSETTYPE (overlay, Lisp_Overlay);
1787
1788 /* Put the new overlay on the wrong list. */
1789 end = OVERLAY_END (overlay);
1790 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1791 b->overlays_after = Fcons (overlay, b->overlays_after);
1792 else
1793 b->overlays_before = Fcons (overlay, b->overlays_before);
1794
1795 /* This puts it in the right list, and in the right order. */
1796 recenter_overlay_lists (b, XINT (b->overlay_center));
1797
1798 /* We don't need to redisplay the region covered by the overlay, because
1799 the overlay has no properties at the moment. */
1800
1801 return overlay;
1802 }
1803
1804 DEFUN ("move-overlay", Fmove_overlay, Smove_overlay, 3, 4, 0,
1805 "Set the endpoints of OVERLAY to BEG and END in BUFFER.\n\
1806 If BUFFER is omitted, leave OVERLAY in the same buffer it inhabits now.\n\
1807 If BUFFER is omitted, and OVERLAY is in no buffer, put it in the current\n\
1808 buffer.")
1809 (overlay, beg, end, buffer)
1810 Lisp_Object overlay, beg, end, buffer;
1811 {
1812 struct buffer *b, *ob;
1813 Lisp_Object obuffer;
1814 int count = specpdl_ptr - specpdl;
1815
1816 CHECK_OVERLAY (overlay, 0);
1817 if (NILP (buffer))
1818 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1819 if (NILP (buffer))
1820 XSET (buffer, Lisp_Buffer, current_buffer);
1821 CHECK_BUFFER (buffer, 3);
1822
1823 if (MARKERP (beg)
1824 && ! EQ (Fmarker_buffer (beg), buffer))
1825 error ("Marker points into wrong buffer");
1826 if (MARKERP (end)
1827 && ! EQ (Fmarker_buffer (end), buffer))
1828 error ("Marker points into wrong buffer");
1829
1830 CHECK_NUMBER_COERCE_MARKER (beg, 1);
1831 CHECK_NUMBER_COERCE_MARKER (end, 1);
1832
1833 specbind (Qinhibit_quit, Qt);
1834
1835 if (XINT (beg) > XINT (end))
1836 {
1837 Lisp_Object temp;
1838 temp = beg; beg = end; end = temp;
1839 }
1840
1841 obuffer = Fmarker_buffer (OVERLAY_START (overlay));
1842 b = XBUFFER (buffer);
1843 ob = XBUFFER (obuffer);
1844
1845 /* If the overlay has changed buffers, do a thorough redisplay. */
1846 if (!EQ (buffer, obuffer))
1847 windows_or_buffers_changed = 1;
1848 else
1849 /* Redisplay the area the overlay has just left, or just enclosed. */
1850 {
1851 Lisp_Object o_beg;
1852 Lisp_Object o_end;
1853 int change_beg, change_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 if (XINT (o_beg) == XINT (beg))
1861 redisplay_region (b, XINT (o_end), XINT (end));
1862 else if (XINT (o_end) == XINT (end))
1863 redisplay_region (b, XINT (o_beg), XINT (beg));
1864 else
1865 {
1866 if (XINT (beg) < XINT (o_beg)) o_beg = beg;
1867 if (XINT (end) > XINT (o_end)) o_end = end;
1868 redisplay_region (b, XINT (o_beg), XINT (o_end));
1869 }
1870 }
1871
1872 if (!NILP (obuffer))
1873 {
1874 ob->overlays_before = Fdelq (overlay, ob->overlays_before);
1875 ob->overlays_after = Fdelq (overlay, ob->overlays_after);
1876 }
1877
1878 Fset_marker (OVERLAY_START (overlay), beg, buffer);
1879 Fset_marker (OVERLAY_END (overlay), end, buffer);
1880
1881 /* Put the overlay on the wrong list. */
1882 end = OVERLAY_END (overlay);
1883 if (OVERLAY_POSITION (end) < XINT (b->overlay_center))
1884 b->overlays_after = Fcons (overlay, b->overlays_after);
1885 else
1886 b->overlays_before = Fcons (overlay, b->overlays_before);
1887
1888 /* This puts it in the right list, and in the right order. */
1889 recenter_overlay_lists (b, XINT (b->overlay_center));
1890
1891 return unbind_to (count, overlay);
1892 }
1893
1894 DEFUN ("delete-overlay", Fdelete_overlay, Sdelete_overlay, 1, 1, 0,
1895 "Delete the overlay OVERLAY from its buffer.")
1896 (overlay)
1897 Lisp_Object overlay;
1898 {
1899 Lisp_Object buffer;
1900 struct buffer *b;
1901 int count = specpdl_ptr - specpdl;
1902
1903 CHECK_OVERLAY (overlay, 0);
1904
1905 buffer = Fmarker_buffer (OVERLAY_START (overlay));
1906 if (NILP (buffer))
1907 return Qnil;
1908
1909 b = XBUFFER (buffer);
1910
1911 specbind (Qinhibit_quit, Qt);
1912
1913 b->overlays_before = Fdelq (overlay, b->overlays_before);
1914 b->overlays_after = Fdelq (overlay, b->overlays_after);
1915
1916 redisplay_region (b,
1917 marker_position (OVERLAY_START (overlay)),
1918 marker_position (OVERLAY_END (overlay)));
1919
1920 Fset_marker (OVERLAY_START (overlay), Qnil, Qnil);
1921 Fset_marker (OVERLAY_END (overlay), Qnil, Qnil);
1922
1923 return unbind_to (count, Qnil);
1924 }
1925 \f
1926 /* Overlay dissection functions. */
1927
1928 DEFUN ("overlay-start", Foverlay_start, Soverlay_start, 1, 1, 0,
1929 "Return the position at which OVERLAY starts.")
1930 (overlay)
1931 Lisp_Object overlay;
1932 {
1933 CHECK_OVERLAY (overlay, 0);
1934
1935 return (Fmarker_position (OVERLAY_START (overlay)));
1936 }
1937
1938 DEFUN ("overlay-end", Foverlay_end, Soverlay_end, 1, 1, 0,
1939 "Return the position at which OVERLAY ends.")
1940 (overlay)
1941 Lisp_Object overlay;
1942 {
1943 CHECK_OVERLAY (overlay, 0);
1944
1945 return (Fmarker_position (OVERLAY_END (overlay)));
1946 }
1947
1948 DEFUN ("overlay-buffer", Foverlay_buffer, Soverlay_buffer, 1, 1, 0,
1949 "Return the buffer OVERLAY belongs to.")
1950 (overlay)
1951 Lisp_Object overlay;
1952 {
1953 CHECK_OVERLAY (overlay, 0);
1954
1955 return Fmarker_buffer (OVERLAY_START (overlay));
1956 }
1957
1958 DEFUN ("overlay-properties", Foverlay_properties, Soverlay_properties, 1, 1, 0,
1959 "Return a list of the properties on OVERLAY.\n\
1960 This is a copy of OVERLAY's plist; modifying its conses has no effect on\n\
1961 OVERLAY.")
1962 (overlay)
1963 Lisp_Object overlay;
1964 {
1965 CHECK_OVERLAY (overlay, 0);
1966
1967 return Fcopy_sequence (Fcdr_safe (XCONS (overlay)->cdr));
1968 }
1969
1970 \f
1971 DEFUN ("overlays-at", Foverlays_at, Soverlays_at, 1, 1, 0,
1972 "Return a list of the overlays that contain position POS.")
1973 (pos)
1974 Lisp_Object pos;
1975 {
1976 int noverlays;
1977 int endpos;
1978 Lisp_Object *overlay_vec;
1979 int len;
1980 Lisp_Object result;
1981
1982 CHECK_NUMBER_COERCE_MARKER (pos, 0);
1983
1984 len = 10;
1985 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
1986
1987 /* Put all the overlays we want in a vector in overlay_vec.
1988 Store the length in len. */
1989 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, &endpos);
1990
1991 /* Make a list of them all. */
1992 result = Flist (noverlays, overlay_vec);
1993
1994 xfree (overlay_vec);
1995 return result;
1996 }
1997
1998 DEFUN ("next-overlay-change", Fnext_overlay_change, Snext_overlay_change,
1999 1, 1, 0,
2000 "Return the next position after POS where an overlay starts or ends.\n\
2001 If there are no more overlay boundaries after POS, return (point-max).")
2002 (pos)
2003 Lisp_Object pos;
2004 {
2005 int noverlays;
2006 int endpos;
2007 Lisp_Object *overlay_vec;
2008 int len;
2009 Lisp_Object result;
2010 int i;
2011
2012 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2013
2014 len = 10;
2015 overlay_vec = (Lisp_Object *) xmalloc (len * sizeof (Lisp_Object));
2016
2017 /* Put all the overlays we want in a vector in overlay_vec.
2018 Store the length in len.
2019 endpos gets the position where the next overlay starts. */
2020 noverlays = overlays_at (XINT (pos), 1, &overlay_vec, &len, &endpos);
2021
2022 /* If any of these overlays ends before endpos,
2023 use its ending point instead. */
2024 for (i = 0; i < noverlays; i++)
2025 {
2026 Lisp_Object oend;
2027 int oendpos;
2028
2029 oend = OVERLAY_END (overlay_vec[i]);
2030 oendpos = OVERLAY_POSITION (oend);
2031 if (oendpos < endpos)
2032 endpos = oendpos;
2033 }
2034
2035 xfree (overlay_vec);
2036 return make_number (endpos);
2037 }
2038 \f
2039 /* These functions are for debugging overlays. */
2040
2041 DEFUN ("overlay-lists", Foverlay_lists, Soverlay_lists, 0, 0, 0,
2042 "Return a pair of lists giving all the overlays of the current buffer.\n\
2043 The car has all the overlays before the overlay center;\n\
2044 the cdr has all the overlays after the overlay center.\n\
2045 Recentering overlays moves overlays between these lists.\n\
2046 The lists you get are copies, so that changing them has no effect.\n\
2047 However, the overlays you get are the real objects that the buffer uses.")
2048 ()
2049 {
2050 Lisp_Object before, after;
2051 before = current_buffer->overlays_before;
2052 if (CONSP (before))
2053 before = Fcopy_sequence (before);
2054 after = current_buffer->overlays_after;
2055 if (CONSP (after))
2056 after = Fcopy_sequence (after);
2057
2058 return Fcons (before, after);
2059 }
2060
2061 DEFUN ("overlay-recenter", Foverlay_recenter, Soverlay_recenter, 1, 1, 0,
2062 "Recenter the overlays of the current buffer around position POS.")
2063 (pos)
2064 Lisp_Object pos;
2065 {
2066 CHECK_NUMBER_COERCE_MARKER (pos, 0);
2067
2068 recenter_overlay_lists (current_buffer, XINT (pos));
2069 return Qnil;
2070 }
2071 \f
2072 DEFUN ("overlay-get", Foverlay_get, Soverlay_get, 2, 2, 0,
2073 "Get the property of overlay OVERLAY with property name NAME.")
2074 (overlay, prop)
2075 Lisp_Object overlay, prop;
2076 {
2077 Lisp_Object plist;
2078
2079 CHECK_OVERLAY (overlay, 0);
2080
2081 for (plist = Fcdr_safe (XCONS (overlay)->cdr);
2082 CONSP (plist) && CONSP (XCONS (plist)->cdr);
2083 plist = XCONS (XCONS (plist)->cdr)->cdr)
2084 {
2085 if (EQ (XCONS (plist)->car, prop))
2086 return XCONS (XCONS (plist)->cdr)->car;
2087 }
2088
2089 return Qnil;
2090 }
2091
2092 DEFUN ("overlay-put", Foverlay_put, Soverlay_put, 3, 3, 0,
2093 "Set one property of overlay OVERLAY: give property PROP value VALUE.")
2094 (overlay, prop, value)
2095 Lisp_Object overlay, prop, value;
2096 {
2097 Lisp_Object plist, tail;
2098
2099 CHECK_OVERLAY (overlay, 0);
2100
2101 tail = Fmarker_buffer (OVERLAY_START (overlay));
2102 if (! NILP (tail))
2103 redisplay_region (XMARKER (OVERLAY_START (overlay))->buffer,
2104 marker_position (OVERLAY_START (overlay)),
2105 marker_position (OVERLAY_END (overlay)));
2106
2107 plist = Fcdr_safe (XCONS (overlay)->cdr);
2108
2109 for (tail = plist;
2110 CONSP (tail) && CONSP (XCONS (tail)->cdr);
2111 tail = XCONS (XCONS (tail)->cdr)->cdr)
2112 {
2113 if (EQ (XCONS (tail)->car, prop))
2114 return XCONS (XCONS (tail)->cdr)->car = value;
2115 }
2116
2117 if (! CONSP (XCONS (overlay)->cdr))
2118 XCONS (overlay)->cdr = Fcons (Qnil, Qnil);
2119
2120 XCONS (XCONS (overlay)->cdr)->cdr
2121 = Fcons (prop, Fcons (value, plist));
2122
2123 return value;
2124 }
2125 \f
2126 /* Run the modification-hooks of overlays that include
2127 any part of the text in START to END.
2128 Run the insert-before-hooks of overlay starting at END,
2129 and the insert-after-hooks of overlay ending at START. */
2130
2131 void
2132 verify_overlay_modification (start, end)
2133 Lisp_Object start, end;
2134 {
2135 Lisp_Object prop, overlay, tail;
2136 int insertion = EQ (start, end);
2137 int tail_copied;
2138 struct gcpro gcpro1, gcpro2;
2139
2140 overlay = Qnil;
2141 tail = Qnil;
2142 GCPRO2 (overlay, tail);
2143
2144 tail_copied = 0;
2145 for (tail = current_buffer->overlays_before;
2146 CONSP (tail);
2147 tail = XCONS (tail)->cdr)
2148 {
2149 int startpos, endpos;
2150 Lisp_Object ostart, oend;
2151
2152 overlay = XCONS (tail)->car;
2153
2154 ostart = OVERLAY_START (overlay);
2155 oend = OVERLAY_END (overlay);
2156 endpos = OVERLAY_POSITION (oend);
2157 if (XFASTINT (start) > endpos)
2158 break;
2159 startpos = OVERLAY_POSITION (ostart);
2160 if (XFASTINT (end) == startpos && insertion)
2161 {
2162 prop = Foverlay_get (overlay, Qinsert_in_front_hooks);
2163 if (!NILP (prop))
2164 {
2165 /* Copy TAIL in case the hook recenters the overlay lists. */
2166 if (!tail_copied)
2167 tail = Fcopy_sequence (tail);
2168 tail_copied = 1;
2169 call_overlay_mod_hooks (prop, overlay, start, end);
2170 }
2171 }
2172 if (XFASTINT (start) == endpos && insertion)
2173 {
2174 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2175 if (!NILP (prop))
2176 {
2177 if (!tail_copied)
2178 tail = Fcopy_sequence (tail);
2179 tail_copied = 1;
2180 call_overlay_mod_hooks (prop, overlay, start, end);
2181 }
2182 }
2183 /* Test for intersecting intervals. This does the right thing
2184 for both insertion and deletion. */
2185 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2186 {
2187 prop = Foverlay_get (overlay, Qmodification_hooks);
2188 if (!NILP (prop))
2189 {
2190 if (!tail_copied)
2191 tail = Fcopy_sequence (tail);
2192 tail_copied = 1;
2193 call_overlay_mod_hooks (prop, overlay, start, end);
2194 }
2195 }
2196 }
2197
2198 tail_copied = 0;
2199 for (tail = current_buffer->overlays_after;
2200 CONSP (tail);
2201 tail = XCONS (tail)->cdr)
2202 {
2203 int startpos, endpos;
2204 Lisp_Object ostart, oend;
2205
2206 overlay = XCONS (tail)->car;
2207
2208 ostart = OVERLAY_START (overlay);
2209 oend = OVERLAY_END (overlay);
2210 startpos = OVERLAY_POSITION (ostart);
2211 endpos = OVERLAY_POSITION (oend);
2212 if (XFASTINT (end) < startpos)
2213 break;
2214 if (XFASTINT (end) == startpos && insertion)
2215 {
2216 prop = Foverlay_get (overlay, Qinsert_in_front_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 if (XFASTINT (start) == endpos && insertion)
2226 {
2227 prop = Foverlay_get (overlay, Qinsert_behind_hooks);
2228 if (!NILP (prop))
2229 {
2230 if (!tail_copied)
2231 tail = Fcopy_sequence (tail);
2232 tail_copied = 1;
2233 call_overlay_mod_hooks (prop, overlay, start, end);
2234 }
2235 }
2236 /* Test for intersecting intervals. This does the right thing
2237 for both insertion and deletion. */
2238 if (XFASTINT (end) > startpos && XFASTINT (start) < endpos)
2239 {
2240 prop = Foverlay_get (overlay, Qmodification_hooks);
2241 if (!NILP (prop))
2242 {
2243 if (!tail_copied)
2244 tail = Fcopy_sequence (tail);
2245 tail_copied = 1;
2246 call_overlay_mod_hooks (prop, overlay, start, end);
2247 }
2248 }
2249 }
2250
2251 UNGCPRO;
2252 }
2253
2254 static void
2255 call_overlay_mod_hooks (list, overlay, start, end)
2256 Lisp_Object list, overlay, start, end;
2257 {
2258 struct gcpro gcpro1;
2259 GCPRO1 (list);
2260 while (!NILP (list))
2261 {
2262 call3 (Fcar (list), overlay, start, end);
2263 list = Fcdr (list);
2264 }
2265 UNGCPRO;
2266 }
2267 \f
2268 /* Somebody has tried to store NEWVAL into the buffer-local slot with
2269 offset XUINT (valcontents), and NEWVAL has an unacceptable type. */
2270 void
2271 buffer_slot_type_mismatch (valcontents, newval)
2272 Lisp_Object valcontents, newval;
2273 {
2274 unsigned int offset = XUINT (valcontents);
2275 unsigned char *symbol_name =
2276 (XSYMBOL (*(Lisp_Object *)(offset + (char *)&buffer_local_symbols))
2277 ->name->data);
2278 char *type_name;
2279
2280 switch (XINT (*(Lisp_Object *)(offset + (char *)&buffer_local_types)))
2281 {
2282 case Lisp_Int: type_name = "integers"; break;
2283 case Lisp_String: type_name = "strings"; break;
2284 case Lisp_Marker: type_name = "markers"; break;
2285 case Lisp_Symbol: type_name = "symbols"; break;
2286 case Lisp_Cons: type_name = "lists"; break;
2287 case Lisp_Vector: type_name = "vectors"; break;
2288 default:
2289 abort ();
2290 }
2291
2292 error ("only %s should be stored in the buffer-local variable %s",
2293 type_name, symbol_name);
2294 }
2295 \f
2296 init_buffer_once ()
2297 {
2298 register Lisp_Object tem;
2299
2300 /* Make sure all markable slots in buffer_defaults
2301 are initialized reasonably, so mark_buffer won't choke. */
2302 reset_buffer (&buffer_defaults);
2303 reset_buffer (&buffer_local_symbols);
2304 XSET (Vbuffer_defaults, Lisp_Buffer, &buffer_defaults);
2305 XSET (Vbuffer_local_symbols, Lisp_Buffer, &buffer_local_symbols);
2306
2307 /* Set up the default values of various buffer slots. */
2308 /* Must do these before making the first buffer! */
2309
2310 /* real setup is done in loaddefs.el */
2311 buffer_defaults.mode_line_format = build_string ("%-");
2312 buffer_defaults.abbrev_mode = Qnil;
2313 buffer_defaults.overwrite_mode = Qnil;
2314 buffer_defaults.case_fold_search = Qt;
2315 buffer_defaults.auto_fill_function = Qnil;
2316 buffer_defaults.selective_display = Qnil;
2317 #ifndef old
2318 buffer_defaults.selective_display_ellipses = Qt;
2319 #endif
2320 buffer_defaults.abbrev_table = Qnil;
2321 buffer_defaults.display_table = Qnil;
2322 buffer_defaults.undo_list = Qnil;
2323 buffer_defaults.mark_active = Qnil;
2324 buffer_defaults.overlays_before = Qnil;
2325 buffer_defaults.overlays_after = Qnil;
2326 XFASTINT (buffer_defaults.overlay_center) = 1;
2327
2328 XFASTINT (buffer_defaults.tab_width) = 8;
2329 buffer_defaults.truncate_lines = Qnil;
2330 buffer_defaults.ctl_arrow = Qt;
2331
2332 #ifdef MSDOS
2333 buffer_defaults.buffer_file_type = Qnil; /* TEXT */
2334 #endif
2335 XFASTINT (buffer_defaults.fill_column) = 70;
2336 XFASTINT (buffer_defaults.left_margin) = 0;
2337
2338 /* Assign the local-flags to the slots that have default values.
2339 The local flag is a bit that is used in the buffer
2340 to say that it has its own local value for the slot.
2341 The local flag bits are in the local_var_flags slot of the buffer. */
2342
2343 /* Nothing can work if this isn't true */
2344 if (sizeof (int) != sizeof (Lisp_Object)) abort ();
2345
2346 /* 0 means not a lisp var, -1 means always local, else mask */
2347 bzero (&buffer_local_flags, sizeof buffer_local_flags);
2348 XFASTINT (buffer_local_flags.filename) = -1;
2349 XFASTINT (buffer_local_flags.directory) = -1;
2350 XFASTINT (buffer_local_flags.backed_up) = -1;
2351 XFASTINT (buffer_local_flags.save_length) = -1;
2352 XFASTINT (buffer_local_flags.auto_save_file_name) = -1;
2353 XFASTINT (buffer_local_flags.read_only) = -1;
2354 XFASTINT (buffer_local_flags.major_mode) = -1;
2355 XFASTINT (buffer_local_flags.mode_name) = -1;
2356 XFASTINT (buffer_local_flags.undo_list) = -1;
2357 XFASTINT (buffer_local_flags.mark_active) = -1;
2358
2359 XFASTINT (buffer_local_flags.mode_line_format) = 1;
2360 XFASTINT (buffer_local_flags.abbrev_mode) = 2;
2361 XFASTINT (buffer_local_flags.overwrite_mode) = 4;
2362 XFASTINT (buffer_local_flags.case_fold_search) = 8;
2363 XFASTINT (buffer_local_flags.auto_fill_function) = 0x10;
2364 XFASTINT (buffer_local_flags.selective_display) = 0x20;
2365 #ifndef old
2366 XFASTINT (buffer_local_flags.selective_display_ellipses) = 0x40;
2367 #endif
2368 XFASTINT (buffer_local_flags.tab_width) = 0x80;
2369 XFASTINT (buffer_local_flags.truncate_lines) = 0x100;
2370 XFASTINT (buffer_local_flags.ctl_arrow) = 0x200;
2371 XFASTINT (buffer_local_flags.fill_column) = 0x400;
2372 XFASTINT (buffer_local_flags.left_margin) = 0x800;
2373 XFASTINT (buffer_local_flags.abbrev_table) = 0x1000;
2374 XFASTINT (buffer_local_flags.display_table) = 0x2000;
2375 XFASTINT (buffer_local_flags.syntax_table) = 0x8000;
2376 #ifdef MSDOS
2377 XFASTINT (buffer_local_flags.buffer_file_type) = 0x4000;
2378 #endif
2379
2380 Vbuffer_alist = Qnil;
2381 current_buffer = 0;
2382 all_buffers = 0;
2383
2384 QSFundamental = build_string ("Fundamental");
2385
2386 Qfundamental_mode = intern ("fundamental-mode");
2387 buffer_defaults.major_mode = Qfundamental_mode;
2388
2389 Qmode_class = intern ("mode-class");
2390
2391 Qprotected_field = intern ("protected-field");
2392
2393 Qpermanent_local = intern ("permanent-local");
2394
2395 Qkill_buffer_hook = intern ("kill-buffer-hook");
2396
2397 Vprin1_to_string_buffer = Fget_buffer_create (build_string (" prin1"));
2398 /* super-magic invisible buffer */
2399 Vbuffer_alist = Qnil;
2400
2401 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2402 }
2403
2404 init_buffer ()
2405 {
2406 char buf[MAXPATHLEN+1];
2407 char *pwd;
2408 struct stat dotstat, pwdstat;
2409 Lisp_Object temp;
2410
2411 Fset_buffer (Fget_buffer_create (build_string ("*scratch*")));
2412
2413 /* If PWD is accurate, use it instead of calling getwd. This is faster
2414 when PWD is right, and may avoid a fatal error. */
2415 if ((pwd = getenv ("PWD")) != 0 && *pwd == '/'
2416 && stat (pwd, &pwdstat) == 0
2417 && stat (".", &dotstat) == 0
2418 && dotstat.st_ino == pwdstat.st_ino
2419 && dotstat.st_dev == pwdstat.st_dev
2420 && strlen (pwd) < MAXPATHLEN)
2421 strcpy (buf, pwd);
2422 else if (getwd (buf) == 0)
2423 fatal ("`getwd' failed: %s.\n", buf);
2424
2425 #ifndef VMS
2426 /* Maybe this should really use some standard subroutine
2427 whose definition is filename syntax dependent. */
2428 if (buf[strlen (buf) - 1] != '/')
2429 strcat (buf, "/");
2430 #endif /* not VMS */
2431 current_buffer->directory = build_string (buf);
2432
2433 temp = get_minibuffer (0);
2434 XBUFFER (temp)->directory = current_buffer->directory;
2435 }
2436
2437 /* initialize the buffer routines */
2438 syms_of_buffer ()
2439 {
2440 extern Lisp_Object Qdisabled;
2441
2442 staticpro (&Vbuffer_defaults);
2443 staticpro (&Vbuffer_local_symbols);
2444 staticpro (&Qfundamental_mode);
2445 staticpro (&Qmode_class);
2446 staticpro (&QSFundamental);
2447 staticpro (&Vbuffer_alist);
2448 staticpro (&Qprotected_field);
2449 staticpro (&Qpermanent_local);
2450 staticpro (&Qkill_buffer_hook);
2451 staticpro (&Qoverlayp);
2452 staticpro (&Qmodification_hooks);
2453 Qmodification_hooks = intern ("modification-hooks");
2454 staticpro (&Qinsert_in_front_hooks);
2455 Qinsert_in_front_hooks = intern ("insert-in-front-hooks");
2456 staticpro (&Qinsert_behind_hooks);
2457 Qinsert_behind_hooks = intern ("insert-behind-hooks");
2458 staticpro (&Qget_file_buffer);
2459 Qget_file_buffer = intern ("get-file-buffer");
2460 Qpriority = intern ("priority");
2461 staticpro (&Qpriority);
2462 Qwindow = intern ("window");
2463 staticpro (&Qwindow);
2464
2465 Qoverlayp = intern ("overlayp");
2466
2467 Fput (Qprotected_field, Qerror_conditions,
2468 Fcons (Qprotected_field, Fcons (Qerror, Qnil)));
2469 Fput (Qprotected_field, Qerror_message,
2470 build_string ("Attempt to modify a protected field"));
2471
2472 /* All these use DEFVAR_LISP_NOPRO because the slots in
2473 buffer_defaults will all be marked via Vbuffer_defaults. */
2474
2475 DEFVAR_LISP_NOPRO ("default-mode-line-format",
2476 &buffer_defaults.mode_line_format,
2477 "Default value of `mode-line-format' for buffers that don't override it.\n\
2478 This is the same as (default-value 'mode-line-format).");
2479
2480 DEFVAR_LISP_NOPRO ("default-abbrev-mode",
2481 &buffer_defaults.abbrev_mode,
2482 "Default value of `abbrev-mode' for buffers that do not override it.\n\
2483 This is the same as (default-value 'abbrev-mode).");
2484
2485 DEFVAR_LISP_NOPRO ("default-ctl-arrow",
2486 &buffer_defaults.ctl_arrow,
2487 "Default value of `ctl-arrow' for buffers that do not override it.\n\
2488 This is the same as (default-value 'ctl-arrow).");
2489
2490 DEFVAR_LISP_NOPRO ("default-truncate-lines",
2491 &buffer_defaults.truncate_lines,
2492 "Default value of `truncate-lines' for buffers that do not override it.\n\
2493 This is the same as (default-value 'truncate-lines).");
2494
2495 DEFVAR_LISP_NOPRO ("default-fill-column",
2496 &buffer_defaults.fill_column,
2497 "Default value of `fill-column' for buffers that do not override it.\n\
2498 This is the same as (default-value 'fill-column).");
2499
2500 DEFVAR_LISP_NOPRO ("default-left-margin",
2501 &buffer_defaults.left_margin,
2502 "Default value of `left-margin' for buffers that do not override it.\n\
2503 This is the same as (default-value 'left-margin).");
2504
2505 DEFVAR_LISP_NOPRO ("default-tab-width",
2506 &buffer_defaults.tab_width,
2507 "Default value of `tab-width' for buffers that do not override it.\n\
2508 This is the same as (default-value 'tab-width).");
2509
2510 DEFVAR_LISP_NOPRO ("default-case-fold-search",
2511 &buffer_defaults.case_fold_search,
2512 "Default value of `case-fold-search' for buffers that don't override it.\n\
2513 This is the same as (default-value 'case-fold-search).");
2514
2515 #ifdef MSDOS
2516 DEFVAR_LISP_NOPRO ("default-buffer-file-type",
2517 &buffer_defaults.buffer_file_type,
2518 "Default file type for buffers that do not override it.\n\
2519 This is the same as (default-value 'buffer-file-type).\n\
2520 The file type is nil for text, t for binary.");
2521 #endif
2522
2523 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2524 Qnil, 0);
2525
2526 /* This doc string is too long for cpp; cpp dies if it isn't in a comment.
2527 But make-docfile finds it!
2528 DEFVAR_PER_BUFFER ("mode-line-format", &current_buffer->mode_line_format,
2529 Qnil,
2530 "Template for displaying mode line for current buffer.\n\
2531 Each buffer has its own value of this variable.\n\
2532 Value may be a string, a symbol or a list or cons cell.\n\
2533 For a symbol, its value is used (but it is ignored if t or nil).\n\
2534 A string appearing directly as the value of a symbol is processed verbatim\n\
2535 in that the %-constructs below are not recognized.\n\
2536 For a list whose car is a symbol, the symbol's value is taken,\n\
2537 and if that is non-nil, the cadr of the list is processed recursively.\n\
2538 Otherwise, the caddr of the list (if there is one) is processed.\n\
2539 For a list whose car is a string or list, each element is processed\n\
2540 recursively and the results are effectively concatenated.\n\
2541 For a list whose car is an integer, the cdr of the list is processed\n\
2542 and padded (if the number is positive) or truncated (if negative)\n\
2543 to the width specified by that number.\n\
2544 A string is printed verbatim in the mode line except for %-constructs:\n\
2545 (%-constructs are allowed when the string is the entire mode-line-format\n\
2546 or when it is found in a cons-cell or a list)\n\
2547 %b -- print buffer name. %f -- print visited file name.\n\
2548 %* -- print *, % or hyphen. %m -- print value of mode-name (obsolete).\n\
2549 %s -- print process status. %l -- print the current line number.\n\
2550 %p -- print percent of buffer above top of window, or Top, Bot or All.\n\
2551 %P -- print percent of buffer above bottom of window, perhaps plus Top,\n\
2552 or print Bottom or All.\n\
2553 %n -- print Narrow if appropriate.\n\
2554 %t -- print T if files is text, B if binary.\n\
2555 %[ -- print one [ for each recursive editing level. %] similar.\n\
2556 %% -- print %. %- -- print infinitely many dashes.\n\
2557 Decimal digits after the % specify field width to which to pad.");
2558 */
2559
2560 DEFVAR_LISP_NOPRO ("default-major-mode", &buffer_defaults.major_mode,
2561 "*Major mode for new buffers. Defaults to `fundamental-mode'.\n\
2562 nil here means use current buffer's major mode.");
2563
2564 DEFVAR_PER_BUFFER ("major-mode", &current_buffer->major_mode,
2565 make_number (Lisp_Symbol),
2566 "Symbol for current buffer's major mode.");
2567
2568 DEFVAR_PER_BUFFER ("mode-name", &current_buffer->mode_name,
2569 make_number (Lisp_String),
2570 "Pretty name of current buffer's major mode (a string).");
2571
2572 DEFVAR_PER_BUFFER ("abbrev-mode", &current_buffer->abbrev_mode, Qnil,
2573 "Non-nil turns on automatic expansion of abbrevs as they are inserted.\n\
2574 Automatically becomes buffer-local when set in any fashion.");
2575
2576 DEFVAR_PER_BUFFER ("case-fold-search", &current_buffer->case_fold_search,
2577 Qnil,
2578 "*Non-nil if searches should ignore case.\n\
2579 Automatically becomes buffer-local when set in any fashion.");
2580
2581 DEFVAR_PER_BUFFER ("fill-column", &current_buffer->fill_column,
2582 make_number (Lisp_Int),
2583 "*Column beyond which automatic line-wrapping should happen.\n\
2584 Automatically becomes buffer-local when set in any fashion.");
2585
2586 DEFVAR_PER_BUFFER ("left-margin", &current_buffer->left_margin,
2587 make_number (Lisp_Int),
2588 "*Column for the default indent-line-function to indent to.\n\
2589 Linefeed indents to this column in Fundamental mode.\n\
2590 Automatically becomes buffer-local when set in any fashion.");
2591
2592 DEFVAR_PER_BUFFER ("tab-width", &current_buffer->tab_width,
2593 make_number (Lisp_Int),
2594 "*Distance between tab stops (for display of tab characters), in columns.\n\
2595 Automatically becomes buffer-local when set in any fashion.");
2596
2597 DEFVAR_PER_BUFFER ("ctl-arrow", &current_buffer->ctl_arrow, Qnil,
2598 "*Non-nil means display control chars with uparrow.\n\
2599 Nil means use backslash and octal digits.\n\
2600 Automatically becomes buffer-local when set in any fashion.\n\
2601 This variable does not apply to characters whose display is specified\n\
2602 in the current display table (if there is one).");
2603
2604 DEFVAR_PER_BUFFER ("truncate-lines", &current_buffer->truncate_lines, Qnil,
2605 "*Non-nil means do not display continuation lines;\n\
2606 give each line of text one screen line.\n\
2607 Automatically becomes buffer-local when set in any fashion.\n\
2608 \n\
2609 Note that this is overridden by the variable\n\
2610 `truncate-partial-width-windows' if that variable is non-nil\n\
2611 and this buffer is not full-frame width.");
2612
2613 #ifdef MSDOS
2614 DEFVAR_PER_BUFFER ("buffer-file-type", &current_buffer->buffer_file_type,
2615 Qnil,
2616 "*If visited file is text, nil; otherwise, t.");
2617 #endif
2618
2619 DEFVAR_PER_BUFFER ("default-directory", &current_buffer->directory,
2620 make_number (Lisp_String),
2621 "Name of default directory of current buffer. Should end with slash.\n\
2622 Each buffer has its own value of this variable.");
2623
2624 DEFVAR_PER_BUFFER ("auto-fill-function", &current_buffer->auto_fill_function,
2625 Qnil,
2626 "Function called (if non-nil) to perform auto-fill.\n\
2627 It is called after self-inserting a space at a column beyond `fill-column'.\n\
2628 Each buffer has its own value of this variable.\n\
2629 NOTE: This variable is not an ordinary hook;\n\
2630 It may not be a list of functions.");
2631
2632 DEFVAR_PER_BUFFER ("buffer-file-name", &current_buffer->filename,
2633 make_number (Lisp_String),
2634 "Name of file visited in current buffer, or nil if not visiting a file.\n\
2635 Each buffer has its own value of this variable.");
2636
2637 DEFVAR_PER_BUFFER ("buffer-auto-save-file-name",
2638 &current_buffer->auto_save_file_name,
2639 make_number (Lisp_String),
2640 "Name of file for auto-saving current buffer,\n\
2641 or nil if buffer should not be auto-saved.\n\
2642 Each buffer has its own value of this variable.");
2643
2644 DEFVAR_PER_BUFFER ("buffer-read-only", &current_buffer->read_only, Qnil,
2645 "Non-nil if this buffer is read-only.\n\
2646 Each buffer has its own value of this variable.");
2647
2648 DEFVAR_PER_BUFFER ("buffer-backed-up", &current_buffer->backed_up, Qnil,
2649 "Non-nil if this buffer's file has been backed up.\n\
2650 Backing up is done before the first time the file is saved.\n\
2651 Each buffer has its own value of this variable.");
2652
2653 DEFVAR_PER_BUFFER ("buffer-saved-size", &current_buffer->save_length,
2654 make_number (Lisp_Int),
2655 "Length of current buffer when last read in, saved or auto-saved.\n\
2656 0 initially.\n\
2657 Each buffer has its own value of this variable.");
2658
2659 DEFVAR_PER_BUFFER ("selective-display", &current_buffer->selective_display,
2660 Qnil,
2661 "Non-nil enables selective display:\n\
2662 Integer N as value means display only lines\n\
2663 that start with less than n columns of space.\n\
2664 A value of t means, after a ^M, all the rest of the line is invisible.\n\
2665 Then ^M's in the file are written into files as newlines.\n\n\
2666 Automatically becomes buffer-local when set in any fashion.");
2667
2668 #ifndef old
2669 DEFVAR_PER_BUFFER ("selective-display-ellipses",
2670 &current_buffer->selective_display_ellipses,
2671 Qnil,
2672 "t means display ... on previous line when a line is invisible.\n\
2673 Automatically becomes buffer-local when set in any fashion.");
2674 #endif
2675
2676 DEFVAR_PER_BUFFER ("overwrite-mode", &current_buffer->overwrite_mode, Qnil,
2677 "Non-nil if self-insertion should replace existing text.\n\
2678 If non-nil and not `overwrite-mode-binary', self-insertion still\n\
2679 inserts at the end of a line, and inserts when point is before a tab,\n\
2680 until the tab is filled in.\n\
2681 If `overwrite-mode-binary', self-insertion replaces newlines and tabs too.\n\
2682 Automatically becomes buffer-local when set in any fashion.");
2683
2684 #if 0 /* The doc string is too long for some compilers,
2685 but make-docfile can find it in this comment. */
2686 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2687 Qnil,
2688 "Display table that controls display of the contents of current buffer.\n\
2689 Automatically becomes buffer-local when set in any fashion.\n\
2690 The display table is a vector created with `make-display-table'.\n\
2691 The first 256 elements control how to display each possible text character.\n\
2692 Each value should be a vector of characters or nil;\n\
2693 nil means display the character in the default fashion.\n\
2694 The remaining five elements control the display of\n\
2695 the end of a truncated screen line (element 256, a single character);\n\
2696 the end of a continued line (element 257, a single character);\n\
2697 the escape character used to display character codes in octal\n\
2698 (element 258, a single character);\n\
2699 the character used as an arrow for control characters (element 259,\n\
2700 a single character);\n\
2701 the decoration indicating the presence of invisible lines (element 260,\n\
2702 a vector of characters).\n\
2703 If this variable is nil, the value of `standard-display-table' is used.\n\
2704 Each window can have its own, overriding display table.");
2705 #endif
2706 DEFVAR_PER_BUFFER ("buffer-display-table", &current_buffer->display_table,
2707 Qnil, 0);
2708
2709 /*DEFVAR_LISP ("debug-check-symbol", &Vcheck_symbol,
2710 "Don't ask.");
2711 */
2712 DEFVAR_LISP ("before-change-function", &Vbefore_change_function,
2713 "Function to call before each text change.\n\
2714 Two arguments are passed to the function: the positions of\n\
2715 the beginning and end of the range of old text to be changed.\n\
2716 \(For an insertion, the beginning and end are at the same place.)\n\
2717 No information is given about the length of the text after the change.\n\
2718 \n\
2719 Buffer changes made while executing the `before-change-function'\n\
2720 don't call any before-change or after-change functions.\n\
2721 That's because these variables are temporarily set to nil.\n\
2722 As a result, a hook function cannot straightforwardly alter the value of\n\
2723 these variables. See the Emacs Lisp manual for a way of\n\
2724 accomplishing an equivalent result by using other variables.");
2725 Vbefore_change_function = Qnil;
2726
2727 DEFVAR_LISP ("after-change-function", &Vafter_change_function,
2728 "Function to call after each text change.\n\
2729 Three arguments are passed to the function: the positions of\n\
2730 the beginning and end of the range of changed text,\n\
2731 and the length of the pre-change text replaced by that range.\n\
2732 \(For an insertion, the pre-change length is zero;\n\
2733 for a deletion, that length is the number of characters deleted,\n\
2734 and the post-change beginning and end are at the same place.)\n\
2735 \n\
2736 Buffer changes made while executing the `after-change-function'\n\
2737 don't call any before-change or after-change functions.\n\
2738 That's because these variables are temporarily set to nil.\n\
2739 As a result, a hook function cannot straightforwardly alter the value of\n\
2740 these variables. See the Emacs Lisp manual for a way of\n\
2741 accomplishing an equivalent result by using other variables.");
2742 Vafter_change_function = Qnil;
2743
2744 DEFVAR_LISP ("before-change-functions", &Vbefore_change_functions,
2745 "List of functions to call before each text change.\n\
2746 Two arguments are passed to each function: the positions of\n\
2747 the beginning and end of the range of old text to be changed.\n\
2748 \(For an insertion, the beginning and end are at the same place.)\n\
2749 No information is given about the length of the text after the change.\n\
2750 \n\
2751 Buffer changes made while executing the `before-change-functions'\n\
2752 don't call any before-change or after-change functions.\n\
2753 That's because these variables are temporarily set to nil.\n\
2754 As a result, a hook function cannot straightforwardly alter the value of\n\
2755 these variables. See the Emacs Lisp manual for a way of\n\
2756 accomplishing an equivalent result by using other variables.");
2757 Vbefore_change_functions = Qnil;
2758
2759 DEFVAR_LISP ("after-change-functions", &Vafter_change_functions,
2760 "List of function to call after each text change.\n\
2761 Three arguments are passed to each function: the positions of\n\
2762 the beginning and end of the range of changed text,\n\
2763 and the length of the pre-change text replaced by that range.\n\
2764 \(For an insertion, the pre-change length is zero;\n\
2765 for a deletion, that length is the number of characters deleted,\n\
2766 and the post-change beginning and end are at the same place.)\n\
2767 \n\
2768 Buffer changes made while executing the `after-change-functions'\n\
2769 don't call any before-change or after-change functions.\n\
2770 That's because these variables are temporarily set to nil.\n\
2771 As a result, a hook function cannot straightforwardly alter the value of\n\
2772 these variables. See the Emacs Lisp manual for a way of\n\
2773 accomplishing an equivalent result by using other variables.");
2774
2775 Vafter_change_functions = Qnil;
2776
2777 DEFVAR_LISP ("first-change-hook", &Vfirst_change_hook,
2778 "A list of functions to call before changing a buffer which is unmodified.\n\
2779 The functions are run using the `run-hooks' function.");
2780 Vfirst_change_hook = Qnil;
2781 Qfirst_change_hook = intern ("first-change-hook");
2782 staticpro (&Qfirst_change_hook);
2783
2784 #if 0 /* The doc string is too long for some compilers,
2785 but make-docfile can find it in this comment. */
2786 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2787 "List of undo entries in current buffer.\n\
2788 Recent changes come first; older changes follow newer.\n\
2789 \n\
2790 An entry (START . END) represents an insertion which begins at\n\
2791 position START and ends at position END.\n\
2792 \n\
2793 An entry (TEXT . POSITION) represents the deletion of the string TEXT\n\
2794 from (abs POSITION). If POSITION is positive, point was at the front\n\
2795 of the text being deleted; if negative, point was at the end.\n\
2796 \n\
2797 An entry (t HIGHWORD LOWWORD) indicates that the buffer had been\n\
2798 previously unmodified. HIGHWORD and LOWWORD are the high and low\n\
2799 16-bit words of the buffer's modification count at the time. If the\n\
2800 modification count of the most recent save is different, this entry is\n\
2801 obsolete.\n\
2802 \n\
2803 An entry (nil PROP VAL BEG . END) indicates that a text property\n\
2804 was modified between BEG and END. PROP is the property name,\n\
2805 and VAL is the old value.\n\
2806 \n\
2807 An entry of the form POSITION indicates that point was at the buffer\n\
2808 location given by the integer. Undoing an entry of this form places\n\
2809 point at POSITION.\n\
2810 \n\
2811 nil marks undo boundaries. The undo command treats the changes\n\
2812 between two undo boundaries as a single step to be undone.\n\
2813 \n\
2814 If the value of the variable is t, undo information is not recorded.");
2815 #endif
2816 DEFVAR_PER_BUFFER ("buffer-undo-list", &current_buffer->undo_list, Qnil,
2817 0);
2818
2819 DEFVAR_PER_BUFFER ("mark-active", &current_buffer->mark_active, Qnil,
2820 "Non-nil means the mark and region are currently active in this buffer.\n\
2821 Automatically local in all buffers.");
2822
2823 DEFVAR_LISP ("transient-mark-mode", &Vtransient_mark_mode,
2824 "*Non-nil means deactivate the mark when the buffer contents change.");
2825 Vtransient_mark_mode = Qnil;
2826
2827 DEFVAR_LISP ("inhibit-read-only", &Vinhibit_read_only,
2828 "*Non-nil means disregard read-only status of buffers or characters.\n\
2829 If the value is t, disregard `buffer-read-only' and all `read-only'\n\
2830 text properties. If the value is a list, disregard `buffer-read-only'\n\
2831 and disregard a `read-only' text property if the property value\n\
2832 is a member of the list.");
2833 Vinhibit_read_only = Qnil;
2834
2835 DEFVAR_LISP ("kill-buffer-query-functions", &Vkill_buffer_query_functions,
2836 "List of functions called with no args to query before killing a buffer.");
2837 Vkill_buffer_query_functions = Qnil;
2838
2839 defsubr (&Sbuffer_list);
2840 defsubr (&Sget_buffer);
2841 defsubr (&Sget_file_buffer);
2842 defsubr (&Sget_buffer_create);
2843 defsubr (&Sgenerate_new_buffer_name);
2844 defsubr (&Sbuffer_name);
2845 /*defsubr (&Sbuffer_number);*/
2846 defsubr (&Sbuffer_file_name);
2847 defsubr (&Sbuffer_local_variables);
2848 defsubr (&Sbuffer_modified_p);
2849 defsubr (&Sset_buffer_modified_p);
2850 defsubr (&Sbuffer_modified_tick);
2851 defsubr (&Srename_buffer);
2852 defsubr (&Sother_buffer);
2853 defsubr (&Sbuffer_disable_undo);
2854 defsubr (&Sbuffer_enable_undo);
2855 defsubr (&Skill_buffer);
2856 defsubr (&Serase_buffer);
2857 defsubr (&Sswitch_to_buffer);
2858 defsubr (&Spop_to_buffer);
2859 defsubr (&Scurrent_buffer);
2860 defsubr (&Sset_buffer);
2861 defsubr (&Sbarf_if_buffer_read_only);
2862 defsubr (&Sbury_buffer);
2863 defsubr (&Slist_buffers);
2864 defsubr (&Skill_all_local_variables);
2865
2866 defsubr (&Soverlayp);
2867 defsubr (&Smake_overlay);
2868 defsubr (&Sdelete_overlay);
2869 defsubr (&Smove_overlay);
2870 defsubr (&Soverlay_start);
2871 defsubr (&Soverlay_end);
2872 defsubr (&Soverlay_buffer);
2873 defsubr (&Soverlay_properties);
2874 defsubr (&Soverlays_at);
2875 defsubr (&Snext_overlay_change);
2876 defsubr (&Soverlay_recenter);
2877 defsubr (&Soverlay_lists);
2878 defsubr (&Soverlay_get);
2879 defsubr (&Soverlay_put);
2880 }
2881
2882 keys_of_buffer ()
2883 {
2884 initial_define_key (control_x_map, 'b', "switch-to-buffer");
2885 initial_define_key (control_x_map, 'k', "kill-buffer");
2886 initial_define_key (control_x_map, Ctl ('B'), "list-buffers");
2887
2888 /* This must not be in syms_of_buffer, because Qdisabled is not
2889 initialized when that function gets called. */
2890 Fput (intern ("erase-buffer"), Qdisabled, Qt);
2891 }