home · contact · privacy
Added explanatory comments to readwrite library.
[plomrogue] / src / readwrite.c
1 /* readwrite.c */
2
3 #include "readwrite.h"
4 #include <stdio.h> /* for FILE typedef*/
5 #include <stdint.h> /* for uint16_t, uint32_t */
6
7
8
9 /* Read/write "x" from/to "file" as bigendian representation of "size" bits. */
10 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size);
11 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size);
12
13
14
15 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size)
16 {
17     if (0 != size % 8)
18     {
19         return 1;
20     }
21     int16_t bitshift = size - 8;
22
23     * x = 0;
24     int test;
25     for (; bitshift >= 0; bitshift = bitshift - 8)
26     {
27         test = fgetc(file);
28         if (EOF == test)
29         {
30             return 1;
31         }
32         * x = * x + ((uint32_t) test << bitshift);
33     }
34     return 0;
35 }
36
37
38
39 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size)
40 {
41     if (0 != size % 8)
42     {
43         return 1;
44     }
45     int16_t bitshift = size - 8;
46
47     for (; bitshift >= 0; bitshift = bitshift - 8)
48     {
49         if (EOF == fputc((x >> bitshift) & 0xFF, file))
50         {
51             return 1;
52         }
53     }
54     return 0;
55 }
56
57
58
59 extern uint8_t read_uint8(FILE * file, uint8_t * x)
60 {
61     /* Since read_uintX_bigendian() works on -- and zeroes -- four bytes, work
62      * on values of fewer bytes corrupts their immediate neighbor bytes. This
63      * necessitates working on newly acquired separate memory areas (* y), only
64      * copying the sufficiently small end result to * x.
65      */
66     uint32_t y = * x;
67     uint8_t err = read_uintX_bigendian(file, &y, 8);
68     * x = (uint8_t) y;
69     return err;
70 }
71
72
73
74 extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x)
75 {
76     /* See read_uint8() introductory comment for rationale. */
77     uint32_t y = * x;
78     uint8_t err = read_uintX_bigendian(file, &y, 16);
79     * x = (uint16_t) y;
80     return err;
81 }
82
83
84
85 extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x)
86 {
87     return read_uintX_bigendian(file, x, 32);
88 }
89
90
91
92 extern uint8_t write_uint8(uint8_t x, FILE * file)
93 {
94     return write_uintX_bigendian(file, x, 8);
95 }
96
97
98
99 extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file)
100 {
101     return write_uintX_bigendian(file, x, 16);
102 }
103
104
105
106 extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file)
107 {
108     return write_uintX_bigendian(file, x, 32);
109 }