Documented all planned Glk API functions
[rodin/chimara.git] / libchimara / graphics.c
index 12a42b2e268fdb4684e84c4fe909baac5768fa15..c87a148390aa0dc05fdd17a7114ac1ca6aa883e4 100644 (file)
@@ -7,6 +7,7 @@
 extern GPrivate *glk_data_key;
 void on_size_prepared(GdkPixbufLoader *loader, gint width, gint height, struct image_info *info);
 void on_pixbuf_closed(GdkPixbufLoader *loader, gpointer data);
+glui32 draw_image_common(winid_t win, GdkPixbuf *pixbuf, glsi32 val1, glsi32 val2);
 
 static gboolean image_loaded;
 static gboolean size_determined;
@@ -138,25 +139,30 @@ 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;
        }
 
        /* Iterate over the cache to find the correct image and size */
+       struct image_info *match = NULL;
        do {
                struct image_info *info = (struct image_info*) link->data;
                if(info->resource_number == to_find->resource_number) {
                        /* Check size: are we looking for a scaled version or the original one? */
                        if(to_find->scaled) {
-                               if(info->width >= to_find->width && info->height >= to_find->height) {
+
+                               if(info->width == to_find->width && info->height == to_find->height) {
+                                       /* Prescaled image found */
+                                       gdk_threads_leave();
+                                       return info;
+                               }
+                               else if(info->width >= to_find->width && info->height >= to_find->height) {
+                                       /* Larger image found, needs to be scaled down in order to work */
                                        gdk_threads_leave();
-                                       printf("Cache hit for image %d\n", to_find->resource_number);
-                                       return info; /* Found a good enough match */
+                                       match = info;
                                }
                        } else {
                                if(!info->scaled) {
                                        gdk_threads_leave();
-                                       printf("Cache hit for image %d\n", to_find->resource_number);
                                        return info; /* Found a match */
                                }
                        }
@@ -165,8 +171,7 @@ image_cache_find(struct image_info* to_find)
 
        gdk_threads_leave();
 
-       printf("Cache miss for image %d\n", to_find->resource_number);
-       return NULL; /* No match found */
+       return match;
 }
 
 /**
@@ -248,11 +253,10 @@ glui32
 glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2)
 {
        VALID_WINDOW(win, return FALSE);
-       g_return_val_if_fail(win->type == wintype_Graphics, FALSE);
+       g_return_val_if_fail(win->type == wintype_Graphics || win->type == wintype_TextBuffer, FALSE);
 
        struct image_info *to_find = g_new0(struct image_info, 1);
        struct image_info *info;
-       GdkPixmap *canvas;
 
        /* Lookup the proper resource */
        to_find->resource_number = image;
@@ -264,22 +268,7 @@ glk_image_draw(winid_t win, glui32 image, glsi32 val1, glsi32 val2)
                        return FALSE;
        }
 
-       gdk_threads_enter();
-
-       gtk_image_get_pixmap( GTK_IMAGE(win->widget), &canvas, NULL );
-       if(canvas == NULL) {
-               WARNING("Could not get pixmap");
-               return FALSE;
-       }
-
-       gdk_draw_pixbuf( GDK_DRAWABLE(canvas), NULL, GDK_PIXBUF((GdkPixbuf*)info->pixbuf), 0, 0, val1, val2, -1, -1, GDK_RGB_DITHER_NONE, 0, 0 );
-
-       /* Update the screen */
-       gtk_widget_queue_draw(win->widget);
-
-       gdk_threads_leave();
-
-       return TRUE;
+       return draw_image_common(win, info->pixbuf, val1, val2);
 }
 
 /**
@@ -309,13 +298,12 @@ glui32
 glk_image_draw_scaled(winid_t win, glui32 image, glsi32 val1, glsi32 val2, glui32 width, glui32 height)
 {
        VALID_WINDOW(win, return FALSE);
-       g_return_val_if_fail(win->type == wintype_Graphics, FALSE);
+       g_return_val_if_fail(win->type == wintype_Graphics || win->type == wintype_TextBuffer, FALSE);
 
        ChimaraGlkPrivate *glk_data = g_private_get(glk_data_key);
        struct image_info *to_find = g_new0(struct image_info, 1);
        struct image_info *info;
        struct image_info *scaled_info;
-       GdkPixmap *canvas;
 
        /* Lookup the proper resource */
        to_find->resource_number = image;
