plomlompom.com Git - plomrogue/blob - 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()
   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 void try_fgets(char * line, int linemax, FILE * file,
  63                       struct World * w, char * f)
  64 {
  65     char * msg = trouble_msg(w, f, "fgets()");
  66     exit_err(NULL == fgets(line, linemax, file), w, msg);
  67     free(msg);
  68 }
  69
  70
  71
  72 extern void try_fwrite(void * ptr, size_t size, size_t nmemb, FILE * stream,
  73                        struct World * w, char * f)
  74 {
  75     char * msg = trouble_msg(w, f, "fwrite()");
  76     exit_err(0 == fwrite(ptr, size, nmemb, stream), w, msg);
  77     free(msg);
  78 }
  79
  80
  81
  82 extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2,
  83                                      struct World * w, char * f)
  84 {
  85     try_fclose(file, w, f);
  86     char * msg1 = "Trouble in ";
  87     char * msg4 = "'.";
  88     if (!access(p2, F_OK))
  89     {
  90         char * msg2 = " with unlink() on path '";
  91         uint16_t size = strlen(msg1) + strlen(msg2) + strlen(msg4)
  92                         + strlen(f) + strlen(p2) + 1;
  93         char msg[size];
  94         sprintf(msg, "%s%s%s%s%s", msg1, f, msg2, p2, msg4);
  95         exit_err(unlink(p2), w, msg);
  96     }
  97     char * msg2 = " with rename() from '";
  98     char * msg3 = "' to '";
  99     uint16_t size = strlen(msg1) + strlen(f) + strlen(msg2) + strlen(p1)
 100                     + strlen(msg3) + strlen(p2) + strlen(msg4) + 1;
 101     char msg[size];
 102     sprintf(msg, "%s%s%s%s%s%s%s", msg1, f, msg2, p1, msg3, p2, msg4);
 103     exit_err(rename(p1, p2), w, msg);
 104 }
 105
 106
 107
 108 extern uint16_t get_linemax(FILE * file, struct World * w, char * f)
 109 {
 110     char * msg = trouble_msg(w, f, "textfile_sizes()");
 111     uint16_t linemax;
 112     exit_err(textfile_sizes(file, &linemax, NULL), w, msg);
 113     free(msg);
 114     return linemax;
 115 }
 116
 117
 118
 119 extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
 120                               uint16_t * n_lines_p)
 121 {
 122     int c = 0;
 123     uint16_t c_count = 0;
 124     uint16_t n_lines = 0;
 125     uint16_t linemax = 0;
 126     while (1)
 127     {
 128         c = fgetc(file);
 129         if (EOF == c)
 130         {
 131             break;
 132         }
 133         c_count++;
 134         if ('\n' == c)
 135         {
 136             if (c_count > linemax)
 137             {
 138                 linemax = c_count;
 139             }
 140             c_count = 0;
 141             if (n_lines_p)
 142             {
 143                 n_lines++;
 144             }
 145         }
 146     }
 147     if (0 == linemax && 0 < c_count) /* Handle files that consist of only one */
 148     {                                /* line / lack newline chars.            */
 149         linemax = c_count;
 150     }
 151
 152     if (-1 == fseek(file, 0, SEEK_SET))
 153     {
 154         return 1;
 155     }
 156     * linemax_p = linemax;
 157     if (n_lines_p)
 158     {
 159         * n_lines_p = n_lines;
 160     }
 161     return 0;
 162 }
 163
 164
 165
 166 static uint8_t read_uintX_bigendian(FILE * file, uint32_t * x, uint8_t size)
 167 {
 168     * x = 0;
 169     int16_t bitshift = size - 8;
 170     int test;
 171     for (; bitshift >= 0; bitshift = bitshift - 8)
 172     {
 173         test = fgetc(file);
 174         if (EOF == test)
 175         {
 176             return 1;
 177         }
 178         * x = * x + ((uint32_t) test << bitshift);
 179     }
 180     return 0;
 181 }
 182
 183
 184
 185 static uint8_t write_uintX_bigendian(FILE * file, uint32_t x, uint8_t size)
 186 {
 187     int16_t bitshift = size - 8;
 188     for (; bitshift >= 0; bitshift = bitshift - 8)
 189     {
 190         if (EOF == fputc((x >> bitshift) & 0xFF, file))
 191         {
 192             return 1;
 193         }
 194     }
 195     return 0;
 196 }
 197
 198
 199
 200 extern uint8_t read_uint8(FILE * file, uint8_t * x)
 201 {
 202     /* Since read_uintX_bigendian() works on -- and zeroes -- four bytes, direct
 203      * work on values of fewer bytes would corrupt immediate neighbor values.
 204      */
 205     uint32_t y = * x;
 206     uint8_t err = read_uintX_bigendian(file, &y, 8);
 207     * x = (uint8_t) y;
 208     return err;
 209 }
 210
 211
 212
 213 extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x)
 214 {
 215     /* See read_uint8() introductory code comment for rationale. */
 216     uint32_t y = * x;
 217     uint8_t err = read_uintX_bigendian(file, &y, 16);
 218     * x = (uint16_t) y;
 219     return err;
 220 }
 221
 222
 223
 224 extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x)
 225 {
 226     return read_uintX_bigendian(file, x, 32);
 227 }
 228
 229
 230
 231 extern uint8_t write_uint8(uint8_t x, FILE * file)
 232 {
 233     return write_uintX_bigendian(file, x, 8);
 234 }
 235
 236
 237
 238 extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file)
 239 {
 240     return write_uintX_bigendian(file, x, 16);
 241 }
 242
 243
 244
 245 extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file)
 246 {
 247     return write_uintX_bigendian(file, x, 32);
 248 }