Send log messages through server out file. Includes major refactoring.

[plomrogue] / src / common / readwrite.h

diff --git a/src/common/readwrite.h b/src/common/readwrite.h
index eddd0e66e1875922f5bc7b15be06305080b07d73..c151f135925edb7bbfc952e8d784902d73317bae 100644 (file)
--- a/src/common/readwrite.h
+++ b/src/common/readwrite.h
@@ -1,4 +1,8 @@
 /* src/common/readwrite.h:
+ *
+ * This file is part of PlomRogue. PlomRogue is licensed under the GPL version 3
+ * or any later version. For details on its copyright, license, and warranties,
+ * see the file NOTICE in the root directory of the PlomRogue source package.
  *
  * Routines for reading and writing files.
  */
@@ -14,11 +18,11 @@
 /* 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);
+extern FILE * try_fopen(char * path, char * mode, const char * f);
+extern void try_fclose(FILE * file, const 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);
+                       const char * f);
+extern void try_fputc(uint8_t c, FILE * file, const char * f);
 
 /* Wrapper to calling fgetc() and fgets() from function "f". The return code is
  * returned unless ferror() indicates an error (i.e. to signify an end of file,
@@ -26,8 +30,11 @@ extern void try_fputc(uint8_t c, FILE * file, char * f);
  * on "file" before fgetc(), because some Unixes fgetc() remember old EOFs and
  * only return those until explicitely cleared.
  */
-extern int try_fgetc(FILE * file, char * f);
-extern char * try_fgets(char * line, int size, FILE * file, char * f);
+extern int try_fgetc(FILE * file, const char * f);
+extern char * try_fgets(char * line, int size, FILE * file, const char * f);
+
+/* Return "path" + suffix "_tmp". Value is malloc'd, must be freed externally.*/
+extern char * build_temp_path(char * path);
 
 /* Write to "path_tmp" "path" + "_tmp" and return a new file at that "path_tmp"
  * open for writing. "path_tmp" is malloc()'d, must be freed externally.
@@ -46,6 +53,21 @@ extern void detect_atomic_leftover(char * path);
 /* Return largest line length from "file" (including  newline chars). */
 extern uint32_t textfile_width(FILE * file);
 
+/* Read "file" for load of bytes to put onto "queue" of "queue_size" (growing
+ * that size). May put many \0-terminated strings on the queue at once. \n chars
+ * are replaced with \0 chars. If the queue doesn't end in \0, a \o byte is
+ * appended to it. Returns 1 if reading succeeds, 0 if nothing is read.
+ */
+extern uint8_t read_file_into_queue(FILE * file, char ** queue,
+                                    uint32_t * queue_size);
+
+/* Cut out and return first \0-terminated string from "queue" and appropriately
+ * reduce "queue_size". Return NULL if queue is empty. Superfluous \0 bytes
+ * after the string are also cut out. Should the queue start with \0 bytes,
+ * those are cut out before returning anything after them.
+ */
+extern char * get_message_from_queue(char ** queue, uint32_t * queue_size);
+
 
 
 #endif