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>
37
#include <grub/ieee1275/ieee1275.h>
40
GRUB_MOD_LICENSE ("GPLv3+");
43
#define ANSI_C0_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_C0_STR "%i%p1%d;%p2%dH");
136
data->cls = grub_strdup (ANSI_C0_STR "2J");
137
data->reverse_video_on = grub_strdup (ANSI_C0_STR "7m");
138
data->reverse_video_off = grub_strdup (ANSI_C0_STR "0m");
140
data->cursor_off = 0;
141
data->setcolor = grub_strdup (ANSI_C0_STR "3%p1%dm"
142
ANSI_C0_STR "4%p2%dm");
146
if (grub_strcmp ("ieee1275", str) == 0)
148
data->name = grub_strdup ("ieee1275");
149
data->gotoxy = grub_strdup ("\e[%i%p1%d;%p2%dH");
150
/* Clear the screen. Using serial console, screen(1) only recognizes the
151
* ANSI escape sequence. Using video console, Apple Open Firmware
152
* (version 3.1.1) only recognizes the literal ^L. So use both. */
153
data->cls = grub_strdup ("\e[2J");
154
data->reverse_video_on = grub_strdup ("\e[7m");
155
data->reverse_video_off = grub_strdup ("\e[m");
156
data->cursor_on = grub_strdup ("\e[?25h");
157
data->cursor_off = grub_strdup ("\e[?25l");
158
data->setcolor = grub_strdup ("\e[3%p1%dm\e[4%p2%dm");
162
if (grub_strcmp ("dumb", str) == 0)
164
data->name = grub_strdup ("dumb");
167
data->reverse_video_on = NULL;
168
data->reverse_video_off = NULL;
169
data->cursor_on = NULL;
170
data->cursor_off = NULL;
171
data->setcolor = NULL;
175
return grub_error (GRUB_ERR_BAD_ARGUMENT, N_("unknown terminfo type `%s'"),
180
grub_terminfo_output_register (struct grub_term_output *term,
184
struct grub_terminfo_output_state *data;
186
err = grub_terminfo_set_current (term, type);
191
data = (struct grub_terminfo_output_state *) term->data;
192
data->next = terminfo_outputs;
193
terminfo_outputs = term;
195
return GRUB_ERR_NONE;
199
grub_terminfo_output_unregister (struct grub_term_output *term)
201
struct grub_term_output **ptr;
203
for (ptr = &terminfo_outputs; *ptr;
204
ptr = &((struct grub_terminfo_output_state *) (*ptr)->data)->next)
207
grub_terminfo_all_free (term);
208
*ptr = ((struct grub_terminfo_output_state *) (*ptr)->data)->next;
209
return GRUB_ERR_NONE;
211
return grub_error (GRUB_ERR_BUG, "terminal not found");
214
/* Wrapper for grub_putchar to write strings. */
216
putstr (struct grub_term_output *term, const char *str)
218
struct grub_terminfo_output_state *data
219
= (struct grub_terminfo_output_state *) term->data;
221
data->put (term, *str++);
225
grub_terminfo_getxy (struct grub_term_output *term)
227
struct grub_terminfo_output_state *data
228
= (struct grub_terminfo_output_state *) term->data;
230
return ((data->xpos << 8) | data->ypos);
234
grub_terminfo_gotoxy (struct grub_term_output *term,
235
grub_uint8_t x, grub_uint8_t y)
237
struct grub_terminfo_output_state *data
238
= (struct grub_terminfo_output_state *) term->data;
240
if (x > grub_term_width (term) || y > grub_term_height (term))
242
grub_error (GRUB_ERR_BUG, "invalid point (%u,%u)", x, y);
247
putstr (term, grub_terminfo_tparm (data->gotoxy, y, x));
250
if ((y == data->ypos) && (x == data->xpos - 1))
251
data->put (term, '\b');
258
/* Clear the screen. */
260
grub_terminfo_cls (struct grub_term_output *term)
262
struct grub_terminfo_output_state *data
263
= (struct grub_terminfo_output_state *) term->data;
265
putstr (term, grub_terminfo_tparm (data->cls));
267
data->xpos = data->ypos = 0;
271
grub_terminfo_setcolorstate (struct grub_term_output *term,
272
const grub_term_color_state state)
274
struct grub_terminfo_output_state *data
275
= (struct grub_terminfo_output_state *) term->data;
281
/* Map from VGA to terminal colors. */
282
const int colormap[8]
295
case GRUB_TERM_COLOR_STANDARD:
296
case GRUB_TERM_COLOR_NORMAL:
297
fg = term->normal_color & 0x0f;
298
bg = term->normal_color >> 4;
300
case GRUB_TERM_COLOR_HIGHLIGHT:
301
fg = term->highlight_color & 0x0f;
302
bg = term->highlight_color >> 4;
308
putstr (term, grub_terminfo_tparm (data->setcolor, colormap[fg & 7],
315
case GRUB_TERM_COLOR_STANDARD:
316
case GRUB_TERM_COLOR_NORMAL:
317
putstr (term, grub_terminfo_tparm (data->reverse_video_off));
319
case GRUB_TERM_COLOR_HIGHLIGHT:
320
putstr (term, grub_terminfo_tparm (data->reverse_video_on));
328
grub_terminfo_setcursor (struct grub_term_output *term, const int on)
330
struct grub_terminfo_output_state *data
331
= (struct grub_terminfo_output_state *) term->data;
334
putstr (term, grub_terminfo_tparm (data->cursor_on));
336
putstr (term, grub_terminfo_tparm (data->cursor_off));
339
/* The terminfo version of putchar. */
341
grub_terminfo_putchar (struct grub_term_output *term,
342
const struct grub_unicode_glyph *c)
344
struct grub_terminfo_output_state *data
345
= (struct grub_terminfo_output_state *) term->data;
347
/* Keep track of the cursor. */
360
if (data->ypos < grub_term_height (term) - 1)
369
if (data->xpos + c->estimated_width >= grub_term_width (term) + 1)
372
if (data->ypos < grub_term_height (term) - 1)
374
data->put (term, '\r');
375
data->put (term, '\n');
377
data->xpos += c->estimated_width;
381
data->put (term, c->base);
385
grub_terminfo_getwh (struct grub_term_output *term)
387
struct grub_terminfo_output_state *data
388
= (struct grub_terminfo_output_state *) term->data;
390
return (data->width << 8) | data->height;
394
grub_terminfo_readkey (struct grub_term_input *term, int *keys, int *len,
395
int (*readkey) (struct grub_term_input *term))
399
#define CONTINUE_READ \
401
grub_uint64_t start; \
402
/* On 9600 we have to wait up to 12 milliseconds. */ \
403
start = grub_get_time_ms (); \
405
c = readkey (term); \
406
while (c == -1 && grub_get_time_ms () - start < 100); \
422
if (c != ANSI_C0 && c != '\e')
424
/* Backspace: Ctrl-h. */
427
if (c < 0x20 && c != '\t' && c!= '\b' && c != '\n' && c != '\r')
428
c = GRUB_TERM_CTRL | (c - 1 + 'a');
442
{'4', GRUB_TERM_KEY_DC},
443
{'A', GRUB_TERM_KEY_UP},
444
{'B', GRUB_TERM_KEY_DOWN},
445
{'C', GRUB_TERM_KEY_RIGHT},
446
{'D', GRUB_TERM_KEY_LEFT},
447
{'F', GRUB_TERM_KEY_END},
448
{'H', GRUB_TERM_KEY_HOME},
449
{'K', GRUB_TERM_KEY_END},
450
{'P', GRUB_TERM_KEY_DC},
451
{'?', GRUB_TERM_KEY_PPAGE},
452
{'/', GRUB_TERM_KEY_NPAGE},
453
{'@', GRUB_TERM_KEY_INSERT},
463
{'1', GRUB_TERM_KEY_HOME},
464
{'3', GRUB_TERM_KEY_DC},
465
{'5', GRUB_TERM_KEY_PPAGE},
466
{'6', GRUB_TERM_KEY_NPAGE}
469
{ 'P', 'Q', 'w', 'x', 't', 'u',
470
'q', 'r', 'p', 'M', 'A', 'B' };
472
{ GRUB_TERM_KEY_F1, GRUB_TERM_KEY_F2, GRUB_TERM_KEY_F3,
473
GRUB_TERM_KEY_F4, GRUB_TERM_KEY_F5, GRUB_TERM_KEY_F6,
474
GRUB_TERM_KEY_F7, GRUB_TERM_KEY_F8, GRUB_TERM_KEY_F9,
475
GRUB_TERM_KEY_F10, GRUB_TERM_KEY_F11, GRUB_TERM_KEY_F12 };
488
for (i = 0; i < ARRAY_SIZE (three_code_table); i++)
489
if (three_code_table[i].key == c)
491
keys[0] = three_code_table[i].ascii;
500
for (i = 0; i < ARRAY_SIZE (fx_key); i++)
503
keys[0] = fx_code[i];
513
if (c != '0' && c != '1')
515
num = (c - '0') * 10;
517
if (c < '0' || c > '9')
520
if (num == 0 || num > 12)
525
keys[0] = fx_code[num - 1];
531
for (i = 0; i < ARRAY_SIZE (four_code_table); i++)
532
if (four_code_table[i].key == c)
537
keys[0] = three_code_table[i].ascii;
547
/* The terminfo version of getkey. */
549
grub_terminfo_getkey (struct grub_term_input *termi)
551
struct grub_terminfo_input_state *data
552
= (struct grub_terminfo_input_state *) (termi->data);
557
ret = data->input_buf[0];
558
grub_memmove (data->input_buf, data->input_buf + 1, data->npending
559
* sizeof (data->input_buf[0]));
563
grub_terminfo_readkey (termi, data->input_buf,
564
&data->npending, data->readkey);
567
if (data->npending == 1 && data->input_buf[0] == '\e'
568
&& grub_ieee1275_test_flag (GRUB_IEEE1275_FLAG_BROKEN_REPEAT)
569
&& grub_get_time_ms () - data->last_key_time < 1000
570
&& (data->last_key & GRUB_TERM_EXTENDED))
573
data->last_key_time = grub_get_time_ms ();
574
return data->last_key;
582
ret = data->input_buf[0];
584
if (grub_ieee1275_test_flag (GRUB_IEEE1275_FLAG_BROKEN_REPEAT))
586
data->last_key = ret;
587
data->last_key_time = grub_get_time_ms ();
590
grub_memmove (data->input_buf, data->input_buf + 1, data->npending
591
* sizeof (data->input_buf[0]));
595
return GRUB_TERM_NO_KEY;
599
grub_terminfo_input_init (struct grub_term_input *termi)
601
struct grub_terminfo_input_state *data
602
= (struct grub_terminfo_input_state *) (termi->data);
605
return GRUB_ERR_NONE;
609
grub_terminfo_output_init (struct grub_term_output *term)
611
grub_terminfo_cls (term);
612
return GRUB_ERR_NONE;
618
print_terminfo (void)
620
const char *encoding_names[(GRUB_TERM_CODE_TYPE_MASK
621
>> GRUB_TERM_CODE_TYPE_SHIFT) + 1]
623
/* VGA and glyph descriptor types are just for completeness,
624
they are not used on terminfo terminals.
626
[GRUB_TERM_CODE_TYPE_ASCII >> GRUB_TERM_CODE_TYPE_SHIFT] = _("ASCII"),
627
[GRUB_TERM_CODE_TYPE_CP437 >> GRUB_TERM_CODE_TYPE_SHIFT] = "CP-437",
628
[GRUB_TERM_CODE_TYPE_UTF8_LOGICAL >> GRUB_TERM_CODE_TYPE_SHIFT]
630
[GRUB_TERM_CODE_TYPE_UTF8_VISUAL >> GRUB_TERM_CODE_TYPE_SHIFT]
631
/* TRANSLATORS: visually ordered UTF-8 is a non-compliant encoding
632
based on UTF-8 with right-to-left languages written in reverse.
633
Used on some terminals. Normal UTF-8 is refered as
634
"logically-ordered UTF-8" by opposition. */
635
= _("visually-ordered UTF-8"),
636
[GRUB_TERM_CODE_TYPE_VISUAL_GLYPHS >> GRUB_TERM_CODE_TYPE_SHIFT]
637
= "Glyph descriptors",
638
_("Unknown encoding"), _("Unknown encoding"), _("Unknown encoding")
640
struct grub_term_output *cur;
642
grub_puts_ (N_("Current terminfo types:"));
643
for (cur = terminfo_outputs; cur;
644
cur = ((struct grub_terminfo_output_state *) cur->data)->next)
645
grub_printf ("%s: %s\t%s\t%dx%d\n", cur->name,
646
grub_terminfo_get_current(cur),
647
encoding_names[(cur->flags & GRUB_TERM_CODE_TYPE_MASK)
648
>> GRUB_TERM_CODE_TYPE_SHIFT],
649
((struct grub_terminfo_output_state *) cur->data)->width,
650
((struct grub_terminfo_output_state *) cur->data)->height);
652
return GRUB_ERR_NONE;
655
static const struct grub_arg_option options[] =
657
{"ascii", 'a', 0, N_("Terminal is ASCII-only [default]."), 0, ARG_TYPE_NONE},
658
{"utf8", 'u', 0, N_("Terminal is logical-ordered UTF-8."), 0, ARG_TYPE_NONE},
659
{"visual-utf8", 'v', 0, N_("Terminal is visually-ordered UTF-8."), 0,
661
{"geometry", 'g', 0, N_("Terminal has specified geometry."),
662
/* TRANSLATORS: "x" has to be entered in, like an identifier, so please don't
663
use better Unicode codepoints. */
664
N_("WIDTHxHEIGHT."), ARG_TYPE_STRING},
677
grub_cmd_terminfo (grub_extcmd_context_t ctxt, int argc, char **args)
679
struct grub_term_output *cur;
680
int encoding = GRUB_TERM_CODE_TYPE_ASCII;
681
struct grub_arg_list *state = ctxt->state;
685
return print_terminfo ();
687
if (state[OPTION_ASCII].set)
688
encoding = GRUB_TERM_CODE_TYPE_ASCII;
690
if (state[OPTION_UTF8].set)
691
encoding = GRUB_TERM_CODE_TYPE_UTF8_LOGICAL;
693
if (state[OPTION_VISUAL_UTF8].set)
694
encoding = GRUB_TERM_CODE_TYPE_UTF8_VISUAL;
696
if (state[OPTION_GEOMETRY].set)
698
char *ptr = state[OPTION_GEOMETRY].arg;
699
w = grub_strtoul (ptr, &ptr, 0);
703
return grub_error (GRUB_ERR_BAD_ARGUMENT,
704
N_("incorrect terminal dimensions specification"));
706
h = grub_strtoul (ptr, &ptr, 0);
711
for (cur = terminfo_outputs; cur;
712
cur = ((struct grub_terminfo_output_state *) cur->data)->next)
713
if (grub_strcmp (args[0], cur->name) == 0
714
|| (grub_strcmp (args[0], "ofconsole") == 0
715
&& grub_strcmp ("console", cur->name) == 0))
717
cur->flags = (cur->flags & ~GRUB_TERM_CODE_TYPE_MASK) | encoding;
721
struct grub_terminfo_output_state *data
722
= (struct grub_terminfo_output_state *) cur->data;
728
return GRUB_ERR_NONE;
730
return grub_terminfo_set_current (cur, args[1]);
733
return grub_error (GRUB_ERR_BAD_ARGUMENT,
734
N_("terminal %s isn't found or it's not handled by terminfo"),
738
static grub_extcmd_t cmd;
740
#if defined (GRUB_MACHINE_IEEE1275) || defined (GRUB_MACHINE_MIPS_LOONGSON) || defined (GRUB_MACHINE_MIPS_QEMU_MIPS) || defined (GRUB_MACHINE_ARC)
741
void grub_terminfo_init (void)
743
GRUB_MOD_INIT(terminfo)
746
cmd = grub_register_extcmd ("terminfo", grub_cmd_terminfo, 0,
747
N_("[[-a|-u|-v] [-g WxH] TERM [TYPE]]"),
748
N_("Set terminfo type of TERM to TYPE.\n"),
752
#if defined (GRUB_MACHINE_IEEE1275) || defined (GRUB_MACHINE_MIPS_LOONGSON) || defined (GRUB_MACHINE_MIPS_QEMU_MIPS) || defined (GRUB_MACHINE_ARC)
753
void grub_terminfo_fini (void)
755
GRUB_MOD_FINI(terminfo)
758
grub_unregister_extcmd (cmd);