1/*-
2 * Copyright (c) 2009, 2014 The FreeBSD Foundation
3 * All rights reserved.
4 *
5 * This software was developed by Ed Schouten under sponsorship from the
6 * FreeBSD Foundation.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 *    notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 *    notice, this list of conditions and the following disclaimer in the
15 *    documentation and/or other materials provided with the distribution.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
28 */
29
30#include <sys/cdefs.h>
31__FBSDID("$FreeBSD: stable/10/usr.bin/vtfontcvt/vtfontcvt.c 332324 2018-04-09 13:00:03Z emaste $");
32
33#include <sys/types.h>
34#include <sys/fnv_hash.h>
35#include <sys/endian.h>
36#include <sys/param.h>
37#include <sys/queue.h>
38
39#include <assert.h>
40#include <err.h>
41#include <stdint.h>
42#include <stdio.h>
43#include <stdlib.h>
44#include <string.h>
45#include <unistd.h>
46
47#define VFNT_MAPS 4
48#define VFNT_MAP_NORMAL 0
49#define VFNT_MAP_NORMAL_RH 1
50#define VFNT_MAP_BOLD 2
51#define VFNT_MAP_BOLD_RH 3
52
53static unsigned int width = 8, wbytes, height = 16;
54
55struct glyph {
56	TAILQ_ENTRY(glyph)	 g_list;
57	SLIST_ENTRY(glyph)	 g_hash;
58	uint8_t			*g_data;
59	unsigned int		 g_index;
60};
61
62#define	FONTCVT_NHASH 4096
63TAILQ_HEAD(glyph_list, glyph);
64static SLIST_HEAD(, glyph) glyph_hash[FONTCVT_NHASH];
65static struct glyph_list glyphs[VFNT_MAPS] = {
66    TAILQ_HEAD_INITIALIZER(glyphs[0]),
67    TAILQ_HEAD_INITIALIZER(glyphs[1]),
68    TAILQ_HEAD_INITIALIZER(glyphs[2]),
69    TAILQ_HEAD_INITIALIZER(glyphs[3]),
70};
71static unsigned int glyph_total, glyph_count[4], glyph_unique, glyph_dupe;
72
73struct mapping {
74	TAILQ_ENTRY(mapping)	 m_list;
75	unsigned int		 m_char;
76	unsigned int		 m_length;
77	struct glyph		*m_glyph;
78};
79
80TAILQ_HEAD(mapping_list, mapping);
81static struct mapping_list maps[VFNT_MAPS] = {
82    TAILQ_HEAD_INITIALIZER(maps[0]),
83    TAILQ_HEAD_INITIALIZER(maps[1]),
84    TAILQ_HEAD_INITIALIZER(maps[2]),
85    TAILQ_HEAD_INITIALIZER(maps[3]),
86};
87static unsigned int mapping_total, map_count[4], map_folded_count[4],
88    mapping_unique, mapping_dupe;
89
90static void
91usage(void)
92{
93
94	(void)fprintf(stderr,
95"usage: vtfontcvt [-w width] [-h height] [-v] normal.bdf [bold.bdf] out.fnt\n");
96	exit(1);
97}
98
99static void *
100xmalloc(size_t size)
101{
102	void *m;
103
104	if ((m = malloc(size)) == NULL)
105		errx(1, "memory allocation failure");
106	return (m);
107}
108
109static int
110add_mapping(struct glyph *gl, unsigned int c, unsigned int map_idx)
111{
112	struct mapping *mp;
113	struct mapping_list *ml;
114
115	mapping_total++;
116
117	mp = xmalloc(sizeof *mp);
118	mp->m_char = c;
119	mp->m_glyph = gl;
120	mp->m_length = 0;
121
122	ml = &maps[map_idx];
123	if (TAILQ_LAST(ml, mapping_list) != NULL &&
124	    TAILQ_LAST(ml, mapping_list)->m_char >= c)
125		errx(1, "Bad ordering at character %u\n", c);
126	TAILQ_INSERT_TAIL(ml, mp, m_list);
127
128	map_count[map_idx]++;
129	mapping_unique++;
130
131	return (0);
132}
133
134static int
135dedup_mapping(unsigned int map_idx)
136{
137	struct mapping *mp_bold, *mp_normal, *mp_temp;
138	unsigned normal_map_idx = map_idx - VFNT_MAP_BOLD;
139
140	assert(map_idx == VFNT_MAP_BOLD || map_idx == VFNT_MAP_BOLD_RH);
141	mp_normal = TAILQ_FIRST(&maps[normal_map_idx]);
142	TAILQ_FOREACH_SAFE(mp_bold, &maps[map_idx], m_list, mp_temp) {
143		while (mp_normal->m_char < mp_bold->m_char)
144			mp_normal = TAILQ_NEXT(mp_normal, m_list);
145		if (mp_bold->m_char != mp_normal->m_char)
146			errx(1, "Character %u not in normal font!\n",
147			    mp_bold->m_char);
148		if (mp_bold->m_glyph != mp_normal->m_glyph)
149			continue;
150
151		/* No mapping is needed if it's equal to the normal mapping. */
152		TAILQ_REMOVE(&maps[map_idx], mp_bold, m_list);
153		free(mp_bold);
154		mapping_dupe++;
155	}
156	return (0);
157}
158
159static struct glyph *
160add_glyph(const uint8_t *bytes, unsigned int map_idx, int fallback)
161{
162	struct glyph *gl;
163	int hash;
164
165	glyph_total++;
166	glyph_count[map_idx]++;
167
168	hash = fnv_32_buf(bytes, wbytes * height, FNV1_32_INIT) % FONTCVT_NHASH;
169	SLIST_FOREACH(gl, &glyph_hash[hash], g_hash) {
170		if (memcmp(gl->g_data, bytes, wbytes * height) == 0) {
171			glyph_dupe++;
172			return (gl);
173		}
174	}
175
176	gl = xmalloc(sizeof *gl);
177	gl->g_data = xmalloc(wbytes * height);
178	memcpy(gl->g_data, bytes, wbytes * height);
179	if (fallback)
180		TAILQ_INSERT_HEAD(&glyphs[map_idx], gl, g_list);
181	else
182		TAILQ_INSERT_TAIL(&glyphs[map_idx], gl, g_list);
183	SLIST_INSERT_HEAD(&glyph_hash[hash], gl, g_hash);
184
185	glyph_unique++;
186	return (gl);
187}
188
189static int
190add_char(unsigned curchar, unsigned map_idx, uint8_t *bytes, uint8_t *bytes_r)
191{
192	struct glyph *gl;
193
194	/* Prevent adding two glyphs for 0xFFFD */
195	if (curchar == 0xFFFD) {
196		if (map_idx < VFNT_MAP_BOLD)
197			gl = add_glyph(bytes, 0, 1);
198	} else if (curchar >= 0x20) {
199		gl = add_glyph(bytes, map_idx, 0);
200		if (add_mapping(gl, curchar, map_idx) != 0)
201			return (1);
202		if (bytes_r != NULL) {
203			gl = add_glyph(bytes_r, map_idx + 1, 0);
204			if (add_mapping(gl, curchar,
205			    map_idx + 1) != 0)
206				return (1);
207		}
208	}
209	return (0);
210}
211
212
213static int
214parse_bitmap_line(uint8_t *left, uint8_t *right, unsigned int line,
215    unsigned int dwidth)
216{
217	uint8_t *p;
218	unsigned int i, subline;
219
220	if (dwidth != width && dwidth != width * 2)
221		errx(1, "Bitmap with unsupported width %u!\n", dwidth);
222
223	/* Move pixel data right to simplify splitting double characters. */
224	line >>= (howmany(dwidth, 8) * 8) - dwidth;
225
226	for (i = dwidth / width; i > 0; i--) {
227		p = (i == 2) ? right : left;
228
229		subline = line & ((1 << width) - 1);
230		subline <<= (howmany(width, 8) * 8) - width;
231
232		if (wbytes == 1) {
233			*p = subline;
234		} else if (wbytes == 2) {
235			*p++ = subline >> 8;
236			*p = subline;
237		} else {
238			errx(1, "Unsupported wbytes %u!\n", wbytes);
239		}
240
241		line >>= width;
242	}
243
244	return (0);
245}
246
247static int
248parse_bdf(FILE *fp, unsigned int map_idx)
249{
250	char *ln;
251	size_t length;
252	uint8_t bytes[wbytes * height], bytes_r[wbytes * height];
253	unsigned int curchar = 0, dwidth = 0, i, line;
254
255	while ((ln = fgetln(fp, &length)) != NULL) {
256		ln[length - 1] = '\0';
257
258		if (strncmp(ln, "ENCODING ", 9) == 0) {
259			curchar = atoi(ln + 9);
260		}
261
262		if (strncmp(ln, "DWIDTH ", 7) == 0) {
263			dwidth = atoi(ln + 7);
264		}
265
266		if (strncmp(ln, "BITMAP", 6) == 0 &&
267		    (ln[6] == ' ' || ln[6] == '\0')) {
268			/*
269			 * Assume that the next _height_ lines are bitmap
270			 * data.  ENDCHAR is allowed to terminate the bitmap
271			 * early but is not otherwise checked; any extra data
272			 * is ignored.
273			 */
274			for (i = 0; i < height; i++) {
275				if ((ln = fgetln(fp, &length)) == NULL)
276					errx(1, "Unexpected EOF!\n");
277				ln[length - 1] = '\0';
278				if (strcmp(ln, "ENDCHAR") == 0) {
279					memset(bytes + i * wbytes, 0,
280					    (height - i) * wbytes);
281					memset(bytes_r + i * wbytes, 0,
282					    (height - i) * wbytes);
283					break;
284				}
285				sscanf(ln, "%x", &line);
286				if (parse_bitmap_line(bytes + i * wbytes,
287				     bytes_r + i * wbytes, line, dwidth) != 0)
288					return (1);
289			}
290
291			if (add_char(curchar, map_idx, bytes,
292			    dwidth == width * 2 ? bytes_r : NULL) != 0)
293				return (1);
294		}
295	}
296
297	return (0);
298}
299
300static void
301set_width(int w)
302{
303
304	if (w <= 0 || w > 128)
305		errx(1, "invalid width %d", w);
306	width = w;
307	wbytes = howmany(width, 8);
308}
309
310static int
311parse_hex(FILE *fp, unsigned int map_idx)
312{
313	char *ln, *p;
314	char fmt_str[8];
315	size_t length;
316	uint8_t *bytes = NULL, *bytes_r = NULL;
317	unsigned curchar = 0, i, line, chars_per_row, dwidth;
318	int rv = 0;
319
320	while ((ln = fgetln(fp, &length)) != NULL) {
321		ln[length - 1] = '\0';
322
323		if (strncmp(ln, "# Height: ", 10) == 0) {
324			if (bytes != NULL)
325				errx(1, "malformed input: Height tag after font data");
326			height = atoi(ln + 10);
327		} else if (strncmp(ln, "# Width: ", 9) == 0) {
328			if (bytes != NULL)
329				errx(1, "malformed input: Width tag after font data");
330			set_width(atoi(ln + 9));
331		} else if (sscanf(ln, "%6x:", &curchar)) {
332			if (bytes == NULL) {
333				bytes = xmalloc(wbytes * height);
334				bytes_r = xmalloc(wbytes * height);
335			}
336			/* ln is guaranteed to have a colon here. */
337			p = strchr(ln, ':') + 1;
338			chars_per_row = strlen(p) / height;
339			dwidth = width;
340			if (chars_per_row / 2 > (width + 7) / 8)
341				dwidth *= 2; /* Double-width character. */
342			snprintf(fmt_str, sizeof(fmt_str), "%%%ux",
343			    chars_per_row);
344
345			for (i = 0; i < height; i++) {
346				sscanf(p, fmt_str, &line);
347				p += chars_per_row;
348				if (parse_bitmap_line(bytes + i * wbytes,
349				    bytes_r + i * wbytes, line, dwidth) != 0) {
350					rv = 1;
351					goto out;
352				}
353			}
354
355			if (add_char(curchar, map_idx, bytes,
356			    dwidth == width * 2 ? bytes_r : NULL) != 0) {
357				rv = 1;
358				goto out;
359			}
360		}
361	}
362out:
363	free(bytes);
364	free(bytes_r);
365	return (rv);
366}
367
368static int
369parse_file(const char *filename, unsigned int map_idx)
370{
371	FILE *fp;
372	size_t len;
373	int rv;
374
375	fp = fopen(filename, "r");
376	if (fp == NULL) {
377		perror(filename);
378		return (1);
379	}
380	len = strlen(filename);
381	if (len > 4 && strcasecmp(filename + len - 4, ".hex") == 0)
382		rv = parse_hex(fp, map_idx);
383	else
384		rv = parse_bdf(fp, map_idx);
385	fclose(fp);
386	return (rv);
387}
388
389static void
390number_glyphs(void)
391{
392	struct glyph *gl;
393	unsigned int i, idx = 0;
394
395	for (i = 0; i < VFNT_MAPS; i++)
396		TAILQ_FOREACH(gl, &glyphs[i], g_list)
397			gl->g_index = idx++;
398}
399
400static int
401write_glyphs(FILE *fp)
402{
403	struct glyph *gl;
404	unsigned int i;
405
406	for (i = 0; i < VFNT_MAPS; i++) {
407		TAILQ_FOREACH(gl, &glyphs[i], g_list)
408			if (fwrite(gl->g_data, wbytes * height, 1, fp) != 1)
409				return (1);
410	}
411	return (0);
412}
413
414static void
415fold_mappings(unsigned int map_idx)
416{
417	struct mapping_list *ml = &maps[map_idx];
418	struct mapping *mn, *mp, *mbase;
419
420	mp = mbase = TAILQ_FIRST(ml);
421	for (mp = mbase = TAILQ_FIRST(ml); mp != NULL; mp = mn) {
422		mn = TAILQ_NEXT(mp, m_list);
423		if (mn != NULL && mn->m_char == mp->m_char + 1 &&
424		    mn->m_glyph->g_index == mp->m_glyph->g_index + 1)
425			continue;
426		mbase->m_length = mp->m_char - mbase->m_char + 1;
427		mbase = mp = mn;
428		map_folded_count[map_idx]++;
429	}
430}
431
432struct file_mapping {
433	uint32_t	source;
434	uint16_t	destination;
435	uint16_t	length;
436} __packed;
437
438static int
439write_mappings(FILE *fp, unsigned int map_idx)
440{
441	struct mapping_list *ml = &maps[map_idx];
442	struct mapping *mp;
443	struct file_mapping fm;
444	unsigned int i = 0, j = 0;
445
446	TAILQ_FOREACH(mp, ml, m_list) {
447		j++;
448		if (mp->m_length > 0) {
449			i += mp->m_length;
450			fm.source = htobe32(mp->m_char);
451			fm.destination = htobe16(mp->m_glyph->g_index);
452			fm.length = htobe16(mp->m_length - 1);
453			if (fwrite(&fm, sizeof fm, 1, fp) != 1)
454				return (1);
455		}
456	}
457	assert(i == j);
458	return (0);
459}
460
461struct file_header {
462	uint8_t		magic[8];
463	uint8_t		width;
464	uint8_t		height;
465	uint16_t	pad;
466	uint32_t	glyph_count;
467	uint32_t	map_count[4];
468} __packed;
469
470static int
471write_fnt(const char *filename)
472{
473	FILE *fp;
474	struct file_header fh = {
475		.magic = "VFNT0002",
476	};
477
478	fp = fopen(filename, "wb");
479	if (fp == NULL) {
480		perror(filename);
481		return (1);
482	}
483
484	fh.width = width;
485	fh.height = height;
486	fh.glyph_count = htobe32(glyph_unique);
487	fh.map_count[0] = htobe32(map_folded_count[0]);
488	fh.map_count[1] = htobe32(map_folded_count[1]);
489	fh.map_count[2] = htobe32(map_folded_count[2]);
490	fh.map_count[3] = htobe32(map_folded_count[3]);
491	if (fwrite(&fh, sizeof fh, 1, fp) != 1) {
492		perror(filename);
493		fclose(fp);
494		return (1);
495	}
496
497	if (write_glyphs(fp) != 0 ||
498	    write_mappings(fp, VFNT_MAP_NORMAL) != 0 ||
499	    write_mappings(fp, 1) != 0 ||
500	    write_mappings(fp, VFNT_MAP_BOLD) != 0 ||
501	    write_mappings(fp, 3) != 0) {
502		perror(filename);
503		fclose(fp);
504		return (1);
505	}
506
507	fclose(fp);
508	return (0);
509}
510
511static void
512print_font_info(void)
513{
514	printf(
515"Statistics:\n"
516"- glyph_total:                 %6u\n"
517"- glyph_normal:                %6u\n"
518"- glyph_normal_right:          %6u\n"
519"- glyph_bold:                  %6u\n"
520"- glyph_bold_right:            %6u\n"
521"- glyph_unique:                %6u\n"
522"- glyph_dupe:                  %6u\n"
523"- mapping_total:               %6u\n"
524"- mapping_normal:              %6u\n"
525"- mapping_normal_folded:       %6u\n"
526"- mapping_normal_right:        %6u\n"
527"- mapping_normal_right_folded: %6u\n"
528"- mapping_bold:                %6u\n"
529"- mapping_bold_folded:         %6u\n"
530"- mapping_bold_right:          %6u\n"
531"- mapping_bold_right_folded:   %6u\n"
532"- mapping_unique:              %6u\n"
533"- mapping_dupe:                %6u\n",
534	    glyph_total,
535	    glyph_count[0],
536	    glyph_count[1],
537	    glyph_count[2],
538	    glyph_count[3],
539	    glyph_unique, glyph_dupe,
540	    mapping_total,
541	    map_count[0], map_folded_count[0],
542	    map_count[1], map_folded_count[1],
543	    map_count[2], map_folded_count[2],
544	    map_count[3], map_folded_count[3],
545	    mapping_unique, mapping_dupe);
546}
547
548int
549main(int argc, char *argv[])
550{
551	int ch, val, verbose = 0;
552
553	assert(sizeof(struct file_header) == 32);
554	assert(sizeof(struct file_mapping) == 8);
555
556	while ((ch = getopt(argc, argv, "h:vw:")) != -1) {
557		switch (ch) {
558		case 'h':
559			val = atoi(optarg);
560			if (val <= 0 || val > 128)
561				errx(1, "Invalid height %d", val);
562			height = val;
563			break;
564		case 'v':
565			verbose = 1;
566			break;
567		case 'w':
568			set_width(atoi(optarg));
569			break;
570		case '?':
571		default:
572			usage();
573		}
574	}
575	argc -= optind;
576	argv += optind;
577
578	if (argc < 2 || argc > 3)
579		usage();
580
581	wbytes = howmany(width, 8);
582
583	if (parse_file(argv[0], VFNT_MAP_NORMAL) != 0)
584		return (1);
585	argc--;
586	argv++;
587	if (argc == 2) {
588		if (parse_file(argv[0], VFNT_MAP_BOLD) != 0)
589			return (1);
590		argc--;
591		argv++;
592	}
593	number_glyphs();
594	dedup_mapping(VFNT_MAP_BOLD);
595	dedup_mapping(VFNT_MAP_BOLD_RH);
596	fold_mappings(0);
597	fold_mappings(1);
598	fold_mappings(2);
599	fold_mappings(3);
600	if (write_fnt(argv[0]) != 0)
601		return (1);
602
603	if (verbose)
604		print_font_info();
605
606	return (0);
607}
608