src/terminal.c

   1 /* Functions related to terminal devices.
   2    Copyright (C) 2005-2012 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->next_terminal = terminal_list;
 229   terminal_list = terminal;
 230
 231   terminal->id = next_terminal_id++;
 232
 233   terminal->keyboard_coding =
 234     (struct coding_system *) xmalloc (sizeof (struct coding_system));
 235   terminal->terminal_coding =
 236     (struct coding_system *) xmalloc (sizeof (struct coding_system));
 237
 238   /* If default coding systems for the terminal and the keyboard are
 239      already defined, use them in preference to the defaults.  This is
 240      needed when Emacs runs in daemon mode.  */
 241   keyboard_coding =
 242     find_symbol_value (intern ("default-keyboard-coding-system"));
 243   if (NILP (keyboard_coding)
 244       || EQ (keyboard_coding, Qunbound)
 245       || NILP (Fcoding_system_p (keyboard_coding)))
 246     keyboard_coding = Qno_conversion;
 247   terminal_coding =
 248     find_symbol_value (intern ("default-terminal-coding-system"));
 249   if (NILP (terminal_coding)
 250       || EQ (terminal_coding, Qunbound)
 251       || NILP (Fcoding_system_p (terminal_coding)))
 252     terminal_coding = Qundecided;
 253
 254   setup_coding_system (keyboard_coding, terminal->keyboard_coding);
 255   setup_coding_system (terminal_coding, terminal->terminal_coding);
 256
 257   return terminal;
 258 }
 259
 260 /* Low-level function to close all frames on a terminal, remove it
 261    from the terminal list and free its memory.  */
 262
 263 void
 264 delete_terminal (struct terminal *terminal)
 265 {
 266   struct terminal **tp;
 267   Lisp_Object tail, frame;
 268
 269   /* Protect against recursive calls.  delete_frame calls the
 270      delete_terminal_hook when we delete our last frame.  */
 271   if (!terminal->name)
 272     return;
 273   xfree (terminal->name);
 274   terminal->name = NULL;
 275
 276   /* Check for live frames that are still on this terminal. */
 277   FOR_EACH_FRAME (tail, frame)
 278     {
 279       struct frame *f = XFRAME (frame);
 280       if (FRAME_LIVE_P (f) && f->terminal == terminal)
 281         {
 282           /* Pass Qnoelisp rather than Qt.  */
 283           delete_frame (frame, Qnoelisp);
 284         }
 285     }
 286
 287   for (tp = &terminal_list; *tp != terminal; tp = &(*tp)->next_terminal)
 288     if (! *tp)
 289       abort ();
 290   *tp = terminal->next_terminal;
 291
 292   xfree (terminal->keyboard_coding);
 293   terminal->keyboard_coding = NULL;
 294   xfree (terminal->terminal_coding);
 295   terminal->terminal_coding = NULL;
 296
 297   if (terminal->kboard && --terminal->kboard->reference_count == 0)
 298     {
 299       delete_kboard (terminal->kboard);
 300       terminal->kboard = NULL;
 301     }
 302 }
 303
 304 Lisp_Object Qrun_hook_with_args;
 305 static Lisp_Object Qdelete_terminal_functions;
 306 DEFUN ("delete-terminal", Fdelete_terminal, Sdelete_terminal, 0, 2, 0,
 307        doc: /* Delete TERMINAL by deleting all frames on it and closing the terminal.
 308 TERMINAL may be a terminal object, a frame, or nil (meaning the
 309 selected frame's terminal).
 310
 311 Normally, you may not delete a display if all other displays are suspended,
 312 but if the second argument FORCE is non-nil, you may do so. */)
 313   (Lisp_Object terminal, Lisp_Object force)
 314 {
 315   struct terminal *t = get_terminal (terminal, 0);
 316
 317   if (!t)
 318     return Qnil;
 319
 320   if (NILP (force))
 321     {
 322       struct terminal *p = terminal_list;
 323       while (p && (p == t || !TERMINAL_ACTIVE_P (p)))
 324         p = p->next_terminal;
 325
 326       if (!p)
 327         error ("Attempt to delete the sole active display terminal");
 328     }
 329
 330   if (NILP (Vrun_hooks))
 331     ;
 332   else if (EQ (force, Qnoelisp))
 333     pending_funcalls
 334       = Fcons (list3 (Qrun_hook_with_args,
 335                       Qdelete_terminal_functions, terminal),
 336                pending_funcalls);
 337   else
 338     safe_call2 (Qrun_hook_with_args, Qdelete_terminal_functions, terminal);
 339
 340   if (t->delete_terminal_hook)
 341     (*t->delete_terminal_hook) (t);
 342   else
 343     delete_terminal (t);
 344
 345   return Qnil;
 346 }
 347
 348 \f
 349 DEFUN ("frame-terminal", Fframe_terminal, Sframe_terminal, 0, 1, 0,
 350        doc: /* Return the terminal that FRAME is displayed on.
 351 If FRAME is nil, the selected frame is used.
 352
 353 The terminal device is represented by its integer identifier.  */)
 354   (Lisp_Object frame)
 355 {
 356   struct terminal *t;
 357
 358   if (NILP (frame))
 359     frame = selected_frame;
 360
 361   CHECK_LIVE_FRAME (frame);
 362
 363   t = FRAME_TERMINAL (XFRAME (frame));
 364
 365   if (!t)
 366     return Qnil;
 367   else
 368     {
 369       Lisp_Object terminal;
 370       XSETTERMINAL (terminal, t);
 371       return terminal;
 372     }
 373 }
 374
 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.  */)
 381   (Lisp_Object object)
 382 {
 383   struct terminal *t;
 384
 385   t = get_terminal (object, 0);
 386
 387   if (!t)
 388     return Qnil;
 389
 390   switch (t->type)
 391     {
 392     case output_initial: /* The initial frame is like a termcap frame. */
 393     case output_termcap:
 394       return Qt;
 395     case output_x_window:
 396       return Qx;
 397     case output_w32:
 398       return Qw32;
 399     case output_msdos_raw:
 400       return Qpc;
 401     case output_mac:
 402       return Qmac;
 403     case output_ns:
 404       return Qns;
 405     default:
 406       abort ();
 407     }
 408 }
 409
 410 DEFUN ("terminal-list", Fterminal_list, Sterminal_list, 0, 0, 0,
 411        doc: /* Return a list of all terminal devices.  */)
 412   (void)
 413 {
 414   Lisp_Object terminal, terminals = Qnil;
 415   struct terminal *t;
 416
 417   for (t = terminal_list; t; t = t->next_terminal)
 418     {
 419       XSETTERMINAL (terminal, t);
 420       terminals = Fcons (terminal, terminals);
 421     }
 422
 423   return terminals;
 424 }
 425
 426 DEFUN ("terminal-name", Fterminal_name, Sterminal_name, 0, 1, 0,
 427        doc: /* Return the name of the terminal device TERMINAL.
 428 It is not guaranteed that the returned value is unique among opened devices.
 429
 430 TERMINAL may be a terminal object, a frame, or nil (meaning the
 431 selected frame's terminal). */)
 432   (Lisp_Object terminal)
 433 {
 434   struct terminal *t
 435     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 436
 437   return t->name ? build_string (t->name) : Qnil;
 438 }
 439
 440
 441 \f
 442 /* Set the value of terminal parameter PARAMETER in terminal D to VALUE.
 443    Return the previous value.  */
 444
 445 static Lisp_Object
 446 store_terminal_param (struct terminal *t, Lisp_Object parameter, Lisp_Object value)
 447 {
 448   Lisp_Object old_alist_elt = Fassq (parameter, t->param_alist);
 449   if (EQ (old_alist_elt, Qnil))
 450     {
 451       t->param_alist = Fcons (Fcons (parameter, value), t->param_alist);
 452       return Qnil;
 453     }
 454   else
 455     {
 456       Lisp_Object result = Fcdr (old_alist_elt);
 457       Fsetcdr (old_alist_elt, value);
 458       return result;
 459     }
 460 }
 461
 462
 463 DEFUN ("terminal-parameters", Fterminal_parameters, Sterminal_parameters, 0, 1, 0,
 464        doc: /* Return the parameter-alist of terminal TERMINAL.
 465 The value is a list of elements of the form (PARM . VALUE), where PARM
 466 is a symbol.
 467
 468 TERMINAL can be a terminal object, a frame, or nil (meaning the
 469 selected frame's terminal).  */)
 470   (Lisp_Object terminal)
 471 {
 472   struct terminal *t
 473     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 474   return Fcopy_alist (t->param_alist);
 475 }
 476
 477 DEFUN ("terminal-parameter", Fterminal_parameter, Sterminal_parameter, 2, 2, 0,
 478        doc: /* Return TERMINAL's value for parameter PARAMETER.
 479 TERMINAL can be a terminal object, a frame, or nil (meaning the
 480 selected frame's terminal).  */)
 481   (Lisp_Object terminal, Lisp_Object parameter)
 482 {
 483   Lisp_Object value;
 484   struct terminal *t
 485     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 486   CHECK_SYMBOL (parameter);
 487   value = Fcdr (Fassq (parameter, t->param_alist));
 488   return value;
 489 }
 490
 491 DEFUN ("set-terminal-parameter", Fset_terminal_parameter,
 492        Sset_terminal_parameter, 3, 3, 0,
 493        doc: /* Set TERMINAL's value for parameter PARAMETER to VALUE.
 494 Return the previous value of PARAMETER.
 495
 496 TERMINAL can be a terminal object, a frame or nil (meaning the
 497 selected frame's terminal).  */)
 498   (Lisp_Object terminal, Lisp_Object parameter, Lisp_Object value)
 499 {
 500   struct terminal *t
 501     = TERMINALP (terminal) ? XTERMINAL (terminal) : get_terminal (terminal, 1);
 502   return store_terminal_param (t, parameter, value);
 503 }
 504
 505 \f
 506
 507 /* Create the bootstrap display terminal for the initial frame.
 508    Returns a terminal of type output_initial.  */
 509
 510 struct terminal *
 511 init_initial_terminal (void)
 512 {
 513   if (initialized || terminal_list || tty_list)
 514     abort ();
 515
 516   initial_terminal = create_terminal ();
 517   initial_terminal->type = output_initial;
 518   initial_terminal->name = xstrdup ("initial_terminal");
 519   initial_terminal->kboard = initial_kboard;
 520   initial_terminal->delete_terminal_hook = &delete_initial_terminal;
 521   /* All other hooks are NULL. */
 522
 523   return initial_terminal;
 524 }
 525
 526 /* Deletes the bootstrap terminal device.
 527    Called through delete_terminal_hook. */
 528
 529 static void
 530 delete_initial_terminal (struct terminal *terminal)
 531 {
 532   if (terminal != initial_terminal)
 533     abort ();
 534
 535   delete_terminal (terminal);
 536   initial_terminal = NULL;
 537 }
 538
 539 void
 540 syms_of_terminal (void)
 541 {
 542
 543   DEFVAR_LISP ("ring-bell-function", Vring_bell_function,
 544     doc: /* Non-nil means call this function to ring the bell.
 545 The function should accept no arguments.  */);
 546   Vring_bell_function = Qnil;
 547
 548   DEFVAR_LISP ("delete-terminal-functions", Vdelete_terminal_functions,
 549     doc: /* Special hook run when a terminal is deleted.
 550 Each function is called with argument, the terminal.
 551 This may be called just before actually deleting the terminal,
 552 or some time later.  */);
 553   Vdelete_terminal_functions = Qnil;
 554   DEFSYM (Qdelete_terminal_functions, "delete-terminal-functions");
 555   DEFSYM (Qrun_hook_with_args, "run-hook-with-args");
 556
 557   defsubr (&Sdelete_terminal);
 558   defsubr (&Sframe_terminal);
 559   defsubr (&Sterminal_live_p);
 560   defsubr (&Sterminal_list);
 561   defsubr (&Sterminal_name);
 562   defsubr (&Sterminal_parameters);
 563   defsubr (&Sterminal_parameter);
 564   defsubr (&Sset_terminal_parameter);
 565
 566   Fprovide (intern_c_string ("multi-tty"), Qnil);
 567 }