src/terminal.c

   1 /* Functions related to terminal devices.
   2    Copyright (C) 2005-2011 Free Software Foundation, Inc.
   3
   4 This file is part of GNU Emacs.
   5
   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.
  10
  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.
  15
  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/>.  */
  18
  19 #include <config.h>
  20 #include <stdio.h>
  21 #include <setjmp.h>
  22
  23 #include "lisp.h"
  24 #include "frame.h"
  25 #include "termchar.h"
  26 #include "termhooks.h"
  27 #include "charset.h"
  28 #include "coding.h"
  29 #include "keyboard.h"
  30
  31 /* Chain of all terminals currently in use. */
  32 struct terminal *terminal_list;
  33
  34 /* The first unallocated terminal id. */
  35 static int next_terminal_id;
  36
  37 /* The initial terminal device, created by initial_term_init. */
  38 struct terminal *initial_terminal;
  39
  40 static void delete_initial_terminal (struct terminal *);
  41
  42 \f
  43
  44 void
  45 ring_bell (struct frame *f)
  46 {
  47   if (!NILP (Vring_bell_function))
  48     {
  49       Lisp_Object function;
  50
  51       /* Temporarily set the global variable to nil
  52          so that if we get an error, it stays nil
  53          and we don't call it over and over.
  54
  55          We don't specbind it, because that would carefully
  56          restore the bad value if there's an error
  57          and make the loop of errors happen anyway.  */
  58
  59       function = Vring_bell_function;
  60       Vring_bell_function = Qnil;
  61
  62       call0 (function);
  63
  64       Vring_bell_function = function;
  65     }
  66   else if (FRAME_TERMINAL (f)->ring_bell_hook)
  67     (*FRAME_TERMINAL (f)->ring_bell_hook) (f);
  68 }
  69
  70 void
  71 update_begin (struct frame *f)
  72 {
  73   if (FRAME_TERMINAL (f)->update_begin_hook)
  74     (*FRAME_TERMINAL (f)->update_begin_hook) (f);
  75 }
  76
  77 void
  78 update_end (struct frame *f)
  79 {
  80   if (FRAME_TERMINAL (f)->update_end_hook)
  81     (*FRAME_TERMINAL (f)->update_end_hook) (f);
  82 }
  83
  84 /* Specify how many text lines, from the top of the window,
  85    should be affected by insert-lines and delete-lines operations.
  86    This, and those operations, are used only within an update
  87    that is bounded by calls to update_begin and update_end.  */
  88
  89 void
  90 set_terminal_window (struct frame *f, int size)
  91 {
  92   if (FRAME_TERMINAL (f)->set_terminal_window_hook)
  93     (*FRAME_TERMINAL (f)->set_terminal_window_hook) (f, size);
  94 }
  95
  96 /* Move cursor to row/column position VPOS/HPOS.  HPOS/VPOS are
  97    frame-relative coordinates.  */
  98
  99 void
 100 cursor_to (struct frame *f, int vpos, int hpos)
 101 {
 102   if (FRAME_TERMINAL (f)->cursor_to_hook)
 103     (*FRAME_TERMINAL (f)->cursor_to_hook) (f, vpos, hpos);
 104 }
 105
 106 /* Similar but don't take any account of the wasted characters.  */
 107
 108 void
 109 raw_cursor_to (struct frame *f, int row, int col)
 110 {
 111   if (FRAME_TERMINAL (f)->raw_cursor_to_hook)
 112     (*FRAME_TERMINAL (f)->raw_cursor_to_hook) (f, row, col);
 113 }
 114
 115 /* Erase operations */
 116
 117 /* Clear from cursor to end of frame. */
 118 void
 119 clear_to_end (struct frame *f)
 120 {
 121   if (FRAME_TERMINAL (f)->clear_to_end_hook)
 122     (*FRAME_TERMINAL (f)->clear_to_end_hook) (f);
 123 }
 124
 125 /* Clear entire frame */
 126
 127 void
 128 clear_frame (struct frame *f)
 129 {
 130   if (FRAME_TERMINAL (f)->clear_frame_hook)
 131     (*FRAME_TERMINAL (f)->clear_frame_hook) (f);
 132 }
 133
 134 /* Clear from cursor to end of line.
 135    Assume that the line is already clear starting at column first_unused_hpos.
 136
 137    Note that the cursor may be moved, on terminals lacking a `ce' string.  */
 138
 139 void
 140 clear_end_of_line (struct frame *f, int first_unused_hpos)
 141 {
 142   if (FRAME_TERMINAL (f)->clear_end_of_line_hook)
 143     (*FRAME_TERMINAL (f)->clear_end_of_line_hook) (f, first_unused_hpos);
 144 }
 145
 146 /* Output LEN glyphs starting at STRING at the nominal cursor position.
 147    Advance the nominal cursor over the text.  */
 148
 149 void
 150 write_glyphs (struct frame *f, struct glyph *string, int len)
 151 {
 152   if (FRAME_TERMINAL (f)->write_glyphs_hook)
 153     (*FRAME_TERMINAL (f)->write_glyphs_hook) (f, string, len);
 154 }
 155
 156 /* Insert LEN glyphs from START at the nominal cursor position.
 157
 158    If start is zero, insert blanks instead of a string at start */
 159
 160 void
 161 insert_glyphs (struct frame *f, struct glyph *start, int len)
 162 {
 163   if (len <= 0)
 164     return;
 165
 166   if (FRAME_TERMINAL (f)->insert_glyphs_hook)
 167     (*FRAME_TERMINAL (f)->insert_glyphs_hook) (f, start, len);
 168 }
 169
 170 /* Delete N glyphs at the nominal cursor position. */
 171
 172 void
 173 delete_glyphs (struct frame *f, int n)
 174 {
 175   if (FRAME_TERMINAL (f)->delete_glyphs_hook)
 176     (*FRAME_TERMINAL (f)->delete_glyphs_hook) (f, n);
 177 }
 178
 179 /* Insert N lines at vpos VPOS.  If N is negative, delete -N lines.  */
 180
 181 void
 182 ins_del_lines (struct frame *f, int vpos, int n)
 183 {
 184   if (FRAME_TERMINAL (f)->ins_del_lines_hook)
 185     (*FRAME_TERMINAL (f)->ins_del_lines_hook) (f, vpos, n);
 186 }
 187
 188
 189 \f
 190
 191 /* Return the terminal object specified by TERMINAL.  TERMINAL may be
 192    a terminal object, a frame, or nil for the terminal device of the
 193    current frame.  If THROW is zero, return NULL for failure,
 194    otherwise throw an error.  */
 195
 196 struct terminal *
 197 get_terminal (Lisp_Object terminal, int throw)
 198 {
 199   struct terminal *result = NULL;
 200
 201   if (NILP (terminal))
 202     terminal = selected_frame;
 203
 204   if (TERMINALP (terminal))
 205     result = XTERMINAL (terminal);
 206   else if (FRAMEP (terminal))
 207     result = FRAME_TERMINAL (XFRAME (terminal));
 208
 209   if (result && !result->name)
 210     result = NULL;
 211
 212   if (result == NULL && throw)
 213     wrong_type_argument (Qterminal_live_p, terminal);
 214
 215   return result;
 216 }
 217
 218 \f
 219
 220 /* Create a new terminal object and add it to the terminal list. */
 221
 222 struct terminal *
 223 create_terminal (void)
 224 {
 225   struct terminal *terminal = allocate_terminal ();
 226   Lisp_Object terminal_coding, keyboard_coding;
 227
 228   terminal->name = NULL;
 229   terminal->next_terminal = terminal_list;
 230   terminal_list = terminal;
 231
 232   terminal->id = next_terminal_id++;
 233
 234   terminal->keyboard_coding =
 235     (struct coding_system *) xmalloc (sizeof (struct coding_system));
 236   terminal->terminal_coding =
 237     (struct coding_system *) xmalloc (sizeof (struct coding_system));
 238
 239   /* If default coding systems for the terminal and the keyboard are
 240      already defined, use them in preference to the defaults.  This is
 241      needed when Emacs runs in daemon mode.  */
 242   keyboard_coding =
 243     find_symbol_value (intern ("default-keyboard-coding-system"));
 244   if (NILP (keyboard_coding)
 245       || EQ (keyboard_coding, Qunbound)
 246       || NILP (Fcoding_system_p (keyboard_coding)))
 247     keyboard_coding = Qno_conversion;
 248   terminal_coding =
 249     find_symbol_value (intern ("default-terminal-coding-system"));
 250   if (NILP (terminal_coding)
 251       || EQ (terminal_coding, Qunbound)
 252       || NILP (Fcoding_system_p (terminal_coding)))
 253     terminal_coding = Qundecided;
 254
 255   setup_coding_system (keyboard_coding, terminal->keyboard_coding);
 256   setup_coding_system (terminal_coding, terminal->terminal_coding);
 257
 258   terminal->param_alist = Qnil;
 259   terminal->charset_list = Qnil;
 260   terminal->Vselection_alist = Qnil;
 261   return terminal;
 262 }
 263
 264 /* Low-level function to close all frames on a terminal, remove it
 265    from the terminal list and free its memory.  */
 266
 267 void
 268 delete_terminal (struct terminal *terminal)
 269 {
 270   struct terminal **tp;
 271   Lisp_Object tail, frame;
 272
 273   /* Protect against recursive calls.  delete_frame calls the
 274      delete_terminal_hook when we delete our last frame.  */
 275   if (!terminal->name)
 276     return;
 277   xfree (terminal->name);
 278   terminal->name = NULL;
 279
 280   /* Check for live frames that are still on this terminal. */
 281   FOR_EACH_FRAME (tail, frame)
 282     {
 283       struct frame *f = XFRAME (frame);
 284       if (FRAME_LIVE_P (f) && f->terminal == terminal)
 285         {
 286           /* Pass Qnoelisp rather than Qt.  */
 287           delete_frame (frame, Qnoelisp);
 288         }
 289     }
 290
 291   for (tp = &terminal_list; *tp != terminal; tp = &(*tp)->next_terminal)
 292     if (! *tp)
 293       abort ();
 294   *tp = terminal->next_terminal;
 295
 296   xfree (terminal->keyboard_coding);
 297   terminal->keyboard_coding = NULL;
 298   xfree (terminal->terminal_coding);
 299   terminal->terminal_coding = NULL;
 300
 301   if (terminal->kboard && --terminal->kboard->reference_count == 0)
 302     {
 303       delete_kboard (terminal->kboard);
 304       terminal->kboard = NULL;
 305     }
 306 }
 307
 308 Lisp_Object Qrun_hook_with_args;
 309 static Lisp_Object Qdelete_terminal_functions;
 310 DEFUN ("delete-terminal", Fdelete_terminal, Sdelete_terminal, 0, 2, 0,
 311        doc: /* Delete TERMINAL by deleting all frames on it and closing the terminal.
 312 TERMINAL may be a terminal object, a frame, or nil (meaning the
 313 selected frame's terminal).
 314
 315 Normally, you may not delete a display if all other displays are suspended,
 316 but if the second argument FORCE is non-nil, you may do so. */)
 317   (Lisp_Object terminal, Lisp_Object force)
 318 {
 319   struct terminal *t = get_terminal (terminal, 0);
 320
 321   if (!t)
 322     return Qnil;
 323
 324   if (NILP (force))
 325     {
 326       struct terminal *p = terminal_list;
 327       while (p && (p == t || !TERMINAL_ACTIVE_P (p)))
 328         p = p->next_terminal;
 329
 330       if (!p)
 331         error ("Attempt to delete the sole active display terminal");
 332     }
 333
 334   if (NILP (Vrun_hooks))
 335     ;
 336   else if (EQ (force, Qnoelisp))
 337     pending_funcalls
 338       = Fcons (list3 (Qrun_hook_with_args,
 339                       Qdelete_terminal_functions, terminal),
 340                pending_funcalls);
 341   else
 342     safe_call2 (Qrun_hook_with_args, Qdelete_terminal_functions, terminal);
 343
 344   if (t->delete_terminal_hook)
 345     (*t->delete_terminal_hook) (t);
 346   else
 347     delete_terminal (t);
 348
 349   return Qnil;
 350 }
 351
 352 \f
 353 DEFUN ("frame-terminal", Fframe_terminal, Sframe_terminal, 0, 1, 0,
 354        doc: /* Return the terminal that FRAME is displayed on.
 355 If FRAME is nil, the selected frame is used.
 356
 357 The terminal device is represented by its integer identifier.  */)
 358   (Lisp_Object frame)
 359 {
 360   struct terminal *t;
 361
 362   if (NILP (frame))
 363     frame = selected_frame;
 364
 365   CHECK_LIVE_FRAME (frame);
 366
 367   t = FRAME_TERMINAL (XFRAME (frame));
 368
 369   if (!t)
 370     return Qnil;
 371   else
 372     {
 373       Lisp_Object terminal;
 374       XSETTERMINAL (terminal, t);
 375       return terminal;
 376     }
 377 }
 378
 379 DEFUN ("terminal-live-p", Fterminal_live_p, Sterminal_live_p, 1, 1, 0,
 380        doc: /* Return non-nil if OBJECT is a terminal which has not been deleted.
 381 Value is nil if OBJECT is not a live display terminal.
 382 If object is a live display terminal, the return value indicates what
 383 sort of output terminal it uses.  See the documentation of `framep' for
 384 possible return values.  */)
 385   (Lisp_Object object)
 386 {
 387   struct terminal *t;
 388
 389   t = get_terminal (object, 0);
 390
 391   if (!t)
 392     return Qnil;
 393
 394   switch (t->type)
 395     {
 396     case output_initial: /* The initial frame is like a termcap frame. */
 397     case output_termcap:
 398       return Qt;
 399     case output_x_window:
 400       return Qx;
 401     case output_w32:
 402       return Qw32;
 403     case output_msdos_raw:
 404       return Qpc;
 405     case output_mac:
 406       return Qmac;
 407     case output_ns:
 408       return Qns;
 409     default:
 410       abort ();
 411     }
 412 }
 413
 414 DEFUN ("terminal-list", Fterminal_list, Sterminal_list, 0, 0, 0,
 415        doc: /* Return a list of all terminal devices.  */)
 416   (void)
 417 {
 418   Lisp_Object terminal, terminals = Qnil;
 419   struct terminal *t;
 420
 421   for (t = terminal_list; t; t = t->next_terminal)
 422     {
 423       XSETTERMINAL (terminal, t);
 424       terminals = Fcons (terminal, terminals);
 425     }
 426
 427   return terminals;
 428 }
 429
 430 DEFUN ("terminal-name", Fterminal_name, Sterminal_name, 0, 1, 0,
 431        doc: /* Return the name of the terminal device TERMINAL.
 432 It is not guaranteed that the returned value is unique among opened devices.
 433
 434 TERMINAL may be a terminal object, a frame, or nil (meaning the
 435 selected frame's terminal). */)
 436   (Lisp_Object terminal)
 437 {
 438   struct terminal *t
 439     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 440
 441   return t->name ? build_string (t->name) : Qnil;
 442 }
 443
 444
 445 \f
 446 /* Set the value of terminal parameter PARAMETER in terminal D to VALUE.
 447    Return the previous value.  */
 448
 449 static Lisp_Object
 450 store_terminal_param (struct terminal *t, Lisp_Object parameter, Lisp_Object value)
 451 {
 452   Lisp_Object old_alist_elt = Fassq (parameter, t->param_alist);
 453   if (EQ (old_alist_elt, Qnil))
 454     {
 455       t->param_alist = Fcons (Fcons (parameter, value), t->param_alist);
 456       return Qnil;
 457     }
 458   else
 459     {
 460       Lisp_Object result = Fcdr (old_alist_elt);
 461       Fsetcdr (old_alist_elt, value);
 462       return result;
 463     }
 464 }
 465
 466
 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
 470 is a symbol.
 471
 472 TERMINAL can be a terminal object, a frame, or nil (meaning the
 473 selected frame's terminal).  */)
 474   (Lisp_Object terminal)
 475 {
 476   struct terminal *t
 477     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 478   return Fcopy_alist (t->param_alist);
 479 }
 480
 481 DEFUN ("terminal-parameter", Fterminal_parameter, Sterminal_parameter, 2, 2, 0,
 482        doc: /* Return TERMINAL's value for parameter PARAMETER.
 483 TERMINAL can be a terminal object, a frame, or nil (meaning the
 484 selected frame's terminal).  */)
 485   (Lisp_Object terminal, Lisp_Object parameter)
 486 {
 487   Lisp_Object value;
 488   struct terminal *t
 489     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 490   CHECK_SYMBOL (parameter);
 491   value = Fcdr (Fassq (parameter, t->param_alist));
 492   return value;
 493 }
 494
 495 DEFUN ("set-terminal-parameter", Fset_terminal_parameter,
 496        Sset_terminal_parameter, 3, 3, 0,
 497        doc: /* Set TERMINAL's value for parameter PARAMETER to VALUE.
 498 Return the previous value of PARAMETER.
 499
 500 TERMINAL can be a terminal object, a frame or nil (meaning the
 501 selected frame's terminal).  */)
 502   (Lisp_Object terminal, Lisp_Object parameter, Lisp_Object value)
 503 {
 504   struct terminal *t
 505     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 506   return store_terminal_param (t, parameter, value);
 507 }
 508
 509 \f
 510
 511 /* Create the bootstrap display terminal for the initial frame.
 512    Returns a terminal of type output_initial.  */
 513
 514 struct terminal *
 515 init_initial_terminal (void)
 516 {
 517   if (initialized || terminal_list || tty_list)
 518     abort ();
 519
 520   initial_terminal = create_terminal ();
 521   initial_terminal->type = output_initial;
 522   initial_terminal->name = xstrdup ("initial_terminal");
 523   initial_terminal->kboard = initial_kboard;
 524   initial_terminal->delete_terminal_hook = &delete_initial_terminal;
 525   /* All other hooks are NULL. */
 526
 527   return initial_terminal;
 528 }
 529
 530 /* Deletes the bootstrap terminal device.
 531    Called through delete_terminal_hook. */
 532
 533 static void
 534 delete_initial_terminal (struct terminal *terminal)
 535 {
 536   if (terminal != initial_terminal)
 537     abort ();
 538
 539   delete_terminal (terminal);
 540   initial_terminal = NULL;
 541 }
 542
 543 void
 544 syms_of_terminal (void)
 545 {
 546
 547   DEFVAR_LISP ("ring-bell-function", Vring_bell_function,
 548     doc: /* Non-nil means call this function to ring the bell.
 549 The function should accept no arguments.  */);
 550   Vring_bell_function = Qnil;
 551
 552   DEFVAR_LISP ("delete-terminal-functions", Vdelete_terminal_functions,
 553     doc: /* Special hook run when a terminal is deleted.
 554 Each function is called with argument, the terminal.
 555 This may be called just before actually deleting the terminal,
 556 or some time later.  */);
 557   Vdelete_terminal_functions = Qnil;
 558   DEFSYM (Qdelete_terminal_functions, "delete-terminal-functions");
 559   DEFSYM (Qrun_hook_with_args, "run-hook-with-args");
 560
 561   defsubr (&Sdelete_terminal);
 562   defsubr (&Sframe_terminal);
 563   defsubr (&Sterminal_live_p);
 564   defsubr (&Sterminal_list);
 565   defsubr (&Sterminal_name);
 566   defsubr (&Sterminal_parameters);
 567   defsubr (&Sterminal_parameter);
 568   defsubr (&Sset_terminal_parameter);
 569
 570   Fprovide (intern_c_string ("multi-tty"), Qnil);
 571 }