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 calling from function called "f" of fopen(), fclose(), fgets()
  15  * and fwrite() and calling exit_err() 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
  22
  23
  24 /* Wrapper to calling fgets() from function called "f". The return code of
  25  * fgets() is returned unless it is NULL *and* ferror() indicates that an error
  26  * occured; otherwise end of file is assumed and NULL is returned properly.
  27  */
  28 extern char * try_fgets(char * line, int size, FILE * file, char * f);
  29
  30
  31
  32 /* Wrapper to successive call of fclose() from function called "f" on "file",
  33  * then unlink() on file at "p2" if it exists, then rename() on "p1" to "p2".
  34  * Used for handling atomic saving of files via temp files.
  35  */
  36 extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2,
  37                                      char * f);
  38
  39
  40
  41 /* Wrapper: Call textfile_sizes() from function called "f" to get max line
  42  * length of "file", exit via exit_err() with trouble_msg()-generated error
  43  * message on failure.
  44  */
  45 extern uint16_t get_linemax(FILE * file, char * f);
  46
  47
  48
  49 /* Learn from "file" the largest line length (pointed to by "linemax_p"; length
  50  * includes newline chars) and (pointed to by "n_lines_p" if it is not set to
  51  * NULL) the number of lines (= number of newline chars).
  52  *
  53  * Returns 0 on success, 1 on error of fseek() (called to return to initial file
  54  * reading position).
  55  */
  56 extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
  57                               uint16_t * n_lines_p);
  58
  59
  60
  61 /* These routines for reading values "x" from / writing values to "file" ensure
  62  * a defined endianness and consistent error codes: return 0 on success and 1 on
  63  * fgetc()/fputc() failure.
  64  */
  65 extern uint8_t read_uint8(FILE * file, uint8_t * x);
  66 extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x);
  67 extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x);
  68 extern uint8_t write_uint8(uint8_t x, FILE * file);
  69 extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file);
  70 extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file);
  71
  72
  73
  74 #endif