home · contact · privacy
On world (re-)generation, server sends 'NEW_WORLD', client clears log.
[plomrogue] / src / client / io.c
index c047f6985d3f9526cc45eb4fa845be77ad9677e2..45008155098ac03150c1ad53bf6a9ea8f503866c 100644 (file)
@@ -1,4 +1,9 @@
-/* src/client/io.c */
+/* src/client/io.c
+ *
+ * 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.
+ */
 
 #define _POSIX_C_SOURCE 1 /* PIPE_BUF */
 #include "io.h"
@@ -16,7 +21,9 @@
 #include "../common/try_malloc.h" /* try_malloc() */
 #include "../common/rexit.h" /* exit_trouble(), exit_err() */
 #include "../common/readwrite.h" /* try_fopen(), try_fclose(), try_fgets(),
-                                  * try_fgetc(), textfile_width(), try_fputc()
+                                  * try_fgetc(), textfile_width(), try_fputc(),
+                                  * read_file_into_queue(),
+                                  * get_message_from_queue(),
                                   */
 #include "control.h" /* try_key() */
 #include "map.h" /* map_center() */
  */
 static void read_inventory(char * read_buf, uint32_t linemax, FILE * file);
 
-/* Read the next characters in "file" into world.map.cells. In detail: Read
+/* Read the next characters in "file" into "map". In detail: Read
  * world.map.length times world.map.length characters, followed by one ignored
  * character (that we assume is a newline).
  */
-static void read_map_cells(FILE * file);
-
-/* Repeatedly use try_fgets() with given arguments to read the remaining lines
- * of "file" into the world.log string.
- */
-static void read_log(char * read_buf, uint32_t linemax, FILE * file);
+static void read_map_cells(FILE * file, char ** map);
 
 /* Return value seen by atoi() in next line of "file" when passed to try_fgets()
  * with the given arguments.
@@ -47,7 +49,7 @@ static void read_log(char * read_buf, uint32_t linemax, FILE * file);
 static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
                                      FILE * file);
 
-/* If the server's worldstate file has changed since the last read_world(),
+/* If the server's worldstate file has changed since the last read_worldstate(),
  * return a pointer to its file descriptor; else, return NULL.
  *
  * Two tests are performed to check for a file change. The file's last data
@@ -64,50 +66,47 @@ static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
 static FILE * changed_worldstate_file(char * path);
 
 /* Attempt to read the server's worldstate file as representation of the game
- * world in a hard-coded serialization format. Returns 1 on success and 0 if the
+ * world in a hard-coded serialization format. Returns 1 on success, or 0 if the
  * out file wasn't read for supposedly not having changed since a last
- * read_world() call.
+ * read_worldstate() call.
  *
- * map_center() is triggered by either, the first successful read_world() (thus
- * on client start), or on turn 1 (thus on world start).
+ * map_center() is triggered by either, the first successful read_worldstate()
+ * (thus on client start), or on turn 1 (thus on world start).
  */
-static uint8_t read_world();
+static uint8_t read_worldstate();
 
-/* If "last_server_answer_time" is too old, send a PING to the server; or, if a
- * previous PING has not sparked any answer after a while, abort the client.
+/* Poll server for queue input. If no new input, send ping, or, if ping already
+ * sent but unanswered for some time, abort.
  */
-static void test_ping_pong(time_t last_server_answer_time);
+static void test_and_poll_server();
 
