1 /* terminfo.c - simple terminfo module */
3 * GRUB -- GRand Unified Bootloader
4 * Copyright (C) 2003,2004,2005,2007 Free Software Foundation, Inc.
6 * GRUB is free software: you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation, either version 3 of the License, or
9 * (at your option) any later version.
11 * GRUB is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with GRUB. If not, see <http://www.gnu.org/licenses/>.
21 * This file contains various functions dealing with different
22 * terminal capabilities. For example, vt52 and vt100.
25 #include <grub/types.h>
26 #include <grub/misc.h>
30 #include <grub/term.h>
31 #include <grub/terminfo.h>
32 #include <grub/tparm.h>
33 #include <grub/extcmd.h>
34 #include <grub/i18n.h>
35 #include <grub/time.h>
36 #if defined(__powerpc__) && defined(GRUB_MACHINE_IEEE1275)
37 #include <grub/ieee1275/ieee1275.h>
40 GRUB_MOD_LICENSE ("GPLv3+");
43 #define ANSI_CSI_STR "\x9b"
45 static struct grub_term_output
*terminfo_outputs
;
47 /* Get current terminfo name. */
49 grub_terminfo_get_current (struct grub_term_output
*term
)
51 struct grub_terminfo_output_state
*data
52 = (struct grub_terminfo_output_state
*) term
->data
;
56 /* Free *PTR and set *PTR to NULL, to prevent double-free. */
58 grub_terminfo_free (char **ptr
)
65 grub_terminfo_all_free (struct grub_term_output
*term
)
67 struct grub_terminfo_output_state
*data
68 = (struct grub_terminfo_output_state
*) term
->data
;
70 /* Free previously allocated memory. */
71 grub_terminfo_free (&data
->name
);
72 grub_terminfo_free (&data
->gotoxy
);
73 grub_terminfo_free (&data
->cls
);
74 grub_terminfo_free (&data
->reverse_video_on
);
75 grub_terminfo_free (&data
->reverse_video_off
);
76 grub_terminfo_free (&data
->cursor_on
);
77 grub_terminfo_free (&data
->cursor_off
);
80 /* Set current terminfo type. */
82 grub_terminfo_set_current (struct grub_term_output
*term
,
85 struct grub_terminfo_output_state
*data
86 = (struct grub_terminfo_output_state
*) term
->data
;
88 * Lookup user specified terminfo type. If found, set term variables
89 * as appropriate. Otherwise return an error.
91 * How should this be done?
92 * a. A static table included in this module.
93 * - I do not like this idea.
94 * b. A table stored in the configuration directory.
95 * - Users must convert their terminfo settings if we have not already.
96 * c. Look for terminfo files in the configuration directory.
97 * - /usr/share/terminfo is 6.3M on my system.
98 * - /usr/share/terminfo is not on most users boot partition.
99 * + Copying the terminfo files you want to use to the grub
100 * configuration directory is easier then (b).
104 grub_terminfo_all_free (term
);
106 if (grub_strcmp ("vt100", str
) == 0)
108 data
->name
= grub_strdup ("vt100");
109 data
->gotoxy
= grub_strdup ("\e[%i%p1%d;%p2%dH");
110 data
->cls
= grub_strdup ("\e[H\e[J");
111 data
->reverse_video_on
= grub_strdup ("\e[7m");
112 data
->reverse_video_off
= grub_strdup ("\e[m");
113 data
->cursor_on
= grub_strdup ("\e[?25h");
114 data
->cursor_off
= grub_strdup ("\e[?25l");
115 data
->setcolor
= NULL
;
119 if (grub_strcmp ("vt100-color", str
) == 0)
121 data
->name
= grub_strdup ("vt100-color");
122 data
->gotoxy
= grub_strdup ("\e[%i%p1%d;%p2%dH");
123 data
->cls
= grub_strdup ("\e[H\e[J");
124 data
->reverse_video_on
= grub_strdup ("\e[7m");
125 data
->reverse_video_off
= grub_strdup ("\e[m");
126 data
->cursor_on
= grub_strdup ("\e[?25h");
127 data
->cursor_off
= grub_strdup ("\e[?25l");
128 data
->setcolor
= grub_strdup ("\e[3%p1%dm\e[4%p2%dm");
132 if (grub_strcmp ("arc", str
) == 0)
134 data
->name
= grub_strdup ("arc");
135 data
->gotoxy
= grub_strdup (ANSI_CSI_STR
"%i%p1%d;%p2%dH");
136 data
->cls
= grub_strdup (ANSI_CSI_STR
"2J");
137 data
->reverse_video_on
= grub_strdup (ANSI_CSI_STR
"7m");
138 data
->reverse_video_off
= grub_strdup (ANSI_CSI_STR
"0m");
140 data
->cursor_off
= 0;
141 data
->setcolor
= grub_strdup (ANSI_CSI_STR
"3%p1%dm"
142 ANSI_CSI_STR
"4%p2%dm");
146 if (grub_strcmp ("ieee1275", str
) == 0
147 || grub_strcmp ("ieee1275-nocursor", str
) == 0)
149 data
->name
= grub_strdup ("ieee1275");
150 data
->gotoxy
= grub_strdup ("\e[%i%p1%d;%p2%dH");
151 /* Clear the screen. Using serial console, screen(1) only recognizes the
152 * ANSI escape sequence. Using video console, Apple Open Firmware
153 * (version 3.1.1) only recognizes the literal ^L. So use both. */
154 data
->cls
= grub_strdup ("\f\e[2J");
155 data
->reverse_video_on
= grub_strdup ("\e[7m");
156 data
->reverse_video_off
= grub_strdup ("\e[m");
157 if (grub_strcmp ("ieee1275", str
) == 0)
159 data
->cursor_on
= grub_strdup ("\e[?25h");
160 data
->cursor_off
= grub_strdup ("\e[?25l");
165 data
->cursor_off
= 0;
167 data
->setcolor
= grub_strdup ("\e[3%p1%dm\e[4%p2%dm");
171 if (grub_strcmp ("dumb", str
) == 0)
173 data
->name
= grub_strdup ("dumb");
176 data
->reverse_video_on
= NULL
;
177 data
->reverse_video_off
= NULL
;
178 data
->cursor_on
= NULL
;
179 data
->cursor_off
= NULL
;
180 data
->setcolor
= NULL
;
184 return grub_error (GRUB_ERR_BAD_ARGUMENT
, N_("unknown terminfo type `%s'"),
189 grub_terminfo_output_register (struct grub_term_output
*term
,
193 struct grub_terminfo_output_state
*data
;
195 err
= grub_terminfo_set_current (term
, type
);
200 data
= (struct grub_terminfo_output_state
*) term
->data
;
201 data
->next
= terminfo_outputs
;
202 terminfo_outputs
= term
;
204 return GRUB_ERR_NONE
;
208 grub_terminfo_output_unregister (struct grub_term_output
*term
)
210 struct grub_term_output
**ptr
;
212 for (ptr
= &terminfo_outputs
; *ptr
;
213 ptr
= &((struct grub_terminfo_output_state
*) (*ptr
)->data
)->next
)
216 grub_terminfo_all_free (term
);
217 *ptr
= ((struct grub_terminfo_output_state
*) (*ptr
)->data
)->next
;
218 return GRUB_ERR_NONE
;
220 return grub_error (GRUB_ERR_BUG
, "terminal not found");
223 /* Wrapper for grub_putchar to write strings. */
225 putstr (struct grub_term_output
*term
, const char *str
)
227 struct grub_terminfo_output_state
*data
228 = (struct grub_terminfo_output_state
*) term
->data
;
230 data
->put (term
, *str
++);
233 struct grub_term_coordinate
234 grub_terminfo_getxy (struct grub_term_output
*term
)
236 struct grub_terminfo_output_state
*data
237 = (struct grub_terminfo_output_state
*) term
->data
;
243 grub_terminfo_gotoxy (struct grub_term_output
*term
,
244 struct grub_term_coordinate pos
)
246 struct grub_terminfo_output_state
*data
247 = (struct grub_terminfo_output_state
*) term
->data
;
249 if (pos
.x
> grub_term_width (term
) || pos
.y
> grub_term_height (term
))
251 grub_error (GRUB_ERR_BUG
, "invalid point (%u,%u)", pos
.x
, pos
.y
);
256 putstr (term
, grub_terminfo_tparm (data
->gotoxy
, pos
.y
, pos
.x
));
259 if ((pos
.y
== data
->pos
.y
) && (pos
.x
== data
->pos
.x
- 1))
260 data
->put (term
, '\b');
266 /* Clear the screen. */
268 grub_terminfo_cls (struct grub_term_output
*term
)
270 struct grub_terminfo_output_state
*data
271 = (struct grub_terminfo_output_state
*) term
->data
;
273 putstr (term
, grub_terminfo_tparm (data
->cls
));
274 grub_terminfo_gotoxy (term
, (struct grub_term_coordinate
) { 0, 0 });
278 grub_terminfo_setcolorstate (struct grub_term_output
*term
,
279 const grub_term_color_state state
)
281 struct grub_terminfo_output_state
*data
282 = (struct grub_terminfo_output_state
*) term
->data
;
288 /* Map from VGA to terminal colors. */
289 const int colormap
[8]
302 case GRUB_TERM_COLOR_STANDARD
:
303 case GRUB_TERM_COLOR_NORMAL
:
304 fg
= grub_term_normal_color
& 0x0f;
305 bg
= grub_term_normal_color
>> 4;
307 case GRUB_TERM_COLOR_HIGHLIGHT
:
308 fg
= grub_term_highlight_color
& 0x0f;
309 bg
= grub_term_highlight_color
>> 4;
315 putstr (term
, grub_terminfo_tparm (data
->setcolor
, colormap
[fg
& 7],
322 case GRUB_TERM_COLOR_STANDARD
:
323 case GRUB_TERM_COLOR_NORMAL
:
324 putstr (term
, grub_terminfo_tparm (data
->reverse_video_off
));
326 case GRUB_TERM_COLOR_HIGHLIGHT
:
327 putstr (term
, grub_terminfo_tparm (data
->reverse_video_on
));
335 grub_terminfo_setcursor (struct grub_term_output
*term
, const int on
)
337 struct grub_terminfo_output_state
*data
338 = (struct grub_terminfo_output_state
*) term
->data
;
341 putstr (term
, grub_terminfo_tparm (data
->cursor_on
));
343 putstr (term
, grub_terminfo_tparm (data
->cursor_off
));
346 /* The terminfo version of putchar. */
348 grub_terminfo_putchar (struct grub_term_output
*term
,
349 const struct grub_unicode_glyph
*c
)
351 struct grub_terminfo_output_state
*data
352 = (struct grub_terminfo_output_state
*) term
->data
;
354 /* Keep track of the cursor. */
367 if (data
->pos
.y
< grub_term_height (term
) - 1)
376 if ((int) data
->pos
.x
+ c
->estimated_width
>= (int) grub_term_width (term
) + 1)
379 if (data
->pos
.y
< grub_term_height (term
) - 1)
381 data
->put (term
, '\r');
382 data
->put (term
, '\n');
384 data
->pos
.x
+= c
->estimated_width
;
388 data
->put (term
, c
->base
);
391 struct grub_term_coordinate
392 grub_terminfo_getwh (struct grub_term_output
*term
)
394 struct grub_terminfo_output_state
*data
395 = (struct grub_terminfo_output_state
*) term
->data
;
401 grub_terminfo_readkey (struct grub_term_input
*term
, int *keys
, int *len
,
402 int (*readkey
) (struct grub_term_input
*term
))
406 #define CONTINUE_READ \
408 grub_uint64_t start; \
409 /* On 9600 we have to wait up to 12 milliseconds. */ \
410 start = grub_get_time_ms (); \
412 c = readkey (term); \
413 while (c == -1 && grub_get_time_ms () - start < 100); \
429 if (c
!= ANSI_CSI
&& c
!= '\e')
431 /* Backspace: Ctrl-h. */
434 if (c
< 0x20 && c
!= '\t' && c
!= '\b' && c
!= '\n' && c
!= '\r')
435 c
= GRUB_TERM_CTRL
| (c
- 1 + 'a');
449 {'4', GRUB_TERM_KEY_DC
},
450 {'A', GRUB_TERM_KEY_UP
},
451 {'B', GRUB_TERM_KEY_DOWN
},
452 {'C', GRUB_TERM_KEY_RIGHT
},
453 {'D', GRUB_TERM_KEY_LEFT
},
454 {'F', GRUB_TERM_KEY_END
},
455 {'H', GRUB_TERM_KEY_HOME
},
456 {'K', GRUB_TERM_KEY_END
},
457 {'P', GRUB_TERM_KEY_DC
},
458 {'?', GRUB_TERM_KEY_PPAGE
},
459 {'/', GRUB_TERM_KEY_NPAGE
},
460 {'@', GRUB_TERM_KEY_INSERT
},
463 static unsigned four_code_table
[] =
465 [1] = GRUB_TERM_KEY_HOME
,
466 [3] = GRUB_TERM_KEY_DC
,
467 [5] = GRUB_TERM_KEY_PPAGE
,
468 [6] = GRUB_TERM_KEY_NPAGE
,
469 [7] = GRUB_TERM_KEY_HOME
,
470 [8] = GRUB_TERM_KEY_END
,
471 [17] = GRUB_TERM_KEY_F6
,
472 [18] = GRUB_TERM_KEY_F7
,
473 [19] = GRUB_TERM_KEY_F8
,
474 [20] = GRUB_TERM_KEY_F9
,
475 [21] = GRUB_TERM_KEY_F10
,
476 [23] = GRUB_TERM_KEY_F11
,
477 [24] = GRUB_TERM_KEY_F12
,
480 { 'P', 'Q', 'w', 'x', 't', 'u',
481 'q', 'r', 'p', 'M', 'A', 'B', 'H', 'F' };
483 { GRUB_TERM_KEY_F1
, GRUB_TERM_KEY_F2
, GRUB_TERM_KEY_F3
,
484 GRUB_TERM_KEY_F4
, GRUB_TERM_KEY_F5
, GRUB_TERM_KEY_F6
,
485 GRUB_TERM_KEY_F7
, GRUB_TERM_KEY_F8
, GRUB_TERM_KEY_F9
,
486 GRUB_TERM_KEY_F10
, GRUB_TERM_KEY_F11
, GRUB_TERM_KEY_F12
,
487 GRUB_TERM_KEY_HOME
, GRUB_TERM_KEY_END
};
498 for (i
= 0; i
< ARRAY_SIZE (fx_key
); i
++)
501 keys
[0] = fx_code
[i
];
513 for (i
= 0; i
< ARRAY_SIZE (three_code_table
); i
++)
514 if (three_code_table
[i
].key
== c
)
516 keys
[0] = three_code_table
[i
].ascii
;
525 if (c
>= 'A' && c
<= 'E')
527 keys
[0] = GRUB_TERM_KEY_F1
+ c
- 'A';
534 for (i
= 0; i
< ARRAY_SIZE (fx_key
); i
++)
537 keys
[0] = fx_code
[i
];
547 if (c
!= '0' && c
!= '1')
549 num
= (c
- '0') * 10;
551 if (c
< '0' || c
> '9')
554 if (num
== 0 || num
> 12)
559 keys
[0] = fx_code
[num
- 1];
566 unsigned val
= c
- '0';
568 if (c
>= '0' && c
<= '9')
570 val
= val
* 10 + (c
- '0');
575 if (val
>= ARRAY_SIZE (four_code_table
)
576 || four_code_table
[val
] == 0)
578 keys
[0] = four_code_table
[val
];
589 /* The terminfo version of getkey. */
591 grub_terminfo_getkey (struct grub_term_input
*termi
)
593 struct grub_terminfo_input_state
*data
594 = (struct grub_terminfo_input_state
*) (termi
->data
);
599 ret
= data
->input_buf
[0];
600 grub_memmove (data
->input_buf
, data
->input_buf
+ 1, data
->npending
601 * sizeof (data
->input_buf
[0]));
605 grub_terminfo_readkey (termi
, data
->input_buf
,
606 &data
->npending
, data
->readkey
);
608 #if defined(__powerpc__) && defined(GRUB_MACHINE_IEEE1275)
609 if (data
->npending
== 1 && data
->input_buf
[0] == '\e'
610 && grub_ieee1275_test_flag (GRUB_IEEE1275_FLAG_BROKEN_REPEAT
)
611 && grub_get_time_ms () - data
->last_key_time
< 1000
612 && (data
->last_key
& GRUB_TERM_EXTENDED
))
615 data
->last_key_time
= grub_get_time_ms ();
616 return data
->last_key
;
624 ret
= data
->input_buf
[0];
625 #if defined(__powerpc__) && defined(GRUB_MACHINE_IEEE1275)
626 if (grub_ieee1275_test_flag (GRUB_IEEE1275_FLAG_BROKEN_REPEAT
))
628 data
->last_key
= ret
;
629 data
->last_key_time
= grub_get_time_ms ();
632 grub_memmove (data
->input_buf
, data
->input_buf
+ 1, data
->npending
633 * sizeof (data
->input_buf
[0]));
637 return GRUB_TERM_NO_KEY
;
641 grub_terminfo_input_init (struct grub_term_input
*termi
)
643 struct grub_terminfo_input_state
*data
644 = (struct grub_terminfo_input_state
*) (termi
->data
);
647 return GRUB_ERR_NONE
;
651 grub_terminfo_output_init (struct grub_term_output
*term
)
653 grub_terminfo_cls (term
);
654 return GRUB_ERR_NONE
;
660 print_terminfo (void)
662 const char *encoding_names
[(GRUB_TERM_CODE_TYPE_MASK
663 >> GRUB_TERM_CODE_TYPE_SHIFT
) + 1]
665 /* VGA and glyph descriptor types are just for completeness,
666 they are not used on terminfo terminals.
668 [GRUB_TERM_CODE_TYPE_ASCII
>> GRUB_TERM_CODE_TYPE_SHIFT
] = _("ASCII"),
669 [GRUB_TERM_CODE_TYPE_CP437
>> GRUB_TERM_CODE_TYPE_SHIFT
] = "CP-437",
670 [GRUB_TERM_CODE_TYPE_UTF8_LOGICAL
>> GRUB_TERM_CODE_TYPE_SHIFT
]
672 [GRUB_TERM_CODE_TYPE_UTF8_VISUAL
>> GRUB_TERM_CODE_TYPE_SHIFT
]
673 /* TRANSLATORS: visually ordered UTF-8 is a non-compliant encoding
674 based on UTF-8 with right-to-left languages written in reverse.
675 Used on some terminals. Normal UTF-8 is refered as
676 "logically-ordered UTF-8" by opposition. */
677 = _("visually-ordered UTF-8"),
678 [GRUB_TERM_CODE_TYPE_VISUAL_GLYPHS
>> GRUB_TERM_CODE_TYPE_SHIFT
]
679 = "Glyph descriptors",
680 _("Unknown encoding"), _("Unknown encoding"), _("Unknown encoding")
682 struct grub_term_output
*cur
;
684 grub_puts_ (N_("Current terminfo types:"));
685 for (cur
= terminfo_outputs
; cur
;
686 cur
= ((struct grub_terminfo_output_state
*) cur
->data
)->next
)
687 grub_printf ("%s: %s\t%s\t%dx%d\n", cur
->name
,
688 grub_terminfo_get_current(cur
),
689 encoding_names
[(cur
->flags
& GRUB_TERM_CODE_TYPE_MASK
)
690 >> GRUB_TERM_CODE_TYPE_SHIFT
],
691 ((struct grub_terminfo_output_state
*) cur
->data
)->pos
.x
,
692 ((struct grub_terminfo_output_state
*) cur
->data
)->pos
.y
);
694 return GRUB_ERR_NONE
;
697 static const struct grub_arg_option options
[] =
699 {"ascii", 'a', 0, N_("Terminal is ASCII-only [default]."), 0, ARG_TYPE_NONE
},
700 {"utf8", 'u', 0, N_("Terminal is logical-ordered UTF-8."), 0, ARG_TYPE_NONE
},
701 {"visual-utf8", 'v', 0, N_("Terminal is visually-ordered UTF-8."), 0,
703 {"geometry", 'g', 0, N_("Terminal has specified geometry."),
704 /* TRANSLATORS: "x" has to be entered in, like an identifier, so please don't
705 use better Unicode codepoints. */
706 N_("WIDTHxHEIGHT."), ARG_TYPE_STRING
},
719 grub_cmd_terminfo (grub_extcmd_context_t ctxt
, int argc
, char **args
)
721 struct grub_term_output
*cur
;
722 int encoding
= GRUB_TERM_CODE_TYPE_ASCII
;
723 struct grub_arg_list
*state
= ctxt
->state
;
727 return print_terminfo ();
729 if (state
[OPTION_ASCII
].set
)
730 encoding
= GRUB_TERM_CODE_TYPE_ASCII
;
732 if (state
[OPTION_UTF8
].set
)
733 encoding
= GRUB_TERM_CODE_TYPE_UTF8_LOGICAL
;
735 if (state
[OPTION_VISUAL_UTF8
].set
)
736 encoding
= GRUB_TERM_CODE_TYPE_UTF8_VISUAL
;
738 if (state
[OPTION_GEOMETRY
].set
)
740 char *ptr
= state
[OPTION_GEOMETRY
].arg
;
741 w
= grub_strtoul (ptr
, &ptr
, 0);
745 return grub_error (GRUB_ERR_BAD_ARGUMENT
,
746 N_("incorrect terminal dimensions specification"));
748 h
= grub_strtoul (ptr
, &ptr
, 0);
753 for (cur
= terminfo_outputs
; cur
;
754 cur
= ((struct grub_terminfo_output_state
*) cur
->data
)->next
)
755 if (grub_strcmp (args
[0], cur
->name
) == 0
756 || (grub_strcmp (args
[0], "ofconsole") == 0
757 && grub_strcmp ("console", cur
->name
) == 0))
759 cur
->flags
= (cur
->flags
& ~GRUB_TERM_CODE_TYPE_MASK
) | encoding
;
763 struct grub_terminfo_output_state
*data
764 = (struct grub_terminfo_output_state
*) cur
->data
;
770 return GRUB_ERR_NONE
;
772 return grub_terminfo_set_current (cur
, args
[1]);
775 return grub_error (GRUB_ERR_BAD_ARGUMENT
,
776 N_("terminal %s isn't found or it's not handled by terminfo"),
780 static grub_extcmd_t cmd
;
782 GRUB_MOD_INIT(terminfo
)
784 cmd
= grub_register_extcmd ("terminfo", grub_cmd_terminfo
, 0,
785 N_("[[-a|-u|-v] [-g WxH] TERM [TYPE]]"),
786 N_("Set terminfo type of TERM to TYPE.\n"),
790 GRUB_MOD_FINI(terminfo
)
792 grub_unregister_extcmd (cmd
);