@@ -327,14 +315,6 @@ glk_image_draw_scaled(winid_t win, glui32 image, glsi32 val1, glsi32 val2, glui3
                        return FALSE;
        }
 
-       gdk_threads_enter();
-
-       gtk_image_get_pixmap( GTK_IMAGE(win->widget), &canvas, NULL );
-       if(canvas == NULL) {
-               WARNING("Could not get pixmap");
-               return FALSE;
-       }
-
        /* Scale the image if necessary */
        if(info->width != width || info->height != height) {
                GdkPixbuf *scaled = gdk_pixbuf_scale_simple(info->pixbuf, width, height, GDK_INTERP_BILINEAR);
@@ -352,13 +332,66 @@ glk_image_draw_scaled(winid_t win, glui32 image, glsi32 val1, glsi32 val2, glui3
                info = scaled_info;
        }
 
-       gdk_draw_pixbuf( GDK_DRAWABLE(canvas), NULL, info->pixbuf, 0, 0, val1, val2, -1, -1, GDK_RGB_DITHER_NONE, 0, 0 );
+       return draw_image_common(win, info->pixbuf, val1, val2);
+}
 
-       /* Update the screen */
-       gtk_widget_queue_draw(win->widget);
+/* Internal function: draws a pixbuf to a graphics window of text buffer */
+glui32
+draw_image_common(winid_t win, GdkPixbuf *pixbuf, glsi32 val1, glsi32 val2)
+{
+       GdkPixmap *canvas;
+       gdk_threads_enter();
 
-       gdk_threads_leave();
+       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_draw_pixbuf( GDK_DRAWABLE(canvas), NULL, pixbuf, 0, 0, val1, val2, -1, -1, GDK_RGB_DITHER_NONE, 0, 0 );
+
+               /* Update the screen */
+               gtk_widget_queue_draw(win->widget);
+       }
+               break;
+
+       case wintype_TextBuffer:
+       {
+               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);
+               gtk_text_iter_forward_char(&end);
+
+               gint height = 0;
+               switch(val1) {
+               case imagealign_InlineDown:
+                       height -= win->unit_height;
+                       break;
+               case imagealign_InlineCenter:
+                       height = -win->unit_height / 2;
+                       break;
+               case imagealign_InlineUp:
+               default:
+                       height = 0;
+               }
+
+               if(height != 0) {
+                       GtkTextTag *tag = gtk_text_buffer_create_tag(buffer, NULL, "rise", PANGO_SCALE * (-height), NULL);
+                       gtk_text_buffer_apply_tag(buffer, tag, &start, &end);
+               }
+       }
+               break;
+
+       }
+
+       gdk_threads_leave();
        return TRUE;
 }
 
@@ -382,7 +415,7 @@ glk_image_draw_scaled(winid_t win, glui32 image, glsi32 val1, glsi32 val2, glui3
  * <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
@@ -413,13 +446,18 @@ 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 );
-       gdk_draw_rectangle( GDK_DRAWABLE(map), win->widget->style->white_gc, TRUE, left, top, width, height);
+
+       GdkGC *gc = gdk_gc_new(map);
+       GdkColor gdkcolor;
+       glkcolor_to_gdkcolor(color, &gdkcolor);
+       gdk_gc_set_rgb_fg_color(gc, &gdkcolor);
+       gdk_draw_rectangle( GDK_DRAWABLE(map), gc, TRUE, left, top, width, height);
        gtk_widget_queue_draw(win->widget);
+       g_object_unref(gc);
 
        gdk_threads_leave();
 }
@@ -443,8 +481,46 @@ 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 ***/