home · contact · privacy
Replaced entire read/write_uint*_bigendian() family in readwrite library with simpler...
[plomrogue] / 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 /* Wrapper to calling fgets() from function called "f". The return code of
23  * fgets() is returned unless it is NULL *and* ferror() indicates that an error
24  * occured; otherwise end of file is assumed and NULL is returned properly.
25  */
26 extern char * try_fgets(char * line, int size, FILE * file, char * f);
27
28 /* fgetc()/fputc() wrappers to catch EOF returns/upon it call exit_trouble(). */
29 extern uint8_t try_fgetc(FILE * file, char * f);
30 extern void try_fputc(uint8_t c, FILE * file, char * f);
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 /* Wrapper: Call textfile_sizes() from function called "f" to get max line
40  * length (includes newline char) of "file", exit via exit_err() with
41  * exit_trouble() on failure.
42  */
43 extern uint16_t get_linemax(FILE * file, char * f);
44
45 /* Learn from "file" the largest line length (pointed to by "linemax_p"; length
46  * includes newline chars) and (pointed to by "n_lines_p" if it is not set to
47  * NULL) the number of lines (= number of newline chars).
48  *
49  * Returns 0 on success, 1 on error of fseek() (called to return to initial file
50  * reading position).
51  */
52 extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
53                               uint16_t * n_lines_p);
54
55 /* Read/write via try_(fgetc|fputc)() uint32 values with defined endianness. */
56 extern uint32_t read_uint32_bigendian(FILE * file);
57 extern void write_uint32_bigendian(uint32_t x, FILE * file);
58
59
60
61 #endif