console-tools/loadfont.c

   1 /* vi: set sw=4 ts=4: */
   2 /*
   3  * loadfont.c - Eugene Crosser & Andries Brouwer
   4  *
   5  * Version 0.96bb
   6  *
   7  * Loads the console font, and possibly the corresponding screen map(s).
   8  * (Adapted for busybox by Matej Vela.)
   9  *
  10  * Licensed under GPLv2, see file LICENSE in this source tree.
  11  */
  12 //config:config LOADFONT
  13 //config:       bool "loadfont"
  14 //config:       default y
  15 //config:       select PLATFORM_LINUX
  16 //config:       help
  17 //config:         This program loads a console font from standard input.
  18 //config:
  19 //config:config SETFONT
  20 //config:       bool "setfont"
  21 //config:       default y
  22 //config:       select PLATFORM_LINUX
  23 //config:       help
  24 //config:         Allows to load console screen map. Useful for i18n.
  25 //config:
  26 //config:config FEATURE_SETFONT_TEXTUAL_MAP
  27 //config:       bool "Support reading textual screen maps"
  28 //config:       default y
  29 //config:       depends on SETFONT
  30 //config:       help
  31 //config:         Support reading textual screen maps.
  32 //config:
  33 //config:config DEFAULT_SETFONT_DIR
  34 //config:       string "Default directory for console-tools files"
  35 //config:       default ""
  36 //config:       depends on SETFONT
  37 //config:       help
  38 //config:         Directory to use if setfont's params are simple filenames
  39 //config:         (not /path/to/file or ./file). Default is "" (no default directory).
  40 //config:
  41 //config:comment "Common options for loadfont and setfont"
  42 //config:       depends on LOADFONT || SETFONT
  43 //config:
  44 //config:config FEATURE_LOADFONT_PSF2
  45 //config:       bool "Support for PSF2 console fonts"
  46 //config:       default y
  47 //config:       depends on LOADFONT || SETFONT
  48 //config:       help
  49 //config:         Support PSF2 console fonts.
  50 //config:
  51 //config:config FEATURE_LOADFONT_RAW
  52 //config:       bool "Support for old (raw) console fonts"
  53 //config:       default y
  54 //config:       depends on LOADFONT || SETFONT
  55 //config:       help
  56 //config:         Support old (raw) console fonts.
  57
  58 //applet:IF_LOADFONT(APPLET(loadfont, BB_DIR_USR_SBIN, BB_SUID_DROP))
  59 //applet:IF_SETFONT(APPLET(setfont, BB_DIR_USR_SBIN, BB_SUID_DROP))
  60
  61 //kbuild:lib-$(CONFIG_LOADFONT) += loadfont.o
  62 //kbuild:lib-$(CONFIG_SETFONT) += loadfont.o
  63
  64 //usage:#define loadfont_trivial_usage
  65 //usage:       "< font"
  66 //usage:#define loadfont_full_usage "\n\n"
  67 //usage:       "Load a console font from stdin"
  68 /* //usage:     "\n     -C TTY  Affect TTY instead of /dev/tty" */
  69 //usage:
  70 //usage:#define loadfont_example_usage
  71 //usage:       "$ loadfont < /etc/i18n/fontname\n"
  72 //usage:
  73 //usage:#define setfont_trivial_usage
  74 //usage:       "FONT [-m MAPFILE] [-C TTY]"
  75 //usage:#define setfont_full_usage "\n\n"
  76 //usage:       "Load a console font\n"
  77 //usage:     "\n        -m MAPFILE      Load console screen map"
  78 //usage:     "\n        -C TTY          Affect TTY instead of /dev/tty"
  79 //usage:
  80 //usage:#define setfont_example_usage
  81 //usage:       "$ setfont -m koi8-r /etc/i18n/fontname\n"
  82
  83 #include "libbb.h"
  84 #include <sys/kd.h>
  85
  86 #ifndef KDFONTOP
  87 # define KDFONTOP 0x4B72
  88 struct console_font_op {
  89         unsigned op;            /* KD_FONT_OP_* */
  90         unsigned flags;         /* KD_FONT_FLAG_* */
  91         unsigned width, height;
  92         unsigned charcount;
  93         unsigned char *data;    /* font data with height fixed to 32 */
  94 };
  95 # define KD_FONT_OP_SET          0  /* Set font */
  96 # define KD_FONT_OP_GET          1  /* Get font */
  97 # define KD_FONT_OP_SET_DEFAULT  2  /* Set font to default, data points to name / NULL */
  98 # define KD_FONT_OP_COPY         3  /* Copy from another console */
  99 # define KD_FONT_FLAG_OLD        0x80000000 /* Invoked via old interface */
 100 # define KD_FONT_FLAG_DONT_RECALC 1 /* Don't call adjust_height() */
 101                                    /* (Used internally for PIO_FONT support) */
 102 #endif /* KDFONTOP */
 103
 104
 105 enum {
 106         PSF1_MAGIC0 = 0x36,
 107         PSF1_MAGIC1 = 0x04,
 108         PSF1_MODE512 = 0x01,
 109         PSF1_MODEHASTAB = 0x02,
 110         PSF1_MODEHASSEQ = 0x04,
 111         PSF1_MAXMODE = 0x05,
 112         PSF1_STARTSEQ = 0xfffe,
 113         PSF1_SEPARATOR = 0xffff,
 114 };
 115
 116 struct psf1_header {
 117         unsigned char magic[2];         /* Magic number */
 118         unsigned char mode;             /* PSF font mode */
 119         unsigned char charsize;         /* Character size */
 120 };
 121
 122 #define psf1h(x) ((struct psf1_header*)(x))
 123
 124 #define PSF1_MAGIC_OK(x) ( \
 125      (x)->magic[0] == PSF1_MAGIC0 \
 126   && (x)->magic[1] == PSF1_MAGIC1 \
 127 )
 128
 129 #if ENABLE_FEATURE_LOADFONT_PSF2
 130 enum {
 131         PSF2_MAGIC0 = 0x72,
 132         PSF2_MAGIC1 = 0xb5,
 133         PSF2_MAGIC2 = 0x4a,
 134         PSF2_MAGIC3 = 0x86,
 135         PSF2_HAS_UNICODE_TABLE = 0x01,
 136         PSF2_MAXVERSION = 0,
 137         PSF2_STARTSEQ = 0xfe,
 138         PSF2_SEPARATOR = 0xff
 139 };
 140
 141 struct psf2_header {
 142         unsigned char magic[4];
 143         unsigned int version;
 144         unsigned int headersize;    /* offset of bitmaps in file */
 145         unsigned int flags;
 146         unsigned int length;        /* number of glyphs */
 147         unsigned int charsize;      /* number of bytes for each character */
 148         unsigned int height;        /* max dimensions of glyphs */
 149         unsigned int width;         /* charsize = height * ((width + 7) / 8) */
 150 };
 151
 152 #define psf2h(x) ((struct psf2_header*)(x))
 153
 154 #define PSF2_MAGIC_OK(x) ( \
 155      (x)->magic[0] == PSF2_MAGIC0 \
 156   && (x)->magic[1] == PSF2_MAGIC1 \
 157   && (x)->magic[2] == PSF2_MAGIC2 \
 158   && (x)->magic[3] == PSF2_MAGIC3 \
 159 )
 160 #endif /* ENABLE_FEATURE_LOADFONT_PSF2 */
 161
 162
 163 static void do_loadfont(int fd, unsigned char *inbuf, int height, int width, int charsize, int fontsize)
 164 {
 165         unsigned char *buf;
 166         int charwidth = 32 * ((width+7)/8);
 167         int i;
 168
 169         if (height < 1 || height > 32 || width < 1 || width > 32)
 170                 bb_error_msg_and_die("bad character size %dx%d", height, width);
 171
 172         buf = xzalloc(charwidth * ((fontsize < 128) ? 128 : fontsize));
 173         for (i = 0; i < fontsize; i++)
 174                 memcpy(buf + (i*charwidth), inbuf + (i*charsize), charsize);
 175
 176         { /* KDFONTOP */
 177                 struct console_font_op cfo;
 178                 cfo.op = KD_FONT_OP_SET;
 179                 cfo.flags = 0;
 180                 cfo.width = width;
 181                 cfo.height = height;
 182                 cfo.charcount = fontsize;
 183                 cfo.data = buf;
 184                 xioctl(fd, KDFONTOP, &cfo);
 185         }
 186
 187         free(buf);
 188 }
 189
 190 /*
 191  * Format of the Unicode information:
 192  *
 193  * For each font position <uc>*<seq>*<term>
 194  * where <uc> is a 2-byte little endian Unicode value (PSF1)
 195  * or an UTF-8 coded value (PSF2),
 196  * <seq> = <ss><uc><uc>*, <ss> = psf1 ? 0xFFFE : 0xFE,
 197  * <term> = psf1 ? 0xFFFF : 0xFF.
 198  * and * denotes zero or more occurrences of the preceding item.
 199  *
 200  * Semantics:
 201  * The leading <uc>* part gives Unicode symbols that are all
 202  * represented by this font position. The following sequences
 203  * are sequences of Unicode symbols - probably a symbol
 204  * together with combining accents - also represented by
 205  * this font position.
 206  *
 207  * Example:
 208  * At the font position for a capital A-ring glyph, we
 209  * may have:
 210  *   00C5,212B,FFFE,0041,030A,FFFF
 211  * Some font positions may be described by sequences only,
 212  * namely when there is no precomposed Unicode value for the glyph.
 213  */
 214 #if !ENABLE_FEATURE_LOADFONT_PSF2
 215 #define do_loadtable(fd, inbuf, tailsz, fontsize, psf2) \
 216         do_loadtable(fd, inbuf, tailsz, fontsize)
 217 #endif
 218 static void do_loadtable(int fd, unsigned char *inbuf, int tailsz, int fontsize, int psf2)
 219 {
 220 #if !ENABLE_FEATURE_LOADFONT_PSF2
 221 /* gcc 4.3.1 code size: */
 222 # define psf2 0 /* +0 bytes */
 223 //      const int psf2 = 0; /* +8 bytes */
 224 //      enum { psf2 = 0 }; /* +13 bytes */
 225 #endif
 226         struct unimapinit advice;
 227         struct unimapdesc ud;
 228         struct unipair *up;
 229         int ct = 0, maxct;
 230         int glyph;
 231         uint16_t unicode;
 232
 233         maxct = tailsz; /* more than enough */
 234         up = xmalloc(maxct * sizeof(*up));
 235
 236         for (glyph = 0; glyph < fontsize; glyph++) {
 237                 while (tailsz > 0) {
 238                         if (!psf2) { /* PSF1 */
 239                                 unicode = (((uint16_t) inbuf[1]) << 8) + inbuf[0];
 240                                 tailsz -= 2;
 241                                 inbuf += 2;
 242                                 if (unicode == PSF1_SEPARATOR)
 243                                         break;
 244                         } else { /* PSF2 */
 245 #if ENABLE_FEATURE_LOADFONT_PSF2
 246                                 --tailsz;
 247                                 unicode = *inbuf++;
 248                                 if (unicode == PSF2_SEPARATOR) {
 249                                         break;
 250                                 } else if (unicode == PSF2_STARTSEQ) {
 251                                         bb_error_msg_and_die("unicode sequences not implemented");
 252                                 } else if (unicode >= 0xC0) {
 253                                         if (unicode >= 0xFC)
 254                                                 unicode &= 0x01, maxct = 5;
 255                                         else if (unicode >= 0xF8)
 256                                                 unicode &= 0x03, maxct = 4;
 257                                         else if (unicode >= 0xF0)
 258                                                 unicode &= 0x07, maxct = 3;
 259                                         else if (unicode >= 0xE0)
 260                                                 unicode &= 0x0F, maxct = 2;
 261                                         else
 262                                                 unicode &= 0x1F, maxct = 1;
 263                                         do {
 264                                                 if (tailsz <= 0 || *inbuf < 0x80 || *inbuf > 0xBF)
 265                                                         bb_error_msg_and_die("illegal UTF-8 character");
 266                                                 --tailsz;
 267                                                 unicode = (unicode << 6) + (*inbuf++ & 0x3F);
 268                                         } while (--maxct > 0);
 269                                 } else if (unicode >= 0x80) {
 270                                         bb_error_msg_and_die("illegal UTF-8 character");
 271                                 }
 272 #else
 273                                 return;
 274 #endif
 275                         }
 276                         up[ct].unicode = unicode;
 277                         up[ct].fontpos = glyph;
 278                         ct++;
 279                 }
 280         }
 281
 282         /* Note: after PIO_UNIMAPCLR and before PIO_UNIMAP
 283          * this printf did not work on many kernels */
 284
 285         advice.advised_hashsize = 0;
 286         advice.advised_hashstep = 0;
 287         advice.advised_hashlevel = 0;
 288         xioctl(fd, PIO_UNIMAPCLR, &advice);
 289         ud.entry_ct = ct;
 290         ud.entries = up;
 291         xioctl(fd, PIO_UNIMAP, &ud);
 292 #undef psf2
 293 }
 294
 295 static void do_load(int fd, unsigned char *buffer, size_t len)
 296 {
 297         int height;
 298         int width = 8;
 299         int charsize;
 300         int fontsize = 256;
 301         int has_table = 0;
 302         unsigned char *font = buffer;
 303         unsigned char *table;
 304
 305         if (len >= sizeof(struct psf1_header) && PSF1_MAGIC_OK(psf1h(buffer))) {
 306                 if (psf1h(buffer)->mode > PSF1_MAXMODE)
 307                         bb_error_msg_and_die("unsupported psf file mode");
 308                 if (psf1h(buffer)->mode & PSF1_MODE512)
 309                         fontsize = 512;
 310                 if (psf1h(buffer)->mode & PSF1_MODEHASTAB)
 311                         has_table = 1;
 312                 height = charsize = psf1h(buffer)->charsize;
 313                 font += sizeof(struct psf1_header);
 314         } else
 315 #if ENABLE_FEATURE_LOADFONT_PSF2
 316         if (len >= sizeof(struct psf2_header) && PSF2_MAGIC_OK(psf2h(buffer))) {
 317                 if (psf2h(buffer)->version > PSF2_MAXVERSION)
 318                         bb_error_msg_and_die("unsupported psf file version");
 319                 fontsize = psf2h(buffer)->length;
 320                 if (psf2h(buffer)->flags & PSF2_HAS_UNICODE_TABLE)
 321                         has_table = 2;
 322                 charsize = psf2h(buffer)->charsize;
 323                 height = psf2h(buffer)->height;
 324                 width = psf2h(buffer)->width;
 325                 font += psf2h(buffer)->headersize;
 326         } else
 327 #endif
 328 #if ENABLE_FEATURE_LOADFONT_RAW
 329         if (len == 9780) {  /* file with three code pages? */
 330                 charsize = height = 16;
 331                 font += 40;
 332         } else if ((len & 0377) == 0) {  /* bare font */
 333                 charsize = height = len / 256;
 334         } else
 335 #endif
 336         {
 337                 bb_error_msg_and_die("input file: bad length or unsupported font type");
 338         }
 339
 340 #if !defined(PIO_FONTX) || defined(__sparc__)
 341         if (fontsize != 256)
 342                 bb_error_msg_and_die("only fontsize 256 supported");
 343 #endif
 344
 345         table = font + fontsize * charsize;
 346         buffer += len;
 347
 348         if (table > buffer || (!has_table && table != buffer))
 349                 bb_error_msg_and_die("input file: bad length");
 350
 351         do_loadfont(fd, font, height, width, charsize, fontsize);
 352
 353         if (has_table)
 354                 do_loadtable(fd, table, buffer - table, fontsize, has_table - 1);
 355 }
 356
 357
 358 #if ENABLE_LOADFONT
 359 int loadfont_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 360 int loadfont_main(int argc UNUSED_PARAM, char **argv)
 361 {
 362         size_t len;
 363         unsigned char *buffer;
 364
 365         // no arguments allowed!
 366         opt_complementary = "=0";
 367         getopt32(argv, "");
 368
 369         /*
 370          * We used to look at the length of the input file
 371          * with stat(); now that we accept compressed files,
 372          * just read the entire file.
 373          * Len was 32k, but latarcyrheb-sun32.psfu is 34377 bytes
 374          * (it has largish Unicode map).
 375          */
 376         len = 128*1024;
 377         buffer = xmalloc_read(STDIN_FILENO, &len);
 378         // xmalloc_open_zipped_read_close(filename, &len);
 379         if (!buffer)
 380                 bb_perror_msg_and_die("error reading input font");
 381         do_load(get_console_fd_or_die(), buffer, len);
 382
 383         return EXIT_SUCCESS;
 384 }
 385 #endif
 386
 387 #if ENABLE_SETFONT
 388
 389 /*
 390 kbd-1.12:
 391
 392 setfont [-O font+umap.orig] [-o font.orig] [-om cmap.orig]
 393 [-ou umap.orig] [-N] [font.new ...] [-m cmap] [-u umap] [-C console]
 394 [-hNN] [-v] [-V]
 395
 396 -h NN  Override font height
 397 -o file
 398        Save previous font in file
 399 -O file
 400        Save previous font and Unicode map in file
 401 -om file
 402        Store console map in file
 403 -ou file
 404        Save previous Unicode map in file
 405 -m file
 406        Load console map or Unicode console map from file
 407 -u file
 408        Load Unicode table describing the font from file
 409        Example:
 410        # cp866
 411        0x00-0x7f       idem
 412        #
 413        0x80    U+0410  # CYRILLIC CAPITAL LETTER A
 414        0x81    U+0411  # CYRILLIC CAPITAL LETTER BE
 415        0x82    U+0412  # CYRILLIC CAPITAL LETTER VE
 416 -C console
 417        Set the font for the indicated console
 418 -v     Verbose
 419 -V     Version
 420 */
 421
 422 #if ENABLE_FEATURE_SETFONT_TEXTUAL_MAP
 423 static int ctoi(char *s)
 424 {
 425         if (s[0] == '\'' && s[1] != '\0' && s[2] == '\'' && s[3] == '\0')
 426                 return s[1];
 427         // U+ means 0x
 428         if (s[0] == 'U' && s[1] == '+') {
 429                 s[0] = '0';
 430                 s[1] = 'x';
 431         }
 432         if (!isdigit(s[0]))
 433                 return -1;
 434         return xstrtoul(s, 0);
 435 }
 436 #endif
 437
 438 int setfont_main(int argc, char **argv) MAIN_EXTERNALLY_VISIBLE;
 439 int setfont_main(int argc UNUSED_PARAM, char **argv)
 440 {
 441         size_t len;
 442         unsigned opts;
 443         int fd;
 444         unsigned char *buffer;
 445         char *mapfilename;
 446         const char *tty_name = CURRENT_TTY;
 447
 448         opt_complementary = "=1";
 449         opts = getopt32(argv, "m:C:", &mapfilename, &tty_name);
 450         argv += optind;
 451
 452         fd = xopen_nonblocking(tty_name);
 453
 454         if (sizeof(CONFIG_DEFAULT_SETFONT_DIR) > 1) { // if not ""
 455                 if (*argv[0] != '/') {
 456                         // goto default fonts location. don't die if doesn't exist
 457                         chdir(CONFIG_DEFAULT_SETFONT_DIR "/consolefonts");
 458                 }
 459         }
 460         // load font
 461         len = 128*1024;
 462         buffer = xmalloc_open_zipped_read_close(*argv, &len);
 463         if (!buffer)
 464                 bb_simple_perror_msg_and_die(*argv);
 465         do_load(fd, buffer, len);
 466
 467         // load the screen map, if any
 468         if (opts & 1) { // -m
 469                 unsigned mode = PIO_SCRNMAP;
 470                 void *map;
 471
 472                 if (sizeof(CONFIG_DEFAULT_SETFONT_DIR) > 1) { // if not ""
 473                         if (mapfilename[0] != '/') {
 474                                 // goto default keymaps location
 475                                 chdir(CONFIG_DEFAULT_SETFONT_DIR "/consoletrans");
 476                         }
 477                 }
 478                 // fetch keymap
 479                 map = xmalloc_open_zipped_read_close(mapfilename, &len);
 480                 if (!map)
 481                         bb_simple_perror_msg_and_die(mapfilename);
 482                 // file size is 256 or 512 bytes? -> assume binary map
 483                 if (len == E_TABSZ || len == 2*E_TABSZ) {
 484                         if (len == 2*E_TABSZ)
 485                                 mode = PIO_UNISCRNMAP;
 486                 }
 487 #if ENABLE_FEATURE_SETFONT_TEXTUAL_MAP
 488                 // assume textual Unicode console maps:
 489                 // 0x00 U+0000  #  NULL (NUL)
 490                 // 0x01 U+0001  #  START OF HEADING (SOH)
 491                 // 0x02 U+0002  #  START OF TEXT (STX)
 492                 // 0x03 U+0003  #  END OF TEXT (ETX)
 493                 else {
 494                         int i;
 495                         char *token[2];
 496                         parser_t *parser;
 497
 498                         if (ENABLE_FEATURE_CLEAN_UP)
 499                                 free(map);
 500                         map = xmalloc(E_TABSZ * sizeof(unsigned short));
 501
 502 #define unicodes ((unsigned short *)map)
 503                         // fill vanilla map
 504                         for (i = 0; i < E_TABSZ; i++)
 505                                 unicodes[i] = 0xf000 + i;
 506
 507                         parser = config_open(mapfilename);
 508                         while (config_read(parser, token, 2, 2, "# \t", PARSE_NORMAL | PARSE_MIN_DIE)) {
 509                                 // parse code/value pair
 510                                 int a = ctoi(token[0]);
 511                                 int b = ctoi(token[1]);
 512                                 if (a < 0 || a >= E_TABSZ
 513                                  || b < 0 || b > 65535
 514                                 ) {
 515                                         bb_error_msg_and_die("map format");
 516                                 }
 517                                 // patch map
 518                                 unicodes[a] = b;
 519                                 // unicode character is met?
 520                                 if (b > 255)
 521                                         mode = PIO_UNISCRNMAP;
 522                         }
 523                         if (ENABLE_FEATURE_CLEAN_UP)
 524                                 config_close(parser);
 525
 526                         if (mode != PIO_UNISCRNMAP) {
 527 #define asciis ((unsigned char *)map)
 528                                 for (i = 0; i < E_TABSZ; i++)
 529                                         asciis[i] = unicodes[i];
 530 #undef asciis
 531                         }
 532 #undef unicodes
 533                 }
 534 #endif // ENABLE_FEATURE_SETFONT_TEXTUAL_MAP
 535
 536                 // do set screen map
 537                 xioctl(fd, mode, map);
 538
 539                 if (ENABLE_FEATURE_CLEAN_UP)
 540                         free(map);
 541         }
 542
 543         return EXIT_SUCCESS;
 544 }
 545 #endif