Use init and clear for GMutex and GCond
[projects/chimara/chimara.git] / libchimara / graphics.c
index 21fcd09067937b6820d33069877f6d798758033b..f83ec0eb2001df91878fc52d5d9da7c1377fb6a0 100644 (file)
@@ -13,21 +13,12 @@ static gboolean image_loaded;
 static gboolean size_determined;
 
 static struct image_info*
-load_image_in_cache(glui32 image, gint width, gint height)
+load_image_from_blorb(giblorb_result_t resource, glui32 image, gint width, gint height)
 {
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
-       giblorb_err_t blorb_error = 0;
-       giblorb_result_t resource;
        GError *pixbuf_error = NULL;
        guchar *buffer;
 
-       /* Lookup the proper resource */
-       blorb_error = giblorb_load_resource(glk_data->resource_map, giblorb_method_FilePos, &resource, giblorb_ID_Pict, image);
-       if(blorb_error != giblorb_err_None) {
-               WARNING_S( "Error loading resource", giblorb_get_error_message(blorb_error) );
-               return NULL;
-       }
-
        struct image_info *info = g_new0(struct image_info, 1);
        info->resource_number = image;
 
@@ -65,30 +56,90 @@ load_image_in_cache(glui32 image, gint width, gint height)
        g_free(buffer);
 
        /* Wait for the PixbufLoader to finish loading the image */
-       g_mutex_lock(glk_data->resource_lock);
+       g_mutex_lock(&glk_data->resource_lock);
        while(!image_loaded) {
-               g_cond_wait(glk_data->resource_loaded, glk_data->resource_lock);
+               g_cond_wait(&glk_data->resource_loaded, &glk_data->resource_lock);
+       }
+       g_mutex_unlock(&glk_data->resource_lock);
+
+       info->pixbuf = gdk_pixbuf_loader_get_pixbuf(loader);
+       g_object_ref(info->pixbuf);
+
+       g_object_unref(loader);
+       return info;
+}
+
+static struct image_info *
+load_image_from_file(const gchar *filename, glui32 image, gint width, gint height)
+{
+       GError *err = NULL;
+       
+       struct image_info *info = g_new0(struct image_info, 1);
+       info->resource_number = image;
+       
+       if(width > 0 && height > 0) {
+               info->scaled = TRUE;
+               info->pixbuf = gdk_pixbuf_new_from_file_at_size(filename, width, height, &err);
+       } else {
+               info->pixbuf = gdk_pixbuf_new_from_file(filename, &err);
+       }
+       if(!info->pixbuf) {
+               IO_WARNING("Error loading resource from alternative location", filename, err->message);
+               g_error_free(err);
+               g_free(info);
+               return NULL;
        }
-       g_mutex_unlock(glk_data->resource_lock);
+       g_object_ref(info->pixbuf);
+
+       return info;
+}
+
+static struct image_info*
+load_image_in_cache(glui32 image, gint width, gint height)
+{
+       ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
+       struct image_info *info = NULL;
+       
+       /* Lookup the proper resource */
+       if(!glk_data->resource_map) {
+               if(!glk_data->resource_load_callback) {
+                       WARNING("No resource map has been loaded yet.");
+                       return NULL;
+               }
+               gchar *filename = glk_data->resource_load_callback(CHIMARA_RESOURCE_IMAGE, image, glk_data->resource_load_callback_data);
+               if(!filename) {
+                       WARNING("Error loading resource from alternative location");
+                       return NULL;
+               }
+               info = load_image_from_file(filename, image, width, height);
+               g_free(filename);
+       } else {
+               giblorb_result_t resource;
+               giblorb_err_t blorb_error = giblorb_load_resource(glk_data->resource_map, giblorb_method_FilePos, &resource, giblorb_ID_Pict, image);
+               if(blorb_error != giblorb_err_None) {
+                       WARNING_S( "Error loading resource", giblorb_get_error_message(blorb_error) );
+                       return NULL;
+               }
+               info = load_image_from_blorb(resource, image, width, height);
+       }
+
+       if(info == NULL)
+               return NULL;
 
        /* Store the image in the cache */
        gdk_threads_enter();
 
        if( g_slist_length(glk_data->image_cache) >= IMAGE_CACHE_MAX_NUM ) {
                struct image_info *head = (struct image_info*) glk_data->image_cache->data;
-               gdk_pixbuf_unref(head->pixbuf);
+               g_object_unref(head->pixbuf);
                g_free(head);
                glk_data->image_cache = g_slist_remove_link(glk_data->image_cache, glk_data->image_cache);
        }
-       info->pixbuf = gdk_pixbuf_loader_get_pixbuf(loader);
-       gdk_pixbuf_ref(info->pixbuf);
        info->width = gdk_pixbuf_get_width(info->pixbuf);
        info->height = gdk_pixbuf_get_height(info->pixbuf);
        glk_data->image_cache = g_slist_prepend(glk_data->image_cache, info);
 
        gdk_threads_leave();
-
-       g_object_unref(loader);
        return info;
 }
 
