src/ui-help.cc

   1 /*
   2  * Copyright (C) 2004 John Ellis
   3  * Copyright (C) 2008 - 2016 The Geeqie Team
   4  *
   5  * Author: John Ellis
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20  */
  21
  22 #include <stdio.h>
  23 #include <string.h>
  24
  25 #include "main.h"
  26 #include "ui-help.h"
  27
  28 #include "ui-fileops.h"
  29 #include "ui-misc.h"
  30 #include "window.h"
  31
  32
  33 #define HELP_WINDOW_WIDTH 650
  34 #define HELP_WINDOW_HEIGHT 350
  35
  36
  37 /*
  38  *-----------------------------------------------------------------------------
  39  * 'help' window
  40  *-----------------------------------------------------------------------------
  41  */
  42
  43 #define SCROLL_MARKNAME "scroll_point"
  44
  45 static void help_window_scroll(GtkWidget *text, const gchar *key)
  46 {
  47         gchar *needle;
  48         GtkTextBuffer *buffer;
  49         GtkTextIter iter;
  50         GtkTextIter start, end;
  51
  52         if (!text || !key) return;
  53
  54         needle = g_strdup_printf("[section:%s]", key);
  55
  56         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
  57         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
  58
  59         if (gtk_text_iter_forward_search(&iter, needle, GTK_TEXT_SEARCH_TEXT_ONLY,
  60                                          &start, &end, NULL))
  61                 {
  62                 gint line;
  63                 GtkTextMark *mark;
  64
  65                 line = gtk_text_iter_get_line(&start);
  66                 gtk_text_buffer_get_iter_at_line_offset(buffer, &iter, line, 0);
  67                 gtk_text_buffer_place_cursor(buffer, &iter);
  68
  69                 /* apparently only scroll_to_mark works when the textview is not visible yet */
  70
  71                 /* if mark exists, move it instead of creating one for every scroll */
  72                 mark = gtk_text_buffer_get_mark(buffer, SCROLL_MARKNAME);
  73                 if (mark)
  74                         {
  75                         gtk_text_buffer_move_mark(buffer, mark, &iter);
  76                         }
  77                 else
  78                         {
  79                         mark = gtk_text_buffer_create_mark(buffer, SCROLL_MARKNAME, &iter, FALSE);
  80                         }
  81                 gtk_text_view_scroll_to_mark(GTK_TEXT_VIEW(text), mark, 0.0, TRUE, 0, 0);
  82                 }
  83
  84         g_free(needle);
  85 }
  86
  87 static void help_window_load_text(GtkWidget *text, const gchar *path)
  88 {
  89         gchar *pathl;
  90         FILE *f;
  91         gchar s_buf[1024];
  92         GtkTextBuffer *buffer;
  93         GtkTextIter iter;
  94         GtkTextIter start, end;
  95
  96         if (!text || !path) return;
  97
  98         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
  99
 100         gtk_text_buffer_get_bounds(buffer, &start, &end);
 101         gtk_text_buffer_delete(buffer, &start, &end);
 102
 103         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 104
 105         pathl = path_from_utf8(path);
 106         f = fopen(pathl, "r");
 107         g_free(pathl);
 108         if (!f)
 109                 {
 110                 gchar *buf;
 111                 buf = g_strdup_printf(_("Unable to load:\n%s"), path);
 112                 gtk_text_buffer_insert(buffer, &iter, buf, -1);
 113                 g_free(buf);
 114                 }
 115         else
 116                 {
 117                 while (fgets(s_buf, sizeof(s_buf), f))
 118                         {
 119                         gchar *buf;
 120                         gint l;
 121
 122                         l = strlen(s_buf);
 123
 124                         if (!g_utf8_validate(s_buf, l, NULL))
 125                                 {
 126                                 buf = g_locale_to_utf8(s_buf, l, NULL, NULL, NULL);
 127                                 if (!buf) buf = g_strdup("\n");
 128                                 }
 129                         else
 130                                 {
 131                                 buf = NULL;
 132                                 }
 133                         gtk_text_buffer_insert_with_tags_by_name(buffer, &iter,
 134                                                                  (buf) ? buf : s_buf, -1,
 135                                                                  "monospace", NULL);
 136                         g_free(buf);
 137                         }
 138                 fclose(f);
 139                 }
 140
 141         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 142         gtk_text_buffer_place_cursor(buffer, &iter);
 143         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(text), &iter, 0.0, TRUE, 0, 0);
 144 }
 145
 146 static gboolean help_window_delete_cb(GtkWidget *widget, GdkEventAny *UNUSED(event), gpointer UNUSED(data))
 147 {
 148         gtk_widget_destroy(widget);
 149         return TRUE;
 150 }
 151
 152 static void help_window_close(GtkWidget *UNUSED(widget), gpointer data)
 153 {
 154         GtkWidget *window = static_cast<GtkWidget *>(data);
 155         gtk_widget_destroy(window);
 156 }
 157
 158 void help_window_set_key(GtkWidget *window, const gchar *key)
 159 {
 160         GtkWidget *text;
 161
 162         if (!window) return;
 163
 164         text = static_cast<GtkWidget *>(g_object_get_data(G_OBJECT(window), "text_widget"));
 165         if (!text) return;
 166
 167         gdk_window_raise(gtk_widget_get_window(window));
 168
 169         if (key) help_window_scroll(text, key);
 170 }
 171
 172 //void help_window_set_file(GtkWidget *window, const gchar *path, const gchar *key)
 173 //{
 174         //GtkWidget *text;
 175
 176         //if (!window || !path) return;
 177
 178         //text = g_object_get_data(G_OBJECT(window), "text_widget");
 179         //if (!text) return;
 180
 181         //gdk_window_raise(gtk_widget_get_window(window));
 182
 183         //help_window_load_text(text, path);
 184         //help_window_scroll(text, key);
 185 //}
 186
 187 GtkWidget *help_window_new(const gchar *title,
 188                            const gchar *subclass,
 189                            const gchar *path, const gchar *key)
 190 {
 191         GtkWidget *window;
 192         GtkWidget *text;
 193         GtkTextBuffer *buffer;
 194         GtkWidget *vbox;
 195         GtkWidget *hbox;
 196         GtkWidget *button;
 197         GtkWidget *scrolled;
 198
 199         /* window */
 200
 201         window = window_new(GTK_WINDOW_TOPLEVEL, subclass, NULL, NULL, title);
 202         DEBUG_NAME(window);
 203         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 204         gtk_window_set_default_size(GTK_WINDOW(window), HELP_WINDOW_WIDTH, HELP_WINDOW_HEIGHT);
 205
 206         g_signal_connect(G_OBJECT(window), "delete_event",
 207                          G_CALLBACK(help_window_delete_cb), NULL);
 208
 209         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 210         gtk_container_add(GTK_CONTAINER(window), vbox);
 211         gtk_widget_show(vbox);
 212
 213         g_object_set_data(G_OBJECT(window), "text_vbox", vbox);
 214
 215         /* text window */
 216
 217         hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
 218         gtk_box_pack_start(GTK_BOX(vbox), hbox, TRUE, TRUE, 0);
 219         gtk_widget_show(hbox);
 220
 221         scrolled = gtk_scrolled_window_new(NULL, NULL);
 222         gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
 223         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
 224                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 225         gtk_box_pack_start(GTK_BOX(hbox), scrolled, TRUE, TRUE, 0);
 226         gtk_widget_show(scrolled);
 227
 228         text = gtk_text_view_new();
 229         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 230         gtk_container_add(GTK_CONTAINER(scrolled), text);
 231         gtk_widget_show(text);
 232
 233         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 234         gtk_text_buffer_create_tag(buffer, "monospace",
 235                                    "family", "monospace", NULL);
 236
 237         hbox = gtk_hbutton_box_new();
 238         gtk_container_set_border_width(GTK_CONTAINER(hbox), PREF_PAD_BORDER);
 239         gtk_button_box_set_layout(GTK_BUTTON_BOX(hbox), GTK_BUTTONBOX_END);
 240         gtk_box_pack_end(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 241         gtk_widget_show(hbox);
 242
 243         button = gtk_button_new_from_stock(GTK_STOCK_CLOSE);
 244         g_signal_connect(G_OBJECT(button), "clicked",
 245                          G_CALLBACK(help_window_close), window);
 246         gtk_container_add(GTK_CONTAINER(hbox), button);
 247         gtk_widget_set_can_default(button, TRUE);
 248         gtk_widget_grab_default(button);
 249         gtk_widget_show(button);
 250
 251         g_object_set_data(G_OBJECT(window), "text_widget", text);
 252
 253         help_window_load_text(text, path);
 254
 255         gtk_widget_show(window);
 256
 257         help_window_scroll(text, key);
 258
 259         return window;
 260 }
 261
 262 //GtkWidget *help_window_get_box(GtkWidget *window)
 263 //{
 264         //return g_object_get_data(G_OBJECT(window), "text_vbox");
 265 //}
 266 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */