1 /* Functions related to terminal devices.
2 Copyright (C) 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
4 This file is part of GNU Emacs.
6 GNU Emacs is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 3 of the License, or
9 (at your option) any later version.
11 GNU Emacs is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. */
26 #include "termhooks.h"
31 /* Chain of all terminals currently in use. */
32 struct terminal
*terminal_list
;
34 /* The first unallocated terminal id. */
35 static int next_terminal_id
;
37 /* The initial terminal device, created by initial_term_init. */
38 struct terminal
*initial_terminal
;
40 /* Function to use to ring the bell. */
41 Lisp_Object Vring_bell_function
;
43 static void delete_initial_terminal (struct terminal
*);
48 ring_bell (struct frame
*f
)
50 if (!NILP (Vring_bell_function
))
54 /* Temporarily set the global variable to nil
55 so that if we get an error, it stays nil
56 and we don't call it over and over.
58 We don't specbind it, because that would carefully
59 restore the bad value if there's an error
60 and make the loop of errors happen anyway. */
62 function
= Vring_bell_function
;
63 Vring_bell_function
= Qnil
;
67 Vring_bell_function
= function
;
69 else if (FRAME_TERMINAL (f
)->ring_bell_hook
)
70 (*FRAME_TERMINAL (f
)->ring_bell_hook
) (f
);
74 update_begin (struct frame
*f
)
76 if (FRAME_TERMINAL (f
)->update_begin_hook
)
77 (*FRAME_TERMINAL (f
)->update_begin_hook
) (f
);
81 update_end (struct frame
*f
)
83 if (FRAME_TERMINAL (f
)->update_end_hook
)
84 (*FRAME_TERMINAL (f
)->update_end_hook
) (f
);
87 /* Specify how many text lines, from the top of the window,
88 should be affected by insert-lines and delete-lines operations.
89 This, and those operations, are used only within an update
90 that is bounded by calls to update_begin and update_end. */
93 set_terminal_window (struct frame
*f
, int size
)
95 if (FRAME_TERMINAL (f
)->set_terminal_window_hook
)
96 (*FRAME_TERMINAL (f
)->set_terminal_window_hook
) (f
, size
);
99 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
100 frame-relative coordinates. */
103 cursor_to (struct frame
*f
, int vpos
, int hpos
)
105 if (FRAME_TERMINAL (f
)->cursor_to_hook
)
106 (*FRAME_TERMINAL (f
)->cursor_to_hook
) (f
, vpos
, hpos
);
109 /* Similar but don't take any account of the wasted characters. */
112 raw_cursor_to (struct frame
*f
, int row
, int col
)
114 if (FRAME_TERMINAL (f
)->raw_cursor_to_hook
)
115 (*FRAME_TERMINAL (f
)->raw_cursor_to_hook
) (f
, row
, col
);
118 /* Erase operations */
120 /* Clear from cursor to end of frame. */
122 clear_to_end (struct frame
*f
)
124 if (FRAME_TERMINAL (f
)->clear_to_end_hook
)
125 (*FRAME_TERMINAL (f
)->clear_to_end_hook
) (f
);
128 /* Clear entire frame */
131 clear_frame (struct frame
*f
)
133 if (FRAME_TERMINAL (f
)->clear_frame_hook
)
134 (*FRAME_TERMINAL (f
)->clear_frame_hook
) (f
);
137 /* Clear from cursor to end of line.
138 Assume that the line is already clear starting at column first_unused_hpos.
140 Note that the cursor may be moved, on terminals lacking a `ce' string. */
143 clear_end_of_line (struct frame
*f
, int first_unused_hpos
)
145 if (FRAME_TERMINAL (f
)->clear_end_of_line_hook
)
146 (*FRAME_TERMINAL (f
)->clear_end_of_line_hook
) (f
, first_unused_hpos
);
149 /* Output LEN glyphs starting at STRING at the nominal cursor position.
150 Advance the nominal cursor over the text. */
153 write_glyphs (struct frame
*f
, struct glyph
*string
, int len
)
155 if (FRAME_TERMINAL (f
)->write_glyphs_hook
)
156 (*FRAME_TERMINAL (f
)->write_glyphs_hook
) (f
, string
, len
);
159 /* Insert LEN glyphs from START at the nominal cursor position.
161 If start is zero, insert blanks instead of a string at start */
164 insert_glyphs (struct frame
*f
, struct glyph
*start
, int len
)
169 if (FRAME_TERMINAL (f
)->insert_glyphs_hook
)
170 (*FRAME_TERMINAL (f
)->insert_glyphs_hook
) (f
, start
, len
);
173 /* Delete N glyphs at the nominal cursor position. */
176 delete_glyphs (struct frame
*f
, int n
)
178 if (FRAME_TERMINAL (f
)->delete_glyphs_hook
)
179 (*FRAME_TERMINAL (f
)->delete_glyphs_hook
) (f
, n
);
182 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
185 ins_del_lines (struct frame
*f
, int vpos
, int n
)
187 if (FRAME_TERMINAL (f
)->ins_del_lines_hook
)
188 (*FRAME_TERMINAL (f
)->ins_del_lines_hook
) (f
, vpos
, n
);
194 /* Return the terminal object specified by TERMINAL. TERMINAL may be
195 a terminal object, a frame, or nil for the terminal device of the
196 current frame. If THROW is zero, return NULL for failure,
197 otherwise throw an error. */
200 get_terminal (Lisp_Object terminal
, int throw)
202 struct terminal
*result
= NULL
;
205 terminal
= selected_frame
;
207 if (TERMINALP (terminal
))
208 result
= XTERMINAL (terminal
);
209 else if (FRAMEP (terminal
))
210 result
= FRAME_TERMINAL (XFRAME (terminal
));
212 if (result
&& !result
->name
)
215 if (result
== NULL
&& throw)
216 wrong_type_argument (Qterminal_live_p
, terminal
);
223 /* Create a new terminal object and add it to the terminal list. */
226 create_terminal (void)
228 struct terminal
*terminal
= allocate_terminal ();
230 terminal
->name
= NULL
;
231 terminal
->next_terminal
= terminal_list
;
232 terminal_list
= terminal
;
234 terminal
->id
= next_terminal_id
++;
236 terminal
->keyboard_coding
=
237 (struct coding_system
*) xmalloc (sizeof (struct coding_system
));
238 terminal
->terminal_coding
=
239 (struct coding_system
*) xmalloc (sizeof (struct coding_system
));
241 setup_coding_system (Qno_conversion
, terminal
->keyboard_coding
);
242 setup_coding_system (Qundecided
, terminal
->terminal_coding
);
244 terminal
->param_alist
= Qnil
;
248 /* Low-level function to close all frames on a terminal, remove it
249 from the terminal list and free its memory. */
252 delete_terminal (struct terminal
*terminal
)
254 struct terminal
**tp
;
255 Lisp_Object tail
, frame
;
257 /* Protect against recursive calls. delete_frame calls the
258 delete_terminal_hook when we delete our last frame. */
261 xfree (terminal
->name
);
262 terminal
->name
= NULL
;
264 /* Check for live frames that are still on this terminal. */
265 FOR_EACH_FRAME (tail
, frame
)
267 struct frame
*f
= XFRAME (frame
);
268 if (FRAME_LIVE_P (f
) && f
->terminal
== terminal
)
270 /* Pass Qnoelisp rather than Qt. */
271 delete_frame (frame
, Qnoelisp
);
275 for (tp
= &terminal_list
; *tp
!= terminal
; tp
= &(*tp
)->next_terminal
)
278 *tp
= terminal
->next_terminal
;
280 xfree (terminal
->keyboard_coding
);
281 terminal
->keyboard_coding
= NULL
;
282 xfree (terminal
->terminal_coding
);
283 terminal
->terminal_coding
= NULL
;
285 if (terminal
->kboard
&& --terminal
->kboard
->reference_count
== 0)
287 delete_kboard (terminal
->kboard
);
288 terminal
->kboard
= NULL
;
292 Lisp_Object Qrun_hook_with_args
;
293 static Lisp_Object Qdelete_terminal_functions
;
294 static Lisp_Object Vdelete_terminal_functions
;
296 DEFUN ("delete-terminal", Fdelete_terminal
, Sdelete_terminal
, 0, 2, 0,
297 doc
: /* Delete TERMINAL by deleting all frames on it and closing the terminal.
298 TERMINAL may be a terminal object, a frame, or nil (meaning the
299 selected frame's terminal).
301 Normally, you may not delete a display if all other displays are suspended,
302 but if the second argument FORCE is non-nil, you may do so. */)
304 Lisp_Object terminal
, force
;
306 struct terminal
*t
= get_terminal (terminal
, 0);
313 struct terminal
*p
= terminal_list
;
314 while (p
&& (p
== t
|| !TERMINAL_ACTIVE_P (p
)))
315 p
= p
->next_terminal
;
318 error ("Attempt to delete the sole active display terminal");
321 if (NILP (Vrun_hooks
))
323 else if (EQ (force
, Qnoelisp
))
325 = Fcons (list3 (Qrun_hook_with_args
,
326 Qdelete_terminal_functions
, terminal
),
329 safe_call2 (Qrun_hook_with_args
, Qdelete_terminal_functions
, terminal
);
331 if (t
->delete_terminal_hook
)
332 (*t
->delete_terminal_hook
) (t
);
340 DEFUN ("frame-terminal", Fframe_terminal
, Sframe_terminal
, 0, 1, 0,
341 doc
: /* Return the terminal that FRAME is displayed on.
342 If FRAME is nil, the selected frame is used.
344 The terminal device is represented by its integer identifier. */)
351 frame
= selected_frame
;
353 CHECK_LIVE_FRAME (frame
);
355 t
= FRAME_TERMINAL (XFRAME (frame
));
361 Lisp_Object terminal
;
362 XSETTERMINAL (terminal
, t
);
367 DEFUN ("terminal-live-p", Fterminal_live_p
, Sterminal_live_p
, 1, 1, 0,
368 doc
: /* Return non-nil if OBJECT is a terminal which has not been deleted.
369 Value is nil if OBJECT is not a live display terminal.
370 If object is a live display terminal, the return value indicates what
371 sort of output terminal it uses. See the documentation of `framep' for
372 possible return values. */)
378 t
= get_terminal (object
, 0);
385 case output_initial
: /* The initial frame is like a termcap frame. */
388 case output_x_window
:
392 case output_msdos_raw
:
403 DEFUN ("terminal-list", Fterminal_list
, Sterminal_list
, 0, 0, 0,
404 doc
: /* Return a list of all terminal devices. */)
407 Lisp_Object terminal
, terminals
= Qnil
;
410 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
412 XSETTERMINAL (terminal
, t
);
413 terminals
= Fcons (terminal
, terminals
);
419 DEFUN ("terminal-name", Fterminal_name
, Sterminal_name
, 0, 1, 0,
420 doc
: /* Return the name of the terminal device TERMINAL.
421 It is not guaranteed that the returned value is unique among opened devices.
423 TERMINAL may be a terminal object, a frame, or nil (meaning the
424 selected frame's terminal). */)
426 Lisp_Object terminal
;
429 = TERMINALP (terminal
) ? XTERMINAL (terminal
) : get_terminal (terminal
, 1);
431 return t
->name
? build_string (t
->name
) : Qnil
;
436 /* Return the value of terminal parameter PARAM in terminal T. */
438 get_terminal_param (struct terminal
*t
, Lisp_Object param
)
440 Lisp_Object tem
= Fassq (param
, t
->param_alist
);
446 /* Set the value of terminal parameter PARAMETER in terminal D to VALUE.
447 Return the previous value. */
450 store_terminal_param (struct terminal
*t
, Lisp_Object parameter
, Lisp_Object value
)
452 Lisp_Object old_alist_elt
= Fassq (parameter
, t
->param_alist
);
453 if (EQ (old_alist_elt
, Qnil
))
455 t
->param_alist
= Fcons (Fcons (parameter
, value
), t
->param_alist
);
460 Lisp_Object result
= Fcdr (old_alist_elt
);
461 Fsetcdr (old_alist_elt
, value
);
467 DEFUN ("terminal-parameters", Fterminal_parameters
, Sterminal_parameters
, 0, 1, 0,
468 doc
: /* Return the parameter-alist of terminal TERMINAL.
469 The value is a list of elements of the form (PARM . VALUE), where PARM
472 TERMINAL can be a terminal object, a frame, or nil (meaning the
473 selected frame's terminal). */)
475 Lisp_Object terminal
;
478 = TERMINALP (terminal
) ? XTERMINAL (terminal
) : get_terminal (terminal
, 1);
479 return Fcopy_alist (t
->param_alist
);
482 DEFUN ("terminal-parameter", Fterminal_parameter
, Sterminal_parameter
, 2, 2, 0,
483 doc
: /* Return TERMINAL's value for parameter PARAMETER.
484 TERMINAL can be a terminal object, a frame, or nil (meaning the
485 selected frame's terminal). */)
486 (terminal
, parameter
)
487 Lisp_Object terminal
;
488 Lisp_Object parameter
;
492 = TERMINALP (terminal
) ? XTERMINAL (terminal
) : get_terminal (terminal
, 1);
493 CHECK_SYMBOL (parameter
);
494 value
= Fcdr (Fassq (parameter
, t
->param_alist
));
498 DEFUN ("set-terminal-parameter", Fset_terminal_parameter
,
499 Sset_terminal_parameter
, 3, 3, 0,
500 doc
: /* Set TERMINAL's value for parameter PARAMETER to VALUE.
501 Return the previous value of PARAMETER.
503 TERMINAL can be a terminal object, a frame or nil (meaning the
504 selected frame's terminal). */)
505 (terminal
, parameter
, value
)
506 Lisp_Object terminal
;
507 Lisp_Object parameter
;
511 = TERMINALP (terminal
) ? XTERMINAL (terminal
) : get_terminal (terminal
, 1);
512 return store_terminal_param (t
, parameter
, value
);
517 /* Create the bootstrap display terminal for the initial frame.
518 Returns a terminal of type output_initial. */
521 init_initial_terminal (void)
523 if (initialized
|| terminal_list
|| tty_list
)
526 initial_terminal
= create_terminal ();
527 initial_terminal
->type
= output_initial
;
528 initial_terminal
->name
= xstrdup ("initial_terminal");
529 initial_terminal
->kboard
= initial_kboard
;
530 initial_terminal
->delete_terminal_hook
= &delete_initial_terminal
;
531 /* All other hooks are NULL. */
533 return initial_terminal
;
536 /* Deletes the bootstrap terminal device.
537 Called through delete_terminal_hook. */
540 delete_initial_terminal (struct terminal
*terminal
)
542 if (terminal
!= initial_terminal
)
545 delete_terminal (terminal
);
546 initial_terminal
= NULL
;
550 syms_of_terminal (void)
553 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function
,
554 doc
: /* Non-nil means call this function to ring the bell.
555 The function should accept no arguments. */);
556 Vring_bell_function
= Qnil
;
558 DEFVAR_LISP ("delete-terminal-functions", &Vdelete_terminal_functions
,
559 doc
: /* Special hook run when a terminal is deleted.
560 Each function is called with argument, the terminal.
561 This may be called just before actually deleting the terminal,
562 or some time later. */);
563 Vdelete_terminal_functions
= Qnil
;
564 Qdelete_terminal_functions
= intern_c_string ("delete-terminal-functions");
565 staticpro (&Qdelete_terminal_functions
);
566 Qrun_hook_with_args
= intern_c_string ("run-hook-with-args");
567 staticpro (&Qrun_hook_with_args
);
569 defsubr (&Sdelete_terminal
);
570 defsubr (&Sframe_terminal
);
571 defsubr (&Sterminal_live_p
);
572 defsubr (&Sterminal_list
);
573 defsubr (&Sterminal_name
);
574 defsubr (&Sterminal_parameters
);
575 defsubr (&Sterminal_parameter
);
576 defsubr (&Sset_terminal_parameter
);
578 Fprovide (intern_c_string ("multi-tty"), Qnil
);
581 /* arch-tag: e9af6f27-b483-47dc-bb1a-730c1c5cab03
582 (do not change this comment) */