1 /* Terminal hooks for GNU Emacs on the Microsoft W32 API.
2 Copyright (C) 1992, 1999, 2001, 2002, 2003, 2004,
3 2005, 2006, 2007, 2008 Free Software Foundation, Inc.
5 This file is part of GNU Emacs.
7 GNU Emacs is free software; you can redistribute it and/or modify
8 it under the terms of the GNU General Public License as published by
9 the Free Software Foundation; either version 3, or (at your option)
12 GNU Emacs is distributed in the hope that it will be useful,
13 but WITHOUT ANY WARRANTY; without even the implied warranty of
14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 GNU General Public License for more details.
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA.
22 Tim Fleehart (apollo@online.com) 1-17-92
23 Geoff Voelker (voelker@cs.washington.edu) 9-12-93
35 #include "character.h"
39 #include "termhooks.h"
41 #include "dispextern.h"
45 extern Lisp_Object
Frecenter ();
48 extern int detect_input_pending ();
51 extern int read_input_pending ();
53 static void w32con_move_cursor (struct frame
*f
, int row
, int col
);
54 static void w32con_clear_to_end (struct frame
*f
);
55 static void w32con_clear_frame (struct frame
*f
);
56 static void w32con_clear_end_of_line (struct frame
*f
, int);
57 static void w32con_ins_del_lines (struct frame
*f
, int vpos
, int n
);
58 static void w32con_insert_glyphs (struct frame
*f
, struct glyph
*start
, int len
);
59 static void w32con_write_glyphs (struct frame
*f
, struct glyph
*string
, int len
);
60 static void w32con_delete_glyphs (struct frame
*f
, int n
);
61 static void w32con_reset_terminal_modes (struct terminal
*t
);
62 static void w32con_set_terminal_modes (struct terminal
*t
);
63 static void w32con_set_terminal_window (struct frame
*f
, int size
);
64 static void w32con_update_begin (struct frame
* f
);
65 static void w32con_update_end (struct frame
* f
);
66 static WORD
w32_face_attributes (struct frame
*f
, int face_id
);
68 static COORD cursor_coords
;
69 static HANDLE prev_screen
, cur_screen
;
70 static WORD char_attr_normal
;
71 static DWORD prev_console_mode
;
73 #ifndef USE_SEPARATE_SCREEN
74 static CONSOLE_CURSOR_INFO prev_console_cursor
;
77 extern Lisp_Object Vtty_defined_color_alist
;
79 /* Determine whether to make frame dimensions match the screen buffer,
80 or the current window size. The former is desirable when running
81 over telnet, while the latter is more useful when working directly at
82 the console with a large scroll-back buffer. */
83 int w32_use_full_screen_buffer
;
84 HANDLE keyboard_handle
;
87 /* Setting this as the ctrl handler prevents emacs from being killed when
88 someone hits ^C in a 'suspended' session (child shell).
89 Also ignore Ctrl-Break signals. */
92 ctrl_c_handler (unsigned long type
)
94 /* Only ignore "interrupt" events when running interactively. */
95 return (!noninteractive
96 && (type
== CTRL_C_EVENT
|| type
== CTRL_BREAK_EVENT
));
100 /* Move the cursor to (ROW, COL) on FRAME. */
102 w32con_move_cursor (struct frame
*f
, int row
, int col
)
104 cursor_coords
.X
= col
;
105 cursor_coords
.Y
= row
;
107 /* TODO: for multi-tty support, cur_screen should be replaced with a
108 reference to the terminal for this frame. */
109 SetConsoleCursorPosition (cur_screen
, cursor_coords
);
112 /* Clear from cursor to end of screen. */
114 w32con_clear_to_end (struct frame
*f
)
116 w32con_clear_end_of_line (f
, FRAME_COLS (f
) - 1);
117 w32con_ins_del_lines (f
, cursor_coords
.Y
, FRAME_LINES (f
) - cursor_coords
.Y
- 1);
120 /* Clear the frame. */
122 w32con_clear_frame (struct frame
*f
)
127 CONSOLE_SCREEN_BUFFER_INFO info
;
129 GetConsoleScreenBufferInfo (GetStdHandle (STD_OUTPUT_HANDLE
), &info
);
131 /* Remember that the screen buffer might be wider than the window. */
132 n
= FRAME_LINES (f
) * info
.dwSize
.X
;
135 FillConsoleOutputAttribute (cur_screen
, char_attr_normal
, n
, dest
, &r
);
136 FillConsoleOutputCharacter (cur_screen
, ' ', n
, dest
, &r
);
138 w32con_move_cursor (f
, 0, 0);
142 static struct glyph glyph_base
[256];
143 static BOOL ceol_initialized
= FALSE
;
145 /* Clear from Cursor to end (what's "standout marker"?). */
147 w32con_clear_end_of_line (struct frame
*f
, int end
)
149 if (!ceol_initialized
)
152 for (i
= 0; i
< 256; i
++)
154 memcpy (&glyph_base
[i
], &space_glyph
, sizeof (struct glyph
));
156 ceol_initialized
= TRUE
;
158 w32con_write_glyphs (f
, glyph_base
, end
- cursor_coords
.X
); /* fencepost ? */
161 /* Insert n lines at vpos. if n is negative delete -n lines. */
163 w32con_ins_del_lines (struct frame
*f
, int vpos
, int n
)
173 scroll
.Top
= vpos
- n
;
174 scroll
.Bottom
= FRAME_LINES (f
);
180 scroll
.Bottom
= FRAME_LINES (f
) - n
;
183 clip
.Top
= clip
.Left
= scroll
.Left
= 0;
184 clip
.Right
= scroll
.Right
= FRAME_COLS (f
);
185 clip
.Bottom
= FRAME_LINES (f
);
189 fill
.Char
.AsciiChar
= 0x20;
190 fill
.Attributes
= char_attr_normal
;
192 ScrollConsoleScreenBuffer (cur_screen
, &scroll
, &clip
, dest
, &fill
);
194 /* Here we have to deal with a w32 console flake: If the scroll
195 region looks like abc and we scroll c to a and fill with d we get
196 cbd... if we scroll block c one line at a time to a, we get cdd...
197 Emacs expects cdd consistently... So we have to deal with that
198 here... (this also occurs scrolling the same way in the other
203 if (scroll
.Bottom
< dest
.Y
)
205 for (i
= scroll
.Bottom
; i
< dest
.Y
; i
++)
207 w32con_move_cursor (f
, i
, 0);
208 w32con_clear_end_of_line (f
, FRAME_COLS (f
));
214 nb
= dest
.Y
+ (scroll
.Bottom
- scroll
.Top
) + 1;
218 for (i
= nb
; i
< scroll
.Top
; i
++)
220 w32con_move_cursor (f
, i
, 0);
221 w32con_clear_end_of_line (f
, FRAME_COLS (f
));
227 cursor_coords
.Y
= vpos
;
236 scroll_line (struct frame
*f
, int dist
, int direction
)
238 /* The idea here is to implement a horizontal scroll in one line to
239 implement delete and half of insert. */
240 SMALL_RECT scroll
, clip
;
244 clip
.Top
= scroll
.Top
= clip
.Bottom
= scroll
.Bottom
= cursor_coords
.Y
;
246 clip
.Right
= FRAME_COLS (f
);
248 if (direction
== LEFT
)
250 scroll
.Left
= cursor_coords
.X
+ dist
;
251 scroll
.Right
= FRAME_COLS (f
) - 1;
255 scroll
.Left
= cursor_coords
.X
;
256 scroll
.Right
= FRAME_COLS (f
) - dist
- 1;
259 dest
.X
= cursor_coords
.X
;
260 dest
.Y
= cursor_coords
.Y
;
262 fill
.Char
.AsciiChar
= 0x20;
263 fill
.Attributes
= char_attr_normal
;
265 ScrollConsoleScreenBuffer (cur_screen
, &scroll
, &clip
, dest
, &fill
);
269 /* If start is zero insert blanks instead of a string at start ?. */
271 w32con_insert_glyphs (struct frame
*f
, register struct glyph
*start
, register int len
)
273 scroll_line (f
, len
, RIGHT
);
275 /* Move len chars to the right starting at cursor_coords, fill with blanks */
278 /* Print the first len characters of start, cursor_coords.X adjusted
281 w32con_write_glyphs (f
, start
, len
);
285 w32con_clear_end_of_line (f
, cursor_coords
.X
+ len
);
289 extern unsigned char *encode_terminal_code
P_ ((struct glyph
*, int,
290 struct coding_system
*));
293 w32con_write_glyphs (struct frame
*f
, register struct glyph
*string
,
298 unsigned char *conversion_buffer
;
299 struct coding_system
*coding
;
304 /* If terminal_coding does any conversion, use it, otherwise use
305 safe_terminal_coding. We can't use CODING_REQUIRE_ENCODING here
306 because it always return 1 if the member src_multibyte is 1. */
307 coding
= (FRAME_TERMINAL_CODING (f
)->common_flags
& CODING_REQUIRE_ENCODING_MASK
308 ? FRAME_TERMINAL_CODING (f
) : &safe_terminal_coding
);
309 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
311 coding
->mode
&= ~CODING_MODE_LAST_BLOCK
;
315 /* Identify a run of glyphs with the same face. */
316 int face_id
= string
->face_id
;
319 for (n
= 1; n
< len
; ++n
)
320 if (string
[n
].face_id
!= face_id
)
323 /* Turn appearance modes of the face of the run on. */
324 char_attr
= w32_face_attributes (f
, face_id
);
327 /* This is the last run. */
328 coding
->mode
|= CODING_MODE_LAST_BLOCK
;
329 conversion_buffer
= encode_terminal_code (string
, n
, coding
);
330 if (coding
->produced
> 0)
332 /* Set the attribute for these characters. */
333 if (!FillConsoleOutputAttribute (cur_screen
, char_attr
,
334 coding
->produced
, cursor_coords
,
337 printf ("Failed writing console attributes: %d\n",
342 /* Write the characters. */
343 if (!WriteConsoleOutputCharacter (cur_screen
, conversion_buffer
,
344 coding
->produced
, cursor_coords
,
347 printf ("Failed writing console characters: %d\n",
352 cursor_coords
.X
+= coding
->produced
;
353 w32con_move_cursor (f
, cursor_coords
.Y
, cursor_coords
.X
);
362 w32con_delete_glyphs (struct frame
*f
, int n
)
364 /* delete chars means scroll chars from cursor_coords.X + n to
365 cursor_coords.X, anything beyond the edge of the screen should
368 scroll_line (f
, n
, LEFT
);
371 static unsigned int sound_type
= 0xFFFFFFFF;
372 #define MB_EMACS_SILENT (0xFFFFFFFF - 1)
375 w32_sys_ring_bell (struct frame
*f
)
377 if (sound_type
== 0xFFFFFFFF)
381 else if (sound_type
== MB_EMACS_SILENT
)
386 MessageBeep (sound_type
);
389 DEFUN ("set-message-beep", Fset_message_beep
, Sset_message_beep
, 1, 1, 0,
390 doc
: /* Set the sound generated when the bell is rung.
391 SOUND is 'asterisk, 'exclamation, 'hand, 'question, 'ok, or 'silent
392 to use the corresponding system sound for the bell. The 'silent sound
393 prevents Emacs from making any sound at all.
394 SOUND is nil to use the normal beep. */)
398 CHECK_SYMBOL (sound
);
401 sound_type
= 0xFFFFFFFF;
402 else if (EQ (sound
, intern ("asterisk")))
403 sound_type
= MB_ICONASTERISK
;
404 else if (EQ (sound
, intern ("exclamation")))
405 sound_type
= MB_ICONEXCLAMATION
;
406 else if (EQ (sound
, intern ("hand")))
407 sound_type
= MB_ICONHAND
;
408 else if (EQ (sound
, intern ("question")))
409 sound_type
= MB_ICONQUESTION
;
410 else if (EQ (sound
, intern ("ok")))
412 else if (EQ (sound
, intern ("silent")))
413 sound_type
= MB_EMACS_SILENT
;
415 sound_type
= 0xFFFFFFFF;
421 w32con_reset_terminal_modes (struct terminal
*t
)
424 CONSOLE_SCREEN_BUFFER_INFO info
;
428 /* Clear the complete screen buffer. This is required because Emacs
429 sets the cursor position to the top of the buffer, but there might
430 be other output below the bottom of the Emacs frame if the screen buffer
431 is larger than the window size. */
432 GetConsoleScreenBufferInfo (cur_screen
, &info
);
435 n
= info
.dwSize
.X
* info
.dwSize
.Y
;
437 FillConsoleOutputAttribute (cur_screen
, char_attr_normal
, n
, dest
, &r
);
438 FillConsoleOutputCharacter (cur_screen
, ' ', n
, dest
, &r
);
439 /* Now that the screen is clear, put the cursor at the top. */
440 SetConsoleCursorPosition (cur_screen
, dest
);
442 #ifdef USE_SEPARATE_SCREEN
443 SetConsoleActiveScreenBuffer (prev_screen
);
445 SetConsoleCursorInfo (prev_screen
, &prev_console_cursor
);
448 SetConsoleMode (keyboard_handle
, prev_console_mode
);
452 w32con_set_terminal_modes (struct terminal
*t
)
454 CONSOLE_CURSOR_INFO cci
;
456 /* make cursor big and visible (100 on Win95 makes it disappear) */
459 (void) SetConsoleCursorInfo (cur_screen
, &cci
);
461 SetConsoleActiveScreenBuffer (cur_screen
);
463 SetConsoleMode (keyboard_handle
, ENABLE_MOUSE_INPUT
| ENABLE_WINDOW_INPUT
);
465 /* Initialize input mode: interrupt_input off, no flow control, allow
466 8 bit character input, standard quit char. */
467 Fset_input_mode (Qnil
, Qnil
, make_number (2), Qnil
);
470 /* hmmm... perhaps these let us bracket screen changes so that we can flush
471 clumps rather than one-character-at-a-time...
473 we'll start with not moving the cursor while an update is in progress. */
475 w32con_update_begin (struct frame
* f
)
480 w32con_update_end (struct frame
* f
)
482 SetConsoleCursorPosition (cur_screen
, cursor_coords
);
486 w32con_set_terminal_window (struct frame
*f
, int size
)
490 /***********************************************************************
492 ***********************************************************************/
495 /* Turn appearances of face FACE_ID on tty frame F on. */
498 w32_face_attributes (f
, face_id
)
503 struct face
*face
= FACE_FROM_ID (f
, face_id
);
505 xassert (face
!= NULL
);
507 char_attr
= char_attr_normal
;
509 /* Reverse the default color if requested. If background and
510 foreground are specified, then they have been reversed already. */
511 if (face
->tty_reverse_p
)
512 char_attr
= (char_attr
& 0xff00) + ((char_attr
& 0x000f) << 4)
513 + ((char_attr
& 0x00f0) >> 4);
515 /* Before the terminal is properly initialized, all colors map to 0.
516 Don't try to resolve them. */
517 if (NILP (Vtty_defined_color_alist
))
520 /* Colors should be in the range 0...15 unless they are one of
521 FACE_TTY_DEFAULT_COLOR, FACE_TTY_DEFAULT_FG_COLOR or
522 FACE_TTY_DEFAULT_BG_COLOR. Other out of range colors are
523 invalid, so it is better to use the default color if they ever
524 get through to here. */
525 if (face
->foreground
>= 0 && face
->foreground
< 16)
526 char_attr
= (char_attr
& 0xfff0) + face
->foreground
;
528 if (face
->background
>= 0 && face
->background
< 16)
529 char_attr
= (char_attr
& 0xff0f) + (face
->background
<< 4);
536 /* Given a color index, return its standard name. */
538 vga_stdcolor_name (int idx
)
540 /* Standard VGA colors, in the order of their standard numbering
541 in the default VGA palette. */
542 static char *vga_colors
[16] = {
543 "black", "blue", "green", "cyan", "red", "magenta", "brown",
544 "lightgray", "darkgray", "lightblue", "lightgreen", "lightcyan",
545 "lightred", "lightmagenta", "yellow", "white"
548 extern Lisp_Object Qunspecified
;
550 if (idx
>= 0 && idx
< sizeof (vga_colors
) / sizeof (vga_colors
[0]))
551 return build_string (vga_colors
[idx
]);
553 return Qunspecified
; /* meaning the default */
556 typedef int (*term_hook
) ();
559 initialize_w32_display (struct terminal
*term
)
561 CONSOLE_SCREEN_BUFFER_INFO info
;
563 term
->rif
= 0; /* No window based redisplay on the console. */
564 term
->cursor_to_hook
= w32con_move_cursor
;
565 term
->raw_cursor_to_hook
= w32con_move_cursor
;
566 term
->clear_to_end_hook
= w32con_clear_to_end
;
567 term
->clear_frame_hook
= w32con_clear_frame
;
568 term
->clear_end_of_line_hook
= w32con_clear_end_of_line
;
569 term
->ins_del_lines_hook
= w32con_ins_del_lines
;
570 term
->insert_glyphs_hook
= w32con_insert_glyphs
;
571 term
->write_glyphs_hook
= w32con_write_glyphs
;
572 term
->delete_glyphs_hook
= w32con_delete_glyphs
;
573 term
->ring_bell_hook
= w32_sys_ring_bell
;
574 term
->reset_terminal_modes_hook
= w32con_reset_terminal_modes
;
575 term
->set_terminal_modes_hook
= w32con_set_terminal_modes
;
576 term
->set_terminal_window_hook
= w32con_set_terminal_window
;
577 term
->update_begin_hook
= w32con_update_begin
;
578 term
->update_end_hook
= w32con_update_end
;
580 term
->read_socket_hook
= w32_console_read_socket
;
581 term
->mouse_position_hook
= w32_console_mouse_position
;
583 /* The following are not used on the console. */
584 term
->frame_rehighlight_hook
= 0;
585 term
->frame_raise_lower_hook
= 0;
586 term
->set_vertical_scroll_bar_hook
= 0;
587 term
->condemn_scroll_bars_hook
= 0;
588 term
->redeem_scroll_bar_hook
= 0;
589 term
->judge_scroll_bars_hook
= 0;
590 term
->frame_up_to_date_hook
= 0;
592 /* Initialize interrupt_handle. */
595 /* Remember original console settings. */
596 keyboard_handle
= GetStdHandle (STD_INPUT_HANDLE
);
597 GetConsoleMode (keyboard_handle
, &prev_console_mode
);
599 prev_screen
= GetStdHandle (STD_OUTPUT_HANDLE
);
601 #ifdef USE_SEPARATE_SCREEN
602 cur_screen
= CreateConsoleScreenBuffer (GENERIC_READ
| GENERIC_WRITE
,
604 CONSOLE_TEXTMODE_BUFFER
,
607 if (cur_screen
== INVALID_HANDLE_VALUE
)
609 printf ("CreateConsoleScreenBuffer failed in ResetTerm\n");
610 printf ("LastError = 0x%lx\n", GetLastError ());
615 cur_screen
= prev_screen
;
616 GetConsoleCursorInfo (prev_screen
, &prev_console_cursor
);
619 /* Respect setting of LINES and COLUMNS environment variables. */
621 char * lines
= getenv("LINES");
622 char * columns
= getenv("COLUMNS");
624 if (lines
!= NULL
&& columns
!= NULL
)
626 SMALL_RECT new_win_dims
;
629 new_size
.X
= atoi (columns
);
630 new_size
.Y
= atoi (lines
);
632 GetConsoleScreenBufferInfo (cur_screen
, &info
);
634 /* Shrink the window first, so the buffer dimensions can be
635 reduced if necessary. */
636 new_win_dims
.Top
= 0;
637 new_win_dims
.Left
= 0;
638 new_win_dims
.Bottom
= min (new_size
.Y
, info
.dwSize
.Y
) - 1;
639 new_win_dims
.Right
= min (new_size
.X
, info
.dwSize
.X
) - 1;
640 SetConsoleWindowInfo (cur_screen
, TRUE
, &new_win_dims
);
642 SetConsoleScreenBufferSize (cur_screen
, new_size
);
644 /* Set the window size to match the buffer dimension. */
645 new_win_dims
.Top
= 0;
646 new_win_dims
.Left
= 0;
647 new_win_dims
.Bottom
= new_size
.Y
- 1;
648 new_win_dims
.Right
= new_size
.X
- 1;
649 SetConsoleWindowInfo (cur_screen
, TRUE
, &new_win_dims
);
653 GetConsoleScreenBufferInfo (cur_screen
, &info
);
655 char_attr_normal
= info
.wAttributes
;
657 /* Determine if the info returned by GetConsoleScreenBufferInfo
658 is realistic. Old MS Telnet servers used to only fill out
659 the dwSize portion, even modern one fill the whole struct with
660 garbage when using non-MS telnet clients. */
661 if ((w32_use_full_screen_buffer
662 && (info
.dwSize
.Y
< 20 || info
.dwSize
.Y
> 100
663 || info
.dwSize
.X
< 40 || info
.dwSize
.X
> 200))
664 || (!w32_use_full_screen_buffer
665 && (info
.srWindow
.Bottom
- info
.srWindow
.Top
< 20
666 || info
.srWindow
.Bottom
- info
.srWindow
.Top
> 100
667 || info
.srWindow
.Right
- info
.srWindow
.Left
< 40
668 || info
.srWindow
.Right
- info
.srWindow
.Left
> 100)))
670 FRAME_LINES (SELECTED_FRAME ()) = 25;
671 SET_FRAME_COLS (SELECTED_FRAME (), 80);
674 else if (w32_use_full_screen_buffer
)
676 FRAME_LINES (SELECTED_FRAME ()) = info
.dwSize
.Y
; /* lines per page */
677 SET_FRAME_COLS (SELECTED_FRAME (), info
.dwSize
.X
); /* characters per line */
681 /* Lines per page. Use buffer coords instead of buffer size. */
682 FRAME_LINES (SELECTED_FRAME ()) = 1 + info
.srWindow
.Bottom
-
684 /* Characters per line. Use buffer coords instead of buffer size. */
685 SET_FRAME_COLS (SELECTED_FRAME (), 1 + info
.srWindow
.Right
-
689 /* Setup w32_display_info structure for this frame. */
691 w32_initialize_display_info (build_string ("Console"));
696 DEFUN ("set-screen-color", Fset_screen_color
, Sset_screen_color
, 2, 2, 0,
697 doc
: /* Set screen colors. */)
698 (foreground
, background
)
699 Lisp_Object foreground
;
700 Lisp_Object background
;
702 char_attr_normal
= XFASTINT (foreground
) + (XFASTINT (background
) << 4);
708 DEFUN ("set-cursor-size", Fset_cursor_size
, Sset_cursor_size
, 1, 1, 0,
709 doc
: /* Set cursor size. */)
713 CONSOLE_CURSOR_INFO cci
;
714 cci
.dwSize
= XFASTINT (size
);
716 (void) SetConsoleCursorInfo (cur_screen
, &cci
);
724 DEFVAR_BOOL ("w32-use-full-screen-buffer",
725 &w32_use_full_screen_buffer
,
726 doc
: /* Non-nil means make terminal frames use the full screen buffer dimensions.
727 This is desirable when running Emacs over telnet.
728 A value of nil means use the current console window dimensions; this
729 may be preferrable when working directly at the console with a large
730 scroll-back buffer. */);
731 w32_use_full_screen_buffer
= 0;
733 defsubr (&Sset_screen_color
);
734 defsubr (&Sset_cursor_size
);
735 defsubr (&Sset_message_beep
);
738 /* arch-tag: a390a07f-f661-42bc-aeb4-e6d8bf860337
739 (do not change this comment) */