1 /* Terminal control module for terminals described by TERMCAP
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 98, 2000, 2001
3 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 2, 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., 59 Temple Place - Suite 330,
20 Boston, MA 02111-1307, USA. */
22 /* New redisplay, TTY faces by Gerd Moellmann <gerd@gnu.org>. */
37 #include "termhooks.h"
38 #include "dispextern.h"
42 /* For now, don't try to include termcap.h. On some systems,
43 configure finds a non-standard termcap.h that the main build
46 #if defined HAVE_TERMCAP_H && 0
49 extern void tputs
P_ ((const char *, int, int (*)(int)));
50 extern int tgetent
P_ ((char *, const char *));
51 extern int tgetflag
P_ ((char *id
));
52 extern int tgetnum
P_ ((char *id
));
63 static void turn_on_face
P_ ((struct frame
*, int face_id
));
64 static void turn_off_face
P_ ((struct frame
*, int face_id
));
65 static void tty_show_cursor
P_ ((void));
66 static void tty_hide_cursor
P_ ((void));
69 tputs (a, (int) (FRAME_HEIGHT (XFRAME (selected_frame)) - curY), cmputc)
70 #define OUTPUT1(a) tputs (a, 1, cmputc)
71 #define OUTPUTL(a, lines) tputs (a, lines, cmputc)
73 #define OUTPUT_IF(a) \
76 tputs (a, (int) (FRAME_HEIGHT (XFRAME (selected_frame)) \
80 #define OUTPUT1_IF(a) do { if (a) tputs (a, 1, cmputc); } while (0)
82 /* Function to use to ring the bell. */
84 Lisp_Object Vring_bell_function
;
86 /* Terminal characteristics that higher levels want to look at.
87 These are all extern'd in termchar.h */
89 int must_write_spaces
; /* Nonzero means spaces in the text
90 must actually be output; can't just skip
91 over some columns to leave them blank. */
92 int min_padding_speed
; /* Speed below which no padding necessary */
94 int line_ins_del_ok
; /* Terminal can insert and delete lines */
95 int char_ins_del_ok
; /* Terminal can insert and delete chars */
96 int scroll_region_ok
; /* Terminal supports setting the
98 int scroll_region_cost
; /* Cost of setting a scroll window,
99 measured in characters */
100 int memory_below_frame
; /* Terminal remembers lines
101 scrolled off bottom */
102 int fast_clear_end_of_line
; /* Terminal has a `ce' string */
104 /* Nonzero means no need to redraw the entire frame on resuming
105 a suspended Emacs. This is useful on terminals with multiple pages,
106 where one page is used for Emacs and another for all else. */
108 int no_redraw_on_reenter
;
110 /* Hook functions that you can set to snap out the functions in this file.
111 These are all extern'd in termhooks.h */
113 void (*cursor_to_hook
) P_ ((int, int));
114 void (*raw_cursor_to_hook
) P_ ((int, int));
115 void (*clear_to_end_hook
) P_ ((void));
116 void (*clear_frame_hook
) P_ ((void));
117 void (*clear_end_of_line_hook
) P_ ((int));
119 void (*ins_del_lines_hook
) P_ ((int, int));
121 void (*delete_glyphs_hook
) P_ ((int));
123 void (*ring_bell_hook
) P_ ((void));
125 void (*reset_terminal_modes_hook
) P_ ((void));
126 void (*set_terminal_modes_hook
) P_ ((void));
127 void (*update_begin_hook
) P_ ((struct frame
*));
128 void (*update_end_hook
) P_ ((struct frame
*));
129 void (*set_terminal_window_hook
) P_ ((int));
130 void (*insert_glyphs_hook
) P_ ((struct glyph
*, int));
131 void (*write_glyphs_hook
) P_ ((struct glyph
*, int));
132 void (*delete_glyphs_hook
) P_ ((int));
134 int (*read_socket_hook
) P_ ((int, struct input_event
*, int, int));
136 void (*frame_up_to_date_hook
) P_ ((struct frame
*));
138 /* Return the current position of the mouse.
140 Set *f to the frame the mouse is in, or zero if the mouse is in no
141 Emacs frame. If it is set to zero, all the other arguments are
144 If the motion started in a scroll bar, set *bar_window to the
145 scroll bar's window, *part to the part the mouse is currently over,
146 *x to the position of the mouse along the scroll bar, and *y to the
147 overall length of the scroll bar.
149 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
150 row of the character cell the mouse is over.
152 Set *time to the time the mouse was at the returned position.
154 This should clear mouse_moved until the next motion
157 void (*mouse_position_hook
) P_ ((FRAME_PTR
*f
, int insist
,
158 Lisp_Object
*bar_window
,
159 enum scroll_bar_part
*part
,
162 unsigned long *time
));
164 /* When reading from a minibuffer in a different frame, Emacs wants
165 to shift the highlight from the selected frame to the mini-buffer's
166 frame; under X, this means it lies about where the focus is.
167 This hook tells the window system code to re-decide where to put
170 void (*frame_rehighlight_hook
) P_ ((FRAME_PTR f
));
172 /* If we're displaying frames using a window system that can stack
173 frames on top of each other, this hook allows you to bring a frame
174 to the front, or bury it behind all the other windows. If this
175 hook is zero, that means the device we're displaying on doesn't
176 support overlapping frames, so there's no need to raise or lower
179 If RAISE is non-zero, F is brought to the front, before all other
180 windows. If RAISE is zero, F is sent to the back, behind all other
183 void (*frame_raise_lower_hook
) P_ ((FRAME_PTR f
, int raise
));
185 /* Set the vertical scroll bar for WINDOW to have its upper left corner
186 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
187 indicate that we are displaying PORTION characters out of a total
188 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
189 have a scroll bar, create one for it. */
191 void (*set_vertical_scroll_bar_hook
)
192 P_ ((struct window
*window
,
193 int portion
, int whole
, int position
));
196 /* The following three hooks are used when we're doing a thorough
197 redisplay of the frame. We don't explicitly know which scroll bars
198 are going to be deleted, because keeping track of when windows go
199 away is a real pain - can you say set-window-configuration?
200 Instead, we just assert at the beginning of redisplay that *all*
201 scroll bars are to be removed, and then save scroll bars from the
202 fiery pit when we actually redisplay their window. */
204 /* Arrange for all scroll bars on FRAME to be removed at the next call
205 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
206 `*redeem_scroll_bar_hook' is applied to its window before the judgment.
208 This should be applied to each frame each time its window tree is
209 redisplayed, even if it is not displaying scroll bars at the moment;
210 if the HAS_SCROLL_BARS flag has just been turned off, only calling
211 this and the judge_scroll_bars_hook will get rid of them.
213 If non-zero, this hook should be safe to apply to any frame,
214 whether or not it can support scroll bars, and whether or not it is
215 currently displaying them. */
217 void (*condemn_scroll_bars_hook
) P_ ((FRAME_PTR frame
));
219 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
220 Note that it's okay to redeem a scroll bar that is not condemned. */
222 void (*redeem_scroll_bar_hook
) P_ ((struct window
*window
));
224 /* Remove all scroll bars on FRAME that haven't been saved since the
225 last call to `*condemn_scroll_bars_hook'.
227 This should be applied to each frame after each time its window
228 tree is redisplayed, even if it is not displaying scroll bars at the
229 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
230 calling this and condemn_scroll_bars_hook will get rid of them.
232 If non-zero, this hook should be safe to apply to any frame,
233 whether or not it can support scroll bars, and whether or not it is
234 currently displaying them. */
236 void (*judge_scroll_bars_hook
) P_ ((FRAME_PTR FRAME
));
238 /* Hook to call in estimate_mode_line_height, if any. */
240 int (* estimate_mode_line_height_hook
) P_ ((struct frame
*f
, enum face_id
));
243 /* Strings, numbers and flags taken from the termcap entry. */
245 char *TS_ins_line
; /* "al" */
246 char *TS_ins_multi_lines
; /* "AL" (one parameter, # lines to insert) */
247 char *TS_bell
; /* "bl" */
248 char *TS_clr_to_bottom
; /* "cd" */
249 char *TS_clr_line
; /* "ce", clear to end of line */
250 char *TS_clr_frame
; /* "cl" */
251 char *TS_set_scroll_region
; /* "cs" (2 params, first line and last line) */
252 char *TS_set_scroll_region_1
; /* "cS" (4 params: total lines,
253 lines above scroll region, lines below it,
254 total lines again) */
255 char *TS_del_char
; /* "dc" */
256 char *TS_del_multi_chars
; /* "DC" (one parameter, # chars to delete) */
257 char *TS_del_line
; /* "dl" */
258 char *TS_del_multi_lines
; /* "DL" (one parameter, # lines to delete) */
259 char *TS_delete_mode
; /* "dm", enter character-delete mode */
260 char *TS_end_delete_mode
; /* "ed", leave character-delete mode */
261 char *TS_end_insert_mode
; /* "ei", leave character-insert mode */
262 char *TS_ins_char
; /* "ic" */
263 char *TS_ins_multi_chars
; /* "IC" (one parameter, # chars to insert) */
264 char *TS_insert_mode
; /* "im", enter character-insert mode */
265 char *TS_pad_inserted_char
; /* "ip". Just padding, no commands. */
266 char *TS_end_keypad_mode
; /* "ke" */
267 char *TS_keypad_mode
; /* "ks" */
268 char *TS_pad_char
; /* "pc", char to use as padding */
269 char *TS_repeat
; /* "rp" (2 params, # times to repeat
270 and character to be repeated) */
271 char *TS_end_standout_mode
; /* "se" */
272 char *TS_fwd_scroll
; /* "sf" */
273 char *TS_standout_mode
; /* "so" */
274 char *TS_rev_scroll
; /* "sr" */
275 char *TS_end_termcap_modes
; /* "te" */
276 char *TS_termcap_modes
; /* "ti" */
277 char *TS_visible_bell
; /* "vb" */
278 char *TS_cursor_normal
; /* "ve" */
279 char *TS_cursor_visible
; /* "vs" */
280 char *TS_cursor_invisible
; /* "vi" */
281 char *TS_set_window
; /* "wi" (4 params, start and end of window,
282 each as vpos and hpos) */
284 /* Value of the "NC" (no_color_video) capability, or 0 if not
287 static int TN_no_color_video
;
289 /* Meaning of bits in no_color_video. Each bit set means that the
290 corresponding attribute cannot be combined with colors. */
294 NC_STANDOUT
= 1 << 0,
295 NC_UNDERLINE
= 1 << 1,
302 NC_ALT_CHARSET
= 1 << 8
305 /* "md" -- turn on bold (extra bright mode). */
307 char *TS_enter_bold_mode
;
309 /* "mh" -- turn on half-bright mode. */
311 char *TS_enter_dim_mode
;
313 /* "mb" -- enter blinking mode. */
315 char *TS_enter_blink_mode
;
317 /* "mr" -- enter reverse video mode. */
319 char *TS_enter_reverse_mode
;
321 /* "us"/"ue" -- start/end underlining. */
323 char *TS_exit_underline_mode
, *TS_enter_underline_mode
;
325 /* "as"/"ae" -- start/end alternate character set. Not really
328 char *TS_enter_alt_charset_mode
, *TS_exit_alt_charset_mode
;
330 /* "me" -- switch appearances off. */
332 char *TS_exit_attribute_mode
;
334 /* "Co" -- number of colors. */
338 /* "pa" -- max. number of color pairs on screen. Not handled yet.
339 Could be a problem if not equal to TN_max_colors * TN_max_colors. */
343 /* "op" -- SVr4 set default pair to its original value. */
347 /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
348 1 param, the color index. */
350 char *TS_set_foreground
, *TS_set_background
;
352 int TF_hazeltine
; /* termcap hz flag. */
353 int TF_insmode_motion
; /* termcap mi flag: can move while in insert mode. */
354 int TF_standout_motion
; /* termcap mi flag: can move while in standout mode. */
355 int TF_underscore
; /* termcap ul flag: _ underlines if over-struck on
356 non-blank position. Must clear before writing _. */
357 int TF_teleray
; /* termcap xt flag: many weird consequences.
360 static int RPov
; /* # chars to start a TS_repeat */
362 static int delete_in_insert_mode
; /* delete mode == insert mode */
364 static int se_is_so
; /* 1 if same string both enters and leaves
369 /* The largest frame width in any call to calculate_costs. */
373 /* The largest frame height in any call to calculate_costs. */
375 int max_frame_height
;
377 int costs_set
= 0; /* Nonzero if costs have been calculated. */
379 int insert_mode
; /* Nonzero when in insert mode. */
380 int standout_mode
; /* Nonzero when in standout mode. */
382 /* Size of window specified by higher levels.
383 This is the number of lines, from the top of frame downwards,
384 which can participate in insert-line/delete-line operations.
386 Effectively it excludes the bottom frame_height - specified_window_size
387 lines from those operations. */
389 int specified_window
;
391 /* Frame currently being redisplayed; 0 if not currently redisplaying.
392 (Direct output does not count). */
394 FRAME_PTR updating_frame
;
396 /* Provided for lisp packages. */
398 static int system_uses_terminfo
;
400 /* Flag used in tty_show/hide_cursor. */
402 static int tty_cursor_hidden
;
406 extern char *tgetstr ();
410 /* We aren't X windows, but we aren't termcap either. This makes me
411 uncertain as to what value to use for frame.output_method. For
412 this file, we'll define FRAME_TERMCAP_P to be zero so that our
413 output hooks get called instead of the termcap functions. Probably
414 the best long-term solution is to define an output_windows_nt... */
416 #undef FRAME_TERMCAP_P
417 #define FRAME_TERMCAP_P(_f_) 0
418 #endif /* WINDOWSNT */
423 if (!NILP (Vring_bell_function
))
425 Lisp_Object function
;
427 /* Temporarily set the global variable to nil
428 so that if we get an error, it stays nil
429 and we don't call it over and over.
431 We don't specbind it, because that would carefully
432 restore the bad value if there's an error
433 and make the loop of errors happen anyway. */
435 function
= Vring_bell_function
;
436 Vring_bell_function
= Qnil
;
440 Vring_bell_function
= function
;
442 else if (!FRAME_TERMCAP_P (XFRAME (selected_frame
)))
443 (*ring_bell_hook
) ();
445 OUTPUT (TS_visible_bell
&& visible_bell
? TS_visible_bell
: TS_bell
);
449 set_terminal_modes ()
451 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
453 OUTPUT_IF (TS_termcap_modes
);
454 OUTPUT_IF (TS_cursor_visible
);
455 OUTPUT_IF (TS_keypad_mode
);
459 (*set_terminal_modes_hook
) ();
463 reset_terminal_modes ()
465 if (FRAME_TERMCAP_P (XFRAME (selected_frame
)))
467 turn_off_highlight ();
469 OUTPUT_IF (TS_end_keypad_mode
);
470 OUTPUT_IF (TS_cursor_normal
);
471 OUTPUT_IF (TS_end_termcap_modes
);
472 OUTPUT_IF (TS_orig_pair
);
473 /* Output raw CR so kernel can track the cursor hpos. */
476 else if (reset_terminal_modes_hook
)
477 (*reset_terminal_modes_hook
) ();
485 if (!FRAME_TERMCAP_P (f
))
486 update_begin_hook (f
);
493 if (FRAME_TERMCAP_P (f
))
495 if (!XWINDOW (selected_window
)->cursor_off_p
)
498 background_highlight ();
503 updating_frame
= NULL
;
507 set_terminal_window (size
)
510 if (FRAME_TERMCAP_P (updating_frame
))
512 specified_window
= size
? size
: FRAME_HEIGHT (updating_frame
);
513 if (scroll_region_ok
)
514 set_scroll_region (0, specified_window
);
517 set_terminal_window_hook (size
);
521 set_scroll_region (start
, stop
)
525 struct frame
*sf
= XFRAME (selected_frame
);
527 if (TS_set_scroll_region
)
528 buf
= tparam (TS_set_scroll_region
, 0, 0, start
, stop
- 1);
529 else if (TS_set_scroll_region_1
)
530 buf
= tparam (TS_set_scroll_region_1
, 0, 0,
531 FRAME_HEIGHT (sf
), start
,
532 FRAME_HEIGHT (sf
) - stop
,
535 buf
= tparam (TS_set_window
, 0, 0, start
, 0, stop
, FRAME_WIDTH (sf
));
547 OUTPUT (TS_insert_mode
);
555 OUTPUT (TS_end_insert_mode
);
559 /* Handle highlighting. */
562 turn_off_highlight ()
565 OUTPUT_IF (TS_end_standout_mode
);
573 OUTPUT_IF (TS_standout_mode
);
581 turn_off_highlight ();
583 turn_on_highlight ();
587 /* Make cursor invisible. */
592 if (tty_cursor_hidden
== 0)
594 tty_cursor_hidden
= 1;
595 OUTPUT_IF (TS_cursor_invisible
);
600 /* Ensure that cursor is visible. */
605 if (tty_cursor_hidden
)
607 tty_cursor_hidden
= 0;
608 OUTPUT_IF (TS_cursor_normal
);
609 OUTPUT_IF (TS_cursor_visible
);
614 /* Set standout mode to the state it should be in for
615 empty space inside windows. What this is,
616 depends on the user option inverse-video. */
619 background_highlight ()
622 turn_on_highlight ();
624 turn_off_highlight ();
627 /* Set standout mode to the mode specified for the text to be output. */
630 highlight_if_desired ()
633 turn_on_highlight ();
635 turn_off_highlight ();
639 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
640 frame-relative coordinates. */
643 cursor_to (vpos
, hpos
)
646 struct frame
*f
= updating_frame
? updating_frame
: XFRAME (selected_frame
);
648 if (! FRAME_TERMCAP_P (f
) && cursor_to_hook
)
650 (*cursor_to_hook
) (vpos
, hpos
);
654 /* Detect the case where we are called from reset_sys_modes
655 and the costs have never been calculated. Do nothing. */
659 if (curY
== vpos
&& curX
== hpos
)
661 if (!TF_standout_motion
)
662 background_highlight ();
663 if (!TF_insmode_motion
)
668 /* Similar but don't take any account of the wasted characters. */
671 raw_cursor_to (row
, col
)
674 struct frame
*f
= updating_frame
? updating_frame
: XFRAME (selected_frame
);
675 if (! FRAME_TERMCAP_P (f
))
677 (*raw_cursor_to_hook
) (row
, col
);
680 if (curY
== row
&& curX
== col
)
682 if (!TF_standout_motion
)
683 background_highlight ();
684 if (!TF_insmode_motion
)
689 /* Erase operations */
691 /* clear from cursor to end of frame */
697 if (clear_to_end_hook
&& ! FRAME_TERMCAP_P (updating_frame
))
699 (*clear_to_end_hook
) ();
702 if (TS_clr_to_bottom
)
704 background_highlight ();
705 OUTPUT (TS_clr_to_bottom
);
709 for (i
= curY
; i
< FRAME_HEIGHT (XFRAME (selected_frame
)); i
++)
712 clear_end_of_line (FRAME_WIDTH (XFRAME (selected_frame
)));
717 /* Clear entire frame */
722 struct frame
*sf
= XFRAME (selected_frame
);
725 && ! FRAME_TERMCAP_P ((updating_frame
? updating_frame
: sf
)))
727 (*clear_frame_hook
) ();
732 background_highlight ();
733 OUTPUT (TS_clr_frame
);
743 /* Clear from cursor to end of line.
744 Assume that the line is already clear starting at column first_unused_hpos.
746 Note that the cursor may be moved, on terminals lacking a `ce' string. */
749 clear_end_of_line (first_unused_hpos
)
750 int first_unused_hpos
;
754 if (clear_end_of_line_hook
755 && ! FRAME_TERMCAP_P ((updating_frame
757 : XFRAME (selected_frame
))))
759 (*clear_end_of_line_hook
) (first_unused_hpos
);
763 /* Detect the case where we are called from reset_sys_modes
764 and the costs have never been calculated. Do nothing. */
768 if (curX
>= first_unused_hpos
)
770 background_highlight ();
773 OUTPUT1 (TS_clr_line
);
776 { /* have to do it the hard way */
777 struct frame
*sf
= XFRAME (selected_frame
);
780 /* Do not write in last row last col with Auto-wrap on. */
781 if (AutoWrap
&& curY
== FRAME_HEIGHT (sf
) - 1
782 && first_unused_hpos
== FRAME_WIDTH (sf
))
785 for (i
= curX
; i
< first_unused_hpos
; i
++)
788 fputc (' ', termscript
);
791 cmplus (first_unused_hpos
- curX
);
795 /* Encode SRC_LEN glyphs starting at SRC to terminal output codes and
796 store them at DST. Do not write more than DST_LEN bytes. That may
797 require stopping before all SRC_LEN input glyphs have been
800 We store the number of glyphs actually converted in *CONSUMED. The
801 return value is the number of bytes store in DST. */
804 encode_terminal_code (src
, dst
, src_len
, dst_len
, consumed
)
808 int dst_len
, *consumed
;
810 struct glyph
*src_start
= src
, *src_end
= src
+ src_len
;
811 unsigned char *dst_start
= dst
, *dst_end
= dst
+ dst_len
;
813 unsigned char workbuf
[MAX_MULTIBYTE_LENGTH
], *buf
;
815 register int tlen
= GLYPH_TABLE_LENGTH
;
816 register Lisp_Object
*tbase
= GLYPH_TABLE_BASE
;
818 struct coding_system
*coding
;
820 /* If terminal_coding does any conversion, use it, otherwise use
821 safe_terminal_coding. We can't use CODING_REQUIRE_ENCODING here
822 because it always return 1 if the member src_multibyte is 1. */
823 coding
= (terminal_coding
.common_flags
& CODING_REQUIRE_ENCODING_MASK
825 : &safe_terminal_coding
);
827 while (src
< src_end
)
829 /* We must skip glyphs to be padded for a wide character. */
830 if (! CHAR_GLYPH_PADDING_P (*src
))
832 g
= GLYPH_FROM_CHAR_GLYPH (src
[0]);
834 if (g
< 0 || g
>= tlen
)
836 /* This glyph doesn't has an entry in Vglyph_table. */
837 if (! CHAR_VALID_P (src
->u
.ch
, 0))
841 coding
->src_multibyte
= 0;
845 len
= CHAR_STRING (src
->u
.ch
, workbuf
);
847 coding
->src_multibyte
= 1;
852 /* This glyph has an entry in Vglyph_table,
853 so process any alias before testing for simpleness. */
854 GLYPH_FOLLOW_ALIASES (tbase
, tlen
, g
);
856 if (GLYPH_SIMPLE_P (tbase
, tlen
, g
))
858 /* We set the multi-byte form of a character in G
859 (that should be an ASCII character) at
861 workbuf
[0] = FAST_GLYPH_CHAR (g
);
864 coding
->src_multibyte
= 0;
868 /* We have a string in Vglyph_table. */
869 len
= GLYPH_LENGTH (tbase
, g
);
870 buf
= GLYPH_STRING (tbase
, g
);
871 coding
->src_multibyte
= STRING_MULTIBYTE (tbase
[g
]);
875 result
= encode_coding (coding
, buf
, dst
, len
, dst_end
- dst
);
876 len
-= coding
->consumed
;
877 dst
+= coding
->produced
;
878 if (result
== CODING_FINISH_INSUFFICIENT_DST
879 || (result
== CODING_FINISH_INSUFFICIENT_SRC
880 && len
> dst_end
- dst
))
881 /* The remaining output buffer is too short. We must
882 break the loop here without increasing SRC so that the
883 next call of this function starts from the same glyph. */
888 /* This is the case that a code of the range 0200..0237
889 exists in buf. We must just write out such a code. */
890 buf
+= coding
->consumed
;
898 *consumed
= src
- src_start
;
899 return (dst
- dst_start
);
904 write_glyphs (string
, len
)
905 register struct glyph
*string
;
908 int produced
, consumed
;
909 struct frame
*sf
= XFRAME (selected_frame
);
910 struct frame
*f
= updating_frame
? updating_frame
: sf
;
911 unsigned char conversion_buffer
[1024];
912 int conversion_buffer_size
= sizeof conversion_buffer
;
914 if (write_glyphs_hook
915 && ! FRAME_TERMCAP_P (f
))
917 (*write_glyphs_hook
) (string
, len
);
924 /* Don't dare write in last column of bottom line, if Auto-Wrap,
925 since that would scroll the whole frame on some terminals. */
928 && curY
+ 1 == FRAME_HEIGHT (sf
)
929 && (curX
+ len
) == FRAME_WIDTH (sf
))
936 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
938 terminal_coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
942 /* Identify a run of glyphs with the same face. */
943 int face_id
= string
->face_id
;
946 for (n
= 1; n
< len
; ++n
)
947 if (string
[n
].face_id
!= face_id
)
950 /* Turn appearance modes of the face of the run on. */
951 highlight_if_desired ();
952 turn_on_face (f
, face_id
);
956 /* We use a fixed size (1024 bytes) of conversion buffer.
957 Usually it is sufficient, but if not, we just repeat the
959 produced
= encode_terminal_code (string
, conversion_buffer
,
960 n
, conversion_buffer_size
,
964 fwrite (conversion_buffer
, 1, produced
, stdout
);
968 fwrite (conversion_buffer
, 1, produced
, termscript
);
975 /* Turn appearance modes off. */
976 turn_off_face (f
, face_id
);
977 turn_off_highlight ();
980 /* We may have to output some codes to terminate the writing. */
981 if (CODING_REQUIRE_FLUSHING (&terminal_coding
))
983 terminal_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
984 encode_coding (&terminal_coding
, "", conversion_buffer
,
985 0, conversion_buffer_size
);
986 if (terminal_coding
.produced
> 0)
988 fwrite (conversion_buffer
, 1, terminal_coding
.produced
, stdout
);
992 fwrite (conversion_buffer
, 1, terminal_coding
.produced
,
1000 /* If start is zero, insert blanks instead of a string at start */
1003 insert_glyphs (start
, len
)
1004 register struct glyph
*start
;
1008 struct glyph
*glyph
= NULL
;
1009 struct frame
*f
, *sf
;
1014 if (insert_glyphs_hook
)
1016 (*insert_glyphs_hook
) (start
, len
);
1020 sf
= XFRAME (selected_frame
);
1021 f
= updating_frame
? updating_frame
: sf
;
1023 if (TS_ins_multi_chars
)
1025 buf
= tparam (TS_ins_multi_chars
, 0, 0, len
);
1029 write_glyphs (start
, len
);
1035 /* The bit CODING_MODE_LAST_BLOCK should be set to 1 only at the tail. */
1036 terminal_coding
.mode
&= ~CODING_MODE_LAST_BLOCK
;
1039 int produced
, consumed
;
1040 unsigned char conversion_buffer
[1024];
1041 int conversion_buffer_size
= sizeof conversion_buffer
;
1043 OUTPUT1_IF (TS_ins_char
);
1046 conversion_buffer
[0] = SPACEGLYPH
;
1051 highlight_if_desired ();
1052 turn_on_face (f
, start
->face_id
);
1055 /* We must open sufficient space for a character which
1056 occupies more than one column. */
1057 while (len
&& CHAR_GLYPH_PADDING_P (*start
))
1059 OUTPUT1_IF (TS_ins_char
);
1064 /* This is the last glyph. */
1065 terminal_coding
.mode
|= CODING_MODE_LAST_BLOCK
;
1067 /* The size of conversion buffer (1024 bytes) is surely
1068 sufficient for just one glyph. */
1069 produced
= encode_terminal_code (glyph
, conversion_buffer
, 1,
1070 conversion_buffer_size
, &consumed
);
1075 fwrite (conversion_buffer
, 1, produced
, stdout
);
1076 if (ferror (stdout
))
1079 fwrite (conversion_buffer
, 1, produced
, termscript
);
1082 OUTPUT1_IF (TS_pad_inserted_char
);
1085 turn_off_face (f
, glyph
->face_id
);
1086 turn_off_highlight ();
1100 if (delete_glyphs_hook
&& ! FRAME_TERMCAP_P (updating_frame
))
1102 (*delete_glyphs_hook
) (n
);
1106 if (delete_in_insert_mode
)
1113 OUTPUT_IF (TS_delete_mode
);
1116 if (TS_del_multi_chars
)
1118 buf
= tparam (TS_del_multi_chars
, 0, 0, n
);
1123 for (i
= 0; i
< n
; i
++)
1124 OUTPUT1 (TS_del_char
);
1125 if (!delete_in_insert_mode
)
1126 OUTPUT_IF (TS_end_delete_mode
);
1129 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
1132 ins_del_lines (vpos
, n
)
1135 char *multi
= n
> 0 ? TS_ins_multi_lines
: TS_del_multi_lines
;
1136 char *single
= n
> 0 ? TS_ins_line
: TS_del_line
;
1137 char *scroll
= n
> 0 ? TS_rev_scroll
: TS_fwd_scroll
;
1140 register int i
= n
> 0 ? n
: -n
;
1143 if (ins_del_lines_hook
&& ! FRAME_TERMCAP_P (updating_frame
))
1145 (*ins_del_lines_hook
) (vpos
, n
);
1149 sf
= XFRAME (selected_frame
);
1151 /* If the lines below the insertion are being pushed
1152 into the end of the window, this is the same as clearing;
1153 and we know the lines are already clear, since the matching
1154 deletion has already been done. So can ignore this. */
1155 /* If the lines below the deletion are blank lines coming
1156 out of the end of the window, don't bother,
1157 as there will be a matching inslines later that will flush them. */
1158 if (scroll_region_ok
&& vpos
+ i
>= specified_window
)
1160 if (!memory_below_frame
&& vpos
+ i
>= FRAME_HEIGHT (sf
))
1165 raw_cursor_to (vpos
, 0);
1166 background_highlight ();
1167 buf
= tparam (multi
, 0, 0, i
);
1173 raw_cursor_to (vpos
, 0);
1174 background_highlight ();
1182 set_scroll_region (vpos
, specified_window
);
1184 raw_cursor_to (specified_window
- 1, 0);
1186 raw_cursor_to (vpos
, 0);
1187 background_highlight ();
1189 OUTPUTL (scroll
, specified_window
- vpos
);
1190 set_scroll_region (0, specified_window
);
1193 if (!scroll_region_ok
&& memory_below_frame
&& n
< 0)
1195 cursor_to (FRAME_HEIGHT (sf
) + n
, 0);
1200 /* Compute cost of sending "str", in characters,
1201 not counting any line-dependent padding. */
1209 tputs (str
, 0, evalcost
);
1213 /* Compute cost of sending "str", in characters,
1214 counting any line-dependent padding at one line. */
1217 string_cost_one_line (str
)
1222 tputs (str
, 1, evalcost
);
1226 /* Compute per line amount of line-dependent padding,
1227 in tenths of characters. */
1235 tputs (str
, 0, evalcost
);
1238 tputs (str
, 10, evalcost
);
1243 /* char_ins_del_cost[n] is cost of inserting N characters.
1244 char_ins_del_cost[-n] is cost of deleting N characters.
1245 The length of this vector is based on max_frame_width. */
1247 int *char_ins_del_vector
;
1249 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_WIDTH ((f))])
1254 calculate_ins_del_char_costs (frame
)
1257 int ins_startup_cost
, del_startup_cost
;
1258 int ins_cost_per_char
, del_cost_per_char
;
1262 if (TS_ins_multi_chars
)
1264 ins_cost_per_char
= 0;
1265 ins_startup_cost
= string_cost_one_line (TS_ins_multi_chars
);
1267 else if (TS_ins_char
|| TS_pad_inserted_char
1268 || (TS_insert_mode
&& TS_end_insert_mode
))
1270 ins_startup_cost
= (30 * (string_cost (TS_insert_mode
)
1271 + string_cost (TS_end_insert_mode
))) / 100;
1272 ins_cost_per_char
= (string_cost_one_line (TS_ins_char
)
1273 + string_cost_one_line (TS_pad_inserted_char
));
1277 ins_startup_cost
= 9999;
1278 ins_cost_per_char
= 0;
1281 if (TS_del_multi_chars
)
1283 del_cost_per_char
= 0;
1284 del_startup_cost
= string_cost_one_line (TS_del_multi_chars
);
1286 else if (TS_del_char
)
1288 del_startup_cost
= (string_cost (TS_delete_mode
)
1289 + string_cost (TS_end_delete_mode
));
1290 if (delete_in_insert_mode
)
1291 del_startup_cost
/= 2;
1292 del_cost_per_char
= string_cost_one_line (TS_del_char
);
1296 del_startup_cost
= 9999;
1297 del_cost_per_char
= 0;
1300 /* Delete costs are at negative offsets */
1301 p
= &char_ins_del_cost (frame
)[0];
1302 for (i
= FRAME_WIDTH (frame
); --i
>= 0;)
1303 *--p
= (del_startup_cost
+= del_cost_per_char
);
1305 /* Doing nothing is free */
1306 p
= &char_ins_del_cost (frame
)[0];
1309 /* Insert costs are at positive offsets */
1310 for (i
= FRAME_WIDTH (frame
); --i
>= 0;)
1311 *p
++ = (ins_startup_cost
+= ins_cost_per_char
);
1315 calculate_costs (frame
)
1318 register char *f
= (TS_set_scroll_region
1319 ? TS_set_scroll_region
1320 : TS_set_scroll_region_1
);
1322 FRAME_COST_BAUD_RATE (frame
) = baud_rate
;
1324 scroll_region_cost
= string_cost (f
);
1326 /* These variables are only used for terminal stuff. They are allocated
1327 once for the terminal frame of X-windows emacs, but not used afterwards.
1329 char_ins_del_vector (i.e., char_ins_del_cost) isn't used because
1330 X turns off char_ins_del_ok. */
1332 max_frame_height
= max (max_frame_height
, FRAME_HEIGHT (frame
));
1333 max_frame_width
= max (max_frame_width
, FRAME_WIDTH (frame
));
1337 if (char_ins_del_vector
!= 0)
1339 = (int *) xrealloc (char_ins_del_vector
,
1341 + 2 * max_frame_width
* sizeof (int)));
1344 = (int *) xmalloc (sizeof (int)
1345 + 2 * max_frame_width
* sizeof (int));
1347 bzero (char_ins_del_vector
, (sizeof (int)
1348 + 2 * max_frame_width
* sizeof (int)));
1350 if (f
&& (!TS_ins_line
&& !TS_del_line
))
1351 do_line_insertion_deletion_costs (frame
,
1352 TS_rev_scroll
, TS_ins_multi_lines
,
1353 TS_fwd_scroll
, TS_del_multi_lines
,
1356 do_line_insertion_deletion_costs (frame
,
1357 TS_ins_line
, TS_ins_multi_lines
,
1358 TS_del_line
, TS_del_multi_lines
,
1361 calculate_ins_del_char_costs (frame
);
1363 /* Don't use TS_repeat if its padding is worse than sending the chars */
1364 if (TS_repeat
&& per_line_cost (TS_repeat
) * baud_rate
< 9000)
1365 RPov
= string_cost (TS_repeat
);
1367 RPov
= FRAME_WIDTH (frame
) * 2;
1369 cmcostinit (); /* set up cursor motion costs */
1376 /* Termcap capability names that correspond directly to X keysyms.
1377 Some of these (marked "terminfo") aren't supplied by old-style
1378 (Berkeley) termcap entries. They're listed in X keysym order;
1379 except we put the keypad keys first, so that if they clash with
1380 other keys (as on the IBM PC keyboard) they get overridden.
1383 static struct fkey_table keys
[] =
1385 "kh", "home", /* termcap */
1386 "kl", "left", /* termcap */
1387 "ku", "up", /* termcap */
1388 "kr", "right", /* termcap */
1389 "kd", "down", /* termcap */
1390 "%8", "prior", /* terminfo */
1391 "%5", "next", /* terminfo */
1392 "@7", "end", /* terminfo */
1393 "@1", "begin", /* terminfo */
1394 "*6", "select", /* terminfo */
1395 "%9", "print", /* terminfo */
1396 "@4", "execute", /* terminfo --- actually the `command' key */
1398 * "insert" --- see below
1400 "&8", "undo", /* terminfo */
1401 "%0", "redo", /* terminfo */
1402 "%7", "menu", /* terminfo --- actually the `options' key */
1403 "@0", "find", /* terminfo */
1404 "@2", "cancel", /* terminfo */
1405 "%1", "help", /* terminfo */
1407 * "break" goes here, but can't be reliably intercepted with termcap
1409 "&4", "reset", /* terminfo --- actually `restart' */
1411 * "system" and "user" --- no termcaps
1413 "kE", "clearline", /* terminfo */
1414 "kA", "insertline", /* terminfo */
1415 "kL", "deleteline", /* terminfo */
1416 "kI", "insertchar", /* terminfo */
1417 "kD", "deletechar", /* terminfo */
1418 "kB", "backtab", /* terminfo */
1420 * "kp_backtab", "kp-space", "kp-tab" --- no termcaps
1422 "@8", "kp-enter", /* terminfo */
1424 * "kp-f1", "kp-f2", "kp-f3" "kp-f4",
1425 * "kp-multiply", "kp-add", "kp-separator",
1426 * "kp-subtract", "kp-decimal", "kp-divide", "kp-0";
1427 * --- no termcaps for any of these.
1429 "K4", "kp-1", /* terminfo */
1431 * "kp-2" --- no termcap
1433 "K5", "kp-3", /* terminfo */
1435 * "kp-4" --- no termcap
1437 "K2", "kp-5", /* terminfo */
1439 * "kp-6" --- no termcap
1441 "K1", "kp-7", /* terminfo */
1443 * "kp-8" --- no termcap
1445 "K3", "kp-9", /* terminfo */
1447 * "kp-equal" --- no termcap
1460 static char **term_get_fkeys_arg
;
1461 static Lisp_Object
term_get_fkeys_1 ();
1463 /* Find the escape codes sent by the function keys for Vfunction_key_map.
1464 This function scans the termcap function key sequence entries, and
1465 adds entries to Vfunction_key_map for each function key it finds. */
1468 term_get_fkeys (address
)
1471 /* We run the body of the function (term_get_fkeys_1) and ignore all Lisp
1472 errors during the call. The only errors should be from Fdefine_key
1473 when given a key sequence containing an invalid prefix key. If the
1474 termcap defines function keys which use a prefix that is already bound
1475 to a command by the default bindings, we should silently ignore that
1476 function key specification, rather than giving the user an error and
1477 refusing to run at all on such a terminal. */
1479 extern Lisp_Object
Fidentity ();
1480 term_get_fkeys_arg
= address
;
1481 internal_condition_case (term_get_fkeys_1
, Qerror
, Fidentity
);
1489 char **address
= term_get_fkeys_arg
;
1491 /* This can happen if CANNOT_DUMP or with strange options. */
1493 Vfunction_key_map
= Fmake_sparse_keymap (Qnil
);
1495 for (i
= 0; i
< (sizeof (keys
)/sizeof (keys
[0])); i
++)
1497 char *sequence
= tgetstr (keys
[i
].cap
, address
);
1499 Fdefine_key (Vfunction_key_map
, build_string (sequence
),
1500 Fmake_vector (make_number (1),
1501 intern (keys
[i
].name
)));
1504 /* The uses of the "k0" capability are inconsistent; sometimes it
1505 describes F10, whereas othertimes it describes F0 and "k;" describes F10.
1506 We will attempt to politely accommodate both systems by testing for
1507 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.
1510 char *k_semi
= tgetstr ("k;", address
);
1511 char *k0
= tgetstr ("k0", address
);
1512 char *k0_name
= "f10";
1516 Fdefine_key (Vfunction_key_map
, build_string (k_semi
),
1517 Fmake_vector (make_number (1), intern ("f10")));
1522 Fdefine_key (Vfunction_key_map
, build_string (k0
),
1523 Fmake_vector (make_number (1), intern (k0_name
)));
1526 /* Set up cookies for numbered function keys above f10. */
1528 char fcap
[3], fkey
[4];
1530 fcap
[0] = 'F'; fcap
[2] = '\0';
1531 for (i
= 11; i
< 64; i
++)
1534 fcap
[1] = '1' + i
- 11;
1536 fcap
[1] = 'A' + i
- 20;
1538 fcap
[1] = 'a' + i
- 46;
1541 char *sequence
= tgetstr (fcap
, address
);
1544 sprintf (fkey
, "f%d", i
);
1545 Fdefine_key (Vfunction_key_map
, build_string (sequence
),
1546 Fmake_vector (make_number (1),
1554 * Various mappings to try and get a better fit.
1557 #define CONDITIONAL_REASSIGN(cap1, cap2, sym) \
1558 if (!tgetstr (cap1, address)) \
1560 char *sequence = tgetstr (cap2, address); \
1562 Fdefine_key (Vfunction_key_map, build_string (sequence), \
1563 Fmake_vector (make_number (1), \
1567 /* if there's no key_next keycap, map key_npage to `next' keysym */
1568 CONDITIONAL_REASSIGN ("%5", "kN", "next");
1569 /* if there's no key_prev keycap, map key_ppage to `previous' keysym */
1570 CONDITIONAL_REASSIGN ("%8", "kP", "prior");
1571 /* if there's no key_dc keycap, map key_ic to `insert' keysym */
1572 CONDITIONAL_REASSIGN ("kD", "kI", "insert");
1573 /* if there's no key_end keycap, map key_ll to 'end' keysym */
1574 CONDITIONAL_REASSIGN ("@7", "kH", "end");
1576 /* IBM has their own non-standard dialect of terminfo.
1577 If the standard name isn't found, try the IBM name. */
1578 CONDITIONAL_REASSIGN ("kB", "KO", "backtab");
1579 CONDITIONAL_REASSIGN ("@4", "kJ", "execute"); /* actually "action" */
1580 CONDITIONAL_REASSIGN ("@4", "kc", "execute"); /* actually "command" */
1581 CONDITIONAL_REASSIGN ("%7", "ki", "menu");
1582 CONDITIONAL_REASSIGN ("@7", "kw", "end");
1583 CONDITIONAL_REASSIGN ("F1", "k<", "f11");
1584 CONDITIONAL_REASSIGN ("F2", "k>", "f12");
1585 CONDITIONAL_REASSIGN ("%1", "kq", "help");
1586 CONDITIONAL_REASSIGN ("*6", "kU", "select");
1587 #undef CONDITIONAL_REASSIGN
1594 /***********************************************************************
1595 Character Display Information
1596 ***********************************************************************/
1598 static void append_glyph
P_ ((struct it
*));
1601 /* Append glyphs to IT's glyph_row. Called from produce_glyphs for
1602 terminal frames if IT->glyph_row != NULL. IT->c is the character
1603 for which to produce glyphs; IT->face_id contains the character's
1604 face. Padding glyphs are appended if IT->c has a IT->pixel_width >
1611 struct glyph
*glyph
, *end
;
1614 xassert (it
->glyph_row
);
1615 glyph
= (it
->glyph_row
->glyphs
[it
->area
]
1616 + it
->glyph_row
->used
[it
->area
]);
1617 end
= it
->glyph_row
->glyphs
[1 + it
->area
];
1620 i
< it
->pixel_width
&& glyph
< end
;
1623 glyph
->type
= CHAR_GLYPH
;
1624 glyph
->pixel_width
= 1;
1625 glyph
->u
.ch
= it
->c
;
1626 glyph
->face_id
= it
->face_id
;
1627 glyph
->padding_p
= i
> 0;
1628 glyph
->charpos
= CHARPOS (it
->position
);
1629 glyph
->object
= it
->object
;
1631 ++it
->glyph_row
->used
[it
->area
];
1637 /* Produce glyphs for the display element described by IT. The
1638 function fills output fields of IT with pixel information like the
1639 pixel width and height of a character, and maybe produces glyphs at
1640 the same time if IT->glyph_row is non-null. See the explanation of
1641 struct display_iterator in dispextern.h for an overview. */
1647 /* If a hook is installed, let it do the work. */
1648 xassert (it
->what
== IT_CHARACTER
1649 || it
->what
== IT_COMPOSITION
1650 || it
->what
== IT_IMAGE
1651 || it
->what
== IT_STRETCH
);
1653 /* Nothing but characters are supported on terminal frames. For a
1654 composition sequence, it->c is the first character of the
1656 xassert (it
->what
== IT_CHARACTER
1657 || it
->what
== IT_COMPOSITION
);
1659 if (it
->c
>= 040 && it
->c
< 0177)
1661 it
->pixel_width
= it
->nglyphs
= 1;
1665 else if (it
->c
== '\n')
1666 it
->pixel_width
= it
->nglyphs
= 0;
1667 else if (it
->c
== '\t')
1669 int absolute_x
= (it
->current_x
1670 + it
->continuation_lines_width
);
1672 = (((1 + absolute_x
+ it
->tab_width
- 1)
1677 /* If part of the TAB has been displayed on the previous line
1678 which is continued now, continuation_lines_width will have
1679 been incremented already by the part that fitted on the
1680 continued line. So, we will get the right number of spaces
1682 nspaces
= next_tab_x
- absolute_x
;
1689 it
->pixel_width
= it
->len
= 1;
1697 it
->pixel_width
= nspaces
;
1698 it
->nglyphs
= nspaces
;
1700 else if (SINGLE_BYTE_CHAR_P (it
->c
))
1702 /* Coming here means that it->c is from display table, thus we
1703 must send the code as is to the terminal. Although there's
1704 no way to know how many columns it occupies on a screen, it
1705 is a good assumption that a single byte code has 1-column
1707 it
->pixel_width
= it
->nglyphs
= 1;
1713 /* A multi-byte character. The display width is fixed for all
1714 characters of the set. Some of the glyphs may have to be
1715 ignored because they are already displayed in a continued
1717 int charset
= CHAR_CHARSET (it
->c
);
1719 it
->pixel_width
= CHARSET_WIDTH (charset
);
1720 it
->nglyphs
= it
->pixel_width
;
1726 /* Advance current_x by the pixel width as a convenience for
1728 if (it
->area
== TEXT_AREA
)
1729 it
->current_x
+= it
->pixel_width
;
1730 it
->ascent
= it
->max_ascent
= it
->phys_ascent
= it
->max_phys_ascent
= 0;
1731 it
->descent
= it
->max_descent
= it
->phys_descent
= it
->max_phys_descent
= 1;
1735 /* Get information about special display element WHAT in an
1736 environment described by IT. WHAT is one of IT_TRUNCATION or
1737 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
1738 non-null glyph_row member. This function ensures that fields like
1739 face_id, c, len of IT are left untouched. */
1742 produce_special_glyphs (it
, what
)
1744 enum display_element_type what
;
1750 temp_it
.what
= IT_CHARACTER
;
1752 temp_it
.object
= make_number (0);
1753 bzero (&temp_it
.current
, sizeof temp_it
.current
);
1755 if (what
== IT_CONTINUATION
)
1757 /* Continuation glyph. */
1759 && INTEGERP (DISP_CONTINUE_GLYPH (it
->dp
))
1760 && GLYPH_CHAR_VALID_P (XINT (DISP_CONTINUE_GLYPH (it
->dp
))))
1762 temp_it
.c
= FAST_GLYPH_CHAR (XINT (DISP_CONTINUE_GLYPH (it
->dp
)));
1763 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
1768 produce_glyphs (&temp_it
);
1769 it
->pixel_width
= temp_it
.pixel_width
;
1770 it
->nglyphs
= temp_it
.pixel_width
;
1772 else if (what
== IT_TRUNCATION
)
1774 /* Truncation glyph. */
1776 && INTEGERP (DISP_TRUNC_GLYPH (it
->dp
))
1777 && GLYPH_CHAR_VALID_P (XINT (DISP_TRUNC_GLYPH (it
->dp
))))
1779 temp_it
.c
= FAST_GLYPH_CHAR (XINT (DISP_TRUNC_GLYPH (it
->dp
)));
1780 temp_it
.len
= CHAR_BYTES (temp_it
.c
);
1785 produce_glyphs (&temp_it
);
1786 it
->pixel_width
= temp_it
.pixel_width
;
1787 it
->nglyphs
= temp_it
.pixel_width
;
1794 /* Return an estimation of the pixel height of mode or top lines on
1795 frame F. FACE_ID specifies what line's height to estimate. */
1798 estimate_mode_line_height (f
, face_id
)
1800 enum face_id face_id
;
1802 if (estimate_mode_line_height_hook
)
1803 return estimate_mode_line_height_hook (f
, face_id
);
1810 /***********************************************************************
1812 ***********************************************************************/
1814 /* Value is non-zero if attribute ATTR may be used. ATTR should be
1815 one of the enumerators from enum no_color_bit, or a bit set built
1816 from them. Some display attributes may not be used together with
1817 color; the termcap capability `NC' specifies which ones. */
1819 #define MAY_USE_WITH_COLORS_P(ATTR) \
1820 (TN_max_colors > 0 \
1821 ? (TN_no_color_video & (ATTR)) == 0 \
1824 /* Turn appearances of face FACE_ID on tty frame F on. */
1827 turn_on_face (f
, face_id
)
1831 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1832 long fg
= face
->foreground
;
1833 long bg
= face
->background
;
1835 /* Do this first because TS_end_standout_mode may be the same
1836 as TS_exit_attribute_mode, which turns all appearances off. */
1837 if (MAY_USE_WITH_COLORS_P (NC_REVERSE
))
1839 if (TN_max_colors
> 0)
1841 if (fg
>= 0 && bg
>= 0)
1843 /* If the terminal supports colors, we can set them
1844 below without using reverse video. The face's fg
1845 and bg colors are set as they should appear on
1846 the screen, i.e. they take the inverse-video'ness
1847 of the face already into account. */
1849 else if (inverse_video
)
1851 if (fg
== FACE_TTY_DEFAULT_FG_COLOR
1852 || bg
== FACE_TTY_DEFAULT_BG_COLOR
)
1853 toggle_highlight ();
1857 if (fg
== FACE_TTY_DEFAULT_BG_COLOR
1858 || bg
== FACE_TTY_DEFAULT_FG_COLOR
)
1859 toggle_highlight ();
1864 /* If we can't display colors, use reverse video
1865 if the face specifies that. */
1868 if (fg
== FACE_TTY_DEFAULT_FG_COLOR
1869 || bg
== FACE_TTY_DEFAULT_BG_COLOR
)
1870 toggle_highlight ();
1874 if (fg
== FACE_TTY_DEFAULT_BG_COLOR
1875 || bg
== FACE_TTY_DEFAULT_FG_COLOR
)
1876 toggle_highlight ();
1881 if (face
->tty_bold_p
)
1883 if (MAY_USE_WITH_COLORS_P (NC_BOLD
))
1884 OUTPUT1_IF (TS_enter_bold_mode
);
1886 else if (face
->tty_dim_p
)
1887 if (MAY_USE_WITH_COLORS_P (NC_DIM
))
1888 OUTPUT1_IF (TS_enter_dim_mode
);
1890 /* Alternate charset and blinking not yet used. */
1891 if (face
->tty_alt_charset_p
1892 && MAY_USE_WITH_COLORS_P (NC_ALT_CHARSET
))
1893 OUTPUT1_IF (TS_enter_alt_charset_mode
);
1895 if (face
->tty_blinking_p
1896 && MAY_USE_WITH_COLORS_P (NC_BLINK
))
1897 OUTPUT1_IF (TS_enter_blink_mode
);
1899 if (face
->tty_underline_p
&& MAY_USE_WITH_COLORS_P (NC_UNDERLINE
))
1900 OUTPUT1_IF (TS_enter_underline_mode
);
1902 if (TN_max_colors
> 0)
1906 if (fg
>= 0 && TS_set_foreground
)
1908 p
= tparam (TS_set_foreground
, NULL
, 0, (int) fg
);
1913 if (bg
>= 0 && TS_set_background
)
1915 p
= tparam (TS_set_background
, NULL
, 0, (int) bg
);
1923 /* Turn off appearances of face FACE_ID on tty frame F. */
1926 turn_off_face (f
, face_id
)
1930 struct face
*face
= FACE_FROM_ID (f
, face_id
);
1932 xassert (face
!= NULL
);
1934 if (TS_exit_attribute_mode
)
1936 /* Capability "me" will turn off appearance modes double-bright,
1937 half-bright, reverse-video, standout, underline. It may or
1938 may not turn off alt-char-mode. */
1939 if (face
->tty_bold_p
1941 || face
->tty_reverse_p
1942 || face
->tty_alt_charset_p
1943 || face
->tty_blinking_p
1944 || face
->tty_underline_p
)
1946 OUTPUT1_IF (TS_exit_attribute_mode
);
1947 if (strcmp (TS_exit_attribute_mode
, TS_end_standout_mode
) == 0)
1951 if (face
->tty_alt_charset_p
)
1952 OUTPUT_IF (TS_exit_alt_charset_mode
);
1956 /* If we don't have "me" we can only have those appearances
1957 that have exit sequences defined. */
1958 if (face
->tty_alt_charset_p
)
1959 OUTPUT_IF (TS_exit_alt_charset_mode
);
1961 if (face
->tty_underline_p
)
1962 OUTPUT_IF (TS_exit_underline_mode
);
1965 /* Switch back to default colors. */
1966 if (TN_max_colors
> 0
1967 && ((face
->foreground
!= FACE_TTY_DEFAULT_COLOR
1968 && face
->foreground
!= FACE_TTY_DEFAULT_FG_COLOR
)
1969 || (face
->background
!= FACE_TTY_DEFAULT_COLOR
1970 && face
->background
!= FACE_TTY_DEFAULT_BG_COLOR
)))
1971 OUTPUT1_IF (TS_orig_pair
);
1975 /* Return non-zero if the terminal is capable to display colors. */
1977 DEFUN ("tty-display-color-p", Ftty_display_color_p
, Stty_display_color_p
,
1979 doc
: /* Return non-nil if TTY can display colors on FRAME. */)
1983 return TN_max_colors
> 0 ? Qt
: Qnil
;
1989 /***********************************************************************
1991 ***********************************************************************/
1994 term_init (terminal_type
)
1995 char *terminal_type
;
1998 char **address
= &area
;
2002 struct frame
*sf
= XFRAME (selected_frame
);
2005 initialize_w32_display ();
2009 area
= (char *) xmalloc (2044);
2014 FrameRows
= FRAME_HEIGHT (sf
);
2015 FrameCols
= FRAME_WIDTH (sf
);
2016 specified_window
= FRAME_HEIGHT (sf
);
2018 delete_in_insert_mode
= 1;
2021 scroll_region_ok
= 0;
2023 /* Seems to insert lines when it's not supposed to, messing
2024 up the display. In doing a trace, it didn't seem to be
2025 called much, so I don't think we're losing anything by
2028 line_ins_del_ok
= 0;
2029 char_ins_del_ok
= 1;
2033 FRAME_CAN_HAVE_SCROLL_BARS (sf
) = 0;
2034 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf
) = vertical_scroll_bar_none
;
2035 TN_max_colors
= 16; /* Required to be non-zero for tty-display-color-p */
2038 #else /* not WINDOWSNT */
2042 status
= tgetent (buffer
, terminal_type
);
2046 fatal ("Cannot open terminfo database file");
2048 fatal ("Cannot open termcap database file");
2054 fatal ("Terminal type %s is not defined.\n\
2055 If that is not the actual type of terminal you have,\n\
2056 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2057 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2058 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2061 fatal ("Terminal type %s is not defined.\n\
2062 If that is not the actual type of terminal you have,\n\
2063 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2064 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2065 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2070 area
= (char *) xmalloc (2044);
2072 area
= (char *) xmalloc (strlen (buffer
));
2073 #endif /* not TERMINFO */
2077 TS_ins_line
= tgetstr ("al", address
);
2078 TS_ins_multi_lines
= tgetstr ("AL", address
);
2079 TS_bell
= tgetstr ("bl", address
);
2080 BackTab
= tgetstr ("bt", address
);
2081 TS_clr_to_bottom
= tgetstr ("cd", address
);
2082 TS_clr_line
= tgetstr ("ce", address
);
2083 TS_clr_frame
= tgetstr ("cl", address
);
2084 ColPosition
= NULL
; /* tgetstr ("ch", address); */
2085 AbsPosition
= tgetstr ("cm", address
);
2086 CR
= tgetstr ("cr", address
);
2087 TS_set_scroll_region
= tgetstr ("cs", address
);
2088 TS_set_scroll_region_1
= tgetstr ("cS", address
);
2089 RowPosition
= tgetstr ("cv", address
);
2090 TS_del_char
= tgetstr ("dc", address
);
2091 TS_del_multi_chars
= tgetstr ("DC", address
);
2092 TS_del_line
= tgetstr ("dl", address
);
2093 TS_del_multi_lines
= tgetstr ("DL", address
);
2094 TS_delete_mode
= tgetstr ("dm", address
);
2095 TS_end_delete_mode
= tgetstr ("ed", address
);
2096 TS_end_insert_mode
= tgetstr ("ei", address
);
2097 Home
= tgetstr ("ho", address
);
2098 TS_ins_char
= tgetstr ("ic", address
);
2099 TS_ins_multi_chars
= tgetstr ("IC", address
);
2100 TS_insert_mode
= tgetstr ("im", address
);
2101 TS_pad_inserted_char
= tgetstr ("ip", address
);
2102 TS_end_keypad_mode
= tgetstr ("ke", address
);
2103 TS_keypad_mode
= tgetstr ("ks", address
);
2104 LastLine
= tgetstr ("ll", address
);
2105 Right
= tgetstr ("nd", address
);
2106 Down
= tgetstr ("do", address
);
2108 Down
= tgetstr ("nl", address
); /* Obsolete name for "do" */
2110 /* VMS puts a carriage return before each linefeed,
2111 so it is not safe to use linefeeds. */
2112 if (Down
&& Down
[0] == '\n' && Down
[1] == '\0')
2115 if (tgetflag ("bs"))
2116 Left
= "\b"; /* can't possibly be longer! */
2117 else /* (Actually, "bs" is obsolete...) */
2118 Left
= tgetstr ("le", address
);
2120 Left
= tgetstr ("bc", address
); /* Obsolete name for "le" */
2121 TS_pad_char
= tgetstr ("pc", address
);
2122 TS_repeat
= tgetstr ("rp", address
);
2123 TS_end_standout_mode
= tgetstr ("se", address
);
2124 TS_fwd_scroll
= tgetstr ("sf", address
);
2125 TS_standout_mode
= tgetstr ("so", address
);
2126 TS_rev_scroll
= tgetstr ("sr", address
);
2127 Wcm
.cm_tab
= tgetstr ("ta", address
);
2128 TS_end_termcap_modes
= tgetstr ("te", address
);
2129 TS_termcap_modes
= tgetstr ("ti", address
);
2130 Up
= tgetstr ("up", address
);
2131 TS_visible_bell
= tgetstr ("vb", address
);
2132 TS_cursor_normal
= tgetstr ("ve", address
);
2133 TS_cursor_visible
= tgetstr ("vs", address
);
2134 TS_cursor_invisible
= tgetstr ("vi", address
);
2135 TS_set_window
= tgetstr ("wi", address
);
2137 TS_enter_underline_mode
= tgetstr ("us", address
);
2138 TS_exit_underline_mode
= tgetstr ("ue", address
);
2139 TS_enter_bold_mode
= tgetstr ("md", address
);
2140 TS_enter_dim_mode
= tgetstr ("mh", address
);
2141 TS_enter_blink_mode
= tgetstr ("mb", address
);
2142 TS_enter_reverse_mode
= tgetstr ("mr", address
);
2143 TS_enter_alt_charset_mode
= tgetstr ("as", address
);
2144 TS_exit_alt_charset_mode
= tgetstr ("ae", address
);
2145 TS_exit_attribute_mode
= tgetstr ("me", address
);
2147 MultiUp
= tgetstr ("UP", address
);
2148 MultiDown
= tgetstr ("DO", address
);
2149 MultiLeft
= tgetstr ("LE", address
);
2150 MultiRight
= tgetstr ("RI", address
);
2152 /* SVr4/ANSI color suppert. If "op" isn't available, don't support
2153 color because we can't switch back to the default foreground and
2155 TS_orig_pair
= tgetstr ("op", address
);
2158 TS_set_foreground
= tgetstr ("AF", address
);
2159 TS_set_background
= tgetstr ("AB", address
);
2160 if (!TS_set_foreground
)
2163 TS_set_foreground
= tgetstr ("Sf", address
);
2164 TS_set_background
= tgetstr ("Sb", address
);
2167 TN_max_colors
= tgetnum ("Co");
2168 TN_max_pairs
= tgetnum ("pa");
2170 TN_no_color_video
= tgetnum ("NC");
2171 if (TN_no_color_video
== -1)
2172 TN_no_color_video
= 0;
2175 MagicWrap
= tgetflag ("xn");
2176 /* Since we make MagicWrap terminals look like AutoWrap, we need to have
2177 the former flag imply the latter. */
2178 AutoWrap
= MagicWrap
|| tgetflag ("am");
2179 memory_below_frame
= tgetflag ("db");
2180 TF_hazeltine
= tgetflag ("hz");
2181 must_write_spaces
= tgetflag ("in");
2182 meta_key
= tgetflag ("km") || tgetflag ("MT");
2183 TF_insmode_motion
= tgetflag ("mi");
2184 TF_standout_motion
= tgetflag ("ms");
2185 TF_underscore
= tgetflag ("ul");
2186 TF_teleray
= tgetflag ("xt");
2188 term_get_fkeys (address
);
2190 /* Get frame size from system, or else from termcap. */
2193 get_frame_size (&width
, &height
);
2194 FRAME_WIDTH (sf
) = width
;
2195 FRAME_HEIGHT (sf
) = height
;
2198 if (FRAME_WIDTH (sf
) <= 0)
2199 SET_FRAME_WIDTH (sf
, tgetnum ("co"));
2201 /* Keep width and external_width consistent */
2202 SET_FRAME_WIDTH (sf
, FRAME_WIDTH (sf
));
2203 if (FRAME_HEIGHT (sf
) <= 0)
2204 FRAME_HEIGHT (sf
) = tgetnum ("li");
2206 if (FRAME_HEIGHT (sf
) < 3 || FRAME_WIDTH (sf
) < 3)
2207 fatal ("Screen size %dx%d is too small",
2208 FRAME_HEIGHT (sf
), FRAME_WIDTH (sf
));
2210 min_padding_speed
= tgetnum ("pb");
2211 TabWidth
= tgetnum ("tw");
2214 /* These capabilities commonly use ^J.
2215 I don't know why, but sending them on VMS does not work;
2216 it causes following spaces to be lost, sometimes.
2217 For now, the simplest fix is to avoid using these capabilities ever. */
2218 if (Down
&& Down
[0] == '\n')
2226 TS_fwd_scroll
= Down
;
2228 PC
= TS_pad_char
? *TS_pad_char
: 0;
2233 /* Turned off since /etc/termcap seems to have :ta= for most terminals
2234 and newer termcap doc does not seem to say there is a default.
2239 /* We don't support standout modes that use `magic cookies', so
2240 turn off any that do. */
2241 if (TS_standout_mode
&& tgetnum ("sg") >= 0)
2243 TS_standout_mode
= 0;
2244 TS_end_standout_mode
= 0;
2246 if (TS_enter_underline_mode
&& tgetnum ("ug") >= 0)
2248 TS_enter_underline_mode
= 0;
2249 TS_exit_underline_mode
= 0;
2252 /* If there's no standout mode, try to use underlining instead. */
2253 if (TS_standout_mode
== 0)
2255 TS_standout_mode
= TS_enter_underline_mode
;
2256 TS_end_standout_mode
= TS_exit_underline_mode
;
2259 /* If no `se' string, try using a `me' string instead.
2260 If that fails, we can't use standout mode at all. */
2261 if (TS_end_standout_mode
== 0)
2263 char *s
= tgetstr ("me", address
);
2265 TS_end_standout_mode
= s
;
2267 TS_standout_mode
= 0;
2273 /* We can't support standout mode, because it uses magic cookies. */
2274 TS_standout_mode
= 0;
2275 /* But that means we cannot rely on ^M to go to column zero! */
2277 /* LF can't be trusted either -- can alter hpos */
2278 /* if move at column 0 thru a line with TS_standout_mode */
2282 /* Special handling for certain terminal types known to need it */
2284 if (!strcmp (terminal_type
, "supdup"))
2286 memory_below_frame
= 1;
2287 Wcm
.cm_losewrap
= 1;
2289 if (!strncmp (terminal_type
, "c10", 3)
2290 || !strcmp (terminal_type
, "perq"))
2292 /* Supply a makeshift :wi string.
2293 This string is not valid in general since it works only
2294 for windows starting at the upper left corner;
2295 but that is all Emacs uses.
2297 This string works only if the frame is using
2298 the top of the video memory, because addressing is memory-relative.
2299 So first check the :ti string to see if that is true.
2301 It would be simpler if the :wi string could go in the termcap
2302 entry, but it can't because it is not fully valid.
2303 If it were in the termcap entry, it would confuse other programs. */
2306 p
= TS_termcap_modes
;
2307 while (*p
&& strcmp (p
, "\033v "))
2310 TS_set_window
= "\033v%C %C %C %C ";
2312 /* Termcap entry often fails to have :in: flag */
2313 must_write_spaces
= 1;
2314 /* :ti string typically fails to have \E^G! in it */
2315 /* This limits scope of insert-char to one line. */
2316 strcpy (area
, TS_termcap_modes
);
2317 strcat (area
, "\033\007!");
2318 TS_termcap_modes
= area
;
2319 area
+= strlen (area
) + 1;
2321 /* Change all %+ parameters to %C, to handle
2322 values above 96 correctly for the C100. */
2325 if (p
[0] == '%' && p
[1] == '+')
2331 FrameRows
= FRAME_HEIGHT (sf
);
2332 FrameCols
= FRAME_WIDTH (sf
);
2333 specified_window
= FRAME_HEIGHT (sf
);
2335 if (Wcm_init () == -1) /* can't do cursor motion */
2337 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2338 It lacks the ability to position the cursor.\n\
2339 If that is not the actual type of terminal you have, use either the\n\
2340 DCL command `SET TERMINAL/DEVICE= ...' for DEC-compatible terminals,\n\
2341 or `define EMACS_TERM \"terminal type\"' for non-DEC terminals.",
2345 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2346 It lacks the ability to position the cursor.\n\
2347 If that is not the actual type of terminal you have,\n\
2348 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2349 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2350 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2352 # else /* TERMCAP */
2353 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2354 It lacks the ability to position the cursor.\n\
2355 If that is not the actual type of terminal you have,\n\
2356 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2357 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2358 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2360 # endif /* TERMINFO */
2362 if (FRAME_HEIGHT (sf
) <= 0
2363 || FRAME_WIDTH (sf
) <= 0)
2364 fatal ("The frame size has not been specified");
2366 delete_in_insert_mode
2367 = TS_delete_mode
&& TS_insert_mode
2368 && !strcmp (TS_delete_mode
, TS_insert_mode
);
2370 se_is_so
= (TS_standout_mode
2371 && TS_end_standout_mode
2372 && !strcmp (TS_standout_mode
, TS_end_standout_mode
));
2374 UseTabs
= tabs_safe_p () && TabWidth
== 8;
2378 && (TS_set_window
|| TS_set_scroll_region
|| TS_set_scroll_region_1
));
2380 line_ins_del_ok
= (((TS_ins_line
|| TS_ins_multi_lines
)
2381 && (TS_del_line
|| TS_del_multi_lines
))
2382 || (scroll_region_ok
&& TS_fwd_scroll
&& TS_rev_scroll
));
2384 char_ins_del_ok
= ((TS_ins_char
|| TS_insert_mode
2385 || TS_pad_inserted_char
|| TS_ins_multi_chars
)
2386 && (TS_del_char
|| TS_del_multi_chars
));
2388 fast_clear_end_of_line
= TS_clr_line
!= 0;
2391 if (read_socket_hook
) /* Baudrate is somewhat */
2392 /* meaningless in this case */
2395 FRAME_CAN_HAVE_SCROLL_BARS (sf
) = 0;
2396 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf
) = vertical_scroll_bar_none
;
2397 #endif /* WINDOWSNT */
2402 fatal (str
, arg1
, arg2
)
2403 char *str
, *arg1
, *arg2
;
2405 fprintf (stderr
, "emacs: ");
2406 fprintf (stderr
, str
, arg1
, arg2
);
2407 fprintf (stderr
, "\n");
2415 DEFVAR_BOOL ("system-uses-terminfo", &system_uses_terminfo
,
2416 doc
: /* Non-nil means the system uses terminfo rather than termcap.
2417 This variable can be used by terminal emulator packages. */);
2419 system_uses_terminfo
= 1;
2421 system_uses_terminfo
= 0;
2424 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function
,
2425 doc
: /* Non-nil means call this function to ring the bell.
2426 The function should accept no arguments. */);
2427 Vring_bell_function
= Qnil
;
2429 defsubr (&Stty_display_color_p
);