(defgroup lisp-shadow): New group name. Previous group name shadow is
[emacs.git] / src / term.c
blob3add820421e14c3f2142e72dda91eda3bad8dd22
1 /* Terminal control module for terminals described by TERMCAP
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 98, 2000, 2001, 2002
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)
10 any later version.
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>. */
24 #include <config.h>
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <string.h>
29 #include "termchar.h"
30 #include "termopts.h"
31 #include "lisp.h"
32 #include "charset.h"
33 #include "coding.h"
34 #include "keyboard.h"
35 #include "frame.h"
36 #include "disptab.h"
37 #include "termhooks.h"
38 #include "dispextern.h"
39 #include "window.h"
40 #include "keymap.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
44 won't find. */
46 #if defined HAVE_TERMCAP_H && 0
47 #include <termcap.h>
48 #else
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));
53 #endif
55 #include "cm.h"
56 #ifdef HAVE_X_WINDOWS
57 #include "xterm.h"
58 #endif
59 #ifdef MAC_OS
60 #include "macterm.h"
61 #endif
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));
68 #define OUTPUT(a) \
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) \
74 do { \
75 if (a) \
76 tputs (a, (int) (FRAME_HEIGHT (XFRAME (selected_frame)) \
77 - curY), cmputc); \
78 } while (0)
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
97 scroll window */
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
142 garbage.
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
155 event arrives. */
157 void (*mouse_position_hook) P_ ((FRAME_PTR *f, int insist,
158 Lisp_Object *bar_window,
159 enum scroll_bar_part *part,
160 Lisp_Object *x,
161 Lisp_Object *y,
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
168 the highlight. */
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
177 anything.
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
181 windows. */
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
285 present. */
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. */
292 enum no_color_bit
294 NC_STANDOUT = 1 << 0,
295 NC_UNDERLINE = 1 << 1,
296 NC_REVERSE = 1 << 2,
297 NC_BLINK = 1 << 3,
298 NC_DIM = 1 << 4,
299 NC_BOLD = 1 << 5,
300 NC_INVIS = 1 << 6,
301 NC_PROTECT = 1 << 7,
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
326 supported, yet. */
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. */
336 int TN_max_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. */
341 int TN_max_pairs;
343 /* "op" -- SVr4 set default pair to its original value. */
345 char *TS_orig_pair;
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.
358 For t1061. */
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
365 standout mode */
367 /* internal state */
369 /* The largest frame width in any call to calculate_costs. */
371 int max_frame_width;
373 /* The largest frame height in any call to calculate_costs. */
375 int max_frame_height;
377 static int costs_set; /* 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;
404 char *tparam ();
406 extern char *tgetstr ();
409 #ifdef WINDOWSNT
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 */
420 void
421 ring_bell ()
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;
438 call0 (function);
440 Vring_bell_function = function;
442 else if (!FRAME_TERMCAP_P (XFRAME (selected_frame)))
443 (*ring_bell_hook) ();
444 else
445 OUTPUT (TS_visible_bell && visible_bell ? TS_visible_bell : TS_bell);
448 void
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);
456 losecursor ();
458 else
459 (*set_terminal_modes_hook) ();
462 void
463 reset_terminal_modes ()
465 if (FRAME_TERMCAP_P (XFRAME (selected_frame)))
467 turn_off_highlight ();
468 turn_off_insert ();
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. */
474 cmputc ('\r');
476 else if (reset_terminal_modes_hook)
477 (*reset_terminal_modes_hook) ();
480 void
481 update_begin (f)
482 struct frame *f;
484 updating_frame = f;
485 if (!FRAME_TERMCAP_P (f))
486 update_begin_hook (f);
489 void
490 update_end (f)
491 struct frame *f;
493 if (FRAME_TERMCAP_P (f))
495 if (!XWINDOW (selected_window)->cursor_off_p)
496 tty_show_cursor ();
497 turn_off_insert ();
498 background_highlight ();
500 else
501 update_end_hook (f);
503 updating_frame = NULL;
506 void
507 set_terminal_window (size)
508 int 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);
516 else
517 set_terminal_window_hook (size);
520 void
521 set_scroll_region (start, stop)
522 int start, stop;
524 char *buf;
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,
533 FRAME_HEIGHT (sf));
534 else
535 buf = tparam (TS_set_window, 0, 0, start, 0, stop, FRAME_WIDTH (sf));
537 OUTPUT (buf);
538 xfree (buf);
539 losecursor ();
543 static void
544 turn_on_insert ()
546 if (!insert_mode)
547 OUTPUT (TS_insert_mode);
548 insert_mode = 1;
551 void
552 turn_off_insert ()
554 if (insert_mode)
555 OUTPUT (TS_end_insert_mode);
556 insert_mode = 0;
559 /* Handle highlighting. */
561 void
562 turn_off_highlight ()
564 if (standout_mode)
565 OUTPUT_IF (TS_end_standout_mode);
566 standout_mode = 0;
569 static void
570 turn_on_highlight ()
572 if (!standout_mode)
573 OUTPUT_IF (TS_standout_mode);
574 standout_mode = 1;
577 static void
578 toggle_highlight ()
580 if (standout_mode)
581 turn_off_highlight ();
582 else
583 turn_on_highlight ();
587 /* Make cursor invisible. */
589 static void
590 tty_hide_cursor ()
592 if (tty_cursor_hidden == 0)
594 tty_cursor_hidden = 1;
595 OUTPUT_IF (TS_cursor_invisible);
600 /* Ensure that cursor is visible. */
602 static void
603 tty_show_cursor ()
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. */
618 void
619 background_highlight ()
621 if (inverse_video)
622 turn_on_highlight ();
623 else
624 turn_off_highlight ();
627 /* Set standout mode to the mode specified for the text to be output. */
629 static void
630 highlight_if_desired ()
632 if (inverse_video)
633 turn_on_highlight ();
634 else
635 turn_off_highlight ();
639 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
640 frame-relative coordinates. */
642 void
643 cursor_to (vpos, hpos)
644 int 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);
651 return;
654 /* Detect the case where we are called from reset_sys_modes
655 and the costs have never been calculated. Do nothing. */
656 if (! costs_set)
657 return;
659 if (curY == vpos && curX == hpos)
660 return;
661 if (!TF_standout_motion)
662 background_highlight ();
663 if (!TF_insmode_motion)
664 turn_off_insert ();
665 cmgoto (vpos, hpos);
668 /* Similar but don't take any account of the wasted characters. */
670 void
671 raw_cursor_to (row, col)
672 int 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);
678 return;
680 if (curY == row && curX == col)
681 return;
682 if (!TF_standout_motion)
683 background_highlight ();
684 if (!TF_insmode_motion)
685 turn_off_insert ();
686 cmgoto (row, col);
689 /* Erase operations */
691 /* clear from cursor to end of frame */
692 void
693 clear_to_end ()
695 register int i;
697 if (clear_to_end_hook && ! FRAME_TERMCAP_P (updating_frame))
699 (*clear_to_end_hook) ();
700 return;
702 if (TS_clr_to_bottom)
704 background_highlight ();
705 OUTPUT (TS_clr_to_bottom);
707 else
709 for (i = curY; i < FRAME_HEIGHT (XFRAME (selected_frame)); i++)
711 cursor_to (i, 0);
712 clear_end_of_line (FRAME_WIDTH (XFRAME (selected_frame)));
717 /* Clear entire frame */
719 void
720 clear_frame ()
722 struct frame *sf = XFRAME (selected_frame);
724 if (clear_frame_hook
725 && ! FRAME_TERMCAP_P ((updating_frame ? updating_frame : sf)))
727 (*clear_frame_hook) ();
728 return;
730 if (TS_clr_frame)
732 background_highlight ();
733 OUTPUT (TS_clr_frame);
734 cmat (0, 0);
736 else
738 cursor_to (0, 0);
739 clear_to_end ();
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. */
748 void
749 clear_end_of_line (first_unused_hpos)
750 int first_unused_hpos;
752 register int i;
754 if (clear_end_of_line_hook
755 && ! FRAME_TERMCAP_P ((updating_frame
756 ? updating_frame
757 : XFRAME (selected_frame))))
759 (*clear_end_of_line_hook) (first_unused_hpos);
760 return;
763 /* Detect the case where we are called from reset_sys_modes
764 and the costs have never been calculated. Do nothing. */
765 if (! costs_set)
766 return;
768 if (curX >= first_unused_hpos)
769 return;
770 background_highlight ();
771 if (TS_clr_line)
773 OUTPUT1 (TS_clr_line);
775 else
776 { /* have to do it the hard way */
777 struct frame *sf = XFRAME (selected_frame);
778 turn_off_insert ();
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))
783 first_unused_hpos--;
785 for (i = curX; i < first_unused_hpos; i++)
787 if (termscript)
788 fputc (' ', termscript);
789 putchar (' ');
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
798 converted.
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)
805 struct glyph *src;
806 int src_len;
807 unsigned char *dst;
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;
812 register GLYPH g;
813 unsigned char workbuf[MAX_MULTIBYTE_LENGTH];
814 const unsigned char *buf;
815 int len;
816 register int tlen = GLYPH_TABLE_LENGTH;
817 register Lisp_Object *tbase = GLYPH_TABLE_BASE;
818 int result;
819 struct coding_system *coding;
821 /* If terminal_coding does any conversion, use it, otherwise use
822 safe_terminal_coding. We can't use CODING_REQUIRE_ENCODING here
823 because it always return 1 if the member src_multibyte is 1. */
824 coding = (terminal_coding.common_flags & CODING_REQUIRE_ENCODING_MASK
825 ? &terminal_coding
826 : &safe_terminal_coding);
828 while (src < src_end)
830 /* We must skip glyphs to be padded for a wide character. */
831 if (! CHAR_GLYPH_PADDING_P (*src))
833 g = GLYPH_FROM_CHAR_GLYPH (src[0]);
835 if (g < 0 || g >= tlen)
837 /* This glyph doesn't has an entry in Vglyph_table. */
838 if (! CHAR_VALID_P (src->u.ch, 0))
840 len = 1;
841 buf = " ";
842 coding->src_multibyte = 0;
844 else
846 len = CHAR_STRING (src->u.ch, workbuf);
847 buf = workbuf;
848 coding->src_multibyte = 1;
851 else
853 /* This glyph has an entry in Vglyph_table,
854 so process any alias before testing for simpleness. */
855 GLYPH_FOLLOW_ALIASES (tbase, tlen, g);
857 if (GLYPH_SIMPLE_P (tbase, tlen, g))
859 /* We set the multi-byte form of a character in G
860 (that should be an ASCII character) at
861 WORKBUF. */
862 workbuf[0] = FAST_GLYPH_CHAR (g);
863 len = 1;
864 buf = workbuf;
865 coding->src_multibyte = 0;
867 else
869 /* We have a string in Vglyph_table. */
870 len = GLYPH_LENGTH (tbase, g);
871 buf = GLYPH_STRING (tbase, g);
872 coding->src_multibyte = STRING_MULTIBYTE (tbase[g]);
876 result = encode_coding (coding, buf, dst, len, dst_end - dst);
877 len -= coding->consumed;
878 dst += coding->produced;
879 if (result == CODING_FINISH_INSUFFICIENT_DST
880 || (result == CODING_FINISH_INSUFFICIENT_SRC
881 && len > dst_end - dst))
882 /* The remaining output buffer is too short. We must
883 break the loop here without increasing SRC so that the
884 next call of this function starts from the same glyph. */
885 break;
887 if (len > 0)
889 /* This is the case that a code of the range 0200..0237
890 exists in buf. We must just write out such a code. */
891 buf += coding->consumed;
892 while (len--)
893 *dst++ = *buf++;
896 src++;
899 *consumed = src - src_start;
900 return (dst - dst_start);
904 void
905 write_glyphs (string, len)
906 register struct glyph *string;
907 register int len;
909 int produced, consumed;
910 struct frame *sf = XFRAME (selected_frame);
911 struct frame *f = updating_frame ? updating_frame : sf;
912 unsigned char conversion_buffer[1024];
913 int conversion_buffer_size = sizeof conversion_buffer;
915 if (write_glyphs_hook
916 && ! FRAME_TERMCAP_P (f))
918 (*write_glyphs_hook) (string, len);
919 return;
922 turn_off_insert ();
923 tty_hide_cursor ();
925 /* Don't dare write in last column of bottom line, if Auto-Wrap,
926 since that would scroll the whole frame on some terminals. */
928 if (AutoWrap
929 && curY + 1 == FRAME_HEIGHT (sf)
930 && (curX + len) == FRAME_WIDTH (sf))
931 len --;
932 if (len <= 0)
933 return;
935 cmplus (len);
937 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
938 the tail. */
939 terminal_coding.mode &= ~CODING_MODE_LAST_BLOCK;
941 while (len > 0)
943 /* Identify a run of glyphs with the same face. */
944 int face_id = string->face_id;
945 int n;
947 for (n = 1; n < len; ++n)
948 if (string[n].face_id != face_id)
949 break;
951 /* Turn appearance modes of the face of the run on. */
952 highlight_if_desired ();
953 turn_on_face (f, face_id);
955 while (n > 0)
957 /* We use a fixed size (1024 bytes) of conversion buffer.
958 Usually it is sufficient, but if not, we just repeat the
959 loop. */
960 produced = encode_terminal_code (string, conversion_buffer,
961 n, conversion_buffer_size,
962 &consumed);
963 if (produced > 0)
965 fwrite (conversion_buffer, 1, produced, stdout);
966 if (ferror (stdout))
967 clearerr (stdout);
968 if (termscript)
969 fwrite (conversion_buffer, 1, produced, termscript);
971 len -= consumed;
972 n -= consumed;
973 string += consumed;
976 /* Turn appearance modes off. */
977 turn_off_face (f, face_id);
978 turn_off_highlight ();
981 /* We may have to output some codes to terminate the writing. */
982 if (CODING_REQUIRE_FLUSHING (&terminal_coding))
984 terminal_coding.mode |= CODING_MODE_LAST_BLOCK;
985 encode_coding (&terminal_coding, "", conversion_buffer,
986 0, conversion_buffer_size);
987 if (terminal_coding.produced > 0)
989 fwrite (conversion_buffer, 1, terminal_coding.produced, stdout);
990 if (ferror (stdout))
991 clearerr (stdout);
992 if (termscript)
993 fwrite (conversion_buffer, 1, terminal_coding.produced,
994 termscript);
998 cmcheckmagic ();
1001 /* If start is zero, insert blanks instead of a string at start */
1003 void
1004 insert_glyphs (start, len)
1005 register struct glyph *start;
1006 register int len;
1008 char *buf;
1009 struct glyph *glyph = NULL;
1010 struct frame *f, *sf;
1012 if (len <= 0)
1013 return;
1015 if (insert_glyphs_hook)
1017 (*insert_glyphs_hook) (start, len);
1018 return;
1021 sf = XFRAME (selected_frame);
1022 f = updating_frame ? updating_frame : sf;
1024 if (TS_ins_multi_chars)
1026 buf = tparam (TS_ins_multi_chars, 0, 0, len);
1027 OUTPUT1 (buf);
1028 xfree (buf);
1029 if (start)
1030 write_glyphs (start, len);
1031 return;
1034 turn_on_insert ();
1035 cmplus (len);
1036 /* The bit CODING_MODE_LAST_BLOCK should be set to 1 only at the tail. */
1037 terminal_coding.mode &= ~CODING_MODE_LAST_BLOCK;
1038 while (len-- > 0)
1040 int produced, consumed;
1041 unsigned char conversion_buffer[1024];
1042 int conversion_buffer_size = sizeof conversion_buffer;
1044 OUTPUT1_IF (TS_ins_char);
1045 if (!start)
1047 conversion_buffer[0] = SPACEGLYPH;
1048 produced = 1;
1050 else
1052 highlight_if_desired ();
1053 turn_on_face (f, start->face_id);
1054 glyph = start;
1055 ++start;
1056 /* We must open sufficient space for a character which
1057 occupies more than one column. */
1058 while (len && CHAR_GLYPH_PADDING_P (*start))
1060 OUTPUT1_IF (TS_ins_char);
1061 start++, len--;
1064 if (len <= 0)
1065 /* This is the last glyph. */
1066 terminal_coding.mode |= CODING_MODE_LAST_BLOCK;
1068 /* The size of conversion buffer (1024 bytes) is surely
1069 sufficient for just one glyph. */
1070 produced = encode_terminal_code (glyph, conversion_buffer, 1,
1071 conversion_buffer_size, &consumed);
1074 if (produced > 0)
1076 fwrite (conversion_buffer, 1, produced, stdout);
1077 if (ferror (stdout))
1078 clearerr (stdout);
1079 if (termscript)
1080 fwrite (conversion_buffer, 1, produced, termscript);
1083 OUTPUT1_IF (TS_pad_inserted_char);
1084 if (start)
1086 turn_off_face (f, glyph->face_id);
1087 turn_off_highlight ();
1091 cmcheckmagic ();
1094 void
1095 delete_glyphs (n)
1096 register int n;
1098 char *buf;
1099 register int i;
1101 if (delete_glyphs_hook && ! FRAME_TERMCAP_P (updating_frame))
1103 (*delete_glyphs_hook) (n);
1104 return;
1107 if (delete_in_insert_mode)
1109 turn_on_insert ();
1111 else
1113 turn_off_insert ();
1114 OUTPUT_IF (TS_delete_mode);
1117 if (TS_del_multi_chars)
1119 buf = tparam (TS_del_multi_chars, 0, 0, n);
1120 OUTPUT1 (buf);
1121 xfree (buf);
1123 else
1124 for (i = 0; i < n; i++)
1125 OUTPUT1 (TS_del_char);
1126 if (!delete_in_insert_mode)
1127 OUTPUT_IF (TS_end_delete_mode);
1130 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
1132 void
1133 ins_del_lines (vpos, n)
1134 int vpos, n;
1136 char *multi = n > 0 ? TS_ins_multi_lines : TS_del_multi_lines;
1137 char *single = n > 0 ? TS_ins_line : TS_del_line;
1138 char *scroll = n > 0 ? TS_rev_scroll : TS_fwd_scroll;
1139 struct frame *sf;
1141 register int i = n > 0 ? n : -n;
1142 register char *buf;
1144 if (ins_del_lines_hook && ! FRAME_TERMCAP_P (updating_frame))
1146 (*ins_del_lines_hook) (vpos, n);
1147 return;
1150 sf = XFRAME (selected_frame);
1152 /* If the lines below the insertion are being pushed
1153 into the end of the window, this is the same as clearing;
1154 and we know the lines are already clear, since the matching
1155 deletion has already been done. So can ignore this. */
1156 /* If the lines below the deletion are blank lines coming
1157 out of the end of the window, don't bother,
1158 as there will be a matching inslines later that will flush them. */
1159 if (scroll_region_ok && vpos + i >= specified_window)
1160 return;
1161 if (!memory_below_frame && vpos + i >= FRAME_HEIGHT (sf))
1162 return;
1164 if (multi)
1166 raw_cursor_to (vpos, 0);
1167 background_highlight ();
1168 buf = tparam (multi, 0, 0, i);
1169 OUTPUT (buf);
1170 xfree (buf);
1172 else if (single)
1174 raw_cursor_to (vpos, 0);
1175 background_highlight ();
1176 while (--i >= 0)
1177 OUTPUT (single);
1178 if (TF_teleray)
1179 curX = 0;
1181 else
1183 set_scroll_region (vpos, specified_window);
1184 if (n < 0)
1185 raw_cursor_to (specified_window - 1, 0);
1186 else
1187 raw_cursor_to (vpos, 0);
1188 background_highlight ();
1189 while (--i >= 0)
1190 OUTPUTL (scroll, specified_window - vpos);
1191 set_scroll_region (0, specified_window);
1194 if (!scroll_region_ok && memory_below_frame && n < 0)
1196 cursor_to (FRAME_HEIGHT (sf) + n, 0);
1197 clear_to_end ();
1201 /* Compute cost of sending "str", in characters,
1202 not counting any line-dependent padding. */
1205 string_cost (str)
1206 char *str;
1208 cost = 0;
1209 if (str)
1210 tputs (str, 0, evalcost);
1211 return cost;
1214 /* Compute cost of sending "str", in characters,
1215 counting any line-dependent padding at one line. */
1217 static int
1218 string_cost_one_line (str)
1219 char *str;
1221 cost = 0;
1222 if (str)
1223 tputs (str, 1, evalcost);
1224 return cost;
1227 /* Compute per line amount of line-dependent padding,
1228 in tenths of characters. */
1231 per_line_cost (str)
1232 register char *str;
1234 cost = 0;
1235 if (str)
1236 tputs (str, 0, evalcost);
1237 cost = - cost;
1238 if (str)
1239 tputs (str, 10, evalcost);
1240 return cost;
1243 #ifndef old
1244 /* char_ins_del_cost[n] is cost of inserting N characters.
1245 char_ins_del_cost[-n] is cost of deleting N characters.
1246 The length of this vector is based on max_frame_width. */
1248 int *char_ins_del_vector;
1250 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_WIDTH ((f))])
1251 #endif
1253 /* ARGSUSED */
1254 static void
1255 calculate_ins_del_char_costs (frame)
1256 FRAME_PTR frame;
1258 int ins_startup_cost, del_startup_cost;
1259 int ins_cost_per_char, del_cost_per_char;
1260 register int i;
1261 register int *p;
1263 if (TS_ins_multi_chars)
1265 ins_cost_per_char = 0;
1266 ins_startup_cost = string_cost_one_line (TS_ins_multi_chars);
1268 else if (TS_ins_char || TS_pad_inserted_char
1269 || (TS_insert_mode && TS_end_insert_mode))
1271 ins_startup_cost = (30 * (string_cost (TS_insert_mode)
1272 + string_cost (TS_end_insert_mode))) / 100;
1273 ins_cost_per_char = (string_cost_one_line (TS_ins_char)
1274 + string_cost_one_line (TS_pad_inserted_char));
1276 else
1278 ins_startup_cost = 9999;
1279 ins_cost_per_char = 0;
1282 if (TS_del_multi_chars)
1284 del_cost_per_char = 0;
1285 del_startup_cost = string_cost_one_line (TS_del_multi_chars);
1287 else if (TS_del_char)
1289 del_startup_cost = (string_cost (TS_delete_mode)
1290 + string_cost (TS_end_delete_mode));
1291 if (delete_in_insert_mode)
1292 del_startup_cost /= 2;
1293 del_cost_per_char = string_cost_one_line (TS_del_char);
1295 else
1297 del_startup_cost = 9999;
1298 del_cost_per_char = 0;
1301 /* Delete costs are at negative offsets */
1302 p = &char_ins_del_cost (frame)[0];
1303 for (i = FRAME_WIDTH (frame); --i >= 0;)
1304 *--p = (del_startup_cost += del_cost_per_char);
1306 /* Doing nothing is free */
1307 p = &char_ins_del_cost (frame)[0];
1308 *p++ = 0;
1310 /* Insert costs are at positive offsets */
1311 for (i = FRAME_WIDTH (frame); --i >= 0;)
1312 *p++ = (ins_startup_cost += ins_cost_per_char);
1315 void
1316 calculate_costs (frame)
1317 FRAME_PTR frame;
1319 register char *f = (TS_set_scroll_region
1320 ? TS_set_scroll_region
1321 : TS_set_scroll_region_1);
1323 FRAME_COST_BAUD_RATE (frame) = baud_rate;
1325 scroll_region_cost = string_cost (f);
1327 /* These variables are only used for terminal stuff. They are allocated
1328 once for the terminal frame of X-windows emacs, but not used afterwards.
1330 char_ins_del_vector (i.e., char_ins_del_cost) isn't used because
1331 X turns off char_ins_del_ok. */
1333 max_frame_height = max (max_frame_height, FRAME_HEIGHT (frame));
1334 max_frame_width = max (max_frame_width, FRAME_WIDTH (frame));
1336 costs_set = 1;
1338 if (char_ins_del_vector != 0)
1339 char_ins_del_vector
1340 = (int *) xrealloc (char_ins_del_vector,
1341 (sizeof (int)
1342 + 2 * max_frame_width * sizeof (int)));
1343 else
1344 char_ins_del_vector
1345 = (int *) xmalloc (sizeof (int)
1346 + 2 * max_frame_width * sizeof (int));
1348 bzero (char_ins_del_vector, (sizeof (int)
1349 + 2 * max_frame_width * sizeof (int)));
1351 if (f && (!TS_ins_line && !TS_del_line))
1352 do_line_insertion_deletion_costs (frame,
1353 TS_rev_scroll, TS_ins_multi_lines,
1354 TS_fwd_scroll, TS_del_multi_lines,
1355 f, f, 1);
1356 else
1357 do_line_insertion_deletion_costs (frame,
1358 TS_ins_line, TS_ins_multi_lines,
1359 TS_del_line, TS_del_multi_lines,
1360 0, 0, 1);
1362 calculate_ins_del_char_costs (frame);
1364 /* Don't use TS_repeat if its padding is worse than sending the chars */
1365 if (TS_repeat && per_line_cost (TS_repeat) * baud_rate < 9000)
1366 RPov = string_cost (TS_repeat);
1367 else
1368 RPov = FRAME_WIDTH (frame) * 2;
1370 cmcostinit (); /* set up cursor motion costs */
1373 struct fkey_table {
1374 char *cap, *name;
1377 /* Termcap capability names that correspond directly to X keysyms.
1378 Some of these (marked "terminfo") aren't supplied by old-style
1379 (Berkeley) termcap entries. They're listed in X keysym order;
1380 except we put the keypad keys first, so that if they clash with
1381 other keys (as on the IBM PC keyboard) they get overridden.
1384 static struct fkey_table keys[] =
1386 {"kh", "home"}, /* termcap */
1387 {"kl", "left"}, /* termcap */
1388 {"ku", "up"}, /* termcap */
1389 {"kr", "right"}, /* termcap */
1390 {"kd", "down"}, /* termcap */
1391 {"%8", "prior"}, /* terminfo */
1392 {"%5", "next"}, /* terminfo */
1393 {"@7", "end"}, /* terminfo */
1394 {"@1", "begin"}, /* terminfo */
1395 {"*6", "select"}, /* terminfo */
1396 {"%9", "print"}, /* terminfo */
1397 {"@4", "execute"}, /* terminfo --- actually the `command' key */
1399 * "insert" --- see below
1401 {"&8", "undo"}, /* terminfo */
1402 {"%0", "redo"}, /* terminfo */
1403 {"%7", "menu"}, /* terminfo --- actually the `options' key */
1404 {"@0", "find"}, /* terminfo */
1405 {"@2", "cancel"}, /* terminfo */
1406 {"%1", "help"}, /* terminfo */
1408 * "break" goes here, but can't be reliably intercepted with termcap
1410 {"&4", "reset"}, /* terminfo --- actually `restart' */
1412 * "system" and "user" --- no termcaps
1414 {"kE", "clearline"}, /* terminfo */
1415 {"kA", "insertline"}, /* terminfo */
1416 {"kL", "deleteline"}, /* terminfo */
1417 {"kI", "insertchar"}, /* terminfo */
1418 {"kD", "deletechar"}, /* terminfo */
1419 {"kB", "backtab"}, /* terminfo */
1421 * "kp_backtab", "kp-space", "kp-tab" --- no termcaps
1423 {"@8", "kp-enter"}, /* terminfo */
1425 * "kp-f1", "kp-f2", "kp-f3" "kp-f4",
1426 * "kp-multiply", "kp-add", "kp-separator",
1427 * "kp-subtract", "kp-decimal", "kp-divide", "kp-0";
1428 * --- no termcaps for any of these.
1430 {"K4", "kp-1"}, /* terminfo */
1432 * "kp-2" --- no termcap
1434 {"K5", "kp-3"}, /* terminfo */
1436 * "kp-4" --- no termcap
1438 {"K2", "kp-5"}, /* terminfo */
1440 * "kp-6" --- no termcap
1442 {"K1", "kp-7"}, /* terminfo */
1444 * "kp-8" --- no termcap
1446 {"K3", "kp-9"}, /* terminfo */
1448 * "kp-equal" --- no termcap
1450 {"k1", "f1"},
1451 {"k2", "f2"},
1452 {"k3", "f3"},
1453 {"k4", "f4"},
1454 {"k5", "f5"},
1455 {"k6", "f6"},
1456 {"k7", "f7"},
1457 {"k8", "f8"},
1458 {"k9", "f9"}
1461 static char **term_get_fkeys_arg;
1462 static Lisp_Object term_get_fkeys_1 ();
1464 /* Find the escape codes sent by the function keys for Vfunction_key_map.
1465 This function scans the termcap function key sequence entries, and
1466 adds entries to Vfunction_key_map for each function key it finds. */
1468 void
1469 term_get_fkeys (address)
1470 char **address;
1472 /* We run the body of the function (term_get_fkeys_1) and ignore all Lisp
1473 errors during the call. The only errors should be from Fdefine_key
1474 when given a key sequence containing an invalid prefix key. If the
1475 termcap defines function keys which use a prefix that is already bound
1476 to a command by the default bindings, we should silently ignore that
1477 function key specification, rather than giving the user an error and
1478 refusing to run at all on such a terminal. */
1480 extern Lisp_Object Fidentity ();
1481 term_get_fkeys_arg = address;
1482 internal_condition_case (term_get_fkeys_1, Qerror, Fidentity);
1485 static Lisp_Object
1486 term_get_fkeys_1 ()
1488 int i;
1490 char **address = term_get_fkeys_arg;
1492 /* This can happen if CANNOT_DUMP or with strange options. */
1493 if (!initialized)
1494 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
1496 for (i = 0; i < (sizeof (keys)/sizeof (keys[0])); i++)
1498 char *sequence = tgetstr (keys[i].cap, address);
1499 if (sequence)
1500 Fdefine_key (Vfunction_key_map, build_string (sequence),
1501 Fmake_vector (make_number (1),
1502 intern (keys[i].name)));
1505 /* The uses of the "k0" capability are inconsistent; sometimes it
1506 describes F10, whereas othertimes it describes F0 and "k;" describes F10.
1507 We will attempt to politely accommodate both systems by testing for
1508 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.
1511 char *k_semi = tgetstr ("k;", address);
1512 char *k0 = tgetstr ("k0", address);
1513 char *k0_name = "f10";
1515 if (k_semi)
1517 if (k0)
1518 /* Define f0 first, so that f10 takes precedence in case the
1519 key sequences happens to be the same. */
1520 Fdefine_key (Vfunction_key_map, build_string (k0),
1521 Fmake_vector (make_number (1), intern ("f0")));
1522 Fdefine_key (Vfunction_key_map, build_string (k_semi),
1523 Fmake_vector (make_number (1), intern ("f10")));
1525 else if (k0)
1526 Fdefine_key (Vfunction_key_map, build_string (k0),
1527 Fmake_vector (make_number (1), intern (k0_name)));
1530 /* Set up cookies for numbered function keys above f10. */
1532 char fcap[3], fkey[4];
1534 fcap[0] = 'F'; fcap[2] = '\0';
1535 for (i = 11; i < 64; i++)
1537 if (i <= 19)
1538 fcap[1] = '1' + i - 11;
1539 else if (i <= 45)
1540 fcap[1] = 'A' + i - 20;
1541 else
1542 fcap[1] = 'a' + i - 46;
1545 char *sequence = tgetstr (fcap, address);
1546 if (sequence)
1548 sprintf (fkey, "f%d", i);
1549 Fdefine_key (Vfunction_key_map, build_string (sequence),
1550 Fmake_vector (make_number (1),
1551 intern (fkey)));
1558 * Various mappings to try and get a better fit.
1561 #define CONDITIONAL_REASSIGN(cap1, cap2, sym) \
1562 if (!tgetstr (cap1, address)) \
1564 char *sequence = tgetstr (cap2, address); \
1565 if (sequence) \
1566 Fdefine_key (Vfunction_key_map, build_string (sequence), \
1567 Fmake_vector (make_number (1), \
1568 intern (sym))); \
1571 /* if there's no key_next keycap, map key_npage to `next' keysym */
1572 CONDITIONAL_REASSIGN ("%5", "kN", "next");
1573 /* if there's no key_prev keycap, map key_ppage to `previous' keysym */
1574 CONDITIONAL_REASSIGN ("%8", "kP", "prior");
1575 /* if there's no key_dc keycap, map key_ic to `insert' keysym */
1576 CONDITIONAL_REASSIGN ("kD", "kI", "insert");
1577 /* if there's no key_end keycap, map key_ll to 'end' keysym */
1578 CONDITIONAL_REASSIGN ("@7", "kH", "end");
1580 /* IBM has their own non-standard dialect of terminfo.
1581 If the standard name isn't found, try the IBM name. */
1582 CONDITIONAL_REASSIGN ("kB", "KO", "backtab");
1583 CONDITIONAL_REASSIGN ("@4", "kJ", "execute"); /* actually "action" */
1584 CONDITIONAL_REASSIGN ("@4", "kc", "execute"); /* actually "command" */
1585 CONDITIONAL_REASSIGN ("%7", "ki", "menu");
1586 CONDITIONAL_REASSIGN ("@7", "kw", "end");
1587 CONDITIONAL_REASSIGN ("F1", "k<", "f11");
1588 CONDITIONAL_REASSIGN ("F2", "k>", "f12");
1589 CONDITIONAL_REASSIGN ("%1", "kq", "help");
1590 CONDITIONAL_REASSIGN ("*6", "kU", "select");
1591 #undef CONDITIONAL_REASSIGN
1594 return Qnil;
1598 /***********************************************************************
1599 Character Display Information
1600 ***********************************************************************/
1602 static void append_glyph P_ ((struct it *));
1605 /* Append glyphs to IT's glyph_row. Called from produce_glyphs for
1606 terminal frames if IT->glyph_row != NULL. IT->c is the character
1607 for which to produce glyphs; IT->face_id contains the character's
1608 face. Padding glyphs are appended if IT->c has a IT->pixel_width >
1609 1. */
1611 static void
1612 append_glyph (it)
1613 struct it *it;
1615 struct glyph *glyph, *end;
1616 int i;
1618 xassert (it->glyph_row);
1619 glyph = (it->glyph_row->glyphs[it->area]
1620 + it->glyph_row->used[it->area]);
1621 end = it->glyph_row->glyphs[1 + it->area];
1623 for (i = 0;
1624 i < it->pixel_width && glyph < end;
1625 ++i)
1627 glyph->type = CHAR_GLYPH;
1628 glyph->pixel_width = 1;
1629 glyph->u.ch = it->c;
1630 glyph->face_id = it->face_id;
1631 glyph->padding_p = i > 0;
1632 glyph->charpos = CHARPOS (it->position);
1633 glyph->object = it->object;
1635 ++it->glyph_row->used[it->area];
1636 ++glyph;
1641 /* Produce glyphs for the display element described by IT. *IT
1642 specifies what we want to produce a glyph for (character, image, ...),
1643 and where in the glyph matrix we currently are (glyph row and hpos).
1644 produce_glyphs fills in output fields of *IT with information such as the
1645 pixel width and height of a character, and maybe output actual glyphs at
1646 the same time if IT->glyph_row is non-null. See the explanation of
1647 struct display_iterator in dispextern.h for an overview.
1649 produce_glyphs also stores the result of glyph width, ascent
1650 etc. computations in *IT.
1652 IT->glyph_row may be null, in which case produce_glyphs does not
1653 actually fill in the glyphs. This is used in the move_* functions
1654 in xdisp.c for text width and height computations.
1656 Callers usually don't call produce_glyphs directly;
1657 instead they use the macro PRODUCE_GLYPHS. */
1659 void
1660 produce_glyphs (it)
1661 struct it *it;
1663 /* If a hook is installed, let it do the work. */
1664 xassert (it->what == IT_CHARACTER
1665 || it->what == IT_COMPOSITION
1666 || it->what == IT_IMAGE
1667 || it->what == IT_STRETCH);
1669 /* Nothing but characters are supported on terminal frames. For a
1670 composition sequence, it->c is the first character of the
1671 sequence. */
1672 xassert (it->what == IT_CHARACTER
1673 || it->what == IT_COMPOSITION);
1675 if (it->c >= 040 && it->c < 0177)
1677 it->pixel_width = it->nglyphs = 1;
1678 if (it->glyph_row)
1679 append_glyph (it);
1681 else if (it->c == '\n')
1682 it->pixel_width = it->nglyphs = 0;
1683 else if (it->c == '\t')
1685 int absolute_x = (it->current_x
1686 + it->continuation_lines_width);
1687 int next_tab_x
1688 = (((1 + absolute_x + it->tab_width - 1)
1689 / it->tab_width)
1690 * it->tab_width);
1691 int nspaces;
1693 /* If part of the TAB has been displayed on the previous line
1694 which is continued now, continuation_lines_width will have
1695 been incremented already by the part that fitted on the
1696 continued line. So, we will get the right number of spaces
1697 here. */
1698 nspaces = next_tab_x - absolute_x;
1700 if (it->glyph_row)
1702 int n = nspaces;
1704 it->c = ' ';
1705 it->pixel_width = it->len = 1;
1707 while (n--)
1708 append_glyph (it);
1710 it->c = '\t';
1713 it->pixel_width = nspaces;
1714 it->nglyphs = nspaces;
1716 else if (SINGLE_BYTE_CHAR_P (it->c))
1718 /* Coming here means that it->c is from display table, thus we
1719 must send the code as is to the terminal. Although there's
1720 no way to know how many columns it occupies on a screen, it
1721 is a good assumption that a single byte code has 1-column
1722 width. */
1723 it->pixel_width = it->nglyphs = 1;
1724 if (it->glyph_row)
1725 append_glyph (it);
1727 else
1729 /* A multi-byte character. The display width is fixed for all
1730 characters of the set. Some of the glyphs may have to be
1731 ignored because they are already displayed in a continued
1732 line. */
1733 int charset = CHAR_CHARSET (it->c);
1735 it->pixel_width = CHARSET_WIDTH (charset);
1736 it->nglyphs = it->pixel_width;
1738 if (it->glyph_row)
1739 append_glyph (it);
1742 /* Advance current_x by the pixel width as a convenience for
1743 the caller. */
1744 if (it->area == TEXT_AREA)
1745 it->current_x += it->pixel_width;
1746 it->ascent = it->max_ascent = it->phys_ascent = it->max_phys_ascent = 0;
1747 it->descent = it->max_descent = it->phys_descent = it->max_phys_descent = 1;
1751 /* Get information about special display element WHAT in an
1752 environment described by IT. WHAT is one of IT_TRUNCATION or
1753 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
1754 non-null glyph_row member. This function ensures that fields like
1755 face_id, c, len of IT are left untouched. */
1757 void
1758 produce_special_glyphs (it, what)
1759 struct it *it;
1760 enum display_element_type what;
1762 struct it temp_it;
1764 temp_it = *it;
1765 temp_it.dp = NULL;
1766 temp_it.what = IT_CHARACTER;
1767 temp_it.len = 1;
1768 temp_it.object = make_number (0);
1769 bzero (&temp_it.current, sizeof temp_it.current);
1771 if (what == IT_CONTINUATION)
1773 /* Continuation glyph. */
1774 if (it->dp
1775 && INTEGERP (DISP_CONTINUE_GLYPH (it->dp))
1776 && GLYPH_CHAR_VALID_P (XINT (DISP_CONTINUE_GLYPH (it->dp))))
1778 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_CONTINUE_GLYPH (it->dp)));
1779 temp_it.len = CHAR_BYTES (temp_it.c);
1781 else
1782 temp_it.c = '\\';
1784 produce_glyphs (&temp_it);
1785 it->pixel_width = temp_it.pixel_width;
1786 it->nglyphs = temp_it.pixel_width;
1788 else if (what == IT_TRUNCATION)
1790 /* Truncation glyph. */
1791 if (it->dp
1792 && INTEGERP (DISP_TRUNC_GLYPH (it->dp))
1793 && GLYPH_CHAR_VALID_P (XINT (DISP_TRUNC_GLYPH (it->dp))))
1795 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_TRUNC_GLYPH (it->dp)));
1796 temp_it.len = CHAR_BYTES (temp_it.c);
1798 else
1799 temp_it.c = '$';
1801 produce_glyphs (&temp_it);
1802 it->pixel_width = temp_it.pixel_width;
1803 it->nglyphs = temp_it.pixel_width;
1805 else
1806 abort ();
1810 /* Return an estimation of the pixel height of mode or top lines on
1811 frame F. FACE_ID specifies what line's height to estimate. */
1814 estimate_mode_line_height (f, face_id)
1815 struct frame *f;
1816 enum face_id face_id;
1818 if (estimate_mode_line_height_hook)
1819 return estimate_mode_line_height_hook (f, face_id);
1820 else
1821 return 1;
1826 /***********************************************************************
1827 Faces
1828 ***********************************************************************/
1830 /* Value is non-zero if attribute ATTR may be used. ATTR should be
1831 one of the enumerators from enum no_color_bit, or a bit set built
1832 from them. Some display attributes may not be used together with
1833 color; the termcap capability `NC' specifies which ones. */
1835 #define MAY_USE_WITH_COLORS_P(ATTR) \
1836 (TN_max_colors > 0 \
1837 ? (TN_no_color_video & (ATTR)) == 0 \
1838 : 1)
1840 /* Turn appearances of face FACE_ID on tty frame F on. */
1842 static void
1843 turn_on_face (f, face_id)
1844 struct frame *f;
1845 int face_id;
1847 struct face *face = FACE_FROM_ID (f, face_id);
1848 long fg = face->foreground;
1849 long bg = face->background;
1851 /* Do this first because TS_end_standout_mode may be the same
1852 as TS_exit_attribute_mode, which turns all appearances off. */
1853 if (MAY_USE_WITH_COLORS_P (NC_REVERSE))
1855 if (TN_max_colors > 0)
1857 if (fg >= 0 && bg >= 0)
1859 /* If the terminal supports colors, we can set them
1860 below without using reverse video. The face's fg
1861 and bg colors are set as they should appear on
1862 the screen, i.e. they take the inverse-video'ness
1863 of the face already into account. */
1865 else if (inverse_video)
1867 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1868 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1869 toggle_highlight ();
1871 else
1873 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1874 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1875 toggle_highlight ();
1878 else
1880 /* If we can't display colors, use reverse video
1881 if the face specifies that. */
1882 if (inverse_video)
1884 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1885 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1886 toggle_highlight ();
1888 else
1890 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1891 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1892 toggle_highlight ();
1897 if (face->tty_bold_p)
1899 if (MAY_USE_WITH_COLORS_P (NC_BOLD))
1900 OUTPUT1_IF (TS_enter_bold_mode);
1902 else if (face->tty_dim_p)
1903 if (MAY_USE_WITH_COLORS_P (NC_DIM))
1904 OUTPUT1_IF (TS_enter_dim_mode);
1906 /* Alternate charset and blinking not yet used. */
1907 if (face->tty_alt_charset_p
1908 && MAY_USE_WITH_COLORS_P (NC_ALT_CHARSET))
1909 OUTPUT1_IF (TS_enter_alt_charset_mode);
1911 if (face->tty_blinking_p
1912 && MAY_USE_WITH_COLORS_P (NC_BLINK))
1913 OUTPUT1_IF (TS_enter_blink_mode);
1915 if (face->tty_underline_p && MAY_USE_WITH_COLORS_P (NC_UNDERLINE))
1916 OUTPUT1_IF (TS_enter_underline_mode);
1918 if (TN_max_colors > 0)
1920 char *p;
1922 if (fg >= 0 && TS_set_foreground)
1924 p = tparam (TS_set_foreground, NULL, 0, (int) fg);
1925 OUTPUT (p);
1926 xfree (p);
1929 if (bg >= 0 && TS_set_background)
1931 p = tparam (TS_set_background, NULL, 0, (int) bg);
1932 OUTPUT (p);
1933 xfree (p);
1939 /* Turn off appearances of face FACE_ID on tty frame F. */
1941 static void
1942 turn_off_face (f, face_id)
1943 struct frame *f;
1944 int face_id;
1946 struct face *face = FACE_FROM_ID (f, face_id);
1948 xassert (face != NULL);
1950 if (TS_exit_attribute_mode)
1952 /* Capability "me" will turn off appearance modes double-bright,
1953 half-bright, reverse-video, standout, underline. It may or
1954 may not turn off alt-char-mode. */
1955 if (face->tty_bold_p
1956 || face->tty_dim_p
1957 || face->tty_reverse_p
1958 || face->tty_alt_charset_p
1959 || face->tty_blinking_p
1960 || face->tty_underline_p)
1962 OUTPUT1_IF (TS_exit_attribute_mode);
1963 if (strcmp (TS_exit_attribute_mode, TS_end_standout_mode) == 0)
1964 standout_mode = 0;
1967 if (face->tty_alt_charset_p)
1968 OUTPUT_IF (TS_exit_alt_charset_mode);
1970 else
1972 /* If we don't have "me" we can only have those appearances
1973 that have exit sequences defined. */
1974 if (face->tty_alt_charset_p)
1975 OUTPUT_IF (TS_exit_alt_charset_mode);
1977 if (face->tty_underline_p)
1978 OUTPUT_IF (TS_exit_underline_mode);
1981 /* Switch back to default colors. */
1982 if (TN_max_colors > 0
1983 && ((face->foreground != FACE_TTY_DEFAULT_COLOR
1984 && face->foreground != FACE_TTY_DEFAULT_FG_COLOR)
1985 || (face->background != FACE_TTY_DEFAULT_COLOR
1986 && face->background != FACE_TTY_DEFAULT_BG_COLOR)))
1987 OUTPUT1_IF (TS_orig_pair);
1991 /* Return non-zero if the terminal on frame F supports all of the
1992 capabilities in CAPS simultaneously, with foreground and background
1993 colors FG and BG. */
1996 tty_capable_p (f, caps, fg, bg)
1997 struct frame *f;
1998 unsigned caps;
1999 unsigned long fg, bg;
2001 #define TTY_CAPABLE_P_TRY(cap, TS, NC_bit) \
2002 if ((caps & (cap)) && (!(TS) || !MAY_USE_WITH_COLORS_P(NC_bit))) \
2003 return 0;
2005 TTY_CAPABLE_P_TRY (TTY_CAP_INVERSE, TS_standout_mode, NC_REVERSE);
2006 TTY_CAPABLE_P_TRY (TTY_CAP_UNDERLINE, TS_enter_underline_mode, NC_UNDERLINE);
2007 TTY_CAPABLE_P_TRY (TTY_CAP_BOLD, TS_enter_bold_mode, NC_BOLD);
2008 TTY_CAPABLE_P_TRY (TTY_CAP_DIM, TS_enter_dim_mode, NC_DIM);
2009 TTY_CAPABLE_P_TRY (TTY_CAP_BLINK, TS_enter_blink_mode, NC_BLINK);
2010 TTY_CAPABLE_P_TRY (TTY_CAP_ALT_CHARSET, TS_enter_alt_charset_mode, NC_ALT_CHARSET);
2012 /* We can do it! */
2013 return 1;
2017 /* Return non-zero if the terminal is capable to display colors. */
2019 DEFUN ("tty-display-color-p", Ftty_display_color_p, Stty_display_color_p,
2020 0, 1, 0,
2021 doc: /* Return non-nil if TTY can display colors on DISPLAY. */)
2022 (display)
2023 Lisp_Object display;
2025 return TN_max_colors > 0 ? Qt : Qnil;
2028 /* Return the number of supported colors. */
2029 DEFUN ("tty-display-color-cells", Ftty_display_color_cells,
2030 Stty_display_color_cells, 0, 1, 0,
2031 doc: /* Return the number of colors supported by TTY on DISPLAY. */)
2032 (display)
2033 Lisp_Object display;
2035 return make_number (TN_max_colors);
2038 #ifndef WINDOWSNT
2040 /* Save or restore the default color-related capabilities of this
2041 terminal. */
2042 static void
2043 tty_default_color_capabilities (save)
2044 int save;
2046 static char
2047 *default_orig_pair, *default_set_foreground, *default_set_background;
2048 static int default_max_colors, default_max_pairs, default_no_color_video;
2050 if (save)
2052 if (default_orig_pair)
2053 xfree (default_orig_pair);
2054 default_orig_pair = TS_orig_pair ? xstrdup (TS_orig_pair) : NULL;
2056 if (default_set_foreground)
2057 xfree (default_set_foreground);
2058 default_set_foreground = TS_set_foreground ? xstrdup (TS_set_foreground)
2059 : NULL;
2061 if (default_set_background)
2062 xfree (default_set_background);
2063 default_set_background = TS_set_background ? xstrdup (TS_set_background)
2064 : NULL;
2066 default_max_colors = TN_max_colors;
2067 default_max_pairs = TN_max_pairs;
2068 default_no_color_video = TN_no_color_video;
2070 else
2072 TS_orig_pair = default_orig_pair;
2073 TS_set_foreground = default_set_foreground;
2074 TS_set_background = default_set_background;
2075 TN_max_colors = default_max_colors;
2076 TN_max_pairs = default_max_pairs;
2077 TN_no_color_video = default_no_color_video;
2081 /* Setup one of the standard tty color schemes according to MODE.
2082 MODE's value is generally the number of colors which we want to
2083 support; zero means set up for the default capabilities, the ones
2084 we saw at term_init time; -1 means turn off color support. */
2085 void
2086 tty_setup_colors (mode)
2087 int mode;
2089 switch (mode)
2091 case -1: /* no colors at all */
2092 TN_max_colors = 0;
2093 TN_max_pairs = 0;
2094 TN_no_color_video = 0;
2095 TS_set_foreground = TS_set_background = TS_orig_pair = NULL;
2096 break;
2097 case 0: /* default colors, if any */
2098 default:
2099 tty_default_color_capabilities (0);
2100 break;
2101 case 8: /* 8 standard ANSI colors */
2102 TS_orig_pair = "\033[0m";
2103 #ifdef TERMINFO
2104 TS_set_foreground = "\033[3%p1%dm";
2105 TS_set_background = "\033[4%p1%dm";
2106 #else
2107 TS_set_foreground = "\033[3%dm";
2108 TS_set_background = "\033[4%dm";
2109 #endif
2110 TN_max_colors = 8;
2111 TN_max_pairs = 64;
2112 TN_no_color_video = 0;
2113 break;
2117 void
2118 set_tty_color_mode (f, val)
2119 struct frame *f;
2120 Lisp_Object val;
2122 Lisp_Object color_mode_spec, current_mode_spec;
2123 Lisp_Object color_mode, current_mode;
2124 int mode, old_mode;
2125 extern Lisp_Object Qtty_color_mode;
2126 Lisp_Object tty_color_mode_alist;
2128 tty_color_mode_alist = Fintern_soft (build_string ("tty-color-mode-alist"),
2129 Qnil);
2131 if (NATNUMP (val))
2132 color_mode = val;
2133 else
2135 if (NILP (tty_color_mode_alist))
2136 color_mode_spec = Qnil;
2137 else
2138 color_mode_spec = Fassq (val, XSYMBOL (tty_color_mode_alist)->value);
2139 current_mode_spec = assq_no_quit (Qtty_color_mode, f->param_alist);
2141 if (CONSP (color_mode_spec))
2142 color_mode = XCDR (color_mode_spec);
2143 else
2144 color_mode = Qnil;
2146 if (CONSP (current_mode_spec))
2147 current_mode = XCDR (current_mode_spec);
2148 else
2149 current_mode = Qnil;
2150 if (NATNUMP (color_mode))
2151 mode = XINT (color_mode);
2152 else
2153 mode = 0; /* meaning default */
2154 if (NATNUMP (current_mode))
2155 old_mode = XINT (current_mode);
2156 else
2157 old_mode = 0;
2159 if (mode != old_mode)
2161 tty_setup_colors (mode);
2162 /* This recomputes all the faces given the new color
2163 definitions. */
2164 call0 (intern ("tty-set-up-initial-frame-faces"));
2165 redraw_frame (f);
2169 #endif /* !WINDOWSNT */
2172 /***********************************************************************
2173 Initialization
2174 ***********************************************************************/
2176 void
2177 term_init (terminal_type)
2178 char *terminal_type;
2180 char *area;
2181 char **address = &area;
2182 char buffer[2044];
2183 register char *p;
2184 int status;
2185 struct frame *sf = XFRAME (selected_frame);
2187 #ifdef WINDOWSNT
2188 initialize_w32_display ();
2190 Wcm_clear ();
2192 area = (char *) xmalloc (2044);
2194 if (area == 0)
2195 abort ();
2197 FrameRows = FRAME_HEIGHT (sf);
2198 FrameCols = FRAME_WIDTH (sf);
2199 specified_window = FRAME_HEIGHT (sf);
2201 delete_in_insert_mode = 1;
2203 UseTabs = 0;
2204 scroll_region_ok = 0;
2206 /* Seems to insert lines when it's not supposed to, messing
2207 up the display. In doing a trace, it didn't seem to be
2208 called much, so I don't think we're losing anything by
2209 turning it off. */
2211 line_ins_del_ok = 0;
2212 char_ins_del_ok = 1;
2214 baud_rate = 19200;
2216 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2217 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2218 TN_max_colors = 16; /* Required to be non-zero for tty-display-color-p */
2220 return;
2221 #else /* not WINDOWSNT */
2223 Wcm_clear ();
2225 status = tgetent (buffer, terminal_type);
2226 if (status < 0)
2228 #ifdef TERMINFO
2229 fatal ("Cannot open terminfo database file");
2230 #else
2231 fatal ("Cannot open termcap database file");
2232 #endif
2234 if (status == 0)
2236 #ifdef TERMINFO
2237 fatal ("Terminal type %s is not defined.\n\
2238 If that is not the actual type of terminal you have,\n\
2239 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2240 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2241 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2242 terminal_type);
2243 #else
2244 fatal ("Terminal type %s is not defined.\n\
2245 If that is not the actual type of terminal you have,\n\
2246 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2247 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2248 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2249 terminal_type);
2250 #endif
2252 #ifdef TERMINFO
2253 area = (char *) xmalloc (2044);
2254 #else
2255 area = (char *) xmalloc (strlen (buffer));
2256 #endif /* not TERMINFO */
2257 if (area == 0)
2258 abort ();
2260 TS_ins_line = tgetstr ("al", address);
2261 TS_ins_multi_lines = tgetstr ("AL", address);
2262 TS_bell = tgetstr ("bl", address);
2263 BackTab = tgetstr ("bt", address);
2264 TS_clr_to_bottom = tgetstr ("cd", address);
2265 TS_clr_line = tgetstr ("ce", address);
2266 TS_clr_frame = tgetstr ("cl", address);
2267 ColPosition = NULL; /* tgetstr ("ch", address); */
2268 AbsPosition = tgetstr ("cm", address);
2269 CR = tgetstr ("cr", address);
2270 TS_set_scroll_region = tgetstr ("cs", address);
2271 TS_set_scroll_region_1 = tgetstr ("cS", address);
2272 RowPosition = tgetstr ("cv", address);
2273 TS_del_char = tgetstr ("dc", address);
2274 TS_del_multi_chars = tgetstr ("DC", address);
2275 TS_del_line = tgetstr ("dl", address);
2276 TS_del_multi_lines = tgetstr ("DL", address);
2277 TS_delete_mode = tgetstr ("dm", address);
2278 TS_end_delete_mode = tgetstr ("ed", address);
2279 TS_end_insert_mode = tgetstr ("ei", address);
2280 Home = tgetstr ("ho", address);
2281 TS_ins_char = tgetstr ("ic", address);
2282 TS_ins_multi_chars = tgetstr ("IC", address);
2283 TS_insert_mode = tgetstr ("im", address);
2284 TS_pad_inserted_char = tgetstr ("ip", address);
2285 TS_end_keypad_mode = tgetstr ("ke", address);
2286 TS_keypad_mode = tgetstr ("ks", address);
2287 LastLine = tgetstr ("ll", address);
2288 Right = tgetstr ("nd", address);
2289 Down = tgetstr ("do", address);
2290 if (!Down)
2291 Down = tgetstr ("nl", address); /* Obsolete name for "do" */
2292 #ifdef VMS
2293 /* VMS puts a carriage return before each linefeed,
2294 so it is not safe to use linefeeds. */
2295 if (Down && Down[0] == '\n' && Down[1] == '\0')
2296 Down = 0;
2297 #endif /* VMS */
2298 if (tgetflag ("bs"))
2299 Left = "\b"; /* can't possibly be longer! */
2300 else /* (Actually, "bs" is obsolete...) */
2301 Left = tgetstr ("le", address);
2302 if (!Left)
2303 Left = tgetstr ("bc", address); /* Obsolete name for "le" */
2304 TS_pad_char = tgetstr ("pc", address);
2305 TS_repeat = tgetstr ("rp", address);
2306 TS_end_standout_mode = tgetstr ("se", address);
2307 TS_fwd_scroll = tgetstr ("sf", address);
2308 TS_standout_mode = tgetstr ("so", address);
2309 TS_rev_scroll = tgetstr ("sr", address);
2310 Wcm.cm_tab = tgetstr ("ta", address);
2311 TS_end_termcap_modes = tgetstr ("te", address);
2312 TS_termcap_modes = tgetstr ("ti", address);
2313 Up = tgetstr ("up", address);
2314 TS_visible_bell = tgetstr ("vb", address);
2315 TS_cursor_normal = tgetstr ("ve", address);
2316 TS_cursor_visible = tgetstr ("vs", address);
2317 TS_cursor_invisible = tgetstr ("vi", address);
2318 TS_set_window = tgetstr ("wi", address);
2320 TS_enter_underline_mode = tgetstr ("us", address);
2321 TS_exit_underline_mode = tgetstr ("ue", address);
2322 TS_enter_bold_mode = tgetstr ("md", address);
2323 TS_enter_dim_mode = tgetstr ("mh", address);
2324 TS_enter_blink_mode = tgetstr ("mb", address);
2325 TS_enter_reverse_mode = tgetstr ("mr", address);
2326 TS_enter_alt_charset_mode = tgetstr ("as", address);
2327 TS_exit_alt_charset_mode = tgetstr ("ae", address);
2328 TS_exit_attribute_mode = tgetstr ("me", address);
2330 MultiUp = tgetstr ("UP", address);
2331 MultiDown = tgetstr ("DO", address);
2332 MultiLeft = tgetstr ("LE", address);
2333 MultiRight = tgetstr ("RI", address);
2335 /* SVr4/ANSI color suppert. If "op" isn't available, don't support
2336 color because we can't switch back to the default foreground and
2337 background. */
2338 TS_orig_pair = tgetstr ("op", address);
2339 if (TS_orig_pair)
2341 TS_set_foreground = tgetstr ("AF", address);
2342 TS_set_background = tgetstr ("AB", address);
2343 if (!TS_set_foreground)
2345 /* SVr4. */
2346 TS_set_foreground = tgetstr ("Sf", address);
2347 TS_set_background = tgetstr ("Sb", address);
2350 TN_max_colors = tgetnum ("Co");
2351 TN_max_pairs = tgetnum ("pa");
2353 TN_no_color_video = tgetnum ("NC");
2354 if (TN_no_color_video == -1)
2355 TN_no_color_video = 0;
2358 tty_default_color_capabilities (1);
2360 MagicWrap = tgetflag ("xn");
2361 /* Since we make MagicWrap terminals look like AutoWrap, we need to have
2362 the former flag imply the latter. */
2363 AutoWrap = MagicWrap || tgetflag ("am");
2364 memory_below_frame = tgetflag ("db");
2365 TF_hazeltine = tgetflag ("hz");
2366 must_write_spaces = tgetflag ("in");
2367 meta_key = tgetflag ("km") || tgetflag ("MT");
2368 TF_insmode_motion = tgetflag ("mi");
2369 TF_standout_motion = tgetflag ("ms");
2370 TF_underscore = tgetflag ("ul");
2371 TF_teleray = tgetflag ("xt");
2373 term_get_fkeys (address);
2375 /* Get frame size from system, or else from termcap. */
2377 int height, width;
2378 get_frame_size (&width, &height);
2379 FRAME_WIDTH (sf) = width;
2380 FRAME_HEIGHT (sf) = height;
2383 if (FRAME_WIDTH (sf) <= 0)
2384 SET_FRAME_WIDTH (sf, tgetnum ("co"));
2385 else
2386 /* Keep width and external_width consistent */
2387 SET_FRAME_WIDTH (sf, FRAME_WIDTH (sf));
2388 if (FRAME_HEIGHT (sf) <= 0)
2389 FRAME_HEIGHT (sf) = tgetnum ("li");
2391 if (FRAME_HEIGHT (sf) < 3 || FRAME_WIDTH (sf) < 3)
2392 fatal ("Screen size %dx%d is too small",
2393 FRAME_HEIGHT (sf), FRAME_WIDTH (sf));
2395 min_padding_speed = tgetnum ("pb");
2396 TabWidth = tgetnum ("tw");
2398 #ifdef VMS
2399 /* These capabilities commonly use ^J.
2400 I don't know why, but sending them on VMS does not work;
2401 it causes following spaces to be lost, sometimes.
2402 For now, the simplest fix is to avoid using these capabilities ever. */
2403 if (Down && Down[0] == '\n')
2404 Down = 0;
2405 #endif /* VMS */
2407 if (!TS_bell)
2408 TS_bell = "\07";
2410 if (!TS_fwd_scroll)
2411 TS_fwd_scroll = Down;
2413 PC = TS_pad_char ? *TS_pad_char : 0;
2415 if (TabWidth < 0)
2416 TabWidth = 8;
2418 /* Turned off since /etc/termcap seems to have :ta= for most terminals
2419 and newer termcap doc does not seem to say there is a default.
2420 if (!Wcm.cm_tab)
2421 Wcm.cm_tab = "\t";
2424 /* We don't support standout modes that use `magic cookies', so
2425 turn off any that do. */
2426 if (TS_standout_mode && tgetnum ("sg") >= 0)
2428 TS_standout_mode = 0;
2429 TS_end_standout_mode = 0;
2431 if (TS_enter_underline_mode && tgetnum ("ug") >= 0)
2433 TS_enter_underline_mode = 0;
2434 TS_exit_underline_mode = 0;
2437 /* If there's no standout mode, try to use underlining instead. */
2438 if (TS_standout_mode == 0)
2440 TS_standout_mode = TS_enter_underline_mode;
2441 TS_end_standout_mode = TS_exit_underline_mode;
2444 /* If no `se' string, try using a `me' string instead.
2445 If that fails, we can't use standout mode at all. */
2446 if (TS_end_standout_mode == 0)
2448 char *s = tgetstr ("me", address);
2449 if (s != 0)
2450 TS_end_standout_mode = s;
2451 else
2452 TS_standout_mode = 0;
2455 if (TF_teleray)
2457 Wcm.cm_tab = 0;
2458 /* We can't support standout mode, because it uses magic cookies. */
2459 TS_standout_mode = 0;
2460 /* But that means we cannot rely on ^M to go to column zero! */
2461 CR = 0;
2462 /* LF can't be trusted either -- can alter hpos */
2463 /* if move at column 0 thru a line with TS_standout_mode */
2464 Down = 0;
2467 /* Special handling for certain terminal types known to need it */
2469 if (!strcmp (terminal_type, "supdup"))
2471 memory_below_frame = 1;
2472 Wcm.cm_losewrap = 1;
2474 if (!strncmp (terminal_type, "c10", 3)
2475 || !strcmp (terminal_type, "perq"))
2477 /* Supply a makeshift :wi string.
2478 This string is not valid in general since it works only
2479 for windows starting at the upper left corner;
2480 but that is all Emacs uses.
2482 This string works only if the frame is using
2483 the top of the video memory, because addressing is memory-relative.
2484 So first check the :ti string to see if that is true.
2486 It would be simpler if the :wi string could go in the termcap
2487 entry, but it can't because it is not fully valid.
2488 If it were in the termcap entry, it would confuse other programs. */
2489 if (!TS_set_window)
2491 p = TS_termcap_modes;
2492 while (*p && strcmp (p, "\033v "))
2493 p++;
2494 if (*p)
2495 TS_set_window = "\033v%C %C %C %C ";
2497 /* Termcap entry often fails to have :in: flag */
2498 must_write_spaces = 1;
2499 /* :ti string typically fails to have \E^G! in it */
2500 /* This limits scope of insert-char to one line. */
2501 strcpy (area, TS_termcap_modes);
2502 strcat (area, "\033\007!");
2503 TS_termcap_modes = area;
2504 area += strlen (area) + 1;
2505 p = AbsPosition;
2506 /* Change all %+ parameters to %C, to handle
2507 values above 96 correctly for the C100. */
2508 while (*p)
2510 if (p[0] == '%' && p[1] == '+')
2511 p[1] = 'C';
2512 p++;
2516 FrameRows = FRAME_HEIGHT (sf);
2517 FrameCols = FRAME_WIDTH (sf);
2518 specified_window = FRAME_HEIGHT (sf);
2520 if (Wcm_init () == -1) /* can't do cursor motion */
2521 #ifdef VMS
2522 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2523 It lacks the ability to position the cursor.\n\
2524 If that is not the actual type of terminal you have, use either the\n\
2525 DCL command `SET TERMINAL/DEVICE= ...' for DEC-compatible terminals,\n\
2526 or `define EMACS_TERM \"terminal type\"' for non-DEC terminals.",
2527 terminal_type);
2528 #else /* not VMS */
2529 # ifdef TERMINFO
2530 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2531 It lacks the ability to position the cursor.\n\
2532 If that is not the actual type of terminal you have,\n\
2533 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2534 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2535 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2536 terminal_type);
2537 # else /* TERMCAP */
2538 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2539 It lacks the ability to position the cursor.\n\
2540 If that is not the actual type of terminal you have,\n\
2541 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2542 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2543 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2544 terminal_type);
2545 # endif /* TERMINFO */
2546 #endif /*VMS */
2547 if (FRAME_HEIGHT (sf) <= 0
2548 || FRAME_WIDTH (sf) <= 0)
2549 fatal ("The frame size has not been specified");
2551 delete_in_insert_mode
2552 = TS_delete_mode && TS_insert_mode
2553 && !strcmp (TS_delete_mode, TS_insert_mode);
2555 se_is_so = (TS_standout_mode
2556 && TS_end_standout_mode
2557 && !strcmp (TS_standout_mode, TS_end_standout_mode));
2559 UseTabs = tabs_safe_p () && TabWidth == 8;
2561 scroll_region_ok
2562 = (Wcm.cm_abs
2563 && (TS_set_window || TS_set_scroll_region || TS_set_scroll_region_1));
2565 line_ins_del_ok = (((TS_ins_line || TS_ins_multi_lines)
2566 && (TS_del_line || TS_del_multi_lines))
2567 || (scroll_region_ok && TS_fwd_scroll && TS_rev_scroll));
2569 char_ins_del_ok = ((TS_ins_char || TS_insert_mode
2570 || TS_pad_inserted_char || TS_ins_multi_chars)
2571 && (TS_del_char || TS_del_multi_chars));
2573 fast_clear_end_of_line = TS_clr_line != 0;
2575 init_baud_rate ();
2576 if (read_socket_hook) /* Baudrate is somewhat */
2577 /* meaningless in this case */
2578 baud_rate = 9600;
2580 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2581 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2582 #endif /* WINDOWSNT */
2585 /* VARARGS 1 */
2586 void
2587 fatal (str, arg1, arg2)
2588 char *str, *arg1, *arg2;
2590 fprintf (stderr, "emacs: ");
2591 fprintf (stderr, str, arg1, arg2);
2592 fprintf (stderr, "\n");
2593 fflush (stderr);
2594 exit (1);
2597 void
2598 syms_of_term ()
2600 DEFVAR_BOOL ("system-uses-terminfo", &system_uses_terminfo,
2601 doc: /* Non-nil means the system uses terminfo rather than termcap.
2602 This variable can be used by terminal emulator packages. */);
2603 #ifdef TERMINFO
2604 system_uses_terminfo = 1;
2605 #else
2606 system_uses_terminfo = 0;
2607 #endif
2609 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function,
2610 doc: /* Non-nil means call this function to ring the bell.
2611 The function should accept no arguments. */);
2612 Vring_bell_function = Qnil;
2614 defsubr (&Stty_display_color_p);
2615 defsubr (&Stty_display_color_cells);