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