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