home · contact · privacy
Corrected unused bit number check.
[plomrogue] / src / readwrite.c
1 /* readwrite.c */
2
3 #include "readwrite.h"
4 #include <stdio.h> /* for FILE typedef*/
5 #include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
6
7
8
9 /* Read/write "x" from/to "file" as bigendian representation of "size" bits. On
10  * failure, return 1, else 0. (As of of now, all extern read/write functions
11  * build on top of these.)
12  *
13  * Only use multiples of 8 greater or equal 32 for "size". Originally a bit
14  * number check prefaced the code of both functions. It was removed as redundant
15  * due to all possible "size" values being hardcoded into the library (i.e. in
16  * all extern functions calling / wrapping around either function). If this ever
17  * changes, (re-)insert:
18  *
19  *    if (0 == size || size > 32 || 0 != size % 8)
20  *    {
21  *        return 1;
22  *    }
23  */
24 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size);
25 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size);
26
27
28 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size)
29 {
30     * x = 0;
31     int16_t bitshift = size - 8;
32     int test;
33     for (; bitshift >= 0; bitshift = bitshift - 8)
34     {
35         test = fgetc(file);
36         if (EOF == test)
37         {
38             return 1;
39         }
40         * x = * x + ((uint32_t) test << bitshift);
41     }
42     return 0;
43 }
44
45
46
47 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size)
48 {
49     int16_t bitshift = size - 8;
50     for (; bitshift >= 0; bitshift = bitshift - 8)
51     {
52         if (EOF == fputc((x >> bitshift) & 0xFF, file))
53         {
54             return 1;
55         }
56     }
57     return 0;
58 }
59
60
61
62 extern uint8_t read_uint8(FILE * file, uint8_t * x)
63 {
64     /* Since read_uintX_bigendian() works on -- and zeroes -- four bytes, direct
65      * work on values of fewer bytes would corrupt immediate neighbor values.
66      */
67     uint32_t y = * x;
68     uint8_t err = read_uintX_bigendian(file, &y, 8);
69     * x = (uint8_t) y;
70     return err;
71 }
72
73
74
75 extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x)
76 {
77     /* See read_uint8() introductory code comment for rationale. */
78     uint32_t y = * x;
79     uint8_t err = read_uintX_bigendian(file, &y, 16);
80     * x = (uint16_t) y;
81     return err;
82 }
83
84
85
86 extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x)
87 {
88     return read_uintX_bigendian(file, x, 32);
89 }
90
91
92
93 extern uint8_t write_uint8(uint8_t x, FILE * file)
94 {
95     return write_uintX_bigendian(file, x, 8);
96 }
97
98
99
100 extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file)
101 {
102     return write_uintX_bigendian(file, x, 16);
103 }
104
105
106
107 extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file)
108 {
109     return write_uintX_bigendian(file, x, 32);
110 }