Various small changes in addition to:
[emacs.git] / src / term.c
blobdc0e51cdf8173aebb757e8a02cf3dfaf8b251d06
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_LINES (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_LINES (XFRAME (selected_frame)) \
77 - curY), cmputc); \
78 } while (0)
80 #define OUTPUT1_IF(a) do { if (a) tputs (a, 1, cmputc); } while (0)
82 /* Display space properties */
84 extern Lisp_Object Qspace, QCalign_to, QCwidth;
86 /* Function to use to ring the bell. */
88 Lisp_Object Vring_bell_function;
90 /* Terminal characteristics that higher levels want to look at.
91 These are all extern'd in termchar.h */
93 int must_write_spaces; /* Nonzero means spaces in the text
94 must actually be output; can't just skip
95 over some columns to leave them blank. */
96 int min_padding_speed; /* Speed below which no padding necessary */
98 int line_ins_del_ok; /* Terminal can insert and delete lines */
99 int char_ins_del_ok; /* Terminal can insert and delete chars */
100 int scroll_region_ok; /* Terminal supports setting the
101 scroll window */
102 int scroll_region_cost; /* Cost of setting a scroll window,
103 measured in characters */
104 int memory_below_frame; /* Terminal remembers lines
105 scrolled off bottom */
106 int fast_clear_end_of_line; /* Terminal has a `ce' string */
108 /* Nonzero means no need to redraw the entire frame on resuming
109 a suspended Emacs. This is useful on terminals with multiple pages,
110 where one page is used for Emacs and another for all else. */
112 int no_redraw_on_reenter;
114 /* Hook functions that you can set to snap out the functions in this file.
115 These are all extern'd in termhooks.h */
117 void (*cursor_to_hook) P_ ((int, int));
118 void (*raw_cursor_to_hook) P_ ((int, int));
119 void (*clear_to_end_hook) P_ ((void));
120 void (*clear_frame_hook) P_ ((void));
121 void (*clear_end_of_line_hook) P_ ((int));
123 void (*ins_del_lines_hook) P_ ((int, int));
125 void (*delete_glyphs_hook) P_ ((int));
127 void (*ring_bell_hook) P_ ((void));
129 void (*reset_terminal_modes_hook) P_ ((void));
130 void (*set_terminal_modes_hook) P_ ((void));
131 void (*update_begin_hook) P_ ((struct frame *));
132 void (*update_end_hook) P_ ((struct frame *));
133 void (*set_terminal_window_hook) P_ ((int));
134 void (*insert_glyphs_hook) P_ ((struct glyph *, int));
135 void (*write_glyphs_hook) P_ ((struct glyph *, int));
136 void (*delete_glyphs_hook) P_ ((int));
138 int (*read_socket_hook) P_ ((int, int, struct input_event *));
140 void (*frame_up_to_date_hook) P_ ((struct frame *));
142 /* Return the current position of the mouse.
144 Set *f to the frame the mouse is in, or zero if the mouse is in no
145 Emacs frame. If it is set to zero, all the other arguments are
146 garbage.
148 If the motion started in a scroll bar, set *bar_window to the
149 scroll bar's window, *part to the part the mouse is currently over,
150 *x to the position of the mouse along the scroll bar, and *y to the
151 overall length of the scroll bar.
153 Otherwise, set *bar_window to Qnil, and *x and *y to the column and
154 row of the character cell the mouse is over.
156 Set *time to the time the mouse was at the returned position.
158 This should clear mouse_moved until the next motion
159 event arrives. */
161 void (*mouse_position_hook) P_ ((FRAME_PTR *f, int insist,
162 Lisp_Object *bar_window,
163 enum scroll_bar_part *part,
164 Lisp_Object *x,
165 Lisp_Object *y,
166 unsigned long *time));
168 /* When reading from a minibuffer in a different frame, Emacs wants
169 to shift the highlight from the selected frame to the mini-buffer's
170 frame; under X, this means it lies about where the focus is.
171 This hook tells the window system code to re-decide where to put
172 the highlight. */
174 void (*frame_rehighlight_hook) P_ ((FRAME_PTR f));
176 /* If we're displaying frames using a window system that can stack
177 frames on top of each other, this hook allows you to bring a frame
178 to the front, or bury it behind all the other windows. If this
179 hook is zero, that means the device we're displaying on doesn't
180 support overlapping frames, so there's no need to raise or lower
181 anything.
183 If RAISE is non-zero, F is brought to the front, before all other
184 windows. If RAISE is zero, F is sent to the back, behind all other
185 windows. */
187 void (*frame_raise_lower_hook) P_ ((FRAME_PTR f, int raise));
189 /* Set the vertical scroll bar for WINDOW to have its upper left corner
190 at (TOP, LEFT), and be LENGTH rows high. Set its handle to
191 indicate that we are displaying PORTION characters out of a total
192 of WHOLE characters, starting at POSITION. If WINDOW doesn't yet
193 have a scroll bar, create one for it. */
195 void (*set_vertical_scroll_bar_hook)
196 P_ ((struct window *window,
197 int portion, int whole, int position));
200 /* The following three hooks are used when we're doing a thorough
201 redisplay of the frame. We don't explicitly know which scroll bars
202 are going to be deleted, because keeping track of when windows go
203 away is a real pain - can you say set-window-configuration?
204 Instead, we just assert at the beginning of redisplay that *all*
205 scroll bars are to be removed, and then save scroll bars from the
206 fiery pit when we actually redisplay their window. */
208 /* Arrange for all scroll bars on FRAME to be removed at the next call
209 to `*judge_scroll_bars_hook'. A scroll bar may be spared if
210 `*redeem_scroll_bar_hook' is applied to its window before the judgment.
212 This should be applied to each frame each time its window tree is
213 redisplayed, even if it is not displaying scroll bars at the moment;
214 if the HAS_SCROLL_BARS flag has just been turned off, only calling
215 this and the judge_scroll_bars_hook will get rid of them.
217 If non-zero, this hook should be safe to apply to any frame,
218 whether or not it can support scroll bars, and whether or not it is
219 currently displaying them. */
221 void (*condemn_scroll_bars_hook) P_ ((FRAME_PTR frame));
223 /* Unmark WINDOW's scroll bar for deletion in this judgement cycle.
224 Note that it's okay to redeem a scroll bar that is not condemned. */
226 void (*redeem_scroll_bar_hook) P_ ((struct window *window));
228 /* Remove all scroll bars on FRAME that haven't been saved since the
229 last call to `*condemn_scroll_bars_hook'.
231 This should be applied to each frame after each time its window
232 tree is redisplayed, even if it is not displaying scroll bars at the
233 moment; if the HAS_SCROLL_BARS flag has just been turned off, only
234 calling this and condemn_scroll_bars_hook will get rid of them.
236 If non-zero, this hook should be safe to apply to any frame,
237 whether or not it can support scroll bars, and whether or not it is
238 currently displaying them. */
240 void (*judge_scroll_bars_hook) P_ ((FRAME_PTR FRAME));
242 /* Strings, numbers and flags taken from the termcap entry. */
244 char *TS_ins_line; /* "al" */
245 char *TS_ins_multi_lines; /* "AL" (one parameter, # lines to insert) */
246 char *TS_bell; /* "bl" */
247 char *TS_clr_to_bottom; /* "cd" */
248 char *TS_clr_line; /* "ce", clear to end of line */
249 char *TS_clr_frame; /* "cl" */
250 char *TS_set_scroll_region; /* "cs" (2 params, first line and last line) */
251 char *TS_set_scroll_region_1; /* "cS" (4 params: total lines,
252 lines above scroll region, lines below it,
253 total lines again) */
254 char *TS_del_char; /* "dc" */
255 char *TS_del_multi_chars; /* "DC" (one parameter, # chars to delete) */
256 char *TS_del_line; /* "dl" */
257 char *TS_del_multi_lines; /* "DL" (one parameter, # lines to delete) */
258 char *TS_delete_mode; /* "dm", enter character-delete mode */
259 char *TS_end_delete_mode; /* "ed", leave character-delete mode */
260 char *TS_end_insert_mode; /* "ei", leave character-insert mode */
261 char *TS_ins_char; /* "ic" */
262 char *TS_ins_multi_chars; /* "IC" (one parameter, # chars to insert) */
263 char *TS_insert_mode; /* "im", enter character-insert mode */
264 char *TS_pad_inserted_char; /* "ip". Just padding, no commands. */
265 char *TS_end_keypad_mode; /* "ke" */
266 char *TS_keypad_mode; /* "ks" */
267 char *TS_pad_char; /* "pc", char to use as padding */
268 char *TS_repeat; /* "rp" (2 params, # times to repeat
269 and character to be repeated) */
270 char *TS_end_standout_mode; /* "se" */
271 char *TS_fwd_scroll; /* "sf" */
272 char *TS_standout_mode; /* "so" */
273 char *TS_rev_scroll; /* "sr" */
274 char *TS_end_termcap_modes; /* "te" */
275 char *TS_termcap_modes; /* "ti" */
276 char *TS_visible_bell; /* "vb" */
277 char *TS_cursor_normal; /* "ve" */
278 char *TS_cursor_visible; /* "vs" */
279 char *TS_cursor_invisible; /* "vi" */
280 char *TS_set_window; /* "wi" (4 params, start and end of window,
281 each as vpos and hpos) */
283 /* Value of the "NC" (no_color_video) capability, or 0 if not
284 present. */
286 static int TN_no_color_video;
288 /* Meaning of bits in no_color_video. Each bit set means that the
289 corresponding attribute cannot be combined with colors. */
291 enum no_color_bit
293 NC_STANDOUT = 1 << 0,
294 NC_UNDERLINE = 1 << 1,
295 NC_REVERSE = 1 << 2,
296 NC_BLINK = 1 << 3,
297 NC_DIM = 1 << 4,
298 NC_BOLD = 1 << 5,
299 NC_INVIS = 1 << 6,
300 NC_PROTECT = 1 << 7,
301 NC_ALT_CHARSET = 1 << 8
304 /* "md" -- turn on bold (extra bright mode). */
306 char *TS_enter_bold_mode;
308 /* "mh" -- turn on half-bright mode. */
310 char *TS_enter_dim_mode;
312 /* "mb" -- enter blinking mode. */
314 char *TS_enter_blink_mode;
316 /* "mr" -- enter reverse video mode. */
318 char *TS_enter_reverse_mode;
320 /* "us"/"ue" -- start/end underlining. */
322 char *TS_exit_underline_mode, *TS_enter_underline_mode;
324 /* "as"/"ae" -- start/end alternate character set. Not really
325 supported, yet. */
327 char *TS_enter_alt_charset_mode, *TS_exit_alt_charset_mode;
329 /* "me" -- switch appearances off. */
331 char *TS_exit_attribute_mode;
333 /* "Co" -- number of colors. */
335 int TN_max_colors;
337 /* "pa" -- max. number of color pairs on screen. Not handled yet.
338 Could be a problem if not equal to TN_max_colors * TN_max_colors. */
340 int TN_max_pairs;
342 /* "op" -- SVr4 set default pair to its original value. */
344 char *TS_orig_pair;
346 /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
347 1 param, the color index. */
349 char *TS_set_foreground, *TS_set_background;
351 int TF_hazeltine; /* termcap hz flag. */
352 int TF_insmode_motion; /* termcap mi flag: can move while in insert mode. */
353 int TF_standout_motion; /* termcap mi flag: can move while in standout mode. */
354 int TF_underscore; /* termcap ul flag: _ underlines if over-struck on
355 non-blank position. Must clear before writing _. */
356 int TF_teleray; /* termcap xt flag: many weird consequences.
357 For t1061. */
359 static int RPov; /* # chars to start a TS_repeat */
361 static int delete_in_insert_mode; /* delete mode == insert mode */
363 static int se_is_so; /* 1 if same string both enters and leaves
364 standout mode */
366 /* internal state */
368 /* The largest frame width in any call to calculate_costs. */
370 int max_frame_cols;
372 /* The largest frame height in any call to calculate_costs. */
374 int max_frame_lines;
376 static int costs_set; /* Nonzero if costs have been calculated. */
378 int insert_mode; /* Nonzero when in insert mode. */
379 int standout_mode; /* Nonzero when in standout mode. */
381 /* Size of window specified by higher levels.
382 This is the number of lines, from the top of frame downwards,
383 which can participate in insert-line/delete-line operations.
385 Effectively it excludes the bottom frame_lines - specified_window_size
386 lines from those operations. */
388 int specified_window;
390 /* Frame currently being redisplayed; 0 if not currently redisplaying.
391 (Direct output does not count). */
393 FRAME_PTR updating_frame;
395 /* Provided for lisp packages. */
397 static int system_uses_terminfo;
399 /* Flag used in tty_show/hide_cursor. */
401 static int tty_cursor_hidden;
403 char *tparam ();
405 extern char *tgetstr ();
408 #ifdef WINDOWSNT
409 /* We aren't X windows, but we aren't termcap either. This makes me
410 uncertain as to what value to use for frame.output_method. For
411 this file, we'll define FRAME_TERMCAP_P to be zero so that our
412 output hooks get called instead of the termcap functions. Probably
413 the best long-term solution is to define an output_windows_nt... */
415 #undef FRAME_TERMCAP_P
416 #define FRAME_TERMCAP_P(_f_) 0
417 #endif /* WINDOWSNT */
419 void
420 ring_bell ()
422 if (!NILP (Vring_bell_function))
424 Lisp_Object function;
426 /* Temporarily set the global variable to nil
427 so that if we get an error, it stays nil
428 and we don't call it over and over.
430 We don't specbind it, because that would carefully
431 restore the bad value if there's an error
432 and make the loop of errors happen anyway. */
434 function = Vring_bell_function;
435 Vring_bell_function = Qnil;
437 call0 (function);
439 Vring_bell_function = function;
441 else if (!FRAME_TERMCAP_P (XFRAME (selected_frame)))
442 (*ring_bell_hook) ();
443 else
444 OUTPUT (TS_visible_bell && visible_bell ? TS_visible_bell : TS_bell);
447 void
448 set_terminal_modes ()
450 if (FRAME_TERMCAP_P (XFRAME (selected_frame)))
452 OUTPUT_IF (TS_termcap_modes);
453 OUTPUT_IF (TS_cursor_visible);
454 OUTPUT_IF (TS_keypad_mode);
455 losecursor ();
457 else
458 (*set_terminal_modes_hook) ();
461 void
462 reset_terminal_modes ()
464 if (FRAME_TERMCAP_P (XFRAME (selected_frame)))
466 turn_off_highlight ();
467 turn_off_insert ();
468 OUTPUT_IF (TS_end_keypad_mode);
469 OUTPUT_IF (TS_cursor_normal);
470 OUTPUT_IF (TS_end_termcap_modes);
471 OUTPUT_IF (TS_orig_pair);
472 /* Output raw CR so kernel can track the cursor hpos. */
473 cmputc ('\r');
475 else if (reset_terminal_modes_hook)
476 (*reset_terminal_modes_hook) ();
479 void
480 update_begin (f)
481 struct frame *f;
483 updating_frame = f;
484 if (!FRAME_TERMCAP_P (f))
485 update_begin_hook (f);
488 void
489 update_end (f)
490 struct frame *f;
492 if (FRAME_TERMCAP_P (f))
494 if (!XWINDOW (selected_window)->cursor_off_p)
495 tty_show_cursor ();
496 turn_off_insert ();
497 background_highlight ();
499 else
500 update_end_hook (f);
502 updating_frame = NULL;
505 void
506 set_terminal_window (size)
507 int size;
509 if (FRAME_TERMCAP_P (updating_frame))
511 specified_window = size ? size : FRAME_LINES (updating_frame);
512 if (scroll_region_ok)
513 set_scroll_region (0, specified_window);
515 else
516 set_terminal_window_hook (size);
519 void
520 set_scroll_region (start, stop)
521 int start, stop;
523 char *buf;
524 struct frame *sf = XFRAME (selected_frame);
526 if (TS_set_scroll_region)
527 buf = tparam (TS_set_scroll_region, 0, 0, start, stop - 1);
528 else if (TS_set_scroll_region_1)
529 buf = tparam (TS_set_scroll_region_1, 0, 0,
530 FRAME_LINES (sf), start,
531 FRAME_LINES (sf) - stop,
532 FRAME_LINES (sf));
533 else
534 buf = tparam (TS_set_window, 0, 0, start, 0, stop, FRAME_COLS (sf));
536 OUTPUT (buf);
537 xfree (buf);
538 losecursor ();
542 static void
543 turn_on_insert ()
545 if (!insert_mode)
546 OUTPUT (TS_insert_mode);
547 insert_mode = 1;
550 void
551 turn_off_insert ()
553 if (insert_mode)
554 OUTPUT (TS_end_insert_mode);
555 insert_mode = 0;
558 /* Handle highlighting. */
560 void
561 turn_off_highlight ()
563 if (standout_mode)
564 OUTPUT_IF (TS_end_standout_mode);
565 standout_mode = 0;
568 static void
569 turn_on_highlight ()
571 if (!standout_mode)
572 OUTPUT_IF (TS_standout_mode);
573 standout_mode = 1;
576 static void
577 toggle_highlight ()
579 if (standout_mode)
580 turn_off_highlight ();
581 else
582 turn_on_highlight ();
586 /* Make cursor invisible. */
588 static void
589 tty_hide_cursor ()
591 if (tty_cursor_hidden == 0)
593 tty_cursor_hidden = 1;
594 OUTPUT_IF (TS_cursor_invisible);
599 /* Ensure that cursor is visible. */
601 static void
602 tty_show_cursor ()
604 if (tty_cursor_hidden)
606 tty_cursor_hidden = 0;
607 OUTPUT_IF (TS_cursor_normal);
608 OUTPUT_IF (TS_cursor_visible);
613 /* Set standout mode to the state it should be in for
614 empty space inside windows. What this is,
615 depends on the user option inverse-video. */
617 void
618 background_highlight ()
620 if (inverse_video)
621 turn_on_highlight ();
622 else
623 turn_off_highlight ();
626 /* Set standout mode to the mode specified for the text to be output. */
628 static void
629 highlight_if_desired ()
631 if (inverse_video)
632 turn_on_highlight ();
633 else
634 turn_off_highlight ();
638 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
639 frame-relative coordinates. */
641 void
642 cursor_to (vpos, hpos)
643 int vpos, hpos;
645 struct frame *f = updating_frame ? updating_frame : XFRAME (selected_frame);
647 if (! FRAME_TERMCAP_P (f) && cursor_to_hook)
649 (*cursor_to_hook) (vpos, hpos);
650 return;
653 /* Detect the case where we are called from reset_sys_modes
654 and the costs have never been calculated. Do nothing. */
655 if (! costs_set)
656 return;
658 if (curY == vpos && curX == hpos)
659 return;
660 if (!TF_standout_motion)
661 background_highlight ();
662 if (!TF_insmode_motion)
663 turn_off_insert ();
664 cmgoto (vpos, hpos);
667 /* Similar but don't take any account of the wasted characters. */
669 void
670 raw_cursor_to (row, col)
671 int row, col;
673 struct frame *f = updating_frame ? updating_frame : XFRAME (selected_frame);
674 if (! FRAME_TERMCAP_P (f))
676 (*raw_cursor_to_hook) (row, col);
677 return;
679 if (curY == row && curX == col)
680 return;
681 if (!TF_standout_motion)
682 background_highlight ();
683 if (!TF_insmode_motion)
684 turn_off_insert ();
685 cmgoto (row, col);
688 /* Erase operations */
690 /* clear from cursor to end of frame */
691 void
692 clear_to_end ()
694 register int i;
696 if (clear_to_end_hook && ! FRAME_TERMCAP_P (updating_frame))
698 (*clear_to_end_hook) ();
699 return;
701 if (TS_clr_to_bottom)
703 background_highlight ();
704 OUTPUT (TS_clr_to_bottom);
706 else
708 for (i = curY; i < FRAME_LINES (XFRAME (selected_frame)); i++)
710 cursor_to (i, 0);
711 clear_end_of_line (FRAME_COLS (XFRAME (selected_frame)));
716 /* Clear entire frame */
718 void
719 clear_frame ()
721 struct frame *sf = XFRAME (selected_frame);
723 if (clear_frame_hook
724 && ! FRAME_TERMCAP_P ((updating_frame ? updating_frame : sf)))
726 (*clear_frame_hook) ();
727 return;
729 if (TS_clr_frame)
731 background_highlight ();
732 OUTPUT (TS_clr_frame);
733 cmat (0, 0);
735 else
737 cursor_to (0, 0);
738 clear_to_end ();
742 /* Clear from cursor to end of line.
743 Assume that the line is already clear starting at column first_unused_hpos.
745 Note that the cursor may be moved, on terminals lacking a `ce' string. */
747 void
748 clear_end_of_line (first_unused_hpos)
749 int first_unused_hpos;
751 register int i;
753 if (clear_end_of_line_hook
754 && ! FRAME_TERMCAP_P ((updating_frame
755 ? updating_frame
756 : XFRAME (selected_frame))))
758 (*clear_end_of_line_hook) (first_unused_hpos);
759 return;
762 /* Detect the case where we are called from reset_sys_modes
763 and the costs have never been calculated. Do nothing. */
764 if (! costs_set)
765 return;
767 if (curX >= first_unused_hpos)
768 return;
769 background_highlight ();
770 if (TS_clr_line)
772 OUTPUT1 (TS_clr_line);
774 else
775 { /* have to do it the hard way */
776 struct frame *sf = XFRAME (selected_frame);
777 turn_off_insert ();
779 /* Do not write in last row last col with Auto-wrap on. */
780 if (AutoWrap && curY == FRAME_LINES (sf) - 1
781 && first_unused_hpos == FRAME_COLS (sf))
782 first_unused_hpos--;
784 for (i = curX; i < first_unused_hpos; i++)
786 if (termscript)
787 fputc (' ', termscript);
788 putchar (' ');
790 cmplus (first_unused_hpos - curX);
794 /* Encode SRC_LEN glyphs starting at SRC to terminal output codes and
795 store them at DST. Do not write more than DST_LEN bytes. That may
796 require stopping before all SRC_LEN input glyphs have been
797 converted.
799 We store the number of glyphs actually converted in *CONSUMED. The
800 return value is the number of bytes store in DST. */
803 encode_terminal_code (src, dst, src_len, dst_len, consumed)
804 struct glyph *src;
805 int src_len;
806 unsigned char *dst;
807 int dst_len, *consumed;
809 struct glyph *src_start = src, *src_end = src + src_len;
810 unsigned char *dst_start = dst, *dst_end = dst + dst_len;
811 register GLYPH g;
812 unsigned char workbuf[MAX_MULTIBYTE_LENGTH];
813 const unsigned char *buf;
814 int len;
815 register int tlen = GLYPH_TABLE_LENGTH;
816 register Lisp_Object *tbase = GLYPH_TABLE_BASE;
817 int result;
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
824 ? &terminal_coding
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))
839 len = 1;
840 buf = " ";
841 coding->src_multibyte = 0;
843 else
845 len = CHAR_STRING (src->u.ch, workbuf);
846 buf = workbuf;
847 coding->src_multibyte = 1;
850 else
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
860 WORKBUF. */
861 workbuf[0] = FAST_GLYPH_CHAR (g);
862 len = 1;
863 buf = workbuf;
864 coding->src_multibyte = 0;
866 else
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. */
884 break;
886 if (len > 0)
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;
891 while (len--)
892 *dst++ = *buf++;
895 src++;
898 *consumed = src - src_start;
899 return (dst - dst_start);
903 void
904 write_glyphs (string, len)
905 register struct glyph *string;
906 register int len;
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);
918 return;
921 turn_off_insert ();
922 tty_hide_cursor ();
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. */
927 if (AutoWrap
928 && curY + 1 == FRAME_LINES (sf)
929 && (curX + len) == FRAME_COLS (sf))
930 len --;
931 if (len <= 0)
932 return;
934 cmplus (len);
936 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
937 the tail. */
938 terminal_coding.mode &= ~CODING_MODE_LAST_BLOCK;
940 while (len > 0)
942 /* Identify a run of glyphs with the same face. */
943 int face_id = string->face_id;
944 int n;
946 for (n = 1; n < len; ++n)
947 if (string[n].face_id != face_id)
948 break;
950 /* Turn appearance modes of the face of the run on. */
951 highlight_if_desired ();
952 turn_on_face (f, face_id);
954 while (n > 0)
956 /* We use a fixed size (1024 bytes) of conversion buffer.
957 Usually it is sufficient, but if not, we just repeat the
958 loop. */
959 produced = encode_terminal_code (string, conversion_buffer,
960 n, conversion_buffer_size,
961 &consumed);
962 if (produced > 0)
964 fwrite (conversion_buffer, 1, produced, stdout);
965 if (ferror (stdout))
966 clearerr (stdout);
967 if (termscript)
968 fwrite (conversion_buffer, 1, produced, termscript);
970 len -= consumed;
971 n -= consumed;
972 string += consumed;
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);
989 if (ferror (stdout))
990 clearerr (stdout);
991 if (termscript)
992 fwrite (conversion_buffer, 1, terminal_coding.produced,
993 termscript);
997 cmcheckmagic ();
1000 /* If start is zero, insert blanks instead of a string at start */
1002 void
1003 insert_glyphs (start, len)
1004 register struct glyph *start;
1005 register int len;
1007 char *buf;
1008 struct glyph *glyph = NULL;
1009 struct frame *f, *sf;
1011 if (len <= 0)
1012 return;
1014 if (insert_glyphs_hook)
1016 (*insert_glyphs_hook) (start, len);
1017 return;
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);
1026 OUTPUT1 (buf);
1027 xfree (buf);
1028 if (start)
1029 write_glyphs (start, len);
1030 return;
1033 turn_on_insert ();
1034 cmplus (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;
1037 while (len-- > 0)
1039 int produced, consumed;
1040 unsigned char conversion_buffer[1024];
1041 int conversion_buffer_size = sizeof conversion_buffer;
1043 OUTPUT1_IF (TS_ins_char);
1044 if (!start)
1046 conversion_buffer[0] = SPACEGLYPH;
1047 produced = 1;
1049 else
1051 highlight_if_desired ();
1052 turn_on_face (f, start->face_id);
1053 glyph = start;
1054 ++start;
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);
1060 start++, len--;
1063 if (len <= 0)
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);
1073 if (produced > 0)
1075 fwrite (conversion_buffer, 1, produced, stdout);
1076 if (ferror (stdout))
1077 clearerr (stdout);
1078 if (termscript)
1079 fwrite (conversion_buffer, 1, produced, termscript);
1082 OUTPUT1_IF (TS_pad_inserted_char);
1083 if (start)
1085 turn_off_face (f, glyph->face_id);
1086 turn_off_highlight ();
1090 cmcheckmagic ();
1093 void
1094 delete_glyphs (n)
1095 register int n;
1097 char *buf;
1098 register int i;
1100 if (delete_glyphs_hook && ! FRAME_TERMCAP_P (updating_frame))
1102 (*delete_glyphs_hook) (n);
1103 return;
1106 if (delete_in_insert_mode)
1108 turn_on_insert ();
1110 else
1112 turn_off_insert ();
1113 OUTPUT_IF (TS_delete_mode);
1116 if (TS_del_multi_chars)
1118 buf = tparam (TS_del_multi_chars, 0, 0, n);
1119 OUTPUT1 (buf);
1120 xfree (buf);
1122 else
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. */
1131 void
1132 ins_del_lines (vpos, n)
1133 int 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;
1138 struct frame *sf;
1140 register int i = n > 0 ? n : -n;
1141 register char *buf;
1143 if (ins_del_lines_hook && ! FRAME_TERMCAP_P (updating_frame))
1145 (*ins_del_lines_hook) (vpos, n);
1146 return;
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)
1159 return;
1160 if (!memory_below_frame && vpos + i >= FRAME_LINES (sf))
1161 return;
1163 if (multi)
1165 raw_cursor_to (vpos, 0);
1166 background_highlight ();
1167 buf = tparam (multi, 0, 0, i);
1168 OUTPUT (buf);
1169 xfree (buf);
1171 else if (single)
1173 raw_cursor_to (vpos, 0);
1174 background_highlight ();
1175 while (--i >= 0)
1176 OUTPUT (single);
1177 if (TF_teleray)
1178 curX = 0;
1180 else
1182 set_scroll_region (vpos, specified_window);
1183 if (n < 0)
1184 raw_cursor_to (specified_window - 1, 0);
1185 else
1186 raw_cursor_to (vpos, 0);
1187 background_highlight ();
1188 while (--i >= 0)
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_LINES (sf) + n, 0);
1196 clear_to_end ();
1200 /* Compute cost of sending "str", in characters,
1201 not counting any line-dependent padding. */
1204 string_cost (str)
1205 char *str;
1207 cost = 0;
1208 if (str)
1209 tputs (str, 0, evalcost);
1210 return cost;
1213 /* Compute cost of sending "str", in characters,
1214 counting any line-dependent padding at one line. */
1216 static int
1217 string_cost_one_line (str)
1218 char *str;
1220 cost = 0;
1221 if (str)
1222 tputs (str, 1, evalcost);
1223 return cost;
1226 /* Compute per line amount of line-dependent padding,
1227 in tenths of characters. */
1230 per_line_cost (str)
1231 register char *str;
1233 cost = 0;
1234 if (str)
1235 tputs (str, 0, evalcost);
1236 cost = - cost;
1237 if (str)
1238 tputs (str, 10, evalcost);
1239 return cost;
1242 #ifndef old
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_cols. */
1247 int *char_ins_del_vector;
1249 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_COLS ((f))])
1250 #endif
1252 /* ARGSUSED */
1253 static void
1254 calculate_ins_del_char_costs (frame)
1255 FRAME_PTR frame;
1257 int ins_startup_cost, del_startup_cost;
1258 int ins_cost_per_char, del_cost_per_char;
1259 register int i;
1260 register int *p;
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));
1275 else
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);
1294 else
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_COLS (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];
1307 *p++ = 0;
1309 /* Insert costs are at positive offsets */
1310 for (i = FRAME_COLS (frame); --i >= 0;)
1311 *p++ = (ins_startup_cost += ins_cost_per_char);
1314 void
1315 calculate_costs (frame)
1316 FRAME_PTR 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_lines = max (max_frame_lines, FRAME_LINES (frame));
1333 max_frame_cols = max (max_frame_cols, FRAME_COLS (frame));
1335 costs_set = 1;
1337 if (char_ins_del_vector != 0)
1338 char_ins_del_vector
1339 = (int *) xrealloc (char_ins_del_vector,
1340 (sizeof (int)
1341 + 2 * max_frame_cols * sizeof (int)));
1342 else
1343 char_ins_del_vector
1344 = (int *) xmalloc (sizeof (int)
1345 + 2 * max_frame_cols * sizeof (int));
1347 bzero (char_ins_del_vector, (sizeof (int)
1348 + 2 * max_frame_cols * 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,
1354 f, f, 1);
1355 else
1356 do_line_insertion_deletion_costs (frame,
1357 TS_ins_line, TS_ins_multi_lines,
1358 TS_del_line, TS_del_multi_lines,
1359 0, 0, 1);
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);
1366 else
1367 RPov = FRAME_COLS (frame) * 2;
1369 cmcostinit (); /* set up cursor motion costs */
1372 struct fkey_table {
1373 char *cap, *name;
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
1449 {"k1", "f1"},
1450 {"k2", "f2"},
1451 {"k3", "f3"},
1452 {"k4", "f4"},
1453 {"k5", "f5"},
1454 {"k6", "f6"},
1455 {"k7", "f7"},
1456 {"k8", "f8"},
1457 {"k9", "f9"}
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. */
1467 void
1468 term_get_fkeys (address)
1469 char **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);
1484 static Lisp_Object
1485 term_get_fkeys_1 ()
1487 int i;
1489 char **address = term_get_fkeys_arg;
1491 /* This can happen if CANNOT_DUMP or with strange options. */
1492 if (!initialized)
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);
1498 if (sequence)
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";
1514 if (k_semi)
1516 if (k0)
1517 /* Define f0 first, so that f10 takes precedence in case the
1518 key sequences happens to be the same. */
1519 Fdefine_key (Vfunction_key_map, build_string (k0),
1520 Fmake_vector (make_number (1), intern ("f0")));
1521 Fdefine_key (Vfunction_key_map, build_string (k_semi),
1522 Fmake_vector (make_number (1), intern ("f10")));
1524 else if (k0)
1525 Fdefine_key (Vfunction_key_map, build_string (k0),
1526 Fmake_vector (make_number (1), intern (k0_name)));
1529 /* Set up cookies for numbered function keys above f10. */
1531 char fcap[3], fkey[4];
1533 fcap[0] = 'F'; fcap[2] = '\0';
1534 for (i = 11; i < 64; i++)
1536 if (i <= 19)
1537 fcap[1] = '1' + i - 11;
1538 else if (i <= 45)
1539 fcap[1] = 'A' + i - 20;
1540 else
1541 fcap[1] = 'a' + i - 46;
1544 char *sequence = tgetstr (fcap, address);
1545 if (sequence)
1547 sprintf (fkey, "f%d", i);
1548 Fdefine_key (Vfunction_key_map, build_string (sequence),
1549 Fmake_vector (make_number (1),
1550 intern (fkey)));
1557 * Various mappings to try and get a better fit.
1560 #define CONDITIONAL_REASSIGN(cap1, cap2, sym) \
1561 if (!tgetstr (cap1, address)) \
1563 char *sequence = tgetstr (cap2, address); \
1564 if (sequence) \
1565 Fdefine_key (Vfunction_key_map, build_string (sequence), \
1566 Fmake_vector (make_number (1), \
1567 intern (sym))); \
1570 /* if there's no key_next keycap, map key_npage to `next' keysym */
1571 CONDITIONAL_REASSIGN ("%5", "kN", "next");
1572 /* if there's no key_prev keycap, map key_ppage to `previous' keysym */
1573 CONDITIONAL_REASSIGN ("%8", "kP", "prior");
1574 /* if there's no key_dc keycap, map key_ic to `insert' keysym */
1575 CONDITIONAL_REASSIGN ("kD", "kI", "insert");
1576 /* if there's no key_end keycap, map key_ll to 'end' keysym */
1577 CONDITIONAL_REASSIGN ("@7", "kH", "end");
1579 /* IBM has their own non-standard dialect of terminfo.
1580 If the standard name isn't found, try the IBM name. */
1581 CONDITIONAL_REASSIGN ("kB", "KO", "backtab");
1582 CONDITIONAL_REASSIGN ("@4", "kJ", "execute"); /* actually "action" */
1583 CONDITIONAL_REASSIGN ("@4", "kc", "execute"); /* actually "command" */
1584 CONDITIONAL_REASSIGN ("%7", "ki", "menu");
1585 CONDITIONAL_REASSIGN ("@7", "kw", "end");
1586 CONDITIONAL_REASSIGN ("F1", "k<", "f11");
1587 CONDITIONAL_REASSIGN ("F2", "k>", "f12");
1588 CONDITIONAL_REASSIGN ("%1", "kq", "help");
1589 CONDITIONAL_REASSIGN ("*6", "kU", "select");
1590 #undef CONDITIONAL_REASSIGN
1593 return Qnil;
1597 /***********************************************************************
1598 Character Display Information
1599 ***********************************************************************/
1601 static void append_glyph P_ ((struct it *));
1602 static void produce_stretch_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_STRETCH);
1668 if (it->what == IT_STRETCH)
1670 produce_stretch_glyph (it);
1671 goto done;
1674 /* Nothing but characters are supported on terminal frames. For a
1675 composition sequence, it->c is the first character of the
1676 sequence. */
1677 xassert (it->what == IT_CHARACTER
1678 || it->what == IT_COMPOSITION);
1680 if (it->c >= 040 && it->c < 0177)
1682 it->pixel_width = it->nglyphs = 1;
1683 if (it->glyph_row)
1684 append_glyph (it);
1686 else if (it->c == '\n')
1687 it->pixel_width = it->nglyphs = 0;
1688 else if (it->c == '\t')
1690 int absolute_x = (it->current_x
1691 + it->continuation_lines_width);
1692 int next_tab_x
1693 = (((1 + absolute_x + it->tab_width - 1)
1694 / it->tab_width)
1695 * it->tab_width);
1696 int nspaces;
1698 /* If part of the TAB has been displayed on the previous line
1699 which is continued now, continuation_lines_width will have
1700 been incremented already by the part that fitted on the
1701 continued line. So, we will get the right number of spaces
1702 here. */
1703 nspaces = next_tab_x - absolute_x;
1705 if (it->glyph_row)
1707 int n = nspaces;
1709 it->c = ' ';
1710 it->pixel_width = it->len = 1;
1712 while (n--)
1713 append_glyph (it);
1715 it->c = '\t';
1718 it->pixel_width = nspaces;
1719 it->nglyphs = nspaces;
1721 else if (SINGLE_BYTE_CHAR_P (it->c))
1723 /* Coming here means that it->c is from display table, thus we
1724 must send the code as is to the terminal. Although there's
1725 no way to know how many columns it occupies on a screen, it
1726 is a good assumption that a single byte code has 1-column
1727 width. */
1728 it->pixel_width = it->nglyphs = 1;
1729 if (it->glyph_row)
1730 append_glyph (it);
1732 else
1734 /* A multi-byte character. The display width is fixed for all
1735 characters of the set. Some of the glyphs may have to be
1736 ignored because they are already displayed in a continued
1737 line. */
1738 int charset = CHAR_CHARSET (it->c);
1740 it->pixel_width = CHARSET_WIDTH (charset);
1741 it->nglyphs = it->pixel_width;
1743 if (it->glyph_row)
1744 append_glyph (it);
1747 done:
1748 /* Advance current_x by the pixel width as a convenience for
1749 the caller. */
1750 if (it->area == TEXT_AREA)
1751 it->current_x += it->pixel_width;
1752 it->ascent = it->max_ascent = it->phys_ascent = it->max_phys_ascent = 0;
1753 it->descent = it->max_descent = it->phys_descent = it->max_phys_descent = 1;
1757 /* Produce a stretch glyph for iterator IT. IT->object is the value
1758 of the glyph property displayed. The value must be a list
1759 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
1760 being recognized:
1762 1. `:width WIDTH' specifies that the space should be WIDTH *
1763 canonical char width wide. WIDTH may be an integer or floating
1764 point number.
1766 2. `:align-to HPOS' specifies that the space should be wide enough
1767 to reach HPOS, a value in canonical character units. */
1769 static void
1770 produce_stretch_glyph (it)
1771 struct it *it;
1773 /* (space :width WIDTH ...) */
1774 Lisp_Object prop, plist;
1775 int width = 0, align_to = -1;
1776 int zero_width_ok_p = 0;
1777 double tem;
1779 /* List should start with `space'. */
1780 xassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
1781 plist = XCDR (it->object);
1783 /* Compute the width of the stretch. */
1784 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
1785 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, 0))
1787 /* Absolute width `:width WIDTH' specified and valid. */
1788 zero_width_ok_p = 1;
1789 width = (int)(tem + 0.5);
1791 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
1792 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, &align_to))
1794 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
1795 align_to = (align_to < 0
1797 : align_to - window_box_left_offset (it->w, TEXT_AREA));
1798 else if (align_to < 0)
1799 align_to = window_box_left_offset (it->w, TEXT_AREA);
1800 width = max (0, (int)(tem + 0.5) + align_to - it->current_x);
1801 zero_width_ok_p = 1;
1803 else
1804 /* Nothing specified -> width defaults to canonical char width. */
1805 width = FRAME_COLUMN_WIDTH (it->f);
1807 if (width <= 0 && (width < 0 || !zero_width_ok_p))
1808 width = 1;
1810 if (width > 0 && it->glyph_row)
1812 Lisp_Object o_object = it->object;
1813 Lisp_Object object = it->stack[it->sp - 1].string;
1814 int n = width;
1815 int c = it->c;
1817 if (!STRINGP (object))
1818 object = it->w->buffer;
1819 it->object = object;
1820 it->c = ' ';
1821 it->pixel_width = it->len = 1;
1822 while (n--)
1823 append_glyph (it);
1824 it->object = o_object;
1825 it->c = c;
1827 it->pixel_width = width;
1828 it->nglyphs = width;
1832 /* Get information about special display element WHAT in an
1833 environment described by IT. WHAT is one of IT_TRUNCATION or
1834 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
1835 non-null glyph_row member. This function ensures that fields like
1836 face_id, c, len of IT are left untouched. */
1838 void
1839 produce_special_glyphs (it, what)
1840 struct it *it;
1841 enum display_element_type what;
1843 struct it temp_it;
1845 temp_it = *it;
1846 temp_it.dp = NULL;
1847 temp_it.what = IT_CHARACTER;
1848 temp_it.len = 1;
1849 temp_it.object = make_number (0);
1850 bzero (&temp_it.current, sizeof temp_it.current);
1852 if (what == IT_CONTINUATION)
1854 /* Continuation glyph. */
1855 if (it->dp
1856 && INTEGERP (DISP_CONTINUE_GLYPH (it->dp))
1857 && GLYPH_CHAR_VALID_P (XINT (DISP_CONTINUE_GLYPH (it->dp))))
1859 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_CONTINUE_GLYPH (it->dp)));
1860 temp_it.len = CHAR_BYTES (temp_it.c);
1862 else
1863 temp_it.c = '\\';
1865 produce_glyphs (&temp_it);
1866 it->pixel_width = temp_it.pixel_width;
1867 it->nglyphs = temp_it.pixel_width;
1869 else if (what == IT_TRUNCATION)
1871 /* Truncation glyph. */
1872 if (it->dp
1873 && INTEGERP (DISP_TRUNC_GLYPH (it->dp))
1874 && GLYPH_CHAR_VALID_P (XINT (DISP_TRUNC_GLYPH (it->dp))))
1876 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_TRUNC_GLYPH (it->dp)));
1877 temp_it.len = CHAR_BYTES (temp_it.c);
1879 else
1880 temp_it.c = '$';
1882 produce_glyphs (&temp_it);
1883 it->pixel_width = temp_it.pixel_width;
1884 it->nglyphs = temp_it.pixel_width;
1886 else
1887 abort ();
1892 /***********************************************************************
1893 Faces
1894 ***********************************************************************/
1896 /* Value is non-zero if attribute ATTR may be used. ATTR should be
1897 one of the enumerators from enum no_color_bit, or a bit set built
1898 from them. Some display attributes may not be used together with
1899 color; the termcap capability `NC' specifies which ones. */
1901 #define MAY_USE_WITH_COLORS_P(ATTR) \
1902 (TN_max_colors > 0 \
1903 ? (TN_no_color_video & (ATTR)) == 0 \
1904 : 1)
1906 /* Turn appearances of face FACE_ID on tty frame F on. */
1908 static void
1909 turn_on_face (f, face_id)
1910 struct frame *f;
1911 int face_id;
1913 struct face *face = FACE_FROM_ID (f, face_id);
1914 long fg = face->foreground;
1915 long bg = face->background;
1917 /* Do this first because TS_end_standout_mode may be the same
1918 as TS_exit_attribute_mode, which turns all appearances off. */
1919 if (MAY_USE_WITH_COLORS_P (NC_REVERSE))
1921 if (TN_max_colors > 0)
1923 if (fg >= 0 && bg >= 0)
1925 /* If the terminal supports colors, we can set them
1926 below without using reverse video. The face's fg
1927 and bg colors are set as they should appear on
1928 the screen, i.e. they take the inverse-video'ness
1929 of the face already into account. */
1931 else if (inverse_video)
1933 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1934 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1935 toggle_highlight ();
1937 else
1939 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1940 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1941 toggle_highlight ();
1944 else
1946 /* If we can't display colors, use reverse video
1947 if the face specifies that. */
1948 if (inverse_video)
1950 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1951 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1952 toggle_highlight ();
1954 else
1956 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1957 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1958 toggle_highlight ();
1963 if (face->tty_bold_p)
1965 if (MAY_USE_WITH_COLORS_P (NC_BOLD))
1966 OUTPUT1_IF (TS_enter_bold_mode);
1968 else if (face->tty_dim_p)
1969 if (MAY_USE_WITH_COLORS_P (NC_DIM))
1970 OUTPUT1_IF (TS_enter_dim_mode);
1972 /* Alternate charset and blinking not yet used. */
1973 if (face->tty_alt_charset_p
1974 && MAY_USE_WITH_COLORS_P (NC_ALT_CHARSET))
1975 OUTPUT1_IF (TS_enter_alt_charset_mode);
1977 if (face->tty_blinking_p
1978 && MAY_USE_WITH_COLORS_P (NC_BLINK))
1979 OUTPUT1_IF (TS_enter_blink_mode);
1981 if (face->tty_underline_p && MAY_USE_WITH_COLORS_P (NC_UNDERLINE))
1982 OUTPUT1_IF (TS_enter_underline_mode);
1984 if (TN_max_colors > 0)
1986 char *p;
1988 if (fg >= 0 && TS_set_foreground)
1990 p = tparam (TS_set_foreground, NULL, 0, (int) fg);
1991 OUTPUT (p);
1992 xfree (p);
1995 if (bg >= 0 && TS_set_background)
1997 p = tparam (TS_set_background, NULL, 0, (int) bg);
1998 OUTPUT (p);
1999 xfree (p);
2005 /* Turn off appearances of face FACE_ID on tty frame F. */
2007 static void
2008 turn_off_face (f, face_id)
2009 struct frame *f;
2010 int face_id;
2012 struct face *face = FACE_FROM_ID (f, face_id);
2014 xassert (face != NULL);
2016 if (TS_exit_attribute_mode)
2018 /* Capability "me" will turn off appearance modes double-bright,
2019 half-bright, reverse-video, standout, underline. It may or
2020 may not turn off alt-char-mode. */
2021 if (face->tty_bold_p
2022 || face->tty_dim_p
2023 || face->tty_reverse_p
2024 || face->tty_alt_charset_p
2025 || face->tty_blinking_p
2026 || face->tty_underline_p)
2028 OUTPUT1_IF (TS_exit_attribute_mode);
2029 if (strcmp (TS_exit_attribute_mode, TS_end_standout_mode) == 0)
2030 standout_mode = 0;
2033 if (face->tty_alt_charset_p)
2034 OUTPUT_IF (TS_exit_alt_charset_mode);
2036 else
2038 /* If we don't have "me" we can only have those appearances
2039 that have exit sequences defined. */
2040 if (face->tty_alt_charset_p)
2041 OUTPUT_IF (TS_exit_alt_charset_mode);
2043 if (face->tty_underline_p)
2044 OUTPUT_IF (TS_exit_underline_mode);
2047 /* Switch back to default colors. */
2048 if (TN_max_colors > 0
2049 && ((face->foreground != FACE_TTY_DEFAULT_COLOR
2050 && face->foreground != FACE_TTY_DEFAULT_FG_COLOR)
2051 || (face->background != FACE_TTY_DEFAULT_COLOR
2052 && face->background != FACE_TTY_DEFAULT_BG_COLOR)))
2053 OUTPUT1_IF (TS_orig_pair);
2057 /* Return non-zero if the terminal on frame F supports all of the
2058 capabilities in CAPS simultaneously, with foreground and background
2059 colors FG and BG. */
2062 tty_capable_p (f, caps, fg, bg)
2063 struct frame *f;
2064 unsigned caps;
2065 unsigned long fg, bg;
2067 #define TTY_CAPABLE_P_TRY(cap, TS, NC_bit) \
2068 if ((caps & (cap)) && (!(TS) || !MAY_USE_WITH_COLORS_P(NC_bit))) \
2069 return 0;
2071 TTY_CAPABLE_P_TRY (TTY_CAP_INVERSE, TS_standout_mode, NC_REVERSE);
2072 TTY_CAPABLE_P_TRY (TTY_CAP_UNDERLINE, TS_enter_underline_mode, NC_UNDERLINE);
2073 TTY_CAPABLE_P_TRY (TTY_CAP_BOLD, TS_enter_bold_mode, NC_BOLD);
2074 TTY_CAPABLE_P_TRY (TTY_CAP_DIM, TS_enter_dim_mode, NC_DIM);
2075 TTY_CAPABLE_P_TRY (TTY_CAP_BLINK, TS_enter_blink_mode, NC_BLINK);
2076 TTY_CAPABLE_P_TRY (TTY_CAP_ALT_CHARSET, TS_enter_alt_charset_mode, NC_ALT_CHARSET);
2078 /* We can do it! */
2079 return 1;
2083 /* Return non-zero if the terminal is capable to display colors. */
2085 DEFUN ("tty-display-color-p", Ftty_display_color_p, Stty_display_color_p,
2086 0, 1, 0,
2087 doc: /* Return non-nil if TTY can display colors on DISPLAY. */)
2088 (display)
2089 Lisp_Object display;
2091 return TN_max_colors > 0 ? Qt : Qnil;
2094 /* Return the number of supported colors. */
2095 DEFUN ("tty-display-color-cells", Ftty_display_color_cells,
2096 Stty_display_color_cells, 0, 1, 0,
2097 doc: /* Return the number of colors supported by TTY on DISPLAY. */)
2098 (display)
2099 Lisp_Object display;
2101 return make_number (TN_max_colors);
2104 #ifndef WINDOWSNT
2106 /* Save or restore the default color-related capabilities of this
2107 terminal. */
2108 static void
2109 tty_default_color_capabilities (save)
2110 int save;
2112 static char
2113 *default_orig_pair, *default_set_foreground, *default_set_background;
2114 static int default_max_colors, default_max_pairs, default_no_color_video;
2116 if (save)
2118 if (default_orig_pair)
2119 xfree (default_orig_pair);
2120 default_orig_pair = TS_orig_pair ? xstrdup (TS_orig_pair) : NULL;
2122 if (default_set_foreground)
2123 xfree (default_set_foreground);
2124 default_set_foreground = TS_set_foreground ? xstrdup (TS_set_foreground)
2125 : NULL;
2127 if (default_set_background)
2128 xfree (default_set_background);
2129 default_set_background = TS_set_background ? xstrdup (TS_set_background)
2130 : NULL;
2132 default_max_colors = TN_max_colors;
2133 default_max_pairs = TN_max_pairs;
2134 default_no_color_video = TN_no_color_video;
2136 else
2138 TS_orig_pair = default_orig_pair;
2139 TS_set_foreground = default_set_foreground;
2140 TS_set_background = default_set_background;
2141 TN_max_colors = default_max_colors;
2142 TN_max_pairs = default_max_pairs;
2143 TN_no_color_video = default_no_color_video;
2147 /* Setup one of the standard tty color schemes according to MODE.
2148 MODE's value is generally the number of colors which we want to
2149 support; zero means set up for the default capabilities, the ones
2150 we saw at term_init time; -1 means turn off color support. */
2151 void
2152 tty_setup_colors (mode)
2153 int mode;
2155 /* Canonicalize all negative values of MODE. */
2156 if (mode < -1)
2157 mode = -1;
2159 switch (mode)
2161 case -1: /* no colors at all */
2162 TN_max_colors = 0;
2163 TN_max_pairs = 0;
2164 TN_no_color_video = 0;
2165 TS_set_foreground = TS_set_background = TS_orig_pair = NULL;
2166 break;
2167 case 0: /* default colors, if any */
2168 default:
2169 tty_default_color_capabilities (0);
2170 break;
2171 case 8: /* 8 standard ANSI colors */
2172 TS_orig_pair = "\033[0m";
2173 #ifdef TERMINFO
2174 TS_set_foreground = "\033[3%p1%dm";
2175 TS_set_background = "\033[4%p1%dm";
2176 #else
2177 TS_set_foreground = "\033[3%dm";
2178 TS_set_background = "\033[4%dm";
2179 #endif
2180 TN_max_colors = 8;
2181 TN_max_pairs = 64;
2182 TN_no_color_video = 0;
2183 break;
2187 void
2188 set_tty_color_mode (f, val)
2189 struct frame *f;
2190 Lisp_Object val;
2192 Lisp_Object color_mode_spec, current_mode_spec;
2193 Lisp_Object color_mode, current_mode;
2194 int mode, old_mode;
2195 extern Lisp_Object Qtty_color_mode;
2196 Lisp_Object tty_color_mode_alist;
2198 tty_color_mode_alist = Fintern_soft (build_string ("tty-color-mode-alist"),
2199 Qnil);
2201 if (INTEGERP (val))
2202 color_mode = val;
2203 else
2205 if (NILP (tty_color_mode_alist))
2206 color_mode_spec = Qnil;
2207 else
2208 color_mode_spec = Fassq (val, XSYMBOL (tty_color_mode_alist)->value);
2210 if (CONSP (color_mode_spec))
2211 color_mode = XCDR (color_mode_spec);
2212 else
2213 color_mode = Qnil;
2216 current_mode_spec = assq_no_quit (Qtty_color_mode, f->param_alist);
2218 if (CONSP (current_mode_spec))
2219 current_mode = XCDR (current_mode_spec);
2220 else
2221 current_mode = Qnil;
2222 if (INTEGERP (color_mode))
2223 mode = XINT (color_mode);
2224 else
2225 mode = 0; /* meaning default */
2226 if (INTEGERP (current_mode))
2227 old_mode = XINT (current_mode);
2228 else
2229 old_mode = 0;
2231 if (mode != old_mode)
2233 tty_setup_colors (mode);
2234 /* This recomputes all the faces given the new color
2235 definitions. */
2236 call0 (intern ("tty-set-up-initial-frame-faces"));
2237 redraw_frame (f);
2241 #endif /* !WINDOWSNT */
2244 /***********************************************************************
2245 Initialization
2246 ***********************************************************************/
2248 void
2249 term_init (terminal_type)
2250 char *terminal_type;
2252 char *area;
2253 char **address = &area;
2254 char *buffer = NULL;
2255 int buffer_size = 4096;
2256 register char *p;
2257 int status;
2258 struct frame *sf = XFRAME (selected_frame);
2260 #ifdef WINDOWSNT
2261 initialize_w32_display ();
2263 Wcm_clear ();
2265 area = (char *) xmalloc (2044);
2267 FrameRows = FRAME_LINES (sf);
2268 FrameCols = FRAME_COLS (sf);
2269 specified_window = FRAME_LINES (sf);
2271 delete_in_insert_mode = 1;
2273 UseTabs = 0;
2274 scroll_region_ok = 0;
2276 /* Seems to insert lines when it's not supposed to, messing
2277 up the display. In doing a trace, it didn't seem to be
2278 called much, so I don't think we're losing anything by
2279 turning it off. */
2281 line_ins_del_ok = 0;
2282 char_ins_del_ok = 1;
2284 baud_rate = 19200;
2286 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2287 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2288 TN_max_colors = 16; /* Required to be non-zero for tty-display-color-p */
2290 return;
2291 #else /* not WINDOWSNT */
2293 Wcm_clear ();
2295 buffer = (char *) xmalloc (buffer_size);
2296 status = tgetent (buffer, terminal_type);
2297 if (status < 0)
2299 #ifdef TERMINFO
2300 fatal ("Cannot open terminfo database file");
2301 #else
2302 fatal ("Cannot open termcap database file");
2303 #endif
2305 if (status == 0)
2307 #ifdef TERMINFO
2308 fatal ("Terminal type %s is not defined.\n\
2309 If that is not the actual type of terminal you have,\n\
2310 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2311 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2312 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2313 terminal_type);
2314 #else
2315 fatal ("Terminal type %s is not defined.\n\
2316 If that is not the actual type of terminal you have,\n\
2317 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2318 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2319 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2320 terminal_type);
2321 #endif
2324 #ifndef TERMINFO
2325 if (strlen (buffer) >= buffer_size)
2326 abort ();
2327 buffer_size = strlen (buffer);
2328 #endif
2329 area = (char *) xmalloc (buffer_size);
2331 TS_ins_line = tgetstr ("al", address);
2332 TS_ins_multi_lines = tgetstr ("AL", address);
2333 TS_bell = tgetstr ("bl", address);
2334 BackTab = tgetstr ("bt", address);
2335 TS_clr_to_bottom = tgetstr ("cd", address);
2336 TS_clr_line = tgetstr ("ce", address);
2337 TS_clr_frame = tgetstr ("cl", address);
2338 ColPosition = NULL; /* tgetstr ("ch", address); */
2339 AbsPosition = tgetstr ("cm", address);
2340 CR = tgetstr ("cr", address);
2341 TS_set_scroll_region = tgetstr ("cs", address);
2342 TS_set_scroll_region_1 = tgetstr ("cS", address);
2343 RowPosition = tgetstr ("cv", address);
2344 TS_del_char = tgetstr ("dc", address);
2345 TS_del_multi_chars = tgetstr ("DC", address);
2346 TS_del_line = tgetstr ("dl", address);
2347 TS_del_multi_lines = tgetstr ("DL", address);
2348 TS_delete_mode = tgetstr ("dm", address);
2349 TS_end_delete_mode = tgetstr ("ed", address);
2350 TS_end_insert_mode = tgetstr ("ei", address);
2351 Home = tgetstr ("ho", address);
2352 TS_ins_char = tgetstr ("ic", address);
2353 TS_ins_multi_chars = tgetstr ("IC", address);
2354 TS_insert_mode = tgetstr ("im", address);
2355 TS_pad_inserted_char = tgetstr ("ip", address);
2356 TS_end_keypad_mode = tgetstr ("ke", address);
2357 TS_keypad_mode = tgetstr ("ks", address);
2358 LastLine = tgetstr ("ll", address);
2359 Right = tgetstr ("nd", address);
2360 Down = tgetstr ("do", address);
2361 if (!Down)
2362 Down = tgetstr ("nl", address); /* Obsolete name for "do" */
2363 #ifdef VMS
2364 /* VMS puts a carriage return before each linefeed,
2365 so it is not safe to use linefeeds. */
2366 if (Down && Down[0] == '\n' && Down[1] == '\0')
2367 Down = 0;
2368 #endif /* VMS */
2369 if (tgetflag ("bs"))
2370 Left = "\b"; /* can't possibly be longer! */
2371 else /* (Actually, "bs" is obsolete...) */
2372 Left = tgetstr ("le", address);
2373 if (!Left)
2374 Left = tgetstr ("bc", address); /* Obsolete name for "le" */
2375 TS_pad_char = tgetstr ("pc", address);
2376 TS_repeat = tgetstr ("rp", address);
2377 TS_end_standout_mode = tgetstr ("se", address);
2378 TS_fwd_scroll = tgetstr ("sf", address);
2379 TS_standout_mode = tgetstr ("so", address);
2380 TS_rev_scroll = tgetstr ("sr", address);
2381 Wcm.cm_tab = tgetstr ("ta", address);
2382 TS_end_termcap_modes = tgetstr ("te", address);
2383 TS_termcap_modes = tgetstr ("ti", address);
2384 Up = tgetstr ("up", address);
2385 TS_visible_bell = tgetstr ("vb", address);
2386 TS_cursor_normal = tgetstr ("ve", address);
2387 TS_cursor_visible = tgetstr ("vs", address);
2388 TS_cursor_invisible = tgetstr ("vi", address);
2389 TS_set_window = tgetstr ("wi", address);
2391 TS_enter_underline_mode = tgetstr ("us", address);
2392 TS_exit_underline_mode = tgetstr ("ue", address);
2393 TS_enter_bold_mode = tgetstr ("md", address);
2394 TS_enter_dim_mode = tgetstr ("mh", address);
2395 TS_enter_blink_mode = tgetstr ("mb", address);
2396 TS_enter_reverse_mode = tgetstr ("mr", address);
2397 TS_enter_alt_charset_mode = tgetstr ("as", address);
2398 TS_exit_alt_charset_mode = tgetstr ("ae", address);
2399 TS_exit_attribute_mode = tgetstr ("me", address);
2401 MultiUp = tgetstr ("UP", address);
2402 MultiDown = tgetstr ("DO", address);
2403 MultiLeft = tgetstr ("LE", address);
2404 MultiRight = tgetstr ("RI", address);
2406 /* SVr4/ANSI color suppert. If "op" isn't available, don't support
2407 color because we can't switch back to the default foreground and
2408 background. */
2409 TS_orig_pair = tgetstr ("op", address);
2410 if (TS_orig_pair)
2412 TS_set_foreground = tgetstr ("AF", address);
2413 TS_set_background = tgetstr ("AB", address);
2414 if (!TS_set_foreground)
2416 /* SVr4. */
2417 TS_set_foreground = tgetstr ("Sf", address);
2418 TS_set_background = tgetstr ("Sb", address);
2421 TN_max_colors = tgetnum ("Co");
2422 TN_max_pairs = tgetnum ("pa");
2424 TN_no_color_video = tgetnum ("NC");
2425 if (TN_no_color_video == -1)
2426 TN_no_color_video = 0;
2429 tty_default_color_capabilities (1);
2431 MagicWrap = tgetflag ("xn");
2432 /* Since we make MagicWrap terminals look like AutoWrap, we need to have
2433 the former flag imply the latter. */
2434 AutoWrap = MagicWrap || tgetflag ("am");
2435 memory_below_frame = tgetflag ("db");
2436 TF_hazeltine = tgetflag ("hz");
2437 must_write_spaces = tgetflag ("in");
2438 meta_key = tgetflag ("km") || tgetflag ("MT");
2439 TF_insmode_motion = tgetflag ("mi");
2440 TF_standout_motion = tgetflag ("ms");
2441 TF_underscore = tgetflag ("ul");
2442 TF_teleray = tgetflag ("xt");
2444 term_get_fkeys (address);
2446 /* Get frame size from system, or else from termcap. */
2448 int height, width;
2449 get_frame_size (&width, &height);
2450 FRAME_COLS (sf) = width;
2451 FRAME_LINES (sf) = height;
2454 if (FRAME_COLS (sf) <= 0)
2455 SET_FRAME_COLS (sf, tgetnum ("co"));
2456 else
2457 /* Keep width and external_width consistent */
2458 SET_FRAME_COLS (sf, FRAME_COLS (sf));
2459 if (FRAME_LINES (sf) <= 0)
2460 FRAME_LINES (sf) = tgetnum ("li");
2462 if (FRAME_LINES (sf) < 3 || FRAME_COLS (sf) < 3)
2463 fatal ("Screen size %dx%d is too small",
2464 FRAME_LINES (sf), FRAME_COLS (sf));
2466 min_padding_speed = tgetnum ("pb");
2467 TabWidth = tgetnum ("tw");
2469 #ifdef VMS
2470 /* These capabilities commonly use ^J.
2471 I don't know why, but sending them on VMS does not work;
2472 it causes following spaces to be lost, sometimes.
2473 For now, the simplest fix is to avoid using these capabilities ever. */
2474 if (Down && Down[0] == '\n')
2475 Down = 0;
2476 #endif /* VMS */
2478 if (!TS_bell)
2479 TS_bell = "\07";
2481 if (!TS_fwd_scroll)
2482 TS_fwd_scroll = Down;
2484 PC = TS_pad_char ? *TS_pad_char : 0;
2486 if (TabWidth < 0)
2487 TabWidth = 8;
2489 /* Turned off since /etc/termcap seems to have :ta= for most terminals
2490 and newer termcap doc does not seem to say there is a default.
2491 if (!Wcm.cm_tab)
2492 Wcm.cm_tab = "\t";
2495 /* We don't support standout modes that use `magic cookies', so
2496 turn off any that do. */
2497 if (TS_standout_mode && tgetnum ("sg") >= 0)
2499 TS_standout_mode = 0;
2500 TS_end_standout_mode = 0;
2502 if (TS_enter_underline_mode && tgetnum ("ug") >= 0)
2504 TS_enter_underline_mode = 0;
2505 TS_exit_underline_mode = 0;
2508 /* If there's no standout mode, try to use underlining instead. */
2509 if (TS_standout_mode == 0)
2511 TS_standout_mode = TS_enter_underline_mode;
2512 TS_end_standout_mode = TS_exit_underline_mode;
2515 /* If no `se' string, try using a `me' string instead.
2516 If that fails, we can't use standout mode at all. */
2517 if (TS_end_standout_mode == 0)
2519 char *s = tgetstr ("me", address);
2520 if (s != 0)
2521 TS_end_standout_mode = s;
2522 else
2523 TS_standout_mode = 0;
2526 if (TF_teleray)
2528 Wcm.cm_tab = 0;
2529 /* We can't support standout mode, because it uses magic cookies. */
2530 TS_standout_mode = 0;
2531 /* But that means we cannot rely on ^M to go to column zero! */
2532 CR = 0;
2533 /* LF can't be trusted either -- can alter hpos */
2534 /* if move at column 0 thru a line with TS_standout_mode */
2535 Down = 0;
2538 /* Special handling for certain terminal types known to need it */
2540 if (!strcmp (terminal_type, "supdup"))
2542 memory_below_frame = 1;
2543 Wcm.cm_losewrap = 1;
2545 if (!strncmp (terminal_type, "c10", 3)
2546 || !strcmp (terminal_type, "perq"))
2548 /* Supply a makeshift :wi string.
2549 This string is not valid in general since it works only
2550 for windows starting at the upper left corner;
2551 but that is all Emacs uses.
2553 This string works only if the frame is using
2554 the top of the video memory, because addressing is memory-relative.
2555 So first check the :ti string to see if that is true.
2557 It would be simpler if the :wi string could go in the termcap
2558 entry, but it can't because it is not fully valid.
2559 If it were in the termcap entry, it would confuse other programs. */
2560 if (!TS_set_window)
2562 p = TS_termcap_modes;
2563 while (*p && strcmp (p, "\033v "))
2564 p++;
2565 if (*p)
2566 TS_set_window = "\033v%C %C %C %C ";
2568 /* Termcap entry often fails to have :in: flag */
2569 must_write_spaces = 1;
2570 /* :ti string typically fails to have \E^G! in it */
2571 /* This limits scope of insert-char to one line. */
2572 strcpy (area, TS_termcap_modes);
2573 strcat (area, "\033\007!");
2574 TS_termcap_modes = area;
2575 area += strlen (area) + 1;
2576 p = AbsPosition;
2577 /* Change all %+ parameters to %C, to handle
2578 values above 96 correctly for the C100. */
2579 while (*p)
2581 if (p[0] == '%' && p[1] == '+')
2582 p[1] = 'C';
2583 p++;
2587 FrameRows = FRAME_LINES (sf);
2588 FrameCols = FRAME_COLS (sf);
2589 specified_window = FRAME_LINES (sf);
2591 if (Wcm_init () == -1) /* can't do cursor motion */
2592 #ifdef VMS
2593 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2594 It lacks the ability to position the cursor.\n\
2595 If that is not the actual type of terminal you have, use either the\n\
2596 DCL command `SET TERMINAL/DEVICE= ...' for DEC-compatible terminals,\n\
2597 or `define EMACS_TERM \"terminal type\"' for non-DEC terminals.",
2598 terminal_type);
2599 #else /* not VMS */
2600 # ifdef TERMINFO
2601 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2602 It lacks the ability to position the cursor.\n\
2603 If that is not the actual type of terminal you have,\n\
2604 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2605 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2606 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2607 terminal_type);
2608 # else /* TERMCAP */
2609 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2610 It lacks the ability to position the cursor.\n\
2611 If that is not the actual type of terminal you have,\n\
2612 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2613 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2614 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2615 terminal_type);
2616 # endif /* TERMINFO */
2617 #endif /*VMS */
2618 if (FRAME_LINES (sf) <= 0
2619 || FRAME_COLS (sf) <= 0)
2620 fatal ("The frame size has not been specified");
2622 delete_in_insert_mode
2623 = TS_delete_mode && TS_insert_mode
2624 && !strcmp (TS_delete_mode, TS_insert_mode);
2626 se_is_so = (TS_standout_mode
2627 && TS_end_standout_mode
2628 && !strcmp (TS_standout_mode, TS_end_standout_mode));
2630 UseTabs = tabs_safe_p () && TabWidth == 8;
2632 scroll_region_ok
2633 = (Wcm.cm_abs
2634 && (TS_set_window || TS_set_scroll_region || TS_set_scroll_region_1));
2636 line_ins_del_ok = (((TS_ins_line || TS_ins_multi_lines)
2637 && (TS_del_line || TS_del_multi_lines))
2638 || (scroll_region_ok && TS_fwd_scroll && TS_rev_scroll));
2640 char_ins_del_ok = ((TS_ins_char || TS_insert_mode
2641 || TS_pad_inserted_char || TS_ins_multi_chars)
2642 && (TS_del_char || TS_del_multi_chars));
2644 fast_clear_end_of_line = TS_clr_line != 0;
2646 init_baud_rate ();
2647 if (read_socket_hook) /* Baudrate is somewhat */
2648 /* meaningless in this case */
2649 baud_rate = 9600;
2651 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2652 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2653 #endif /* WINDOWSNT */
2655 xfree (buffer);
2658 /* VARARGS 1 */
2659 void
2660 fatal (str, arg1, arg2)
2661 char *str, *arg1, *arg2;
2663 fprintf (stderr, "emacs: ");
2664 fprintf (stderr, str, arg1, arg2);
2665 fprintf (stderr, "\n");
2666 fflush (stderr);
2667 exit (1);
2670 void
2671 syms_of_term ()
2673 DEFVAR_BOOL ("system-uses-terminfo", &system_uses_terminfo,
2674 doc: /* Non-nil means the system uses terminfo rather than termcap.
2675 This variable can be used by terminal emulator packages. */);
2676 #ifdef TERMINFO
2677 system_uses_terminfo = 1;
2678 #else
2679 system_uses_terminfo = 0;
2680 #endif
2682 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function,
2683 doc: /* Non-nil means call this function to ring the bell.
2684 The function should accept no arguments. */);
2685 Vring_bell_function = Qnil;
2687 defsubr (&Stty_display_color_p);
2688 defsubr (&Stty_display_color_cells);
2691 /* arch-tag: 498e7449-6f2e-45e2-91dd-b7d4ca488193
2692 (do not change this comment) */