plomlompom.com Git - plomrogue/blob - src/readwrite.h

   1 /* readwrite.h:
   2  *
   3  * Routines for reading and writing files.
   4  */
   5
   6 #ifndef READWRITE_H
   7 #define READWRITE_H
   8
   9 #include <stdio.h> /* for FILE typedef */
  10 #include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
  11
  12
  13
  14 /* Wrappers to fopen(), fclose(), fgets() and fwrite() from function called "f",
  15  * calling exit_err() upon error with appropriate error messages.
  16  */
  17 extern FILE * try_fopen(char * path, char * mode, char * f);
  18 extern void try_fclose(FILE * file, char * f);
  19 extern void try_fwrite(void * ptr, size_t size, size_t nmemb, FILE * stream,
  20                        char * f);
  21 extern void try_fputc(uint8_t c, FILE * file, char * f);
  22
  23 /* Wrapper to calling fgets() from function called "f". The return code of
  24  * fgets() is returned unless it is NULL *and* ferror() indicates that an error
  25  * occured; otherwise end of file is assumed and NULL is returned properly.
  26  */
  27 extern char * try_fgets(char * line, int size, FILE * file, char * f);
  28
  29 /* Wrapper to calling fgetc() from function "f", treating either
  30  * (try_fgetc_noeof()) all EOF returns as errors triggering exit_trouble(), or
  31  * (try_fgetc()) only those accompanied by a positive ferror() result.
  32  */
  33 extern int try_fgetc(FILE * file, char * f);
  34 extern uint8_t try_fgetc_noeof(FILE * file, char * f);
  35
  36 /* Wrapper to successive call of fclose() from function called "f" on "file",
  37  * then unlink() on file at path "p2" if it exists, then rename() from path "p1"
  38  * to "p2". Used for handling atomic saving of files via temp files.
  39  */
  40 extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2,
  41                                      char * f);
  42
  43 /* Return largest line length from "file" the largest line length (including
  44  * newline chars) and write the number of newline chars in "file" to the memory
  45  * pointed to by "n_lines_p" if it is not passed as NULL.
  46  */
  47 extern uint16_t textfile_sizes(FILE * file, uint16_t * n_lines_p);
  48
  49 /* Read/write via try_(fgetc|fputc)() uint32 values with defined endianness. */
  50 extern uint32_t read_uint32_bigendian(FILE * file);
  51 extern void write_uint32_bigendian(uint32_t x, FILE * file);
  52
  53
  54
  55 #endif