source: mainline/uspace/lib/draw/font/pcf.c@ b7fd2a0

lfn serial ticket/834-toolchain-update topic/msim-upgrade topic/simplify-dev-export
Last change on this file since b7fd2a0 was b7fd2a0, checked in by Jiří Zárevúcky <zarevucky.jiri@…>, 8 years ago

Use errno_t in all uspace and kernel code.

Change type of every variable, parameter and return value that holds an
<errno.h> constant to either errno_t (the usual case), or sys_errno_t
(some places in kernel). This is for the purpose of self-documentation,
as well as for type-checking with a bit of type definition hackery.

Although this is a massive commit, it is a simple text replacement, and thus
is very easy to verify. Simply do the following:

`
git checkout <this commit's hash>
git reset HEAD
git add .
tools/srepl '\berrno_t\b' int
git add .
tools/srepl '\bsys_errno_t\b' sysarg_t
git reset
git diff
`

While this doesn't ensure that the replacements are correct, it does ensure
that the commit doesn't do anything except those replacements. Since errno_t
is typedef'd to int in the usual case (and sys_errno_t to sysarg_t), even if
incorrect, this commit cannot change behavior.
  • Property mode set to 100644
File size: 16.9 KB
Line 
1/*
2 * Copyright (c) 2014 Martin Sucha
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * - Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * - Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
14 * - The name of the author may not be used to endorse or promote products
15 * derived from this software without specific prior written permission.
16 *
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
18 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
19 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
20 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
21 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
22 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
23 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
24 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27 */
28
29/** @addtogroup draw
30 * @{
31 */
32/**
33 * @file
34 */
35
36#include <stddef.h>
37#include <stdint.h>
38#include <errno.h>
39#include <byteorder.h>
40#include <stdio.h>
41#include <align.h>
42#include <offset.h>
43#include <stdlib.h>
44
45#include "pcf.h"
46#include "../drawctx.h"
47#include "bitmap_backend.h"
48
49#define PCF_TABLE_ACCELERATORS 0x02
50#define PCF_TABLE_METRICS 0x04
51#define PCF_TABLE_BITMAPS 0x08
52#define PCF_TABLE_INK_METRICS 0x10
53#define PCF_TABLE_ENCODINGS 0x20
54
55#define PCF_FORMAT_DEFAULT 0x00000000
56#define PCF_FORMAT_MASK 0xffffff00
57#define PCF_FORMAT_MSBYTE_FIRST 0x00000004
58#define PCF_FORMAT_MSBIT_FIRST 0x00000008
59#define PCF_FORMAT_COMPRESSED_METRICS 0x00000100
60
61typedef struct {
62 uint32_t type;
63 uint32_t format;
64 uint32_t size; /* in bytes */
65 uint32_t offset; /* in bytes from beginning of file */
66} __attribute__((__packed__)) pcf_toc_entry_t;
67
68typedef struct {
69 uint16_t min_byte2;
70 uint16_t max_byte2;
71 uint16_t min_byte1;
72 uint16_t max_byte1;
73 uint16_t default_char;
74} __attribute__((__packed__)) pcf_encoding_t;
75
76typedef struct {
77 uint8_t left_side_bearing;
78 uint8_t right_side_bearing;
79 uint8_t character_width;
80 uint8_t character_ascent;
81 uint8_t character_descent;
82} __attribute__((__packed__)) pcf_compressed_metrics_t;
83
84typedef struct {
85 int16_t left_side_bearing;
86 int16_t right_side_bearing;
87 int16_t character_width;
88 int16_t character_ascent;
89 int16_t character_descent;
90 uint16_t character_attributes;
91} __attribute__((__packed__)) pcf_default_metrics_t;
92
93typedef struct {
94 uint8_t unused_font_information[8];
95 int32_t font_ascent;
96 int32_t font_descent;
97} __attribute__((__packed__)) pcf_accelerators_t;
98
99typedef struct {
100 FILE *file;
101 uint32_t glyph_count;
102 pcf_toc_entry_t bitmap_table;
103 pcf_toc_entry_t metrics_table;
104 pcf_toc_entry_t encodings_table;
105 pcf_toc_entry_t accelerators_table;
106 pcf_encoding_t encoding;
107 font_metrics_t font_metrics;
108} pcf_data_t;
109
110static inline uint32_t uint32_t_pcf2host(uint32_t val, uint32_t format)
111{
112 if (format & PCF_FORMAT_MSBYTE_FIRST) {
113 return uint32_t_be2host(val);
114 }
115 else {
116 return uint32_t_le2host(val);
117 }
118}
119
120static inline uint16_t uint16_t_pcf2host(uint16_t val, uint32_t format)
121{
122 if (format & PCF_FORMAT_MSBYTE_FIRST) {
123 return uint16_t_be2host(val);
124 }
125 else {
126 return uint16_t_le2host(val);
127 }
128}
129
130static inline int16_t int16_t_pcf2host(int16_t val, uint32_t format)
131{
132 return (int16_t) uint16_t_pcf2host((uint16_t) val, format);
133}
134
135static inline int32_t int32_t_pcf2host(int32_t val, uint32_t format)
136{
137 return (int32_t) uint32_t_pcf2host((uint32_t) val, format);
138}
139
140
141static int16_t compressed2int(uint8_t compressed)
142{
143 int16_t ret = compressed;
144 ret -= 0x80;
145 return ret;
146}
147
148static errno_t pcf_resolve_glyph(void *opaque_data, const wchar_t chr,
149 glyph_id_t *glyph_id)
150{
151 pcf_data_t *data = (pcf_data_t *) opaque_data;
152
153 /* TODO is this correct? */
154 uint8_t byte1 = (chr >> 8) & 0xff;
155 uint8_t byte2 = chr & 0xff;
156 pcf_encoding_t *e = &data->encoding;
157
158 aoff64_t entry_index =
159 (byte1 - e->min_byte1) * (e->max_byte2 - e->min_byte2 + 1) +
160 (byte2 - e->min_byte2);
161
162 aoff64_t entry_offset = data->encodings_table.offset +
163 (sizeof(uint32_t) + 5 * sizeof(uint16_t)) +
164 entry_index * sizeof(uint16_t);
165
166 int rc = fseek(data->file, entry_offset, SEEK_SET);
167 if (rc != 0)
168 return errno;
169
170 uint16_t glyph = 0;
171 size_t records_read = fread(&glyph, sizeof(uint16_t), 1, data->file);
172 if (records_read != 1)
173 return EINVAL;
174
175 glyph = uint16_t_pcf2host(glyph, data->encodings_table.format);
176
177 if (glyph == 0xffff)
178 return ENOENT;
179
180 *glyph_id = glyph;
181
182 return EOK;
183}
184
185static errno_t load_glyph_metrics(pcf_data_t *data, uint32_t glyph_id,
186 pcf_toc_entry_t *table, pcf_default_metrics_t *metrics)
187{
188 aoff64_t offset;
189 int rc;
190 size_t records_read;
191
192 if (table->format & PCF_FORMAT_COMPRESSED_METRICS) {
193 offset = table->offset + sizeof(uint32_t) + sizeof(uint16_t) +
194 glyph_id * sizeof(pcf_compressed_metrics_t);
195
196 rc = fseek(data->file, offset, SEEK_SET);
197 if (rc != 0)
198 return errno;
199
200 pcf_compressed_metrics_t compressed_metrics;
201 records_read = fread(&compressed_metrics,
202 sizeof(pcf_compressed_metrics_t), 1,data->file);
203 if (records_read != 1)
204 return EINVAL;
205
206 metrics->left_side_bearing =
207 compressed2int(compressed_metrics.left_side_bearing);
208 metrics->right_side_bearing =
209 compressed2int(compressed_metrics.right_side_bearing);
210 metrics->character_width =
211 compressed2int(compressed_metrics.character_width);
212 metrics->character_ascent =
213 compressed2int(compressed_metrics.character_ascent);
214 metrics->character_descent =
215 compressed2int(compressed_metrics.character_descent);
216 metrics->character_attributes = 0;
217 }
218 else {
219 offset = table->offset + 2 * sizeof(uint32_t) +
220 glyph_id * sizeof(pcf_default_metrics_t);
221
222 rc = fseek(data->file, offset, SEEK_SET);
223 if (rc != 0)
224 return errno;
225
226 pcf_default_metrics_t uncompressed_metrics;
227 records_read = fread(&uncompressed_metrics,
228 sizeof(pcf_default_metrics_t), 1,data->file);
229 if (records_read != 1)
230 return EINVAL;
231
232 metrics->left_side_bearing =
233 int16_t_pcf2host(uncompressed_metrics.left_side_bearing,
234 table->format);
235 metrics->right_side_bearing =
236 int16_t_pcf2host(uncompressed_metrics.right_side_bearing,
237 table->format);
238 metrics->character_width =
239 int16_t_pcf2host(uncompressed_metrics.character_width,
240 table->format);
241 metrics->character_ascent =
242 int16_t_pcf2host(uncompressed_metrics.character_ascent,
243 table->format);
244 metrics->character_descent =
245 int16_t_pcf2host(uncompressed_metrics.character_descent,
246 table->format);
247 metrics->character_attributes =
248 uint16_t_pcf2host(uncompressed_metrics.character_attributes,
249 table->format);
250 }
251
252 return EOK;
253}
254
255static errno_t pcf_load_glyph_surface(void *opaque_data, glyph_id_t glyph_id,
256 surface_t **out_surface)
257{
258 pcf_data_t *data = (pcf_data_t *) opaque_data;
259
260 pcf_default_metrics_t pcf_metrics;
261 memset(&pcf_metrics, 0, sizeof(pcf_default_metrics_t));
262 errno_t rc = load_glyph_metrics(data, glyph_id, &data->metrics_table,
263 &pcf_metrics);
264 if (rc != EOK)
265 return rc;
266
267 aoff64_t offset = data->bitmap_table.offset + (2 * sizeof(uint32_t)) +
268 (glyph_id * sizeof(uint32_t));
269
270 if (fseek(data->file, offset, SEEK_SET) < 0)
271 return errno;
272
273 uint32_t bitmap_offset = 0;
274 size_t records_read = fread(&bitmap_offset, sizeof(uint32_t), 1,
275 data->file);
276 if (records_read != 1)
277 return EINVAL;
278 bitmap_offset = uint32_t_pcf2host(bitmap_offset,
279 data->bitmap_table.format);
280
281 offset = data->bitmap_table.offset + (2 * sizeof(uint32_t)) +
282 (data->glyph_count * sizeof(uint32_t)) + (4 * sizeof(uint32_t))
283 + bitmap_offset;
284
285 if (fseek(data->file, offset, SEEK_SET) < 0)
286 return errno;
287
288 surface_coord_t width = pcf_metrics.character_width;
289 surface_coord_t height = pcf_metrics.character_ascent +
290 pcf_metrics.character_descent;
291 size_t row_padding_bytes = (1 << (data->bitmap_table.format & 3));
292 size_t word_size_bytes = (1 << ((data->bitmap_table.format >> 4) & 3));
293 size_t row_bytes = ALIGN_UP(ALIGN_UP(width, 8) / 8, row_padding_bytes);
294 size_t bitmap_bytes = height * row_bytes;
295
296 uint8_t *bitmap = malloc(bitmap_bytes);
297 if (bitmap == NULL)
298 return ENOMEM;
299
300 records_read = fread(bitmap, sizeof(uint8_t), bitmap_bytes,
301 data->file);
302
303 surface_t *surface = surface_create(width, height, NULL, 0);
304 if (!surface) {
305 free(bitmap);
306 return ENOMEM;
307 }
308
309 for (unsigned int y = 0; y < height; ++y) {
310 size_t row_offset = row_bytes * y;
311 for (unsigned int x = 0; x < width; ++x) {
312 size_t word_index = x / (word_size_bytes * 8);
313 size_t column_offset1 = word_index * word_size_bytes;
314 size_t byte_index_within_word =
315 (x % (word_size_bytes * 8)) / 8;
316 size_t column_offset2;
317 if (data->bitmap_table.format & PCF_FORMAT_MSBYTE_FIRST) {
318 column_offset2 = (word_size_bytes - 1) - byte_index_within_word;
319 }
320 else {
321 column_offset2 = byte_index_within_word;
322 }
323 uint8_t b = bitmap[row_offset + column_offset1 + column_offset2];
324 bool set;
325 if (data->bitmap_table.format & PCF_FORMAT_MSBIT_FIRST) {
326 set = (b >> (7 - (x % 8))) & 1;
327 }
328 else {
329 set = (b >> (x % 8)) & 1;
330 }
331 pixel_t p = set ? PIXEL(255, 0, 0, 0) : PIXEL(0, 0, 0, 0);
332 surface_put_pixel(surface, x, y, p);
333 }
334 }
335
336 *out_surface = surface;
337 free(bitmap);
338 return EOK;
339}
340
341static errno_t pcf_load_glyph_metrics(void *opaque_data, glyph_id_t glyph_id,
342 glyph_metrics_t *gm)
343{
344 pcf_data_t *data = (pcf_data_t *) opaque_data;
345
346 pcf_default_metrics_t pcf_metrics;
347 memset(&pcf_metrics, 0, sizeof(pcf_default_metrics_t));
348 errno_t rc = load_glyph_metrics(data, glyph_id, &data->metrics_table,
349 &pcf_metrics);
350 if (rc != EOK)
351 return rc;
352
353 gm->left_side_bearing = pcf_metrics.left_side_bearing;
354 gm->width = pcf_metrics.character_width;
355 gm->right_side_bearing = pcf_metrics.right_side_bearing -
356 pcf_metrics.character_width;
357 gm->height = pcf_metrics.character_descent +
358 pcf_metrics.character_ascent;
359 gm->ascender = pcf_metrics.character_ascent;
360
361 return EOK;
362}
363
364static void pcf_release(void *opaque_data)
365{
366 pcf_data_t *data = (pcf_data_t *) opaque_data;
367
368 fclose(data->file);
369 free(data);
370}
371
372bitmap_font_decoder_t fd_pcf = {
373 .resolve_glyph = pcf_resolve_glyph,
374 .load_glyph_surface = pcf_load_glyph_surface,
375 .load_glyph_metrics = pcf_load_glyph_metrics,
376 .release = pcf_release
377};
378
379static errno_t pcf_read_toc(pcf_data_t *data)
380{
381 int rc = fseek(data->file, 0, SEEK_END);
382 if (rc != 0)
383 return errno;
384
385 aoff64_t file_size = ftell(data->file);
386
387 rc = fseek(data->file, 0, SEEK_SET);
388 if (rc != 0)
389 return errno;
390
391 char header[4];
392 size_t records_read = fread(header, sizeof(char), 4, data->file);
393 if (records_read != 4)
394 return EINVAL;
395
396 if (header[0] != 1 || header[1] != 'f' || header[2] != 'c' ||
397 header[3] != 'p')
398 return EINVAL;
399
400 uint32_t table_count;
401 records_read = fread(&table_count, sizeof(uint32_t), 1,
402 data->file);
403 if (records_read != 1)
404 return EINVAL;
405
406 table_count = uint32_t_le2host(table_count);
407
408 bool found_bitmap_table = false;
409 bool found_metrics_table = false;
410 bool found_encodings_table = false;
411 bool found_accelerators_table = false;
412
413 for (uint32_t index = 0; index < table_count; index++) {
414 pcf_toc_entry_t toc_entry;
415 records_read = fread(&toc_entry, sizeof(pcf_toc_entry_t), 1,
416 data->file);
417 toc_entry.type = uint32_t_le2host(toc_entry.type);
418 toc_entry.format = uint32_t_le2host(toc_entry.format);
419 toc_entry.size = uint32_t_le2host(toc_entry.size);
420 toc_entry.offset = uint32_t_le2host(toc_entry.offset);
421
422 if (toc_entry.offset >= file_size)
423 continue;
424
425 aoff64_t end = ((aoff64_t) toc_entry.offset) + ((aoff64_t) toc_entry.size);
426 if (end > file_size)
427 continue;
428
429 if (toc_entry.type == PCF_TABLE_BITMAPS) {
430 if (found_bitmap_table)
431 return EINVAL;
432 found_bitmap_table = true;
433 data->bitmap_table = toc_entry;
434 }
435 else if (toc_entry.type == PCF_TABLE_METRICS) {
436 if (found_metrics_table)
437 return EINVAL;
438 found_metrics_table = true;
439 data->metrics_table = toc_entry;
440 }
441 else if (toc_entry.type == PCF_TABLE_ENCODINGS) {
442 if (found_encodings_table)
443 return EINVAL;
444 found_encodings_table = true;
445 data->encodings_table = toc_entry;
446 }
447 else if (toc_entry.type == PCF_TABLE_ACCELERATORS) {
448 if (found_accelerators_table)
449 return EINVAL;
450 found_accelerators_table = true;
451 data->accelerators_table = toc_entry;
452 }
453 }
454
455 if (!found_bitmap_table || !found_metrics_table ||
456 !found_encodings_table || !found_accelerators_table)
457 return EINVAL;
458
459 return EOK;
460}
461
462static errno_t pcf_seek_table_header(pcf_data_t *data, pcf_toc_entry_t *table)
463{
464 uint32_t format;
465 int rc = fseek(data->file, table->offset, SEEK_SET);
466 if (rc != 0)
467 return errno;
468
469 size_t records_read = fread(&format, sizeof(uint32_t), 1, data->file);
470 if (records_read != 1)
471 return EINVAL;
472
473 format = uint32_t_le2host(format);
474 if (format != table->format)
475 return EINVAL;
476
477 return EOK;
478}
479
480static errno_t pcf_read_bitmap_table_header(pcf_data_t *data)
481{
482 errno_t rc = pcf_seek_table_header(data, &data->bitmap_table);
483 if (rc != EOK)
484 return rc;
485
486 if ((data->bitmap_table.format & PCF_FORMAT_MASK) != PCF_FORMAT_DEFAULT)
487 return EINVAL;
488
489 uint32_t glyph_count = 0;
490 size_t records_read = fread(&glyph_count, sizeof(uint32_t), 1,
491 data->file);
492 if (records_read != 1)
493 return EINVAL;
494 glyph_count = uint32_t_pcf2host(glyph_count, data->bitmap_table.format);
495
496 data->glyph_count = glyph_count;
497 return EOK;
498}
499
500static errno_t pcf_read_metrics_table_header(pcf_data_t *data)
501{
502 errno_t rc = pcf_seek_table_header(data, &data->metrics_table);
503 if (rc != EOK)
504 return rc;
505
506 size_t records_read;
507 uint32_t metrics_count;
508 if (data->metrics_table.format & PCF_FORMAT_COMPRESSED_METRICS) {
509 uint16_t metrics_count_16;
510 records_read = fread(&metrics_count_16, sizeof(uint16_t), 1,
511 data->file);
512 if (records_read != 1)
513 return EINVAL;
514 metrics_count_16 = uint16_t_pcf2host(metrics_count_16,
515 data->metrics_table.format);
516 metrics_count = metrics_count_16;
517 }
518 else {
519 records_read = fread(&metrics_count, sizeof(uint32_t), 1,
520 data->file);
521 if (records_read != 1)
522 return EINVAL;
523 metrics_count = uint32_t_pcf2host(metrics_count,
524 data->metrics_table.format);
525 }
526
527 if (metrics_count != data->glyph_count)
528 return EINVAL;
529
530 return EOK;
531}
532
533static errno_t pcf_read_encodings_table_header(pcf_data_t *data)
534{
535 errno_t rc = pcf_seek_table_header(data, &data->encodings_table);
536 if (rc != EOK)
537 return rc;
538
539 pcf_encoding_t encoding;
540 size_t records_read = fread(&encoding, sizeof(pcf_encoding_t), 1,
541 data->file);
542 if (records_read != 1)
543 return EINVAL;
544
545 encoding.min_byte1 = uint16_t_pcf2host(encoding.min_byte1,
546 data->encodings_table.format);
547 encoding.max_byte1 = uint16_t_pcf2host(encoding.max_byte1,
548 data->encodings_table.format);
549 encoding.min_byte2 = uint16_t_pcf2host(encoding.min_byte2,
550 data->encodings_table.format);
551 encoding.max_byte2 = uint16_t_pcf2host(encoding.max_byte2,
552 data->encodings_table.format);
553 encoding.default_char = uint16_t_pcf2host(encoding.default_char,
554 data->encodings_table.format);
555
556 data->encoding = encoding;
557 return EOK;
558}
559
560static errno_t pcf_read_accelerators_table(pcf_data_t *data)
561{
562 errno_t rc = pcf_seek_table_header(data, &data->accelerators_table);
563 if (rc != EOK)
564 return rc;
565
566 pcf_accelerators_t accelerators;
567 size_t records_read = fread(&accelerators, sizeof(pcf_accelerators_t),
568 1, data->file);
569 if (records_read != 1)
570 return EINVAL;
571
572 data->font_metrics.ascender = int32_t_pcf2host(accelerators.font_ascent,
573 data->accelerators_table.format);
574 data->font_metrics.descender = int32_t_pcf2host(accelerators.font_descent,
575 data->accelerators_table.format);
576 data->font_metrics.leading = 0;
577
578 return EOK;
579}
580
581errno_t pcf_font_create(font_t **font, char *filename, uint16_t points)
582{
583 errno_t rc;
584 pcf_data_t *data = malloc(sizeof(pcf_data_t));
585 if (data == NULL)
586 return ENOMEM;
587
588 data->file = fopen(filename, "rb");
589 if (data->file == NULL)
590 goto read_error;
591
592 rc = pcf_read_toc(data);
593 if (rc != EOK)
594 goto error;
595
596 rc = pcf_read_bitmap_table_header(data);
597 if (rc != EOK)
598 goto error;
599
600 rc = pcf_read_metrics_table_header(data);
601 if (rc != EOK)
602 goto error;
603
604 rc = pcf_read_encodings_table_header(data);
605 if (rc != EOK)
606 goto error;
607
608 rc = pcf_read_accelerators_table(data);
609 if (rc != EOK)
610 goto error;
611
612 rc = bitmap_font_create(&fd_pcf, data, data->glyph_count,
613 data->font_metrics, points, font);
614 if (rc != EOK)
615 goto error;
616
617 return EOK;
618read_error:
619 rc = EINVAL;
620error:
621 if (data->file)
622 fclose(data->file);
623 free(data);
624 return rc;
625}
626
627/** @}
628 */
Note: See TracBrowser for help on using the repository browser.