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