-/* Update "last_server_answer_time" if new stuff has been written to the
- * server's out file.
- */
-static void test_server_activity(time_t * last_server_answer_time);
+/* Read messages from queue, act on them. */
+static uint8_t read_queue();
 
 
 
 static void read_inventory(char * read_buf, uint32_t linemax, FILE * file)
 {
-    char * f_name = "read_inventory()";
     char * delimiter = "%\n";
     free(world.player_inventory);
     world.player_inventory = NULL;          /* Avoids illegal strlen() below. */
     while (1)
     {
-        try_fgets(read_buf, linemax + 1, file, f_name);
+        try_fgets(read_buf, linemax + 1, file, __func__);
         if (!(strcmp(read_buf, delimiter)))
         {
             break;
         }
         int old_size = 0;
-        if (NULL != world.player_inventory)
+        if (world.player_inventory)
         {
             old_size = strlen(world.player_inventory);
         }
         int new_size = strlen(read_buf);
-        char * new_inventory = try_malloc(old_size + new_size + 1, f_name);
+        char * new_inventory = try_malloc(old_size + new_size + 1, __func__);
         memcpy(new_inventory, world.player_inventory, old_size);
         int test = sprintf(new_inventory + old_size, "%s", read_buf);
-        exit_trouble(test < 0, f_name, "sprintf()");
+        exit_trouble(test < 0, __func__, "sprintf");
         free(world.player_inventory);
         world.player_inventory = new_inventory;
     }
@@ -117,44 +116,24 @@ static void read_inventory(char * read_buf, uint32_t linemax, FILE * file)
 
 
 
-static void read_map_cells(FILE * file)
+static void read_map_cells(FILE * file, char ** map)
 {
-    char * f_name = "read_map_cells()";
-    free(world.map.cells);
-    world.map.cells = try_malloc(world.map.length * world.map.length, f_name);
+    if (*map)
+    {
+        free(*map);
+        *map = NULL;
+    }
+    *map = try_malloc(world.map.length * world.map.length, __func__);
+    char * map_cells = *map;
     uint16_t y, x;
     for (y = 0; y < world.map.length; y++)
     {
         for (x = 0; x < world.map.length; x++)
         {
-            char c = try_fgetc(file, f_name);
-            world.map.cells[(y * world.map.length) + x] = c;
+            char c = try_fgetc(file, __func__);
+            map_cells[y * world.map.length + x] = c;
         }
-        try_fgetc(file, f_name);
-    }
-}
-
-
-
-static void read_log(char * read_buf, uint32_t linemax, FILE * file)
-{
-    char * f_name = "read_log()";
-    free(world.log);
-    world.log = NULL;
-    while (try_fgets(read_buf, linemax + 1, file, f_name))
-    {
-        int old_size = 0;
-        if (NULL != world.log)
-        {
-            old_size = strlen(world.log);
-        }
-        int new_size = strlen(read_buf);
-        char * new_log = try_malloc(old_size + new_size + 1, f_name);
-        memcpy(new_log, world.log, old_size);
-        int test = sprintf(new_log + old_size, "%s", read_buf);
-        exit_trouble(test < 0, f_name, "sprintf()");
-        free(world.log);
-        world.log = new_log;
+        try_fgetc(file, __func__);
     }
 }
 
@@ -163,8 +142,7 @@ static void read_log(char * read_buf, uint32_t linemax, FILE * file)
 static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
                                      FILE * file)
 {
-    char * f_name = "read_value_from_line()";
-    try_fgets(read_buf, linemax + 1, file, f_name);
+    try_fgets(read_buf, linemax + 1, file, __func__);
     return atoi(read_buf);
 }
 
@@ -172,31 +150,29 @@ static uint16_t read_value_from_line(char * read_buf, uint32_t linemax,
 
 static FILE * changed_worldstate_file(char * path)
 {
-    char * f_name = "changed_worldstate_file()";
     struct stat stat_buf;
-    exit_trouble(stat(path, &stat_buf), f_name, "stat()");
+    exit_trouble(stat(path, &stat_buf), __func__, "stat");
     if (stat_buf.st_mtime != world.last_update)
     {
         world.last_update = stat_buf.st_mtime;
-        return try_fopen(path, "r", f_name);
+        return try_fopen(path, "r", __func__);
     }
-    FILE * file = try_fopen(path, "r", f_name);
+    FILE * file = try_fopen(path, "r", __func__);
     char turn_string[6];
-    try_fgets(turn_string, 6, file, f_name);
+    try_fgets(turn_string, 6, file, __func__);
     if (world.turn == atoi(turn_string))
     {
-        try_fclose(file, f_name);
+        try_fclose(file, __func__);
         return NULL;
     }
-    exit_trouble(fseek(file, 0, SEEK_SET), f_name, "fseek()");
+    exit_trouble(fseek(file, 0, SEEK_SET), __func__, "fseek");
     return file;
 }
 
 
 
-static uint8_t read_world()
+static uint8_t read_worldstate()
 {
-    char * f_name = "read_world()";
     char * path = "server/worldstate";
     char * quit_msg = "No worldstate file found to read. Server may be down.";
     static uint8_t first_read = 1;
@@ -207,7 +183,7 @@ static uint8_t read_world()
         return 0;
     }
     uint32_t linemax = textfile_width(file);
-    char * read_buf = try_malloc(linemax + 1, f_name);
+    char * read_buf = try_malloc(linemax + 1, __func__);
     world.turn = read_value_from_line(read_buf, linemax, file);
     world.player_lifepoints = read_value_from_line(read_buf, linemax, file);
     read_inventory(read_buf, linemax, file);
@@ -219,22 +195,29 @@ static uint8_t read_world()
         first_read = 0;
     }
     world.map.length = read_value_from_line(read_buf, linemax, file);