@@ -97,12 +148,12 @@ on_size_prepared(GdkPixbufLoader *loader, gint width, gint height, struct image_
 {
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 
-       g_mutex_lock(glk_data->resource_lock);
+       g_mutex_lock(&glk_data->resource_lock);
        info->width = width;
        info->height = height;
        size_determined = TRUE;
-       g_cond_broadcast(glk_data->resource_info_available);
-       g_mutex_unlock(glk_data->resource_lock);
+       g_cond_broadcast(&glk_data->resource_info_available);
+       g_mutex_unlock(&glk_data->resource_lock);
 }
 
 void
@@ -112,10 +163,10 @@ on_pixbuf_closed(GdkPixbufLoader *loader, gpointer data)
 
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
 
-       g_mutex_lock(glk_data->resource_lock);
+       g_mutex_lock(&glk_data->resource_lock);
        image_loaded = TRUE;
-       g_cond_broadcast(glk_data->resource_loaded);
-       g_mutex_unlock(glk_data->resource_lock);
+       g_cond_broadcast(&glk_data->resource_loaded);
+       g_mutex_unlock(&glk_data->resource_lock);
 
        gdk_threads_leave();
 }
@@ -124,7 +175,7 @@ on_pixbuf_closed(GdkPixbufLoader *loader, gpointer data)
 void
 clear_image_cache(struct image_info *data, gpointer user_data)
 {
-       gdk_pixbuf_unref(data->pixbuf);
+       g_object_unref(data->pixbuf);
        g_free(data);
 }
 
@@ -139,7 +190,6 @@ image_cache_find(struct image_info* to_find)
        /* Empty cache */
        if(link == NULL) {
                gdk_threads_leave();
-               printf("Cache miss for image %d\n", to_find->resource_number);
                return NULL;
        }
 
@@ -154,7 +204,6 @@ image_cache_find(struct image_info* to_find)
                                if(info->width == to_find->width && info->height == to_find->height) {
                                        /* Prescaled image found */
                                        gdk_threads_leave();
-                                       printf("Exact cache hit for image %d\n", to_find->resource_number);
                                        return info;
                                }
                                else if(info->width >= to_find->width && info->height >= to_find->height) {
@@ -165,7 +214,6 @@ image_cache_find(struct image_info* to_find)
                        } else {
                                if(!info->scaled) {
                                        gdk_threads_leave();
-                                       printf("Exact cache hit for image %d\n", to_find->resource_number);
                                        return info; /* Found a match */
                                }
                        }
@@ -174,11 +222,6 @@ image_cache_find(struct image_info* to_find)
 
        gdk_threads_leave();
 
-       if(match == NULL)
-               printf("Cache miss for image %d\n", to_find->resource_number);
-       else
-               printf("Approx cache hit for image %d\n", to_find->resource_number);
-
        return match;
 }
 
@@ -189,11 +232,11 @@ image_cache_find(struct image_info* to_find)
  * @height: Pointer to a location at which to store the image's height.
  *
  * This gets information about the image resource with the given identifier. It
- * returns %TRUE if there is such an image, and %FALSE if not. You can also pass
- * pointers to width and height variables; if the image exists, the variables
- * will be filled in with the width and height of the image, in pixels. (You can
- * pass %NULL for either width or height if you don't care about that 
- * information.)
+ * returns %TRUE (1) if there is such an image, and %FALSE (0) if not. You can
+ * also pass pointers to width and height variables; if the image exists, the
+ * variables will be filled in with the width and height of the image, in
+ * pixels. (You can pass %NULL for either width or height if you don't care
+ * about that information.)
  * 
  * <note><para>
  *   You should always use this function to measure the size of images when you 
@@ -224,7 +267,7 @@ glk_image_get_info(glui32 image, glui32 *width, glui32 *height)
 
        if(width != NULL)
                *width = found->width;
-       if(width != NULL)
+       if(height != NULL)
                *height = found->height;
        return TRUE;
 }
@@ -343,38 +386,39 @@ glk_image_draw_scaled(winid_t win, glui32 image, glsi32 val1, glsi32 val2, glui3
        return draw_image_common(win, info->pixbuf, val1, val2);
 }
 
