Use init and clear for GMutex and GCond
[projects/chimara/chimara.git] / libchimara / abort.c
index 61234a06f5743747687e6fbf397763dae528598c..26eb8c4d1c136a4c122ffb0ebaad2e738fe5b5bb 100644 (file)
+#include "abort.h"
 #include "event.h"
 #include <glib.h>
 #include <gtk/gtk.h>
 
 #include "chimara-glk-private.h"
+#include "window.h"
 
-extern ChimaraGlkPrivate *glk_data;
+extern GPrivate *glk_data_key;
 
 /**
  * glk_set_interrupt_handler:
  * @func: A pointer to an interrupt handler function.
  *
- * Sets @func to be the interrupt handler. @func should be a pointer to a 
+ * Sets @func to be the interrupt handler. @func should be a pointer to a
  * function which takes no argument and returns no result. If Glk receives an
- * interrupt, and you have set an interrupt handler, your handler will be 
+ * interrupt, and you have set an interrupt handler, your handler will be
  * called, before the process is shut down.
- * 
+ *
  * Initially there is no interrupt handler. You can reset to not having any by
  * calling <code>#glk_set_interrupt_handler(%NULL)</code>.
- * 
+ *
  * If you call glk_set_interrupt_handler() with a new handler function while an
  * older one is set, the new one replaces the old one. Glk does not try to queue
  * interrupt handlers.
  *
  * You should not try to interact with the player in your interrupt handler. Do
  * not call glk_select() or glk_select_poll(). Anything you print to a window
- * may not be visible to the player. 
+ * may not be visible to the player.
  */
 void
 glk_set_interrupt_handler(void (*func)(void))
 {
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
        glk_data->interrupt_handler = func;
 }
 
 /* Internal function: abort this Glk program, freeing resources and calling the
 user's interrupt handler. */
 static void
-abort_glk()
+abort_glk(void)
 {
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
        if(glk_data->interrupt_handler)
                (*(glk_data->interrupt_handler))();
-       g_signal_emit_by_name(glk_data->self, "stopped");
+       shutdown_glk_pre();
+       shutdown_glk_post();
+       /* If program is terminated by g_thread_exit() instead of returning from the
+        glk_main() function, then the line in glk_exit() where the "stopped" 
+        signal is emitted will not be reached. So we have to emit it here. */
+       if(!glk_data->in_startup)
+               g_signal_emit_by_name(glk_data->self, "stopped");
        g_thread_exit(NULL);
 }
 
-/* Internal function: Signal this Glk thread to abort. Does nothing if the abort
-mutex has already been freed. (That means the thread already ended.) */
+/* Internal function: check if the Glk program has been interrupted. */
 void
