(macro-declaration-function): Move to emacs-lisp/byte-run.el.
[emacs.git] / src / term.c
blob23da2ac8704d976f59ddf70ada1777c5bf619c9d
1 /* Terminal control module for terminals described by TERMCAP
2 Copyright (C) 1985, 86, 87, 93, 94, 95, 98, 2000, 2001, 2002, 2005
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 /* Buffer to store the source and result of code conversion for terminal. */
795 static unsigned char *encode_terminal_buf;
796 /* Allocated size of the above buffer. */
797 static int encode_terminal_bufsize;
799 /* Encode SRC_LEN glyphs starting at SRC to terminal output codes.
800 Set CODING->produced to the byte-length of the resulting byte
801 sequence, and return a pointer to that byte sequence. */
803 unsigned char *
804 encode_terminal_code (src, src_len, coding)
805 struct glyph *src;
806 int src_len;
807 struct coding_system *coding;
809 struct glyph *src_start = src, *src_end = src + src_len;
810 register GLYPH g;
811 unsigned char *buf;
812 int nchars, nbytes, required;
813 register int tlen = GLYPH_TABLE_LENGTH;
814 register Lisp_Object *tbase = GLYPH_TABLE_BASE;
816 /* Allocate sufficient size of buffer to store all characters in
817 multibyte-form. But, it may be enlarged on demand if
818 Vglyph_table contains a string. */
819 required = MAX_MULTIBYTE_LENGTH * src_len;
820 if (encode_terminal_bufsize < required)
822 if (encode_terminal_bufsize == 0)
823 encode_terminal_buf = xmalloc (required);
824 else
825 encode_terminal_buf = xrealloc (encode_terminal_buf, required);
826 encode_terminal_bufsize = required;
829 buf = encode_terminal_buf;
830 nchars = 0;
831 while (src < src_end)
833 /* We must skip glyphs to be padded for a wide character. */
834 if (! CHAR_GLYPH_PADDING_P (*src))
836 g = GLYPH_FROM_CHAR_GLYPH (src[0]);
838 if (g < 0 || g >= tlen)
840 /* This glyph doesn't has an entry in Vglyph_table. */
841 if (CHAR_VALID_P (src->u.ch, 0))
842 buf += CHAR_STRING (src->u.ch, buf);
843 else
844 *buf++ = SPACEGLYPH;
845 nchars++;
847 else
849 /* This glyph has an entry in Vglyph_table,
850 so process any alias before testing for simpleness. */
851 GLYPH_FOLLOW_ALIASES (tbase, tlen, g);
853 if (GLYPH_SIMPLE_P (tbase, tlen, g))
855 int c = FAST_GLYPH_CHAR (g);
857 if (CHAR_VALID_P (c, 0))
858 buf += CHAR_STRING (c, buf);
859 else
860 *buf++ = SPACEGLYPH;
861 nchars++;
863 else
865 /* We have a string in Vglyph_table. */
866 Lisp_Object string;
868 string = tbase[g];
869 if (! STRING_MULTIBYTE (string))
870 string = string_to_multibyte (string);
871 nbytes = buf - encode_terminal_buf;
872 if (encode_terminal_bufsize < nbytes + SBYTES (string))
874 encode_terminal_bufsize = nbytes + SBYTES (string);
875 encode_terminal_buf = xrealloc (encode_terminal_buf,
876 encode_terminal_bufsize);
877 buf = encode_terminal_buf + nbytes;
879 bcopy (SDATA (string), buf, SBYTES (string));
880 buf += SBYTES (string);
881 nchars += SCHARS (string);
885 src++;
888 nbytes = buf - encode_terminal_buf;
889 coding->src_multibyte = 1;
890 coding->dst_multibyte = 0;
891 if (SYMBOLP (coding->pre_write_conversion)
892 && ! NILP (Ffboundp (coding->pre_write_conversion)))
894 run_pre_write_conversin_on_c_str (&encode_terminal_buf,
895 &encode_terminal_bufsize,
896 nchars, nbytes, coding);
897 nchars = coding->produced_char;
898 nbytes = coding->produced;
900 required = nbytes + encoding_buffer_size (coding, nbytes);
901 if (encode_terminal_bufsize < required)
903 encode_terminal_bufsize = required;
904 encode_terminal_buf = xrealloc (encode_terminal_buf, required);
907 encode_coding (coding, encode_terminal_buf, encode_terminal_buf + nbytes,
908 nbytes, encode_terminal_bufsize - nbytes);
909 return encode_terminal_buf + nbytes;
912 void
913 write_glyphs (string, len)
914 register struct glyph *string;
915 register int len;
917 struct frame *sf = XFRAME (selected_frame);
918 struct frame *f = updating_frame ? updating_frame : sf;
919 unsigned char *conversion_buffer;
920 struct coding_system *coding;
922 if (write_glyphs_hook
923 && ! FRAME_TERMCAP_P (f))
925 (*write_glyphs_hook) (string, len);
926 return;
929 turn_off_insert ();
930 tty_hide_cursor ();
932 /* Don't dare write in last column of bottom line, if Auto-Wrap,
933 since that would scroll the whole frame on some terminals. */
935 if (AutoWrap
936 && curY + 1 == FRAME_LINES (sf)
937 && (curX + len) == FRAME_COLS (sf))
938 len --;
939 if (len <= 0)
940 return;
942 cmplus (len);
944 /* If terminal_coding does any conversion, use it, otherwise use
945 safe_terminal_coding. We can't use CODING_REQUIRE_ENCODING here
946 because it always return 1 if the member src_multibyte is 1. */
947 coding = (terminal_coding.common_flags & CODING_REQUIRE_ENCODING_MASK
948 ? &terminal_coding : &safe_terminal_coding);
949 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
950 the tail. */
951 coding->mode &= ~CODING_MODE_LAST_BLOCK;
953 while (len > 0)
955 /* Identify a run of glyphs with the same face. */
956 int face_id = string->face_id;
957 int n;
959 for (n = 1; n < len; ++n)
960 if (string[n].face_id != face_id)
961 break;
963 /* Turn appearance modes of the face of the run on. */
964 highlight_if_desired ();
965 turn_on_face (f, face_id);
967 if (n == len)
968 /* This is the last run. */
969 coding->mode |= CODING_MODE_LAST_BLOCK;
970 conversion_buffer = encode_terminal_code (string, n, coding);
971 if (coding->produced > 0)
973 fwrite (conversion_buffer, 1, coding->produced, stdout);
974 if (ferror (stdout))
975 clearerr (stdout);
976 if (termscript)
977 fwrite (conversion_buffer, 1, coding->produced, termscript);
979 len -= n;
980 string += n;
982 /* Turn appearance modes off. */
983 turn_off_face (f, face_id);
984 turn_off_highlight ();
987 cmcheckmagic ();
990 /* If start is zero, insert blanks instead of a string at start */
992 void
993 insert_glyphs (start, len)
994 register struct glyph *start;
995 register int len;
997 char *buf;
998 struct glyph *glyph = NULL;
999 struct frame *f, *sf;
1000 unsigned char *conversion_buffer;
1001 unsigned char space[1];
1002 struct coding_system *coding;
1004 if (len <= 0)
1005 return;
1007 if (insert_glyphs_hook)
1009 (*insert_glyphs_hook) (start, len);
1010 return;
1013 sf = XFRAME (selected_frame);
1014 f = updating_frame ? updating_frame : sf;
1016 if (TS_ins_multi_chars)
1018 buf = tparam (TS_ins_multi_chars, 0, 0, len);
1019 OUTPUT1 (buf);
1020 xfree (buf);
1021 if (start)
1022 write_glyphs (start, len);
1023 return;
1026 turn_on_insert ();
1027 cmplus (len);
1029 if (! start)
1030 space[0] = SPACEGLYPH;
1032 /* If terminal_coding does any conversion, use it, otherwise use
1033 safe_terminal_coding. We can't use CODING_REQUIRE_ENCODING here
1034 because it always return 1 if the member src_multibyte is 1. */
1035 coding = (terminal_coding.common_flags & CODING_REQUIRE_ENCODING_MASK
1036 ? &terminal_coding : &safe_terminal_coding);
1037 /* The mode bit CODING_MODE_LAST_BLOCK should be set to 1 only at
1038 the tail. */
1039 coding->mode &= ~CODING_MODE_LAST_BLOCK;
1041 while (len-- > 0)
1043 OUTPUT1_IF (TS_ins_char);
1044 if (!start)
1046 conversion_buffer = space;
1047 coding->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 coding->mode |= CODING_MODE_LAST_BLOCK;
1067 conversion_buffer = encode_terminal_code (glyph, 1, coding);
1070 if (coding->produced > 0)
1072 fwrite (conversion_buffer, 1, coding->produced, stdout);
1073 if (ferror (stdout))
1074 clearerr (stdout);
1075 if (termscript)
1076 fwrite (conversion_buffer, 1, coding->produced, termscript);
1079 OUTPUT1_IF (TS_pad_inserted_char);
1080 if (start)
1082 turn_off_face (f, glyph->face_id);
1083 turn_off_highlight ();
1087 cmcheckmagic ();
1090 void
1091 delete_glyphs (n)
1092 register int n;
1094 char *buf;
1095 register int i;
1097 if (delete_glyphs_hook && ! FRAME_TERMCAP_P (updating_frame))
1099 (*delete_glyphs_hook) (n);
1100 return;
1103 if (delete_in_insert_mode)
1105 turn_on_insert ();
1107 else
1109 turn_off_insert ();
1110 OUTPUT_IF (TS_delete_mode);
1113 if (TS_del_multi_chars)
1115 buf = tparam (TS_del_multi_chars, 0, 0, n);
1116 OUTPUT1 (buf);
1117 xfree (buf);
1119 else
1120 for (i = 0; i < n; i++)
1121 OUTPUT1 (TS_del_char);
1122 if (!delete_in_insert_mode)
1123 OUTPUT_IF (TS_end_delete_mode);
1126 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
1128 void
1129 ins_del_lines (vpos, n)
1130 int vpos, n;
1132 char *multi = n > 0 ? TS_ins_multi_lines : TS_del_multi_lines;
1133 char *single = n > 0 ? TS_ins_line : TS_del_line;
1134 char *scroll = n > 0 ? TS_rev_scroll : TS_fwd_scroll;
1135 struct frame *sf;
1137 register int i = n > 0 ? n : -n;
1138 register char *buf;
1140 if (ins_del_lines_hook && ! FRAME_TERMCAP_P (updating_frame))
1142 (*ins_del_lines_hook) (vpos, n);
1143 return;
1146 sf = XFRAME (selected_frame);
1148 /* If the lines below the insertion are being pushed
1149 into the end of the window, this is the same as clearing;
1150 and we know the lines are already clear, since the matching
1151 deletion has already been done. So can ignore this. */
1152 /* If the lines below the deletion are blank lines coming
1153 out of the end of the window, don't bother,
1154 as there will be a matching inslines later that will flush them. */
1155 if (scroll_region_ok && vpos + i >= specified_window)
1156 return;
1157 if (!memory_below_frame && vpos + i >= FRAME_LINES (sf))
1158 return;
1160 if (multi)
1162 raw_cursor_to (vpos, 0);
1163 background_highlight ();
1164 buf = tparam (multi, 0, 0, i);
1165 OUTPUT (buf);
1166 xfree (buf);
1168 else if (single)
1170 raw_cursor_to (vpos, 0);
1171 background_highlight ();
1172 while (--i >= 0)
1173 OUTPUT (single);
1174 if (TF_teleray)
1175 curX = 0;
1177 else
1179 set_scroll_region (vpos, specified_window);
1180 if (n < 0)
1181 raw_cursor_to (specified_window - 1, 0);
1182 else
1183 raw_cursor_to (vpos, 0);
1184 background_highlight ();
1185 while (--i >= 0)
1186 OUTPUTL (scroll, specified_window - vpos);
1187 set_scroll_region (0, specified_window);
1190 if (!scroll_region_ok && memory_below_frame && n < 0)
1192 cursor_to (FRAME_LINES (sf) + n, 0);
1193 clear_to_end ();
1197 /* Compute cost of sending "str", in characters,
1198 not counting any line-dependent padding. */
1201 string_cost (str)
1202 char *str;
1204 cost = 0;
1205 if (str)
1206 tputs (str, 0, evalcost);
1207 return cost;
1210 /* Compute cost of sending "str", in characters,
1211 counting any line-dependent padding at one line. */
1213 static int
1214 string_cost_one_line (str)
1215 char *str;
1217 cost = 0;
1218 if (str)
1219 tputs (str, 1, evalcost);
1220 return cost;
1223 /* Compute per line amount of line-dependent padding,
1224 in tenths of characters. */
1227 per_line_cost (str)
1228 register char *str;
1230 cost = 0;
1231 if (str)
1232 tputs (str, 0, evalcost);
1233 cost = - cost;
1234 if (str)
1235 tputs (str, 10, evalcost);
1236 return cost;
1239 #ifndef old
1240 /* char_ins_del_cost[n] is cost of inserting N characters.
1241 char_ins_del_cost[-n] is cost of deleting N characters.
1242 The length of this vector is based on max_frame_cols. */
1244 int *char_ins_del_vector;
1246 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_COLS ((f))])
1247 #endif
1249 /* ARGSUSED */
1250 static void
1251 calculate_ins_del_char_costs (frame)
1252 FRAME_PTR frame;
1254 int ins_startup_cost, del_startup_cost;
1255 int ins_cost_per_char, del_cost_per_char;
1256 register int i;
1257 register int *p;
1259 if (TS_ins_multi_chars)
1261 ins_cost_per_char = 0;
1262 ins_startup_cost = string_cost_one_line (TS_ins_multi_chars);
1264 else if (TS_ins_char || TS_pad_inserted_char
1265 || (TS_insert_mode && TS_end_insert_mode))
1267 ins_startup_cost = (30 * (string_cost (TS_insert_mode)
1268 + string_cost (TS_end_insert_mode))) / 100;
1269 ins_cost_per_char = (string_cost_one_line (TS_ins_char)
1270 + string_cost_one_line (TS_pad_inserted_char));
1272 else
1274 ins_startup_cost = 9999;
1275 ins_cost_per_char = 0;
1278 if (TS_del_multi_chars)
1280 del_cost_per_char = 0;
1281 del_startup_cost = string_cost_one_line (TS_del_multi_chars);
1283 else if (TS_del_char)
1285 del_startup_cost = (string_cost (TS_delete_mode)
1286 + string_cost (TS_end_delete_mode));
1287 if (delete_in_insert_mode)
1288 del_startup_cost /= 2;
1289 del_cost_per_char = string_cost_one_line (TS_del_char);
1291 else
1293 del_startup_cost = 9999;
1294 del_cost_per_char = 0;
1297 /* Delete costs are at negative offsets */
1298 p = &char_ins_del_cost (frame)[0];
1299 for (i = FRAME_COLS (frame); --i >= 0;)
1300 *--p = (del_startup_cost += del_cost_per_char);
1302 /* Doing nothing is free */
1303 p = &char_ins_del_cost (frame)[0];
1304 *p++ = 0;
1306 /* Insert costs are at positive offsets */
1307 for (i = FRAME_COLS (frame); --i >= 0;)
1308 *p++ = (ins_startup_cost += ins_cost_per_char);
1311 void
1312 calculate_costs (frame)
1313 FRAME_PTR frame;
1315 register char *f = (TS_set_scroll_region
1316 ? TS_set_scroll_region
1317 : TS_set_scroll_region_1);
1319 FRAME_COST_BAUD_RATE (frame) = baud_rate;
1321 scroll_region_cost = string_cost (f);
1323 /* These variables are only used for terminal stuff. They are allocated
1324 once for the terminal frame of X-windows emacs, but not used afterwards.
1326 char_ins_del_vector (i.e., char_ins_del_cost) isn't used because
1327 X turns off char_ins_del_ok. */
1329 max_frame_lines = max (max_frame_lines, FRAME_LINES (frame));
1330 max_frame_cols = max (max_frame_cols, FRAME_COLS (frame));
1332 costs_set = 1;
1334 if (char_ins_del_vector != 0)
1335 char_ins_del_vector
1336 = (int *) xrealloc (char_ins_del_vector,
1337 (sizeof (int)
1338 + 2 * max_frame_cols * sizeof (int)));
1339 else
1340 char_ins_del_vector
1341 = (int *) xmalloc (sizeof (int)
1342 + 2 * max_frame_cols * sizeof (int));
1344 bzero (char_ins_del_vector, (sizeof (int)
1345 + 2 * max_frame_cols * sizeof (int)));
1347 if (f && (!TS_ins_line && !TS_del_line))
1348 do_line_insertion_deletion_costs (frame,
1349 TS_rev_scroll, TS_ins_multi_lines,
1350 TS_fwd_scroll, TS_del_multi_lines,
1351 f, f, 1);
1352 else
1353 do_line_insertion_deletion_costs (frame,
1354 TS_ins_line, TS_ins_multi_lines,
1355 TS_del_line, TS_del_multi_lines,
1356 0, 0, 1);
1358 calculate_ins_del_char_costs (frame);
1360 /* Don't use TS_repeat if its padding is worse than sending the chars */
1361 if (TS_repeat && per_line_cost (TS_repeat) * baud_rate < 9000)
1362 RPov = string_cost (TS_repeat);
1363 else
1364 RPov = FRAME_COLS (frame) * 2;
1366 cmcostinit (); /* set up cursor motion costs */
1369 struct fkey_table {
1370 char *cap, *name;
1373 /* Termcap capability names that correspond directly to X keysyms.
1374 Some of these (marked "terminfo") aren't supplied by old-style
1375 (Berkeley) termcap entries. They're listed in X keysym order;
1376 except we put the keypad keys first, so that if they clash with
1377 other keys (as on the IBM PC keyboard) they get overridden.
1380 static struct fkey_table keys[] =
1382 {"kh", "home"}, /* termcap */
1383 {"kl", "left"}, /* termcap */
1384 {"ku", "up"}, /* termcap */
1385 {"kr", "right"}, /* termcap */
1386 {"kd", "down"}, /* termcap */
1387 {"%8", "prior"}, /* terminfo */
1388 {"%5", "next"}, /* terminfo */
1389 {"@7", "end"}, /* terminfo */
1390 {"@1", "begin"}, /* terminfo */
1391 {"*6", "select"}, /* terminfo */
1392 {"%9", "print"}, /* terminfo */
1393 {"@4", "execute"}, /* terminfo --- actually the `command' key */
1395 * "insert" --- see below
1397 {"&8", "undo"}, /* terminfo */
1398 {"%0", "redo"}, /* terminfo */
1399 {"%7", "menu"}, /* terminfo --- actually the `options' key */
1400 {"@0", "find"}, /* terminfo */
1401 {"@2", "cancel"}, /* terminfo */
1402 {"%1", "help"}, /* terminfo */
1404 * "break" goes here, but can't be reliably intercepted with termcap
1406 {"&4", "reset"}, /* terminfo --- actually `restart' */
1408 * "system" and "user" --- no termcaps
1410 {"kE", "clearline"}, /* terminfo */
1411 {"kA", "insertline"}, /* terminfo */
1412 {"kL", "deleteline"}, /* terminfo */
1413 {"kI", "insertchar"}, /* terminfo */
1414 {"kD", "deletechar"}, /* terminfo */
1415 {"kB", "backtab"}, /* terminfo */
1417 * "kp_backtab", "kp-space", "kp-tab" --- no termcaps
1419 {"@8", "kp-enter"}, /* terminfo */
1421 * "kp-f1", "kp-f2", "kp-f3" "kp-f4",
1422 * "kp-multiply", "kp-add", "kp-separator",
1423 * "kp-subtract", "kp-decimal", "kp-divide", "kp-0";
1424 * --- no termcaps for any of these.
1426 {"K4", "kp-1"}, /* terminfo */
1428 * "kp-2" --- no termcap
1430 {"K5", "kp-3"}, /* terminfo */
1432 * "kp-4" --- no termcap
1434 {"K2", "kp-5"}, /* terminfo */
1436 * "kp-6" --- no termcap
1438 {"K1", "kp-7"}, /* terminfo */
1440 * "kp-8" --- no termcap
1442 {"K3", "kp-9"}, /* terminfo */
1444 * "kp-equal" --- no termcap
1446 {"k1", "f1"},
1447 {"k2", "f2"},
1448 {"k3", "f3"},
1449 {"k4", "f4"},
1450 {"k5", "f5"},
1451 {"k6", "f6"},
1452 {"k7", "f7"},
1453 {"k8", "f8"},
1454 {"k9", "f9"}
1457 static char **term_get_fkeys_arg;
1458 static Lisp_Object term_get_fkeys_1 ();
1460 /* Find the escape codes sent by the function keys for Vfunction_key_map.
1461 This function scans the termcap function key sequence entries, and
1462 adds entries to Vfunction_key_map for each function key it finds. */
1464 void
1465 term_get_fkeys (address)
1466 char **address;
1468 /* We run the body of the function (term_get_fkeys_1) and ignore all Lisp
1469 errors during the call. The only errors should be from Fdefine_key
1470 when given a key sequence containing an invalid prefix key. If the
1471 termcap defines function keys which use a prefix that is already bound
1472 to a command by the default bindings, we should silently ignore that
1473 function key specification, rather than giving the user an error and
1474 refusing to run at all on such a terminal. */
1476 extern Lisp_Object Fidentity ();
1477 term_get_fkeys_arg = address;
1478 internal_condition_case (term_get_fkeys_1, Qerror, Fidentity);
1481 static Lisp_Object
1482 term_get_fkeys_1 ()
1484 int i;
1486 char **address = term_get_fkeys_arg;
1488 /* This can happen if CANNOT_DUMP or with strange options. */
1489 if (!initialized)
1490 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
1492 for (i = 0; i < (sizeof (keys)/sizeof (keys[0])); i++)
1494 char *sequence = tgetstr (keys[i].cap, address);
1495 if (sequence)
1496 Fdefine_key (Vfunction_key_map, build_string (sequence),
1497 Fmake_vector (make_number (1),
1498 intern (keys[i].name)));
1501 /* The uses of the "k0" capability are inconsistent; sometimes it
1502 describes F10, whereas othertimes it describes F0 and "k;" describes F10.
1503 We will attempt to politely accommodate both systems by testing for
1504 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.
1507 char *k_semi = tgetstr ("k;", address);
1508 char *k0 = tgetstr ("k0", address);
1509 char *k0_name = "f10";
1511 if (k_semi)
1513 if (k0)
1514 /* Define f0 first, so that f10 takes precedence in case the
1515 key sequences happens to be the same. */
1516 Fdefine_key (Vfunction_key_map, build_string (k0),
1517 Fmake_vector (make_number (1), intern ("f0")));
1518 Fdefine_key (Vfunction_key_map, build_string (k_semi),
1519 Fmake_vector (make_number (1), intern ("f10")));
1521 else if (k0)
1522 Fdefine_key (Vfunction_key_map, build_string (k0),
1523 Fmake_vector (make_number (1), intern (k0_name)));
1526 /* Set up cookies for numbered function keys above f10. */
1528 char fcap[3], fkey[4];
1530 fcap[0] = 'F'; fcap[2] = '\0';
1531 for (i = 11; i < 64; i++)
1533 if (i <= 19)
1534 fcap[1] = '1' + i - 11;
1535 else if (i <= 45)
1536 fcap[1] = 'A' + i - 20;
1537 else
1538 fcap[1] = 'a' + i - 46;
1541 char *sequence = tgetstr (fcap, address);
1542 if (sequence)
1544 sprintf (fkey, "f%d", i);
1545 Fdefine_key (Vfunction_key_map, build_string (sequence),
1546 Fmake_vector (make_number (1),
1547 intern (fkey)));
1554 * Various mappings to try and get a better fit.
1557 #define CONDITIONAL_REASSIGN(cap1, cap2, sym) \
1558 if (!tgetstr (cap1, address)) \
1560 char *sequence = tgetstr (cap2, address); \
1561 if (sequence) \
1562 Fdefine_key (Vfunction_key_map, build_string (sequence), \
1563 Fmake_vector (make_number (1), \
1564 intern (sym))); \
1567 /* if there's no key_next keycap, map key_npage to `next' keysym */
1568 CONDITIONAL_REASSIGN ("%5", "kN", "next");
1569 /* if there's no key_prev keycap, map key_ppage to `previous' keysym */
1570 CONDITIONAL_REASSIGN ("%8", "kP", "prior");
1571 /* if there's no key_dc keycap, map key_ic to `insert' keysym */
1572 CONDITIONAL_REASSIGN ("kD", "kI", "insert");
1573 /* if there's no key_end keycap, map key_ll to 'end' keysym */
1574 CONDITIONAL_REASSIGN ("@7", "kH", "end");
1576 /* IBM has their own non-standard dialect of terminfo.
1577 If the standard name isn't found, try the IBM name. */
1578 CONDITIONAL_REASSIGN ("kB", "KO", "backtab");
1579 CONDITIONAL_REASSIGN ("@4", "kJ", "execute"); /* actually "action" */
1580 CONDITIONAL_REASSIGN ("@4", "kc", "execute"); /* actually "command" */
1581 CONDITIONAL_REASSIGN ("%7", "ki", "menu");
1582 CONDITIONAL_REASSIGN ("@7", "kw", "end");
1583 CONDITIONAL_REASSIGN ("F1", "k<", "f11");
1584 CONDITIONAL_REASSIGN ("F2", "k>", "f12");
1585 CONDITIONAL_REASSIGN ("%1", "kq", "help");
1586 CONDITIONAL_REASSIGN ("*6", "kU", "select");
1587 #undef CONDITIONAL_REASSIGN
1590 return Qnil;
1594 /***********************************************************************
1595 Character Display Information
1596 ***********************************************************************/
1598 static void append_glyph P_ ((struct it *));
1599 static void produce_stretch_glyph P_ ((struct it *));
1602 /* Append glyphs to IT's glyph_row. Called from produce_glyphs for
1603 terminal frames if IT->glyph_row != NULL. IT->c is the character
1604 for which to produce glyphs; IT->face_id contains the character's
1605 face. Padding glyphs are appended if IT->c has a IT->pixel_width >
1606 1. */
1608 static void
1609 append_glyph (it)
1610 struct it *it;
1612 struct glyph *glyph, *end;
1613 int i;
1615 xassert (it->glyph_row);
1616 glyph = (it->glyph_row->glyphs[it->area]
1617 + it->glyph_row->used[it->area]);
1618 end = it->glyph_row->glyphs[1 + it->area];
1620 for (i = 0;
1621 i < it->pixel_width && glyph < end;
1622 ++i)
1624 glyph->type = CHAR_GLYPH;
1625 glyph->pixel_width = 1;
1626 glyph->u.ch = it->c;
1627 glyph->face_id = it->face_id;
1628 glyph->padding_p = i > 0;
1629 glyph->charpos = CHARPOS (it->position);
1630 glyph->object = it->object;
1632 ++it->glyph_row->used[it->area];
1633 ++glyph;
1638 /* Produce glyphs for the display element described by IT. *IT
1639 specifies what we want to produce a glyph for (character, image, ...),
1640 and where in the glyph matrix we currently are (glyph row and hpos).
1641 produce_glyphs fills in output fields of *IT with information such as the
1642 pixel width and height of a character, and maybe output actual glyphs at
1643 the same time if IT->glyph_row is non-null. See the explanation of
1644 struct display_iterator in dispextern.h for an overview.
1646 produce_glyphs also stores the result of glyph width, ascent
1647 etc. computations in *IT.
1649 IT->glyph_row may be null, in which case produce_glyphs does not
1650 actually fill in the glyphs. This is used in the move_* functions
1651 in xdisp.c for text width and height computations.
1653 Callers usually don't call produce_glyphs directly;
1654 instead they use the macro PRODUCE_GLYPHS. */
1656 void
1657 produce_glyphs (it)
1658 struct it *it;
1660 /* If a hook is installed, let it do the work. */
1661 xassert (it->what == IT_CHARACTER
1662 || it->what == IT_COMPOSITION
1663 || it->what == IT_STRETCH);
1665 if (it->what == IT_STRETCH)
1667 produce_stretch_glyph (it);
1668 goto done;
1671 /* Nothing but characters are supported on terminal frames. For a
1672 composition sequence, it->c is the first character of the
1673 sequence. */
1674 xassert (it->what == IT_CHARACTER
1675 || it->what == IT_COMPOSITION);
1677 if (it->c >= 040 && it->c < 0177)
1679 it->pixel_width = it->nglyphs = 1;
1680 if (it->glyph_row)
1681 append_glyph (it);
1683 else if (it->c == '\n')
1684 it->pixel_width = it->nglyphs = 0;
1685 else if (it->c == '\t')
1687 int absolute_x = (it->current_x
1688 + it->continuation_lines_width);
1689 int next_tab_x
1690 = (((1 + absolute_x + it->tab_width - 1)
1691 / it->tab_width)
1692 * it->tab_width);
1693 int nspaces;
1695 /* If part of the TAB has been displayed on the previous line
1696 which is continued now, continuation_lines_width will have
1697 been incremented already by the part that fitted on the
1698 continued line. So, we will get the right number of spaces
1699 here. */
1700 nspaces = next_tab_x - absolute_x;
1702 if (it->glyph_row)
1704 int n = nspaces;
1706 it->c = ' ';
1707 it->pixel_width = it->len = 1;
1709 while (n--)
1710 append_glyph (it);
1712 it->c = '\t';
1715 it->pixel_width = nspaces;
1716 it->nglyphs = nspaces;
1718 else if (SINGLE_BYTE_CHAR_P (it->c))
1720 /* Coming here means that it->c is from display table, thus we
1721 must send the code as is to the terminal. Although there's
1722 no way to know how many columns it occupies on a screen, it
1723 is a good assumption that a single byte code has 1-column
1724 width. */
1725 it->pixel_width = it->nglyphs = 1;
1726 if (it->glyph_row)
1727 append_glyph (it);
1729 else
1731 /* A multi-byte character. The display width is fixed for all
1732 characters of the set. Some of the glyphs may have to be
1733 ignored because they are already displayed in a continued
1734 line. */
1735 int charset = CHAR_CHARSET (it->c);
1737 it->pixel_width = CHARSET_WIDTH (charset);
1738 it->nglyphs = it->pixel_width;
1740 if (it->glyph_row)
1741 append_glyph (it);
1744 done:
1745 /* Advance current_x by the pixel width as a convenience for
1746 the caller. */
1747 if (it->area == TEXT_AREA)
1748 it->current_x += it->pixel_width;
1749 it->ascent = it->max_ascent = it->phys_ascent = it->max_phys_ascent = 0;
1750 it->descent = it->max_descent = it->phys_descent = it->max_phys_descent = 1;
1754 /* Produce a stretch glyph for iterator IT. IT->object is the value
1755 of the glyph property displayed. The value must be a list
1756 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
1757 being recognized:
1759 1. `:width WIDTH' specifies that the space should be WIDTH *
1760 canonical char width wide. WIDTH may be an integer or floating
1761 point number.
1763 2. `:align-to HPOS' specifies that the space should be wide enough
1764 to reach HPOS, a value in canonical character units. */
1766 static void
1767 produce_stretch_glyph (it)
1768 struct it *it;
1770 /* (space :width WIDTH ...) */
1771 Lisp_Object prop, plist;
1772 int width = 0, align_to = -1;
1773 int zero_width_ok_p = 0;
1774 double tem;
1776 /* List should start with `space'. */
1777 xassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
1778 plist = XCDR (it->object);
1780 /* Compute the width of the stretch. */
1781 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
1782 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, 0))
1784 /* Absolute width `:width WIDTH' specified and valid. */
1785 zero_width_ok_p = 1;
1786 width = (int)(tem + 0.5);
1788 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
1789 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, &align_to))
1791 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
1792 align_to = (align_to < 0
1794 : align_to - window_box_left_offset (it->w, TEXT_AREA));
1795 else if (align_to < 0)
1796 align_to = window_box_left_offset (it->w, TEXT_AREA);
1797 width = max (0, (int)(tem + 0.5) + align_to - it->current_x);
1798 zero_width_ok_p = 1;
1800 else
1801 /* Nothing specified -> width defaults to canonical char width. */
1802 width = FRAME_COLUMN_WIDTH (it->f);
1804 if (width <= 0 && (width < 0 || !zero_width_ok_p))
1805 width = 1;
1807 if (width > 0 && it->glyph_row)
1809 Lisp_Object o_object = it->object;
1810 Lisp_Object object = it->stack[it->sp - 1].string;
1811 int n = width;
1812 int c = it->c;
1814 if (!STRINGP (object))
1815 object = it->w->buffer;
1816 it->object = object;
1817 it->c = ' ';
1818 it->pixel_width = it->len = 1;
1819 while (n--)
1820 append_glyph (it);
1821 it->object = o_object;
1822 it->c = c;
1824 it->pixel_width = width;
1825 it->nglyphs = width;
1829 /* Get information about special display element WHAT in an
1830 environment described by IT. WHAT is one of IT_TRUNCATION or
1831 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
1832 non-null glyph_row member. This function ensures that fields like
1833 face_id, c, len of IT are left untouched. */
1835 void
1836 produce_special_glyphs (it, what)
1837 struct it *it;
1838 enum display_element_type what;
1840 struct it temp_it;
1842 temp_it = *it;
1843 temp_it.dp = NULL;
1844 temp_it.what = IT_CHARACTER;
1845 temp_it.len = 1;
1846 temp_it.object = make_number (0);
1847 bzero (&temp_it.current, sizeof temp_it.current);
1849 if (what == IT_CONTINUATION)
1851 /* Continuation glyph. */
1852 if (it->dp
1853 && INTEGERP (DISP_CONTINUE_GLYPH (it->dp))
1854 && GLYPH_CHAR_VALID_P (XINT (DISP_CONTINUE_GLYPH (it->dp))))
1856 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_CONTINUE_GLYPH (it->dp)));
1857 temp_it.len = CHAR_BYTES (temp_it.c);
1859 else
1860 temp_it.c = '\\';
1862 produce_glyphs (&temp_it);
1863 it->pixel_width = temp_it.pixel_width;
1864 it->nglyphs = temp_it.pixel_width;
1866 else if (what == IT_TRUNCATION)
1868 /* Truncation glyph. */
1869 if (it->dp
1870 && INTEGERP (DISP_TRUNC_GLYPH (it->dp))
1871 && GLYPH_CHAR_VALID_P (XINT (DISP_TRUNC_GLYPH (it->dp))))
1873 temp_it.c = FAST_GLYPH_CHAR (XINT (DISP_TRUNC_GLYPH (it->dp)));
1874 temp_it.len = CHAR_BYTES (temp_it.c);
1876 else
1877 temp_it.c = '$';
1879 produce_glyphs (&temp_it);
1880 it->pixel_width = temp_it.pixel_width;
1881 it->nglyphs = temp_it.pixel_width;
1883 else
1884 abort ();
1889 /***********************************************************************
1890 Faces
1891 ***********************************************************************/
1893 /* Value is non-zero if attribute ATTR may be used. ATTR should be
1894 one of the enumerators from enum no_color_bit, or a bit set built
1895 from them. Some display attributes may not be used together with
1896 color; the termcap capability `NC' specifies which ones. */
1898 #define MAY_USE_WITH_COLORS_P(ATTR) \
1899 (TN_max_colors > 0 \
1900 ? (TN_no_color_video & (ATTR)) == 0 \
1901 : 1)
1903 /* Turn appearances of face FACE_ID on tty frame F on. */
1905 static void
1906 turn_on_face (f, face_id)
1907 struct frame *f;
1908 int face_id;
1910 struct face *face = FACE_FROM_ID (f, face_id);
1911 long fg = face->foreground;
1912 long bg = face->background;
1914 /* Do this first because TS_end_standout_mode may be the same
1915 as TS_exit_attribute_mode, which turns all appearances off. */
1916 if (MAY_USE_WITH_COLORS_P (NC_REVERSE))
1918 if (TN_max_colors > 0)
1920 if (fg >= 0 && bg >= 0)
1922 /* If the terminal supports colors, we can set them
1923 below without using reverse video. The face's fg
1924 and bg colors are set as they should appear on
1925 the screen, i.e. they take the inverse-video'ness
1926 of the face already into account. */
1928 else if (inverse_video)
1930 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1931 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1932 toggle_highlight ();
1934 else
1936 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1937 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1938 toggle_highlight ();
1941 else
1943 /* If we can't display colors, use reverse video
1944 if the face specifies that. */
1945 if (inverse_video)
1947 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1948 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1949 toggle_highlight ();
1951 else
1953 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1954 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1955 toggle_highlight ();
1960 if (face->tty_bold_p)
1962 if (MAY_USE_WITH_COLORS_P (NC_BOLD))
1963 OUTPUT1_IF (TS_enter_bold_mode);
1965 else if (face->tty_dim_p)
1966 if (MAY_USE_WITH_COLORS_P (NC_DIM))
1967 OUTPUT1_IF (TS_enter_dim_mode);
1969 /* Alternate charset and blinking not yet used. */
1970 if (face->tty_alt_charset_p
1971 && MAY_USE_WITH_COLORS_P (NC_ALT_CHARSET))
1972 OUTPUT1_IF (TS_enter_alt_charset_mode);
1974 if (face->tty_blinking_p
1975 && MAY_USE_WITH_COLORS_P (NC_BLINK))
1976 OUTPUT1_IF (TS_enter_blink_mode);
1978 if (face->tty_underline_p && MAY_USE_WITH_COLORS_P (NC_UNDERLINE))
1979 OUTPUT1_IF (TS_enter_underline_mode);
1981 if (TN_max_colors > 0)
1983 char *p;
1985 if (fg >= 0 && TS_set_foreground)
1987 p = tparam (TS_set_foreground, NULL, 0, (int) fg);
1988 OUTPUT (p);
1989 xfree (p);
1992 if (bg >= 0 && TS_set_background)
1994 p = tparam (TS_set_background, NULL, 0, (int) bg);
1995 OUTPUT (p);
1996 xfree (p);
2002 /* Turn off appearances of face FACE_ID on tty frame F. */
2004 static void
2005 turn_off_face (f, face_id)
2006 struct frame *f;
2007 int face_id;
2009 struct face *face = FACE_FROM_ID (f, face_id);
2011 xassert (face != NULL);
2013 if (TS_exit_attribute_mode)
2015 /* Capability "me" will turn off appearance modes double-bright,
2016 half-bright, reverse-video, standout, underline. It may or
2017 may not turn off alt-char-mode. */
2018 if (face->tty_bold_p
2019 || face->tty_dim_p
2020 || face->tty_reverse_p
2021 || face->tty_alt_charset_p
2022 || face->tty_blinking_p
2023 || face->tty_underline_p)
2025 OUTPUT1_IF (TS_exit_attribute_mode);
2026 if (strcmp (TS_exit_attribute_mode, TS_end_standout_mode) == 0)
2027 standout_mode = 0;
2030 if (face->tty_alt_charset_p)
2031 OUTPUT_IF (TS_exit_alt_charset_mode);
2033 else
2035 /* If we don't have "me" we can only have those appearances
2036 that have exit sequences defined. */
2037 if (face->tty_alt_charset_p)
2038 OUTPUT_IF (TS_exit_alt_charset_mode);
2040 if (face->tty_underline_p)
2041 OUTPUT_IF (TS_exit_underline_mode);
2044 /* Switch back to default colors. */
2045 if (TN_max_colors > 0
2046 && ((face->foreground != FACE_TTY_DEFAULT_COLOR
2047 && face->foreground != FACE_TTY_DEFAULT_FG_COLOR)
2048 || (face->background != FACE_TTY_DEFAULT_COLOR
2049 && face->background != FACE_TTY_DEFAULT_BG_COLOR)))
2050 OUTPUT1_IF (TS_orig_pair);
2054 /* Return non-zero if the terminal on frame F supports all of the
2055 capabilities in CAPS simultaneously, with foreground and background
2056 colors FG and BG. */
2059 tty_capable_p (f, caps, fg, bg)
2060 struct frame *f;
2061 unsigned caps;
2062 unsigned long fg, bg;
2064 #define TTY_CAPABLE_P_TRY(cap, TS, NC_bit) \
2065 if ((caps & (cap)) && (!(TS) || !MAY_USE_WITH_COLORS_P(NC_bit))) \
2066 return 0;
2068 TTY_CAPABLE_P_TRY (TTY_CAP_INVERSE, TS_standout_mode, NC_REVERSE);
2069 TTY_CAPABLE_P_TRY (TTY_CAP_UNDERLINE, TS_enter_underline_mode, NC_UNDERLINE);
2070 TTY_CAPABLE_P_TRY (TTY_CAP_BOLD, TS_enter_bold_mode, NC_BOLD);
2071 TTY_CAPABLE_P_TRY (TTY_CAP_DIM, TS_enter_dim_mode, NC_DIM);
2072 TTY_CAPABLE_P_TRY (TTY_CAP_BLINK, TS_enter_blink_mode, NC_BLINK);
2073 TTY_CAPABLE_P_TRY (TTY_CAP_ALT_CHARSET, TS_enter_alt_charset_mode, NC_ALT_CHARSET);
2075 /* We can do it! */
2076 return 1;
2080 /* Return non-zero if the terminal is capable to display colors. */
2082 DEFUN ("tty-display-color-p", Ftty_display_color_p, Stty_display_color_p,
2083 0, 1, 0,
2084 doc: /* Return non-nil if TTY can display colors on DISPLAY. */)
2085 (display)
2086 Lisp_Object display;
2088 return TN_max_colors > 0 ? Qt : Qnil;
2091 /* Return the number of supported colors. */
2092 DEFUN ("tty-display-color-cells", Ftty_display_color_cells,
2093 Stty_display_color_cells, 0, 1, 0,
2094 doc: /* Return the number of colors supported by TTY on DISPLAY. */)
2095 (display)
2096 Lisp_Object display;
2098 return make_number (TN_max_colors);
2101 #ifndef WINDOWSNT
2103 /* Save or restore the default color-related capabilities of this
2104 terminal. */
2105 static void
2106 tty_default_color_capabilities (save)
2107 int save;
2109 static char
2110 *default_orig_pair, *default_set_foreground, *default_set_background;
2111 static int default_max_colors, default_max_pairs, default_no_color_video;
2113 if (save)
2115 if (default_orig_pair)
2116 xfree (default_orig_pair);
2117 default_orig_pair = TS_orig_pair ? xstrdup (TS_orig_pair) : NULL;
2119 if (default_set_foreground)
2120 xfree (default_set_foreground);
2121 default_set_foreground = TS_set_foreground ? xstrdup (TS_set_foreground)
2122 : NULL;
2124 if (default_set_background)
2125 xfree (default_set_background);
2126 default_set_background = TS_set_background ? xstrdup (TS_set_background)
2127 : NULL;
2129 default_max_colors = TN_max_colors;
2130 default_max_pairs = TN_max_pairs;
2131 default_no_color_video = TN_no_color_video;
2133 else
2135 TS_orig_pair = default_orig_pair;
2136 TS_set_foreground = default_set_foreground;
2137 TS_set_background = default_set_background;
2138 TN_max_colors = default_max_colors;
2139 TN_max_pairs = default_max_pairs;
2140 TN_no_color_video = default_no_color_video;
2144 /* Setup one of the standard tty color schemes according to MODE.
2145 MODE's value is generally the number of colors which we want to
2146 support; zero means set up for the default capabilities, the ones
2147 we saw at term_init time; -1 means turn off color support. */
2148 void
2149 tty_setup_colors (mode)
2150 int mode;
2152 /* Canonicalize all negative values of MODE. */
2153 if (mode < -1)
2154 mode = -1;
2156 switch (mode)
2158 case -1: /* no colors at all */
2159 TN_max_colors = 0;
2160 TN_max_pairs = 0;
2161 TN_no_color_video = 0;
2162 TS_set_foreground = TS_set_background = TS_orig_pair = NULL;
2163 break;
2164 case 0: /* default colors, if any */
2165 default:
2166 tty_default_color_capabilities (0);
2167 break;
2168 case 8: /* 8 standard ANSI colors */
2169 TS_orig_pair = "\033[0m";
2170 #ifdef TERMINFO
2171 TS_set_foreground = "\033[3%p1%dm";
2172 TS_set_background = "\033[4%p1%dm";
2173 #else
2174 TS_set_foreground = "\033[3%dm";
2175 TS_set_background = "\033[4%dm";
2176 #endif
2177 TN_max_colors = 8;
2178 TN_max_pairs = 64;
2179 TN_no_color_video = 0;
2180 break;
2184 void
2185 set_tty_color_mode (f, val)
2186 struct frame *f;
2187 Lisp_Object val;
2189 Lisp_Object color_mode_spec, current_mode_spec;
2190 Lisp_Object color_mode, current_mode;
2191 int mode, old_mode;
2192 extern Lisp_Object Qtty_color_mode;
2193 Lisp_Object tty_color_mode_alist;
2195 tty_color_mode_alist = Fintern_soft (build_string ("tty-color-mode-alist"),
2196 Qnil);
2198 if (INTEGERP (val))
2199 color_mode = val;
2200 else
2202 if (NILP (tty_color_mode_alist))
2203 color_mode_spec = Qnil;
2204 else
2205 color_mode_spec = Fassq (val, XSYMBOL (tty_color_mode_alist)->value);
2207 if (CONSP (color_mode_spec))
2208 color_mode = XCDR (color_mode_spec);
2209 else
2210 color_mode = Qnil;
2213 current_mode_spec = assq_no_quit (Qtty_color_mode, f->param_alist);
2215 if (CONSP (current_mode_spec))
2216 current_mode = XCDR (current_mode_spec);
2217 else
2218 current_mode = Qnil;
2219 if (INTEGERP (color_mode))
2220 mode = XINT (color_mode);
2221 else
2222 mode = 0; /* meaning default */
2223 if (INTEGERP (current_mode))
2224 old_mode = XINT (current_mode);
2225 else
2226 old_mode = 0;
2228 if (mode != old_mode)
2230 tty_setup_colors (mode);
2231 /* This recomputes all the faces given the new color
2232 definitions. */
2233 call0 (intern ("tty-set-up-initial-frame-faces"));
2234 redraw_frame (f);
2238 #endif /* !WINDOWSNT */
2241 /***********************************************************************
2242 Initialization
2243 ***********************************************************************/
2245 void
2246 term_init (terminal_type)
2247 char *terminal_type;
2249 char *area;
2250 char **address = &area;
2251 char *buffer = NULL;
2252 int buffer_size = 4096;
2253 register char *p;
2254 int status;
2255 struct frame *sf = XFRAME (selected_frame);
2257 encode_terminal_bufsize = 0;
2259 #ifdef WINDOWSNT
2260 initialize_w32_display ();
2262 Wcm_clear ();
2264 area = (char *) xmalloc (2044);
2266 FrameRows = FRAME_LINES (sf);
2267 FrameCols = FRAME_COLS (sf);
2268 specified_window = FRAME_LINES (sf);
2270 delete_in_insert_mode = 1;
2272 UseTabs = 0;
2273 scroll_region_ok = 0;
2275 /* Seems to insert lines when it's not supposed to, messing
2276 up the display. In doing a trace, it didn't seem to be
2277 called much, so I don't think we're losing anything by
2278 turning it off. */
2280 line_ins_del_ok = 0;
2281 char_ins_del_ok = 1;
2283 baud_rate = 19200;
2285 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2286 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2287 TN_max_colors = 16; /* Required to be non-zero for tty-display-color-p */
2289 return;
2290 #else /* not WINDOWSNT */
2292 Wcm_clear ();
2294 buffer = (char *) xmalloc (buffer_size);
2295 status = tgetent (buffer, terminal_type);
2296 if (status < 0)
2298 #ifdef TERMINFO
2299 fatal ("Cannot open terminfo database file");
2300 #else
2301 fatal ("Cannot open termcap database file");
2302 #endif
2304 if (status == 0)
2306 #ifdef TERMINFO
2307 fatal ("Terminal type %s is not defined.\n\
2308 If that is not the actual type of terminal you have,\n\
2309 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2310 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2311 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2312 terminal_type);
2313 #else
2314 fatal ("Terminal type %s is not defined.\n\
2315 If that is not the actual type of terminal you have,\n\
2316 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2317 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2318 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2319 terminal_type);
2320 #endif
2323 #ifndef TERMINFO
2324 if (strlen (buffer) >= buffer_size)
2325 abort ();
2326 buffer_size = strlen (buffer);
2327 #endif
2328 area = (char *) xmalloc (buffer_size);
2330 TS_ins_line = tgetstr ("al", address);
2331 TS_ins_multi_lines = tgetstr ("AL", address);
2332 TS_bell = tgetstr ("bl", address);
2333 BackTab = tgetstr ("bt", address);
2334 TS_clr_to_bottom = tgetstr ("cd", address);
2335 TS_clr_line = tgetstr ("ce", address);
2336 TS_clr_frame = tgetstr ("cl", address);
2337 ColPosition = NULL; /* tgetstr ("ch", address); */
2338 AbsPosition = tgetstr ("cm", address);
2339 CR = tgetstr ("cr", address);
2340 TS_set_scroll_region = tgetstr ("cs", address);
2341 TS_set_scroll_region_1 = tgetstr ("cS", address);
2342 RowPosition = tgetstr ("cv", address);
2343 TS_del_char = tgetstr ("dc", address);
2344 TS_del_multi_chars = tgetstr ("DC", address);
2345 TS_del_line = tgetstr ("dl", address);
2346 TS_del_multi_lines = tgetstr ("DL", address);
2347 TS_delete_mode = tgetstr ("dm", address);
2348 TS_end_delete_mode = tgetstr ("ed", address);
2349 TS_end_insert_mode = tgetstr ("ei", address);
2350 Home = tgetstr ("ho", address);
2351 TS_ins_char = tgetstr ("ic", address);
2352 TS_ins_multi_chars = tgetstr ("IC", address);
2353 TS_insert_mode = tgetstr ("im", address);
2354 TS_pad_inserted_char = tgetstr ("ip", address);
2355 TS_end_keypad_mode = tgetstr ("ke", address);
2356 TS_keypad_mode = tgetstr ("ks", address);
2357 LastLine = tgetstr ("ll", address);
2358 Right = tgetstr ("nd", address);
2359 Down = tgetstr ("do", address);
2360 if (!Down)
2361 Down = tgetstr ("nl", address); /* Obsolete name for "do" */
2362 #ifdef VMS
2363 /* VMS puts a carriage return before each linefeed,
2364 so it is not safe to use linefeeds. */
2365 if (Down && Down[0] == '\n' && Down[1] == '\0')
2366 Down = 0;
2367 #endif /* VMS */
2368 if (tgetflag ("bs"))
2369 Left = "\b"; /* can't possibly be longer! */
2370 else /* (Actually, "bs" is obsolete...) */
2371 Left = tgetstr ("le", address);
2372 if (!Left)
2373 Left = tgetstr ("bc", address); /* Obsolete name for "le" */
2374 TS_pad_char = tgetstr ("pc", address);
2375 TS_repeat = tgetstr ("rp", address);
2376 TS_end_standout_mode = tgetstr ("se", address);
2377 TS_fwd_scroll = tgetstr ("sf", address);
2378 TS_standout_mode = tgetstr ("so", address);
2379 TS_rev_scroll = tgetstr ("sr", address);
2380 Wcm.cm_tab = tgetstr ("ta", address);
2381 TS_end_termcap_modes = tgetstr ("te", address);
2382 TS_termcap_modes = tgetstr ("ti", address);
2383 Up = tgetstr ("up", address);
2384 TS_visible_bell = tgetstr ("vb", address);
2385 TS_cursor_normal = tgetstr ("ve", address);
2386 TS_cursor_visible = tgetstr ("vs", address);
2387 TS_cursor_invisible = tgetstr ("vi", address);
2388 TS_set_window = tgetstr ("wi", address);
2390 TS_enter_underline_mode = tgetstr ("us", address);
2391 TS_exit_underline_mode = tgetstr ("ue", address);
2392 TS_enter_bold_mode = tgetstr ("md", address);
2393 TS_enter_dim_mode = tgetstr ("mh", address);
2394 TS_enter_blink_mode = tgetstr ("mb", address);
2395 TS_enter_reverse_mode = tgetstr ("mr", address);
2396 TS_enter_alt_charset_mode = tgetstr ("as", address);
2397 TS_exit_alt_charset_mode = tgetstr ("ae", address);
2398 TS_exit_attribute_mode = tgetstr ("me", address);
2400 MultiUp = tgetstr ("UP", address);
2401 MultiDown = tgetstr ("DO", address);
2402 MultiLeft = tgetstr ("LE", address);
2403 MultiRight = tgetstr ("RI", address);
2405 /* SVr4/ANSI color suppert. If "op" isn't available, don't support
2406 color because we can't switch back to the default foreground and
2407 background. */
2408 TS_orig_pair = tgetstr ("op", address);
2409 if (TS_orig_pair)
2411 TS_set_foreground = tgetstr ("AF", address);
2412 TS_set_background = tgetstr ("AB", address);
2413 if (!TS_set_foreground)
2415 /* SVr4. */
2416 TS_set_foreground = tgetstr ("Sf", address);
2417 TS_set_background = tgetstr ("Sb", address);
2420 TN_max_colors = tgetnum ("Co");
2421 TN_max_pairs = tgetnum ("pa");
2423 TN_no_color_video = tgetnum ("NC");
2424 if (TN_no_color_video == -1)
2425 TN_no_color_video = 0;
2428 tty_default_color_capabilities (1);
2430 MagicWrap = tgetflag ("xn");
2431 /* Since we make MagicWrap terminals look like AutoWrap, we need to have
2432 the former flag imply the latter. */
2433 AutoWrap = MagicWrap || tgetflag ("am");
2434 memory_below_frame = tgetflag ("db");
2435 TF_hazeltine = tgetflag ("hz");
2436 must_write_spaces = tgetflag ("in");
2437 meta_key = tgetflag ("km") || tgetflag ("MT");
2438 TF_insmode_motion = tgetflag ("mi");
2439 TF_standout_motion = tgetflag ("ms");
2440 TF_underscore = tgetflag ("ul");
2441 TF_teleray = tgetflag ("xt");
2443 term_get_fkeys (address);
2445 /* Get frame size from system, or else from termcap. */
2447 int height, width;
2448 get_frame_size (&width, &height);
2449 FRAME_COLS (sf) = width;
2450 FRAME_LINES (sf) = height;
2453 if (FRAME_COLS (sf) <= 0)
2454 SET_FRAME_COLS (sf, tgetnum ("co"));
2455 else
2456 /* Keep width and external_width consistent */
2457 SET_FRAME_COLS (sf, FRAME_COLS (sf));
2458 if (FRAME_LINES (sf) <= 0)
2459 FRAME_LINES (sf) = tgetnum ("li");
2461 if (FRAME_LINES (sf) < 3 || FRAME_COLS (sf) < 3)
2462 fatal ("Screen size %dx%d is too small",
2463 FRAME_LINES (sf), FRAME_COLS (sf));
2465 min_padding_speed = tgetnum ("pb");
2466 TabWidth = tgetnum ("tw");
2468 #ifdef VMS
2469 /* These capabilities commonly use ^J.
2470 I don't know why, but sending them on VMS does not work;
2471 it causes following spaces to be lost, sometimes.
2472 For now, the simplest fix is to avoid using these capabilities ever. */
2473 if (Down && Down[0] == '\n')
2474 Down = 0;
2475 #endif /* VMS */
2477 if (!TS_bell)
2478 TS_bell = "\07";
2480 if (!TS_fwd_scroll)
2481 TS_fwd_scroll = Down;
2483 PC = TS_pad_char ? *TS_pad_char : 0;
2485 if (TabWidth < 0)
2486 TabWidth = 8;
2488 /* Turned off since /etc/termcap seems to have :ta= for most terminals
2489 and newer termcap doc does not seem to say there is a default.
2490 if (!Wcm.cm_tab)
2491 Wcm.cm_tab = "\t";
2494 /* We don't support standout modes that use `magic cookies', so
2495 turn off any that do. */
2496 if (TS_standout_mode && tgetnum ("sg") >= 0)
2498 TS_standout_mode = 0;
2499 TS_end_standout_mode = 0;
2501 if (TS_enter_underline_mode && tgetnum ("ug") >= 0)
2503 TS_enter_underline_mode = 0;
2504 TS_exit_underline_mode = 0;
2507 /* If there's no standout mode, try to use underlining instead. */
2508 if (TS_standout_mode == 0)
2510 TS_standout_mode = TS_enter_underline_mode;
2511 TS_end_standout_mode = TS_exit_underline_mode;
2514 /* If no `se' string, try using a `me' string instead.
2515 If that fails, we can't use standout mode at all. */
2516 if (TS_end_standout_mode == 0)
2518 char *s = tgetstr ("me", address);
2519 if (s != 0)
2520 TS_end_standout_mode = s;
2521 else
2522 TS_standout_mode = 0;
2525 if (TF_teleray)
2527 Wcm.cm_tab = 0;
2528 /* We can't support standout mode, because it uses magic cookies. */
2529 TS_standout_mode = 0;
2530 /* But that means we cannot rely on ^M to go to column zero! */
2531 CR = 0;
2532 /* LF can't be trusted either -- can alter hpos */
2533 /* if move at column 0 thru a line with TS_standout_mode */
2534 Down = 0;
2537 /* Special handling for certain terminal types known to need it */
2539 if (!strcmp (terminal_type, "supdup"))
2541 memory_below_frame = 1;
2542 Wcm.cm_losewrap = 1;
2544 if (!strncmp (terminal_type, "c10", 3)
2545 || !strcmp (terminal_type, "perq"))
2547 /* Supply a makeshift :wi string.
2548 This string is not valid in general since it works only
2549 for windows starting at the upper left corner;
2550 but that is all Emacs uses.
2552 This string works only if the frame is using
2553 the top of the video memory, because addressing is memory-relative.
2554 So first check the :ti string to see if that is true.
2556 It would be simpler if the :wi string could go in the termcap
2557 entry, but it can't because it is not fully valid.
2558 If it were in the termcap entry, it would confuse other programs. */
2559 if (!TS_set_window)
2561 p = TS_termcap_modes;
2562 while (*p && strcmp (p, "\033v "))
2563 p++;
2564 if (*p)
2565 TS_set_window = "\033v%C %C %C %C ";
2567 /* Termcap entry often fails to have :in: flag */
2568 must_write_spaces = 1;
2569 /* :ti string typically fails to have \E^G! in it */
2570 /* This limits scope of insert-char to one line. */
2571 strcpy (area, TS_termcap_modes);
2572 strcat (area, "\033\007!");
2573 TS_termcap_modes = area;
2574 area += strlen (area) + 1;
2575 p = AbsPosition;
2576 /* Change all %+ parameters to %C, to handle
2577 values above 96 correctly for the C100. */
2578 while (*p)
2580 if (p[0] == '%' && p[1] == '+')
2581 p[1] = 'C';
2582 p++;
2586 FrameRows = FRAME_LINES (sf);
2587 FrameCols = FRAME_COLS (sf);
2588 specified_window = FRAME_LINES (sf);
2590 if (Wcm_init () == -1) /* can't do cursor motion */
2591 #ifdef VMS
2592 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2593 It lacks the ability to position the cursor.\n\
2594 If that is not the actual type of terminal you have, use either the\n\
2595 DCL command `SET TERMINAL/DEVICE= ...' for DEC-compatible terminals,\n\
2596 or `define EMACS_TERM \"terminal type\"' for non-DEC terminals.",
2597 terminal_type);
2598 #else /* not VMS */
2599 # ifdef TERMINFO
2600 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2601 It lacks the ability to position the cursor.\n\
2602 If that is not the actual type of terminal you have,\n\
2603 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2604 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2605 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2606 terminal_type);
2607 # else /* TERMCAP */
2608 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2609 It lacks the ability to position the cursor.\n\
2610 If that is not the actual type of terminal you have,\n\
2611 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2612 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2613 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2614 terminal_type);
2615 # endif /* TERMINFO */
2616 #endif /*VMS */
2617 if (FRAME_LINES (sf) <= 0
2618 || FRAME_COLS (sf) <= 0)
2619 fatal ("The frame size has not been specified");
2621 delete_in_insert_mode
2622 = TS_delete_mode && TS_insert_mode
2623 && !strcmp (TS_delete_mode, TS_insert_mode);
2625 se_is_so = (TS_standout_mode
2626 && TS_end_standout_mode
2627 && !strcmp (TS_standout_mode, TS_end_standout_mode));
2629 UseTabs = tabs_safe_p () && TabWidth == 8;
2631 scroll_region_ok
2632 = (Wcm.cm_abs
2633 && (TS_set_window || TS_set_scroll_region || TS_set_scroll_region_1));
2635 line_ins_del_ok = (((TS_ins_line || TS_ins_multi_lines)
2636 && (TS_del_line || TS_del_multi_lines))
2637 || (scroll_region_ok && TS_fwd_scroll && TS_rev_scroll));
2639 char_ins_del_ok = ((TS_ins_char || TS_insert_mode
2640 || TS_pad_inserted_char || TS_ins_multi_chars)
2641 && (TS_del_char || TS_del_multi_chars));
2643 fast_clear_end_of_line = TS_clr_line != 0;
2645 init_baud_rate ();
2646 if (read_socket_hook) /* Baudrate is somewhat */
2647 /* meaningless in this case */
2648 baud_rate = 9600;
2650 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2651 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2652 #endif /* WINDOWSNT */
2654 xfree (buffer);
2657 /* VARARGS 1 */
2658 void
2659 fatal (str, arg1, arg2)
2660 char *str, *arg1, *arg2;
2662 fprintf (stderr, "emacs: ");
2663 fprintf (stderr, str, arg1, arg2);
2664 fprintf (stderr, "\n");
2665 fflush (stderr);
2666 exit (1);
2669 void
2670 syms_of_term ()
2672 DEFVAR_BOOL ("system-uses-terminfo", &system_uses_terminfo,
2673 doc: /* Non-nil means the system uses terminfo rather than termcap.
2674 This variable can be used by terminal emulator packages. */);
2675 #ifdef TERMINFO
2676 system_uses_terminfo = 1;
2677 #else
2678 system_uses_terminfo = 0;
2679 #endif
2681 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function,
2682 doc: /* Non-nil means call this function to ring the bell.
2683 The function should accept no arguments. */);
2684 Vring_bell_function = Qnil;
2686 defsubr (&Stty_display_color_p);
2687 defsubr (&Stty_display_color_cells);
2690 /* arch-tag: 498e7449-6f2e-45e2-91dd-b7d4ca488193
2691 (do not change this comment) */