libchimara/pager.c

   1 #include <gdk/gdkkeysyms.h>
   2
   3 #include "pager.h"
   4
   5 /* Helper function: move the pager to the last visible position in the buffer,
   6  and return the distance between the pager and the end of the buffer in buffer
   7  coordinates */
   8 static void
   9 move_pager_and_get_scroll_distance(GtkTextView *textview, gint *view_height, gint *scroll_distance, gboolean move )
  10 {
  11         GdkRectangle pagerpos, endpos, visiblerect;
  12         GtkTextIter oldpager, newpager, end;
  13         GtkTextBuffer *buffer = gtk_text_view_get_buffer(textview);
  14         GtkTextMark *pager = gtk_text_buffer_get_mark(buffer, "pager_position");
  15
  16         /* Get an iter at the lower right corner of the visible part of the buffer */
  17         gtk_text_view_get_visible_rect(textview, &visiblerect);
  18         gtk_text_view_get_iter_at_location(
  19                 textview,
  20                 &newpager,
  21                 visiblerect.x + visiblerect.width,
  22                 visiblerect.y + visiblerect.height
  23         );
  24         gtk_text_buffer_get_iter_at_mark(buffer, &oldpager, pager);
  25
  26         if(move)
  27                 gtk_text_buffer_move_mark(buffer, pager, &newpager);
  28
  29         /* Get the buffer coordinates of the pager and the end iter */
  30         gtk_text_buffer_get_end_iter(buffer, &end);
  31         gtk_text_buffer_get_iter_at_mark(buffer, &newpager, pager);
  32         gtk_text_view_get_iter_location(textview, &newpager, &pagerpos);
  33         gtk_text_view_get_iter_location(textview, &end, &endpos);
  34
  35         /*
  36         g_printerr("View height = %d\n", visiblerect.height);
  37         g_printerr("End - Pager = %d - %d = %d\n", endpos.y, pagerpos.y, endpos.y - pagerpos.y);
  38         */
  39
  40         *view_height = visiblerect.height;
  41         *scroll_distance = endpos.y - pagerpos.y;
  42 }
  43
  44 /* Helper function: turn on paging for this textview */
  45 static void
  46 start_paging(winid_t win)
  47 {
  48         win->currently_paging = TRUE;
  49         gtk_widget_show(win->pager);
  50         g_signal_handler_unblock(win->widget, win->pager_keypress_handler);
  51 }
  52
  53 /* Helper function: turn off paging for this textview */
  54 static void
  55 stop_paging(winid_t win)
  56 {
  57         win->currently_paging = FALSE;
  58         gtk_widget_hide(win->pager);
  59         g_signal_handler_block(win->widget, win->pager_keypress_handler);
  60 }
  61
  62 void
  63 pager_on_clicked(GtkButton *pager, winid_t win)
  64 {
  65         GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment( GTK_SCROLLED_WINDOW(win->scrolledwindow) );
  66         double upper = gtk_adjustment_get_upper(adj);
  67         gtk_adjustment_set_value(adj, upper);
  68 }
  69
  70 /* When the user scrolls up in a textbuffer, start paging. */
  71 void
  72 pager_after_adjustment_changed(GtkAdjustment *adj, winid_t win)
  73 {
  74         /* Move the pager, etc. */
  75         gint scroll_distance, view_height;
  76         move_pager_and_get_scroll_distance( GTK_TEXT_VIEW(win->widget), &view_height, &scroll_distance, TRUE );
  77
  78         if(scroll_distance > 0 && !win->currently_paging)
  79                 start_paging(win);
  80         else if(scroll_distance == 0 && win->currently_paging)
  81                 stop_paging(win);
  82 }
  83
  84 /* Handle key press events in the textview while paging is active */
  85 gboolean
  86 pager_on_key_press_event(GtkTextView *textview, GdkEventKey *event, winid_t win)
  87 {
  88         GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment( GTK_SCROLLED_WINDOW(win->scrolledwindow) );
  89         gdouble page_size, upper, lower, value;
  90         g_object_get(adj,
  91                 "page-size", &page_size,
  92                 "upper", &upper,
  93                 "lower", &lower,
  94                 "value", &value,
  95                 NULL);
  96
  97         switch (event->keyval) {
  98                 case GDK_KEY_space: case GDK_KEY_KP_Space:
  99                 case GDK_KEY_Page_Down: case GDK_KEY_KP_Page_Down:
 100                 case GDK_KEY_Return: case GDK_KEY_KP_Enter:
 101                         gtk_adjustment_set_value(adj, CLAMP(value + page_size, lower, upper - page_size));
 102                         return TRUE;
 103                 case GDK_KEY_Page_Up: case GDK_KEY_KP_Page_Up:
 104                         gtk_adjustment_set_value(adj, CLAMP(value - page_size, lower, upper - page_size));
 105                         return TRUE;
 106                         /* don't handle "up" and "down", they're used for input history */
 107         }
 108
 109         return FALSE; /* if the key wasn't handled here, pass it to other handlers */
 110 }
 111
 112 /* Check whether paging should be done. This function is called after the
 113  * textview has finished validating text positions. */
 114 void
 115 pager_after_size_allocate(GtkTextView *textview, GdkRectangle *allocation, winid_t win)
 116 {
 117         /* Move the pager to the last visible character in the buffer */
 118         gint view_height, scroll_distance;
 119         move_pager_and_get_scroll_distance(GTK_TEXT_VIEW(win->widget), &view_height, &scroll_distance, FALSE);
 120
 121         if(view_height <= 1)
 122                 /* Paging is unusable when window is too small */
 123                 return;
 124
 125         /* If not in interactive mode, then just scroll to the bottom. */
 126         ChimaraGlk *glk = CHIMARA_GLK(gtk_widget_get_ancestor(GTK_WIDGET(textview), CHIMARA_TYPE_GLK));
 127         g_assert(glk);
 128         if(!chimara_glk_get_interactive(glk)) {
 129                 GtkTextIter end;
 130                 gtk_text_buffer_get_end_iter(gtk_text_view_get_buffer(textview), &end);
 131                 gtk_text_view_scroll_to_iter(textview, &end, 0.0, TRUE, 0.0, 0.0);
 132                 return;
 133         }
 134
 135         /* Scroll past text already read by user. This is automatic scrolling, so disable the pager_ajustment_handler
 136          * first, that acts on the belief the scolling is performed by the user. */
 137         GtkAdjustment *adj = gtk_scrolled_window_get_vadjustment(GTK_SCROLLED_WINDOW(win->scrolledwindow));
 138         g_signal_handler_block(adj, win->pager_adjustment_handler);
 139         GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 140         GtkTextMark *pager_position = gtk_text_buffer_get_mark(buffer, "pager_position");
 141         gtk_text_view_scroll_to_mark(GTK_TEXT_VIEW(win->widget), pager_position, 0.0, TRUE, 0.0, 0.0);
 142         g_signal_handler_unblock(adj, win->pager_adjustment_handler);
 143
 144         if(!win->currently_paging) {
 145                 if(scroll_distance > view_height) {
 146                         start_paging(win);
 147                         gdk_window_invalidate_rect(gtk_widget_get_window(win->widget), NULL, TRUE);
 148                 }
 149         }
 150 }
 151
 152 void
 153 pager_update(winid_t win)
 154 {
 155         GtkTextIter input_iter;
 156         GtkTextBuffer *buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(win->widget));
 157         GtkTextMark *input_position = gtk_text_buffer_get_mark(buffer, "input_position");
 158         GtkTextMark *pager_position = gtk_text_buffer_get_mark(buffer, "pager_position");
 159         gtk_text_buffer_get_iter_at_mark(buffer, &input_iter, input_position);
 160         gtk_text_buffer_move_mark(buffer, pager_position, &input_iter);
 161 }