clang-tidy: readability-isolate-declaration
[geeqie.git] / src / advanced-exif.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 "main.h"
23 #include "advanced-exif.h"
24
25 #include "exif.h"
26 #include "filedata.h"
27 #include "history-list.h"
28 #include "layout-util.h"
29 #include "misc.h"
30 #include "ui-misc.h"
31 #include "window.h"
32 #include "dnd.h"
33
34 enum {
35         ADVANCED_EXIF_DATA_COLUMN_WIDTH = 200
36 };
37
38 /*
39  *-------------------------------------------------------------------
40  * EXIF window
41  *-------------------------------------------------------------------
42  */
43
44 struct ExifWin
45 {
46         GtkWidget *window;
47         GtkWidget *vbox;
48         GtkWidget *scrolled;
49         GtkWidget *listview;
50         GtkWidget *label_file_name;
51
52         FileData *fd;
53 };
54
55 enum {
56         EXIF_ADVCOL_ENABLED = 0,
57         EXIF_ADVCOL_TAG,
58         EXIF_ADVCOL_NAME,
59         EXIF_ADVCOL_VALUE,
60         EXIF_ADVCOL_FORMAT,
61         EXIF_ADVCOL_ELEMENTS,
62         EXIF_ADVCOL_DESCRIPTION,
63         EXIF_ADVCOL_COUNT
64 };
65
66 gint display_order [6] = {
67         EXIF_ADVCOL_DESCRIPTION,
68         EXIF_ADVCOL_VALUE,
69         EXIF_ADVCOL_NAME,
70         EXIF_ADVCOL_TAG,
71         EXIF_ADVCOL_FORMAT,
72         EXIF_ADVCOL_ELEMENTS
73 };
74
75 static gboolean advanced_exif_row_enabled(const gchar *name)
76 {
77         GList *list;
78
79         if (!name) return FALSE;
80
81         list = history_list_get_by_key("exif_extras");
82         while (list)
83                 {
84                 if (strcmp(name, static_cast<gchar *>(list->data)) == 0) return TRUE;
85                 list = list->next;
86         }
87
88         return FALSE;
89 }
90
91 static void advanced_exif_update(ExifWin *ew)
92 {
93         ExifData *exif;
94
95         GtkListStore *store;
96         GtkTreeIter iter;
97         ExifData *exif_original;
98         ExifItem *item;
99
100         exif = exif_read_fd(ew->fd);
101
102         gtk_widget_set_sensitive(ew->scrolled, !!exif);
103
104         if (!exif) return;
105
106         exif_original = exif_get_original(exif);
107
108         store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview)));
109         gtk_list_store_clear(store);
110
111         item = exif_get_first_item(exif_original);
112         while (item)
113                 {
114                 gchar *tag;
115                 gchar *tag_name;
116                 gchar *text;
117                 gchar *utf8_text;
118                 const gchar *format;
119                 gchar *elements;
120                 gchar *description;
121
122                 tag = g_strdup_printf("0x%04x", exif_item_get_tag_id(item));
123                 tag_name = exif_item_get_tag_name(item);
124                 format = exif_item_get_format_name(item, TRUE);
125                 text = exif_item_get_data_as_text(item, exif);
126                 utf8_text = utf8_validate_or_convert(text);
127                 g_free(text);
128                 elements = g_strdup_printf("%d", exif_item_get_elements(item));
129                 description = exif_item_get_description(item);
130                 if (!description || *description == '\0')
131                         {
132                         g_free(description);
133                         description = g_strdup(tag_name);
134                         }
135
136                 gtk_list_store_append(store, &iter);
137                 gtk_list_store_set(store, &iter,
138                                 EXIF_ADVCOL_ENABLED, advanced_exif_row_enabled(tag_name),
139                                 EXIF_ADVCOL_TAG, tag,
140                                 EXIF_ADVCOL_NAME, tag_name,
141                                 EXIF_ADVCOL_VALUE, utf8_text,
142                                 EXIF_ADVCOL_FORMAT, format,
143                                 EXIF_ADVCOL_ELEMENTS, elements,
144                                 EXIF_ADVCOL_DESCRIPTION, description, -1);
145                 g_free(tag);
146                 g_free(utf8_text);
147                 g_free(elements);
148                 g_free(description);
149                 g_free(tag_name);
150                 item = exif_get_next_item(exif_original);
151                 }
152         exif_free_fd(ew->fd, exif);
153
154 }
155
156 static void advanced_exif_clear(ExifWin *ew)
157 {
158         GtkListStore *store;
159
160         store = GTK_LIST_STORE(gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview)));
161         gtk_list_store_clear(store);
162 }
163
164 void advanced_exif_set_fd(GtkWidget *window, FileData *fd)
165 {
166         ExifWin *ew;
167
168         ew = static_cast<ExifWin *>(g_object_get_data(G_OBJECT(window), "advanced_exif_data"));
169         if (!ew) return;
170
171         /* store this, advanced view toggle needs to reload data */
172         file_data_unref(ew->fd);
173         ew->fd = file_data_ref(fd);
174
175         gtk_label_set_text(GTK_LABEL(ew->label_file_name), (ew->fd) ? ew->fd->path : "");
176
177         advanced_exif_clear(ew);
178         advanced_exif_update(ew);
179 }
180
181 static GtkTargetEntry advanced_exif_drag_types[] = {
182         { const_cast<gchar *>("text/plain"), 0, TARGET_TEXT_PLAIN }
183 };
184 static gint n_exif_drag_types = 1;
185
186
187 static void advanced_exif_dnd_get(GtkWidget *listview, GdkDragContext *,
188                                   GtkSelectionData *selection_data,
189                                   guint, guint, gpointer)
190 {
191         GtkTreeSelection *sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(listview));
192         GtkTreeIter iter;
193
194         if (gtk_tree_selection_get_selected(sel, nullptr, &iter))
195                 {
196                 GtkTreeModel *store = gtk_tree_view_get_model(GTK_TREE_VIEW(listview));
197                 gchar *key;
198
199                 gtk_tree_model_get(store, &iter, EXIF_ADVCOL_NAME, &key, -1);
200                 gtk_selection_data_set_text(selection_data, key, -1);
201                 g_free(key);
202                 }
203
204 }
205
206
207 static void advanced_exif_dnd_begin(GtkWidget *listview, GdkDragContext *context, gpointer)
208 {
209         GtkTreeSelection *sel = gtk_tree_view_get_selection(GTK_TREE_VIEW(listview));
210         GtkTreeIter iter;
211
212         if (gtk_tree_selection_get_selected(sel, nullptr, &iter))
213                 {
214                 GtkTreeModel *store = gtk_tree_view_get_model(GTK_TREE_VIEW(listview));
215                 gchar *key;
216
217                 gtk_tree_model_get(store, &iter, EXIF_ADVCOL_NAME, &key, -1);
218
219                 dnd_set_drag_label(listview, context, key);
220                 g_free(key);
221                 }
222 }
223
224
225
226 static void advanced_exif_add_column(GtkWidget *listview, const gchar *title, gint n, gboolean sizable)
227 {
228         GtkTreeViewColumn *column;
229         GtkCellRenderer *renderer;
230
231         column = gtk_tree_view_column_new();
232         gtk_tree_view_column_set_title(column, title);
233
234         if (sizable)
235                 {
236                 gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_FIXED);
237                 gtk_tree_view_column_set_fixed_width(column, ADVANCED_EXIF_DATA_COLUMN_WIDTH);
238                 }
239         else
240                 {
241                 gtk_tree_view_column_set_sizing(column, GTK_TREE_VIEW_COLUMN_AUTOSIZE);
242                 }
243
244         gtk_tree_view_column_set_resizable(column, TRUE);
245         gtk_tree_view_column_set_sort_column_id(column, n);
246
247         renderer = gtk_cell_renderer_text_new();
248         gtk_tree_view_column_pack_start(column, renderer, TRUE);
249         gtk_tree_view_column_add_attribute(column, renderer, "text", n);
250         gtk_tree_view_append_column(GTK_TREE_VIEW(listview), column);
251 }
252
253 static void advanced_exif_window_get_geometry(ExifWin *ew)
254 {
255         GdkWindow *window;
256         LayoutWindow *lw = nullptr;
257
258         layout_valid(&lw);
259
260         if (!ew || !lw) return;
261
262         window = gtk_widget_get_window(ew->window);
263         gdk_window_get_position(window, &lw->options.advanced_exif_window.x, &lw->options.advanced_exif_window.y);
264         lw->options.advanced_exif_window.w = gdk_window_get_width(window);
265         lw->options.advanced_exif_window.h = gdk_window_get_height(window);
266 }
267
268 void advanced_exif_close(ExifWin *ew)
269 {
270         if (!ew) return;
271
272         advanced_exif_window_get_geometry(ew);
273         file_data_unref(ew->fd);
274
275         gq_gtk_widget_destroy(ew->window);
276
277         g_free(ew);
278 }
279
280 static gboolean advanced_exif_delete_cb(GtkWidget *, GdkEvent *, gpointer data)
281 {
282         auto ew = static_cast<ExifWin *>(data);
283
284         if (!ew) return FALSE;
285
286         advanced_exif_window_get_geometry(ew);
287         file_data_unref(ew->fd);
288
289         g_free(ew);
290
291         return FALSE;
292 }
293
294 static gint advanced_exif_sort_cb(GtkTreeModel *model, GtkTreeIter *a, GtkTreeIter *b, gpointer data)
295 {
296         gint n = GPOINTER_TO_INT(data);
297         gint ret = 0;
298
299         switch (n)
300                 {
301                 case EXIF_ADVCOL_DESCRIPTION:
302                 case EXIF_ADVCOL_VALUE:
303                 case EXIF_ADVCOL_NAME:
304                 case EXIF_ADVCOL_TAG:
305                 case EXIF_ADVCOL_FORMAT:
306                 case EXIF_ADVCOL_ELEMENTS:
307                         {
308                         gchar *s1;
309                         gchar *s2;
310
311                         gtk_tree_model_get(model, a, n, &s1, -1);
312                         gtk_tree_model_get(model, b, n, &s2, -1);
313
314                         if (!s1 || !s2)
315                                 {
316                                 if (!s1 && !s2) break;
317                                 ret = s1 ? 1 : -1;
318                                 }
319                         else
320                                 {
321                                 ret = g_utf8_collate(s1, s2);
322                                 }
323
324                         g_free(s1);
325                         g_free(s2);
326                         }
327                         break;
328
329                 default:
330                         g_return_val_if_reached(0);
331                 }
332
333         return ret;
334 }
335
336 #ifdef HAVE_GTK4
337 static gboolean advanced_exif_mouseclick(GtkWidget *, GdkEventButton *, gpointer data)
338 {
339 /* @FIXME GTK4 stub */
340         return TRUE;
341 }
342 #else
343 static gboolean advanced_exif_mouseclick(GtkWidget *, GdkEventButton *, gpointer data)
344 {
345         auto ew = static_cast<ExifWin *>(data);
346         GtkTreePath *path;
347         GtkTreeViewColumn *column;
348         GtkTreeIter iter;
349         GtkTreeModel *store;
350         gchar *value;
351         GList *cols;
352         gint col_num;
353         GtkClipboard *clipboard;
354
355         gtk_tree_view_get_cursor(GTK_TREE_VIEW(ew->listview), &path, &column);
356         if (path && column)
357                 {
358                 store = gtk_tree_view_get_model(GTK_TREE_VIEW(ew->listview));
359                 gtk_tree_model_get_iter(store, &iter, path);
360
361                 cols = gtk_tree_view_get_columns(GTK_TREE_VIEW(ew->listview));
362                 col_num = g_list_index(cols, column);
363                 gtk_tree_model_get(store, &iter, display_order[col_num], &value, -1);
364
365                 clipboard = gtk_clipboard_get(GDK_SELECTION_PRIMARY);
366                 gtk_clipboard_set_text(clipboard, value, -1);
367
368                 g_list_free(cols);
369                 g_free(value);
370
371                 gtk_tree_view_set_search_column(GTK_TREE_VIEW(ew->listview), gtk_tree_view_column_get_sort_column_id(column));
372                 }
373
374         return TRUE;
375 }
376 #endif
377
378 static gboolean advanced_exif_keypress(GtkWidget *, GdkEventKey *event, gpointer data)
379 {
380         auto ew = static_cast<ExifWin *>(data);
381         gboolean stop_signal = FALSE;
382
383         if (event->state & GDK_CONTROL_MASK)
384                 {
385                 switch (event->keyval)
386                         {
387                         case 'W': case 'w':
388                                 advanced_exif_close(ew);
389                                 stop_signal = TRUE;
390                                 break;
391                         }
392                 } // if (event->state & GDK_CONTROL...
393         if (!stop_signal && is_help_key(event))
394                 {
395                 help_window_show("GuideOtherWindowsExif.html");
396                 stop_signal = TRUE;
397                 }
398
399         return stop_signal;
400 }
401
402 static gboolean search_function_cb(GtkTreeModel *model, gint column, const gchar *key, GtkTreeIter *iter, gpointer)
403 {
404         gboolean ret = TRUE;
405         gchar *field_contents;
406         gchar *field_contents_nocase;
407         gchar *key_nocase;
408
409         gtk_tree_model_get(model, iter, column, &field_contents, -1);
410
411         field_contents_nocase = g_utf8_casefold(field_contents, -1);
412         key_nocase = g_utf8_casefold(key, -1);
413
414         if (g_strstr_len(field_contents_nocase, -1, key_nocase))
415                 {
416                 ret = FALSE;
417                 }
418
419         g_free(field_contents);
420         g_free(field_contents_nocase);
421         g_free(key_nocase);
422
423         return ret;
424 }
425
426 GtkWidget *advanced_exif_new(LayoutWindow *lw)
427 {
428         ExifWin *ew;
429         GtkListStore *store;
430         GdkGeometry geometry;
431         GtkTreeSortable *sortable;
432         GtkWidget *box;
433         gint n;
434
435         ew = g_new0(ExifWin, 1);
436
437         ew->window = window_new("view", nullptr, nullptr, _("Metadata"));
438         DEBUG_NAME(ew->window);
439
440         geometry.min_width = 900;
441         geometry.min_height = 600;
442         gtk_window_set_geometry_hints(GTK_WINDOW(ew->window), nullptr, &geometry, GDK_HINT_MIN_SIZE);
443
444         gtk_window_set_resizable(GTK_WINDOW(ew->window), TRUE);
445
446         gtk_window_resize(GTK_WINDOW(ew->window), lw->options.advanced_exif_window.w, lw->options.advanced_exif_window.h);
447         if (lw->options.advanced_exif_window.x != 0 && lw->options.advanced_exif_window.y != 0)
448                 {
449                 gq_gtk_window_move(GTK_WINDOW(ew->window), lw->options.advanced_exif_window.x, lw->options.advanced_exif_window.y);
450                 }
451
452         g_object_set_data(G_OBJECT(ew->window), "advanced_exif_data", ew);
453         g_signal_connect(G_OBJECT(ew->window), "delete_event", G_CALLBACK(advanced_exif_delete_cb), ew);
454
455         ew->vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, PREF_PAD_GAP);
456         gq_gtk_container_add(GTK_WIDGET(ew->window), ew->vbox);
457         gtk_widget_show(ew->vbox);
458
459         box = gtk_box_new(GTK_ORIENTATION_HORIZONTAL, 0);
460
461         ew->label_file_name = gtk_label_new("");
462         gtk_label_set_ellipsize(GTK_LABEL(ew->label_file_name), PANGO_ELLIPSIZE_START);
463         gtk_label_set_selectable(GTK_LABEL(ew->label_file_name), TRUE);
464         gtk_label_set_xalign(GTK_LABEL(ew->label_file_name), 0.5);
465         gtk_label_set_yalign(GTK_LABEL(ew->label_file_name), 0.5);
466
467         gq_gtk_box_pack_start(GTK_BOX(box), ew->label_file_name, TRUE, TRUE, 0);
468         gtk_widget_show(ew->label_file_name);
469
470         gq_gtk_box_pack_start(GTK_BOX(ew->vbox), box, FALSE, FALSE, 0);
471         gtk_widget_show(box);
472
473
474         store = gtk_list_store_new(7, G_TYPE_BOOLEAN,
475                                       G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING,
476                                       G_TYPE_STRING, G_TYPE_STRING, G_TYPE_STRING);
477
478         /* set up sorting */
479         sortable = GTK_TREE_SORTABLE(store);
480         for (n = EXIF_ADVCOL_DESCRIPTION; n <= EXIF_ADVCOL_ELEMENTS; n++)
481                 gtk_tree_sortable_set_sort_func(sortable, n, advanced_exif_sort_cb,
482                                                 GINT_TO_POINTER(n), nullptr);
483
484         /* set initial sort order */
485         gtk_tree_sortable_set_sort_column_id(sortable, EXIF_ADVCOL_NAME, GTK_SORT_ASCENDING);
486
487         ew->listview = gtk_tree_view_new_with_model(GTK_TREE_MODEL(store));
488         g_object_unref(store);
489
490         gtk_tree_view_set_headers_visible(GTK_TREE_VIEW(ew->listview), TRUE);
491
492         advanced_exif_add_column(ew->listview, _("Description"), EXIF_ADVCOL_DESCRIPTION, FALSE);
493         advanced_exif_add_column(ew->listview, _("Value"), EXIF_ADVCOL_VALUE, TRUE);
494         advanced_exif_add_column(ew->listview, _("Name"), EXIF_ADVCOL_NAME, FALSE);
495         advanced_exif_add_column(ew->listview, _("Tag"), EXIF_ADVCOL_TAG, FALSE);
496         advanced_exif_add_column(ew->listview, _("Format"), EXIF_ADVCOL_FORMAT, FALSE);
497         advanced_exif_add_column(ew->listview, _("Elements"), EXIF_ADVCOL_ELEMENTS, FALSE);
498
499         gtk_tree_view_set_enable_search(GTK_TREE_VIEW(ew->listview), TRUE);
500         gtk_tree_view_set_search_column(GTK_TREE_VIEW(ew->listview), EXIF_ADVCOL_DESCRIPTION);
501         gtk_tree_view_set_search_equal_func(GTK_TREE_VIEW(ew->listview), search_function_cb, ew, nullptr);
502
503         gtk_drag_source_set(ew->listview,
504                            static_cast<GdkModifierType>(GDK_BUTTON1_MASK | GDK_BUTTON2_MASK),
505                            advanced_exif_drag_types, n_exif_drag_types,
506                            static_cast<GdkDragAction>(GDK_ACTION_COPY | GDK_ACTION_MOVE | GDK_ACTION_LINK));
507
508         g_signal_connect(G_OBJECT(ew->listview), "drag_data_get",
509                          G_CALLBACK(advanced_exif_dnd_get), ew);
510
511         g_signal_connect(G_OBJECT(ew->listview), "drag_begin",
512                          G_CALLBACK(advanced_exif_dnd_begin), ew);
513
514         g_signal_connect(G_OBJECT(ew->window), "key_press_event",
515                          G_CALLBACK(advanced_exif_keypress), ew);
516
517         g_signal_connect(G_OBJECT(ew->listview), "button_release_event",
518                         G_CALLBACK(advanced_exif_mouseclick), ew);
519
520         ew->scrolled = gq_gtk_scrolled_window_new(nullptr, nullptr);
521         gq_gtk_scrolled_window_set_shadow_type(GTK_SCROLLED_WINDOW(ew->scrolled), GTK_SHADOW_IN);
522         gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(ew->scrolled),
523                                        GTK_POLICY_AUTOMATIC, GTK_POLICY_ALWAYS);
524         gq_gtk_box_pack_start(GTK_BOX(ew->vbox), ew->scrolled, TRUE, TRUE, 0);
525         gq_gtk_container_add(GTK_WIDGET(ew->scrolled), ew->listview);
526         gtk_widget_show(ew->listview);
527         gtk_widget_show(ew->scrolled);
528
529         gtk_widget_show(ew->window);
530         return ew->window;
531 }
532 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */