src/osd.cc

   1 /*
   2  * Copyright (C) 2018 The Geeqie Team
   3  *
   4  * Author: Colin Clark
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  */
  20
  21 /* Routines for creating the Overlay Screen Display text. Also
  22  * used for the same purposes by the Print routines
  23  */
  24
  25 #include "main.h"
  26 #include "osd.h"
  27
  28 #include "dnd.h"
  29 #include "exif.h"
  30 #include "glua.h"
  31 #include "metadata.h"
  32 #include "ui-fileops.h"
  33 #include "ui-misc.h"
  34
  35 #include <cmath>
  36
  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")},
  81         {nullptr, nullptr}};
  82
  83 static GtkTargetEntry osd_drag_types[] = {
  84         { const_cast<gchar *>("text/plain"), GTK_TARGET_SAME_APP, TARGET_TEXT_PLAIN }
  85 };
  86
  87 struct TagData
  88 {
  89         gchar *key;
  90         gchar *title;
  91 };
  92
  93 static void tag_button_cb(GtkWidget *widget, gpointer data)
  94 {
  95         auto image_overlay_template_view = static_cast<GtkTextView *>(data);
  96         GtkTextBuffer *buffer;
  97         TagData *td;
  98
  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);
 102
 103         gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
 104 }
 105
 106 static void osd_dnd_get_cb(GtkWidget *btn, GdkDragContext *, GtkSelectionData *selection_data, guint, guint, gpointer data)
 107 {
 108         TagData *td;
 109         auto image_overlay_template_view = static_cast<GtkTextView *>(data);
 110
 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);
 113
 114         gtk_widget_grab_focus(GTK_WIDGET(image_overlay_template_view));
 115 }
 116
 117 static void osd_btn_destroy_cb(GtkWidget *btn, GdkDragContext *, GtkSelectionData *, guint, guint, gpointer)
 118 {
 119         TagData *td;
 120
 121         td = static_cast<TagData *>(g_object_get_data(G_OBJECT(btn), "tag_data"));
 122         g_free(td->key);
 123         g_free(td->title);
 124 }
 125
 126 static void set_osd_button(GtkTable *table, const gint rows, const gint cols, const gchar *key, const gchar *title, GtkWidget *template_view)
 127 {
 128         GtkWidget *new_button;
 129         TagData *td;
 130
 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);
 134
 135         td = g_new0(TagData, 1);
 136         td->key = g_strdup(key);
 137         td->title = g_strdup(title);
 138
 139         g_object_set_data(G_OBJECT(new_button), "tag_data", td);
 140
 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);
 146
 147         gtk_table_attach_defaults(table, new_button, cols, cols+1, rows, rows+1);
 148
 149 }
 150
 151 GtkWidget *osd_new(gint max_cols, GtkWidget *template_view)
 152 {
 153         GtkWidget *vbox;
 154         GtkWidget *scrolled;
 155         gint i = 0;
 156         gint rows = 0;
 157         gint max_rows = 0;
 158         gint cols = 0;
 159         gdouble entries;
 160         GtkWidget *viewport;
 161
 162         vbox = gtk_box_new(GTK_ORIENTATION_VERTICAL, 0);
 163
 164         pref_label_new(vbox, _("To include predefined tags in the template, click a button or drag-and-drop"));
 165
 166         scrolled = gtk_scrolled_window_new(nullptr, nullptr);
 167         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);
 173
 174         viewport = gtk_viewport_new(nullptr, nullptr);
 175         gtk_viewport_set_shadow_type(GTK_VIEWPORT(viewport), GTK_SHADOW_NONE);
 176         gtk_container_add(GTK_CONTAINER(scrolled), viewport);
 177         gtk_widget_show(viewport);
 178
 179         entries = (sizeof(predefined_tags) / sizeof(predefined_tags[0])) - 1;
 180         max_rows = ceil(entries / max_cols);
 181
 182         GtkTable *table;
 183         table = GTK_TABLE(gtk_table_new(max_rows, max_cols, FALSE));
 184         gtk_container_add(GTK_CONTAINER(viewport), GTK_WIDGET(table));
 185         gtk_widget_show(GTK_WIDGET(table));
 186
 187         for (rows = 0; rows < max_rows; rows++)
 188                 {
 189                 cols = 0;
 190
 191                 while (cols < max_cols && predefined_tags[i][0])
 192                         {
 193                         set_osd_button(table, rows, cols, predefined_tags[i][0], predefined_tags[i][1], template_view);
 194                         i = i + 1;
 195                         cols++;
 196                         }
 197                 }
 198         return vbox;
 199 }
 200 static gchar *keywords_to_string(FileData *fd)
 201 {
 202         GList *keywords;
 203         GString *kwstr = nullptr;
 204         gchar *ret = nullptr;
 205
 206         g_assert(fd);
 207
 208         keywords = metadata_read_list(fd, KEYWORD_KEY, METADATA_PLAIN);
 209
 210         if (keywords)
 211                 {
 212                 GList *work = keywords;
 213
 214                 while (work)
 215                         {
 216                         auto kw = static_cast<gchar *>(work->data);
 217                         work = work->next;
 218
 219                         if (!kw) continue;
 220                         if (!kwstr)
 221                                 kwstr = g_string_new("");
 222                         else
 223                                 g_string_append(kwstr, ", ");
 224
 225                         g_string_append(kwstr, kw);
 226                         }
 227                 g_list_free_full(keywords, g_free);
 228                 }
 229
 230         if (kwstr)
 231                 {
 232                 ret = g_strdup(kwstr->str);
 233                 g_string_free(kwstr, TRUE);
 234                 }
 235
 236         return ret;
 237 }
 238
 239 gchar *image_osd_mkinfo(const gchar *str, FileData *fd, GHashTable *vars)
 240 {
 241         gchar delim = '%', imp = '|', sep[] = " - ";
 242         gchar *start, *end;
 243         guint pos, prev;
 244         gboolean want_separator = FALSE;
 245         gchar *name, *data;
 246         GString *osd_info;
 247         gchar *ret;
 248
 249         if (!str || !*str) return g_strdup("");
 250
 251         osd_info = g_string_new(str);
 252
 253         prev = -1;
 254
 255         while (TRUE)
 256                 {
 257                 guint limit = 0;
 258                 gchar *trunc = nullptr;
 259                 gchar *limpos = nullptr;
 260                 gchar *extra = nullptr;
 261                 gchar *extrapos = nullptr;
 262                 gchar *p;
 263
 264                 start = strchr(osd_info->str + (prev + 1), delim);
 265                 if (!start)
 266                         break;
 267                 end = strchr(start+1, delim);
 268                 if (!end)
 269                         break;
 270
 271                 /* Search for optional modifiers
 272                  * %name:99:extra% -> name = "name", limit=99, extra = "extra"
 273                  */
 274                 for (p = start + 1; p < end; p++)
 275                         {
 276                         if (p[0] == ':')
 277                                 {
 278                                 if (g_ascii_isdigit(p[1]) && !limpos)
 279                                         {
 280                                         limpos = p + 1;
 281                                         if (!trunc) trunc = p;
 282                                         }
 283                                 else
 284                                         {
 285                                         extrapos = p + 1;
 286                                         if (!trunc) trunc = p;
 287                                         break;
 288                                         }
 289                                 }
 290                         }
 291
 292                 if (limpos)
 293                         limit = static_cast<guint>(atoi(limpos));
 294
 295                 if (extrapos)
 296                         extra = g_strndup(extrapos, end - extrapos);
 297
 298                 name = g_strndup(start+1, (trunc ? trunc : end)-start-1);
 299                 pos = start - osd_info->str;
 300                 data = nullptr;
 301
 302                 if (strcmp(name, "keywords") == 0)
 303                         {
 304                         data = keywords_to_string(fd);
 305                         }
 306                 else if (strcmp(name, "comment") == 0)
 307                         {
 308                         data = metadata_read_string(fd, COMMENT_KEY, METADATA_PLAIN);
 309                         }
 310                 else if (strcmp(name, "imagecomment") == 0)
 311                         {
 312                         data = exif_get_image_comment(fd);
 313                         }
 314                 else if (strcmp(name, "rating") == 0)
 315                         {
 316                         data = metadata_read_string(fd, RATING_KEY, METADATA_PLAIN);
 317                         }
 318 #ifdef HAVE_LUA
 319                 else if (strncmp(name, "lua/", 4) == 0)
 320                         {
 321                         gchar *tmp;
 322                         tmp = strchr(name+4, '/');
 323                         if (!tmp)
 324                                 break;
 325                         *tmp = '\0';
 326                         data = lua_callvalue(fd, name+4, tmp+1);
 327                         }
 328 #endif
 329                 else
 330                         {
 331                         data = g_strdup(static_cast<const gchar *>(g_hash_table_lookup(vars, static_cast<gconstpointer>(name))));
 332                         if (!data)
 333                                 data = metadata_read_string(fd, name, METADATA_FORMATTED);
 334                         }
 335
 336                 if (data && *data && limit > 0 && strlen(data) > limit + 3)
 337                         {
 338                         gchar *new_data = g_strdup_printf("%-*.*s...", limit, limit, data);
 339                         g_free(data);
 340                         data = new_data;
 341                         }
 342
 343                 if (data)
 344                         {
 345                         /* Since we use pango markup to display, we need to escape here */
 346                         gchar *escaped = g_markup_escape_text(data, -1);
 347                         g_free(data);
 348                         data = escaped;
 349                         }
 350
 351                 if (extra)
 352                         {
 353                         if (data && *data)
 354                                 {
 355                                 /* Display data between left and right parts of extra string
 356                                  * the data is expressed by a '*' character. A '*' may be escaped
 357                                  * by a \. You should escape all '*' characters, do not rely on the
 358                                  * current implementation which only replaces the first unescaped '*'.
 359                                  * If no "*" is present, the extra string is just appended to data string.
 360                                  * Pango mark up is accepted in left and right parts.
 361                                  * Any \n is replaced by a newline
 362                                  * Examples:
 363                                  * "<i>*</i>\n" -> data is displayed in italics ended with a newline
 364                                  * "\n"         -> ended with newline
 365                                  * "ISO *"      -> prefix data with "ISO " (ie. "ISO 100")
 366                                  * "\**\*"      -> prefix data with a star, and append a star (ie. "*100*")
 367                                  * "\\*"        -> prefix data with an anti slash (ie "\100")
 368                                  * "Collection <b>*</b>\n" -> display data in bold prefixed by "Collection " and a newline is appended
 369                                  */
 370                                 /** @FIXME using background / foreground colors lead to weird results.
 371                                  */
 372                                 gchar *new_data;
 373                                 gchar *left = nullptr;
 374                                 gchar *right = extra;
 375                                 gchar *p;
 376                                 guint len = strlen(extra);
 377
 378                                 /* Search for left and right parts and unescape characters */
 379                                 for (p = extra; *p; p++, len--)
 380                                         if (p[0] == '\\')
 381                                                 {
 382                                                 if (p[1] == 'n')
 383                                                         {
 384                                                         memmove(p+1, p+2, --len);
 385                                                         p[0] = '\n';
 386                                                         }
 387                                                 else if (p[1] != '\0')
 388                                                         memmove(p, p+1, len--); // includes \0
 389                                                 }
 390                                         else if (p[0] == '*' && !left)
 391                                                 {
 392                                                 right = p + 1;
 393                                                 left = extra;
 394                                                 }
 395
 396                                 if (left) right[-1] = '\0';
 397
 398                                 new_data = g_strdup_printf("%s%s%s", left ? left : "", data, right);
 399                                 g_free(data);
 400                                 data = new_data;
 401                                 }
 402                         g_free(extra);
 403                         }
 404
 405                 g_string_erase(osd_info, pos, end-start+1);
 406                 if (data && *data)
 407                         {
 408                         if (want_separator)
 409                                 {
 410                                 /* insert separator */
 411                                 g_string_insert(osd_info, pos, sep);
 412                                 pos += strlen(sep);
 413                                 want_separator = FALSE;
 414                                 }
 415
 416                         g_string_insert(osd_info, pos, data);
 417                         pos += strlen(data);
 418                 }
 419
 420                 if (pos-prev >= 1 && osd_info->str[pos] == imp)
 421                         {
 422                         /* pipe character is replaced by a separator, delete it
 423                          * and raise a flag if needed */
 424                         g_string_erase(osd_info, pos--, 1);
 425                         want_separator |= (data && *data);
 426                         }
 427
 428                 if (osd_info->str[pos] == '\n') want_separator = FALSE;
 429
 430                 prev = pos - 1;
 431
 432                 g_free(name);
 433                 g_free(data);
 434                 }
 435
 436         /* search and destroy empty lines */
 437         end = osd_info->str;
 438         while ((start = strchr(end, '\n')))
 439                 {
 440                 end = start;
 441                 while (*++(end) == '\n')
 442                         ;
 443                 g_string_erase(osd_info, start-osd_info->str, end-start-1);
 444                 }
 445
 446         g_strchomp(osd_info->str);
 447
 448         ret = g_strdup(osd_info->str);
 449         g_string_free(osd_info, TRUE);
 450
 451         return ret;
 452 }
 453
 454 void osd_template_insert(GHashTable *vars, const gchar *keyword, const gchar *value, OsdTemplateFlags flags)
 455 {
 456         if (!value)
 457                 {
 458                 g_hash_table_insert(vars, const_cast<gchar *>(keyword), g_strdup(""));
 459                 return;
 460                 }
 461
 462         if (flags & OSDT_NO_DUP)
 463                 {
 464                 g_hash_table_insert(vars, const_cast<gchar *>(keyword), const_cast<gchar *>(value));
 465                 return;
 466                 }
 467         else
 468                 {
 469                 g_hash_table_insert(vars, const_cast<gchar *>(keyword), g_strdup(value));
 470                 }
 471
 472         if (flags & OSDT_FREE) g_free(const_cast<gchar *>(value));
 473 }
 474 /* vim: set shiftwidth=8 softtabstop=0 cindent cinoptions={1s: */