X-Git-Url: https://plomlompom.com/repos/?a=blobdiff_plain;f=src%2Freadwrite.h;h=0dc47da9eb4a7ee404bf48892e49868d76475caf;hb=10680a2398daf76e6a0cd261c2b247e6902f2ad0;hp=bcdf10eb20632caada30e8ee02fb35cd586ee8cf;hpb=ec5c4edd169be8fe8c778cabdfc7ada665629ffd;p=plomrogue diff --git a/src/readwrite.h b/src/readwrite.h index bcdf10e..0dc47da 100644 --- a/src/readwrite.h +++ b/src/readwrite.h @@ -6,62 +6,50 @@ #ifndef READWRITE_H #define READWRITE_H - - #include /* for FILE typedef */ #include /* for uint8_t, uint16_t, uint32_t */ -struct World; -/* Wrappers to calling from function called "f" of fopen(), fclose() and fgets() - * and calling exit_err() with appropriate error messages. +/* Wrappers to fopen(), fclose(), fgets() and fwrite() from function called "f", + * calling exit_err() upon error with appropriate error messages. */ -extern FILE * try_fopen(char * path, char * mode, struct World * w, char * f); -extern void try_fclose(FILE * file, struct World * w, char * f); -extern void try_fgets(char * line, int size, FILE * file, - struct World * w, char * f); - +extern FILE * try_fopen(char * path, char * mode, char * f); +extern void try_fclose(FILE * file, char * f); +extern void try_fwrite(void * ptr, size_t size, size_t nmemb, FILE * stream, + char * f); +extern void try_fputc(uint8_t c, FILE * file, char * f); + +/* Wrapper to calling fgets() from function called "f". The return code of + * fgets() is returned unless it is NULL *and* ferror() indicates that an error + * occured; otherwise end of file is assumed and NULL is returned properly. + */ +extern char * try_fgets(char * line, int size, FILE * file, char * f); +/* Wrapper to calling fgetc() from function "f", treating either + * (try_fgetc_noeof()) all EOF returns as errors triggering exit_trouble(), or + * (try_fgetc()) only those accompanied by a positive ferror() result. + */ +extern int try_fgetc(FILE * file, char * f); +extern uint8_t try_fgetc_noeof(FILE * file, char * f); /* Wrapper to successive call of fclose() from function called "f" on "file", - * then unlink() on file at "p2" if it exists, then rename() on "p1" to "p2". - * Used for handling atomic saving of files via temp files. + * then unlink() on file at path "p2" if it exists, then rename() from path "p1" + * to "p2". Used for handling atomic saving of files via temp files. */ extern void try_fclose_unlink_rename(FILE * file, char * p1, char * p2, - struct World * w, char * f); - - + char * f); -/* Wrapper: Call textfile_sizes() from function called "f" to get max line - * length of "file", exit via exit_err() with trouble_msg()-generated error - * message on failure. +/* Return largest line length from "file" the largest line length (including + * newline chars) and write the number of newline chars in "file" to the memory + * pointed to by "n_lines_p" if it is not passed as NULL. */ -extern uint16_t get_linemax(FILE * file, struct World * w, char * f); +extern uint16_t textfile_sizes(FILE * file, uint16_t * n_lines_p); +/* Read/write via try_(fgetc|fputc)() uint32 values with defined endianness. */ +extern uint32_t read_uint32_bigendian(FILE * file); +extern void write_uint32_bigendian(uint32_t x, FILE * file); -/* Learn from "file" the largest line length (pointed to by "linemax_p"; length - * includes newline chars) and (pointed to by "n_lines_p" if it is not set to - * NULL) the number of lines (= number of newline chars). - * - * Returns 0 on success, 1 on error of fseek() (called to return to initial file - * reading position). - */ -extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p, - uint16_t * n_lines_p); - - - -/* These routines for reading values "x" from / writing values to "file" ensure a - * defined endianness and consistent error codes: return 0 on success and 1 on - * fgetc()/fputc() failure. - */ -extern uint8_t read_uint8(FILE * file, uint8_t * x); -extern uint8_t read_uint16_bigendian(FILE * file, uint16_t * x); -extern uint8_t read_uint32_bigendian(FILE * file, uint32_t * x); -extern uint8_t write_uint8(uint8_t x, FILE * file); -extern uint8_t write_uint16_bigendian(uint16_t x, FILE * file); -extern uint8_t write_uint32_bigendian(uint32_t x, FILE * file); #endif