1 /* Functions related to terminal devices.
2 Copyright (C) 2005 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 2, or (at your option)
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; see the file COPYING. If not, write to
18 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
19 Boston, MA 02110-1301, USA. */
27 #include "termhooks.h"
32 /* Chain of all terminals currently in use. */
33 struct terminal
*terminal_list
;
35 /* The first unallocated terminal id. */
36 static int next_terminal_id
;
38 /* The initial terminal device, created by initial_term_init. */
39 struct terminal
*initial_terminal
;
41 /* Function to use to ring the bell. */
42 Lisp_Object Vring_bell_function
;
44 static void delete_initial_terminal
P_ ((struct terminal
*));
49 ring_bell (struct frame
*f
)
51 if (!NILP (Vring_bell_function
))
55 /* Temporarily set the global variable to nil
56 so that if we get an error, it stays nil
57 and we don't call it over and over.
59 We don't specbind it, because that would carefully
60 restore the bad value if there's an error
61 and make the loop of errors happen anyway. */
63 function
= Vring_bell_function
;
64 Vring_bell_function
= Qnil
;
68 Vring_bell_function
= function
;
70 else if (FRAME_TERMINAL (f
)->ring_bell_hook
)
71 (*FRAME_TERMINAL (f
)->ring_bell_hook
) (f
);
75 update_begin (struct frame
*f
)
77 if (FRAME_TERMINAL (f
)->update_begin_hook
)
78 (*FRAME_TERMINAL (f
)->update_begin_hook
) (f
);
82 update_end (struct frame
*f
)
84 if (FRAME_TERMINAL (f
)->update_end_hook
)
85 (*FRAME_TERMINAL (f
)->update_end_hook
) (f
);
88 /* Specify how many text lines, from the top of the window,
89 should be affected by insert-lines and delete-lines operations.
90 This, and those operations, are used only within an update
91 that is bounded by calls to update_begin and update_end. */
94 set_terminal_window (struct frame
*f
, int size
)
96 if (FRAME_TERMINAL (f
)->set_terminal_window_hook
)
97 (*FRAME_TERMINAL (f
)->set_terminal_window_hook
) (f
, size
);
100 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
101 frame-relative coordinates. */
104 cursor_to (struct frame
*f
, int vpos
, int hpos
)
106 if (FRAME_TERMINAL (f
)->cursor_to_hook
)
107 (*FRAME_TERMINAL (f
)->cursor_to_hook
) (f
, vpos
, hpos
);
110 /* Similar but don't take any account of the wasted characters. */
113 raw_cursor_to (struct frame
*f
, int row
, int col
)
115 if (FRAME_TERMINAL (f
)->raw_cursor_to_hook
)
116 (*FRAME_TERMINAL (f
)->raw_cursor_to_hook
) (f
, row
, col
);
119 /* Erase operations */
121 /* Clear from cursor to end of frame. */
123 clear_to_end (struct frame
*f
)
125 if (FRAME_TERMINAL (f
)->clear_to_end_hook
)
126 (*FRAME_TERMINAL (f
)->clear_to_end_hook
) (f
);
129 /* Clear entire frame */
132 clear_frame (struct frame
*f
)
134 if (FRAME_TERMINAL (f
)->clear_frame_hook
)
135 (*FRAME_TERMINAL (f
)->clear_frame_hook
) (f
);
138 /* Clear from cursor to end of line.
139 Assume that the line is already clear starting at column first_unused_hpos.
141 Note that the cursor may be moved, on terminals lacking a `ce' string. */
144 clear_end_of_line (struct frame
*f
, int first_unused_hpos
)
146 if (FRAME_TERMINAL (f
)->clear_end_of_line_hook
)
147 (*FRAME_TERMINAL (f
)->clear_end_of_line_hook
) (f
, first_unused_hpos
);
150 /* Output LEN glyphs starting at STRING at the nominal cursor position.
151 Advance the nominal cursor over the text. */
154 write_glyphs (struct frame
*f
, struct glyph
*string
, int len
)
156 if (FRAME_TERMINAL (f
)->write_glyphs_hook
)
157 (*FRAME_TERMINAL (f
)->write_glyphs_hook
) (f
, string
, len
);
160 /* Insert LEN glyphs from START at the nominal cursor position.
162 If start is zero, insert blanks instead of a string at start */
165 insert_glyphs (struct frame
*f
, struct glyph
*start
, int len
)
170 if (FRAME_TERMINAL (f
)->insert_glyphs_hook
)
171 (*FRAME_TERMINAL (f
)->insert_glyphs_hook
) (f
, start
, len
);
174 /* Delete N glyphs at the nominal cursor position. */
177 delete_glyphs (struct frame
*f
, int n
)
179 if (FRAME_TERMINAL (f
)->delete_glyphs_hook
)
180 (*FRAME_TERMINAL (f
)->delete_glyphs_hook
) (f
, n
);
183 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
186 ins_del_lines (struct frame
*f
, int vpos
, int n
)
188 if (FRAME_TERMINAL (f
)->ins_del_lines_hook
)
189 (*FRAME_TERMINAL (f
)->ins_del_lines_hook
) (f
, vpos
, n
);
195 /* Return the terminal object specified by TERMINAL. TERMINAL may be a
196 terminal id, a frame, or nil for the terminal device of the current
197 frame. If THROW is zero, return NULL for failure, otherwise throw
201 get_terminal (Lisp_Object terminal
, int throw)
203 struct terminal
*result
= NULL
;
206 terminal
= selected_frame
;
208 if (INTEGERP (terminal
))
212 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
214 if (t
->id
== XINT (terminal
))
221 else if (FRAMEP (terminal
))
223 result
= FRAME_TERMINAL (XFRAME (terminal
));
226 if (result
== NULL
&& throw)
227 wrong_type_argument (Qterminal_live_p
, terminal
);
234 /* Create a new terminal object and add it to the terminal list. */
237 create_terminal (void)
239 struct terminal
*terminal
= (struct terminal
*) xmalloc (sizeof (struct terminal
));
241 bzero (terminal
, sizeof (struct terminal
));
242 terminal
->next_terminal
= terminal_list
;
243 terminal_list
= terminal
;
245 terminal
->id
= next_terminal_id
++;
247 terminal
->keyboard_coding
=
248 (struct coding_system
*) xmalloc (sizeof (struct coding_system
));
249 terminal
->terminal_coding
=
250 (struct coding_system
*) xmalloc (sizeof (struct coding_system
));
252 setup_coding_system (Qnil
, terminal
->keyboard_coding
);
253 setup_coding_system (Qnil
, terminal
->terminal_coding
);
255 terminal
->param_alist
= Qnil
;
259 /* Mark the Lisp pointers in the terminal objects.
260 Called by the Fgarbage_collector. */
263 mark_terminals (void)
266 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
268 mark_object (t
->param_alist
);
273 /* Low-level function to close all frames on a terminal, remove it
274 from the terminal list and free its memory. */
277 delete_terminal (struct terminal
*terminal
)
279 struct terminal
**tp
;
280 Lisp_Object tail
, frame
;
282 /* Protect against recursive calls. Fdelete_frame calls the
283 delete_terminal_hook when we delete our last frame. */
284 if (terminal
->deleted
)
286 terminal
->deleted
= 1;
288 /* Check for live frames that are still on this terminal. */
289 FOR_EACH_FRAME (tail
, frame
)
291 struct frame
*f
= XFRAME (frame
);
292 if (FRAME_LIVE_P (f
) && f
->terminal
== terminal
)
294 Fdelete_frame (frame
, Qt
);
298 for (tp
= &terminal_list
; *tp
!= terminal
; tp
= &(*tp
)->next_terminal
)
301 *tp
= terminal
->next_terminal
;
303 if (terminal
->keyboard_coding
)
304 xfree (terminal
->keyboard_coding
);
305 if (terminal
->terminal_coding
)
306 xfree (terminal
->terminal_coding
);
308 xfree (terminal
->name
);
311 if (terminal
->kboard
&& --terminal
->kboard
->reference_count
== 0)
312 delete_kboard (terminal
->kboard
);
315 bzero (terminal
, sizeof (struct terminal
));
319 DEFUN ("delete-terminal", Fdelete_terminal
, Sdelete_terminal
, 0, 2, 0,
320 doc
: /* Delete TERMINAL by deleting all frames on it and closing the terminal.
321 TERMINAL may be a terminal id, a frame, or nil (meaning the selected
324 Normally, you may not delete a display if all other displays are suspended,
325 but if the second argument FORCE is non-nil, you may do so. */)
327 Lisp_Object terminal
, force
;
329 struct terminal
*t
, *p
;
331 t
= get_terminal (terminal
, 0);
337 while (p
&& (p
== t
|| !TERMINAL_ACTIVE_P (p
)))
338 p
= p
->next_terminal
;
340 if (NILP (force
) && !p
)
341 error ("Attempt to delete the sole active display terminal");
343 if (t
->delete_terminal_hook
)
344 (*t
->delete_terminal_hook
) (t
);
352 DEFUN ("frame-terminal", Fframe_terminal
, Sframe_terminal
, 0, 1, 0,
353 doc
: /* Return the terminal that FRAME is displayed on.
354 If FRAME is nil, the selected frame is used.
356 The terminal device is represented by its integer identifier. */)
363 frame
= selected_frame
;
365 CHECK_LIVE_FRAME (frame
);
367 t
= get_terminal (frame
, 0);
372 return make_number (t
->id
);
375 DEFUN ("terminal-live-p", Fterminal_live_p
, Sterminal_live_p
, 1, 1, 0,
376 doc
: /* Return non-nil if OBJECT is a terminal which has not been deleted.
377 Value is nil if OBJECT is not a live display terminal.
378 If object is a live display terminal, the return value indicates what
379 sort of output terminal it uses. See the documentation of `framep' for
380 possible return values.
382 Display terminals are represented by their integer identifiers. */)
388 if (!INTEGERP (object
))
391 t
= get_terminal (object
, 0);
398 case output_initial
: /* The initial frame is like a termcap frame. */
401 case output_x_window
:
405 case output_msdos_raw
:
414 DEFUN ("terminal-list", Fterminal_list
, Sterminal_list
, 0, 0, 0,
415 doc
: /* Return a list of all terminal devices.
416 Terminal devices are represented by their integer identifiers. */)
419 Lisp_Object terminals
= Qnil
;
422 for (t
= terminal_list
; t
; t
= t
->next_terminal
)
423 terminals
= Fcons (make_number (t
->id
), terminals
);
428 DEFUN ("terminal-name", Fterminal_name
, Sterminal_name
, 0, 1, 0,
429 doc
: /* Return the name of the terminal device TERMINAL.
430 It is not guaranteed that the returned value is unique among opened devices.
432 TERMINAL may be a terminal id, a frame, or nil (meaning the
433 selected frame's terminal). */)
435 Lisp_Object terminal
;
437 struct terminal
*t
= get_terminal (terminal
, 1);
440 return build_string (t
->name
);
447 /* Return the value of terminal parameter PARAM in terminal T. */
449 get_terminal_param (t
, param
)
453 Lisp_Object tem
= Fassq (param
, t
->param_alist
);
459 /* Set the value of terminal parameter PARAMETER in terminal D to VALUE.
460 Return the previous value. */
463 store_terminal_param (t
, parameter
, value
)
465 Lisp_Object parameter
;
468 Lisp_Object old_alist_elt
= Fassq (parameter
, t
->param_alist
);
469 if (EQ (old_alist_elt
, Qnil
))
471 t
->param_alist
= Fcons (Fcons (parameter
, value
), t
->param_alist
);
476 Lisp_Object result
= Fcdr (old_alist_elt
);
477 Fsetcdr (old_alist_elt
, value
);
483 DEFUN ("terminal-parameters", Fterminal_parameters
, Sterminal_parameters
, 0, 1, 0,
484 doc
: /* Return the parameter-alist of terminal TERMINAL.
485 The value is a list of elements of the form (PARM . VALUE), where PARM
488 TERMINAL can be a terminal id, a frame or nil (meaning the selected
489 frame's terminal). */)
491 Lisp_Object terminal
;
493 struct terminal
*t
= get_terminal (terminal
, 1);
494 return Fcopy_alist (t
->param_alist
);
497 DEFUN ("terminal-parameter", Fterminal_parameter
, Sterminal_parameter
, 2, 2, 0,
498 doc
: /* Return TERMINAL's value for parameter PARAMETER.
499 TERMINAL can be a terminal id, a frame or nil (meaning the selected
500 frame's terminal). */)
501 (terminal
, parameter
)
502 Lisp_Object terminal
;
503 Lisp_Object parameter
;
506 struct terminal
*t
= get_terminal (terminal
, 1);
507 CHECK_SYMBOL (parameter
);
508 value
= Fcdr (Fassq (parameter
, t
->param_alist
));
512 DEFUN ("modify-terminal-parameters", Fmodify_terminal_parameters
,
513 Smodify_terminal_parameters
, 2, 2, 0,
514 doc
: /* Modify the parameters of terminal TERMINAL according to ALIST.
515 ALIST is an alist of parameters to change and their new values.
516 Each element of ALIST has the form (PARM . VALUE), where PARM is a symbol.
518 TERMINAL can be a terminal id, a frame or nil (meaning the selected
519 frame's terminal). */)
521 Lisp_Object terminal
;
524 Lisp_Object tail
, prop
, val
;
525 struct terminal
*t
= get_terminal (terminal
, 1);
526 int length
= XINT (Fsafe_length (alist
));
528 Lisp_Object
*parms
= (Lisp_Object
*) alloca (length
* sizeof (Lisp_Object
));
529 Lisp_Object
*values
= (Lisp_Object
*) alloca (length
* sizeof (Lisp_Object
));
531 /* Extract parm names and values into those vectors. */
534 for (tail
= alist
; CONSP (tail
); tail
= Fcdr (tail
))
539 parms
[i
] = Fcar (elt
);
540 values
[i
] = Fcdr (elt
);
544 /* Now process them in reverse of specified order. */
545 for (i
--; i
>= 0; i
--)
549 store_terminal_param (t
, prop
, val
);
554 DEFUN ("set-terminal-parameter", Fset_terminal_parameter
,
555 Sset_terminal_parameter
, 3, 3, 0,
556 doc
: /* Set TERMINAL's value for parameter PARAMETER to VALUE.
557 Return the previous value of PARAMETER.
559 TERMINAL can be a terminal id, a frame or nil (meaning the selected
560 frame's terminal). */)
561 (terminal
, parameter
, value
)
562 Lisp_Object terminal
;
563 Lisp_Object parameter
;
566 struct terminal
*t
= get_terminal (terminal
, 1);
567 return store_terminal_param (t
, parameter
, value
);
572 /* Create the bootstrap display terminal for the initial frame.
573 Returns a terminal of type output_initial. */
576 init_initial_terminal (void)
578 if (initialized
|| terminal_list
|| tty_list
)
581 initial_terminal
= create_terminal ();
582 initial_terminal
->type
= output_initial
;
583 initial_terminal
->name
= xstrdup ("initial_terminal");
584 initial_terminal
->kboard
= initial_kboard
;
586 initial_terminal
->delete_terminal_hook
= &delete_initial_terminal
;
587 /* All other hooks are NULL. */
589 return initial_terminal
;
592 /* Deletes the bootstrap terminal device.
593 Called through delete_terminal_hook. */
596 delete_initial_terminal (struct terminal
*terminal
)
598 if (terminal
!= initial_terminal
)
601 delete_terminal (terminal
);
602 initial_terminal
= NULL
;
609 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function
,
610 doc
: /* Non-nil means call this function to ring the bell.
611 The function should accept no arguments. */);
612 Vring_bell_function
= Qnil
;
614 defsubr (&Sdelete_terminal
);
615 defsubr (&Sframe_terminal
);
616 defsubr (&Sterminal_live_p
);
617 defsubr (&Sterminal_list
);
618 defsubr (&Sterminal_name
);
619 defsubr (&Sterminal_parameters
);
620 defsubr (&Sterminal_parameter
);
621 defsubr (&Smodify_terminal_parameters
);
622 defsubr (&Sset_terminal_parameter
);
624 Fprovide (intern ("multi-tty"), Qnil
);
627 /* arch-tag: e9af6f27-b483-47dc-bb1a-730c1c5cab03
628 (do not change this comment) */