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 <cstdio>
  23 #include <cstring>
  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 enum {
  34         HELP_WINDOW_WIDTH = 650,
  35         HELP_WINDOW_HEIGHT = 350
  36 };
  37
  38
  39 /*
  40  *-----------------------------------------------------------------------------
  41  * 'help' window
  42  *-----------------------------------------------------------------------------
  43  */
  44
  45 #define SCROLL_MARKNAME "scroll_point"
  46
  47 static void help_window_scroll(GtkWidget *text, const gchar *key)
  48 {
  49         gchar *needle;
  50         GtkTextBuffer *buffer;
  51         GtkTextIter iter;
  52         GtkTextIter start;
  53         GtkTextIter end;
  54
  55         if (!text || !key) return;
  56
  57         needle = g_strdup_printf("[section:%s]", key);
  58
  59         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
  60         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
  61
  62         if (gtk_text_iter_forward_search(&iter, needle, GTK_TEXT_SEARCH_TEXT_ONLY,
  63                                          &start, &end, nullptr))
  64                 {
  65                 gint line;
  66                 GtkTextMark *mark;
  67
  68                 line = gtk_text_iter_get_line(&start);
  69                 gtk_text_buffer_get_iter_at_line_offset(buffer, &iter, line, 0);
  70                 gtk_text_buffer_place_cursor(buffer, &iter);
  71
  72                 /* apparently only scroll_to_mark works when the textview is not visible yet */
  73
  74                 /* if mark exists, move it instead of creating one for every scroll */
  75                 mark = gtk_text_buffer_get_mark(buffer, SCROLL_MARKNAME);
  76                 if (mark)
  77                         {
  78                         gtk_text_buffer_move_mark(buffer, mark, &iter);
  79                         }
  80                 else
  81                         {
  82                         mark = gtk_text_buffer_create_mark(buffer, SCROLL_MARKNAME, &iter, FALSE);
  83                         }
  84                 gtk_text_view_scroll_to_mark(GTK_TEXT_VIEW(text), mark, 0.0, TRUE, 0, 0);
  85                 }
  86
  87         g_free(needle);
  88 }
  89
  90 static void help_window_load_text(GtkWidget *text, const gchar *path)
  91 {
  92         gchar *pathl;
  93         FILE *f;
  94         gchar s_buf[1024];
  95         GtkTextBuffer *buffer;
  96         GtkTextIter iter;
  97         GtkTextIter start;
  98         GtkTextIter end;
  99
 100         if (!text || !path) return;
 101
 102         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 103
 104         gtk_text_buffer_get_bounds(buffer, &start, &end);
 105         gtk_text_buffer_delete(buffer, &start, &end);
 106
 107         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 108
 109         pathl = path_from_utf8(path);
 110         f = fopen(pathl, "r");
 111         g_free(pathl);
 112         if (!f)
 113                 {
 114                 gchar *buf;
 115                 buf = g_strdup_printf(_("Unable to load:\n%s"), path);
 116                 gtk_text_buffer_insert(buffer, &iter, buf, -1);
 117                 g_free(buf);
 118                 }
 119         else
 120                 {
 121                 while (fgets(s_buf, sizeof(s_buf), f))
 122                         {
 123                         gchar *buf;
 124                         gint l;
 125
 126                         l = strlen(s_buf);
 127
 128                         if (!g_utf8_validate(s_buf, l, nullptr))
 129                                 {
 130                                 buf = g_locale_to_utf8(s_buf, l, nullptr, nullptr, nullptr);
 131                                 if (!buf) buf = g_strdup("\n");
 132                                 }
 133                         else
 134                                 {
 135                                 buf = nullptr;
 136                                 }
 137                         gtk_text_buffer_insert_with_tags_by_name(buffer, &iter,
 138                                                                  (buf) ? buf : s_buf, -1,
 139                                                                  "monospace", NULL);
 140                         g_free(buf);
 141                         }
 142                 fclose(f);
 143                 }
 144
 145         gtk_text_buffer_get_iter_at_offset(buffer, &iter, 0);
 146         gtk_text_buffer_place_cursor(buffer, &iter);
 147         gtk_text_view_scroll_to_iter(GTK_TEXT_VIEW(text), &iter, 0.0, TRUE, 0, 0);
 148 }
 149
 150 static gboolean help_window_delete_cb(GtkWidget *widget, GdkEventAny *, gpointer)
 151 {
 152         gq_gtk_widget_destroy(widget);
 153         return TRUE;
 154 }
 155
 156 static void help_window_close(GtkWidget *, gpointer data)
 157 {
 158         auto window = static_cast<GtkWidget *>(data);
 159         gq_gtk_widget_destroy(window);
 160 }
 161
 162 void help_window_set_key(GtkWidget *window, const gchar *key)
 163 {
 164         GtkWidget *text;
 165
 166         if (!window) return;
 167
 168         text = static_cast<GtkWidget *>(g_object_get_data(G_OBJECT(window), "text_widget"));
 169         if (!text) return;
 170
 171         gdk_window_raise(gtk_widget_get_window(window));
 172
 173         if (key) help_window_scroll(text, key);
 174 }
 175
 176 #pragma GCC diagnostic push
 177 #pragma GCC diagnostic ignored "-Wunused-function"
 178 void help_window_set_file_unused(GtkWidget *window, const gchar *path, const gchar *key)
 179 {
 180         GtkWidget *text;
 181
 182         if (!window || !path) return;
 183
 184         text = static_cast<GtkWidget *>(g_object_get_data(G_OBJECT(window), "text_widget"));
 185         if (!text) return;
 186
 187         gdk_window_raise(gtk_widget_get_window(window));
 188
 189         help_window_load_text(text, path);
 190         help_window_scroll(text, key);
 191 }
 192 #pragma GCC diagnostic pop
 193
 194 GtkWidget *help_window_new(const gchar *title,
 195                            const gchar *subclass,
 196                            const gchar *path, const gchar *key)
 197 {
 198         GtkWidget *window;
 199         GtkWidget *text;
 200         GtkTextBuffer *buffer;
 201         GtkWidget *vbox;
 202         GtkWidget *hbox;
 203         GtkWidget *button;
 204         GtkWidget *scrolled;
 205
 206         /* window */
 207
 208         window = window_new(subclass, nullptr, nullptr, title);
 209         DEBUG_NAME(window);
 210         gtk_window_set_resizable(GTK_WINDOW(window), TRUE);
 211         gtk_window_set_default_size(GTK_WINDOW(window), HELP_WINDOW_WIDTH, HELP_WINDOW_HEIGHT);
 212
 213         g_signal_connect(G_OBJECT(window), "delete_event",
 214                          G_CALLBACK(help_window_delete_cb), NULL);
 215
 216         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 217         gq_gtk_container_add(GTK_WIDGET(window), vbox);
 218         gtk_widget_show(vbox);
 219
 220         g_object_set_data(G_OBJECT(window), "text_vbox", vbox);
 221
 222         /* text window */
 223
 224         hbox = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
 225         gq_gtk_box_pack_start(GTK_BOX(vbox), hbox, TRUE, TRUE, 0);
 226         gtk_widget_show(hbox);
 227
 228         scrolled = gq_gtk_scrolled_window_new(nullptr, nullptr);
 229         gq_gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(scrolled), GTK_SHADOW_IN);
 230         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
 231                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_AUTOMATIC);
 232         gq_gtk_box_pack_start(GTK_BOX(hbox), scrolled, TRUE, TRUE, 0);
 233         gtk_widget_show(scrolled);
 234
 235         text = gtk_text_view_new();
 236         gtk_text_view_set_editable(GTK_TEXT_VIEW(text), FALSE);
 237         gq_gtk_container_add(GTK_WIDGET(scrolled), text);
 238         gtk_widget_show(text);
 239
 240         buffer = gtk_text_view_get_buffer(GTK_TEXT_VIEW(text));
 241         gtk_text_buffer_create_tag(buffer, "monospace",
 242                                    "family", "monospace", NULL);
 243
 244         hbox = gtk_button_box_new(GTK_ORIENTATION_HORIZONTAL);
 245         gtk_container_set_border_width(GTK_CONTAINER(hbox), PREF_PAD_BORDER);
 246         gtk_button_box_set_layout(GTK_BUTTON_BOX(hbox), GTK_BUTTONBOX_END);
 247         gq_gtk_box_pack_end(GTK_BOX(vbox), hbox, FALSE, FALSE, 0);
 248         gtk_widget_show(hbox);
 249
 250         button = gtk_button_new_from_icon_name(GQ_ICON_CLOSE, GTK_ICON_SIZE_BUTTON);
 251         g_signal_connect(G_OBJECT(button), "clicked",
 252                          G_CALLBACK(help_window_close), window);
 253         gq_gtk_container_add(GTK_WIDGET(hbox), button);
 254         gtk_widget_set_can_default(button, TRUE);
 255         gtk_widget_grab_default(button);
 256         gtk_widget_show(button);
 257
 258         g_object_set_data(G_OBJECT(window), "text_widget", text);
 259
 260         help_window_load_text(text, path);
 261
 262         gtk_widget_show(window);
 263
 264         help_window_scroll(text, key);
 265
 266         return window;
 267 }
 268
 269 #pragma GCC diagnostic push
 270 #pragma GCC diagnostic ignored "-Wunused-function"
 271 GtkWidget *help_window_get_box_unused(GtkWidget *window)
 272 {
 273         return static_cast<GtkWidget *>(g_object_get_data(G_OBJECT(window), "text_vbox"));
 274 }
 275 #pragma GCC diagnostic pop
 276
 277 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */