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