]> code.delx.au - gnu-emacs/blob - src/term.c
(Fload, load_unwind): Use make_save_value to unwind
[gnu-emacs] / src / term.c
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.
4
5 This file is part of GNU Emacs.
6
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.
11
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.
16
17 You should have received a copy of the GNU General Public License
18 along with GNU Emacs; see the file COPYING. If not, write to
19 the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
20 Boston, MA 02110-1301, USA. */
21
22 /* New redisplay, TTY faces by Gerd Moellmann <gerd@gnu.org>. */
23
24 #include <config.h>
25 #include <stdio.h>
26 #include <ctype.h>
27 #include <string.h>
28
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"
41
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. */
45
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
54
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
62
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));
67
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)
72
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)
79
80 #define OUTPUT1_IF(a) do { if (a) tputs (a, 1, cmputc); } while (0)
81
82 /* Display space properties */
83
84 extern Lisp_Object Qspace, QCalign_to, QCwidth;
85
86 /* Function to use to ring the bell. */
87
88 Lisp_Object Vring_bell_function;
89
90 /* Terminal characteristics that higher levels want to look at.
91 These are all extern'd in termchar.h */
92
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 */
97
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 */
107
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. */
111
112 int no_redraw_on_reenter;
113
114 /* Hook functions that you can set to snap out the functions in this file.
115 These are all extern'd in termhooks.h */
116
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));
122
123 void (*ins_del_lines_hook) P_ ((int, int));
124
125 void (*delete_glyphs_hook) P_ ((int));
126
127 void (*ring_bell_hook) P_ ((void));
128
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));
137
138 int (*read_socket_hook) P_ ((int, int, struct input_event *));
139
140 void (*frame_up_to_date_hook) P_ ((struct frame *));
141
142 /* Return the current position of the mouse.
143
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.
147
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.
152
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.
155
156 Set *time to the time the mouse was at the returned position.
157
158 This should clear mouse_moved until the next motion
159 event arrives. */
160
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));
167
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. */
173
174 void (*frame_rehighlight_hook) P_ ((FRAME_PTR f));
175
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.
182
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. */
186
187 void (*frame_raise_lower_hook) P_ ((FRAME_PTR f, int raise));
188
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. */
194
195 void (*set_vertical_scroll_bar_hook)
196 P_ ((struct window *window,
197 int portion, int whole, int position));
198
199
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. */
207
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.
211
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.
216
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. */
220
221 void (*condemn_scroll_bars_hook) P_ ((FRAME_PTR frame));
222
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. */
225
226 void (*redeem_scroll_bar_hook) P_ ((struct window *window));
227
228 /* Remove all scroll bars on FRAME that haven't been saved since the
229 last call to `*condemn_scroll_bars_hook'.
230
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.
235
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. */
239
240 void (*judge_scroll_bars_hook) P_ ((FRAME_PTR FRAME));
241
242 /* Strings, numbers and flags taken from the termcap entry. */
243
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) */
282
283 /* Value of the "NC" (no_color_video) capability, or 0 if not
284 present. */
285
286 static int TN_no_color_video;
287
288 /* Meaning of bits in no_color_video. Each bit set means that the
289 corresponding attribute cannot be combined with colors. */
290
291 enum no_color_bit
292 {
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
302 };
303
304 /* "md" -- turn on bold (extra bright mode). */
305
306 char *TS_enter_bold_mode;
307
308 /* "mh" -- turn on half-bright mode. */
309
310 char *TS_enter_dim_mode;
311
312 /* "mb" -- enter blinking mode. */
313
314 char *TS_enter_blink_mode;
315
316 /* "mr" -- enter reverse video mode. */
317
318 char *TS_enter_reverse_mode;
319
320 /* "us"/"ue" -- start/end underlining. */
321
322 char *TS_exit_underline_mode, *TS_enter_underline_mode;
323
324 /* "as"/"ae" -- start/end alternate character set. Not really
325 supported, yet. */
326
327 char *TS_enter_alt_charset_mode, *TS_exit_alt_charset_mode;
328
329 /* "me" -- switch appearances off. */
330
331 char *TS_exit_attribute_mode;
332
333 /* "Co" -- number of colors. */
334
335 int TN_max_colors;
336
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. */
339
340 int TN_max_pairs;
341
342 /* "op" -- SVr4 set default pair to its original value. */
343
344 char *TS_orig_pair;
345
346 /* "AF"/"AB" or "Sf"/"Sb"-- set ANSI or SVr4 foreground/background color.
347 1 param, the color index. */
348
349 char *TS_set_foreground, *TS_set_background;
350
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. */
358
359 static int RPov; /* # chars to start a TS_repeat */
360
361 static int delete_in_insert_mode; /* delete mode == insert mode */
362
363 static int se_is_so; /* 1 if same string both enters and leaves
364 standout mode */
365
366 /* internal state */
367
368 /* The largest frame width in any call to calculate_costs. */
369
370 int max_frame_cols;
371
372 /* The largest frame height in any call to calculate_costs. */
373
374 int max_frame_lines;
375
376 static int costs_set; /* Nonzero if costs have been calculated. */
377
378 int insert_mode; /* Nonzero when in insert mode. */
379 int standout_mode; /* Nonzero when in standout mode. */
380
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.
384
385 Effectively it excludes the bottom frame_lines - specified_window_size
386 lines from those operations. */
387
388 int specified_window;
389
390 /* Frame currently being redisplayed; 0 if not currently redisplaying.
391 (Direct output does not count). */
392
393 FRAME_PTR updating_frame;
394
395 /* Provided for lisp packages. */
396
397 static int system_uses_terminfo;
398
399 /* Flag used in tty_show/hide_cursor. */
400
401 static int tty_cursor_hidden;
402
403 char *tparam ();
404
405 extern char *tgetstr ();
406 \f
407
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... */
414
415 #undef FRAME_TERMCAP_P
416 #define FRAME_TERMCAP_P(_f_) 0
417 #endif /* WINDOWSNT */
418
419 void
420 ring_bell ()
421 {
422 if (!NILP (Vring_bell_function))
423 {
424 Lisp_Object function;
425
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.
429
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. */
433
434 function = Vring_bell_function;
435 Vring_bell_function = Qnil;
436
437 call0 (function);
438
439 Vring_bell_function = function;
440 }
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);
445 }
446
447 void
448 set_terminal_modes ()
449 {
450 if (FRAME_TERMCAP_P (XFRAME (selected_frame)))
451 {
452 OUTPUT_IF (TS_termcap_modes);
453 OUTPUT_IF (TS_cursor_visible);
454 OUTPUT_IF (TS_keypad_mode);
455 losecursor ();
456 }
457 else
458 (*set_terminal_modes_hook) ();
459 }
460
461 void
462 reset_terminal_modes ()
463 {
464 if (FRAME_TERMCAP_P (XFRAME (selected_frame)))
465 {
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');
474 }
475 else if (reset_terminal_modes_hook)
476 (*reset_terminal_modes_hook) ();
477 }
478
479 void
480 update_begin (f)
481 struct frame *f;
482 {
483 updating_frame = f;
484 if (!FRAME_TERMCAP_P (f))
485 update_begin_hook (f);
486 }
487
488 void
489 update_end (f)
490 struct frame *f;
491 {
492 if (FRAME_TERMCAP_P (f))
493 {
494 if (!XWINDOW (selected_window)->cursor_off_p)
495 tty_show_cursor ();
496 turn_off_insert ();
497 background_highlight ();
498 }
499 else
500 update_end_hook (f);
501
502 updating_frame = NULL;
503 }
504
505 void
506 set_terminal_window (size)
507 int size;
508 {
509 if (FRAME_TERMCAP_P (updating_frame))
510 {
511 specified_window = size ? size : FRAME_LINES (updating_frame);
512 if (scroll_region_ok)
513 set_scroll_region (0, specified_window);
514 }
515 else
516 set_terminal_window_hook (size);
517 }
518
519 void
520 set_scroll_region (start, stop)
521 int start, stop;
522 {
523 char *buf;
524 struct frame *sf = XFRAME (selected_frame);
525
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));
535
536 OUTPUT (buf);
537 xfree (buf);
538 losecursor ();
539 }
540
541 \f
542 static void
543 turn_on_insert ()
544 {
545 if (!insert_mode)
546 OUTPUT (TS_insert_mode);
547 insert_mode = 1;
548 }
549
550 void
551 turn_off_insert ()
552 {
553 if (insert_mode)
554 OUTPUT (TS_end_insert_mode);
555 insert_mode = 0;
556 }
557 \f
558 /* Handle highlighting. */
559
560 void
561 turn_off_highlight ()
562 {
563 if (standout_mode)
564 OUTPUT_IF (TS_end_standout_mode);
565 standout_mode = 0;
566 }
567
568 static void
569 turn_on_highlight ()
570 {
571 if (!standout_mode)
572 OUTPUT_IF (TS_standout_mode);
573 standout_mode = 1;
574 }
575
576 static void
577 toggle_highlight ()
578 {
579 if (standout_mode)
580 turn_off_highlight ();
581 else
582 turn_on_highlight ();
583 }
584
585
586 /* Make cursor invisible. */
587
588 static void
589 tty_hide_cursor ()
590 {
591 if (tty_cursor_hidden == 0)
592 {
593 tty_cursor_hidden = 1;
594 OUTPUT_IF (TS_cursor_invisible);
595 }
596 }
597
598
599 /* Ensure that cursor is visible. */
600
601 static void
602 tty_show_cursor ()
603 {
604 if (tty_cursor_hidden)
605 {
606 tty_cursor_hidden = 0;
607 OUTPUT_IF (TS_cursor_normal);
608 OUTPUT_IF (TS_cursor_visible);
609 }
610 }
611
612
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. */
616
617 void
618 background_highlight ()
619 {
620 if (inverse_video)
621 turn_on_highlight ();
622 else
623 turn_off_highlight ();
624 }
625
626 /* Set standout mode to the mode specified for the text to be output. */
627
628 static void
629 highlight_if_desired ()
630 {
631 if (inverse_video)
632 turn_on_highlight ();
633 else
634 turn_off_highlight ();
635 }
636 \f
637
638 /* Move cursor to row/column position VPOS/HPOS. HPOS/VPOS are
639 frame-relative coordinates. */
640
641 void
642 cursor_to (vpos, hpos)
643 int vpos, hpos;
644 {
645 struct frame *f = updating_frame ? updating_frame : XFRAME (selected_frame);
646
647 if (! FRAME_TERMCAP_P (f) && cursor_to_hook)
648 {
649 (*cursor_to_hook) (vpos, hpos);
650 return;
651 }
652
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;
657
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);
665 }
666
667 /* Similar but don't take any account of the wasted characters. */
668
669 void
670 raw_cursor_to (row, col)
671 int row, col;
672 {
673 struct frame *f = updating_frame ? updating_frame : XFRAME (selected_frame);
674 if (! FRAME_TERMCAP_P (f))
675 {
676 (*raw_cursor_to_hook) (row, col);
677 return;
678 }
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);
686 }
687 \f
688 /* Erase operations */
689
690 /* clear from cursor to end of frame */
691 void
692 clear_to_end ()
693 {
694 register int i;
695
696 if (clear_to_end_hook && ! FRAME_TERMCAP_P (updating_frame))
697 {
698 (*clear_to_end_hook) ();
699 return;
700 }
701 if (TS_clr_to_bottom)
702 {
703 background_highlight ();
704 OUTPUT (TS_clr_to_bottom);
705 }
706 else
707 {
708 for (i = curY; i < FRAME_LINES (XFRAME (selected_frame)); i++)
709 {
710 cursor_to (i, 0);
711 clear_end_of_line (FRAME_COLS (XFRAME (selected_frame)));
712 }
713 }
714 }
715
716 /* Clear entire frame */
717
718 void
719 clear_frame ()
720 {
721 struct frame *sf = XFRAME (selected_frame);
722
723 if (clear_frame_hook
724 && ! FRAME_TERMCAP_P ((updating_frame ? updating_frame : sf)))
725 {
726 (*clear_frame_hook) ();
727 return;
728 }
729 if (TS_clr_frame)
730 {
731 background_highlight ();
732 OUTPUT (TS_clr_frame);
733 cmat (0, 0);
734 }
735 else
736 {
737 cursor_to (0, 0);
738 clear_to_end ();
739 }
740 }
741
742 /* Clear from cursor to end of line.
743 Assume that the line is already clear starting at column first_unused_hpos.
744
745 Note that the cursor may be moved, on terminals lacking a `ce' string. */
746
747 void
748 clear_end_of_line (first_unused_hpos)
749 int first_unused_hpos;
750 {
751 register int i;
752
753 if (clear_end_of_line_hook
754 && ! FRAME_TERMCAP_P ((updating_frame
755 ? updating_frame
756 : XFRAME (selected_frame))))
757 {
758 (*clear_end_of_line_hook) (first_unused_hpos);
759 return;
760 }
761
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;
766
767 if (curX >= first_unused_hpos)
768 return;
769 background_highlight ();
770 if (TS_clr_line)
771 {
772 OUTPUT1 (TS_clr_line);
773 }
774 else
775 { /* have to do it the hard way */
776 struct frame *sf = XFRAME (selected_frame);
777 turn_off_insert ();
778
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--;
783
784 for (i = curX; i < first_unused_hpos; i++)
785 {
786 if (termscript)
787 fputc (' ', termscript);
788 putchar (' ');
789 }
790 cmplus (first_unused_hpos - curX);
791 }
792 }
793 \f
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;
798
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. */
802
803 unsigned char *
804 encode_terminal_code (src, src_len, coding)
805 struct glyph *src;
806 int src_len;
807 struct coding_system *coding;
808 {
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;
815
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)
821 {
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;
827 }
828
829 buf = encode_terminal_buf;
830 nchars = 0;
831 while (src < src_end)
832 {
833 /* We must skip glyphs to be padded for a wide character. */
834 if (! CHAR_GLYPH_PADDING_P (*src))
835 {
836 g = GLYPH_FROM_CHAR_GLYPH (src[0]);
837
838 if (g < 0 || g >= tlen)
839 {
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++;
846 }
847 else
848 {
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);
852
853 if (GLYPH_SIMPLE_P (tbase, tlen, g))
854 {
855 int c = FAST_GLYPH_CHAR (g);
856
857 if (CHAR_VALID_P (c, 0))
858 buf += CHAR_STRING (c, buf);
859 else
860 *buf++ = SPACEGLYPH;
861 nchars++;
862 }
863 else
864 {
865 /* We have a string in Vglyph_table. */
866 Lisp_Object string;
867
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))
873 {
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;
878 }
879 bcopy (SDATA (string), buf, SBYTES (string));
880 buf += SBYTES (string);
881 nchars += SCHARS (string);
882 }
883 }
884 }
885 src++;
886 }
887
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)))
893 {
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;
899 }
900 required = nbytes + encoding_buffer_size (coding, nbytes);
901 if (encode_terminal_bufsize < required)
902 {
903 encode_terminal_bufsize = required;
904 encode_terminal_buf = xrealloc (encode_terminal_buf, required);
905 }
906
907 encode_coding (coding, encode_terminal_buf, encode_terminal_buf + nbytes,
908 nbytes, encode_terminal_bufsize - nbytes);
909 return encode_terminal_buf + nbytes;
910 }
911
912 void
913 write_glyphs (string, len)
914 register struct glyph *string;
915 register int len;
916 {
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;
921
922 if (write_glyphs_hook
923 && ! FRAME_TERMCAP_P (f))
924 {
925 (*write_glyphs_hook) (string, len);
926 return;
927 }
928
929 turn_off_insert ();
930 tty_hide_cursor ();
931
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. */
934
935 if (AutoWrap
936 && curY + 1 == FRAME_LINES (sf)
937 && (curX + len) == FRAME_COLS (sf))
938 len --;
939 if (len <= 0)
940 return;
941
942 cmplus (len);
943
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;
952
953 while (len > 0)
954 {
955 /* Identify a run of glyphs with the same face. */
956 int face_id = string->face_id;
957 int n;
958
959 for (n = 1; n < len; ++n)
960 if (string[n].face_id != face_id)
961 break;
962
963 /* Turn appearance modes of the face of the run on. */
964 highlight_if_desired ();
965 turn_on_face (f, face_id);
966
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)
972 {
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);
978 }
979 len -= n;
980 string += n;
981
982 /* Turn appearance modes off. */
983 turn_off_face (f, face_id);
984 turn_off_highlight ();
985 }
986
987 cmcheckmagic ();
988 }
989
990 /* If start is zero, insert blanks instead of a string at start */
991
992 void
993 insert_glyphs (start, len)
994 register struct glyph *start;
995 register int len;
996 {
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;
1003
1004 if (len <= 0)
1005 return;
1006
1007 if (insert_glyphs_hook)
1008 {
1009 (*insert_glyphs_hook) (start, len);
1010 return;
1011 }
1012
1013 sf = XFRAME (selected_frame);
1014 f = updating_frame ? updating_frame : sf;
1015
1016 if (TS_ins_multi_chars)
1017 {
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;
1024 }
1025
1026 turn_on_insert ();
1027 cmplus (len);
1028
1029 if (! start)
1030 space[0] = SPACEGLYPH;
1031
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;
1040
1041 while (len-- > 0)
1042 {
1043 OUTPUT1_IF (TS_ins_char);
1044 if (!start)
1045 {
1046 conversion_buffer = space;
1047 coding->produced = 1;
1048 }
1049 else
1050 {
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))
1058 {
1059 OUTPUT1_IF (TS_ins_char);
1060 start++, len--;
1061 }
1062
1063 if (len <= 0)
1064 /* This is the last glyph. */
1065 coding->mode |= CODING_MODE_LAST_BLOCK;
1066
1067 conversion_buffer = encode_terminal_code (glyph, 1, coding);
1068 }
1069
1070 if (coding->produced > 0)
1071 {
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);
1077 }
1078
1079 OUTPUT1_IF (TS_pad_inserted_char);
1080 if (start)
1081 {
1082 turn_off_face (f, glyph->face_id);
1083 turn_off_highlight ();
1084 }
1085 }
1086
1087 cmcheckmagic ();
1088 }
1089
1090 void
1091 delete_glyphs (n)
1092 register int n;
1093 {
1094 char *buf;
1095 register int i;
1096
1097 if (delete_glyphs_hook && ! FRAME_TERMCAP_P (updating_frame))
1098 {
1099 (*delete_glyphs_hook) (n);
1100 return;
1101 }
1102
1103 if (delete_in_insert_mode)
1104 {
1105 turn_on_insert ();
1106 }
1107 else
1108 {
1109 turn_off_insert ();
1110 OUTPUT_IF (TS_delete_mode);
1111 }
1112
1113 if (TS_del_multi_chars)
1114 {
1115 buf = tparam (TS_del_multi_chars, 0, 0, n);
1116 OUTPUT1 (buf);
1117 xfree (buf);
1118 }
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);
1124 }
1125 \f
1126 /* Insert N lines at vpos VPOS. If N is negative, delete -N lines. */
1127
1128 void
1129 ins_del_lines (vpos, n)
1130 int vpos, n;
1131 {
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;
1136
1137 register int i = n > 0 ? n : -n;
1138 register char *buf;
1139
1140 if (ins_del_lines_hook && ! FRAME_TERMCAP_P (updating_frame))
1141 {
1142 (*ins_del_lines_hook) (vpos, n);
1143 return;
1144 }
1145
1146 sf = XFRAME (selected_frame);
1147
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;
1159
1160 if (multi)
1161 {
1162 raw_cursor_to (vpos, 0);
1163 background_highlight ();
1164 buf = tparam (multi, 0, 0, i);
1165 OUTPUT (buf);
1166 xfree (buf);
1167 }
1168 else if (single)
1169 {
1170 raw_cursor_to (vpos, 0);
1171 background_highlight ();
1172 while (--i >= 0)
1173 OUTPUT (single);
1174 if (TF_teleray)
1175 curX = 0;
1176 }
1177 else
1178 {
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);
1188 }
1189
1190 if (!scroll_region_ok && memory_below_frame && n < 0)
1191 {
1192 cursor_to (FRAME_LINES (sf) + n, 0);
1193 clear_to_end ();
1194 }
1195 }
1196 \f
1197 /* Compute cost of sending "str", in characters,
1198 not counting any line-dependent padding. */
1199
1200 int
1201 string_cost (str)
1202 char *str;
1203 {
1204 cost = 0;
1205 if (str)
1206 tputs (str, 0, evalcost);
1207 return cost;
1208 }
1209
1210 /* Compute cost of sending "str", in characters,
1211 counting any line-dependent padding at one line. */
1212
1213 static int
1214 string_cost_one_line (str)
1215 char *str;
1216 {
1217 cost = 0;
1218 if (str)
1219 tputs (str, 1, evalcost);
1220 return cost;
1221 }
1222
1223 /* Compute per line amount of line-dependent padding,
1224 in tenths of characters. */
1225
1226 int
1227 per_line_cost (str)
1228 register char *str;
1229 {
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;
1237 }
1238
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. */
1243
1244 int *char_ins_del_vector;
1245
1246 #define char_ins_del_cost(f) (&char_ins_del_vector[FRAME_COLS ((f))])
1247 #endif
1248
1249 /* ARGSUSED */
1250 static void
1251 calculate_ins_del_char_costs (frame)
1252 FRAME_PTR frame;
1253 {
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;
1258
1259 if (TS_ins_multi_chars)
1260 {
1261 ins_cost_per_char = 0;
1262 ins_startup_cost = string_cost_one_line (TS_ins_multi_chars);
1263 }
1264 else if (TS_ins_char || TS_pad_inserted_char
1265 || (TS_insert_mode && TS_end_insert_mode))
1266 {
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));
1271 }
1272 else
1273 {
1274 ins_startup_cost = 9999;
1275 ins_cost_per_char = 0;
1276 }
1277
1278 if (TS_del_multi_chars)
1279 {
1280 del_cost_per_char = 0;
1281 del_startup_cost = string_cost_one_line (TS_del_multi_chars);
1282 }
1283 else if (TS_del_char)
1284 {
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);
1290 }
1291 else
1292 {
1293 del_startup_cost = 9999;
1294 del_cost_per_char = 0;
1295 }
1296
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);
1301
1302 /* Doing nothing is free */
1303 p = &char_ins_del_cost (frame)[0];
1304 *p++ = 0;
1305
1306 /* Insert costs are at positive offsets */
1307 for (i = FRAME_COLS (frame); --i >= 0;)
1308 *p++ = (ins_startup_cost += ins_cost_per_char);
1309 }
1310
1311 void
1312 calculate_costs (frame)
1313 FRAME_PTR frame;
1314 {
1315 register char *f = (TS_set_scroll_region
1316 ? TS_set_scroll_region
1317 : TS_set_scroll_region_1);
1318
1319 FRAME_COST_BAUD_RATE (frame) = baud_rate;
1320
1321 scroll_region_cost = string_cost (f);
1322
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.
1325
1326 char_ins_del_vector (i.e., char_ins_del_cost) isn't used because
1327 X turns off char_ins_del_ok. */
1328
1329 max_frame_lines = max (max_frame_lines, FRAME_LINES (frame));
1330 max_frame_cols = max (max_frame_cols, FRAME_COLS (frame));
1331
1332 costs_set = 1;
1333
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));
1343
1344 bzero (char_ins_del_vector, (sizeof (int)
1345 + 2 * max_frame_cols * sizeof (int)));
1346
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);
1357
1358 calculate_ins_del_char_costs (frame);
1359
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;
1365
1366 cmcostinit (); /* set up cursor motion costs */
1367 }
1368 \f
1369 struct fkey_table {
1370 char *cap, *name;
1371 };
1372
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.
1378 */
1379
1380 static struct fkey_table keys[] =
1381 {
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 */
1394 /*
1395 * "insert" --- see below
1396 */
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 */
1403 /*
1404 * "break" goes here, but can't be reliably intercepted with termcap
1405 */
1406 {"&4", "reset"}, /* terminfo --- actually `restart' */
1407 /*
1408 * "system" and "user" --- no termcaps
1409 */
1410 {"kE", "clearline"}, /* terminfo */
1411 {"kA", "insertline"}, /* terminfo */
1412 {"kL", "deleteline"}, /* terminfo */
1413 {"kI", "insertchar"}, /* terminfo */
1414 {"kD", "deletechar"}, /* terminfo */
1415 {"kB", "backtab"}, /* terminfo */
1416 /*
1417 * "kp_backtab", "kp-space", "kp-tab" --- no termcaps
1418 */
1419 {"@8", "kp-enter"}, /* terminfo */
1420 /*
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.
1425 */
1426 {"K4", "kp-1"}, /* terminfo */
1427 /*
1428 * "kp-2" --- no termcap
1429 */
1430 {"K5", "kp-3"}, /* terminfo */
1431 /*
1432 * "kp-4" --- no termcap
1433 */
1434 {"K2", "kp-5"}, /* terminfo */
1435 /*
1436 * "kp-6" --- no termcap
1437 */
1438 {"K1", "kp-7"}, /* terminfo */
1439 /*
1440 * "kp-8" --- no termcap
1441 */
1442 {"K3", "kp-9"}, /* terminfo */
1443 /*
1444 * "kp-equal" --- no termcap
1445 */
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"},
1455
1456 {"&0", "S-cancel"}, /*shifted cancel key*/
1457 {"&9", "S-begin"}, /*shifted begin key*/
1458 {"*0", "S-find"}, /*shifted find key*/
1459 {"*1", "S-execute"}, /*shifted execute? actually shifted command key*/
1460 {"*4", "S-delete"}, /*shifted delete-character key*/
1461 {"*7", "S-end"}, /*shifted end key*/
1462 {"*8", "S-clearline"}, /*shifted clear-to end-of-line key*/
1463 {"#1", "S-help"}, /*shifted help key*/
1464 {"#2", "S-home"}, /*shifted home key*/
1465 {"#3", "S-insert"}, /*shifted insert-character key*/
1466 {"#4", "S-left"}, /*shifted left-arrow key*/
1467 {"%d", "S-menu"}, /*shifted menu? actually shifted options key*/
1468 {"%c", "S-next"}, /*shifted next key*/
1469 {"%e", "S-prior"}, /*shifted previous key*/
1470 {"%f", "S-print"}, /*shifted print key*/
1471 {"%g", "S-redo"}, /*shifted redo key*/
1472 {"%i", "S-right"}, /*shifted right-arrow key*/
1473 {"!3", "S-undo"} /*shifted undo key*/
1474 };
1475
1476 static char **term_get_fkeys_arg;
1477 static Lisp_Object term_get_fkeys_1 ();
1478
1479 /* Find the escape codes sent by the function keys for Vfunction_key_map.
1480 This function scans the termcap function key sequence entries, and
1481 adds entries to Vfunction_key_map for each function key it finds. */
1482
1483 void
1484 term_get_fkeys (address)
1485 char **address;
1486 {
1487 /* We run the body of the function (term_get_fkeys_1) and ignore all Lisp
1488 errors during the call. The only errors should be from Fdefine_key
1489 when given a key sequence containing an invalid prefix key. If the
1490 termcap defines function keys which use a prefix that is already bound
1491 to a command by the default bindings, we should silently ignore that
1492 function key specification, rather than giving the user an error and
1493 refusing to run at all on such a terminal. */
1494
1495 extern Lisp_Object Fidentity ();
1496 term_get_fkeys_arg = address;
1497 internal_condition_case (term_get_fkeys_1, Qerror, Fidentity);
1498 }
1499
1500 static Lisp_Object
1501 term_get_fkeys_1 ()
1502 {
1503 int i;
1504
1505 char **address = term_get_fkeys_arg;
1506
1507 /* This can happen if CANNOT_DUMP or with strange options. */
1508 if (!initialized)
1509 Vfunction_key_map = Fmake_sparse_keymap (Qnil);
1510
1511 for (i = 0; i < (sizeof (keys)/sizeof (keys[0])); i++)
1512 {
1513 char *sequence = tgetstr (keys[i].cap, address);
1514 if (sequence)
1515 Fdefine_key (Vfunction_key_map, build_string (sequence),
1516 Fmake_vector (make_number (1),
1517 intern (keys[i].name)));
1518 }
1519
1520 /* The uses of the "k0" capability are inconsistent; sometimes it
1521 describes F10, whereas othertimes it describes F0 and "k;" describes F10.
1522 We will attempt to politely accommodate both systems by testing for
1523 "k;", and if it is present, assuming that "k0" denotes F0, otherwise F10.
1524 */
1525 {
1526 char *k_semi = tgetstr ("k;", address);
1527 char *k0 = tgetstr ("k0", address);
1528 char *k0_name = "f10";
1529
1530 if (k_semi)
1531 {
1532 if (k0)
1533 /* Define f0 first, so that f10 takes precedence in case the
1534 key sequences happens to be the same. */
1535 Fdefine_key (Vfunction_key_map, build_string (k0),
1536 Fmake_vector (make_number (1), intern ("f0")));
1537 Fdefine_key (Vfunction_key_map, build_string (k_semi),
1538 Fmake_vector (make_number (1), intern ("f10")));
1539 }
1540 else if (k0)
1541 Fdefine_key (Vfunction_key_map, build_string (k0),
1542 Fmake_vector (make_number (1), intern (k0_name)));
1543 }
1544
1545 /* Set up cookies for numbered function keys above f10. */
1546 {
1547 char fcap[3], fkey[4];
1548
1549 fcap[0] = 'F'; fcap[2] = '\0';
1550 for (i = 11; i < 64; i++)
1551 {
1552 if (i <= 19)
1553 fcap[1] = '1' + i - 11;
1554 else if (i <= 45)
1555 fcap[1] = 'A' + i - 20;
1556 else
1557 fcap[1] = 'a' + i - 46;
1558
1559 {
1560 char *sequence = tgetstr (fcap, address);
1561 if (sequence)
1562 {
1563 sprintf (fkey, "f%d", i);
1564 Fdefine_key (Vfunction_key_map, build_string (sequence),
1565 Fmake_vector (make_number (1),
1566 intern (fkey)));
1567 }
1568 }
1569 }
1570 }
1571
1572 /*
1573 * Various mappings to try and get a better fit.
1574 */
1575 {
1576 #define CONDITIONAL_REASSIGN(cap1, cap2, sym) \
1577 if (!tgetstr (cap1, address)) \
1578 { \
1579 char *sequence = tgetstr (cap2, address); \
1580 if (sequence) \
1581 Fdefine_key (Vfunction_key_map, build_string (sequence), \
1582 Fmake_vector (make_number (1), \
1583 intern (sym))); \
1584 }
1585
1586 /* if there's no key_next keycap, map key_npage to `next' keysym */
1587 CONDITIONAL_REASSIGN ("%5", "kN", "next");
1588 /* if there's no key_prev keycap, map key_ppage to `previous' keysym */
1589 CONDITIONAL_REASSIGN ("%8", "kP", "prior");
1590 /* if there's no key_dc keycap, map key_ic to `insert' keysym */
1591 CONDITIONAL_REASSIGN ("kD", "kI", "insert");
1592 /* if there's no key_end keycap, map key_ll to 'end' keysym */
1593 CONDITIONAL_REASSIGN ("@7", "kH", "end");
1594
1595 /* IBM has their own non-standard dialect of terminfo.
1596 If the standard name isn't found, try the IBM name. */
1597 CONDITIONAL_REASSIGN ("kB", "KO", "backtab");
1598 CONDITIONAL_REASSIGN ("@4", "kJ", "execute"); /* actually "action" */
1599 CONDITIONAL_REASSIGN ("@4", "kc", "execute"); /* actually "command" */
1600 CONDITIONAL_REASSIGN ("%7", "ki", "menu");
1601 CONDITIONAL_REASSIGN ("@7", "kw", "end");
1602 CONDITIONAL_REASSIGN ("F1", "k<", "f11");
1603 CONDITIONAL_REASSIGN ("F2", "k>", "f12");
1604 CONDITIONAL_REASSIGN ("%1", "kq", "help");
1605 CONDITIONAL_REASSIGN ("*6", "kU", "select");
1606 #undef CONDITIONAL_REASSIGN
1607 }
1608
1609 return Qnil;
1610 }
1611
1612 \f
1613 /***********************************************************************
1614 Character Display Information
1615 ***********************************************************************/
1616
1617 static void append_glyph P_ ((struct it *));
1618 static void produce_stretch_glyph P_ ((struct it *));
1619
1620
1621 /* Append glyphs to IT's glyph_row. Called from produce_glyphs for
1622 terminal frames if IT->glyph_row != NULL. IT->c is the character
1623 for which to produce glyphs; IT->face_id contains the character's
1624 face. Padding glyphs are appended if IT->c has a IT->pixel_width >
1625 1. */
1626
1627 static void
1628 append_glyph (it)
1629 struct it *it;
1630 {
1631 struct glyph *glyph, *end;
1632 int i;
1633
1634 xassert (it->glyph_row);
1635 glyph = (it->glyph_row->glyphs[it->area]
1636 + it->glyph_row->used[it->area]);
1637 end = it->glyph_row->glyphs[1 + it->area];
1638
1639 for (i = 0;
1640 i < it->pixel_width && glyph < end;
1641 ++i)
1642 {
1643 glyph->type = CHAR_GLYPH;
1644 glyph->pixel_width = 1;
1645 glyph->u.ch = it->c;
1646 glyph->face_id = it->face_id;
1647 glyph->padding_p = i > 0;
1648 glyph->charpos = CHARPOS (it->position);
1649 glyph->object = it->object;
1650
1651 ++it->glyph_row->used[it->area];
1652 ++glyph;
1653 }
1654 }
1655
1656
1657 /* Produce glyphs for the display element described by IT. *IT
1658 specifies what we want to produce a glyph for (character, image, ...),
1659 and where in the glyph matrix we currently are (glyph row and hpos).
1660 produce_glyphs fills in output fields of *IT with information such as the
1661 pixel width and height of a character, and maybe output actual glyphs at
1662 the same time if IT->glyph_row is non-null. See the explanation of
1663 struct display_iterator in dispextern.h for an overview.
1664
1665 produce_glyphs also stores the result of glyph width, ascent
1666 etc. computations in *IT.
1667
1668 IT->glyph_row may be null, in which case produce_glyphs does not
1669 actually fill in the glyphs. This is used in the move_* functions
1670 in xdisp.c for text width and height computations.
1671
1672 Callers usually don't call produce_glyphs directly;
1673 instead they use the macro PRODUCE_GLYPHS. */
1674
1675 void
1676 produce_glyphs (it)
1677 struct it *it;
1678 {
1679 /* If a hook is installed, let it do the work. */
1680 xassert (it->what == IT_CHARACTER
1681 || it->what == IT_COMPOSITION
1682 || it->what == IT_STRETCH);
1683
1684 if (it->what == IT_STRETCH)
1685 {
1686 produce_stretch_glyph (it);
1687 goto done;
1688 }
1689
1690 /* Nothing but characters are supported on terminal frames. For a
1691 composition sequence, it->c is the first character of the
1692 sequence. */
1693 xassert (it->what == IT_CHARACTER
1694 || it->what == IT_COMPOSITION);
1695
1696 if (it->c >= 040 && it->c < 0177)
1697 {
1698 it->pixel_width = it->nglyphs = 1;
1699 if (it->glyph_row)
1700 append_glyph (it);
1701 }
1702 else if (it->c == '\n')
1703 it->pixel_width = it->nglyphs = 0;
1704 else if (it->c == '\t')
1705 {
1706 int absolute_x = (it->current_x
1707 + it->continuation_lines_width);
1708 int next_tab_x
1709 = (((1 + absolute_x + it->tab_width - 1)
1710 / it->tab_width)
1711 * it->tab_width);
1712 int nspaces;
1713
1714 /* If part of the TAB has been displayed on the previous line
1715 which is continued now, continuation_lines_width will have
1716 been incremented already by the part that fitted on the
1717 continued line. So, we will get the right number of spaces
1718 here. */
1719 nspaces = next_tab_x - absolute_x;
1720
1721 if (it->glyph_row)
1722 {
1723 int n = nspaces;
1724
1725 it->c = ' ';
1726 it->pixel_width = it->len = 1;
1727
1728 while (n--)
1729 append_glyph (it);
1730
1731 it->c = '\t';
1732 }
1733
1734 it->pixel_width = nspaces;
1735 it->nglyphs = nspaces;
1736 }
1737 else if (SINGLE_BYTE_CHAR_P (it->c))
1738 {
1739 /* Coming here means that it->c is from display table, thus we
1740 must send the code as is to the terminal. Although there's
1741 no way to know how many columns it occupies on a screen, it
1742 is a good assumption that a single byte code has 1-column
1743 width. */
1744 it->pixel_width = it->nglyphs = 1;
1745 if (it->glyph_row)
1746 append_glyph (it);
1747 }
1748 else
1749 {
1750 /* A multi-byte character. The display width is fixed for all
1751 characters of the set. Some of the glyphs may have to be
1752 ignored because they are already displayed in a continued
1753 line. */
1754 int charset = CHAR_CHARSET (it->c);
1755
1756 it->pixel_width = CHARSET_WIDTH (charset);
1757 it->nglyphs = it->pixel_width;
1758
1759 if (it->glyph_row)
1760 append_glyph (it);
1761 }
1762
1763 done:
1764 /* Advance current_x by the pixel width as a convenience for
1765 the caller. */
1766 if (it->area == TEXT_AREA)
1767 it->current_x += it->pixel_width;
1768 it->ascent = it->max_ascent = it->phys_ascent = it->max_phys_ascent = 0;
1769 it->descent = it->max_descent = it->phys_descent = it->max_phys_descent = 1;
1770 }
1771
1772
1773 /* Produce a stretch glyph for iterator IT. IT->object is the value
1774 of the glyph property displayed. The value must be a list
1775 `(space KEYWORD VALUE ...)' with the following KEYWORD/VALUE pairs
1776 being recognized:
1777
1778 1. `:width WIDTH' specifies that the space should be WIDTH *
1779 canonical char width wide. WIDTH may be an integer or floating
1780 point number.
1781
1782 2. `:align-to HPOS' specifies that the space should be wide enough
1783 to reach HPOS, a value in canonical character units. */
1784
1785 static void
1786 produce_stretch_glyph (it)
1787 struct it *it;
1788 {
1789 /* (space :width WIDTH ...) */
1790 Lisp_Object prop, plist;
1791 int width = 0, align_to = -1;
1792 int zero_width_ok_p = 0;
1793 double tem;
1794
1795 /* List should start with `space'. */
1796 xassert (CONSP (it->object) && EQ (XCAR (it->object), Qspace));
1797 plist = XCDR (it->object);
1798
1799 /* Compute the width of the stretch. */
1800 if ((prop = Fplist_get (plist, QCwidth), !NILP (prop))
1801 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, 0))
1802 {
1803 /* Absolute width `:width WIDTH' specified and valid. */
1804 zero_width_ok_p = 1;
1805 width = (int)(tem + 0.5);
1806 }
1807 else if ((prop = Fplist_get (plist, QCalign_to), !NILP (prop))
1808 && calc_pixel_width_or_height (&tem, it, prop, 0, 1, &align_to))
1809 {
1810 if (it->glyph_row == NULL || !it->glyph_row->mode_line_p)
1811 align_to = (align_to < 0
1812 ? 0
1813 : align_to - window_box_left_offset (it->w, TEXT_AREA));
1814 else if (align_to < 0)
1815 align_to = window_box_left_offset (it->w, TEXT_AREA);
1816 width = max (0, (int)(tem + 0.5) + align_to - it->current_x);
1817 zero_width_ok_p = 1;
1818 }
1819 else
1820 /* Nothing specified -> width defaults to canonical char width. */
1821 width = FRAME_COLUMN_WIDTH (it->f);
1822
1823 if (width <= 0 && (width < 0 || !zero_width_ok_p))
1824 width = 1;
1825
1826 if (width > 0 && it->glyph_row)
1827 {
1828 Lisp_Object o_object = it->object;
1829 Lisp_Object object = it->stack[it->sp - 1].string;
1830 int n = width;
1831 int c = it->c;
1832
1833 if (!STRINGP (object))
1834 object = it->w->buffer;
1835 it->object = object;
1836 it->c = ' ';
1837 it->pixel_width = it->len = 1;
1838 while (n--)
1839 append_glyph (it);
1840 it->object = o_object;
1841 it->c = c;
1842 }
1843 it->pixel_width = width;
1844 it->nglyphs = width;
1845 }
1846
1847
1848 /* Get information about special display element WHAT in an
1849 environment described by IT. WHAT is one of IT_TRUNCATION or
1850 IT_CONTINUATION. Maybe produce glyphs for WHAT if IT has a
1851 non-null glyph_row member. This function ensures that fields like
1852 face_id, c, len of IT are left untouched. */
1853
1854 void
1855 produce_special_glyphs (it, what)
1856 struct it *it;
1857 enum display_element_type what;
1858 {
1859 struct it temp_it;
1860 GLYPH glyph;
1861
1862 temp_it = *it;
1863 temp_it.dp = NULL;
1864 temp_it.what = IT_CHARACTER;
1865 temp_it.len = 1;
1866 temp_it.object = make_number (0);
1867 bzero (&temp_it.current, sizeof temp_it.current);
1868
1869 if (what == IT_CONTINUATION)
1870 {
1871 /* Continuation glyph. */
1872 if (it->dp
1873 && INTEGERP (DISP_CONTINUE_GLYPH (it->dp))
1874 && GLYPH_CHAR_VALID_P (XINT (DISP_CONTINUE_GLYPH (it->dp))))
1875 {
1876 glyph = XINT (DISP_CONTINUE_GLYPH (it->dp));
1877 glyph = spec_glyph_lookup_face (XWINDOW (it->window), glyph);
1878 }
1879 else
1880 glyph = '\\';
1881 }
1882 else if (what == IT_TRUNCATION)
1883 {
1884 /* Truncation glyph. */
1885 if (it->dp
1886 && INTEGERP (DISP_TRUNC_GLYPH (it->dp))
1887 && GLYPH_CHAR_VALID_P (XINT (DISP_TRUNC_GLYPH (it->dp))))
1888 {
1889 glyph = XINT (DISP_TRUNC_GLYPH (it->dp));
1890 glyph = spec_glyph_lookup_face (XWINDOW (it->window), glyph);
1891 }
1892 else
1893 glyph = '$';
1894 }
1895 else
1896 abort ();
1897
1898 temp_it.c = FAST_GLYPH_CHAR (glyph);
1899 temp_it.face_id = FAST_GLYPH_FACE (glyph);
1900 temp_it.len = CHAR_BYTES (temp_it.c);
1901
1902 produce_glyphs (&temp_it);
1903 it->pixel_width = temp_it.pixel_width;
1904 it->nglyphs = temp_it.pixel_width;
1905 }
1906
1907
1908 \f
1909 /***********************************************************************
1910 Faces
1911 ***********************************************************************/
1912
1913 /* Value is non-zero if attribute ATTR may be used. ATTR should be
1914 one of the enumerators from enum no_color_bit, or a bit set built
1915 from them. Some display attributes may not be used together with
1916 color; the termcap capability `NC' specifies which ones. */
1917
1918 #define MAY_USE_WITH_COLORS_P(ATTR) \
1919 (TN_max_colors > 0 \
1920 ? (TN_no_color_video & (ATTR)) == 0 \
1921 : 1)
1922
1923 /* Turn appearances of face FACE_ID on tty frame F on.
1924 FACE_ID is a realized face ID number, in the face cache. */
1925
1926 static void
1927 turn_on_face (f, face_id)
1928 struct frame *f;
1929 int face_id;
1930 {
1931 struct face *face = FACE_FROM_ID (f, face_id);
1932 long fg = face->foreground;
1933 long bg = face->background;
1934
1935 /* Do this first because TS_end_standout_mode may be the same
1936 as TS_exit_attribute_mode, which turns all appearances off. */
1937 if (MAY_USE_WITH_COLORS_P (NC_REVERSE))
1938 {
1939 if (TN_max_colors > 0)
1940 {
1941 if (fg >= 0 && bg >= 0)
1942 {
1943 /* If the terminal supports colors, we can set them
1944 below without using reverse video. The face's fg
1945 and bg colors are set as they should appear on
1946 the screen, i.e. they take the inverse-video'ness
1947 of the face already into account. */
1948 }
1949 else if (inverse_video)
1950 {
1951 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1952 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1953 toggle_highlight ();
1954 }
1955 else
1956 {
1957 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1958 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1959 toggle_highlight ();
1960 }
1961 }
1962 else
1963 {
1964 /* If we can't display colors, use reverse video
1965 if the face specifies that. */
1966 if (inverse_video)
1967 {
1968 if (fg == FACE_TTY_DEFAULT_FG_COLOR
1969 || bg == FACE_TTY_DEFAULT_BG_COLOR)
1970 toggle_highlight ();
1971 }
1972 else
1973 {
1974 if (fg == FACE_TTY_DEFAULT_BG_COLOR
1975 || bg == FACE_TTY_DEFAULT_FG_COLOR)
1976 toggle_highlight ();
1977 }
1978 }
1979 }
1980
1981 if (face->tty_bold_p)
1982 {
1983 if (MAY_USE_WITH_COLORS_P (NC_BOLD))
1984 OUTPUT1_IF (TS_enter_bold_mode);
1985 }
1986 else if (face->tty_dim_p)
1987 if (MAY_USE_WITH_COLORS_P (NC_DIM))
1988 OUTPUT1_IF (TS_enter_dim_mode);
1989
1990 /* Alternate charset and blinking not yet used. */
1991 if (face->tty_alt_charset_p
1992 && MAY_USE_WITH_COLORS_P (NC_ALT_CHARSET))
1993 OUTPUT1_IF (TS_enter_alt_charset_mode);
1994
1995 if (face->tty_blinking_p
1996 && MAY_USE_WITH_COLORS_P (NC_BLINK))
1997 OUTPUT1_IF (TS_enter_blink_mode);
1998
1999 if (face->tty_underline_p && MAY_USE_WITH_COLORS_P (NC_UNDERLINE))
2000 OUTPUT1_IF (TS_enter_underline_mode);
2001
2002 if (TN_max_colors > 0)
2003 {
2004 char *p;
2005
2006 if (fg >= 0 && TS_set_foreground)
2007 {
2008 if (standout_mode)
2009 p = tparam (TS_set_background, NULL, 0, (int) fg);
2010 else
2011 p = tparam (TS_set_foreground, NULL, 0, (int) fg);
2012 OUTPUT (p);
2013 xfree (p);
2014 }
2015
2016 if (bg >= 0 && TS_set_background)
2017 {
2018 if (standout_mode)
2019 p = tparam (TS_set_foreground, NULL, 0, (int) bg);
2020 else
2021 p = tparam (TS_set_background, NULL, 0, (int) bg);
2022 OUTPUT (p);
2023 xfree (p);
2024 }
2025 }
2026 }
2027
2028
2029 /* Turn off appearances of face FACE_ID on tty frame F. */
2030
2031 static void
2032 turn_off_face (f, face_id)
2033 struct frame *f;
2034 int face_id;
2035 {
2036 struct face *face = FACE_FROM_ID (f, face_id);
2037
2038 xassert (face != NULL);
2039
2040 if (TS_exit_attribute_mode)
2041 {
2042 /* Capability "me" will turn off appearance modes double-bright,
2043 half-bright, reverse-video, standout, underline. It may or
2044 may not turn off alt-char-mode. */
2045 if (face->tty_bold_p
2046 || face->tty_dim_p
2047 || face->tty_reverse_p
2048 || face->tty_alt_charset_p
2049 || face->tty_blinking_p
2050 || face->tty_underline_p)
2051 {
2052 OUTPUT1_IF (TS_exit_attribute_mode);
2053 if (strcmp (TS_exit_attribute_mode, TS_end_standout_mode) == 0)
2054 standout_mode = 0;
2055 }
2056
2057 if (face->tty_alt_charset_p)
2058 OUTPUT_IF (TS_exit_alt_charset_mode);
2059 }
2060 else
2061 {
2062 /* If we don't have "me" we can only have those appearances
2063 that have exit sequences defined. */
2064 if (face->tty_alt_charset_p)
2065 OUTPUT_IF (TS_exit_alt_charset_mode);
2066
2067 if (face->tty_underline_p)
2068 OUTPUT_IF (TS_exit_underline_mode);
2069 }
2070
2071 /* Switch back to default colors. */
2072 if (TN_max_colors > 0
2073 && ((face->foreground != FACE_TTY_DEFAULT_COLOR
2074 && face->foreground != FACE_TTY_DEFAULT_FG_COLOR)
2075 || (face->background != FACE_TTY_DEFAULT_COLOR
2076 && face->background != FACE_TTY_DEFAULT_BG_COLOR)))
2077 OUTPUT1_IF (TS_orig_pair);
2078 }
2079
2080
2081 /* Return non-zero if the terminal on frame F supports all of the
2082 capabilities in CAPS simultaneously, with foreground and background
2083 colors FG and BG. */
2084
2085 int
2086 tty_capable_p (f, caps, fg, bg)
2087 struct frame *f;
2088 unsigned caps;
2089 unsigned long fg, bg;
2090 {
2091 #define TTY_CAPABLE_P_TRY(cap, TS, NC_bit) \
2092 if ((caps & (cap)) && (!(TS) || !MAY_USE_WITH_COLORS_P(NC_bit))) \
2093 return 0;
2094
2095 TTY_CAPABLE_P_TRY (TTY_CAP_INVERSE, TS_standout_mode, NC_REVERSE);
2096 TTY_CAPABLE_P_TRY (TTY_CAP_UNDERLINE, TS_enter_underline_mode, NC_UNDERLINE);
2097 TTY_CAPABLE_P_TRY (TTY_CAP_BOLD, TS_enter_bold_mode, NC_BOLD);
2098 TTY_CAPABLE_P_TRY (TTY_CAP_DIM, TS_enter_dim_mode, NC_DIM);
2099 TTY_CAPABLE_P_TRY (TTY_CAP_BLINK, TS_enter_blink_mode, NC_BLINK);
2100 TTY_CAPABLE_P_TRY (TTY_CAP_ALT_CHARSET, TS_enter_alt_charset_mode, NC_ALT_CHARSET);
2101
2102 /* We can do it! */
2103 return 1;
2104 }
2105
2106
2107 /* Return non-zero if the terminal is capable to display colors. */
2108
2109 DEFUN ("tty-display-color-p", Ftty_display_color_p, Stty_display_color_p,
2110 0, 1, 0,
2111 doc: /* Return non-nil if TTY can display colors on DISPLAY. */)
2112 (display)
2113 Lisp_Object display;
2114 {
2115 return TN_max_colors > 0 ? Qt : Qnil;
2116 }
2117
2118 /* Return the number of supported colors. */
2119 DEFUN ("tty-display-color-cells", Ftty_display_color_cells,
2120 Stty_display_color_cells, 0, 1, 0,
2121 doc: /* Return the number of colors supported by TTY on DISPLAY. */)
2122 (display)
2123 Lisp_Object display;
2124 {
2125 return make_number (TN_max_colors);
2126 }
2127
2128 #ifndef WINDOWSNT
2129
2130 /* Save or restore the default color-related capabilities of this
2131 terminal. */
2132 static void
2133 tty_default_color_capabilities (save)
2134 int save;
2135 {
2136 static char
2137 *default_orig_pair, *default_set_foreground, *default_set_background;
2138 static int default_max_colors, default_max_pairs, default_no_color_video;
2139
2140 if (save)
2141 {
2142 if (default_orig_pair)
2143 xfree (default_orig_pair);
2144 default_orig_pair = TS_orig_pair ? xstrdup (TS_orig_pair) : NULL;
2145
2146 if (default_set_foreground)
2147 xfree (default_set_foreground);
2148 default_set_foreground = TS_set_foreground ? xstrdup (TS_set_foreground)
2149 : NULL;
2150
2151 if (default_set_background)
2152 xfree (default_set_background);
2153 default_set_background = TS_set_background ? xstrdup (TS_set_background)
2154 : NULL;
2155
2156 default_max_colors = TN_max_colors;
2157 default_max_pairs = TN_max_pairs;
2158 default_no_color_video = TN_no_color_video;
2159 }
2160 else
2161 {
2162 TS_orig_pair = default_orig_pair;
2163 TS_set_foreground = default_set_foreground;
2164 TS_set_background = default_set_background;
2165 TN_max_colors = default_max_colors;
2166 TN_max_pairs = default_max_pairs;
2167 TN_no_color_video = default_no_color_video;
2168 }
2169 }
2170
2171 /* Setup one of the standard tty color schemes according to MODE.
2172 MODE's value is generally the number of colors which we want to
2173 support; zero means set up for the default capabilities, the ones
2174 we saw at term_init time; -1 means turn off color support. */
2175 void
2176 tty_setup_colors (mode)
2177 int mode;
2178 {
2179 /* Canonicalize all negative values of MODE. */
2180 if (mode < -1)
2181 mode = -1;
2182
2183 switch (mode)
2184 {
2185 case -1: /* no colors at all */
2186 TN_max_colors = 0;
2187 TN_max_pairs = 0;
2188 TN_no_color_video = 0;
2189 TS_set_foreground = TS_set_background = TS_orig_pair = NULL;
2190 break;
2191 case 0: /* default colors, if any */
2192 default:
2193 tty_default_color_capabilities (0);
2194 break;
2195 case 8: /* 8 standard ANSI colors */
2196 TS_orig_pair = "\033[0m";
2197 #ifdef TERMINFO
2198 TS_set_foreground = "\033[3%p1%dm";
2199 TS_set_background = "\033[4%p1%dm";
2200 #else
2201 TS_set_foreground = "\033[3%dm";
2202 TS_set_background = "\033[4%dm";
2203 #endif
2204 TN_max_colors = 8;
2205 TN_max_pairs = 64;
2206 TN_no_color_video = 0;
2207 break;
2208 }
2209 }
2210
2211 void
2212 set_tty_color_mode (f, val)
2213 struct frame *f;
2214 Lisp_Object val;
2215 {
2216 Lisp_Object color_mode_spec, current_mode_spec;
2217 Lisp_Object color_mode, current_mode;
2218 int mode, old_mode;
2219 extern Lisp_Object Qtty_color_mode;
2220 Lisp_Object tty_color_mode_alist;
2221
2222 tty_color_mode_alist = Fintern_soft (build_string ("tty-color-mode-alist"),
2223 Qnil);
2224
2225 if (INTEGERP (val))
2226 color_mode = val;
2227 else
2228 {
2229 if (NILP (tty_color_mode_alist))
2230 color_mode_spec = Qnil;
2231 else
2232 color_mode_spec = Fassq (val, XSYMBOL (tty_color_mode_alist)->value);
2233
2234 if (CONSP (color_mode_spec))
2235 color_mode = XCDR (color_mode_spec);
2236 else
2237 color_mode = Qnil;
2238 }
2239
2240 current_mode_spec = assq_no_quit (Qtty_color_mode, f->param_alist);
2241
2242 if (CONSP (current_mode_spec))
2243 current_mode = XCDR (current_mode_spec);
2244 else
2245 current_mode = Qnil;
2246 if (INTEGERP (color_mode))
2247 mode = XINT (color_mode);
2248 else
2249 mode = 0; /* meaning default */
2250 if (INTEGERP (current_mode))
2251 old_mode = XINT (current_mode);
2252 else
2253 old_mode = 0;
2254
2255 if (mode != old_mode)
2256 {
2257 tty_setup_colors (mode);
2258 /* This recomputes all the faces given the new color
2259 definitions. */
2260 call0 (intern ("tty-set-up-initial-frame-faces"));
2261 redraw_frame (f);
2262 }
2263 }
2264
2265 #endif /* !WINDOWSNT */
2266
2267 \f
2268 /***********************************************************************
2269 Initialization
2270 ***********************************************************************/
2271
2272 void
2273 term_init (terminal_type)
2274 char *terminal_type;
2275 {
2276 char *area;
2277 char **address = &area;
2278 char *buffer = NULL;
2279 int buffer_size = 4096;
2280 register char *p;
2281 int status;
2282 struct frame *sf = XFRAME (selected_frame);
2283
2284 encode_terminal_bufsize = 0;
2285
2286 #ifdef WINDOWSNT
2287 initialize_w32_display ();
2288
2289 Wcm_clear ();
2290
2291 area = (char *) xmalloc (2044);
2292
2293 FrameRows = FRAME_LINES (sf);
2294 FrameCols = FRAME_COLS (sf);
2295 specified_window = FRAME_LINES (sf);
2296
2297 delete_in_insert_mode = 1;
2298
2299 UseTabs = 0;
2300 scroll_region_ok = 0;
2301
2302 /* Seems to insert lines when it's not supposed to, messing
2303 up the display. In doing a trace, it didn't seem to be
2304 called much, so I don't think we're losing anything by
2305 turning it off. */
2306
2307 line_ins_del_ok = 0;
2308 char_ins_del_ok = 1;
2309
2310 baud_rate = 19200;
2311
2312 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2313 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2314 TN_max_colors = 16; /* Required to be non-zero for tty-display-color-p */
2315
2316 return;
2317 #else /* not WINDOWSNT */
2318
2319 Wcm_clear ();
2320
2321 buffer = (char *) xmalloc (buffer_size);
2322 status = tgetent (buffer, terminal_type);
2323 if (status < 0)
2324 {
2325 #ifdef TERMINFO
2326 fatal ("Cannot open terminfo database file");
2327 #else
2328 fatal ("Cannot open termcap database file");
2329 #endif
2330 }
2331 if (status == 0)
2332 {
2333 #ifdef TERMINFO
2334 fatal ("Terminal type %s is not defined.\n\
2335 If that is not the actual type of terminal you have,\n\
2336 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2337 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2338 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2339 terminal_type);
2340 #else
2341 fatal ("Terminal type %s is not defined.\n\
2342 If that is not the actual type of terminal you have,\n\
2343 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2344 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2345 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2346 terminal_type);
2347 #endif
2348 }
2349
2350 #ifndef TERMINFO
2351 if (strlen (buffer) >= buffer_size)
2352 abort ();
2353 buffer_size = strlen (buffer);
2354 #endif
2355 area = (char *) xmalloc (buffer_size);
2356
2357 TS_ins_line = tgetstr ("al", address);
2358 TS_ins_multi_lines = tgetstr ("AL", address);
2359 TS_bell = tgetstr ("bl", address);
2360 BackTab = tgetstr ("bt", address);
2361 TS_clr_to_bottom = tgetstr ("cd", address);
2362 TS_clr_line = tgetstr ("ce", address);
2363 TS_clr_frame = tgetstr ("cl", address);
2364 ColPosition = NULL; /* tgetstr ("ch", address); */
2365 AbsPosition = tgetstr ("cm", address);
2366 CR = tgetstr ("cr", address);
2367 TS_set_scroll_region = tgetstr ("cs", address);
2368 TS_set_scroll_region_1 = tgetstr ("cS", address);
2369 RowPosition = tgetstr ("cv", address);
2370 TS_del_char = tgetstr ("dc", address);
2371 TS_del_multi_chars = tgetstr ("DC", address);
2372 TS_del_line = tgetstr ("dl", address);
2373 TS_del_multi_lines = tgetstr ("DL", address);
2374 TS_delete_mode = tgetstr ("dm", address);
2375 TS_end_delete_mode = tgetstr ("ed", address);
2376 TS_end_insert_mode = tgetstr ("ei", address);
2377 Home = tgetstr ("ho", address);
2378 TS_ins_char = tgetstr ("ic", address);
2379 TS_ins_multi_chars = tgetstr ("IC", address);
2380 TS_insert_mode = tgetstr ("im", address);
2381 TS_pad_inserted_char = tgetstr ("ip", address);
2382 TS_end_keypad_mode = tgetstr ("ke", address);
2383 TS_keypad_mode = tgetstr ("ks", address);
2384 LastLine = tgetstr ("ll", address);
2385 Right = tgetstr ("nd", address);
2386 Down = tgetstr ("do", address);
2387 if (!Down)
2388 Down = tgetstr ("nl", address); /* Obsolete name for "do" */
2389 #ifdef VMS
2390 /* VMS puts a carriage return before each linefeed,
2391 so it is not safe to use linefeeds. */
2392 if (Down && Down[0] == '\n' && Down[1] == '\0')
2393 Down = 0;
2394 #endif /* VMS */
2395 if (tgetflag ("bs"))
2396 Left = "\b"; /* can't possibly be longer! */
2397 else /* (Actually, "bs" is obsolete...) */
2398 Left = tgetstr ("le", address);
2399 if (!Left)
2400 Left = tgetstr ("bc", address); /* Obsolete name for "le" */
2401 TS_pad_char = tgetstr ("pc", address);
2402 TS_repeat = tgetstr ("rp", address);
2403 TS_end_standout_mode = tgetstr ("se", address);
2404 TS_fwd_scroll = tgetstr ("sf", address);
2405 TS_standout_mode = tgetstr ("so", address);
2406 TS_rev_scroll = tgetstr ("sr", address);
2407 Wcm.cm_tab = tgetstr ("ta", address);
2408 TS_end_termcap_modes = tgetstr ("te", address);
2409 TS_termcap_modes = tgetstr ("ti", address);
2410 Up = tgetstr ("up", address);
2411 TS_visible_bell = tgetstr ("vb", address);
2412 TS_cursor_normal = tgetstr ("ve", address);
2413 TS_cursor_visible = tgetstr ("vs", address);
2414 TS_cursor_invisible = tgetstr ("vi", address);
2415 TS_set_window = tgetstr ("wi", address);
2416
2417 TS_enter_underline_mode = tgetstr ("us", address);
2418 TS_exit_underline_mode = tgetstr ("ue", address);
2419 TS_enter_bold_mode = tgetstr ("md", address);
2420 TS_enter_dim_mode = tgetstr ("mh", address);
2421 TS_enter_blink_mode = tgetstr ("mb", address);
2422 TS_enter_reverse_mode = tgetstr ("mr", address);
2423 TS_enter_alt_charset_mode = tgetstr ("as", address);
2424 TS_exit_alt_charset_mode = tgetstr ("ae", address);
2425 TS_exit_attribute_mode = tgetstr ("me", address);
2426
2427 MultiUp = tgetstr ("UP", address);
2428 MultiDown = tgetstr ("DO", address);
2429 MultiLeft = tgetstr ("LE", address);
2430 MultiRight = tgetstr ("RI", address);
2431
2432 /* SVr4/ANSI color suppert. If "op" isn't available, don't support
2433 color because we can't switch back to the default foreground and
2434 background. */
2435 TS_orig_pair = tgetstr ("op", address);
2436 if (TS_orig_pair)
2437 {
2438 TS_set_foreground = tgetstr ("AF", address);
2439 TS_set_background = tgetstr ("AB", address);
2440 if (!TS_set_foreground)
2441 {
2442 /* SVr4. */
2443 TS_set_foreground = tgetstr ("Sf", address);
2444 TS_set_background = tgetstr ("Sb", address);
2445 }
2446
2447 TN_max_colors = tgetnum ("Co");
2448 TN_max_pairs = tgetnum ("pa");
2449
2450 TN_no_color_video = tgetnum ("NC");
2451 if (TN_no_color_video == -1)
2452 TN_no_color_video = 0;
2453 }
2454
2455 tty_default_color_capabilities (1);
2456
2457 MagicWrap = tgetflag ("xn");
2458 /* Since we make MagicWrap terminals look like AutoWrap, we need to have
2459 the former flag imply the latter. */
2460 AutoWrap = MagicWrap || tgetflag ("am");
2461 memory_below_frame = tgetflag ("db");
2462 TF_hazeltine = tgetflag ("hz");
2463 must_write_spaces = tgetflag ("in");
2464 meta_key = tgetflag ("km") || tgetflag ("MT");
2465 TF_insmode_motion = tgetflag ("mi");
2466 TF_standout_motion = tgetflag ("ms");
2467 TF_underscore = tgetflag ("ul");
2468 TF_teleray = tgetflag ("xt");
2469
2470 term_get_fkeys (address);
2471
2472 /* Get frame size from system, or else from termcap. */
2473 {
2474 int height, width;
2475 get_frame_size (&width, &height);
2476 FRAME_COLS (sf) = width;
2477 FRAME_LINES (sf) = height;
2478 }
2479
2480 if (FRAME_COLS (sf) <= 0)
2481 SET_FRAME_COLS (sf, tgetnum ("co"));
2482 else
2483 /* Keep width and external_width consistent */
2484 SET_FRAME_COLS (sf, FRAME_COLS (sf));
2485 if (FRAME_LINES (sf) <= 0)
2486 FRAME_LINES (sf) = tgetnum ("li");
2487
2488 if (FRAME_LINES (sf) < 3 || FRAME_COLS (sf) < 3)
2489 fatal ("Screen size %dx%d is too small",
2490 FRAME_LINES (sf), FRAME_COLS (sf));
2491
2492 min_padding_speed = tgetnum ("pb");
2493 TabWidth = tgetnum ("tw");
2494
2495 #ifdef VMS
2496 /* These capabilities commonly use ^J.
2497 I don't know why, but sending them on VMS does not work;
2498 it causes following spaces to be lost, sometimes.
2499 For now, the simplest fix is to avoid using these capabilities ever. */
2500 if (Down && Down[0] == '\n')
2501 Down = 0;
2502 #endif /* VMS */
2503
2504 if (!TS_bell)
2505 TS_bell = "\07";
2506
2507 if (!TS_fwd_scroll)
2508 TS_fwd_scroll = Down;
2509
2510 PC = TS_pad_char ? *TS_pad_char : 0;
2511
2512 if (TabWidth < 0)
2513 TabWidth = 8;
2514
2515 /* Turned off since /etc/termcap seems to have :ta= for most terminals
2516 and newer termcap doc does not seem to say there is a default.
2517 if (!Wcm.cm_tab)
2518 Wcm.cm_tab = "\t";
2519 */
2520
2521 /* We don't support standout modes that use `magic cookies', so
2522 turn off any that do. */
2523 if (TS_standout_mode && tgetnum ("sg") >= 0)
2524 {
2525 TS_standout_mode = 0;
2526 TS_end_standout_mode = 0;
2527 }
2528 if (TS_enter_underline_mode && tgetnum ("ug") >= 0)
2529 {
2530 TS_enter_underline_mode = 0;
2531 TS_exit_underline_mode = 0;
2532 }
2533
2534 /* If there's no standout mode, try to use underlining instead. */
2535 if (TS_standout_mode == 0)
2536 {
2537 TS_standout_mode = TS_enter_underline_mode;
2538 TS_end_standout_mode = TS_exit_underline_mode;
2539 }
2540
2541 /* If no `se' string, try using a `me' string instead.
2542 If that fails, we can't use standout mode at all. */
2543 if (TS_end_standout_mode == 0)
2544 {
2545 char *s = tgetstr ("me", address);
2546 if (s != 0)
2547 TS_end_standout_mode = s;
2548 else
2549 TS_standout_mode = 0;
2550 }
2551
2552 if (TF_teleray)
2553 {
2554 Wcm.cm_tab = 0;
2555 /* We can't support standout mode, because it uses magic cookies. */
2556 TS_standout_mode = 0;
2557 /* But that means we cannot rely on ^M to go to column zero! */
2558 CR = 0;
2559 /* LF can't be trusted either -- can alter hpos */
2560 /* if move at column 0 thru a line with TS_standout_mode */
2561 Down = 0;
2562 }
2563
2564 /* Special handling for certain terminal types known to need it */
2565
2566 if (!strcmp (terminal_type, "supdup"))
2567 {
2568 memory_below_frame = 1;
2569 Wcm.cm_losewrap = 1;
2570 }
2571 if (!strncmp (terminal_type, "c10", 3)
2572 || !strcmp (terminal_type, "perq"))
2573 {
2574 /* Supply a makeshift :wi string.
2575 This string is not valid in general since it works only
2576 for windows starting at the upper left corner;
2577 but that is all Emacs uses.
2578
2579 This string works only if the frame is using
2580 the top of the video memory, because addressing is memory-relative.
2581 So first check the :ti string to see if that is true.
2582
2583 It would be simpler if the :wi string could go in the termcap
2584 entry, but it can't because it is not fully valid.
2585 If it were in the termcap entry, it would confuse other programs. */
2586 if (!TS_set_window)
2587 {
2588 p = TS_termcap_modes;
2589 while (*p && strcmp (p, "\033v "))
2590 p++;
2591 if (*p)
2592 TS_set_window = "\033v%C %C %C %C ";
2593 }
2594 /* Termcap entry often fails to have :in: flag */
2595 must_write_spaces = 1;
2596 /* :ti string typically fails to have \E^G! in it */
2597 /* This limits scope of insert-char to one line. */
2598 strcpy (area, TS_termcap_modes);
2599 strcat (area, "\033\007!");
2600 TS_termcap_modes = area;
2601 area += strlen (area) + 1;
2602 p = AbsPosition;
2603 /* Change all %+ parameters to %C, to handle
2604 values above 96 correctly for the C100. */
2605 while (*p)
2606 {
2607 if (p[0] == '%' && p[1] == '+')
2608 p[1] = 'C';
2609 p++;
2610 }
2611 }
2612
2613 FrameRows = FRAME_LINES (sf);
2614 FrameCols = FRAME_COLS (sf);
2615 specified_window = FRAME_LINES (sf);
2616
2617 if (Wcm_init () == -1) /* can't do cursor motion */
2618 #ifdef VMS
2619 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2620 It lacks the ability to position the cursor.\n\
2621 If that is not the actual type of terminal you have, use either the\n\
2622 DCL command `SET TERMINAL/DEVICE= ...' for DEC-compatible terminals,\n\
2623 or `define EMACS_TERM \"terminal type\"' for non-DEC terminals.",
2624 terminal_type);
2625 #else /* not VMS */
2626 # ifdef TERMINFO
2627 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2628 It lacks the ability to position the cursor.\n\
2629 If that is not the actual type of terminal you have,\n\
2630 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2631 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2632 to do `unset TERMINFO' (C-shell: `unsetenv TERMINFO') as well.",
2633 terminal_type);
2634 # else /* TERMCAP */
2635 fatal ("Terminal type \"%s\" is not powerful enough to run Emacs.\n\
2636 It lacks the ability to position the cursor.\n\
2637 If that is not the actual type of terminal you have,\n\
2638 use the Bourne shell command `TERM=... export TERM' (C-shell:\n\
2639 `setenv TERM ...') to specify the correct type. It may be necessary\n\
2640 to do `unset TERMCAP' (C-shell: `unsetenv TERMCAP') as well.",
2641 terminal_type);
2642 # endif /* TERMINFO */
2643 #endif /*VMS */
2644 if (FRAME_LINES (sf) <= 0
2645 || FRAME_COLS (sf) <= 0)
2646 fatal ("The frame size has not been specified");
2647
2648 delete_in_insert_mode
2649 = TS_delete_mode && TS_insert_mode
2650 && !strcmp (TS_delete_mode, TS_insert_mode);
2651
2652 se_is_so = (TS_standout_mode
2653 && TS_end_standout_mode
2654 && !strcmp (TS_standout_mode, TS_end_standout_mode));
2655
2656 UseTabs = tabs_safe_p () && TabWidth == 8;
2657
2658 scroll_region_ok
2659 = (Wcm.cm_abs
2660 && (TS_set_window || TS_set_scroll_region || TS_set_scroll_region_1));
2661
2662 line_ins_del_ok = (((TS_ins_line || TS_ins_multi_lines)
2663 && (TS_del_line || TS_del_multi_lines))
2664 || (scroll_region_ok && TS_fwd_scroll && TS_rev_scroll));
2665
2666 char_ins_del_ok = ((TS_ins_char || TS_insert_mode
2667 || TS_pad_inserted_char || TS_ins_multi_chars)
2668 && (TS_del_char || TS_del_multi_chars));
2669
2670 fast_clear_end_of_line = TS_clr_line != 0;
2671
2672 init_baud_rate ();
2673 if (read_socket_hook) /* Baudrate is somewhat */
2674 /* meaningless in this case */
2675 baud_rate = 9600;
2676
2677 FRAME_CAN_HAVE_SCROLL_BARS (sf) = 0;
2678 FRAME_VERTICAL_SCROLL_BAR_TYPE (sf) = vertical_scroll_bar_none;
2679 #endif /* WINDOWSNT */
2680
2681 xfree (buffer);
2682 }
2683
2684 /* VARARGS 1 */
2685 void
2686 fatal (str, arg1, arg2)
2687 char *str, *arg1, *arg2;
2688 {
2689 fprintf (stderr, "emacs: ");
2690 fprintf (stderr, str, arg1, arg2);
2691 fprintf (stderr, "\n");
2692 fflush (stderr);
2693 exit (1);
2694 }
2695
2696 DEFUN ("tty-no-underline", Ftty_no_underline, Stty_no_underline, 0, 0, 0,
2697 doc: /* Declare that this terminal does not handle underlining.
2698 This is used to override the terminfo data, for certain terminals that
2699 do not really do underlining, but say that they do. */)
2700 ()
2701 {
2702 TS_enter_underline_mode = 0;
2703 return Qnil;
2704 }
2705
2706 void
2707 syms_of_term ()
2708 {
2709 DEFVAR_BOOL ("system-uses-terminfo", &system_uses_terminfo,
2710 doc: /* Non-nil means the system uses terminfo rather than termcap.
2711 This variable can be used by terminal emulator packages. */);
2712 #ifdef TERMINFO
2713 system_uses_terminfo = 1;
2714 #else
2715 system_uses_terminfo = 0;
2716 #endif
2717
2718 DEFVAR_LISP ("ring-bell-function", &Vring_bell_function,
2719 doc: /* Non-nil means call this function to ring the bell.
2720 The function should accept no arguments. */);
2721 Vring_bell_function = Qnil;
2722
2723 defsubr (&Stty_display_color_p);
2724 defsubr (&Stty_display_color_cells);
2725 defsubr (&Stty_no_underline);
2726 }
2727
2728 /* arch-tag: 498e7449-6f2e-45e2-91dd-b7d4ca488193
2729 (do not change this comment) */