Simplified textfile_sizes() and replaced all get_linemax() calls with it.

[plomrogue] / src / readwrite.h

diff --git a/src/readwrite.h b/src/readwrite.h
index 2e0ca9f47e858a57241c9b4595dffffadd8fe661..0dc47da9eb4a7ee404bf48892e49868d76475caf 100644 (file)
--- a/src/readwrite.h
+++ b/src/readwrite.h
@@ -11,8 +11,8 @@
 
 
 
-/* Wrappers to calling from function called "f" of fopen(), fclose(), fgets()
- * and fwrite() 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, char * f);
 extern void try_fclose(FILE * file, char * f);
@@ -26,34 +26,25 @@ extern void try_fputc(uint8_t c, FILE * file, char * f);
  */
 extern char * try_fgets(char * line, int size, FILE * file, char * f);
 
-/* Wrappers to calling fgetc() and (try_fgetc_noeof()) treating all EOFs returns
- * as errors to call exit_trouble(), or (try_fgetc()) only if ferror() says so.
+/* 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,
                                      char * f);
 
-/* Wrapper: Call textfile_sizes() from function called "f" to get max line
- * length (includes newline char) of "file", exit via exit_err() with
- * exit_trouble() 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, char * f);
-
-/* 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);
+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);