-/* Internal function: draws a pixbuf to a graphics window of text buffer */
+/* Internal function: draws a pixbuf to a graphics window or text buffer */
 glui32
 draw_image_common(winid_t win, GdkPixbuf *pixbuf, glsi32 val1, glsi32 val2)
 {
-       GdkPixmap *canvas;
-       gdk_threads_enter();
-
        switch(win->type) {
        case wintype_Graphics:
        {
-               gtk_image_get_pixmap( GTK_IMAGE(win->widget), &canvas, NULL );
-               if(canvas == NULL) {
-                       WARNING("Could not get pixmap");
-                       return FALSE;
-               }
+               gdk_threads_enter();
 
-               gdk_draw_pixbuf( GDK_DRAWABLE(canvas), NULL, pixbuf, 0, 0, val1, val2, -1, -1, GDK_RGB_DITHER_NONE, 0, 0 );
+               cairo_t *cr = cairo_create(win->backing_store);
+               gdk_cairo_set_source_pixbuf(cr, pixbuf, val1, val2);
+               cairo_paint(cr);
+               cairo_destroy(cr);
 
                /* Update the screen */
                gtk_widget_queue_draw(win->widget);
+
+               gdk_threads_leave();
        }
                break;
 
        case wintype_TextBuffer:
        {
+               flush_window_buffer(win);
+
+               gdk_threads_enter();
+
                GtkTextBuffer *buffer = gtk_text_view_get_buffer( GTK_TEXT_VIEW(win->widget) );
                GtkTextIter end, start;
                gtk_text_buffer_get_end_iter(buffer, &end);
-               start = end;
 
-               flush_window_buffer(win);
                gtk_text_buffer_insert_pixbuf(buffer, &end, pixbuf);
+               start = end;
                gtk_text_iter_forward_char(&end);
 
                gint height = 0;
@@ -394,12 +438,11 @@ draw_image_common(winid_t win, GdkPixbuf *pixbuf, glsi32 val1, glsi32 val2)
                        GtkTextTag *tag = gtk_text_buffer_create_tag(buffer, NULL, "rise", PANGO_SCALE * (-height), NULL);
                        gtk_text_buffer_apply_tag(buffer, tag, &start, &end);
                }
+
+               gdk_threads_leave();
        }
                break;
-
        }
-
-       gdk_threads_leave();
        return TRUE;
 }
 
@@ -423,7 +466,7 @@ draw_image_common(winid_t win, GdkPixbuf *pixbuf, glsi32 val1, glsi32 val2)
  * <note><para>
  *   This function may only be used with graphics windows. To set background 
  *   colors in a text window, use text styles with color hints; see <link 
- *   linkend="Styles">Styles</link>.
+ *   linkend="chimara-Styles">Styles</link>.
  * </para></note>
  */
 void
@@ -435,6 +478,16 @@ glk_window_set_background_color(winid_t win, glui32 color)
        win->background_color = color;
 }
 
+static void
+glkcairo_set_source_glkcolor(cairo_t *cr, glui32 val)
+{
+       double r, g, b;
+       r = ((val & 0xff0000) >> 16) / 256.0;
+       g = ((val & 0x00ff00) >> 8) / 256.0;
+       b = (val & 0x0000ff) / 256.0;
+       cairo_set_source_rgb(cr, r, g, b);
+}
+
 /**
  * glk_window_fill_rect:
  * @win: A graphics window.
@@ -454,17 +507,14 @@ glk_window_fill_rect(winid_t win, glui32 color, glsi32 left, glsi32 top, glui32
        VALID_WINDOW(win, return);
        g_return_if_fail(win->type == wintype_Graphics);
 
-
        gdk_threads_enter();
 
-       GdkPixmap *map;
-       gtk_image_get_pixmap( GTK_IMAGE(win->widget), &map, NULL );
-
-       GdkGC *gc = gdk_gc_new(map);
-       gdk_gc_set_foreground( gc, glkcolor_to_gdkcolor(color) );
-       gdk_draw_rectangle( GDK_DRAWABLE(map), gc, TRUE, left, top, width, height);
+       cairo_t *cr = cairo_create(win->backing_store);
+       glkcairo_set_source_glkcolor(cr, color);
+       cairo_rectangle(cr, (double)left, (double)top, (double)width, (double)height);
+       cairo_fill(cr);
        gtk_widget_queue_draw(win->widget);
-       g_object_unref(gc);
+       cairo_destroy(cr);
 
        gdk_threads_leave();
 }
@@ -488,41 +538,96 @@ glk_window_erase_rect(winid_t win, glsi32 left, glsi32 top, glui32 width, glui32
        glk_window_fill_rect(win, win->background_color, left, top, width, height);
 }
 
+/**
+ * glk_window_flow_break:
+ * @win: A window.
+ *
+ * You may wish to <quote>break</quote> the stream of text down below the 
+ * current margin image. Since lines of text can be in any font and size, you 
+ * cannot do this by counting newlines. Instead, use this function.
+ *
+ * If the current point in the text is indented around a margin-aligned image, 
+ * this acts like the correct number of newlines to start a new line below the 
+ * image. (If there are several margin-aligned images, it goes below all of 
+ * them.) If the current point is not beside a margin-aligned image, this call 
+ * has no effect.
+ *
+ * When a text buffer window is resized, a flow-break behaves cleverly; it may 
+ * become active or inactive as necessary. You can consider this function to 
+ * insert an invisible mark in the text stream. The mark works out how many 
+ * newlines it needs to be whenever the text is formatted for display.
+ * 
+ * An example of the use of glk_window_flow_break(): If you display a 
+ * left-margin image at the start of every line, they can stack up in a strange 
+ * diagonal way that eventually squeezes all the text off the screen. 
+ * <note><para>
+ *   If you can't picture this, draw some diagrams. Make the margin images more 
+ *   than one line tall, so that each line starts already indented around the 
+ *   last image.
+ * </para></note>
+ * To avoid this problem, call glk_window_flow_break() immediately before 
+ * glk_image_draw() for every margin-aligned image.
+ * 
+ * In all windows other than text buffers, glk_window_flow_break() has no 
+ * effect. 
+ *
+ * <warning><para>
+ *   This function is not implemented yet.
+ * </para></warning>
+ */
 void glk_window_flow_break(winid_t win)
 {
+       VALID_WINDOW(win, return);
 }
 
