home · contact · privacy
657d8173dd674ecfa9528cfce9653ee5dd841449
[plomrogue] / src / readwrite.c
1 /* readwrite.c */
2
3 #include "readwrite.h"
4 #include <stdio.h>  /* for FILE typedef, fopen(), fgetc(), fputc(), fseek(),
5                      * sprintf(), fwrite(), ferror()
6                      */
7 #include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
8 #include <string.h> /* for strlen()*/
9 #include <unistd.h> /* for unlink() */
10 #include "rexit.h"  /* for exit_err() */
11 #include "misc.h"   /* for trouble_msg() */
12 struct World;
13
14
15
16 /* Read/write "x" from/to "file" as bigendian representation of "size" bits. On
17  * failure, return 1, else 0. (As of of now, all extern read/write functions
18  * build on top of these.)
19  *
20  * Only use multiples of 8 greater or equal 32 for "size", so that storage
21  * inside uint32_t is possible. Originally a bit number check prefaced the code
22  * of both functions. It was removed as redundant due to all possible "size"
23  * values being hardcoded into the library (i.e. in all extern functions calling
24  * / wrapping around either function). If this ever changes, (re-)insert:
25  *
26  *    if (0 == size || size > 32 || 0 != size % 8)
27  *    {
28  *        return 1;
29  *    }
30  */
31 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size);
32 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size);
33
34
35
36 extern FILE * try_fopen(char * path, char * mode, struct World * w, char * f)
37 {
38     char * msg1 = "Trouble in ";
39     char * msg2 = " with fopen() (mode '";
40     char * msg3 = "') on path '";
41     char * msg4 = "'.";
42     uint16_t size = strlen(msg1) + strlen(msg2) + strlen(msg3) + strlen(msg4)
43                     + strlen(f) + strlen(path) + strlen(mode) + 1;
44     char msg[size];
45     sprintf(msg, "%s%s%s%s%s%s%s", msg1, f, msg2, mode, msg3, path, msg4);
46     FILE * file_p = fopen(path, mode);
47     exit_err(NULL == file_p, w, msg);
48     return file_p;
49 }
50
51
52
53 extern void try_fclose(FILE * file, struct World * w, char * f)
54 {
55     char * msg = trouble_msg(w, f, "fclose()");
56     exit_err(fclose(file), w, msg);
57     free(msg);
58 }
59
60
61
62 extern char * try_fgets(char * line, int linemax, FILE * file,
63                         struct World * w, char * f)
64 {
65     char * msg = trouble_msg(w, f, "fgets()");
66     char * test = fgets(line, linemax, file);
67     exit_err(NULL == test && ferror(file), w, msg);
68     free(msg);
69     return test;
70 }
71
72
73
74 extern void try_fwrite(void * ptr, size_t size, size_t nmemb, FILE * stream,
75                        struct World * w, char * f)
76 {
77     char * msg = trouble_msg(w, f, "fwrite()");
78     exit_err(0 == fwrite(ptr, size, nmemb, stream), w, msg);
79     free(msg);
80 }
81
82
83
84 extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2,
85                                      struct World * w, char * f)
86 {
87     try_fclose(file, w, f);
88     char * msg1 = "Trouble in ";
89     char * msg4 = "'.";
90     if (!access(p2, F_OK))
91     {
92         char * msg2 = " with unlink() on path '";
93         uint16_t size = strlen(msg1) + strlen(msg2) + strlen(msg4)
94                         + strlen(f) + strlen(p2) + 1;
95         char msg[size];
96         sprintf(msg, "%s%s%s%s%s", msg1, f, msg2, p2, msg4);
97         exit_err(unlink(p2), w, msg);
98     }
99     char * msg2 = " with rename() from '";
100     char * msg3 = "' to '";
101     uint16_t size = strlen(msg1) + strlen(f) + strlen(msg2) + strlen(p1)
102                     + strlen(msg3) + strlen(p2) + strlen(msg4) + 1;
103     char msg[size];
104     sprintf(msg, "%s%s%s%s%s%s%s", msg1, f, msg2, p1, msg3, p2, msg4);
105     exit_err(rename(p1, p2), w, msg);
106 }
107
108
109
110 extern uint16_t get_linemax(FILE * file, struct World * w, char * f)
111 {
112     char * msg = trouble_msg(w, f, "textfile_sizes()");
113     uint16_t linemax;
114     exit_err(textfile_sizes(file, &linemax, NULL), w, msg);
115     free(msg);
116     return linemax;
117 }
118
119
120
121 extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
122                               uint16_t * n_lines_p)
123 {
124     int c = 0;
125     uint16_t c_count = 0;
126     uint16_t n_lines = 0;
127     uint16_t linemax = 0;
128     while (1)
129     {
130         c = fgetc(file);
131         if (EOF == c)
132         {
133             break;
134         }
135         c_count++;
136         if ('\n' == c)
137         {
138             if (c_count > linemax)
139             {
140                 linemax = c_count;
141             }
142             c_count = 0;
143             if (n_lines_p)
144             {
145                 n_lines++;
146             }
147         }
148     }
149     if (0 == linemax && 0 < c_count) /* Handle files that consist of only one */
150     {                                /* line / lack newline chars.            */
151         linemax = c_count;
152     }
153
154     if (-1 == fseek(file, 0, SEEK_SET))
155     {
156         return 1;
157     }
158     * linemax_p = linemax;
159     if (n_lines_p)
160     {
161         * n_lines_p = n_lines;
162     }
163     return 0;
164 }
165
166
167
168 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size)
169 {
170     * x = 0;
171     int16_t bitshift = size - 8;
172     int test;
173     for (; bitshift >= 0; bitshift = bitshift - 8)
174     {
175         test = fgetc(file);
176         if (EOF == test)
177         {
178             return 1;
179         }
180         * x = * x + ((uint32_t) test << bitshift);
181     }
182     return 0;
183 }
184
185
186
187 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size)
188 {
189     int16_t bitshift = size - 8;
190     for (; bitshift >= 0; bitshift = bitshift - 8)
191     {
192         if (EOF == fputc((x >> bitshift) & 0xFF, file))
193         {
194             return 1;
195         }
196     }
197     return 0;
198 }
199
200
201
202 extern uint8_t read_uint8(FILE * file, uint8_t * x)
203 {
204     /* Since read_uintX_bigendian() works on -- and zeroes -- four bytes, direct
205      * work on values of fewer bytes would corrupt immediate neighbor values.
206      */
207     uint32_t y = * x;
208     uint8_t err = read_uintX_bigendian(file, &y, 8);
209     * x = (uint8_t) y;
210     return err;
211 }
212
213
214
215 extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x)
216 {
217     /* See read_uint8() introductory code comment for rationale. */
218     uint32_t y = * x;
219     uint8_t err = read_uintX_bigendian(file, &y, 16);
220     * x = (uint16_t) y;
221     return err;
222 }
223
224
225
226 extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x)
227 {
228     return read_uintX_bigendian(file, x, 32);
229 }
230
231
232
233 extern uint8_t write_uint8(uint8_t x, FILE * file)
234 {
235     return write_uintX_bigendian(file, x, 8);
236 }
237
238
239
240 extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file)
241 {
242     return write_uintX_bigendian(file, x, 16);
243 }
244
245
246
247 extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file)
248 {
249     return write_uintX_bigendian(file, x, 32);
250 }