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
static struct grub_term_output *terminfo_outputs;
39
/* Get current terminfo name. */
41
grub_terminfo_get_current (struct grub_term_output *term)
43
struct grub_terminfo_output_state *data
44
= (struct grub_terminfo_output_state *) term->data;
48
/* Free *PTR and set *PTR to NULL, to prevent double-free. */
50
grub_terminfo_free (char **ptr)
57
grub_terminfo_all_free (struct grub_term_output *term)
59
struct grub_terminfo_output_state *data
60
= (struct grub_terminfo_output_state *) term->data;
62
/* Free previously allocated memory. */
63
grub_terminfo_free (&data->name);
64
grub_terminfo_free (&data->gotoxy);
65
grub_terminfo_free (&data->cls);
66
grub_terminfo_free (&data->reverse_video_on);
67
grub_terminfo_free (&data->reverse_video_off);
68
grub_terminfo_free (&data->cursor_on);
69
grub_terminfo_free (&data->cursor_off);
72
/* Set current terminfo type. */
74
grub_terminfo_set_current (struct grub_term_output *term,
77
struct grub_terminfo_output_state *data
78
= (struct grub_terminfo_output_state *) term->data;
80
* Lookup user specified terminfo type. If found, set term variables
81
* as appropriate. Otherwise return an error.
83
* How should this be done?
84
* a. A static table included in this module.
85
* - I do not like this idea.
86
* b. A table stored in the configuration directory.
87
* - Users must convert their terminfo settings if we have not already.
88
* c. Look for terminfo files in the configuration directory.
89
* - /usr/share/terminfo is 6.3M on my system.
90
* - /usr/share/terminfo is not on most users boot partition.
91
* + Copying the terminfo files you want to use to the grub
92
* configuration directory is easier then (b).
96
grub_terminfo_all_free (term);
98
if (grub_strcmp ("vt100", str) == 0)
100
data->name = grub_strdup ("vt100");
101
data->gotoxy = grub_strdup ("\e[%i%p1%d;%p2%dH");
102
data->cls = grub_strdup ("\e[H\e[J");
103
data->reverse_video_on = grub_strdup ("\e[7m");
104
data->reverse_video_off = grub_strdup ("\e[m");
105
data->cursor_on = grub_strdup ("\e[?25h");
106
data->cursor_off = grub_strdup ("\e[?25l");
107
data->setcolor = NULL;
111
if (grub_strcmp ("vt100-color", str) == 0)
113
data->name = grub_strdup ("vt100-color");
114
data->gotoxy = grub_strdup ("\e[%i%p1%d;%p2%dH");
115
data->cls = grub_strdup ("\e[H\e[J");
116
data->reverse_video_on = grub_strdup ("\e[7m");
117
data->reverse_video_off = grub_strdup ("\e[m");
118
data->cursor_on = grub_strdup ("\e[?25h");
119
data->cursor_off = grub_strdup ("\e[?25l");
120
data->setcolor = grub_strdup ("\e[3%p1%dm\e[4%p2%dm");
124
if (grub_strcmp ("ieee1275", str) == 0)
126
data->name = grub_strdup ("ieee1275");
127
data->gotoxy = grub_strdup ("\e[%i%p1%d;%p2%dH");
128
/* Clear the screen. Using serial console, screen(1) only recognizes the
129
* ANSI escape sequence. Using video console, Apple Open Firmware
130
* (version 3.1.1) only recognizes the literal ^L. So use both. */
131
data->cls = grub_strdup ("\e[2J");
132
data->reverse_video_on = grub_strdup ("\e[7m");
133
data->reverse_video_off = grub_strdup ("\e[m");
134
data->cursor_on = grub_strdup ("\e[?25h");
135
data->cursor_off = grub_strdup ("\e[?25l");
136
data->setcolor = grub_strdup ("\e[3%p1%dm\e[4%p2%dm");
140
if (grub_strcmp ("dumb", str) == 0)
142
data->name = grub_strdup ("dumb");
145
data->reverse_video_on = NULL;
146
data->reverse_video_off = NULL;
147
data->cursor_on = NULL;
148
data->cursor_off = NULL;
149
data->setcolor = NULL;
153
return grub_error (GRUB_ERR_BAD_ARGUMENT, "unknown terminfo type");
157
grub_terminfo_output_register (struct grub_term_output *term,
161
struct grub_terminfo_output_state *data;
163
err = grub_terminfo_set_current (term, type);
168
data = (struct grub_terminfo_output_state *) term->data;
169
data->next = terminfo_outputs;
170
terminfo_outputs = term;
172
return GRUB_ERR_NONE;
176
grub_terminfo_output_unregister (struct grub_term_output *term)
178
struct grub_term_output **ptr;
180
for (ptr = &terminfo_outputs; *ptr;
181
ptr = &((struct grub_terminfo_output_state *) (*ptr)->data)->next)
184
grub_terminfo_all_free (term);
185
*ptr = ((struct grub_terminfo_output_state *) (*ptr)->data)->next;
186
return GRUB_ERR_NONE;
188
return grub_error (GRUB_ERR_BAD_ARGUMENT, "terminal not found");
191
/* Wrapper for grub_putchar to write strings. */
193
putstr (struct grub_term_output *term, const char *str)
195
struct grub_terminfo_output_state *data
196
= (struct grub_terminfo_output_state *) term->data;
198
data->put (term, *str++);
202
grub_terminfo_getxy (struct grub_term_output *term)
204
struct grub_terminfo_output_state *data
205
= (struct grub_terminfo_output_state *) term->data;
207
return ((data->xpos << 8) | data->ypos);
211
grub_terminfo_gotoxy (struct grub_term_output *term,
212
grub_uint8_t x, grub_uint8_t y)
214
struct grub_terminfo_output_state *data
215
= (struct grub_terminfo_output_state *) term->data;
217
if (x > grub_term_width (term) || y > grub_term_height (term))
219
grub_error (GRUB_ERR_OUT_OF_RANGE, "invalid point (%u,%u)", x, y);
224
putstr (term, grub_terminfo_tparm (data->gotoxy, y, x));
227
if ((y == data->ypos) && (x == data->xpos - 1))
228
data->put (term, '\b');
235
/* Clear the screen. */
237
grub_terminfo_cls (struct grub_term_output *term)
239
struct grub_terminfo_output_state *data
240
= (struct grub_terminfo_output_state *) term->data;
242
putstr (term, grub_terminfo_tparm (data->cls));
244
data->xpos = data->ypos = 0;
248
grub_terminfo_setcolorstate (struct grub_term_output *term,
249
const grub_term_color_state state)
251
struct grub_terminfo_output_state *data
252
= (struct grub_terminfo_output_state *) term->data;
258
/* Map from VGA to terminal colors. */
259
const int colormap[8]
272
case GRUB_TERM_COLOR_STANDARD:
273
case GRUB_TERM_COLOR_NORMAL:
274
fg = term->normal_color & 0x0f;
275
bg = term->normal_color >> 4;
277
case GRUB_TERM_COLOR_HIGHLIGHT:
278
fg = term->highlight_color & 0x0f;
279
bg = term->highlight_color >> 4;
285
putstr (term, grub_terminfo_tparm (data->setcolor, colormap[fg & 7],
292
case GRUB_TERM_COLOR_STANDARD:
293
case GRUB_TERM_COLOR_NORMAL:
294
putstr (term, grub_terminfo_tparm (data->reverse_video_off));
296
case GRUB_TERM_COLOR_HIGHLIGHT:
297
putstr (term, grub_terminfo_tparm (data->reverse_video_on));
305
grub_terminfo_setcursor (struct grub_term_output *term, const int on)
307
struct grub_terminfo_output_state *data
308
= (struct grub_terminfo_output_state *) term->data;
311
putstr (term, grub_terminfo_tparm (data->cursor_on));
313
putstr (term, grub_terminfo_tparm (data->cursor_off));
316
/* The terminfo version of putchar. */
318
grub_terminfo_putchar (struct grub_term_output *term,
319
const struct grub_unicode_glyph *c)
321
struct grub_terminfo_output_state *data
322
= (struct grub_terminfo_output_state *) term->data;
324
/* Keep track of the cursor. */
337
if (data->ypos < grub_term_height (term) - 1)
346
if (data->xpos + c->estimated_width >= grub_term_width (term) + 1)
349
if (data->ypos < grub_term_height (term) - 1)
351
data->put (term, '\r');
352
data->put (term, '\n');
354
data->xpos += c->estimated_width;
358
data->put (term, c->base);
362
grub_terminfo_getwh (struct grub_term_output *term)
364
struct grub_terminfo_output_state *data
365
= (struct grub_terminfo_output_state *) term->data;
367
return (data->width << 8) | data->height;
373
grub_terminfo_readkey (struct grub_term_input *term, int *keys, int *len,
374
int (*readkey) (struct grub_term_input *term))
378
#define CONTINUE_READ \
380
grub_uint64_t start; \
381
/* On 9600 we have to wait up to 12 milliseconds. */ \
382
start = grub_get_time_ms (); \
384
c = readkey (term); \
385
while (c == -1 && grub_get_time_ms () - start < 12); \
401
if (c != ANSI_C0 && c != '\e')
403
/* Backspace: Ctrl-h. */
419
{'4', GRUB_TERM_KEY_DC},
420
{'A', GRUB_TERM_KEY_UP},
421
{'B', GRUB_TERM_KEY_DOWN},
422
{'C', GRUB_TERM_KEY_RIGHT},
423
{'D', GRUB_TERM_KEY_LEFT},
424
{'F', GRUB_TERM_KEY_END},
425
{'H', GRUB_TERM_KEY_HOME},
426
{'K', GRUB_TERM_KEY_END},
427
{'P', GRUB_TERM_KEY_DC},
428
{'?', GRUB_TERM_KEY_PPAGE},
429
{'/', GRUB_TERM_KEY_NPAGE}
439
{'1', GRUB_TERM_KEY_HOME},
440
{'3', GRUB_TERM_KEY_DC},
441
{'5', GRUB_TERM_KEY_PPAGE},
442
{'6', GRUB_TERM_KEY_NPAGE}
456
for (i = 0; i < ARRAY_SIZE (three_code_table); i++)
457
if (three_code_table[i].key == c)
459
keys[0] = three_code_table[i].ascii;
464
for (i = 0; i < ARRAY_SIZE (four_code_table); i++)
465
if (four_code_table[i].key == c)
470
keys[0] = three_code_table[i].ascii;
479
/* The terminfo version of getkey. */
481
grub_terminfo_getkey (struct grub_term_input *termi)
483
struct grub_terminfo_input_state *data
484
= (struct grub_terminfo_input_state *) (termi->data);
488
grub_memmove (data->input_buf, data->input_buf + 1, data->npending);
489
return data->input_buf[0];
492
grub_terminfo_readkey (termi, data->input_buf,
493
&data->npending, data->readkey);
498
grub_memmove (data->input_buf, data->input_buf + 1, data->npending);
499
return data->input_buf[0];
502
return GRUB_TERM_NO_KEY;
506
grub_terminfo_input_init (struct grub_term_input *termi)
508
struct grub_terminfo_input_state *data
509
= (struct grub_terminfo_input_state *) (termi->data);
512
return GRUB_ERR_NONE;
518
print_terminfo (void)
520
const char *encoding_names[(GRUB_TERM_CODE_TYPE_MASK
521
>> GRUB_TERM_CODE_TYPE_SHIFT) + 1]
523
/* VGA and glyph descriptor types are just for completeness,
524
they are not used on terminfo terminals.
526
[GRUB_TERM_CODE_TYPE_ASCII >> GRUB_TERM_CODE_TYPE_SHIFT] = _("ASCII"),
527
[GRUB_TERM_CODE_TYPE_CP437 >> GRUB_TERM_CODE_TYPE_SHIFT] = "CP-437",
528
[GRUB_TERM_CODE_TYPE_UTF8_LOGICAL >> GRUB_TERM_CODE_TYPE_SHIFT]
530
[GRUB_TERM_CODE_TYPE_UTF8_VISUAL >> GRUB_TERM_CODE_TYPE_SHIFT]
532
[GRUB_TERM_CODE_TYPE_VISUAL_GLYPHS >> GRUB_TERM_CODE_TYPE_SHIFT]
533
= "Glyph descriptors",
534
_("Unknown"), _("Unknown"), _("Unknown")
536
struct grub_term_output *cur;
538
grub_printf ("Current terminfo types: \n");
539
for (cur = terminfo_outputs; cur;
540
cur = ((struct grub_terminfo_output_state *) cur->data)->next)
541
grub_printf ("%s: %s\t%s\n", cur->name,
542
grub_terminfo_get_current(cur),
543
encoding_names[(cur->flags & GRUB_TERM_CODE_TYPE_MASK)
544
>> GRUB_TERM_CODE_TYPE_SHIFT]);
546
return GRUB_ERR_NONE;
549
static const struct grub_arg_option options[] =
551
{"ascii", 'a', 0, N_("Terminal is ASCII-only [default]."), 0, ARG_TYPE_NONE},
552
{"utf8", 'u', 0, N_("Terminal is logical-ordered UTF-8."), 0, ARG_TYPE_NONE},
553
{"visual-utf8", 'v', 0, N_("Terminal is visually-ordered UTF-8."), 0,
555
{"geometry", 'g', 0, N_("Terminal has given geometry."),
556
N_("WIDTHxHEIGHT."), ARG_TYPE_STRING},
569
grub_cmd_terminfo (grub_extcmd_context_t ctxt, int argc, char **args)
571
struct grub_term_output *cur;
572
int encoding = GRUB_TERM_CODE_TYPE_ASCII;
573
struct grub_arg_list *state = ctxt->state;
577
return print_terminfo ();
579
if (state[OPTION_ASCII].set)
580
encoding = GRUB_TERM_CODE_TYPE_ASCII;
582
if (state[OPTION_UTF8].set)
583
encoding = GRUB_TERM_CODE_TYPE_UTF8_LOGICAL;
585
if (state[OPTION_VISUAL_UTF8].set)
586
encoding = GRUB_TERM_CODE_TYPE_UTF8_VISUAL;
588
if (state[OPTION_GEOMETRY].set)
590
char *ptr = state[OPTION_GEOMETRY].arg;
591
w = grub_strtoul (ptr, &ptr, 0);
595
return grub_error (GRUB_ERR_BAD_ARGUMENT,
596
"incorrect geometry specification");
598
h = grub_strtoul (ptr, &ptr, 0);
603
for (cur = terminfo_outputs; cur;
604
cur = ((struct grub_terminfo_output_state *) cur->data)->next)
605
if (grub_strcmp (args[0], cur->name) == 0)
607
cur->flags = (cur->flags & ~GRUB_TERM_CODE_TYPE_MASK) | encoding;
611
struct grub_terminfo_output_state *data
612
= (struct grub_terminfo_output_state *) cur->data;
618
return GRUB_ERR_NONE;
620
return grub_terminfo_set_current (cur, args[1]);
623
return grub_error (GRUB_ERR_BAD_ARGUMENT,
624
"no terminal %s found or it's not handled by terminfo",
628
static grub_extcmd_t cmd;
630
GRUB_MOD_INIT(terminfo)
632
cmd = grub_register_extcmd ("terminfo", grub_cmd_terminfo, 0,
633
N_("[[-a|-u|-v] [-g WxH] TERM [TYPE]]"),
634
N_("Set terminfo type of TERM to TYPE.\n"),
638
GRUB_MOD_FINI(terminfo)
640
grub_unregister_extcmd (cmd);