-    read_map_cells(file);
-    read_log(read_buf, linemax, file);
+    read_map_cells(file, &world.map.cells);
+    read_map_cells(file, &world.mem_map);
     free(read_buf);
-    try_fclose(file, f_name);
+    try_fclose(file, __func__);
     return 1;
 }
 
 
 
-static void test_ping_pong(time_t last_server_answer_time)
+static void test_and_poll_server()
 {
+    static time_t last_server_answer_time = 0;
     static uint8_t ping_sent = 0;
-    time_t now = time(0);
-    if (ping_sent && last_server_answer_time > now - 3)
+    if (read_file_into_queue(world.file_server_out, &world.queue))
     {
-        ping_sent = 0;
+        last_server_answer_time = time(0);
+        return;
+    }
+    time_t now = time(0);
+    if (ping_sent && last_server_answer_time > now - 3)  /* Re-set if last    */
+    {                                                    /* ping was answered */
+        ping_sent = 0;                                   /* with server       */
+        return;                                          /* activity.         */
     }
     if (!ping_sent && last_server_answer_time < now - 3)
     {
@@ -247,32 +230,51 @@ static void test_ping_pong(time_t last_server_answer_time)
 
 
 
-static void test_server_activity(time_t * last_server_answer_time)
+static uint8_t read_queue()
 {
-    char * f_name = "test_server_activity()";
-    int test = try_fgetc(world.file_server_out, f_name);
-    if (EOF == test)
+    uint8_t ret = 0;
+    char * msg;
+    while (NULL != (msg = get_message_from_queue(&world.queue)))
     {
-        return;
-    }
-    do
-    {
-        ;
+        char * log_prefix = "LOG ";
+        char * new_world = "NEW_WORLD";
+        if (!strcmp(msg, new_world))
+        {
+            ret = 1;
+            free(world.log);
+            world.log = NULL;
+        }
+        else if (!strncmp(msg, log_prefix, strlen(log_prefix)))
+        {
+            ret = 1;
+            char * log_msg = msg + strlen(log_prefix);
+            int old_size = 0;
+            if (world.log)
+            {
+                old_size = strlen(world.log);
+            }
+            int new_size = strlen(log_msg);
+            char * new_log = try_malloc(old_size + 1 + new_size + 1, __func__);
+            memcpy(new_log, world.log, old_size);
+            int test = sprintf(new_log + old_size, "\n%s", log_msg);
+            exit_trouble(test < 0, __func__, "sprintf");
+            free(world.log);
+            world.log = new_log;
+        }
+        free(msg);
     }
-    while (EOF != (test = try_fgetc(world.file_server_out, f_name)));
-    * last_server_answer_time = time(0);
+    return ret;
 }
 
 
 
 extern void send(char * msg)
 {
-    char * f_name = "send()";
     uint32_t msg_size = strlen(msg) + 1;
-    char * err = "send() tries to send message larger than PIPE_BUF bytes.";
+    char * err = "send() tried to send message larger than PIPE_BUF bytes.";
     exit_err(msg_size > PIPE_BUF, err);
-    try_fwrite(msg, strlen(msg), 1, world.file_server_in, f_name);
-    try_fputc('\n', world.file_server_in, f_name);
+    try_fwrite(msg, strlen(msg), 1, world.file_server_in, __func__);
+    try_fputc('\n', world.file_server_in, __func__);
     fflush(world.file_server_in);
 }
 
@@ -280,22 +282,20 @@ extern void send(char * msg)
 
 extern char * io_loop()
 {
-    world.halfdelay = 1;            /* Ensures read_world() is only called 10 */
-    halfdelay(world.halfdelay);     /* times a second during user inactivity. */
+    world.halfdelay = 1;             /* Ensure server is polled only 10 times */
+    halfdelay(world.halfdelay);      /* a second during user inactivity.      */
     uint8_t change_in_client = 0;
     uint16_t last_focused_turn = world.turn;
-    time_t last_server_answer_time = time(0);
     while (1)
     {
-        test_server_activity(&last_server_answer_time);
-        test_ping_pong(last_server_answer_time);
+        test_and_poll_server();
         if (world.winch)
         {
             reset_windows_on_winch();
             world.winch = 0;
             change_in_client++;
         }
-        if (change_in_client || read_world())
+        if (change_in_client || read_worldstate() || read_queue())
         {
             if (world.turn != last_focused_turn && world.focus_each_turn)
             {