3 * Routines for reading and writing files.
9 #include <stdio.h> /* for FILE typedef */
10 #include <stdint.h> /* for uint8_t, uint16_t, uint32_t */
14 /* Wrappers to calling from function called "f" of fopen(), fclose(), fgets()
15 * and fwrite() and calling exit_err() with appropriate error messages.
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,
21 extern void try_fputc(uint8_t c, FILE * file, char * f);
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.
27 extern char * try_fgets(char * line, int size, FILE * file, char * f);
29 /* Wrappers to calling fgetc() and (try_fgetc_noeof()) treating all EOFs returns
30 * as errors to call exit_trouble(), or (try_fgetc()) only if ferror() says so.
32 extern int try_fgetc(FILE * file, char * f);
33 extern uint8_t try_fgetc_noeof(FILE * file, char * f);
35 /* Wrapper to successive call of fclose() from function called "f" on "file",
36 * then unlink() on file at "p2" if it exists, then rename() on "p1" to "p2".
37 * Used for handling atomic saving of files via temp files.
39 extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2,
42 /* Wrapper: Call textfile_sizes() from function called "f" to get max line
43 * length (includes newline char) of "file", exit via exit_err() with
44 * exit_trouble() on failure.
46 extern uint16_t get_linemax(FILE * file, char * f);
48 /* Learn from "file" the largest line length (pointed to by "linemax_p"; length
49 * includes newline chars) and (pointed to by "n_lines_p" if it is not set to
50 * NULL) the number of lines (= number of newline chars).
52 * Returns 0 on success, 1 on error of fseek() (called to return to initial file
55 extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
56 uint16_t * n_lines_p);
58 /* Read/write via try_(fgetc|fputc)() uint32 values with defined endianness. */
59 extern uint32_t read_uint32_bigendian(FILE * file);
60 extern void write_uint32_bigendian(uint32_t x, FILE * file);