-/*** Called when the graphics window is resized. Resize the backing pixmap if necessary ***/
-void
-on_graphics_size_allocate(GtkWidget *widget, GtkAllocation *allocation, winid_t win)
-{ 
-       GdkPixmap *oldmap;
-       gtk_image_get_pixmap( GTK_IMAGE(widget), &oldmap, NULL );
-       gint oldwidth = 0;
-       gint oldheight = 0;
-       /* Determine whether a pixmap exists with the correct size */
+/* Called when the graphics window is resized, restacked, or moved. Resize the
+backing store if necessary. */
+gboolean
+on_graphics_configure(GtkWidget *widget, GdkEventConfigure *event, winid_t win)
+{
+       int oldwidth = 0, oldheight = 0;
+
+       /* Determine whether the backing store can stay the same size */
        gboolean needs_resize = FALSE;
-       if(oldmap == NULL)
+       if(win->backing_store == NULL)
                needs_resize = TRUE;
        else {
-               gdk_drawable_get_size( GDK_DRAWABLE(oldmap), &oldwidth, &oldheight );
-               if(oldwidth != allocation->width || oldheight != allocation->height)
+               oldwidth = cairo_image_surface_get_width(win->backing_store);
+               oldheight = cairo_image_surface_get_height(win->backing_store);
+               if(oldwidth != event->width || oldheight != event->height)
                        needs_resize = TRUE;
        }
 
        if(needs_resize) {
-               /* Create a new pixmap */
-               GdkPixmap *newmap = gdk_pixmap_new(widget->window, allocation->width, allocation->height, -1);
-               gdk_draw_rectangle( GDK_DRAWABLE(newmap), widget->style->white_gc, TRUE, 0, 0, allocation->width, allocation->height);
-
-               /* Copy the contents of the old pixmap */
-               if(oldmap != NULL)
-                       gdk_draw_drawable( GDK_DRAWABLE(newmap), widget->style->white_gc, GDK_DRAWABLE(oldmap), 0, 0, 0, 0, oldwidth, oldheight);
-               
-               /* Use the new pixmap */
-               gtk_image_set_from_pixmap( GTK_IMAGE(widget), newmap, NULL );
-               g_object_unref(newmap);
+               /* Create a new backing store */
+               cairo_surface_t *new_backing_store = gdk_window_create_similar_surface( gtk_widget_get_window(widget), CAIRO_CONTENT_COLOR, gtk_widget_get_allocated_width(widget), gtk_widget_get_allocated_height(widget) );
+               cairo_t *cr = cairo_create(new_backing_store);
+
+               /* Clear to background color */
+               glkcairo_set_source_glkcolor(cr, win->background_color);
+               cairo_paint(cr);
+
+               if(win->backing_store != NULL) {
+                       /* Copy the contents of the old backing store */
+                       cairo_set_source_surface(cr, win->backing_store, 0, 0);
+                       cairo_paint(cr);
+                       cairo_surface_destroy(win->backing_store);
+               }
+
+               cairo_destroy(cr);
+               /* Use the new backing store */
+               win->backing_store = new_backing_store;
        }
+
+       return TRUE; /* Event handled, stop processing */
 }
 
+/* Draw the backing store to the screen. Called whenever the drawing area is
+exposed. */
+gboolean
+on_graphics_draw(GtkWidget *widget, cairo_t *cr, winid_t win)
+{
+       cairo_set_source_surface(cr, win->backing_store, 0, 0);
+       cairo_paint(cr);
+       return FALSE;
+}