-signal_abort()
+check_for_abort(void)
 {
-       if(glk_data && glk_data->abort_lock) {
-               g_mutex_lock(glk_data->abort_lock);
-               glk_data->abort_signalled = TRUE;
-               g_mutex_unlock(glk_data->abort_lock);
-               /* Stop blocking on the event queue condition */
-               event_throw(evtype_Abort, NULL, 0, 0);
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       g_mutex_lock(&glk_data->abort_lock);
+       if(glk_data->abort_signalled)
+       {
+               g_mutex_unlock(&glk_data->abort_lock);
+               abort_glk();
        }
+       g_mutex_unlock(&glk_data->abort_lock);
 }
 
-/* Internal function: check if the Glk program has been interrupted. */
+/* Internal function: shut down all requests and anything not necessary while
+ showing the last displayed configuration of windows. */
 void
-check_for_abort()
+shutdown_glk_pre(void)
 {
-       g_mutex_lock(glk_data->abort_lock);
-       if(glk_data->abort_signalled) 
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       
+       /* Stop any timers */
+       glk_request_timer_events(0);
+       
+       /* Cancel any pending input requests and flush all window buffers */
+       winid_t win;
+       for(win = glk_window_iterate(NULL, NULL); win; win = glk_window_iterate(win, NULL))
        {
-               g_mutex_unlock(glk_data->abort_lock);
-               abort_glk();
+               switch(win->input_request_type)
+               {
+                       case INPUT_REQUEST_CHARACTER:
+                       case INPUT_REQUEST_CHARACTER_UNICODE:
+                               glk_cancel_char_event(win);
+                               break;
+                       case INPUT_REQUEST_LINE:
+                       case INPUT_REQUEST_LINE_UNICODE:
+                               glk_cancel_line_event(win, NULL);
+                               break;
+                       case INPUT_REQUEST_NONE:
+                       default:
+                               ; /* TODO: Handle mouse and hyperlink requests */
+               }
+               
+               flush_window_buffer(win);
        }
-       g_mutex_unlock(glk_data->abort_lock);
+       
+       /* Close any open resource files */
+       if(glk_data->resource_map != NULL) {
+               giblorb_destroy_map(glk_data->resource_map);
+               glk_data->resource_map = NULL;
+               glk_stream_close(glk_data->resource_file, NULL);
+       }
+       
+       /* Empty the input queues */
+       while(g_async_queue_try_pop(glk_data->char_input_queue))
+               ;
+       while(g_async_queue_try_pop(glk_data->line_input_queue))
+               ;
+       
+       /* Wait for any pending window rearrange */
+       g_mutex_lock(&glk_data->arrange_lock);
+       if(glk_data->needs_rearrange)
+               g_cond_wait(&glk_data->rearranged, &glk_data->arrange_lock);
+       g_mutex_unlock(&glk_data->arrange_lock);
+}
+
+/* Internal function: do any Glk-thread cleanup for shutting down the Glk library. */
+void
+shutdown_glk_post(void)
+{
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       
+       /* Free all opaque objects; can't iterate normally, because the objects are
+        being removed from the global iteration lists */
+       if(glk_data->root_window)
+               glk_window_close(glk_data->root_window->data, NULL);
+       g_assert(glk_data->root_window == NULL);
+       strid_t str;
+       while( (str = glk_stream_iterate(NULL, NULL)) )
+               glk_stream_close(str, NULL);
+       frefid_t fref;
+       while( (fref = glk_fileref_iterate(NULL, NULL)) )
+               glk_fileref_destroy(fref);
+       schanid_t sch;
+       while( (sch = glk_schannel_iterate(NULL, NULL)) )
+               glk_schannel_destroy(sch);
+       
+       /* Empty the event queue */
+       g_mutex_lock(&glk_data->event_lock);
+       g_queue_foreach(glk_data->event_queue, (GFunc)g_free, NULL);
+
+       /* COMPAT: g_queue_clear could be used here, but only appeared in 2.14 */
+       // g_queue_clear(glk_data->event_queue);
+       g_list_free(glk_data->event_queue->head);
+       glk_data->event_queue->head = glk_data->event_queue->tail = NULL;
+       glk_data->event_queue->length = 0;
+
+       g_mutex_unlock(&glk_data->event_lock);
+
+       /* Reset the abort signaling mechanism */
+       g_mutex_lock(&glk_data->abort_lock);
+       glk_data->abort_signalled = FALSE;
+       g_mutex_unlock(&glk_data->abort_lock);
+
+       /* Reset arrangement mechanism */
+       g_mutex_lock(&glk_data->arrange_lock);
+       glk_data->needs_rearrange = FALSE;
+       glk_data->ignore_next_arrange_event = FALSE;
+       g_mutex_unlock(&glk_data->arrange_lock);
+
+       /* Unref input queues (they are not destroyed because the main thread stil holds a ref */
+       g_async_queue_unref(glk_data->char_input_queue);
+       g_async_queue_unref(glk_data->line_input_queue);
+
+       /* Reset other stuff */
+       glk_data->interrupt_handler = NULL;
+       g_free(glk_data->current_dir);
+       glk_data->current_dir = NULL;
+       /* Remove the dispatch callbacks */
+       glk_data->register_obj = NULL;
+       glk_data->unregister_obj = NULL;
+       glk_data->register_arr = NULL;
+       glk_data->unregister_arr = NULL;
 }