2 * Copyright (C) 2018 The Geeqie Team
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 /* Routines for creating the Overlay Screen Display text. Also
22 * used for the same purposes by the Print routines
32 #include "ui-fileops.h"
37 static const gchar *predefined_tags[][2] = {
38 {"%name%", N_("Name")},
39 {"%path:60%", N_("Path")},
40 {"%date%", N_("Date")},
41 {"%size%", N_("Size")},
42 {"%zoom%", N_("Zoom")},
43 {"%dimensions%", N_("Dimensions")},
44 {"%collection%", N_("Collection")},
45 {"%number%", N_("Image index")},
46 {"%total%", N_("Images total")},
47 {"%comment%", N_("Comment")},
48 {"%keywords%", N_("Keywords")},
49 {"%file.ctime%", N_("File ctime")},
50 {"%file.mode%", N_("File mode")},
51 {"%file.owner%", N_("File owner")},
52 {"%file.group%", N_("File group")},
53 {"%file.link%", N_("File link")},
54 {"%file.class%", N_("File class")},
55 {"%file.page_no%", N_("File page no.")},
56 {"%formatted.DateTime%", N_("Image date")},
57 {"%formatted.DateTimeDigitized%", N_("Date digitized")},
58 {"%formatted.ShutterSpeed%", N_("ShutterSpeed")},
59 {"%formatted.Aperture%", N_("Aperture")},
60 {"%formatted.ExposureBias%", N_("Exposure bias")},
61 {"%formatted.Resolution%", N_("Resolution")},
62 {"%formatted.Camera%", N_("Camera")},
63 {"%lua.lensID%", N_("Lens")},
64 {"%formatted.ISOSpeedRating%", N_("ISO")},
65 {"%formatted.FocalLength%", N_("Focal length")},
66 {"%formatted.FocalLength35mmFilm%", N_("Focal len. 35mm")},
67 {"%formatted.SubjectDistance%", N_("Subject distance")},
68 {"%formatted.Flash%", N_("Flash")},
69 {"%formatted.ColorProfile%", N_("Color profile")},
70 {"%formatted.GPSPosition%", N_("Lat, Long")},
71 {"%formatted.GPSAltitude%", N_("Altitude")},
72 {"%formatted.localtime%", N_("Local time")},
73 {"%formatted.timezone%", N_("Timezone")},
74 {"%formatted.countryname%", N_("Country name")},
75 {"%formatted.countrycode%", N_("Country code")},
76 {"%rating%", N_("Rating")},
77 {"%formatted.star_rating%", N_("Star rating")},
78 {"%Xmp.dc.creator%", N_("© Creator")},
79 {"%Xmp.dc.contributor%", N_("© Contributor")},
80 {"%Xmp.dc.rights%", N_("© Rights")},
83 static GtkTargetEntry osd_drag_types[] = {
84 { const_cast<gchar *>("text/plain"), GTK_TARGET_SAME_APP, TARGET_TEXT_PLAIN }
93 static void tag_button_cb(GtkWidget *widget, gpointer data)
95 auto image_overlay_template_view = static_cast<GtkTextView *>(data);
96 GtkTextBuffer *buffer;
99 buffer = gtk_text_view_get_buffer(image_overlay_template_view);
100 td = static_cast<TagData *>(g_object_get_data(G_OBJECT(widget), "tag_data"));
101 gtk_text_buffer_insert_at_cursor(GTK_TEXT_BUFFER(buffer), td->key, -1);
103 gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
106 static void osd_dnd_get_cb(GtkWidget *btn, GdkDragContext *, GtkSelectionData *selection_data, guint, guint, gpointer data)
109 auto image_overlay_template_view = static_cast<GtkTextView *>(data);
111 td = static_cast<TagData *>(g_object_get_data(G_OBJECT(btn), "tag_data"));
112 gtk_selection_data_set_text(selection_data, td->key, -1);
114 gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
117 static void osd_btn_destroy_cb(GtkWidget *btn, GdkDragContext *, GtkSelectionData *, guint, guint, gpointer)
121 td = static_cast<TagData *>(g_object_get_data(G_OBJECT(btn), "tag_data"));
126 static void set_osd_button(GtkGrid *grid, const gint rows, const gint cols, const gchar *key, const gchar *title, GtkWidget *template_view)
128 GtkWidget *new_button;
131 new_button = gtk_button_new_with_label(title);
132 g_signal_connect(G_OBJECT(new_button), "clicked", G_CALLBACK(tag_button_cb), template_view);
133 gtk_widget_show(new_button);
135 td = g_new0(TagData, 1);
136 td->key = g_strdup(key);
137 td->title = g_strdup(title);
139 g_object_set_data(G_OBJECT(new_button), "tag_data", td);
141 gtk_drag_source_set(new_button, GDK_BUTTON1_MASK, osd_drag_types, 1, GDK_ACTION_COPY);
142 g_signal_connect(G_OBJECT(new_button), "drag_data_get",
143 G_CALLBACK(osd_dnd_get_cb), template_view);
144 g_signal_connect(G_OBJECT(new_button), "destroy",
145 G_CALLBACK(osd_btn_destroy_cb), new_button);
147 gtk_grid_attach(grid, new_button, cols, rows, 1, 1);
151 GtkWidget *osd_new(gint max_cols, GtkWidget *template_view)
162 vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
164 pref_label_new(vbox, _("To include predefined tags in the template, click a button or drag-and-drop"));
166 scrolled = gq_gtk_scrolled_window_new(nullptr, nullptr);
167 gq_gtk_box_pack_start(GTK_BOX(vbox), scrolled, FALSE, FALSE, 0);
168 gtk_container_set_border_width(GTK_CONTAINER(scrolled), PREF_PAD_BORDER);
169 gtk_scrolled_window_set_policy(GTK_SCROLLED_WINDOW(scrolled),
170 GTK_POLICY_NEVER, GTK_POLICY_AUTOMATIC);
171 gtk_widget_show(scrolled);
172 gtk_widget_set_size_request(scrolled, -1, 140);
174 viewport = gtk_viewport_new(nullptr, nullptr);
175 gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
176 gq_gtk_container_add(GTK_WIDGET(scrolled), viewport);
177 gtk_widget_show(viewport);
179 entries = (sizeof(predefined_tags) / sizeof(predefined_tags[0])) - 1;
180 max_rows = ceil(entries / max_cols);
183 grid = GTK_GRID(gtk_grid_new());
184 gq_gtk_container_add(GTK_WIDGET(viewport), GTK_WIDGET(grid));
185 gtk_widget_show(GTK_WIDGET(grid));
187 for (rows = 0; rows < max_rows; rows++)
191 while (cols < max_cols && predefined_tags[i][0])
193 set_osd_button(grid, rows, cols, predefined_tags[i][0], predefined_tags[i][1], template_view);
200 static gchar *keywords_to_string(FileData *fd)
203 GString *kwstr = nullptr;
207 keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN);
211 GList *work = keywords;
215 auto kw = static_cast<gchar *>(work->data);
220 kwstr = g_string_new("");
222 g_string_append(kwstr, ", ");
224 g_string_append(kwstr, kw);
226 g_list_free_full(keywords, g_free);
231 return g_string_free(kwstr, FALSE);
237 gchar *image_osd_mkinfo(const gchar *str, FileData *fd, GHashTable *vars)
239 gchar delim = '%', imp = '|', sep[] = " - ";
242 gboolean want_separator = FALSE;
247 if (!str || !*str) return g_strdup("");
249 osd_info = g_string_new(str);
256 gchar *trunc = nullptr;
257 gchar *limpos = nullptr;
258 gchar *extra = nullptr;
259 gchar *extrapos = nullptr;
262 start = strchr(osd_info->str + (prev + 1), delim);
265 end = strchr(start+1, delim);
269 /* Search for optional modifiers
270 * %name:99:extra% -> name = "name", limit=99, extra = "extra"
272 for (p = start + 1; p < end; p++)
276 if (g_ascii_isdigit(p[1]) && !limpos)
279 if (!trunc) trunc = p;
284 if (!trunc) trunc = p;
291 limit = static_cast<guint>(atoi(limpos));
294 extra = g_strndup(extrapos, end - extrapos);
296 name = g_strndup(start+1, (trunc ? trunc : end)-start-1);
297 pos = start - osd_info->str;
300 if (strcmp(name, "keywords") == 0)
302 data = keywords_to_string(fd);
304 else if (strcmp(name, "comment") == 0)
306 data = metadata_read_string(fd, COMMENT_KEY, METADATA_PLAIN);
308 else if (strcmp(name, "imagecomment") == 0)
310 data = exif_get_image_comment(fd);
312 else if (strcmp(name, "rating") == 0)
314 data = metadata_read_string(fd, RATING_KEY, METADATA_PLAIN);
317 else if (strncmp(name, "lua/", 4) == 0)
320 tmp = strchr(name+4, '/');
324 data = lua_callvalue(fd, name+4, tmp+1);
329 data = g_strdup(static_cast<const gchar *>(g_hash_table_lookup(vars, static_cast<gconstpointer>(name))));
331 data = metadata_read_string(fd, name, METADATA_FORMATTED);
334 if (data && *data && limit > 0 && strlen(data) > limit + 3)
336 gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
343 /* Since we use pango markup to display, we need to escape here */
344 gchar *escaped = g_markup_escape_text(data, -1);
353 /* Display data between left and right parts of extra string
354 * the data is expressed by a '*' character. A '*' may be escaped
355 * by a \. You should escape all '*' characters, do not rely on the
356 * current implementation which only replaces the first unescaped '*'.
357 * If no "*" is present, the extra string is just appended to data string.
358 * Pango mark up is accepted in left and right parts.
359 * Any \n is replaced by a newline
361 * "<i>*</i>\n" -> data is displayed in italics ended with a newline
362 * "\n" -> ended with newline
363 * "ISO *" -> prefix data with "ISO " (ie. "ISO 100")
364 * "\**\*" -> prefix data with a star, and append a star (ie. "*100*")
365 * "\\*" -> prefix data with an anti slash (ie "\100")
366 * "Collection <b>*</b>\n" -> display data in bold prefixed by "Collection " and a newline is appended
368 /** @FIXME using background / foreground colors lead to weird results.
371 gchar *left = nullptr;
372 gchar *right = extra;
374 guint len = strlen(extra);
376 /* Search for left and right parts and unescape characters */
377 for (p = extra; *p; p++, len--)
382 memmove(p+1, p+2, --len);
385 else if (p[1] != '\0')
386 memmove(p, p+1, len--); // includes \0
388 else if (p[0] == '*' && !left)
394 if (left) right[-1] = '\0';
396 new_data = g_strdup_printf("%s%s%s", left ? left : "", data, right);
403 g_string_erase(osd_info, pos, end-start+1);
408 /* insert separator */
409 g_string_insert(osd_info, pos, sep);
411 want_separator = FALSE;
414 g_string_insert(osd_info, pos, data);
418 if (pos-prev >= 1 && osd_info->str[pos] == imp)
420 /* pipe character is replaced by a separator, delete it
421 * and raise a flag if needed */
422 g_string_erase(osd_info, pos--, 1);
423 want_separator |= (data && *data);
426 if (osd_info->str[pos] == '\n') want_separator = FALSE;
434 /* search and destroy empty lines */
436 while ((start = strchr(end, '\n')))
439 while (*++(end) == '\n')
441 g_string_erase(osd_info, start-osd_info->str, end-start-1);
444 ret = g_string_free(osd_info, FALSE);
446 return g_strchomp(ret);
449 void osd_template_insert(GHashTable *vars, const gchar *keyword, const gchar *value, OsdTemplateFlags flags)
453 g_hash_table_insert(vars, const_cast<gchar *>(keyword), g_strdup(""));
457 if (flags & OSDT_NO_DUP)
459 g_hash_table_insert(vars, const_cast<gchar *>(keyword), const_cast<gchar *>(value));
463 g_hash_table_insert(vars, const_cast<gchar *>(keyword), g_strdup(value));
465 if (flags & OSDT_FREE) g_free(const_cast<gchar *>(value));
467 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */