Improved and defined more precisely textfile_sizes().

[plomrogue] / src / misc.h

diff --git a/src/misc.h b/src/misc.h
index be431979360ace92538ac339fbc53c55f4a94337..568c56d432c5d9d572fb37c4f22f2025a86ac825 100644 (file)
--- a/src/misc.h
+++ b/src/misc.h
@@ -9,7 +9,7 @@
 
 
 
-#include <stdint.h>    /* for uint16_t */
+#include <stdint.h>    /* for uint8_t, uint16_t */
 #include <stdio.h>     /* for FILE typedef */
 #include "yx_uint16.h" /* for yx_uint16 coordinates */
 struct World;
@@ -17,11 +17,15 @@ struct Map;
 
 
 
-/* Learn from "file" the largest line length (pointed to by "linemax_p") and
- * (pointed to by "n_lines_p" if it is not set to NULL) the number of lines.
+/* 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 void textfile_sizes(FILE * file, uint16_t * linemax_p,
-                           uint16_t * n_lines_p);
+extern uint8_t textfile_sizes(FILE * file, uint16_t * linemax_p,
+                              uint16_t * n_lines_p);