2 Copyright (C) 1992, 1993, 1994 Free Software Foundation, Inc.
3 Copyright (C) 1996 Ben Wing.
5 This file is part of XEmacs.
7 XEmacs is free software; you can redistribute it and/or modify it
8 under the terms of the GNU General Public License as published by the
9 Free Software Foundation; either version 2, or (at your option) any
12 XEmacs is distributed in the hope that it will be useful, but WITHOUT
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with XEmacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* Synched up with: Not in FSF. */
24 /* Written by Ben Wing. */
30 #include "console-tty.h"
33 #include "redisplay.h"
37 Lisp_Object Vconsole_list, Vselected_console;
39 Lisp_Object Vcreate_console_hook, Vdelete_console_hook;
41 Lisp_Object Qconsolep, Qconsole_live_p;
42 Lisp_Object Qcreate_console_hook;
43 Lisp_Object Qdelete_console_hook;
45 Lisp_Object Qsuspend_hook;
46 Lisp_Object Qsuspend_resume_hook;
48 /* This structure holds the default values of the console-local
49 variables defined with DEFVAR_CONSOLE_LOCAL, that have special
50 slots in each console. The default value occupies the same slot
51 in this structure as an individual console's value occupies in
52 that console. Setting the default value also goes through the
53 list of consoles and stores into each console that does not say
54 it has a local value. */
55 Lisp_Object Vconsole_defaults;
56 static void *console_defaults_saved_slots;
58 /* This structure marks which slots in a console have corresponding
59 default values in console_defaults.
60 Each such slot has a nonzero value in this structure.
61 The value has only one nonzero bit.
63 When a console has its own local value for a slot,
64 the bit for that slot (found in the same slot in this structure)
65 is turned on in the console's local_var_flags slot.
67 If a slot in this structure is 0, then there is a DEFVAR_CONSOLE_LOCAL
68 for the slot, but there is no default value for it; the corresponding
69 slot in console_defaults is not used except to initialize newly-created
72 If a slot is -1, then there is a DEFVAR_CONSOLE_LOCAL for it
73 as well as a default value which is used to initialize newly-created
74 consoles and as a reset-value when local-vars are killed.
76 If a slot is -2, there is no DEFVAR_CONSOLE_LOCAL for it.
77 (The slot is always local, but there's no lisp variable for it.)
78 The default value is only used to initialize newly-creation consoles.
80 If a slot is -3, then there is no DEFVAR_CONSOLE_LOCAL for it but
81 there is a default which is used to initialize newly-creation
82 consoles and as a reset-value when local-vars are killed.
86 struct console console_local_flags;
88 /* This structure holds the names of symbols whose values may be
89 console-local. It is indexed and accessed in the same way as the above. */
90 static Lisp_Object Vconsole_local_symbols;
91 static void *console_local_symbols_saved_slots;
93 DEFINE_CONSOLE_TYPE (dead);
95 Lisp_Object Vconsole_type_list;
97 console_type_entry_dynarr *the_console_type_entry_dynarr;
101 mark_console (Lisp_Object obj)
103 struct console *con = XCONSOLE (obj);
105 #define MARKED_SLOT(x) mark_object (con->x)
106 #include "conslots.h"
109 /* Can be zero for Vconsole_defaults, Vconsole_local_symbols */
112 mark_object (con->conmeths->symbol);
113 MAYBE_CONMETH (con, mark_console, (con));
120 print_console (Lisp_Object obj, Lisp_Object printcharfun, int escapeflag)
122 struct console *con = XCONSOLE (obj);
126 error ("printing unreadable object #<console %s 0x%x>",
127 XSTRING_DATA (con->name), con->header.uid);
129 sprintf (buf, "#<%s-console", !CONSOLE_LIVE_P (con) ? "dead" :
130 CONSOLE_TYPE_NAME (con));
131 write_c_string (buf, printcharfun);
132 if (CONSOLE_LIVE_P (con) && !NILP (CONSOLE_CONNECTION (con)))
134 write_c_string (" on ", printcharfun);
135 print_internal (CONSOLE_CONNECTION (con), printcharfun, 1);
137 sprintf (buf, " 0x%x>", con->header.uid);
138 write_c_string (buf, printcharfun);
141 DEFINE_LRECORD_IMPLEMENTATION ("console", console,
142 mark_console, print_console, 0, 0, 0, 0,
145 static struct console *
146 allocate_console (void)
149 struct console *con = alloc_lcrecord_type (struct console, &lrecord_console);
152 copy_lcrecord (con, XCONSOLE (Vconsole_defaults));
154 XSETCONSOLE (console, con);
157 con->quit_char = 7; /* C-g */
158 con->command_builder = allocate_command_builder (console);
159 con->function_key_map = Fmake_sparse_keymap (Qnil);
166 decode_console (Lisp_Object console)
169 console = Fselected_console ();
170 /* quietly accept devices and frames for the console arg */
171 if (DEVICEP (console) || FRAMEP (console))
172 console = DEVICE_CONSOLE (decode_device (console));
173 CHECK_LIVE_CONSOLE (console);
174 return XCONSOLE (console);
178 struct console_methods *
179 decode_console_type (Lisp_Object type, Error_behavior errb)
183 for (i = 0; i < Dynarr_length (the_console_type_entry_dynarr); i++)
184 if (EQ (type, Dynarr_at (the_console_type_entry_dynarr, i).symbol))
185 return Dynarr_at (the_console_type_entry_dynarr, i).meths;
187 maybe_signal_simple_error ("Invalid console type", type, Qconsole, errb);
193 valid_console_type_p (Lisp_Object type)
195 return decode_console_type (type, ERROR_ME_NOT) != 0;
198 DEFUN ("valid-console-type-p", Fvalid_console_type_p, 1, 1, 0, /*
199 Given a CONSOLE-TYPE, return t if it is valid.
200 Valid types are 'x, 'tty, and 'stream.
204 return valid_console_type_p (console_type) ? Qt : Qnil;
207 DEFUN ("console-type-list", Fconsole_type_list, 0, 0, 0, /*
208 Return a list of valid console types.
212 return Fcopy_sequence (Vconsole_type_list);
215 DEFUN ("cdfw-console", Fcdfw_console, 1, 1, 0, /*
216 Given a console, device, frame, or window, return the associated console.
217 Return nil otherwise.
221 return CDFW_CONSOLE (obj);
225 DEFUN ("selected-console", Fselected_console, 0, 0, 0, /*
226 Return the console which is currently active.
230 return Vselected_console;
233 /* Called from selected_device_1(), called from selected_frame_1(),
234 called from Fselect_window() */
236 select_console_1 (Lisp_Object console)
238 /* perhaps this should do something more complicated */
239 Vselected_console = console;
241 /* #### Schedule this to be removed in 19.14 */
242 #ifdef HAVE_X_WINDOWS
243 if (CONSOLE_X_P (XCONSOLE (console)))
247 #ifdef HAVE_MS_WINDOWS
248 if (CONSOLE_MSWINDOWS_P (XCONSOLE (console)))
249 Vwindow_system = Qmswindows;
252 Vwindow_system = Qnil;
255 DEFUN ("select-console", Fselect_console, 1, 1, 0, /*
256 Select the console CONSOLE.
257 Subsequent editing commands apply to its selected device, selected frame,
258 and selected window. The selection of CONSOLE lasts until the next time
259 the user does something to select a different console, or until the next
260 time this function is called.
266 CHECK_LIVE_CONSOLE (console);
268 device = CONSOLE_SELECTED_DEVICE (XCONSOLE (console));
271 struct device *d = XDEVICE (device);
272 Lisp_Object frame = DEVICE_SELECTED_FRAME (d);
275 struct frame *f = XFRAME(frame);
276 Fselect_window (FRAME_SELECTED_WINDOW (f), Qnil);
279 error ("Can't select console with no frames.");
282 error ("Can't select a console with no devices");
287 set_console_last_nonminibuf_frame (struct console *con,
290 con->last_nonminibuf_frame = frame;
293 DEFUN ("consolep", Fconsolep, 1, 1, 0, /*
294 Return non-nil if OBJECT is a console.
298 return CONSOLEP (object) ? Qt : Qnil;
301 DEFUN ("console-live-p", Fconsole_live_p, 1, 1, 0, /*
302 Return non-nil if OBJECT is a console that has not been deleted.
306 return CONSOLEP (object) && CONSOLE_LIVE_P (XCONSOLE (object)) ? Qt : Qnil;
309 DEFUN ("console-type", Fconsole_type, 0, 1, 0, /*
310 Return the type of the specified console (e.g. `x' or `tty').
311 Value is `tty' for a tty console (a character-only terminal),
312 `x' for a console that is an X display,
313 `mswindows' for a console that is a Windows NT/95/97 connection,
314 `pc' for a console that is a direct-write MS-DOS connection (not yet
316 `stream' for a stream console (which acts like a stdio stream), and
317 `dead' for a deleted console.
321 /* don't call decode_console() because we want to allow for dead
324 console = Fselected_console ();
325 CHECK_CONSOLE (console);
326 return CONSOLE_TYPE (XCONSOLE (console));
329 DEFUN ("console-name", Fconsole_name, 0, 1, 0, /*
330 Return the name of the specified console.
334 return CONSOLE_NAME (decode_console (console));
337 DEFUN ("console-connection", Fconsole_connection, 0, 1, 0, /*
338 Return the connection of the specified console.
339 CONSOLE defaults to the selected console if omitted.
343 return CONSOLE_CONNECTION (decode_console (console));
347 make_console (struct console *con)
350 XSETCONSOLE (console, con);
355 semi_canonicalize_console_connection (struct console_methods *meths,
356 Lisp_Object name, Error_behavior errb)
358 if (HAS_CONTYPE_METH_P (meths, semi_canonicalize_console_connection))
359 return CONTYPE_METH (meths, semi_canonicalize_console_connection,
362 return CONTYPE_METH_OR_GIVEN (meths, canonicalize_console_connection,
367 canonicalize_console_connection (struct console_methods *meths,
368 Lisp_Object name, Error_behavior errb)
370 if (HAS_CONTYPE_METH_P (meths, canonicalize_console_connection))
371 return CONTYPE_METH (meths, canonicalize_console_connection,
374 return CONTYPE_METH_OR_GIVEN (meths, semi_canonicalize_console_connection,
379 find_console_of_type (struct console_methods *meths, Lisp_Object canon)
383 CONSOLE_LOOP (concons)
385 Lisp_Object console = XCAR (concons);
387 if (EQ (CONMETH_TYPE (meths), CONSOLE_TYPE (XCONSOLE (console)))
388 && internal_equal (CONSOLE_CANON_CONNECTION (XCONSOLE (console)),
396 DEFUN ("find-console", Ffind_console, 1, 2, 0, /*
397 Look for an existing console attached to connection CONNECTION.
398 Return the console if found; otherwise, return nil.
400 If TYPE is specified, only return consoles of that type; otherwise,
401 return consoles of any type. (It is possible, although unlikely,
402 that two consoles of different types could have the same connection
403 name; in such a case, the first console found is returned.)
407 Lisp_Object canon = Qnil;
414 struct console_methods *conmeths = decode_console_type (type, ERROR_ME);
415 canon = canonicalize_console_connection (conmeths, connection,
417 if (UNBOUNDP (canon))
418 RETURN_UNGCPRO (Qnil);
420 RETURN_UNGCPRO (find_console_of_type (conmeths, canon));
426 for (i = 0; i < Dynarr_length (the_console_type_entry_dynarr); i++)
428 struct console_methods *conmeths =
429 Dynarr_at (the_console_type_entry_dynarr, i).meths;
430 canon = canonicalize_console_connection (conmeths, connection,
432 if (!UNBOUNDP (canon))
434 Lisp_Object console = find_console_of_type (conmeths, canon);
436 RETURN_UNGCPRO (console);
440 RETURN_UNGCPRO (Qnil);
444 DEFUN ("get-console", Fget_console, 1, 2, 0, /*
445 Look for an existing console attached to connection CONNECTION.
446 Return the console if found; otherwise, signal an error.
448 If TYPE is specified, only return consoles of that type; otherwise,
449 return consoles of any type. (It is possible, although unlikely,
450 that two consoles of different types could have the same connection
451 name; in such a case, the first console found is returned.)
455 Lisp_Object console = Ffind_console (connection, type);
459 signal_simple_error ("No such console", connection);
461 signal_simple_error_2 ("No such console", type, connection);
467 create_console (Lisp_Object name, Lisp_Object type, Lisp_Object connection,
470 /* This function can GC */
475 console = Ffind_console (connection, type);
479 con = allocate_console ();
480 XSETCONSOLE (console, con);
484 con->conmeths = decode_console_type (type, ERROR_ME);
486 CONSOLE_NAME (con) = name;
487 CONSOLE_CONNECTION (con) =
488 semi_canonicalize_console_connection (con->conmeths, connection,
490 CONSOLE_CANON_CONNECTION (con) =
491 canonicalize_console_connection (con->conmeths, connection,
494 MAYBE_CONMETH (con, init_console, (con, props));
496 /* Do it this way so that the console list is in order of creation */
497 Vconsole_list = nconc2 (Vconsole_list, Fcons (console, Qnil));
499 if (CONMETH_OR_GIVEN (con, initially_selected_for_input, (con), 0))
500 event_stream_select_console (con);
507 add_entry_to_console_type_list (Lisp_Object symbol,
508 struct console_methods *meths)
510 struct console_type_entry entry;
512 entry.symbol = symbol;
514 Dynarr_add (the_console_type_entry_dynarr, entry);
515 Vconsole_type_list = Fcons (symbol, Vconsole_type_list);
518 /* find a console other than the selected one. Prefer non-stream
519 consoles over stream consoles. */
522 find_other_console (Lisp_Object console)
526 /* look for a non-stream console */
527 CONSOLE_LOOP (concons)
529 Lisp_Object con = XCAR (concons);
530 if (!CONSOLE_STREAM_P (XCONSOLE (con))
531 && !EQ (con, console)
532 && !NILP (CONSOLE_SELECTED_DEVICE (XCONSOLE (con)))
533 && !NILP (DEVICE_SELECTED_FRAME
534 (XDEVICE (CONSOLE_SELECTED_DEVICE (XCONSOLE (con))))))
538 return XCAR (concons);
540 /* OK, now look for a stream console */
541 CONSOLE_LOOP (concons)
543 Lisp_Object con = XCAR (concons);
544 if (!EQ (con, console)
545 && !NILP (CONSOLE_SELECTED_DEVICE (XCONSOLE (con)))
546 && !NILP (DEVICE_SELECTED_FRAME
547 (XDEVICE (CONSOLE_SELECTED_DEVICE (XCONSOLE (con))))))
551 return XCAR (concons);
553 /* Sorry, there ain't none */
558 find_nonminibuffer_frame_not_on_console_predicate (Lisp_Object frame,
563 VOID_TO_LISP (console, closure);
564 if (FRAME_MINIBUF_ONLY_P (XFRAME (frame)))
566 if (EQ (console, FRAME_CONSOLE (XFRAME (frame))))
572 find_nonminibuffer_frame_not_on_console (Lisp_Object console)
574 return find_some_frame (find_nonminibuffer_frame_not_on_console_predicate,
575 LISP_TO_VOID (console));
578 /* Delete console CON.
580 If FORCE is non-zero, allow deletion of the only frame.
582 If CALLED_FROM_KILL_EMACS is non-zero, then, if
583 deleting the last console, just delete it,
584 instead of calling `save-buffers-kill-emacs'.
586 If FROM_IO_ERROR is non-zero, then the console is gone due
587 to an I/O error. This affects what happens if we exit
588 (we do an emergency exit instead of `save-buffers-kill-emacs'.)
592 delete_console_internal (struct console *con, int force,
593 int called_from_kill_emacs, int from_io_error)
595 /* This function can GC */
599 /* OK to delete an already-deleted console. */
600 if (!CONSOLE_LIVE_P (con))
603 XSETCONSOLE (console, con);
606 if (!called_from_kill_emacs)
610 if ((XINT (Flength (Vconsole_list)) == 1)
611 /* if we just created the console, it might not be listed,
613 && !NILP (memq_no_quit (console, Vconsole_list)))
615 /* If there aren't any nonminibuffer frames that would
616 be left, then exit. */
617 else if (NILP (find_nonminibuffer_frame_not_on_console (console)))
623 error ("Attempt to delete the only frame");
624 else if (from_io_error)
626 /* Mayday mayday! We're going down! */
627 stderr_out (" Autosaving and exiting...\n");
628 Vwindow_system = Qnil; /* let it lie! */
629 preparing_for_armageddon = 1;
630 Fkill_emacs (make_int (70));
634 call0 (Qsave_buffers_kill_emacs);
636 /* If we get here, the user said they didn't want
637 to exit, so don't. */
643 /* Breathe a sigh of relief. We're still alive. */
646 Lisp_Object frmcons, devcons;
648 /* First delete all frames without their own minibuffers,
649 to avoid errors coming from attempting to delete a frame
650 that is a surrogate for another frame.
652 We don't set "called_from_delete_console" because we want the
653 device to go ahead and get deleted if we delete the last frame
654 on a device. We won't run into trouble here because for any
655 frame without a minibuffer, there has to be another one on
656 the same console with a minibuffer, and we're not deleting that,
657 so delete_console_internal() won't get recursively called.
659 WRONG! With surrogate minibuffers this isn't true. Frames
660 with only a minibuffer are not enough to prevent
661 delete_frame_internal from triggering a device deletion. */
662 CONSOLE_FRAME_LOOP_NO_BREAK (frmcons, devcons, con)
664 struct frame *f = XFRAME (XCAR (frmcons));
665 /* delete_frame_internal() might do anything such as run hooks,
667 if (FRAME_LIVE_P (f) && !FRAME_HAS_MINIBUF_P (f))
668 delete_frame_internal (f, 1, 1, from_io_error);
670 if (!CONSOLE_LIVE_P (con)) /* make sure the delete-*-hook didn't
671 go ahead and delete anything */
678 CONSOLE_DEVICE_LOOP (devcons, con)
680 struct device *d = XDEVICE (XCAR (devcons));
681 /* delete_device_internal() might do anything such as run hooks,
683 if (DEVICE_LIVE_P (d))
684 delete_device_internal (d, 1, 1, from_io_error);
685 if (!CONSOLE_LIVE_P (con)) /* make sure the delete-*-hook didn't
686 go ahead and delete anything */
694 CONSOLE_SELECTED_DEVICE (con) = Qnil;
696 /* try to select another console */
698 if (EQ (console, Fselected_console ()))
700 Lisp_Object other_dev = find_other_console (console);
701 if (!NILP (other_dev))
702 Fselect_console (other_dev);
706 Vselected_console = Qnil;
707 Vwindow_system = Qnil;
711 if (con->input_enabled)
712 event_stream_unselect_console (con);
714 MAYBE_CONMETH (con, delete_console, (con));
716 Vconsole_list = delq_no_quit (console, Vconsole_list);
717 RESET_CHANGED_SET_FLAGS;
718 con->conmeths = dead_console_methods;
724 io_error_delete_console (Lisp_Object console)
726 delete_console_internal (XCONSOLE (console), 1, 0, 1);
729 DEFUN ("delete-console", Fdelete_console, 1, 2, 0, /*
730 Delete CONSOLE, permanently eliminating it from use.
731 Normally, you cannot delete the last non-minibuffer-only frame (you must
732 use `save-buffers-kill-emacs' or `kill-emacs'). However, if optional
733 second argument FORCE is non-nil, you can delete the last frame. (This
734 will automatically call `save-buffers-kill-emacs'.)
738 CHECK_CONSOLE (console);
739 delete_console_internal (XCONSOLE (console), !NILP (force), 0, 0);
743 DEFUN ("console-list", Fconsole_list, 0, 0, 0, /*
744 Return a list of all consoles.
748 return Fcopy_sequence (Vconsole_list);
751 DEFUN ("console-device-list", Fconsole_device_list, 0, 1, 0, /*
752 Return a list of all devices on CONSOLE.
753 If CONSOLE is nil, the selected console will be used.
757 return Fcopy_sequence (CONSOLE_DEVICE_LIST (decode_console (console)));
760 DEFUN ("console-enable-input", Fconsole_enable_input, 1, 1, 0, /*
761 Enable input on console CONSOLE.
765 struct console *con = decode_console (console);
766 if (!con->input_enabled)
767 event_stream_select_console (con);
771 DEFUN ("console-disable-input", Fconsole_disable_input, 1, 1, 0, /*
772 Disable input on console CONSOLE.
776 struct console *con = decode_console (console);
777 if (con->input_enabled)
778 event_stream_unselect_console (con);
782 DEFUN ("console-on-window-system-p", Fconsole_on_window_system_p, 0, 1, 0, /*
783 Return non-nil if this console is on a window system.
784 This generally means that there is support for the mouse, the menubar,
785 the toolbar, glyphs, etc.
789 Lisp_Object type = CONSOLE_TYPE (decode_console (console));
791 return !EQ (type, Qtty) && !EQ (type, Qstream) ? Qt : Qnil;
796 /**********************************************************************/
797 /* Miscellaneous low-level functions */
798 /**********************************************************************/
801 unwind_init_sys_modes (Lisp_Object console)
803 reinit_initial_console ();
805 if (!no_redraw_on_reenter &&
806 CONSOLEP (console) &&
807 CONSOLE_LIVE_P (XCONSOLE (console)))
810 XFRAME (DEVICE_SELECTED_FRAME
811 (XDEVICE (CONSOLE_SELECTED_DEVICE (XCONSOLE (console)))));
812 MARK_FRAME_CHANGED (f);
817 DEFUN ("suspend-emacs", Fsuspend_emacs, 0, 1, "", /*
818 Stop Emacs and return to superior process. You can resume later.
819 On systems that don't have job control, run a subshell instead.
821 If optional arg STUFFSTRING is non-nil, its characters are stuffed
822 to be read as terminal input by Emacs's superior shell.
824 Before suspending, run the normal hook `suspend-hook'.
825 After resumption run the normal hook `suspend-resume-hook'.
827 Some operating systems cannot stop the Emacs process and resume it later.
828 On such systems, Emacs will start a subshell and wait for it to exit.
832 int speccount = specpdl_depth ();
835 if (!NILP (stuffstring))
836 CHECK_STRING (stuffstring);
837 GCPRO1 (stuffstring);
839 /* There used to be a check that the initial console is TTY.
840 This is bogus. Even checking to see whether any console
841 is a controlling terminal is not correct -- maybe
842 the user used the -t option or something. If we want to
843 suspend, then we suspend. Period. */
845 /* Call value of suspend-hook. */
846 run_hook (Qsuspend_hook);
848 reset_initial_console ();
849 /* sys_suspend can get an error if it tries to fork a subshell
850 and the system resources aren't available for that. */
851 record_unwind_protect (unwind_init_sys_modes, Vcontrolling_terminal);
852 stuff_buffered_input (stuffstring);
854 /* the console is un-reset inside of the unwind-protect. */
855 unbind_to (speccount, Qnil);
858 /* It is possible that a size change occurred while we were
859 suspended. Assume one did just to be safe. It won't hurt
860 anything if one didn't. */
861 asynch_device_change_pending++;
864 /* Call value of suspend-resume-hook
865 if it is bound and value is non-nil. */
866 run_hook (Qsuspend_resume_hook);
872 /* If STUFFSTRING is a string, stuff its contents as pending terminal input.
873 Then in any case stuff anything Emacs has read ahead and not used. */
876 stuff_buffered_input (Lisp_Object stuffstring)
878 /* stuff_char works only in BSD, versions 4.2 and up. */
880 if (!CONSOLEP (Vcontrolling_terminal) ||
881 !CONSOLE_LIVE_P (XCONSOLE (Vcontrolling_terminal)))
884 if (STRINGP (stuffstring))
889 TO_EXTERNAL_FORMAT (LISP_STRING, stuffstring,
893 stuff_char (XCONSOLE (Vcontrolling_terminal), *p++);
894 stuff_char (XCONSOLE (Vcontrolling_terminal), '\n');
896 /* Anything we have read ahead, put back for the shell to read. */
897 # if 0 /* oh, who cares about this silliness */
898 while (kbd_fetch_ptr != kbd_store_ptr)
900 if (kbd_fetch_ptr == kbd_buffer + KBD_BUFFER_SIZE)
901 kbd_fetch_ptr = kbd_buffer;
902 stuff_char (XCONSOLE (Vcontrolling_terminal), *kbd_fetch_ptr++);
908 DEFUN ("suspend-console", Fsuspend_console, 0, 1, "", /*
909 Suspend a console. For tty consoles, it sends a signal to suspend
910 the process in charge of the tty, and removes the devices and
911 frames of that console from the display.
913 If optional arg CONSOLE is non-nil, it is the console to be suspended.
914 Otherwise it is assumed to be the selected console.
916 Some operating systems cannot stop processes and resume them later.
917 On such systems, who knows what will happen.
922 struct console *con = decode_console (console);
924 if (CONSOLE_TTY_P (con))
927 * hide all the unhidden frames so the display code won't update
928 * them while the console is suspended.
930 Lisp_Object device = CONSOLE_SELECTED_DEVICE (con);
933 struct device *d = XDEVICE (device);
934 Lisp_Object frame_list = DEVICE_FRAME_LIST (d);
935 while (CONSP (frame_list))
937 struct frame *f = XFRAME (XCAR (frame_list));
938 if (FRAME_REPAINT_P (f))
940 frame_list = XCDR (frame_list);
943 reset_one_console (con);
944 event_stream_unselect_console (con);
945 sys_suspend_process (XINT (Fconsole_tty_controlling_process (console)));
947 #endif /* HAVE_TTY */
952 DEFUN ("resume-console", Fresume_console, 1, 1, "", /*
953 Re-initialize a previously suspended console.
954 For tty consoles, do stuff to the tty to make it sane again.
959 struct console *con = decode_console (console);
961 if (CONSOLE_TTY_P (con))
963 /* raise the selected frame */
964 Lisp_Object device = CONSOLE_SELECTED_DEVICE (con);
967 struct device *d = XDEVICE (device);
968 Lisp_Object frame = DEVICE_SELECTED_FRAME (d);
971 /* force the frame to be cleared */
972 SET_FRAME_CLEAR (XFRAME (frame));
973 Fraise_frame (frame);
976 init_one_console (con);
977 event_stream_select_console (con);
979 /* The same as in Fsuspend_emacs: it is possible that a size
980 change occurred while we were suspended. Assume one did just
981 to be safe. It won't hurt anything if one didn't. */
982 asynch_device_change_pending++;
985 #endif /* HAVE_TTY */
990 DEFUN ("set-input-mode", Fset_input_mode, 3, 5, 0, /*
991 Set mode of reading keyboard input.
992 First arg is ignored, for backward compatibility.
993 Second arg FLOW non-nil means use ^S/^Q flow control for output to terminal
994 (no effect except in CBREAK mode).
995 Third arg META t means accept 8-bit input (for a Meta key).
996 META nil means ignore the top bit, on the assumption it is parity.
997 Otherwise, accept 8-bit input and don't use the top bit for Meta.
998 First three arguments only apply to TTY consoles.
999 Optional fourth arg QUIT if non-nil specifies character to use for quitting.
1000 Optional fifth arg CONSOLE specifies console to make changes to; nil means
1001 the selected console.
1002 See also `current-input-mode'.
1004 (ignored, flow, meta, quit, console))
1006 struct console *con = decode_console (console);
1007 int meta_key = (!CONSOLE_TTY_P (con) ? 1 :
1008 EQ (meta, Qnil) ? 0 :
1014 CHECK_CHAR_COERCE_INT (quit);
1015 CONSOLE_QUIT_CHAR (con) =
1016 ((unsigned int) XCHAR (quit)) & (meta_key ? 0377 : 0177);
1020 if (CONSOLE_TTY_P (con))
1022 reset_one_console (con);
1023 TTY_FLAGS (con).flow_control = !NILP (flow);
1024 TTY_FLAGS (con).meta_key = meta_key;
1025 init_one_console (con);
1032 DEFUN ("current-input-mode", Fcurrent_input_mode, 0, 1, 0, /*
1033 Return information about the way Emacs currently reads keyboard input.
1034 Optional arg CONSOLE specifies console to return information about; nil means
1035 the selected console.
1036 The value is a list of the form (nil FLOW META QUIT), where
1037 FLOW is non-nil if Emacs uses ^S/^Q flow control for output to the
1038 terminal; this does not apply if Emacs uses interrupt-driven input.
1039 META is t if accepting 8-bit input with 8th bit as Meta flag.
1040 META nil means ignoring the top bit, on the assumption it is parity.
1041 META is neither t nor nil if accepting 8-bit input and using
1042 all 8 bits as the character code.
1043 QUIT is the character Emacs currently uses to quit.
1044 FLOW, and META are only meaningful for TTY consoles.
1045 The elements of this list correspond to the arguments of
1050 struct console *con = decode_console (console);
1051 Lisp_Object flow, meta, quit;
1054 flow = CONSOLE_TTY_P (con) && TTY_FLAGS (con).flow_control ? Qt : Qnil;
1055 meta = (!CONSOLE_TTY_P (con) ? Qt :
1056 TTY_FLAGS (con).meta_key == 1 ? Qt :
1057 TTY_FLAGS (con).meta_key == 2 ? Qzero :
1063 quit = make_char (CONSOLE_QUIT_CHAR (con));
1065 return list4 (Qnil, flow, meta, quit);
1069 /************************************************************************/
1070 /* initialization */
1071 /************************************************************************/
1074 syms_of_console (void)
1076 INIT_LRECORD_IMPLEMENTATION (console);
1078 DEFSUBR (Fvalid_console_type_p);
1079 DEFSUBR (Fconsole_type_list);
1080 DEFSUBR (Fcdfw_console);
1081 DEFSUBR (Fselected_console);
1082 DEFSUBR (Fselect_console);
1083 DEFSUBR (Fconsolep);
1084 DEFSUBR (Fconsole_live_p);
1085 DEFSUBR (Fconsole_type);
1086 DEFSUBR (Fconsole_name);
1087 DEFSUBR (Fconsole_connection);
1088 DEFSUBR (Ffind_console);
1089 DEFSUBR (Fget_console);
1090 DEFSUBR (Fdelete_console);
1091 DEFSUBR (Fconsole_list);
1092 DEFSUBR (Fconsole_device_list);
1093 DEFSUBR (Fconsole_enable_input);
1094 DEFSUBR (Fconsole_disable_input);
1095 DEFSUBR (Fconsole_on_window_system_p);
1096 DEFSUBR (Fsuspend_console);
1097 DEFSUBR (Fresume_console);
1099 DEFSUBR (Fsuspend_emacs);
1100 DEFSUBR (Fset_input_mode);
1101 DEFSUBR (Fcurrent_input_mode);
1103 defsymbol (&Qconsolep, "consolep");
1104 defsymbol (&Qconsole_live_p, "console-live-p");
1106 defsymbol (&Qcreate_console_hook, "create-console-hook");
1107 defsymbol (&Qdelete_console_hook, "delete-console-hook");
1109 defsymbol (&Qsuspend_hook, "suspend-hook");
1110 defsymbol (&Qsuspend_resume_hook, "suspend-resume-hook");
1113 static const struct lrecord_description cte_description_1[] = {
1114 { XD_LISP_OBJECT, offsetof (console_type_entry, symbol) },
1115 { XD_STRUCT_PTR, offsetof (console_type_entry, meths), 1, &console_methods_description },
1119 static const struct struct_description cte_description = {
1120 sizeof (console_type_entry),
1124 static const struct lrecord_description cted_description_1[] = {
1125 XD_DYNARR_DESC (console_type_entry_dynarr, &cte_description),
1129 const struct struct_description cted_description = {
1130 sizeof (console_type_entry_dynarr),
1134 static const struct lrecord_description console_methods_description_1[] = {
1135 { XD_LISP_OBJECT, offsetof (struct console_methods, symbol) },
1136 { XD_LISP_OBJECT, offsetof (struct console_methods, predicate_symbol) },
1137 { XD_LISP_OBJECT, offsetof (struct console_methods, image_conversion_list) },
1141 const struct struct_description console_methods_description = {
1142 sizeof (struct console_methods),
1143 console_methods_description_1
1148 console_type_create (void)
1150 the_console_type_entry_dynarr = Dynarr_new (console_type_entry);
1151 dumpstruct(&the_console_type_entry_dynarr, &cted_description);
1153 Vconsole_type_list = Qnil;
1154 staticpro (&Vconsole_type_list);
1156 /* Initialize the dead console type */
1157 INITIALIZE_CONSOLE_TYPE (dead, "dead", "console-dead-p");
1159 /* then reset the console-type lists, because `dead' is not really
1160 a valid console type */
1161 Dynarr_reset (the_console_type_entry_dynarr);
1162 Vconsole_type_list = Qnil;
1166 reinit_vars_of_console (void)
1168 staticpro_nodump (&Vconsole_list);
1169 Vconsole_list = Qnil;
1170 staticpro_nodump (&Vselected_console);
1171 Vselected_console = Qnil;
1175 vars_of_console (void)
1177 reinit_vars_of_console ();
1179 DEFVAR_LISP ("create-console-hook", &Vcreate_console_hook /*
1180 Function or functions to call when a console is created.
1181 One argument, the newly-created console.
1182 This is called after the first frame has been created, but before
1183 calling the `create-device-hook' or `create-frame-hook'.
1184 Note that in general the console will not be selected.
1186 Vcreate_console_hook = Qnil;
1188 DEFVAR_LISP ("delete-console-hook", &Vdelete_console_hook /*
1189 Function or functions to call when a console is deleted.
1190 One argument, the to-be-deleted console.
1192 Vdelete_console_hook = Qnil;
1194 #ifdef HAVE_WINDOW_SYSTEM
1195 Fprovide (intern ("window-system"));
1199 /* The docstrings for DEFVAR_* are recorded externally by make-docfile. */
1200 #define DEFVAR_CONSOLE_LOCAL_1(lname, field_name, forward_type, magicfun) do { \
1201 static const struct symbol_value_forward I_hate_C = \
1202 { /* struct symbol_value_forward */ \
1203 { /* struct symbol_value_magic */ \
1204 { /* struct lcrecord_header */ \
1205 { /* struct lrecord_header */ \
1206 lrecord_type_symbol_value_forward, /* lrecord_type_index */ \
1208 1, /* c_readonly bit */ \
1209 1 /* lisp_readonly bit */ \
1215 &(console_local_flags.field_name), \
1222 int offset = ((char *)symbol_value_forward_forward (&I_hate_C) \
1223 - (char *)&console_local_flags); \
1225 defvar_magic (lname, &I_hate_C); \
1227 *((Lisp_Object *)(offset + (char *)XCONSOLE (Vconsole_local_symbols))) \
1232 #define DEFVAR_CONSOLE_LOCAL_MAGIC(lname, field_name, magicfun) \
1233 DEFVAR_CONSOLE_LOCAL_1 (lname, field_name, \
1234 SYMVAL_SELECTED_CONSOLE_FORWARD, magicfun)
1235 #define DEFVAR_CONSOLE_LOCAL(lname, field_name) \
1236 DEFVAR_CONSOLE_LOCAL_MAGIC (lname, field_name, 0)
1237 #define DEFVAR_CONST_CONSOLE_LOCAL_MAGIC(lname, field_name, magicfun) \
1238 DEFVAR_CONSOLE_LOCAL_1 (lname, field_name, \
1239 SYMVAL_CONST_SELECTED_CONSOLE_FORWARD, magicfun)
1240 #define DEFVAR_CONST_CONSOLE_LOCAL(lname, field_name) \
1241 DEFVAR_CONST_CONSOLE_LOCAL_MAGIC (lname, field_name, 0)
1243 #define DEFVAR_CONSOLE_DEFAULTS_MAGIC(lname, field_name, magicfun) \
1244 DEFVAR_SYMVAL_FWD(lname, &(console_local_flags.field_name), \
1245 SYMVAL_DEFAULT_CONSOLE_FORWARD, magicfun)
1246 #define DEFVAR_CONSOLE_DEFAULTS(lname, field_name) \
1247 DEFVAR_CONSOLE_DEFAULTS_MAGIC (lname, field_name, 0)
1250 nuke_all_console_slots (struct console *con, Lisp_Object zap)
1252 zero_lcrecord (con);
1254 #define MARKED_SLOT(x) con->x = zap
1255 #include "conslots.h"
1260 common_init_complex_vars_of_console (void)
1262 /* Make sure all markable slots in console_defaults
1263 are initialized reasonably, so mark_console won't choke.
1265 struct console *defs = alloc_lcrecord_type (struct console, &lrecord_console);
1266 struct console *syms = alloc_lcrecord_type (struct console, &lrecord_console);
1268 staticpro_nodump (&Vconsole_defaults);
1269 staticpro_nodump (&Vconsole_local_symbols);
1270 XSETCONSOLE (Vconsole_defaults, defs);
1271 XSETCONSOLE (Vconsole_local_symbols, syms);
1273 nuke_all_console_slots (syms, Qnil);
1274 nuke_all_console_slots (defs, Qnil);
1276 /* Set up the non-nil default values of various console slots.
1277 Must do these before making the first console.
1279 /* #### Anything needed here? */
1282 /* 0 means var is always local. Default used only at creation.
1283 * -1 means var is always local. Default used only at reset and
1285 * -2 means there's no lisp variable corresponding to this slot
1286 * and the default is only used at creation.
1287 * -3 means no Lisp variable. Default used only at reset and creation.
1288 * >0 is mask. Var is local if ((console->local_var_flags & mask) != 0)
1289 * Otherwise default is used.
1291 * #### We don't currently ever reset console variables, so there
1292 * is no current distinction between 0 and -1, and between -2 and -3.
1294 Lisp_Object always_local_resettable = make_int (-1);
1296 #if 0 /* not used */
1297 Lisp_Object always_local_no_default = make_int (0);
1298 Lisp_Object resettable = make_int (-3);
1301 /* Assign the local-flags to the slots that have default values.
1302 The local flag is a bit that is used in the console
1303 to say that it has its own local value for the slot.
1304 The local flag bits are in the local_var_flags slot of the
1307 nuke_all_console_slots (&console_local_flags, make_int (-2));
1308 console_local_flags.defining_kbd_macro = always_local_resettable;
1309 console_local_flags.last_kbd_macro = always_local_resettable;
1310 console_local_flags.prefix_arg = always_local_resettable;
1311 console_local_flags.default_minibuffer_frame = always_local_resettable;
1312 console_local_flags.overriding_terminal_local_map =
1313 always_local_resettable;
1315 console_local_flags.tty_erase_char = always_local_resettable;
1318 console_local_flags.function_key_map = make_int (1);
1320 /* #### Warning, 0x4000000 (that's six zeroes) is the largest number
1321 currently allowable due to the XINT() handling of this value.
1322 With some rearrangement you can get 4 more bits. */
1327 #define CONSOLE_SLOTS_SIZE (offsetof (struct console, CONSOLE_SLOTS_LAST_NAME) - offsetof (struct console, CONSOLE_SLOTS_FIRST_NAME) + sizeof (Lisp_Object))
1328 #define CONSOLE_SLOTS_COUNT (CONSOLE_SLOTS_SIZE / sizeof (Lisp_Object))
1331 reinit_complex_vars_of_console (void)
1333 struct console *defs, *syms;
1335 common_init_complex_vars_of_console ();
1337 defs = XCONSOLE (Vconsole_defaults);
1338 syms = XCONSOLE (Vconsole_local_symbols);
1339 memcpy (&defs->CONSOLE_SLOTS_FIRST_NAME,
1340 console_defaults_saved_slots,
1341 CONSOLE_SLOTS_SIZE);
1342 memcpy (&syms->CONSOLE_SLOTS_FIRST_NAME,
1343 console_local_symbols_saved_slots,
1344 CONSOLE_SLOTS_SIZE);
1348 static const struct lrecord_description console_slots_description_1[] = {
1349 { XD_LISP_OBJECT_ARRAY, 0, CONSOLE_SLOTS_COUNT },
1353 static const struct struct_description console_slots_description = {
1355 console_slots_description_1
1359 complex_vars_of_console (void)
1361 struct console *defs, *syms;
1363 common_init_complex_vars_of_console ();
1365 defs = XCONSOLE (Vconsole_defaults);
1366 syms = XCONSOLE (Vconsole_local_symbols);
1367 console_defaults_saved_slots = &defs->CONSOLE_SLOTS_FIRST_NAME;
1368 console_local_symbols_saved_slots = &syms->CONSOLE_SLOTS_FIRST_NAME;
1369 dumpstruct (&console_defaults_saved_slots, &console_slots_description);
1370 dumpstruct (&console_local_symbols_saved_slots, &console_slots_description);
1372 DEFVAR_CONSOLE_DEFAULTS ("default-function-key-map", function_key_map /*
1373 Default value of `function-key-map' for consoles that don't override it.
1374 This is the same as (default-value 'function-key-map).
1377 DEFVAR_CONSOLE_LOCAL ("function-key-map", function_key_map /*
1378 Keymap mapping ASCII function key sequences onto their preferred forms.
1379 This allows Emacs to recognize function keys sent from ASCII
1380 terminals at any point in a key sequence.
1382 The `read-key-sequence' function replaces any subsequence bound by
1383 `function-key-map' with its binding. More precisely, when the active
1384 keymaps have no binding for the current key sequence but
1385 `function-key-map' binds a suffix of the sequence to a vector or string,
1386 `read-key-sequence' replaces the matching suffix with its binding, and
1387 continues with the new sequence.
1389 The events that come from bindings in `function-key-map' are not
1390 themselves looked up in `function-key-map'.
1392 For example, suppose `function-key-map' binds `ESC O P' to [f1].
1393 Typing `ESC O P' to `read-key-sequence' would return
1394 \[#<keypress-event f1>]. Typing `C-x ESC O P' would return
1395 \[#<keypress-event control-X> #<keypress-event f1>]. If [f1]
1396 were a prefix key, typing `ESC O P x' would return
1397 \[#<keypress-event f1> #<keypress-event x>].
1401 /* #### Should this somehow go to TTY data? How do we make it
1402 accessible from Lisp, then? */
1403 DEFVAR_CONSOLE_LOCAL ("tty-erase-char", tty_erase_char /*
1404 The ERASE character as set by the user with stty.
1405 When this value cannot be determined or would be meaningless (on non-TTY
1406 consoles, for example), it is set to nil.
1410 /* While this should be const it can't be because some things
1411 (i.e. edebug) do manipulate it. */
1412 DEFVAR_CONSOLE_LOCAL ("defining-kbd-macro", defining_kbd_macro /*
1413 Non-nil while a keyboard macro is being defined. Don't set this!
1416 DEFVAR_CONSOLE_LOCAL ("last-kbd-macro", last_kbd_macro /*
1417 Last keyboard macro defined, as a vector of events; nil if none defined.
1420 DEFVAR_CONSOLE_LOCAL ("prefix-arg", prefix_arg /*
1421 The value of the prefix argument for the next editing command.
1422 It may be a number, or the symbol `-' for just a minus sign as arg,
1423 or a list whose car is a number for just one or more C-U's
1424 or nil if no argument has been specified.
1426 You cannot examine this variable to find the argument for this command
1427 since it has been set to nil by the time you can look.
1428 Instead, you should use the variable `current-prefix-arg', although
1429 normally commands can get this prefix argument with (interactive "P").
1432 DEFVAR_CONSOLE_LOCAL ("default-minibuffer-frame",
1433 default_minibuffer_frame /*
1434 Minibufferless frames use this frame's minibuffer.
1436 Emacs cannot create minibufferless frames unless this is set to an
1437 appropriate surrogate.
1439 XEmacs consults this variable only when creating minibufferless
1440 frames; once the frame is created, it sticks with its assigned
1441 minibuffer, no matter what this variable is set to. This means that
1442 this variable doesn't necessarily say anything meaningful about the
1443 current set of frames, or where the minibuffer is currently being
1447 DEFVAR_CONSOLE_LOCAL ("overriding-terminal-local-map",
1448 overriding_terminal_local_map /*
1449 Keymap that overrides all other local keymaps, for the selected console only.
1450 If this variable is non-nil, it is used as a keymap instead of the
1451 buffer's local map, and the minor mode keymaps and text property keymaps.
1454 /* Check for DEFVAR_CONSOLE_LOCAL without initializing the corresponding
1455 slot of console_local_flags and vice-versa. Must be done after all
1456 DEFVAR_CONSOLE_LOCAL() calls. */
1457 #define MARKED_SLOT(slot) \
1458 if ((XINT (console_local_flags.slot) != -2 && \
1459 XINT (console_local_flags.slot) != -3) \
1460 != !(NILP (XCONSOLE (Vconsole_local_symbols)->slot))) \
1462 #include "conslots.h"